blob: 1417f10e645dae3dba312c98b105c719dc07b23b [file] [log] [blame]
Chris Lattner86e44452003-10-05 19:14:42 +00001//===- LowerInvoke.cpp - Eliminate Invoke & Unwind instructions -----------===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanfd939082005-04-21 23:48:37 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner86e44452003-10-05 19:14:42 +00009//
10// This transformation is designed for use by code generators which do not yet
Chris Lattner6d784572004-02-08 19:53:56 +000011// support stack unwinding. This pass supports two models of exception handling
12// lowering, the 'cheap' support and the 'expensive' support.
13//
14// 'Cheap' exception handling support gives the program the ability to execute
15// any program which does not "throw an exception", by turning 'invoke'
16// instructions into calls and by turning 'unwind' instructions into calls to
17// abort(). If the program does dynamically use the unwind instruction, the
18// program will print a message then abort.
19//
20// 'Expensive' exception handling support gives the full exception handling
John Criswellfe3706a2005-05-02 14:47:42 +000021// support to the program at the cost of making the 'invoke' instruction
22// really expensive. It basically inserts setjmp/longjmp calls to emulate the
23// exception handling as necessary.
Chris Lattner6d784572004-02-08 19:53:56 +000024//
25// Because the 'expensive' support slows down programs a lot, and EH is only
26// used for a subset of the programs, it must be specifically enabled by an
27// option.
Chris Lattner86e44452003-10-05 19:14:42 +000028//
Chris Lattner0e28eca2004-03-31 22:00:30 +000029// Note that after this pass runs the CFG is not entirely accurate (exceptional
30// control flow edges are not correct anymore) so only very simple things should
31// be done after the lowerinvoke pass has run (like generation of native code).
32// This should not be used as a general purpose "my LLVM-to-LLVM pass doesn't
33// support the invoke instruction yet" lowering pass.
34//
Chris Lattner86e44452003-10-05 19:14:42 +000035//===----------------------------------------------------------------------===//
36
Chris Lattnerd216e8b2006-12-19 22:17:40 +000037#define DEBUG_TYPE "lowerinvoke"
Chris Lattner86e44452003-10-05 19:14:42 +000038#include "llvm/Transforms/Scalar.h"
Chris Lattnere1c09302004-02-08 07:30:29 +000039#include "llvm/Constants.h"
40#include "llvm/DerivedTypes.h"
Chris Lattner6d784572004-02-08 19:53:56 +000041#include "llvm/Instructions.h"
Duncan Sandsa1220432008-04-07 13:41:19 +000042#include "llvm/Intrinsics.h"
Owen Anderson0a205a42009-07-05 22:41:43 +000043#include "llvm/LLVMContext.h"
Chris Lattnere1c09302004-02-08 07:30:29 +000044#include "llvm/Module.h"
Chris Lattner86e44452003-10-05 19:14:42 +000045#include "llvm/Pass.h"
Chris Lattner6d784572004-02-08 19:53:56 +000046#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +000047#include "llvm/Transforms/Utils/Local.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000048#include "llvm/ADT/Statistic.h"
49#include "llvm/Support/CommandLine.h"
Chris Lattnera4f0b3a2006-08-27 12:54:02 +000050#include "llvm/Support/Compiler.h"
Duraid Madina2a0013f2006-09-04 06:21:35 +000051#include "llvm/Target/TargetLowering.h"
Chris Lattner6d784572004-02-08 19:53:56 +000052#include <csetjmp>
Reid Spencer6734b572007-02-04 00:40:42 +000053#include <set>
Chris Lattnerdead9932003-12-10 20:22:42 +000054using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000055
Chris Lattnerd216e8b2006-12-19 22:17:40 +000056STATISTIC(NumInvokes, "Number of invokes replaced");
57STATISTIC(NumUnwinds, "Number of unwinds replaced");
58STATISTIC(NumSpilled, "Number of registers live across unwind edges");
59
60static cl::opt<bool> ExpensiveEHSupport("enable-correct-eh-support",
Chris Lattner6d784572004-02-08 19:53:56 +000061 cl::desc("Make the -lowerinvoke pass insert expensive, but correct, EH code"));
Chris Lattner86e44452003-10-05 19:14:42 +000062
Chris Lattnerd216e8b2006-12-19 22:17:40 +000063namespace {
Chris Lattnerf4b54612006-06-28 22:08:15 +000064 class VISIBILITY_HIDDEN LowerInvoke : public FunctionPass {
Chris Lattner6d784572004-02-08 19:53:56 +000065 // Used for both models.
Chris Lattnerb76efb72007-01-07 08:12:01 +000066 Constant *WriteFn;
67 Constant *AbortFn;
Chris Lattner6d784572004-02-08 19:53:56 +000068 Value *AbortMessage;
69 unsigned AbortMessageLength;
70
71 // Used for expensive EH support.
72 const Type *JBLinkTy;
73 GlobalVariable *JBListHead;
Chris Lattnerb76efb72007-01-07 08:12:01 +000074 Constant *SetJmpFn, *LongJmpFn;
Jim Grosbach46445382009-04-17 23:30:55 +000075
Duraid Madina2a0013f2006-09-04 06:21:35 +000076 // We peek in TLI to grab the target's jmp_buf size and alignment
77 const TargetLowering *TLI;
Jim Grosbach46445382009-04-17 23:30:55 +000078
Chris Lattner86e44452003-10-05 19:14:42 +000079 public:
Nick Lewyckyecd94c82007-05-06 13:37:16 +000080 static char ID; // Pass identification, replacement for typeid
Dan Gohmanc2bbfc12007-08-01 15:32:29 +000081 explicit LowerInvoke(const TargetLowering *tli = NULL)
Dan Gohmanae73dc12008-09-04 17:05:41 +000082 : FunctionPass(&ID), TLI(tli) { }
Chris Lattner86e44452003-10-05 19:14:42 +000083 bool doInitialization(Module &M);
84 bool runOnFunction(Function &F);
Jim Grosbach46445382009-04-17 23:30:55 +000085
Chris Lattnered96fe82006-05-17 21:05:27 +000086 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Anton Korobeynikovbed29462007-04-16 18:10:23 +000087 // This is a cluster of orthogonal Transforms
Chris Lattnered96fe82006-05-17 21:05:27 +000088 AU.addPreservedID(PromoteMemoryToRegisterID);
Chris Lattnered96fe82006-05-17 21:05:27 +000089 AU.addPreservedID(LowerSwitchID);
90 AU.addPreservedID(LowerAllocationsID);
91 }
Jim Grosbach46445382009-04-17 23:30:55 +000092
Chris Lattner6d784572004-02-08 19:53:56 +000093 private:
Chris Lattnerb76efb72007-01-07 08:12:01 +000094 void createAbortMessage(Module *M);
Chris Lattner501825e2004-02-08 22:14:44 +000095 void writeAbortMessage(Instruction *IB);
Chris Lattner6d784572004-02-08 19:53:56 +000096 bool insertCheapEHSupport(Function &F);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +000097 void splitLiveRangesLiveAcrossInvokes(std::vector<InvokeInst*> &Invokes);
98 void rewriteExpensiveInvoke(InvokeInst *II, unsigned InvokeNo,
99 AllocaInst *InvokeNum, SwitchInst *CatchSwitch);
Chris Lattner6d784572004-02-08 19:53:56 +0000100 bool insertExpensiveEHSupport(Function &F);
Chris Lattner86e44452003-10-05 19:14:42 +0000101 };
Chris Lattner86e44452003-10-05 19:14:42 +0000102}
103
Dan Gohman844731a2008-05-13 00:00:25 +0000104char LowerInvoke::ID = 0;
105static RegisterPass<LowerInvoke>
106X("lowerinvoke", "Lower invoke and unwind, for unwindless code generators");
107
Dan Gohman6ddba2b2008-05-13 02:05:11 +0000108const PassInfo *const llvm::LowerInvokePassID = &X;
Chris Lattnercefc18e2004-02-13 16:16:16 +0000109
Brian Gaeked0fde302003-11-11 22:41:34 +0000110// Public Interface To the LowerInvoke pass.
Jim Grosbach46445382009-04-17 23:30:55 +0000111FunctionPass *llvm::createLowerInvokePass(const TargetLowering *TLI) {
112 return new LowerInvoke(TLI);
Nate Begeman14b05292005-11-05 09:21:28 +0000113}
Chris Lattner86e44452003-10-05 19:14:42 +0000114
115// doInitialization - Make sure that there is a prototype for abort in the
116// current module.
117bool LowerInvoke::doInitialization(Module &M) {
Owen Anderson001dbfe2009-07-16 18:04:31 +0000118 Context = &M.getContext();
119
Owen Anderson0a205a42009-07-05 22:41:43 +0000120 const Type *VoidPtrTy = Context->getPointerTypeUnqual(Type::Int8Ty);
Jim Laskey7d485382007-02-22 16:21:18 +0000121 AbortMessage = 0;
122 if (ExpensiveEHSupport) {
123 // Insert a type for the linked list of jump buffers.
124 unsigned JBSize = TLI ? TLI->getJumpBufSize() : 0;
125 JBSize = JBSize ? JBSize : 200;
Owen Anderson0a205a42009-07-05 22:41:43 +0000126 const Type *JmpBufTy = Context->getArrayType(VoidPtrTy, JBSize);
Chris Lattnere1c09302004-02-08 07:30:29 +0000127
Jim Laskey7d485382007-02-22 16:21:18 +0000128 { // The type is recursive, so use a type holder.
129 std::vector<const Type*> Elements;
130 Elements.push_back(JmpBufTy);
Owen Anderson0a205a42009-07-05 22:41:43 +0000131 OpaqueType *OT = Context->getOpaqueType();
132 Elements.push_back(Context->getPointerTypeUnqual(OT));
133 PATypeHolder JBLType(Context->getStructType(Elements));
Jim Laskey7d485382007-02-22 16:21:18 +0000134 OT->refineAbstractTypeTo(JBLType.get()); // Complete the cycle.
135 JBLinkTy = JBLType.get();
136 M.addTypeName("llvm.sjljeh.jmpbufty", JBLinkTy);
Chris Lattner6d784572004-02-08 19:53:56 +0000137 }
138
Owen Anderson0a205a42009-07-05 22:41:43 +0000139 const Type *PtrJBList = Context->getPointerTypeUnqual(JBLinkTy);
Jim Laskey7d485382007-02-22 16:21:18 +0000140
141 // Now that we've done that, insert the jmpbuf list head global, unless it
142 // already exists.
143 if (!(JBListHead = M.getGlobalVariable("llvm.sjljeh.jblist", PtrJBList))) {
Owen Andersone9b11b42009-07-08 19:03:57 +0000144 JBListHead = new GlobalVariable(M, PtrJBList, false,
Duncan Sands667d4b82009-03-07 15:45:40 +0000145 GlobalValue::LinkOnceAnyLinkage,
Owen Anderson0a205a42009-07-05 22:41:43 +0000146 Context->getNullValue(PtrJBList),
Owen Andersone9b11b42009-07-08 19:03:57 +0000147 "llvm.sjljeh.jblist");
Jim Laskey7d485382007-02-22 16:21:18 +0000148 }
Chuck Rose IIIcc51c312008-04-15 21:27:11 +0000149
Jim Grosbach46445382009-04-17 23:30:55 +0000150// VisualStudio defines setjmp as _setjmp via #include <csetjmp> / <setjmp.h>,
Chuck Rose IIIcc51c312008-04-15 21:27:11 +0000151// so it looks like Intrinsic::_setjmp
152#if defined(_MSC_VER) && defined(setjmp)
153#define setjmp_undefined_for_visual_studio
154#undef setjmp
155#endif
156
Duncan Sandsa1220432008-04-07 13:41:19 +0000157 SetJmpFn = Intrinsic::getDeclaration(&M, Intrinsic::setjmp);
Chuck Rose IIIcc51c312008-04-15 21:27:11 +0000158
159#if defined(_MSC_VER) && defined(setjmp_undefined_for_visual_studio)
Jim Grosbach46445382009-04-17 23:30:55 +0000160// let's return it to _setjmp state in case anyone ever needs it after this
Chuck Rose IIIcc51c312008-04-15 21:27:11 +0000161// point under VisualStudio
Jim Grosbach46445382009-04-17 23:30:55 +0000162#define setjmp _setjmp
Chuck Rose IIIcc51c312008-04-15 21:27:11 +0000163#endif
164
Duncan Sandsa1220432008-04-07 13:41:19 +0000165 LongJmpFn = Intrinsic::getDeclaration(&M, Intrinsic::longjmp);
Chris Lattner6d784572004-02-08 19:53:56 +0000166 }
Jim Laskey7d485382007-02-22 16:21:18 +0000167
168 // We need the 'write' and 'abort' functions for both models.
169 AbortFn = M.getOrInsertFunction("abort", Type::VoidTy, (Type *)0);
Jeff Cohen09b362c2007-04-20 22:40:10 +0000170#if 0 // "write" is Unix-specific.. code is going away soon anyway.
Jim Laskey7d485382007-02-22 16:21:18 +0000171 WriteFn = M.getOrInsertFunction("write", Type::VoidTy, Type::Int32Ty,
172 VoidPtrTy, Type::Int32Ty, (Type *)0);
Jeff Cohen09b362c2007-04-20 22:40:10 +0000173#else
174 WriteFn = 0;
175#endif
Chris Lattner86e44452003-10-05 19:14:42 +0000176 return true;
177}
178
Chris Lattnerb76efb72007-01-07 08:12:01 +0000179void LowerInvoke::createAbortMessage(Module *M) {
Chris Lattner0c3b3902004-11-13 19:07:32 +0000180 if (ExpensiveEHSupport) {
181 // The abort message for expensive EH support tells the user that the
182 // program 'unwound' without an 'invoke' instruction.
183 Constant *Msg =
Owen Anderson0a205a42009-07-05 22:41:43 +0000184 Context->getConstantArray("ERROR: Exception thrown, but not caught!\n");
Chris Lattner0c3b3902004-11-13 19:07:32 +0000185 AbortMessageLength = Msg->getNumOperands()-1; // don't include \0
Misha Brukmanfd939082005-04-21 23:48:37 +0000186
Owen Andersone9b11b42009-07-08 19:03:57 +0000187 GlobalVariable *MsgGV = new GlobalVariable(*M, Msg->getType(), true,
Chris Lattner0c3b3902004-11-13 19:07:32 +0000188 GlobalValue::InternalLinkage,
Owen Andersone9b11b42009-07-08 19:03:57 +0000189 Msg, "abortmsg");
Owen Anderson0a205a42009-07-05 22:41:43 +0000190 std::vector<Constant*> GEPIdx(2, Context->getNullValue(Type::Int32Ty));
191 AbortMessage = Context->getConstantExprGetElementPtr(MsgGV, &GEPIdx[0], 2);
Chris Lattner0c3b3902004-11-13 19:07:32 +0000192 } else {
193 // The abort message for cheap EH support tells the user that EH is not
194 // enabled.
195 Constant *Msg =
Owen Anderson0a205a42009-07-05 22:41:43 +0000196 Context->getConstantArray("Exception handler needed, but not enabled."
197 "Recompile program with -enable-correct-eh-support.\n");
Chris Lattner0c3b3902004-11-13 19:07:32 +0000198 AbortMessageLength = Msg->getNumOperands()-1; // don't include \0
199
Owen Andersone9b11b42009-07-08 19:03:57 +0000200 GlobalVariable *MsgGV = new GlobalVariable(*M, Msg->getType(), true,
Chris Lattner0c3b3902004-11-13 19:07:32 +0000201 GlobalValue::InternalLinkage,
Owen Andersone9b11b42009-07-08 19:03:57 +0000202 Msg, "abortmsg");
Owen Anderson0a205a42009-07-05 22:41:43 +0000203 std::vector<Constant*> GEPIdx(2, Context->getNullValue(Type::Int32Ty));
Chris Lattnerec1f7522007-02-19 07:34:47 +0000204 AbortMessage = ConstantExpr::getGetElementPtr(MsgGV, &GEPIdx[0], 2);
Chris Lattner0c3b3902004-11-13 19:07:32 +0000205 }
206}
207
208
Chris Lattner501825e2004-02-08 22:14:44 +0000209void LowerInvoke::writeAbortMessage(Instruction *IB) {
Jeff Cohen09b362c2007-04-20 22:40:10 +0000210#if 0
Chris Lattnerb76efb72007-01-07 08:12:01 +0000211 if (AbortMessage == 0)
212 createAbortMessage(IB->getParent()->getParent()->getParent());
Chris Lattner0c3b3902004-11-13 19:07:32 +0000213
Chris Lattnerb76efb72007-01-07 08:12:01 +0000214 // These are the arguments we WANT...
Chris Lattner93e985f2007-02-13 02:10:56 +0000215 Value* Args[3];
216 Args[0] = ConstantInt::get(Type::Int32Ty, 2);
217 Args[1] = AbortMessage;
218 Args[2] = ConstantInt::get(Type::Int32Ty, AbortMessageLength);
219 (new CallInst(WriteFn, Args, 3, "", IB))->setTailCall();
Jeff Cohen09b362c2007-04-20 22:40:10 +0000220#endif
Chris Lattner501825e2004-02-08 22:14:44 +0000221}
222
Chris Lattner6d784572004-02-08 19:53:56 +0000223bool LowerInvoke::insertCheapEHSupport(Function &F) {
Chris Lattner86e44452003-10-05 19:14:42 +0000224 bool Changed = false;
Chris Lattnerdead9932003-12-10 20:22:42 +0000225 for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
226 if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator())) {
Bill Wendling9a507cd2009-03-13 21:15:59 +0000227 std::vector<Value*> CallArgs(II->op_begin()+3, II->op_end());
Chris Lattner86e44452003-10-05 19:14:42 +0000228 // Insert a normal call instruction...
Gabor Greif051a9502008-04-06 20:25:17 +0000229 CallInst *NewCall = CallInst::Create(II->getCalledValue(),
230 CallArgs.begin(), CallArgs.end(), "",II);
Chris Lattner86cc4232007-02-11 01:37:51 +0000231 NewCall->takeName(II);
Chris Lattnerefd91682005-05-13 06:27:02 +0000232 NewCall->setCallingConv(II->getCallingConv());
Devang Patel05988662008-09-25 21:00:45 +0000233 NewCall->setAttributes(II->getAttributes());
Chris Lattner86e44452003-10-05 19:14:42 +0000234 II->replaceAllUsesWith(NewCall);
Misha Brukmanfd939082005-04-21 23:48:37 +0000235
Chris Lattnerdead9932003-12-10 20:22:42 +0000236 // Insert an unconditional branch to the normal destination.
Gabor Greif051a9502008-04-06 20:25:17 +0000237 BranchInst::Create(II->getNormalDest(), II);
Chris Lattner86e44452003-10-05 19:14:42 +0000238
Chris Lattnerdead9932003-12-10 20:22:42 +0000239 // Remove any PHI node entries from the exception destination.
Chris Lattneraeb2a1d2004-02-08 21:44:31 +0000240 II->getUnwindDest()->removePredecessor(BB);
Chris Lattnerdead9932003-12-10 20:22:42 +0000241
Chris Lattner86e44452003-10-05 19:14:42 +0000242 // Remove the invoke instruction now.
Chris Lattnerdead9932003-12-10 20:22:42 +0000243 BB->getInstList().erase(II);
Chris Lattner86e44452003-10-05 19:14:42 +0000244
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000245 ++NumInvokes; Changed = true;
Chris Lattnerdead9932003-12-10 20:22:42 +0000246 } else if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
Chris Lattnere1c09302004-02-08 07:30:29 +0000247 // Insert a new call to write(2, AbortMessage, AbortMessageLength);
Chris Lattner501825e2004-02-08 22:14:44 +0000248 writeAbortMessage(UI);
Chris Lattnere1c09302004-02-08 07:30:29 +0000249
Chris Lattner86e44452003-10-05 19:14:42 +0000250 // Insert a call to abort()
Gabor Greif051a9502008-04-06 20:25:17 +0000251 CallInst::Create(AbortFn, "", UI)->setTailCall();
Chris Lattner86e44452003-10-05 19:14:42 +0000252
Chris Lattner6d784572004-02-08 19:53:56 +0000253 // Insert a return instruction. This really should be a "barrier", as it
254 // is unreachable.
Gabor Greif051a9502008-04-06 20:25:17 +0000255 ReturnInst::Create(F.getReturnType() == Type::VoidTy ? 0 :
Owen Anderson0a5372e2009-07-13 04:09:18 +0000256 Context->getNullValue(F.getReturnType()), UI);
Chris Lattner86e44452003-10-05 19:14:42 +0000257
258 // Remove the unwind instruction now.
Chris Lattnerdead9932003-12-10 20:22:42 +0000259 BB->getInstList().erase(UI);
Chris Lattner86e44452003-10-05 19:14:42 +0000260
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000261 ++NumUnwinds; Changed = true;
Chris Lattner86e44452003-10-05 19:14:42 +0000262 }
263 return Changed;
264}
Chris Lattner6d784572004-02-08 19:53:56 +0000265
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000266/// rewriteExpensiveInvoke - Insert code and hack the function to replace the
267/// specified invoke instruction with a call.
268void LowerInvoke::rewriteExpensiveInvoke(InvokeInst *II, unsigned InvokeNo,
269 AllocaInst *InvokeNum,
270 SwitchInst *CatchSwitch) {
Owen Anderson9adc0ab2009-07-14 23:09:55 +0000271 ConstantInt *InvokeNoC = Context->getConstantInt(Type::Int32Ty, InvokeNo);
Chris Lattner6d784572004-02-08 19:53:56 +0000272
Chris Lattner8c5c22f2008-02-14 19:18:13 +0000273 // If the unwind edge has phi nodes, split the edge.
274 if (isa<PHINode>(II->getUnwindDest()->begin())) {
275 SplitCriticalEdge(II, 1, this);
Jim Grosbach46445382009-04-17 23:30:55 +0000276
Chris Lattner8c5c22f2008-02-14 19:18:13 +0000277 // If there are any phi nodes left, they must have a single predecessor.
278 while (PHINode *PN = dyn_cast<PHINode>(II->getUnwindDest()->begin())) {
279 PN->replaceAllUsesWith(PN->getIncomingValue(0));
280 PN->eraseFromParent();
281 }
282 }
Jim Grosbach46445382009-04-17 23:30:55 +0000283
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000284 // Insert a store of the invoke num before the invoke and store zero into the
285 // location afterward.
286 new StoreInst(InvokeNoC, InvokeNum, true, II); // volatile
Jim Grosbach46445382009-04-17 23:30:55 +0000287
Dan Gohman02dea8b2008-05-23 21:05:58 +0000288 BasicBlock::iterator NI = II->getNormalDest()->getFirstNonPHI();
Chris Lattner93e50ce2005-09-29 17:44:20 +0000289 // nonvolatile.
Owen Anderson0a5372e2009-07-13 04:09:18 +0000290 new StoreInst(Context->getNullValue(Type::Int32Ty), InvokeNum, false, NI);
Jim Grosbach46445382009-04-17 23:30:55 +0000291
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000292 // Add a switch case to our unwind block.
293 CatchSwitch->addCase(InvokeNoC, II->getUnwindDest());
Jim Grosbach46445382009-04-17 23:30:55 +0000294
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000295 // Insert a normal call instruction.
Bill Wendling9a507cd2009-03-13 21:15:59 +0000296 std::vector<Value*> CallArgs(II->op_begin()+3, II->op_end());
Gabor Greif051a9502008-04-06 20:25:17 +0000297 CallInst *NewCall = CallInst::Create(II->getCalledValue(),
298 CallArgs.begin(), CallArgs.end(), "",
299 II);
Chris Lattner86cc4232007-02-11 01:37:51 +0000300 NewCall->takeName(II);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000301 NewCall->setCallingConv(II->getCallingConv());
Devang Patel05988662008-09-25 21:00:45 +0000302 NewCall->setAttributes(II->getAttributes());
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000303 II->replaceAllUsesWith(NewCall);
Jim Grosbach46445382009-04-17 23:30:55 +0000304
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000305 // Replace the invoke with an uncond branch.
Gabor Greif051a9502008-04-06 20:25:17 +0000306 BranchInst::Create(II->getNormalDest(), NewCall->getParent());
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000307 II->eraseFromParent();
308}
Chris Lattner6d784572004-02-08 19:53:56 +0000309
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000310/// MarkBlocksLiveIn - Insert BB and all of its predescessors into LiveBBs until
311/// we reach blocks we've already seen.
312static void MarkBlocksLiveIn(BasicBlock *BB, std::set<BasicBlock*> &LiveBBs) {
313 if (!LiveBBs.insert(BB).second) return; // already been here.
Jim Grosbach46445382009-04-17 23:30:55 +0000314
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000315 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
Jim Grosbach46445382009-04-17 23:30:55 +0000316 MarkBlocksLiveIn(*PI, LiveBBs);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000317}
Chris Lattner6d784572004-02-08 19:53:56 +0000318
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000319// First thing we need to do is scan the whole function for values that are
320// live across unwind edges. Each value that is live across an unwind edge
321// we spill into a stack location, guaranteeing that there is nothing live
322// across the unwind edge. This process also splits all critical edges
323// coming out of invoke's.
324void LowerInvoke::
325splitLiveRangesLiveAcrossInvokes(std::vector<InvokeInst*> &Invokes) {
326 // First step, split all critical edges from invoke instructions.
327 for (unsigned i = 0, e = Invokes.size(); i != e; ++i) {
328 InvokeInst *II = Invokes[i];
329 SplitCriticalEdge(II, 0, this);
330 SplitCriticalEdge(II, 1, this);
331 assert(!isa<PHINode>(II->getNormalDest()) &&
332 !isa<PHINode>(II->getUnwindDest()) &&
333 "critical edge splitting left single entry phi nodes?");
Chris Lattner6d784572004-02-08 19:53:56 +0000334 }
335
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000336 Function *F = Invokes.back()->getParent()->getParent();
Jim Grosbach46445382009-04-17 23:30:55 +0000337
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000338 // To avoid having to handle incoming arguments specially, we lower each arg
Reid Spencer3da59db2006-11-27 01:05:10 +0000339 // to a copy instruction in the entry block. This ensures that the argument
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000340 // value itself cannot be live across the entry block.
341 BasicBlock::iterator AfterAllocaInsertPt = F->begin()->begin();
342 while (isa<AllocaInst>(AfterAllocaInsertPt) &&
343 isa<ConstantInt>(cast<AllocaInst>(AfterAllocaInsertPt)->getArraySize()))
344 ++AfterAllocaInsertPt;
345 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end();
346 AI != E; ++AI) {
Reid Spencer3da59db2006-11-27 01:05:10 +0000347 // This is always a no-op cast because we're casting AI to AI->getType() so
348 // src and destination types are identical. BitCast is the only possibility.
349 CastInst *NC = new BitCastInst(
350 AI, AI->getType(), AI->getName()+".tmp", AfterAllocaInsertPt);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000351 AI->replaceAllUsesWith(NC);
Reid Spencer3da59db2006-11-27 01:05:10 +0000352 // Normally its is forbidden to replace a CastInst's operand because it
353 // could cause the opcode to reflect an illegal conversion. However, we're
354 // replacing it here with the same value it was constructed with to simply
355 // make NC its user.
Jim Grosbach46445382009-04-17 23:30:55 +0000356 NC->setOperand(0, AI);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000357 }
Jim Grosbach46445382009-04-17 23:30:55 +0000358
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000359 // Finally, scan the code looking for instructions with bad live ranges.
360 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
361 for (BasicBlock::iterator II = BB->begin(), E = BB->end(); II != E; ++II) {
362 // Ignore obvious cases we don't have to handle. In particular, most
363 // instructions either have no uses or only have a single use inside the
364 // current block. Ignore them quickly.
365 Instruction *Inst = II;
366 if (Inst->use_empty()) continue;
367 if (Inst->hasOneUse() &&
368 cast<Instruction>(Inst->use_back())->getParent() == BB &&
369 !isa<PHINode>(Inst->use_back())) continue;
Jim Grosbach46445382009-04-17 23:30:55 +0000370
Chris Lattner45313712005-09-27 21:33:12 +0000371 // If this is an alloca in the entry block, it's not a real register
372 // value.
373 if (AllocaInst *AI = dyn_cast<AllocaInst>(Inst))
374 if (isa<ConstantInt>(AI->getArraySize()) && BB == F->begin())
375 continue;
Jim Grosbach46445382009-04-17 23:30:55 +0000376
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000377 // Avoid iterator invalidation by copying users to a temporary vector.
378 std::vector<Instruction*> Users;
379 for (Value::use_iterator UI = Inst->use_begin(), E = Inst->use_end();
380 UI != E; ++UI) {
381 Instruction *User = cast<Instruction>(*UI);
382 if (User->getParent() != BB || isa<PHINode>(User))
383 Users.push_back(User);
384 }
385
386 // Scan all of the uses and see if the live range is live across an unwind
387 // edge. If we find a use live across an invoke edge, create an alloca
388 // and spill the value.
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000389 std::set<InvokeInst*> InvokesWithStoreInserted;
390
391 // Find all of the blocks that this value is live in.
392 std::set<BasicBlock*> LiveBBs;
393 LiveBBs.insert(Inst->getParent());
394 while (!Users.empty()) {
395 Instruction *U = Users.back();
396 Users.pop_back();
Jim Grosbach46445382009-04-17 23:30:55 +0000397
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000398 if (!isa<PHINode>(U)) {
399 MarkBlocksLiveIn(U->getParent(), LiveBBs);
400 } else {
401 // Uses for a PHI node occur in their predecessor block.
402 PHINode *PN = cast<PHINode>(U);
403 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
404 if (PN->getIncomingValue(i) == Inst)
405 MarkBlocksLiveIn(PN->getIncomingBlock(i), LiveBBs);
406 }
407 }
Jim Grosbach46445382009-04-17 23:30:55 +0000408
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000409 // Now that we know all of the blocks that this thing is live in, see if
410 // it includes any of the unwind locations.
411 bool NeedsSpill = false;
412 for (unsigned i = 0, e = Invokes.size(); i != e; ++i) {
413 BasicBlock *UnwindBlock = Invokes[i]->getUnwindDest();
414 if (UnwindBlock != BB && LiveBBs.count(UnwindBlock)) {
415 NeedsSpill = true;
416 }
417 }
418
419 // If we decided we need a spill, do it.
420 if (NeedsSpill) {
421 ++NumSpilled;
Owen Anderson50dead02009-07-15 23:53:25 +0000422 DemoteRegToStack(*Inst, true);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000423 }
424 }
425}
426
427bool LowerInvoke::insertExpensiveEHSupport(Function &F) {
428 std::vector<ReturnInst*> Returns;
429 std::vector<UnwindInst*> Unwinds;
430 std::vector<InvokeInst*> Invokes;
431
432 for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
433 if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
434 // Remember all return instructions in case we insert an invoke into this
435 // function.
436 Returns.push_back(RI);
437 } else if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator())) {
438 Invokes.push_back(II);
439 } else if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
440 Unwinds.push_back(UI);
441 }
442
443 if (Unwinds.empty() && Invokes.empty()) return false;
444
445 NumInvokes += Invokes.size();
446 NumUnwinds += Unwinds.size();
Jim Grosbach46445382009-04-17 23:30:55 +0000447
Chris Lattner5b3c7022005-09-27 22:44:59 +0000448 // TODO: This is not an optimal way to do this. In particular, this always
449 // inserts setjmp calls into the entries of functions with invoke instructions
450 // even though there are possibly paths through the function that do not
451 // execute any invokes. In particular, for functions with early exits, e.g.
452 // the 'addMove' method in hexxagon, it would be nice to not have to do the
453 // setjmp stuff on the early exit path. This requires a bit of dataflow, but
454 // would not be too hard to do.
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000455
456 // If we have an invoke instruction, insert a setjmp that dominates all
457 // invokes. After the setjmp, use a cond branch that goes to the original
458 // code path on zero, and to a designated 'catch' block of nonzero.
459 Value *OldJmpBufPtr = 0;
460 if (!Invokes.empty()) {
461 // First thing we need to do is scan the whole function for values that are
462 // live across unwind edges. Each value that is live across an unwind edge
463 // we spill into a stack location, guaranteeing that there is nothing live
464 // across the unwind edge. This process also splits all critical edges
465 // coming out of invoke's.
Jim Grosbach46445382009-04-17 23:30:55 +0000466 splitLiveRangesLiveAcrossInvokes(Invokes);
467
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000468 BasicBlock *EntryBB = F.begin();
Jim Grosbach46445382009-04-17 23:30:55 +0000469
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000470 // Create an alloca for the incoming jump buffer ptr and the new jump buffer
471 // that needs to be restored on all exits from the function. This is an
472 // alloca because the value needs to be live across invokes.
Chris Lattner97d2dbd2006-09-05 17:48:07 +0000473 unsigned Align = TLI ? TLI->getJumpBufAlignment() : 0;
Jim Grosbach46445382009-04-17 23:30:55 +0000474 AllocaInst *JmpBuf =
Owen Anderson50dead02009-07-15 23:53:25 +0000475 new AllocaInst(JBLinkTy, 0, Align,
Owen Anderson9adc0ab2009-07-14 23:09:55 +0000476 "jblink", F.begin()->begin());
Jim Grosbach46445382009-04-17 23:30:55 +0000477
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000478 std::vector<Value*> Idx;
Owen Anderson0a5372e2009-07-13 04:09:18 +0000479 Idx.push_back(Context->getNullValue(Type::Int32Ty));
Owen Anderson9adc0ab2009-07-14 23:09:55 +0000480 Idx.push_back(Context->getConstantInt(Type::Int32Ty, 1));
Gabor Greif051a9502008-04-06 20:25:17 +0000481 OldJmpBufPtr = GetElementPtrInst::Create(JmpBuf, Idx.begin(), Idx.end(),
Owen Anderson9adc0ab2009-07-14 23:09:55 +0000482 "OldBuf",
483 EntryBB->getTerminator());
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000484
485 // Copy the JBListHead to the alloca.
486 Value *OldBuf = new LoadInst(JBListHead, "oldjmpbufptr", true,
487 EntryBB->getTerminator());
488 new StoreInst(OldBuf, OldJmpBufPtr, true, EntryBB->getTerminator());
Jim Grosbach46445382009-04-17 23:30:55 +0000489
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000490 // Add the new jumpbuf to the list.
491 new StoreInst(JmpBuf, JBListHead, true, EntryBB->getTerminator());
492
493 // Create the catch block. The catch block is basically a big switch
494 // statement that goes to all of the invoke catch blocks.
Gabor Greif051a9502008-04-06 20:25:17 +0000495 BasicBlock *CatchBB = BasicBlock::Create("setjmp.catch", &F);
Jim Grosbach46445382009-04-17 23:30:55 +0000496
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000497 // Create an alloca which keeps track of which invoke is currently
498 // executing. For normal calls it contains zero.
Owen Anderson50dead02009-07-15 23:53:25 +0000499 AllocaInst *InvokeNum = new AllocaInst(Type::Int32Ty, 0,
Owen Anderson9adc0ab2009-07-14 23:09:55 +0000500 "invokenum",EntryBB->begin());
501 new StoreInst(Context->getConstantInt(Type::Int32Ty, 0), InvokeNum, true,
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000502 EntryBB->getTerminator());
Jim Grosbach46445382009-04-17 23:30:55 +0000503
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000504 // Insert a load in the Catch block, and a switch on its value. By default,
505 // we go to a block that just does an unwind (which is the correct action
506 // for a standard call).
Gabor Greif051a9502008-04-06 20:25:17 +0000507 BasicBlock *UnwindBB = BasicBlock::Create("unwindbb", &F);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000508 Unwinds.push_back(new UnwindInst(UnwindBB));
Jim Grosbach46445382009-04-17 23:30:55 +0000509
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000510 Value *CatchLoad = new LoadInst(InvokeNum, "invoke.num", true, CatchBB);
Gabor Greif051a9502008-04-06 20:25:17 +0000511 SwitchInst *CatchSwitch =
512 SwitchInst::Create(CatchLoad, UnwindBB, Invokes.size(), CatchBB);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000513
514 // Now that things are set up, insert the setjmp call itself.
Jim Grosbach46445382009-04-17 23:30:55 +0000515
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000516 // Split the entry block to insert the conditional branch for the setjmp.
517 BasicBlock *ContBlock = EntryBB->splitBasicBlock(EntryBB->getTerminator(),
518 "setjmp.cont");
519
Owen Anderson9adc0ab2009-07-14 23:09:55 +0000520 Idx[1] = Context->getConstantInt(Type::Int32Ty, 0);
Gabor Greif051a9502008-04-06 20:25:17 +0000521 Value *JmpBufPtr = GetElementPtrInst::Create(JmpBuf, Idx.begin(), Idx.end(),
522 "TheJmpBuf",
523 EntryBB->getTerminator());
Duncan Sandsa1220432008-04-07 13:41:19 +0000524 JmpBufPtr = new BitCastInst(JmpBufPtr, PointerType::getUnqual(Type::Int8Ty),
525 "tmp", EntryBB->getTerminator());
Gabor Greif051a9502008-04-06 20:25:17 +0000526 Value *SJRet = CallInst::Create(SetJmpFn, JmpBufPtr, "sjret",
527 EntryBB->getTerminator());
Duncan Sandsa1220432008-04-07 13:41:19 +0000528
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000529 // Compare the return value to zero.
Owen Anderson333c4002009-07-09 23:48:35 +0000530 Value *IsNormal = new ICmpInst(EntryBB->getTerminator(),
531 ICmpInst::ICMP_EQ, SJRet,
Owen Anderson0a5372e2009-07-13 04:09:18 +0000532 Context->getNullValue(SJRet->getType()),
Owen Anderson333c4002009-07-09 23:48:35 +0000533 "notunwind");
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000534 // Nuke the uncond branch.
535 EntryBB->getTerminator()->eraseFromParent();
Jim Grosbach46445382009-04-17 23:30:55 +0000536
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000537 // Put in a new condbranch in its place.
Gabor Greif051a9502008-04-06 20:25:17 +0000538 BranchInst::Create(ContBlock, CatchBB, IsNormal, EntryBB);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000539
540 // At this point, we are all set up, rewrite each invoke instruction.
541 for (unsigned i = 0, e = Invokes.size(); i != e; ++i)
542 rewriteExpensiveInvoke(Invokes[i], i+1, InvokeNum, CatchSwitch);
543 }
544
545 // We know that there is at least one unwind.
Jim Grosbach46445382009-04-17 23:30:55 +0000546
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000547 // Create three new blocks, the block to load the jmpbuf ptr and compare
548 // against null, the block to do the longjmp, and the error block for if it
549 // is null. Add them at the end of the function because they are not hot.
Gabor Greif051a9502008-04-06 20:25:17 +0000550 BasicBlock *UnwindHandler = BasicBlock::Create("dounwind", &F);
551 BasicBlock *UnwindBlock = BasicBlock::Create("unwind", &F);
552 BasicBlock *TermBlock = BasicBlock::Create("unwinderror", &F);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000553
554 // If this function contains an invoke, restore the old jumpbuf ptr.
555 Value *BufPtr;
556 if (OldJmpBufPtr) {
557 // Before the return, insert a copy from the saved value to the new value.
558 BufPtr = new LoadInst(OldJmpBufPtr, "oldjmpbufptr", UnwindHandler);
559 new StoreInst(BufPtr, JBListHead, UnwindHandler);
560 } else {
561 BufPtr = new LoadInst(JBListHead, "ehlist", UnwindHandler);
562 }
Jim Grosbach46445382009-04-17 23:30:55 +0000563
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000564 // Load the JBList, if it's null, then there was no catch!
Owen Anderson333c4002009-07-09 23:48:35 +0000565 Value *NotNull = new ICmpInst(*UnwindHandler, ICmpInst::ICMP_NE, BufPtr,
Owen Anderson0a5372e2009-07-13 04:09:18 +0000566 Context->getNullValue(BufPtr->getType()),
Owen Anderson333c4002009-07-09 23:48:35 +0000567 "notnull");
Gabor Greif051a9502008-04-06 20:25:17 +0000568 BranchInst::Create(UnwindBlock, TermBlock, NotNull, UnwindHandler);
Jim Grosbach46445382009-04-17 23:30:55 +0000569
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000570 // Create the block to do the longjmp.
571 // Get a pointer to the jmpbuf and longjmp.
572 std::vector<Value*> Idx;
Owen Anderson0a5372e2009-07-13 04:09:18 +0000573 Idx.push_back(Context->getNullValue(Type::Int32Ty));
Owen Anderson9adc0ab2009-07-14 23:09:55 +0000574 Idx.push_back(Context->getConstantInt(Type::Int32Ty, 0));
Gabor Greif051a9502008-04-06 20:25:17 +0000575 Idx[0] = GetElementPtrInst::Create(BufPtr, Idx.begin(), Idx.end(), "JmpBuf",
576 UnwindBlock);
Duncan Sandsa1220432008-04-07 13:41:19 +0000577 Idx[0] = new BitCastInst(Idx[0], PointerType::getUnqual(Type::Int8Ty),
578 "tmp", UnwindBlock);
Owen Anderson9adc0ab2009-07-14 23:09:55 +0000579 Idx[1] = Context->getConstantInt(Type::Int32Ty, 1);
Gabor Greif051a9502008-04-06 20:25:17 +0000580 CallInst::Create(LongJmpFn, Idx.begin(), Idx.end(), "", UnwindBlock);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000581 new UnreachableInst(UnwindBlock);
Jim Grosbach46445382009-04-17 23:30:55 +0000582
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000583 // Set up the term block ("throw without a catch").
584 new UnreachableInst(TermBlock);
585
586 // Insert a new call to write(2, AbortMessage, AbortMessageLength);
587 writeAbortMessage(TermBlock->getTerminator());
Jim Grosbach46445382009-04-17 23:30:55 +0000588
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000589 // Insert a call to abort()
Gabor Greif051a9502008-04-06 20:25:17 +0000590 CallInst::Create(AbortFn, "",
591 TermBlock->getTerminator())->setTailCall();
Jim Grosbach46445382009-04-17 23:30:55 +0000592
593
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000594 // Replace all unwinds with a branch to the unwind handler.
595 for (unsigned i = 0, e = Unwinds.size(); i != e; ++i) {
Gabor Greif051a9502008-04-06 20:25:17 +0000596 BranchInst::Create(UnwindHandler, Unwinds[i]);
Jim Grosbach46445382009-04-17 23:30:55 +0000597 Unwinds[i]->eraseFromParent();
598 }
599
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000600 // Finally, for any returns from this function, if this function contains an
601 // invoke, restore the old jmpbuf pointer to its input value.
602 if (OldJmpBufPtr) {
603 for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
604 ReturnInst *R = Returns[i];
Jim Grosbach46445382009-04-17 23:30:55 +0000605
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000606 // Before the return, insert a copy from the saved value to the new value.
607 Value *OldBuf = new LoadInst(OldJmpBufPtr, "oldjmpbufptr", true, R);
608 new StoreInst(OldBuf, JBListHead, true, R);
609 }
610 }
Jim Grosbach46445382009-04-17 23:30:55 +0000611
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000612 return true;
Chris Lattner6d784572004-02-08 19:53:56 +0000613}
614
615bool LowerInvoke::runOnFunction(Function &F) {
616 if (ExpensiveEHSupport)
617 return insertExpensiveEHSupport(F);
618 else
619 return insertCheapEHSupport(F);
620}