blob: ce505689e13ccf119fed6283839869fc21d54408 [file] [log] [blame]
Jim Grosbach8b818d72009-08-17 16:41:22 +00001//===- SjLjEHPass.cpp - Eliminate Invoke & Unwind instructions -----------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This transformation is designed for use by code generators which use SjLj
11// based exception handling.
12//
13//===----------------------------------------------------------------------===//
14
15#define DEBUG_TYPE "sjljehprepare"
16#include "llvm/Transforms/Scalar.h"
17#include "llvm/Constants.h"
18#include "llvm/DerivedTypes.h"
19#include "llvm/Instructions.h"
20#include "llvm/Intrinsics.h"
21#include "llvm/LLVMContext.h"
22#include "llvm/Module.h"
23#include "llvm/Pass.h"
24#include "llvm/CodeGen/Passes.h"
25#include "llvm/Transforms/Utils/BasicBlockUtils.h"
26#include "llvm/Transforms/Utils/Local.h"
27#include "llvm/ADT/Statistic.h"
Jim Grosbach606f3d62009-08-17 21:40:03 +000028#include "llvm/ADT/SmallVector.h"
Jim Grosbach8b818d72009-08-17 16:41:22 +000029#include "llvm/Support/CommandLine.h"
Jim Grosbach8b818d72009-08-17 16:41:22 +000030#include "llvm/Support/Debug.h"
31#include "llvm/Support/raw_ostream.h"
32#include "llvm/Target/TargetLowering.h"
Jim Grosbach8b818d72009-08-17 16:41:22 +000033using namespace llvm;
34
35STATISTIC(NumInvokes, "Number of invokes replaced");
36STATISTIC(NumUnwinds, "Number of unwinds replaced");
37STATISTIC(NumSpilled, "Number of registers live across unwind edges");
38
39namespace {
Nick Lewycky6726b6d2009-10-25 06:33:48 +000040 class SjLjEHPass : public FunctionPass {
Jim Grosbach8b818d72009-08-17 16:41:22 +000041
42 const TargetLowering *TLI;
43
44 const Type *FunctionContextTy;
45 Constant *RegisterFn;
46 Constant *UnregisterFn;
Jim Grosbach8b818d72009-08-17 16:41:22 +000047 Constant *BuiltinSetjmpFn;
48 Constant *FrameAddrFn;
Jim Grosbach0798edd2010-05-27 23:49:24 +000049 Constant *StackAddrFn;
50 Constant *StackRestoreFn;
Jim Grosbach8b818d72009-08-17 16:41:22 +000051 Constant *LSDAAddrFn;
52 Value *PersonalityFn;
Duncan Sandsb01bbdc2009-10-14 16:11:37 +000053 Constant *SelectorFn;
Jim Grosbach8b818d72009-08-17 16:41:22 +000054 Constant *ExceptionFn;
Jim Grosbachca752c92010-01-28 01:45:32 +000055 Constant *CallSiteFn;
Jim Grosbach8b818d72009-08-17 16:41:22 +000056
57 Value *CallSite;
58 public:
59 static char ID; // Pass identification, replacement for typeid
60 explicit SjLjEHPass(const TargetLowering *tli = NULL)
61 : FunctionPass(&ID), TLI(tli) { }
62 bool doInitialization(Module &M);
63 bool runOnFunction(Function &F);
64
65 virtual void getAnalysisUsage(AnalysisUsage &AU) const { }
66 const char *getPassName() const {
67 return "SJLJ Exception Handling preparation";
68 }
69
70 private:
Jim Grosbachb58a59b2010-03-04 22:07:46 +000071 void insertCallSiteStore(Instruction *I, int Number, Value *CallSite);
72 void markInvokeCallSite(InvokeInst *II, int InvokeNo, Value *CallSite,
Jim Grosbach0bb61c52009-08-31 01:35:03 +000073 SwitchInst *CatchSwitch);
Jim Grosbach606f3d62009-08-17 21:40:03 +000074 void splitLiveRangesLiveAcrossInvokes(SmallVector<InvokeInst*,16> &Invokes);
Jim Grosbach8b818d72009-08-17 16:41:22 +000075 bool insertSjLjEHSupport(Function &F);
76 };
77} // end anonymous namespace
78
79char SjLjEHPass::ID = 0;
80
81// Public Interface To the SjLjEHPass pass.
82FunctionPass *llvm::createSjLjEHPass(const TargetLowering *TLI) {
83 return new SjLjEHPass(TLI);
84}
Jim Grosbacha235d132009-08-23 18:13:48 +000085// doInitialization - Set up decalarations and types needed to process
86// exceptions.
Jim Grosbach8b818d72009-08-17 16:41:22 +000087bool SjLjEHPass::doInitialization(Module &M) {
88 // Build the function context structure.
89 // builtin_setjmp uses a five word jbuf
90 const Type *VoidPtrTy =
Duncan Sandsac53a0b2009-10-06 15:40:36 +000091 Type::getInt8PtrTy(M.getContext());
Jim Grosbach8b818d72009-08-17 16:41:22 +000092 const Type *Int32Ty = Type::getInt32Ty(M.getContext());
93 FunctionContextTy =
94 StructType::get(M.getContext(),
95 VoidPtrTy, // __prev
96 Int32Ty, // call_site
97 ArrayType::get(Int32Ty, 4), // __data
98 VoidPtrTy, // __personality
99 VoidPtrTy, // __lsda
100 ArrayType::get(VoidPtrTy, 5), // __jbuf
101 NULL);
102 RegisterFn = M.getOrInsertFunction("_Unwind_SjLj_Register",
103 Type::getVoidTy(M.getContext()),
104 PointerType::getUnqual(FunctionContextTy),
105 (Type *)0);
106 UnregisterFn =
107 M.getOrInsertFunction("_Unwind_SjLj_Unregister",
108 Type::getVoidTy(M.getContext()),
109 PointerType::getUnqual(FunctionContextTy),
110 (Type *)0);
Jim Grosbach8b818d72009-08-17 16:41:22 +0000111 FrameAddrFn = Intrinsic::getDeclaration(&M, Intrinsic::frameaddress);
Jim Grosbach0798edd2010-05-27 23:49:24 +0000112 StackAddrFn = Intrinsic::getDeclaration(&M, Intrinsic::stacksave);
113 StackRestoreFn = Intrinsic::getDeclaration(&M, Intrinsic::stackrestore);
Jim Grosbach8b818d72009-08-17 16:41:22 +0000114 BuiltinSetjmpFn = Intrinsic::getDeclaration(&M, Intrinsic::eh_sjlj_setjmp);
115 LSDAAddrFn = Intrinsic::getDeclaration(&M, Intrinsic::eh_sjlj_lsda);
Duncan Sandsb01bbdc2009-10-14 16:11:37 +0000116 SelectorFn = Intrinsic::getDeclaration(&M, Intrinsic::eh_selector);
Jim Grosbach8b818d72009-08-17 16:41:22 +0000117 ExceptionFn = Intrinsic::getDeclaration(&M, Intrinsic::eh_exception);
Jim Grosbachca752c92010-01-28 01:45:32 +0000118 CallSiteFn = Intrinsic::getDeclaration(&M, Intrinsic::eh_sjlj_callsite);
Jim Grosbacha235d132009-08-23 18:13:48 +0000119 PersonalityFn = 0;
Jim Grosbach8b818d72009-08-17 16:41:22 +0000120
121 return true;
122}
123
Jim Grosbachb58a59b2010-03-04 22:07:46 +0000124/// insertCallSiteStore - Insert a store of the call-site value to the
125/// function context
126void SjLjEHPass::insertCallSiteStore(Instruction *I, int Number,
127 Value *CallSite) {
128 ConstantInt *CallSiteNoC = ConstantInt::get(Type::getInt32Ty(I->getContext()),
129 Number);
130 // Insert a store of the call-site number
131 new StoreInst(CallSiteNoC, CallSite, true, I); // volatile
132}
133
Jim Grosbach8b818d72009-08-17 16:41:22 +0000134/// markInvokeCallSite - Insert code to mark the call_site for this invoke
Jim Grosbachb58a59b2010-03-04 22:07:46 +0000135void SjLjEHPass::markInvokeCallSite(InvokeInst *II, int InvokeNo,
Jim Grosbach0bb61c52009-08-31 01:35:03 +0000136 Value *CallSite,
137 SwitchInst *CatchSwitch) {
Jim Grosbach8b818d72009-08-17 16:41:22 +0000138 ConstantInt *CallSiteNoC= ConstantInt::get(Type::getInt32Ty(II->getContext()),
Jim Grosbachb58a59b2010-03-04 22:07:46 +0000139 InvokeNo);
Jim Grosbach0bb61c52009-08-31 01:35:03 +0000140 // The runtime comes back to the dispatcher with the call_site - 1 in
141 // the context. Odd, but there it is.
142 ConstantInt *SwitchValC = ConstantInt::get(Type::getInt32Ty(II->getContext()),
143 InvokeNo - 1);
Jim Grosbach8b818d72009-08-17 16:41:22 +0000144
145 // If the unwind edge has phi nodes, split the edge.
146 if (isa<PHINode>(II->getUnwindDest()->begin())) {
147 SplitCriticalEdge(II, 1, this);
148
149 // If there are any phi nodes left, they must have a single predecessor.
150 while (PHINode *PN = dyn_cast<PHINode>(II->getUnwindDest()->begin())) {
151 PN->replaceAllUsesWith(PN->getIncomingValue(0));
152 PN->eraseFromParent();
153 }
154 }
155
Jim Grosbachb58a59b2010-03-04 22:07:46 +0000156 // Insert the store of the call site value
157 insertCallSiteStore(II, InvokeNo, CallSite);
158
159 // Record the call site value for the back end so it stays associated with
160 // the invoke.
Jim Grosbachca752c92010-01-28 01:45:32 +0000161 CallInst::Create(CallSiteFn, CallSiteNoC, "", II);
Jim Grosbach8b818d72009-08-17 16:41:22 +0000162
Jim Grosbach0bb61c52009-08-31 01:35:03 +0000163 // Add a switch case to our unwind block.
164 CatchSwitch->addCase(SwitchValC, II->getUnwindDest());
Jim Grosbachca752c92010-01-28 01:45:32 +0000165 // We still want this to look like an invoke so we emit the LSDA properly,
166 // so we don't transform the invoke into a call here.
Jim Grosbach8b818d72009-08-17 16:41:22 +0000167}
168
169/// MarkBlocksLiveIn - Insert BB and all of its predescessors into LiveBBs until
170/// we reach blocks we've already seen.
171static void MarkBlocksLiveIn(BasicBlock *BB, std::set<BasicBlock*> &LiveBBs) {
172 if (!LiveBBs.insert(BB).second) return; // already been here.
173
174 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
175 MarkBlocksLiveIn(*PI, LiveBBs);
176}
177
Jim Grosbach606f3d62009-08-17 21:40:03 +0000178/// splitLiveRangesAcrossInvokes - Each value that is live across an unwind edge
179/// we spill into a stack location, guaranteeing that there is nothing live
180/// across the unwind edge. This process also splits all critical edges
181/// coming out of invoke's.
Jim Grosbach8b818d72009-08-17 16:41:22 +0000182void SjLjEHPass::
Jim Grosbach606f3d62009-08-17 21:40:03 +0000183splitLiveRangesLiveAcrossInvokes(SmallVector<InvokeInst*,16> &Invokes) {
Jim Grosbach8b818d72009-08-17 16:41:22 +0000184 // First step, split all critical edges from invoke instructions.
185 for (unsigned i = 0, e = Invokes.size(); i != e; ++i) {
186 InvokeInst *II = Invokes[i];
187 SplitCriticalEdge(II, 0, this);
188 SplitCriticalEdge(II, 1, this);
189 assert(!isa<PHINode>(II->getNormalDest()) &&
190 !isa<PHINode>(II->getUnwindDest()) &&
191 "critical edge splitting left single entry phi nodes?");
192 }
193
194 Function *F = Invokes.back()->getParent()->getParent();
195
196 // To avoid having to handle incoming arguments specially, we lower each arg
197 // to a copy instruction in the entry block. This ensures that the argument
198 // value itself cannot be live across the entry block.
199 BasicBlock::iterator AfterAllocaInsertPt = F->begin()->begin();
200 while (isa<AllocaInst>(AfterAllocaInsertPt) &&
201 isa<ConstantInt>(cast<AllocaInst>(AfterAllocaInsertPt)->getArraySize()))
202 ++AfterAllocaInsertPt;
203 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end();
204 AI != E; ++AI) {
205 // This is always a no-op cast because we're casting AI to AI->getType() so
206 // src and destination types are identical. BitCast is the only possibility.
207 CastInst *NC = new BitCastInst(
208 AI, AI->getType(), AI->getName()+".tmp", AfterAllocaInsertPt);
209 AI->replaceAllUsesWith(NC);
210 // Normally its is forbidden to replace a CastInst's operand because it
211 // could cause the opcode to reflect an illegal conversion. However, we're
212 // replacing it here with the same value it was constructed with to simply
213 // make NC its user.
214 NC->setOperand(0, AI);
215 }
216
217 // Finally, scan the code looking for instructions with bad live ranges.
218 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
219 for (BasicBlock::iterator II = BB->begin(), E = BB->end(); II != E; ++II) {
220 // Ignore obvious cases we don't have to handle. In particular, most
221 // instructions either have no uses or only have a single use inside the
222 // current block. Ignore them quickly.
223 Instruction *Inst = II;
224 if (Inst->use_empty()) continue;
225 if (Inst->hasOneUse() &&
226 cast<Instruction>(Inst->use_back())->getParent() == BB &&
227 !isa<PHINode>(Inst->use_back())) continue;
228
229 // If this is an alloca in the entry block, it's not a real register
230 // value.
231 if (AllocaInst *AI = dyn_cast<AllocaInst>(Inst))
232 if (isa<ConstantInt>(AI->getArraySize()) && BB == F->begin())
233 continue;
234
235 // Avoid iterator invalidation by copying users to a temporary vector.
Jim Grosbach606f3d62009-08-17 21:40:03 +0000236 SmallVector<Instruction*,16> Users;
Jim Grosbach8b818d72009-08-17 16:41:22 +0000237 for (Value::use_iterator UI = Inst->use_begin(), E = Inst->use_end();
238 UI != E; ++UI) {
239 Instruction *User = cast<Instruction>(*UI);
240 if (User->getParent() != BB || isa<PHINode>(User))
241 Users.push_back(User);
242 }
243
Jim Grosbach8b818d72009-08-17 16:41:22 +0000244 // Find all of the blocks that this value is live in.
245 std::set<BasicBlock*> LiveBBs;
246 LiveBBs.insert(Inst->getParent());
247 while (!Users.empty()) {
248 Instruction *U = Users.back();
249 Users.pop_back();
250
251 if (!isa<PHINode>(U)) {
252 MarkBlocksLiveIn(U->getParent(), LiveBBs);
253 } else {
254 // Uses for a PHI node occur in their predecessor block.
255 PHINode *PN = cast<PHINode>(U);
256 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
257 if (PN->getIncomingValue(i) == Inst)
258 MarkBlocksLiveIn(PN->getIncomingBlock(i), LiveBBs);
259 }
260 }
261
262 // Now that we know all of the blocks that this thing is live in, see if
263 // it includes any of the unwind locations.
264 bool NeedsSpill = false;
265 for (unsigned i = 0, e = Invokes.size(); i != e; ++i) {
266 BasicBlock *UnwindBlock = Invokes[i]->getUnwindDest();
267 if (UnwindBlock != BB && LiveBBs.count(UnwindBlock)) {
268 NeedsSpill = true;
269 }
270 }
271
272 // If we decided we need a spill, do it.
273 if (NeedsSpill) {
274 ++NumSpilled;
275 DemoteRegToStack(*Inst, true);
276 }
277 }
278}
279
280bool SjLjEHPass::insertSjLjEHSupport(Function &F) {
Jim Grosbach606f3d62009-08-17 21:40:03 +0000281 SmallVector<ReturnInst*,16> Returns;
282 SmallVector<UnwindInst*,16> Unwinds;
283 SmallVector<InvokeInst*,16> Invokes;
Jim Grosbach8b818d72009-08-17 16:41:22 +0000284
285 // Look through the terminators of the basic blocks to find invokes, returns
Jim Grosbachb58a59b2010-03-04 22:07:46 +0000286 // and unwinds.
287 for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB) {
Jim Grosbach8b818d72009-08-17 16:41:22 +0000288 if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
289 // Remember all return instructions in case we insert an invoke into this
290 // function.
291 Returns.push_back(RI);
292 } else if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator())) {
293 Invokes.push_back(II);
294 } else if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
295 Unwinds.push_back(UI);
296 }
Jim Grosbachb58a59b2010-03-04 22:07:46 +0000297 }
Jim Grosbach8b818d72009-08-17 16:41:22 +0000298 // If we don't have any invokes or unwinds, there's nothing to do.
299 if (Unwinds.empty() && Invokes.empty()) return false;
300
Jim Grosbach0798edd2010-05-27 23:49:24 +0000301 // Find the eh.selector.*, eh.exception and alloca calls.
302 //
303 // Remember any allocas() that aren't in the entry block, as the
304 // jmpbuf saved SP will need to be updated for them.
305 //
306 // We'll use the first eh.selector to determine the right personality
307 // function to use. For SJLJ, we always use the same personality for the
308 // whole function, not on a per-selector basis.
Jim Grosbacha235d132009-08-23 18:13:48 +0000309 // FIXME: That's a bit ugly. Better way?
310 SmallVector<CallInst*,16> EH_Selectors;
311 SmallVector<CallInst*,16> EH_Exceptions;
Jim Grosbach0798edd2010-05-27 23:49:24 +0000312 SmallVector<Instruction*,16> JmpbufUpdatePoints;
313 // Note: Skip the entry block since there's nothing there that interests
314 // us. eh.selector and eh.exception shouldn't ever be there, and we
315 // want to disregard any allocas that are there.
316 for (Function::iterator BB = F.begin(), E = F.end(); ++BB != E;) {
Jim Grosbacha235d132009-08-23 18:13:48 +0000317 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
318 if (CallInst *CI = dyn_cast<CallInst>(I)) {
Duncan Sandsb01bbdc2009-10-14 16:11:37 +0000319 if (CI->getCalledFunction() == SelectorFn) {
Eric Christopher551754c2010-04-16 23:37:20 +0000320 if (!PersonalityFn) PersonalityFn = CI->getOperand(2);
Jim Grosbacha235d132009-08-23 18:13:48 +0000321 EH_Selectors.push_back(CI);
322 } else if (CI->getCalledFunction() == ExceptionFn) {
323 EH_Exceptions.push_back(CI);
Jim Grosbach0798edd2010-05-27 23:49:24 +0000324 } else if (CI->getCalledFunction() == StackRestoreFn) {
325 JmpbufUpdatePoints.push_back(CI);
Jim Grosbacha235d132009-08-23 18:13:48 +0000326 }
Jim Grosbach0798edd2010-05-27 23:49:24 +0000327 } else if (AllocaInst *AI = dyn_cast<AllocaInst>(I)) {
328 JmpbufUpdatePoints.push_back(AI);
Jim Grosbacha235d132009-08-23 18:13:48 +0000329 }
330 }
331 }
332 // If we don't have any eh.selector calls, we can't determine the personality
333 // function. Without a personality function, we can't process exceptions.
334 if (!PersonalityFn) return false;
335
Jim Grosbach8b818d72009-08-17 16:41:22 +0000336 NumInvokes += Invokes.size();
337 NumUnwinds += Unwinds.size();
338
Jim Grosbach8b818d72009-08-17 16:41:22 +0000339 if (!Invokes.empty()) {
340 // We have invokes, so we need to add register/unregister calls to get
341 // this function onto the global unwind stack.
Jim Grosbach0bb61c52009-08-31 01:35:03 +0000342 //
343 // First thing we need to do is scan the whole function for values that are
344 // live across unwind edges. Each value that is live across an unwind edge
345 // we spill into a stack location, guaranteeing that there is nothing live
346 // across the unwind edge. This process also splits all critical edges
347 // coming out of invoke's.
348 splitLiveRangesLiveAcrossInvokes(Invokes);
Jim Grosbach8b818d72009-08-17 16:41:22 +0000349
350 BasicBlock *EntryBB = F.begin();
351 // Create an alloca for the incoming jump buffer ptr and the new jump buffer
352 // that needs to be restored on all exits from the function. This is an
353 // alloca because the value needs to be added to the global context list.
354 unsigned Align = 4; // FIXME: Should be a TLI check?
355 AllocaInst *FunctionContext =
356 new AllocaInst(FunctionContextTy, 0, Align,
357 "fcn_context", F.begin()->begin());
358
359 Value *Idxs[2];
360 const Type *Int32Ty = Type::getInt32Ty(F.getContext());
361 Value *Zero = ConstantInt::get(Int32Ty, 0);
362 // We need to also keep around a reference to the call_site field
363 Idxs[0] = Zero;
364 Idxs[1] = ConstantInt::get(Int32Ty, 1);
365 CallSite = GetElementPtrInst::Create(FunctionContext, Idxs, Idxs+2,
366 "call_site",
367 EntryBB->getTerminator());
368
369 // The exception selector comes back in context->data[1]
370 Idxs[1] = ConstantInt::get(Int32Ty, 2);
371 Value *FCData = GetElementPtrInst::Create(FunctionContext, Idxs, Idxs+2,
372 "fc_data",
373 EntryBB->getTerminator());
374 Idxs[1] = ConstantInt::get(Int32Ty, 1);
375 Value *SelectorAddr = GetElementPtrInst::Create(FCData, Idxs, Idxs+2,
376 "exc_selector_gep",
377 EntryBB->getTerminator());
378 // The exception value comes back in context->data[0]
379 Idxs[1] = Zero;
380 Value *ExceptionAddr = GetElementPtrInst::Create(FCData, Idxs, Idxs+2,
381 "exception_gep",
382 EntryBB->getTerminator());
383
Jim Grosbach8b818d72009-08-17 16:41:22 +0000384 // The result of the eh.selector call will be replaced with a
385 // a reference to the selector value returned in the function
386 // context. We leave the selector itself so the EH analysis later
387 // can use it.
388 for (int i = 0, e = EH_Selectors.size(); i < e; ++i) {
389 CallInst *I = EH_Selectors[i];
390 Value *SelectorVal = new LoadInst(SelectorAddr, "select_val", true, I);
391 I->replaceAllUsesWith(SelectorVal);
392 }
393 // eh.exception calls are replaced with references to the proper
394 // location in the context. Unlike eh.selector, the eh.exception
395 // calls are removed entirely.
396 for (int i = 0, e = EH_Exceptions.size(); i < e; ++i) {
397 CallInst *I = EH_Exceptions[i];
398 // Possible for there to be duplicates, so check to make sure
399 // the instruction hasn't already been removed.
400 if (!I->getParent()) continue;
401 Value *Val = new LoadInst(ExceptionAddr, "exception", true, I);
Duncan Sandsac53a0b2009-10-06 15:40:36 +0000402 const Type *Ty = Type::getInt8PtrTy(F.getContext());
Jim Grosbach606f3d62009-08-17 21:40:03 +0000403 Val = CastInst::Create(Instruction::IntToPtr, Val, Ty, "", I);
Jim Grosbach8b818d72009-08-17 16:41:22 +0000404
405 I->replaceAllUsesWith(Val);
406 I->eraseFromParent();
407 }
408
Jim Grosbach8b818d72009-08-17 16:41:22 +0000409 // The entry block changes to have the eh.sjlj.setjmp, with a conditional
410 // branch to a dispatch block for non-zero returns. If we return normally,
411 // we're not handling an exception and just register the function context
412 // and continue.
413
414 // Create the dispatch block. The dispatch block is basically a big switch
415 // statement that goes to all of the invoke landing pads.
416 BasicBlock *DispatchBlock =
417 BasicBlock::Create(F.getContext(), "eh.sjlj.setjmp.catch", &F);
418
419 // Insert a load in the Catch block, and a switch on its value. By default,
420 // we go to a block that just does an unwind (which is the correct action
421 // for a standard call).
Jim Grosbach03825f82010-01-15 00:32:47 +0000422 BasicBlock *UnwindBlock =
423 BasicBlock::Create(F.getContext(), "unwindbb", &F);
Jim Grosbach8b818d72009-08-17 16:41:22 +0000424 Unwinds.push_back(new UnwindInst(F.getContext(), UnwindBlock));
425
426 Value *DispatchLoad = new LoadInst(CallSite, "invoke.num", true,
427 DispatchBlock);
428 SwitchInst *DispatchSwitch =
Jim Grosbach03825f82010-01-15 00:32:47 +0000429 SwitchInst::Create(DispatchLoad, UnwindBlock, Invokes.size(),
430 DispatchBlock);
Jim Grosbach8b818d72009-08-17 16:41:22 +0000431 // Split the entry block to insert the conditional branch for the setjmp.
432 BasicBlock *ContBlock = EntryBB->splitBasicBlock(EntryBB->getTerminator(),
433 "eh.sjlj.setjmp.cont");
434
435 // Populate the Function Context
436 // 1. LSDA address
437 // 2. Personality function address
Jim Grosbach0798edd2010-05-27 23:49:24 +0000438 // 3. jmpbuf (save SP, FP and call eh.sjlj.setjmp)
Jim Grosbach8b818d72009-08-17 16:41:22 +0000439
440 // LSDA address
441 Idxs[0] = Zero;
442 Idxs[1] = ConstantInt::get(Int32Ty, 4);
443 Value *LSDAFieldPtr =
444 GetElementPtrInst::Create(FunctionContext, Idxs, Idxs+2,
445 "lsda_gep",
446 EntryBB->getTerminator());
447 Value *LSDA = CallInst::Create(LSDAAddrFn, "lsda_addr",
448 EntryBB->getTerminator());
449 new StoreInst(LSDA, LSDAFieldPtr, true, EntryBB->getTerminator());
450
451 Idxs[1] = ConstantInt::get(Int32Ty, 3);
452 Value *PersonalityFieldPtr =
453 GetElementPtrInst::Create(FunctionContext, Idxs, Idxs+2,
454 "lsda_gep",
455 EntryBB->getTerminator());
456 new StoreInst(PersonalityFn, PersonalityFieldPtr, true,
457 EntryBB->getTerminator());
458
Jim Grosbach0798edd2010-05-27 23:49:24 +0000459 // Save the frame pointer.
Jim Grosbach8b818d72009-08-17 16:41:22 +0000460 Idxs[1] = ConstantInt::get(Int32Ty, 5);
Jim Grosbach0798edd2010-05-27 23:49:24 +0000461 Value *JBufPtr
Jim Grosbach8b818d72009-08-17 16:41:22 +0000462 = GetElementPtrInst::Create(FunctionContext, Idxs, Idxs+2,
463 "jbuf_gep",
464 EntryBB->getTerminator());
465 Idxs[1] = ConstantInt::get(Int32Ty, 0);
Jim Grosbach0798edd2010-05-27 23:49:24 +0000466 Value *FramePtr =
467 GetElementPtrInst::Create(JBufPtr, Idxs, Idxs+2, "jbuf_fp_gep",
Jim Grosbach8b818d72009-08-17 16:41:22 +0000468 EntryBB->getTerminator());
469
470 Value *Val = CallInst::Create(FrameAddrFn,
471 ConstantInt::get(Int32Ty, 0),
472 "fp",
473 EntryBB->getTerminator());
Jim Grosbach0798edd2010-05-27 23:49:24 +0000474 new StoreInst(Val, FramePtr, true, EntryBB->getTerminator());
475
476 // Save the stack pointer.
477 Idxs[1] = ConstantInt::get(Int32Ty, 2);
478 Value *StackPtr =
479 GetElementPtrInst::Create(JBufPtr, Idxs, Idxs+2, "jbuf_sp_gep",
480 EntryBB->getTerminator());
481
482 Val = CallInst::Create(StackAddrFn, "sp", EntryBB->getTerminator());
483 new StoreInst(Val, StackPtr, true, EntryBB->getTerminator());
484
485 // Call the setjmp instrinsic. It fills in the rest of the jmpbuf.
Jim Grosbach8b818d72009-08-17 16:41:22 +0000486 Value *SetjmpArg =
Jim Grosbach0798edd2010-05-27 23:49:24 +0000487 CastInst::Create(Instruction::BitCast, JBufPtr,
Duncan Sandsac53a0b2009-10-06 15:40:36 +0000488 Type::getInt8PtrTy(F.getContext()), "",
489 EntryBB->getTerminator());
Jim Grosbach8b818d72009-08-17 16:41:22 +0000490 Value *DispatchVal = CallInst::Create(BuiltinSetjmpFn, SetjmpArg,
491 "dispatch",
492 EntryBB->getTerminator());
Jim Grosbach0798edd2010-05-27 23:49:24 +0000493 // check the return value of the setjmp. non-zero goes to dispatcher.
Jim Grosbach8b818d72009-08-17 16:41:22 +0000494 Value *IsNormal = new ICmpInst(EntryBB->getTerminator(),
495 ICmpInst::ICMP_EQ, DispatchVal, Zero,
496 "notunwind");
497 // Nuke the uncond branch.
498 EntryBB->getTerminator()->eraseFromParent();
499
500 // Put in a new condbranch in its place.
501 BranchInst::Create(ContBlock, DispatchBlock, IsNormal, EntryBB);
502
503 // Register the function context and make sure it's known to not throw
504 CallInst *Register =
505 CallInst::Create(RegisterFn, FunctionContext, "",
506 ContBlock->getTerminator());
507 Register->setDoesNotThrow();
508
Jim Grosbach0bb61c52009-08-31 01:35:03 +0000509 // At this point, we are all set up, update the invoke instructions
Jim Grosbach8b818d72009-08-17 16:41:22 +0000510 // to mark their call_site values, and fill in the dispatch switch
511 // accordingly.
Jim Grosbachf38a33c2010-01-21 20:10:22 +0000512 for (unsigned i = 0, e = Invokes.size(); i != e; ++i)
Jim Grosbach0bb61c52009-08-31 01:35:03 +0000513 markInvokeCallSite(Invokes[i], i+1, CallSite, DispatchSwitch);
Jim Grosbach8b818d72009-08-17 16:41:22 +0000514
Jim Grosbachb58a59b2010-03-04 22:07:46 +0000515 // Mark call instructions that aren't nounwind as no-action
516 // (call_site == -1). Skip the entry block, as prior to then, no function
517 // context has been created for this function and any unexpected exceptions
518 // thrown will go directly to the caller's context, which is what we want
519 // anyway, so no need to do anything here.
520 for (Function::iterator BB = F.begin(), E = F.end(); ++BB != E;) {
521 for (BasicBlock::iterator I = BB->begin(), end = BB->end(); I != end; ++I)
522 if (CallInst *CI = dyn_cast<CallInst>(I)) {
523 // Ignore calls to the EH builtins (eh.selector, eh.exception)
524 Constant *Callee = CI->getCalledFunction();
525 if (Callee != SelectorFn && Callee != ExceptionFn
526 && !CI->doesNotThrow())
527 insertCallSiteStore(CI, -1, CallSite);
Jim Grosbach8b818d72009-08-17 16:41:22 +0000528 }
Jim Grosbachb58a59b2010-03-04 22:07:46 +0000529 }
Jim Grosbach8b818d72009-08-17 16:41:22 +0000530
531 // Replace all unwinds with a branch to the unwind handler.
532 // ??? Should this ever happen with sjlj exceptions?
533 for (unsigned i = 0, e = Unwinds.size(); i != e; ++i) {
534 BranchInst::Create(UnwindBlock, Unwinds[i]);
535 Unwinds[i]->eraseFromParent();
536 }
537
Jim Grosbach0798edd2010-05-27 23:49:24 +0000538 // Following any allocas not in the entry block, update the saved SP
539 // in the jmpbuf to the new value.
540 for (unsigned i = 0, e = JmpbufUpdatePoints.size(); i != e; ++i) {
541 Instruction *AI = JmpbufUpdatePoints[i];
542 Instruction *StackAddr = CallInst::Create(StackAddrFn, "sp");
543 StackAddr->insertAfter(AI);
544 Instruction *StoreStackAddr = new StoreInst(StackAddr, StackPtr, true);
545 StoreStackAddr->insertAfter(StackAddr);
546 }
547
Jim Grosbach8b818d72009-08-17 16:41:22 +0000548 // Finally, for any returns from this function, if this function contains an
549 // invoke, add a call to unregister the function context.
550 for (unsigned i = 0, e = Returns.size(); i != e; ++i)
551 CallInst::Create(UnregisterFn, FunctionContext, "", Returns[i]);
552 }
553
554 return true;
555}
556
557bool SjLjEHPass::runOnFunction(Function &F) {
558 bool Res = insertSjLjEHSupport(F);
559 return Res;
560}