lib/Transforms/Utils/LowerInvoke.cpp

   1 //===- LowerInvoke.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 do not yet
  11 // 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
  21 // 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.
  24 //
  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.
  28 //
  29 // 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 //
  35 //===----------------------------------------------------------------------===//
  36
  37 #define DEBUG_TYPE "lowerinvoke"
  38 #include "llvm/Transforms/Scalar.h"
  39 #include "llvm/Constants.h"
  40 #include "llvm/DerivedTypes.h"
  41 #include "llvm/Instructions.h"
  42 #include "llvm/Intrinsics.h"
  43 #include "llvm/LLVMContext.h"
  44 #include "llvm/Module.h"
  45 #include "llvm/Pass.h"
  46 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  47 #include "llvm/Transforms/Utils/Local.h"
  48 #include "llvm/ADT/Statistic.h"
  49 #include "llvm/Support/CommandLine.h"
  50 #include "llvm/Support/Compiler.h"
  51 #include "llvm/Target/TargetLowering.h"
  52 #include <csetjmp>
  53 #include <set>
  54 using namespace llvm;
  55
  56 STATISTIC(NumInvokes, "Number of invokes replaced");
  57 STATISTIC(NumUnwinds, "Number of unwinds replaced");
  58 STATISTIC(NumSpilled, "Number of registers live across unwind edges");
  59
  60 static cl::opt<bool> ExpensiveEHSupport("enable-correct-eh-support",
  61  cl::desc("Make the -lowerinvoke pass insert expensive, but correct, EH code"));
  62
  63 namespace {
  64   class VISIBILITY_HIDDEN LowerInvoke : public FunctionPass {
  65     // Used for both models.
  66     Constant *WriteFn;
  67     Constant *AbortFn;
  68     Value *AbortMessage;
  69     unsigned AbortMessageLength;
  70
  71     // Used for expensive EH support.
  72     const Type *JBLinkTy;
  73     GlobalVariable *JBListHead;
  74     Constant *SetJmpFn, *LongJmpFn;
  75
  76     // We peek in TLI to grab the target's jmp_buf size and alignment
  77     const TargetLowering *TLI;
  78
  79   public:
  80     static char ID; // Pass identification, replacement for typeid
  81     explicit LowerInvoke(const TargetLowering *tli = NULL)
  82       : FunctionPass(&ID), TLI(tli) { }
  83     bool doInitialization(Module &M);
  84     bool runOnFunction(Function &F);
  85
  86     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  87       // This is a cluster of orthogonal Transforms
  88       AU.addPreservedID(PromoteMemoryToRegisterID);
  89       AU.addPreservedID(LowerSwitchID);
  90       AU.addPreservedID(LowerAllocationsID);
  91     }
  92
  93   private:
  94     void createAbortMessage(Module *M);
  95     void writeAbortMessage(Instruction *IB);
  96     bool insertCheapEHSupport(Function &F);
  97     void splitLiveRangesLiveAcrossInvokes(std::vector<InvokeInst*> &Invokes);
  98     void rewriteExpensiveInvoke(InvokeInst *II, unsigned InvokeNo,
  99                                 AllocaInst *InvokeNum, SwitchInst *CatchSwitch);
 100     bool insertExpensiveEHSupport(Function &F);
 101   };
 102 }
 103
 104 char LowerInvoke::ID = 0;
 105 static RegisterPass<LowerInvoke>
 106 X("lowerinvoke", "Lower invoke and unwind, for unwindless code generators");
 107
 108 const PassInfo *const llvm::LowerInvokePassID = &X;
 109
 110 // Public Interface To the LowerInvoke pass.
 111 FunctionPass *llvm::createLowerInvokePass(const TargetLowering *TLI) {
 112   return new LowerInvoke(TLI);
 113 }
 114
 115 // doInitialization - Make sure that there is a prototype for abort in the
 116 // current module.
 117 bool LowerInvoke::doInitialization(Module &M) {
 118   const Type *VoidPtrTy = Context->getPointerTypeUnqual(Type::Int8Ty);
 119   AbortMessage = 0;
 120   if (ExpensiveEHSupport) {
 121     // Insert a type for the linked list of jump buffers.
 122     unsigned JBSize = TLI ? TLI->getJumpBufSize() : 0;
 123     JBSize = JBSize ? JBSize : 200;
 124     const Type *JmpBufTy = Context->getArrayType(VoidPtrTy, JBSize);
 125
 126     { // The type is recursive, so use a type holder.
 127       std::vector<const Type*> Elements;
 128       Elements.push_back(JmpBufTy);
 129       OpaqueType *OT = Context->getOpaqueType();
 130       Elements.push_back(Context->getPointerTypeUnqual(OT));
 131       PATypeHolder JBLType(Context->getStructType(Elements));
 132       OT->refineAbstractTypeTo(JBLType.get());  // Complete the cycle.
 133       JBLinkTy = JBLType.get();
 134       M.addTypeName("llvm.sjljeh.jmpbufty", JBLinkTy);
 135     }
 136
 137     const Type *PtrJBList = Context->getPointerTypeUnqual(JBLinkTy);
 138
 139     // Now that we've done that, insert the jmpbuf list head global, unless it
 140     // already exists.
 141     if (!(JBListHead = M.getGlobalVariable("llvm.sjljeh.jblist", PtrJBList))) {
 142       JBListHead = new GlobalVariable(M, PtrJBList, false,
 143                                       GlobalValue::LinkOnceAnyLinkage,
 144                                       Context->getNullValue(PtrJBList),
 145                                       "llvm.sjljeh.jblist");
 146     }
 147
 148 // VisualStudio defines setjmp as _setjmp via #include <csetjmp> / <setjmp.h>,
 149 // so it looks like Intrinsic::_setjmp
 150 #if defined(_MSC_VER) && defined(setjmp)
 151 #define setjmp_undefined_for_visual_studio
 152 #undef setjmp
 153 #endif
 154
 155     SetJmpFn = Intrinsic::getDeclaration(&M, Intrinsic::setjmp);
 156
 157 #if defined(_MSC_VER) && defined(setjmp_undefined_for_visual_studio)
 158 // let's return it to _setjmp state in case anyone ever needs it after this
 159 // point under VisualStudio
 160 #define setjmp _setjmp
 161 #endif
 162
 163     LongJmpFn = Intrinsic::getDeclaration(&M, Intrinsic::longjmp);
 164   }
 165
 166   // We need the 'write' and 'abort' functions for both models.
 167   AbortFn = M.getOrInsertFunction("abort", Type::VoidTy, (Type *)0);
 168 #if 0 // "write" is Unix-specific.. code is going away soon anyway.
 169   WriteFn = M.getOrInsertFunction("write", Type::VoidTy, Type::Int32Ty,
 170                                   VoidPtrTy, Type::Int32Ty, (Type *)0);
 171 #else
 172   WriteFn = 0;
 173 #endif
 174   return true;
 175 }
 176
 177 void LowerInvoke::createAbortMessage(Module *M) {
 178   if (ExpensiveEHSupport) {
 179     // The abort message for expensive EH support tells the user that the
 180     // program 'unwound' without an 'invoke' instruction.
 181     Constant *Msg =
 182       Context->getConstantArray("ERROR: Exception thrown, but not caught!\n");
 183     AbortMessageLength = Msg->getNumOperands()-1;  // don't include \0
 184
 185     GlobalVariable *MsgGV = new GlobalVariable(*M, Msg->getType(), true,
 186                                                GlobalValue::InternalLinkage,
 187                                                Msg, "abortmsg");
 188     std::vector<Constant*> GEPIdx(2, Context->getNullValue(Type::Int32Ty));
 189     AbortMessage = Context->getConstantExprGetElementPtr(MsgGV, &GEPIdx[0], 2);
 190   } else {
 191     // The abort message for cheap EH support tells the user that EH is not
 192     // enabled.
 193     Constant *Msg =
 194       Context->getConstantArray("Exception handler needed, but not enabled."
 195                         "Recompile program with -enable-correct-eh-support.\n");
 196     AbortMessageLength = Msg->getNumOperands()-1;  // don't include \0
 197
 198     GlobalVariable *MsgGV = new GlobalVariable(*M, Msg->getType(), true,
 199                                                GlobalValue::InternalLinkage,
 200                                                Msg, "abortmsg");
 201     std::vector<Constant*> GEPIdx(2, Context->getNullValue(Type::Int32Ty));
 202     AbortMessage = ConstantExpr::getGetElementPtr(MsgGV, &GEPIdx[0], 2);
 203   }
 204 }
 205
 206
 207 void LowerInvoke::writeAbortMessage(Instruction *IB) {
 208 #if 0
 209   if (AbortMessage == 0)
 210     createAbortMessage(IB->getParent()->getParent()->getParent());
 211
 212   // These are the arguments we WANT...
 213   Value* Args[3];
 214   Args[0] = ConstantInt::get(Type::Int32Ty, 2);
 215   Args[1] = AbortMessage;
 216   Args[2] = ConstantInt::get(Type::Int32Ty, AbortMessageLength);
 217   (new CallInst(WriteFn, Args, 3, "", IB))->setTailCall();
 218 #endif
 219 }
 220
 221 bool LowerInvoke::insertCheapEHSupport(Function &F) {
 222   bool Changed = false;
 223   for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
 224     if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator())) {
 225       std::vector<Value*> CallArgs(II->op_begin()+3, II->op_end());
 226       // Insert a normal call instruction...
 227       CallInst *NewCall = CallInst::Create(II->getCalledValue(),
 228                                            CallArgs.begin(), CallArgs.end(), "",II);
 229       NewCall->takeName(II);
 230       NewCall->setCallingConv(II->getCallingConv());
 231       NewCall->setAttributes(II->getAttributes());
 232       II->replaceAllUsesWith(NewCall);
 233
 234       // Insert an unconditional branch to the normal destination.
 235       BranchInst::Create(II->getNormalDest(), II);
 236
 237       // Remove any PHI node entries from the exception destination.
 238       II->getUnwindDest()->removePredecessor(BB);
 239
 240       // Remove the invoke instruction now.
 241       BB->getInstList().erase(II);
 242
 243       ++NumInvokes; Changed = true;
 244     } else if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
 245       // Insert a new call to write(2, AbortMessage, AbortMessageLength);
 246       writeAbortMessage(UI);
 247
 248       // Insert a call to abort()
 249       CallInst::Create(AbortFn, "", UI)->setTailCall();
 250
 251       // Insert a return instruction.  This really should be a "barrier", as it
 252       // is unreachable.
 253       ReturnInst::Create(F.getReturnType() == Type::VoidTy ? 0 :
 254                          Context->getNullValue(F.getReturnType()), UI);
 255
 256       // Remove the unwind instruction now.
 257       BB->getInstList().erase(UI);
 258
 259       ++NumUnwinds; Changed = true;
 260     }
 261   return Changed;
 262 }
 263
 264 /// rewriteExpensiveInvoke - Insert code and hack the function to replace the
 265 /// specified invoke instruction with a call.
 266 void LowerInvoke::rewriteExpensiveInvoke(InvokeInst *II, unsigned InvokeNo,
 267                                          AllocaInst *InvokeNum,
 268                                          SwitchInst *CatchSwitch) {
 269   ConstantInt *InvokeNoC = ConstantInt::get(Type::Int32Ty, InvokeNo);
 270
 271   // If the unwind edge has phi nodes, split the edge.
 272   if (isa<PHINode>(II->getUnwindDest()->begin())) {
 273     SplitCriticalEdge(II, 1, this);
 274
 275     // If there are any phi nodes left, they must have a single predecessor.
 276     while (PHINode *PN = dyn_cast<PHINode>(II->getUnwindDest()->begin())) {
 277       PN->replaceAllUsesWith(PN->getIncomingValue(0));
 278       PN->eraseFromParent();
 279     }
 280   }
 281
 282   // Insert a store of the invoke num before the invoke and store zero into the
 283   // location afterward.
 284   new StoreInst(InvokeNoC, InvokeNum, true, II);  // volatile
 285
 286   BasicBlock::iterator NI = II->getNormalDest()->getFirstNonPHI();
 287   // nonvolatile.
 288   new StoreInst(Context->getNullValue(Type::Int32Ty), InvokeNum, false, NI);
 289
 290   // Add a switch case to our unwind block.
 291   CatchSwitch->addCase(InvokeNoC, II->getUnwindDest());
 292
 293   // Insert a normal call instruction.
 294   std::vector<Value*> CallArgs(II->op_begin()+3, II->op_end());
 295   CallInst *NewCall = CallInst::Create(II->getCalledValue(),
 296                                        CallArgs.begin(), CallArgs.end(), "",
 297                                        II);
 298   NewCall->takeName(II);
 299   NewCall->setCallingConv(II->getCallingConv());
 300   NewCall->setAttributes(II->getAttributes());
 301   II->replaceAllUsesWith(NewCall);
 302
 303   // Replace the invoke with an uncond branch.
 304   BranchInst::Create(II->getNormalDest(), NewCall->getParent());
 305   II->eraseFromParent();
 306 }
 307
 308 /// MarkBlocksLiveIn - Insert BB and all of its predescessors into LiveBBs until
 309 /// we reach blocks we've already seen.
 310 static void MarkBlocksLiveIn(BasicBlock *BB, std::set<BasicBlock*> &LiveBBs) {
 311   if (!LiveBBs.insert(BB).second) return; // already been here.
 312
 313   for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
 314     MarkBlocksLiveIn(*PI, LiveBBs);
 315 }
 316
 317 // First thing we need to do is scan the whole function for values that are
 318 // live across unwind edges.  Each value that is live across an unwind edge
 319 // we spill into a stack location, guaranteeing that there is nothing live
 320 // across the unwind edge.  This process also splits all critical edges
 321 // coming out of invoke's.
 322 void LowerInvoke::
 323 splitLiveRangesLiveAcrossInvokes(std::vector<InvokeInst*> &Invokes) {
 324   // First step, split all critical edges from invoke instructions.
 325   for (unsigned i = 0, e = Invokes.size(); i != e; ++i) {
 326     InvokeInst *II = Invokes[i];
 327     SplitCriticalEdge(II, 0, this);
 328     SplitCriticalEdge(II, 1, this);
 329     assert(!isa<PHINode>(II->getNormalDest()) &&
 330            !isa<PHINode>(II->getUnwindDest()) &&
 331            "critical edge splitting left single entry phi nodes?");
 332   }
 333
 334   Function *F = Invokes.back()->getParent()->getParent();
 335
 336   // To avoid having to handle incoming arguments specially, we lower each arg
 337   // to a copy instruction in the entry block.  This ensures that the argument
 338   // value itself cannot be live across the entry block.
 339   BasicBlock::iterator AfterAllocaInsertPt = F->begin()->begin();
 340   while (isa<AllocaInst>(AfterAllocaInsertPt) &&
 341         isa<ConstantInt>(cast<AllocaInst>(AfterAllocaInsertPt)->getArraySize()))
 342     ++AfterAllocaInsertPt;
 343   for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end();
 344        AI != E; ++AI) {
 345     // This is always a no-op cast because we're casting AI to AI->getType() so
 346     // src and destination types are identical. BitCast is the only possibility.
 347     CastInst *NC = new BitCastInst(
 348       AI, AI->getType(), AI->getName()+".tmp", AfterAllocaInsertPt);
 349     AI->replaceAllUsesWith(NC);
 350     // Normally its is forbidden to replace a CastInst's operand because it
 351     // could cause the opcode to reflect an illegal conversion. However, we're
 352     // replacing it here with the same value it was constructed with to simply
 353     // make NC its user.
 354     NC->setOperand(0, AI);
 355   }
 356
 357   // Finally, scan the code looking for instructions with bad live ranges.
 358   for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
 359     for (BasicBlock::iterator II = BB->begin(), E = BB->end(); II != E; ++II) {
 360       // Ignore obvious cases we don't have to handle.  In particular, most
 361       // instructions either have no uses or only have a single use inside the
 362       // current block.  Ignore them quickly.
 363       Instruction *Inst = II;
 364       if (Inst->use_empty()) continue;
 365       if (Inst->hasOneUse() &&
 366           cast<Instruction>(Inst->use_back())->getParent() == BB &&
 367           !isa<PHINode>(Inst->use_back())) continue;
 368
 369       // If this is an alloca in the entry block, it's not a real register
 370       // value.
 371       if (AllocaInst *AI = dyn_cast<AllocaInst>(Inst))
 372         if (isa<ConstantInt>(AI->getArraySize()) && BB == F->begin())
 373           continue;
 374
 375       // Avoid iterator invalidation by copying users to a temporary vector.
 376       std::vector<Instruction*> Users;
 377       for (Value::use_iterator UI = Inst->use_begin(), E = Inst->use_end();
 378            UI != E; ++UI) {
 379         Instruction *User = cast<Instruction>(*UI);
 380         if (User->getParent() != BB || isa<PHINode>(User))
 381           Users.push_back(User);
 382       }
 383
 384       // Scan all of the uses and see if the live range is live across an unwind
 385       // edge.  If we find a use live across an invoke edge, create an alloca
 386       // and spill the value.
 387       std::set<InvokeInst*> InvokesWithStoreInserted;
 388
 389       // Find all of the blocks that this value is live in.
 390       std::set<BasicBlock*> LiveBBs;
 391       LiveBBs.insert(Inst->getParent());
 392       while (!Users.empty()) {
 393         Instruction *U = Users.back();
 394         Users.pop_back();
 395
 396         if (!isa<PHINode>(U)) {
 397           MarkBlocksLiveIn(U->getParent(), LiveBBs);
 398         } else {
 399           // Uses for a PHI node occur in their predecessor block.
 400           PHINode *PN = cast<PHINode>(U);
 401           for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 402             if (PN->getIncomingValue(i) == Inst)
 403               MarkBlocksLiveIn(PN->getIncomingBlock(i), LiveBBs);
 404         }
 405       }
 406
 407       // Now that we know all of the blocks that this thing is live in, see if
 408       // it includes any of the unwind locations.
 409       bool NeedsSpill = false;
 410       for (unsigned i = 0, e = Invokes.size(); i != e; ++i) {
 411         BasicBlock *UnwindBlock = Invokes[i]->getUnwindDest();
 412         if (UnwindBlock != BB && LiveBBs.count(UnwindBlock)) {
 413           NeedsSpill = true;
 414         }
 415       }
 416
 417       // If we decided we need a spill, do it.
 418       if (NeedsSpill) {
 419         ++NumSpilled;
 420         DemoteRegToStack(*Inst, true);
 421       }
 422     }
 423 }
 424
 425 bool LowerInvoke::insertExpensiveEHSupport(Function &F) {
 426   std::vector<ReturnInst*> Returns;
 427   std::vector<UnwindInst*> Unwinds;
 428   std::vector<InvokeInst*> Invokes;
 429
 430   for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
 431     if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
 432       // Remember all return instructions in case we insert an invoke into this
 433       // function.
 434       Returns.push_back(RI);
 435     } else if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator())) {
 436       Invokes.push_back(II);
 437     } else if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
 438       Unwinds.push_back(UI);
 439     }
 440
 441   if (Unwinds.empty() && Invokes.empty()) return false;
 442
 443   NumInvokes += Invokes.size();
 444   NumUnwinds += Unwinds.size();
 445
 446   // TODO: This is not an optimal way to do this.  In particular, this always
 447   // inserts setjmp calls into the entries of functions with invoke instructions
 448   // even though there are possibly paths through the function that do not
 449   // execute any invokes.  In particular, for functions with early exits, e.g.
 450   // the 'addMove' method in hexxagon, it would be nice to not have to do the
 451   // setjmp stuff on the early exit path.  This requires a bit of dataflow, but
 452   // would not be too hard to do.
 453
 454   // If we have an invoke instruction, insert a setjmp that dominates all
 455   // invokes.  After the setjmp, use a cond branch that goes to the original
 456   // code path on zero, and to a designated 'catch' block of nonzero.
 457   Value *OldJmpBufPtr = 0;
 458   if (!Invokes.empty()) {
 459     // First thing we need to do is scan the whole function for values that are
 460     // live across unwind edges.  Each value that is live across an unwind edge
 461     // we spill into a stack location, guaranteeing that there is nothing live
 462     // across the unwind edge.  This process also splits all critical edges
 463     // coming out of invoke's.
 464     splitLiveRangesLiveAcrossInvokes(Invokes);
 465
 466     BasicBlock *EntryBB = F.begin();
 467
 468     // Create an alloca for the incoming jump buffer ptr and the new jump buffer
 469     // that needs to be restored on all exits from the function.  This is an
 470     // alloca because the value needs to be live across invokes.
 471     unsigned Align = TLI ? TLI->getJumpBufAlignment() : 0;
 472     AllocaInst *JmpBuf =
 473       new AllocaInst(JBLinkTy, 0, Align, "jblink", F.begin()->begin());
 474
 475     std::vector<Value*> Idx;
 476     Idx.push_back(Context->getNullValue(Type::Int32Ty));
 477     Idx.push_back(ConstantInt::get(Type::Int32Ty, 1));
 478     OldJmpBufPtr = GetElementPtrInst::Create(JmpBuf, Idx.begin(), Idx.end(),
 479                                              "OldBuf", EntryBB->getTerminator());
 480
 481     // Copy the JBListHead to the alloca.
 482     Value *OldBuf = new LoadInst(JBListHead, "oldjmpbufptr", true,
 483                                  EntryBB->getTerminator());
 484     new StoreInst(OldBuf, OldJmpBufPtr, true, EntryBB->getTerminator());
 485
 486     // Add the new jumpbuf to the list.
 487     new StoreInst(JmpBuf, JBListHead, true, EntryBB->getTerminator());
 488
 489     // Create the catch block.  The catch block is basically a big switch
 490     // statement that goes to all of the invoke catch blocks.
 491     BasicBlock *CatchBB = BasicBlock::Create("setjmp.catch", &F);
 492
 493     // Create an alloca which keeps track of which invoke is currently
 494     // executing.  For normal calls it contains zero.
 495     AllocaInst *InvokeNum = new AllocaInst(Type::Int32Ty, 0, "invokenum",
 496                                            EntryBB->begin());
 497     new StoreInst(ConstantInt::get(Type::Int32Ty, 0), InvokeNum, true,
 498                   EntryBB->getTerminator());
 499
 500     // Insert a load in the Catch block, and a switch on its value.  By default,
 501     // we go to a block that just does an unwind (which is the correct action
 502     // for a standard call).
 503     BasicBlock *UnwindBB = BasicBlock::Create("unwindbb", &F);
 504     Unwinds.push_back(new UnwindInst(UnwindBB));
 505
 506     Value *CatchLoad = new LoadInst(InvokeNum, "invoke.num", true, CatchBB);
 507     SwitchInst *CatchSwitch =
 508       SwitchInst::Create(CatchLoad, UnwindBB, Invokes.size(), CatchBB);
 509
 510     // Now that things are set up, insert the setjmp call itself.
 511
 512     // Split the entry block to insert the conditional branch for the setjmp.
 513     BasicBlock *ContBlock = EntryBB->splitBasicBlock(EntryBB->getTerminator(),
 514                                                      "setjmp.cont");
 515
 516     Idx[1] = ConstantInt::get(Type::Int32Ty, 0);
 517     Value *JmpBufPtr = GetElementPtrInst::Create(JmpBuf, Idx.begin(), Idx.end(),
 518                                                  "TheJmpBuf",
 519                                                  EntryBB->getTerminator());
 520     JmpBufPtr = new BitCastInst(JmpBufPtr, PointerType::getUnqual(Type::Int8Ty),
 521                                 "tmp", EntryBB->getTerminator());
 522     Value *SJRet = CallInst::Create(SetJmpFn, JmpBufPtr, "sjret",
 523                                     EntryBB->getTerminator());
 524
 525     // Compare the return value to zero.
 526     Value *IsNormal = new ICmpInst(EntryBB->getTerminator(),
 527                                    ICmpInst::ICMP_EQ, SJRet,
 528                                    Context->getNullValue(SJRet->getType()),
 529                                    "notunwind");
 530     // Nuke the uncond branch.
 531     EntryBB->getTerminator()->eraseFromParent();
 532
 533     // Put in a new condbranch in its place.
 534     BranchInst::Create(ContBlock, CatchBB, IsNormal, EntryBB);
 535
 536     // At this point, we are all set up, rewrite each invoke instruction.
 537     for (unsigned i = 0, e = Invokes.size(); i != e; ++i)
 538       rewriteExpensiveInvoke(Invokes[i], i+1, InvokeNum, CatchSwitch);
 539   }
 540
 541   // We know that there is at least one unwind.
 542
 543   // Create three new blocks, the block to load the jmpbuf ptr and compare
 544   // against null, the block to do the longjmp, and the error block for if it
 545   // is null.  Add them at the end of the function because they are not hot.
 546   BasicBlock *UnwindHandler = BasicBlock::Create("dounwind", &F);
 547   BasicBlock *UnwindBlock = BasicBlock::Create("unwind", &F);
 548   BasicBlock *TermBlock = BasicBlock::Create("unwinderror", &F);
 549
 550   // If this function contains an invoke, restore the old jumpbuf ptr.
 551   Value *BufPtr;
 552   if (OldJmpBufPtr) {
 553     // Before the return, insert a copy from the saved value to the new value.
 554     BufPtr = new LoadInst(OldJmpBufPtr, "oldjmpbufptr", UnwindHandler);
 555     new StoreInst(BufPtr, JBListHead, UnwindHandler);
 556   } else {
 557     BufPtr = new LoadInst(JBListHead, "ehlist", UnwindHandler);
 558   }
 559
 560   // Load the JBList, if it's null, then there was no catch!
 561   Value *NotNull = new ICmpInst(*UnwindHandler, ICmpInst::ICMP_NE, BufPtr,
 562                                 Context->getNullValue(BufPtr->getType()),
 563                                 "notnull");
 564   BranchInst::Create(UnwindBlock, TermBlock, NotNull, UnwindHandler);
 565
 566   // Create the block to do the longjmp.
 567   // Get a pointer to the jmpbuf and longjmp.
 568   std::vector<Value*> Idx;
 569   Idx.push_back(Context->getNullValue(Type::Int32Ty));
 570   Idx.push_back(ConstantInt::get(Type::Int32Ty, 0));
 571   Idx[0] = GetElementPtrInst::Create(BufPtr, Idx.begin(), Idx.end(), "JmpBuf",
 572                                      UnwindBlock);
 573   Idx[0] = new BitCastInst(Idx[0], PointerType::getUnqual(Type::Int8Ty),
 574                            "tmp", UnwindBlock);
 575   Idx[1] = ConstantInt::get(Type::Int32Ty, 1);
 576   CallInst::Create(LongJmpFn, Idx.begin(), Idx.end(), "", UnwindBlock);
 577   new UnreachableInst(UnwindBlock);
 578
 579   // Set up the term block ("throw without a catch").
 580   new UnreachableInst(TermBlock);
 581
 582   // Insert a new call to write(2, AbortMessage, AbortMessageLength);
 583   writeAbortMessage(TermBlock->getTerminator());
 584
 585   // Insert a call to abort()
 586   CallInst::Create(AbortFn, "",
 587                    TermBlock->getTerminator())->setTailCall();
 588
 589
 590   // Replace all unwinds with a branch to the unwind handler.
 591   for (unsigned i = 0, e = Unwinds.size(); i != e; ++i) {
 592     BranchInst::Create(UnwindHandler, Unwinds[i]);
 593     Unwinds[i]->eraseFromParent();
 594   }
 595
 596   // Finally, for any returns from this function, if this function contains an
 597   // invoke, restore the old jmpbuf pointer to its input value.
 598   if (OldJmpBufPtr) {
 599     for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
 600       ReturnInst *R = Returns[i];
 601
 602       // Before the return, insert a copy from the saved value to the new value.
 603       Value *OldBuf = new LoadInst(OldJmpBufPtr, "oldjmpbufptr", true, R);
 604       new StoreInst(OldBuf, JBListHead, true, R);
 605     }
 606   }
 607
 608   return true;
 609 }
 610
 611 bool LowerInvoke::runOnFunction(Function &F) {
 612   if (ExpensiveEHSupport)
 613     return insertExpensiveEHSupport(F);
 614   else
 615     return insertCheapEHSupport(F);
 616 }