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