blob: 18f334e7c5536fbf915bf25897fbdf18da9d01ac [file] [log] [blame]
Chris Lattner01d1ee32002-05-21 20:50:24 +00001//===- SimplifyCFG.cpp - Code to perform CFG simplification ---------------===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanfd939082005-04-21 23:48:37 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner01d1ee32002-05-21 20:50:24 +00009//
Chris Lattnerbb190ac2002-10-08 21:36:33 +000010// Peephole optimize the CFG.
Chris Lattner01d1ee32002-05-21 20:50:24 +000011//
12//===----------------------------------------------------------------------===//
13
Chris Lattner218a8222004-06-20 01:13:18 +000014#define DEBUG_TYPE "simplifycfg"
Chris Lattner01d1ee32002-05-21 20:50:24 +000015#include "llvm/Transforms/Utils/Local.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000016#include "llvm/ADT/DenseMap.h"
17#include "llvm/ADT/STLExtras.h"
18#include "llvm/ADT/SetVector.h"
19#include "llvm/ADT/SmallPtrSet.h"
20#include "llvm/ADT/SmallVector.h"
21#include "llvm/ADT/Statistic.h"
22#include "llvm/Analysis/InstructionSimplify.h"
Chandler Carruthbe049292013-01-07 03:08:10 +000023#include "llvm/Analysis/TargetTransformInfo.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000024#include "llvm/Analysis/ValueTracking.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000025#include "llvm/IR/Constants.h"
26#include "llvm/IR/DataLayout.h"
27#include "llvm/IR/DerivedTypes.h"
28#include "llvm/IR/GlobalVariable.h"
29#include "llvm/IR/IRBuilder.h"
30#include "llvm/IR/Instructions.h"
31#include "llvm/IR/IntrinsicInst.h"
32#include "llvm/IR/LLVMContext.h"
33#include "llvm/IR/MDBuilder.h"
34#include "llvm/IR/Metadata.h"
35#include "llvm/IR/Module.h"
36#include "llvm/IR/Operator.h"
37#include "llvm/IR/Type.h"
Chris Lattner302ba6f2010-12-14 06:17:25 +000038#include "llvm/Support/CFG.h"
Evan Chengc3f507f2011-01-29 04:46:23 +000039#include "llvm/Support/CommandLine.h"
Chris Lattnere27db742010-12-17 06:20:15 +000040#include "llvm/Support/ConstantRange.h"
Chris Lattner302ba6f2010-12-14 06:17:25 +000041#include "llvm/Support/Debug.h"
Devang Pateld3a17882011-05-19 20:52:46 +000042#include "llvm/Support/NoFolder.h"
Chris Lattner302ba6f2010-12-14 06:17:25 +000043#include "llvm/Support/raw_ostream.h"
Chandler Carruth06cb8ed2012-06-29 12:38:19 +000044#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Chris Lattner01d1ee32002-05-21 20:50:24 +000045#include <algorithm>
Chris Lattner698f96f2004-10-18 04:07:22 +000046#include <map>
Chandler Carruthd04a8d42012-12-03 16:50:05 +000047#include <set>
Chris Lattnerf7703df2004-01-09 06:12:26 +000048using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000049
Peter Collingbourne57808b32011-04-29 18:47:38 +000050static cl::opt<unsigned>
51PHINodeFoldingThreshold("phi-node-folding-threshold", cl::Hidden, cl::init(1),
52 cl::desc("Control the amount of phi node folding to perform (default = 1)"));
53
Evan Chengc3f507f2011-01-29 04:46:23 +000054static cl::opt<bool>
55DupRet("simplifycfg-dup-ret", cl::Hidden, cl::init(false),
56 cl::desc("Duplicate return instructions into unconditional branches"));
57
Manman Ren554da1a2012-09-20 22:37:36 +000058static cl::opt<bool>
59SinkCommon("simplifycfg-sink-common", cl::Hidden, cl::init(true),
60 cl::desc("Sink common instructions down to the end block"));
61
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +000062static cl::opt<bool>
63HoistCondStores("simplifycfg-hoist-cond-stores", cl::Hidden, cl::init(true),
64 cl::desc("Hoist conditional stores if an unconditional store preceeds"));
65
Hans Wennborgd72271c2012-09-26 09:44:49 +000066STATISTIC(NumBitMaps, "Number of switch instructions turned into bitmaps");
Hans Wennborg50b7d702012-09-26 14:01:53 +000067STATISTIC(NumLookupTables, "Number of switch instructions turned into lookup tables");
Manman Ren554da1a2012-09-20 22:37:36 +000068STATISTIC(NumSinkCommons, "Number of common instructions sunk down to the end block");
Hans Wennborg50b7d702012-09-26 14:01:53 +000069STATISTIC(NumSpeculations, "Number of speculative executed instructions");
Evan Cheng502a4f52008-06-12 21:15:59 +000070
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000071namespace {
Eric Christopherc723eb12012-07-02 23:22:21 +000072 /// ValueEqualityComparisonCase - Represents a case of a switch.
73 struct ValueEqualityComparisonCase {
74 ConstantInt *Value;
75 BasicBlock *Dest;
76
77 ValueEqualityComparisonCase(ConstantInt *Value, BasicBlock *Dest)
78 : Value(Value), Dest(Dest) {}
79
80 bool operator<(ValueEqualityComparisonCase RHS) const {
81 // Comparing pointers is ok as we only rely on the order for uniquing.
82 return Value < RHS.Value;
83 }
Benjamin Kramer8e13ded2012-10-14 11:15:42 +000084
85 bool operator==(BasicBlock *RHSDest) const { return Dest == RHSDest; }
Eric Christopherc723eb12012-07-02 23:22:21 +000086 };
87
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000088class SimplifyCFGOpt {
Chandler Carruth5f46c3c2013-01-07 03:53:25 +000089 const TargetTransformInfo &TTI;
Micah Villmow3574eca2012-10-08 16:38:25 +000090 const DataLayout *const TD;
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000091
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000092 Value *isValueEqualityComparison(TerminatorInst *TI);
93 BasicBlock *GetValueEqualityComparisonCases(TerminatorInst *TI,
Eric Christopherc723eb12012-07-02 23:22:21 +000094 std::vector<ValueEqualityComparisonCase> &Cases);
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000095 bool SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
Devang Patel007349d2011-05-18 20:35:38 +000096 BasicBlock *Pred,
97 IRBuilder<> &Builder);
Devang Patelb55d9242011-05-18 20:53:17 +000098 bool FoldValueComparisonIntoPredecessors(TerminatorInst *TI,
99 IRBuilder<> &Builder);
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000100
Devang Patel176ec402011-05-18 21:33:11 +0000101 bool SimplifyReturn(ReturnInst *RI, IRBuilder<> &Builder);
Bill Wendlingaa5abe82012-02-06 21:16:41 +0000102 bool SimplifyResume(ResumeInst *RI, IRBuilder<> &Builder);
Chris Lattner3d512132010-12-13 06:25:44 +0000103 bool SimplifyUnreachable(UnreachableInst *UI);
Devang Patel007349d2011-05-18 20:35:38 +0000104 bool SimplifySwitch(SwitchInst *SI, IRBuilder<> &Builder);
Chris Lattner3d512132010-12-13 06:25:44 +0000105 bool SimplifyIndirectBr(IndirectBrInst *IBI);
Devang Patela23812c2011-05-18 18:28:48 +0000106 bool SimplifyUncondBranch(BranchInst *BI, IRBuilder <> &Builder);
Devang Patel007349d2011-05-18 20:35:38 +0000107 bool SimplifyCondBranch(BranchInst *BI, IRBuilder <>&Builder);
Chris Lattner3d512132010-12-13 06:25:44 +0000108
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000109public:
Chandler Carruth5f46c3c2013-01-07 03:53:25 +0000110 SimplifyCFGOpt(const TargetTransformInfo &TTI, const DataLayout *TD)
111 : TTI(TTI), TD(TD) {}
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000112 bool run(BasicBlock *BB);
113};
114}
115
Chris Lattner2bdcb562005-08-03 00:19:45 +0000116/// SafeToMergeTerminators - Return true if it is safe to merge these two
117/// terminator instructions together.
118///
119static bool SafeToMergeTerminators(TerminatorInst *SI1, TerminatorInst *SI2) {
120 if (SI1 == SI2) return false; // Can't merge with self!
Andrew Trick6b014382012-08-29 21:46:36 +0000121
Chris Lattner2bdcb562005-08-03 00:19:45 +0000122 // It is not safe to merge these two switch instructions if they have a common
123 // successor, and if that successor has a PHI node, and if *that* PHI node has
124 // conflicting incoming values from the two switch blocks.
125 BasicBlock *SI1BB = SI1->getParent();
126 BasicBlock *SI2BB = SI2->getParent();
Chris Lattnerc9951232007-04-02 01:44:59 +0000127 SmallPtrSet<BasicBlock*, 16> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
Andrew Trick6b014382012-08-29 21:46:36 +0000128
Chris Lattner2bdcb562005-08-03 00:19:45 +0000129 for (succ_iterator I = succ_begin(SI2BB), E = succ_end(SI2BB); I != E; ++I)
130 if (SI1Succs.count(*I))
131 for (BasicBlock::iterator BBI = (*I)->begin();
132 isa<PHINode>(BBI); ++BBI) {
133 PHINode *PN = cast<PHINode>(BBI);
134 if (PN->getIncomingValueForBlock(SI1BB) !=
135 PN->getIncomingValueForBlock(SI2BB))
136 return false;
137 }
Andrew Trick6b014382012-08-29 21:46:36 +0000138
Chris Lattner2bdcb562005-08-03 00:19:45 +0000139 return true;
140}
141
Manman Renee28e0f2012-06-13 05:43:29 +0000142/// isProfitableToFoldUnconditional - Return true if it is safe and profitable
143/// to merge these two terminator instructions together, where SI1 is an
144/// unconditional branch. PhiNodes will store all PHI nodes in common
145/// successors.
146///
147static bool isProfitableToFoldUnconditional(BranchInst *SI1,
148 BranchInst *SI2,
Nick Lewyckyedb58422012-06-24 10:15:42 +0000149 Instruction *Cond,
Manman Renee28e0f2012-06-13 05:43:29 +0000150 SmallVectorImpl<PHINode*> &PhiNodes) {
151 if (SI1 == SI2) return false; // Can't merge with self!
152 assert(SI1->isUnconditional() && SI2->isConditional());
153
154 // We fold the unconditional branch if we can easily update all PHI nodes in
Andrew Trick6b014382012-08-29 21:46:36 +0000155 // common successors:
Manman Renee28e0f2012-06-13 05:43:29 +0000156 // 1> We have a constant incoming value for the conditional branch;
157 // 2> We have "Cond" as the incoming value for the unconditional branch;
158 // 3> SI2->getCondition() and Cond have same operands.
159 CmpInst *Ci2 = dyn_cast<CmpInst>(SI2->getCondition());
160 if (!Ci2) return false;
161 if (!(Cond->getOperand(0) == Ci2->getOperand(0) &&
162 Cond->getOperand(1) == Ci2->getOperand(1)) &&
163 !(Cond->getOperand(0) == Ci2->getOperand(1) &&
164 Cond->getOperand(1) == Ci2->getOperand(0)))
165 return false;
166
167 BasicBlock *SI1BB = SI1->getParent();
168 BasicBlock *SI2BB = SI2->getParent();
169 SmallPtrSet<BasicBlock*, 16> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
170 for (succ_iterator I = succ_begin(SI2BB), E = succ_end(SI2BB); I != E; ++I)
171 if (SI1Succs.count(*I))
172 for (BasicBlock::iterator BBI = (*I)->begin();
173 isa<PHINode>(BBI); ++BBI) {
174 PHINode *PN = cast<PHINode>(BBI);
175 if (PN->getIncomingValueForBlock(SI1BB) != Cond ||
Nick Lewyckyedb58422012-06-24 10:15:42 +0000176 !isa<ConstantInt>(PN->getIncomingValueForBlock(SI2BB)))
Manman Renee28e0f2012-06-13 05:43:29 +0000177 return false;
178 PhiNodes.push_back(PN);
179 }
180 return true;
181}
182
Chris Lattner2bdcb562005-08-03 00:19:45 +0000183/// AddPredecessorToBlock - Update PHI nodes in Succ to indicate that there will
184/// now be entries in it from the 'NewPred' block. The values that will be
185/// flowing into the PHI nodes will be the same as those coming in from
186/// ExistPred, an existing predecessor of Succ.
187static void AddPredecessorToBlock(BasicBlock *Succ, BasicBlock *NewPred,
188 BasicBlock *ExistPred) {
Chris Lattner2bdcb562005-08-03 00:19:45 +0000189 if (!isa<PHINode>(Succ->begin())) return; // Quick exit if nothing to do
Andrew Trick6b014382012-08-29 21:46:36 +0000190
Chris Lattner093a4382008-07-13 22:23:11 +0000191 PHINode *PN;
192 for (BasicBlock::iterator I = Succ->begin();
193 (PN = dyn_cast<PHINode>(I)); ++I)
194 PN->addIncoming(PN->getIncomingValueForBlock(ExistPred), NewPred);
Chris Lattner2bdcb562005-08-03 00:19:45 +0000195}
196
Chris Lattner7e663482005-08-03 00:11:16 +0000197
Chris Lattner73c50a62010-12-14 07:00:00 +0000198/// GetIfCondition - Given a basic block (BB) with two predecessors (and at
199/// least one PHI node in it), check to see if the merge at this block is due
Chris Lattner723c66d2004-02-11 03:36:04 +0000200/// to an "if condition". If so, return the boolean condition that determines
201/// which entry into BB will be taken. Also, return by references the block
202/// that will be entered from if the condition is true, and the block that will
203/// be entered if the condition is false.
Misha Brukmanfd939082005-04-21 23:48:37 +0000204///
Chris Lattner995ba1b2010-12-14 07:15:21 +0000205/// This does no checking to see if the true/false blocks have large or unsavory
206/// instructions in them.
Chris Lattner73c50a62010-12-14 07:00:00 +0000207static Value *GetIfCondition(BasicBlock *BB, BasicBlock *&IfTrue,
208 BasicBlock *&IfFalse) {
209 PHINode *SomePHI = cast<PHINode>(BB->begin());
210 assert(SomePHI->getNumIncomingValues() == 2 &&
Chris Lattner723c66d2004-02-11 03:36:04 +0000211 "Function can only handle blocks with 2 predecessors!");
Chris Lattner73c50a62010-12-14 07:00:00 +0000212 BasicBlock *Pred1 = SomePHI->getIncomingBlock(0);
213 BasicBlock *Pred2 = SomePHI->getIncomingBlock(1);
Chris Lattner723c66d2004-02-11 03:36:04 +0000214
215 // We can only handle branches. Other control flow will be lowered to
216 // branches if possible anyway.
Chris Lattner995ba1b2010-12-14 07:15:21 +0000217 BranchInst *Pred1Br = dyn_cast<BranchInst>(Pred1->getTerminator());
218 BranchInst *Pred2Br = dyn_cast<BranchInst>(Pred2->getTerminator());
219 if (Pred1Br == 0 || Pred2Br == 0)
Chris Lattner723c66d2004-02-11 03:36:04 +0000220 return 0;
Chris Lattner723c66d2004-02-11 03:36:04 +0000221
222 // Eliminate code duplication by ensuring that Pred1Br is conditional if
223 // either are.
224 if (Pred2Br->isConditional()) {
225 // If both branches are conditional, we don't have an "if statement". In
226 // reality, we could transform this case, but since the condition will be
227 // required anyway, we stand no chance of eliminating it, so the xform is
228 // probably not profitable.
229 if (Pred1Br->isConditional())
230 return 0;
231
232 std::swap(Pred1, Pred2);
233 std::swap(Pred1Br, Pred2Br);
234 }
235
236 if (Pred1Br->isConditional()) {
Chris Lattner995ba1b2010-12-14 07:15:21 +0000237 // The only thing we have to watch out for here is to make sure that Pred2
238 // doesn't have incoming edges from other blocks. If it does, the condition
239 // doesn't dominate BB.
240 if (Pred2->getSinglePredecessor() == 0)
241 return 0;
Andrew Trick6b014382012-08-29 21:46:36 +0000242
Chris Lattner723c66d2004-02-11 03:36:04 +0000243 // If we found a conditional branch predecessor, make sure that it branches
244 // to BB and Pred2Br. If it doesn't, this isn't an "if statement".
245 if (Pred1Br->getSuccessor(0) == BB &&
246 Pred1Br->getSuccessor(1) == Pred2) {
247 IfTrue = Pred1;
248 IfFalse = Pred2;
249 } else if (Pred1Br->getSuccessor(0) == Pred2 &&
250 Pred1Br->getSuccessor(1) == BB) {
251 IfTrue = Pred2;
252 IfFalse = Pred1;
253 } else {
254 // We know that one arm of the conditional goes to BB, so the other must
255 // go somewhere unrelated, and this must not be an "if statement".
256 return 0;
257 }
258
Chris Lattner723c66d2004-02-11 03:36:04 +0000259 return Pred1Br->getCondition();
260 }
261
262 // Ok, if we got here, both predecessors end with an unconditional branch to
263 // BB. Don't panic! If both blocks only have a single (identical)
264 // predecessor, and THAT is a conditional branch, then we're all ok!
Chris Lattner995ba1b2010-12-14 07:15:21 +0000265 BasicBlock *CommonPred = Pred1->getSinglePredecessor();
266 if (CommonPred == 0 || CommonPred != Pred2->getSinglePredecessor())
Chris Lattner723c66d2004-02-11 03:36:04 +0000267 return 0;
268
269 // Otherwise, if this is a conditional branch, then we can use it!
Chris Lattner995ba1b2010-12-14 07:15:21 +0000270 BranchInst *BI = dyn_cast<BranchInst>(CommonPred->getTerminator());
271 if (BI == 0) return 0;
Andrew Trick6b014382012-08-29 21:46:36 +0000272
Chris Lattner995ba1b2010-12-14 07:15:21 +0000273 assert(BI->isConditional() && "Two successors but not conditional?");
274 if (BI->getSuccessor(0) == Pred1) {
275 IfTrue = Pred1;
276 IfFalse = Pred2;
277 } else {
278 IfTrue = Pred2;
279 IfFalse = Pred1;
Chris Lattner723c66d2004-02-11 03:36:04 +0000280 }
Chris Lattner995ba1b2010-12-14 07:15:21 +0000281 return BI->getCondition();
Chris Lattner723c66d2004-02-11 03:36:04 +0000282}
283
David Majnemerf7dad782013-06-01 19:43:23 +0000284/// ComputeSpeculationCost - Compute an abstract "cost" of speculating the
Dan Gohman3b205172012-01-05 23:58:56 +0000285/// given instruction, which is assumed to be safe to speculate. 1 means
286/// cheap, 2 means less cheap, and UINT_MAX means prohibitively expensive.
287static unsigned ComputeSpeculationCost(const User *I) {
288 assert(isSafeToSpeculativelyExecute(I) &&
289 "Instruction is not safe to speculatively execute!");
290 switch (Operator::getOpcode(I)) {
291 default:
292 // In doubt, be conservative.
293 return UINT_MAX;
294 case Instruction::GetElementPtr:
295 // GEPs are cheap if all indices are constant.
296 if (!cast<GEPOperator>(I)->hasAllConstantIndices())
297 return UINT_MAX;
298 return 1;
299 case Instruction::Load:
300 case Instruction::Add:
301 case Instruction::Sub:
302 case Instruction::And:
303 case Instruction::Or:
304 case Instruction::Xor:
305 case Instruction::Shl:
306 case Instruction::LShr:
307 case Instruction::AShr:
308 case Instruction::ICmp:
309 case Instruction::Trunc:
310 case Instruction::ZExt:
311 case Instruction::SExt:
312 return 1; // These are all cheap.
313
314 case Instruction::Call:
315 case Instruction::Select:
316 return 2;
317 }
318}
319
Bill Wendling5049fa62009-01-19 23:43:56 +0000320/// DominatesMergePoint - If we have a merge point of an "if condition" as
321/// accepted above, return true if the specified value dominates the block. We
322/// don't handle the true generality of domination here, just a special case
323/// which works well enough for us.
324///
325/// If AggressiveInsts is non-null, and if V does not dominate BB, we check to
Peter Collingbournef15907f2011-04-29 18:47:31 +0000326/// see if V (which must be an instruction) and its recursive operands
327/// that do not dominate BB have a combined cost lower than CostRemaining and
328/// are non-trapping. If both are true, the instruction is inserted into the
329/// set and true is returned.
330///
331/// The cost for most non-trapping instructions is defined as 1 except for
332/// Select whose cost is 2.
333///
334/// After this function returns, CostRemaining is decreased by the cost of
335/// V plus its non-dominating operands. If that cost is greater than
336/// CostRemaining, false is returned and CostRemaining is undefined.
Chris Lattner9c078662004-10-14 05:13:36 +0000337static bool DominatesMergePoint(Value *V, BasicBlock *BB,
Peter Collingbournef15907f2011-04-29 18:47:31 +0000338 SmallPtrSet<Instruction*, 4> *AggressiveInsts,
339 unsigned &CostRemaining) {
Chris Lattner570751c2004-04-09 22:50:22 +0000340 Instruction *I = dyn_cast<Instruction>(V);
Chris Lattnerb74b1812006-10-20 00:42:07 +0000341 if (!I) {
342 // Non-instructions all dominate instructions, but not all constantexprs
343 // can be executed unconditionally.
344 if (ConstantExpr *C = dyn_cast<ConstantExpr>(V))
345 if (C->canTrap())
346 return false;
347 return true;
348 }
Chris Lattner570751c2004-04-09 22:50:22 +0000349 BasicBlock *PBB = I->getParent();
Chris Lattner723c66d2004-02-11 03:36:04 +0000350
Chris Lattnerda895d62005-02-27 06:18:25 +0000351 // We don't want to allow weird loops that might have the "if condition" in
Chris Lattner570751c2004-04-09 22:50:22 +0000352 // the bottom of this block.
353 if (PBB == BB) return false;
Chris Lattner723c66d2004-02-11 03:36:04 +0000354
Chris Lattner570751c2004-04-09 22:50:22 +0000355 // If this instruction is defined in a block that contains an unconditional
356 // branch to BB, then it must be in the 'conditional' part of the "if
Chris Lattner44da7ca2010-12-14 07:41:39 +0000357 // statement". If not, it definitely dominates the region.
358 BranchInst *BI = dyn_cast<BranchInst>(PBB->getTerminator());
359 if (BI == 0 || BI->isConditional() || BI->getSuccessor(0) != BB)
360 return true;
Eli Friedman0b79a772009-07-17 04:28:42 +0000361
Chris Lattner44da7ca2010-12-14 07:41:39 +0000362 // If we aren't allowing aggressive promotion anymore, then don't consider
363 // instructions in the 'if region'.
364 if (AggressiveInsts == 0) return false;
Andrew Trick6b014382012-08-29 21:46:36 +0000365
Peter Collingbournef15907f2011-04-29 18:47:31 +0000366 // If we have seen this instruction before, don't count it again.
367 if (AggressiveInsts->count(I)) return true;
368
Chris Lattner44da7ca2010-12-14 07:41:39 +0000369 // Okay, it looks like the instruction IS in the "condition". Check to
370 // see if it's a cheap instruction to unconditionally compute, and if it
371 // only uses stuff defined outside of the condition. If so, hoist it out.
Dan Gohmanf0426602011-12-14 23:49:11 +0000372 if (!isSafeToSpeculativelyExecute(I))
Chris Lattner44da7ca2010-12-14 07:41:39 +0000373 return false;
Misha Brukmanfd939082005-04-21 23:48:37 +0000374
Dan Gohman3b205172012-01-05 23:58:56 +0000375 unsigned Cost = ComputeSpeculationCost(I);
Chris Lattner570751c2004-04-09 22:50:22 +0000376
Peter Collingbournef15907f2011-04-29 18:47:31 +0000377 if (Cost > CostRemaining)
378 return false;
379
380 CostRemaining -= Cost;
381
382 // Okay, we can only really hoist these out if their operands do
383 // not take us over the cost threshold.
Chris Lattner44da7ca2010-12-14 07:41:39 +0000384 for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i)
Peter Collingbournef15907f2011-04-29 18:47:31 +0000385 if (!DominatesMergePoint(*i, BB, AggressiveInsts, CostRemaining))
Chris Lattner44da7ca2010-12-14 07:41:39 +0000386 return false;
387 // Okay, it's safe to do this! Remember this instruction.
388 AggressiveInsts->insert(I);
Chris Lattner723c66d2004-02-11 03:36:04 +0000389 return true;
390}
Chris Lattner01d1ee32002-05-21 20:50:24 +0000391
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000392/// GetConstantInt - Extract ConstantInt from value, looking through IntToPtr
393/// and PointerNullValue. Return NULL if value is not a constant int.
Micah Villmow3574eca2012-10-08 16:38:25 +0000394static ConstantInt *GetConstantInt(Value *V, const DataLayout *TD) {
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000395 // Normal constant int.
396 ConstantInt *CI = dyn_cast<ConstantInt>(V);
Duncan Sands1df98592010-02-16 11:11:14 +0000397 if (CI || !TD || !isa<Constant>(V) || !V->getType()->isPointerTy())
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000398 return CI;
399
400 // This is some kind of pointer constant. Turn it into a pointer-sized
401 // ConstantInt if possible.
Duncan Sands7ed4f942012-10-29 17:31:46 +0000402 IntegerType *PtrTy = cast<IntegerType>(TD->getIntPtrType(V->getType()));
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000403
404 // Null pointer means 0, see SelectionDAGBuilder::getValue(const Value*).
405 if (isa<ConstantPointerNull>(V))
406 return ConstantInt::get(PtrTy, 0);
407
408 // IntToPtr const int.
409 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
410 if (CE->getOpcode() == Instruction::IntToPtr)
411 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(0))) {
412 // The constant is very likely to have the right type already.
413 if (CI->getType() == PtrTy)
414 return CI;
415 else
416 return cast<ConstantInt>
417 (ConstantExpr::getIntegerCast(CI, PtrTy, /*isSigned=*/false));
418 }
419 return 0;
420}
421
Chris Lattner0aa749b2010-12-13 04:26:26 +0000422/// GatherConstantCompares - Given a potentially 'or'd or 'and'd together
423/// collection of icmp eq/ne instructions that compare a value against a
424/// constant, return the value being compared, and stick the constant into the
425/// Values vector.
Chris Lattner28acc132010-12-13 03:30:12 +0000426static Value *
Chris Lattner0aa749b2010-12-13 04:26:26 +0000427GatherConstantCompares(Value *V, std::vector<ConstantInt*> &Vals, Value *&Extra,
Micah Villmow3574eca2012-10-08 16:38:25 +0000428 const DataLayout *TD, bool isEQ, unsigned &UsedICmps) {
Chris Lattner0aa749b2010-12-13 04:26:26 +0000429 Instruction *I = dyn_cast<Instruction>(V);
430 if (I == 0) return 0;
Andrew Trick6b014382012-08-29 21:46:36 +0000431
Chris Lattner7312a222010-12-13 04:50:38 +0000432 // If this is an icmp against a constant, handle this as one of the cases.
Chris Lattner0aa749b2010-12-13 04:26:26 +0000433 if (ICmpInst *ICI = dyn_cast<ICmpInst>(I)) {
Chris Lattnere27db742010-12-17 06:20:15 +0000434 if (ConstantInt *C = GetConstantInt(I->getOperand(1), TD)) {
435 if (ICI->getPredicate() == (isEQ ? ICmpInst::ICMP_EQ:ICmpInst::ICMP_NE)) {
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000436 UsedICmps++;
Chris Lattner0aa749b2010-12-13 04:26:26 +0000437 Vals.push_back(C);
438 return I->getOperand(0);
439 }
Andrew Trick6b014382012-08-29 21:46:36 +0000440
Chris Lattnere27db742010-12-17 06:20:15 +0000441 // If we have "x ult 3" comparison, for example, then we can add 0,1,2 to
442 // the set.
443 ConstantRange Span =
Chris Lattnera37029c2010-12-18 20:22:49 +0000444 ConstantRange::makeICmpRegion(ICI->getPredicate(), C->getValue());
Andrew Trick6b014382012-08-29 21:46:36 +0000445
Chris Lattnere27db742010-12-17 06:20:15 +0000446 // If this is an and/!= check then we want to optimize "x ugt 2" into
447 // x != 0 && x != 1.
448 if (!isEQ)
449 Span = Span.inverse();
Andrew Trick6b014382012-08-29 21:46:36 +0000450
Chris Lattnere27db742010-12-17 06:20:15 +0000451 // If there are a ton of values, we don't want to make a ginormous switch.
Nick Lewyckyf460bf82012-01-19 18:19:42 +0000452 if (Span.getSetSize().ugt(8) || Span.isEmptySet())
Chris Lattnere27db742010-12-17 06:20:15 +0000453 return 0;
Andrew Trick6b014382012-08-29 21:46:36 +0000454
Chris Lattnere27db742010-12-17 06:20:15 +0000455 for (APInt Tmp = Span.getLower(); Tmp != Span.getUpper(); ++Tmp)
456 Vals.push_back(ConstantInt::get(V->getContext(), Tmp));
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000457 UsedICmps++;
Chris Lattnere27db742010-12-17 06:20:15 +0000458 return I->getOperand(0);
459 }
Chris Lattner662269d2010-12-13 04:18:32 +0000460 return 0;
461 }
Andrew Trick6b014382012-08-29 21:46:36 +0000462
Chris Lattner7312a222010-12-13 04:50:38 +0000463 // Otherwise, we can only handle an | or &, depending on isEQ.
Chris Lattner0aa749b2010-12-13 04:26:26 +0000464 if (I->getOpcode() != (isEQ ? Instruction::Or : Instruction::And))
Chris Lattner662269d2010-12-13 04:18:32 +0000465 return 0;
Andrew Trick6b014382012-08-29 21:46:36 +0000466
Chris Lattner7312a222010-12-13 04:50:38 +0000467 unsigned NumValsBeforeLHS = Vals.size();
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000468 unsigned UsedICmpsBeforeLHS = UsedICmps;
Chris Lattner0aa749b2010-12-13 04:26:26 +0000469 if (Value *LHS = GatherConstantCompares(I->getOperand(0), Vals, Extra, TD,
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000470 isEQ, UsedICmps)) {
Chris Lattner7312a222010-12-13 04:50:38 +0000471 unsigned NumVals = Vals.size();
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000472 unsigned UsedICmpsBeforeRHS = UsedICmps;
Chris Lattner0aa749b2010-12-13 04:26:26 +0000473 if (Value *RHS = GatherConstantCompares(I->getOperand(1), Vals, Extra, TD,
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000474 isEQ, UsedICmps)) {
Chris Lattner0aa749b2010-12-13 04:26:26 +0000475 if (LHS == RHS)
476 return LHS;
Chris Lattner92407e52010-12-13 07:41:29 +0000477 Vals.resize(NumVals);
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000478 UsedICmps = UsedICmpsBeforeRHS;
Chris Lattner0aa749b2010-12-13 04:26:26 +0000479 }
Chris Lattner7312a222010-12-13 04:50:38 +0000480
481 // The RHS of the or/and can't be folded in and we haven't used "Extra" yet,
482 // set it and return success.
483 if (Extra == 0 || Extra == I->getOperand(1)) {
484 Extra = I->getOperand(1);
485 return LHS;
486 }
Andrew Trick6b014382012-08-29 21:46:36 +0000487
Chris Lattner7312a222010-12-13 04:50:38 +0000488 Vals.resize(NumValsBeforeLHS);
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000489 UsedICmps = UsedICmpsBeforeLHS;
Chris Lattner7312a222010-12-13 04:50:38 +0000490 return 0;
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000491 }
Andrew Trick6b014382012-08-29 21:46:36 +0000492
Chris Lattner7312a222010-12-13 04:50:38 +0000493 // If the LHS can't be folded in, but Extra is available and RHS can, try to
494 // use LHS as Extra.
495 if (Extra == 0 || Extra == I->getOperand(0)) {
Chris Lattner92407e52010-12-13 07:41:29 +0000496 Value *OldExtra = Extra;
Chris Lattner7312a222010-12-13 04:50:38 +0000497 Extra = I->getOperand(0);
498 if (Value *RHS = GatherConstantCompares(I->getOperand(1), Vals, Extra, TD,
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000499 isEQ, UsedICmps))
Chris Lattner7312a222010-12-13 04:50:38 +0000500 return RHS;
Chris Lattner92407e52010-12-13 07:41:29 +0000501 assert(Vals.size() == NumValsBeforeLHS);
502 Extra = OldExtra;
Chris Lattner7312a222010-12-13 04:50:38 +0000503 }
Andrew Trick6b014382012-08-29 21:46:36 +0000504
Chris Lattner0d560082004-02-24 05:38:11 +0000505 return 0;
506}
Nick Lewycky9d523102011-12-26 20:37:40 +0000507
Eli Friedman080efb82008-12-16 20:54:32 +0000508static void EraseTerminatorInstAndDCECond(TerminatorInst *TI) {
Nick Lewycky9d523102011-12-26 20:37:40 +0000509 Instruction *Cond = 0;
Eli Friedman080efb82008-12-16 20:54:32 +0000510 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
511 Cond = dyn_cast<Instruction>(SI->getCondition());
512 } else if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
513 if (BI->isConditional())
514 Cond = dyn_cast<Instruction>(BI->getCondition());
Frits van Bommel7ac40c32010-12-05 18:29:03 +0000515 } else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(TI)) {
516 Cond = dyn_cast<Instruction>(IBI->getAddress());
Eli Friedman080efb82008-12-16 20:54:32 +0000517 }
518
519 TI->eraseFromParent();
520 if (Cond) RecursivelyDeleteTriviallyDeadInstructions(Cond);
521}
522
Chris Lattner9fd49552008-11-27 23:25:44 +0000523/// isValueEqualityComparison - Return true if the specified terminator checks
524/// to see if a value is equal to constant integer value.
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000525Value *SimplifyCFGOpt::isValueEqualityComparison(TerminatorInst *TI) {
526 Value *CV = 0;
Chris Lattner4bebf082004-03-16 19:45:22 +0000527 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
528 // Do not permit merging of large switch instructions into their
529 // predecessors unless there is only one predecessor.
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000530 if (SI->getNumSuccessors()*std::distance(pred_begin(SI->getParent()),
531 pred_end(SI->getParent())) <= 128)
532 CV = SI->getCondition();
533 } else if (BranchInst *BI = dyn_cast<BranchInst>(TI))
Chris Lattner542f1492004-02-28 21:28:10 +0000534 if (BI->isConditional() && BI->getCondition()->hasOneUse())
Reid Spencere4d87aa2006-12-23 06:05:41 +0000535 if (ICmpInst *ICI = dyn_cast<ICmpInst>(BI->getCondition()))
David Majnemer404fa722013-06-03 20:39:50 +0000536 if (ICI->isEquality() && GetConstantInt(ICI->getOperand(1), TD))
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000537 CV = ICI->getOperand(0);
538
539 // Unwrap any lossless ptrtoint cast.
Chandler Carruthece6c6b2012-11-01 08:07:29 +0000540 if (TD && CV && CV->getType() == TD->getIntPtrType(CV->getContext()))
541 if (PtrToIntInst *PTII = dyn_cast<PtrToIntInst>(CV))
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000542 CV = PTII->getOperand(0);
543 return CV;
Chris Lattner542f1492004-02-28 21:28:10 +0000544}
545
Bill Wendling5049fa62009-01-19 23:43:56 +0000546/// GetValueEqualityComparisonCases - Given a value comparison instruction,
547/// decode all of the 'cases' that it represents and return the 'default' block.
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000548BasicBlock *SimplifyCFGOpt::
Misha Brukmanfd939082005-04-21 23:48:37 +0000549GetValueEqualityComparisonCases(TerminatorInst *TI,
Eric Christopherc723eb12012-07-02 23:22:21 +0000550 std::vector<ValueEqualityComparisonCase>
551 &Cases) {
Chris Lattner542f1492004-02-28 21:28:10 +0000552 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Eric Christopherc723eb12012-07-02 23:22:21 +0000553 Cases.reserve(SI->getNumCases());
554 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end(); i != e; ++i)
555 Cases.push_back(ValueEqualityComparisonCase(i.getCaseValue(),
556 i.getCaseSuccessor()));
Chris Lattner542f1492004-02-28 21:28:10 +0000557 return SI->getDefaultDest();
558 }
Eric Christopherc723eb12012-07-02 23:22:21 +0000559
Chris Lattner542f1492004-02-28 21:28:10 +0000560 BranchInst *BI = cast<BranchInst>(TI);
Reid Spencere4d87aa2006-12-23 06:05:41 +0000561 ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
Eric Christopherc723eb12012-07-02 23:22:21 +0000562 BasicBlock *Succ = BI->getSuccessor(ICI->getPredicate() == ICmpInst::ICMP_NE);
563 Cases.push_back(ValueEqualityComparisonCase(GetConstantInt(ICI->getOperand(1),
564 TD),
565 Succ));
Reid Spencere4d87aa2006-12-23 06:05:41 +0000566 return BI->getSuccessor(ICI->getPredicate() == ICmpInst::ICMP_EQ);
Chris Lattner542f1492004-02-28 21:28:10 +0000567}
568
Eric Christopherc723eb12012-07-02 23:22:21 +0000569
570/// EliminateBlockCases - Given a vector of bb/value pairs, remove any entries
571/// in the list that match the specified block.
572static void EliminateBlockCases(BasicBlock *BB,
573 std::vector<ValueEqualityComparisonCase> &Cases) {
Benjamin Kramer8e13ded2012-10-14 11:15:42 +0000574 Cases.erase(std::remove(Cases.begin(), Cases.end(), BB), Cases.end());
Eric Christopherc723eb12012-07-02 23:22:21 +0000575}
576
577/// ValuesOverlap - Return true if there are any keys in C1 that exist in C2 as
578/// well.
579static bool
580ValuesOverlap(std::vector<ValueEqualityComparisonCase> &C1,
581 std::vector<ValueEqualityComparisonCase > &C2) {
582 std::vector<ValueEqualityComparisonCase> *V1 = &C1, *V2 = &C2;
583
584 // Make V1 be smaller than V2.
585 if (V1->size() > V2->size())
586 std::swap(V1, V2);
587
588 if (V1->size() == 0) return false;
589 if (V1->size() == 1) {
590 // Just scan V2.
591 ConstantInt *TheVal = (*V1)[0].Value;
592 for (unsigned i = 0, e = V2->size(); i != e; ++i)
593 if (TheVal == (*V2)[i].Value)
594 return true;
595 }
596
597 // Otherwise, just sort both lists and compare element by element.
598 array_pod_sort(V1->begin(), V1->end());
599 array_pod_sort(V2->begin(), V2->end());
600 unsigned i1 = 0, i2 = 0, e1 = V1->size(), e2 = V2->size();
601 while (i1 != e1 && i2 != e2) {
602 if ((*V1)[i1].Value == (*V2)[i2].Value)
603 return true;
604 if ((*V1)[i1].Value < (*V2)[i2].Value)
605 ++i1;
606 else
607 ++i2;
608 }
609 return false;
610}
611
Bill Wendling5049fa62009-01-19 23:43:56 +0000612/// SimplifyEqualityComparisonWithOnlyPredecessor - If TI is known to be a
613/// terminator instruction and its block is known to only have a single
614/// predecessor block, check to see if that predecessor is also a value
615/// comparison with the same value, and if that comparison determines the
616/// outcome of this comparison. If so, simplify TI. This does a very limited
617/// form of jump threading.
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000618bool SimplifyCFGOpt::
619SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
Devang Patel007349d2011-05-18 20:35:38 +0000620 BasicBlock *Pred,
621 IRBuilder<> &Builder) {
Chris Lattner623369a2005-02-24 06:17:52 +0000622 Value *PredVal = isValueEqualityComparison(Pred->getTerminator());
623 if (!PredVal) return false; // Not a value comparison in predecessor.
624
625 Value *ThisVal = isValueEqualityComparison(TI);
626 assert(ThisVal && "This isn't a value comparison!!");
627 if (ThisVal != PredVal) return false; // Different predicates.
628
Andrew Trickb1b97832012-08-29 21:46:38 +0000629 // TODO: Preserve branch weight metadata, similarly to how
630 // FoldValueComparisonIntoPredecessors preserves it.
631
Chris Lattner623369a2005-02-24 06:17:52 +0000632 // Find out information about when control will move from Pred to TI's block.
Eric Christopherc723eb12012-07-02 23:22:21 +0000633 std::vector<ValueEqualityComparisonCase> PredCases;
Chris Lattner623369a2005-02-24 06:17:52 +0000634 BasicBlock *PredDef = GetValueEqualityComparisonCases(Pred->getTerminator(),
635 PredCases);
Eric Christopherc723eb12012-07-02 23:22:21 +0000636 EliminateBlockCases(PredDef, PredCases); // Remove default from cases.
Misha Brukmanfd939082005-04-21 23:48:37 +0000637
Chris Lattner623369a2005-02-24 06:17:52 +0000638 // Find information about how control leaves this block.
Eric Christopherc723eb12012-07-02 23:22:21 +0000639 std::vector<ValueEqualityComparisonCase> ThisCases;
Chris Lattner623369a2005-02-24 06:17:52 +0000640 BasicBlock *ThisDef = GetValueEqualityComparisonCases(TI, ThisCases);
Eric Christopherc723eb12012-07-02 23:22:21 +0000641 EliminateBlockCases(ThisDef, ThisCases); // Remove default from cases.
Chris Lattner623369a2005-02-24 06:17:52 +0000642
643 // If TI's block is the default block from Pred's comparison, potentially
644 // simplify TI based on this knowledge.
645 if (PredDef == TI->getParent()) {
646 // If we are here, we know that the value is none of those cases listed in
647 // PredCases. If there are any cases in ThisCases that are in PredCases, we
648 // can simplify TI.
Eric Christopherc723eb12012-07-02 23:22:21 +0000649 if (!ValuesOverlap(PredCases, ThisCases))
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000650 return false;
Andrew Trick6b014382012-08-29 21:46:36 +0000651
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000652 if (isa<BranchInst>(TI)) {
653 // Okay, one of the successors of this condbr is dead. Convert it to a
654 // uncond br.
655 assert(ThisCases.size() == 1 && "Branch can only have one case!");
656 // Insert the new branch.
Devang Patel007349d2011-05-18 20:35:38 +0000657 Instruction *NI = Builder.CreateBr(ThisDef);
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000658 (void) NI;
Chris Lattner623369a2005-02-24 06:17:52 +0000659
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000660 // Remove PHI node entries for the dead edge.
Eric Christopherc723eb12012-07-02 23:22:21 +0000661 ThisCases[0].Dest->removePredecessor(TI->getParent());
Chris Lattner623369a2005-02-24 06:17:52 +0000662
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000663 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
664 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
Chris Lattner623369a2005-02-24 06:17:52 +0000665
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000666 EraseTerminatorInstAndDCECond(TI);
667 return true;
Chris Lattner623369a2005-02-24 06:17:52 +0000668 }
Andrew Trick6b014382012-08-29 21:46:36 +0000669
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000670 SwitchInst *SI = cast<SwitchInst>(TI);
671 // Okay, TI has cases that are statically dead, prune them away.
Eric Christopherc723eb12012-07-02 23:22:21 +0000672 SmallPtrSet<Constant*, 16> DeadCases;
673 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
674 DeadCases.insert(PredCases[i].Value);
Chris Lattner623369a2005-02-24 06:17:52 +0000675
David Greene89d6fd32010-01-05 01:26:52 +0000676 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000677 << "Through successor TI: " << *TI);
Chris Lattner623369a2005-02-24 06:17:52 +0000678
Manman Renad289072012-09-14 21:53:06 +0000679 // Collect branch weights into a vector.
680 SmallVector<uint32_t, 8> Weights;
681 MDNode* MD = SI->getMetadata(LLVMContext::MD_prof);
682 bool HasWeight = MD && (MD->getNumOperands() == 2 + SI->getNumCases());
683 if (HasWeight)
684 for (unsigned MD_i = 1, MD_e = MD->getNumOperands(); MD_i < MD_e;
685 ++MD_i) {
686 ConstantInt* CI = dyn_cast<ConstantInt>(MD->getOperand(MD_i));
687 assert(CI);
688 Weights.push_back(CI->getValue().getZExtValue());
689 }
Eric Christopherc723eb12012-07-02 23:22:21 +0000690 for (SwitchInst::CaseIt i = SI->case_end(), e = SI->case_begin(); i != e;) {
691 --i;
692 if (DeadCases.count(i.getCaseValue())) {
Manman Renad289072012-09-14 21:53:06 +0000693 if (HasWeight) {
694 std::swap(Weights[i.getCaseIndex()+1], Weights.back());
695 Weights.pop_back();
696 }
Eric Christopherc723eb12012-07-02 23:22:21 +0000697 i.getCaseSuccessor()->removePredecessor(TI->getParent());
698 SI->removeCase(i);
699 }
700 }
Manman Rend61d1eb2012-10-11 22:28:34 +0000701 if (HasWeight && Weights.size() >= 2)
Manman Renad289072012-09-14 21:53:06 +0000702 SI->setMetadata(LLVMContext::MD_prof,
703 MDBuilder(SI->getParent()->getContext()).
704 createBranchWeights(Weights));
Eric Christopherc723eb12012-07-02 23:22:21 +0000705
706 DEBUG(dbgs() << "Leaving: " << *TI << "\n");
Chris Lattner623369a2005-02-24 06:17:52 +0000707 return true;
708 }
Andrew Trick6b014382012-08-29 21:46:36 +0000709
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000710 // Otherwise, TI's block must correspond to some matched value. Find out
711 // which value (or set of values) this is.
Eric Christopherc723eb12012-07-02 23:22:21 +0000712 ConstantInt *TIV = 0;
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000713 BasicBlock *TIBB = TI->getParent();
Eric Christopherc723eb12012-07-02 23:22:21 +0000714 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
715 if (PredCases[i].Dest == TIBB) {
716 if (TIV != 0)
717 return false; // Cannot handle multiple values coming to this block.
718 TIV = PredCases[i].Value;
719 }
720 assert(TIV && "No edge from pred to succ?");
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000721
722 // Okay, we found the one constant that our value can be if we get into TI's
723 // BB. Find out which successor will unconditionally be branched to.
Eric Christopherc723eb12012-07-02 23:22:21 +0000724 BasicBlock *TheRealDest = 0;
725 for (unsigned i = 0, e = ThisCases.size(); i != e; ++i)
726 if (ThisCases[i].Value == TIV) {
727 TheRealDest = ThisCases[i].Dest;
728 break;
729 }
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000730
731 // If not handled by any explicit cases, it is handled by the default case.
732 if (TheRealDest == 0) TheRealDest = ThisDef;
733
734 // Remove PHI node entries for dead edges.
735 BasicBlock *CheckEdge = TheRealDest;
736 for (succ_iterator SI = succ_begin(TIBB), e = succ_end(TIBB); SI != e; ++SI)
737 if (*SI != CheckEdge)
738 (*SI)->removePredecessor(TIBB);
739 else
740 CheckEdge = 0;
741
742 // Insert the new branch.
Devang Patel007349d2011-05-18 20:35:38 +0000743 Instruction *NI = Builder.CreateBr(TheRealDest);
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000744 (void) NI;
745
746 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
747 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
748
749 EraseTerminatorInstAndDCECond(TI);
750 return true;
Chris Lattner623369a2005-02-24 06:17:52 +0000751}
752
Dale Johannesenc81f5442009-03-12 21:01:11 +0000753namespace {
754 /// ConstantIntOrdering - This class implements a stable ordering of constant
755 /// integers that does not depend on their address. This is important for
756 /// applications that sort ConstantInt's to ensure uniqueness.
757 struct ConstantIntOrdering {
758 bool operator()(const ConstantInt *LHS, const ConstantInt *RHS) const {
759 return LHS->getValue().ult(RHS->getValue());
760 }
761 };
762}
Dale Johannesena9537cf2009-03-12 01:00:26 +0000763
Chris Lattner6d4d21e2010-12-13 02:00:58 +0000764static int ConstantIntSortPredicate(const void *P1, const void *P2) {
Roman Divacky59324292012-09-05 22:26:57 +0000765 const ConstantInt *LHS = *(const ConstantInt*const*)P1;
766 const ConstantInt *RHS = *(const ConstantInt*const*)P2;
Chris Lattnerba3c8152010-12-15 04:52:41 +0000767 if (LHS->getValue().ult(RHS->getValue()))
768 return 1;
769 if (LHS->getValue() == RHS->getValue())
770 return 0;
771 return -1;
Chris Lattner6d4d21e2010-12-13 02:00:58 +0000772}
773
Andrew Trickb1b97832012-08-29 21:46:38 +0000774static inline bool HasBranchWeights(const Instruction* I) {
775 MDNode* ProfMD = I->getMetadata(LLVMContext::MD_prof);
776 if (ProfMD && ProfMD->getOperand(0))
777 if (MDString* MDS = dyn_cast<MDString>(ProfMD->getOperand(0)))
778 return MDS->getString().equals("branch_weights");
779
780 return false;
781}
782
Manman Ren020aba02012-09-11 17:43:35 +0000783/// Get Weights of a given TerminatorInst, the default weight is at the front
784/// of the vector. If TI is a conditional eq, we need to swap the branch-weight
785/// metadata.
786static void GetBranchWeights(TerminatorInst *TI,
787 SmallVectorImpl<uint64_t> &Weights) {
788 MDNode* MD = TI->getMetadata(LLVMContext::MD_prof);
789 assert(MD);
790 for (unsigned i = 1, e = MD->getNumOperands(); i < e; ++i) {
791 ConstantInt* CI = dyn_cast<ConstantInt>(MD->getOperand(i));
Andrew Trickb1b97832012-08-29 21:46:38 +0000792 assert(CI);
Manman Ren020aba02012-09-11 17:43:35 +0000793 Weights.push_back(CI->getValue().getZExtValue());
Andrew Trickb1b97832012-08-29 21:46:38 +0000794 }
795
Manman Ren020aba02012-09-11 17:43:35 +0000796 // If TI is a conditional eq, the default case is the false case,
797 // and the corresponding branch-weight data is at index 2. We swap the
798 // default weight to be the first entry.
799 if (BranchInst* BI = dyn_cast<BranchInst>(TI)) {
800 assert(Weights.size() == 2);
801 ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
802 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
803 std::swap(Weights.front(), Weights.back());
Andrew Trickb1b97832012-08-29 21:46:38 +0000804 }
805}
806
807/// Sees if any of the weights are too big for a uint32_t, and halves all the
808/// weights if any are.
809static void FitWeights(MutableArrayRef<uint64_t> Weights) {
810 bool Halve = false;
811 for (unsigned i = 0; i < Weights.size(); ++i)
812 if (Weights[i] > UINT_MAX) {
813 Halve = true;
814 break;
815 }
816
817 if (! Halve)
818 return;
819
820 for (unsigned i = 0; i < Weights.size(); ++i)
821 Weights[i] /= 2;
822}
823
Bill Wendling5049fa62009-01-19 23:43:56 +0000824/// FoldValueComparisonIntoPredecessors - The specified terminator is a value
825/// equality comparison instruction (either a switch or a branch on "X == c").
826/// See if any of the predecessors of the terminator block are value comparisons
827/// on the same value. If so, and if safe to do so, fold them together.
Devang Patelb55d9242011-05-18 20:53:17 +0000828bool SimplifyCFGOpt::FoldValueComparisonIntoPredecessors(TerminatorInst *TI,
829 IRBuilder<> &Builder) {
Chris Lattner542f1492004-02-28 21:28:10 +0000830 BasicBlock *BB = TI->getParent();
831 Value *CV = isValueEqualityComparison(TI); // CondVal
832 assert(CV && "Not a comparison?");
833 bool Changed = false;
834
Chris Lattner82442432008-02-18 07:42:56 +0000835 SmallVector<BasicBlock*, 16> Preds(pred_begin(BB), pred_end(BB));
Chris Lattner542f1492004-02-28 21:28:10 +0000836 while (!Preds.empty()) {
Dan Gohmane9d87f42009-05-06 17:22:41 +0000837 BasicBlock *Pred = Preds.pop_back_val();
Misha Brukmanfd939082005-04-21 23:48:37 +0000838
Chris Lattner542f1492004-02-28 21:28:10 +0000839 // See if the predecessor is a comparison with the same value.
840 TerminatorInst *PTI = Pred->getTerminator();
841 Value *PCV = isValueEqualityComparison(PTI); // PredCondVal
842
843 if (PCV == CV && SafeToMergeTerminators(TI, PTI)) {
844 // Figure out which 'cases' to copy from SI to PSI.
Eric Christopherc723eb12012-07-02 23:22:21 +0000845 std::vector<ValueEqualityComparisonCase> BBCases;
Chris Lattner542f1492004-02-28 21:28:10 +0000846 BasicBlock *BBDefault = GetValueEqualityComparisonCases(TI, BBCases);
847
Eric Christopherc723eb12012-07-02 23:22:21 +0000848 std::vector<ValueEqualityComparisonCase> PredCases;
Chris Lattner542f1492004-02-28 21:28:10 +0000849 BasicBlock *PredDefault = GetValueEqualityComparisonCases(PTI, PredCases);
850
851 // Based on whether the default edge from PTI goes to BB or not, fill in
852 // PredCases and PredDefault with the new switch cases we would like to
853 // build.
Chris Lattner82442432008-02-18 07:42:56 +0000854 SmallVector<BasicBlock*, 8> NewSuccessors;
Chris Lattner542f1492004-02-28 21:28:10 +0000855
Andrew Trickb1b97832012-08-29 21:46:38 +0000856 // Update the branch weight metadata along the way
857 SmallVector<uint64_t, 8> Weights;
Andrew Trickb1b97832012-08-29 21:46:38 +0000858 bool PredHasWeights = HasBranchWeights(PTI);
859 bool SuccHasWeights = HasBranchWeights(TI);
860
Manman Ren796d9452012-09-14 19:05:19 +0000861 if (PredHasWeights) {
Manman Ren020aba02012-09-11 17:43:35 +0000862 GetBranchWeights(PTI, Weights);
Andrew Trickc2aa0032012-11-15 18:40:31 +0000863 // branch-weight metadata is inconsistent here.
Manman Ren796d9452012-09-14 19:05:19 +0000864 if (Weights.size() != 1 + PredCases.size())
865 PredHasWeights = SuccHasWeights = false;
866 } else if (SuccHasWeights)
Andrew Trickb1b97832012-08-29 21:46:38 +0000867 // If there are no predecessor weights but there are successor weights,
868 // populate Weights with 1, which will later be scaled to the sum of
869 // successor's weights
870 Weights.assign(1 + PredCases.size(), 1);
Andrew Trickb1b97832012-08-29 21:46:38 +0000871
Manman Ren020aba02012-09-11 17:43:35 +0000872 SmallVector<uint64_t, 8> SuccWeights;
Manman Ren796d9452012-09-14 19:05:19 +0000873 if (SuccHasWeights) {
Manman Ren020aba02012-09-11 17:43:35 +0000874 GetBranchWeights(TI, SuccWeights);
Andrew Trickc2aa0032012-11-15 18:40:31 +0000875 // branch-weight metadata is inconsistent here.
Manman Ren796d9452012-09-14 19:05:19 +0000876 if (SuccWeights.size() != 1 + BBCases.size())
877 PredHasWeights = SuccHasWeights = false;
878 } else if (PredHasWeights)
Manman Ren020aba02012-09-11 17:43:35 +0000879 SuccWeights.assign(1 + BBCases.size(), 1);
Andrew Trickb1b97832012-08-29 21:46:38 +0000880
Chris Lattner542f1492004-02-28 21:28:10 +0000881 if (PredDefault == BB) {
882 // If this is the default destination from PTI, only the edges in TI
883 // that don't occur in PTI, or that branch to BB will be activated.
Eric Christopherc723eb12012-07-02 23:22:21 +0000884 std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
885 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
886 if (PredCases[i].Dest != BB)
887 PTIHandled.insert(PredCases[i].Value);
888 else {
889 // The default destination is BB, we don't need explicit targets.
890 std::swap(PredCases[i], PredCases.back());
Andrew Trickb1b97832012-08-29 21:46:38 +0000891
Manman Ren020aba02012-09-11 17:43:35 +0000892 if (PredHasWeights || SuccHasWeights) {
893 // Increase weight for the default case.
894 Weights[0] += Weights[i+1];
Andrew Trickb1b97832012-08-29 21:46:38 +0000895 std::swap(Weights[i+1], Weights.back());
896 Weights.pop_back();
897 }
898
Eric Christopherc723eb12012-07-02 23:22:21 +0000899 PredCases.pop_back();
900 --i; --e;
901 }
Chris Lattner542f1492004-02-28 21:28:10 +0000902
Eric Christopherc723eb12012-07-02 23:22:21 +0000903 // Reconstruct the new switch statement we will be building.
Chris Lattner542f1492004-02-28 21:28:10 +0000904 if (PredDefault != BBDefault) {
905 PredDefault->removePredecessor(Pred);
906 PredDefault = BBDefault;
907 NewSuccessors.push_back(BBDefault);
908 }
Andrew Trickb1b97832012-08-29 21:46:38 +0000909
Manman Ren020aba02012-09-11 17:43:35 +0000910 unsigned CasesFromPred = Weights.size();
911 uint64_t ValidTotalSuccWeight = 0;
Eric Christopherc723eb12012-07-02 23:22:21 +0000912 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
913 if (!PTIHandled.count(BBCases[i].Value) &&
914 BBCases[i].Dest != BBDefault) {
915 PredCases.push_back(BBCases[i]);
916 NewSuccessors.push_back(BBCases[i].Dest);
Manman Ren020aba02012-09-11 17:43:35 +0000917 if (SuccHasWeights || PredHasWeights) {
918 // The default weight is at index 0, so weight for the ith case
919 // should be at index i+1. Scale the cases from successor by
920 // PredDefaultWeight (Weights[0]).
921 Weights.push_back(Weights[0] * SuccWeights[i+1]);
922 ValidTotalSuccWeight += SuccWeights[i+1];
Andrew Trickb1b97832012-08-29 21:46:38 +0000923 }
Eric Christopherc723eb12012-07-02 23:22:21 +0000924 }
Chris Lattner542f1492004-02-28 21:28:10 +0000925
Manman Ren020aba02012-09-11 17:43:35 +0000926 if (SuccHasWeights || PredHasWeights) {
927 ValidTotalSuccWeight += SuccWeights[0];
928 // Scale the cases from predecessor by ValidTotalSuccWeight.
929 for (unsigned i = 1; i < CasesFromPred; ++i)
930 Weights[i] *= ValidTotalSuccWeight;
931 // Scale the default weight by SuccDefaultWeight (SuccWeights[0]).
932 Weights[0] *= SuccWeights[0];
933 }
Chris Lattner542f1492004-02-28 21:28:10 +0000934 } else {
935 // If this is not the default destination from PSI, only the edges
936 // in SI that occur in PSI with a destination of BB will be
937 // activated.
Eric Christopherc723eb12012-07-02 23:22:21 +0000938 std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
Manman Rena8a2b992012-09-14 17:29:56 +0000939 std::map<ConstantInt*, uint64_t> WeightsForHandled;
Eric Christopherc723eb12012-07-02 23:22:21 +0000940 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
941 if (PredCases[i].Dest == BB) {
942 PTIHandled.insert(PredCases[i].Value);
Manman Rena8a2b992012-09-14 17:29:56 +0000943
944 if (PredHasWeights || SuccHasWeights) {
945 WeightsForHandled[PredCases[i].Value] = Weights[i+1];
946 std::swap(Weights[i+1], Weights.back());
947 Weights.pop_back();
948 }
949
Eric Christopherc723eb12012-07-02 23:22:21 +0000950 std::swap(PredCases[i], PredCases.back());
951 PredCases.pop_back();
952 --i; --e;
953 }
Chris Lattner542f1492004-02-28 21:28:10 +0000954
955 // Okay, now we know which constants were sent to BB from the
956 // predecessor. Figure out where they will all go now.
Eric Christopherc723eb12012-07-02 23:22:21 +0000957 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
958 if (PTIHandled.count(BBCases[i].Value)) {
959 // If this is one we are capable of getting...
Manman Rena8a2b992012-09-14 17:29:56 +0000960 if (PredHasWeights || SuccHasWeights)
961 Weights.push_back(WeightsForHandled[BBCases[i].Value]);
Eric Christopherc723eb12012-07-02 23:22:21 +0000962 PredCases.push_back(BBCases[i]);
963 NewSuccessors.push_back(BBCases[i].Dest);
964 PTIHandled.erase(BBCases[i].Value);// This constant is taken care of
965 }
966
Chris Lattner542f1492004-02-28 21:28:10 +0000967 // If there are any constants vectored to BB that TI doesn't handle,
968 // they must go to the default destination of TI.
Andrew Trick6b014382012-08-29 21:46:36 +0000969 for (std::set<ConstantInt*, ConstantIntOrdering>::iterator I =
Eric Christopherc723eb12012-07-02 23:22:21 +0000970 PTIHandled.begin(),
971 E = PTIHandled.end(); I != E; ++I) {
Andrew Trickdf523d42012-11-15 18:40:29 +0000972 if (PredHasWeights || SuccHasWeights)
973 Weights.push_back(WeightsForHandled[*I]);
Eric Christopherc723eb12012-07-02 23:22:21 +0000974 PredCases.push_back(ValueEqualityComparisonCase(*I, BBDefault));
Chris Lattner542f1492004-02-28 21:28:10 +0000975 NewSuccessors.push_back(BBDefault);
Eric Christopherc723eb12012-07-02 23:22:21 +0000976 }
Chris Lattner542f1492004-02-28 21:28:10 +0000977 }
978
979 // Okay, at this point, we know which new successor Pred will get. Make
980 // sure we update the number of entries in the PHI nodes for these
981 // successors.
982 for (unsigned i = 0, e = NewSuccessors.size(); i != e; ++i)
983 AddPredecessorToBlock(NewSuccessors[i], Pred, BB);
984
Devang Patelb55d9242011-05-18 20:53:17 +0000985 Builder.SetInsertPoint(PTI);
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000986 // Convert pointer to int before we switch.
Duncan Sands1df98592010-02-16 11:11:14 +0000987 if (CV->getType()->isPointerTy()) {
Micah Villmow3574eca2012-10-08 16:38:25 +0000988 assert(TD && "Cannot switch on pointer without DataLayout");
Chandler Carruthece6c6b2012-11-01 08:07:29 +0000989 CV = Builder.CreatePtrToInt(CV, TD->getIntPtrType(CV->getContext()),
Devang Patelb55d9242011-05-18 20:53:17 +0000990 "magicptr");
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000991 }
992
Chris Lattner542f1492004-02-28 21:28:10 +0000993 // Now that the successors are updated, create the new Switch instruction.
Devang Patelb55d9242011-05-18 20:53:17 +0000994 SwitchInst *NewSI = Builder.CreateSwitch(CV, PredDefault,
995 PredCases.size());
Devang Pateld80e8ed2011-05-17 23:29:05 +0000996 NewSI->setDebugLoc(PTI->getDebugLoc());
Eric Christopherc723eb12012-07-02 23:22:21 +0000997 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
998 NewSI->addCase(PredCases[i].Value, PredCases[i].Dest);
Chris Lattner13b2f762005-01-01 16:02:12 +0000999
Andrew Trickb1b97832012-08-29 21:46:38 +00001000 if (PredHasWeights || SuccHasWeights) {
1001 // Halve the weights if any of them cannot fit in an uint32_t
1002 FitWeights(Weights);
1003
1004 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
1005
1006 NewSI->setMetadata(LLVMContext::MD_prof,
1007 MDBuilder(BB->getContext()).
1008 createBranchWeights(MDWeights));
1009 }
1010
Eli Friedman080efb82008-12-16 20:54:32 +00001011 EraseTerminatorInstAndDCECond(PTI);
Chris Lattner13b2f762005-01-01 16:02:12 +00001012
Chris Lattner542f1492004-02-28 21:28:10 +00001013 // Okay, last check. If BB is still a successor of PSI, then we must
1014 // have an infinite loop case. If so, add an infinitely looping block
1015 // to handle the case to preserve the behavior of the code.
1016 BasicBlock *InfLoopBlock = 0;
1017 for (unsigned i = 0, e = NewSI->getNumSuccessors(); i != e; ++i)
1018 if (NewSI->getSuccessor(i) == BB) {
1019 if (InfLoopBlock == 0) {
Chris Lattner093a4382008-07-13 22:23:11 +00001020 // Insert it at the end of the function, because it's either code,
Chris Lattner542f1492004-02-28 21:28:10 +00001021 // or it won't matter if it's hot. :)
Owen Anderson1d0be152009-08-13 21:58:54 +00001022 InfLoopBlock = BasicBlock::Create(BB->getContext(),
1023 "infloop", BB->getParent());
Gabor Greif051a9502008-04-06 20:25:17 +00001024 BranchInst::Create(InfLoopBlock, InfLoopBlock);
Chris Lattner542f1492004-02-28 21:28:10 +00001025 }
1026 NewSI->setSuccessor(i, InfLoopBlock);
1027 }
Misha Brukmanfd939082005-04-21 23:48:37 +00001028
Chris Lattner542f1492004-02-28 21:28:10 +00001029 Changed = true;
1030 }
1031 }
1032 return Changed;
1033}
1034
Dale Johannesenc1f10402009-06-15 20:59:27 +00001035// isSafeToHoistInvoke - If we would need to insert a select that uses the
1036// value of this invoke (comments in HoistThenElseCodeToIf explain why we
1037// would need to do this), we can't hoist the invoke, as there is nowhere
1038// to put the select in this case.
1039static bool isSafeToHoistInvoke(BasicBlock *BB1, BasicBlock *BB2,
1040 Instruction *I1, Instruction *I2) {
1041 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
1042 PHINode *PN;
1043 for (BasicBlock::iterator BBI = SI->begin();
1044 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
1045 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1046 Value *BB2V = PN->getIncomingValueForBlock(BB2);
1047 if (BB1V != BB2V && (BB1V==I1 || BB2V==I2)) {
1048 return false;
1049 }
1050 }
1051 }
1052 return true;
1053}
1054
Chris Lattner6306d072005-08-03 17:59:45 +00001055/// HoistThenElseCodeToIf - Given a conditional branch that goes to BB1 and
Chris Lattner37dc9382004-11-30 00:29:14 +00001056/// BB2, hoist any common code in the two blocks up into the branch block. The
1057/// caller of this function guarantees that BI's block dominates BB1 and BB2.
Rafael Espindola216dde92011-05-19 02:26:30 +00001058static bool HoistThenElseCodeToIf(BranchInst *BI) {
Chris Lattner37dc9382004-11-30 00:29:14 +00001059 // This does very trivial matching, with limited scanning, to find identical
1060 // instructions in the two blocks. In particular, we don't want to get into
1061 // O(M*N) situations here where M and N are the sizes of BB1 and BB2. As
1062 // such, we currently just scan for obviously identical instructions in an
1063 // identical order.
1064 BasicBlock *BB1 = BI->getSuccessor(0); // The true destination.
1065 BasicBlock *BB2 = BI->getSuccessor(1); // The false destination
1066
Devang Patel65085cf2009-02-04 00:03:08 +00001067 BasicBlock::iterator BB1_Itr = BB1->begin();
1068 BasicBlock::iterator BB2_Itr = BB2->begin();
1069
1070 Instruction *I1 = BB1_Itr++, *I2 = BB2_Itr++;
Devang Patel949666e2011-04-07 17:27:36 +00001071 // Skip debug info if it is not identical.
1072 DbgInfoIntrinsic *DBI1 = dyn_cast<DbgInfoIntrinsic>(I1);
1073 DbgInfoIntrinsic *DBI2 = dyn_cast<DbgInfoIntrinsic>(I2);
1074 if (!DBI1 || !DBI2 || !DBI1->isIdenticalToWhenDefined(DBI2)) {
1075 while (isa<DbgInfoIntrinsic>(I1))
1076 I1 = BB1_Itr++;
1077 while (isa<DbgInfoIntrinsic>(I2))
1078 I2 = BB2_Itr++;
1079 }
Devang Patelae6c95b2011-04-07 00:30:15 +00001080 if (isa<PHINode>(I1) || !I1->isIdenticalToWhenDefined(I2) ||
Dale Johannesenc1f10402009-06-15 20:59:27 +00001081 (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2)))
Chris Lattner37dc9382004-11-30 00:29:14 +00001082 return false;
1083
1084 // If we get here, we can hoist at least one instruction.
1085 BasicBlock *BIParent = BI->getParent();
Chris Lattner37dc9382004-11-30 00:29:14 +00001086
1087 do {
1088 // If we are hoisting the terminator instruction, don't move one (making a
1089 // broken BB), instead clone it, and remove BI.
1090 if (isa<TerminatorInst>(I1))
1091 goto HoistTerminator;
Misha Brukmanfd939082005-04-21 23:48:37 +00001092
Chris Lattner37dc9382004-11-30 00:29:14 +00001093 // For a normal instruction, we just move one to right before the branch,
1094 // then replace all uses of the other with the first. Finally, we remove
1095 // the now redundant second instruction.
1096 BIParent->getInstList().splice(BI, BB1->getInstList(), I1);
1097 if (!I2->use_empty())
1098 I2->replaceAllUsesWith(I1);
Dan Gohman58cfa3b2009-08-25 22:11:20 +00001099 I1->intersectOptionalDataWith(I2);
Chris Lattner302ba6f2010-12-14 06:17:25 +00001100 I2->eraseFromParent();
Misha Brukmanfd939082005-04-21 23:48:37 +00001101
Devang Patel65085cf2009-02-04 00:03:08 +00001102 I1 = BB1_Itr++;
Devang Patel65085cf2009-02-04 00:03:08 +00001103 I2 = BB2_Itr++;
Devang Patel949666e2011-04-07 17:27:36 +00001104 // Skip debug info if it is not identical.
1105 DbgInfoIntrinsic *DBI1 = dyn_cast<DbgInfoIntrinsic>(I1);
1106 DbgInfoIntrinsic *DBI2 = dyn_cast<DbgInfoIntrinsic>(I2);
1107 if (!DBI1 || !DBI2 || !DBI1->isIdenticalToWhenDefined(DBI2)) {
1108 while (isa<DbgInfoIntrinsic>(I1))
1109 I1 = BB1_Itr++;
1110 while (isa<DbgInfoIntrinsic>(I2))
1111 I2 = BB2_Itr++;
1112 }
Devang Patelae6c95b2011-04-07 00:30:15 +00001113 } while (I1->isIdenticalToWhenDefined(I2));
Chris Lattner37dc9382004-11-30 00:29:14 +00001114
1115 return true;
1116
1117HoistTerminator:
Dale Johannesenc1f10402009-06-15 20:59:27 +00001118 // It may not be possible to hoist an invoke.
1119 if (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2))
1120 return true;
1121
Chris Lattner37dc9382004-11-30 00:29:14 +00001122 // Okay, it is safe to hoist the terminator.
Nick Lewycky67760642009-09-27 07:38:41 +00001123 Instruction *NT = I1->clone();
Chris Lattner37dc9382004-11-30 00:29:14 +00001124 BIParent->getInstList().insert(BI, NT);
Benjamin Kramerf0127052010-01-05 13:12:22 +00001125 if (!NT->getType()->isVoidTy()) {
Chris Lattner37dc9382004-11-30 00:29:14 +00001126 I1->replaceAllUsesWith(NT);
1127 I2->replaceAllUsesWith(NT);
Chris Lattner86cc4232007-02-11 01:37:51 +00001128 NT->takeName(I1);
Chris Lattner37dc9382004-11-30 00:29:14 +00001129 }
1130
Devang Pateld3a17882011-05-19 20:52:46 +00001131 IRBuilder<true, NoFolder> Builder(NT);
Chris Lattner37dc9382004-11-30 00:29:14 +00001132 // Hoisting one of the terminators from our successor is a great thing.
1133 // Unfortunately, the successors of the if/else blocks may have PHI nodes in
1134 // them. If they do, all PHI entries for BB1/BB2 must agree for all PHI
1135 // nodes, so we insert select instruction to compute the final result.
1136 std::map<std::pair<Value*,Value*>, SelectInst*> InsertedSelects;
1137 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
1138 PHINode *PN;
1139 for (BasicBlock::iterator BBI = SI->begin();
Chris Lattner0f535c62004-11-30 07:47:34 +00001140 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
Chris Lattner37dc9382004-11-30 00:29:14 +00001141 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1142 Value *BB2V = PN->getIncomingValueForBlock(BB2);
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001143 if (BB1V == BB2V) continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001144
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001145 // These values do not agree. Insert a select instruction before NT
1146 // that determines the right value.
1147 SelectInst *&SI = InsertedSelects[std::make_pair(BB1V, BB2V)];
Andrew Trick6b014382012-08-29 21:46:36 +00001148 if (SI == 0)
Devang Pateld3a17882011-05-19 20:52:46 +00001149 SI = cast<SelectInst>
1150 (Builder.CreateSelect(BI->getCondition(), BB1V, BB2V,
1151 BB1V->getName()+"."+BB2V->getName()));
1152
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001153 // Make the PHI node use the select for all incoming values for BB1/BB2
1154 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1155 if (PN->getIncomingBlock(i) == BB1 || PN->getIncomingBlock(i) == BB2)
1156 PN->setIncomingValue(i, SI);
Chris Lattner37dc9382004-11-30 00:29:14 +00001157 }
1158 }
1159
1160 // Update any PHI nodes in our new successors.
1161 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI)
1162 AddPredecessorToBlock(*SI, BIParent, BB1);
Misha Brukmanfd939082005-04-21 23:48:37 +00001163
Eli Friedman080efb82008-12-16 20:54:32 +00001164 EraseTerminatorInstAndDCECond(BI);
Chris Lattner37dc9382004-11-30 00:29:14 +00001165 return true;
1166}
1167
Manman Ren554da1a2012-09-20 22:37:36 +00001168/// SinkThenElseCodeToEnd - Given an unconditional branch that goes to BBEnd,
1169/// check whether BBEnd has only two predecessors and the other predecessor
1170/// ends with an unconditional branch. If it is true, sink any common code
1171/// in the two predecessors to BBEnd.
1172static bool SinkThenElseCodeToEnd(BranchInst *BI1) {
1173 assert(BI1->isUnconditional());
1174 BasicBlock *BB1 = BI1->getParent();
1175 BasicBlock *BBEnd = BI1->getSuccessor(0);
1176
1177 // Check that BBEnd has two predecessors and the other predecessor ends with
1178 // an unconditional branch.
Benjamin Kramerfdb96062012-09-30 21:03:56 +00001179 pred_iterator PI = pred_begin(BBEnd), PE = pred_end(BBEnd);
1180 BasicBlock *Pred0 = *PI++;
1181 if (PI == PE) // Only one predecessor.
Manman Ren554da1a2012-09-20 22:37:36 +00001182 return false;
Benjamin Kramerfdb96062012-09-30 21:03:56 +00001183 BasicBlock *Pred1 = *PI++;
1184 if (PI != PE) // More than two predecessors.
1185 return false;
1186 BasicBlock *BB2 = (Pred0 == BB1) ? Pred1 : Pred0;
Manman Ren554da1a2012-09-20 22:37:36 +00001187 BranchInst *BI2 = dyn_cast<BranchInst>(BB2->getTerminator());
1188 if (!BI2 || !BI2->isUnconditional())
1189 return false;
1190
1191 // Gather the PHI nodes in BBEnd.
1192 std::map<Value*, std::pair<Value*, PHINode*> > MapValueFromBB1ToBB2;
1193 Instruction *FirstNonPhiInBBEnd = 0;
1194 for (BasicBlock::iterator I = BBEnd->begin(), E = BBEnd->end();
1195 I != E; ++I) {
1196 if (PHINode *PN = dyn_cast<PHINode>(I)) {
1197 Value *BB1V = PN->getIncomingValueForBlock(BB1);
Andrew Trickdf523d42012-11-15 18:40:29 +00001198 Value *BB2V = PN->getIncomingValueForBlock(BB2);
Manman Ren554da1a2012-09-20 22:37:36 +00001199 MapValueFromBB1ToBB2[BB1V] = std::make_pair(BB2V, PN);
1200 } else {
1201 FirstNonPhiInBBEnd = &*I;
1202 break;
1203 }
1204 }
1205 if (!FirstNonPhiInBBEnd)
1206 return false;
Andrew Trickdf523d42012-11-15 18:40:29 +00001207
Manman Ren554da1a2012-09-20 22:37:36 +00001208
1209 // This does very trivial matching, with limited scanning, to find identical
1210 // instructions in the two blocks. We scan backward for obviously identical
1211 // instructions in an identical order.
1212 BasicBlock::InstListType::reverse_iterator RI1 = BB1->getInstList().rbegin(),
1213 RE1 = BB1->getInstList().rend(), RI2 = BB2->getInstList().rbegin(),
1214 RE2 = BB2->getInstList().rend();
1215 // Skip debug info.
1216 while (RI1 != RE1 && isa<DbgInfoIntrinsic>(&*RI1)) ++RI1;
1217 if (RI1 == RE1)
1218 return false;
1219 while (RI2 != RE2 && isa<DbgInfoIntrinsic>(&*RI2)) ++RI2;
1220 if (RI2 == RE2)
1221 return false;
1222 // Skip the unconditional branches.
1223 ++RI1;
1224 ++RI2;
1225
1226 bool Changed = false;
1227 while (RI1 != RE1 && RI2 != RE2) {
1228 // Skip debug info.
1229 while (RI1 != RE1 && isa<DbgInfoIntrinsic>(&*RI1)) ++RI1;
1230 if (RI1 == RE1)
1231 return Changed;
1232 while (RI2 != RE2 && isa<DbgInfoIntrinsic>(&*RI2)) ++RI2;
1233 if (RI2 == RE2)
1234 return Changed;
1235
1236 Instruction *I1 = &*RI1, *I2 = &*RI2;
1237 // I1 and I2 should have a single use in the same PHI node, and they
1238 // perform the same operation.
1239 // Cannot move control-flow-involving, volatile loads, vaarg, etc.
1240 if (isa<PHINode>(I1) || isa<PHINode>(I2) ||
1241 isa<TerminatorInst>(I1) || isa<TerminatorInst>(I2) ||
1242 isa<LandingPadInst>(I1) || isa<LandingPadInst>(I2) ||
1243 isa<AllocaInst>(I1) || isa<AllocaInst>(I2) ||
1244 I1->mayHaveSideEffects() || I2->mayHaveSideEffects() ||
1245 I1->mayReadOrWriteMemory() || I2->mayReadOrWriteMemory() ||
1246 !I1->hasOneUse() || !I2->hasOneUse() ||
1247 MapValueFromBB1ToBB2.find(I1) == MapValueFromBB1ToBB2.end() ||
1248 MapValueFromBB1ToBB2[I1].first != I2)
1249 return Changed;
1250
1251 // Check whether we should swap the operands of ICmpInst.
1252 ICmpInst *ICmp1 = dyn_cast<ICmpInst>(I1), *ICmp2 = dyn_cast<ICmpInst>(I2);
1253 bool SwapOpnds = false;
1254 if (ICmp1 && ICmp2 &&
1255 ICmp1->getOperand(0) != ICmp2->getOperand(0) &&
1256 ICmp1->getOperand(1) != ICmp2->getOperand(1) &&
1257 (ICmp1->getOperand(0) == ICmp2->getOperand(1) ||
1258 ICmp1->getOperand(1) == ICmp2->getOperand(0))) {
1259 ICmp2->swapOperands();
1260 SwapOpnds = true;
1261 }
1262 if (!I1->isSameOperationAs(I2)) {
1263 if (SwapOpnds)
1264 ICmp2->swapOperands();
1265 return Changed;
1266 }
1267
1268 // The operands should be either the same or they need to be generated
1269 // with a PHI node after sinking. We only handle the case where there is
1270 // a single pair of different operands.
1271 Value *DifferentOp1 = 0, *DifferentOp2 = 0;
1272 unsigned Op1Idx = 0;
1273 for (unsigned I = 0, E = I1->getNumOperands(); I != E; ++I) {
1274 if (I1->getOperand(I) == I2->getOperand(I))
1275 continue;
1276 // Early exit if we have more-than one pair of different operands or
1277 // the different operand is already in MapValueFromBB1ToBB2.
1278 // Early exit if we need a PHI node to replace a constant.
1279 if (DifferentOp1 ||
1280 MapValueFromBB1ToBB2.find(I1->getOperand(I)) !=
1281 MapValueFromBB1ToBB2.end() ||
1282 isa<Constant>(I1->getOperand(I)) ||
1283 isa<Constant>(I2->getOperand(I))) {
1284 // If we can't sink the instructions, undo the swapping.
1285 if (SwapOpnds)
1286 ICmp2->swapOperands();
1287 return Changed;
1288 }
1289 DifferentOp1 = I1->getOperand(I);
1290 Op1Idx = I;
1291 DifferentOp2 = I2->getOperand(I);
1292 }
1293
1294 // We insert the pair of different operands to MapValueFromBB1ToBB2 and
1295 // remove (I1, I2) from MapValueFromBB1ToBB2.
1296 if (DifferentOp1) {
1297 PHINode *NewPN = PHINode::Create(DifferentOp1->getType(), 2,
1298 DifferentOp1->getName() + ".sink",
1299 BBEnd->begin());
1300 MapValueFromBB1ToBB2[DifferentOp1] = std::make_pair(DifferentOp2, NewPN);
1301 // I1 should use NewPN instead of DifferentOp1.
1302 I1->setOperand(Op1Idx, NewPN);
1303 NewPN->addIncoming(DifferentOp1, BB1);
1304 NewPN->addIncoming(DifferentOp2, BB2);
1305 DEBUG(dbgs() << "Create PHI node " << *NewPN << "\n";);
1306 }
1307 PHINode *OldPN = MapValueFromBB1ToBB2[I1].second;
1308 MapValueFromBB1ToBB2.erase(I1);
1309
1310 DEBUG(dbgs() << "SINK common instructions " << *I1 << "\n";);
1311 DEBUG(dbgs() << " " << *I2 << "\n";);
1312 // We need to update RE1 and RE2 if we are going to sink the first
1313 // instruction in the basic block down.
1314 bool UpdateRE1 = (I1 == BB1->begin()), UpdateRE2 = (I2 == BB2->begin());
1315 // Sink the instruction.
1316 BBEnd->getInstList().splice(FirstNonPhiInBBEnd, BB1->getInstList(), I1);
1317 if (!OldPN->use_empty())
1318 OldPN->replaceAllUsesWith(I1);
1319 OldPN->eraseFromParent();
1320
1321 if (!I2->use_empty())
1322 I2->replaceAllUsesWith(I1);
1323 I1->intersectOptionalDataWith(I2);
1324 I2->eraseFromParent();
1325
1326 if (UpdateRE1)
1327 RE1 = BB1->getInstList().rend();
1328 if (UpdateRE2)
1329 RE2 = BB2->getInstList().rend();
1330 FirstNonPhiInBBEnd = I1;
1331 NumSinkCommons++;
1332 Changed = true;
1333 }
1334 return Changed;
1335}
1336
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001337/// \brief Determine if we can hoist sink a sole store instruction out of a
1338/// conditional block.
1339///
1340/// We are looking for code like the following:
1341/// BrBB:
1342/// store i32 %add, i32* %arrayidx2
1343/// ... // No other stores or function calls (we could be calling a memory
1344/// ... // function).
1345/// %cmp = icmp ult %x, %y
1346/// br i1 %cmp, label %EndBB, label %ThenBB
1347/// ThenBB:
1348/// store i32 %add5, i32* %arrayidx2
1349/// br label EndBB
1350/// EndBB:
1351/// ...
1352/// We are going to transform this into:
1353/// BrBB:
1354/// store i32 %add, i32* %arrayidx2
1355/// ... //
1356/// %cmp = icmp ult %x, %y
1357/// %add.add5 = select i1 %cmp, i32 %add, %add5
1358/// store i32 %add.add5, i32* %arrayidx2
1359/// ...
1360///
1361/// \return The pointer to the value of the previous store if the store can be
1362/// hoisted into the predecessor block. 0 otherwise.
Benjamin Kramer603100d2013-05-23 16:09:15 +00001363static Value *isSafeToSpeculateStore(Instruction *I, BasicBlock *BrBB,
1364 BasicBlock *StoreBB, BasicBlock *EndBB) {
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001365 StoreInst *StoreToHoist = dyn_cast<StoreInst>(I);
1366 if (!StoreToHoist)
1367 return 0;
1368
1369 // Volatile or atomic.
1370 if (!StoreToHoist->isSimple())
1371 return 0;
1372
1373 Value *StorePtr = StoreToHoist->getPointerOperand();
1374
1375 // Look for a store to the same pointer in BrBB.
1376 unsigned MaxNumInstToLookAt = 10;
1377 for (BasicBlock::reverse_iterator RI = BrBB->rbegin(),
1378 RE = BrBB->rend(); RI != RE && (--MaxNumInstToLookAt); ++RI) {
1379 Instruction *CurI = &*RI;
1380
1381 // Could be calling an instruction that effects memory like free().
1382 if (CurI->mayHaveSideEffects() && !isa<StoreInst>(CurI))
1383 return 0;
1384
1385 StoreInst *SI = dyn_cast<StoreInst>(CurI);
1386 // Found the previous store make sure it stores to the same location.
1387 if (SI && SI->getPointerOperand() == StorePtr)
1388 // Found the previous store, return its value operand.
1389 return SI->getValueOperand();
1390 else if (SI)
1391 return 0; // Unknown store.
1392 }
1393
1394 return 0;
1395}
1396
Chandler Carruthc61bc7a2013-01-24 08:05:06 +00001397/// \brief Speculate a conditional basic block flattening the CFG.
Dan Gohman3b205172012-01-05 23:58:56 +00001398///
Chandler Carruthc61bc7a2013-01-24 08:05:06 +00001399/// Note that this is a very risky transform currently. Speculating
1400/// instructions like this is most often not desirable. Instead, there is an MI
1401/// pass which can do it with full awareness of the resource constraints.
1402/// However, some cases are "obvious" and we should do directly. An example of
1403/// this is speculating a single, reasonably cheap instruction.
1404///
1405/// There is only one distinct advantage to flattening the CFG at the IR level:
1406/// it makes very common but simplistic optimizations such as are common in
1407/// instcombine and the DAG combiner more powerful by removing CFG edges and
1408/// modeling their effects with easier to reason about SSA value graphs.
1409///
1410///
1411/// An illustration of this transform is turning this IR:
1412/// \code
1413/// BB:
1414/// %cmp = icmp ult %x, %y
1415/// br i1 %cmp, label %EndBB, label %ThenBB
1416/// ThenBB:
1417/// %sub = sub %x, %y
Dan Gohman3b205172012-01-05 23:58:56 +00001418/// br label BB2
Chandler Carruthc61bc7a2013-01-24 08:05:06 +00001419/// EndBB:
1420/// %phi = phi [ %sub, %ThenBB ], [ 0, %EndBB ]
1421/// ...
1422/// \endcode
1423///
1424/// Into this IR:
1425/// \code
1426/// BB:
1427/// %cmp = icmp ult %x, %y
1428/// %sub = sub %x, %y
1429/// %cond = select i1 %cmp, 0, %sub
1430/// ...
1431/// \endcode
1432///
1433/// \returns true if the conditional block is removed.
Chandler Carruth455151e2013-01-27 06:42:03 +00001434static bool SpeculativelyExecuteBB(BranchInst *BI, BasicBlock *ThenBB) {
Chandler Carruth9e620952013-01-24 08:22:40 +00001435 // Be conservative for now. FP select instruction can often be expensive.
1436 Value *BrCond = BI->getCondition();
1437 if (isa<FCmpInst>(BrCond))
1438 return false;
1439
Chandler Carruth6cf7a912013-01-24 09:59:39 +00001440 BasicBlock *BB = BI->getParent();
1441 BasicBlock *EndBB = ThenBB->getTerminator()->getSuccessor(0);
1442
1443 // If ThenBB is actually on the false edge of the conditional branch, remember
1444 // to swap the select operands later.
1445 bool Invert = false;
1446 if (ThenBB != BI->getSuccessor(0)) {
1447 assert(ThenBB == BI->getSuccessor(1) && "No edge from 'if' block?");
1448 Invert = true;
1449 }
1450 assert(EndBB == BI->getSuccessor(!Invert) && "No edge from to end block");
1451
Chandler Carruthbaf868b2013-01-25 05:40:09 +00001452 // Keep a count of how many times instructions are used within CondBB when
1453 // they are candidates for sinking into CondBB. Specifically:
1454 // - They are defined in BB, and
1455 // - They have no side effects, and
1456 // - All of their uses are in CondBB.
1457 SmallDenseMap<Instruction *, unsigned, 4> SinkCandidateUseCounts;
1458
Chandler Carruth2c107a82013-01-24 11:52:58 +00001459 unsigned SpeculationCost = 0;
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001460 Value *SpeculatedStoreValue = 0;
1461 StoreInst *SpeculatedStore = 0;
Chandler Carruth2c107a82013-01-24 11:52:58 +00001462 for (BasicBlock::iterator BBI = ThenBB->begin(),
1463 BBE = llvm::prior(ThenBB->end());
Devang Patel06b1e672009-03-06 06:00:17 +00001464 BBI != BBE; ++BBI) {
1465 Instruction *I = BBI;
1466 // Skip debug info.
Chandler Carruth2c107a82013-01-24 11:52:58 +00001467 if (isa<DbgInfoIntrinsic>(I))
1468 continue;
Devang Patel06b1e672009-03-06 06:00:17 +00001469
Chandler Carruth2c107a82013-01-24 11:52:58 +00001470 // Only speculatively execution a single instruction (not counting the
1471 // terminator) for now.
Chandler Carruth455151e2013-01-27 06:42:03 +00001472 ++SpeculationCost;
1473 if (SpeculationCost > 1)
Devang Patel06b1e672009-03-06 06:00:17 +00001474 return false;
Dan Gohman3b205172012-01-05 23:58:56 +00001475
Dan Gohman3b205172012-01-05 23:58:56 +00001476 // Don't hoist the instruction if it's unsafe or expensive.
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001477 if (!isSafeToSpeculativelyExecute(I) &&
1478 !(HoistCondStores &&
1479 (SpeculatedStoreValue = isSafeToSpeculateStore(I, BB, ThenBB,
1480 EndBB))))
Dan Gohman3b205172012-01-05 23:58:56 +00001481 return false;
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001482 if (!SpeculatedStoreValue &&
1483 ComputeSpeculationCost(I) > PHINodeFoldingThreshold)
Dan Gohman3b205172012-01-05 23:58:56 +00001484 return false;
1485
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001486 // Store the store speculation candidate.
1487 if (SpeculatedStoreValue)
1488 SpeculatedStore = cast<StoreInst>(I);
1489
Dan Gohman3b205172012-01-05 23:58:56 +00001490 // Do not hoist the instruction if any of its operands are defined but not
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001491 // used in BB. The transformation will prevent the operand from
Dan Gohman3b205172012-01-05 23:58:56 +00001492 // being sunk into the use block.
Chandler Carruth2c107a82013-01-24 11:52:58 +00001493 for (User::op_iterator i = I->op_begin(), e = I->op_end();
Dan Gohman3b205172012-01-05 23:58:56 +00001494 i != e; ++i) {
1495 Instruction *OpI = dyn_cast<Instruction>(*i);
Chandler Carruthbaf868b2013-01-25 05:40:09 +00001496 if (!OpI || OpI->getParent() != BB ||
1497 OpI->mayHaveSideEffects())
1498 continue; // Not a candidate for sinking.
1499
1500 ++SinkCandidateUseCounts[OpI];
Dan Gohman3b205172012-01-05 23:58:56 +00001501 }
1502 }
Evan Cheng4d09efd2008-06-07 08:52:29 +00001503
Chandler Carruthbaf868b2013-01-25 05:40:09 +00001504 // Consider any sink candidates which are only used in CondBB as costs for
1505 // speculation. Note, while we iterate over a DenseMap here, we are summing
1506 // and so iteration order isn't significant.
1507 for (SmallDenseMap<Instruction *, unsigned, 4>::iterator I =
1508 SinkCandidateUseCounts.begin(), E = SinkCandidateUseCounts.end();
1509 I != E; ++I)
1510 if (I->first->getNumUses() == I->second) {
Chandler Carruth455151e2013-01-27 06:42:03 +00001511 ++SpeculationCost;
1512 if (SpeculationCost > 1)
Chandler Carruthbaf868b2013-01-25 05:40:09 +00001513 return false;
1514 }
1515
Chandler Carruth0afa3312013-01-24 10:40:51 +00001516 // Check that the PHI nodes can be converted to selects.
1517 bool HaveRewritablePHIs = false;
Chandler Carruth6cf7a912013-01-24 09:59:39 +00001518 for (BasicBlock::iterator I = EndBB->begin();
Dan Gohman3b205172012-01-05 23:58:56 +00001519 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
Chandler Carruth6cf7a912013-01-24 09:59:39 +00001520 Value *OrigV = PN->getIncomingValueForBlock(BB);
1521 Value *ThenV = PN->getIncomingValueForBlock(ThenBB);
Dan Gohman3b205172012-01-05 23:58:56 +00001522
1523 // Skip PHIs which are trivial.
Chandler Carruth6cf7a912013-01-24 09:59:39 +00001524 if (ThenV == OrigV)
Dan Gohman3b205172012-01-05 23:58:56 +00001525 continue;
1526
Chandler Carruth0afa3312013-01-24 10:40:51 +00001527 HaveRewritablePHIs = true;
Chandler Carruth0afa3312013-01-24 10:40:51 +00001528 ConstantExpr *CE = dyn_cast<ConstantExpr>(ThenV);
1529 if (!CE)
Chandler Carruth681add72013-01-24 11:53:01 +00001530 continue; // Known safe and cheap.
1531
1532 if (!isSafeToSpeculativelyExecute(CE))
1533 return false;
Chandler Carruth455151e2013-01-27 06:42:03 +00001534 if (ComputeSpeculationCost(CE) > PHINodeFoldingThreshold)
Chandler Carruth681add72013-01-24 11:53:01 +00001535 return false;
Chandler Carruth0afa3312013-01-24 10:40:51 +00001536
Chandler Carruth47d8f6d2013-01-24 12:05:17 +00001537 // Account for the cost of an unfolded ConstantExpr which could end up
1538 // getting expanded into Instructions.
1539 // FIXME: This doesn't account for how many operations are combined in the
Chandler Carruth455151e2013-01-27 06:42:03 +00001540 // constant expression.
1541 ++SpeculationCost;
1542 if (SpeculationCost > 1)
Chandler Carruth0afa3312013-01-24 10:40:51 +00001543 return false;
Evan Cheng4d09efd2008-06-07 08:52:29 +00001544 }
Dan Gohman3b205172012-01-05 23:58:56 +00001545
1546 // If there are no PHIs to process, bail early. This helps ensure idempotence
1547 // as well.
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001548 if (!HaveRewritablePHIs && !(HoistCondStores && SpeculatedStoreValue))
Dan Gohman3b205172012-01-05 23:58:56 +00001549 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001550
Dan Gohman3b205172012-01-05 23:58:56 +00001551 // If we get here, we can hoist the instruction and if-convert.
Chandler Carruth6cf7a912013-01-24 09:59:39 +00001552 DEBUG(dbgs() << "SPECULATIVELY EXECUTING BB" << *ThenBB << "\n";);
Evan Cheng4d09efd2008-06-07 08:52:29 +00001553
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001554 // Insert a select of the value of the speculated store.
1555 if (SpeculatedStoreValue) {
1556 IRBuilder<true, NoFolder> Builder(BI);
1557 Value *TrueV = SpeculatedStore->getValueOperand();
1558 Value *FalseV = SpeculatedStoreValue;
1559 if (Invert)
1560 std::swap(TrueV, FalseV);
1561 Value *S = Builder.CreateSelect(BrCond, TrueV, FalseV, TrueV->getName() +
1562 "." + FalseV->getName());
1563 SpeculatedStore->setOperand(0, S);
1564 }
1565
Chandler Carruth2c107a82013-01-24 11:52:58 +00001566 // Hoist the instructions.
1567 BB->getInstList().splice(BI, ThenBB->getInstList(), ThenBB->begin(),
1568 llvm::prior(ThenBB->end()));
Evan Cheng502a4f52008-06-12 21:15:59 +00001569
Dan Gohman3b205172012-01-05 23:58:56 +00001570 // Insert selects and rewrite the PHI operands.
Devang Pateld3a17882011-05-19 20:52:46 +00001571 IRBuilder<true, NoFolder> Builder(BI);
Chandler Carruth0afa3312013-01-24 10:40:51 +00001572 for (BasicBlock::iterator I = EndBB->begin();
1573 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
1574 unsigned OrigI = PN->getBasicBlockIndex(BB);
1575 unsigned ThenI = PN->getBasicBlockIndex(ThenBB);
1576 Value *OrigV = PN->getIncomingValue(OrigI);
1577 Value *ThenV = PN->getIncomingValue(ThenI);
1578
1579 // Skip PHIs which are trivial.
1580 if (OrigV == ThenV)
1581 continue;
Evan Cheng4d09efd2008-06-07 08:52:29 +00001582
Dan Gohman3b205172012-01-05 23:58:56 +00001583 // Create a select whose true value is the speculatively executed value and
Chandler Carruth0afa3312013-01-24 10:40:51 +00001584 // false value is the preexisting value. Swap them if the branch
1585 // destinations were inverted.
1586 Value *TrueV = ThenV, *FalseV = OrigV;
Dan Gohman3b205172012-01-05 23:58:56 +00001587 if (Invert)
Chandler Carruth0afa3312013-01-24 10:40:51 +00001588 std::swap(TrueV, FalseV);
1589 Value *V = Builder.CreateSelect(BrCond, TrueV, FalseV,
1590 TrueV->getName() + "." + FalseV->getName());
1591 PN->setIncomingValue(OrigI, V);
1592 PN->setIncomingValue(ThenI, V);
Evan Cheng4d09efd2008-06-07 08:52:29 +00001593 }
1594
Evan Cheng502a4f52008-06-12 21:15:59 +00001595 ++NumSpeculations;
Evan Cheng4d09efd2008-06-07 08:52:29 +00001596 return true;
1597}
1598
Chris Lattner2e42e362005-09-20 00:43:16 +00001599/// BlockIsSimpleEnoughToThreadThrough - Return true if we can thread a branch
1600/// across this block.
1601static bool BlockIsSimpleEnoughToThreadThrough(BasicBlock *BB) {
1602 BranchInst *BI = cast<BranchInst>(BB->getTerminator());
Chris Lattnere9487f02005-09-20 01:48:40 +00001603 unsigned Size = 0;
Andrew Trick6b014382012-08-29 21:46:36 +00001604
Devang Patel9200c892009-03-10 18:00:05 +00001605 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
Dale Johannesen8483e542009-03-12 23:18:09 +00001606 if (isa<DbgInfoIntrinsic>(BBI))
1607 continue;
Chris Lattnere9487f02005-09-20 01:48:40 +00001608 if (Size > 10) return false; // Don't clone large BB's.
Dale Johannesen8483e542009-03-12 23:18:09 +00001609 ++Size;
Andrew Trick6b014382012-08-29 21:46:36 +00001610
Dale Johannesen8483e542009-03-12 23:18:09 +00001611 // We can only support instructions that do not define values that are
Chris Lattnere9487f02005-09-20 01:48:40 +00001612 // live outside of the current basic block.
1613 for (Value::use_iterator UI = BBI->use_begin(), E = BBI->use_end();
1614 UI != E; ++UI) {
1615 Instruction *U = cast<Instruction>(*UI);
1616 if (U->getParent() != BB || isa<PHINode>(U)) return false;
1617 }
Andrew Trick6b014382012-08-29 21:46:36 +00001618
Chris Lattner2e42e362005-09-20 00:43:16 +00001619 // Looks ok, continue checking.
1620 }
Chris Lattnere9487f02005-09-20 01:48:40 +00001621
Chris Lattner2e42e362005-09-20 00:43:16 +00001622 return true;
1623}
1624
Chris Lattnereaba3a12005-09-19 23:49:37 +00001625/// FoldCondBranchOnPHI - If we have a conditional branch on a PHI node value
1626/// that is defined in the same block as the branch and if any PHI entries are
1627/// constants, thread edges corresponding to that entry to be branches to their
1628/// ultimate destination.
Micah Villmow3574eca2012-10-08 16:38:25 +00001629static bool FoldCondBranchOnPHI(BranchInst *BI, const DataLayout *TD) {
Chris Lattnereaba3a12005-09-19 23:49:37 +00001630 BasicBlock *BB = BI->getParent();
1631 PHINode *PN = dyn_cast<PHINode>(BI->getCondition());
Chris Lattner9c88d982005-09-19 23:57:04 +00001632 // NOTE: we currently cannot transform this case if the PHI node is used
1633 // outside of the block.
Chris Lattner2e42e362005-09-20 00:43:16 +00001634 if (!PN || PN->getParent() != BB || !PN->hasOneUse())
1635 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001636
Chris Lattnereaba3a12005-09-19 23:49:37 +00001637 // Degenerate case of a single entry PHI.
1638 if (PN->getNumIncomingValues() == 1) {
Chris Lattner29874e02008-12-03 19:44:02 +00001639 FoldSingleEntryPHINodes(PN->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00001640 return true;
Chris Lattnereaba3a12005-09-19 23:49:37 +00001641 }
1642
1643 // Now we know that this block has multiple preds and two succs.
Chris Lattner2e42e362005-09-20 00:43:16 +00001644 if (!BlockIsSimpleEnoughToThreadThrough(BB)) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001645
Chris Lattnereaba3a12005-09-19 23:49:37 +00001646 // Okay, this is a simple enough basic block. See if any phi values are
1647 // constants.
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00001648 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001649 ConstantInt *CB = dyn_cast<ConstantInt>(PN->getIncomingValue(i));
1650 if (CB == 0 || !CB->getType()->isIntegerTy(1)) continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001651
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001652 // Okay, we now know that all edges from PredBB should be revectored to
1653 // branch to RealDest.
1654 BasicBlock *PredBB = PN->getIncomingBlock(i);
1655 BasicBlock *RealDest = BI->getSuccessor(!CB->getZExtValue());
Andrew Trick6b014382012-08-29 21:46:36 +00001656
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001657 if (RealDest == BB) continue; // Skip self loops.
Bill Wendling6a648b82011-06-04 09:42:04 +00001658 // Skip if the predecessor's terminator is an indirect branch.
1659 if (isa<IndirectBrInst>(PredBB->getTerminator())) continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001660
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001661 // The dest block might have PHI nodes, other predecessors and other
1662 // difficult cases. Instead of being smart about this, just insert a new
1663 // block that jumps to the destination block, effectively splitting
1664 // the edge we are about to create.
1665 BasicBlock *EdgeBB = BasicBlock::Create(BB->getContext(),
1666 RealDest->getName()+".critedge",
1667 RealDest->getParent(), RealDest);
1668 BranchInst::Create(RealDest, EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00001669
Chris Lattner6de0a282010-12-14 07:09:42 +00001670 // Update PHI nodes.
1671 AddPredecessorToBlock(RealDest, EdgeBB, BB);
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001672
1673 // BB may have instructions that are being threaded over. Clone these
1674 // instructions into EdgeBB. We know that there will be no uses of the
1675 // cloned instructions outside of EdgeBB.
1676 BasicBlock::iterator InsertPt = EdgeBB->begin();
1677 DenseMap<Value*, Value*> TranslateMap; // Track translated values.
1678 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
1679 if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
1680 TranslateMap[PN] = PN->getIncomingValueForBlock(PredBB);
1681 continue;
1682 }
1683 // Clone the instruction.
1684 Instruction *N = BBI->clone();
1685 if (BBI->hasName()) N->setName(BBI->getName()+".c");
Andrew Trick6b014382012-08-29 21:46:36 +00001686
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001687 // Update operands due to translation.
1688 for (User::op_iterator i = N->op_begin(), e = N->op_end();
1689 i != e; ++i) {
1690 DenseMap<Value*, Value*>::iterator PI = TranslateMap.find(*i);
1691 if (PI != TranslateMap.end())
1692 *i = PI->second;
1693 }
Andrew Trick6b014382012-08-29 21:46:36 +00001694
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001695 // Check for trivial simplification.
Chris Lattner302ba6f2010-12-14 06:17:25 +00001696 if (Value *V = SimplifyInstruction(N, TD)) {
1697 TranslateMap[BBI] = V;
1698 delete N; // Instruction folded away, don't need actual inst
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001699 } else {
1700 // Insert the new instruction into its new home.
1701 EdgeBB->getInstList().insert(InsertPt, N);
1702 if (!BBI->use_empty())
1703 TranslateMap[BBI] = N;
1704 }
1705 }
1706
1707 // Loop over all of the edges from PredBB to BB, changing them to branch
1708 // to EdgeBB instead.
1709 TerminatorInst *PredBBTI = PredBB->getTerminator();
1710 for (unsigned i = 0, e = PredBBTI->getNumSuccessors(); i != e; ++i)
1711 if (PredBBTI->getSuccessor(i) == BB) {
1712 BB->removePredecessor(PredBB);
1713 PredBBTI->setSuccessor(i, EdgeBB);
1714 }
Bill Wendling6a648b82011-06-04 09:42:04 +00001715
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001716 // Recurse, simplifying any other constants.
Chris Lattner302ba6f2010-12-14 06:17:25 +00001717 return FoldCondBranchOnPHI(BI, TD) | true;
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00001718 }
Chris Lattnereaba3a12005-09-19 23:49:37 +00001719
1720 return false;
1721}
1722
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001723/// FoldTwoEntryPHINode - Given a BB that starts with the specified two-entry
1724/// PHI node, see if we can eliminate it.
Micah Villmow3574eca2012-10-08 16:38:25 +00001725static bool FoldTwoEntryPHINode(PHINode *PN, const DataLayout *TD) {
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001726 // Ok, this is a two entry PHI node. Check to see if this is a simple "if
1727 // statement", which has a very simple dominance structure. Basically, we
1728 // are trying to find the condition that is being branched on, which
1729 // subsequently causes this merge to happen. We really want control
1730 // dependence information for this check, but simplifycfg can't keep it up
1731 // to date, and this catches most of the cases we care about anyway.
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001732 BasicBlock *BB = PN->getParent();
1733 BasicBlock *IfTrue, *IfFalse;
1734 Value *IfCond = GetIfCondition(BB, IfTrue, IfFalse);
Chris Lattner60d410d2010-12-14 08:01:53 +00001735 if (!IfCond ||
1736 // Don't bother if the branch will be constant folded trivially.
1737 isa<ConstantInt>(IfCond))
1738 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001739
Chris Lattner822a8792006-11-18 19:19:36 +00001740 // Okay, we found that we can merge this two-entry phi node into a select.
1741 // Doing so would require us to fold *all* two entry phi nodes in this block.
1742 // At some point this becomes non-profitable (particularly if the target
1743 // doesn't support cmov's). Only do this transformation if there are two or
1744 // fewer PHI nodes in this block.
1745 unsigned NumPhis = 0;
1746 for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I); ++NumPhis, ++I)
1747 if (NumPhis > 2)
1748 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001749
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001750 // Loop over the PHI's seeing if we can promote them all to select
1751 // instructions. While we are at it, keep track of the instructions
1752 // that need to be moved to the dominating block.
Chris Lattner44da7ca2010-12-14 07:41:39 +00001753 SmallPtrSet<Instruction*, 4> AggressiveInsts;
Peter Collingbourne57808b32011-04-29 18:47:38 +00001754 unsigned MaxCostVal0 = PHINodeFoldingThreshold,
1755 MaxCostVal1 = PHINodeFoldingThreshold;
Andrew Trick6b014382012-08-29 21:46:36 +00001756
Chris Lattner3aff13b2010-12-14 08:46:09 +00001757 for (BasicBlock::iterator II = BB->begin(); isa<PHINode>(II);) {
1758 PHINode *PN = cast<PHINode>(II++);
Chris Lattner07ff3532010-12-14 07:20:29 +00001759 if (Value *V = SimplifyInstruction(PN, TD)) {
1760 PN->replaceAllUsesWith(V);
Chris Lattner3aff13b2010-12-14 08:46:09 +00001761 PN->eraseFromParent();
Chris Lattner07ff3532010-12-14 07:20:29 +00001762 continue;
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001763 }
Andrew Trick6b014382012-08-29 21:46:36 +00001764
Peter Collingbournef15907f2011-04-29 18:47:31 +00001765 if (!DominatesMergePoint(PN->getIncomingValue(0), BB, &AggressiveInsts,
1766 MaxCostVal0) ||
1767 !DominatesMergePoint(PN->getIncomingValue(1), BB, &AggressiveInsts,
1768 MaxCostVal1))
Chris Lattner07ff3532010-12-14 07:20:29 +00001769 return false;
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001770 }
Andrew Trick6b014382012-08-29 21:46:36 +00001771
Sylvestre Ledruc8e41c52012-07-23 08:51:15 +00001772 // If we folded the first phi, PN dangles at this point. Refresh it. If
Chris Lattner44da7ca2010-12-14 07:41:39 +00001773 // we ran out of PHIs then we simplified them all.
1774 PN = dyn_cast<PHINode>(BB->begin());
1775 if (PN == 0) return true;
Andrew Trick6b014382012-08-29 21:46:36 +00001776
Chris Lattner3aff13b2010-12-14 08:46:09 +00001777 // Don't fold i1 branches on PHIs which contain binary operators. These can
1778 // often be turned into switches and other things.
1779 if (PN->getType()->isIntegerTy(1) &&
1780 (isa<BinaryOperator>(PN->getIncomingValue(0)) ||
1781 isa<BinaryOperator>(PN->getIncomingValue(1)) ||
1782 isa<BinaryOperator>(IfCond)))
1783 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001784
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001785 // If we all PHI nodes are promotable, check to make sure that all
1786 // instructions in the predecessor blocks can be promoted as well. If
1787 // not, we won't be able to get rid of the control flow, so it's not
1788 // worth promoting to select instructions.
Chris Lattner44da7ca2010-12-14 07:41:39 +00001789 BasicBlock *DomBlock = 0;
1790 BasicBlock *IfBlock1 = PN->getIncomingBlock(0);
1791 BasicBlock *IfBlock2 = PN->getIncomingBlock(1);
1792 if (cast<BranchInst>(IfBlock1->getTerminator())->isConditional()) {
1793 IfBlock1 = 0;
1794 } else {
1795 DomBlock = *pred_begin(IfBlock1);
1796 for (BasicBlock::iterator I = IfBlock1->begin();!isa<TerminatorInst>(I);++I)
Devang Patel383d7ed2009-02-03 22:12:02 +00001797 if (!AggressiveInsts.count(I) && !isa<DbgInfoIntrinsic>(I)) {
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001798 // This is not an aggressive instruction that we can promote.
1799 // Because of this, we won't be able to get rid of the control
1800 // flow, so the xform is not worth it.
1801 return false;
1802 }
1803 }
Andrew Trick6b014382012-08-29 21:46:36 +00001804
Chris Lattner44da7ca2010-12-14 07:41:39 +00001805 if (cast<BranchInst>(IfBlock2->getTerminator())->isConditional()) {
1806 IfBlock2 = 0;
1807 } else {
1808 DomBlock = *pred_begin(IfBlock2);
1809 for (BasicBlock::iterator I = IfBlock2->begin();!isa<TerminatorInst>(I);++I)
Devang Patel383d7ed2009-02-03 22:12:02 +00001810 if (!AggressiveInsts.count(I) && !isa<DbgInfoIntrinsic>(I)) {
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001811 // This is not an aggressive instruction that we can promote.
1812 // Because of this, we won't be able to get rid of the control
1813 // flow, so the xform is not worth it.
1814 return false;
1815 }
1816 }
Andrew Trick6b014382012-08-29 21:46:36 +00001817
Chris Lattnere0b18e52010-12-14 07:23:10 +00001818 DEBUG(dbgs() << "FOUND IF CONDITION! " << *IfCond << " T: "
Chris Lattner44da7ca2010-12-14 07:41:39 +00001819 << IfTrue->getName() << " F: " << IfFalse->getName() << "\n");
Andrew Trick6b014382012-08-29 21:46:36 +00001820
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001821 // If we can still promote the PHI nodes after this gauntlet of tests,
1822 // do all of the PHI's now.
Chris Lattner3aff13b2010-12-14 08:46:09 +00001823 Instruction *InsertPt = DomBlock->getTerminator();
Devang Pateld3a17882011-05-19 20:52:46 +00001824 IRBuilder<true, NoFolder> Builder(InsertPt);
Andrew Trick6b014382012-08-29 21:46:36 +00001825
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001826 // Move all 'aggressive' instructions, which are defined in the
1827 // conditional parts of the if's up to the dominating block.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001828 if (IfBlock1)
Chris Lattner3aff13b2010-12-14 08:46:09 +00001829 DomBlock->getInstList().splice(InsertPt,
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001830 IfBlock1->getInstList(), IfBlock1->begin(),
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001831 IfBlock1->getTerminator());
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001832 if (IfBlock2)
Chris Lattner3aff13b2010-12-14 08:46:09 +00001833 DomBlock->getInstList().splice(InsertPt,
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001834 IfBlock2->getInstList(), IfBlock2->begin(),
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001835 IfBlock2->getTerminator());
Andrew Trick6b014382012-08-29 21:46:36 +00001836
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001837 while (PHINode *PN = dyn_cast<PHINode>(BB->begin())) {
1838 // Change the PHI node into a select instruction.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001839 Value *TrueVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfFalse);
1840 Value *FalseVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfTrue);
Andrew Trick6b014382012-08-29 21:46:36 +00001841
1842 SelectInst *NV =
Devang Patelf60364d2011-05-18 18:16:44 +00001843 cast<SelectInst>(Builder.CreateSelect(IfCond, TrueVal, FalseVal, ""));
Chris Lattner86cc4232007-02-11 01:37:51 +00001844 PN->replaceAllUsesWith(NV);
1845 NV->takeName(PN);
Chris Lattner302ba6f2010-12-14 06:17:25 +00001846 PN->eraseFromParent();
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001847 }
Andrew Trick6b014382012-08-29 21:46:36 +00001848
Chris Lattner60d410d2010-12-14 08:01:53 +00001849 // At this point, IfBlock1 and IfBlock2 are both empty, so our if statement
1850 // has been flattened. Change DomBlock to jump directly to our new block to
1851 // avoid other simplifycfg's kicking in on the diamond.
1852 TerminatorInst *OldTI = DomBlock->getTerminator();
Devang Patelf60364d2011-05-18 18:16:44 +00001853 Builder.SetInsertPoint(OldTI);
1854 Builder.CreateBr(BB);
Chris Lattner60d410d2010-12-14 08:01:53 +00001855 OldTI->eraseFromParent();
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001856 return true;
1857}
Chris Lattnereaba3a12005-09-19 23:49:37 +00001858
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001859/// SimplifyCondBranchToTwoReturns - If we found a conditional branch that goes
1860/// to two returning blocks, try to merge them together into one return,
1861/// introducing a select if the return values disagree.
Andrew Trick6b014382012-08-29 21:46:36 +00001862static bool SimplifyCondBranchToTwoReturns(BranchInst *BI,
Devang Patel176ec402011-05-18 21:33:11 +00001863 IRBuilder<> &Builder) {
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001864 assert(BI->isConditional() && "Must be a conditional branch");
1865 BasicBlock *TrueSucc = BI->getSuccessor(0);
1866 BasicBlock *FalseSucc = BI->getSuccessor(1);
1867 ReturnInst *TrueRet = cast<ReturnInst>(TrueSucc->getTerminator());
1868 ReturnInst *FalseRet = cast<ReturnInst>(FalseSucc->getTerminator());
Andrew Trick6b014382012-08-29 21:46:36 +00001869
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001870 // Check to ensure both blocks are empty (just a return) or optionally empty
1871 // with PHI nodes. If there are other instructions, merging would cause extra
1872 // computation on one path or the other.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001873 if (!TrueSucc->getFirstNonPHIOrDbg()->isTerminator())
Devang Patel2cc86a12009-02-05 00:30:42 +00001874 return false;
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001875 if (!FalseSucc->getFirstNonPHIOrDbg()->isTerminator())
Devang Patel2cc86a12009-02-05 00:30:42 +00001876 return false;
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001877
Devang Patel176ec402011-05-18 21:33:11 +00001878 Builder.SetInsertPoint(BI);
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001879 // Okay, we found a branch that is going to two return nodes. If
1880 // there is no return value for this function, just change the
1881 // branch into a return.
1882 if (FalseRet->getNumOperands() == 0) {
1883 TrueSucc->removePredecessor(BI->getParent());
1884 FalseSucc->removePredecessor(BI->getParent());
Devang Patel176ec402011-05-18 21:33:11 +00001885 Builder.CreateRetVoid();
Eli Friedman080efb82008-12-16 20:54:32 +00001886 EraseTerminatorInstAndDCECond(BI);
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001887 return true;
1888 }
Andrew Trick6b014382012-08-29 21:46:36 +00001889
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001890 // Otherwise, figure out what the true and false return values are
1891 // so we can insert a new select instruction.
1892 Value *TrueValue = TrueRet->getReturnValue();
1893 Value *FalseValue = FalseRet->getReturnValue();
Andrew Trick6b014382012-08-29 21:46:36 +00001894
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001895 // Unwrap any PHI nodes in the return blocks.
1896 if (PHINode *TVPN = dyn_cast_or_null<PHINode>(TrueValue))
1897 if (TVPN->getParent() == TrueSucc)
1898 TrueValue = TVPN->getIncomingValueForBlock(BI->getParent());
1899 if (PHINode *FVPN = dyn_cast_or_null<PHINode>(FalseValue))
1900 if (FVPN->getParent() == FalseSucc)
1901 FalseValue = FVPN->getIncomingValueForBlock(BI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00001902
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001903 // In order for this transformation to be safe, we must be able to
1904 // unconditionally execute both operands to the return. This is
1905 // normally the case, but we could have a potentially-trapping
1906 // constant expression that prevents this transformation from being
1907 // safe.
1908 if (ConstantExpr *TCV = dyn_cast_or_null<ConstantExpr>(TrueValue))
1909 if (TCV->canTrap())
1910 return false;
1911 if (ConstantExpr *FCV = dyn_cast_or_null<ConstantExpr>(FalseValue))
1912 if (FCV->canTrap())
1913 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001914
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001915 // Okay, we collected all the mapped values and checked them for sanity, and
1916 // defined to really do this transformation. First, update the CFG.
1917 TrueSucc->removePredecessor(BI->getParent());
1918 FalseSucc->removePredecessor(BI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00001919
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001920 // Insert select instructions where needed.
1921 Value *BrCond = BI->getCondition();
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001922 if (TrueValue) {
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001923 // Insert a select if the results differ.
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001924 if (TrueValue == FalseValue || isa<UndefValue>(FalseValue)) {
1925 } else if (isa<UndefValue>(TrueValue)) {
1926 TrueValue = FalseValue;
1927 } else {
Devang Patel176ec402011-05-18 21:33:11 +00001928 TrueValue = Builder.CreateSelect(BrCond, TrueValue,
1929 FalseValue, "retval");
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001930 }
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001931 }
1932
Andrew Trick6b014382012-08-29 21:46:36 +00001933 Value *RI = !TrueValue ?
Devang Patel176ec402011-05-18 21:33:11 +00001934 Builder.CreateRetVoid() : Builder.CreateRet(TrueValue);
1935
Daniel Dunbare317bcc2009-08-23 10:29:55 +00001936 (void) RI;
Andrew Trick6b014382012-08-29 21:46:36 +00001937
David Greene89d6fd32010-01-05 01:26:52 +00001938 DEBUG(dbgs() << "\nCHANGING BRANCH TO TWO RETURNS INTO SELECT:"
Chris Lattnerbdff5482009-08-23 04:37:46 +00001939 << "\n " << *BI << "NewRet = " << *RI
1940 << "TRUEBLOCK: " << *TrueSucc << "FALSEBLOCK: "<< *FalseSucc);
Andrew Trick6b014382012-08-29 21:46:36 +00001941
Eli Friedman080efb82008-12-16 20:54:32 +00001942 EraseTerminatorInstAndDCECond(BI);
1943
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001944 return true;
1945}
1946
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001947/// ExtractBranchMetadata - Given a conditional BranchInstruction, retrieve the
1948/// probabilities of the branch taking each edge. Fills in the two APInt
1949/// parameters and return true, or returns false if no or invalid metadata was
1950/// found.
1951static bool ExtractBranchMetadata(BranchInst *BI,
Manman Ren062986c2012-09-15 00:39:57 +00001952 uint64_t &ProbTrue, uint64_t &ProbFalse) {
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001953 assert(BI->isConditional() &&
1954 "Looking for probabilities on unconditional branch?");
1955 MDNode *ProfileData = BI->getMetadata(LLVMContext::MD_prof);
Nick Lewycky91968482011-12-27 18:27:22 +00001956 if (!ProfileData || ProfileData->getNumOperands() != 3) return false;
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001957 ConstantInt *CITrue = dyn_cast<ConstantInt>(ProfileData->getOperand(1));
1958 ConstantInt *CIFalse = dyn_cast<ConstantInt>(ProfileData->getOperand(2));
Nick Lewycky91968482011-12-27 18:27:22 +00001959 if (!CITrue || !CIFalse) return false;
Manman Ren062986c2012-09-15 00:39:57 +00001960 ProbTrue = CITrue->getValue().getZExtValue();
1961 ProbFalse = CIFalse->getValue().getZExtValue();
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001962 return true;
1963}
1964
Manman Renee28e0f2012-06-13 05:43:29 +00001965/// checkCSEInPredecessor - Return true if the given instruction is available
1966/// in its predecessor block. If yes, the instruction will be removed.
1967///
Benjamin Kramer23d36222012-07-13 13:25:15 +00001968static bool checkCSEInPredecessor(Instruction *Inst, BasicBlock *PB) {
Manman Renee28e0f2012-06-13 05:43:29 +00001969 if (!isa<BinaryOperator>(Inst) && !isa<CmpInst>(Inst))
1970 return false;
1971 for (BasicBlock::iterator I = PB->begin(), E = PB->end(); I != E; I++) {
1972 Instruction *PBI = &*I;
1973 // Check whether Inst and PBI generate the same value.
1974 if (Inst->isIdenticalTo(PBI)) {
1975 Inst->replaceAllUsesWith(PBI);
1976 Inst->eraseFromParent();
1977 return true;
1978 }
1979 }
1980 return false;
1981}
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00001982
Chris Lattnerc8fbc342011-04-11 23:24:57 +00001983/// FoldBranchToCommonDest - If this basic block is simple enough, and if a
1984/// predecessor branches to us and one of our successors, fold the block into
1985/// the predecessor and use logical operations to pick the right destination.
Dan Gohman4b35f832009-06-27 21:30:38 +00001986bool llvm::FoldBranchToCommonDest(BranchInst *BI) {
Chris Lattner093a4382008-07-13 22:23:11 +00001987 BasicBlock *BB = BI->getParent();
Devang Pateld3a17882011-05-19 20:52:46 +00001988
Manman Renee28e0f2012-06-13 05:43:29 +00001989 Instruction *Cond = 0;
1990 if (BI->isConditional())
1991 Cond = dyn_cast<Instruction>(BI->getCondition());
1992 else {
1993 // For unconditional branch, check for a simple CFG pattern, where
1994 // BB has a single predecessor and BB's successor is also its predecessor's
1995 // successor. If such pattern exisits, check for CSE between BB and its
1996 // predecessor.
1997 if (BasicBlock *PB = BB->getSinglePredecessor())
1998 if (BranchInst *PBI = dyn_cast<BranchInst>(PB->getTerminator()))
1999 if (PBI->isConditional() &&
2000 (BI->getSuccessor(0) == PBI->getSuccessor(0) ||
2001 BI->getSuccessor(0) == PBI->getSuccessor(1))) {
2002 for (BasicBlock::iterator I = BB->begin(), E = BB->end();
2003 I != E; ) {
2004 Instruction *Curr = I++;
2005 if (isa<CmpInst>(Curr)) {
2006 Cond = Curr;
2007 break;
2008 }
2009 // Quit if we can't remove this instruction.
2010 if (!checkCSEInPredecessor(Curr, PB))
2011 return false;
2012 }
2013 }
2014
2015 if (Cond == 0)
2016 return false;
2017 }
Andrew Trick6b014382012-08-29 21:46:36 +00002018
Owen Andersone84178a2010-07-14 19:52:16 +00002019 if (Cond == 0 || (!isa<CmpInst>(Cond) && !isa<BinaryOperator>(Cond)) ||
2020 Cond->getParent() != BB || !Cond->hasOneUse())
2021 return false;
Devang Pateld4181942011-04-06 22:37:20 +00002022
Chris Lattner1347e872008-07-13 21:12:01 +00002023 // Only allow this if the condition is a simple instruction that can be
2024 // executed unconditionally. It must be in the same block as the branch, and
2025 // must be at the front of the block.
Devang Pateld0a203d2009-02-04 21:39:48 +00002026 BasicBlock::iterator FrontIt = BB->front();
Chris Lattner3c6e7462011-04-14 02:44:53 +00002027
Devang Pateld0a203d2009-02-04 21:39:48 +00002028 // Ignore dbg intrinsics.
Chris Lattner3c6e7462011-04-14 02:44:53 +00002029 while (isa<DbgInfoIntrinsic>(FrontIt)) ++FrontIt;
Nick Lewycky9d523102011-12-26 20:37:40 +00002030
Owen Andersone84178a2010-07-14 19:52:16 +00002031 // Allow a single instruction to be hoisted in addition to the compare
2032 // that feeds the branch. We later ensure that any values that _it_ uses
2033 // were also live in the predecessor, so that we don't unnecessarily create
2034 // register pressure or inhibit out-of-order execution.
2035 Instruction *BonusInst = 0;
2036 if (&*FrontIt != Cond &&
Owen Anderson2722dfa2010-07-15 16:38:22 +00002037 FrontIt->hasOneUse() && *FrontIt->use_begin() == Cond &&
Dan Gohmanf0426602011-12-14 23:49:11 +00002038 isSafeToSpeculativelyExecute(FrontIt)) {
Owen Andersone84178a2010-07-14 19:52:16 +00002039 BonusInst = &*FrontIt;
2040 ++FrontIt;
Andrew Trick6b014382012-08-29 21:46:36 +00002041
Chris Lattner3c6e7462011-04-14 02:44:53 +00002042 // Ignore dbg intrinsics.
2043 while (isa<DbgInfoIntrinsic>(FrontIt)) ++FrontIt;
Devang Patel60d490c2011-04-07 23:11:25 +00002044 }
2045
Owen Andersone84178a2010-07-14 19:52:16 +00002046 // Only a single bonus inst is allowed.
2047 if (&*FrontIt != Cond)
2048 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002049
Chris Lattner1347e872008-07-13 21:12:01 +00002050 // Make sure the instruction after the condition is the cond branch.
2051 BasicBlock::iterator CondIt = Cond; ++CondIt;
Chris Lattner3c6e7462011-04-14 02:44:53 +00002052
Devang Pateld0a203d2009-02-04 21:39:48 +00002053 // Ingore dbg intrinsics.
Chris Lattner3c6e7462011-04-14 02:44:53 +00002054 while (isa<DbgInfoIntrinsic>(CondIt)) ++CondIt;
Andrew Trick6b014382012-08-29 21:46:36 +00002055
Chris Lattner3c6e7462011-04-14 02:44:53 +00002056 if (&*CondIt != BI)
Chris Lattner1347e872008-07-13 21:12:01 +00002057 return false;
Chris Lattner6ff645b2009-01-19 23:03:13 +00002058
2059 // Cond is known to be a compare or binary operator. Check to make sure that
2060 // neither operand is a potentially-trapping constant expression.
2061 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(0)))
2062 if (CE->canTrap())
2063 return false;
2064 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(1)))
2065 if (CE->canTrap())
2066 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002067
Chris Lattner1347e872008-07-13 21:12:01 +00002068 // Finally, don't infinitely unroll conditional loops.
2069 BasicBlock *TrueDest = BI->getSuccessor(0);
Manman Renee28e0f2012-06-13 05:43:29 +00002070 BasicBlock *FalseDest = (BI->isConditional()) ? BI->getSuccessor(1) : 0;
Chris Lattner1347e872008-07-13 21:12:01 +00002071 if (TrueDest == BB || FalseDest == BB)
2072 return false;
Devang Pateld4181942011-04-06 22:37:20 +00002073
Chris Lattner1347e872008-07-13 21:12:01 +00002074 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
2075 BasicBlock *PredBlock = *PI;
2076 BranchInst *PBI = dyn_cast<BranchInst>(PredBlock->getTerminator());
Andrew Trick6b014382012-08-29 21:46:36 +00002077
Chris Lattner093a4382008-07-13 22:23:11 +00002078 // Check that we have two conditional branches. If there is a PHI node in
2079 // the common successor, verify that the same value flows in from both
2080 // blocks.
Manman Renee28e0f2012-06-13 05:43:29 +00002081 SmallVector<PHINode*, 4> PHIs;
2082 if (PBI == 0 || PBI->isUnconditional() ||
Andrew Trick6b014382012-08-29 21:46:36 +00002083 (BI->isConditional() &&
Manman Renee28e0f2012-06-13 05:43:29 +00002084 !SafeToMergeTerminators(BI, PBI)) ||
2085 (!BI->isConditional() &&
2086 !isProfitableToFoldUnconditional(BI, PBI, Cond, PHIs)))
Chris Lattner1347e872008-07-13 21:12:01 +00002087 continue;
Andrew Trick6b014382012-08-29 21:46:36 +00002088
Chris Lattner3c6e7462011-04-14 02:44:53 +00002089 // Determine if the two branches share a common destination.
Axel Naumann3780ad82012-09-17 14:20:57 +00002090 Instruction::BinaryOps Opc = Instruction::BinaryOpsEnd;
Chris Lattner3c6e7462011-04-14 02:44:53 +00002091 bool InvertPredCond = false;
Andrew Trick6b014382012-08-29 21:46:36 +00002092
Manman Renee28e0f2012-06-13 05:43:29 +00002093 if (BI->isConditional()) {
2094 if (PBI->getSuccessor(0) == TrueDest)
2095 Opc = Instruction::Or;
2096 else if (PBI->getSuccessor(1) == FalseDest)
2097 Opc = Instruction::And;
2098 else if (PBI->getSuccessor(0) == FalseDest)
2099 Opc = Instruction::And, InvertPredCond = true;
2100 else if (PBI->getSuccessor(1) == TrueDest)
2101 Opc = Instruction::Or, InvertPredCond = true;
2102 else
2103 continue;
2104 } else {
2105 if (PBI->getSuccessor(0) != TrueDest && PBI->getSuccessor(1) != TrueDest)
2106 continue;
2107 }
Chris Lattner3c6e7462011-04-14 02:44:53 +00002108
Owen Andersone84178a2010-07-14 19:52:16 +00002109 // Ensure that any values used in the bonus instruction are also used
2110 // by the terminator of the predecessor. This means that those values
Andrew Trick6b014382012-08-29 21:46:36 +00002111 // must already have been resolved, so we won't be inhibiting the
Owen Andersone84178a2010-07-14 19:52:16 +00002112 // out-of-order core by speculating them earlier.
2113 if (BonusInst) {
2114 // Collect the values used by the bonus inst
2115 SmallPtrSet<Value*, 4> UsedValues;
2116 for (Instruction::op_iterator OI = BonusInst->op_begin(),
2117 OE = BonusInst->op_end(); OI != OE; ++OI) {
Nick Lewycky9d523102011-12-26 20:37:40 +00002118 Value *V = *OI;
Owen Andersone84178a2010-07-14 19:52:16 +00002119 if (!isa<Constant>(V))
2120 UsedValues.insert(V);
2121 }
2122
2123 SmallVector<std::pair<Value*, unsigned>, 4> Worklist;
2124 Worklist.push_back(std::make_pair(PBI->getOperand(0), 0));
Andrew Trick6b014382012-08-29 21:46:36 +00002125
Owen Andersone84178a2010-07-14 19:52:16 +00002126 // Walk up to four levels back up the use-def chain of the predecessor's
2127 // terminator to see if all those values were used. The choice of four
2128 // levels is arbitrary, to provide a compile-time-cost bound.
2129 while (!Worklist.empty()) {
2130 std::pair<Value*, unsigned> Pair = Worklist.back();
2131 Worklist.pop_back();
Andrew Trick6b014382012-08-29 21:46:36 +00002132
Owen Andersone84178a2010-07-14 19:52:16 +00002133 if (Pair.second >= 4) continue;
2134 UsedValues.erase(Pair.first);
2135 if (UsedValues.empty()) break;
Andrew Trick6b014382012-08-29 21:46:36 +00002136
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00002137 if (Instruction *I = dyn_cast<Instruction>(Pair.first)) {
Owen Andersone84178a2010-07-14 19:52:16 +00002138 for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
2139 OI != OE; ++OI)
2140 Worklist.push_back(std::make_pair(OI->get(), Pair.second+1));
Andrew Trick6b014382012-08-29 21:46:36 +00002141 }
Owen Andersone84178a2010-07-14 19:52:16 +00002142 }
Andrew Trick6b014382012-08-29 21:46:36 +00002143
Owen Andersone84178a2010-07-14 19:52:16 +00002144 if (!UsedValues.empty()) return false;
2145 }
Chris Lattner36989092008-07-13 21:20:19 +00002146
David Greene89d6fd32010-01-05 01:26:52 +00002147 DEBUG(dbgs() << "FOLDING BRANCH TO COMMON DEST:\n" << *PBI << *BB);
Andrew Trick6b014382012-08-29 21:46:36 +00002148 IRBuilder<> Builder(PBI);
Devang Pateld3a17882011-05-19 20:52:46 +00002149
Chris Lattner36989092008-07-13 21:20:19 +00002150 // If we need to invert the condition in the pred block to match, do so now.
2151 if (InvertPredCond) {
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00002152 Value *NewCond = PBI->getCondition();
Andrew Trick6b014382012-08-29 21:46:36 +00002153
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00002154 if (NewCond->hasOneUse() && isa<CmpInst>(NewCond)) {
2155 CmpInst *CI = cast<CmpInst>(NewCond);
2156 CI->setPredicate(CI->getInversePredicate());
2157 } else {
Andrew Trick6b014382012-08-29 21:46:36 +00002158 NewCond = Builder.CreateNot(NewCond,
Devang Pateld3a17882011-05-19 20:52:46 +00002159 PBI->getCondition()->getName()+".not");
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00002160 }
Andrew Trick6b014382012-08-29 21:46:36 +00002161
Chris Lattner1347e872008-07-13 21:12:01 +00002162 PBI->setCondition(NewCond);
Nick Lewyckyc9a1aed2011-12-26 20:54:14 +00002163 PBI->swapSuccessors();
Chris Lattner1347e872008-07-13 21:12:01 +00002164 }
Andrew Trick6b014382012-08-29 21:46:36 +00002165
Owen Andersone84178a2010-07-14 19:52:16 +00002166 // If we have a bonus inst, clone it into the predecessor block.
2167 Instruction *NewBonus = 0;
2168 if (BonusInst) {
2169 NewBonus = BonusInst->clone();
2170 PredBlock->getInstList().insert(PBI, NewBonus);
2171 NewBonus->takeName(BonusInst);
2172 BonusInst->setName(BonusInst->getName()+".old");
2173 }
Andrew Trick6b014382012-08-29 21:46:36 +00002174
Chris Lattner36989092008-07-13 21:20:19 +00002175 // Clone Cond into the predecessor basic block, and or/and the
2176 // two conditions together.
Nick Lewycky67760642009-09-27 07:38:41 +00002177 Instruction *New = Cond->clone();
Owen Andersone84178a2010-07-14 19:52:16 +00002178 if (BonusInst) New->replaceUsesOfWith(BonusInst, NewBonus);
Chris Lattner36989092008-07-13 21:20:19 +00002179 PredBlock->getInstList().insert(PBI, New);
2180 New->takeName(Cond);
2181 Cond->setName(New->getName()+".old");
Andrew Trick6b014382012-08-29 21:46:36 +00002182
Manman Renee28e0f2012-06-13 05:43:29 +00002183 if (BI->isConditional()) {
Andrew Trick6b014382012-08-29 21:46:36 +00002184 Instruction *NewCond =
Manman Renee28e0f2012-06-13 05:43:29 +00002185 cast<Instruction>(Builder.CreateBinOp(Opc, PBI->getCondition(),
Devang Pateld3a17882011-05-19 20:52:46 +00002186 New, "or.cond"));
Manman Renee28e0f2012-06-13 05:43:29 +00002187 PBI->setCondition(NewCond);
2188
Manman Ren062986c2012-09-15 00:39:57 +00002189 uint64_t PredTrueWeight, PredFalseWeight, SuccTrueWeight, SuccFalseWeight;
2190 bool PredHasWeights = ExtractBranchMetadata(PBI, PredTrueWeight,
2191 PredFalseWeight);
2192 bool SuccHasWeights = ExtractBranchMetadata(BI, SuccTrueWeight,
2193 SuccFalseWeight);
2194 SmallVector<uint64_t, 8> NewWeights;
2195
Manman Renee28e0f2012-06-13 05:43:29 +00002196 if (PBI->getSuccessor(0) == BB) {
Manman Ren062986c2012-09-15 00:39:57 +00002197 if (PredHasWeights && SuccHasWeights) {
2198 // PBI: br i1 %x, BB, FalseDest
2199 // BI: br i1 %y, TrueDest, FalseDest
2200 //TrueWeight is TrueWeight for PBI * TrueWeight for BI.
2201 NewWeights.push_back(PredTrueWeight * SuccTrueWeight);
2202 //FalseWeight is FalseWeight for PBI * TotalWeight for BI +
2203 // TrueWeight for PBI * FalseWeight for BI.
2204 // We assume that total weights of a BranchInst can fit into 32 bits.
2205 // Therefore, we will not have overflow using 64-bit arithmetic.
2206 NewWeights.push_back(PredFalseWeight * (SuccFalseWeight +
2207 SuccTrueWeight) + PredTrueWeight * SuccFalseWeight);
2208 }
Manman Renee28e0f2012-06-13 05:43:29 +00002209 AddPredecessorToBlock(TrueDest, PredBlock, BB);
2210 PBI->setSuccessor(0, TrueDest);
2211 }
2212 if (PBI->getSuccessor(1) == BB) {
Manman Ren062986c2012-09-15 00:39:57 +00002213 if (PredHasWeights && SuccHasWeights) {
2214 // PBI: br i1 %x, TrueDest, BB
2215 // BI: br i1 %y, TrueDest, FalseDest
2216 //TrueWeight is TrueWeight for PBI * TotalWeight for BI +
2217 // FalseWeight for PBI * TrueWeight for BI.
2218 NewWeights.push_back(PredTrueWeight * (SuccFalseWeight +
2219 SuccTrueWeight) + PredFalseWeight * SuccTrueWeight);
2220 //FalseWeight is FalseWeight for PBI * FalseWeight for BI.
2221 NewWeights.push_back(PredFalseWeight * SuccFalseWeight);
2222 }
Manman Renee28e0f2012-06-13 05:43:29 +00002223 AddPredecessorToBlock(FalseDest, PredBlock, BB);
2224 PBI->setSuccessor(1, FalseDest);
2225 }
Manman Ren062986c2012-09-15 00:39:57 +00002226 if (NewWeights.size() == 2) {
2227 // Halve the weights if any of them cannot fit in an uint32_t
2228 FitWeights(NewWeights);
2229
2230 SmallVector<uint32_t, 8> MDWeights(NewWeights.begin(),NewWeights.end());
2231 PBI->setMetadata(LLVMContext::MD_prof,
2232 MDBuilder(BI->getContext()).
2233 createBranchWeights(MDWeights));
2234 } else
2235 PBI->setMetadata(LLVMContext::MD_prof, NULL);
Manman Renee28e0f2012-06-13 05:43:29 +00002236 } else {
2237 // Update PHI nodes in the common successors.
2238 for (unsigned i = 0, e = PHIs.size(); i != e; ++i) {
Nick Lewyckyedb58422012-06-24 10:15:42 +00002239 ConstantInt *PBI_C = cast<ConstantInt>(
Manman Renee28e0f2012-06-13 05:43:29 +00002240 PHIs[i]->getIncomingValueForBlock(PBI->getParent()));
2241 assert(PBI_C->getType()->isIntegerTy(1));
2242 Instruction *MergedCond = 0;
2243 if (PBI->getSuccessor(0) == TrueDest) {
2244 // Create (PBI_Cond and PBI_C) or (!PBI_Cond and BI_Value)
2245 // PBI_C is true: PBI_Cond or (!PBI_Cond and BI_Value)
2246 // is false: !PBI_Cond and BI_Value
2247 Instruction *NotCond =
2248 cast<Instruction>(Builder.CreateNot(PBI->getCondition(),
2249 "not.cond"));
2250 MergedCond =
2251 cast<Instruction>(Builder.CreateBinOp(Instruction::And,
2252 NotCond, New,
2253 "and.cond"));
2254 if (PBI_C->isOne())
2255 MergedCond =
2256 cast<Instruction>(Builder.CreateBinOp(Instruction::Or,
2257 PBI->getCondition(), MergedCond,
2258 "or.cond"));
2259 } else {
2260 // Create (PBI_Cond and BI_Value) or (!PBI_Cond and PBI_C)
2261 // PBI_C is true: (PBI_Cond and BI_Value) or (!PBI_Cond)
2262 // is false: PBI_Cond and BI_Value
Andrew Trick6b014382012-08-29 21:46:36 +00002263 MergedCond =
Manman Renee28e0f2012-06-13 05:43:29 +00002264 cast<Instruction>(Builder.CreateBinOp(Instruction::And,
2265 PBI->getCondition(), New,
2266 "and.cond"));
2267 if (PBI_C->isOne()) {
2268 Instruction *NotCond =
2269 cast<Instruction>(Builder.CreateNot(PBI->getCondition(),
2270 "not.cond"));
Andrew Trick6b014382012-08-29 21:46:36 +00002271 MergedCond =
Manman Renee28e0f2012-06-13 05:43:29 +00002272 cast<Instruction>(Builder.CreateBinOp(Instruction::Or,
2273 NotCond, MergedCond,
2274 "or.cond"));
2275 }
2276 }
2277 // Update PHI Node.
2278 PHIs[i]->setIncomingValue(PHIs[i]->getBasicBlockIndex(PBI->getParent()),
2279 MergedCond);
2280 }
2281 // Change PBI from Conditional to Unconditional.
2282 BranchInst *New_PBI = BranchInst::Create(TrueDest, PBI);
2283 EraseTerminatorInstAndDCECond(PBI);
2284 PBI = New_PBI;
Chris Lattner36989092008-07-13 21:20:19 +00002285 }
Devang Pateld4181942011-04-06 22:37:20 +00002286
Nick Lewycky06cc66f2011-12-27 04:31:52 +00002287 // TODO: If BB is reachable from all paths through PredBlock, then we
2288 // could replace PBI's branch probabilities with BI's.
2289
Chris Lattner3c6e7462011-04-14 02:44:53 +00002290 // Copy any debug value intrinsics into the end of PredBlock.
2291 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
2292 if (isa<DbgInfoIntrinsic>(*I))
2293 I->clone()->insertBefore(PBI);
Andrew Trick6b014382012-08-29 21:46:36 +00002294
Chris Lattner117f8cf2010-12-14 05:57:30 +00002295 return true;
Chris Lattner1347e872008-07-13 21:12:01 +00002296 }
2297 return false;
2298}
2299
Chris Lattner867661a2008-07-13 21:53:26 +00002300/// SimplifyCondBranchToCondBranch - If we have a conditional branch as a
2301/// predecessor of another block, this function tries to simplify it. We know
2302/// that PBI and BI are both conditional branches, and BI is in one of the
2303/// successor blocks of PBI - PBI branches to BI.
2304static bool SimplifyCondBranchToCondBranch(BranchInst *PBI, BranchInst *BI) {
2305 assert(PBI->isConditional() && BI->isConditional());
2306 BasicBlock *BB = BI->getParent();
Dan Gohman4ae51262009-08-12 16:23:25 +00002307
Chris Lattner867661a2008-07-13 21:53:26 +00002308 // If this block ends with a branch instruction, and if there is a
Andrew Trick6b014382012-08-29 21:46:36 +00002309 // predecessor that ends on a branch of the same condition, make
Chris Lattner867661a2008-07-13 21:53:26 +00002310 // this conditional branch redundant.
2311 if (PBI->getCondition() == BI->getCondition() &&
2312 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
2313 // Okay, the outcome of this conditional branch is statically
2314 // knowable. If this block had a single pred, handle specially.
2315 if (BB->getSinglePredecessor()) {
2316 // Turn this into a branch on constant.
2317 bool CondIsTrue = PBI->getSuccessor(0) == BB;
Andrew Trick6b014382012-08-29 21:46:36 +00002318 BI->setCondition(ConstantInt::get(Type::getInt1Ty(BB->getContext()),
Owen Anderson1d0be152009-08-13 21:58:54 +00002319 CondIsTrue));
Chris Lattner867661a2008-07-13 21:53:26 +00002320 return true; // Nuke the branch on constant.
2321 }
Andrew Trick6b014382012-08-29 21:46:36 +00002322
Chris Lattner867661a2008-07-13 21:53:26 +00002323 // Otherwise, if there are multiple predecessors, insert a PHI that merges
2324 // in the constant and simplify the block result. Subsequent passes of
2325 // simplifycfg will thread the block.
2326 if (BlockIsSimpleEnoughToThreadThrough(BB)) {
Jay Foadd8b4fb42011-03-30 11:19:20 +00002327 pred_iterator PB = pred_begin(BB), PE = pred_end(BB);
Owen Anderson1d0be152009-08-13 21:58:54 +00002328 PHINode *NewPN = PHINode::Create(Type::getInt1Ty(BB->getContext()),
Jay Foad3ecfc862011-03-30 11:28:46 +00002329 std::distance(PB, PE),
Chris Lattner867661a2008-07-13 21:53:26 +00002330 BI->getCondition()->getName() + ".pr",
2331 BB->begin());
Chris Lattnereb388af2008-07-13 21:55:46 +00002332 // Okay, we're going to insert the PHI node. Since PBI is not the only
2333 // predecessor, compute the PHI'd conditional value for all of the preds.
2334 // Any predecessor where the condition is not computable we keep symbolic.
Jay Foadd8b4fb42011-03-30 11:19:20 +00002335 for (pred_iterator PI = PB; PI != PE; ++PI) {
Gabor Greif62539832010-07-12 10:59:23 +00002336 BasicBlock *P = *PI;
2337 if ((PBI = dyn_cast<BranchInst>(P->getTerminator())) &&
Chris Lattner867661a2008-07-13 21:53:26 +00002338 PBI != BI && PBI->isConditional() &&
2339 PBI->getCondition() == BI->getCondition() &&
2340 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
2341 bool CondIsTrue = PBI->getSuccessor(0) == BB;
Andrew Trick6b014382012-08-29 21:46:36 +00002342 NewPN->addIncoming(ConstantInt::get(Type::getInt1Ty(BB->getContext()),
Gabor Greif62539832010-07-12 10:59:23 +00002343 CondIsTrue), P);
Chris Lattner867661a2008-07-13 21:53:26 +00002344 } else {
Gabor Greif62539832010-07-12 10:59:23 +00002345 NewPN->addIncoming(BI->getCondition(), P);
Chris Lattner867661a2008-07-13 21:53:26 +00002346 }
Gabor Greif62539832010-07-12 10:59:23 +00002347 }
Andrew Trick6b014382012-08-29 21:46:36 +00002348
Chris Lattner867661a2008-07-13 21:53:26 +00002349 BI->setCondition(NewPN);
Chris Lattner867661a2008-07-13 21:53:26 +00002350 return true;
2351 }
2352 }
Andrew Trick6b014382012-08-29 21:46:36 +00002353
Chris Lattner867661a2008-07-13 21:53:26 +00002354 // If this is a conditional branch in an empty block, and if any
2355 // predecessors is a conditional branch to one of our destinations,
2356 // fold the conditions into logical ops and one cond br.
Zhou Shenga8d57fe2009-02-26 06:56:37 +00002357 BasicBlock::iterator BBI = BB->begin();
2358 // Ignore dbg intrinsics.
2359 while (isa<DbgInfoIntrinsic>(BBI))
2360 ++BBI;
2361 if (&*BBI != BI)
Chris Lattnerb8245122008-07-13 22:04:41 +00002362 return false;
Chris Lattner63bf29b2009-01-20 01:15:41 +00002363
Andrew Trick6b014382012-08-29 21:46:36 +00002364
Chris Lattner63bf29b2009-01-20 01:15:41 +00002365 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(BI->getCondition()))
2366 if (CE->canTrap())
2367 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002368
Chris Lattnerb8245122008-07-13 22:04:41 +00002369 int PBIOp, BIOp;
2370 if (PBI->getSuccessor(0) == BI->getSuccessor(0))
2371 PBIOp = BIOp = 0;
2372 else if (PBI->getSuccessor(0) == BI->getSuccessor(1))
2373 PBIOp = 0, BIOp = 1;
2374 else if (PBI->getSuccessor(1) == BI->getSuccessor(0))
2375 PBIOp = 1, BIOp = 0;
2376 else if (PBI->getSuccessor(1) == BI->getSuccessor(1))
2377 PBIOp = BIOp = 1;
2378 else
2379 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002380
Chris Lattnerb8245122008-07-13 22:04:41 +00002381 // Check to make sure that the other destination of this branch
2382 // isn't BB itself. If so, this is an infinite loop that will
2383 // keep getting unwound.
2384 if (PBI->getSuccessor(PBIOp) == BB)
2385 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002386
2387 // Do not perform this transformation if it would require
Chris Lattnerb8245122008-07-13 22:04:41 +00002388 // insertion of a large number of select instructions. For targets
2389 // without predication/cmovs, this is a big pessimization.
2390 BasicBlock *CommonDest = PBI->getSuccessor(PBIOp);
Andrew Trick6b014382012-08-29 21:46:36 +00002391
Chris Lattnerb8245122008-07-13 22:04:41 +00002392 unsigned NumPhis = 0;
2393 for (BasicBlock::iterator II = CommonDest->begin();
2394 isa<PHINode>(II); ++II, ++NumPhis)
2395 if (NumPhis > 2) // Disable this xform.
2396 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002397
Chris Lattnerb8245122008-07-13 22:04:41 +00002398 // Finally, if everything is ok, fold the branches to logical ops.
2399 BasicBlock *OtherDest = BI->getSuccessor(BIOp ^ 1);
Andrew Trick6b014382012-08-29 21:46:36 +00002400
David Greene89d6fd32010-01-05 01:26:52 +00002401 DEBUG(dbgs() << "FOLDING BRs:" << *PBI->getParent()
Chris Lattnerbdff5482009-08-23 04:37:46 +00002402 << "AND: " << *BI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00002403
2404
Chris Lattner093a4382008-07-13 22:23:11 +00002405 // If OtherDest *is* BB, then BB is a basic block with a single conditional
2406 // branch in it, where one edge (OtherDest) goes back to itself but the other
2407 // exits. We don't *know* that the program avoids the infinite loop
2408 // (even though that seems likely). If we do this xform naively, we'll end up
2409 // recursively unpeeling the loop. Since we know that (after the xform is
2410 // done) that the block *is* infinite if reached, we just make it an obviously
2411 // infinite loop with no cond branch.
2412 if (OtherDest == BB) {
2413 // Insert it at the end of the function, because it's either code,
2414 // or it won't matter if it's hot. :)
Owen Anderson1d0be152009-08-13 21:58:54 +00002415 BasicBlock *InfLoopBlock = BasicBlock::Create(BB->getContext(),
2416 "infloop", BB->getParent());
Chris Lattner093a4382008-07-13 22:23:11 +00002417 BranchInst::Create(InfLoopBlock, InfLoopBlock);
2418 OtherDest = InfLoopBlock;
Andrew Trick6b014382012-08-29 21:46:36 +00002419 }
2420
David Greene89d6fd32010-01-05 01:26:52 +00002421 DEBUG(dbgs() << *PBI->getParent()->getParent());
Devang Pateld3a17882011-05-19 20:52:46 +00002422
Chris Lattnerb8245122008-07-13 22:04:41 +00002423 // BI may have other predecessors. Because of this, we leave
2424 // it alone, but modify PBI.
Andrew Trick6b014382012-08-29 21:46:36 +00002425
Chris Lattnerb8245122008-07-13 22:04:41 +00002426 // Make sure we get to CommonDest on True&True directions.
2427 Value *PBICond = PBI->getCondition();
Devang Pateld3a17882011-05-19 20:52:46 +00002428 IRBuilder<true, NoFolder> Builder(PBI);
Chris Lattnerb8245122008-07-13 22:04:41 +00002429 if (PBIOp)
Devang Pateld3a17882011-05-19 20:52:46 +00002430 PBICond = Builder.CreateNot(PBICond, PBICond->getName()+".not");
2431
Chris Lattnerb8245122008-07-13 22:04:41 +00002432 Value *BICond = BI->getCondition();
2433 if (BIOp)
Devang Pateld3a17882011-05-19 20:52:46 +00002434 BICond = Builder.CreateNot(BICond, BICond->getName()+".not");
2435
Chris Lattnerb8245122008-07-13 22:04:41 +00002436 // Merge the conditions.
Devang Pateld3a17882011-05-19 20:52:46 +00002437 Value *Cond = Builder.CreateOr(PBICond, BICond, "brmerge");
Andrew Trick6b014382012-08-29 21:46:36 +00002438
Chris Lattnerb8245122008-07-13 22:04:41 +00002439 // Modify PBI to branch on the new condition to the new dests.
2440 PBI->setCondition(Cond);
2441 PBI->setSuccessor(0, CommonDest);
2442 PBI->setSuccessor(1, OtherDest);
Andrew Trick6b014382012-08-29 21:46:36 +00002443
Manman Ren56654032012-09-17 21:30:40 +00002444 // Update branch weight for PBI.
2445 uint64_t PredTrueWeight, PredFalseWeight, SuccTrueWeight, SuccFalseWeight;
2446 bool PredHasWeights = ExtractBranchMetadata(PBI, PredTrueWeight,
2447 PredFalseWeight);
2448 bool SuccHasWeights = ExtractBranchMetadata(BI, SuccTrueWeight,
2449 SuccFalseWeight);
2450 if (PredHasWeights && SuccHasWeights) {
2451 uint64_t PredCommon = PBIOp ? PredFalseWeight : PredTrueWeight;
2452 uint64_t PredOther = PBIOp ?PredTrueWeight : PredFalseWeight;
2453 uint64_t SuccCommon = BIOp ? SuccFalseWeight : SuccTrueWeight;
2454 uint64_t SuccOther = BIOp ? SuccTrueWeight : SuccFalseWeight;
2455 // The weight to CommonDest should be PredCommon * SuccTotal +
2456 // PredOther * SuccCommon.
2457 // The weight to OtherDest should be PredOther * SuccOther.
2458 SmallVector<uint64_t, 2> NewWeights;
2459 NewWeights.push_back(PredCommon * (SuccCommon + SuccOther) +
2460 PredOther * SuccCommon);
2461 NewWeights.push_back(PredOther * SuccOther);
2462 // Halve the weights if any of them cannot fit in an uint32_t
2463 FitWeights(NewWeights);
2464
2465 SmallVector<uint32_t, 2> MDWeights(NewWeights.begin(),NewWeights.end());
2466 PBI->setMetadata(LLVMContext::MD_prof,
2467 MDBuilder(BI->getContext()).
2468 createBranchWeights(MDWeights));
2469 }
2470
Chris Lattnerb8245122008-07-13 22:04:41 +00002471 // OtherDest may have phi nodes. If so, add an entry from PBI's
2472 // block that are identical to the entries for BI's block.
Chris Lattner6de0a282010-12-14 07:09:42 +00002473 AddPredecessorToBlock(OtherDest, PBI->getParent(), BB);
Andrew Trick6b014382012-08-29 21:46:36 +00002474
Chris Lattnerb8245122008-07-13 22:04:41 +00002475 // We know that the CommonDest already had an edge from PBI to
2476 // it. If it has PHIs though, the PHIs may have different
2477 // entries for BB and PBI's BB. If so, insert a select to make
2478 // them agree.
Chris Lattner6de0a282010-12-14 07:09:42 +00002479 PHINode *PN;
Chris Lattnerb8245122008-07-13 22:04:41 +00002480 for (BasicBlock::iterator II = CommonDest->begin();
2481 (PN = dyn_cast<PHINode>(II)); ++II) {
2482 Value *BIV = PN->getIncomingValueForBlock(BB);
2483 unsigned PBBIdx = PN->getBasicBlockIndex(PBI->getParent());
2484 Value *PBIV = PN->getIncomingValue(PBBIdx);
2485 if (BIV != PBIV) {
2486 // Insert a select in PBI to pick the right value.
Devang Pateld3a17882011-05-19 20:52:46 +00002487 Value *NV = cast<SelectInst>
2488 (Builder.CreateSelect(PBICond, PBIV, BIV, PBIV->getName()+".mux"));
Chris Lattnerb8245122008-07-13 22:04:41 +00002489 PN->setIncomingValue(PBBIdx, NV);
Chris Lattner867661a2008-07-13 21:53:26 +00002490 }
2491 }
Andrew Trick6b014382012-08-29 21:46:36 +00002492
David Greene89d6fd32010-01-05 01:26:52 +00002493 DEBUG(dbgs() << "INTO: " << *PBI->getParent());
2494 DEBUG(dbgs() << *PBI->getParent()->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00002495
Chris Lattnerb8245122008-07-13 22:04:41 +00002496 // This basic block is probably dead. We know it has at least
2497 // one fewer predecessor.
2498 return true;
Chris Lattner867661a2008-07-13 21:53:26 +00002499}
2500
Frits van Bommel65fdded2011-01-11 12:52:11 +00002501// SimplifyTerminatorOnSelect - Simplifies a terminator by replacing it with a
2502// branch to TrueBB if Cond is true or to FalseBB if Cond is false.
2503// Takes care of updating the successors and removing the old terminator.
2504// Also makes sure not to introduce new successors by assuming that edges to
2505// non-successor TrueBBs and FalseBBs aren't reachable.
2506static bool SimplifyTerminatorOnSelect(TerminatorInst *OldTerm, Value *Cond,
Manman Renb11cbe62012-09-17 22:28:55 +00002507 BasicBlock *TrueBB, BasicBlock *FalseBB,
2508 uint32_t TrueWeight,
2509 uint32_t FalseWeight){
Frits van Bommel65fdded2011-01-11 12:52:11 +00002510 // Remove any superfluous successor edges from the CFG.
2511 // First, figure out which successors to preserve.
2512 // If TrueBB and FalseBB are equal, only try to preserve one copy of that
2513 // successor.
2514 BasicBlock *KeepEdge1 = TrueBB;
2515 BasicBlock *KeepEdge2 = TrueBB != FalseBB ? FalseBB : 0;
2516
2517 // Then remove the rest.
2518 for (unsigned I = 0, E = OldTerm->getNumSuccessors(); I != E; ++I) {
2519 BasicBlock *Succ = OldTerm->getSuccessor(I);
2520 // Make sure only to keep exactly one copy of each edge.
2521 if (Succ == KeepEdge1)
2522 KeepEdge1 = 0;
2523 else if (Succ == KeepEdge2)
2524 KeepEdge2 = 0;
2525 else
2526 Succ->removePredecessor(OldTerm->getParent());
2527 }
2528
Devang Pateld3372b82011-05-18 18:43:31 +00002529 IRBuilder<> Builder(OldTerm);
2530 Builder.SetCurrentDebugLocation(OldTerm->getDebugLoc());
2531
Frits van Bommel65fdded2011-01-11 12:52:11 +00002532 // Insert an appropriate new terminator.
2533 if ((KeepEdge1 == 0) && (KeepEdge2 == 0)) {
2534 if (TrueBB == FalseBB)
2535 // We were only looking for one successor, and it was present.
2536 // Create an unconditional branch to it.
Devang Pateld3372b82011-05-18 18:43:31 +00002537 Builder.CreateBr(TrueBB);
Manman Renb11cbe62012-09-17 22:28:55 +00002538 else {
Frits van Bommel65fdded2011-01-11 12:52:11 +00002539 // We found both of the successors we were looking for.
2540 // Create a conditional branch sharing the condition of the select.
Manman Renb11cbe62012-09-17 22:28:55 +00002541 BranchInst *NewBI = Builder.CreateCondBr(Cond, TrueBB, FalseBB);
2542 if (TrueWeight != FalseWeight)
2543 NewBI->setMetadata(LLVMContext::MD_prof,
2544 MDBuilder(OldTerm->getContext()).
2545 createBranchWeights(TrueWeight, FalseWeight));
2546 }
Frits van Bommel65fdded2011-01-11 12:52:11 +00002547 } else if (KeepEdge1 && (KeepEdge2 || TrueBB == FalseBB)) {
2548 // Neither of the selected blocks were successors, so this
2549 // terminator must be unreachable.
2550 new UnreachableInst(OldTerm->getContext(), OldTerm);
2551 } else {
2552 // One of the selected values was a successor, but the other wasn't.
2553 // Insert an unconditional branch to the one that was found;
2554 // the edge to the one that wasn't must be unreachable.
2555 if (KeepEdge1 == 0)
2556 // Only TrueBB was found.
Devang Pateld3372b82011-05-18 18:43:31 +00002557 Builder.CreateBr(TrueBB);
Frits van Bommel65fdded2011-01-11 12:52:11 +00002558 else
2559 // Only FalseBB was found.
Devang Pateld3372b82011-05-18 18:43:31 +00002560 Builder.CreateBr(FalseBB);
Frits van Bommel65fdded2011-01-11 12:52:11 +00002561 }
2562
2563 EraseTerminatorInstAndDCECond(OldTerm);
2564 return true;
2565}
2566
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00002567// SimplifySwitchOnSelect - Replaces
2568// (switch (select cond, X, Y)) on constant X, Y
2569// with a branch - conditional if X and Y lead to distinct BBs,
2570// unconditional otherwise.
2571static bool SimplifySwitchOnSelect(SwitchInst *SI, SelectInst *Select) {
2572 // Check for constant integer values in the select.
2573 ConstantInt *TrueVal = dyn_cast<ConstantInt>(Select->getTrueValue());
2574 ConstantInt *FalseVal = dyn_cast<ConstantInt>(Select->getFalseValue());
2575 if (!TrueVal || !FalseVal)
2576 return false;
2577
2578 // Find the relevant condition and destinations.
2579 Value *Condition = Select->getCondition();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002580 BasicBlock *TrueBB = SI->findCaseValue(TrueVal).getCaseSuccessor();
2581 BasicBlock *FalseBB = SI->findCaseValue(FalseVal).getCaseSuccessor();
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00002582
Manman Renb11cbe62012-09-17 22:28:55 +00002583 // Get weight for TrueBB and FalseBB.
2584 uint32_t TrueWeight = 0, FalseWeight = 0;
2585 SmallVector<uint64_t, 8> Weights;
2586 bool HasWeights = HasBranchWeights(SI);
2587 if (HasWeights) {
2588 GetBranchWeights(SI, Weights);
2589 if (Weights.size() == 1 + SI->getNumCases()) {
2590 TrueWeight = (uint32_t)Weights[SI->findCaseValue(TrueVal).
2591 getSuccessorIndex()];
2592 FalseWeight = (uint32_t)Weights[SI->findCaseValue(FalseVal).
2593 getSuccessorIndex()];
2594 }
2595 }
2596
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00002597 // Perform the actual simplification.
Manman Renb11cbe62012-09-17 22:28:55 +00002598 return SimplifyTerminatorOnSelect(SI, Condition, TrueBB, FalseBB,
2599 TrueWeight, FalseWeight);
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00002600}
2601
Frits van Bommel7ac40c32010-12-05 18:29:03 +00002602// SimplifyIndirectBrOnSelect - Replaces
2603// (indirectbr (select cond, blockaddress(@fn, BlockA),
2604// blockaddress(@fn, BlockB)))
2605// with
2606// (br cond, BlockA, BlockB).
2607static bool SimplifyIndirectBrOnSelect(IndirectBrInst *IBI, SelectInst *SI) {
2608 // Check that both operands of the select are block addresses.
2609 BlockAddress *TBA = dyn_cast<BlockAddress>(SI->getTrueValue());
2610 BlockAddress *FBA = dyn_cast<BlockAddress>(SI->getFalseValue());
2611 if (!TBA || !FBA)
2612 return false;
2613
2614 // Extract the actual blocks.
2615 BasicBlock *TrueBB = TBA->getBasicBlock();
2616 BasicBlock *FalseBB = FBA->getBasicBlock();
2617
Frits van Bommel65fdded2011-01-11 12:52:11 +00002618 // Perform the actual simplification.
Manman Renb11cbe62012-09-17 22:28:55 +00002619 return SimplifyTerminatorOnSelect(IBI, SI->getCondition(), TrueBB, FalseBB,
2620 0, 0);
Frits van Bommel7ac40c32010-12-05 18:29:03 +00002621}
2622
Chris Lattner61c77442010-12-13 03:18:54 +00002623/// TryToSimplifyUncondBranchWithICmpInIt - This is called when we find an icmp
2624/// instruction (a seteq/setne with a constant) as the only instruction in a
2625/// block that ends with an uncond branch. We are looking for a very specific
2626/// pattern that occurs when "A == 1 || A == 2 || A == 3" gets simplified. In
2627/// this case, we merge the first two "or's of icmp" into a switch, but then the
2628/// default value goes to an uncond block with a seteq in it, we get something
2629/// like:
2630///
2631/// switch i8 %A, label %DEFAULT [ i8 1, label %end i8 2, label %end ]
2632/// DEFAULT:
2633/// %tmp = icmp eq i8 %A, 92
2634/// br label %end
2635/// end:
2636/// ... = phi i1 [ true, %entry ], [ %tmp, %DEFAULT ], [ true, %entry ]
Andrew Trick6b014382012-08-29 21:46:36 +00002637///
Chris Lattner61c77442010-12-13 03:18:54 +00002638/// We prefer to split the edge to 'end' so that there is a true/false entry to
2639/// the PHI, merging the third icmp into the switch.
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00002640static bool TryToSimplifyUncondBranchWithICmpInIt(
2641 ICmpInst *ICI, IRBuilder<> &Builder, const TargetTransformInfo &TTI,
2642 const DataLayout *TD) {
Chris Lattner61c77442010-12-13 03:18:54 +00002643 BasicBlock *BB = ICI->getParent();
Devang Patela23812c2011-05-18 18:28:48 +00002644
Chris Lattner61c77442010-12-13 03:18:54 +00002645 // If the block has any PHIs in it or the icmp has multiple uses, it is too
2646 // complex.
2647 if (isa<PHINode>(BB->begin()) || !ICI->hasOneUse()) return false;
2648
2649 Value *V = ICI->getOperand(0);
2650 ConstantInt *Cst = cast<ConstantInt>(ICI->getOperand(1));
Andrew Trick6b014382012-08-29 21:46:36 +00002651
Chris Lattner61c77442010-12-13 03:18:54 +00002652 // The pattern we're looking for is where our only predecessor is a switch on
2653 // 'V' and this block is the default case for the switch. In this case we can
2654 // fold the compared value into the switch to simplify things.
2655 BasicBlock *Pred = BB->getSinglePredecessor();
2656 if (Pred == 0 || !isa<SwitchInst>(Pred->getTerminator())) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002657
Chris Lattner61c77442010-12-13 03:18:54 +00002658 SwitchInst *SI = cast<SwitchInst>(Pred->getTerminator());
2659 if (SI->getCondition() != V)
2660 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002661
Chris Lattner61c77442010-12-13 03:18:54 +00002662 // If BB is reachable on a non-default case, then we simply know the value of
2663 // V in this block. Substitute it and constant fold the icmp instruction
2664 // away.
2665 if (SI->getDefaultDest() != BB) {
2666 ConstantInt *VVal = SI->findCaseDest(BB);
2667 assert(VVal && "Should have a unique destination value");
2668 ICI->setOperand(0, VVal);
Andrew Trick6b014382012-08-29 21:46:36 +00002669
Chris Lattner302ba6f2010-12-14 06:17:25 +00002670 if (Value *V = SimplifyInstruction(ICI, TD)) {
2671 ICI->replaceAllUsesWith(V);
Chris Lattner61c77442010-12-13 03:18:54 +00002672 ICI->eraseFromParent();
2673 }
2674 // BB is now empty, so it is likely to simplify away.
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00002675 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner61c77442010-12-13 03:18:54 +00002676 }
Andrew Trick6b014382012-08-29 21:46:36 +00002677
Chris Lattnerabf70672010-12-13 03:43:57 +00002678 // Ok, the block is reachable from the default dest. If the constant we're
2679 // comparing exists in one of the other edges, then we can constant fold ICI
2680 // and zap it.
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002681 if (SI->findCaseValue(Cst) != SI->case_default()) {
Chris Lattnerabf70672010-12-13 03:43:57 +00002682 Value *V;
2683 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
2684 V = ConstantInt::getFalse(BB->getContext());
2685 else
2686 V = ConstantInt::getTrue(BB->getContext());
Andrew Trick6b014382012-08-29 21:46:36 +00002687
Chris Lattnerabf70672010-12-13 03:43:57 +00002688 ICI->replaceAllUsesWith(V);
2689 ICI->eraseFromParent();
2690 // BB is now empty, so it is likely to simplify away.
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00002691 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattnerabf70672010-12-13 03:43:57 +00002692 }
Andrew Trick6b014382012-08-29 21:46:36 +00002693
Chris Lattner61c77442010-12-13 03:18:54 +00002694 // The use of the icmp has to be in the 'end' block, by the only PHI node in
2695 // the block.
2696 BasicBlock *SuccBlock = BB->getTerminator()->getSuccessor(0);
2697 PHINode *PHIUse = dyn_cast<PHINode>(ICI->use_back());
2698 if (PHIUse == 0 || PHIUse != &SuccBlock->front() ||
2699 isa<PHINode>(++BasicBlock::iterator(PHIUse)))
2700 return false;
2701
2702 // If the icmp is a SETEQ, then the default dest gets false, the new edge gets
2703 // true in the PHI.
2704 Constant *DefaultCst = ConstantInt::getTrue(BB->getContext());
2705 Constant *NewCst = ConstantInt::getFalse(BB->getContext());
2706
2707 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
2708 std::swap(DefaultCst, NewCst);
2709
2710 // Replace ICI (which is used by the PHI for the default value) with true or
2711 // false depending on if it is EQ or NE.
2712 ICI->replaceAllUsesWith(DefaultCst);
2713 ICI->eraseFromParent();
2714
2715 // Okay, the switch goes to this block on a default value. Add an edge from
2716 // the switch to the merge point on the compared value.
2717 BasicBlock *NewBB = BasicBlock::Create(BB->getContext(), "switch.edge",
2718 BB->getParent(), BB);
Manman Renb0102772012-09-17 23:07:43 +00002719 SmallVector<uint64_t, 8> Weights;
2720 bool HasWeights = HasBranchWeights(SI);
2721 if (HasWeights) {
2722 GetBranchWeights(SI, Weights);
2723 if (Weights.size() == 1 + SI->getNumCases()) {
2724 // Split weight for default case to case for "Cst".
2725 Weights[0] = (Weights[0]+1) >> 1;
2726 Weights.push_back(Weights[0]);
2727
2728 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
2729 SI->setMetadata(LLVMContext::MD_prof,
2730 MDBuilder(SI->getContext()).
2731 createBranchWeights(MDWeights));
2732 }
2733 }
Chris Lattner61c77442010-12-13 03:18:54 +00002734 SI->addCase(Cst, NewBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002735
Chris Lattner61c77442010-12-13 03:18:54 +00002736 // NewBB branches to the phi block, add the uncond branch and the phi entry.
Devang Patela23812c2011-05-18 18:28:48 +00002737 Builder.SetInsertPoint(NewBB);
2738 Builder.SetCurrentDebugLocation(SI->getDebugLoc());
2739 Builder.CreateBr(SuccBlock);
Chris Lattner61c77442010-12-13 03:18:54 +00002740 PHIUse->addIncoming(NewCst, NewBB);
2741 return true;
2742}
2743
Chris Lattner97fdb892010-12-13 05:03:41 +00002744/// SimplifyBranchOnICmpChain - The specified branch is a conditional branch.
2745/// Check to see if it is branching on an or/and chain of icmp instructions, and
2746/// fold it into a switch instruction if so.
Micah Villmow3574eca2012-10-08 16:38:25 +00002747static bool SimplifyBranchOnICmpChain(BranchInst *BI, const DataLayout *TD,
Devang Patel02dd5412011-05-18 23:18:47 +00002748 IRBuilder<> &Builder) {
Chris Lattner97fdb892010-12-13 05:03:41 +00002749 Instruction *Cond = dyn_cast<Instruction>(BI->getCondition());
2750 if (Cond == 0) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002751
2752
Chris Lattner97fdb892010-12-13 05:03:41 +00002753 // Change br (X == 0 | X == 1), T, F into a switch instruction.
2754 // If this is a bunch of seteq's or'd together, or if it's a bunch of
2755 // 'setne's and'ed together, collect them.
2756 Value *CompVal = 0;
2757 std::vector<ConstantInt*> Values;
2758 bool TrueWhenEqual = true;
2759 Value *ExtraCase = 0;
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002760 unsigned UsedICmps = 0;
Andrew Trick6b014382012-08-29 21:46:36 +00002761
Chris Lattner97fdb892010-12-13 05:03:41 +00002762 if (Cond->getOpcode() == Instruction::Or) {
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002763 CompVal = GatherConstantCompares(Cond, Values, ExtraCase, TD, true,
2764 UsedICmps);
Chris Lattner97fdb892010-12-13 05:03:41 +00002765 } else if (Cond->getOpcode() == Instruction::And) {
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002766 CompVal = GatherConstantCompares(Cond, Values, ExtraCase, TD, false,
2767 UsedICmps);
Chris Lattner97fdb892010-12-13 05:03:41 +00002768 TrueWhenEqual = false;
2769 }
Andrew Trick6b014382012-08-29 21:46:36 +00002770
Chris Lattner97fdb892010-12-13 05:03:41 +00002771 // If we didn't have a multiply compared value, fail.
2772 if (CompVal == 0) return false;
2773
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002774 // Avoid turning single icmps into a switch.
2775 if (UsedICmps <= 1)
2776 return false;
2777
Chris Lattner97fdb892010-12-13 05:03:41 +00002778 // There might be duplicate constants in the list, which the switch
2779 // instruction can't handle, remove them now.
2780 array_pod_sort(Values.begin(), Values.end(), ConstantIntSortPredicate);
2781 Values.erase(std::unique(Values.begin(), Values.end()), Values.end());
Andrew Trick6b014382012-08-29 21:46:36 +00002782
Chris Lattner97fdb892010-12-13 05:03:41 +00002783 // If Extra was used, we require at least two switch values to do the
2784 // transformation. A switch with one value is just an cond branch.
2785 if (ExtraCase && Values.size() < 2) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002786
Andrew Trickb1b97832012-08-29 21:46:38 +00002787 // TODO: Preserve branch weight metadata, similarly to how
2788 // FoldValueComparisonIntoPredecessors preserves it.
2789
Chris Lattner97fdb892010-12-13 05:03:41 +00002790 // Figure out which block is which destination.
2791 BasicBlock *DefaultBB = BI->getSuccessor(1);
2792 BasicBlock *EdgeBB = BI->getSuccessor(0);
2793 if (!TrueWhenEqual) std::swap(DefaultBB, EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002794
Chris Lattner97fdb892010-12-13 05:03:41 +00002795 BasicBlock *BB = BI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002796
Chris Lattner302ba6f2010-12-14 06:17:25 +00002797 DEBUG(dbgs() << "Converting 'icmp' chain with " << Values.size()
Chris Lattner117f8cf2010-12-14 05:57:30 +00002798 << " cases into SWITCH. BB is:\n" << *BB);
Andrew Trick6b014382012-08-29 21:46:36 +00002799
Chris Lattner97fdb892010-12-13 05:03:41 +00002800 // If there are any extra values that couldn't be folded into the switch
2801 // then we evaluate them with an explicit branch first. Split the block
2802 // right before the condbr to handle it.
2803 if (ExtraCase) {
2804 BasicBlock *NewBB = BB->splitBasicBlock(BI, "switch.early.test");
2805 // Remove the uncond branch added to the old block.
2806 TerminatorInst *OldTI = BB->getTerminator();
Devang Patel02dd5412011-05-18 23:18:47 +00002807 Builder.SetInsertPoint(OldTI);
2808
Chris Lattner117f8cf2010-12-14 05:57:30 +00002809 if (TrueWhenEqual)
Devang Patel02dd5412011-05-18 23:18:47 +00002810 Builder.CreateCondBr(ExtraCase, EdgeBB, NewBB);
Chris Lattner117f8cf2010-12-14 05:57:30 +00002811 else
Devang Patel02dd5412011-05-18 23:18:47 +00002812 Builder.CreateCondBr(ExtraCase, NewBB, EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002813
Chris Lattner97fdb892010-12-13 05:03:41 +00002814 OldTI->eraseFromParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002815
Chris Lattner97bd89e2010-12-13 05:34:18 +00002816 // If there are PHI nodes in EdgeBB, then we need to add a new entry to them
2817 // for the edge we just added.
Chris Lattner6de0a282010-12-14 07:09:42 +00002818 AddPredecessorToBlock(EdgeBB, BB, NewBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002819
Chris Lattner302ba6f2010-12-14 06:17:25 +00002820 DEBUG(dbgs() << " ** 'icmp' chain unhandled condition: " << *ExtraCase
2821 << "\nEXTRABB = " << *BB);
Chris Lattner97fdb892010-12-13 05:03:41 +00002822 BB = NewBB;
2823 }
Devang Patel02dd5412011-05-18 23:18:47 +00002824
2825 Builder.SetInsertPoint(BI);
Chris Lattner97fdb892010-12-13 05:03:41 +00002826 // Convert pointer to int before we switch.
2827 if (CompVal->getType()->isPointerTy()) {
Micah Villmow3574eca2012-10-08 16:38:25 +00002828 assert(TD && "Cannot switch on pointer without DataLayout");
Devang Patel02dd5412011-05-18 23:18:47 +00002829 CompVal = Builder.CreatePtrToInt(CompVal,
Chandler Carruthece6c6b2012-11-01 08:07:29 +00002830 TD->getIntPtrType(CompVal->getContext()),
Devang Patel02dd5412011-05-18 23:18:47 +00002831 "magicptr");
Chris Lattner97fdb892010-12-13 05:03:41 +00002832 }
Andrew Trick6b014382012-08-29 21:46:36 +00002833
Chris Lattner97fdb892010-12-13 05:03:41 +00002834 // Create the new switch instruction now.
Devang Patel02dd5412011-05-18 23:18:47 +00002835 SwitchInst *New = Builder.CreateSwitch(CompVal, DefaultBB, Values.size());
Devang Pateld80e8ed2011-05-17 23:29:05 +00002836
Chris Lattner97fdb892010-12-13 05:03:41 +00002837 // Add all of the 'cases' to the switch instruction.
2838 for (unsigned i = 0, e = Values.size(); i != e; ++i)
2839 New->addCase(Values[i], EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002840
Chris Lattner97fdb892010-12-13 05:03:41 +00002841 // We added edges from PI to the EdgeBB. As such, if there were any
2842 // PHI nodes in EdgeBB, they need entries to be added corresponding to
2843 // the number of edges added.
2844 for (BasicBlock::iterator BBI = EdgeBB->begin();
2845 isa<PHINode>(BBI); ++BBI) {
2846 PHINode *PN = cast<PHINode>(BBI);
2847 Value *InVal = PN->getIncomingValueForBlock(BB);
2848 for (unsigned i = 0, e = Values.size()-1; i != e; ++i)
2849 PN->addIncoming(InVal, BB);
2850 }
Andrew Trick6b014382012-08-29 21:46:36 +00002851
Chris Lattner97fdb892010-12-13 05:03:41 +00002852 // Erase the old branch instruction.
2853 EraseTerminatorInstAndDCECond(BI);
Andrew Trick6b014382012-08-29 21:46:36 +00002854
Chris Lattner302ba6f2010-12-14 06:17:25 +00002855 DEBUG(dbgs() << " ** 'icmp' chain result is:\n" << *BB << '\n');
Chris Lattner97fdb892010-12-13 05:03:41 +00002856 return true;
2857}
2858
Duncan Sandsad99ef82011-09-05 12:57:57 +00002859bool SimplifyCFGOpt::SimplifyResume(ResumeInst *RI, IRBuilder<> &Builder) {
2860 // If this is a trivial landing pad that just continues unwinding the caught
2861 // exception then zap the landing pad, turning its invokes into calls.
2862 BasicBlock *BB = RI->getParent();
2863 LandingPadInst *LPInst = dyn_cast<LandingPadInst>(BB->getFirstNonPHI());
2864 if (RI->getValue() != LPInst)
2865 // Not a landing pad, or the resume is not unwinding the exception that
2866 // caused control to branch here.
2867 return false;
2868
2869 // Check that there are no other instructions except for debug intrinsics.
2870 BasicBlock::iterator I = LPInst, E = RI;
2871 while (++I != E)
2872 if (!isa<DbgInfoIntrinsic>(I))
2873 return false;
2874
2875 // Turn all invokes that unwind here into calls and delete the basic block.
Bill Wendlingd5bb2082013-03-11 20:53:00 +00002876 bool InvokeRequiresTableEntry = false;
2877 bool Changed = false;
Duncan Sandsad99ef82011-09-05 12:57:57 +00002878 for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE;) {
2879 InvokeInst *II = cast<InvokeInst>((*PI++)->getTerminator());
Bill Wendlingd5bb2082013-03-11 20:53:00 +00002880
2881 if (II->hasFnAttr(Attribute::UWTable)) {
2882 // Don't remove an `invoke' instruction if the ABI requires an entry into
2883 // the table.
2884 InvokeRequiresTableEntry = true;
2885 continue;
2886 }
2887
Duncan Sandsad99ef82011-09-05 12:57:57 +00002888 SmallVector<Value*, 8> Args(II->op_begin(), II->op_end() - 3);
Bill Wendlingd5bb2082013-03-11 20:53:00 +00002889
Duncan Sandsad99ef82011-09-05 12:57:57 +00002890 // Insert a call instruction before the invoke.
2891 CallInst *Call = CallInst::Create(II->getCalledValue(), Args, "", II);
2892 Call->takeName(II);
2893 Call->setCallingConv(II->getCallingConv());
2894 Call->setAttributes(II->getAttributes());
2895 Call->setDebugLoc(II->getDebugLoc());
2896
2897 // Anything that used the value produced by the invoke instruction now uses
2898 // the value produced by the call instruction. Note that we do this even
2899 // for void functions and calls with no uses so that the callgraph edge is
2900 // updated.
2901 II->replaceAllUsesWith(Call);
2902 BB->removePredecessor(II->getParent());
2903
2904 // Insert a branch to the normal destination right before the invoke.
2905 BranchInst::Create(II->getNormalDest(), II);
2906
2907 // Finally, delete the invoke instruction!
2908 II->eraseFromParent();
Bill Wendlingd5bb2082013-03-11 20:53:00 +00002909 Changed = true;
Duncan Sandsad99ef82011-09-05 12:57:57 +00002910 }
2911
Bill Wendlingd5bb2082013-03-11 20:53:00 +00002912 if (!InvokeRequiresTableEntry)
2913 // The landingpad is now unreachable. Zap it.
2914 BB->eraseFromParent();
2915
2916 return Changed;
Duncan Sandsad99ef82011-09-05 12:57:57 +00002917}
2918
Devang Patel176ec402011-05-18 21:33:11 +00002919bool SimplifyCFGOpt::SimplifyReturn(ReturnInst *RI, IRBuilder<> &Builder) {
Chris Lattner3d512132010-12-13 06:25:44 +00002920 BasicBlock *BB = RI->getParent();
2921 if (!BB->getFirstNonPHIOrDbg()->isTerminator()) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002922
Chris Lattner3d512132010-12-13 06:25:44 +00002923 // Find predecessors that end with branches.
2924 SmallVector<BasicBlock*, 8> UncondBranchPreds;
2925 SmallVector<BranchInst*, 8> CondBranchPreds;
2926 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
2927 BasicBlock *P = *PI;
2928 TerminatorInst *PTI = P->getTerminator();
2929 if (BranchInst *BI = dyn_cast<BranchInst>(PTI)) {
2930 if (BI->isUnconditional())
2931 UncondBranchPreds.push_back(P);
2932 else
2933 CondBranchPreds.push_back(BI);
2934 }
2935 }
Andrew Trick6b014382012-08-29 21:46:36 +00002936
Chris Lattner3d512132010-12-13 06:25:44 +00002937 // If we found some, do the transformation!
Evan Chengc3f507f2011-01-29 04:46:23 +00002938 if (!UncondBranchPreds.empty() && DupRet) {
Chris Lattner3d512132010-12-13 06:25:44 +00002939 while (!UncondBranchPreds.empty()) {
2940 BasicBlock *Pred = UncondBranchPreds.pop_back_val();
2941 DEBUG(dbgs() << "FOLDING: " << *BB
2942 << "INTO UNCOND BRANCH PRED: " << *Pred);
Evan Chengc3f507f2011-01-29 04:46:23 +00002943 (void)FoldReturnIntoUncondBranch(RI, BB, Pred);
Chris Lattner3d512132010-12-13 06:25:44 +00002944 }
Andrew Trick6b014382012-08-29 21:46:36 +00002945
Chris Lattner3d512132010-12-13 06:25:44 +00002946 // If we eliminated all predecessors of the block, delete the block now.
2947 if (pred_begin(BB) == pred_end(BB))
2948 // We know there are no successors, so just nuke the block.
2949 BB->eraseFromParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002950
Chris Lattner3d512132010-12-13 06:25:44 +00002951 return true;
2952 }
Andrew Trick6b014382012-08-29 21:46:36 +00002953
Chris Lattner3d512132010-12-13 06:25:44 +00002954 // Check out all of the conditional branches going to this return
2955 // instruction. If any of them just select between returns, change the
2956 // branch itself into a select/return pair.
2957 while (!CondBranchPreds.empty()) {
2958 BranchInst *BI = CondBranchPreds.pop_back_val();
Andrew Trick6b014382012-08-29 21:46:36 +00002959
Chris Lattner3d512132010-12-13 06:25:44 +00002960 // Check to see if the non-BB successor is also a return block.
2961 if (isa<ReturnInst>(BI->getSuccessor(0)->getTerminator()) &&
2962 isa<ReturnInst>(BI->getSuccessor(1)->getTerminator()) &&
Devang Patel176ec402011-05-18 21:33:11 +00002963 SimplifyCondBranchToTwoReturns(BI, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00002964 return true;
2965 }
2966 return false;
2967}
2968
Chris Lattner3d512132010-12-13 06:25:44 +00002969bool SimplifyCFGOpt::SimplifyUnreachable(UnreachableInst *UI) {
2970 BasicBlock *BB = UI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002971
Chris Lattner3d512132010-12-13 06:25:44 +00002972 bool Changed = false;
Andrew Trick6b014382012-08-29 21:46:36 +00002973
Chris Lattner3d512132010-12-13 06:25:44 +00002974 // If there are any instructions immediately before the unreachable that can
2975 // be removed, do so.
2976 while (UI != BB->begin()) {
2977 BasicBlock::iterator BBI = UI;
2978 --BBI;
Eli Friedman81763882011-08-15 23:59:28 +00002979 // Do not delete instructions that can have side effects which might cause
2980 // the unreachable to not be reachable; specifically, calls and volatile
2981 // operations may have this effect.
Chris Lattner3d512132010-12-13 06:25:44 +00002982 if (isa<CallInst>(BBI) && !isa<DbgInfoIntrinsic>(BBI)) break;
Eli Friedman81763882011-08-15 23:59:28 +00002983
2984 if (BBI->mayHaveSideEffects()) {
2985 if (StoreInst *SI = dyn_cast<StoreInst>(BBI)) {
2986 if (SI->isVolatile())
2987 break;
2988 } else if (LoadInst *LI = dyn_cast<LoadInst>(BBI)) {
2989 if (LI->isVolatile())
2990 break;
2991 } else if (AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(BBI)) {
2992 if (RMWI->isVolatile())
2993 break;
2994 } else if (AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(BBI)) {
2995 if (CXI->isVolatile())
2996 break;
2997 } else if (!isa<FenceInst>(BBI) && !isa<VAArgInst>(BBI) &&
2998 !isa<LandingPadInst>(BBI)) {
Chris Lattner3d512132010-12-13 06:25:44 +00002999 break;
Eli Friedman81763882011-08-15 23:59:28 +00003000 }
Bill Wendling23b49ba2011-08-16 20:41:17 +00003001 // Note that deleting LandingPad's here is in fact okay, although it
3002 // involves a bit of subtle reasoning. If this inst is a LandingPad,
3003 // all the predecessors of this block will be the unwind edges of Invokes,
3004 // and we can therefore guarantee this block will be erased.
Eli Friedman81763882011-08-15 23:59:28 +00003005 }
3006
Eli Friedman2adc5b62011-03-09 00:48:33 +00003007 // Delete this instruction (any uses are guaranteed to be dead)
3008 if (!BBI->use_empty())
3009 BBI->replaceAllUsesWith(UndefValue::get(BBI->getType()));
Chris Lattner302ba6f2010-12-14 06:17:25 +00003010 BBI->eraseFromParent();
Chris Lattner3d512132010-12-13 06:25:44 +00003011 Changed = true;
3012 }
Andrew Trick6b014382012-08-29 21:46:36 +00003013
Chris Lattner3d512132010-12-13 06:25:44 +00003014 // If the unreachable instruction is the first in the block, take a gander
3015 // at all of the predecessors of this instruction, and simplify them.
3016 if (&BB->front() != UI) return Changed;
Andrew Trick6b014382012-08-29 21:46:36 +00003017
Chris Lattner3d512132010-12-13 06:25:44 +00003018 SmallVector<BasicBlock*, 8> Preds(pred_begin(BB), pred_end(BB));
3019 for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
3020 TerminatorInst *TI = Preds[i]->getTerminator();
Devang Patel1aa89a22011-05-19 00:09:21 +00003021 IRBuilder<> Builder(TI);
Chris Lattner3d512132010-12-13 06:25:44 +00003022 if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
3023 if (BI->isUnconditional()) {
3024 if (BI->getSuccessor(0) == BB) {
3025 new UnreachableInst(TI->getContext(), TI);
3026 TI->eraseFromParent();
3027 Changed = true;
3028 }
3029 } else {
3030 if (BI->getSuccessor(0) == BB) {
Devang Patel1aa89a22011-05-19 00:09:21 +00003031 Builder.CreateBr(BI->getSuccessor(1));
Chris Lattner3d512132010-12-13 06:25:44 +00003032 EraseTerminatorInstAndDCECond(BI);
3033 } else if (BI->getSuccessor(1) == BB) {
Devang Patel1aa89a22011-05-19 00:09:21 +00003034 Builder.CreateBr(BI->getSuccessor(0));
Chris Lattner3d512132010-12-13 06:25:44 +00003035 EraseTerminatorInstAndDCECond(BI);
3036 Changed = true;
3037 }
3038 }
3039 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003040 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003041 i != e; ++i)
3042 if (i.getCaseSuccessor() == BB) {
Chris Lattner3d512132010-12-13 06:25:44 +00003043 BB->removePredecessor(SI->getParent());
3044 SI->removeCase(i);
3045 --i; --e;
3046 Changed = true;
3047 }
3048 // If the default value is unreachable, figure out the most popular
3049 // destination and make it the default.
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003050 if (SI->getDefaultDest() == BB) {
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003051 std::map<BasicBlock*, std::pair<unsigned, unsigned> > Popularity;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003052 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003053 i != e; ++i) {
Nick Lewycky9d523102011-12-26 20:37:40 +00003054 std::pair<unsigned, unsigned> &entry =
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003055 Popularity[i.getCaseSuccessor()];
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003056 if (entry.first == 0) {
3057 entry.first = 1;
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003058 entry.second = i.getCaseIndex();
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003059 } else {
3060 entry.first++;
3061 }
3062 }
3063
Chris Lattner3d512132010-12-13 06:25:44 +00003064 // Find the most popular block.
3065 unsigned MaxPop = 0;
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003066 unsigned MaxIndex = 0;
Chris Lattner3d512132010-12-13 06:25:44 +00003067 BasicBlock *MaxBlock = 0;
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003068 for (std::map<BasicBlock*, std::pair<unsigned, unsigned> >::iterator
Chris Lattner3d512132010-12-13 06:25:44 +00003069 I = Popularity.begin(), E = Popularity.end(); I != E; ++I) {
Andrew Trick6b014382012-08-29 21:46:36 +00003070 if (I->second.first > MaxPop ||
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003071 (I->second.first == MaxPop && MaxIndex > I->second.second)) {
3072 MaxPop = I->second.first;
3073 MaxIndex = I->second.second;
Chris Lattner3d512132010-12-13 06:25:44 +00003074 MaxBlock = I->first;
3075 }
3076 }
3077 if (MaxBlock) {
3078 // Make this the new default, allowing us to delete any explicit
3079 // edges to it.
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003080 SI->setDefaultDest(MaxBlock);
Chris Lattner3d512132010-12-13 06:25:44 +00003081 Changed = true;
Andrew Trick6b014382012-08-29 21:46:36 +00003082
Chris Lattner3d512132010-12-13 06:25:44 +00003083 // If MaxBlock has phinodes in it, remove MaxPop-1 entries from
3084 // it.
3085 if (isa<PHINode>(MaxBlock->begin()))
3086 for (unsigned i = 0; i != MaxPop-1; ++i)
3087 MaxBlock->removePredecessor(SI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00003088
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003089 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003090 i != e; ++i)
3091 if (i.getCaseSuccessor() == MaxBlock) {
Chris Lattner3d512132010-12-13 06:25:44 +00003092 SI->removeCase(i);
3093 --i; --e;
3094 }
3095 }
3096 }
3097 } else if (InvokeInst *II = dyn_cast<InvokeInst>(TI)) {
3098 if (II->getUnwindDest() == BB) {
3099 // Convert the invoke to a call instruction. This would be a good
3100 // place to note that the call does not throw though.
Devang Patel1aa89a22011-05-19 00:09:21 +00003101 BranchInst *BI = Builder.CreateBr(II->getNormalDest());
Chris Lattner3d512132010-12-13 06:25:44 +00003102 II->removeFromParent(); // Take out of symbol table
Andrew Trick6b014382012-08-29 21:46:36 +00003103
Chris Lattner3d512132010-12-13 06:25:44 +00003104 // Insert the call now...
3105 SmallVector<Value*, 8> Args(II->op_begin(), II->op_end()-3);
Devang Patel1aa89a22011-05-19 00:09:21 +00003106 Builder.SetInsertPoint(BI);
3107 CallInst *CI = Builder.CreateCall(II->getCalledValue(),
Jay Foada3efbb12011-07-15 08:37:34 +00003108 Args, II->getName());
Chris Lattner3d512132010-12-13 06:25:44 +00003109 CI->setCallingConv(II->getCallingConv());
3110 CI->setAttributes(II->getAttributes());
3111 // If the invoke produced a value, the call does now instead.
3112 II->replaceAllUsesWith(CI);
3113 delete II;
3114 Changed = true;
3115 }
3116 }
3117 }
Andrew Trick6b014382012-08-29 21:46:36 +00003118
Chris Lattner3d512132010-12-13 06:25:44 +00003119 // If this block is now dead, remove it.
3120 if (pred_begin(BB) == pred_end(BB) &&
3121 BB != &BB->getParent()->getEntryBlock()) {
3122 // We know there are no successors, so just nuke the block.
3123 BB->eraseFromParent();
3124 return true;
3125 }
3126
3127 return Changed;
3128}
3129
Benjamin Kramer56442df2011-02-02 15:56:22 +00003130/// TurnSwitchRangeIntoICmp - Turns a switch with that contains only a
3131/// integer range comparison into a sub, an icmp and a branch.
Devang Patel007349d2011-05-18 20:35:38 +00003132static bool TurnSwitchRangeIntoICmp(SwitchInst *SI, IRBuilder<> &Builder) {
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003133 assert(SI->getNumCases() > 1 && "Degenerate switch?");
Benjamin Kramer56442df2011-02-02 15:56:22 +00003134
Benjamin Kramer042b27f2011-02-03 22:51:41 +00003135 // Make sure all cases point to the same destination and gather the values.
3136 SmallVector<ConstantInt *, 16> Cases;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003137 SwitchInst::CaseIt I = SI->case_begin();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003138 Cases.push_back(I.getCaseValue());
3139 SwitchInst::CaseIt PrevI = I++;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003140 for (SwitchInst::CaseIt E = SI->case_end(); I != E; PrevI = I++) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003141 if (PrevI.getCaseSuccessor() != I.getCaseSuccessor())
Benjamin Kramer042b27f2011-02-03 22:51:41 +00003142 return false;
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003143 Cases.push_back(I.getCaseValue());
Benjamin Kramer042b27f2011-02-03 22:51:41 +00003144 }
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003145 assert(Cases.size() == SI->getNumCases() && "Not all cases gathered");
Benjamin Kramer042b27f2011-02-03 22:51:41 +00003146
3147 // Sort the case values, then check if they form a range we can transform.
3148 array_pod_sort(Cases.begin(), Cases.end(), ConstantIntSortPredicate);
3149 for (unsigned I = 1, E = Cases.size(); I != E; ++I) {
3150 if (Cases[I-1]->getValue() != Cases[I]->getValue()+1)
3151 return false;
3152 }
3153
3154 Constant *Offset = ConstantExpr::getNeg(Cases.back());
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003155 Constant *NumCases = ConstantInt::get(Offset->getType(), SI->getNumCases());
Benjamin Kramer56442df2011-02-02 15:56:22 +00003156
Benjamin Kramer33828bc2011-02-07 22:37:28 +00003157 Value *Sub = SI->getCondition();
3158 if (!Offset->isNullValue())
Devang Patel1f5812b2011-05-19 00:13:33 +00003159 Sub = Builder.CreateAdd(Sub, Offset, Sub->getName()+".off");
Hans Wennborga121e242013-04-16 08:35:36 +00003160 Value *Cmp;
3161 // If NumCases overflowed, then all possible values jump to the successor.
3162 if (NumCases->isNullValue() && SI->getNumCases() != 0)
3163 Cmp = ConstantInt::getTrue(SI->getContext());
3164 else
3165 Cmp = Builder.CreateICmpULT(Sub, NumCases, "switch");
Manman Ren222d6192012-09-18 00:47:33 +00003166 BranchInst *NewBI = Builder.CreateCondBr(
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003167 Cmp, SI->case_begin().getCaseSuccessor(), SI->getDefaultDest());
Benjamin Kramer56442df2011-02-02 15:56:22 +00003168
Manman Ren222d6192012-09-18 00:47:33 +00003169 // Update weight for the newly-created conditional branch.
3170 SmallVector<uint64_t, 8> Weights;
3171 bool HasWeights = HasBranchWeights(SI);
3172 if (HasWeights) {
3173 GetBranchWeights(SI, Weights);
3174 if (Weights.size() == 1 + SI->getNumCases()) {
3175 // Combine all weights for the cases to be the true weight of NewBI.
3176 // We assume that the sum of all weights for a Terminator can fit into 32
3177 // bits.
3178 uint32_t NewTrueWeight = 0;
3179 for (unsigned I = 1, E = Weights.size(); I != E; ++I)
3180 NewTrueWeight += (uint32_t)Weights[I];
3181 NewBI->setMetadata(LLVMContext::MD_prof,
3182 MDBuilder(SI->getContext()).
3183 createBranchWeights(NewTrueWeight,
3184 (uint32_t)Weights[0]));
3185 }
3186 }
3187
Benjamin Kramer56442df2011-02-02 15:56:22 +00003188 // Prune obsolete incoming values off the successor's PHI nodes.
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003189 for (BasicBlock::iterator BBI = SI->case_begin().getCaseSuccessor()->begin();
Benjamin Kramer56442df2011-02-02 15:56:22 +00003190 isa<PHINode>(BBI); ++BBI) {
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003191 for (unsigned I = 0, E = SI->getNumCases()-1; I != E; ++I)
Benjamin Kramer56442df2011-02-02 15:56:22 +00003192 cast<PHINode>(BBI)->removeIncomingValue(SI->getParent());
3193 }
3194 SI->eraseFromParent();
3195
3196 return true;
3197}
Chris Lattner3d512132010-12-13 06:25:44 +00003198
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003199/// EliminateDeadSwitchCases - Compute masked bits for the condition of a switch
3200/// and use it to remove dead cases.
3201static bool EliminateDeadSwitchCases(SwitchInst *SI) {
3202 Value *Cond = SI->getCondition();
3203 unsigned Bits = cast<IntegerType>(Cond->getType())->getBitWidth();
3204 APInt KnownZero(Bits, 0), KnownOne(Bits, 0);
Rafael Espindola26c8dcc2012-04-04 12:51:34 +00003205 ComputeMaskedBits(Cond, KnownZero, KnownOne);
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003206
3207 // Gather dead cases.
3208 SmallVector<ConstantInt*, 8> DeadCases;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003209 for (SwitchInst::CaseIt I = SI->case_begin(), E = SI->case_end(); I != E; ++I) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003210 if ((I.getCaseValue()->getValue() & KnownZero) != 0 ||
3211 (I.getCaseValue()->getValue() & KnownOne) != KnownOne) {
3212 DeadCases.push_back(I.getCaseValue());
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003213 DEBUG(dbgs() << "SimplifyCFG: switch case '"
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003214 << I.getCaseValue() << "' is dead.\n");
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003215 }
3216 }
3217
Manman Ren222d6192012-09-18 00:47:33 +00003218 SmallVector<uint64_t, 8> Weights;
3219 bool HasWeight = HasBranchWeights(SI);
3220 if (HasWeight) {
3221 GetBranchWeights(SI, Weights);
3222 HasWeight = (Weights.size() == 1 + SI->getNumCases());
3223 }
3224
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003225 // Remove dead cases from the switch.
3226 for (unsigned I = 0, E = DeadCases.size(); I != E; ++I) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003227 SwitchInst::CaseIt Case = SI->findCaseValue(DeadCases[I]);
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003228 assert(Case != SI->case_default() &&
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003229 "Case was not found. Probably mistake in DeadCases forming.");
Manman Ren222d6192012-09-18 00:47:33 +00003230 if (HasWeight) {
3231 std::swap(Weights[Case.getCaseIndex()+1], Weights.back());
3232 Weights.pop_back();
3233 }
3234
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003235 // Prune unused values from PHI nodes.
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003236 Case.getCaseSuccessor()->removePredecessor(SI->getParent());
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003237 SI->removeCase(Case);
3238 }
Manman Ren222d6192012-09-18 00:47:33 +00003239 if (HasWeight) {
3240 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
3241 SI->setMetadata(LLVMContext::MD_prof,
3242 MDBuilder(SI->getParent()->getContext()).
3243 createBranchWeights(MDWeights));
3244 }
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003245
3246 return !DeadCases.empty();
3247}
3248
Hans Wennborg448da512011-06-18 10:28:47 +00003249/// FindPHIForConditionForwarding - If BB would be eligible for simplification
3250/// by TryToSimplifyUncondBranchFromEmptyBlock (i.e. it is empty and terminated
3251/// by an unconditional branch), look at the phi node for BB in the successor
3252/// block and see if the incoming value is equal to CaseValue. If so, return
3253/// the phi node, and set PhiIndex to BB's index in the phi node.
3254static PHINode *FindPHIForConditionForwarding(ConstantInt *CaseValue,
3255 BasicBlock *BB,
3256 int *PhiIndex) {
3257 if (BB->getFirstNonPHIOrDbg() != BB->getTerminator())
3258 return NULL; // BB must be empty to be a candidate for simplification.
3259 if (!BB->getSinglePredecessor())
3260 return NULL; // BB must be dominated by the switch.
3261
3262 BranchInst *Branch = dyn_cast<BranchInst>(BB->getTerminator());
3263 if (!Branch || !Branch->isUnconditional())
3264 return NULL; // Terminator must be unconditional branch.
3265
3266 BasicBlock *Succ = Branch->getSuccessor(0);
3267
3268 BasicBlock::iterator I = Succ->begin();
3269 while (PHINode *PHI = dyn_cast<PHINode>(I++)) {
3270 int Idx = PHI->getBasicBlockIndex(BB);
3271 assert(Idx >= 0 && "PHI has no entry for predecessor?");
3272
3273 Value *InValue = PHI->getIncomingValue(Idx);
3274 if (InValue != CaseValue) continue;
3275
3276 *PhiIndex = Idx;
3277 return PHI;
3278 }
3279
3280 return NULL;
3281}
3282
3283/// ForwardSwitchConditionToPHI - Try to forward the condition of a switch
3284/// instruction to a phi node dominated by the switch, if that would mean that
3285/// some of the destination blocks of the switch can be folded away.
3286/// Returns true if a change is made.
3287static bool ForwardSwitchConditionToPHI(SwitchInst *SI) {
3288 typedef DenseMap<PHINode*, SmallVector<int,4> > ForwardingNodesMap;
3289 ForwardingNodesMap ForwardingNodes;
3290
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003291 for (SwitchInst::CaseIt I = SI->case_begin(), E = SI->case_end(); I != E; ++I) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003292 ConstantInt *CaseValue = I.getCaseValue();
3293 BasicBlock *CaseDest = I.getCaseSuccessor();
Hans Wennborg448da512011-06-18 10:28:47 +00003294
3295 int PhiIndex;
3296 PHINode *PHI = FindPHIForConditionForwarding(CaseValue, CaseDest,
3297 &PhiIndex);
3298 if (!PHI) continue;
3299
3300 ForwardingNodes[PHI].push_back(PhiIndex);
3301 }
3302
3303 bool Changed = false;
3304
3305 for (ForwardingNodesMap::iterator I = ForwardingNodes.begin(),
3306 E = ForwardingNodes.end(); I != E; ++I) {
3307 PHINode *Phi = I->first;
3308 SmallVector<int,4> &Indexes = I->second;
3309
3310 if (Indexes.size() < 2) continue;
3311
3312 for (size_t I = 0, E = Indexes.size(); I != E; ++I)
3313 Phi->setIncomingValue(Indexes[I], SI->getCondition());
3314 Changed = true;
3315 }
3316
3317 return Changed;
3318}
3319
Hans Wennborg486270a2012-09-06 09:43:28 +00003320/// ValidLookupTableConstant - Return true if the backend will be able to handle
3321/// initializing an array of constants like C.
Hans Wennborgbf015822012-09-07 08:22:57 +00003322static bool ValidLookupTableConstant(Constant *C) {
Hans Wennborg486270a2012-09-06 09:43:28 +00003323 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
3324 return CE->isGEPWithNoNotionalOverIndexing();
3325
3326 return isa<ConstantFP>(C) ||
3327 isa<ConstantInt>(C) ||
3328 isa<ConstantPointerNull>(C) ||
3329 isa<GlobalValue>(C) ||
3330 isa<UndefValue>(C);
3331}
3332
Hans Wennborgef026f12012-10-31 15:14:39 +00003333/// LookupConstant - If V is a Constant, return it. Otherwise, try to look up
Hans Wennborgdaf4cfc2012-10-31 15:31:09 +00003334/// its constant value in ConstantPool, returning 0 if it's not there.
Hans Wennborgef026f12012-10-31 15:14:39 +00003335static Constant *LookupConstant(Value *V,
3336 const SmallDenseMap<Value*, Constant*>& ConstantPool) {
3337 if (Constant *C = dyn_cast<Constant>(V))
3338 return C;
3339 return ConstantPool.lookup(V);
3340}
3341
Hans Wennborge03d9e42012-10-31 13:42:45 +00003342/// ConstantFold - Try to fold instruction I into a constant. This works for
3343/// simple instructions such as binary operations where both operands are
3344/// constant or can be replaced by constants from the ConstantPool. Returns the
Hans Wennborgdaf4cfc2012-10-31 15:31:09 +00003345/// resulting constant on success, 0 otherwise.
Hans Wennborgef026f12012-10-31 15:14:39 +00003346static Constant *ConstantFold(Instruction *I,
Hans Wennborge03d9e42012-10-31 13:42:45 +00003347 const SmallDenseMap<Value*, Constant*>& ConstantPool) {
3348 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(I)) {
Hans Wennborgef026f12012-10-31 15:14:39 +00003349 Constant *A = LookupConstant(BO->getOperand(0), ConstantPool);
3350 if (!A)
3351 return 0;
3352 Constant *B = LookupConstant(BO->getOperand(1), ConstantPool);
3353 if (!B)
3354 return 0;
3355 return ConstantExpr::get(BO->getOpcode(), A, B);
Hans Wennborge03d9e42012-10-31 13:42:45 +00003356 }
3357
3358 if (CmpInst *Cmp = dyn_cast<CmpInst>(I)) {
Hans Wennborgef026f12012-10-31 15:14:39 +00003359 Constant *A = LookupConstant(I->getOperand(0), ConstantPool);
3360 if (!A)
3361 return 0;
3362 Constant *B = LookupConstant(I->getOperand(1), ConstantPool);
3363 if (!B)
3364 return 0;
3365 return ConstantExpr::getCompare(Cmp->getPredicate(), A, B);
Hans Wennborge03d9e42012-10-31 13:42:45 +00003366 }
3367
3368 if (SelectInst *Select = dyn_cast<SelectInst>(I)) {
Hans Wennborgef026f12012-10-31 15:14:39 +00003369 Constant *A = LookupConstant(Select->getCondition(), ConstantPool);
3370 if (!A)
3371 return 0;
3372 if (A->isAllOnesValue())
3373 return LookupConstant(Select->getTrueValue(), ConstantPool);
3374 if (A->isNullValue())
3375 return LookupConstant(Select->getFalseValue(), ConstantPool);
Hans Wennborgdaf4cfc2012-10-31 15:31:09 +00003376 return 0;
Hans Wennborge03d9e42012-10-31 13:42:45 +00003377 }
3378
3379 if (CastInst *Cast = dyn_cast<CastInst>(I)) {
Hans Wennborgef026f12012-10-31 15:14:39 +00003380 Constant *A = LookupConstant(I->getOperand(0), ConstantPool);
3381 if (!A)
3382 return 0;
3383 return ConstantExpr::getCast(Cast->getOpcode(), A, Cast->getDestTy());
Hans Wennborge03d9e42012-10-31 13:42:45 +00003384 }
3385
Hans Wennborgef026f12012-10-31 15:14:39 +00003386 return 0;
Hans Wennborge03d9e42012-10-31 13:42:45 +00003387}
3388
3389/// GetCaseResults - Try to determine the resulting constant values in phi nodes
3390/// at the common destination basic block, *CommonDest, for one of the case
Hans Wennborgdaf4cfc2012-10-31 15:31:09 +00003391/// destionations CaseDest corresponding to value CaseVal (0 for the default
Hans Wennborge03d9e42012-10-31 13:42:45 +00003392/// case), of a switch instruction SI.
Hans Wennborg486270a2012-09-06 09:43:28 +00003393static bool GetCaseResults(SwitchInst *SI,
Hans Wennborge03d9e42012-10-31 13:42:45 +00003394 ConstantInt *CaseVal,
Hans Wennborg486270a2012-09-06 09:43:28 +00003395 BasicBlock *CaseDest,
3396 BasicBlock **CommonDest,
3397 SmallVector<std::pair<PHINode*,Constant*>, 4> &Res) {
3398 // The block from which we enter the common destination.
3399 BasicBlock *Pred = SI->getParent();
3400
Hans Wennborge03d9e42012-10-31 13:42:45 +00003401 // If CaseDest is empty except for some side-effect free instructions through
3402 // which we can constant-propagate the CaseVal, continue to its successor.
3403 SmallDenseMap<Value*, Constant*> ConstantPool;
3404 ConstantPool.insert(std::make_pair(SI->getCondition(), CaseVal));
3405 for (BasicBlock::iterator I = CaseDest->begin(), E = CaseDest->end(); I != E;
3406 ++I) {
3407 if (TerminatorInst *T = dyn_cast<TerminatorInst>(I)) {
3408 // If the terminator is a simple branch, continue to the next block.
3409 if (T->getNumSuccessors() != 1)
3410 return false;
3411 Pred = CaseDest;
3412 CaseDest = T->getSuccessor(0);
3413 } else if (isa<DbgInfoIntrinsic>(I)) {
3414 // Skip debug intrinsic.
3415 continue;
3416 } else if (Constant *C = ConstantFold(I, ConstantPool)) {
3417 // Instruction is side-effect free and constant.
3418 ConstantPool.insert(std::make_pair(I, C));
3419 } else {
3420 break;
3421 }
Hans Wennborg486270a2012-09-06 09:43:28 +00003422 }
3423
3424 // If we did not have a CommonDest before, use the current one.
3425 if (!*CommonDest)
3426 *CommonDest = CaseDest;
3427 // If the destination isn't the common one, abort.
3428 if (CaseDest != *CommonDest)
3429 return false;
3430
3431 // Get the values for this case from phi nodes in the destination block.
3432 BasicBlock::iterator I = (*CommonDest)->begin();
3433 while (PHINode *PHI = dyn_cast<PHINode>(I++)) {
3434 int Idx = PHI->getBasicBlockIndex(Pred);
3435 if (Idx == -1)
3436 continue;
3437
Hans Wennborgef026f12012-10-31 15:14:39 +00003438 Constant *ConstVal = LookupConstant(PHI->getIncomingValue(Idx),
3439 ConstantPool);
Hans Wennborge03d9e42012-10-31 13:42:45 +00003440 if (!ConstVal)
Hans Wennborg486270a2012-09-06 09:43:28 +00003441 return false;
3442
Hans Wennborge03d9e42012-10-31 13:42:45 +00003443 // Note: If the constant comes from constant-propagating the case value
3444 // through the CaseDest basic block, it will be safe to remove the
3445 // instructions in that block. They cannot be used (except in the phi nodes
3446 // we visit) outside CaseDest, because that block does not dominate its
3447 // successor. If it did, we would not be in this phi node.
3448
Hans Wennborg486270a2012-09-06 09:43:28 +00003449 // Be conservative about which kinds of constants we support.
3450 if (!ValidLookupTableConstant(ConstVal))
3451 return false;
3452
3453 Res.push_back(std::make_pair(PHI, ConstVal));
3454 }
3455
3456 return true;
3457}
3458
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003459namespace {
3460 /// SwitchLookupTable - This class represents a lookup table that can be used
3461 /// to replace a switch.
3462 class SwitchLookupTable {
3463 public:
3464 /// SwitchLookupTable - Create a lookup table to use as a switch replacement
3465 /// with the contents of Values, using DefaultValue to fill any holes in the
3466 /// table.
3467 SwitchLookupTable(Module &M,
3468 uint64_t TableSize,
3469 ConstantInt *Offset,
3470 const SmallVector<std::pair<ConstantInt*, Constant*>, 4>& Values,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003471 Constant *DefaultValue,
Micah Villmow3574eca2012-10-08 16:38:25 +00003472 const DataLayout *TD);
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003473
3474 /// BuildLookup - Build instructions with Builder to retrieve the value at
3475 /// the position given by Index in the lookup table.
3476 Value *BuildLookup(Value *Index, IRBuilder<> &Builder);
3477
Hans Wennborgd72271c2012-09-26 09:44:49 +00003478 /// WouldFitInRegister - Return true if a table with TableSize elements of
3479 /// type ElementType would fit in a target-legal register.
Micah Villmow3574eca2012-10-08 16:38:25 +00003480 static bool WouldFitInRegister(const DataLayout *TD,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003481 uint64_t TableSize,
3482 const Type *ElementType);
3483
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003484 private:
3485 // Depending on the contents of the table, it can be represented in
3486 // different ways.
3487 enum {
3488 // For tables where each element contains the same value, we just have to
3489 // store that single value and return it for each lookup.
3490 SingleValueKind,
3491
Hans Wennborgd72271c2012-09-26 09:44:49 +00003492 // For small tables with integer elements, we can pack them into a bitmap
3493 // that fits into a target-legal register. Values are retrieved by
3494 // shift and mask operations.
3495 BitMapKind,
3496
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003497 // The table is stored as an array of values. Values are retrieved by load
3498 // instructions from the table.
3499 ArrayKind
3500 } Kind;
3501
3502 // For SingleValueKind, this is the single value.
3503 Constant *SingleValue;
3504
Hans Wennborgd72271c2012-09-26 09:44:49 +00003505 // For BitMapKind, this is the bitmap.
3506 ConstantInt *BitMap;
3507 IntegerType *BitMapElementTy;
3508
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003509 // For ArrayKind, this is the array.
3510 GlobalVariable *Array;
3511 };
3512}
3513
3514SwitchLookupTable::SwitchLookupTable(Module &M,
3515 uint64_t TableSize,
3516 ConstantInt *Offset,
3517 const SmallVector<std::pair<ConstantInt*, Constant*>, 4>& Values,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003518 Constant *DefaultValue,
Duncan Sands70465612013-01-23 09:09:50 +00003519 const DataLayout *TD)
3520 : SingleValue(0), BitMap(0), BitMapElementTy(0), Array(0) {
Hans Wennborg565df792012-09-26 11:07:37 +00003521 assert(Values.size() && "Can't build lookup table without values!");
3522 assert(TableSize >= Values.size() && "Can't fit values in table!");
Hans Wennborg486270a2012-09-06 09:43:28 +00003523
3524 // If all values in the table are equal, this is that value.
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003525 SingleValue = Values.begin()->second;
Hans Wennborg486270a2012-09-06 09:43:28 +00003526
3527 // Build up the table contents.
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003528 SmallVector<Constant*, 64> TableContents(TableSize);
3529 for (size_t I = 0, E = Values.size(); I != E; ++I) {
3530 ConstantInt *CaseVal = Values[I].first;
3531 Constant *CaseRes = Values[I].second;
3532 assert(CaseRes->getType() == DefaultValue->getType());
Hans Wennborg486270a2012-09-06 09:43:28 +00003533
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003534 uint64_t Idx = (CaseVal->getValue() - Offset->getValue())
3535 .getLimitedValue();
Hans Wennborg486270a2012-09-06 09:43:28 +00003536 TableContents[Idx] = CaseRes;
3537
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003538 if (CaseRes != SingleValue)
Hans Wennborgef026f12012-10-31 15:14:39 +00003539 SingleValue = 0;
Hans Wennborg486270a2012-09-06 09:43:28 +00003540 }
3541
3542 // Fill in any holes in the table with the default result.
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003543 if (Values.size() < TableSize) {
3544 for (uint64_t I = 0; I < TableSize; ++I) {
3545 if (!TableContents[I])
3546 TableContents[I] = DefaultValue;
Hans Wennborg486270a2012-09-06 09:43:28 +00003547 }
3548
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003549 if (DefaultValue != SingleValue)
Hans Wennborgef026f12012-10-31 15:14:39 +00003550 SingleValue = 0;
Hans Wennborg486270a2012-09-06 09:43:28 +00003551 }
3552
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003553 // If each element in the table contains the same value, we only need to store
3554 // that single value.
3555 if (SingleValue) {
3556 Kind = SingleValueKind;
3557 return;
Hans Wennborg486270a2012-09-06 09:43:28 +00003558 }
3559
Hans Wennborgd72271c2012-09-26 09:44:49 +00003560 // If the type is integer and the table fits in a register, build a bitmap.
3561 if (WouldFitInRegister(TD, TableSize, DefaultValue->getType())) {
3562 IntegerType *IT = cast<IntegerType>(DefaultValue->getType());
3563 APInt TableInt(TableSize * IT->getBitWidth(), 0);
3564 for (uint64_t I = TableSize; I > 0; --I) {
3565 TableInt <<= IT->getBitWidth();
Benjamin Kramer64f27e72012-10-01 11:31:48 +00003566 // Insert values into the bitmap. Undef values are set to zero.
3567 if (!isa<UndefValue>(TableContents[I - 1])) {
3568 ConstantInt *Val = cast<ConstantInt>(TableContents[I - 1]);
3569 TableInt |= Val->getValue().zext(TableInt.getBitWidth());
3570 }
Hans Wennborgd72271c2012-09-26 09:44:49 +00003571 }
3572 BitMap = ConstantInt::get(M.getContext(), TableInt);
3573 BitMapElementTy = IT;
3574 Kind = BitMapKind;
3575 ++NumBitMaps;
3576 return;
3577 }
3578
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003579 // Store the table in an array.
3580 ArrayType *ArrayTy = ArrayType::get(DefaultValue->getType(), TableSize);
Hans Wennborg486270a2012-09-06 09:43:28 +00003581 Constant *Initializer = ConstantArray::get(ArrayTy, TableContents);
3582
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003583 Array = new GlobalVariable(M, ArrayTy, /*constant=*/ true,
3584 GlobalVariable::PrivateLinkage,
3585 Initializer,
3586 "switch.table");
3587 Array->setUnnamedAddr(true);
3588 Kind = ArrayKind;
3589}
3590
3591Value *SwitchLookupTable::BuildLookup(Value *Index, IRBuilder<> &Builder) {
3592 switch (Kind) {
3593 case SingleValueKind:
3594 return SingleValue;
Hans Wennborgd72271c2012-09-26 09:44:49 +00003595 case BitMapKind: {
3596 // Type of the bitmap (e.g. i59).
3597 IntegerType *MapTy = BitMap->getType();
3598
3599 // Cast Index to the same type as the bitmap.
3600 // Note: The Index is <= the number of elements in the table, so
3601 // truncating it to the width of the bitmask is safe.
Hans Wennborg50b7d702012-09-26 14:01:53 +00003602 Value *ShiftAmt = Builder.CreateZExtOrTrunc(Index, MapTy, "switch.cast");
Hans Wennborgd72271c2012-09-26 09:44:49 +00003603
3604 // Multiply the shift amount by the element width.
3605 ShiftAmt = Builder.CreateMul(ShiftAmt,
3606 ConstantInt::get(MapTy, BitMapElementTy->getBitWidth()),
3607 "switch.shiftamt");
3608
3609 // Shift down.
3610 Value *DownShifted = Builder.CreateLShr(BitMap, ShiftAmt,
3611 "switch.downshift");
3612 // Mask off.
3613 return Builder.CreateTrunc(DownShifted, BitMapElementTy,
3614 "switch.masked");
3615 }
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003616 case ArrayKind: {
3617 Value *GEPIndices[] = { Builder.getInt32(0), Index };
3618 Value *GEP = Builder.CreateInBoundsGEP(Array, GEPIndices,
3619 "switch.gep");
3620 return Builder.CreateLoad(GEP, "switch.load");
3621 }
3622 }
3623 llvm_unreachable("Unknown lookup table kind!");
3624}
3625
Micah Villmow3574eca2012-10-08 16:38:25 +00003626bool SwitchLookupTable::WouldFitInRegister(const DataLayout *TD,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003627 uint64_t TableSize,
3628 const Type *ElementType) {
3629 if (!TD)
3630 return false;
3631 const IntegerType *IT = dyn_cast<IntegerType>(ElementType);
3632 if (!IT)
3633 return false;
3634 // FIXME: If the type is wider than it needs to be, e.g. i8 but all values
3635 // are <= 15, we could try to narrow the type.
Benjamin Kramer465251a2012-09-27 18:29:58 +00003636
3637 // Avoid overflow, fitsInLegalInteger uses unsigned int for the width.
3638 if (TableSize >= UINT_MAX/IT->getBitWidth())
3639 return false;
Hans Wennborgd72271c2012-09-26 09:44:49 +00003640 return TD->fitsInLegalInteger(TableSize * IT->getBitWidth());
3641}
3642
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003643/// ShouldBuildLookupTable - Determine whether a lookup table should be built
3644/// for this switch, based on the number of caes, size of the table and the
3645/// types of the results.
3646static bool ShouldBuildLookupTable(SwitchInst *SI,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003647 uint64_t TableSize,
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003648 const TargetTransformInfo &TTI,
Micah Villmow3574eca2012-10-08 16:38:25 +00003649 const DataLayout *TD,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003650 const SmallDenseMap<PHINode*, Type*>& ResultTypes) {
Hans Wennborg565df792012-09-26 11:07:37 +00003651 if (SI->getNumCases() > TableSize || TableSize >= UINT64_MAX / 10)
3652 return false; // TableSize overflowed, or mul below might overflow.
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003653
Chandler Carruth06ec7212012-11-30 09:26:25 +00003654 bool AllTablesFitInRegister = true;
Evan Cheng40eef5f2012-11-30 02:02:42 +00003655 bool HasIllegalType = false;
Hans Wennborgd72271c2012-09-26 09:44:49 +00003656 for (SmallDenseMap<PHINode*, Type*>::const_iterator I = ResultTypes.begin(),
3657 E = ResultTypes.end(); I != E; ++I) {
Evan Cheng40eef5f2012-11-30 02:02:42 +00003658 Type *Ty = I->second;
Chandler Carruth66ea2f92012-11-30 09:34:29 +00003659
3660 // Saturate this flag to true.
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003661 HasIllegalType = HasIllegalType || !TTI.isTypeLegal(Ty);
Chandler Carruth66ea2f92012-11-30 09:34:29 +00003662
3663 // Saturate this flag to false.
3664 AllTablesFitInRegister = AllTablesFitInRegister &&
3665 SwitchLookupTable::WouldFitInRegister(TD, TableSize, Ty);
3666
3667 // If both flags saturate, we're done. NOTE: This *only* works with
3668 // saturating flags, and all flags have to saturate first due to the
3669 // non-deterministic behavior of iterating over a dense map.
3670 if (HasIllegalType && !AllTablesFitInRegister)
Evan Cheng40eef5f2012-11-30 02:02:42 +00003671 break;
Hans Wennborgd72271c2012-09-26 09:44:49 +00003672 }
Evan Cheng40eef5f2012-11-30 02:02:42 +00003673
Chandler Carruth06ec7212012-11-30 09:26:25 +00003674 // If each table would fit in a register, we should build it anyway.
3675 if (AllTablesFitInRegister)
3676 return true;
3677
3678 // Don't build a table that doesn't fit in-register if it has illegal types.
3679 if (HasIllegalType)
3680 return false;
3681
3682 // The table density should be at least 40%. This is the same criterion as for
3683 // jump tables, see SelectionDAGBuilder::handleJTSwitchCase.
3684 // FIXME: Find the best cut-off.
3685 return SI->getNumCases() * 10 >= TableSize * 4;
Hans Wennborg486270a2012-09-06 09:43:28 +00003686}
3687
3688/// SwitchToLookupTable - If the switch is only used to initialize one or more
3689/// phi nodes in a common successor block with different constant values,
3690/// replace the switch with lookup tables.
3691static bool SwitchToLookupTable(SwitchInst *SI,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003692 IRBuilder<> &Builder,
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003693 const TargetTransformInfo &TTI,
3694 const DataLayout* TD) {
Hans Wennborg486270a2012-09-06 09:43:28 +00003695 assert(SI->getNumCases() > 1 && "Degenerate switch?");
Hans Wennborg04d7d132012-10-30 11:23:25 +00003696
Hans Wennborgb0319962012-11-07 21:35:12 +00003697 // Only build lookup table when we have a target that supports it.
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003698 if (!TTI.shouldBuildLookupTables())
Hans Wennborg04d7d132012-10-30 11:23:25 +00003699 return false;
3700
Hans Wennborg486270a2012-09-06 09:43:28 +00003701 // FIXME: If the switch is too sparse for a lookup table, perhaps we could
3702 // split off a dense part and build a lookup table for that.
3703
Hans Wennborg486270a2012-09-06 09:43:28 +00003704 // FIXME: This creates arrays of GEPs to constant strings, which means each
3705 // GEP needs a runtime relocation in PIC code. We should just build one big
3706 // string and lookup indices into that.
3707
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003708 // Ignore the switch if the number of cases is too small.
Hans Wennborg486270a2012-09-06 09:43:28 +00003709 // This is similar to the check when building jump tables in
3710 // SelectionDAGBuilder::handleJTSwitchCase.
3711 // FIXME: Determine the best cut-off.
3712 if (SI->getNumCases() < 4)
3713 return false;
3714
3715 // Figure out the corresponding result for each case value and phi node in the
3716 // common destination, as well as the the min and max case values.
3717 assert(SI->case_begin() != SI->case_end());
3718 SwitchInst::CaseIt CI = SI->case_begin();
3719 ConstantInt *MinCaseVal = CI.getCaseValue();
3720 ConstantInt *MaxCaseVal = CI.getCaseValue();
3721
Hans Wennborgef026f12012-10-31 15:14:39 +00003722 BasicBlock *CommonDest = 0;
Hans Wennborg2f9fc762012-09-10 07:44:22 +00003723 typedef SmallVector<std::pair<ConstantInt*, Constant*>, 4> ResultListTy;
Hans Wennborg486270a2012-09-06 09:43:28 +00003724 SmallDenseMap<PHINode*, ResultListTy> ResultLists;
3725 SmallDenseMap<PHINode*, Constant*> DefaultResults;
3726 SmallDenseMap<PHINode*, Type*> ResultTypes;
3727 SmallVector<PHINode*, 4> PHIs;
3728
3729 for (SwitchInst::CaseIt E = SI->case_end(); CI != E; ++CI) {
3730 ConstantInt *CaseVal = CI.getCaseValue();
3731 if (CaseVal->getValue().slt(MinCaseVal->getValue()))
3732 MinCaseVal = CaseVal;
3733 if (CaseVal->getValue().sgt(MaxCaseVal->getValue()))
3734 MaxCaseVal = CaseVal;
3735
3736 // Resulting value at phi nodes for this case value.
3737 typedef SmallVector<std::pair<PHINode*, Constant*>, 4> ResultsTy;
3738 ResultsTy Results;
Hans Wennborge03d9e42012-10-31 13:42:45 +00003739 if (!GetCaseResults(SI, CaseVal, CI.getCaseSuccessor(), &CommonDest,
3740 Results))
Hans Wennborg486270a2012-09-06 09:43:28 +00003741 return false;
3742
3743 // Append the result from this case to the list for each phi.
3744 for (ResultsTy::iterator I = Results.begin(), E = Results.end(); I!=E; ++I) {
3745 if (!ResultLists.count(I->first))
3746 PHIs.push_back(I->first);
3747 ResultLists[I->first].push_back(std::make_pair(CaseVal, I->second));
3748 }
3749 }
3750
3751 // Get the resulting values for the default case.
Hans Wennborg2f9fc762012-09-10 07:44:22 +00003752 SmallVector<std::pair<PHINode*, Constant*>, 4> DefaultResultsList;
Hans Wennborgef026f12012-10-31 15:14:39 +00003753 if (!GetCaseResults(SI, 0, SI->getDefaultDest(), &CommonDest,
Hans Wennborge03d9e42012-10-31 13:42:45 +00003754 DefaultResultsList))
Hans Wennborg2f9fc762012-09-10 07:44:22 +00003755 return false;
3756 for (size_t I = 0, E = DefaultResultsList.size(); I != E; ++I) {
3757 PHINode *PHI = DefaultResultsList[I].first;
3758 Constant *Result = DefaultResultsList[I].second;
3759 DefaultResults[PHI] = Result;
3760 ResultTypes[PHI] = Result->getType();
Hans Wennborg486270a2012-09-06 09:43:28 +00003761 }
3762
3763 APInt RangeSpread = MaxCaseVal->getValue() - MinCaseVal->getValue();
Hans Wennborg486270a2012-09-06 09:43:28 +00003764 uint64_t TableSize = RangeSpread.getLimitedValue() + 1;
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003765 if (!ShouldBuildLookupTable(SI, TableSize, TTI, TD, ResultTypes))
Hans Wennborg486270a2012-09-06 09:43:28 +00003766 return false;
3767
Hans Wennborg486270a2012-09-06 09:43:28 +00003768 // Create the BB that does the lookups.
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003769 Module &Mod = *CommonDest->getParent()->getParent();
Hans Wennborg486270a2012-09-06 09:43:28 +00003770 BasicBlock *LookupBB = BasicBlock::Create(Mod.getContext(),
3771 "switch.lookup",
3772 CommonDest->getParent(),
3773 CommonDest);
3774
3775 // Check whether the condition value is within the case range, and branch to
3776 // the new BB.
3777 Builder.SetInsertPoint(SI);
3778 Value *TableIndex = Builder.CreateSub(SI->getCondition(), MinCaseVal,
3779 "switch.tableidx");
3780 Value *Cmp = Builder.CreateICmpULT(TableIndex, ConstantInt::get(
3781 MinCaseVal->getType(), TableSize));
3782 Builder.CreateCondBr(Cmp, LookupBB, SI->getDefaultDest());
3783
3784 // Populate the BB that does the lookups.
3785 Builder.SetInsertPoint(LookupBB);
3786 bool ReturnedEarly = false;
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003787 for (size_t I = 0, E = PHIs.size(); I != E; ++I) {
3788 PHINode *PHI = PHIs[I];
Hans Wennborg486270a2012-09-06 09:43:28 +00003789
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003790 SwitchLookupTable Table(Mod, TableSize, MinCaseVal, ResultLists[PHI],
Hans Wennborgd72271c2012-09-26 09:44:49 +00003791 DefaultResults[PHI], TD);
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003792
3793 Value *Result = Table.BuildLookup(TableIndex, Builder);
Hans Wennborg486270a2012-09-06 09:43:28 +00003794
Hans Wennborg57933e32012-09-19 14:24:21 +00003795 // If the result is used to return immediately from the function, we want to
3796 // do that right here.
3797 if (PHI->hasOneUse() && isa<ReturnInst>(*PHI->use_begin()) &&
3798 *PHI->use_begin() == CommonDest->getFirstNonPHIOrDbg()) {
3799 Builder.CreateRet(Result);
3800 ReturnedEarly = true;
3801 break;
Hans Wennborg486270a2012-09-06 09:43:28 +00003802 }
3803
Hans Wennborg57933e32012-09-19 14:24:21 +00003804 PHI->addIncoming(Result, LookupBB);
Hans Wennborg486270a2012-09-06 09:43:28 +00003805 }
3806
3807 if (!ReturnedEarly)
3808 Builder.CreateBr(CommonDest);
3809
3810 // Remove the switch.
3811 for (unsigned i = 0; i < SI->getNumSuccessors(); ++i) {
3812 BasicBlock *Succ = SI->getSuccessor(i);
3813 if (Succ == SI->getDefaultDest()) continue;
3814 Succ->removePredecessor(SI->getParent());
3815 }
3816 SI->eraseFromParent();
3817
3818 ++NumLookupTables;
3819 return true;
3820}
3821
Devang Patel007349d2011-05-18 20:35:38 +00003822bool SimplifyCFGOpt::SimplifySwitch(SwitchInst *SI, IRBuilder<> &Builder) {
Chris Lattner3d512132010-12-13 06:25:44 +00003823 BasicBlock *BB = SI->getParent();
3824
Jakob Stoklund Olesene5a7a682012-10-25 18:51:15 +00003825 if (isValueEqualityComparison(SI)) {
3826 // If we only have one predecessor, and if it is a branch on this value,
3827 // see if that predecessor totally determines the outcome of this switch.
3828 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
3829 if (SimplifyEqualityComparisonWithOnlyPredecessor(SI, OnlyPred, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003830 return SimplifyCFG(BB, TTI, TD) | true;
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00003831
Jakob Stoklund Olesene5a7a682012-10-25 18:51:15 +00003832 Value *Cond = SI->getCondition();
3833 if (SelectInst *Select = dyn_cast<SelectInst>(Cond))
3834 if (SimplifySwitchOnSelect(SI, Select))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003835 return SimplifyCFG(BB, TTI, TD) | true;
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00003836
Jakob Stoklund Olesene5a7a682012-10-25 18:51:15 +00003837 // If the block only contains the switch, see if we can fold the block
3838 // away into any preds.
3839 BasicBlock::iterator BBI = BB->begin();
3840 // Ignore dbg intrinsics.
3841 while (isa<DbgInfoIntrinsic>(BBI))
3842 ++BBI;
3843 if (SI == &*BBI)
3844 if (FoldValueComparisonIntoPredecessors(SI, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003845 return SimplifyCFG(BB, TTI, TD) | true;
Jakob Stoklund Olesene5a7a682012-10-25 18:51:15 +00003846 }
Benjamin Kramer56442df2011-02-02 15:56:22 +00003847
3848 // Try to transform the switch into an icmp and a branch.
Devang Patel007349d2011-05-18 20:35:38 +00003849 if (TurnSwitchRangeIntoICmp(SI, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003850 return SimplifyCFG(BB, TTI, TD) | true;
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003851
3852 // Remove unreachable cases.
3853 if (EliminateDeadSwitchCases(SI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003854 return SimplifyCFG(BB, TTI, TD) | true;
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003855
Hans Wennborg448da512011-06-18 10:28:47 +00003856 if (ForwardSwitchConditionToPHI(SI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003857 return SimplifyCFG(BB, TTI, TD) | true;
Hans Wennborg448da512011-06-18 10:28:47 +00003858
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003859 if (SwitchToLookupTable(SI, Builder, TTI, TD))
3860 return SimplifyCFG(BB, TTI, TD) | true;
Hans Wennborg486270a2012-09-06 09:43:28 +00003861
Chris Lattner3d512132010-12-13 06:25:44 +00003862 return false;
3863}
3864
3865bool SimplifyCFGOpt::SimplifyIndirectBr(IndirectBrInst *IBI) {
3866 BasicBlock *BB = IBI->getParent();
3867 bool Changed = false;
Andrew Trick6b014382012-08-29 21:46:36 +00003868
Chris Lattner3d512132010-12-13 06:25:44 +00003869 // Eliminate redundant destinations.
3870 SmallPtrSet<Value *, 8> Succs;
3871 for (unsigned i = 0, e = IBI->getNumDestinations(); i != e; ++i) {
3872 BasicBlock *Dest = IBI->getDestination(i);
3873 if (!Dest->hasAddressTaken() || !Succs.insert(Dest)) {
3874 Dest->removePredecessor(BB);
3875 IBI->removeDestination(i);
3876 --i; --e;
3877 Changed = true;
3878 }
Andrew Trick6b014382012-08-29 21:46:36 +00003879 }
Chris Lattner3d512132010-12-13 06:25:44 +00003880
3881 if (IBI->getNumDestinations() == 0) {
3882 // If the indirectbr has no successors, change it to unreachable.
3883 new UnreachableInst(IBI->getContext(), IBI);
3884 EraseTerminatorInstAndDCECond(IBI);
3885 return true;
3886 }
Andrew Trick6b014382012-08-29 21:46:36 +00003887
Chris Lattner3d512132010-12-13 06:25:44 +00003888 if (IBI->getNumDestinations() == 1) {
3889 // If the indirectbr has one successor, change it to a direct branch.
3890 BranchInst::Create(IBI->getDestination(0), IBI);
3891 EraseTerminatorInstAndDCECond(IBI);
3892 return true;
3893 }
Andrew Trick6b014382012-08-29 21:46:36 +00003894
Chris Lattner3d512132010-12-13 06:25:44 +00003895 if (SelectInst *SI = dyn_cast<SelectInst>(IBI->getAddress())) {
3896 if (SimplifyIndirectBrOnSelect(IBI, SI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003897 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003898 }
3899 return Changed;
3900}
3901
Devang Patela23812c2011-05-18 18:28:48 +00003902bool SimplifyCFGOpt::SimplifyUncondBranch(BranchInst *BI, IRBuilder<> &Builder){
Chris Lattner3d512132010-12-13 06:25:44 +00003903 BasicBlock *BB = BI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00003904
Manman Ren554da1a2012-09-20 22:37:36 +00003905 if (SinkCommon && SinkThenElseCodeToEnd(BI))
3906 return true;
3907
Chris Lattner3d512132010-12-13 06:25:44 +00003908 // If the Terminator is the only non-phi instruction, simplify the block.
Rafael Espindola77a2c372011-06-30 20:14:24 +00003909 BasicBlock::iterator I = BB->getFirstNonPHIOrDbgOrLifetime();
Chris Lattner3d512132010-12-13 06:25:44 +00003910 if (I->isTerminator() && BB != &BB->getParent()->getEntryBlock() &&
3911 TryToSimplifyUncondBranchFromEmptyBlock(BB))
3912 return true;
Andrew Trick6b014382012-08-29 21:46:36 +00003913
Chris Lattner3d512132010-12-13 06:25:44 +00003914 // If the only instruction in the block is a seteq/setne comparison
3915 // against a constant, try to simplify the block.
3916 if (ICmpInst *ICI = dyn_cast<ICmpInst>(I))
3917 if (ICI->isEquality() && isa<ConstantInt>(ICI->getOperand(1))) {
3918 for (++I; isa<DbgInfoIntrinsic>(I); ++I)
3919 ;
Nick Lewycky9d523102011-12-26 20:37:40 +00003920 if (I->isTerminator() &&
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003921 TryToSimplifyUncondBranchWithICmpInIt(ICI, Builder, TTI, TD))
Chris Lattner3d512132010-12-13 06:25:44 +00003922 return true;
3923 }
Andrew Trick6b014382012-08-29 21:46:36 +00003924
Manman Renee28e0f2012-06-13 05:43:29 +00003925 // If this basic block is ONLY a compare and a branch, and if a predecessor
3926 // branches to us and our successor, fold the comparison into the
3927 // predecessor and use logical operations to update the incoming value
3928 // for PHI nodes in common successor.
3929 if (FoldBranchToCommonDest(BI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003930 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003931 return false;
3932}
3933
3934
Devang Patel007349d2011-05-18 20:35:38 +00003935bool SimplifyCFGOpt::SimplifyCondBranch(BranchInst *BI, IRBuilder<> &Builder) {
Chris Lattner3d512132010-12-13 06:25:44 +00003936 BasicBlock *BB = BI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00003937
Chris Lattner3d512132010-12-13 06:25:44 +00003938 // Conditional branch
3939 if (isValueEqualityComparison(BI)) {
3940 // If we only have one predecessor, and if it is a branch on this value,
3941 // see if that predecessor totally determines the outcome of this
3942 // switch.
3943 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
Devang Patel007349d2011-05-18 20:35:38 +00003944 if (SimplifyEqualityComparisonWithOnlyPredecessor(BI, OnlyPred, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003945 return SimplifyCFG(BB, TTI, TD) | true;
Andrew Trick6b014382012-08-29 21:46:36 +00003946
Chris Lattner3d512132010-12-13 06:25:44 +00003947 // This block must be empty, except for the setcond inst, if it exists.
3948 // Ignore dbg intrinsics.
3949 BasicBlock::iterator I = BB->begin();
3950 // Ignore dbg intrinsics.
3951 while (isa<DbgInfoIntrinsic>(I))
3952 ++I;
3953 if (&*I == BI) {
Devang Patelb55d9242011-05-18 20:53:17 +00003954 if (FoldValueComparisonIntoPredecessors(BI, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003955 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003956 } else if (&*I == cast<Instruction>(BI->getCondition())){
3957 ++I;
3958 // Ignore dbg intrinsics.
3959 while (isa<DbgInfoIntrinsic>(I))
3960 ++I;
Devang Patelb55d9242011-05-18 20:53:17 +00003961 if (&*I == BI && FoldValueComparisonIntoPredecessors(BI, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003962 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003963 }
3964 }
Andrew Trick6b014382012-08-29 21:46:36 +00003965
Chris Lattner3d512132010-12-13 06:25:44 +00003966 // Try to turn "br (X == 0 | X == 1), T, F" into a switch instruction.
Devang Patel02dd5412011-05-18 23:18:47 +00003967 if (SimplifyBranchOnICmpChain(BI, TD, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00003968 return true;
Andrew Trick6b014382012-08-29 21:46:36 +00003969
Dan Gohman3b205172012-01-05 23:58:56 +00003970 // If this basic block is ONLY a compare and a branch, and if a predecessor
3971 // branches to us and one of our successors, fold the comparison into the
3972 // predecessor and use logical operations to pick the right destination.
3973 if (FoldBranchToCommonDest(BI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003974 return SimplifyCFG(BB, TTI, TD) | true;
Andrew Trick6b014382012-08-29 21:46:36 +00003975
Chris Lattner3d512132010-12-13 06:25:44 +00003976 // We have a conditional branch to two blocks that are only reachable
3977 // from BI. We know that the condbr dominates the two blocks, so see if
3978 // there is any identical code in the "then" and "else" blocks. If so, we
3979 // can hoist it up to the branching block.
3980 if (BI->getSuccessor(0)->getSinglePredecessor() != 0) {
3981 if (BI->getSuccessor(1)->getSinglePredecessor() != 0) {
Rafael Espindola216dde92011-05-19 02:26:30 +00003982 if (HoistThenElseCodeToIf(BI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003983 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003984 } else {
3985 // If Successor #1 has multiple preds, we may be able to conditionally
3986 // execute Successor #0 if it branches to successor #1.
3987 TerminatorInst *Succ0TI = BI->getSuccessor(0)->getTerminator();
3988 if (Succ0TI->getNumSuccessors() == 1 &&
3989 Succ0TI->getSuccessor(0) == BI->getSuccessor(1))
Chandler Carruth455151e2013-01-27 06:42:03 +00003990 if (SpeculativelyExecuteBB(BI, BI->getSuccessor(0)))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003991 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003992 }
3993 } else if (BI->getSuccessor(1)->getSinglePredecessor() != 0) {
3994 // If Successor #0 has multiple preds, we may be able to conditionally
3995 // execute Successor #1 if it branches to successor #0.
3996 TerminatorInst *Succ1TI = BI->getSuccessor(1)->getTerminator();
3997 if (Succ1TI->getNumSuccessors() == 1 &&
3998 Succ1TI->getSuccessor(0) == BI->getSuccessor(0))
Chandler Carruth455151e2013-01-27 06:42:03 +00003999 if (SpeculativelyExecuteBB(BI, BI->getSuccessor(1)))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00004000 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00004001 }
Andrew Trick6b014382012-08-29 21:46:36 +00004002
Chris Lattner3d512132010-12-13 06:25:44 +00004003 // If this is a branch on a phi node in the current block, thread control
4004 // through this block if any PHI node entries are constants.
4005 if (PHINode *PN = dyn_cast<PHINode>(BI->getCondition()))
4006 if (PN->getParent() == BI->getParent())
Chris Lattner302ba6f2010-12-14 06:17:25 +00004007 if (FoldCondBranchOnPHI(BI, TD))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00004008 return SimplifyCFG(BB, TTI, TD) | true;
Andrew Trick6b014382012-08-29 21:46:36 +00004009
Chris Lattner3d512132010-12-13 06:25:44 +00004010 // Scan predecessor blocks for conditional branches.
4011 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
4012 if (BranchInst *PBI = dyn_cast<BranchInst>((*PI)->getTerminator()))
4013 if (PBI != BI && PBI->isConditional())
4014 if (SimplifyCondBranchToCondBranch(PBI, BI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00004015 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00004016
4017 return false;
4018}
4019
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004020/// Check if passing a value to an instruction will cause undefined behavior.
4021static bool passingValueIsAlwaysUndefined(Value *V, Instruction *I) {
4022 Constant *C = dyn_cast<Constant>(V);
4023 if (!C)
4024 return false;
4025
Benjamin Kramer1e21db62012-10-04 16:11:49 +00004026 if (I->use_empty())
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004027 return false;
4028
4029 if (C->isNullValue()) {
Benjamin Kramer1e21db62012-10-04 16:11:49 +00004030 // Only look at the first use, avoid hurting compile time with long uselists
4031 User *Use = *I->use_begin();
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004032
4033 // Now make sure that there are no instructions in between that can alter
4034 // control flow (eg. calls)
4035 for (BasicBlock::iterator i = ++BasicBlock::iterator(I); &*i != Use; ++i)
Benjamin Kramer9bb54882011-08-26 02:25:55 +00004036 if (i == I->getParent()->end() || i->mayHaveSideEffects())
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004037 return false;
4038
4039 // Look through GEPs. A load from a GEP derived from NULL is still undefined
4040 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Use))
4041 if (GEP->getPointerOperand() == I)
4042 return passingValueIsAlwaysUndefined(V, GEP);
4043
4044 // Look through bitcasts.
4045 if (BitCastInst *BC = dyn_cast<BitCastInst>(Use))
4046 return passingValueIsAlwaysUndefined(V, BC);
4047
Benjamin Kramer9bb54882011-08-26 02:25:55 +00004048 // Load from null is undefined.
4049 if (LoadInst *LI = dyn_cast<LoadInst>(Use))
Andrew Trick119003f2013-03-07 01:03:35 +00004050 if (!LI->isVolatile())
4051 return LI->getPointerAddressSpace() == 0;
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004052
Benjamin Kramer9bb54882011-08-26 02:25:55 +00004053 // Store to null is undefined.
4054 if (StoreInst *SI = dyn_cast<StoreInst>(Use))
Andrew Trick119003f2013-03-07 01:03:35 +00004055 if (!SI->isVolatile())
4056 return SI->getPointerAddressSpace() == 0 && SI->getPointerOperand() == I;
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004057 }
4058 return false;
4059}
4060
4061/// If BB has an incoming value that will always trigger undefined behavior
Nick Lewycky9d523102011-12-26 20:37:40 +00004062/// (eg. null pointer dereference), remove the branch leading here.
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004063static bool removeUndefIntroducingPredecessor(BasicBlock *BB) {
4064 for (BasicBlock::iterator i = BB->begin();
4065 PHINode *PHI = dyn_cast<PHINode>(i); ++i)
4066 for (unsigned i = 0, e = PHI->getNumIncomingValues(); i != e; ++i)
4067 if (passingValueIsAlwaysUndefined(PHI->getIncomingValue(i), PHI)) {
4068 TerminatorInst *T = PHI->getIncomingBlock(i)->getTerminator();
4069 IRBuilder<> Builder(T);
4070 if (BranchInst *BI = dyn_cast<BranchInst>(T)) {
4071 BB->removePredecessor(PHI->getIncomingBlock(i));
4072 // Turn uncoditional branches into unreachables and remove the dead
4073 // destination from conditional branches.
4074 if (BI->isUnconditional())
4075 Builder.CreateUnreachable();
4076 else
4077 Builder.CreateBr(BI->getSuccessor(0) == BB ? BI->getSuccessor(1) :
4078 BI->getSuccessor(0));
4079 BI->eraseFromParent();
4080 return true;
4081 }
4082 // TODO: SwitchInst.
4083 }
4084
4085 return false;
4086}
4087
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +00004088bool SimplifyCFGOpt::run(BasicBlock *BB) {
Chris Lattnerdc3602b2003-08-24 18:36:16 +00004089 bool Changed = false;
Chris Lattner01d1ee32002-05-21 20:50:24 +00004090
Chris Lattner302ba6f2010-12-14 06:17:25 +00004091 assert(BB && BB->getParent() && "Block not embedded in function!");
Chris Lattner01d1ee32002-05-21 20:50:24 +00004092 assert(BB->getTerminator() && "Degenerate basic block encountered!");
Chris Lattner01d1ee32002-05-21 20:50:24 +00004093
Dan Gohmane2c6d132010-08-14 00:29:42 +00004094 // Remove basic blocks that have no predecessors (except the entry block)...
4095 // or that just have themself as a predecessor. These are unreachable.
Chris Lattner302ba6f2010-12-14 06:17:25 +00004096 if ((pred_begin(BB) == pred_end(BB) &&
4097 BB != &BB->getParent()->getEntryBlock()) ||
Dan Gohmane2c6d132010-08-14 00:29:42 +00004098 BB->getSinglePredecessor() == BB) {
David Greene89d6fd32010-01-05 01:26:52 +00004099 DEBUG(dbgs() << "Removing BB: \n" << *BB);
Chris Lattner71af9b02008-12-03 06:40:52 +00004100 DeleteDeadBlock(BB);
Chris Lattner01d1ee32002-05-21 20:50:24 +00004101 return true;
4102 }
4103
Chris Lattner694e37f2003-08-17 19:41:53 +00004104 // Check to see if we can constant propagate this terminator instruction
4105 // away...
Frits van Bommel5649ba72011-05-22 16:24:18 +00004106 Changed |= ConstantFoldTerminator(BB, true);
Chris Lattner694e37f2003-08-17 19:41:53 +00004107
Dan Gohman2c635662009-10-30 22:39:04 +00004108 // Check for and eliminate duplicate PHI nodes in this block.
4109 Changed |= EliminateDuplicatePHINodes(BB);
4110
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004111 // Check for and remove branches that will always cause undefined behavior.
4112 Changed |= removeUndefIntroducingPredecessor(BB);
4113
Chris Lattnerddb97a22010-12-13 05:10:48 +00004114 // Merge basic blocks into their predecessor if there is only one distinct
4115 // pred, and if there is only one distinct successor of the predecessor, and
4116 // if there are no PHI nodes.
4117 //
4118 if (MergeBlockIntoPredecessor(BB))
4119 return true;
Andrew Trick6b014382012-08-29 21:46:36 +00004120
Devang Patel3e410c62011-05-18 18:01:27 +00004121 IRBuilder<> Builder(BB);
4122
Dan Gohman882d87d2008-03-11 21:53:06 +00004123 // If there is a trivial two-entry PHI node in this basic block, and we can
4124 // eliminate it, do so now.
4125 if (PHINode *PN = dyn_cast<PHINode>(BB->begin()))
4126 if (PN->getNumIncomingValues() == 2)
Devang Pateld3a17882011-05-19 20:52:46 +00004127 Changed |= FoldTwoEntryPHINode(PN, TD);
Dan Gohman882d87d2008-03-11 21:53:06 +00004128
Devang Patel007349d2011-05-18 20:35:38 +00004129 Builder.SetInsertPoint(BB->getTerminator());
Chris Lattner3d512132010-12-13 06:25:44 +00004130 if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) {
Chris Lattner021c9d32010-12-13 06:36:51 +00004131 if (BI->isUnconditional()) {
Devang Patela23812c2011-05-18 18:28:48 +00004132 if (SimplifyUncondBranch(BI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00004133 } else {
Devang Patel007349d2011-05-18 20:35:38 +00004134 if (SimplifyCondBranch(BI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00004135 }
4136 } else if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
Devang Patel176ec402011-05-18 21:33:11 +00004137 if (SimplifyReturn(RI, Builder)) return true;
Bill Wendlingaa5abe82012-02-06 21:16:41 +00004138 } else if (ResumeInst *RI = dyn_cast<ResumeInst>(BB->getTerminator())) {
4139 if (SimplifyResume(RI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00004140 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
Devang Patel007349d2011-05-18 20:35:38 +00004141 if (SimplifySwitch(SI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00004142 } else if (UnreachableInst *UI =
4143 dyn_cast<UnreachableInst>(BB->getTerminator())) {
4144 if (SimplifyUnreachable(UI)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00004145 } else if (IndirectBrInst *IBI =
4146 dyn_cast<IndirectBrInst>(BB->getTerminator())) {
4147 if (SimplifyIndirectBr(IBI)) return true;
Chris Lattner19831ec2004-02-16 06:35:48 +00004148 }
4149
Chris Lattner694e37f2003-08-17 19:41:53 +00004150 return Changed;
Chris Lattner01d1ee32002-05-21 20:50:24 +00004151}
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +00004152
4153/// SimplifyCFG - This function is used to do simplification of a CFG. For
4154/// example, it adjusts branches to branches to eliminate the extra hop, it
4155/// eliminates unreachable basic blocks, and does other "peephole" optimization
4156/// of the CFG. It returns true if a modification was made.
4157///
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00004158bool llvm::SimplifyCFG(BasicBlock *BB, const TargetTransformInfo &TTI,
4159 const DataLayout *TD) {
4160 return SimplifyCFGOpt(TTI, TD).run(BB);
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +00004161}