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