lib/Transforms/Scalar/SimplifyCFG.cpp

   1 //===- SimplifyCFG.cpp - CFG Simplification Pass --------------------------===//
   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 dead code elimination and basic block merging, along
  11 // with a collection of other peephole control flow optimizations.  For example:
  12 //
  13 //   * Removes basic blocks with no predecessors.
  14 //   * Merges a basic block into its predecessor if there is only one and the
  15 //     predecessor only has one successor.
  16 //   * Eliminates PHI nodes for basic blocks with a single predecessor.
  17 //   * Eliminates a basic block that only contains an unconditional branch.
  18 //   * Changes invoke instructions to nounwind functions to be calls.
  19 //   * Change things like "if (x) if (y)" into "if (x&y)".
  20 //   * etc..
  21 //
  22 //===----------------------------------------------------------------------===//
  23
  24 #define DEBUG_TYPE "simplifycfg"
  25 #include "llvm/Transforms/Scalar.h"
  26 #include "llvm/Transforms/Utils/Local.h"
  27 #include "llvm/Constants.h"
  28 #include "llvm/Instructions.h"
  29 #include "llvm/Module.h"
  30 #include "llvm/ParameterAttributes.h"
  31 #include "llvm/Support/CFG.h"
  32 #include "llvm/Support/Compiler.h"
  33 #include "llvm/Pass.h"
  34 #include "llvm/ADT/SmallVector.h"
  35 #include "llvm/ADT/SmallPtrSet.h"
  36 #include "llvm/ADT/Statistic.h"
  37 using namespace llvm;
  38
  39 STATISTIC(NumSimpl, "Number of blocks simplified");
  40
  41 namespace {
  42   struct VISIBILITY_HIDDEN CFGSimplifyPass : public FunctionPass {
  43     static char ID; // Pass identification, replacement for typeid
  44     CFGSimplifyPass() : FunctionPass((intptr_t)&ID) {}
  45
  46     virtual bool runOnFunction(Function &F);
  47   };
  48   char CFGSimplifyPass::ID = 0;
  49   RegisterPass<CFGSimplifyPass> X("simplifycfg", "Simplify the CFG");
  50 }
  51
  52 // Public interface to the CFGSimplification pass
  53 FunctionPass *llvm::createCFGSimplificationPass() {
  54   return new CFGSimplifyPass();
  55 }
  56
  57 /// ChangeToUnreachable - Insert an unreachable instruction before the specified
  58 /// instruction, making it and the rest of the code in the block dead.
  59 static void ChangeToUnreachable(Instruction *I) {
  60   BasicBlock *BB = I->getParent();
  61   // Loop over all of the successors, removing BB's entry from any PHI
  62   // nodes.
  63   for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
  64     (*SI)->removePredecessor(BB);
  65
  66   new UnreachableInst(I);
  67
  68   // All instructions after this are dead.
  69   BasicBlock::iterator BBI = I, BBE = BB->end();
  70   while (BBI != BBE) {
  71     if (!BBI->use_empty())
  72       BBI->replaceAllUsesWith(UndefValue::get(BBI->getType()));
  73     BB->getInstList().erase(BBI++);
  74   }
  75 }
  76
  77 /// ChangeToCall - Convert the specified invoke into a normal call.
  78 static void ChangeToCall(InvokeInst *II) {
  79   BasicBlock *BB = II->getParent();
  80   SmallVector<Value*, 8> Args(II->op_begin()+3, II->op_end());
  81   CallInst *NewCall = new CallInst(II->getCalledValue(), Args.begin(),
  82                                    Args.end(), "", II);
  83   NewCall->takeName(II);
  84   NewCall->setCallingConv(II->getCallingConv());
  85   NewCall->setParamAttrs(II->getParamAttrs());
  86   II->replaceAllUsesWith(NewCall);
  87
  88   // Follow the call by a branch to the normal destination.
  89   new BranchInst(II->getNormalDest(), II);
  90
  91   // Update PHI nodes in the unwind destination
  92   II->getUnwindDest()->removePredecessor(BB);
  93   BB->getInstList().erase(II);
  94 }
  95
  96 static bool MarkAliveBlocks(BasicBlock *BB,
  97                             SmallPtrSet<BasicBlock*, 128> &Reachable) {
  98
  99   SmallVector<BasicBlock*, 128> Worklist;
 100   Worklist.push_back(BB);
 101   bool Changed = false;
 102   while (!Worklist.empty()) {
 103     BB = Worklist.back();
 104     Worklist.pop_back();
 105
 106     if (!Reachable.insert(BB))
 107       continue;
 108
 109     // Do a quick scan of the basic block, turning any obviously unreachable
 110     // instructions into LLVM unreachable insts.  The instruction combining pass
 111     // canonicalizes unreachable insts into stores to null or undef.
 112     for (BasicBlock::iterator BBI = BB->begin(), E = BB->end(); BBI != E;++BBI){
 113       if (CallInst *CI = dyn_cast<CallInst>(BBI)) {
 114         if (CI->doesNotReturn()) {
 115           // If we found a call to a no-return function, insert an unreachable
 116           // instruction after it.  Make sure there isn't *already* one there
 117           // though.
 118           ++BBI;
 119           if (!isa<UnreachableInst>(BBI)) {
 120             ChangeToUnreachable(BBI);
 121             Changed = true;
 122           }
 123           break;
 124         }
 125       }
 126
 127       if (StoreInst *SI = dyn_cast<StoreInst>(BBI))
 128         if (isa<ConstantPointerNull>(SI->getOperand(1)) ||
 129             isa<UndefValue>(SI->getOperand(1))) {
 130           ChangeToUnreachable(SI);
 131           Changed = true;
 132           break;
 133         }
 134     }
 135
 136     // Turn invokes that call 'nounwind' functions into ordinary calls.
 137     if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator()))
 138       if (II->doesNotThrow()) {
 139         ChangeToCall(II);
 140         Changed = true;
 141       }
 142
 143     Changed |= ConstantFoldTerminator(BB);
 144     for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
 145       Worklist.push_back(*SI);
 146   }
 147   return Changed;
 148 }
 149
 150 /// RemoveUnreachableBlocks - Remove blocks that are not reachable, even if they
 151 /// are in a dead cycle.  Return true if a change was made, false otherwise.
 152 static bool RemoveUnreachableBlocks(Function &F) {
 153   SmallPtrSet<BasicBlock*, 128> Reachable;
 154   bool Changed = MarkAliveBlocks(F.begin(), Reachable);
 155
 156   // If there are unreachable blocks in the CFG...
 157   if (Reachable.size() == F.size())
 158     return Changed;
 159
 160   assert(Reachable.size() < F.size());
 161   NumSimpl += F.size()-Reachable.size();
 162
 163   // Loop over all of the basic blocks that are not reachable, dropping all of
 164   // their internal references...
 165   for (Function::iterator BB = ++F.begin(), E = F.end(); BB != E; ++BB) {
 166     if (Reachable.count(BB))
 167       continue;
 168
 169     for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
 170       if (Reachable.count(*SI))
 171         (*SI)->removePredecessor(BB);
 172     BB->dropAllReferences();
 173   }
 174
 175   for (Function::iterator I = ++F.begin(); I != F.end();)
 176     if (!Reachable.count(I))
 177       I = F.getBasicBlockList().erase(I);
 178     else
 179       ++I;
 180
 181   return true;
 182 }
 183
 184 /// IterativeSimplifyCFG - Call SimplifyCFG on all the blocks in the function,
 185 /// iterating until no more changes are made.
 186 static bool IterativeSimplifyCFG(Function &F) {
 187   bool Changed = false;
 188   bool LocalChange = true;
 189   while (LocalChange) {
 190     LocalChange = false;
 191
 192     // Loop over all of the basic blocks (except the first one) and remove them
 193     // if they are unneeded...
 194     //
 195     for (Function::iterator BBIt = ++F.begin(); BBIt != F.end(); ) {
 196       if (SimplifyCFG(BBIt++)) {
 197         LocalChange = true;
 198         ++NumSimpl;
 199       }
 200     }
 201     Changed |= LocalChange;
 202   }
 203   return Changed;
 204 }
 205
 206 // It is possible that we may require multiple passes over the code to fully
 207 // simplify the CFG.
 208 //
 209 bool CFGSimplifyPass::runOnFunction(Function &F) {
 210   bool EverChanged = RemoveUnreachableBlocks(F);
 211   EverChanged |= IterativeSimplifyCFG(F);
 212
 213   // If neither pass changed anything, we're done.
 214   if (!EverChanged) return false;
 215
 216   // IterativeSimplifyCFG can (rarely) make some loops dead.  If this happens,
 217   // RemoveUnreachableBlocks is needed to nuke them, which means we should
 218   // iterate between the two optimizations.  We structure the code like this to
 219   // avoid reruning IterativeSimplifyCFG if the second pass of
 220   // RemoveUnreachableBlocks doesn't do anything.
 221   if (!RemoveUnreachableBlocks(F))
 222     return true;
 223
 224   do {
 225     EverChanged = IterativeSimplifyCFG(F);
 226     EverChanged |= RemoveUnreachableBlocks(F);
 227   } while (EverChanged);
 228
 229   return true;
 230 }