Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 1 | //===- LowerInvoke.cpp - Eliminate Invoke & Unwind instructions -----------===// |
Misha Brukman | fd93908 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 2 | // |
John Criswell | b576c94 | 2003-10-20 19:43:21 +0000 | [diff] [blame] | 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
Chris Lattner | 4ee451d | 2007-12-29 20:36:04 +0000 | [diff] [blame] | 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
Misha Brukman | fd93908 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 7 | // |
John Criswell | b576c94 | 2003-10-20 19:43:21 +0000 | [diff] [blame] | 8 | //===----------------------------------------------------------------------===// |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 9 | // |
| 10 | // This transformation is designed for use by code generators which do not yet |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 11 | // 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 Criswell | fe3706a | 2005-05-02 14:47:42 +0000 | [diff] [blame] | 21 | // 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 Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 24 | // |
| 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 Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 28 | // |
Chris Lattner | 0e28eca | 2004-03-31 22:00:30 +0000 | [diff] [blame] | 29 | // 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 Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 35 | //===----------------------------------------------------------------------===// |
| 36 | |
Chris Lattner | d216e8b | 2006-12-19 22:17:40 +0000 | [diff] [blame] | 37 | #define DEBUG_TYPE "lowerinvoke" |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 38 | #include "llvm/Transforms/Scalar.h" |
Chris Lattner | e1c0930 | 2004-02-08 07:30:29 +0000 | [diff] [blame] | 39 | #include "llvm/Constants.h" |
| 40 | #include "llvm/DerivedTypes.h" |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 41 | #include "llvm/Instructions.h" |
Duncan Sands | a122043 | 2008-04-07 13:41:19 +0000 | [diff] [blame] | 42 | #include "llvm/Intrinsics.h" |
Owen Anderson | 0a205a4 | 2009-07-05 22:41:43 +0000 | [diff] [blame] | 43 | #include "llvm/LLVMContext.h" |
Chris Lattner | e1c0930 | 2004-02-08 07:30:29 +0000 | [diff] [blame] | 44 | #include "llvm/Module.h" |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 45 | #include "llvm/Pass.h" |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 46 | #include "llvm/Transforms/Utils/BasicBlockUtils.h" |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 47 | #include "llvm/Transforms/Utils/Local.h" |
Nadav Rotem | 725f1d1 | 2012-10-19 04:27:49 +0000 | [diff] [blame] | 48 | #include "llvm/TargetTransformInfo.h" |
Jim Grosbach | 601f9d6 | 2010-06-01 17:56:41 +0000 | [diff] [blame] | 49 | #include "llvm/ADT/SmallVector.h" |
Reid Spencer | 551ccae | 2004-09-01 22:55:40 +0000 | [diff] [blame] | 50 | #include "llvm/ADT/Statistic.h" |
| 51 | #include "llvm/Support/CommandLine.h" |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 52 | #include <csetjmp> |
Reid Spencer | 6734b57 | 2007-02-04 00:40:42 +0000 | [diff] [blame] | 53 | #include <set> |
Chris Lattner | dead993 | 2003-12-10 20:22:42 +0000 | [diff] [blame] | 54 | using namespace llvm; |
Brian Gaeke | d0fde30 | 2003-11-11 22:41:34 +0000 | [diff] [blame] | 55 | |
Chris Lattner | d216e8b | 2006-12-19 22:17:40 +0000 | [diff] [blame] | 56 | STATISTIC(NumInvokes, "Number of invokes replaced"); |
Chris Lattner | d216e8b | 2006-12-19 22:17:40 +0000 | [diff] [blame] | 57 | STATISTIC(NumSpilled, "Number of registers live across unwind edges"); |
| 58 | |
| 59 | static cl::opt<bool> ExpensiveEHSupport("enable-correct-eh-support", |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 60 | cl::desc("Make the -lowerinvoke pass insert expensive, but correct, EH code")); |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 61 | |
Chris Lattner | d216e8b | 2006-12-19 22:17:40 +0000 | [diff] [blame] | 62 | namespace { |
Nick Lewycky | 6726b6d | 2009-10-25 06:33:48 +0000 | [diff] [blame] | 63 | class LowerInvoke : public FunctionPass { |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 64 | // Used for both models. |
Chris Lattner | b76efb7 | 2007-01-07 08:12:01 +0000 | [diff] [blame] | 65 | Constant *AbortFn; |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 66 | |
| 67 | // Used for expensive EH support. |
Chris Lattner | 1afcace | 2011-07-09 17:41:24 +0000 | [diff] [blame] | 68 | StructType *JBLinkTy; |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 69 | GlobalVariable *JBListHead; |
Chris Lattner | c6f0aad | 2010-04-26 23:49:32 +0000 | [diff] [blame] | 70 | Constant *SetJmpFn, *LongJmpFn, *StackSaveFn, *StackRestoreFn; |
| 71 | bool useExpensiveEHSupport; |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 72 | |
Nadav Rotem | 725f1d1 | 2012-10-19 04:27:49 +0000 | [diff] [blame] | 73 | // We peek in STTI to grab the target's jmp_buf size and alignment |
| 74 | const ScalarTargetTransformInfo *STTI; |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 75 | |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 76 | public: |
Nick Lewycky | ecd94c8 | 2007-05-06 13:37:16 +0000 | [diff] [blame] | 77 | static char ID; // Pass identification, replacement for typeid |
Nadav Rotem | 725f1d1 | 2012-10-19 04:27:49 +0000 | [diff] [blame] | 78 | explicit LowerInvoke(bool useExpensiveEHSupport = ExpensiveEHSupport) |
Owen Anderson | 90c579d | 2010-08-06 18:33:48 +0000 | [diff] [blame] | 79 | : FunctionPass(ID), useExpensiveEHSupport(useExpensiveEHSupport), |
Nadav Rotem | 725f1d1 | 2012-10-19 04:27:49 +0000 | [diff] [blame] | 80 | STTI(0) { |
Owen Anderson | 081c34b | 2010-10-19 17:21:58 +0000 | [diff] [blame] | 81 | initializeLowerInvokePass(*PassRegistry::getPassRegistry()); |
| 82 | } |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 83 | bool doInitialization(Module &M); |
| 84 | bool runOnFunction(Function &F); |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 85 | |
Chris Lattner | ed96fe8 | 2006-05-17 21:05:27 +0000 | [diff] [blame] | 86 | virtual void getAnalysisUsage(AnalysisUsage &AU) const { |
Anton Korobeynikov | bed2946 | 2007-04-16 18:10:23 +0000 | [diff] [blame] | 87 | // This is a cluster of orthogonal Transforms |
Dan Gohman | 60493c3 | 2010-08-06 21:48:06 +0000 | [diff] [blame] | 88 | AU.addPreserved("mem2reg"); |
Chris Lattner | ed96fe8 | 2006-05-17 21:05:27 +0000 | [diff] [blame] | 89 | AU.addPreservedID(LowerSwitchID); |
Chris Lattner | ed96fe8 | 2006-05-17 21:05:27 +0000 | [diff] [blame] | 90 | } |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 91 | |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 92 | private: |
| 93 | bool insertCheapEHSupport(Function &F); |
Jim Grosbach | aeafb37 | 2010-06-01 21:06:46 +0000 | [diff] [blame] | 94 | void splitLiveRangesLiveAcrossInvokes(SmallVectorImpl<InvokeInst*>&Invokes); |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 95 | void rewriteExpensiveInvoke(InvokeInst *II, unsigned InvokeNo, |
Chris Lattner | c6f0aad | 2010-04-26 23:49:32 +0000 | [diff] [blame] | 96 | AllocaInst *InvokeNum, AllocaInst *StackPtr, |
| 97 | SwitchInst *CatchSwitch); |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 98 | bool insertExpensiveEHSupport(Function &F); |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 99 | }; |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 100 | } |
| 101 | |
Dan Gohman | 844731a | 2008-05-13 00:00:25 +0000 | [diff] [blame] | 102 | char LowerInvoke::ID = 0; |
Owen Anderson | 02dd53e | 2010-08-23 17:52:01 +0000 | [diff] [blame] | 103 | INITIALIZE_PASS(LowerInvoke, "lowerinvoke", |
| 104 | "Lower invoke and unwind, for unwindless code generators", |
Owen Anderson | ce665bd | 2010-10-07 22:25:06 +0000 | [diff] [blame] | 105 | false, false) |
Dan Gohman | 844731a | 2008-05-13 00:00:25 +0000 | [diff] [blame] | 106 | |
Owen Anderson | 90c579d | 2010-08-06 18:33:48 +0000 | [diff] [blame] | 107 | char &llvm::LowerInvokePassID = LowerInvoke::ID; |
Chris Lattner | cefc18e | 2004-02-13 16:16:16 +0000 | [diff] [blame] | 108 | |
Brian Gaeke | d0fde30 | 2003-11-11 22:41:34 +0000 | [diff] [blame] | 109 | // Public Interface To the LowerInvoke pass. |
Nadav Rotem | 725f1d1 | 2012-10-19 04:27:49 +0000 | [diff] [blame] | 110 | FunctionPass *llvm::createLowerInvokePass() { |
| 111 | return new LowerInvoke(ExpensiveEHSupport); |
Chris Lattner | c6f0aad | 2010-04-26 23:49:32 +0000 | [diff] [blame] | 112 | } |
Nadav Rotem | 725f1d1 | 2012-10-19 04:27:49 +0000 | [diff] [blame] | 113 | FunctionPass *llvm::createLowerInvokePass(bool useExpensiveEHSupport) { |
| 114 | return new LowerInvoke(useExpensiveEHSupport); |
Nate Begeman | 14b0529 | 2005-11-05 09:21:28 +0000 | [diff] [blame] | 115 | } |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 116 | |
| 117 | // doInitialization - Make sure that there is a prototype for abort in the |
| 118 | // current module. |
| 119 | bool LowerInvoke::doInitialization(Module &M) { |
Nadav Rotem | 725f1d1 | 2012-10-19 04:27:49 +0000 | [diff] [blame] | 120 | TargetTransformInfo *TTI = getAnalysisIfAvailable<TargetTransformInfo>(); |
| 121 | if (TTI) |
| 122 | STTI = TTI->getScalarTargetTransformInfo(); |
| 123 | |
Chris Lattner | db125cf | 2011-07-18 04:54:35 +0000 | [diff] [blame] | 124 | Type *VoidPtrTy = Type::getInt8PtrTy(M.getContext()); |
Chris Lattner | c6f0aad | 2010-04-26 23:49:32 +0000 | [diff] [blame] | 125 | if (useExpensiveEHSupport) { |
Jim Laskey | 7d48538 | 2007-02-22 16:21:18 +0000 | [diff] [blame] | 126 | // Insert a type for the linked list of jump buffers. |
Nadav Rotem | 725f1d1 | 2012-10-19 04:27:49 +0000 | [diff] [blame] | 127 | unsigned JBSize = STTI ? STTI->getJumpBufSize() : 0; |
Jim Laskey | 7d48538 | 2007-02-22 16:21:18 +0000 | [diff] [blame] | 128 | JBSize = JBSize ? JBSize : 200; |
Chris Lattner | 1afcace | 2011-07-09 17:41:24 +0000 | [diff] [blame] | 129 | Type *JmpBufTy = ArrayType::get(VoidPtrTy, JBSize); |
Chris Lattner | e1c0930 | 2004-02-08 07:30:29 +0000 | [diff] [blame] | 130 | |
Chris Lattner | 3ebb649 | 2011-08-12 18:06:37 +0000 | [diff] [blame] | 131 | JBLinkTy = StructType::create(M.getContext(), "llvm.sjljeh.jmpbufty"); |
Chris Lattner | 1afcace | 2011-07-09 17:41:24 +0000 | [diff] [blame] | 132 | Type *Elts[] = { JmpBufTy, PointerType::getUnqual(JBLinkTy) }; |
| 133 | JBLinkTy->setBody(Elts); |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 134 | |
Chris Lattner | db125cf | 2011-07-18 04:54:35 +0000 | [diff] [blame] | 135 | Type *PtrJBList = PointerType::getUnqual(JBLinkTy); |
Jim Laskey | 7d48538 | 2007-02-22 16:21:18 +0000 | [diff] [blame] | 136 | |
| 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 Anderson | e9b11b4 | 2009-07-08 19:03:57 +0000 | [diff] [blame] | 140 | JBListHead = new GlobalVariable(M, PtrJBList, false, |
Duncan Sands | 667d4b8 | 2009-03-07 15:45:40 +0000 | [diff] [blame] | 141 | GlobalValue::LinkOnceAnyLinkage, |
Owen Anderson | a7235ea | 2009-07-31 20:28:14 +0000 | [diff] [blame] | 142 | Constant::getNullValue(PtrJBList), |
Owen Anderson | e9b11b4 | 2009-07-08 19:03:57 +0000 | [diff] [blame] | 143 | "llvm.sjljeh.jblist"); |
Jim Laskey | 7d48538 | 2007-02-22 16:21:18 +0000 | [diff] [blame] | 144 | } |
Chuck Rose III | cc51c31 | 2008-04-15 21:27:11 +0000 | [diff] [blame] | 145 | |
Michael J. Spencer | 1f40960 | 2010-09-24 19:48:47 +0000 | [diff] [blame] | 146 | // 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 III | cc51c31 | 2008-04-15 21:27:11 +0000 | [diff] [blame] | 152 | #endif |
| 153 | |
Duncan Sands | a122043 | 2008-04-07 13:41:19 +0000 | [diff] [blame] | 154 | SetJmpFn = Intrinsic::getDeclaration(&M, Intrinsic::setjmp); |
Chuck Rose III | cc51c31 | 2008-04-15 21:27:11 +0000 | [diff] [blame] | 155 | |
Michael J. Spencer | 1f40960 | 2010-09-24 19:48:47 +0000 | [diff] [blame] | 156 | #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 III | cc51c31 | 2008-04-15 21:27:11 +0000 | [diff] [blame] | 160 | #endif |
| 161 | |
Duncan Sands | a122043 | 2008-04-07 13:41:19 +0000 | [diff] [blame] | 162 | LongJmpFn = Intrinsic::getDeclaration(&M, Intrinsic::longjmp); |
Chris Lattner | c6f0aad | 2010-04-26 23:49:32 +0000 | [diff] [blame] | 163 | StackSaveFn = Intrinsic::getDeclaration(&M, Intrinsic::stacksave); |
| 164 | StackRestoreFn = Intrinsic::getDeclaration(&M, Intrinsic::stackrestore); |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 165 | } |
Jim Laskey | 7d48538 | 2007-02-22 16:21:18 +0000 | [diff] [blame] | 166 | |
| 167 | // We need the 'write' and 'abort' functions for both models. |
Owen Anderson | 1d0be15 | 2009-08-13 21:58:54 +0000 | [diff] [blame] | 168 | AbortFn = M.getOrInsertFunction("abort", Type::getVoidTy(M.getContext()), |
| 169 | (Type *)0); |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 170 | return true; |
| 171 | } |
| 172 | |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 173 | bool LowerInvoke::insertCheapEHSupport(Function &F) { |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 174 | bool Changed = false; |
Chris Lattner | dead993 | 2003-12-10 20:22:42 +0000 | [diff] [blame] | 175 | for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB) |
| 176 | if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator())) { |
Jim Grosbach | 601f9d6 | 2010-06-01 17:56:41 +0000 | [diff] [blame] | 177 | SmallVector<Value*,16> CallArgs(II->op_begin(), II->op_end() - 3); |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 178 | // Insert a normal call instruction... |
Gabor Greif | 051a950 | 2008-04-06 20:25:17 +0000 | [diff] [blame] | 179 | CallInst *NewCall = CallInst::Create(II->getCalledValue(), |
Jay Foad | a3efbb1 | 2011-07-15 08:37:34 +0000 | [diff] [blame] | 180 | CallArgs, "", II); |
Chris Lattner | 86cc423 | 2007-02-11 01:37:51 +0000 | [diff] [blame] | 181 | NewCall->takeName(II); |
Chris Lattner | efd9168 | 2005-05-13 06:27:02 +0000 | [diff] [blame] | 182 | NewCall->setCallingConv(II->getCallingConv()); |
Devang Patel | 0598866 | 2008-09-25 21:00:45 +0000 | [diff] [blame] | 183 | NewCall->setAttributes(II->getAttributes()); |
Devang Patel | 3bcb3a6 | 2010-10-18 18:53:44 +0000 | [diff] [blame] | 184 | NewCall->setDebugLoc(II->getDebugLoc()); |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 185 | II->replaceAllUsesWith(NewCall); |
Misha Brukman | fd93908 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 186 | |
Chris Lattner | dead993 | 2003-12-10 20:22:42 +0000 | [diff] [blame] | 187 | // Insert an unconditional branch to the normal destination. |
Gabor Greif | 051a950 | 2008-04-06 20:25:17 +0000 | [diff] [blame] | 188 | BranchInst::Create(II->getNormalDest(), II); |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 189 | |
Chris Lattner | dead993 | 2003-12-10 20:22:42 +0000 | [diff] [blame] | 190 | // Remove any PHI node entries from the exception destination. |
Chris Lattner | aeb2a1d | 2004-02-08 21:44:31 +0000 | [diff] [blame] | 191 | II->getUnwindDest()->removePredecessor(BB); |
Chris Lattner | dead993 | 2003-12-10 20:22:42 +0000 | [diff] [blame] | 192 | |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 193 | // Remove the invoke instruction now. |
Chris Lattner | dead993 | 2003-12-10 20:22:42 +0000 | [diff] [blame] | 194 | BB->getInstList().erase(II); |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 195 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 196 | ++NumInvokes; Changed = true; |
Chris Lattner | 86e4445 | 2003-10-05 19:14:42 +0000 | [diff] [blame] | 197 | } |
| 198 | return Changed; |
| 199 | } |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 200 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 201 | /// rewriteExpensiveInvoke - Insert code and hack the function to replace the |
| 202 | /// specified invoke instruction with a call. |
| 203 | void LowerInvoke::rewriteExpensiveInvoke(InvokeInst *II, unsigned InvokeNo, |
| 204 | AllocaInst *InvokeNum, |
Chris Lattner | c6f0aad | 2010-04-26 23:49:32 +0000 | [diff] [blame] | 205 | AllocaInst *StackPtr, |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 206 | SwitchInst *CatchSwitch) { |
Owen Anderson | 1d0be15 | 2009-08-13 21:58:54 +0000 | [diff] [blame] | 207 | ConstantInt *InvokeNoC = ConstantInt::get(Type::getInt32Ty(II->getContext()), |
| 208 | InvokeNo); |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 209 | |
Chris Lattner | 8c5c22f | 2008-02-14 19:18:13 +0000 | [diff] [blame] | 210 | // If the unwind edge has phi nodes, split the edge. |
| 211 | if (isa<PHINode>(II->getUnwindDest()->begin())) { |
| 212 | SplitCriticalEdge(II, 1, this); |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 213 | |
Chris Lattner | 8c5c22f | 2008-02-14 19:18:13 +0000 | [diff] [blame] | 214 | // 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 Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 220 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 221 | // 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 Lattner | c6f0aad | 2010-04-26 23:49:32 +0000 | [diff] [blame] | 224 | |
| 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 Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 229 | |
Bill Wendling | 89d4411 | 2011-08-25 01:08:34 +0000 | [diff] [blame] | 230 | BasicBlock::iterator NI = II->getNormalDest()->getFirstInsertionPt(); |
Chris Lattner | 93e50ce | 2005-09-29 17:44:20 +0000 | [diff] [blame] | 231 | // nonvolatile. |
Owen Anderson | 1d0be15 | 2009-08-13 21:58:54 +0000 | [diff] [blame] | 232 | new StoreInst(Constant::getNullValue(Type::getInt32Ty(II->getContext())), |
| 233 | InvokeNum, false, NI); |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 234 | |
Bill Wendling | 89d4411 | 2011-08-25 01:08:34 +0000 | [diff] [blame] | 235 | Instruction* StackPtrLoad = |
| 236 | new LoadInst(StackPtr, "stackptr.restore", true, |
| 237 | II->getUnwindDest()->getFirstInsertionPt()); |
Chris Lattner | c6f0aad | 2010-04-26 23:49:32 +0000 | [diff] [blame] | 238 | CallInst::Create(StackRestoreFn, StackPtrLoad, "")->insertAfter(StackPtrLoad); |
| 239 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 240 | // Add a switch case to our unwind block. |
| 241 | CatchSwitch->addCase(InvokeNoC, II->getUnwindDest()); |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 242 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 243 | // Insert a normal call instruction. |
Jim Grosbach | 601f9d6 | 2010-06-01 17:56:41 +0000 | [diff] [blame] | 244 | SmallVector<Value*,16> CallArgs(II->op_begin(), II->op_end() - 3); |
Gabor Greif | 051a950 | 2008-04-06 20:25:17 +0000 | [diff] [blame] | 245 | CallInst *NewCall = CallInst::Create(II->getCalledValue(), |
Jay Foad | a3efbb1 | 2011-07-15 08:37:34 +0000 | [diff] [blame] | 246 | CallArgs, "", II); |
Chris Lattner | 86cc423 | 2007-02-11 01:37:51 +0000 | [diff] [blame] | 247 | NewCall->takeName(II); |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 248 | NewCall->setCallingConv(II->getCallingConv()); |
Devang Patel | 0598866 | 2008-09-25 21:00:45 +0000 | [diff] [blame] | 249 | NewCall->setAttributes(II->getAttributes()); |
Devang Patel | 3bcb3a6 | 2010-10-18 18:53:44 +0000 | [diff] [blame] | 250 | NewCall->setDebugLoc(II->getDebugLoc()); |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 251 | II->replaceAllUsesWith(NewCall); |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 252 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 253 | // Replace the invoke with an uncond branch. |
Gabor Greif | 051a950 | 2008-04-06 20:25:17 +0000 | [diff] [blame] | 254 | BranchInst::Create(II->getNormalDest(), NewCall->getParent()); |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 255 | II->eraseFromParent(); |
| 256 | } |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 257 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 258 | /// MarkBlocksLiveIn - Insert BB and all of its predescessors into LiveBBs until |
| 259 | /// we reach blocks we've already seen. |
| 260 | static void MarkBlocksLiveIn(BasicBlock *BB, std::set<BasicBlock*> &LiveBBs) { |
| 261 | if (!LiveBBs.insert(BB).second) return; // already been here. |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 262 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 263 | for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 264 | MarkBlocksLiveIn(*PI, LiveBBs); |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 265 | } |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 266 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 267 | // 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. |
| 272 | void LowerInvoke:: |
Jim Grosbach | aeafb37 | 2010-06-01 21:06:46 +0000 | [diff] [blame] | 273 | splitLiveRangesLiveAcrossInvokes(SmallVectorImpl<InvokeInst*> &Invokes) { |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 274 | // 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 Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 282 | } |
| 283 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 284 | Function *F = Invokes.back()->getParent()->getParent(); |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 285 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 286 | // To avoid having to handle incoming arguments specially, we lower each arg |
Reid Spencer | 3da59db | 2006-11-27 01:05:10 +0000 | [diff] [blame] | 287 | // to a copy instruction in the entry block. This ensures that the argument |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 288 | // 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 Lattner | db125cf | 2011-07-18 04:54:35 +0000 | [diff] [blame] | 295 | Type *Ty = AI->getType(); |
Jim Grosbach | 7fa1bba | 2010-06-30 22:22:59 +0000 | [diff] [blame] | 296 | // Aggregate types can't be cast, but are legal argument types, so we have |
Jim Grosbach | 0fd8b62 | 2010-06-01 18:04:56 +0000 | [diff] [blame] | 297 | // to handle them differently. We use an extract/insert pair as a |
| 298 | // lightweight method to achieve the same goal. |
Jim Grosbach | 7fa1bba | 2010-06-30 22:22:59 +0000 | [diff] [blame] | 299 | if (isa<StructType>(Ty) || isa<ArrayType>(Ty) || isa<VectorType>(Ty)) { |
| 300 | Instruction *EI = ExtractValueInst::Create(AI, 0, "",AfterAllocaInsertPt); |
Jim Grosbach | 0fd8b62 | 2010-06-01 18:04:56 +0000 | [diff] [blame] | 301 | Instruction *NI = InsertValueInst::Create(AI, EI, 0); |
| 302 | NI->insertAfter(EI); |
| 303 | AI->replaceAllUsesWith(NI); |
Jim Grosbach | 7fa1bba | 2010-06-30 22:22:59 +0000 | [diff] [blame] | 304 | // Set the operand of the instructions back to the AllocaInst. |
Jim Grosbach | 0fd8b62 | 2010-06-01 18:04:56 +0000 | [diff] [blame] | 305 | 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 Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 322 | } |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 323 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 324 | // 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 Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 335 | |
Chris Lattner | 4531371 | 2005-09-27 21:33:12 +0000 | [diff] [blame] | 336 | // 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 Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 341 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 342 | // Avoid iterator invalidation by copying users to a temporary vector. |
Jim Grosbach | 601f9d6 | 2010-06-01 17:56:41 +0000 | [diff] [blame] | 343 | SmallVector<Instruction*,16> Users; |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 344 | 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 Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 354 | 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 Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 362 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 363 | 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 Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 373 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 374 | // 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 Anderson | 50dead0 | 2009-07-15 23:53:25 +0000 | [diff] [blame] | 387 | DemoteRegToStack(*Inst, true); |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 388 | } |
| 389 | } |
| 390 | } |
| 391 | |
| 392 | bool LowerInvoke::insertExpensiveEHSupport(Function &F) { |
Jim Grosbach | 601f9d6 | 2010-06-01 17:56:41 +0000 | [diff] [blame] | 393 | SmallVector<ReturnInst*,16> Returns; |
Jim Grosbach | 601f9d6 | 2010-06-01 17:56:41 +0000 | [diff] [blame] | 394 | SmallVector<InvokeInst*,16> Invokes; |
Bill Wendling | 8d676c2 | 2011-08-09 01:17:10 +0000 | [diff] [blame] | 395 | UnreachableInst* UnreachablePlaceholder = 0; |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 396 | |
| 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 Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 404 | } |
| 405 | |
Bill Wendling | aa5abe8 | 2012-02-06 21:16:41 +0000 | [diff] [blame] | 406 | if (Invokes.empty()) return false; |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 407 | |
| 408 | NumInvokes += Invokes.size(); |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 409 | |
Chris Lattner | 5b3c702 | 2005-09-27 22:44:59 +0000 | [diff] [blame] | 410 | // 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 Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 417 | |
| 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 Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 428 | splitLiveRangesLiveAcrossInvokes(Invokes); |
| 429 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 430 | BasicBlock *EntryBB = F.begin(); |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 431 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 432 | // 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 Rotem | 725f1d1 | 2012-10-19 04:27:49 +0000 | [diff] [blame] | 435 | unsigned Align = STTI ? STTI->getJumpBufAlignment() : 0; |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 436 | AllocaInst *JmpBuf = |
Owen Anderson | 50dead0 | 2009-07-15 23:53:25 +0000 | [diff] [blame] | 437 | new AllocaInst(JBLinkTy, 0, Align, |
Owen Anderson | 9adc0ab | 2009-07-14 23:09:55 +0000 | [diff] [blame] | 438 | "jblink", F.begin()->begin()); |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 439 | |
Jim Grosbach | aeafb37 | 2010-06-01 21:06:46 +0000 | [diff] [blame] | 440 | Value *Idx[] = { Constant::getNullValue(Type::getInt32Ty(F.getContext())), |
| 441 | ConstantInt::get(Type::getInt32Ty(F.getContext()), 1) }; |
Jay Foad | a920310 | 2011-07-25 09:48:08 +0000 | [diff] [blame] | 442 | OldJmpBufPtr = GetElementPtrInst::Create(JmpBuf, Idx, "OldBuf", |
Jim Grosbach | aeafb37 | 2010-06-01 21:06:46 +0000 | [diff] [blame] | 443 | EntryBB->getTerminator()); |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 444 | |
| 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 Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 449 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 450 | // 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 Anderson | 1d0be15 | 2009-08-13 21:58:54 +0000 | [diff] [blame] | 455 | BasicBlock *CatchBB = |
| 456 | BasicBlock::Create(F.getContext(), "setjmp.catch", &F); |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 457 | |
Chris Lattner | c6f0aad | 2010-04-26 23:49:32 +0000 | [diff] [blame] | 458 | // 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 Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 464 | // Create an alloca which keeps track of which invoke is currently |
| 465 | // executing. For normal calls it contains zero. |
Owen Anderson | 1d0be15 | 2009-08-13 21:58:54 +0000 | [diff] [blame] | 466 | AllocaInst *InvokeNum = new AllocaInst(Type::getInt32Ty(F.getContext()), 0, |
Owen Anderson | 9adc0ab | 2009-07-14 23:09:55 +0000 | [diff] [blame] | 467 | "invokenum",EntryBB->begin()); |
Owen Anderson | 1d0be15 | 2009-08-13 21:58:54 +0000 | [diff] [blame] | 468 | new StoreInst(ConstantInt::get(Type::getInt32Ty(F.getContext()), 0), |
| 469 | InvokeNum, true, EntryBB->getTerminator()); |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 470 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 471 | // 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 Wendling | 4fa93b7 | 2011-08-09 01:09:21 +0000 | [diff] [blame] | 473 | // for a standard call). We insert an unreachable instruction here and |
| 474 | // modify the block to jump to the correct unwinding pad later. |
Owen Anderson | 1d0be15 | 2009-08-13 21:58:54 +0000 | [diff] [blame] | 475 | BasicBlock *UnwindBB = BasicBlock::Create(F.getContext(), "unwindbb", &F); |
Bill Wendling | 8d676c2 | 2011-08-09 01:17:10 +0000 | [diff] [blame] | 476 | UnreachablePlaceholder = new UnreachableInst(F.getContext(), UnwindBB); |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 477 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 478 | Value *CatchLoad = new LoadInst(InvokeNum, "invoke.num", true, CatchBB); |
Gabor Greif | 051a950 | 2008-04-06 20:25:17 +0000 | [diff] [blame] | 479 | SwitchInst *CatchSwitch = |
| 480 | SwitchInst::Create(CatchLoad, UnwindBB, Invokes.size(), CatchBB); |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 481 | |
| 482 | // Now that things are set up, insert the setjmp call itself. |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 483 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 484 | // Split the entry block to insert the conditional branch for the setjmp. |
| 485 | BasicBlock *ContBlock = EntryBB->splitBasicBlock(EntryBB->getTerminator(), |
| 486 | "setjmp.cont"); |
| 487 | |
Owen Anderson | 1d0be15 | 2009-08-13 21:58:54 +0000 | [diff] [blame] | 488 | Idx[1] = ConstantInt::get(Type::getInt32Ty(F.getContext()), 0); |
Jay Foad | a920310 | 2011-07-25 09:48:08 +0000 | [diff] [blame] | 489 | Value *JmpBufPtr = GetElementPtrInst::Create(JmpBuf, Idx, "TheJmpBuf", |
Gabor Greif | 051a950 | 2008-04-06 20:25:17 +0000 | [diff] [blame] | 490 | EntryBB->getTerminator()); |
Owen Anderson | 1d0be15 | 2009-08-13 21:58:54 +0000 | [diff] [blame] | 491 | JmpBufPtr = new BitCastInst(JmpBufPtr, |
Duncan Sands | ac53a0b | 2009-10-06 15:40:36 +0000 | [diff] [blame] | 492 | Type::getInt8PtrTy(F.getContext()), |
Duncan Sands | a122043 | 2008-04-07 13:41:19 +0000 | [diff] [blame] | 493 | "tmp", EntryBB->getTerminator()); |
Gabor Greif | 051a950 | 2008-04-06 20:25:17 +0000 | [diff] [blame] | 494 | Value *SJRet = CallInst::Create(SetJmpFn, JmpBufPtr, "sjret", |
| 495 | EntryBB->getTerminator()); |
Duncan Sands | a122043 | 2008-04-07 13:41:19 +0000 | [diff] [blame] | 496 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 497 | // Compare the return value to zero. |
Owen Anderson | 333c400 | 2009-07-09 23:48:35 +0000 | [diff] [blame] | 498 | Value *IsNormal = new ICmpInst(EntryBB->getTerminator(), |
| 499 | ICmpInst::ICMP_EQ, SJRet, |
Owen Anderson | a7235ea | 2009-07-31 20:28:14 +0000 | [diff] [blame] | 500 | Constant::getNullValue(SJRet->getType()), |
Owen Anderson | 333c400 | 2009-07-09 23:48:35 +0000 | [diff] [blame] | 501 | "notunwind"); |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 502 | // Nuke the uncond branch. |
| 503 | EntryBB->getTerminator()->eraseFromParent(); |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 504 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 505 | // Put in a new condbranch in its place. |
Gabor Greif | 051a950 | 2008-04-06 20:25:17 +0000 | [diff] [blame] | 506 | BranchInst::Create(ContBlock, CatchBB, IsNormal, EntryBB); |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 507 | |
| 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 Lattner | c6f0aad | 2010-04-26 23:49:32 +0000 | [diff] [blame] | 510 | rewriteExpensiveInvoke(Invokes[i], i+1, InvokeNum, StackPtr, CatchSwitch); |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 511 | } |
| 512 | |
| 513 | // We know that there is at least one unwind. |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 514 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 515 | // 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 Anderson | 1d0be15 | 2009-08-13 21:58:54 +0000 | [diff] [blame] | 518 | 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 Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 522 | |
| 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 Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 532 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 533 | // Load the JBList, if it's null, then there was no catch! |
Owen Anderson | 333c400 | 2009-07-09 23:48:35 +0000 | [diff] [blame] | 534 | Value *NotNull = new ICmpInst(*UnwindHandler, ICmpInst::ICMP_NE, BufPtr, |
Owen Anderson | a7235ea | 2009-07-31 20:28:14 +0000 | [diff] [blame] | 535 | Constant::getNullValue(BufPtr->getType()), |
Owen Anderson | 333c400 | 2009-07-09 23:48:35 +0000 | [diff] [blame] | 536 | "notnull"); |
Gabor Greif | 051a950 | 2008-04-06 20:25:17 +0000 | [diff] [blame] | 537 | BranchInst::Create(UnwindBlock, TermBlock, NotNull, UnwindHandler); |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 538 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 539 | // Create the block to do the longjmp. |
| 540 | // Get a pointer to the jmpbuf and longjmp. |
Jim Grosbach | aeafb37 | 2010-06-01 21:06:46 +0000 | [diff] [blame] | 541 | Value *Idx[] = { Constant::getNullValue(Type::getInt32Ty(F.getContext())), |
| 542 | ConstantInt::get(Type::getInt32Ty(F.getContext()), 0) }; |
Jay Foad | a920310 | 2011-07-25 09:48:08 +0000 | [diff] [blame] | 543 | Idx[0] = GetElementPtrInst::Create(BufPtr, Idx, "JmpBuf", UnwindBlock); |
Owen Anderson | 1d0be15 | 2009-08-13 21:58:54 +0000 | [diff] [blame] | 544 | Idx[0] = new BitCastInst(Idx[0], |
Duncan Sands | ac53a0b | 2009-10-06 15:40:36 +0000 | [diff] [blame] | 545 | Type::getInt8PtrTy(F.getContext()), |
Duncan Sands | a122043 | 2008-04-07 13:41:19 +0000 | [diff] [blame] | 546 | "tmp", UnwindBlock); |
Owen Anderson | 1d0be15 | 2009-08-13 21:58:54 +0000 | [diff] [blame] | 547 | Idx[1] = ConstantInt::get(Type::getInt32Ty(F.getContext()), 1); |
Jay Foad | a3efbb1 | 2011-07-15 08:37:34 +0000 | [diff] [blame] | 548 | CallInst::Create(LongJmpFn, Idx, "", UnwindBlock); |
Owen Anderson | 1d0be15 | 2009-08-13 21:58:54 +0000 | [diff] [blame] | 549 | new UnreachableInst(F.getContext(), UnwindBlock); |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 550 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 551 | // Set up the term block ("throw without a catch"). |
Owen Anderson | 1d0be15 | 2009-08-13 21:58:54 +0000 | [diff] [blame] | 552 | new UnreachableInst(F.getContext(), TermBlock); |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 553 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 554 | // Insert a call to abort() |
Gabor Greif | 051a950 | 2008-04-06 20:25:17 +0000 | [diff] [blame] | 555 | CallInst::Create(AbortFn, "", |
| 556 | TermBlock->getTerminator())->setTailCall(); |
Jim Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 557 | |
Bill Wendling | 8d676c2 | 2011-08-09 01:17:10 +0000 | [diff] [blame] | 558 | // Replace the inserted unreachable with a branch to the unwind handler. |
| 559 | if (UnreachablePlaceholder) { |
| 560 | BranchInst::Create(UnwindHandler, UnreachablePlaceholder); |
| 561 | UnreachablePlaceholder->eraseFromParent(); |
Bill Wendling | 4fa93b7 | 2011-08-09 01:09:21 +0000 | [diff] [blame] | 562 | } |
| 563 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 564 | // 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 Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 569 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 570 | // 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 Grosbach | 4644538 | 2009-04-17 23:30:55 +0000 | [diff] [blame] | 575 | |
Chris Lattner | f4e6c3a | 2005-09-27 21:18:17 +0000 | [diff] [blame] | 576 | return true; |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 577 | } |
| 578 | |
| 579 | bool LowerInvoke::runOnFunction(Function &F) { |
Nadav Rotem | 725f1d1 | 2012-10-19 04:27:49 +0000 | [diff] [blame] | 580 | TargetTransformInfo *TTI = getAnalysisIfAvailable<TargetTransformInfo>(); |
| 581 | if (TTI) |
| 582 | STTI = TTI->getScalarTargetTransformInfo(); |
| 583 | |
Chris Lattner | c6f0aad | 2010-04-26 23:49:32 +0000 | [diff] [blame] | 584 | if (useExpensiveEHSupport) |
Chris Lattner | 6d78457 | 2004-02-08 19:53:56 +0000 | [diff] [blame] | 585 | return insertExpensiveEHSupport(F); |
| 586 | else |
| 587 | return insertCheapEHSupport(F); |
| 588 | } |