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