1 //===- SimplifyCFGPass.cpp - CFG Simplification Pass ----------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements dead code elimination and basic block merging, along
11 // with a collection of other peephole control flow optimizations. For example:
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)".
22 //===----------------------------------------------------------------------===//
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/Attributes.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"
39 STATISTIC(NumSimpl, "Number of blocks simplified");
42 struct VISIBILITY_HIDDEN CFGSimplifyPass : public FunctionPass {
43 static char ID; // Pass identification, replacement for typeid
44 CFGSimplifyPass() : FunctionPass(&ID) {}
46 virtual bool runOnFunction(Function &F);
50 char CFGSimplifyPass::ID = 0;
51 static RegisterPass<CFGSimplifyPass> X("simplifycfg", "Simplify the CFG");
53 // Public interface to the CFGSimplification pass
54 FunctionPass *llvm::createCFGSimplificationPass() {
55 return new CFGSimplifyPass();
58 /// ChangeToUnreachable - Insert an unreachable instruction before the specified
59 /// instruction, making it and the rest of the code in the block dead.
60 static void ChangeToUnreachable(Instruction *I) {
61 BasicBlock *BB = I->getParent();
62 // Loop over all of the successors, removing BB's entry from any PHI
64 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
65 (*SI)->removePredecessor(BB);
67 new UnreachableInst(I);
69 // All instructions after this are dead.
70 BasicBlock::iterator BBI = I, BBE = BB->end();
72 if (!BBI->use_empty())
73 BBI->replaceAllUsesWith(UndefValue::get(BBI->getType()));
74 BB->getInstList().erase(BBI++);
78 /// ChangeToCall - Convert the specified invoke into a normal call.
79 static void ChangeToCall(InvokeInst *II) {
80 BasicBlock *BB = II->getParent();
81 SmallVector<Value*, 8> Args(II->op_begin()+3, II->op_end());
82 CallInst *NewCall = CallInst::Create(II->getCalledValue(), Args.begin(),
84 NewCall->takeName(II);
85 NewCall->setCallingConv(II->getCallingConv());
86 NewCall->setAttributes(II->getAttributes());
87 II->replaceAllUsesWith(NewCall);
89 // Follow the call by a branch to the normal destination.
90 BranchInst::Create(II->getNormalDest(), II);
92 // Update PHI nodes in the unwind destination
93 II->getUnwindDest()->removePredecessor(BB);
94 BB->getInstList().erase(II);
97 static bool MarkAliveBlocks(BasicBlock *BB,
98 SmallPtrSet<BasicBlock*, 128> &Reachable) {
100 SmallVector<BasicBlock*, 128> Worklist;
101 Worklist.push_back(BB);
102 bool Changed = false;
103 while (!Worklist.empty()) {
104 BB = Worklist.back();
107 if (!Reachable.insert(BB))
110 // Do a quick scan of the basic block, turning any obviously unreachable
111 // instructions into LLVM unreachable insts. The instruction combining pass
112 // canonicalizes unreachable insts into stores to null or undef.
113 for (BasicBlock::iterator BBI = BB->begin(), E = BB->end(); BBI != E;++BBI){
114 if (CallInst *CI = dyn_cast<CallInst>(BBI)) {
115 if (CI->doesNotReturn()) {
116 // If we found a call to a no-return function, insert an unreachable
117 // instruction after it. Make sure there isn't *already* one there
120 if (!isa<UnreachableInst>(BBI)) {
121 ChangeToUnreachable(BBI);
128 if (StoreInst *SI = dyn_cast<StoreInst>(BBI)) {
129 Value *Ptr = SI->getOperand(1);
131 if (isa<UndefValue>(Ptr) ||
132 (isa<ConstantPointerNull>(Ptr) &&
133 cast<PointerType>(Ptr->getType())->getAddressSpace() == 0)) {
134 ChangeToUnreachable(SI);
141 // Turn invokes that call 'nounwind' functions into ordinary calls.
142 if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator()))
143 if (II->doesNotThrow()) {
148 Changed |= ConstantFoldTerminator(BB);
149 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
150 Worklist.push_back(*SI);
155 /// RemoveUnreachableBlocksFromFn - Remove blocks that are not reachable, even
156 /// if they are in a dead cycle. Return true if a change was made, false
158 static bool RemoveUnreachableBlocksFromFn(Function &F) {
159 SmallPtrSet<BasicBlock*, 128> Reachable;
160 bool Changed = MarkAliveBlocks(F.begin(), Reachable);
162 // If there are unreachable blocks in the CFG...
163 if (Reachable.size() == F.size())
166 assert(Reachable.size() < F.size());
167 NumSimpl += F.size()-Reachable.size();
169 // Loop over all of the basic blocks that are not reachable, dropping all of
170 // their internal references...
171 for (Function::iterator BB = ++F.begin(), E = F.end(); BB != E; ++BB) {
172 if (Reachable.count(BB))
175 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
176 if (Reachable.count(*SI))
177 (*SI)->removePredecessor(BB);
178 BB->dropAllReferences();
181 for (Function::iterator I = ++F.begin(); I != F.end();)
182 if (!Reachable.count(I))
183 I = F.getBasicBlockList().erase(I);
190 /// IterativeSimplifyCFG - Call SimplifyCFG on all the blocks in the function,
191 /// iterating until no more changes are made.
192 static bool IterativeSimplifyCFG(Function &F) {
193 bool Changed = false;
194 bool LocalChange = true;
195 while (LocalChange) {
198 // Loop over all of the basic blocks (except the first one) and remove them
199 // if they are unneeded...
201 for (Function::iterator BBIt = ++F.begin(); BBIt != F.end(); ) {
202 if (SimplifyCFG(BBIt++)) {
207 Changed |= LocalChange;
212 // It is possible that we may require multiple passes over the code to fully
215 bool CFGSimplifyPass::runOnFunction(Function &F) {
216 bool EverChanged = RemoveUnreachableBlocksFromFn(F);
217 EverChanged |= IterativeSimplifyCFG(F);
219 // If neither pass changed anything, we're done.
220 if (!EverChanged) return false;
222 // IterativeSimplifyCFG can (rarely) make some loops dead. If this happens,
223 // RemoveUnreachableBlocksFromFn is needed to nuke them, which means we should
224 // iterate between the two optimizations. We structure the code like this to
225 // avoid reruning IterativeSimplifyCFG if the second pass of
226 // RemoveUnreachableBlocksFromFn doesn't do anything.
227 if (!RemoveUnreachableBlocksFromFn(F))
231 EverChanged = IterativeSimplifyCFG(F);
232 EverChanged |= RemoveUnreachableBlocksFromFn(F);
233 } while (EverChanged);