blob: 884f4fce9196c1564edc3dd768a6f08e011fa70b [file] [log] [blame]
Chris Lattner86e44452003-10-05 19:14:42 +00001//===- LowerInvoke.cpp - Eliminate Invoke & Unwind instructions -----------===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanfd939082005-04-21 23:48:37 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner86e44452003-10-05 19:14:42 +00009//
10// This transformation is designed for use by code generators which do not yet
Chris Lattner6d784572004-02-08 19:53:56 +000011// support stack unwinding. This pass supports two models of exception handling
12// lowering, the 'cheap' support and the 'expensive' support.
13//
14// 'Cheap' exception handling support gives the program the ability to execute
15// any program which does not "throw an exception", by turning 'invoke'
16// instructions into calls and by turning 'unwind' instructions into calls to
17// abort(). If the program does dynamically use the unwind instruction, the
18// program will print a message then abort.
19//
20// 'Expensive' exception handling support gives the full exception handling
John Criswellfe3706a2005-05-02 14:47:42 +000021// support to the program at the cost of making the 'invoke' instruction
22// really expensive. It basically inserts setjmp/longjmp calls to emulate the
23// exception handling as necessary.
Chris Lattner6d784572004-02-08 19:53:56 +000024//
25// Because the 'expensive' support slows down programs a lot, and EH is only
26// used for a subset of the programs, it must be specifically enabled by an
27// option.
Chris Lattner86e44452003-10-05 19:14:42 +000028//
Chris Lattner0e28eca2004-03-31 22:00:30 +000029// Note that after this pass runs the CFG is not entirely accurate (exceptional
30// control flow edges are not correct anymore) so only very simple things should
31// be done after the lowerinvoke pass has run (like generation of native code).
32// This should not be used as a general purpose "my LLVM-to-LLVM pass doesn't
33// support the invoke instruction yet" lowering pass.
34//
Chris Lattner86e44452003-10-05 19:14:42 +000035//===----------------------------------------------------------------------===//
36
Chris Lattnerd216e8b2006-12-19 22:17:40 +000037#define DEBUG_TYPE "lowerinvoke"
Chris Lattner86e44452003-10-05 19:14:42 +000038#include "llvm/Transforms/Scalar.h"
Chris Lattnere1c09302004-02-08 07:30:29 +000039#include "llvm/Constants.h"
40#include "llvm/DerivedTypes.h"
Chris Lattner6d784572004-02-08 19:53:56 +000041#include "llvm/Instructions.h"
Duncan Sandsa1220432008-04-07 13:41:19 +000042#include "llvm/Intrinsics.h"
Chris Lattnere1c09302004-02-08 07:30:29 +000043#include "llvm/Module.h"
Chris Lattner86e44452003-10-05 19:14:42 +000044#include "llvm/Pass.h"
Chris Lattner6d784572004-02-08 19:53:56 +000045#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +000046#include "llvm/Transforms/Utils/Local.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000047#include "llvm/ADT/Statistic.h"
48#include "llvm/Support/CommandLine.h"
Chris Lattnera4f0b3a2006-08-27 12:54:02 +000049#include "llvm/Support/Compiler.h"
Duraid Madina2a0013f2006-09-04 06:21:35 +000050#include "llvm/Target/TargetLowering.h"
Chris Lattner6d784572004-02-08 19:53:56 +000051#include <csetjmp>
Reid Spencer6734b572007-02-04 00:40:42 +000052#include <set>
Chris Lattnerdead9932003-12-10 20:22:42 +000053using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000054
Chris Lattnerd216e8b2006-12-19 22:17:40 +000055STATISTIC(NumInvokes, "Number of invokes replaced");
56STATISTIC(NumUnwinds, "Number of unwinds replaced");
57STATISTIC(NumSpilled, "Number of registers live across unwind edges");
58
59static cl::opt<bool> ExpensiveEHSupport("enable-correct-eh-support",
Chris Lattner6d784572004-02-08 19:53:56 +000060 cl::desc("Make the -lowerinvoke pass insert expensive, but correct, EH code"));
Chris Lattner86e44452003-10-05 19:14:42 +000061
Chris Lattnerd216e8b2006-12-19 22:17:40 +000062namespace {
Chris Lattnerf4b54612006-06-28 22:08:15 +000063 class VISIBILITY_HIDDEN LowerInvoke : public FunctionPass {
Chris Lattner6d784572004-02-08 19:53:56 +000064 // Used for both models.
Chris Lattnerb76efb72007-01-07 08:12:01 +000065 Constant *WriteFn;
66 Constant *AbortFn;
Chris Lattner6d784572004-02-08 19:53:56 +000067 Value *AbortMessage;
68 unsigned AbortMessageLength;
69
70 // Used for expensive EH support.
71 const Type *JBLinkTy;
72 GlobalVariable *JBListHead;
Chris Lattnerb76efb72007-01-07 08:12:01 +000073 Constant *SetJmpFn, *LongJmpFn;
Duraid Madina2a0013f2006-09-04 06:21:35 +000074
75 // We peek in TLI to grab the target's jmp_buf size and alignment
76 const TargetLowering *TLI;
77
Chris Lattner86e44452003-10-05 19:14:42 +000078 public:
Nick Lewyckyecd94c82007-05-06 13:37:16 +000079 static char ID; // Pass identification, replacement for typeid
Dan Gohmanc2bbfc12007-08-01 15:32:29 +000080 explicit LowerInvoke(const TargetLowering *tli = NULL)
81 : FunctionPass((intptr_t)&ID), TLI(tli) { }
Chris Lattner86e44452003-10-05 19:14:42 +000082 bool doInitialization(Module &M);
83 bool runOnFunction(Function &F);
Chris Lattnered96fe82006-05-17 21:05:27 +000084
85 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Anton Korobeynikovbed29462007-04-16 18:10:23 +000086 // This is a cluster of orthogonal Transforms
Chris Lattnered96fe82006-05-17 21:05:27 +000087 AU.addPreservedID(PromoteMemoryToRegisterID);
Chris Lattnered96fe82006-05-17 21:05:27 +000088 AU.addPreservedID(LowerSwitchID);
89 AU.addPreservedID(LowerAllocationsID);
90 }
91
Chris Lattner6d784572004-02-08 19:53:56 +000092 private:
Chris Lattnerb76efb72007-01-07 08:12:01 +000093 void createAbortMessage(Module *M);
Chris Lattner501825e2004-02-08 22:14:44 +000094 void writeAbortMessage(Instruction *IB);
Chris Lattner6d784572004-02-08 19:53:56 +000095 bool insertCheapEHSupport(Function &F);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +000096 void splitLiveRangesLiveAcrossInvokes(std::vector<InvokeInst*> &Invokes);
97 void rewriteExpensiveInvoke(InvokeInst *II, unsigned InvokeNo,
98 AllocaInst *InvokeNum, SwitchInst *CatchSwitch);
Chris Lattner6d784572004-02-08 19:53:56 +000099 bool insertExpensiveEHSupport(Function &F);
Chris Lattner86e44452003-10-05 19:14:42 +0000100 };
101
Devang Patel19974732007-05-03 01:11:54 +0000102 char LowerInvoke::ID = 0;
Chris Lattner7f8897f2006-08-27 22:42:52 +0000103 RegisterPass<LowerInvoke>
Chris Lattner86e44452003-10-05 19:14:42 +0000104 X("lowerinvoke", "Lower invoke and unwind, for unwindless code generators");
105}
106
Chris Lattnercefc18e2004-02-13 16:16:16 +0000107const PassInfo *llvm::LowerInvokePassID = X.getPassInfo();
108
Brian Gaeked0fde302003-11-11 22:41:34 +0000109// Public Interface To the LowerInvoke pass.
Duraid Madina2a0013f2006-09-04 06:21:35 +0000110FunctionPass *llvm::createLowerInvokePass(const TargetLowering *TLI) {
111 return new LowerInvoke(TLI);
Nate Begeman14b05292005-11-05 09:21:28 +0000112}
Chris Lattner86e44452003-10-05 19:14:42 +0000113
114// doInitialization - Make sure that there is a prototype for abort in the
115// current module.
116bool LowerInvoke::doInitialization(Module &M) {
Christopher Lamb43ad6b32007-12-17 01:12:55 +0000117 const Type *VoidPtrTy = PointerType::getUnqual(Type::Int8Ty);
Jim Laskey7d485382007-02-22 16:21:18 +0000118 AbortMessage = 0;
119 if (ExpensiveEHSupport) {
120 // Insert a type for the linked list of jump buffers.
121 unsigned JBSize = TLI ? TLI->getJumpBufSize() : 0;
122 JBSize = JBSize ? JBSize : 200;
123 const Type *JmpBufTy = ArrayType::get(VoidPtrTy, JBSize);
Chris Lattnere1c09302004-02-08 07:30:29 +0000124
Jim Laskey7d485382007-02-22 16:21:18 +0000125 { // The type is recursive, so use a type holder.
126 std::vector<const Type*> Elements;
127 Elements.push_back(JmpBufTy);
128 OpaqueType *OT = OpaqueType::get();
Christopher Lamb43ad6b32007-12-17 01:12:55 +0000129 Elements.push_back(PointerType::getUnqual(OT));
Jim Laskey7d485382007-02-22 16:21:18 +0000130 PATypeHolder JBLType(StructType::get(Elements));
131 OT->refineAbstractTypeTo(JBLType.get()); // Complete the cycle.
132 JBLinkTy = JBLType.get();
133 M.addTypeName("llvm.sjljeh.jmpbufty", JBLinkTy);
Chris Lattner6d784572004-02-08 19:53:56 +0000134 }
135
Christopher Lamb43ad6b32007-12-17 01:12:55 +0000136 const Type *PtrJBList = PointerType::getUnqual(JBLinkTy);
Jim Laskey7d485382007-02-22 16:21:18 +0000137
138 // Now that we've done that, insert the jmpbuf list head global, unless it
139 // already exists.
140 if (!(JBListHead = M.getGlobalVariable("llvm.sjljeh.jblist", PtrJBList))) {
141 JBListHead = new GlobalVariable(PtrJBList, false,
142 GlobalValue::LinkOnceLinkage,
143 Constant::getNullValue(PtrJBList),
144 "llvm.sjljeh.jblist", &M);
145 }
Duncan Sandsa1220432008-04-07 13:41:19 +0000146 SetJmpFn = Intrinsic::getDeclaration(&M, Intrinsic::setjmp);
147 LongJmpFn = Intrinsic::getDeclaration(&M, Intrinsic::longjmp);
Chris Lattner6d784572004-02-08 19:53:56 +0000148 }
Jim Laskey7d485382007-02-22 16:21:18 +0000149
150 // We need the 'write' and 'abort' functions for both models.
151 AbortFn = M.getOrInsertFunction("abort", Type::VoidTy, (Type *)0);
Jeff Cohen09b362c2007-04-20 22:40:10 +0000152#if 0 // "write" is Unix-specific.. code is going away soon anyway.
Jim Laskey7d485382007-02-22 16:21:18 +0000153 WriteFn = M.getOrInsertFunction("write", Type::VoidTy, Type::Int32Ty,
154 VoidPtrTy, Type::Int32Ty, (Type *)0);
Jeff Cohen09b362c2007-04-20 22:40:10 +0000155#else
156 WriteFn = 0;
157#endif
Chris Lattner86e44452003-10-05 19:14:42 +0000158 return true;
159}
160
Chris Lattnerb76efb72007-01-07 08:12:01 +0000161void LowerInvoke::createAbortMessage(Module *M) {
Chris Lattner0c3b3902004-11-13 19:07:32 +0000162 if (ExpensiveEHSupport) {
163 // The abort message for expensive EH support tells the user that the
164 // program 'unwound' without an 'invoke' instruction.
165 Constant *Msg =
166 ConstantArray::get("ERROR: Exception thrown, but not caught!\n");
167 AbortMessageLength = Msg->getNumOperands()-1; // don't include \0
Misha Brukmanfd939082005-04-21 23:48:37 +0000168
Chris Lattner0c3b3902004-11-13 19:07:32 +0000169 GlobalVariable *MsgGV = new GlobalVariable(Msg->getType(), true,
170 GlobalValue::InternalLinkage,
Chris Lattnerb76efb72007-01-07 08:12:01 +0000171 Msg, "abortmsg", M);
Reid Spencerc5b206b2006-12-31 05:48:39 +0000172 std::vector<Constant*> GEPIdx(2, Constant::getNullValue(Type::Int32Ty));
Chris Lattnerec1f7522007-02-19 07:34:47 +0000173 AbortMessage = ConstantExpr::getGetElementPtr(MsgGV, &GEPIdx[0], 2);
Chris Lattner0c3b3902004-11-13 19:07:32 +0000174 } else {
175 // The abort message for cheap EH support tells the user that EH is not
176 // enabled.
177 Constant *Msg =
178 ConstantArray::get("Exception handler needed, but not enabled. Recompile"
179 " program with -enable-correct-eh-support.\n");
180 AbortMessageLength = Msg->getNumOperands()-1; // don't include \0
181
182 GlobalVariable *MsgGV = new GlobalVariable(Msg->getType(), true,
183 GlobalValue::InternalLinkage,
Chris Lattnerb76efb72007-01-07 08:12:01 +0000184 Msg, "abortmsg", M);
Reid Spencerc5b206b2006-12-31 05:48:39 +0000185 std::vector<Constant*> GEPIdx(2, Constant::getNullValue(Type::Int32Ty));
Chris Lattnerec1f7522007-02-19 07:34:47 +0000186 AbortMessage = ConstantExpr::getGetElementPtr(MsgGV, &GEPIdx[0], 2);
Chris Lattner0c3b3902004-11-13 19:07:32 +0000187 }
188}
189
190
Chris Lattner501825e2004-02-08 22:14:44 +0000191void LowerInvoke::writeAbortMessage(Instruction *IB) {
Jeff Cohen09b362c2007-04-20 22:40:10 +0000192#if 0
Chris Lattnerb76efb72007-01-07 08:12:01 +0000193 if (AbortMessage == 0)
194 createAbortMessage(IB->getParent()->getParent()->getParent());
Chris Lattner0c3b3902004-11-13 19:07:32 +0000195
Chris Lattnerb76efb72007-01-07 08:12:01 +0000196 // These are the arguments we WANT...
Chris Lattner93e985f2007-02-13 02:10:56 +0000197 Value* Args[3];
198 Args[0] = ConstantInt::get(Type::Int32Ty, 2);
199 Args[1] = AbortMessage;
200 Args[2] = ConstantInt::get(Type::Int32Ty, AbortMessageLength);
201 (new CallInst(WriteFn, Args, 3, "", IB))->setTailCall();
Jeff Cohen09b362c2007-04-20 22:40:10 +0000202#endif
Chris Lattner501825e2004-02-08 22:14:44 +0000203}
204
Chris Lattner6d784572004-02-08 19:53:56 +0000205bool LowerInvoke::insertCheapEHSupport(Function &F) {
Chris Lattner86e44452003-10-05 19:14:42 +0000206 bool Changed = false;
Chris Lattnerdead9932003-12-10 20:22:42 +0000207 for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
208 if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator())) {
Chris Lattner93e985f2007-02-13 02:10:56 +0000209 std::vector<Value*> CallArgs(II->op_begin()+3, II->op_end());
Chris Lattner86e44452003-10-05 19:14:42 +0000210 // Insert a normal call instruction...
Gabor Greif051a9502008-04-06 20:25:17 +0000211 CallInst *NewCall = CallInst::Create(II->getCalledValue(),
212 CallArgs.begin(), CallArgs.end(), "",II);
Chris Lattner86cc4232007-02-11 01:37:51 +0000213 NewCall->takeName(II);
Chris Lattnerefd91682005-05-13 06:27:02 +0000214 NewCall->setCallingConv(II->getCallingConv());
Duncan Sandsdc024672007-11-27 13:23:08 +0000215 NewCall->setParamAttrs(II->getParamAttrs());
Chris Lattner86e44452003-10-05 19:14:42 +0000216 II->replaceAllUsesWith(NewCall);
Misha Brukmanfd939082005-04-21 23:48:37 +0000217
Chris Lattnerdead9932003-12-10 20:22:42 +0000218 // Insert an unconditional branch to the normal destination.
Gabor Greif051a9502008-04-06 20:25:17 +0000219 BranchInst::Create(II->getNormalDest(), II);
Chris Lattner86e44452003-10-05 19:14:42 +0000220
Chris Lattnerdead9932003-12-10 20:22:42 +0000221 // Remove any PHI node entries from the exception destination.
Chris Lattneraeb2a1d2004-02-08 21:44:31 +0000222 II->getUnwindDest()->removePredecessor(BB);
Chris Lattnerdead9932003-12-10 20:22:42 +0000223
Chris Lattner86e44452003-10-05 19:14:42 +0000224 // Remove the invoke instruction now.
Chris Lattnerdead9932003-12-10 20:22:42 +0000225 BB->getInstList().erase(II);
Chris Lattner86e44452003-10-05 19:14:42 +0000226
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000227 ++NumInvokes; Changed = true;
Chris Lattnerdead9932003-12-10 20:22:42 +0000228 } else if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
Chris Lattnere1c09302004-02-08 07:30:29 +0000229 // Insert a new call to write(2, AbortMessage, AbortMessageLength);
Chris Lattner501825e2004-02-08 22:14:44 +0000230 writeAbortMessage(UI);
Chris Lattnere1c09302004-02-08 07:30:29 +0000231
Chris Lattner86e44452003-10-05 19:14:42 +0000232 // Insert a call to abort()
Gabor Greif051a9502008-04-06 20:25:17 +0000233 CallInst::Create(AbortFn, "", UI)->setTailCall();
Chris Lattner86e44452003-10-05 19:14:42 +0000234
Chris Lattner6d784572004-02-08 19:53:56 +0000235 // Insert a return instruction. This really should be a "barrier", as it
236 // is unreachable.
Gabor Greif051a9502008-04-06 20:25:17 +0000237 ReturnInst::Create(F.getReturnType() == Type::VoidTy ? 0 :
238 Constant::getNullValue(F.getReturnType()), UI);
Chris Lattner86e44452003-10-05 19:14:42 +0000239
240 // Remove the unwind instruction now.
Chris Lattnerdead9932003-12-10 20:22:42 +0000241 BB->getInstList().erase(UI);
Chris Lattner86e44452003-10-05 19:14:42 +0000242
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000243 ++NumUnwinds; Changed = true;
Chris Lattner86e44452003-10-05 19:14:42 +0000244 }
245 return Changed;
246}
Chris Lattner6d784572004-02-08 19:53:56 +0000247
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000248/// rewriteExpensiveInvoke - Insert code and hack the function to replace the
249/// specified invoke instruction with a call.
250void LowerInvoke::rewriteExpensiveInvoke(InvokeInst *II, unsigned InvokeNo,
251 AllocaInst *InvokeNum,
252 SwitchInst *CatchSwitch) {
Reid Spencerc5b206b2006-12-31 05:48:39 +0000253 ConstantInt *InvokeNoC = ConstantInt::get(Type::Int32Ty, InvokeNo);
Chris Lattner6d784572004-02-08 19:53:56 +0000254
Chris Lattner8c5c22f2008-02-14 19:18:13 +0000255 // If the unwind edge has phi nodes, split the edge.
256 if (isa<PHINode>(II->getUnwindDest()->begin())) {
257 SplitCriticalEdge(II, 1, this);
258
259 // If there are any phi nodes left, they must have a single predecessor.
260 while (PHINode *PN = dyn_cast<PHINode>(II->getUnwindDest()->begin())) {
261 PN->replaceAllUsesWith(PN->getIncomingValue(0));
262 PN->eraseFromParent();
263 }
264 }
265
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000266 // Insert a store of the invoke num before the invoke and store zero into the
267 // location afterward.
268 new StoreInst(InvokeNoC, InvokeNum, true, II); // volatile
Chris Lattner93e50ce2005-09-29 17:44:20 +0000269
270 BasicBlock::iterator NI = II->getNormalDest()->begin();
271 while (isa<PHINode>(NI)) ++NI;
272 // nonvolatile.
Reid Spencerc5b206b2006-12-31 05:48:39 +0000273 new StoreInst(Constant::getNullValue(Type::Int32Ty), InvokeNum, false, NI);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000274
275 // Add a switch case to our unwind block.
276 CatchSwitch->addCase(InvokeNoC, II->getUnwindDest());
277
278 // Insert a normal call instruction.
Chris Lattner93e985f2007-02-13 02:10:56 +0000279 std::vector<Value*> CallArgs(II->op_begin()+3, II->op_end());
Gabor Greif051a9502008-04-06 20:25:17 +0000280 CallInst *NewCall = CallInst::Create(II->getCalledValue(),
281 CallArgs.begin(), CallArgs.end(), "",
282 II);
Chris Lattner86cc4232007-02-11 01:37:51 +0000283 NewCall->takeName(II);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000284 NewCall->setCallingConv(II->getCallingConv());
Duncan Sandsdc024672007-11-27 13:23:08 +0000285 NewCall->setParamAttrs(II->getParamAttrs());
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000286 II->replaceAllUsesWith(NewCall);
287
288 // Replace the invoke with an uncond branch.
Gabor Greif051a9502008-04-06 20:25:17 +0000289 BranchInst::Create(II->getNormalDest(), NewCall->getParent());
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000290 II->eraseFromParent();
291}
Chris Lattner6d784572004-02-08 19:53:56 +0000292
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000293/// MarkBlocksLiveIn - Insert BB and all of its predescessors into LiveBBs until
294/// we reach blocks we've already seen.
295static void MarkBlocksLiveIn(BasicBlock *BB, std::set<BasicBlock*> &LiveBBs) {
296 if (!LiveBBs.insert(BB).second) return; // already been here.
297
298 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
299 MarkBlocksLiveIn(*PI, LiveBBs);
300}
Chris Lattner6d784572004-02-08 19:53:56 +0000301
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000302// First thing we need to do is scan the whole function for values that are
303// live across unwind edges. Each value that is live across an unwind edge
304// we spill into a stack location, guaranteeing that there is nothing live
305// across the unwind edge. This process also splits all critical edges
306// coming out of invoke's.
307void LowerInvoke::
308splitLiveRangesLiveAcrossInvokes(std::vector<InvokeInst*> &Invokes) {
309 // First step, split all critical edges from invoke instructions.
310 for (unsigned i = 0, e = Invokes.size(); i != e; ++i) {
311 InvokeInst *II = Invokes[i];
312 SplitCriticalEdge(II, 0, this);
313 SplitCriticalEdge(II, 1, this);
314 assert(!isa<PHINode>(II->getNormalDest()) &&
315 !isa<PHINode>(II->getUnwindDest()) &&
316 "critical edge splitting left single entry phi nodes?");
Chris Lattner6d784572004-02-08 19:53:56 +0000317 }
318
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000319 Function *F = Invokes.back()->getParent()->getParent();
320
321 // To avoid having to handle incoming arguments specially, we lower each arg
Reid Spencer3da59db2006-11-27 01:05:10 +0000322 // to a copy instruction in the entry block. This ensures that the argument
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000323 // value itself cannot be live across the entry block.
324 BasicBlock::iterator AfterAllocaInsertPt = F->begin()->begin();
325 while (isa<AllocaInst>(AfterAllocaInsertPt) &&
326 isa<ConstantInt>(cast<AllocaInst>(AfterAllocaInsertPt)->getArraySize()))
327 ++AfterAllocaInsertPt;
328 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end();
329 AI != E; ++AI) {
Reid Spencer3da59db2006-11-27 01:05:10 +0000330 // This is always a no-op cast because we're casting AI to AI->getType() so
331 // src and destination types are identical. BitCast is the only possibility.
332 CastInst *NC = new BitCastInst(
333 AI, AI->getType(), AI->getName()+".tmp", AfterAllocaInsertPt);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000334 AI->replaceAllUsesWith(NC);
Reid Spencer3da59db2006-11-27 01:05:10 +0000335 // Normally its is forbidden to replace a CastInst's operand because it
336 // could cause the opcode to reflect an illegal conversion. However, we're
337 // replacing it here with the same value it was constructed with to simply
338 // make NC its user.
339 NC->setOperand(0, AI);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000340 }
341
342 // Finally, scan the code looking for instructions with bad live ranges.
343 for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
344 for (BasicBlock::iterator II = BB->begin(), E = BB->end(); II != E; ++II) {
345 // Ignore obvious cases we don't have to handle. In particular, most
346 // instructions either have no uses or only have a single use inside the
347 // current block. Ignore them quickly.
348 Instruction *Inst = II;
349 if (Inst->use_empty()) continue;
350 if (Inst->hasOneUse() &&
351 cast<Instruction>(Inst->use_back())->getParent() == BB &&
352 !isa<PHINode>(Inst->use_back())) continue;
353
Chris Lattner45313712005-09-27 21:33:12 +0000354 // If this is an alloca in the entry block, it's not a real register
355 // value.
356 if (AllocaInst *AI = dyn_cast<AllocaInst>(Inst))
357 if (isa<ConstantInt>(AI->getArraySize()) && BB == F->begin())
358 continue;
359
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000360 // Avoid iterator invalidation by copying users to a temporary vector.
361 std::vector<Instruction*> Users;
362 for (Value::use_iterator UI = Inst->use_begin(), E = Inst->use_end();
363 UI != E; ++UI) {
364 Instruction *User = cast<Instruction>(*UI);
365 if (User->getParent() != BB || isa<PHINode>(User))
366 Users.push_back(User);
367 }
368
369 // Scan all of the uses and see if the live range is live across an unwind
370 // edge. If we find a use live across an invoke edge, create an alloca
371 // and spill the value.
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000372 std::set<InvokeInst*> InvokesWithStoreInserted;
373
374 // Find all of the blocks that this value is live in.
375 std::set<BasicBlock*> LiveBBs;
376 LiveBBs.insert(Inst->getParent());
377 while (!Users.empty()) {
378 Instruction *U = Users.back();
379 Users.pop_back();
380
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000381 if (!isa<PHINode>(U)) {
382 MarkBlocksLiveIn(U->getParent(), LiveBBs);
383 } else {
384 // Uses for a PHI node occur in their predecessor block.
385 PHINode *PN = cast<PHINode>(U);
386 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
387 if (PN->getIncomingValue(i) == Inst)
388 MarkBlocksLiveIn(PN->getIncomingBlock(i), LiveBBs);
389 }
390 }
391
392 // Now that we know all of the blocks that this thing is live in, see if
393 // it includes any of the unwind locations.
394 bool NeedsSpill = false;
395 for (unsigned i = 0, e = Invokes.size(); i != e; ++i) {
396 BasicBlock *UnwindBlock = Invokes[i]->getUnwindDest();
397 if (UnwindBlock != BB && LiveBBs.count(UnwindBlock)) {
398 NeedsSpill = true;
399 }
400 }
401
402 // If we decided we need a spill, do it.
403 if (NeedsSpill) {
404 ++NumSpilled;
405 DemoteRegToStack(*Inst, true);
406 }
407 }
408}
409
410bool LowerInvoke::insertExpensiveEHSupport(Function &F) {
411 std::vector<ReturnInst*> Returns;
412 std::vector<UnwindInst*> Unwinds;
413 std::vector<InvokeInst*> Invokes;
414
415 for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
416 if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
417 // Remember all return instructions in case we insert an invoke into this
418 // function.
419 Returns.push_back(RI);
420 } else if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator())) {
421 Invokes.push_back(II);
422 } else if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
423 Unwinds.push_back(UI);
424 }
425
426 if (Unwinds.empty() && Invokes.empty()) return false;
427
428 NumInvokes += Invokes.size();
429 NumUnwinds += Unwinds.size();
Chris Lattner5b3c7022005-09-27 22:44:59 +0000430
431 // TODO: This is not an optimal way to do this. In particular, this always
432 // inserts setjmp calls into the entries of functions with invoke instructions
433 // even though there are possibly paths through the function that do not
434 // execute any invokes. In particular, for functions with early exits, e.g.
435 // the 'addMove' method in hexxagon, it would be nice to not have to do the
436 // setjmp stuff on the early exit path. This requires a bit of dataflow, but
437 // would not be too hard to do.
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000438
439 // If we have an invoke instruction, insert a setjmp that dominates all
440 // invokes. After the setjmp, use a cond branch that goes to the original
441 // code path on zero, and to a designated 'catch' block of nonzero.
442 Value *OldJmpBufPtr = 0;
443 if (!Invokes.empty()) {
444 // First thing we need to do is scan the whole function for values that are
445 // live across unwind edges. Each value that is live across an unwind edge
446 // we spill into a stack location, guaranteeing that there is nothing live
447 // across the unwind edge. This process also splits all critical edges
448 // coming out of invoke's.
449 splitLiveRangesLiveAcrossInvokes(Invokes);
450
451 BasicBlock *EntryBB = F.begin();
452
453 // Create an alloca for the incoming jump buffer ptr and the new jump buffer
454 // that needs to be restored on all exits from the function. This is an
455 // alloca because the value needs to be live across invokes.
Chris Lattner97d2dbd2006-09-05 17:48:07 +0000456 unsigned Align = TLI ? TLI->getJumpBufAlignment() : 0;
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000457 AllocaInst *JmpBuf =
Chris Lattner97d2dbd2006-09-05 17:48:07 +0000458 new AllocaInst(JBLinkTy, 0, Align, "jblink", F.begin()->begin());
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000459
460 std::vector<Value*> Idx;
Reid Spencerc5b206b2006-12-31 05:48:39 +0000461 Idx.push_back(Constant::getNullValue(Type::Int32Ty));
462 Idx.push_back(ConstantInt::get(Type::Int32Ty, 1));
Gabor Greif051a9502008-04-06 20:25:17 +0000463 OldJmpBufPtr = GetElementPtrInst::Create(JmpBuf, Idx.begin(), Idx.end(),
464 "OldBuf", EntryBB->getTerminator());
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000465
466 // Copy the JBListHead to the alloca.
467 Value *OldBuf = new LoadInst(JBListHead, "oldjmpbufptr", true,
468 EntryBB->getTerminator());
469 new StoreInst(OldBuf, OldJmpBufPtr, true, EntryBB->getTerminator());
470
471 // Add the new jumpbuf to the list.
472 new StoreInst(JmpBuf, JBListHead, true, EntryBB->getTerminator());
473
474 // Create the catch block. The catch block is basically a big switch
475 // statement that goes to all of the invoke catch blocks.
Gabor Greif051a9502008-04-06 20:25:17 +0000476 BasicBlock *CatchBB = BasicBlock::Create("setjmp.catch", &F);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000477
478 // Create an alloca which keeps track of which invoke is currently
479 // executing. For normal calls it contains zero.
Reid Spencerc5b206b2006-12-31 05:48:39 +0000480 AllocaInst *InvokeNum = new AllocaInst(Type::Int32Ty, 0, "invokenum",
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000481 EntryBB->begin());
Reid Spencerc5b206b2006-12-31 05:48:39 +0000482 new StoreInst(ConstantInt::get(Type::Int32Ty, 0), InvokeNum, true,
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000483 EntryBB->getTerminator());
484
485 // Insert a load in the Catch block, and a switch on its value. By default,
486 // we go to a block that just does an unwind (which is the correct action
487 // for a standard call).
Gabor Greif051a9502008-04-06 20:25:17 +0000488 BasicBlock *UnwindBB = BasicBlock::Create("unwindbb", &F);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000489 Unwinds.push_back(new UnwindInst(UnwindBB));
490
491 Value *CatchLoad = new LoadInst(InvokeNum, "invoke.num", true, CatchBB);
Gabor Greif051a9502008-04-06 20:25:17 +0000492 SwitchInst *CatchSwitch =
493 SwitchInst::Create(CatchLoad, UnwindBB, Invokes.size(), CatchBB);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000494
495 // Now that things are set up, insert the setjmp call itself.
496
497 // Split the entry block to insert the conditional branch for the setjmp.
498 BasicBlock *ContBlock = EntryBB->splitBasicBlock(EntryBB->getTerminator(),
499 "setjmp.cont");
500
Reid Spencerc5b206b2006-12-31 05:48:39 +0000501 Idx[1] = ConstantInt::get(Type::Int32Ty, 0);
Gabor Greif051a9502008-04-06 20:25:17 +0000502 Value *JmpBufPtr = GetElementPtrInst::Create(JmpBuf, Idx.begin(), Idx.end(),
503 "TheJmpBuf",
504 EntryBB->getTerminator());
Duncan Sandsa1220432008-04-07 13:41:19 +0000505 JmpBufPtr = new BitCastInst(JmpBufPtr, PointerType::getUnqual(Type::Int8Ty),
506 "tmp", EntryBB->getTerminator());
Gabor Greif051a9502008-04-06 20:25:17 +0000507 Value *SJRet = CallInst::Create(SetJmpFn, JmpBufPtr, "sjret",
508 EntryBB->getTerminator());
Duncan Sandsa1220432008-04-07 13:41:19 +0000509
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000510 // Compare the return value to zero.
Reid Spencere4d87aa2006-12-23 06:05:41 +0000511 Value *IsNormal = new ICmpInst(ICmpInst::ICMP_EQ, SJRet,
512 Constant::getNullValue(SJRet->getType()),
513 "notunwind", EntryBB->getTerminator());
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000514 // Nuke the uncond branch.
515 EntryBB->getTerminator()->eraseFromParent();
516
517 // Put in a new condbranch in its place.
Gabor Greif051a9502008-04-06 20:25:17 +0000518 BranchInst::Create(ContBlock, CatchBB, IsNormal, EntryBB);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000519
520 // At this point, we are all set up, rewrite each invoke instruction.
521 for (unsigned i = 0, e = Invokes.size(); i != e; ++i)
522 rewriteExpensiveInvoke(Invokes[i], i+1, InvokeNum, CatchSwitch);
523 }
524
525 // We know that there is at least one unwind.
526
527 // Create three new blocks, the block to load the jmpbuf ptr and compare
528 // against null, the block to do the longjmp, and the error block for if it
529 // is null. Add them at the end of the function because they are not hot.
Gabor Greif051a9502008-04-06 20:25:17 +0000530 BasicBlock *UnwindHandler = BasicBlock::Create("dounwind", &F);
531 BasicBlock *UnwindBlock = BasicBlock::Create("unwind", &F);
532 BasicBlock *TermBlock = BasicBlock::Create("unwinderror", &F);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000533
534 // If this function contains an invoke, restore the old jumpbuf ptr.
535 Value *BufPtr;
536 if (OldJmpBufPtr) {
537 // Before the return, insert a copy from the saved value to the new value.
538 BufPtr = new LoadInst(OldJmpBufPtr, "oldjmpbufptr", UnwindHandler);
539 new StoreInst(BufPtr, JBListHead, UnwindHandler);
540 } else {
541 BufPtr = new LoadInst(JBListHead, "ehlist", UnwindHandler);
542 }
543
544 // Load the JBList, if it's null, then there was no catch!
Reid Spencere4d87aa2006-12-23 06:05:41 +0000545 Value *NotNull = new ICmpInst(ICmpInst::ICMP_NE, BufPtr,
546 Constant::getNullValue(BufPtr->getType()),
547 "notnull", UnwindHandler);
Gabor Greif051a9502008-04-06 20:25:17 +0000548 BranchInst::Create(UnwindBlock, TermBlock, NotNull, UnwindHandler);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000549
550 // Create the block to do the longjmp.
551 // Get a pointer to the jmpbuf and longjmp.
552 std::vector<Value*> Idx;
Reid Spencerc5b206b2006-12-31 05:48:39 +0000553 Idx.push_back(Constant::getNullValue(Type::Int32Ty));
554 Idx.push_back(ConstantInt::get(Type::Int32Ty, 0));
Gabor Greif051a9502008-04-06 20:25:17 +0000555 Idx[0] = GetElementPtrInst::Create(BufPtr, Idx.begin(), Idx.end(), "JmpBuf",
556 UnwindBlock);
Duncan Sandsa1220432008-04-07 13:41:19 +0000557 Idx[0] = new BitCastInst(Idx[0], PointerType::getUnqual(Type::Int8Ty),
558 "tmp", UnwindBlock);
Reid Spencerc5b206b2006-12-31 05:48:39 +0000559 Idx[1] = ConstantInt::get(Type::Int32Ty, 1);
Gabor Greif051a9502008-04-06 20:25:17 +0000560 CallInst::Create(LongJmpFn, Idx.begin(), Idx.end(), "", UnwindBlock);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000561 new UnreachableInst(UnwindBlock);
562
563 // Set up the term block ("throw without a catch").
564 new UnreachableInst(TermBlock);
565
566 // Insert a new call to write(2, AbortMessage, AbortMessageLength);
567 writeAbortMessage(TermBlock->getTerminator());
568
569 // Insert a call to abort()
Gabor Greif051a9502008-04-06 20:25:17 +0000570 CallInst::Create(AbortFn, "",
571 TermBlock->getTerminator())->setTailCall();
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000572
573
574 // Replace all unwinds with a branch to the unwind handler.
575 for (unsigned i = 0, e = Unwinds.size(); i != e; ++i) {
Gabor Greif051a9502008-04-06 20:25:17 +0000576 BranchInst::Create(UnwindHandler, Unwinds[i]);
Chris Lattnerf4e6c3a2005-09-27 21:18:17 +0000577 Unwinds[i]->eraseFromParent();
578 }
579
580 // Finally, for any returns from this function, if this function contains an
581 // invoke, restore the old jmpbuf pointer to its input value.
582 if (OldJmpBufPtr) {
583 for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
584 ReturnInst *R = Returns[i];
585
586 // Before the return, insert a copy from the saved value to the new value.
587 Value *OldBuf = new LoadInst(OldJmpBufPtr, "oldjmpbufptr", true, R);
588 new StoreInst(OldBuf, JBListHead, true, R);
589 }
590 }
591
592 return true;
Chris Lattner6d784572004-02-08 19:53:56 +0000593}
594
595bool LowerInvoke::runOnFunction(Function &F) {
596 if (ExpensiveEHSupport)
597 return insertExpensiveEHSupport(F);
598 else
599 return insertCheapEHSupport(F);
600}