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