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 #include "llvm/Transforms/Scalar.h"
  38 #include "llvm/Constants.h"
  39 #include "llvm/DerivedTypes.h"
  40 #include "llvm/Instructions.h"
  41 #include "llvm/Module.h"
  42 #include "llvm/Pass.h"
  43 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  44 #include "llvm/ADT/Statistic.h"
  45 #include "llvm/Support/CommandLine.h"
  46 #include <csetjmp>
  47 using namespace llvm;
  48
  49 namespace {
  50   Statistic<> NumLowered("lowerinvoke", "Number of invoke & unwinds replaced");
  51   cl::opt<bool> ExpensiveEHSupport("enable-correct-eh-support",
  52  cl::desc("Make the -lowerinvoke pass insert expensive, but correct, EH code"));
  53
  54   class LowerInvoke : public FunctionPass {
  55     // Used for both models.
  56     Function *WriteFn;
  57     Function *AbortFn;
  58     Value *AbortMessage;
  59     unsigned AbortMessageLength;
  60
  61     // Used for expensive EH support.
  62     const Type *JBLinkTy;
  63     GlobalVariable *JBListHead;
  64     Function *SetJmpFn, *LongJmpFn;
  65   public:
  66     bool doInitialization(Module &M);
  67     bool runOnFunction(Function &F);
  68   private:
  69     void createAbortMessage();
  70     void writeAbortMessage(Instruction *IB);
  71     bool insertCheapEHSupport(Function &F);
  72     bool insertExpensiveEHSupport(Function &F);
  73   };
  74
  75   RegisterOpt<LowerInvoke>
  76   X("lowerinvoke", "Lower invoke and unwind, for unwindless code generators");
  77 }
  78
  79 const PassInfo *llvm::LowerInvokePassID = X.getPassInfo();
  80
  81 // Public Interface To the LowerInvoke pass.
  82 FunctionPass *llvm::createLowerInvokePass() { return new LowerInvoke(); }
  83
  84 // doInitialization - Make sure that there is a prototype for abort in the
  85 // current module.
  86 bool LowerInvoke::doInitialization(Module &M) {
  87   const Type *VoidPtrTy = PointerType::get(Type::SByteTy);
  88   AbortMessage = 0;
  89   if (ExpensiveEHSupport) {
  90     // Insert a type for the linked list of jump buffers.  Unfortunately, we
  91     // don't know the size of the target's setjmp buffer, so we make a guess.
  92     // If this guess turns out to be too small, bad stuff could happen.
  93     unsigned JmpBufSize = 200;  // PPC has 192 words
  94     assert(sizeof(jmp_buf) <= JmpBufSize*sizeof(void*) &&
  95        "LowerInvoke doesn't know about targets with jmp_buf size > 200 words!");
  96     const Type *JmpBufTy = ArrayType::get(VoidPtrTy, JmpBufSize);
  97
  98     { // The type is recursive, so use a type holder.
  99       std::vector<const Type*> Elements;
 100       OpaqueType *OT = OpaqueType::get();
 101       Elements.push_back(PointerType::get(OT));
 102       Elements.push_back(JmpBufTy);
 103       PATypeHolder JBLType(StructType::get(Elements));
 104       OT->refineAbstractTypeTo(JBLType.get());  // Complete the cycle.
 105       JBLinkTy = JBLType.get();
 106       M.addTypeName("llvm.sjljeh.jmpbufty", JBLinkTy);
 107     }
 108
 109     const Type *PtrJBList = PointerType::get(JBLinkTy);
 110
 111     // Now that we've done that, insert the jmpbuf list head global, unless it
 112     // already exists.
 113     if (!(JBListHead = M.getGlobalVariable("llvm.sjljeh.jblist", PtrJBList)))
 114       JBListHead = new GlobalVariable(PtrJBList, false,
 115                                       GlobalValue::LinkOnceLinkage,
 116                                       Constant::getNullValue(PtrJBList),
 117                                       "llvm.sjljeh.jblist", &M);
 118     SetJmpFn = M.getOrInsertFunction("llvm.setjmp", Type::IntTy,
 119                                      PointerType::get(JmpBufTy), 0);
 120     LongJmpFn = M.getOrInsertFunction("llvm.longjmp", Type::VoidTy,
 121                                       PointerType::get(JmpBufTy),
 122                                       Type::IntTy, 0);
 123   }
 124
 125   // We need the 'write' and 'abort' functions for both models.
 126   AbortFn = M.getOrInsertFunction("abort", Type::VoidTy, 0);
 127
 128   // Unfortunately, 'write' can end up being prototyped in several different
 129   // ways.  If the user defines a three (or more) operand function named 'write'
 130   // we will use their prototype.  We _do not_ want to insert another instance
 131   // of a write prototype, because we don't know that the funcresolve pass will
 132   // run after us.  If there is a definition of a write function, but it's not
 133   // suitable for our uses, we just don't emit write calls.  If there is no
 134   // write prototype at all, we just add one.
 135   if (Function *WF = M.getNamedFunction("write")) {
 136     if (WF->getFunctionType()->getNumParams() > 3 ||
 137         WF->getFunctionType()->isVarArg())
 138       WriteFn = WF;
 139     else
 140       WriteFn = 0;
 141   } else {
 142     WriteFn = M.getOrInsertFunction("write", Type::VoidTy, Type::IntTy,
 143                                     VoidPtrTy, Type::IntTy, 0);
 144   }
 145   return true;
 146 }
 147
 148 void LowerInvoke::createAbortMessage() {
 149   Module &M = *WriteFn->getParent();
 150   if (ExpensiveEHSupport) {
 151     // The abort message for expensive EH support tells the user that the
 152     // program 'unwound' without an 'invoke' instruction.
 153     Constant *Msg =
 154       ConstantArray::get("ERROR: Exception thrown, but not caught!\n");
 155     AbortMessageLength = Msg->getNumOperands()-1;  // don't include \0
 156
 157     GlobalVariable *MsgGV = new GlobalVariable(Msg->getType(), true,
 158                                                GlobalValue::InternalLinkage,
 159                                                Msg, "abortmsg", &M);
 160     std::vector<Constant*> GEPIdx(2, Constant::getNullValue(Type::LongTy));
 161     AbortMessage = ConstantExpr::getGetElementPtr(MsgGV, GEPIdx);
 162   } else {
 163     // The abort message for cheap EH support tells the user that EH is not
 164     // enabled.
 165     Constant *Msg =
 166       ConstantArray::get("Exception handler needed, but not enabled.  Recompile"
 167                          " program with -enable-correct-eh-support.\n");
 168     AbortMessageLength = Msg->getNumOperands()-1;  // don't include \0
 169
 170     GlobalVariable *MsgGV = new GlobalVariable(Msg->getType(), true,
 171                                                GlobalValue::InternalLinkage,
 172                                                Msg, "abortmsg", &M);
 173     std::vector<Constant*> GEPIdx(2, Constant::getNullValue(Type::LongTy));
 174     AbortMessage = ConstantExpr::getGetElementPtr(MsgGV, GEPIdx);
 175   }
 176 }
 177
 178
 179 void LowerInvoke::writeAbortMessage(Instruction *IB) {
 180   if (WriteFn) {
 181     if (AbortMessage == 0) createAbortMessage();
 182
 183     // These are the arguments we WANT...
 184     std::vector<Value*> Args;
 185     Args.push_back(ConstantInt::get(Type::IntTy, 2));
 186     Args.push_back(AbortMessage);
 187     Args.push_back(ConstantInt::get(Type::IntTy, AbortMessageLength));
 188
 189     // If the actual declaration of write disagrees, insert casts as
 190     // appropriate.
 191     const FunctionType *FT = WriteFn->getFunctionType();
 192     unsigned NumArgs = FT->getNumParams();
 193     for (unsigned i = 0; i != 3; ++i)
 194       if (i < NumArgs && FT->getParamType(i) != Args[i]->getType())
 195         Args[i] = ConstantExpr::getCast(cast<Constant>(Args[i]),
 196                                         FT->getParamType(i));
 197
 198     new CallInst(WriteFn, Args, "", IB);
 199   }
 200 }
 201
 202 bool LowerInvoke::insertCheapEHSupport(Function &F) {
 203   bool Changed = false;
 204   for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
 205     if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator())) {
 206       // Insert a normal call instruction...
 207       std::string Name = II->getName(); II->setName("");
 208       Value *NewCall = new CallInst(II->getCalledValue(),
 209                                     std::vector<Value*>(II->op_begin()+3,
 210                                                         II->op_end()), Name,II);
 211       II->replaceAllUsesWith(NewCall);
 212
 213       // Insert an unconditional branch to the normal destination.
 214       new BranchInst(II->getNormalDest(), II);
 215
 216       // Remove any PHI node entries from the exception destination.
 217       II->getUnwindDest()->removePredecessor(BB);
 218
 219       // Remove the invoke instruction now.
 220       BB->getInstList().erase(II);
 221
 222       ++NumLowered; Changed = true;
 223     } else if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
 224       // Insert a new call to write(2, AbortMessage, AbortMessageLength);
 225       writeAbortMessage(UI);
 226
 227       // Insert a call to abort()
 228       new CallInst(AbortFn, std::vector<Value*>(), "", UI);
 229
 230       // Insert a return instruction.  This really should be a "barrier", as it
 231       // is unreachable.
 232       new ReturnInst(F.getReturnType() == Type::VoidTy ? 0 :
 233                             Constant::getNullValue(F.getReturnType()), UI);
 234
 235       // Remove the unwind instruction now.
 236       BB->getInstList().erase(UI);
 237
 238       ++NumLowered; Changed = true;
 239     }
 240   return Changed;
 241 }
 242
 243 bool LowerInvoke::insertExpensiveEHSupport(Function &F) {
 244   bool Changed = false;
 245
 246   // If a function uses invoke, we have an alloca for the jump buffer.
 247   AllocaInst *JmpBuf = 0;
 248
 249   // If this function contains an unwind instruction, two blocks get added: one
 250   // to actually perform the longjmp, and one to terminate the program if there
 251   // is no handler.
 252   BasicBlock *UnwindBlock = 0, *TermBlock = 0;
 253   std::vector<LoadInst*> JBPtrs;
 254
 255   for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
 256     if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator())) {
 257       if (JmpBuf == 0)
 258         JmpBuf = new AllocaInst(JBLinkTy, 0, "jblink", F.begin()->begin());
 259
 260       // On the entry to the invoke, we must install our JmpBuf as the top of
 261       // the stack.
 262       LoadInst *OldEntry = new LoadInst(JBListHead, "oldehlist", II);
 263
 264       // Store this old value as our 'next' field, and store our alloca as the
 265       // current jblist.
 266       std::vector<Value*> Idx;
 267       Idx.push_back(Constant::getNullValue(Type::IntTy));
 268       Idx.push_back(ConstantUInt::get(Type::UIntTy, 0));
 269       Value *NextFieldPtr = new GetElementPtrInst(JmpBuf, Idx, "NextField", II);
 270       new StoreInst(OldEntry, NextFieldPtr, II);
 271       new StoreInst(JmpBuf, JBListHead, II);
 272
 273       // Call setjmp, passing in the address of the jmpbuffer.
 274       Idx[1] = ConstantUInt::get(Type::UIntTy, 1);
 275       Value *JmpBufPtr = new GetElementPtrInst(JmpBuf, Idx, "TheJmpBuf", II);
 276       Value *SJRet = new CallInst(SetJmpFn, JmpBufPtr, "sjret", II);
 277
 278       // Compare the return value to zero.
 279       Value *IsNormal = BinaryOperator::create(Instruction::SetEQ, SJRet,
 280                                        Constant::getNullValue(SJRet->getType()),
 281                                                "notunwind", II);
 282       // Create the receiver block if there is a critical edge to the normal
 283       // destination.
 284       SplitCriticalEdge(II, 0, this);
 285       Instruction *InsertLoc = II->getNormalDest()->begin();
 286
 287       // Insert a normal call instruction on the normal execution path.
 288       std::string Name = II->getName(); II->setName("");
 289       Value *NewCall = new CallInst(II->getCalledValue(),
 290                                     std::vector<Value*>(II->op_begin()+3,
 291                                                         II->op_end()), Name,
 292                                     InsertLoc);
 293       II->replaceAllUsesWith(NewCall);
 294
 295       // If we got this far, then no exception was thrown and we can pop our
 296       // jmpbuf entry off.
 297       new StoreInst(OldEntry, JBListHead, InsertLoc);
 298
 299       // Now we change the invoke into a branch instruction.
 300       new BranchInst(II->getNormalDest(), II->getUnwindDest(), IsNormal, II);
 301
 302       // Remove the InvokeInst now.
 303       BB->getInstList().erase(II);
 304       ++NumLowered; Changed = true;
 305
 306     } else if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->getTerminator())) {
 307       if (UnwindBlock == 0) {
 308         // Create two new blocks, the unwind block and the terminate block.  Add
 309         // them at the end of the function because they are not hot.
 310         UnwindBlock = new BasicBlock("unwind", &F);
 311         TermBlock = new BasicBlock("unwinderror", &F);
 312
 313         // Insert return instructions.  These really should be "barrier"s, as
 314         // they are unreachable.
 315         new ReturnInst(F.getReturnType() == Type::VoidTy ? 0 :
 316                        Constant::getNullValue(F.getReturnType()), UnwindBlock);
 317         new ReturnInst(F.getReturnType() == Type::VoidTy ? 0 :
 318                        Constant::getNullValue(F.getReturnType()), TermBlock);
 319       }
 320
 321       // Load the JBList, if it's null, then there was no catch!
 322       LoadInst *Ptr = new LoadInst(JBListHead, "ehlist", UI);
 323       Value *NotNull = BinaryOperator::create(Instruction::SetNE, Ptr,
 324                                         Constant::getNullValue(Ptr->getType()),
 325                                               "notnull", UI);
 326       new BranchInst(UnwindBlock, TermBlock, NotNull, UI);
 327
 328       // Remember the loaded value so we can insert the PHI node as needed.
 329       JBPtrs.push_back(Ptr);
 330
 331       // Remove the UnwindInst now.
 332       BB->getInstList().erase(UI);
 333       ++NumLowered; Changed = true;
 334     }
 335
 336   // If an unwind instruction was inserted, we need to set up the Unwind and
 337   // term blocks.
 338   if (UnwindBlock) {
 339     // In the unwind block, we know that the pointer coming in on the JBPtrs
 340     // list are non-null.
 341     Instruction *RI = UnwindBlock->getTerminator();
 342
 343     Value *RecPtr;
 344     if (JBPtrs.size() == 1)
 345       RecPtr = JBPtrs[0];
 346     else {
 347       // If there is more than one unwind in this function, make a PHI node to
 348       // merge in all of the loaded values.
 349       PHINode *PN = new PHINode(JBPtrs[0]->getType(), "jbptrs", RI);
 350       for (unsigned i = 0, e = JBPtrs.size(); i != e; ++i)
 351         PN->addIncoming(JBPtrs[i], JBPtrs[i]->getParent());
 352       RecPtr = PN;
 353     }
 354
 355     // Now that we have a pointer to the whole record, remove the entry from the
 356     // JBList.
 357     std::vector<Value*> Idx;
 358     Idx.push_back(Constant::getNullValue(Type::LongTy));
 359     Idx.push_back(ConstantUInt::get(Type::UIntTy, 0));
 360     Value *NextFieldPtr = new GetElementPtrInst(RecPtr, Idx, "NextField", RI);
 361     Value *NextRec = new LoadInst(NextFieldPtr, "NextRecord", RI);
 362     new StoreInst(NextRec, JBListHead, RI);
 363
 364     // Now that we popped the top of the JBList, get a pointer to the jmpbuf and
 365     // longjmp.
 366     Idx[1] = ConstantUInt::get(Type::UIntTy, 1);
 367     Idx[0] = new GetElementPtrInst(RecPtr, Idx, "JmpBuf", RI);
 368     Idx[1] = ConstantInt::get(Type::IntTy, 1);
 369     new CallInst(LongJmpFn, Idx, "", RI);
 370
 371     // Now we set up the terminate block.
 372     RI = TermBlock->getTerminator();
 373
 374     // Insert a new call to write(2, AbortMessage, AbortMessageLength);
 375     writeAbortMessage(RI);
 376
 377     // Insert a call to abort()
 378     new CallInst(AbortFn, std::vector<Value*>(), "", RI);
 379   }
 380
 381   return Changed;
 382 }
 383
 384 bool LowerInvoke::runOnFunction(Function &F) {
 385   if (ExpensiveEHSupport)
 386     return insertExpensiveEHSupport(F);
 387   else
 388     return insertCheapEHSupport(F);
 389 }