lib/Transforms/Scalar/SimplifyCFGPass.cpp

   1 //===- SimplifyCFGPass.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/IntrinsicInst.h"
  30 #include "llvm/Module.h"
  31 #include "llvm/Attributes.h"
  32 #include "llvm/Support/CFG.h"
  33 #include "llvm/Pass.h"
  34 #include "llvm/Target/TargetData.h"
  35 #include "llvm/ADT/SmallVector.h"
  36 #include "llvm/ADT/SmallPtrSet.h"
  37 #include "llvm/ADT/Statistic.h"
  38 using namespace llvm;
  39
  40 STATISTIC(NumSimpl, "Number of blocks simplified");
  41
  42 namespace {
  43   struct CFGSimplifyPass : public FunctionPass {
  44     static char ID; // Pass identification, replacement for typeid
  45     CFGSimplifyPass() : FunctionPass(&ID) {}
  46
  47     virtual bool runOnFunction(Function &F);
  48   };
  49 }
  50
  51 char CFGSimplifyPass::ID = 0;
  52 static RegisterPass<CFGSimplifyPass> X("simplifycfg", "Simplify the CFG");
  53
  54 // Public interface to the CFGSimplification pass
  55 FunctionPass *llvm::createCFGSimplificationPass() {
  56   return new CFGSimplifyPass();
  57 }
  58
  59 /// ChangeToUnreachable - Insert an unreachable instruction before the specified
  60 /// instruction, making it and the rest of the code in the block dead.
  61 static void ChangeToUnreachable(Instruction *I, bool UseLLVMTrap) {
  62   BasicBlock *BB = I->getParent();
  63   // Loop over all of the successors, removing BB's entry from any PHI
  64   // nodes.
  65   for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
  66     (*SI)->removePredecessor(BB);
  67
  68   // Insert a call to llvm.trap right before this.  This turns the undefined
  69   // behavior into a hard fail instead of falling through into random code.
  70   if (UseLLVMTrap) {
  71     Function *TrapFn =
  72       Intrinsic::getDeclaration(BB->getParent()->getParent(), Intrinsic::trap);
  73     CallInst::Create(TrapFn, "", I);
  74   }
  75   new UnreachableInst(I->getContext(), I);
  76
  77   // All instructions after this are dead.
  78   BasicBlock::iterator BBI = I, BBE = BB->end();
  79   while (BBI != BBE) {
  80     if (!BBI->use_empty())
  81       BBI->replaceAllUsesWith(UndefValue::get(BBI->getType()));
  82     BB->getInstList().erase(BBI++);
  83   }
  84 }
  85
  86 /// ChangeToCall - Convert the specified invoke into a normal call.
  87 static void ChangeToCall(InvokeInst *II) {
  88   BasicBlock *BB = II->getParent();
  89   SmallVector<Value*, 8> Args(II->op_begin(), II->op_end() - 3);
  90   CallInst *NewCall = CallInst::Create(II->getCalledValue(), Args.begin(),
  91                                        Args.end(), "", II);
  92   NewCall->takeName(II);
  93   NewCall->setCallingConv(II->getCallingConv());
  94   NewCall->setAttributes(II->getAttributes());
  95   II->replaceAllUsesWith(NewCall);
  96
  97   // Follow the call by a branch to the normal destination.
  98   BranchInst::Create(II->getNormalDest(), II);
  99
 100   // Update PHI nodes in the unwind destination
 101   II->getUnwindDest()->removePredecessor(BB);
 102   BB->getInstList().erase(II);
 103 }
 104
 105 static bool MarkAliveBlocks(BasicBlock *BB,
 106                             SmallPtrSet<BasicBlock*, 128> &Reachable) {
 107
 108   SmallVector<BasicBlock*, 128> Worklist;
 109   Worklist.push_back(BB);
 110   bool Changed = false;
 111   do {
 112     BB = Worklist.pop_back_val();
 113
 114     if (!Reachable.insert(BB))
 115       continue;
 116
 117     // Do a quick scan of the basic block, turning any obviously unreachable
 118     // instructions into LLVM unreachable insts.  The instruction combining pass
 119     // canonicalizes unreachable insts into stores to null or undef.
 120     for (BasicBlock::iterator BBI = BB->begin(), E = BB->end(); BBI != E;++BBI){
 121       if (CallInst *CI = dyn_cast<CallInst>(BBI)) {
 122         if (CI->doesNotReturn()) {
 123           // If we found a call to a no-return function, insert an unreachable
 124           // instruction after it.  Make sure there isn't *already* one there
 125           // though.
 126           ++BBI;
 127           if (!isa<UnreachableInst>(BBI)) {
 128             // Don't insert a call to llvm.trap right before the unreachable.
 129             ChangeToUnreachable(BBI, false);
 130             Changed = true;
 131           }
 132           break;
 133         }
 134       }
 135
 136       // Store to undef and store to null are undefined and used to signal that
 137       // they should be changed to unreachable by passes that can't modify the
 138       // CFG.
 139       if (StoreInst *SI = dyn_cast<StoreInst>(BBI)) {
 140         // Don't touch volatile stores.
 141         if (SI->isVolatile()) continue;
 142
 143         Value *Ptr = SI->getOperand(1);
 144
 145         if (isa<UndefValue>(Ptr) ||
 146             (isa<ConstantPointerNull>(Ptr) &&
 147              SI->getPointerAddressSpace() == 0)) {
 148           ChangeToUnreachable(SI, true);
 149           Changed = true;
 150           break;
 151         }
 152       }
 153     }
 154
 155     // Turn invokes that call 'nounwind' functions into ordinary calls.
 156     if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator()))
 157       if (II->doesNotThrow()) {
 158         ChangeToCall(II);
 159         Changed = true;
 160       }
 161
 162     Changed |= ConstantFoldTerminator(BB);
 163     for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
 164       Worklist.push_back(*SI);
 165   } while (!Worklist.empty());
 166   return Changed;
 167 }
 168
 169 /// RemoveUnreachableBlocksFromFn - Remove blocks that are not reachable, even
 170 /// if they are in a dead cycle.  Return true if a change was made, false
 171 /// otherwise.
 172 static bool RemoveUnreachableBlocksFromFn(Function &F) {
 173   SmallPtrSet<BasicBlock*, 128> Reachable;
 174   bool Changed = MarkAliveBlocks(F.begin(), Reachable);
 175
 176   // If there are unreachable blocks in the CFG...
 177   if (Reachable.size() == F.size())
 178     return Changed;
 179
 180   assert(Reachable.size() < F.size());
 181   NumSimpl += F.size()-Reachable.size();
 182
 183   // Loop over all of the basic blocks that are not reachable, dropping all of
 184   // their internal references...
 185   for (Function::iterator BB = ++F.begin(), E = F.end(); BB != E; ++BB) {
 186     if (Reachable.count(BB))
 187       continue;
 188
 189     for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
 190       if (Reachable.count(*SI))
 191         (*SI)->removePredecessor(BB);
 192     BB->dropAllReferences();
 193   }
 194
 195   for (Function::iterator I = ++F.begin(); I != F.end();)
 196     if (!Reachable.count(I))
 197       I = F.getBasicBlockList().erase(I);
 198     else
 199       ++I;
 200
 201   return true;
 202 }
 203
 204 /// MergeEmptyReturnBlocks - If we have more than one empty (other than phi
 205 /// node) return blocks, merge them together to promote recursive block merging.
 206 static bool MergeEmptyReturnBlocks(Function &F) {
 207   bool Changed = false;
 208
 209   BasicBlock *RetBlock = 0;
 210
 211   // Scan all the blocks in the function, looking for empty return blocks.
 212   for (Function::iterator BBI = F.begin(), E = F.end(); BBI != E; ) {
 213     BasicBlock &BB = *BBI++;
 214
 215     // Only look at return blocks.
 216     ReturnInst *Ret = dyn_cast<ReturnInst>(BB.getTerminator());
 217     if (Ret == 0) continue;
 218
 219     // Only look at the block if it is empty or the only other thing in it is a
 220     // single PHI node that is the operand to the return.
 221     if (Ret != &BB.front()) {
 222       // Check for something else in the block.
 223       BasicBlock::iterator I = Ret;
 224       --I;
 225       // Skip over debug info.
 226       while (isa<DbgInfoIntrinsic>(I) && I != BB.begin())
 227         --I;
 228       if (!isa<DbgInfoIntrinsic>(I) &&
 229           (!isa<PHINode>(I) || I != BB.begin() ||
 230            Ret->getNumOperands() == 0 ||
 231            Ret->getOperand(0) != I))
 232         continue;
 233     }
 234
 235     // If this is the first returning block, remember it and keep going.
 236     if (RetBlock == 0) {
 237       RetBlock = &BB;
 238       continue;
 239     }
 240
 241     // Otherwise, we found a duplicate return block.  Merge the two.
 242     Changed = true;
 243
 244     // Case when there is no input to the return or when the returned values
 245     // agree is trivial.  Note that they can't agree if there are phis in the
 246     // blocks.
 247     if (Ret->getNumOperands() == 0 ||
 248         Ret->getOperand(0) ==
 249           cast<ReturnInst>(RetBlock->getTerminator())->getOperand(0)) {
 250       BB.replaceAllUsesWith(RetBlock);
 251       BB.eraseFromParent();
 252       continue;
 253     }
 254
 255     // If the canonical return block has no PHI node, create one now.
 256     PHINode *RetBlockPHI = dyn_cast<PHINode>(RetBlock->begin());
 257     if (RetBlockPHI == 0) {
 258       Value *InVal = cast<ReturnInst>(RetBlock->getTerminator())->getOperand(0);
 259       RetBlockPHI = PHINode::Create(Ret->getOperand(0)->getType(), "merge",
 260                                     &RetBlock->front());
 261
 262       for (pred_iterator PI = pred_begin(RetBlock), E = pred_end(RetBlock);
 263            PI != E; ++PI)
 264         RetBlockPHI->addIncoming(InVal, *PI);
 265       RetBlock->getTerminator()->setOperand(0, RetBlockPHI);
 266     }
 267
 268     // Turn BB into a block that just unconditionally branches to the return
 269     // block.  This handles the case when the two return blocks have a common
 270     // predecessor but that return different things.
 271     RetBlockPHI->addIncoming(Ret->getOperand(0), &BB);
 272     BB.getTerminator()->eraseFromParent();
 273     BranchInst::Create(RetBlock, &BB);
 274   }
 275
 276   return Changed;
 277 }
 278
 279 /// IterativeSimplifyCFG - Call SimplifyCFG on all the blocks in the function,
 280 /// iterating until no more changes are made.
 281 static bool IterativeSimplifyCFG(Function &F, const TargetData *TD) {
 282   bool Changed = false;
 283   bool LocalChange = true;
 284   while (LocalChange) {
 285     LocalChange = false;
 286
 287     // Loop over all of the basic blocks (except the first one) and remove them
 288     // if they are unneeded...
 289     //
 290     for (Function::iterator BBIt = ++F.begin(); BBIt != F.end(); ) {
 291       if (SimplifyCFG(BBIt++, TD)) {
 292         LocalChange = true;
 293         ++NumSimpl;
 294       }
 295     }
 296     Changed |= LocalChange;
 297   }
 298   return Changed;
 299 }
 300
 301 // It is possible that we may require multiple passes over the code to fully
 302 // simplify the CFG.
 303 //
 304 bool CFGSimplifyPass::runOnFunction(Function &F) {
 305   const TargetData *TD = getAnalysisIfAvailable<TargetData>();
 306   bool EverChanged = RemoveUnreachableBlocksFromFn(F);
 307   EverChanged |= MergeEmptyReturnBlocks(F);
 308   EverChanged |= IterativeSimplifyCFG(F, TD);
 309
 310   // If neither pass changed anything, we're done.
 311   if (!EverChanged) return false;
 312
 313   // IterativeSimplifyCFG can (rarely) make some loops dead.  If this happens,
 314   // RemoveUnreachableBlocksFromFn is needed to nuke them, which means we should
 315   // iterate between the two optimizations.  We structure the code like this to
 316   // avoid reruning IterativeSimplifyCFG if the second pass of
 317   // RemoveUnreachableBlocksFromFn doesn't do anything.
 318   if (!RemoveUnreachableBlocksFromFn(F))
 319     return true;
 320
 321   do {
 322     EverChanged = IterativeSimplifyCFG(F, TD);
 323     EverChanged |= RemoveUnreachableBlocksFromFn(F);
 324   } while (EverChanged);
 325
 326   return true;
 327 }