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::get(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::get(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::get(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::get(JmpBufTy), (Type *)0);
 148     LongJmpFn = M.getOrInsertFunction("llvm.longjmp", Type::VoidTy,
 149                                       PointerType::get(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 = new CallInst(II->getCalledValue(),
 215                                        CallArgs.begin(), CallArgs.end(), "", II);
 216       NewCall->takeName(II);
 217       NewCall->setCallingConv(II->getCallingConv());
 218       II->replaceAllUsesWith(NewCall);
 219
 220       // Insert an unconditional branch to the normal destination.
 221       new BranchInst(II->getNormalDest(), II);
 222
 223       // Remove any PHI node entries from the exception destination.
 224       II->getUnwindDest()->removePredecessor(BB);
 225
 226       // Remove the invoke instruction now.
 227       BB->getInstList().erase(II);
 228
 229       ++NumInvokes; Changed = true;
 230     } else if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
 231       // Insert a new call to write(2, AbortMessage, AbortMessageLength);
 232       writeAbortMessage(UI);
 233
 234       // Insert a call to abort()
 235       (new CallInst(AbortFn, "", UI))->setTailCall();
 236
 237       // Insert a return instruction.  This really should be a "barrier", as it
 238       // is unreachable.
 239       new ReturnInst(F.getReturnType() == Type::VoidTy ? 0 :
 240                             Constant::getNullValue(F.getReturnType()), UI);
 241
 242       // Remove the unwind instruction now.
 243       BB->getInstList().erase(UI);
 244
 245       ++NumUnwinds; Changed = true;
 246     }
 247   return Changed;
 248 }
 249
 250 /// rewriteExpensiveInvoke - Insert code and hack the function to replace the
 251 /// specified invoke instruction with a call.
 252 void LowerInvoke::rewriteExpensiveInvoke(InvokeInst *II, unsigned InvokeNo,
 253                                          AllocaInst *InvokeNum,
 254                                          SwitchInst *CatchSwitch) {
 255   ConstantInt *InvokeNoC = ConstantInt::get(Type::Int32Ty, InvokeNo);
 256
 257   // Insert a store of the invoke num before the invoke and store zero into the
 258   // location afterward.
 259   new StoreInst(InvokeNoC, InvokeNum, true, II);  // volatile
 260
 261   BasicBlock::iterator NI = II->getNormalDest()->begin();
 262   while (isa<PHINode>(NI)) ++NI;
 263   // nonvolatile.
 264   new StoreInst(Constant::getNullValue(Type::Int32Ty), InvokeNum, false, NI);
 265
 266   // Add a switch case to our unwind block.
 267   CatchSwitch->addCase(InvokeNoC, II->getUnwindDest());
 268
 269   // Insert a normal call instruction.
 270   std::vector<Value*> CallArgs(II->op_begin()+3, II->op_end());
 271   CallInst *NewCall = new CallInst(II->getCalledValue(),
 272                                    CallArgs.begin(), CallArgs.end(), "",
 273                                    II);
 274   NewCall->takeName(II);
 275   NewCall->setCallingConv(II->getCallingConv());
 276   II->replaceAllUsesWith(NewCall);
 277
 278   // Replace the invoke with an uncond branch.
 279   new BranchInst(II->getNormalDest(), NewCall->getParent());
 280   II->eraseFromParent();
 281 }
 282
 283 /// MarkBlocksLiveIn - Insert BB and all of its predescessors into LiveBBs until
 284 /// we reach blocks we've already seen.
 285 static void MarkBlocksLiveIn(BasicBlock *BB, std::set<BasicBlock*> &LiveBBs) {
 286   if (!LiveBBs.insert(BB).second) return; // already been here.
 287
 288   for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
 289     MarkBlocksLiveIn(*PI, LiveBBs);
 290 }
 291
 292 // First thing we need to do is scan the whole function for values that are
 293 // live across unwind edges.  Each value that is live across an unwind edge
 294 // we spill into a stack location, guaranteeing that there is nothing live
 295 // across the unwind edge.  This process also splits all critical edges
 296 // coming out of invoke's.
 297 void LowerInvoke::
 298 splitLiveRangesLiveAcrossInvokes(std::vector<InvokeInst*> &Invokes) {
 299   // First step, split all critical edges from invoke instructions.
 300   for (unsigned i = 0, e = Invokes.size(); i != e; ++i) {
 301     InvokeInst *II = Invokes[i];
 302     SplitCriticalEdge(II, 0, this);
 303     SplitCriticalEdge(II, 1, this);
 304     assert(!isa<PHINode>(II->getNormalDest()) &&
 305            !isa<PHINode>(II->getUnwindDest()) &&
 306            "critical edge splitting left single entry phi nodes?");
 307   }
 308
 309   Function *F = Invokes.back()->getParent()->getParent();
 310
 311   // To avoid having to handle incoming arguments specially, we lower each arg
 312   // to a copy instruction in the entry block.  This ensures that the argument
 313   // value itself cannot be live across the entry block.
 314   BasicBlock::iterator AfterAllocaInsertPt = F->begin()->begin();
 315   while (isa<AllocaInst>(AfterAllocaInsertPt) &&
 316         isa<ConstantInt>(cast<AllocaInst>(AfterAllocaInsertPt)->getArraySize()))
 317     ++AfterAllocaInsertPt;
 318   for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end();
 319        AI != E; ++AI) {
 320     // This is always a no-op cast because we're casting AI to AI->getType() so
 321     // src and destination types are identical. BitCast is the only possibility.
 322     CastInst *NC = new BitCastInst(
 323       AI, AI->getType(), AI->getName()+".tmp", AfterAllocaInsertPt);
 324     AI->replaceAllUsesWith(NC);
 325     // Normally its is forbidden to replace a CastInst's operand because it
 326     // could cause the opcode to reflect an illegal conversion. However, we're
 327     // replacing it here with the same value it was constructed with to simply
 328     // make NC its user.
 329     NC->setOperand(0, AI);
 330   }
 331
 332   // Finally, scan the code looking for instructions with bad live ranges.
 333   for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
 334     for (BasicBlock::iterator II = BB->begin(), E = BB->end(); II != E; ++II) {
 335       // Ignore obvious cases we don't have to handle.  In particular, most
 336       // instructions either have no uses or only have a single use inside the
 337       // current block.  Ignore them quickly.
 338       Instruction *Inst = II;
 339       if (Inst->use_empty()) continue;
 340       if (Inst->hasOneUse() &&
 341           cast<Instruction>(Inst->use_back())->getParent() == BB &&
 342           !isa<PHINode>(Inst->use_back())) continue;
 343
 344       // If this is an alloca in the entry block, it's not a real register
 345       // value.
 346       if (AllocaInst *AI = dyn_cast<AllocaInst>(Inst))
 347         if (isa<ConstantInt>(AI->getArraySize()) && BB == F->begin())
 348           continue;
 349
 350       // Avoid iterator invalidation by copying users to a temporary vector.
 351       std::vector<Instruction*> Users;
 352       for (Value::use_iterator UI = Inst->use_begin(), E = Inst->use_end();
 353            UI != E; ++UI) {
 354         Instruction *User = cast<Instruction>(*UI);
 355         if (User->getParent() != BB || isa<PHINode>(User))
 356           Users.push_back(User);
 357       }
 358
 359       // Scan all of the uses and see if the live range is live across an unwind
 360       // edge.  If we find a use live across an invoke edge, create an alloca
 361       // and spill the value.
 362       std::set<InvokeInst*> InvokesWithStoreInserted;
 363
 364       // Find all of the blocks that this value is live in.
 365       std::set<BasicBlock*> LiveBBs;
 366       LiveBBs.insert(Inst->getParent());
 367       while (!Users.empty()) {
 368         Instruction *U = Users.back();
 369         Users.pop_back();
 370
 371         if (!isa<PHINode>(U)) {
 372           MarkBlocksLiveIn(U->getParent(), LiveBBs);
 373         } else {
 374           // Uses for a PHI node occur in their predecessor block.
 375           PHINode *PN = cast<PHINode>(U);
 376           for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 377             if (PN->getIncomingValue(i) == Inst)
 378               MarkBlocksLiveIn(PN->getIncomingBlock(i), LiveBBs);
 379         }
 380       }
 381
 382       // Now that we know all of the blocks that this thing is live in, see if
 383       // it includes any of the unwind locations.
 384       bool NeedsSpill = false;
 385       for (unsigned i = 0, e = Invokes.size(); i != e; ++i) {
 386         BasicBlock *UnwindBlock = Invokes[i]->getUnwindDest();
 387         if (UnwindBlock != BB && LiveBBs.count(UnwindBlock)) {
 388           NeedsSpill = true;
 389         }
 390       }
 391
 392       // If we decided we need a spill, do it.
 393       if (NeedsSpill) {
 394         ++NumSpilled;
 395         DemoteRegToStack(*Inst, true);
 396       }
 397     }
 398 }
 399
 400 bool LowerInvoke::insertExpensiveEHSupport(Function &F) {
 401   std::vector<ReturnInst*> Returns;
 402   std::vector<UnwindInst*> Unwinds;
 403   std::vector<InvokeInst*> Invokes;
 404
 405   for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
 406     if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
 407       // Remember all return instructions in case we insert an invoke into this
 408       // function.
 409       Returns.push_back(RI);
 410     } else if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator())) {
 411       Invokes.push_back(II);
 412     } else if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
 413       Unwinds.push_back(UI);
 414     }
 415
 416   if (Unwinds.empty() && Invokes.empty()) return false;
 417
 418   NumInvokes += Invokes.size();
 419   NumUnwinds += Unwinds.size();
 420
 421   // TODO: This is not an optimal way to do this.  In particular, this always
 422   // inserts setjmp calls into the entries of functions with invoke instructions
 423   // even though there are possibly paths through the function that do not
 424   // execute any invokes.  In particular, for functions with early exits, e.g.
 425   // the 'addMove' method in hexxagon, it would be nice to not have to do the
 426   // setjmp stuff on the early exit path.  This requires a bit of dataflow, but
 427   // would not be too hard to do.
 428
 429   // If we have an invoke instruction, insert a setjmp that dominates all
 430   // invokes.  After the setjmp, use a cond branch that goes to the original
 431   // code path on zero, and to a designated 'catch' block of nonzero.
 432   Value *OldJmpBufPtr = 0;
 433   if (!Invokes.empty()) {
 434     // First thing we need to do is scan the whole function for values that are
 435     // live across unwind edges.  Each value that is live across an unwind edge
 436     // we spill into a stack location, guaranteeing that there is nothing live
 437     // across the unwind edge.  This process also splits all critical edges
 438     // coming out of invoke's.
 439     splitLiveRangesLiveAcrossInvokes(Invokes);
 440
 441     BasicBlock *EntryBB = F.begin();
 442
 443     // Create an alloca for the incoming jump buffer ptr and the new jump buffer
 444     // that needs to be restored on all exits from the function.  This is an
 445     // alloca because the value needs to be live across invokes.
 446     unsigned Align = TLI ? TLI->getJumpBufAlignment() : 0;
 447     AllocaInst *JmpBuf =
 448       new AllocaInst(JBLinkTy, 0, Align, "jblink", F.begin()->begin());
 449
 450     std::vector<Value*> Idx;
 451     Idx.push_back(Constant::getNullValue(Type::Int32Ty));
 452     Idx.push_back(ConstantInt::get(Type::Int32Ty, 1));
 453     OldJmpBufPtr = new GetElementPtrInst(JmpBuf, Idx.begin(), Idx.end(),
 454                                          "OldBuf", EntryBB->getTerminator());
 455
 456     // Copy the JBListHead to the alloca.
 457     Value *OldBuf = new LoadInst(JBListHead, "oldjmpbufptr", true,
 458                                  EntryBB->getTerminator());
 459     new StoreInst(OldBuf, OldJmpBufPtr, true, EntryBB->getTerminator());
 460
 461     // Add the new jumpbuf to the list.
 462     new StoreInst(JmpBuf, JBListHead, true, EntryBB->getTerminator());
 463
 464     // Create the catch block.  The catch block is basically a big switch
 465     // statement that goes to all of the invoke catch blocks.
 466     BasicBlock *CatchBB = new BasicBlock("setjmp.catch", &F);
 467
 468     // Create an alloca which keeps track of which invoke is currently
 469     // executing.  For normal calls it contains zero.
 470     AllocaInst *InvokeNum = new AllocaInst(Type::Int32Ty, 0, "invokenum",
 471                                            EntryBB->begin());
 472     new StoreInst(ConstantInt::get(Type::Int32Ty, 0), InvokeNum, true,
 473                   EntryBB->getTerminator());
 474
 475     // Insert a load in the Catch block, and a switch on its value.  By default,
 476     // we go to a block that just does an unwind (which is the correct action
 477     // for a standard call).
 478     BasicBlock *UnwindBB = new BasicBlock("unwindbb", &F);
 479     Unwinds.push_back(new UnwindInst(UnwindBB));
 480
 481     Value *CatchLoad = new LoadInst(InvokeNum, "invoke.num", true, CatchBB);
 482     SwitchInst *CatchSwitch =
 483       new SwitchInst(CatchLoad, UnwindBB, Invokes.size(), CatchBB);
 484
 485     // Now that things are set up, insert the setjmp call itself.
 486
 487     // Split the entry block to insert the conditional branch for the setjmp.
 488     BasicBlock *ContBlock = EntryBB->splitBasicBlock(EntryBB->getTerminator(),
 489                                                      "setjmp.cont");
 490
 491     Idx[1] = ConstantInt::get(Type::Int32Ty, 0);
 492     Value *JmpBufPtr = new GetElementPtrInst(JmpBuf, Idx.begin(), Idx.end(),
 493                                              "TheJmpBuf",
 494                                              EntryBB->getTerminator());
 495     Value *SJRet = new CallInst(SetJmpFn, JmpBufPtr, "sjret",
 496                                 EntryBB->getTerminator());
 497
 498     // Compare the return value to zero.
 499     Value *IsNormal = new ICmpInst(ICmpInst::ICMP_EQ, SJRet,
 500                                    Constant::getNullValue(SJRet->getType()),
 501       "notunwind", EntryBB->getTerminator());
 502     // Nuke the uncond branch.
 503     EntryBB->getTerminator()->eraseFromParent();
 504
 505     // Put in a new condbranch in its place.
 506     new BranchInst(ContBlock, CatchBB, IsNormal, EntryBB);
 507
 508     // At this point, we are all set up, rewrite each invoke instruction.
 509     for (unsigned i = 0, e = Invokes.size(); i != e; ++i)
 510       rewriteExpensiveInvoke(Invokes[i], i+1, InvokeNum, CatchSwitch);
 511   }
 512
 513   // We know that there is at least one unwind.
 514
 515   // Create three new blocks, the block to load the jmpbuf ptr and compare
 516   // against null, the block to do the longjmp, and the error block for if it
 517   // is null.  Add them at the end of the function because they are not hot.
 518   BasicBlock *UnwindHandler = new BasicBlock("dounwind", &F);
 519   BasicBlock *UnwindBlock = new BasicBlock("unwind", &F);
 520   BasicBlock *TermBlock = new BasicBlock("unwinderror", &F);
 521
 522   // If this function contains an invoke, restore the old jumpbuf ptr.
 523   Value *BufPtr;
 524   if (OldJmpBufPtr) {
 525     // Before the return, insert a copy from the saved value to the new value.
 526     BufPtr = new LoadInst(OldJmpBufPtr, "oldjmpbufptr", UnwindHandler);
 527     new StoreInst(BufPtr, JBListHead, UnwindHandler);
 528   } else {
 529     BufPtr = new LoadInst(JBListHead, "ehlist", UnwindHandler);
 530   }
 531
 532   // Load the JBList, if it's null, then there was no catch!
 533   Value *NotNull = new ICmpInst(ICmpInst::ICMP_NE, BufPtr,
 534                                 Constant::getNullValue(BufPtr->getType()),
 535     "notnull", UnwindHandler);
 536   new BranchInst(UnwindBlock, TermBlock, NotNull, UnwindHandler);
 537
 538   // Create the block to do the longjmp.
 539   // Get a pointer to the jmpbuf and longjmp.
 540   std::vector<Value*> Idx;
 541   Idx.push_back(Constant::getNullValue(Type::Int32Ty));
 542   Idx.push_back(ConstantInt::get(Type::Int32Ty, 0));
 543   Idx[0] = new GetElementPtrInst(BufPtr, Idx.begin(), Idx.end(), "JmpBuf",
 544                                  UnwindBlock);
 545   Idx[1] = ConstantInt::get(Type::Int32Ty, 1);
 546   new CallInst(LongJmpFn, Idx.begin(), Idx.end(), "", UnwindBlock);
 547   new UnreachableInst(UnwindBlock);
 548
 549   // Set up the term block ("throw without a catch").
 550   new UnreachableInst(TermBlock);
 551
 552   // Insert a new call to write(2, AbortMessage, AbortMessageLength);
 553   writeAbortMessage(TermBlock->getTerminator());
 554
 555   // Insert a call to abort()
 556   (new CallInst(AbortFn, "",
 557                 TermBlock->getTerminator()))->setTailCall();
 558
 559
 560   // Replace all unwinds with a branch to the unwind handler.
 561   for (unsigned i = 0, e = Unwinds.size(); i != e; ++i) {
 562     new BranchInst(UnwindHandler, Unwinds[i]);
 563     Unwinds[i]->eraseFromParent();
 564   }
 565
 566   // Finally, for any returns from this function, if this function contains an
 567   // invoke, restore the old jmpbuf pointer to its input value.
 568   if (OldJmpBufPtr) {
 569     for (unsigned i = 0, e = Returns.size(); i != e; ++i) {
 570       ReturnInst *R = Returns[i];
 571
 572       // Before the return, insert a copy from the saved value to the new value.
 573       Value *OldBuf = new LoadInst(OldJmpBufPtr, "oldjmpbufptr", true, R);
 574       new StoreInst(OldBuf, JBListHead, true, R);
 575     }
 576   }
 577
 578   return true;
 579 }
 580
 581 bool LowerInvoke::runOnFunction(Function &F) {
 582   if (ExpensiveEHSupport)
 583     return insertExpensiveEHSupport(F);
 584   else
 585     return insertCheapEHSupport(F);
 586 }