lib/Transforms/IPO/PruneEH.cpp

   1 //===- PruneEH.cpp - Pass which deletes unused exception handlers ---------===//
   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 file implements a simple interprocedural pass which walks the
  11 // call-graph, turning invoke instructions into calls, iff the callee cannot
  12 // throw an exception, and marking functions 'nounwind' if they cannot throw.
  13 // It implements this as a bottom-up traversal of the call-graph.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #define DEBUG_TYPE "prune-eh"
  18 #include "llvm/Transforms/IPO.h"
  19 #include "llvm/CallGraphSCCPass.h"
  20 #include "llvm/Constants.h"
  21 #include "llvm/Function.h"
  22 #include "llvm/Instructions.h"
  23 #include "llvm/Analysis/CallGraph.h"
  24 #include "llvm/ADT/SmallVector.h"
  25 #include "llvm/ADT/Statistic.h"
  26 #include "llvm/Support/CFG.h"
  27 #include "llvm/Support/Compiler.h"
  28 #include <set>
  29 #include <algorithm>
  30 using namespace llvm;
  31
  32 STATISTIC(NumRemoved, "Number of invokes removed");
  33 STATISTIC(NumUnreach, "Number of noreturn calls optimized");
  34
  35 namespace {
  36   struct VISIBILITY_HIDDEN PruneEH : public CallGraphSCCPass {
  37     static char ID; // Pass identification, replacement for typeid
  38     PruneEH() : CallGraphSCCPass((intptr_t)&ID) {}
  39
  40     // runOnSCC - Analyze the SCC, performing the transformation if possible.
  41     bool runOnSCC(const std::vector<CallGraphNode *> &SCC);
  42
  43     bool SimplifyFunction(Function *F);
  44     void DeleteBasicBlock(BasicBlock *BB);
  45   };
  46
  47   char PruneEH::ID = 0;
  48   RegisterPass<PruneEH> X("prune-eh", "Remove unused exception handling info");
  49 }
  50
  51 Pass *llvm::createPruneEHPass() { return new PruneEH(); }
  52
  53
  54 bool PruneEH::runOnSCC(const std::vector<CallGraphNode *> &SCC) {
  55   CallGraph &CG = getAnalysis<CallGraph>();
  56   bool MadeChange = false;
  57
  58   // First pass, scan all of the functions in the SCC, simplifying them
  59   // according to what we know.
  60   for (unsigned i = 0, e = SCC.size(); i != e; ++i)
  61     if (Function *F = SCC[i]->getFunction())
  62       MadeChange |= SimplifyFunction(F);
  63
  64   // Next, check to see if any callees might throw or if there are any external
  65   // functions in this SCC: if so, we cannot prune any functions in this SCC.
  66   // If this SCC includes the unwind instruction, we KNOW it throws, so
  67   // obviously the SCC might throw.
  68   //
  69   bool SCCMightUnwind = false, SCCMightReturn = false;
  70   for (unsigned i = 0, e = SCC.size();
  71        (!SCCMightUnwind || !SCCMightReturn) && i != e; ++i) {
  72     Function *F = SCC[i]->getFunction();
  73     if (F == 0) {
  74       SCCMightUnwind = true;
  75       SCCMightReturn = true;
  76     } else if (F->isDeclaration()) {
  77       SCCMightUnwind |= !F->doesNotThrow();
  78       SCCMightReturn |= !F->doesNotReturn();
  79     } else {
  80       bool CheckUnwind = !SCCMightUnwind && !F->doesNotThrow();
  81       bool CheckReturn = !SCCMightReturn && !F->doesNotReturn();
  82
  83       if (!CheckUnwind && !CheckReturn)
  84         continue;
  85
  86       // Check to see if this function performs an unwind or calls an
  87       // unwinding function.
  88       for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
  89         if (CheckUnwind && isa<UnwindInst>(BB->getTerminator())) {
  90           // Uses unwind!
  91           SCCMightUnwind = true;
  92         } else if (CheckReturn && isa<ReturnInst>(BB->getTerminator())) {
  93           SCCMightReturn = true;
  94         }
  95
  96         // Invoke instructions don't allow unwinding to continue, so we are
  97         // only interested in call instructions.
  98         if (CheckUnwind && !SCCMightUnwind)
  99           for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
 100             if (CallInst *CI = dyn_cast<CallInst>(I)) {
 101               if (CI->doesNotThrow()) {
 102                 // This call cannot throw.
 103               } else if (Function *Callee = CI->getCalledFunction()) {
 104                 CallGraphNode *CalleeNode = CG[Callee];
 105                 // If the callee is outside our current SCC then we may
 106                 // throw because it might.
 107                 if (std::find(SCC.begin(), SCC.end(), CalleeNode) == SCC.end()){
 108                   SCCMightUnwind = true;
 109                   break;
 110                 }
 111               } else {
 112                 // Indirect call, it might throw.
 113                 SCCMightUnwind = true;
 114                 break;
 115               }
 116             }
 117         if (SCCMightUnwind && SCCMightReturn) break;
 118       }
 119     }
 120   }
 121
 122   // If the SCC doesn't unwind or doesn't throw, note this fact.
 123   if (!SCCMightUnwind || !SCCMightReturn)
 124     for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
 125       ParameterAttributes NewAttributes = ParamAttr::None;
 126
 127       if (!SCCMightUnwind)
 128         NewAttributes |= ParamAttr::NoUnwind;
 129       if (!SCCMightReturn)
 130         NewAttributes |= ParamAttr::NoReturn;
 131
 132       const PAListPtr &PAL = SCC[i]->getFunction()->getParamAttrs();
 133       SCC[i]->getFunction()->setParamAttrs(PAL.addAttr(0, NewAttributes));
 134     }
 135
 136   for (unsigned i = 0, e = SCC.size(); i != e; ++i) {
 137     // Convert any invoke instructions to non-throwing functions in this node
 138     // into call instructions with a branch.  This makes the exception blocks
 139     // dead.
 140     if (Function *F = SCC[i]->getFunction())
 141       MadeChange |= SimplifyFunction(F);
 142   }
 143
 144   return MadeChange;
 145 }
 146
 147
 148 // SimplifyFunction - Given information about callees, simplify the specified
 149 // function if we have invokes to non-unwinding functions or code after calls to
 150 // no-return functions.
 151 bool PruneEH::SimplifyFunction(Function *F) {
 152   bool MadeChange = false;
 153   for (Function::iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
 154     if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator()))
 155       if (II->doesNotThrow()) {
 156         SmallVector<Value*, 8> Args(II->op_begin()+3, II->op_end());
 157         // Insert a call instruction before the invoke.
 158         CallInst *Call = CallInst::Create(II->getCalledValue(),
 159                                           Args.begin(), Args.end(), "", II);
 160         Call->takeName(II);
 161         Call->setCallingConv(II->getCallingConv());
 162         Call->setParamAttrs(II->getParamAttrs());
 163
 164         // Anything that used the value produced by the invoke instruction
 165         // now uses the value produced by the call instruction.
 166         II->replaceAllUsesWith(Call);
 167         BasicBlock *UnwindBlock = II->getUnwindDest();
 168         UnwindBlock->removePredecessor(II->getParent());
 169
 170         // Insert a branch to the normal destination right before the
 171         // invoke.
 172         BranchInst::Create(II->getNormalDest(), II);
 173
 174         // Finally, delete the invoke instruction!
 175         BB->getInstList().pop_back();
 176
 177         // If the unwind block is now dead, nuke it.
 178         if (pred_begin(UnwindBlock) == pred_end(UnwindBlock))
 179           DeleteBasicBlock(UnwindBlock);  // Delete the new BB.
 180
 181         ++NumRemoved;
 182         MadeChange = true;
 183       }
 184
 185     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; )
 186       if (CallInst *CI = dyn_cast<CallInst>(I++))
 187         if (CI->doesNotReturn() && !isa<UnreachableInst>(I)) {
 188           // This call calls a function that cannot return.  Insert an
 189           // unreachable instruction after it and simplify the code.  Do this
 190           // by splitting the BB, adding the unreachable, then deleting the
 191           // new BB.
 192           BasicBlock *New = BB->splitBasicBlock(I);
 193
 194           // Remove the uncond branch and add an unreachable.
 195           BB->getInstList().pop_back();
 196           new UnreachableInst(BB);
 197
 198           DeleteBasicBlock(New);  // Delete the new BB.
 199           MadeChange = true;
 200           ++NumUnreach;
 201           break;
 202         }
 203   }
 204
 205   return MadeChange;
 206 }
 207
 208 /// DeleteBasicBlock - remove the specified basic block from the program,
 209 /// updating the callgraph to reflect any now-obsolete edges due to calls that
 210 /// exist in the BB.
 211 void PruneEH::DeleteBasicBlock(BasicBlock *BB) {
 212   assert(pred_begin(BB) == pred_end(BB) && "BB is not dead!");
 213   CallGraph &CG = getAnalysis<CallGraph>();
 214
 215   CallGraphNode *CGN = CG[BB->getParent()];
 216   for (BasicBlock::iterator I = BB->end(), E = BB->begin(); I != E; ) {
 217     --I;
 218     if (CallInst *CI = dyn_cast<CallInst>(I)) {
 219       if (Function *Callee = CI->getCalledFunction())
 220         CGN->removeCallEdgeTo(CG[Callee]);
 221     } else if (InvokeInst *II = dyn_cast<InvokeInst>(I)) {
 222       if (Function *Callee = II->getCalledFunction())
 223         CGN->removeCallEdgeTo(CG[Callee]);
 224     }
 225     if (!I->use_empty())
 226       I->replaceAllUsesWith(UndefValue::get(I->getType()));
 227   }
 228
 229   // Get the list of successors of this block.
 230   std::vector<BasicBlock*> Succs(succ_begin(BB), succ_end(BB));
 231
 232   for (unsigned i = 0, e = Succs.size(); i != e; ++i)
 233     Succs[i]->removePredecessor(BB);
 234
 235   BB->eraseFromParent();
 236 }