Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 1 | //===- LowerSetJmp.cpp - Code pertaining to lowering set/long jumps -------===// |
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 | // |
| 5 | // This file was developed by the LLVM research group and is distributed under |
| 6 | // the University of Illinois Open Source 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 | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 9 | // |
| 10 | // This file implements the lowering of setjmp and longjmp to use the |
Chris Lattner | 77b398c | 2003-09-15 05:43:05 +0000 | [diff] [blame] | 11 | // LLVM invoke and unwind instructions as necessary. |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 12 | // |
| 13 | // Lowering of longjmp is fairly trivial. We replace the call with a |
| 14 | // call to the LLVM library function "__llvm_sjljeh_throw_longjmp()". |
| 15 | // This unwinds the stack for us calling all of the destructors for |
| 16 | // objects allocated on the stack. |
| 17 | // |
| 18 | // At a setjmp call, the basic block is split and the setjmp removed. |
| 19 | // The calls in a function that have a setjmp are converted to invoke |
| 20 | // where the except part checks to see if it's a longjmp exception and, |
| 21 | // if so, if it's handled in the function. If it is, then it gets the |
| 22 | // value returned by the longjmp and goes to where the basic block was |
| 23 | // split. Invoke instructions are handled in a similar fashion with the |
| 24 | // original except block being executed if it isn't a longjmp except |
| 25 | // that is handled by that function. |
| 26 | // |
| 27 | //===----------------------------------------------------------------------===// |
| 28 | |
| 29 | //===----------------------------------------------------------------------===// |
| 30 | // FIXME: This pass doesn't deal with PHI statements just yet. That is, |
| 31 | // we expect this to occur before SSAification is done. This would seem |
| 32 | // to make sense, but in general, it might be a good idea to make this |
| 33 | // pass invokable via the "opt" command at will. |
| 34 | //===----------------------------------------------------------------------===// |
| 35 | |
Chris Lattner | 86453c5 | 2006-12-19 22:09:18 +0000 | [diff] [blame] | 36 | #define DEBUG_TYPE "lowersetjmp" |
Chris Lattner | 1e2385b | 2003-11-21 21:54:22 +0000 | [diff] [blame] | 37 | #include "llvm/Transforms/IPO.h" |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 38 | #include "llvm/Constants.h" |
| 39 | #include "llvm/DerivedTypes.h" |
| 40 | #include "llvm/Instructions.h" |
| 41 | #include "llvm/Intrinsics.h" |
| 42 | #include "llvm/Module.h" |
| 43 | #include "llvm/Pass.h" |
Chris Lattner | bb2d4de | 2003-10-13 00:57:16 +0000 | [diff] [blame] | 44 | #include "llvm/Support/CFG.h" |
Reid Spencer | 9133fe2 | 2007-02-05 23:32:05 +0000 | [diff] [blame] | 45 | #include "llvm/Support/Compiler.h" |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 46 | #include "llvm/Support/InstVisitor.h" |
Chris Lattner | a2dc727 | 2004-03-14 02:13:38 +0000 | [diff] [blame] | 47 | #include "llvm/Transforms/Utils/Local.h" |
Reid Spencer | 551ccae | 2004-09-01 22:55:40 +0000 | [diff] [blame] | 48 | #include "llvm/ADT/DepthFirstIterator.h" |
| 49 | #include "llvm/ADT/Statistic.h" |
| 50 | #include "llvm/ADT/StringExtras.h" |
| 51 | #include "llvm/ADT/VectorExtras.h" |
David Greene | 52eec54 | 2007-08-01 03:43:44 +0000 | [diff] [blame] | 52 | #include "llvm/ADT/SmallVector.h" |
Chris Lattner | 1e2385b | 2003-11-21 21:54:22 +0000 | [diff] [blame] | 53 | using namespace llvm; |
Brian Gaeke | d0fde30 | 2003-11-11 22:41:34 +0000 | [diff] [blame] | 54 | |
Chris Lattner | 86453c5 | 2006-12-19 22:09:18 +0000 | [diff] [blame] | 55 | STATISTIC(LongJmpsTransformed, "Number of longjmps transformed"); |
| 56 | STATISTIC(SetJmpsTransformed , "Number of setjmps transformed"); |
| 57 | STATISTIC(CallsTransformed , "Number of calls invokified"); |
| 58 | STATISTIC(InvokesTransformed , "Number of invokes modified"); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 59 | |
Chris Lattner | 86453c5 | 2006-12-19 22:09:18 +0000 | [diff] [blame] | 60 | namespace { |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 61 | //===--------------------------------------------------------------------===// |
Chris Lattner | bc53e5e | 2004-10-07 06:00:24 +0000 | [diff] [blame] | 62 | // LowerSetJmp pass implementation. |
Reid Spencer | 9133fe2 | 2007-02-05 23:32:05 +0000 | [diff] [blame] | 63 | class VISIBILITY_HIDDEN LowerSetJmp : public ModulePass, |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 64 | public InstVisitor<LowerSetJmp> { |
| 65 | // LLVM library functions... |
Chris Lattner | 35057c2 | 2007-01-07 06:59:47 +0000 | [diff] [blame] | 66 | Constant *InitSJMap; // __llvm_sjljeh_init_setjmpmap |
| 67 | Constant *DestroySJMap; // __llvm_sjljeh_destroy_setjmpmap |
| 68 | Constant *AddSJToMap; // __llvm_sjljeh_add_setjmp_to_map |
| 69 | Constant *ThrowLongJmp; // __llvm_sjljeh_throw_longjmp |
| 70 | Constant *TryCatchLJ; // __llvm_sjljeh_try_catching_longjmp_exception |
| 71 | Constant *IsLJException; // __llvm_sjljeh_is_longjmp_exception |
| 72 | Constant *GetLJValue; // __llvm_sjljeh_get_longjmp_value |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 73 | |
| 74 | typedef std::pair<SwitchInst*, CallInst*> SwitchValuePair; |
| 75 | |
Chris Lattner | bb2d4de | 2003-10-13 00:57:16 +0000 | [diff] [blame] | 76 | // Keep track of those basic blocks reachable via a depth-first search of |
| 77 | // the CFG from a setjmp call. We only need to transform those "call" and |
| 78 | // "invoke" instructions that are reachable from the setjmp call site. |
| 79 | std::set<BasicBlock*> DFSBlocks; |
| 80 | |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 81 | // The setjmp map is going to hold information about which setjmps |
| 82 | // were called (each setjmp gets its own number) and with which |
| 83 | // buffer it was called. |
| 84 | std::map<Function*, AllocaInst*> SJMap; |
| 85 | |
| 86 | // The rethrow basic block map holds the basic block to branch to if |
| 87 | // the exception isn't handled in the current function and needs to |
| 88 | // be rethrown. |
| 89 | std::map<const Function*, BasicBlock*> RethrowBBMap; |
| 90 | |
| 91 | // The preliminary basic block map holds a basic block that grabs the |
| 92 | // exception and determines if it's handled by the current function. |
| 93 | std::map<const Function*, BasicBlock*> PrelimBBMap; |
| 94 | |
| 95 | // The switch/value map holds a switch inst/call inst pair. The |
| 96 | // switch inst controls which handler (if any) gets called and the |
| 97 | // value is the value returned to that handler by the call to |
| 98 | // __llvm_sjljeh_get_longjmp_value. |
| 99 | std::map<const Function*, SwitchValuePair> SwitchValMap; |
| 100 | |
| 101 | // A map of which setjmps we've seen so far in a function. |
| 102 | std::map<const Function*, unsigned> SetJmpIDMap; |
| 103 | |
| 104 | AllocaInst* GetSetJmpMap(Function* Func); |
| 105 | BasicBlock* GetRethrowBB(Function* Func); |
| 106 | SwitchValuePair GetSJSwitch(Function* Func, BasicBlock* Rethrow); |
| 107 | |
| 108 | void TransformLongJmpCall(CallInst* Inst); |
| 109 | void TransformSetJmpCall(CallInst* Inst); |
| 110 | |
| 111 | bool IsTransformableFunction(const std::string& Name); |
| 112 | public: |
Nick Lewycky | ecd94c8 | 2007-05-06 13:37:16 +0000 | [diff] [blame] | 113 | static char ID; // Pass identification, replacement for typeid |
Devang Patel | 794fd75 | 2007-05-01 21:15:47 +0000 | [diff] [blame] | 114 | LowerSetJmp() : ModulePass((intptr_t)&ID) {} |
| 115 | |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 116 | void visitCallInst(CallInst& CI); |
| 117 | void visitInvokeInst(InvokeInst& II); |
| 118 | void visitReturnInst(ReturnInst& RI); |
| 119 | void visitUnwindInst(UnwindInst& UI); |
| 120 | |
Chris Lattner | b12914b | 2004-09-20 04:48:05 +0000 | [diff] [blame] | 121 | bool runOnModule(Module& M); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 122 | bool doInitialization(Module& M); |
| 123 | }; |
| 124 | |
Devang Patel | 1997473 | 2007-05-03 01:11:54 +0000 | [diff] [blame] | 125 | char LowerSetJmp::ID = 0; |
Chris Lattner | 7f8897f | 2006-08-27 22:42:52 +0000 | [diff] [blame] | 126 | RegisterPass<LowerSetJmp> X("lowersetjmp", "Lower Set Jump"); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 127 | } // end anonymous namespace |
| 128 | |
| 129 | // run - Run the transformation on the program. We grab the function |
| 130 | // prototypes for longjmp and setjmp. If they are used in the program, |
| 131 | // then we can go directly to the places they're at and transform them. |
Chris Lattner | b12914b | 2004-09-20 04:48:05 +0000 | [diff] [blame] | 132 | bool LowerSetJmp::runOnModule(Module& M) { |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 133 | bool Changed = false; |
| 134 | |
| 135 | // These are what the functions are called. |
Reid Spencer | 688b049 | 2007-02-05 21:19:13 +0000 | [diff] [blame] | 136 | Function* SetJmp = M.getFunction("llvm.setjmp"); |
| 137 | Function* LongJmp = M.getFunction("llvm.longjmp"); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 138 | |
| 139 | // This program doesn't have longjmp and setjmp calls. |
| 140 | if ((!LongJmp || LongJmp->use_empty()) && |
| 141 | (!SetJmp || SetJmp->use_empty())) return false; |
| 142 | |
| 143 | // Initialize some values and functions we'll need to transform the |
| 144 | // setjmp/longjmp functions. |
| 145 | doInitialization(M); |
| 146 | |
Chris Lattner | bb2d4de | 2003-10-13 00:57:16 +0000 | [diff] [blame] | 147 | if (SetJmp) { |
Chris Lattner | bb2d4de | 2003-10-13 00:57:16 +0000 | [diff] [blame] | 148 | for (Value::use_iterator B = SetJmp->use_begin(), E = SetJmp->use_end(); |
| 149 | B != E; ++B) { |
Chris Lattner | 6d3906b | 2003-10-13 01:02:33 +0000 | [diff] [blame] | 150 | BasicBlock* BB = cast<Instruction>(*B)->getParent(); |
Chris Lattner | 8b716f6 | 2003-10-13 16:49:21 +0000 | [diff] [blame] | 151 | for (df_ext_iterator<BasicBlock*> I = df_ext_begin(BB, DFSBlocks), |
| 152 | E = df_ext_end(BB, DFSBlocks); I != E; ++I) |
Chris Lattner | 46e033d | 2003-10-13 16:44:50 +0000 | [diff] [blame] | 153 | /* empty */; |
Chris Lattner | bb2d4de | 2003-10-13 00:57:16 +0000 | [diff] [blame] | 154 | } |
| 155 | |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 156 | while (!SetJmp->use_empty()) { |
| 157 | assert(isa<CallInst>(SetJmp->use_back()) && |
| 158 | "User of setjmp intrinsic not a call?"); |
| 159 | TransformSetJmpCall(cast<CallInst>(SetJmp->use_back())); |
| 160 | Changed = true; |
| 161 | } |
Chris Lattner | bb2d4de | 2003-10-13 00:57:16 +0000 | [diff] [blame] | 162 | } |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 163 | |
| 164 | if (LongJmp) |
| 165 | while (!LongJmp->use_empty()) { |
| 166 | assert(isa<CallInst>(LongJmp->use_back()) && |
| 167 | "User of longjmp intrinsic not a call?"); |
| 168 | TransformLongJmpCall(cast<CallInst>(LongJmp->use_back())); |
| 169 | Changed = true; |
| 170 | } |
| 171 | |
| 172 | // Now go through the affected functions and convert calls and invokes |
| 173 | // to new invokes... |
| 174 | for (std::map<Function*, AllocaInst*>::iterator |
| 175 | B = SJMap.begin(), E = SJMap.end(); B != E; ++B) { |
| 176 | Function* F = B->first; |
| 177 | for (Function::iterator BB = F->begin(), BE = F->end(); BB != BE; ++BB) |
| 178 | for (BasicBlock::iterator IB = BB->begin(), IE = BB->end(); IB != IE; ) { |
| 179 | visit(*IB++); |
| 180 | if (IB != BB->end() && IB->getParent() != BB) |
| 181 | break; // The next instruction got moved to a different block! |
| 182 | } |
| 183 | } |
| 184 | |
Chris Lattner | bb2d4de | 2003-10-13 00:57:16 +0000 | [diff] [blame] | 185 | DFSBlocks.clear(); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 186 | SJMap.clear(); |
| 187 | RethrowBBMap.clear(); |
| 188 | PrelimBBMap.clear(); |
| 189 | SwitchValMap.clear(); |
| 190 | SetJmpIDMap.clear(); |
| 191 | |
| 192 | return Changed; |
| 193 | } |
| 194 | |
| 195 | // doInitialization - For the lower long/setjmp pass, this ensures that a |
| 196 | // module contains a declaration for the intrisic functions we are going |
| 197 | // to call to convert longjmp and setjmp calls. |
| 198 | // |
| 199 | // This function is always successful, unless it isn't. |
| 200 | bool LowerSetJmp::doInitialization(Module& M) |
| 201 | { |
Christopher Lamb | 43ad6b3 | 2007-12-17 01:12:55 +0000 | [diff] [blame] | 202 | const Type *SBPTy = PointerType::getUnqual(Type::Int8Ty); |
| 203 | const Type *SBPPTy = PointerType::getUnqual(SBPTy); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 204 | |
| 205 | // N.B. See llvm/runtime/GCCLibraries/libexception/SJLJ-Exception.h for |
| 206 | // a description of the following library functions. |
| 207 | |
| 208 | // void __llvm_sjljeh_init_setjmpmap(void**) |
| 209 | InitSJMap = M.getOrInsertFunction("__llvm_sjljeh_init_setjmpmap", |
Jeff Cohen | 66c5fd6 | 2005-10-23 04:37:20 +0000 | [diff] [blame] | 210 | Type::VoidTy, SBPPTy, (Type *)0); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 211 | // void __llvm_sjljeh_destroy_setjmpmap(void**) |
| 212 | DestroySJMap = M.getOrInsertFunction("__llvm_sjljeh_destroy_setjmpmap", |
Jeff Cohen | 66c5fd6 | 2005-10-23 04:37:20 +0000 | [diff] [blame] | 213 | Type::VoidTy, SBPPTy, (Type *)0); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 214 | |
| 215 | // void __llvm_sjljeh_add_setjmp_to_map(void**, void*, unsigned) |
| 216 | AddSJToMap = M.getOrInsertFunction("__llvm_sjljeh_add_setjmp_to_map", |
| 217 | Type::VoidTy, SBPPTy, SBPTy, |
Reid Spencer | c5b206b | 2006-12-31 05:48:39 +0000 | [diff] [blame] | 218 | Type::Int32Ty, (Type *)0); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 219 | |
| 220 | // void __llvm_sjljeh_throw_longjmp(int*, int) |
| 221 | ThrowLongJmp = M.getOrInsertFunction("__llvm_sjljeh_throw_longjmp", |
Reid Spencer | c5b206b | 2006-12-31 05:48:39 +0000 | [diff] [blame] | 222 | Type::VoidTy, SBPTy, Type::Int32Ty, |
Jeff Cohen | 66c5fd6 | 2005-10-23 04:37:20 +0000 | [diff] [blame] | 223 | (Type *)0); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 224 | |
| 225 | // unsigned __llvm_sjljeh_try_catching_longjmp_exception(void **) |
| 226 | TryCatchLJ = |
| 227 | M.getOrInsertFunction("__llvm_sjljeh_try_catching_longjmp_exception", |
Reid Spencer | c5b206b | 2006-12-31 05:48:39 +0000 | [diff] [blame] | 228 | Type::Int32Ty, SBPPTy, (Type *)0); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 229 | |
| 230 | // bool __llvm_sjljeh_is_longjmp_exception() |
| 231 | IsLJException = M.getOrInsertFunction("__llvm_sjljeh_is_longjmp_exception", |
Reid Spencer | 4fe16d6 | 2007-01-11 18:21:29 +0000 | [diff] [blame] | 232 | Type::Int1Ty, (Type *)0); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 233 | |
| 234 | // int __llvm_sjljeh_get_longjmp_value() |
| 235 | GetLJValue = M.getOrInsertFunction("__llvm_sjljeh_get_longjmp_value", |
Reid Spencer | c5b206b | 2006-12-31 05:48:39 +0000 | [diff] [blame] | 236 | Type::Int32Ty, (Type *)0); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 237 | return true; |
| 238 | } |
| 239 | |
| 240 | // IsTransformableFunction - Return true if the function name isn't one |
| 241 | // of the ones we don't want transformed. Currently, don't transform any |
| 242 | // "llvm.{setjmp,longjmp}" functions and none of the setjmp/longjmp error |
| 243 | // handling functions (beginning with __llvm_sjljeh_...they don't throw |
| 244 | // exceptions). |
Chris Lattner | cb2d1a2 | 2005-04-21 16:46:46 +0000 | [diff] [blame] | 245 | bool LowerSetJmp::IsTransformableFunction(const std::string& Name) { |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 246 | std::string SJLJEh("__llvm_sjljeh"); |
| 247 | |
Chris Lattner | 77b398c | 2003-09-15 05:43:05 +0000 | [diff] [blame] | 248 | if (Name.size() > SJLJEh.size()) |
| 249 | return std::string(Name.begin(), Name.begin() + SJLJEh.size()) != SJLJEh; |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 250 | |
| 251 | return true; |
| 252 | } |
| 253 | |
| 254 | // TransformLongJmpCall - Transform a longjmp call into a call to the |
| 255 | // internal __llvm_sjljeh_throw_longjmp function. It then takes care of |
| 256 | // throwing the exception for us. |
| 257 | void LowerSetJmp::TransformLongJmpCall(CallInst* Inst) |
| 258 | { |
Christopher Lamb | 43ad6b3 | 2007-12-17 01:12:55 +0000 | [diff] [blame] | 259 | const Type* SBPTy = PointerType::getUnqual(Type::Int8Ty); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 260 | |
| 261 | // Create the call to "__llvm_sjljeh_throw_longjmp". This takes the |
| 262 | // same parameters as "longjmp", except that the buffer is cast to a |
| 263 | // char*. It returns "void", so it doesn't need to replace any of |
| 264 | // Inst's uses and doesn't get a name. |
Reid Spencer | 3da59db | 2006-11-27 01:05:10 +0000 | [diff] [blame] | 265 | CastInst* CI = |
| 266 | new BitCastInst(Inst->getOperand(1), SBPTy, "LJBuf", Inst); |
David Greene | 52eec54 | 2007-08-01 03:43:44 +0000 | [diff] [blame] | 267 | SmallVector<Value *, 2> Args; |
| 268 | Args.push_back(CI); |
| 269 | Args.push_back(Inst->getOperand(2)); |
| 270 | new CallInst(ThrowLongJmp, Args.begin(), Args.end(), "", Inst); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 271 | |
| 272 | SwitchValuePair& SVP = SwitchValMap[Inst->getParent()->getParent()]; |
| 273 | |
| 274 | // If the function has a setjmp call in it (they are transformed first) |
| 275 | // we should branch to the basic block that determines if this longjmp |
| 276 | // is applicable here. Otherwise, issue an unwind. |
| 277 | if (SVP.first) |
| 278 | new BranchInst(SVP.first->getParent(), Inst); |
| 279 | else |
| 280 | new UnwindInst(Inst); |
| 281 | |
Chris Lattner | 3987abd | 2005-05-05 15:47:43 +0000 | [diff] [blame] | 282 | // Remove all insts after the branch/unwind inst. Go from back to front to |
| 283 | // avoid replaceAllUsesWith if possible. |
| 284 | BasicBlock *BB = Inst->getParent(); |
| 285 | Instruction *Removed; |
| 286 | do { |
| 287 | Removed = &BB->back(); |
| 288 | // If the removed instructions have any users, replace them now. |
| 289 | if (!Removed->use_empty()) |
| 290 | Removed->replaceAllUsesWith(UndefValue::get(Removed->getType())); |
| 291 | Removed->eraseFromParent(); |
| 292 | } while (Removed != Inst); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 293 | |
| 294 | ++LongJmpsTransformed; |
| 295 | } |
| 296 | |
| 297 | // GetSetJmpMap - Retrieve (create and initialize, if necessary) the |
| 298 | // setjmp map. This map is going to hold information about which setjmps |
| 299 | // were called (each setjmp gets its own number) and with which buffer it |
| 300 | // was called. There can be only one! |
| 301 | AllocaInst* LowerSetJmp::GetSetJmpMap(Function* Func) |
| 302 | { |
| 303 | if (SJMap[Func]) return SJMap[Func]; |
| 304 | |
| 305 | // Insert the setjmp map initialization before the first instruction in |
| 306 | // the function. |
Chris Lattner | 02a3be0 | 2003-09-20 14:39:18 +0000 | [diff] [blame] | 307 | Instruction* Inst = Func->getEntryBlock().begin(); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 308 | assert(Inst && "Couldn't find even ONE instruction in entry block!"); |
| 309 | |
| 310 | // Fill in the alloca and call to initialize the SJ map. |
Christopher Lamb | 43ad6b3 | 2007-12-17 01:12:55 +0000 | [diff] [blame] | 311 | const Type *SBPTy = PointerType::getUnqual(Type::Int8Ty); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 312 | AllocaInst* Map = new AllocaInst(SBPTy, 0, "SJMap", Inst); |
Chris Lattner | 93e985f | 2007-02-13 02:10:56 +0000 | [diff] [blame] | 313 | new CallInst(InitSJMap, Map, "", Inst); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 314 | return SJMap[Func] = Map; |
| 315 | } |
| 316 | |
| 317 | // GetRethrowBB - Only one rethrow basic block is needed per function. |
| 318 | // If this is a longjmp exception but not handled in this block, this BB |
| 319 | // performs the rethrow. |
| 320 | BasicBlock* LowerSetJmp::GetRethrowBB(Function* Func) |
| 321 | { |
| 322 | if (RethrowBBMap[Func]) return RethrowBBMap[Func]; |
| 323 | |
| 324 | // The basic block we're going to jump to if we need to rethrow the |
| 325 | // exception. |
| 326 | BasicBlock* Rethrow = new BasicBlock("RethrowExcept", Func); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 327 | |
| 328 | // Fill in the "Rethrow" BB with a call to rethrow the exception. This |
| 329 | // is the last instruction in the BB since at this point the runtime |
| 330 | // should exit this function and go to the next function. |
Chris Lattner | f8485c6 | 2003-11-20 18:25:24 +0000 | [diff] [blame] | 331 | new UnwindInst(Rethrow); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 332 | return RethrowBBMap[Func] = Rethrow; |
| 333 | } |
| 334 | |
| 335 | // GetSJSwitch - Return the switch statement that controls which handler |
| 336 | // (if any) gets called and the value returned to that handler. |
| 337 | LowerSetJmp::SwitchValuePair LowerSetJmp::GetSJSwitch(Function* Func, |
| 338 | BasicBlock* Rethrow) |
| 339 | { |
| 340 | if (SwitchValMap[Func].first) return SwitchValMap[Func]; |
| 341 | |
| 342 | BasicBlock* LongJmpPre = new BasicBlock("LongJmpBlkPre", Func); |
| 343 | BasicBlock::InstListType& LongJmpPreIL = LongJmpPre->getInstList(); |
| 344 | |
| 345 | // Keep track of the preliminary basic block for some of the other |
| 346 | // transformations. |
| 347 | PrelimBBMap[Func] = LongJmpPre; |
| 348 | |
| 349 | // Grab the exception. |
Chris Lattner | 93e985f | 2007-02-13 02:10:56 +0000 | [diff] [blame] | 350 | CallInst* Cond = new CallInst(IsLJException, "IsLJExcept"); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 351 | LongJmpPreIL.push_back(Cond); |
| 352 | |
| 353 | // The "decision basic block" gets the number associated with the |
| 354 | // setjmp call returning to switch on and the value returned by |
| 355 | // longjmp. |
| 356 | BasicBlock* DecisionBB = new BasicBlock("LJDecisionBB", Func); |
| 357 | BasicBlock::InstListType& DecisionBBIL = DecisionBB->getInstList(); |
| 358 | |
Chris Lattner | f8485c6 | 2003-11-20 18:25:24 +0000 | [diff] [blame] | 359 | new BranchInst(DecisionBB, Rethrow, Cond, LongJmpPre); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 360 | |
| 361 | // Fill in the "decision" basic block. |
Chris Lattner | 93e985f | 2007-02-13 02:10:56 +0000 | [diff] [blame] | 362 | CallInst* LJVal = new CallInst(GetLJValue, "LJVal"); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 363 | DecisionBBIL.push_back(LJVal); |
Chris Lattner | 93e985f | 2007-02-13 02:10:56 +0000 | [diff] [blame] | 364 | CallInst* SJNum = new CallInst(TryCatchLJ, GetSetJmpMap(Func), "SJNum"); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 365 | DecisionBBIL.push_back(SJNum); |
| 366 | |
Chris Lattner | 667fdae | 2005-01-29 00:38:45 +0000 | [diff] [blame] | 367 | SwitchInst* SI = new SwitchInst(SJNum, Rethrow, 0, DecisionBB); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 368 | return SwitchValMap[Func] = SwitchValuePair(SI, LJVal); |
| 369 | } |
| 370 | |
| 371 | // TransformSetJmpCall - The setjmp call is a bit trickier to transform. |
| 372 | // We're going to convert all setjmp calls to nops. Then all "call" and |
| 373 | // "invoke" instructions in the function are converted to "invoke" where |
| 374 | // the "except" branch is used when returning from a longjmp call. |
| 375 | void LowerSetJmp::TransformSetJmpCall(CallInst* Inst) |
| 376 | { |
| 377 | BasicBlock* ABlock = Inst->getParent(); |
| 378 | Function* Func = ABlock->getParent(); |
| 379 | |
| 380 | // Add this setjmp to the setjmp map. |
Christopher Lamb | 43ad6b3 | 2007-12-17 01:12:55 +0000 | [diff] [blame] | 381 | const Type* SBPTy = PointerType::getUnqual(Type::Int8Ty); |
Reid Spencer | 3da59db | 2006-11-27 01:05:10 +0000 | [diff] [blame] | 382 | CastInst* BufPtr = |
| 383 | new BitCastInst(Inst->getOperand(1), SBPTy, "SBJmpBuf", Inst); |
Chris Lattner | 93e985f | 2007-02-13 02:10:56 +0000 | [diff] [blame] | 384 | std::vector<Value*> Args = |
| 385 | make_vector<Value*>(GetSetJmpMap(Func), BufPtr, |
| 386 | ConstantInt::get(Type::Int32Ty, |
| 387 | SetJmpIDMap[Func]++), 0); |
David Greene | 52eec54 | 2007-08-01 03:43:44 +0000 | [diff] [blame] | 388 | new CallInst(AddSJToMap, Args.begin(), Args.end(), "", Inst); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 389 | |
Chris Lattner | d7222ec | 2003-11-06 19:18:49 +0000 | [diff] [blame] | 390 | // We are guaranteed that there are no values live across basic blocks |
| 391 | // (because we are "not in SSA form" yet), but there can still be values live |
| 392 | // in basic blocks. Because of this, splitting the setjmp block can cause |
| 393 | // values above the setjmp to not dominate uses which are after the setjmp |
| 394 | // call. For all of these occasions, we must spill the value to the stack. |
| 395 | // |
| 396 | std::set<Instruction*> InstrsAfterCall; |
| 397 | |
| 398 | // The call is probably very close to the end of the basic block, for the |
| 399 | // common usage pattern of: 'if (setjmp(...))', so keep track of the |
| 400 | // instructions after the call. |
| 401 | for (BasicBlock::iterator I = ++BasicBlock::iterator(Inst), E = ABlock->end(); |
| 402 | I != E; ++I) |
Misha Brukman | fd93908 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 403 | InstrsAfterCall.insert(I); |
Chris Lattner | d7222ec | 2003-11-06 19:18:49 +0000 | [diff] [blame] | 404 | |
| 405 | for (BasicBlock::iterator II = ABlock->begin(); |
| 406 | II != BasicBlock::iterator(Inst); ++II) |
| 407 | // Loop over all of the uses of instruction. If any of them are after the |
| 408 | // call, "spill" the value to the stack. |
| 409 | for (Value::use_iterator UI = II->use_begin(), E = II->use_end(); |
| 410 | UI != E; ++UI) |
| 411 | if (cast<Instruction>(*UI)->getParent() != ABlock || |
| 412 | InstrsAfterCall.count(cast<Instruction>(*UI))) { |
| 413 | DemoteRegToStack(*II); |
| 414 | break; |
| 415 | } |
| 416 | InstrsAfterCall.clear(); |
| 417 | |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 418 | // Change the setjmp call into a branch statement. We'll remove the |
| 419 | // setjmp call in a little bit. No worries. |
| 420 | BasicBlock* SetJmpContBlock = ABlock->splitBasicBlock(Inst); |
| 421 | assert(SetJmpContBlock && "Couldn't split setjmp BB!!"); |
| 422 | |
Chris Lattner | cb2d1a2 | 2005-04-21 16:46:46 +0000 | [diff] [blame] | 423 | SetJmpContBlock->setName(ABlock->getName()+"SetJmpCont"); |
| 424 | |
| 425 | // Add the SetJmpContBlock to the set of blocks reachable from a setjmp. |
| 426 | DFSBlocks.insert(SetJmpContBlock); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 427 | |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 428 | // This PHI node will be in the new block created from the |
| 429 | // splitBasicBlock call. |
Reid Spencer | c5b206b | 2006-12-31 05:48:39 +0000 | [diff] [blame] | 430 | PHINode* PHI = new PHINode(Type::Int32Ty, "SetJmpReturn", Inst); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 431 | |
| 432 | // Coming from a call to setjmp, the return is 0. |
Reid Spencer | c5b206b | 2006-12-31 05:48:39 +0000 | [diff] [blame] | 433 | PHI->addIncoming(ConstantInt::getNullValue(Type::Int32Ty), ABlock); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 434 | |
| 435 | // Add the case for this setjmp's number... |
| 436 | SwitchValuePair SVP = GetSJSwitch(Func, GetRethrowBB(Func)); |
Reid Spencer | c5b206b | 2006-12-31 05:48:39 +0000 | [diff] [blame] | 437 | SVP.first->addCase(ConstantInt::get(Type::Int32Ty, SetJmpIDMap[Func] - 1), |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 438 | SetJmpContBlock); |
| 439 | |
| 440 | // Value coming from the handling of the exception. |
| 441 | PHI->addIncoming(SVP.second, SVP.second->getParent()); |
| 442 | |
| 443 | // Replace all uses of this instruction with the PHI node created by |
| 444 | // the eradication of setjmp. |
| 445 | Inst->replaceAllUsesWith(PHI); |
| 446 | Inst->getParent()->getInstList().erase(Inst); |
| 447 | |
| 448 | ++SetJmpsTransformed; |
| 449 | } |
| 450 | |
| 451 | // visitCallInst - This converts all LLVM call instructions into invoke |
| 452 | // instructions. The except part of the invoke goes to the "LongJmpBlkPre" |
| 453 | // that grabs the exception and proceeds to determine if it's a longjmp |
| 454 | // exception or not. |
| 455 | void LowerSetJmp::visitCallInst(CallInst& CI) |
| 456 | { |
| 457 | if (CI.getCalledFunction()) |
| 458 | if (!IsTransformableFunction(CI.getCalledFunction()->getName()) || |
| 459 | CI.getCalledFunction()->isIntrinsic()) return; |
| 460 | |
| 461 | BasicBlock* OldBB = CI.getParent(); |
Chris Lattner | bb2d4de | 2003-10-13 00:57:16 +0000 | [diff] [blame] | 462 | |
| 463 | // If not reachable from a setjmp call, don't transform. |
| 464 | if (!DFSBlocks.count(OldBB)) return; |
| 465 | |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 466 | BasicBlock* NewBB = OldBB->splitBasicBlock(CI); |
| 467 | assert(NewBB && "Couldn't split BB of \"call\" instruction!!"); |
Chris Lattner | d286b24 | 2005-06-15 22:49:30 +0000 | [diff] [blame] | 468 | DFSBlocks.insert(NewBB); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 469 | NewBB->setName("Call2Invoke"); |
| 470 | |
Chris Lattner | 6d3906b | 2003-10-13 01:02:33 +0000 | [diff] [blame] | 471 | Function* Func = OldBB->getParent(); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 472 | |
| 473 | // Construct the new "invoke" instruction. |
| 474 | TerminatorInst* Term = OldBB->getTerminator(); |
| 475 | std::vector<Value*> Params(CI.op_begin() + 1, CI.op_end()); |
| 476 | InvokeInst* II = new |
| 477 | InvokeInst(CI.getCalledValue(), NewBB, PrelimBBMap[Func], |
David Greene | f1355a5 | 2007-08-27 19:04:21 +0000 | [diff] [blame] | 478 | Params.begin(), Params.end(), CI.getName(), Term); |
Duncan Sands | dc02467 | 2007-11-27 13:23:08 +0000 | [diff] [blame] | 479 | II->setCallingConv(CI.getCallingConv()); |
| 480 | II->setParamAttrs(CI.getParamAttrs()); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 481 | |
| 482 | // Replace the old call inst with the invoke inst and remove the call. |
| 483 | CI.replaceAllUsesWith(II); |
| 484 | CI.getParent()->getInstList().erase(&CI); |
| 485 | |
| 486 | // The old terminator is useless now that we have the invoke inst. |
| 487 | Term->getParent()->getInstList().erase(Term); |
Chris Lattner | fe2143d | 2003-10-28 23:14:59 +0000 | [diff] [blame] | 488 | ++CallsTransformed; |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 489 | } |
| 490 | |
| 491 | // visitInvokeInst - Converting the "invoke" instruction is fairly |
| 492 | // straight-forward. The old exception part is replaced by a query asking |
| 493 | // if this is a longjmp exception. If it is, then it goes to the longjmp |
| 494 | // exception blocks. Otherwise, control is passed the old exception. |
| 495 | void LowerSetJmp::visitInvokeInst(InvokeInst& II) |
| 496 | { |
| 497 | if (II.getCalledFunction()) |
| 498 | if (!IsTransformableFunction(II.getCalledFunction()->getName()) || |
| 499 | II.getCalledFunction()->isIntrinsic()) return; |
| 500 | |
Chris Lattner | bb2d4de | 2003-10-13 00:57:16 +0000 | [diff] [blame] | 501 | BasicBlock* BB = II.getParent(); |
Chris Lattner | bb2d4de | 2003-10-13 00:57:16 +0000 | [diff] [blame] | 502 | |
| 503 | // If not reachable from a setjmp call, don't transform. |
| 504 | if (!DFSBlocks.count(BB)) return; |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 505 | |
Chris Lattner | aeb2a1d | 2004-02-08 21:44:31 +0000 | [diff] [blame] | 506 | BasicBlock* ExceptBB = II.getUnwindDest(); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 507 | |
Chris Lattner | 6d3906b | 2003-10-13 01:02:33 +0000 | [diff] [blame] | 508 | Function* Func = BB->getParent(); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 509 | BasicBlock* NewExceptBB = new BasicBlock("InvokeExcept", Func); |
| 510 | BasicBlock::InstListType& InstList = NewExceptBB->getInstList(); |
| 511 | |
| 512 | // If this is a longjmp exception, then branch to the preliminary BB of |
| 513 | // the longjmp exception handling. Otherwise, go to the old exception. |
Chris Lattner | 93e985f | 2007-02-13 02:10:56 +0000 | [diff] [blame] | 514 | CallInst* IsLJExcept = new CallInst(IsLJException, "IsLJExcept"); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 515 | InstList.push_back(IsLJExcept); |
| 516 | |
Chris Lattner | f8485c6 | 2003-11-20 18:25:24 +0000 | [diff] [blame] | 517 | new BranchInst(PrelimBBMap[Func], ExceptBB, IsLJExcept, NewExceptBB); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 518 | |
Chris Lattner | aeb2a1d | 2004-02-08 21:44:31 +0000 | [diff] [blame] | 519 | II.setUnwindDest(NewExceptBB); |
Chris Lattner | fe2143d | 2003-10-28 23:14:59 +0000 | [diff] [blame] | 520 | ++InvokesTransformed; |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 521 | } |
| 522 | |
| 523 | // visitReturnInst - We want to destroy the setjmp map upon exit from the |
| 524 | // function. |
Chris Lattner | b12914b | 2004-09-20 04:48:05 +0000 | [diff] [blame] | 525 | void LowerSetJmp::visitReturnInst(ReturnInst &RI) { |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 526 | Function* Func = RI.getParent()->getParent(); |
Chris Lattner | 93e985f | 2007-02-13 02:10:56 +0000 | [diff] [blame] | 527 | new CallInst(DestroySJMap, GetSetJmpMap(Func), "", &RI); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 528 | } |
| 529 | |
| 530 | // visitUnwindInst - We want to destroy the setjmp map upon exit from the |
| 531 | // function. |
Chris Lattner | b12914b | 2004-09-20 04:48:05 +0000 | [diff] [blame] | 532 | void LowerSetJmp::visitUnwindInst(UnwindInst &UI) { |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 533 | Function* Func = UI.getParent()->getParent(); |
Chris Lattner | 93e985f | 2007-02-13 02:10:56 +0000 | [diff] [blame] | 534 | new CallInst(DestroySJMap, GetSetJmpMap(Func), "", &UI); |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 535 | } |
| 536 | |
Chris Lattner | b12914b | 2004-09-20 04:48:05 +0000 | [diff] [blame] | 537 | ModulePass *llvm::createLowerSetJmpPass() { |
Chris Lattner | 6420f1c | 2003-09-15 04:56:27 +0000 | [diff] [blame] | 538 | return new LowerSetJmp(); |
| 539 | } |
Brian Gaeke | d0fde30 | 2003-11-11 22:41:34 +0000 | [diff] [blame] | 540 | |