1 //===- SimplifyCFG.cpp - CFG Simplification Pass --------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements dead code elimination and basic block merging.
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.
19 //===----------------------------------------------------------------------===//
21 #define DEBUG_TYPE "simplifycfg"
22 #include "llvm/Transforms/Scalar.h"
23 #include "llvm/Transforms/Utils/Local.h"
24 #include "llvm/Constants.h"
25 #include "llvm/Instructions.h"
26 #include "llvm/Module.h"
27 #include "llvm/ParameterAttributes.h"
28 #include "llvm/Support/CFG.h"
29 #include "llvm/Support/Compiler.h"
30 #include "llvm/Pass.h"
31 #include "llvm/ADT/SmallVector.h"
32 #include "llvm/ADT/SmallPtrSet.h"
33 #include "llvm/ADT/Statistic.h"
36 STATISTIC(NumSimpl, "Number of blocks simplified");
39 struct VISIBILITY_HIDDEN CFGSimplifyPass : public FunctionPass {
40 static char ID; // Pass identification, replacement for typeid
41 CFGSimplifyPass() : FunctionPass((intptr_t)&ID) {}
43 virtual bool runOnFunction(Function &F);
45 char CFGSimplifyPass::ID = 0;
46 RegisterPass<CFGSimplifyPass> X("simplifycfg", "Simplify the CFG");
49 // Public interface to the CFGSimplification pass
50 FunctionPass *llvm::createCFGSimplificationPass() {
51 return new CFGSimplifyPass();
54 /// ChangeToUnreachable - Insert an unreachable instruction before the specified
55 /// instruction, making it and the rest of the code in the block dead.
56 static void ChangeToUnreachable(Instruction *I) {
57 BasicBlock *BB = I->getParent();
58 // Loop over all of the successors, removing BB's entry from any PHI
60 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
61 (*SI)->removePredecessor(BB);
63 new UnreachableInst(I);
65 // All instructions after this are dead.
66 BasicBlock::iterator BBI = I, BBE = BB->end();
68 if (!BBI->use_empty())
69 BBI->replaceAllUsesWith(UndefValue::get(BBI->getType()));
70 BB->getInstList().erase(BBI++);
74 /// ChangeToCall - Convert the specified invoke into a normal call.
75 static void ChangeToCall(InvokeInst *II) {
76 BasicBlock *BB = II->getParent();
77 SmallVector<Value*, 8> Args(II->op_begin()+3, II->op_end());
78 CallInst *NewCall = new CallInst(II->getCalledValue(), Args.begin(),
80 NewCall->takeName(II);
81 NewCall->setCallingConv(II->getCallingConv());
82 NewCall->setParamAttrs(II->getParamAttrs());
83 II->replaceAllUsesWith(NewCall);
85 // Follow the call by a branch to the normal destination.
86 new BranchInst(II->getNormalDest(), II);
88 // Update PHI nodes in the unwind destination
89 II->getUnwindDest()->removePredecessor(BB);
90 BB->getInstList().erase(II);
93 /// IsNoReturn - Return true if the specified call is to a no-return function.
94 static bool IsNoReturn(const CallInst *CI) {
95 if (const ParamAttrsList *Attrs = CI->getParamAttrs())
96 if (Attrs->paramHasAttr(0, ParamAttr::NoReturn))
99 if (const Function *Callee = CI->getCalledFunction())
100 if (const ParamAttrsList *Attrs = Callee->getParamAttrs())
101 if (Attrs->paramHasAttr(0, ParamAttr::NoReturn))
107 /// IsNoUnwind - Return true if the specified invoke is to a no-unwind function.
108 static bool IsNoUnwind(const InvokeInst *II) {
109 if (const ParamAttrsList *Attrs = II->getParamAttrs())
110 if (Attrs->paramHasAttr(0, ParamAttr::NoUnwind))
113 if (const Function *Callee = II->getCalledFunction())
114 if (const ParamAttrsList *Attrs = Callee->getParamAttrs())
115 if (Attrs->paramHasAttr(0, ParamAttr::NoUnwind))
122 static bool MarkAliveBlocks(BasicBlock *BB,
123 SmallPtrSet<BasicBlock*, 128> &Reachable) {
125 SmallVector<BasicBlock*, 128> Worklist;
126 Worklist.push_back(BB);
127 bool Changed = false;
128 while (!Worklist.empty()) {
129 BB = Worklist.back();
132 if (!Reachable.insert(BB))
135 // Do a quick scan of the basic block, turning any obviously unreachable
136 // instructions into LLVM unreachable insts. The instruction combining pass
137 // canonicalizes unreachable insts into stores to null or undef.
138 for (BasicBlock::iterator BBI = BB->begin(), E = BB->end(); BBI != E;++BBI){
139 if (CallInst *CI = dyn_cast<CallInst>(BBI)) {
140 if (IsNoReturn(CI)) {
141 // If we found a call to a no-return function, insert an unreachable
142 // instruction after it. Make sure there isn't *already* one there
145 if (!isa<UnreachableInst>(BBI)) {
146 ChangeToUnreachable(BBI);
153 if (StoreInst *SI = dyn_cast<StoreInst>(BBI))
154 if (isa<ConstantPointerNull>(SI->getOperand(1)) ||
155 isa<UndefValue>(SI->getOperand(1))) {
156 ChangeToUnreachable(SI);
162 // Turn invokes that call 'nounwind' functions into ordinary calls.
163 if (InvokeInst *II = dyn_cast<InvokeInst>(BB->getTerminator()))
164 if (IsNoUnwind(II)) {
169 Changed |= ConstantFoldTerminator(BB);
170 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI != SE; ++SI)
171 Worklist.push_back(*SI);
176 /// RemoveUnreachableBlocks - Remove blocks that are not reachable, even if they
177 /// are in a dead cycle. Return true if a change was made, false otherwise.
178 static bool RemoveUnreachableBlocks(Function &F) {
179 SmallPtrSet<BasicBlock*, 128> Reachable;
180 bool Changed = MarkAliveBlocks(F.begin(), Reachable);
182 // If there are unreachable blocks in the CFG...
183 if (Reachable.size() == F.size())
186 assert(Reachable.size() < F.size());
187 NumSimpl += F.size()-Reachable.size();
189 // Loop over all of the basic blocks that are not reachable, dropping all of
190 // their internal references...
191 for (Function::iterator BB = ++F.begin(), E = F.end(); BB != E; ++BB)
192 if (!Reachable.count(BB)) {
193 for (succ_iterator SI = succ_begin(BB), SE = succ_end(BB); SI!=SE; ++SI)
194 if (Reachable.count(*SI))
195 (*SI)->removePredecessor(BB);
196 BB->dropAllReferences();
199 for (Function::iterator I = ++F.begin(); I != F.end();)
200 if (!Reachable.count(I))
201 I = F.getBasicBlockList().erase(I);
208 /// IterativeSimplifyCFG - Call SimplifyCFG on all the blocks in the function,
209 /// iterating until no more changes are made.
210 static bool IterativeSimplifyCFG(Function &F) {
211 bool Changed = false;
212 bool LocalChange = true;
213 while (LocalChange) {
216 // Loop over all of the basic blocks (except the first one) and remove them
217 // if they are unneeded...
219 for (Function::iterator BBIt = ++F.begin(); BBIt != F.end(); ) {
220 if (SimplifyCFG(BBIt++)) {
225 Changed |= LocalChange;
230 // It is possible that we may require multiple passes over the code to fully
233 bool CFGSimplifyPass::runOnFunction(Function &F) {
234 bool EverChanged = RemoveUnreachableBlocks(F);
235 EverChanged |= IterativeSimplifyCFG(F);
237 // If neither pass changed anything, we're done.
238 if (!EverChanged) return false;
240 // IterativeSimplifyCFG can (rarely) make some loops dead. If this happens,
241 // RemoveUnreachableBlocks is needed to nuke them, which means we should
242 // iterate between the two optimizations. We structure the code like this to
243 // avoid reruning IterativeSimplifyCFG if the second pass of
244 // RemoveUnreachableBlocks doesn't do anything.
245 if (!RemoveUnreachableBlocks(F))
249 EverChanged = IterativeSimplifyCFG(F);
250 EverChanged |= RemoveUnreachableBlocks(F);
251 } while (EverChanged);