1 //===- LowerSetJmp.cpp - Code pertaining to lowering set/long jumps -------===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
10 // This file implements the lowering of setjmp and longjmp to use the
11 // LLVM invoke and unwind instructions as necessary.
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.
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.
27 //===----------------------------------------------------------------------===//
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 //===----------------------------------------------------------------------===//
36 #define DEBUG_TYPE "lowersetjmp"
37 #include "llvm/Transforms/IPO.h"
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"
44 #include "llvm/Support/CFG.h"
45 #include "llvm/Support/Compiler.h"
46 #include "llvm/Support/InstVisitor.h"
47 #include "llvm/Transforms/Utils/Local.h"
48 #include "llvm/ADT/DepthFirstIterator.h"
49 #include "llvm/ADT/Statistic.h"
50 #include "llvm/ADT/StringExtras.h"
51 #include "llvm/ADT/VectorExtras.h"
54 STATISTIC(LongJmpsTransformed, "Number of longjmps transformed");
55 STATISTIC(SetJmpsTransformed , "Number of setjmps transformed");
56 STATISTIC(CallsTransformed , "Number of calls invokified");
57 STATISTIC(InvokesTransformed , "Number of invokes modified");
60 //===--------------------------------------------------------------------===//
61 // LowerSetJmp pass implementation.
62 class VISIBILITY_HIDDEN LowerSetJmp : public ModulePass,
63 public InstVisitor<LowerSetJmp> {
64 // LLVM library functions...
65 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
73 typedef std::pair<SwitchInst*, CallInst*> SwitchValuePair;
75 // 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;
80 // 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;
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
88 std::map<const Function*, BasicBlock*> RethrowBBMap;
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;
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;
100 // A map of which setjmps we've seen so far in a function.
101 std::map<const Function*, unsigned> SetJmpIDMap;
103 AllocaInst* GetSetJmpMap(Function* Func);
104 BasicBlock* GetRethrowBB(Function* Func);
105 SwitchValuePair GetSJSwitch(Function* Func, BasicBlock* Rethrow);
107 void TransformLongJmpCall(CallInst* Inst);
108 void TransformSetJmpCall(CallInst* Inst);
110 bool IsTransformableFunction(const std::string& Name);
112 static const int ID; // Pass identifcation, replacement for typeid
113 LowerSetJmp() : ModulePass((intptr_t)&ID) {}
115 void visitCallInst(CallInst& CI);
116 void visitInvokeInst(InvokeInst& II);
117 void visitReturnInst(ReturnInst& RI);
118 void visitUnwindInst(UnwindInst& UI);
120 bool runOnModule(Module& M);
121 bool doInitialization(Module& M);
124 const int LowerSetJmp::ID = 0;
125 RegisterPass<LowerSetJmp> X("lowersetjmp", "Lower Set Jump");
126 } // end anonymous namespace
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.
131 bool LowerSetJmp::runOnModule(Module& M) {
132 bool Changed = false;
134 // These are what the functions are called.
135 Function* SetJmp = M.getFunction("llvm.setjmp");
136 Function* LongJmp = M.getFunction("llvm.longjmp");
138 // This program doesn't have longjmp and setjmp calls.
139 if ((!LongJmp || LongJmp->use_empty()) &&
140 (!SetJmp || SetJmp->use_empty())) return false;
142 // Initialize some values and functions we'll need to transform the
143 // setjmp/longjmp functions.
147 for (Value::use_iterator B = SetJmp->use_begin(), E = SetJmp->use_end();
149 BasicBlock* BB = cast<Instruction>(*B)->getParent();
150 for (df_ext_iterator<BasicBlock*> I = df_ext_begin(BB, DFSBlocks),
151 E = df_ext_end(BB, DFSBlocks); I != E; ++I)
155 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()));
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()));
171 // Now go through the affected functions and convert calls and 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; ) {
179 if (IB != BB->end() && IB->getParent() != BB)
180 break; // The next instruction got moved to a different block!
186 RethrowBBMap.clear();
188 SwitchValMap.clear();
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.
198 // This function is always successful, unless it isn't.
199 bool LowerSetJmp::doInitialization(Module& M)
201 const Type *SBPTy = PointerType::get(Type::Int8Ty);
202 const Type *SBPPTy = PointerType::get(SBPTy);
204 // N.B. See llvm/runtime/GCCLibraries/libexception/SJLJ-Exception.h for
205 // a description of the following library functions.
207 // void __llvm_sjljeh_init_setjmpmap(void**)
208 InitSJMap = M.getOrInsertFunction("__llvm_sjljeh_init_setjmpmap",
209 Type::VoidTy, SBPPTy, (Type *)0);
210 // void __llvm_sjljeh_destroy_setjmpmap(void**)
211 DestroySJMap = M.getOrInsertFunction("__llvm_sjljeh_destroy_setjmpmap",
212 Type::VoidTy, SBPPTy, (Type *)0);
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,
217 Type::Int32Ty, (Type *)0);
219 // void __llvm_sjljeh_throw_longjmp(int*, int)
220 ThrowLongJmp = M.getOrInsertFunction("__llvm_sjljeh_throw_longjmp",
221 Type::VoidTy, SBPTy, Type::Int32Ty,
224 // unsigned __llvm_sjljeh_try_catching_longjmp_exception(void **)
226 M.getOrInsertFunction("__llvm_sjljeh_try_catching_longjmp_exception",
227 Type::Int32Ty, SBPPTy, (Type *)0);
229 // bool __llvm_sjljeh_is_longjmp_exception()
230 IsLJException = M.getOrInsertFunction("__llvm_sjljeh_is_longjmp_exception",
231 Type::Int1Ty, (Type *)0);
233 // int __llvm_sjljeh_get_longjmp_value()
234 GetLJValue = M.getOrInsertFunction("__llvm_sjljeh_get_longjmp_value",
235 Type::Int32Ty, (Type *)0);
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
244 bool LowerSetJmp::IsTransformableFunction(const std::string& Name) {
245 std::string SJLJEh("__llvm_sjljeh");
247 if (Name.size() > SJLJEh.size())
248 return std::string(Name.begin(), Name.begin() + SJLJEh.size()) != SJLJEh;
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.
256 void LowerSetJmp::TransformLongJmpCall(CallInst* Inst)
258 const Type* SBPTy = PointerType::get(Type::Int8Ty);
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.
265 new BitCastInst(Inst->getOperand(1), SBPTy, "LJBuf", Inst);
266 new CallInst(ThrowLongJmp, CI, Inst->getOperand(2), "", Inst);
268 SwitchValuePair& SVP = SwitchValMap[Inst->getParent()->getParent()];
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.
274 new BranchInst(SVP.first->getParent(), Inst);
276 new UnwindInst(Inst);
278 // 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;
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);
290 ++LongJmpsTransformed;
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!
297 AllocaInst* LowerSetJmp::GetSetJmpMap(Function* Func)
299 if (SJMap[Func]) return SJMap[Func];
301 // Insert the setjmp map initialization before the first instruction in
303 Instruction* Inst = Func->getEntryBlock().begin();
304 assert(Inst && "Couldn't find even ONE instruction in entry block!");
306 // Fill in the alloca and call to initialize the SJ map.
307 const Type *SBPTy = PointerType::get(Type::Int8Ty);
308 AllocaInst* Map = new AllocaInst(SBPTy, 0, "SJMap", Inst);
309 new CallInst(InitSJMap, Map, "", Inst);
310 return SJMap[Func] = Map;
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.
316 BasicBlock* LowerSetJmp::GetRethrowBB(Function* Func)
318 if (RethrowBBMap[Func]) return RethrowBBMap[Func];
320 // The basic block we're going to jump to if we need to rethrow the
322 BasicBlock* Rethrow = new BasicBlock("RethrowExcept", Func);
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.
327 new UnwindInst(Rethrow);
328 return RethrowBBMap[Func] = Rethrow;
331 // GetSJSwitch - Return the switch statement that controls which handler
332 // (if any) gets called and the value returned to that handler.
333 LowerSetJmp::SwitchValuePair LowerSetJmp::GetSJSwitch(Function* Func,
336 if (SwitchValMap[Func].first) return SwitchValMap[Func];
338 BasicBlock* LongJmpPre = new BasicBlock("LongJmpBlkPre", Func);
339 BasicBlock::InstListType& LongJmpPreIL = LongJmpPre->getInstList();
341 // Keep track of the preliminary basic block for some of the other
343 PrelimBBMap[Func] = LongJmpPre;
345 // Grab the exception.
346 CallInst* Cond = new CallInst(IsLJException, "IsLJExcept");
347 LongJmpPreIL.push_back(Cond);
349 // The "decision basic block" gets the number associated with the
350 // setjmp call returning to switch on and the value returned by
352 BasicBlock* DecisionBB = new BasicBlock("LJDecisionBB", Func);
353 BasicBlock::InstListType& DecisionBBIL = DecisionBB->getInstList();
355 new BranchInst(DecisionBB, Rethrow, Cond, LongJmpPre);
357 // Fill in the "decision" basic block.
358 CallInst* LJVal = new CallInst(GetLJValue, "LJVal");
359 DecisionBBIL.push_back(LJVal);
360 CallInst* SJNum = new CallInst(TryCatchLJ, GetSetJmpMap(Func), "SJNum");
361 DecisionBBIL.push_back(SJNum);
363 SwitchInst* SI = new SwitchInst(SJNum, Rethrow, 0, DecisionBB);
364 return SwitchValMap[Func] = SwitchValuePair(SI, LJVal);
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.
371 void LowerSetJmp::TransformSetJmpCall(CallInst* Inst)
373 BasicBlock* ABlock = Inst->getParent();
374 Function* Func = ABlock->getParent();
376 // Add this setjmp to the setjmp map.
377 const Type* SBPTy = PointerType::get(Type::Int8Ty);
379 new BitCastInst(Inst->getOperand(1), SBPTy, "SBJmpBuf", Inst);
380 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);
386 // 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.
392 std::set<Instruction*> InstrsAfterCall;
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();
399 InstrsAfterCall.insert(I);
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();
407 if (cast<Instruction>(*UI)->getParent() != ABlock ||
408 InstrsAfterCall.count(cast<Instruction>(*UI))) {
409 DemoteRegToStack(*II);
412 InstrsAfterCall.clear();
414 // 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!!");
419 SetJmpContBlock->setName(ABlock->getName()+"SetJmpCont");
421 // Add the SetJmpContBlock to the set of blocks reachable from a setjmp.
422 DFSBlocks.insert(SetJmpContBlock);
424 // This PHI node will be in the new block created from the
425 // splitBasicBlock call.
426 PHINode* PHI = new PHINode(Type::Int32Ty, "SetJmpReturn", Inst);
428 // Coming from a call to setjmp, the return is 0.
429 PHI->addIncoming(ConstantInt::getNullValue(Type::Int32Ty), ABlock);
431 // Add the case for this setjmp's number...
432 SwitchValuePair SVP = GetSJSwitch(Func, GetRethrowBB(Func));
433 SVP.first->addCase(ConstantInt::get(Type::Int32Ty, SetJmpIDMap[Func] - 1),
436 // Value coming from the handling of the exception.
437 PHI->addIncoming(SVP.second, SVP.second->getParent());
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);
444 ++SetJmpsTransformed;
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
451 void LowerSetJmp::visitCallInst(CallInst& CI)
453 if (CI.getCalledFunction())
454 if (!IsTransformableFunction(CI.getCalledFunction()->getName()) ||
455 CI.getCalledFunction()->isIntrinsic()) return;
457 BasicBlock* OldBB = CI.getParent();
459 // If not reachable from a setjmp call, don't transform.
460 if (!DFSBlocks.count(OldBB)) return;
462 BasicBlock* NewBB = OldBB->splitBasicBlock(CI);
463 assert(NewBB && "Couldn't split BB of \"call\" instruction!!");
464 DFSBlocks.insert(NewBB);
465 NewBB->setName("Call2Invoke");
467 Function* Func = OldBB->getParent();
469 // Construct the new "invoke" instruction.
470 TerminatorInst* Term = OldBB->getTerminator();
471 std::vector<Value*> Params(CI.op_begin() + 1, CI.op_end());
473 InvokeInst(CI.getCalledValue(), NewBB, PrelimBBMap[Func],
474 &Params[0], Params.size(), CI.getName(), Term);
476 // Replace the old call inst with the invoke inst and remove the call.
477 CI.replaceAllUsesWith(II);
478 CI.getParent()->getInstList().erase(&CI);
480 // The old terminator is useless now that we have the invoke inst.
481 Term->getParent()->getInstList().erase(Term);
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.
489 void LowerSetJmp::visitInvokeInst(InvokeInst& II)
491 if (II.getCalledFunction())
492 if (!IsTransformableFunction(II.getCalledFunction()->getName()) ||
493 II.getCalledFunction()->isIntrinsic()) return;
495 BasicBlock* BB = II.getParent();
497 // If not reachable from a setjmp call, don't transform.
498 if (!DFSBlocks.count(BB)) return;
500 BasicBlock* ExceptBB = II.getUnwindDest();
502 Function* Func = BB->getParent();
503 BasicBlock* NewExceptBB = new BasicBlock("InvokeExcept", Func);
504 BasicBlock::InstListType& InstList = NewExceptBB->getInstList();
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.
508 CallInst* IsLJExcept = new CallInst(IsLJException, "IsLJExcept");
509 InstList.push_back(IsLJExcept);
511 new BranchInst(PrelimBBMap[Func], ExceptBB, IsLJExcept, NewExceptBB);
513 II.setUnwindDest(NewExceptBB);
514 ++InvokesTransformed;
517 // visitReturnInst - We want to destroy the setjmp map upon exit from the
519 void LowerSetJmp::visitReturnInst(ReturnInst &RI) {
520 Function* Func = RI.getParent()->getParent();
521 new CallInst(DestroySJMap, GetSetJmpMap(Func), "", &RI);
524 // visitUnwindInst - We want to destroy the setjmp map upon exit from the
526 void LowerSetJmp::visitUnwindInst(UnwindInst &UI) {
527 Function* Func = UI.getParent()->getParent();
528 new CallInst(DestroySJMap, GetSetJmpMap(Func), "", &UI);
531 ModulePass *llvm::createLowerSetJmpPass() {
532 return new LowerSetJmp();