lib/Transforms/Utils/LowerInvoke.cpp

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