blob: f35cbbdde5e4da27e2867131a9b04a8df00ea1be [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"
Nadav Rotem725f1d12012-10-19 04:27:49 +000048#include "llvm/TargetTransformInfo.h"
Jim Grosbach601f9d62010-06-01 17:56:41 +000049#include "llvm/ADT/SmallVector.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000050#include "llvm/ADT/Statistic.h"
51#include "llvm/Support/CommandLine.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");
Chris Lattnerd216e8b2006-12-19 22:17:40 +000057STATISTIC(NumSpilled, "Number of registers live across unwind edges");
58
59static cl::opt<bool> ExpensiveEHSupport("enable-correct-eh-support",
Chris Lattner6d784572004-02-08 19:53:56 +000060 cl::desc("Make the -lowerinvoke pass insert expensive, but correct, EH code"));
Chris Lattner86e44452003-10-05 19:14:42 +000061
Chris Lattnerd216e8b2006-12-19 22:17:40 +000062namespace {
Nick Lewycky6726b6d2009-10-25 06:33:48 +000063 class LowerInvoke : public FunctionPass {
Chris Lattner6d784572004-02-08 19:53:56 +000064 // Used for both models.
Chris Lattnerb76efb72007-01-07 08:12:01 +000065 Constant *AbortFn;
Chris Lattner6d784572004-02-08 19:53:56 +000066
67 // Used for expensive EH support.
Chris Lattner1afcace2011-07-09 17:41:24 +000068 StructType *JBLinkTy;
Chris Lattner6d784572004-02-08 19:53:56 +000069 GlobalVariable *JBListHead;
Chris Lattnerc6f0aad2010-04-26 23:49:32 +000070 Constant *SetJmpFn, *LongJmpFn, *StackSaveFn, *StackRestoreFn;
71 bool useExpensiveEHSupport;
Jim Grosbach46445382009-04-17 23:30:55 +000072
Nadav Rotem725f1d12012-10-19 04:27:49 +000073 // We peek in STTI to grab the target's jmp_buf size and alignment
74 const ScalarTargetTransformInfo *STTI;
Jim Grosbach46445382009-04-17 23:30:55 +000075
Chris Lattner86e44452003-10-05 19:14:42 +000076 public:
Nick Lewyckyecd94c82007-05-06 13:37:16 +000077 static char ID; // Pass identification, replacement for typeid
Nadav Rotem725f1d12012-10-19 04:27:49 +000078 explicit LowerInvoke(bool useExpensiveEHSupport = ExpensiveEHSupport)
Owen Anderson90c579d2010-08-06 18:33:48 +000079 : FunctionPass(ID), useExpensiveEHSupport(useExpensiveEHSupport),
Nadav Rotem725f1d12012-10-19 04:27:49 +000080 STTI(0) {
Owen Anderson081c34b2010-10-19 17:21:58 +000081 initializeLowerInvokePass(*PassRegistry::getPassRegistry());
82 }
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
Dan Gohman60493c32010-08-06 21:48:06 +000088 AU.addPreserved("mem2reg");
Chris Lattnered96fe82006-05-17 21:05:27 +000089 AU.addPreservedID(LowerSwitchID);
Chris Lattnered96fe82006-05-17 21:05:27 +000090 }
Jim Grosbach46445382009-04-17 23:30:55 +000091
Chris Lattner6d784572004-02-08 19:53:56 +000092 private:
93 bool insertCheapEHSupport(Function &F);
Jim Grosbachaeafb372010-06-01 21:06:46 +000094 void splitLiveRangesLiveAcrossInvokes(SmallVectorImpl<InvokeInst*>&Invokes);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +000095 void rewriteExpensiveInvoke(InvokeInst *II, unsigned InvokeNo,
Chris Lattnerc6f0aad2010-04-26 23:49:32 +000096 AllocaInst *InvokeNum, AllocaInst *StackPtr,
97 SwitchInst *CatchSwitch);
Chris Lattner6d784572004-02-08 19:53:56 +000098 bool insertExpensiveEHSupport(Function &F);
Chris Lattner86e44452003-10-05 19:14:42 +000099 };
Chris Lattner86e44452003-10-05 19:14:42 +0000100}
101
Dan Gohman844731a2008-05-13 00:00:25 +0000102char LowerInvoke::ID = 0;
Owen Anderson02dd53e2010-08-23 17:52:01 +0000103INITIALIZE_PASS(LowerInvoke, "lowerinvoke",
104 "Lower invoke and unwind, for unwindless code generators",
Owen Andersonce665bd2010-10-07 22:25:06 +0000105 false, false)
Dan Gohman844731a2008-05-13 00:00:25 +0000106
Owen Anderson90c579d2010-08-06 18:33:48 +0000107char &llvm::LowerInvokePassID = LowerInvoke::ID;
Chris Lattnercefc18e2004-02-13 16:16:16 +0000108
Brian Gaeked0fde302003-11-11 22:41:34 +0000109// Public Interface To the LowerInvoke pass.
Nadav Rotem725f1d12012-10-19 04:27:49 +0000110FunctionPass *llvm::createLowerInvokePass() {
111 return new LowerInvoke(ExpensiveEHSupport);
Chris Lattnerc6f0aad2010-04-26 23:49:32 +0000112}
Nadav Rotem725f1d12012-10-19 04:27:49 +0000113FunctionPass *llvm::createLowerInvokePass(bool useExpensiveEHSupport) {
114 return new LowerInvoke(useExpensiveEHSupport);
Nate Begeman14b05292005-11-05 09:21:28 +0000115}
Chris Lattner86e44452003-10-05 19:14:42 +0000116
117// doInitialization - Make sure that there is a prototype for abort in the
118// current module.
119bool LowerInvoke::doInitialization(Module &M) {
Nadav Rotem725f1d12012-10-19 04:27:49 +0000120 TargetTransformInfo *TTI = getAnalysisIfAvailable<TargetTransformInfo>();
121 if (TTI)
122 STTI = TTI->getScalarTargetTransformInfo();
123
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000124 Type *VoidPtrTy = Type::getInt8PtrTy(M.getContext());
Chris Lattnerc6f0aad2010-04-26 23:49:32 +0000125 if (useExpensiveEHSupport) {
Jim Laskey7d485382007-02-22 16:21:18 +0000126 // Insert a type for the linked list of jump buffers.
Nadav Rotem725f1d12012-10-19 04:27:49 +0000127 unsigned JBSize = STTI ? STTI->getJumpBufSize() : 0;
Jim Laskey7d485382007-02-22 16:21:18 +0000128 JBSize = JBSize ? JBSize : 200;
Chris Lattner1afcace2011-07-09 17:41:24 +0000129 Type *JmpBufTy = ArrayType::get(VoidPtrTy, JBSize);
Chris Lattnere1c09302004-02-08 07:30:29 +0000130
Chris Lattner3ebb6492011-08-12 18:06:37 +0000131 JBLinkTy = StructType::create(M.getContext(), "llvm.sjljeh.jmpbufty");
Chris Lattner1afcace2011-07-09 17:41:24 +0000132 Type *Elts[] = { JmpBufTy, PointerType::getUnqual(JBLinkTy) };
133 JBLinkTy->setBody(Elts);
Chris Lattner6d784572004-02-08 19:53:56 +0000134
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000135 Type *PtrJBList = PointerType::getUnqual(JBLinkTy);
Jim Laskey7d485382007-02-22 16:21:18 +0000136
137 // Now that we've done that, insert the jmpbuf list head global, unless it
138 // already exists.
139 if (!(JBListHead = M.getGlobalVariable("llvm.sjljeh.jblist", PtrJBList))) {
Owen Andersone9b11b42009-07-08 19:03:57 +0000140 JBListHead = new GlobalVariable(M, PtrJBList, false,
Duncan Sands667d4b82009-03-07 15:45:40 +0000141 GlobalValue::LinkOnceAnyLinkage,
Owen Andersona7235ea2009-07-31 20:28:14 +0000142 Constant::getNullValue(PtrJBList),
Owen Andersone9b11b42009-07-08 19:03:57 +0000143 "llvm.sjljeh.jblist");
Jim Laskey7d485382007-02-22 16:21:18 +0000144 }
Chuck Rose IIIcc51c312008-04-15 21:27:11 +0000145
Michael J. Spencer1f409602010-09-24 19:48:47 +0000146// VisualStudio defines setjmp as _setjmp
147#if defined(_MSC_VER) && defined(setjmp) && \
148 !defined(setjmp_undefined_for_msvc)
149# pragma push_macro("setjmp")
150# undef setjmp
151# define setjmp_undefined_for_msvc
Chuck Rose IIIcc51c312008-04-15 21:27:11 +0000152#endif
153
Duncan Sandsa1220432008-04-07 13:41:19 +0000154 SetJmpFn = Intrinsic::getDeclaration(&M, Intrinsic::setjmp);
Chuck Rose IIIcc51c312008-04-15 21:27:11 +0000155
Michael J. Spencer1f409602010-09-24 19:48:47 +0000156#if defined(_MSC_VER) && defined(setjmp_undefined_for_msvc)
157 // let's return it to _setjmp state
158# pragma pop_macro("setjmp")
159# undef setjmp_undefined_for_msvc
Chuck Rose IIIcc51c312008-04-15 21:27:11 +0000160#endif
161
Duncan Sandsa1220432008-04-07 13:41:19 +0000162 LongJmpFn = Intrinsic::getDeclaration(&M, Intrinsic::longjmp);
Chris Lattnerc6f0aad2010-04-26 23:49:32 +0000163 StackSaveFn = Intrinsic::getDeclaration(&M, Intrinsic::stacksave);
164 StackRestoreFn = Intrinsic::getDeclaration(&M, Intrinsic::stackrestore);
Chris Lattner6d784572004-02-08 19:53:56 +0000165 }
Jim Laskey7d485382007-02-22 16:21:18 +0000166
167 // We need the 'write' and 'abort' functions for both models.
Owen Anderson1d0be152009-08-13 21:58:54 +0000168 AbortFn = M.getOrInsertFunction("abort", Type::getVoidTy(M.getContext()),
169 (Type *)0);
Chris Lattner86e44452003-10-05 19:14:42 +0000170 return true;
171}
172
Chris Lattner6d784572004-02-08 19:53:56 +0000173bool LowerInvoke::insertCheapEHSupport(Function &F) {
Chris Lattner86e44452003-10-05 19:14:42 +0000174 bool Changed = false;
Chris Lattnerdead9932003-12-10 20:22:42 +0000175 for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
176 if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator())) {
Jim Grosbach601f9d62010-06-01 17:56:41 +0000177 SmallVector<Value*,16> CallArgs(II->op_begin(), II->op_end() - 3);
Chris Lattner86e44452003-10-05 19:14:42 +0000178 // Insert a normal call instruction...
Gabor Greif051a9502008-04-06 20:25:17 +0000179 CallInst *NewCall = CallInst::Create(II->getCalledValue(),
Jay Foada3efbb12011-07-15 08:37:34 +0000180 CallArgs, "", II);
Chris Lattner86cc4232007-02-11 01:37:51 +0000181 NewCall->takeName(II);
Chris Lattnerefd91682005-05-13 06:27:02 +0000182 NewCall->setCallingConv(II->getCallingConv());
Devang Patel05988662008-09-25 21:00:45 +0000183 NewCall->setAttributes(II->getAttributes());
Devang Patel3bcb3a62010-10-18 18:53:44 +0000184 NewCall->setDebugLoc(II->getDebugLoc());
Chris Lattner86e44452003-10-05 19:14:42 +0000185 II->replaceAllUsesWith(NewCall);
Misha Brukmanfd939082005-04-21 23:48:37 +0000186
Chris Lattnerdead9932003-12-10 20:22:42 +0000187 // Insert an unconditional branch to the normal destination.
Gabor Greif051a9502008-04-06 20:25:17 +0000188 BranchInst::Create(II->getNormalDest(), II);
Chris Lattner86e44452003-10-05 19:14:42 +0000189
Chris Lattnerdead9932003-12-10 20:22:42 +0000190 // Remove any PHI node entries from the exception destination.
Chris Lattneraeb2a1d2004-02-08 21:44:31 +0000191 II->getUnwindDest()->removePredecessor(BB);
Chris Lattnerdead9932003-12-10 20:22:42 +0000192
Chris Lattner86e44452003-10-05 19:14:42 +0000193 // Remove the invoke instruction now.
Chris Lattnerdead9932003-12-10 20:22:42 +0000194 BB->getInstList().erase(II);
Chris Lattner86e44452003-10-05 19:14:42 +0000195
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000196 ++NumInvokes; Changed = true;
Chris Lattner86e44452003-10-05 19:14:42 +0000197 }
198 return Changed;
199}
Chris Lattner6d784572004-02-08 19:53:56 +0000200
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000201/// rewriteExpensiveInvoke - Insert code and hack the function to replace the
202/// specified invoke instruction with a call.
203void LowerInvoke::rewriteExpensiveInvoke(InvokeInst *II, unsigned InvokeNo,
204 AllocaInst *InvokeNum,
Chris Lattnerc6f0aad2010-04-26 23:49:32 +0000205 AllocaInst *StackPtr,
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000206 SwitchInst *CatchSwitch) {
Owen Anderson1d0be152009-08-13 21:58:54 +0000207 ConstantInt *InvokeNoC = ConstantInt::get(Type::getInt32Ty(II->getContext()),
208 InvokeNo);
Chris Lattner6d784572004-02-08 19:53:56 +0000209
Chris Lattner8c5c22f2008-02-14 19:18:13 +0000210 // If the unwind edge has phi nodes, split the edge.
211 if (isa<PHINode>(II->getUnwindDest()->begin())) {
212 SplitCriticalEdge(II, 1, this);
Jim Grosbach46445382009-04-17 23:30:55 +0000213
Chris Lattner8c5c22f2008-02-14 19:18:13 +0000214 // If there are any phi nodes left, they must have a single predecessor.
215 while (PHINode *PN = dyn_cast<PHINode>(II->getUnwindDest()->begin())) {
216 PN->replaceAllUsesWith(PN->getIncomingValue(0));
217 PN->eraseFromParent();
218 }
219 }
Jim Grosbach46445382009-04-17 23:30:55 +0000220
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000221 // Insert a store of the invoke num before the invoke and store zero into the
222 // location afterward.
223 new StoreInst(InvokeNoC, InvokeNum, true, II); // volatile
Chris Lattnerc6f0aad2010-04-26 23:49:32 +0000224
225 // Insert a store of the stack ptr before the invoke, so we can restore it
226 // later in the exception case.
227 CallInst* StackSaveRet = CallInst::Create(StackSaveFn, "ssret", II);
228 new StoreInst(StackSaveRet, StackPtr, true, II); // volatile
Jim Grosbach46445382009-04-17 23:30:55 +0000229
Bill Wendling89d44112011-08-25 01:08:34 +0000230 BasicBlock::iterator NI = II->getNormalDest()->getFirstInsertionPt();
Chris Lattner93e50ce2005-09-29 17:44:20 +0000231 // nonvolatile.
Owen Anderson1d0be152009-08-13 21:58:54 +0000232 new StoreInst(Constant::getNullValue(Type::getInt32Ty(II->getContext())),
233 InvokeNum, false, NI);
Jim Grosbach46445382009-04-17 23:30:55 +0000234
Bill Wendling89d44112011-08-25 01:08:34 +0000235 Instruction* StackPtrLoad =
236 new LoadInst(StackPtr, "stackptr.restore", true,
237 II->getUnwindDest()->getFirstInsertionPt());
Chris Lattnerc6f0aad2010-04-26 23:49:32 +0000238 CallInst::Create(StackRestoreFn, StackPtrLoad, "")->insertAfter(StackPtrLoad);
239
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000240 // Add a switch case to our unwind block.
241 CatchSwitch->addCase(InvokeNoC, II->getUnwindDest());
Jim Grosbach46445382009-04-17 23:30:55 +0000242
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000243 // Insert a normal call instruction.
Jim Grosbach601f9d62010-06-01 17:56:41 +0000244 SmallVector<Value*,16> CallArgs(II->op_begin(), II->op_end() - 3);
Gabor Greif051a9502008-04-06 20:25:17 +0000245 CallInst *NewCall = CallInst::Create(II->getCalledValue(),
Jay Foada3efbb12011-07-15 08:37:34 +0000246 CallArgs, "", II);
Chris Lattner86cc4232007-02-11 01:37:51 +0000247 NewCall->takeName(II);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000248 NewCall->setCallingConv(II->getCallingConv());
Devang Patel05988662008-09-25 21:00:45 +0000249 NewCall->setAttributes(II->getAttributes());
Devang Patel3bcb3a62010-10-18 18:53:44 +0000250 NewCall->setDebugLoc(II->getDebugLoc());
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000251 II->replaceAllUsesWith(NewCall);
Jim Grosbach46445382009-04-17 23:30:55 +0000252
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000253 // Replace the invoke with an uncond branch.
Gabor Greif051a9502008-04-06 20:25:17 +0000254 BranchInst::Create(II->getNormalDest(), NewCall->getParent());
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000255 II->eraseFromParent();
256}
Chris Lattner6d784572004-02-08 19:53:56 +0000257
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000258/// MarkBlocksLiveIn - Insert BB and all of its predescessors into LiveBBs until
259/// we reach blocks we've already seen.
260static void MarkBlocksLiveIn(BasicBlock *BB, std::set<BasicBlock*> &LiveBBs) {
261 if (!LiveBBs.insert(BB).second) return; // already been here.
Jim Grosbach46445382009-04-17 23:30:55 +0000262
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000263 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
Jim Grosbach46445382009-04-17 23:30:55 +0000264 MarkBlocksLiveIn(*PI, LiveBBs);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000265}
Chris Lattner6d784572004-02-08 19:53:56 +0000266
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000267// First thing we need to do is scan the whole function for values that are
268// live across unwind edges. Each value that is live across an unwind edge
269// we spill into a stack location, guaranteeing that there is nothing live
270// across the unwind edge. This process also splits all critical edges
271// coming out of invoke's.
272void LowerInvoke::
Jim Grosbachaeafb372010-06-01 21:06:46 +0000273splitLiveRangesLiveAcrossInvokes(SmallVectorImpl<InvokeInst*> &Invokes) {
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000274 // First step, split all critical edges from invoke instructions.
275 for (unsigned i = 0, e = Invokes.size(); i != e; ++i) {
276 InvokeInst *II = Invokes[i];
277 SplitCriticalEdge(II, 0, this);
278 SplitCriticalEdge(II, 1, this);
279 assert(!isa<PHINode>(II->getNormalDest()) &&
280 !isa<PHINode>(II->getUnwindDest()) &&
281 "critical edge splitting left single entry phi nodes?");
Chris Lattner6d784572004-02-08 19:53:56 +0000282 }
283
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000284 Function *F = Invokes.back()->getParent()->getParent();
Jim Grosbach46445382009-04-17 23:30:55 +0000285
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000286 // To avoid having to handle incoming arguments specially, we lower each arg
Reid Spencer3da59db2006-11-27 01:05:10 +0000287 // to a copy instruction in the entry block. This ensures that the argument
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000288 // value itself cannot be live across the entry block.
289 BasicBlock::iterator AfterAllocaInsertPt = F->begin()->begin();
290 while (isa<AllocaInst>(AfterAllocaInsertPt) &&
291 isa<ConstantInt>(cast<AllocaInst>(AfterAllocaInsertPt)->getArraySize()))
292 ++AfterAllocaInsertPt;
293 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end();
294 AI != E; ++AI) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000295 Type *Ty = AI->getType();
Jim Grosbach7fa1bba2010-06-30 22:22:59 +0000296 // Aggregate types can't be cast, but are legal argument types, so we have
Jim Grosbach0fd8b622010-06-01 18:04:56 +0000297 // to handle them differently. We use an extract/insert pair as a
298 // lightweight method to achieve the same goal.
Jim Grosbach7fa1bba2010-06-30 22:22:59 +0000299 if (isa<StructType>(Ty) || isa<ArrayType>(Ty) || isa<VectorType>(Ty)) {
300 Instruction *EI = ExtractValueInst::Create(AI, 0, "",AfterAllocaInsertPt);
Jim Grosbach0fd8b622010-06-01 18:04:56 +0000301 Instruction *NI = InsertValueInst::Create(AI, EI, 0);
302 NI->insertAfter(EI);
303 AI->replaceAllUsesWith(NI);
Jim Grosbach7fa1bba2010-06-30 22:22:59 +0000304 // Set the operand of the instructions back to the AllocaInst.
Jim Grosbach0fd8b622010-06-01 18:04:56 +0000305 EI->setOperand(0, AI);
306 NI->setOperand(0, AI);
307 } else {
308 // This is always a no-op cast because we're casting AI to AI->getType()
309 // so src and destination types are identical. BitCast is the only
310 // possibility.
311 CastInst *NC = new BitCastInst(
312 AI, AI->getType(), AI->getName()+".tmp", AfterAllocaInsertPt);
313 AI->replaceAllUsesWith(NC);
314 // Set the operand of the cast instruction back to the AllocaInst.
315 // Normally it's forbidden to replace a CastInst's operand because it
316 // could cause the opcode to reflect an illegal conversion. However,
317 // we're replacing it here with the same value it was constructed with.
318 // We do this because the above replaceAllUsesWith() clobbered the
319 // operand, but we want this one to remain.
320 NC->setOperand(0, AI);
321 }
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000322 }
Jim Grosbach46445382009-04-17 23:30:55 +0000323
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000324 // Finally, scan the code looking for instructions with bad live ranges.
325 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
326 for (BasicBlock::iterator II = BB->begin(), E = BB->end(); II != E; ++II) {
327 // Ignore obvious cases we don't have to handle. In particular, most
328 // instructions either have no uses or only have a single use inside the
329 // current block. Ignore them quickly.
330 Instruction *Inst = II;
331 if (Inst->use_empty()) continue;
332 if (Inst->hasOneUse() &&
333 cast<Instruction>(Inst->use_back())->getParent() == BB &&
334 !isa<PHINode>(Inst->use_back())) continue;
Jim Grosbach46445382009-04-17 23:30:55 +0000335
Chris Lattner45313712005-09-27 21:33:12 +0000336 // If this is an alloca in the entry block, it's not a real register
337 // value.
338 if (AllocaInst *AI = dyn_cast<AllocaInst>(Inst))
339 if (isa<ConstantInt>(AI->getArraySize()) && BB == F->begin())
340 continue;
Jim Grosbach46445382009-04-17 23:30:55 +0000341
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000342 // Avoid iterator invalidation by copying users to a temporary vector.
Jim Grosbach601f9d62010-06-01 17:56:41 +0000343 SmallVector<Instruction*,16> Users;
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000344 for (Value::use_iterator UI = Inst->use_begin(), E = Inst->use_end();
345 UI != E; ++UI) {
346 Instruction *User = cast<Instruction>(*UI);
347 if (User->getParent() != BB || isa<PHINode>(User))
348 Users.push_back(User);
349 }
350
351 // Scan all of the uses and see if the live range is live across an unwind
352 // edge. If we find a use live across an invoke edge, create an alloca
353 // and spill the value.
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000354 std::set<InvokeInst*> InvokesWithStoreInserted;
355
356 // Find all of the blocks that this value is live in.
357 std::set<BasicBlock*> LiveBBs;
358 LiveBBs.insert(Inst->getParent());
359 while (!Users.empty()) {
360 Instruction *U = Users.back();
361 Users.pop_back();
Jim Grosbach46445382009-04-17 23:30:55 +0000362
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000363 if (!isa<PHINode>(U)) {
364 MarkBlocksLiveIn(U->getParent(), LiveBBs);
365 } else {
366 // Uses for a PHI node occur in their predecessor block.
367 PHINode *PN = cast<PHINode>(U);
368 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
369 if (PN->getIncomingValue(i) == Inst)
370 MarkBlocksLiveIn(PN->getIncomingBlock(i), LiveBBs);
371 }
372 }
Jim Grosbach46445382009-04-17 23:30:55 +0000373
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000374 // Now that we know all of the blocks that this thing is live in, see if
375 // it includes any of the unwind locations.
376 bool NeedsSpill = false;
377 for (unsigned i = 0, e = Invokes.size(); i != e; ++i) {
378 BasicBlock *UnwindBlock = Invokes[i]->getUnwindDest();
379 if (UnwindBlock != BB && LiveBBs.count(UnwindBlock)) {
380 NeedsSpill = true;
381 }
382 }
383
384 // If we decided we need a spill, do it.
385 if (NeedsSpill) {
386 ++NumSpilled;
Owen Anderson50dead02009-07-15 23:53:25 +0000387 DemoteRegToStack(*Inst, true);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000388 }
389 }
390}
391
392bool LowerInvoke::insertExpensiveEHSupport(Function &F) {
Jim Grosbach601f9d62010-06-01 17:56:41 +0000393 SmallVector<ReturnInst*,16> Returns;
Jim Grosbach601f9d62010-06-01 17:56:41 +0000394 SmallVector<InvokeInst*,16> Invokes;
Bill Wendling8d676c22011-08-09 01:17:10 +0000395 UnreachableInst* UnreachablePlaceholder = 0;
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000396
397 for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
398 if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
399 // Remember all return instructions in case we insert an invoke into this
400 // function.
401 Returns.push_back(RI);
402 } else if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator())) {
403 Invokes.push_back(II);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000404 }
405
Bill Wendlingaa5abe82012-02-06 21:16:41 +0000406 if (Invokes.empty()) return false;
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000407
408 NumInvokes += Invokes.size();
Jim Grosbach46445382009-04-17 23:30:55 +0000409
Chris Lattner5b3c7022005-09-27 22:44:59 +0000410 // TODO: This is not an optimal way to do this. In particular, this always
411 // inserts setjmp calls into the entries of functions with invoke instructions
412 // even though there are possibly paths through the function that do not
413 // execute any invokes. In particular, for functions with early exits, e.g.
414 // the 'addMove' method in hexxagon, it would be nice to not have to do the
415 // setjmp stuff on the early exit path. This requires a bit of dataflow, but
416 // would not be too hard to do.
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000417
418 // If we have an invoke instruction, insert a setjmp that dominates all
419 // invokes. After the setjmp, use a cond branch that goes to the original
420 // code path on zero, and to a designated 'catch' block of nonzero.
421 Value *OldJmpBufPtr = 0;
422 if (!Invokes.empty()) {
423 // First thing we need to do is scan the whole function for values that are
424 // live across unwind edges. Each value that is live across an unwind edge
425 // we spill into a stack location, guaranteeing that there is nothing live
426 // across the unwind edge. This process also splits all critical edges
427 // coming out of invoke's.
Jim Grosbach46445382009-04-17 23:30:55 +0000428 splitLiveRangesLiveAcrossInvokes(Invokes);
429
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000430 BasicBlock *EntryBB = F.begin();
Jim Grosbach46445382009-04-17 23:30:55 +0000431
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000432 // Create an alloca for the incoming jump buffer ptr and the new jump buffer
433 // that needs to be restored on all exits from the function. This is an
434 // alloca because the value needs to be live across invokes.
Nadav Rotem725f1d12012-10-19 04:27:49 +0000435 unsigned Align = STTI ? STTI->getJumpBufAlignment() : 0;
Jim Grosbach46445382009-04-17 23:30:55 +0000436 AllocaInst *JmpBuf =
Owen Anderson50dead02009-07-15 23:53:25 +0000437 new AllocaInst(JBLinkTy, 0, Align,
Owen Anderson9adc0ab2009-07-14 23:09:55 +0000438 "jblink", F.begin()->begin());
Jim Grosbach46445382009-04-17 23:30:55 +0000439
Jim Grosbachaeafb372010-06-01 21:06:46 +0000440 Value *Idx[] = { Constant::getNullValue(Type::getInt32Ty(F.getContext())),
441 ConstantInt::get(Type::getInt32Ty(F.getContext()), 1) };
Jay Foada9203102011-07-25 09:48:08 +0000442 OldJmpBufPtr = GetElementPtrInst::Create(JmpBuf, Idx, "OldBuf",
Jim Grosbachaeafb372010-06-01 21:06:46 +0000443 EntryBB->getTerminator());
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000444
445 // Copy the JBListHead to the alloca.
446 Value *OldBuf = new LoadInst(JBListHead, "oldjmpbufptr", true,
447 EntryBB->getTerminator());
448 new StoreInst(OldBuf, OldJmpBufPtr, true, EntryBB->getTerminator());
Jim Grosbach46445382009-04-17 23:30:55 +0000449
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000450 // Add the new jumpbuf to the list.
451 new StoreInst(JmpBuf, JBListHead, true, EntryBB->getTerminator());
452
453 // Create the catch block. The catch block is basically a big switch
454 // statement that goes to all of the invoke catch blocks.
Owen Anderson1d0be152009-08-13 21:58:54 +0000455 BasicBlock *CatchBB =
456 BasicBlock::Create(F.getContext(), "setjmp.catch", &F);
Jim Grosbach46445382009-04-17 23:30:55 +0000457
Chris Lattnerc6f0aad2010-04-26 23:49:32 +0000458 // Create an alloca which keeps track of the stack pointer before every
459 // invoke, this allows us to properly restore the stack pointer after
460 // long jumping.
461 AllocaInst *StackPtr = new AllocaInst(Type::getInt8PtrTy(F.getContext()), 0,
462 "stackptr", EntryBB->begin());
463
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000464 // Create an alloca which keeps track of which invoke is currently
465 // executing. For normal calls it contains zero.
Owen Anderson1d0be152009-08-13 21:58:54 +0000466 AllocaInst *InvokeNum = new AllocaInst(Type::getInt32Ty(F.getContext()), 0,
Owen Anderson9adc0ab2009-07-14 23:09:55 +0000467 "invokenum",EntryBB->begin());
Owen Anderson1d0be152009-08-13 21:58:54 +0000468 new StoreInst(ConstantInt::get(Type::getInt32Ty(F.getContext()), 0),
469 InvokeNum, true, EntryBB->getTerminator());
Jim Grosbach46445382009-04-17 23:30:55 +0000470
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000471 // Insert a load in the Catch block, and a switch on its value. By default,
472 // we go to a block that just does an unwind (which is the correct action
Bill Wendling4fa93b72011-08-09 01:09:21 +0000473 // for a standard call). We insert an unreachable instruction here and
474 // modify the block to jump to the correct unwinding pad later.
Owen Anderson1d0be152009-08-13 21:58:54 +0000475 BasicBlock *UnwindBB = BasicBlock::Create(F.getContext(), "unwindbb", &F);
Bill Wendling8d676c22011-08-09 01:17:10 +0000476 UnreachablePlaceholder = new UnreachableInst(F.getContext(), UnwindBB);
Jim Grosbach46445382009-04-17 23:30:55 +0000477
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000478 Value *CatchLoad = new LoadInst(InvokeNum, "invoke.num", true, CatchBB);
Gabor Greif051a9502008-04-06 20:25:17 +0000479 SwitchInst *CatchSwitch =
480 SwitchInst::Create(CatchLoad, UnwindBB, Invokes.size(), CatchBB);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000481
482 // Now that things are set up, insert the setjmp call itself.
Jim Grosbach46445382009-04-17 23:30:55 +0000483
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000484 // Split the entry block to insert the conditional branch for the setjmp.
485 BasicBlock *ContBlock = EntryBB->splitBasicBlock(EntryBB->getTerminator(),
486 "setjmp.cont");
487
Owen Anderson1d0be152009-08-13 21:58:54 +0000488 Idx[1] = ConstantInt::get(Type::getInt32Ty(F.getContext()), 0);
Jay Foada9203102011-07-25 09:48:08 +0000489 Value *JmpBufPtr = GetElementPtrInst::Create(JmpBuf, Idx, "TheJmpBuf",
Gabor Greif051a9502008-04-06 20:25:17 +0000490 EntryBB->getTerminator());
Owen Anderson1d0be152009-08-13 21:58:54 +0000491 JmpBufPtr = new BitCastInst(JmpBufPtr,
Duncan Sandsac53a0b2009-10-06 15:40:36 +0000492 Type::getInt8PtrTy(F.getContext()),
Duncan Sandsa1220432008-04-07 13:41:19 +0000493 "tmp", EntryBB->getTerminator());
Gabor Greif051a9502008-04-06 20:25:17 +0000494 Value *SJRet = CallInst::Create(SetJmpFn, JmpBufPtr, "sjret",
495 EntryBB->getTerminator());
Duncan Sandsa1220432008-04-07 13:41:19 +0000496
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000497 // Compare the return value to zero.
Owen Anderson333c4002009-07-09 23:48:35 +0000498 Value *IsNormal = new ICmpInst(EntryBB->getTerminator(),
499 ICmpInst::ICMP_EQ, SJRet,
Owen Andersona7235ea2009-07-31 20:28:14 +0000500 Constant::getNullValue(SJRet->getType()),
Owen Anderson333c4002009-07-09 23:48:35 +0000501 "notunwind");
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000502 // Nuke the uncond branch.
503 EntryBB->getTerminator()->eraseFromParent();
Jim Grosbach46445382009-04-17 23:30:55 +0000504
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000505 // Put in a new condbranch in its place.
Gabor Greif051a9502008-04-06 20:25:17 +0000506 BranchInst::Create(ContBlock, CatchBB, IsNormal, EntryBB);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000507
508 // At this point, we are all set up, rewrite each invoke instruction.
509 for (unsigned i = 0, e = Invokes.size(); i != e; ++i)
Chris Lattnerc6f0aad2010-04-26 23:49:32 +0000510 rewriteExpensiveInvoke(Invokes[i], i+1, InvokeNum, StackPtr, CatchSwitch);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000511 }
512
513 // We know that there is at least one unwind.
Jim Grosbach46445382009-04-17 23:30:55 +0000514
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000515 // Create three new blocks, the block to load the jmpbuf ptr and compare
516 // against null, the block to do the longjmp, and the error block for if it
517 // is null. Add them at the end of the function because they are not hot.
Owen Anderson1d0be152009-08-13 21:58:54 +0000518 BasicBlock *UnwindHandler = BasicBlock::Create(F.getContext(),
519 "dounwind", &F);
520 BasicBlock *UnwindBlock = BasicBlock::Create(F.getContext(), "unwind", &F);
521 BasicBlock *TermBlock = BasicBlock::Create(F.getContext(), "unwinderror", &F);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000522
523 // If this function contains an invoke, restore the old jumpbuf ptr.
524 Value *BufPtr;
525 if (OldJmpBufPtr) {
526 // Before the return, insert a copy from the saved value to the new value.
527 BufPtr = new LoadInst(OldJmpBufPtr, "oldjmpbufptr", UnwindHandler);
528 new StoreInst(BufPtr, JBListHead, UnwindHandler);
529 } else {
530 BufPtr = new LoadInst(JBListHead, "ehlist", UnwindHandler);
531 }
Jim Grosbach46445382009-04-17 23:30:55 +0000532
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000533 // Load the JBList, if it's null, then there was no catch!
Owen Anderson333c4002009-07-09 23:48:35 +0000534 Value *NotNull = new ICmpInst(*UnwindHandler, ICmpInst::ICMP_NE, BufPtr,
Owen Andersona7235ea2009-07-31 20:28:14 +0000535 Constant::getNullValue(BufPtr->getType()),
Owen Anderson333c4002009-07-09 23:48:35 +0000536 "notnull");
Gabor Greif051a9502008-04-06 20:25:17 +0000537 BranchInst::Create(UnwindBlock, TermBlock, NotNull, UnwindHandler);
Jim Grosbach46445382009-04-17 23:30:55 +0000538
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000539 // Create the block to do the longjmp.
540 // Get a pointer to the jmpbuf and longjmp.
Jim Grosbachaeafb372010-06-01 21:06:46 +0000541 Value *Idx[] = { Constant::getNullValue(Type::getInt32Ty(F.getContext())),
542 ConstantInt::get(Type::getInt32Ty(F.getContext()), 0) };
Jay Foada9203102011-07-25 09:48:08 +0000543 Idx[0] = GetElementPtrInst::Create(BufPtr, Idx, "JmpBuf", UnwindBlock);
Owen Anderson1d0be152009-08-13 21:58:54 +0000544 Idx[0] = new BitCastInst(Idx[0],
Duncan Sandsac53a0b2009-10-06 15:40:36 +0000545 Type::getInt8PtrTy(F.getContext()),
Duncan Sandsa1220432008-04-07 13:41:19 +0000546 "tmp", UnwindBlock);
Owen Anderson1d0be152009-08-13 21:58:54 +0000547 Idx[1] = ConstantInt::get(Type::getInt32Ty(F.getContext()), 1);
Jay Foada3efbb12011-07-15 08:37:34 +0000548 CallInst::Create(LongJmpFn, Idx, "", UnwindBlock);
Owen Anderson1d0be152009-08-13 21:58:54 +0000549 new UnreachableInst(F.getContext(), UnwindBlock);
Jim Grosbach46445382009-04-17 23:30:55 +0000550
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000551 // Set up the term block ("throw without a catch").
Owen Anderson1d0be152009-08-13 21:58:54 +0000552 new UnreachableInst(F.getContext(), TermBlock);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000553
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000554 // Insert a call to abort()
Gabor Greif051a9502008-04-06 20:25:17 +0000555 CallInst::Create(AbortFn, "",
556 TermBlock->getTerminator())->setTailCall();
Jim Grosbach46445382009-04-17 23:30:55 +0000557
Bill Wendling8d676c22011-08-09 01:17:10 +0000558 // Replace the inserted unreachable with a branch to the unwind handler.
559 if (UnreachablePlaceholder) {
560 BranchInst::Create(UnwindHandler, UnreachablePlaceholder);
561 UnreachablePlaceholder->eraseFromParent();
Bill Wendling4fa93b72011-08-09 01:09:21 +0000562 }
563
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000564 // Finally, for any returns from this function, if this function contains an
565 // invoke, restore the old jmpbuf pointer to its input value.
566 if (OldJmpBufPtr) {
567 for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
568 ReturnInst *R = Returns[i];
Jim Grosbach46445382009-04-17 23:30:55 +0000569
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000570 // Before the return, insert a copy from the saved value to the new value.
571 Value *OldBuf = new LoadInst(OldJmpBufPtr, "oldjmpbufptr", true, R);
572 new StoreInst(OldBuf, JBListHead, true, R);
573 }
574 }
Jim Grosbach46445382009-04-17 23:30:55 +0000575
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000576 return true;
Chris Lattner6d784572004-02-08 19:53:56 +0000577}
578
579bool LowerInvoke::runOnFunction(Function &F) {
Nadav Rotem725f1d12012-10-19 04:27:49 +0000580 TargetTransformInfo *TTI = getAnalysisIfAvailable<TargetTransformInfo>();
581 if (TTI)
582 STTI = TTI->getScalarTargetTransformInfo();
583
Chris Lattnerc6f0aad2010-04-26 23:49:32 +0000584 if (useExpensiveEHSupport)
Chris Lattner6d784572004-02-08 19:53:56 +0000585 return insertExpensiveEHSupport(F);
586 else
587 return insertCheapEHSupport(F);
588}