blob: 1f83add34add71e667d0572a1398411f61f45452 [file] [log] [blame]
Chris Lattner6420f1c2003-09-15 04:56:27 +00001//===- LowerSetJmp.cpp - Code pertaining to lowering set/long jumps -------===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// 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 Brukmanfd939082005-04-21 23:48:37 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner6420f1c2003-09-15 04:56:27 +00009//
10// This file implements the lowering of setjmp and longjmp to use the
Chris Lattner77b398c2003-09-15 05:43:05 +000011// LLVM invoke and unwind instructions as necessary.
Chris Lattner6420f1c2003-09-15 04:56:27 +000012//
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 Lattner86453c52006-12-19 22:09:18 +000036#define DEBUG_TYPE "lowersetjmp"
Chris Lattner1e2385b2003-11-21 21:54:22 +000037#include "llvm/Transforms/IPO.h"
Chris Lattner6420f1c2003-09-15 04:56:27 +000038#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 Lattnerbb2d4de2003-10-13 00:57:16 +000044#include "llvm/Support/CFG.h"
Reid Spencer9133fe22007-02-05 23:32:05 +000045#include "llvm/Support/Compiler.h"
Chris Lattner6420f1c2003-09-15 04:56:27 +000046#include "llvm/Support/InstVisitor.h"
Chris Lattnera2dc7272004-03-14 02:13:38 +000047#include "llvm/Transforms/Utils/Local.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000048#include "llvm/ADT/DepthFirstIterator.h"
49#include "llvm/ADT/Statistic.h"
50#include "llvm/ADT/StringExtras.h"
51#include "llvm/ADT/VectorExtras.h"
Chris Lattner1e2385b2003-11-21 21:54:22 +000052using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000053
Chris Lattner86453c52006-12-19 22:09:18 +000054STATISTIC(LongJmpsTransformed, "Number of longjmps transformed");
55STATISTIC(SetJmpsTransformed , "Number of setjmps transformed");
56STATISTIC(CallsTransformed , "Number of calls invokified");
57STATISTIC(InvokesTransformed , "Number of invokes modified");
Chris Lattner6420f1c2003-09-15 04:56:27 +000058
Chris Lattner86453c52006-12-19 22:09:18 +000059namespace {
Chris Lattner6420f1c2003-09-15 04:56:27 +000060 //===--------------------------------------------------------------------===//
Chris Lattnerbc53e5e2004-10-07 06:00:24 +000061 // LowerSetJmp pass implementation.
Reid Spencer9133fe22007-02-05 23:32:05 +000062 class VISIBILITY_HIDDEN LowerSetJmp : public ModulePass,
Chris Lattner6420f1c2003-09-15 04:56:27 +000063 public InstVisitor<LowerSetJmp> {
64 // LLVM library functions...
Chris Lattner35057c22007-01-07 06:59:47 +000065 Constant *InitSJMap; // __llvm_sjljeh_init_setjmpmap
66 Constant *DestroySJMap; // __llvm_sjljeh_destroy_setjmpmap
67 Constant *AddSJToMap; // __llvm_sjljeh_add_setjmp_to_map
68 Constant *ThrowLongJmp; // __llvm_sjljeh_throw_longjmp
69 Constant *TryCatchLJ; // __llvm_sjljeh_try_catching_longjmp_exception
70 Constant *IsLJException; // __llvm_sjljeh_is_longjmp_exception
71 Constant *GetLJValue; // __llvm_sjljeh_get_longjmp_value
Chris Lattner6420f1c2003-09-15 04:56:27 +000072
73 typedef std::pair<SwitchInst*, CallInst*> SwitchValuePair;
74
Chris Lattnerbb2d4de2003-10-13 00:57:16 +000075 // Keep track of those basic blocks reachable via a depth-first search of
76 // the CFG from a setjmp call. We only need to transform those "call" and
77 // "invoke" instructions that are reachable from the setjmp call site.
78 std::set<BasicBlock*> DFSBlocks;
79
Chris Lattner6420f1c2003-09-15 04:56:27 +000080 // The setjmp map is going to hold information about which setjmps
81 // were called (each setjmp gets its own number) and with which
82 // buffer it was called.
83 std::map<Function*, AllocaInst*> SJMap;
84
85 // The rethrow basic block map holds the basic block to branch to if
86 // the exception isn't handled in the current function and needs to
87 // be rethrown.
88 std::map<const Function*, BasicBlock*> RethrowBBMap;
89
90 // The preliminary basic block map holds a basic block that grabs the
91 // exception and determines if it's handled by the current function.
92 std::map<const Function*, BasicBlock*> PrelimBBMap;
93
94 // The switch/value map holds a switch inst/call inst pair. The
95 // switch inst controls which handler (if any) gets called and the
96 // value is the value returned to that handler by the call to
97 // __llvm_sjljeh_get_longjmp_value.
98 std::map<const Function*, SwitchValuePair> SwitchValMap;
99
100 // A map of which setjmps we've seen so far in a function.
101 std::map<const Function*, unsigned> SetJmpIDMap;
102
103 AllocaInst* GetSetJmpMap(Function* Func);
104 BasicBlock* GetRethrowBB(Function* Func);
105 SwitchValuePair GetSJSwitch(Function* Func, BasicBlock* Rethrow);
106
107 void TransformLongJmpCall(CallInst* Inst);
108 void TransformSetJmpCall(CallInst* Inst);
109
110 bool IsTransformableFunction(const std::string& Name);
111 public:
Devang Patel19974732007-05-03 01:11:54 +0000112 static char ID; // Pass identifcation, replacement for typeid
Devang Patel794fd752007-05-01 21:15:47 +0000113 LowerSetJmp() : ModulePass((intptr_t)&ID) {}
114
Chris Lattner6420f1c2003-09-15 04:56:27 +0000115 void visitCallInst(CallInst& CI);
116 void visitInvokeInst(InvokeInst& II);
117 void visitReturnInst(ReturnInst& RI);
118 void visitUnwindInst(UnwindInst& UI);
119
Chris Lattnerb12914b2004-09-20 04:48:05 +0000120 bool runOnModule(Module& M);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000121 bool doInitialization(Module& M);
122 };
123
Devang Patel19974732007-05-03 01:11:54 +0000124 char LowerSetJmp::ID = 0;
Chris Lattner7f8897f2006-08-27 22:42:52 +0000125 RegisterPass<LowerSetJmp> X("lowersetjmp", "Lower Set Jump");
Chris Lattner6420f1c2003-09-15 04:56:27 +0000126} // end anonymous namespace
127
128// run - Run the transformation on the program. We grab the function
129// prototypes for longjmp and setjmp. If they are used in the program,
130// then we can go directly to the places they're at and transform them.
Chris Lattnerb12914b2004-09-20 04:48:05 +0000131bool LowerSetJmp::runOnModule(Module& M) {
Chris Lattner6420f1c2003-09-15 04:56:27 +0000132 bool Changed = false;
133
134 // These are what the functions are called.
Reid Spencer688b0492007-02-05 21:19:13 +0000135 Function* SetJmp = M.getFunction("llvm.setjmp");
136 Function* LongJmp = M.getFunction("llvm.longjmp");
Chris Lattner6420f1c2003-09-15 04:56:27 +0000137
138 // This program doesn't have longjmp and setjmp calls.
139 if ((!LongJmp || LongJmp->use_empty()) &&
140 (!SetJmp || SetJmp->use_empty())) return false;
141
142 // Initialize some values and functions we'll need to transform the
143 // setjmp/longjmp functions.
144 doInitialization(M);
145
Chris Lattnerbb2d4de2003-10-13 00:57:16 +0000146 if (SetJmp) {
Chris Lattnerbb2d4de2003-10-13 00:57:16 +0000147 for (Value::use_iterator B = SetJmp->use_begin(), E = SetJmp->use_end();
148 B != E; ++B) {
Chris Lattner6d3906b2003-10-13 01:02:33 +0000149 BasicBlock* BB = cast<Instruction>(*B)->getParent();
Chris Lattner8b716f62003-10-13 16:49:21 +0000150 for (df_ext_iterator<BasicBlock*> I = df_ext_begin(BB, DFSBlocks),
151 E = df_ext_end(BB, DFSBlocks); I != E; ++I)
Chris Lattner46e033d2003-10-13 16:44:50 +0000152 /* empty */;
Chris Lattnerbb2d4de2003-10-13 00:57:16 +0000153 }
154
Chris Lattner6420f1c2003-09-15 04:56:27 +0000155 while (!SetJmp->use_empty()) {
156 assert(isa<CallInst>(SetJmp->use_back()) &&
157 "User of setjmp intrinsic not a call?");
158 TransformSetJmpCall(cast<CallInst>(SetJmp->use_back()));
159 Changed = true;
160 }
Chris Lattnerbb2d4de2003-10-13 00:57:16 +0000161 }
Chris Lattner6420f1c2003-09-15 04:56:27 +0000162
163 if (LongJmp)
164 while (!LongJmp->use_empty()) {
165 assert(isa<CallInst>(LongJmp->use_back()) &&
166 "User of longjmp intrinsic not a call?");
167 TransformLongJmpCall(cast<CallInst>(LongJmp->use_back()));
168 Changed = true;
169 }
170
171 // Now go through the affected functions and convert calls and invokes
172 // to new invokes...
173 for (std::map<Function*, AllocaInst*>::iterator
174 B = SJMap.begin(), E = SJMap.end(); B != E; ++B) {
175 Function* F = B->first;
176 for (Function::iterator BB = F->begin(), BE = F->end(); BB != BE; ++BB)
177 for (BasicBlock::iterator IB = BB->begin(), IE = BB->end(); IB != IE; ) {
178 visit(*IB++);
179 if (IB != BB->end() && IB->getParent() != BB)
180 break; // The next instruction got moved to a different block!
181 }
182 }
183
Chris Lattnerbb2d4de2003-10-13 00:57:16 +0000184 DFSBlocks.clear();
Chris Lattner6420f1c2003-09-15 04:56:27 +0000185 SJMap.clear();
186 RethrowBBMap.clear();
187 PrelimBBMap.clear();
188 SwitchValMap.clear();
189 SetJmpIDMap.clear();
190
191 return Changed;
192}
193
194// doInitialization - For the lower long/setjmp pass, this ensures that a
195// module contains a declaration for the intrisic functions we are going
196// to call to convert longjmp and setjmp calls.
197//
198// This function is always successful, unless it isn't.
199bool LowerSetJmp::doInitialization(Module& M)
200{
Reid Spencerc5b206b2006-12-31 05:48:39 +0000201 const Type *SBPTy = PointerType::get(Type::Int8Ty);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000202 const Type *SBPPTy = PointerType::get(SBPTy);
203
204 // N.B. See llvm/runtime/GCCLibraries/libexception/SJLJ-Exception.h for
205 // a description of the following library functions.
206
207 // void __llvm_sjljeh_init_setjmpmap(void**)
208 InitSJMap = M.getOrInsertFunction("__llvm_sjljeh_init_setjmpmap",
Jeff Cohen66c5fd62005-10-23 04:37:20 +0000209 Type::VoidTy, SBPPTy, (Type *)0);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000210 // void __llvm_sjljeh_destroy_setjmpmap(void**)
211 DestroySJMap = M.getOrInsertFunction("__llvm_sjljeh_destroy_setjmpmap",
Jeff Cohen66c5fd62005-10-23 04:37:20 +0000212 Type::VoidTy, SBPPTy, (Type *)0);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000213
214 // void __llvm_sjljeh_add_setjmp_to_map(void**, void*, unsigned)
215 AddSJToMap = M.getOrInsertFunction("__llvm_sjljeh_add_setjmp_to_map",
216 Type::VoidTy, SBPPTy, SBPTy,
Reid Spencerc5b206b2006-12-31 05:48:39 +0000217 Type::Int32Ty, (Type *)0);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000218
219 // void __llvm_sjljeh_throw_longjmp(int*, int)
220 ThrowLongJmp = M.getOrInsertFunction("__llvm_sjljeh_throw_longjmp",
Reid Spencerc5b206b2006-12-31 05:48:39 +0000221 Type::VoidTy, SBPTy, Type::Int32Ty,
Jeff Cohen66c5fd62005-10-23 04:37:20 +0000222 (Type *)0);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000223
224 // unsigned __llvm_sjljeh_try_catching_longjmp_exception(void **)
225 TryCatchLJ =
226 M.getOrInsertFunction("__llvm_sjljeh_try_catching_longjmp_exception",
Reid Spencerc5b206b2006-12-31 05:48:39 +0000227 Type::Int32Ty, SBPPTy, (Type *)0);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000228
229 // bool __llvm_sjljeh_is_longjmp_exception()
230 IsLJException = M.getOrInsertFunction("__llvm_sjljeh_is_longjmp_exception",
Reid Spencer4fe16d62007-01-11 18:21:29 +0000231 Type::Int1Ty, (Type *)0);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000232
233 // int __llvm_sjljeh_get_longjmp_value()
234 GetLJValue = M.getOrInsertFunction("__llvm_sjljeh_get_longjmp_value",
Reid Spencerc5b206b2006-12-31 05:48:39 +0000235 Type::Int32Ty, (Type *)0);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000236 return true;
237}
238
239// IsTransformableFunction - Return true if the function name isn't one
240// of the ones we don't want transformed. Currently, don't transform any
241// "llvm.{setjmp,longjmp}" functions and none of the setjmp/longjmp error
242// handling functions (beginning with __llvm_sjljeh_...they don't throw
243// exceptions).
Chris Lattnercb2d1a22005-04-21 16:46:46 +0000244bool LowerSetJmp::IsTransformableFunction(const std::string& Name) {
Chris Lattner6420f1c2003-09-15 04:56:27 +0000245 std::string SJLJEh("__llvm_sjljeh");
246
Chris Lattner77b398c2003-09-15 05:43:05 +0000247 if (Name.size() > SJLJEh.size())
248 return std::string(Name.begin(), Name.begin() + SJLJEh.size()) != SJLJEh;
Chris Lattner6420f1c2003-09-15 04:56:27 +0000249
250 return true;
251}
252
253// TransformLongJmpCall - Transform a longjmp call into a call to the
254// internal __llvm_sjljeh_throw_longjmp function. It then takes care of
255// throwing the exception for us.
256void LowerSetJmp::TransformLongJmpCall(CallInst* Inst)
257{
Reid Spencerc5b206b2006-12-31 05:48:39 +0000258 const Type* SBPTy = PointerType::get(Type::Int8Ty);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000259
260 // Create the call to "__llvm_sjljeh_throw_longjmp". This takes the
261 // same parameters as "longjmp", except that the buffer is cast to a
262 // char*. It returns "void", so it doesn't need to replace any of
263 // Inst's uses and doesn't get a name.
Reid Spencer3da59db2006-11-27 01:05:10 +0000264 CastInst* CI =
265 new BitCastInst(Inst->getOperand(1), SBPTy, "LJBuf", Inst);
Chris Lattner93e985f2007-02-13 02:10:56 +0000266 new CallInst(ThrowLongJmp, CI, Inst->getOperand(2), "", Inst);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000267
268 SwitchValuePair& SVP = SwitchValMap[Inst->getParent()->getParent()];
269
270 // If the function has a setjmp call in it (they are transformed first)
271 // we should branch to the basic block that determines if this longjmp
272 // is applicable here. Otherwise, issue an unwind.
273 if (SVP.first)
274 new BranchInst(SVP.first->getParent(), Inst);
275 else
276 new UnwindInst(Inst);
277
Chris Lattner3987abd2005-05-05 15:47:43 +0000278 // Remove all insts after the branch/unwind inst. Go from back to front to
279 // avoid replaceAllUsesWith if possible.
280 BasicBlock *BB = Inst->getParent();
281 Instruction *Removed;
282 do {
283 Removed = &BB->back();
284 // If the removed instructions have any users, replace them now.
285 if (!Removed->use_empty())
286 Removed->replaceAllUsesWith(UndefValue::get(Removed->getType()));
287 Removed->eraseFromParent();
288 } while (Removed != Inst);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000289
290 ++LongJmpsTransformed;
291}
292
293// GetSetJmpMap - Retrieve (create and initialize, if necessary) the
294// setjmp map. This map is going to hold information about which setjmps
295// were called (each setjmp gets its own number) and with which buffer it
296// was called. There can be only one!
297AllocaInst* LowerSetJmp::GetSetJmpMap(Function* Func)
298{
299 if (SJMap[Func]) return SJMap[Func];
300
301 // Insert the setjmp map initialization before the first instruction in
302 // the function.
Chris Lattner02a3be02003-09-20 14:39:18 +0000303 Instruction* Inst = Func->getEntryBlock().begin();
Chris Lattner6420f1c2003-09-15 04:56:27 +0000304 assert(Inst && "Couldn't find even ONE instruction in entry block!");
305
306 // Fill in the alloca and call to initialize the SJ map.
Reid Spencerc5b206b2006-12-31 05:48:39 +0000307 const Type *SBPTy = PointerType::get(Type::Int8Ty);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000308 AllocaInst* Map = new AllocaInst(SBPTy, 0, "SJMap", Inst);
Chris Lattner93e985f2007-02-13 02:10:56 +0000309 new CallInst(InitSJMap, Map, "", Inst);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000310 return SJMap[Func] = Map;
311}
312
313// GetRethrowBB - Only one rethrow basic block is needed per function.
314// If this is a longjmp exception but not handled in this block, this BB
315// performs the rethrow.
316BasicBlock* LowerSetJmp::GetRethrowBB(Function* Func)
317{
318 if (RethrowBBMap[Func]) return RethrowBBMap[Func];
319
320 // The basic block we're going to jump to if we need to rethrow the
321 // exception.
322 BasicBlock* Rethrow = new BasicBlock("RethrowExcept", Func);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000323
324 // Fill in the "Rethrow" BB with a call to rethrow the exception. This
325 // is the last instruction in the BB since at this point the runtime
326 // should exit this function and go to the next function.
Chris Lattnerf8485c62003-11-20 18:25:24 +0000327 new UnwindInst(Rethrow);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000328 return RethrowBBMap[Func] = Rethrow;
329}
330
331// GetSJSwitch - Return the switch statement that controls which handler
332// (if any) gets called and the value returned to that handler.
333LowerSetJmp::SwitchValuePair LowerSetJmp::GetSJSwitch(Function* Func,
334 BasicBlock* Rethrow)
335{
336 if (SwitchValMap[Func].first) return SwitchValMap[Func];
337
338 BasicBlock* LongJmpPre = new BasicBlock("LongJmpBlkPre", Func);
339 BasicBlock::InstListType& LongJmpPreIL = LongJmpPre->getInstList();
340
341 // Keep track of the preliminary basic block for some of the other
342 // transformations.
343 PrelimBBMap[Func] = LongJmpPre;
344
345 // Grab the exception.
Chris Lattner93e985f2007-02-13 02:10:56 +0000346 CallInst* Cond = new CallInst(IsLJException, "IsLJExcept");
Chris Lattner6420f1c2003-09-15 04:56:27 +0000347 LongJmpPreIL.push_back(Cond);
348
349 // The "decision basic block" gets the number associated with the
350 // setjmp call returning to switch on and the value returned by
351 // longjmp.
352 BasicBlock* DecisionBB = new BasicBlock("LJDecisionBB", Func);
353 BasicBlock::InstListType& DecisionBBIL = DecisionBB->getInstList();
354
Chris Lattnerf8485c62003-11-20 18:25:24 +0000355 new BranchInst(DecisionBB, Rethrow, Cond, LongJmpPre);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000356
357 // Fill in the "decision" basic block.
Chris Lattner93e985f2007-02-13 02:10:56 +0000358 CallInst* LJVal = new CallInst(GetLJValue, "LJVal");
Chris Lattner6420f1c2003-09-15 04:56:27 +0000359 DecisionBBIL.push_back(LJVal);
Chris Lattner93e985f2007-02-13 02:10:56 +0000360 CallInst* SJNum = new CallInst(TryCatchLJ, GetSetJmpMap(Func), "SJNum");
Chris Lattner6420f1c2003-09-15 04:56:27 +0000361 DecisionBBIL.push_back(SJNum);
362
Chris Lattner667fdae2005-01-29 00:38:45 +0000363 SwitchInst* SI = new SwitchInst(SJNum, Rethrow, 0, DecisionBB);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000364 return SwitchValMap[Func] = SwitchValuePair(SI, LJVal);
365}
366
367// TransformSetJmpCall - The setjmp call is a bit trickier to transform.
368// We're going to convert all setjmp calls to nops. Then all "call" and
369// "invoke" instructions in the function are converted to "invoke" where
370// the "except" branch is used when returning from a longjmp call.
371void LowerSetJmp::TransformSetJmpCall(CallInst* Inst)
372{
373 BasicBlock* ABlock = Inst->getParent();
374 Function* Func = ABlock->getParent();
375
376 // Add this setjmp to the setjmp map.
Reid Spencerc5b206b2006-12-31 05:48:39 +0000377 const Type* SBPTy = PointerType::get(Type::Int8Ty);
Reid Spencer3da59db2006-11-27 01:05:10 +0000378 CastInst* BufPtr =
379 new BitCastInst(Inst->getOperand(1), SBPTy, "SBJmpBuf", Inst);
Chris Lattner93e985f2007-02-13 02:10:56 +0000380 std::vector<Value*> Args =
381 make_vector<Value*>(GetSetJmpMap(Func), BufPtr,
382 ConstantInt::get(Type::Int32Ty,
383 SetJmpIDMap[Func]++), 0);
384 new CallInst(AddSJToMap, &Args[0], Args.size(), "", Inst);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000385
Chris Lattnerd7222ec2003-11-06 19:18:49 +0000386 // We are guaranteed that there are no values live across basic blocks
387 // (because we are "not in SSA form" yet), but there can still be values live
388 // in basic blocks. Because of this, splitting the setjmp block can cause
389 // values above the setjmp to not dominate uses which are after the setjmp
390 // call. For all of these occasions, we must spill the value to the stack.
391 //
392 std::set<Instruction*> InstrsAfterCall;
393
394 // The call is probably very close to the end of the basic block, for the
395 // common usage pattern of: 'if (setjmp(...))', so keep track of the
396 // instructions after the call.
397 for (BasicBlock::iterator I = ++BasicBlock::iterator(Inst), E = ABlock->end();
398 I != E; ++I)
Misha Brukmanfd939082005-04-21 23:48:37 +0000399 InstrsAfterCall.insert(I);
Chris Lattnerd7222ec2003-11-06 19:18:49 +0000400
401 for (BasicBlock::iterator II = ABlock->begin();
402 II != BasicBlock::iterator(Inst); ++II)
403 // Loop over all of the uses of instruction. If any of them are after the
404 // call, "spill" the value to the stack.
405 for (Value::use_iterator UI = II->use_begin(), E = II->use_end();
406 UI != E; ++UI)
407 if (cast<Instruction>(*UI)->getParent() != ABlock ||
408 InstrsAfterCall.count(cast<Instruction>(*UI))) {
409 DemoteRegToStack(*II);
410 break;
411 }
412 InstrsAfterCall.clear();
413
Chris Lattner6420f1c2003-09-15 04:56:27 +0000414 // Change the setjmp call into a branch statement. We'll remove the
415 // setjmp call in a little bit. No worries.
416 BasicBlock* SetJmpContBlock = ABlock->splitBasicBlock(Inst);
417 assert(SetJmpContBlock && "Couldn't split setjmp BB!!");
418
Chris Lattnercb2d1a22005-04-21 16:46:46 +0000419 SetJmpContBlock->setName(ABlock->getName()+"SetJmpCont");
420
421 // Add the SetJmpContBlock to the set of blocks reachable from a setjmp.
422 DFSBlocks.insert(SetJmpContBlock);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000423
Chris Lattner6420f1c2003-09-15 04:56:27 +0000424 // This PHI node will be in the new block created from the
425 // splitBasicBlock call.
Reid Spencerc5b206b2006-12-31 05:48:39 +0000426 PHINode* PHI = new PHINode(Type::Int32Ty, "SetJmpReturn", Inst);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000427
428 // Coming from a call to setjmp, the return is 0.
Reid Spencerc5b206b2006-12-31 05:48:39 +0000429 PHI->addIncoming(ConstantInt::getNullValue(Type::Int32Ty), ABlock);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000430
431 // Add the case for this setjmp's number...
432 SwitchValuePair SVP = GetSJSwitch(Func, GetRethrowBB(Func));
Reid Spencerc5b206b2006-12-31 05:48:39 +0000433 SVP.first->addCase(ConstantInt::get(Type::Int32Ty, SetJmpIDMap[Func] - 1),
Chris Lattner6420f1c2003-09-15 04:56:27 +0000434 SetJmpContBlock);
435
436 // Value coming from the handling of the exception.
437 PHI->addIncoming(SVP.second, SVP.second->getParent());
438
439 // Replace all uses of this instruction with the PHI node created by
440 // the eradication of setjmp.
441 Inst->replaceAllUsesWith(PHI);
442 Inst->getParent()->getInstList().erase(Inst);
443
444 ++SetJmpsTransformed;
445}
446
447// visitCallInst - This converts all LLVM call instructions into invoke
448// instructions. The except part of the invoke goes to the "LongJmpBlkPre"
449// that grabs the exception and proceeds to determine if it's a longjmp
450// exception or not.
451void LowerSetJmp::visitCallInst(CallInst& CI)
452{
453 if (CI.getCalledFunction())
454 if (!IsTransformableFunction(CI.getCalledFunction()->getName()) ||
455 CI.getCalledFunction()->isIntrinsic()) return;
456
457 BasicBlock* OldBB = CI.getParent();
Chris Lattnerbb2d4de2003-10-13 00:57:16 +0000458
459 // If not reachable from a setjmp call, don't transform.
460 if (!DFSBlocks.count(OldBB)) return;
461
Chris Lattner6420f1c2003-09-15 04:56:27 +0000462 BasicBlock* NewBB = OldBB->splitBasicBlock(CI);
463 assert(NewBB && "Couldn't split BB of \"call\" instruction!!");
Chris Lattnerd286b242005-06-15 22:49:30 +0000464 DFSBlocks.insert(NewBB);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000465 NewBB->setName("Call2Invoke");
466
Chris Lattner6d3906b2003-10-13 01:02:33 +0000467 Function* Func = OldBB->getParent();
Chris Lattner6420f1c2003-09-15 04:56:27 +0000468
469 // Construct the new "invoke" instruction.
470 TerminatorInst* Term = OldBB->getTerminator();
471 std::vector<Value*> Params(CI.op_begin() + 1, CI.op_end());
472 InvokeInst* II = new
473 InvokeInst(CI.getCalledValue(), NewBB, PrelimBBMap[Func],
Chris Lattner93e985f2007-02-13 02:10:56 +0000474 &Params[0], Params.size(), CI.getName(), Term);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000475
476 // Replace the old call inst with the invoke inst and remove the call.
477 CI.replaceAllUsesWith(II);
478 CI.getParent()->getInstList().erase(&CI);
479
480 // The old terminator is useless now that we have the invoke inst.
481 Term->getParent()->getInstList().erase(Term);
Chris Lattnerfe2143d2003-10-28 23:14:59 +0000482 ++CallsTransformed;
Chris Lattner6420f1c2003-09-15 04:56:27 +0000483}
484
485// visitInvokeInst - Converting the "invoke" instruction is fairly
486// straight-forward. The old exception part is replaced by a query asking
487// if this is a longjmp exception. If it is, then it goes to the longjmp
488// exception blocks. Otherwise, control is passed the old exception.
489void LowerSetJmp::visitInvokeInst(InvokeInst& II)
490{
491 if (II.getCalledFunction())
492 if (!IsTransformableFunction(II.getCalledFunction()->getName()) ||
493 II.getCalledFunction()->isIntrinsic()) return;
494
Chris Lattnerbb2d4de2003-10-13 00:57:16 +0000495 BasicBlock* BB = II.getParent();
Chris Lattnerbb2d4de2003-10-13 00:57:16 +0000496
497 // If not reachable from a setjmp call, don't transform.
498 if (!DFSBlocks.count(BB)) return;
Chris Lattner6420f1c2003-09-15 04:56:27 +0000499
Chris Lattneraeb2a1d2004-02-08 21:44:31 +0000500 BasicBlock* ExceptBB = II.getUnwindDest();
Chris Lattner6420f1c2003-09-15 04:56:27 +0000501
Chris Lattner6d3906b2003-10-13 01:02:33 +0000502 Function* Func = BB->getParent();
Chris Lattner6420f1c2003-09-15 04:56:27 +0000503 BasicBlock* NewExceptBB = new BasicBlock("InvokeExcept", Func);
504 BasicBlock::InstListType& InstList = NewExceptBB->getInstList();
505
506 // If this is a longjmp exception, then branch to the preliminary BB of
507 // the longjmp exception handling. Otherwise, go to the old exception.
Chris Lattner93e985f2007-02-13 02:10:56 +0000508 CallInst* IsLJExcept = new CallInst(IsLJException, "IsLJExcept");
Chris Lattner6420f1c2003-09-15 04:56:27 +0000509 InstList.push_back(IsLJExcept);
510
Chris Lattnerf8485c62003-11-20 18:25:24 +0000511 new BranchInst(PrelimBBMap[Func], ExceptBB, IsLJExcept, NewExceptBB);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000512
Chris Lattneraeb2a1d2004-02-08 21:44:31 +0000513 II.setUnwindDest(NewExceptBB);
Chris Lattnerfe2143d2003-10-28 23:14:59 +0000514 ++InvokesTransformed;
Chris Lattner6420f1c2003-09-15 04:56:27 +0000515}
516
517// visitReturnInst - We want to destroy the setjmp map upon exit from the
518// function.
Chris Lattnerb12914b2004-09-20 04:48:05 +0000519void LowerSetJmp::visitReturnInst(ReturnInst &RI) {
Chris Lattner6420f1c2003-09-15 04:56:27 +0000520 Function* Func = RI.getParent()->getParent();
Chris Lattner93e985f2007-02-13 02:10:56 +0000521 new CallInst(DestroySJMap, GetSetJmpMap(Func), "", &RI);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000522}
523
524// visitUnwindInst - We want to destroy the setjmp map upon exit from the
525// function.
Chris Lattnerb12914b2004-09-20 04:48:05 +0000526void LowerSetJmp::visitUnwindInst(UnwindInst &UI) {
Chris Lattner6420f1c2003-09-15 04:56:27 +0000527 Function* Func = UI.getParent()->getParent();
Chris Lattner93e985f2007-02-13 02:10:56 +0000528 new CallInst(DestroySJMap, GetSetJmpMap(Func), "", &UI);
Chris Lattner6420f1c2003-09-15 04:56:27 +0000529}
530
Chris Lattnerb12914b2004-09-20 04:48:05 +0000531ModulePass *llvm::createLowerSetJmpPass() {
Chris Lattner6420f1c2003-09-15 04:56:27 +0000532 return new LowerSetJmp();
533}
Brian Gaeked0fde302003-11-11 22:41:34 +0000534