blob: db8edea10c8faac527c53d1c2dd36cd4a59012c0 [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"
Chris Lattner723c66d2004-02-11 03:36:04 +000016#include "llvm/Constants.h"
Nick Lewycky9d523102011-12-26 20:37:40 +000017#include "llvm/DerivedTypes.h"
18#include "llvm/GlobalVariable.h"
Chandler Carruth06cb8ed2012-06-29 12:38:19 +000019#include "llvm/IRBuilder.h"
Chris Lattner723c66d2004-02-11 03:36:04 +000020#include "llvm/Instructions.h"
Devang Patel383d7ed2009-02-03 22:12:02 +000021#include "llvm/IntrinsicInst.h"
Nick Lewycky06cc66f2011-12-27 04:31:52 +000022#include "llvm/LLVMContext.h"
Chandler Carruth0baa4802012-07-15 23:26:50 +000023#include "llvm/MDBuilder.h"
Nick Lewycky06cc66f2011-12-27 04:31:52 +000024#include "llvm/Metadata.h"
Hans Wennborg486270a2012-09-06 09:43:28 +000025#include "llvm/Module.h"
Dan Gohman3b205172012-01-05 23:58:56 +000026#include "llvm/Operator.h"
Chris Lattner0d560082004-02-24 05:38:11 +000027#include "llvm/Type.h"
Chandler Carruth06cb8ed2012-06-29 12:38:19 +000028#include "llvm/ADT/DenseMap.h"
29#include "llvm/ADT/STLExtras.h"
30#include "llvm/ADT/SetVector.h"
31#include "llvm/ADT/SmallPtrSet.h"
32#include "llvm/ADT/SmallVector.h"
33#include "llvm/ADT/Statistic.h"
Chris Lattner302ba6f2010-12-14 06:17:25 +000034#include "llvm/Analysis/InstructionSimplify.h"
Benjamin Kramer10fcfb52011-05-14 15:57:25 +000035#include "llvm/Analysis/ValueTracking.h"
Chris Lattner302ba6f2010-12-14 06:17:25 +000036#include "llvm/Support/CFG.h"
Evan Chengc3f507f2011-01-29 04:46:23 +000037#include "llvm/Support/CommandLine.h"
Chris Lattnere27db742010-12-17 06:20:15 +000038#include "llvm/Support/ConstantRange.h"
Chris Lattner302ba6f2010-12-14 06:17:25 +000039#include "llvm/Support/Debug.h"
Devang Pateld3a17882011-05-19 20:52:46 +000040#include "llvm/Support/NoFolder.h"
Chris Lattner302ba6f2010-12-14 06:17:25 +000041#include "llvm/Support/raw_ostream.h"
Chandler Carruth06cb8ed2012-06-29 12:38:19 +000042#include "llvm/Target/TargetData.h"
43#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Chris Lattner01d1ee32002-05-21 20:50:24 +000044#include <algorithm>
Chris Lattnerd52c2612004-02-24 07:23:58 +000045#include <set>
Chris Lattner698f96f2004-10-18 04:07:22 +000046#include <map>
Chris Lattnerf7703df2004-01-09 06:12:26 +000047using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000048
Peter Collingbourne57808b32011-04-29 18:47:38 +000049static cl::opt<unsigned>
50PHINodeFoldingThreshold("phi-node-folding-threshold", cl::Hidden, cl::init(1),
51 cl::desc("Control the amount of phi node folding to perform (default = 1)"));
52
Evan Chengc3f507f2011-01-29 04:46:23 +000053static cl::opt<bool>
54DupRet("simplifycfg-dup-ret", cl::Hidden, cl::init(false),
55 cl::desc("Duplicate return instructions into unconditional branches"));
56
Evan Cheng502a4f52008-06-12 21:15:59 +000057STATISTIC(NumSpeculations, "Number of speculative executed instructions");
Hans Wennborg486270a2012-09-06 09:43:28 +000058STATISTIC(NumLookupTables, "Number of switch instructions turned into lookup tables");
Evan Cheng502a4f52008-06-12 21:15:59 +000059
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000060namespace {
Eric Christopherc723eb12012-07-02 23:22:21 +000061 /// ValueEqualityComparisonCase - Represents a case of a switch.
62 struct ValueEqualityComparisonCase {
63 ConstantInt *Value;
64 BasicBlock *Dest;
65
66 ValueEqualityComparisonCase(ConstantInt *Value, BasicBlock *Dest)
67 : Value(Value), Dest(Dest) {}
68
69 bool operator<(ValueEqualityComparisonCase RHS) const {
70 // Comparing pointers is ok as we only rely on the order for uniquing.
71 return Value < RHS.Value;
72 }
73 };
74
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000075class SimplifyCFGOpt {
76 const TargetData *const TD;
77
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000078 Value *isValueEqualityComparison(TerminatorInst *TI);
79 BasicBlock *GetValueEqualityComparisonCases(TerminatorInst *TI,
Eric Christopherc723eb12012-07-02 23:22:21 +000080 std::vector<ValueEqualityComparisonCase> &Cases);
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000081 bool SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
Devang Patel007349d2011-05-18 20:35:38 +000082 BasicBlock *Pred,
83 IRBuilder<> &Builder);
Devang Patelb55d9242011-05-18 20:53:17 +000084 bool FoldValueComparisonIntoPredecessors(TerminatorInst *TI,
85 IRBuilder<> &Builder);
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000086
Devang Patel176ec402011-05-18 21:33:11 +000087 bool SimplifyReturn(ReturnInst *RI, IRBuilder<> &Builder);
Bill Wendlingaa5abe82012-02-06 21:16:41 +000088 bool SimplifyResume(ResumeInst *RI, IRBuilder<> &Builder);
Chris Lattner3d512132010-12-13 06:25:44 +000089 bool SimplifyUnreachable(UnreachableInst *UI);
Devang Patel007349d2011-05-18 20:35:38 +000090 bool SimplifySwitch(SwitchInst *SI, IRBuilder<> &Builder);
Chris Lattner3d512132010-12-13 06:25:44 +000091 bool SimplifyIndirectBr(IndirectBrInst *IBI);
Devang Patela23812c2011-05-18 18:28:48 +000092 bool SimplifyUncondBranch(BranchInst *BI, IRBuilder <> &Builder);
Devang Patel007349d2011-05-18 20:35:38 +000093 bool SimplifyCondBranch(BranchInst *BI, IRBuilder <>&Builder);
Chris Lattner3d512132010-12-13 06:25:44 +000094
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000095public:
96 explicit SimplifyCFGOpt(const TargetData *td) : TD(td) {}
97 bool run(BasicBlock *BB);
98};
99}
100
Chris Lattner2bdcb562005-08-03 00:19:45 +0000101/// SafeToMergeTerminators - Return true if it is safe to merge these two
102/// terminator instructions together.
103///
104static bool SafeToMergeTerminators(TerminatorInst *SI1, TerminatorInst *SI2) {
105 if (SI1 == SI2) return false; // Can't merge with self!
Andrew Trick6b014382012-08-29 21:46:36 +0000106
Chris Lattner2bdcb562005-08-03 00:19:45 +0000107 // It is not safe to merge these two switch instructions if they have a common
108 // successor, and if that successor has a PHI node, and if *that* PHI node has
109 // conflicting incoming values from the two switch blocks.
110 BasicBlock *SI1BB = SI1->getParent();
111 BasicBlock *SI2BB = SI2->getParent();
Chris Lattnerc9951232007-04-02 01:44:59 +0000112 SmallPtrSet<BasicBlock*, 16> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
Andrew Trick6b014382012-08-29 21:46:36 +0000113
Chris Lattner2bdcb562005-08-03 00:19:45 +0000114 for (succ_iterator I = succ_begin(SI2BB), E = succ_end(SI2BB); I != E; ++I)
115 if (SI1Succs.count(*I))
116 for (BasicBlock::iterator BBI = (*I)->begin();
117 isa<PHINode>(BBI); ++BBI) {
118 PHINode *PN = cast<PHINode>(BBI);
119 if (PN->getIncomingValueForBlock(SI1BB) !=
120 PN->getIncomingValueForBlock(SI2BB))
121 return false;
122 }
Andrew Trick6b014382012-08-29 21:46:36 +0000123
Chris Lattner2bdcb562005-08-03 00:19:45 +0000124 return true;
125}
126
Manman Renee28e0f2012-06-13 05:43:29 +0000127/// isProfitableToFoldUnconditional - Return true if it is safe and profitable
128/// to merge these two terminator instructions together, where SI1 is an
129/// unconditional branch. PhiNodes will store all PHI nodes in common
130/// successors.
131///
132static bool isProfitableToFoldUnconditional(BranchInst *SI1,
133 BranchInst *SI2,
Nick Lewyckyedb58422012-06-24 10:15:42 +0000134 Instruction *Cond,
Manman Renee28e0f2012-06-13 05:43:29 +0000135 SmallVectorImpl<PHINode*> &PhiNodes) {
136 if (SI1 == SI2) return false; // Can't merge with self!
137 assert(SI1->isUnconditional() && SI2->isConditional());
138
139 // We fold the unconditional branch if we can easily update all PHI nodes in
Andrew Trick6b014382012-08-29 21:46:36 +0000140 // common successors:
Manman Renee28e0f2012-06-13 05:43:29 +0000141 // 1> We have a constant incoming value for the conditional branch;
142 // 2> We have "Cond" as the incoming value for the unconditional branch;
143 // 3> SI2->getCondition() and Cond have same operands.
144 CmpInst *Ci2 = dyn_cast<CmpInst>(SI2->getCondition());
145 if (!Ci2) return false;
146 if (!(Cond->getOperand(0) == Ci2->getOperand(0) &&
147 Cond->getOperand(1) == Ci2->getOperand(1)) &&
148 !(Cond->getOperand(0) == Ci2->getOperand(1) &&
149 Cond->getOperand(1) == Ci2->getOperand(0)))
150 return false;
151
152 BasicBlock *SI1BB = SI1->getParent();
153 BasicBlock *SI2BB = SI2->getParent();
154 SmallPtrSet<BasicBlock*, 16> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
155 for (succ_iterator I = succ_begin(SI2BB), E = succ_end(SI2BB); I != E; ++I)
156 if (SI1Succs.count(*I))
157 for (BasicBlock::iterator BBI = (*I)->begin();
158 isa<PHINode>(BBI); ++BBI) {
159 PHINode *PN = cast<PHINode>(BBI);
160 if (PN->getIncomingValueForBlock(SI1BB) != Cond ||
Nick Lewyckyedb58422012-06-24 10:15:42 +0000161 !isa<ConstantInt>(PN->getIncomingValueForBlock(SI2BB)))
Manman Renee28e0f2012-06-13 05:43:29 +0000162 return false;
163 PhiNodes.push_back(PN);
164 }
165 return true;
166}
167
Chris Lattner2bdcb562005-08-03 00:19:45 +0000168/// AddPredecessorToBlock - Update PHI nodes in Succ to indicate that there will
169/// now be entries in it from the 'NewPred' block. The values that will be
170/// flowing into the PHI nodes will be the same as those coming in from
171/// ExistPred, an existing predecessor of Succ.
172static void AddPredecessorToBlock(BasicBlock *Succ, BasicBlock *NewPred,
173 BasicBlock *ExistPred) {
Chris Lattner2bdcb562005-08-03 00:19:45 +0000174 if (!isa<PHINode>(Succ->begin())) return; // Quick exit if nothing to do
Andrew Trick6b014382012-08-29 21:46:36 +0000175
Chris Lattner093a4382008-07-13 22:23:11 +0000176 PHINode *PN;
177 for (BasicBlock::iterator I = Succ->begin();
178 (PN = dyn_cast<PHINode>(I)); ++I)
179 PN->addIncoming(PN->getIncomingValueForBlock(ExistPred), NewPred);
Chris Lattner2bdcb562005-08-03 00:19:45 +0000180}
181
Chris Lattner7e663482005-08-03 00:11:16 +0000182
Chris Lattner73c50a62010-12-14 07:00:00 +0000183/// GetIfCondition - Given a basic block (BB) with two predecessors (and at
184/// least one PHI node in it), check to see if the merge at this block is due
Chris Lattner723c66d2004-02-11 03:36:04 +0000185/// to an "if condition". If so, return the boolean condition that determines
186/// which entry into BB will be taken. Also, return by references the block
187/// that will be entered from if the condition is true, and the block that will
188/// be entered if the condition is false.
Misha Brukmanfd939082005-04-21 23:48:37 +0000189///
Chris Lattner995ba1b2010-12-14 07:15:21 +0000190/// This does no checking to see if the true/false blocks have large or unsavory
191/// instructions in them.
Chris Lattner73c50a62010-12-14 07:00:00 +0000192static Value *GetIfCondition(BasicBlock *BB, BasicBlock *&IfTrue,
193 BasicBlock *&IfFalse) {
194 PHINode *SomePHI = cast<PHINode>(BB->begin());
195 assert(SomePHI->getNumIncomingValues() == 2 &&
Chris Lattner723c66d2004-02-11 03:36:04 +0000196 "Function can only handle blocks with 2 predecessors!");
Chris Lattner73c50a62010-12-14 07:00:00 +0000197 BasicBlock *Pred1 = SomePHI->getIncomingBlock(0);
198 BasicBlock *Pred2 = SomePHI->getIncomingBlock(1);
Chris Lattner723c66d2004-02-11 03:36:04 +0000199
200 // We can only handle branches. Other control flow will be lowered to
201 // branches if possible anyway.
Chris Lattner995ba1b2010-12-14 07:15:21 +0000202 BranchInst *Pred1Br = dyn_cast<BranchInst>(Pred1->getTerminator());
203 BranchInst *Pred2Br = dyn_cast<BranchInst>(Pred2->getTerminator());
204 if (Pred1Br == 0 || Pred2Br == 0)
Chris Lattner723c66d2004-02-11 03:36:04 +0000205 return 0;
Chris Lattner723c66d2004-02-11 03:36:04 +0000206
207 // Eliminate code duplication by ensuring that Pred1Br is conditional if
208 // either are.
209 if (Pred2Br->isConditional()) {
210 // If both branches are conditional, we don't have an "if statement". In
211 // reality, we could transform this case, but since the condition will be
212 // required anyway, we stand no chance of eliminating it, so the xform is
213 // probably not profitable.
214 if (Pred1Br->isConditional())
215 return 0;
216
217 std::swap(Pred1, Pred2);
218 std::swap(Pred1Br, Pred2Br);
219 }
220
221 if (Pred1Br->isConditional()) {
Chris Lattner995ba1b2010-12-14 07:15:21 +0000222 // The only thing we have to watch out for here is to make sure that Pred2
223 // doesn't have incoming edges from other blocks. If it does, the condition
224 // doesn't dominate BB.
225 if (Pred2->getSinglePredecessor() == 0)
226 return 0;
Andrew Trick6b014382012-08-29 21:46:36 +0000227
Chris Lattner723c66d2004-02-11 03:36:04 +0000228 // If we found a conditional branch predecessor, make sure that it branches
229 // to BB and Pred2Br. If it doesn't, this isn't an "if statement".
230 if (Pred1Br->getSuccessor(0) == BB &&
231 Pred1Br->getSuccessor(1) == Pred2) {
232 IfTrue = Pred1;
233 IfFalse = Pred2;
234 } else if (Pred1Br->getSuccessor(0) == Pred2 &&
235 Pred1Br->getSuccessor(1) == BB) {
236 IfTrue = Pred2;
237 IfFalse = Pred1;
238 } else {
239 // We know that one arm of the conditional goes to BB, so the other must
240 // go somewhere unrelated, and this must not be an "if statement".
241 return 0;
242 }
243
Chris Lattner723c66d2004-02-11 03:36:04 +0000244 return Pred1Br->getCondition();
245 }
246
247 // Ok, if we got here, both predecessors end with an unconditional branch to
248 // BB. Don't panic! If both blocks only have a single (identical)
249 // predecessor, and THAT is a conditional branch, then we're all ok!
Chris Lattner995ba1b2010-12-14 07:15:21 +0000250 BasicBlock *CommonPred = Pred1->getSinglePredecessor();
251 if (CommonPred == 0 || CommonPred != Pred2->getSinglePredecessor())
Chris Lattner723c66d2004-02-11 03:36:04 +0000252 return 0;
253
254 // Otherwise, if this is a conditional branch, then we can use it!
Chris Lattner995ba1b2010-12-14 07:15:21 +0000255 BranchInst *BI = dyn_cast<BranchInst>(CommonPred->getTerminator());
256 if (BI == 0) return 0;
Andrew Trick6b014382012-08-29 21:46:36 +0000257
Chris Lattner995ba1b2010-12-14 07:15:21 +0000258 assert(BI->isConditional() && "Two successors but not conditional?");
259 if (BI->getSuccessor(0) == Pred1) {
260 IfTrue = Pred1;
261 IfFalse = Pred2;
262 } else {
263 IfTrue = Pred2;
264 IfFalse = Pred1;
Chris Lattner723c66d2004-02-11 03:36:04 +0000265 }
Chris Lattner995ba1b2010-12-14 07:15:21 +0000266 return BI->getCondition();
Chris Lattner723c66d2004-02-11 03:36:04 +0000267}
268
Dan Gohman3b205172012-01-05 23:58:56 +0000269/// ComputeSpeculuationCost - Compute an abstract "cost" of speculating the
270/// given instruction, which is assumed to be safe to speculate. 1 means
271/// cheap, 2 means less cheap, and UINT_MAX means prohibitively expensive.
272static unsigned ComputeSpeculationCost(const User *I) {
273 assert(isSafeToSpeculativelyExecute(I) &&
274 "Instruction is not safe to speculatively execute!");
275 switch (Operator::getOpcode(I)) {
276 default:
277 // In doubt, be conservative.
278 return UINT_MAX;
279 case Instruction::GetElementPtr:
280 // GEPs are cheap if all indices are constant.
281 if (!cast<GEPOperator>(I)->hasAllConstantIndices())
282 return UINT_MAX;
283 return 1;
284 case Instruction::Load:
285 case Instruction::Add:
286 case Instruction::Sub:
287 case Instruction::And:
288 case Instruction::Or:
289 case Instruction::Xor:
290 case Instruction::Shl:
291 case Instruction::LShr:
292 case Instruction::AShr:
293 case Instruction::ICmp:
294 case Instruction::Trunc:
295 case Instruction::ZExt:
296 case Instruction::SExt:
297 return 1; // These are all cheap.
298
299 case Instruction::Call:
300 case Instruction::Select:
301 return 2;
302 }
303}
304
Bill Wendling5049fa62009-01-19 23:43:56 +0000305/// DominatesMergePoint - If we have a merge point of an "if condition" as
306/// accepted above, return true if the specified value dominates the block. We
307/// don't handle the true generality of domination here, just a special case
308/// which works well enough for us.
309///
310/// If AggressiveInsts is non-null, and if V does not dominate BB, we check to
Peter Collingbournef15907f2011-04-29 18:47:31 +0000311/// see if V (which must be an instruction) and its recursive operands
312/// that do not dominate BB have a combined cost lower than CostRemaining and
313/// are non-trapping. If both are true, the instruction is inserted into the
314/// set and true is returned.
315///
316/// The cost for most non-trapping instructions is defined as 1 except for
317/// Select whose cost is 2.
318///
319/// After this function returns, CostRemaining is decreased by the cost of
320/// V plus its non-dominating operands. If that cost is greater than
321/// CostRemaining, false is returned and CostRemaining is undefined.
Chris Lattner9c078662004-10-14 05:13:36 +0000322static bool DominatesMergePoint(Value *V, BasicBlock *BB,
Peter Collingbournef15907f2011-04-29 18:47:31 +0000323 SmallPtrSet<Instruction*, 4> *AggressiveInsts,
324 unsigned &CostRemaining) {
Chris Lattner570751c2004-04-09 22:50:22 +0000325 Instruction *I = dyn_cast<Instruction>(V);
Chris Lattnerb74b1812006-10-20 00:42:07 +0000326 if (!I) {
327 // Non-instructions all dominate instructions, but not all constantexprs
328 // can be executed unconditionally.
329 if (ConstantExpr *C = dyn_cast<ConstantExpr>(V))
330 if (C->canTrap())
331 return false;
332 return true;
333 }
Chris Lattner570751c2004-04-09 22:50:22 +0000334 BasicBlock *PBB = I->getParent();
Chris Lattner723c66d2004-02-11 03:36:04 +0000335
Chris Lattnerda895d62005-02-27 06:18:25 +0000336 // We don't want to allow weird loops that might have the "if condition" in
Chris Lattner570751c2004-04-09 22:50:22 +0000337 // the bottom of this block.
338 if (PBB == BB) return false;
Chris Lattner723c66d2004-02-11 03:36:04 +0000339
Chris Lattner570751c2004-04-09 22:50:22 +0000340 // If this instruction is defined in a block that contains an unconditional
341 // branch to BB, then it must be in the 'conditional' part of the "if
Chris Lattner44da7ca2010-12-14 07:41:39 +0000342 // statement". If not, it definitely dominates the region.
343 BranchInst *BI = dyn_cast<BranchInst>(PBB->getTerminator());
344 if (BI == 0 || BI->isConditional() || BI->getSuccessor(0) != BB)
345 return true;
Eli Friedman0b79a772009-07-17 04:28:42 +0000346
Chris Lattner44da7ca2010-12-14 07:41:39 +0000347 // If we aren't allowing aggressive promotion anymore, then don't consider
348 // instructions in the 'if region'.
349 if (AggressiveInsts == 0) return false;
Andrew Trick6b014382012-08-29 21:46:36 +0000350
Peter Collingbournef15907f2011-04-29 18:47:31 +0000351 // If we have seen this instruction before, don't count it again.
352 if (AggressiveInsts->count(I)) return true;
353
Chris Lattner44da7ca2010-12-14 07:41:39 +0000354 // Okay, it looks like the instruction IS in the "condition". Check to
355 // see if it's a cheap instruction to unconditionally compute, and if it
356 // only uses stuff defined outside of the condition. If so, hoist it out.
Dan Gohmanf0426602011-12-14 23:49:11 +0000357 if (!isSafeToSpeculativelyExecute(I))
Chris Lattner44da7ca2010-12-14 07:41:39 +0000358 return false;
Misha Brukmanfd939082005-04-21 23:48:37 +0000359
Dan Gohman3b205172012-01-05 23:58:56 +0000360 unsigned Cost = ComputeSpeculationCost(I);
Chris Lattner570751c2004-04-09 22:50:22 +0000361
Peter Collingbournef15907f2011-04-29 18:47:31 +0000362 if (Cost > CostRemaining)
363 return false;
364
365 CostRemaining -= Cost;
366
367 // Okay, we can only really hoist these out if their operands do
368 // not take us over the cost threshold.
Chris Lattner44da7ca2010-12-14 07:41:39 +0000369 for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i)
Peter Collingbournef15907f2011-04-29 18:47:31 +0000370 if (!DominatesMergePoint(*i, BB, AggressiveInsts, CostRemaining))
Chris Lattner44da7ca2010-12-14 07:41:39 +0000371 return false;
372 // Okay, it's safe to do this! Remember this instruction.
373 AggressiveInsts->insert(I);
Chris Lattner723c66d2004-02-11 03:36:04 +0000374 return true;
375}
Chris Lattner01d1ee32002-05-21 20:50:24 +0000376
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000377/// GetConstantInt - Extract ConstantInt from value, looking through IntToPtr
378/// and PointerNullValue. Return NULL if value is not a constant int.
Chris Lattner28acc132010-12-13 03:30:12 +0000379static ConstantInt *GetConstantInt(Value *V, const TargetData *TD) {
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000380 // Normal constant int.
381 ConstantInt *CI = dyn_cast<ConstantInt>(V);
Duncan Sands1df98592010-02-16 11:11:14 +0000382 if (CI || !TD || !isa<Constant>(V) || !V->getType()->isPointerTy())
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000383 return CI;
384
385 // This is some kind of pointer constant. Turn it into a pointer-sized
386 // ConstantInt if possible.
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000387 IntegerType *PtrTy = TD->getIntPtrType(V->getContext());
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000388
389 // Null pointer means 0, see SelectionDAGBuilder::getValue(const Value*).
390 if (isa<ConstantPointerNull>(V))
391 return ConstantInt::get(PtrTy, 0);
392
393 // IntToPtr const int.
394 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
395 if (CE->getOpcode() == Instruction::IntToPtr)
396 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(0))) {
397 // The constant is very likely to have the right type already.
398 if (CI->getType() == PtrTy)
399 return CI;
400 else
401 return cast<ConstantInt>
402 (ConstantExpr::getIntegerCast(CI, PtrTy, /*isSigned=*/false));
403 }
404 return 0;
405}
406
Chris Lattner0aa749b2010-12-13 04:26:26 +0000407/// GatherConstantCompares - Given a potentially 'or'd or 'and'd together
408/// collection of icmp eq/ne instructions that compare a value against a
409/// constant, return the value being compared, and stick the constant into the
410/// Values vector.
Chris Lattner28acc132010-12-13 03:30:12 +0000411static Value *
Chris Lattner0aa749b2010-12-13 04:26:26 +0000412GatherConstantCompares(Value *V, std::vector<ConstantInt*> &Vals, Value *&Extra,
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000413 const TargetData *TD, bool isEQ, unsigned &UsedICmps) {
Chris Lattner0aa749b2010-12-13 04:26:26 +0000414 Instruction *I = dyn_cast<Instruction>(V);
415 if (I == 0) return 0;
Andrew Trick6b014382012-08-29 21:46:36 +0000416
Chris Lattner7312a222010-12-13 04:50:38 +0000417 // If this is an icmp against a constant, handle this as one of the cases.
Chris Lattner0aa749b2010-12-13 04:26:26 +0000418 if (ICmpInst *ICI = dyn_cast<ICmpInst>(I)) {
Chris Lattnere27db742010-12-17 06:20:15 +0000419 if (ConstantInt *C = GetConstantInt(I->getOperand(1), TD)) {
420 if (ICI->getPredicate() == (isEQ ? ICmpInst::ICMP_EQ:ICmpInst::ICMP_NE)) {
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000421 UsedICmps++;
Chris Lattner0aa749b2010-12-13 04:26:26 +0000422 Vals.push_back(C);
423 return I->getOperand(0);
424 }
Andrew Trick6b014382012-08-29 21:46:36 +0000425
Chris Lattnere27db742010-12-17 06:20:15 +0000426 // If we have "x ult 3" comparison, for example, then we can add 0,1,2 to
427 // the set.
428 ConstantRange Span =
Chris Lattnera37029c2010-12-18 20:22:49 +0000429 ConstantRange::makeICmpRegion(ICI->getPredicate(), C->getValue());
Andrew Trick6b014382012-08-29 21:46:36 +0000430
Chris Lattnere27db742010-12-17 06:20:15 +0000431 // If this is an and/!= check then we want to optimize "x ugt 2" into
432 // x != 0 && x != 1.
433 if (!isEQ)
434 Span = Span.inverse();
Andrew Trick6b014382012-08-29 21:46:36 +0000435
Chris Lattnere27db742010-12-17 06:20:15 +0000436 // If there are a ton of values, we don't want to make a ginormous switch.
Nick Lewyckyf460bf82012-01-19 18:19:42 +0000437 if (Span.getSetSize().ugt(8) || Span.isEmptySet())
Chris Lattnere27db742010-12-17 06:20:15 +0000438 return 0;
Andrew Trick6b014382012-08-29 21:46:36 +0000439
Chris Lattnere27db742010-12-17 06:20:15 +0000440 for (APInt Tmp = Span.getLower(); Tmp != Span.getUpper(); ++Tmp)
441 Vals.push_back(ConstantInt::get(V->getContext(), Tmp));
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000442 UsedICmps++;
Chris Lattnere27db742010-12-17 06:20:15 +0000443 return I->getOperand(0);
444 }
Chris Lattner662269d2010-12-13 04:18:32 +0000445 return 0;
446 }
Andrew Trick6b014382012-08-29 21:46:36 +0000447
Chris Lattner7312a222010-12-13 04:50:38 +0000448 // Otherwise, we can only handle an | or &, depending on isEQ.
Chris Lattner0aa749b2010-12-13 04:26:26 +0000449 if (I->getOpcode() != (isEQ ? Instruction::Or : Instruction::And))
Chris Lattner662269d2010-12-13 04:18:32 +0000450 return 0;
Andrew Trick6b014382012-08-29 21:46:36 +0000451
Chris Lattner7312a222010-12-13 04:50:38 +0000452 unsigned NumValsBeforeLHS = Vals.size();
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000453 unsigned UsedICmpsBeforeLHS = UsedICmps;
Chris Lattner0aa749b2010-12-13 04:26:26 +0000454 if (Value *LHS = GatherConstantCompares(I->getOperand(0), Vals, Extra, TD,
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000455 isEQ, UsedICmps)) {
Chris Lattner7312a222010-12-13 04:50:38 +0000456 unsigned NumVals = Vals.size();
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000457 unsigned UsedICmpsBeforeRHS = UsedICmps;
Chris Lattner0aa749b2010-12-13 04:26:26 +0000458 if (Value *RHS = GatherConstantCompares(I->getOperand(1), Vals, Extra, TD,
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000459 isEQ, UsedICmps)) {
Chris Lattner0aa749b2010-12-13 04:26:26 +0000460 if (LHS == RHS)
461 return LHS;
Chris Lattner92407e52010-12-13 07:41:29 +0000462 Vals.resize(NumVals);
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000463 UsedICmps = UsedICmpsBeforeRHS;
Chris Lattner0aa749b2010-12-13 04:26:26 +0000464 }
Chris Lattner7312a222010-12-13 04:50:38 +0000465
466 // The RHS of the or/and can't be folded in and we haven't used "Extra" yet,
467 // set it and return success.
468 if (Extra == 0 || Extra == I->getOperand(1)) {
469 Extra = I->getOperand(1);
470 return LHS;
471 }
Andrew Trick6b014382012-08-29 21:46:36 +0000472
Chris Lattner7312a222010-12-13 04:50:38 +0000473 Vals.resize(NumValsBeforeLHS);
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000474 UsedICmps = UsedICmpsBeforeLHS;
Chris Lattner7312a222010-12-13 04:50:38 +0000475 return 0;
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000476 }
Andrew Trick6b014382012-08-29 21:46:36 +0000477
Chris Lattner7312a222010-12-13 04:50:38 +0000478 // If the LHS can't be folded in, but Extra is available and RHS can, try to
479 // use LHS as Extra.
480 if (Extra == 0 || Extra == I->getOperand(0)) {
Chris Lattner92407e52010-12-13 07:41:29 +0000481 Value *OldExtra = Extra;
Chris Lattner7312a222010-12-13 04:50:38 +0000482 Extra = I->getOperand(0);
483 if (Value *RHS = GatherConstantCompares(I->getOperand(1), Vals, Extra, TD,
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000484 isEQ, UsedICmps))
Chris Lattner7312a222010-12-13 04:50:38 +0000485 return RHS;
Chris Lattner92407e52010-12-13 07:41:29 +0000486 assert(Vals.size() == NumValsBeforeLHS);
487 Extra = OldExtra;
Chris Lattner7312a222010-12-13 04:50:38 +0000488 }
Andrew Trick6b014382012-08-29 21:46:36 +0000489
Chris Lattner0d560082004-02-24 05:38:11 +0000490 return 0;
491}
Nick Lewycky9d523102011-12-26 20:37:40 +0000492
Eli Friedman080efb82008-12-16 20:54:32 +0000493static void EraseTerminatorInstAndDCECond(TerminatorInst *TI) {
Nick Lewycky9d523102011-12-26 20:37:40 +0000494 Instruction *Cond = 0;
Eli Friedman080efb82008-12-16 20:54:32 +0000495 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
496 Cond = dyn_cast<Instruction>(SI->getCondition());
497 } else if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
498 if (BI->isConditional())
499 Cond = dyn_cast<Instruction>(BI->getCondition());
Frits van Bommel7ac40c32010-12-05 18:29:03 +0000500 } else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(TI)) {
501 Cond = dyn_cast<Instruction>(IBI->getAddress());
Eli Friedman080efb82008-12-16 20:54:32 +0000502 }
503
504 TI->eraseFromParent();
505 if (Cond) RecursivelyDeleteTriviallyDeadInstructions(Cond);
506}
507
Chris Lattner9fd49552008-11-27 23:25:44 +0000508/// isValueEqualityComparison - Return true if the specified terminator checks
509/// to see if a value is equal to constant integer value.
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000510Value *SimplifyCFGOpt::isValueEqualityComparison(TerminatorInst *TI) {
511 Value *CV = 0;
Chris Lattner4bebf082004-03-16 19:45:22 +0000512 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
513 // Do not permit merging of large switch instructions into their
514 // predecessors unless there is only one predecessor.
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000515 if (SI->getNumSuccessors()*std::distance(pred_begin(SI->getParent()),
516 pred_end(SI->getParent())) <= 128)
517 CV = SI->getCondition();
518 } else if (BranchInst *BI = dyn_cast<BranchInst>(TI))
Chris Lattner542f1492004-02-28 21:28:10 +0000519 if (BI->isConditional() && BI->getCondition()->hasOneUse())
Reid Spencere4d87aa2006-12-23 06:05:41 +0000520 if (ICmpInst *ICI = dyn_cast<ICmpInst>(BI->getCondition()))
521 if ((ICI->getPredicate() == ICmpInst::ICMP_EQ ||
522 ICI->getPredicate() == ICmpInst::ICMP_NE) &&
Chris Lattner28acc132010-12-13 03:30:12 +0000523 GetConstantInt(ICI->getOperand(1), TD))
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000524 CV = ICI->getOperand(0);
525
526 // Unwrap any lossless ptrtoint cast.
527 if (TD && CV && CV->getType() == TD->getIntPtrType(CV->getContext()))
528 if (PtrToIntInst *PTII = dyn_cast<PtrToIntInst>(CV))
529 CV = PTII->getOperand(0);
530 return CV;
Chris Lattner542f1492004-02-28 21:28:10 +0000531}
532
Bill Wendling5049fa62009-01-19 23:43:56 +0000533/// GetValueEqualityComparisonCases - Given a value comparison instruction,
534/// decode all of the 'cases' that it represents and return the 'default' block.
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000535BasicBlock *SimplifyCFGOpt::
Misha Brukmanfd939082005-04-21 23:48:37 +0000536GetValueEqualityComparisonCases(TerminatorInst *TI,
Eric Christopherc723eb12012-07-02 23:22:21 +0000537 std::vector<ValueEqualityComparisonCase>
538 &Cases) {
Chris Lattner542f1492004-02-28 21:28:10 +0000539 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Eric Christopherc723eb12012-07-02 23:22:21 +0000540 Cases.reserve(SI->getNumCases());
541 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end(); i != e; ++i)
542 Cases.push_back(ValueEqualityComparisonCase(i.getCaseValue(),
543 i.getCaseSuccessor()));
Chris Lattner542f1492004-02-28 21:28:10 +0000544 return SI->getDefaultDest();
545 }
Eric Christopherc723eb12012-07-02 23:22:21 +0000546
Chris Lattner542f1492004-02-28 21:28:10 +0000547 BranchInst *BI = cast<BranchInst>(TI);
Reid Spencere4d87aa2006-12-23 06:05:41 +0000548 ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
Eric Christopherc723eb12012-07-02 23:22:21 +0000549 BasicBlock *Succ = BI->getSuccessor(ICI->getPredicate() == ICmpInst::ICMP_NE);
550 Cases.push_back(ValueEqualityComparisonCase(GetConstantInt(ICI->getOperand(1),
551 TD),
552 Succ));
Reid Spencere4d87aa2006-12-23 06:05:41 +0000553 return BI->getSuccessor(ICI->getPredicate() == ICmpInst::ICMP_EQ);
Chris Lattner542f1492004-02-28 21:28:10 +0000554}
555
Eric Christopherc723eb12012-07-02 23:22:21 +0000556
557/// EliminateBlockCases - Given a vector of bb/value pairs, remove any entries
558/// in the list that match the specified block.
559static void EliminateBlockCases(BasicBlock *BB,
560 std::vector<ValueEqualityComparisonCase> &Cases) {
561 for (unsigned i = 0, e = Cases.size(); i != e; ++i)
562 if (Cases[i].Dest == BB) {
563 Cases.erase(Cases.begin()+i);
564 --i; --e;
565 }
566}
567
568/// ValuesOverlap - Return true if there are any keys in C1 that exist in C2 as
569/// well.
570static bool
571ValuesOverlap(std::vector<ValueEqualityComparisonCase> &C1,
572 std::vector<ValueEqualityComparisonCase > &C2) {
573 std::vector<ValueEqualityComparisonCase> *V1 = &C1, *V2 = &C2;
574
575 // Make V1 be smaller than V2.
576 if (V1->size() > V2->size())
577 std::swap(V1, V2);
578
579 if (V1->size() == 0) return false;
580 if (V1->size() == 1) {
581 // Just scan V2.
582 ConstantInt *TheVal = (*V1)[0].Value;
583 for (unsigned i = 0, e = V2->size(); i != e; ++i)
584 if (TheVal == (*V2)[i].Value)
585 return true;
586 }
587
588 // Otherwise, just sort both lists and compare element by element.
589 array_pod_sort(V1->begin(), V1->end());
590 array_pod_sort(V2->begin(), V2->end());
591 unsigned i1 = 0, i2 = 0, e1 = V1->size(), e2 = V2->size();
592 while (i1 != e1 && i2 != e2) {
593 if ((*V1)[i1].Value == (*V2)[i2].Value)
594 return true;
595 if ((*V1)[i1].Value < (*V2)[i2].Value)
596 ++i1;
597 else
598 ++i2;
599 }
600 return false;
601}
602
Bill Wendling5049fa62009-01-19 23:43:56 +0000603/// SimplifyEqualityComparisonWithOnlyPredecessor - If TI is known to be a
604/// terminator instruction and its block is known to only have a single
605/// predecessor block, check to see if that predecessor is also a value
606/// comparison with the same value, and if that comparison determines the
607/// outcome of this comparison. If so, simplify TI. This does a very limited
608/// form of jump threading.
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000609bool SimplifyCFGOpt::
610SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
Devang Patel007349d2011-05-18 20:35:38 +0000611 BasicBlock *Pred,
612 IRBuilder<> &Builder) {
Chris Lattner623369a2005-02-24 06:17:52 +0000613 Value *PredVal = isValueEqualityComparison(Pred->getTerminator());
614 if (!PredVal) return false; // Not a value comparison in predecessor.
615
616 Value *ThisVal = isValueEqualityComparison(TI);
617 assert(ThisVal && "This isn't a value comparison!!");
618 if (ThisVal != PredVal) return false; // Different predicates.
619
Andrew Trickb1b97832012-08-29 21:46:38 +0000620 // TODO: Preserve branch weight metadata, similarly to how
621 // FoldValueComparisonIntoPredecessors preserves it.
622
Chris Lattner623369a2005-02-24 06:17:52 +0000623 // Find out information about when control will move from Pred to TI's block.
Eric Christopherc723eb12012-07-02 23:22:21 +0000624 std::vector<ValueEqualityComparisonCase> PredCases;
Chris Lattner623369a2005-02-24 06:17:52 +0000625 BasicBlock *PredDef = GetValueEqualityComparisonCases(Pred->getTerminator(),
626 PredCases);
Eric Christopherc723eb12012-07-02 23:22:21 +0000627 EliminateBlockCases(PredDef, PredCases); // Remove default from cases.
Misha Brukmanfd939082005-04-21 23:48:37 +0000628
Chris Lattner623369a2005-02-24 06:17:52 +0000629 // Find information about how control leaves this block.
Eric Christopherc723eb12012-07-02 23:22:21 +0000630 std::vector<ValueEqualityComparisonCase> ThisCases;
Chris Lattner623369a2005-02-24 06:17:52 +0000631 BasicBlock *ThisDef = GetValueEqualityComparisonCases(TI, ThisCases);
Eric Christopherc723eb12012-07-02 23:22:21 +0000632 EliminateBlockCases(ThisDef, ThisCases); // Remove default from cases.
Chris Lattner623369a2005-02-24 06:17:52 +0000633
634 // If TI's block is the default block from Pred's comparison, potentially
635 // simplify TI based on this knowledge.
636 if (PredDef == TI->getParent()) {
637 // If we are here, we know that the value is none of those cases listed in
638 // PredCases. If there are any cases in ThisCases that are in PredCases, we
639 // can simplify TI.
Eric Christopherc723eb12012-07-02 23:22:21 +0000640 if (!ValuesOverlap(PredCases, ThisCases))
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000641 return false;
Andrew Trick6b014382012-08-29 21:46:36 +0000642
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000643 if (isa<BranchInst>(TI)) {
644 // Okay, one of the successors of this condbr is dead. Convert it to a
645 // uncond br.
646 assert(ThisCases.size() == 1 && "Branch can only have one case!");
647 // Insert the new branch.
Devang Patel007349d2011-05-18 20:35:38 +0000648 Instruction *NI = Builder.CreateBr(ThisDef);
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000649 (void) NI;
Chris Lattner623369a2005-02-24 06:17:52 +0000650
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000651 // Remove PHI node entries for the dead edge.
Eric Christopherc723eb12012-07-02 23:22:21 +0000652 ThisCases[0].Dest->removePredecessor(TI->getParent());
Chris Lattner623369a2005-02-24 06:17:52 +0000653
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000654 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
655 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
Chris Lattner623369a2005-02-24 06:17:52 +0000656
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000657 EraseTerminatorInstAndDCECond(TI);
658 return true;
Chris Lattner623369a2005-02-24 06:17:52 +0000659 }
Andrew Trick6b014382012-08-29 21:46:36 +0000660
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000661 SwitchInst *SI = cast<SwitchInst>(TI);
662 // Okay, TI has cases that are statically dead, prune them away.
Eric Christopherc723eb12012-07-02 23:22:21 +0000663 SmallPtrSet<Constant*, 16> DeadCases;
664 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
665 DeadCases.insert(PredCases[i].Value);
Chris Lattner623369a2005-02-24 06:17:52 +0000666
David Greene89d6fd32010-01-05 01:26:52 +0000667 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000668 << "Through successor TI: " << *TI);
Chris Lattner623369a2005-02-24 06:17:52 +0000669
Eric Christopherc723eb12012-07-02 23:22:21 +0000670 for (SwitchInst::CaseIt i = SI->case_end(), e = SI->case_begin(); i != e;) {
671 --i;
672 if (DeadCases.count(i.getCaseValue())) {
673 i.getCaseSuccessor()->removePredecessor(TI->getParent());
674 SI->removeCase(i);
675 }
676 }
677
678 DEBUG(dbgs() << "Leaving: " << *TI << "\n");
Chris Lattner623369a2005-02-24 06:17:52 +0000679 return true;
680 }
Andrew Trick6b014382012-08-29 21:46:36 +0000681
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000682 // Otherwise, TI's block must correspond to some matched value. Find out
683 // which value (or set of values) this is.
Eric Christopherc723eb12012-07-02 23:22:21 +0000684 ConstantInt *TIV = 0;
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000685 BasicBlock *TIBB = TI->getParent();
Eric Christopherc723eb12012-07-02 23:22:21 +0000686 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
687 if (PredCases[i].Dest == TIBB) {
688 if (TIV != 0)
689 return false; // Cannot handle multiple values coming to this block.
690 TIV = PredCases[i].Value;
691 }
692 assert(TIV && "No edge from pred to succ?");
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000693
694 // Okay, we found the one constant that our value can be if we get into TI's
695 // BB. Find out which successor will unconditionally be branched to.
Eric Christopherc723eb12012-07-02 23:22:21 +0000696 BasicBlock *TheRealDest = 0;
697 for (unsigned i = 0, e = ThisCases.size(); i != e; ++i)
698 if (ThisCases[i].Value == TIV) {
699 TheRealDest = ThisCases[i].Dest;
700 break;
701 }
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000702
703 // If not handled by any explicit cases, it is handled by the default case.
704 if (TheRealDest == 0) TheRealDest = ThisDef;
705
706 // Remove PHI node entries for dead edges.
707 BasicBlock *CheckEdge = TheRealDest;
708 for (succ_iterator SI = succ_begin(TIBB), e = succ_end(TIBB); SI != e; ++SI)
709 if (*SI != CheckEdge)
710 (*SI)->removePredecessor(TIBB);
711 else
712 CheckEdge = 0;
713
714 // Insert the new branch.
Devang Patel007349d2011-05-18 20:35:38 +0000715 Instruction *NI = Builder.CreateBr(TheRealDest);
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000716 (void) NI;
717
718 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
719 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
720
721 EraseTerminatorInstAndDCECond(TI);
722 return true;
Chris Lattner623369a2005-02-24 06:17:52 +0000723}
724
Dale Johannesenc81f5442009-03-12 21:01:11 +0000725namespace {
726 /// ConstantIntOrdering - This class implements a stable ordering of constant
727 /// integers that does not depend on their address. This is important for
728 /// applications that sort ConstantInt's to ensure uniqueness.
729 struct ConstantIntOrdering {
730 bool operator()(const ConstantInt *LHS, const ConstantInt *RHS) const {
731 return LHS->getValue().ult(RHS->getValue());
732 }
733 };
734}
Dale Johannesena9537cf2009-03-12 01:00:26 +0000735
Chris Lattner6d4d21e2010-12-13 02:00:58 +0000736static int ConstantIntSortPredicate(const void *P1, const void *P2) {
Roman Divacky59324292012-09-05 22:26:57 +0000737 const ConstantInt *LHS = *(const ConstantInt*const*)P1;
738 const ConstantInt *RHS = *(const ConstantInt*const*)P2;
Chris Lattnerba3c8152010-12-15 04:52:41 +0000739 if (LHS->getValue().ult(RHS->getValue()))
740 return 1;
741 if (LHS->getValue() == RHS->getValue())
742 return 0;
743 return -1;
Chris Lattner6d4d21e2010-12-13 02:00:58 +0000744}
745
Andrew Trickb1b97832012-08-29 21:46:38 +0000746static inline bool HasBranchWeights(const Instruction* I) {
747 MDNode* ProfMD = I->getMetadata(LLVMContext::MD_prof);
748 if (ProfMD && ProfMD->getOperand(0))
749 if (MDString* MDS = dyn_cast<MDString>(ProfMD->getOperand(0)))
750 return MDS->getString().equals("branch_weights");
751
752 return false;
753}
754
755/// Tries to get a branch weight for the given instruction, returns NULL if it
756/// can't. Pos starts at 0.
757static ConstantInt* GetWeight(Instruction* I, int Pos) {
758 MDNode* ProfMD = I->getMetadata(LLVMContext::MD_prof);
759 if (ProfMD && ProfMD->getOperand(0)) {
760 if (MDString* MDS = dyn_cast<MDString>(ProfMD->getOperand(0))) {
761 if (MDS->getString().equals("branch_weights")) {
762 assert(ProfMD->getNumOperands() >= 3);
763 return dyn_cast<ConstantInt>(ProfMD->getOperand(1 + Pos));
764 }
765 }
766 }
767
768 return 0;
769}
770
Michael Ilseman74980782012-08-30 15:45:16 +0000771/// Scale the given weights based on the successor TI's metadata. Scaling is
772/// done by multiplying every weight by the sum of the successor's weights.
Andrew Trickb1b97832012-08-29 21:46:38 +0000773static void ScaleWeights(Instruction* STI, MutableArrayRef<uint64_t> Weights) {
774 // Sum the successor's weights
775 assert(HasBranchWeights(STI));
776 unsigned Scale = 0;
777 MDNode* ProfMD = STI->getMetadata(LLVMContext::MD_prof);
778 for (unsigned i = 1; i < ProfMD->getNumOperands(); ++i) {
779 ConstantInt* CI = dyn_cast<ConstantInt>(ProfMD->getOperand(i));
780 assert(CI);
781 Scale += CI->getValue().getZExtValue();
782 }
783
784 // Skip default, as it's replaced during the folding
785 for (unsigned i = 1; i < Weights.size(); ++i) {
786 Weights[i] *= Scale;
787 }
788}
789
790/// Sees if any of the weights are too big for a uint32_t, and halves all the
791/// weights if any are.
792static void FitWeights(MutableArrayRef<uint64_t> Weights) {
793 bool Halve = false;
794 for (unsigned i = 0; i < Weights.size(); ++i)
795 if (Weights[i] > UINT_MAX) {
796 Halve = true;
797 break;
798 }
799
800 if (! Halve)
801 return;
802
803 for (unsigned i = 0; i < Weights.size(); ++i)
804 Weights[i] /= 2;
805}
806
Bill Wendling5049fa62009-01-19 23:43:56 +0000807/// FoldValueComparisonIntoPredecessors - The specified terminator is a value
808/// equality comparison instruction (either a switch or a branch on "X == c").
809/// See if any of the predecessors of the terminator block are value comparisons
810/// on the same value. If so, and if safe to do so, fold them together.
Devang Patelb55d9242011-05-18 20:53:17 +0000811bool SimplifyCFGOpt::FoldValueComparisonIntoPredecessors(TerminatorInst *TI,
812 IRBuilder<> &Builder) {
Chris Lattner542f1492004-02-28 21:28:10 +0000813 BasicBlock *BB = TI->getParent();
814 Value *CV = isValueEqualityComparison(TI); // CondVal
815 assert(CV && "Not a comparison?");
816 bool Changed = false;
817
Chris Lattner82442432008-02-18 07:42:56 +0000818 SmallVector<BasicBlock*, 16> Preds(pred_begin(BB), pred_end(BB));
Chris Lattner542f1492004-02-28 21:28:10 +0000819 while (!Preds.empty()) {
Dan Gohmane9d87f42009-05-06 17:22:41 +0000820 BasicBlock *Pred = Preds.pop_back_val();
Misha Brukmanfd939082005-04-21 23:48:37 +0000821
Chris Lattner542f1492004-02-28 21:28:10 +0000822 // See if the predecessor is a comparison with the same value.
823 TerminatorInst *PTI = Pred->getTerminator();
824 Value *PCV = isValueEqualityComparison(PTI); // PredCondVal
825
826 if (PCV == CV && SafeToMergeTerminators(TI, PTI)) {
827 // Figure out which 'cases' to copy from SI to PSI.
Eric Christopherc723eb12012-07-02 23:22:21 +0000828 std::vector<ValueEqualityComparisonCase> BBCases;
Chris Lattner542f1492004-02-28 21:28:10 +0000829 BasicBlock *BBDefault = GetValueEqualityComparisonCases(TI, BBCases);
830
Eric Christopherc723eb12012-07-02 23:22:21 +0000831 std::vector<ValueEqualityComparisonCase> PredCases;
Chris Lattner542f1492004-02-28 21:28:10 +0000832 BasicBlock *PredDefault = GetValueEqualityComparisonCases(PTI, PredCases);
833
834 // Based on whether the default edge from PTI goes to BB or not, fill in
835 // PredCases and PredDefault with the new switch cases we would like to
836 // build.
Chris Lattner82442432008-02-18 07:42:56 +0000837 SmallVector<BasicBlock*, 8> NewSuccessors;
Chris Lattner542f1492004-02-28 21:28:10 +0000838
Andrew Trickb1b97832012-08-29 21:46:38 +0000839 // Update the branch weight metadata along the way
840 SmallVector<uint64_t, 8> Weights;
841 uint64_t PredDefaultWeight = 0;
842 bool PredHasWeights = HasBranchWeights(PTI);
843 bool SuccHasWeights = HasBranchWeights(TI);
844
845 if (PredHasWeights) {
846 MDNode* MD = PTI->getMetadata(LLVMContext::MD_prof);
847 assert(MD);
848 for (unsigned i = 1, e = MD->getNumOperands(); i < e; ++i) {
849 ConstantInt* CI = dyn_cast<ConstantInt>(MD->getOperand(i));
850 assert(CI);
851 Weights.push_back(CI->getValue().getZExtValue());
852 }
853
854 // If the predecessor is a conditional eq, then swap the default weight
855 // to be the first entry.
856 if (BranchInst* BI = dyn_cast<BranchInst>(PTI)) {
857 assert(Weights.size() == 2);
858 ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
859
860 if (ICI->getPredicate() == ICmpInst::ICMP_EQ) {
861 std::swap(Weights.front(), Weights.back());
862 }
863 }
864
865 PredDefaultWeight = Weights.front();
866 } else if (SuccHasWeights) {
867 // 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);
871 PredDefaultWeight = 1;
872 }
873
874 uint64_t SuccDefaultWeight = 0;
875 if (SuccHasWeights) {
876 int Index = 0;
877 if (BranchInst* BI = dyn_cast<BranchInst>(TI)) {
878 ICmpInst* ICI = dyn_cast<ICmpInst>(BI->getCondition());
879 assert(ICI);
880
881 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
882 Index = 1;
883 }
884
885 SuccDefaultWeight = GetWeight(TI, Index)->getValue().getZExtValue();
886 }
887
Chris Lattner542f1492004-02-28 21:28:10 +0000888 if (PredDefault == BB) {
889 // If this is the default destination from PTI, only the edges in TI
890 // that don't occur in PTI, or that branch to BB will be activated.
Eric Christopherc723eb12012-07-02 23:22:21 +0000891 std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
892 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
893 if (PredCases[i].Dest != BB)
894 PTIHandled.insert(PredCases[i].Value);
895 else {
896 // The default destination is BB, we don't need explicit targets.
897 std::swap(PredCases[i], PredCases.back());
Andrew Trickb1b97832012-08-29 21:46:38 +0000898
899 if (PredHasWeights) {
900 std::swap(Weights[i+1], Weights.back());
901 Weights.pop_back();
902 }
903
Eric Christopherc723eb12012-07-02 23:22:21 +0000904 PredCases.pop_back();
905 --i; --e;
906 }
Chris Lattner542f1492004-02-28 21:28:10 +0000907
Eric Christopherc723eb12012-07-02 23:22:21 +0000908 // Reconstruct the new switch statement we will be building.
Chris Lattner542f1492004-02-28 21:28:10 +0000909 if (PredDefault != BBDefault) {
910 PredDefault->removePredecessor(Pred);
911 PredDefault = BBDefault;
912 NewSuccessors.push_back(BBDefault);
913 }
Andrew Trickb1b97832012-08-29 21:46:38 +0000914
915 if (SuccHasWeights) {
916 ScaleWeights(TI, Weights);
917 Weights.front() *= SuccDefaultWeight;
918 } else if (PredHasWeights) {
919 Weights.front() /= (1 + BBCases.size());
920 }
921
Eric Christopherc723eb12012-07-02 23:22:21 +0000922 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
923 if (!PTIHandled.count(BBCases[i].Value) &&
924 BBCases[i].Dest != BBDefault) {
925 PredCases.push_back(BBCases[i]);
926 NewSuccessors.push_back(BBCases[i].Dest);
Andrew Trickb1b97832012-08-29 21:46:38 +0000927 if (SuccHasWeights) {
928 Weights.push_back(PredDefaultWeight *
929 GetWeight(TI, i)->getValue().getZExtValue());
930 } else if (PredHasWeights) {
931 // Split the old default's weight amongst the children
Andrew Trickb1b97832012-08-29 21:46:38 +0000932 Weights.push_back(PredDefaultWeight / (1 + BBCases.size()));
933 }
Eric Christopherc723eb12012-07-02 23:22:21 +0000934 }
Chris Lattner542f1492004-02-28 21:28:10 +0000935
936 } else {
Andrew Trickb1b97832012-08-29 21:46:38 +0000937 // FIXME: preserve branch weight metadata, similarly to the 'then'
938 // above. For now, drop it.
939 PredHasWeights = false;
940 SuccHasWeights = false;
941
Chris Lattner542f1492004-02-28 21:28:10 +0000942 // If this is not the default destination from PSI, only the edges
943 // in SI that occur in PSI with a destination of BB will be
944 // activated.
Eric Christopherc723eb12012-07-02 23:22:21 +0000945 std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
946 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
947 if (PredCases[i].Dest == BB) {
948 PTIHandled.insert(PredCases[i].Value);
949 std::swap(PredCases[i], PredCases.back());
950 PredCases.pop_back();
951 --i; --e;
952 }
Chris Lattner542f1492004-02-28 21:28:10 +0000953
954 // Okay, now we know which constants were sent to BB from the
955 // predecessor. Figure out where they will all go now.
Eric Christopherc723eb12012-07-02 23:22:21 +0000956 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
957 if (PTIHandled.count(BBCases[i].Value)) {
958 // If this is one we are capable of getting...
959 PredCases.push_back(BBCases[i]);
960 NewSuccessors.push_back(BBCases[i].Dest);
961 PTIHandled.erase(BBCases[i].Value);// This constant is taken care of
962 }
963
Chris Lattner542f1492004-02-28 21:28:10 +0000964 // If there are any constants vectored to BB that TI doesn't handle,
965 // they must go to the default destination of TI.
Andrew Trick6b014382012-08-29 21:46:36 +0000966 for (std::set<ConstantInt*, ConstantIntOrdering>::iterator I =
Eric Christopherc723eb12012-07-02 23:22:21 +0000967 PTIHandled.begin(),
968 E = PTIHandled.end(); I != E; ++I) {
969 PredCases.push_back(ValueEqualityComparisonCase(*I, BBDefault));
Chris Lattner542f1492004-02-28 21:28:10 +0000970 NewSuccessors.push_back(BBDefault);
Eric Christopherc723eb12012-07-02 23:22:21 +0000971 }
Chris Lattner542f1492004-02-28 21:28:10 +0000972 }
973
974 // Okay, at this point, we know which new successor Pred will get. Make
975 // sure we update the number of entries in the PHI nodes for these
976 // successors.
977 for (unsigned i = 0, e = NewSuccessors.size(); i != e; ++i)
978 AddPredecessorToBlock(NewSuccessors[i], Pred, BB);
979
Devang Patelb55d9242011-05-18 20:53:17 +0000980 Builder.SetInsertPoint(PTI);
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000981 // Convert pointer to int before we switch.
Duncan Sands1df98592010-02-16 11:11:14 +0000982 if (CV->getType()->isPointerTy()) {
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000983 assert(TD && "Cannot switch on pointer without TargetData");
Devang Patelb55d9242011-05-18 20:53:17 +0000984 CV = Builder.CreatePtrToInt(CV, TD->getIntPtrType(CV->getContext()),
985 "magicptr");
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000986 }
987
Chris Lattner542f1492004-02-28 21:28:10 +0000988 // Now that the successors are updated, create the new Switch instruction.
Devang Patelb55d9242011-05-18 20:53:17 +0000989 SwitchInst *NewSI = Builder.CreateSwitch(CV, PredDefault,
990 PredCases.size());
Devang Pateld80e8ed2011-05-17 23:29:05 +0000991 NewSI->setDebugLoc(PTI->getDebugLoc());
Eric Christopherc723eb12012-07-02 23:22:21 +0000992 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
993 NewSI->addCase(PredCases[i].Value, PredCases[i].Dest);
Chris Lattner13b2f762005-01-01 16:02:12 +0000994
Andrew Trickb1b97832012-08-29 21:46:38 +0000995 if (PredHasWeights || SuccHasWeights) {
996 // Halve the weights if any of them cannot fit in an uint32_t
997 FitWeights(Weights);
998
999 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
1000
1001 NewSI->setMetadata(LLVMContext::MD_prof,
1002 MDBuilder(BB->getContext()).
1003 createBranchWeights(MDWeights));
1004 }
1005
Eli Friedman080efb82008-12-16 20:54:32 +00001006 EraseTerminatorInstAndDCECond(PTI);
Chris Lattner13b2f762005-01-01 16:02:12 +00001007
Chris Lattner542f1492004-02-28 21:28:10 +00001008 // Okay, last check. If BB is still a successor of PSI, then we must
1009 // have an infinite loop case. If so, add an infinitely looping block
1010 // to handle the case to preserve the behavior of the code.
1011 BasicBlock *InfLoopBlock = 0;
1012 for (unsigned i = 0, e = NewSI->getNumSuccessors(); i != e; ++i)
1013 if (NewSI->getSuccessor(i) == BB) {
1014 if (InfLoopBlock == 0) {
Chris Lattner093a4382008-07-13 22:23:11 +00001015 // Insert it at the end of the function, because it's either code,
Chris Lattner542f1492004-02-28 21:28:10 +00001016 // or it won't matter if it's hot. :)
Owen Anderson1d0be152009-08-13 21:58:54 +00001017 InfLoopBlock = BasicBlock::Create(BB->getContext(),
1018 "infloop", BB->getParent());
Gabor Greif051a9502008-04-06 20:25:17 +00001019 BranchInst::Create(InfLoopBlock, InfLoopBlock);
Chris Lattner542f1492004-02-28 21:28:10 +00001020 }
1021 NewSI->setSuccessor(i, InfLoopBlock);
1022 }
Misha Brukmanfd939082005-04-21 23:48:37 +00001023
Chris Lattner542f1492004-02-28 21:28:10 +00001024 Changed = true;
1025 }
1026 }
1027 return Changed;
1028}
1029
Dale Johannesenc1f10402009-06-15 20:59:27 +00001030// isSafeToHoistInvoke - If we would need to insert a select that uses the
1031// value of this invoke (comments in HoistThenElseCodeToIf explain why we
1032// would need to do this), we can't hoist the invoke, as there is nowhere
1033// to put the select in this case.
1034static bool isSafeToHoistInvoke(BasicBlock *BB1, BasicBlock *BB2,
1035 Instruction *I1, Instruction *I2) {
1036 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
1037 PHINode *PN;
1038 for (BasicBlock::iterator BBI = SI->begin();
1039 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
1040 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1041 Value *BB2V = PN->getIncomingValueForBlock(BB2);
1042 if (BB1V != BB2V && (BB1V==I1 || BB2V==I2)) {
1043 return false;
1044 }
1045 }
1046 }
1047 return true;
1048}
1049
Chris Lattner6306d072005-08-03 17:59:45 +00001050/// HoistThenElseCodeToIf - Given a conditional branch that goes to BB1 and
Chris Lattner37dc9382004-11-30 00:29:14 +00001051/// BB2, hoist any common code in the two blocks up into the branch block. The
1052/// caller of this function guarantees that BI's block dominates BB1 and BB2.
Rafael Espindola216dde92011-05-19 02:26:30 +00001053static bool HoistThenElseCodeToIf(BranchInst *BI) {
Chris Lattner37dc9382004-11-30 00:29:14 +00001054 // This does very trivial matching, with limited scanning, to find identical
1055 // instructions in the two blocks. In particular, we don't want to get into
1056 // O(M*N) situations here where M and N are the sizes of BB1 and BB2. As
1057 // such, we currently just scan for obviously identical instructions in an
1058 // identical order.
1059 BasicBlock *BB1 = BI->getSuccessor(0); // The true destination.
1060 BasicBlock *BB2 = BI->getSuccessor(1); // The false destination
1061
Devang Patel65085cf2009-02-04 00:03:08 +00001062 BasicBlock::iterator BB1_Itr = BB1->begin();
1063 BasicBlock::iterator BB2_Itr = BB2->begin();
1064
1065 Instruction *I1 = BB1_Itr++, *I2 = BB2_Itr++;
Devang Patel949666e2011-04-07 17:27:36 +00001066 // Skip debug info if it is not identical.
1067 DbgInfoIntrinsic *DBI1 = dyn_cast<DbgInfoIntrinsic>(I1);
1068 DbgInfoIntrinsic *DBI2 = dyn_cast<DbgInfoIntrinsic>(I2);
1069 if (!DBI1 || !DBI2 || !DBI1->isIdenticalToWhenDefined(DBI2)) {
1070 while (isa<DbgInfoIntrinsic>(I1))
1071 I1 = BB1_Itr++;
1072 while (isa<DbgInfoIntrinsic>(I2))
1073 I2 = BB2_Itr++;
1074 }
Devang Patelae6c95b2011-04-07 00:30:15 +00001075 if (isa<PHINode>(I1) || !I1->isIdenticalToWhenDefined(I2) ||
Dale Johannesenc1f10402009-06-15 20:59:27 +00001076 (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2)))
Chris Lattner37dc9382004-11-30 00:29:14 +00001077 return false;
1078
1079 // If we get here, we can hoist at least one instruction.
1080 BasicBlock *BIParent = BI->getParent();
Chris Lattner37dc9382004-11-30 00:29:14 +00001081
1082 do {
1083 // If we are hoisting the terminator instruction, don't move one (making a
1084 // broken BB), instead clone it, and remove BI.
1085 if (isa<TerminatorInst>(I1))
1086 goto HoistTerminator;
Misha Brukmanfd939082005-04-21 23:48:37 +00001087
Chris Lattner37dc9382004-11-30 00:29:14 +00001088 // For a normal instruction, we just move one to right before the branch,
1089 // then replace all uses of the other with the first. Finally, we remove
1090 // the now redundant second instruction.
1091 BIParent->getInstList().splice(BI, BB1->getInstList(), I1);
1092 if (!I2->use_empty())
1093 I2->replaceAllUsesWith(I1);
Dan Gohman58cfa3b2009-08-25 22:11:20 +00001094 I1->intersectOptionalDataWith(I2);
Chris Lattner302ba6f2010-12-14 06:17:25 +00001095 I2->eraseFromParent();
Misha Brukmanfd939082005-04-21 23:48:37 +00001096
Devang Patel65085cf2009-02-04 00:03:08 +00001097 I1 = BB1_Itr++;
Devang Patel65085cf2009-02-04 00:03:08 +00001098 I2 = BB2_Itr++;
Devang Patel949666e2011-04-07 17:27:36 +00001099 // Skip debug info if it is not identical.
1100 DbgInfoIntrinsic *DBI1 = dyn_cast<DbgInfoIntrinsic>(I1);
1101 DbgInfoIntrinsic *DBI2 = dyn_cast<DbgInfoIntrinsic>(I2);
1102 if (!DBI1 || !DBI2 || !DBI1->isIdenticalToWhenDefined(DBI2)) {
1103 while (isa<DbgInfoIntrinsic>(I1))
1104 I1 = BB1_Itr++;
1105 while (isa<DbgInfoIntrinsic>(I2))
1106 I2 = BB2_Itr++;
1107 }
Devang Patelae6c95b2011-04-07 00:30:15 +00001108 } while (I1->isIdenticalToWhenDefined(I2));
Chris Lattner37dc9382004-11-30 00:29:14 +00001109
1110 return true;
1111
1112HoistTerminator:
Dale Johannesenc1f10402009-06-15 20:59:27 +00001113 // It may not be possible to hoist an invoke.
1114 if (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2))
1115 return true;
1116
Chris Lattner37dc9382004-11-30 00:29:14 +00001117 // Okay, it is safe to hoist the terminator.
Nick Lewycky67760642009-09-27 07:38:41 +00001118 Instruction *NT = I1->clone();
Chris Lattner37dc9382004-11-30 00:29:14 +00001119 BIParent->getInstList().insert(BI, NT);
Benjamin Kramerf0127052010-01-05 13:12:22 +00001120 if (!NT->getType()->isVoidTy()) {
Chris Lattner37dc9382004-11-30 00:29:14 +00001121 I1->replaceAllUsesWith(NT);
1122 I2->replaceAllUsesWith(NT);
Chris Lattner86cc4232007-02-11 01:37:51 +00001123 NT->takeName(I1);
Chris Lattner37dc9382004-11-30 00:29:14 +00001124 }
1125
Devang Pateld3a17882011-05-19 20:52:46 +00001126 IRBuilder<true, NoFolder> Builder(NT);
Chris Lattner37dc9382004-11-30 00:29:14 +00001127 // Hoisting one of the terminators from our successor is a great thing.
1128 // Unfortunately, the successors of the if/else blocks may have PHI nodes in
1129 // them. If they do, all PHI entries for BB1/BB2 must agree for all PHI
1130 // nodes, so we insert select instruction to compute the final result.
1131 std::map<std::pair<Value*,Value*>, SelectInst*> InsertedSelects;
1132 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
1133 PHINode *PN;
1134 for (BasicBlock::iterator BBI = SI->begin();
Chris Lattner0f535c62004-11-30 07:47:34 +00001135 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
Chris Lattner37dc9382004-11-30 00:29:14 +00001136 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1137 Value *BB2V = PN->getIncomingValueForBlock(BB2);
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001138 if (BB1V == BB2V) continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001139
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001140 // These values do not agree. Insert a select instruction before NT
1141 // that determines the right value.
1142 SelectInst *&SI = InsertedSelects[std::make_pair(BB1V, BB2V)];
Andrew Trick6b014382012-08-29 21:46:36 +00001143 if (SI == 0)
Devang Pateld3a17882011-05-19 20:52:46 +00001144 SI = cast<SelectInst>
1145 (Builder.CreateSelect(BI->getCondition(), BB1V, BB2V,
1146 BB1V->getName()+"."+BB2V->getName()));
1147
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001148 // Make the PHI node use the select for all incoming values for BB1/BB2
1149 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1150 if (PN->getIncomingBlock(i) == BB1 || PN->getIncomingBlock(i) == BB2)
1151 PN->setIncomingValue(i, SI);
Chris Lattner37dc9382004-11-30 00:29:14 +00001152 }
1153 }
1154
1155 // Update any PHI nodes in our new successors.
1156 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI)
1157 AddPredecessorToBlock(*SI, BIParent, BB1);
Misha Brukmanfd939082005-04-21 23:48:37 +00001158
Eli Friedman080efb82008-12-16 20:54:32 +00001159 EraseTerminatorInstAndDCECond(BI);
Chris Lattner37dc9382004-11-30 00:29:14 +00001160 return true;
1161}
1162
Evan Cheng4d09efd2008-06-07 08:52:29 +00001163/// SpeculativelyExecuteBB - Given a conditional branch that goes to BB1
1164/// and an BB2 and the only successor of BB1 is BB2, hoist simple code
1165/// (for now, restricted to a single instruction that's side effect free) from
1166/// the BB1 into the branch block to speculatively execute it.
Dan Gohman3b205172012-01-05 23:58:56 +00001167///
1168/// Turn
1169/// BB:
1170/// %t1 = icmp
1171/// br i1 %t1, label %BB1, label %BB2
1172/// BB1:
1173/// %t3 = add %t2, c
1174/// br label BB2
1175/// BB2:
1176/// =>
1177/// BB:
1178/// %t1 = icmp
1179/// %t4 = add %t2, c
1180/// %t3 = select i1 %t1, %t2, %t3
Rafael Espindola216dde92011-05-19 02:26:30 +00001181static bool SpeculativelyExecuteBB(BranchInst *BI, BasicBlock *BB1) {
Evan Cheng4d09efd2008-06-07 08:52:29 +00001182 // Only speculatively execution a single instruction (not counting the
1183 // terminator) for now.
Devang Patel06b1e672009-03-06 06:00:17 +00001184 Instruction *HInst = NULL;
1185 Instruction *Term = BB1->getTerminator();
1186 for (BasicBlock::iterator BBI = BB1->begin(), BBE = BB1->end();
1187 BBI != BBE; ++BBI) {
1188 Instruction *I = BBI;
1189 // Skip debug info.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001190 if (isa<DbgInfoIntrinsic>(I)) continue;
1191 if (I == Term) break;
Devang Patel06b1e672009-03-06 06:00:17 +00001192
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001193 if (HInst)
Devang Patel06b1e672009-03-06 06:00:17 +00001194 return false;
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001195 HInst = I;
Devang Patel06b1e672009-03-06 06:00:17 +00001196 }
Dan Gohman3b205172012-01-05 23:58:56 +00001197
1198 BasicBlock *BIParent = BI->getParent();
1199
1200 // Check the instruction to be hoisted, if there is one.
1201 if (HInst) {
1202 // Don't hoist the instruction if it's unsafe or expensive.
1203 if (!isSafeToSpeculativelyExecute(HInst))
1204 return false;
1205 if (ComputeSpeculationCost(HInst) > PHINodeFoldingThreshold)
1206 return false;
1207
1208 // Do not hoist the instruction if any of its operands are defined but not
1209 // used in this BB. The transformation will prevent the operand from
1210 // being sunk into the use block.
Andrew Trick6b014382012-08-29 21:46:36 +00001211 for (User::op_iterator i = HInst->op_begin(), e = HInst->op_end();
Dan Gohman3b205172012-01-05 23:58:56 +00001212 i != e; ++i) {
1213 Instruction *OpI = dyn_cast<Instruction>(*i);
1214 if (OpI && OpI->getParent() == BIParent &&
1215 !OpI->mayHaveSideEffects() &&
1216 !OpI->isUsedInBasicBlock(BIParent))
1217 return false;
1218 }
1219 }
Evan Cheng4d09efd2008-06-07 08:52:29 +00001220
Evan Cheng797d9512008-06-11 19:18:20 +00001221 // Be conservative for now. FP select instruction can often be expensive.
1222 Value *BrCond = BI->getCondition();
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001223 if (isa<FCmpInst>(BrCond))
Evan Cheng797d9512008-06-11 19:18:20 +00001224 return false;
1225
Evan Cheng4d09efd2008-06-07 08:52:29 +00001226 // If BB1 is actually on the false edge of the conditional branch, remember
1227 // to swap the select operands later.
1228 bool Invert = false;
1229 if (BB1 != BI->getSuccessor(0)) {
1230 assert(BB1 == BI->getSuccessor(1) && "No edge from 'if' block?");
1231 Invert = true;
1232 }
1233
Dan Gohman3b205172012-01-05 23:58:56 +00001234 // Collect interesting PHIs, and scan for hazards.
1235 SmallSetVector<std::pair<Value *, Value *>, 4> PHIs;
Chris Lattner6fe73bb2009-01-19 00:36:37 +00001236 BasicBlock *BB2 = BB1->getTerminator()->getSuccessor(0);
Dan Gohman3b205172012-01-05 23:58:56 +00001237 for (BasicBlock::iterator I = BB2->begin();
1238 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
1239 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1240 Value *BIParentV = PN->getIncomingValueForBlock(BIParent);
1241
1242 // Skip PHIs which are trivial.
1243 if (BB1V == BIParentV)
1244 continue;
1245
1246 // Check for saftey.
1247 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(BB1V)) {
1248 // An unfolded ConstantExpr could end up getting expanded into
1249 // Instructions. Don't speculate this and another instruction at
1250 // the same time.
1251 if (HInst)
1252 return false;
1253 if (!isSafeToSpeculativelyExecute(CE))
1254 return false;
1255 if (ComputeSpeculationCost(CE) > PHINodeFoldingThreshold)
1256 return false;
1257 }
1258
1259 // Ok, we may insert a select for this PHI.
1260 PHIs.insert(std::make_pair(BB1V, BIParentV));
Evan Cheng4d09efd2008-06-07 08:52:29 +00001261 }
Dan Gohman3b205172012-01-05 23:58:56 +00001262
1263 // If there are no PHIs to process, bail early. This helps ensure idempotence
1264 // as well.
1265 if (PHIs.empty())
1266 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001267
Dan Gohman3b205172012-01-05 23:58:56 +00001268 // If we get here, we can hoist the instruction and if-convert.
1269 DEBUG(dbgs() << "SPECULATIVELY EXECUTING BB" << *BB1 << "\n";);
Evan Cheng4d09efd2008-06-07 08:52:29 +00001270
Dan Gohman3b205172012-01-05 23:58:56 +00001271 // Hoist the instruction.
1272 if (HInst)
1273 BIParent->getInstList().splice(BI, BB1->getInstList(), HInst);
Evan Cheng502a4f52008-06-12 21:15:59 +00001274
Dan Gohman3b205172012-01-05 23:58:56 +00001275 // Insert selects and rewrite the PHI operands.
Devang Pateld3a17882011-05-19 20:52:46 +00001276 IRBuilder<true, NoFolder> Builder(BI);
Dan Gohman3b205172012-01-05 23:58:56 +00001277 for (unsigned i = 0, e = PHIs.size(); i != e; ++i) {
1278 Value *TrueV = PHIs[i].first;
1279 Value *FalseV = PHIs[i].second;
Evan Cheng4d09efd2008-06-07 08:52:29 +00001280
Dan Gohman3b205172012-01-05 23:58:56 +00001281 // Create a select whose true value is the speculatively executed value and
1282 // false value is the previously determined FalseV.
1283 SelectInst *SI;
1284 if (Invert)
1285 SI = cast<SelectInst>
1286 (Builder.CreateSelect(BrCond, FalseV, TrueV,
1287 FalseV->getName() + "." + TrueV->getName()));
1288 else
1289 SI = cast<SelectInst>
1290 (Builder.CreateSelect(BrCond, TrueV, FalseV,
1291 TrueV->getName() + "." + FalseV->getName()));
1292
1293 // Make the PHI node use the select for all incoming values for "then" and
1294 // "if" blocks.
1295 for (BasicBlock::iterator I = BB2->begin();
1296 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
1297 unsigned BB1I = PN->getBasicBlockIndex(BB1);
1298 unsigned BIParentI = PN->getBasicBlockIndex(BIParent);
1299 Value *BB1V = PN->getIncomingValue(BB1I);
1300 Value *BIParentV = PN->getIncomingValue(BIParentI);
1301 if (TrueV == BB1V && FalseV == BIParentV) {
1302 PN->setIncomingValue(BB1I, SI);
1303 PN->setIncomingValue(BIParentI, SI);
1304 }
1305 }
Evan Cheng4d09efd2008-06-07 08:52:29 +00001306 }
1307
Evan Cheng502a4f52008-06-12 21:15:59 +00001308 ++NumSpeculations;
Evan Cheng4d09efd2008-06-07 08:52:29 +00001309 return true;
1310}
1311
Chris Lattner2e42e362005-09-20 00:43:16 +00001312/// BlockIsSimpleEnoughToThreadThrough - Return true if we can thread a branch
1313/// across this block.
1314static bool BlockIsSimpleEnoughToThreadThrough(BasicBlock *BB) {
1315 BranchInst *BI = cast<BranchInst>(BB->getTerminator());
Chris Lattnere9487f02005-09-20 01:48:40 +00001316 unsigned Size = 0;
Andrew Trick6b014382012-08-29 21:46:36 +00001317
Devang Patel9200c892009-03-10 18:00:05 +00001318 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
Dale Johannesen8483e542009-03-12 23:18:09 +00001319 if (isa<DbgInfoIntrinsic>(BBI))
1320 continue;
Chris Lattnere9487f02005-09-20 01:48:40 +00001321 if (Size > 10) return false; // Don't clone large BB's.
Dale Johannesen8483e542009-03-12 23:18:09 +00001322 ++Size;
Andrew Trick6b014382012-08-29 21:46:36 +00001323
Dale Johannesen8483e542009-03-12 23:18:09 +00001324 // We can only support instructions that do not define values that are
Chris Lattnere9487f02005-09-20 01:48:40 +00001325 // live outside of the current basic block.
1326 for (Value::use_iterator UI = BBI->use_begin(), E = BBI->use_end();
1327 UI != E; ++UI) {
1328 Instruction *U = cast<Instruction>(*UI);
1329 if (U->getParent() != BB || isa<PHINode>(U)) return false;
1330 }
Andrew Trick6b014382012-08-29 21:46:36 +00001331
Chris Lattner2e42e362005-09-20 00:43:16 +00001332 // Looks ok, continue checking.
1333 }
Chris Lattnere9487f02005-09-20 01:48:40 +00001334
Chris Lattner2e42e362005-09-20 00:43:16 +00001335 return true;
1336}
1337
Chris Lattnereaba3a12005-09-19 23:49:37 +00001338/// FoldCondBranchOnPHI - If we have a conditional branch on a PHI node value
1339/// that is defined in the same block as the branch and if any PHI entries are
1340/// constants, thread edges corresponding to that entry to be branches to their
1341/// ultimate destination.
Chris Lattner302ba6f2010-12-14 06:17:25 +00001342static bool FoldCondBranchOnPHI(BranchInst *BI, const TargetData *TD) {
Chris Lattnereaba3a12005-09-19 23:49:37 +00001343 BasicBlock *BB = BI->getParent();
1344 PHINode *PN = dyn_cast<PHINode>(BI->getCondition());
Chris Lattner9c88d982005-09-19 23:57:04 +00001345 // NOTE: we currently cannot transform this case if the PHI node is used
1346 // outside of the block.
Chris Lattner2e42e362005-09-20 00:43:16 +00001347 if (!PN || PN->getParent() != BB || !PN->hasOneUse())
1348 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001349
Chris Lattnereaba3a12005-09-19 23:49:37 +00001350 // Degenerate case of a single entry PHI.
1351 if (PN->getNumIncomingValues() == 1) {
Chris Lattner29874e02008-12-03 19:44:02 +00001352 FoldSingleEntryPHINodes(PN->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00001353 return true;
Chris Lattnereaba3a12005-09-19 23:49:37 +00001354 }
1355
1356 // Now we know that this block has multiple preds and two succs.
Chris Lattner2e42e362005-09-20 00:43:16 +00001357 if (!BlockIsSimpleEnoughToThreadThrough(BB)) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001358
Chris Lattnereaba3a12005-09-19 23:49:37 +00001359 // Okay, this is a simple enough basic block. See if any phi values are
1360 // constants.
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00001361 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001362 ConstantInt *CB = dyn_cast<ConstantInt>(PN->getIncomingValue(i));
1363 if (CB == 0 || !CB->getType()->isIntegerTy(1)) continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001364
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001365 // Okay, we now know that all edges from PredBB should be revectored to
1366 // branch to RealDest.
1367 BasicBlock *PredBB = PN->getIncomingBlock(i);
1368 BasicBlock *RealDest = BI->getSuccessor(!CB->getZExtValue());
Andrew Trick6b014382012-08-29 21:46:36 +00001369
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001370 if (RealDest == BB) continue; // Skip self loops.
Bill Wendling6a648b82011-06-04 09:42:04 +00001371 // Skip if the predecessor's terminator is an indirect branch.
1372 if (isa<IndirectBrInst>(PredBB->getTerminator())) continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001373
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001374 // The dest block might have PHI nodes, other predecessors and other
1375 // difficult cases. Instead of being smart about this, just insert a new
1376 // block that jumps to the destination block, effectively splitting
1377 // the edge we are about to create.
1378 BasicBlock *EdgeBB = BasicBlock::Create(BB->getContext(),
1379 RealDest->getName()+".critedge",
1380 RealDest->getParent(), RealDest);
1381 BranchInst::Create(RealDest, EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00001382
Chris Lattner6de0a282010-12-14 07:09:42 +00001383 // Update PHI nodes.
1384 AddPredecessorToBlock(RealDest, EdgeBB, BB);
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001385
1386 // BB may have instructions that are being threaded over. Clone these
1387 // instructions into EdgeBB. We know that there will be no uses of the
1388 // cloned instructions outside of EdgeBB.
1389 BasicBlock::iterator InsertPt = EdgeBB->begin();
1390 DenseMap<Value*, Value*> TranslateMap; // Track translated values.
1391 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
1392 if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
1393 TranslateMap[PN] = PN->getIncomingValueForBlock(PredBB);
1394 continue;
1395 }
1396 // Clone the instruction.
1397 Instruction *N = BBI->clone();
1398 if (BBI->hasName()) N->setName(BBI->getName()+".c");
Andrew Trick6b014382012-08-29 21:46:36 +00001399
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001400 // Update operands due to translation.
1401 for (User::op_iterator i = N->op_begin(), e = N->op_end();
1402 i != e; ++i) {
1403 DenseMap<Value*, Value*>::iterator PI = TranslateMap.find(*i);
1404 if (PI != TranslateMap.end())
1405 *i = PI->second;
1406 }
Andrew Trick6b014382012-08-29 21:46:36 +00001407
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001408 // Check for trivial simplification.
Chris Lattner302ba6f2010-12-14 06:17:25 +00001409 if (Value *V = SimplifyInstruction(N, TD)) {
1410 TranslateMap[BBI] = V;
1411 delete N; // Instruction folded away, don't need actual inst
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001412 } else {
1413 // Insert the new instruction into its new home.
1414 EdgeBB->getInstList().insert(InsertPt, N);
1415 if (!BBI->use_empty())
1416 TranslateMap[BBI] = N;
1417 }
1418 }
1419
1420 // Loop over all of the edges from PredBB to BB, changing them to branch
1421 // to EdgeBB instead.
1422 TerminatorInst *PredBBTI = PredBB->getTerminator();
1423 for (unsigned i = 0, e = PredBBTI->getNumSuccessors(); i != e; ++i)
1424 if (PredBBTI->getSuccessor(i) == BB) {
1425 BB->removePredecessor(PredBB);
1426 PredBBTI->setSuccessor(i, EdgeBB);
1427 }
Bill Wendling6a648b82011-06-04 09:42:04 +00001428
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001429 // Recurse, simplifying any other constants.
Chris Lattner302ba6f2010-12-14 06:17:25 +00001430 return FoldCondBranchOnPHI(BI, TD) | true;
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00001431 }
Chris Lattnereaba3a12005-09-19 23:49:37 +00001432
1433 return false;
1434}
1435
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001436/// FoldTwoEntryPHINode - Given a BB that starts with the specified two-entry
1437/// PHI node, see if we can eliminate it.
Devang Pateld3a17882011-05-19 20:52:46 +00001438static bool FoldTwoEntryPHINode(PHINode *PN, const TargetData *TD) {
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001439 // Ok, this is a two entry PHI node. Check to see if this is a simple "if
1440 // statement", which has a very simple dominance structure. Basically, we
1441 // are trying to find the condition that is being branched on, which
1442 // subsequently causes this merge to happen. We really want control
1443 // dependence information for this check, but simplifycfg can't keep it up
1444 // to date, and this catches most of the cases we care about anyway.
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001445 BasicBlock *BB = PN->getParent();
1446 BasicBlock *IfTrue, *IfFalse;
1447 Value *IfCond = GetIfCondition(BB, IfTrue, IfFalse);
Chris Lattner60d410d2010-12-14 08:01:53 +00001448 if (!IfCond ||
1449 // Don't bother if the branch will be constant folded trivially.
1450 isa<ConstantInt>(IfCond))
1451 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001452
Chris Lattner822a8792006-11-18 19:19:36 +00001453 // Okay, we found that we can merge this two-entry phi node into a select.
1454 // Doing so would require us to fold *all* two entry phi nodes in this block.
1455 // At some point this becomes non-profitable (particularly if the target
1456 // doesn't support cmov's). Only do this transformation if there are two or
1457 // fewer PHI nodes in this block.
1458 unsigned NumPhis = 0;
1459 for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I); ++NumPhis, ++I)
1460 if (NumPhis > 2)
1461 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001462
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001463 // Loop over the PHI's seeing if we can promote them all to select
1464 // instructions. While we are at it, keep track of the instructions
1465 // that need to be moved to the dominating block.
Chris Lattner44da7ca2010-12-14 07:41:39 +00001466 SmallPtrSet<Instruction*, 4> AggressiveInsts;
Peter Collingbourne57808b32011-04-29 18:47:38 +00001467 unsigned MaxCostVal0 = PHINodeFoldingThreshold,
1468 MaxCostVal1 = PHINodeFoldingThreshold;
Andrew Trick6b014382012-08-29 21:46:36 +00001469
Chris Lattner3aff13b2010-12-14 08:46:09 +00001470 for (BasicBlock::iterator II = BB->begin(); isa<PHINode>(II);) {
1471 PHINode *PN = cast<PHINode>(II++);
Chris Lattner07ff3532010-12-14 07:20:29 +00001472 if (Value *V = SimplifyInstruction(PN, TD)) {
1473 PN->replaceAllUsesWith(V);
Chris Lattner3aff13b2010-12-14 08:46:09 +00001474 PN->eraseFromParent();
Chris Lattner07ff3532010-12-14 07:20:29 +00001475 continue;
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001476 }
Andrew Trick6b014382012-08-29 21:46:36 +00001477
Peter Collingbournef15907f2011-04-29 18:47:31 +00001478 if (!DominatesMergePoint(PN->getIncomingValue(0), BB, &AggressiveInsts,
1479 MaxCostVal0) ||
1480 !DominatesMergePoint(PN->getIncomingValue(1), BB, &AggressiveInsts,
1481 MaxCostVal1))
Chris Lattner07ff3532010-12-14 07:20:29 +00001482 return false;
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001483 }
Andrew Trick6b014382012-08-29 21:46:36 +00001484
Sylvestre Ledruc8e41c52012-07-23 08:51:15 +00001485 // If we folded the first phi, PN dangles at this point. Refresh it. If
Chris Lattner44da7ca2010-12-14 07:41:39 +00001486 // we ran out of PHIs then we simplified them all.
1487 PN = dyn_cast<PHINode>(BB->begin());
1488 if (PN == 0) return true;
Andrew Trick6b014382012-08-29 21:46:36 +00001489
Chris Lattner3aff13b2010-12-14 08:46:09 +00001490 // Don't fold i1 branches on PHIs which contain binary operators. These can
1491 // often be turned into switches and other things.
1492 if (PN->getType()->isIntegerTy(1) &&
1493 (isa<BinaryOperator>(PN->getIncomingValue(0)) ||
1494 isa<BinaryOperator>(PN->getIncomingValue(1)) ||
1495 isa<BinaryOperator>(IfCond)))
1496 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001497
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001498 // If we all PHI nodes are promotable, check to make sure that all
1499 // instructions in the predecessor blocks can be promoted as well. If
1500 // not, we won't be able to get rid of the control flow, so it's not
1501 // worth promoting to select instructions.
Chris Lattner44da7ca2010-12-14 07:41:39 +00001502 BasicBlock *DomBlock = 0;
1503 BasicBlock *IfBlock1 = PN->getIncomingBlock(0);
1504 BasicBlock *IfBlock2 = PN->getIncomingBlock(1);
1505 if (cast<BranchInst>(IfBlock1->getTerminator())->isConditional()) {
1506 IfBlock1 = 0;
1507 } else {
1508 DomBlock = *pred_begin(IfBlock1);
1509 for (BasicBlock::iterator I = IfBlock1->begin();!isa<TerminatorInst>(I);++I)
Devang Patel383d7ed2009-02-03 22:12:02 +00001510 if (!AggressiveInsts.count(I) && !isa<DbgInfoIntrinsic>(I)) {
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001511 // This is not an aggressive instruction that we can promote.
1512 // Because of this, we won't be able to get rid of the control
1513 // flow, so the xform is not worth it.
1514 return false;
1515 }
1516 }
Andrew Trick6b014382012-08-29 21:46:36 +00001517
Chris Lattner44da7ca2010-12-14 07:41:39 +00001518 if (cast<BranchInst>(IfBlock2->getTerminator())->isConditional()) {
1519 IfBlock2 = 0;
1520 } else {
1521 DomBlock = *pred_begin(IfBlock2);
1522 for (BasicBlock::iterator I = IfBlock2->begin();!isa<TerminatorInst>(I);++I)
Devang Patel383d7ed2009-02-03 22:12:02 +00001523 if (!AggressiveInsts.count(I) && !isa<DbgInfoIntrinsic>(I)) {
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001524 // This is not an aggressive instruction that we can promote.
1525 // Because of this, we won't be able to get rid of the control
1526 // flow, so the xform is not worth it.
1527 return false;
1528 }
1529 }
Andrew Trick6b014382012-08-29 21:46:36 +00001530
Chris Lattnere0b18e52010-12-14 07:23:10 +00001531 DEBUG(dbgs() << "FOUND IF CONDITION! " << *IfCond << " T: "
Chris Lattner44da7ca2010-12-14 07:41:39 +00001532 << IfTrue->getName() << " F: " << IfFalse->getName() << "\n");
Andrew Trick6b014382012-08-29 21:46:36 +00001533
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001534 // If we can still promote the PHI nodes after this gauntlet of tests,
1535 // do all of the PHI's now.
Chris Lattner3aff13b2010-12-14 08:46:09 +00001536 Instruction *InsertPt = DomBlock->getTerminator();
Devang Pateld3a17882011-05-19 20:52:46 +00001537 IRBuilder<true, NoFolder> Builder(InsertPt);
Andrew Trick6b014382012-08-29 21:46:36 +00001538
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001539 // Move all 'aggressive' instructions, which are defined in the
1540 // conditional parts of the if's up to the dominating block.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001541 if (IfBlock1)
Chris Lattner3aff13b2010-12-14 08:46:09 +00001542 DomBlock->getInstList().splice(InsertPt,
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001543 IfBlock1->getInstList(), IfBlock1->begin(),
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001544 IfBlock1->getTerminator());
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001545 if (IfBlock2)
Chris Lattner3aff13b2010-12-14 08:46:09 +00001546 DomBlock->getInstList().splice(InsertPt,
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001547 IfBlock2->getInstList(), IfBlock2->begin(),
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001548 IfBlock2->getTerminator());
Andrew Trick6b014382012-08-29 21:46:36 +00001549
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001550 while (PHINode *PN = dyn_cast<PHINode>(BB->begin())) {
1551 // Change the PHI node into a select instruction.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001552 Value *TrueVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfFalse);
1553 Value *FalseVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfTrue);
Andrew Trick6b014382012-08-29 21:46:36 +00001554
1555 SelectInst *NV =
Devang Patelf60364d2011-05-18 18:16:44 +00001556 cast<SelectInst>(Builder.CreateSelect(IfCond, TrueVal, FalseVal, ""));
Chris Lattner86cc4232007-02-11 01:37:51 +00001557 PN->replaceAllUsesWith(NV);
1558 NV->takeName(PN);
Chris Lattner302ba6f2010-12-14 06:17:25 +00001559 PN->eraseFromParent();
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001560 }
Andrew Trick6b014382012-08-29 21:46:36 +00001561
Chris Lattner60d410d2010-12-14 08:01:53 +00001562 // At this point, IfBlock1 and IfBlock2 are both empty, so our if statement
1563 // has been flattened. Change DomBlock to jump directly to our new block to
1564 // avoid other simplifycfg's kicking in on the diamond.
1565 TerminatorInst *OldTI = DomBlock->getTerminator();
Devang Patelf60364d2011-05-18 18:16:44 +00001566 Builder.SetInsertPoint(OldTI);
1567 Builder.CreateBr(BB);
Chris Lattner60d410d2010-12-14 08:01:53 +00001568 OldTI->eraseFromParent();
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001569 return true;
1570}
Chris Lattnereaba3a12005-09-19 23:49:37 +00001571
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001572/// SimplifyCondBranchToTwoReturns - If we found a conditional branch that goes
1573/// to two returning blocks, try to merge them together into one return,
1574/// introducing a select if the return values disagree.
Andrew Trick6b014382012-08-29 21:46:36 +00001575static bool SimplifyCondBranchToTwoReturns(BranchInst *BI,
Devang Patel176ec402011-05-18 21:33:11 +00001576 IRBuilder<> &Builder) {
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001577 assert(BI->isConditional() && "Must be a conditional branch");
1578 BasicBlock *TrueSucc = BI->getSuccessor(0);
1579 BasicBlock *FalseSucc = BI->getSuccessor(1);
1580 ReturnInst *TrueRet = cast<ReturnInst>(TrueSucc->getTerminator());
1581 ReturnInst *FalseRet = cast<ReturnInst>(FalseSucc->getTerminator());
Andrew Trick6b014382012-08-29 21:46:36 +00001582
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001583 // Check to ensure both blocks are empty (just a return) or optionally empty
1584 // with PHI nodes. If there are other instructions, merging would cause extra
1585 // computation on one path or the other.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001586 if (!TrueSucc->getFirstNonPHIOrDbg()->isTerminator())
Devang Patel2cc86a12009-02-05 00:30:42 +00001587 return false;
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001588 if (!FalseSucc->getFirstNonPHIOrDbg()->isTerminator())
Devang Patel2cc86a12009-02-05 00:30:42 +00001589 return false;
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001590
Devang Patel176ec402011-05-18 21:33:11 +00001591 Builder.SetInsertPoint(BI);
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001592 // Okay, we found a branch that is going to two return nodes. If
1593 // there is no return value for this function, just change the
1594 // branch into a return.
1595 if (FalseRet->getNumOperands() == 0) {
1596 TrueSucc->removePredecessor(BI->getParent());
1597 FalseSucc->removePredecessor(BI->getParent());
Devang Patel176ec402011-05-18 21:33:11 +00001598 Builder.CreateRetVoid();
Eli Friedman080efb82008-12-16 20:54:32 +00001599 EraseTerminatorInstAndDCECond(BI);
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001600 return true;
1601 }
Andrew Trick6b014382012-08-29 21:46:36 +00001602
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001603 // Otherwise, figure out what the true and false return values are
1604 // so we can insert a new select instruction.
1605 Value *TrueValue = TrueRet->getReturnValue();
1606 Value *FalseValue = FalseRet->getReturnValue();
Andrew Trick6b014382012-08-29 21:46:36 +00001607
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001608 // Unwrap any PHI nodes in the return blocks.
1609 if (PHINode *TVPN = dyn_cast_or_null<PHINode>(TrueValue))
1610 if (TVPN->getParent() == TrueSucc)
1611 TrueValue = TVPN->getIncomingValueForBlock(BI->getParent());
1612 if (PHINode *FVPN = dyn_cast_or_null<PHINode>(FalseValue))
1613 if (FVPN->getParent() == FalseSucc)
1614 FalseValue = FVPN->getIncomingValueForBlock(BI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00001615
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001616 // In order for this transformation to be safe, we must be able to
1617 // unconditionally execute both operands to the return. This is
1618 // normally the case, but we could have a potentially-trapping
1619 // constant expression that prevents this transformation from being
1620 // safe.
1621 if (ConstantExpr *TCV = dyn_cast_or_null<ConstantExpr>(TrueValue))
1622 if (TCV->canTrap())
1623 return false;
1624 if (ConstantExpr *FCV = dyn_cast_or_null<ConstantExpr>(FalseValue))
1625 if (FCV->canTrap())
1626 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001627
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001628 // Okay, we collected all the mapped values and checked them for sanity, and
1629 // defined to really do this transformation. First, update the CFG.
1630 TrueSucc->removePredecessor(BI->getParent());
1631 FalseSucc->removePredecessor(BI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00001632
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001633 // Insert select instructions where needed.
1634 Value *BrCond = BI->getCondition();
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001635 if (TrueValue) {
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001636 // Insert a select if the results differ.
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001637 if (TrueValue == FalseValue || isa<UndefValue>(FalseValue)) {
1638 } else if (isa<UndefValue>(TrueValue)) {
1639 TrueValue = FalseValue;
1640 } else {
Devang Patel176ec402011-05-18 21:33:11 +00001641 TrueValue = Builder.CreateSelect(BrCond, TrueValue,
1642 FalseValue, "retval");
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001643 }
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001644 }
1645
Andrew Trick6b014382012-08-29 21:46:36 +00001646 Value *RI = !TrueValue ?
Devang Patel176ec402011-05-18 21:33:11 +00001647 Builder.CreateRetVoid() : Builder.CreateRet(TrueValue);
1648
Daniel Dunbare317bcc2009-08-23 10:29:55 +00001649 (void) RI;
Andrew Trick6b014382012-08-29 21:46:36 +00001650
David Greene89d6fd32010-01-05 01:26:52 +00001651 DEBUG(dbgs() << "\nCHANGING BRANCH TO TWO RETURNS INTO SELECT:"
Chris Lattnerbdff5482009-08-23 04:37:46 +00001652 << "\n " << *BI << "NewRet = " << *RI
1653 << "TRUEBLOCK: " << *TrueSucc << "FALSEBLOCK: "<< *FalseSucc);
Andrew Trick6b014382012-08-29 21:46:36 +00001654
Eli Friedman080efb82008-12-16 20:54:32 +00001655 EraseTerminatorInstAndDCECond(BI);
1656
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001657 return true;
1658}
1659
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001660/// ExtractBranchMetadata - Given a conditional BranchInstruction, retrieve the
1661/// probabilities of the branch taking each edge. Fills in the two APInt
1662/// parameters and return true, or returns false if no or invalid metadata was
1663/// found.
1664static bool ExtractBranchMetadata(BranchInst *BI,
1665 APInt &ProbTrue, APInt &ProbFalse) {
1666 assert(BI->isConditional() &&
1667 "Looking for probabilities on unconditional branch?");
1668 MDNode *ProfileData = BI->getMetadata(LLVMContext::MD_prof);
Nick Lewycky91968482011-12-27 18:27:22 +00001669 if (!ProfileData || ProfileData->getNumOperands() != 3) return false;
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001670 ConstantInt *CITrue = dyn_cast<ConstantInt>(ProfileData->getOperand(1));
1671 ConstantInt *CIFalse = dyn_cast<ConstantInt>(ProfileData->getOperand(2));
Nick Lewycky91968482011-12-27 18:27:22 +00001672 if (!CITrue || !CIFalse) return false;
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001673 ProbTrue = CITrue->getValue();
1674 ProbFalse = CIFalse->getValue();
1675 assert(ProbTrue.getBitWidth() == 32 && ProbFalse.getBitWidth() == 32 &&
1676 "Branch probability metadata must be 32-bit integers");
1677 return true;
1678}
1679
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00001680/// MultiplyAndLosePrecision - Multiplies A and B, then returns the result. In
1681/// the event of overflow, logically-shifts all four inputs right until the
1682/// multiply fits.
1683static APInt MultiplyAndLosePrecision(APInt &A, APInt &B, APInt &C, APInt &D,
1684 unsigned &BitsLost) {
1685 BitsLost = 0;
1686 bool Overflow = false;
1687 APInt Result = A.umul_ov(B, Overflow);
1688 if (Overflow) {
1689 APInt MaxB = APInt::getMaxValue(A.getBitWidth()).udiv(A);
1690 do {
1691 B = B.lshr(1);
1692 ++BitsLost;
1693 } while (B.ugt(MaxB));
1694 A = A.lshr(BitsLost);
1695 C = C.lshr(BitsLost);
1696 D = D.lshr(BitsLost);
1697 Result = A * B;
1698 }
1699 return Result;
1700}
1701
Manman Renee28e0f2012-06-13 05:43:29 +00001702/// checkCSEInPredecessor - Return true if the given instruction is available
1703/// in its predecessor block. If yes, the instruction will be removed.
1704///
Benjamin Kramer23d36222012-07-13 13:25:15 +00001705static bool checkCSEInPredecessor(Instruction *Inst, BasicBlock *PB) {
Manman Renee28e0f2012-06-13 05:43:29 +00001706 if (!isa<BinaryOperator>(Inst) && !isa<CmpInst>(Inst))
1707 return false;
1708 for (BasicBlock::iterator I = PB->begin(), E = PB->end(); I != E; I++) {
1709 Instruction *PBI = &*I;
1710 // Check whether Inst and PBI generate the same value.
1711 if (Inst->isIdenticalTo(PBI)) {
1712 Inst->replaceAllUsesWith(PBI);
1713 Inst->eraseFromParent();
1714 return true;
1715 }
1716 }
1717 return false;
1718}
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00001719
Chris Lattnerc8fbc342011-04-11 23:24:57 +00001720/// FoldBranchToCommonDest - If this basic block is simple enough, and if a
1721/// predecessor branches to us and one of our successors, fold the block into
1722/// the predecessor and use logical operations to pick the right destination.
Dan Gohman4b35f832009-06-27 21:30:38 +00001723bool llvm::FoldBranchToCommonDest(BranchInst *BI) {
Chris Lattner093a4382008-07-13 22:23:11 +00001724 BasicBlock *BB = BI->getParent();
Devang Pateld3a17882011-05-19 20:52:46 +00001725
Manman Renee28e0f2012-06-13 05:43:29 +00001726 Instruction *Cond = 0;
1727 if (BI->isConditional())
1728 Cond = dyn_cast<Instruction>(BI->getCondition());
1729 else {
1730 // For unconditional branch, check for a simple CFG pattern, where
1731 // BB has a single predecessor and BB's successor is also its predecessor's
1732 // successor. If such pattern exisits, check for CSE between BB and its
1733 // predecessor.
1734 if (BasicBlock *PB = BB->getSinglePredecessor())
1735 if (BranchInst *PBI = dyn_cast<BranchInst>(PB->getTerminator()))
1736 if (PBI->isConditional() &&
1737 (BI->getSuccessor(0) == PBI->getSuccessor(0) ||
1738 BI->getSuccessor(0) == PBI->getSuccessor(1))) {
1739 for (BasicBlock::iterator I = BB->begin(), E = BB->end();
1740 I != E; ) {
1741 Instruction *Curr = I++;
1742 if (isa<CmpInst>(Curr)) {
1743 Cond = Curr;
1744 break;
1745 }
1746 // Quit if we can't remove this instruction.
1747 if (!checkCSEInPredecessor(Curr, PB))
1748 return false;
1749 }
1750 }
1751
1752 if (Cond == 0)
1753 return false;
1754 }
Andrew Trick6b014382012-08-29 21:46:36 +00001755
Owen Andersone84178a2010-07-14 19:52:16 +00001756 if (Cond == 0 || (!isa<CmpInst>(Cond) && !isa<BinaryOperator>(Cond)) ||
1757 Cond->getParent() != BB || !Cond->hasOneUse())
1758 return false;
Devang Pateld4181942011-04-06 22:37:20 +00001759
Chris Lattner1347e872008-07-13 21:12:01 +00001760 // Only allow this if the condition is a simple instruction that can be
1761 // executed unconditionally. It must be in the same block as the branch, and
1762 // must be at the front of the block.
Devang Pateld0a203d2009-02-04 21:39:48 +00001763 BasicBlock::iterator FrontIt = BB->front();
Chris Lattner3c6e7462011-04-14 02:44:53 +00001764
Devang Pateld0a203d2009-02-04 21:39:48 +00001765 // Ignore dbg intrinsics.
Chris Lattner3c6e7462011-04-14 02:44:53 +00001766 while (isa<DbgInfoIntrinsic>(FrontIt)) ++FrontIt;
Nick Lewycky9d523102011-12-26 20:37:40 +00001767
Owen Andersone84178a2010-07-14 19:52:16 +00001768 // Allow a single instruction to be hoisted in addition to the compare
1769 // that feeds the branch. We later ensure that any values that _it_ uses
1770 // were also live in the predecessor, so that we don't unnecessarily create
1771 // register pressure or inhibit out-of-order execution.
1772 Instruction *BonusInst = 0;
1773 if (&*FrontIt != Cond &&
Owen Anderson2722dfa2010-07-15 16:38:22 +00001774 FrontIt->hasOneUse() && *FrontIt->use_begin() == Cond &&
Dan Gohmanf0426602011-12-14 23:49:11 +00001775 isSafeToSpeculativelyExecute(FrontIt)) {
Owen Andersone84178a2010-07-14 19:52:16 +00001776 BonusInst = &*FrontIt;
1777 ++FrontIt;
Andrew Trick6b014382012-08-29 21:46:36 +00001778
Chris Lattner3c6e7462011-04-14 02:44:53 +00001779 // Ignore dbg intrinsics.
1780 while (isa<DbgInfoIntrinsic>(FrontIt)) ++FrontIt;
Devang Patel60d490c2011-04-07 23:11:25 +00001781 }
1782
Owen Andersone84178a2010-07-14 19:52:16 +00001783 // Only a single bonus inst is allowed.
1784 if (&*FrontIt != Cond)
1785 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001786
Chris Lattner1347e872008-07-13 21:12:01 +00001787 // Make sure the instruction after the condition is the cond branch.
1788 BasicBlock::iterator CondIt = Cond; ++CondIt;
Chris Lattner3c6e7462011-04-14 02:44:53 +00001789
Devang Pateld0a203d2009-02-04 21:39:48 +00001790 // Ingore dbg intrinsics.
Chris Lattner3c6e7462011-04-14 02:44:53 +00001791 while (isa<DbgInfoIntrinsic>(CondIt)) ++CondIt;
Andrew Trick6b014382012-08-29 21:46:36 +00001792
Chris Lattner3c6e7462011-04-14 02:44:53 +00001793 if (&*CondIt != BI)
Chris Lattner1347e872008-07-13 21:12:01 +00001794 return false;
Chris Lattner6ff645b2009-01-19 23:03:13 +00001795
1796 // Cond is known to be a compare or binary operator. Check to make sure that
1797 // neither operand is a potentially-trapping constant expression.
1798 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(0)))
1799 if (CE->canTrap())
1800 return false;
1801 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(1)))
1802 if (CE->canTrap())
1803 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001804
Chris Lattner1347e872008-07-13 21:12:01 +00001805 // Finally, don't infinitely unroll conditional loops.
1806 BasicBlock *TrueDest = BI->getSuccessor(0);
Manman Renee28e0f2012-06-13 05:43:29 +00001807 BasicBlock *FalseDest = (BI->isConditional()) ? BI->getSuccessor(1) : 0;
Chris Lattner1347e872008-07-13 21:12:01 +00001808 if (TrueDest == BB || FalseDest == BB)
1809 return false;
Devang Pateld4181942011-04-06 22:37:20 +00001810
Chris Lattner1347e872008-07-13 21:12:01 +00001811 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
1812 BasicBlock *PredBlock = *PI;
1813 BranchInst *PBI = dyn_cast<BranchInst>(PredBlock->getTerminator());
Andrew Trick6b014382012-08-29 21:46:36 +00001814
Chris Lattner093a4382008-07-13 22:23:11 +00001815 // Check that we have two conditional branches. If there is a PHI node in
1816 // the common successor, verify that the same value flows in from both
1817 // blocks.
Manman Renee28e0f2012-06-13 05:43:29 +00001818 SmallVector<PHINode*, 4> PHIs;
1819 if (PBI == 0 || PBI->isUnconditional() ||
Andrew Trick6b014382012-08-29 21:46:36 +00001820 (BI->isConditional() &&
Manman Renee28e0f2012-06-13 05:43:29 +00001821 !SafeToMergeTerminators(BI, PBI)) ||
1822 (!BI->isConditional() &&
1823 !isProfitableToFoldUnconditional(BI, PBI, Cond, PHIs)))
Chris Lattner1347e872008-07-13 21:12:01 +00001824 continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001825
Chris Lattner3c6e7462011-04-14 02:44:53 +00001826 // Determine if the two branches share a common destination.
1827 Instruction::BinaryOps Opc;
1828 bool InvertPredCond = false;
Andrew Trick6b014382012-08-29 21:46:36 +00001829
Manman Renee28e0f2012-06-13 05:43:29 +00001830 if (BI->isConditional()) {
1831 if (PBI->getSuccessor(0) == TrueDest)
1832 Opc = Instruction::Or;
1833 else if (PBI->getSuccessor(1) == FalseDest)
1834 Opc = Instruction::And;
1835 else if (PBI->getSuccessor(0) == FalseDest)
1836 Opc = Instruction::And, InvertPredCond = true;
1837 else if (PBI->getSuccessor(1) == TrueDest)
1838 Opc = Instruction::Or, InvertPredCond = true;
1839 else
1840 continue;
1841 } else {
1842 if (PBI->getSuccessor(0) != TrueDest && PBI->getSuccessor(1) != TrueDest)
1843 continue;
1844 }
Chris Lattner3c6e7462011-04-14 02:44:53 +00001845
Owen Andersone84178a2010-07-14 19:52:16 +00001846 // Ensure that any values used in the bonus instruction are also used
1847 // by the terminator of the predecessor. This means that those values
Andrew Trick6b014382012-08-29 21:46:36 +00001848 // must already have been resolved, so we won't be inhibiting the
Owen Andersone84178a2010-07-14 19:52:16 +00001849 // out-of-order core by speculating them earlier.
1850 if (BonusInst) {
1851 // Collect the values used by the bonus inst
1852 SmallPtrSet<Value*, 4> UsedValues;
1853 for (Instruction::op_iterator OI = BonusInst->op_begin(),
1854 OE = BonusInst->op_end(); OI != OE; ++OI) {
Nick Lewycky9d523102011-12-26 20:37:40 +00001855 Value *V = *OI;
Owen Andersone84178a2010-07-14 19:52:16 +00001856 if (!isa<Constant>(V))
1857 UsedValues.insert(V);
1858 }
1859
1860 SmallVector<std::pair<Value*, unsigned>, 4> Worklist;
1861 Worklist.push_back(std::make_pair(PBI->getOperand(0), 0));
Andrew Trick6b014382012-08-29 21:46:36 +00001862
Owen Andersone84178a2010-07-14 19:52:16 +00001863 // Walk up to four levels back up the use-def chain of the predecessor's
1864 // terminator to see if all those values were used. The choice of four
1865 // levels is arbitrary, to provide a compile-time-cost bound.
1866 while (!Worklist.empty()) {
1867 std::pair<Value*, unsigned> Pair = Worklist.back();
1868 Worklist.pop_back();
Andrew Trick6b014382012-08-29 21:46:36 +00001869
Owen Andersone84178a2010-07-14 19:52:16 +00001870 if (Pair.second >= 4) continue;
1871 UsedValues.erase(Pair.first);
1872 if (UsedValues.empty()) break;
Andrew Trick6b014382012-08-29 21:46:36 +00001873
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00001874 if (Instruction *I = dyn_cast<Instruction>(Pair.first)) {
Owen Andersone84178a2010-07-14 19:52:16 +00001875 for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
1876 OI != OE; ++OI)
1877 Worklist.push_back(std::make_pair(OI->get(), Pair.second+1));
Andrew Trick6b014382012-08-29 21:46:36 +00001878 }
Owen Andersone84178a2010-07-14 19:52:16 +00001879 }
Andrew Trick6b014382012-08-29 21:46:36 +00001880
Owen Andersone84178a2010-07-14 19:52:16 +00001881 if (!UsedValues.empty()) return false;
1882 }
Chris Lattner36989092008-07-13 21:20:19 +00001883
David Greene89d6fd32010-01-05 01:26:52 +00001884 DEBUG(dbgs() << "FOLDING BRANCH TO COMMON DEST:\n" << *PBI << *BB);
Andrew Trick6b014382012-08-29 21:46:36 +00001885 IRBuilder<> Builder(PBI);
Devang Pateld3a17882011-05-19 20:52:46 +00001886
Chris Lattner36989092008-07-13 21:20:19 +00001887 // If we need to invert the condition in the pred block to match, do so now.
1888 if (InvertPredCond) {
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00001889 Value *NewCond = PBI->getCondition();
Andrew Trick6b014382012-08-29 21:46:36 +00001890
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00001891 if (NewCond->hasOneUse() && isa<CmpInst>(NewCond)) {
1892 CmpInst *CI = cast<CmpInst>(NewCond);
1893 CI->setPredicate(CI->getInversePredicate());
1894 } else {
Andrew Trick6b014382012-08-29 21:46:36 +00001895 NewCond = Builder.CreateNot(NewCond,
Devang Pateld3a17882011-05-19 20:52:46 +00001896 PBI->getCondition()->getName()+".not");
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00001897 }
Andrew Trick6b014382012-08-29 21:46:36 +00001898
Chris Lattner1347e872008-07-13 21:12:01 +00001899 PBI->setCondition(NewCond);
Nick Lewyckyc9a1aed2011-12-26 20:54:14 +00001900 PBI->swapSuccessors();
Chris Lattner1347e872008-07-13 21:12:01 +00001901 }
Andrew Trick6b014382012-08-29 21:46:36 +00001902
Owen Andersone84178a2010-07-14 19:52:16 +00001903 // If we have a bonus inst, clone it into the predecessor block.
1904 Instruction *NewBonus = 0;
1905 if (BonusInst) {
1906 NewBonus = BonusInst->clone();
1907 PredBlock->getInstList().insert(PBI, NewBonus);
1908 NewBonus->takeName(BonusInst);
1909 BonusInst->setName(BonusInst->getName()+".old");
1910 }
Andrew Trick6b014382012-08-29 21:46:36 +00001911
Chris Lattner36989092008-07-13 21:20:19 +00001912 // Clone Cond into the predecessor basic block, and or/and the
1913 // two conditions together.
Nick Lewycky67760642009-09-27 07:38:41 +00001914 Instruction *New = Cond->clone();
Owen Andersone84178a2010-07-14 19:52:16 +00001915 if (BonusInst) New->replaceUsesOfWith(BonusInst, NewBonus);
Chris Lattner36989092008-07-13 21:20:19 +00001916 PredBlock->getInstList().insert(PBI, New);
1917 New->takeName(Cond);
1918 Cond->setName(New->getName()+".old");
Andrew Trick6b014382012-08-29 21:46:36 +00001919
Manman Renee28e0f2012-06-13 05:43:29 +00001920 if (BI->isConditional()) {
Andrew Trick6b014382012-08-29 21:46:36 +00001921 Instruction *NewCond =
Manman Renee28e0f2012-06-13 05:43:29 +00001922 cast<Instruction>(Builder.CreateBinOp(Opc, PBI->getCondition(),
Devang Pateld3a17882011-05-19 20:52:46 +00001923 New, "or.cond"));
Manman Renee28e0f2012-06-13 05:43:29 +00001924 PBI->setCondition(NewCond);
1925
1926 if (PBI->getSuccessor(0) == BB) {
1927 AddPredecessorToBlock(TrueDest, PredBlock, BB);
1928 PBI->setSuccessor(0, TrueDest);
1929 }
1930 if (PBI->getSuccessor(1) == BB) {
1931 AddPredecessorToBlock(FalseDest, PredBlock, BB);
1932 PBI->setSuccessor(1, FalseDest);
1933 }
1934 } else {
1935 // Update PHI nodes in the common successors.
1936 for (unsigned i = 0, e = PHIs.size(); i != e; ++i) {
Nick Lewyckyedb58422012-06-24 10:15:42 +00001937 ConstantInt *PBI_C = cast<ConstantInt>(
Manman Renee28e0f2012-06-13 05:43:29 +00001938 PHIs[i]->getIncomingValueForBlock(PBI->getParent()));
1939 assert(PBI_C->getType()->isIntegerTy(1));
1940 Instruction *MergedCond = 0;
1941 if (PBI->getSuccessor(0) == TrueDest) {
1942 // Create (PBI_Cond and PBI_C) or (!PBI_Cond and BI_Value)
1943 // PBI_C is true: PBI_Cond or (!PBI_Cond and BI_Value)
1944 // is false: !PBI_Cond and BI_Value
1945 Instruction *NotCond =
1946 cast<Instruction>(Builder.CreateNot(PBI->getCondition(),
1947 "not.cond"));
1948 MergedCond =
1949 cast<Instruction>(Builder.CreateBinOp(Instruction::And,
1950 NotCond, New,
1951 "and.cond"));
1952 if (PBI_C->isOne())
1953 MergedCond =
1954 cast<Instruction>(Builder.CreateBinOp(Instruction::Or,
1955 PBI->getCondition(), MergedCond,
1956 "or.cond"));
1957 } else {
1958 // Create (PBI_Cond and BI_Value) or (!PBI_Cond and PBI_C)
1959 // PBI_C is true: (PBI_Cond and BI_Value) or (!PBI_Cond)
1960 // is false: PBI_Cond and BI_Value
Andrew Trick6b014382012-08-29 21:46:36 +00001961 MergedCond =
Manman Renee28e0f2012-06-13 05:43:29 +00001962 cast<Instruction>(Builder.CreateBinOp(Instruction::And,
1963 PBI->getCondition(), New,
1964 "and.cond"));
1965 if (PBI_C->isOne()) {
1966 Instruction *NotCond =
1967 cast<Instruction>(Builder.CreateNot(PBI->getCondition(),
1968 "not.cond"));
Andrew Trick6b014382012-08-29 21:46:36 +00001969 MergedCond =
Manman Renee28e0f2012-06-13 05:43:29 +00001970 cast<Instruction>(Builder.CreateBinOp(Instruction::Or,
1971 NotCond, MergedCond,
1972 "or.cond"));
1973 }
1974 }
1975 // Update PHI Node.
1976 PHIs[i]->setIncomingValue(PHIs[i]->getBasicBlockIndex(PBI->getParent()),
1977 MergedCond);
1978 }
1979 // Change PBI from Conditional to Unconditional.
1980 BranchInst *New_PBI = BranchInst::Create(TrueDest, PBI);
1981 EraseTerminatorInstAndDCECond(PBI);
1982 PBI = New_PBI;
Chris Lattner36989092008-07-13 21:20:19 +00001983 }
Devang Pateld4181942011-04-06 22:37:20 +00001984
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001985 // TODO: If BB is reachable from all paths through PredBlock, then we
1986 // could replace PBI's branch probabilities with BI's.
1987
1988 // Merge probability data into PredBlock's branch.
1989 APInt A, B, C, D;
Manman Renee28e0f2012-06-13 05:43:29 +00001990 if (PBI->isConditional() && BI->isConditional() &&
1991 ExtractBranchMetadata(PBI, C, D) && ExtractBranchMetadata(BI, A, B)) {
Nick Lewycky8da7ddf2011-12-28 06:57:32 +00001992 // Given IR which does:
1993 // bbA:
1994 // br i1 %x, label %bbB, label %bbC
1995 // bbB:
1996 // br i1 %y, label %bbD, label %bbC
1997 // Let's call the probability that we take the edge from %bbA to %bbB
1998 // 'a', from %bbA to %bbC, 'b', from %bbB to %bbD 'c' and from %bbB to
1999 // %bbC probability 'd'.
Nick Lewycky06cc66f2011-12-27 04:31:52 +00002000 //
Nick Lewycky8da7ddf2011-12-28 06:57:32 +00002001 // We transform the IR into:
2002 // bbA:
2003 // br i1 %z, label %bbD, label %bbC
2004 // where the probability of going to %bbD is (a*c) and going to bbC is
2005 // (b+a*d).
2006 //
2007 // Probabilities aren't stored as ratios directly. Using branch weights,
2008 // we get:
Nick Lewycky06cc66f2011-12-27 04:31:52 +00002009 // (a*c)% = A*C, (b+(a*d))% = A*D+B*C+B*D.
2010
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00002011 // In the event of overflow, we want to drop the LSB of the input
2012 // probabilities.
2013 unsigned BitsLost;
Nick Lewycky06cc66f2011-12-27 04:31:52 +00002014
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00002015 // Ignore overflow result on ProbTrue.
2016 APInt ProbTrue = MultiplyAndLosePrecision(A, C, B, D, BitsLost);
Nick Lewycky06cc66f2011-12-27 04:31:52 +00002017
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00002018 APInt Tmp1 = MultiplyAndLosePrecision(B, D, A, C, BitsLost);
2019 if (BitsLost) {
2020 ProbTrue = ProbTrue.lshr(BitsLost*2);
2021 }
Nick Lewycky06cc66f2011-12-27 04:31:52 +00002022
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00002023 APInt Tmp2 = MultiplyAndLosePrecision(A, D, C, B, BitsLost);
2024 if (BitsLost) {
2025 ProbTrue = ProbTrue.lshr(BitsLost*2);
2026 Tmp1 = Tmp1.lshr(BitsLost*2);
2027 }
2028
2029 APInt Tmp3 = MultiplyAndLosePrecision(B, C, A, D, BitsLost);
2030 if (BitsLost) {
2031 ProbTrue = ProbTrue.lshr(BitsLost*2);
2032 Tmp1 = Tmp1.lshr(BitsLost*2);
2033 Tmp2 = Tmp2.lshr(BitsLost*2);
2034 }
2035
2036 bool Overflow1 = false, Overflow2 = false;
2037 APInt Tmp4 = Tmp2.uadd_ov(Tmp3, Overflow1);
2038 APInt ProbFalse = Tmp4.uadd_ov(Tmp1, Overflow2);
2039
2040 if (Overflow1 || Overflow2) {
2041 ProbTrue = ProbTrue.lshr(1);
2042 Tmp1 = Tmp1.lshr(1);
2043 Tmp2 = Tmp2.lshr(1);
2044 Tmp3 = Tmp3.lshr(1);
2045 Tmp4 = Tmp2 + Tmp3;
2046 ProbFalse = Tmp4 + Tmp1;
2047 }
2048
2049 // The sum of branch weights must fit in 32-bits.
2050 if (ProbTrue.isNegative() && ProbFalse.isNegative()) {
2051 ProbTrue = ProbTrue.lshr(1);
2052 ProbFalse = ProbFalse.lshr(1);
2053 }
2054
2055 if (ProbTrue != ProbFalse) {
2056 // Normalize the result.
2057 APInt GCD = APIntOps::GreatestCommonDivisor(ProbTrue, ProbFalse);
2058 ProbTrue = ProbTrue.udiv(GCD);
2059 ProbFalse = ProbFalse.udiv(GCD);
2060
Benjamin Kramer937338c2012-05-26 13:59:43 +00002061 MDBuilder MDB(BI->getContext());
2062 MDNode *N = MDB.createBranchWeights(ProbTrue.getZExtValue(),
2063 ProbFalse.getZExtValue());
2064 PBI->setMetadata(LLVMContext::MD_prof, N);
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00002065 } else {
2066 PBI->setMetadata(LLVMContext::MD_prof, NULL);
Nick Lewycky06cc66f2011-12-27 04:31:52 +00002067 }
2068 } else {
2069 PBI->setMetadata(LLVMContext::MD_prof, NULL);
2070 }
2071
Chris Lattner3c6e7462011-04-14 02:44:53 +00002072 // Copy any debug value intrinsics into the end of PredBlock.
2073 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
2074 if (isa<DbgInfoIntrinsic>(*I))
2075 I->clone()->insertBefore(PBI);
Andrew Trick6b014382012-08-29 21:46:36 +00002076
Chris Lattner117f8cf2010-12-14 05:57:30 +00002077 return true;
Chris Lattner1347e872008-07-13 21:12:01 +00002078 }
2079 return false;
2080}
2081
Chris Lattner867661a2008-07-13 21:53:26 +00002082/// SimplifyCondBranchToCondBranch - If we have a conditional branch as a
2083/// predecessor of another block, this function tries to simplify it. We know
2084/// that PBI and BI are both conditional branches, and BI is in one of the
2085/// successor blocks of PBI - PBI branches to BI.
2086static bool SimplifyCondBranchToCondBranch(BranchInst *PBI, BranchInst *BI) {
2087 assert(PBI->isConditional() && BI->isConditional());
2088 BasicBlock *BB = BI->getParent();
Dan Gohman4ae51262009-08-12 16:23:25 +00002089
Chris Lattner867661a2008-07-13 21:53:26 +00002090 // If this block ends with a branch instruction, and if there is a
Andrew Trick6b014382012-08-29 21:46:36 +00002091 // predecessor that ends on a branch of the same condition, make
Chris Lattner867661a2008-07-13 21:53:26 +00002092 // this conditional branch redundant.
2093 if (PBI->getCondition() == BI->getCondition() &&
2094 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
2095 // Okay, the outcome of this conditional branch is statically
2096 // knowable. If this block had a single pred, handle specially.
2097 if (BB->getSinglePredecessor()) {
2098 // Turn this into a branch on constant.
2099 bool CondIsTrue = PBI->getSuccessor(0) == BB;
Andrew Trick6b014382012-08-29 21:46:36 +00002100 BI->setCondition(ConstantInt::get(Type::getInt1Ty(BB->getContext()),
Owen Anderson1d0be152009-08-13 21:58:54 +00002101 CondIsTrue));
Chris Lattner867661a2008-07-13 21:53:26 +00002102 return true; // Nuke the branch on constant.
2103 }
Andrew Trick6b014382012-08-29 21:46:36 +00002104
Chris Lattner867661a2008-07-13 21:53:26 +00002105 // Otherwise, if there are multiple predecessors, insert a PHI that merges
2106 // in the constant and simplify the block result. Subsequent passes of
2107 // simplifycfg will thread the block.
2108 if (BlockIsSimpleEnoughToThreadThrough(BB)) {
Jay Foadd8b4fb42011-03-30 11:19:20 +00002109 pred_iterator PB = pred_begin(BB), PE = pred_end(BB);
Owen Anderson1d0be152009-08-13 21:58:54 +00002110 PHINode *NewPN = PHINode::Create(Type::getInt1Ty(BB->getContext()),
Jay Foad3ecfc862011-03-30 11:28:46 +00002111 std::distance(PB, PE),
Chris Lattner867661a2008-07-13 21:53:26 +00002112 BI->getCondition()->getName() + ".pr",
2113 BB->begin());
Chris Lattnereb388af2008-07-13 21:55:46 +00002114 // Okay, we're going to insert the PHI node. Since PBI is not the only
2115 // predecessor, compute the PHI'd conditional value for all of the preds.
2116 // Any predecessor where the condition is not computable we keep symbolic.
Jay Foadd8b4fb42011-03-30 11:19:20 +00002117 for (pred_iterator PI = PB; PI != PE; ++PI) {
Gabor Greif62539832010-07-12 10:59:23 +00002118 BasicBlock *P = *PI;
2119 if ((PBI = dyn_cast<BranchInst>(P->getTerminator())) &&
Chris Lattner867661a2008-07-13 21:53:26 +00002120 PBI != BI && PBI->isConditional() &&
2121 PBI->getCondition() == BI->getCondition() &&
2122 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
2123 bool CondIsTrue = PBI->getSuccessor(0) == BB;
Andrew Trick6b014382012-08-29 21:46:36 +00002124 NewPN->addIncoming(ConstantInt::get(Type::getInt1Ty(BB->getContext()),
Gabor Greif62539832010-07-12 10:59:23 +00002125 CondIsTrue), P);
Chris Lattner867661a2008-07-13 21:53:26 +00002126 } else {
Gabor Greif62539832010-07-12 10:59:23 +00002127 NewPN->addIncoming(BI->getCondition(), P);
Chris Lattner867661a2008-07-13 21:53:26 +00002128 }
Gabor Greif62539832010-07-12 10:59:23 +00002129 }
Andrew Trick6b014382012-08-29 21:46:36 +00002130
Chris Lattner867661a2008-07-13 21:53:26 +00002131 BI->setCondition(NewPN);
Chris Lattner867661a2008-07-13 21:53:26 +00002132 return true;
2133 }
2134 }
Andrew Trick6b014382012-08-29 21:46:36 +00002135
Chris Lattner867661a2008-07-13 21:53:26 +00002136 // If this is a conditional branch in an empty block, and if any
2137 // predecessors is a conditional branch to one of our destinations,
2138 // fold the conditions into logical ops and one cond br.
Zhou Shenga8d57fe2009-02-26 06:56:37 +00002139 BasicBlock::iterator BBI = BB->begin();
2140 // Ignore dbg intrinsics.
2141 while (isa<DbgInfoIntrinsic>(BBI))
2142 ++BBI;
2143 if (&*BBI != BI)
Chris Lattnerb8245122008-07-13 22:04:41 +00002144 return false;
Chris Lattner63bf29b2009-01-20 01:15:41 +00002145
Andrew Trick6b014382012-08-29 21:46:36 +00002146
Chris Lattner63bf29b2009-01-20 01:15:41 +00002147 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(BI->getCondition()))
2148 if (CE->canTrap())
2149 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002150
Chris Lattnerb8245122008-07-13 22:04:41 +00002151 int PBIOp, BIOp;
2152 if (PBI->getSuccessor(0) == BI->getSuccessor(0))
2153 PBIOp = BIOp = 0;
2154 else if (PBI->getSuccessor(0) == BI->getSuccessor(1))
2155 PBIOp = 0, BIOp = 1;
2156 else if (PBI->getSuccessor(1) == BI->getSuccessor(0))
2157 PBIOp = 1, BIOp = 0;
2158 else if (PBI->getSuccessor(1) == BI->getSuccessor(1))
2159 PBIOp = BIOp = 1;
2160 else
2161 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002162
Chris Lattnerb8245122008-07-13 22:04:41 +00002163 // Check to make sure that the other destination of this branch
2164 // isn't BB itself. If so, this is an infinite loop that will
2165 // keep getting unwound.
2166 if (PBI->getSuccessor(PBIOp) == BB)
2167 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002168
2169 // Do not perform this transformation if it would require
Chris Lattnerb8245122008-07-13 22:04:41 +00002170 // insertion of a large number of select instructions. For targets
2171 // without predication/cmovs, this is a big pessimization.
2172 BasicBlock *CommonDest = PBI->getSuccessor(PBIOp);
Andrew Trick6b014382012-08-29 21:46:36 +00002173
Chris Lattnerb8245122008-07-13 22:04:41 +00002174 unsigned NumPhis = 0;
2175 for (BasicBlock::iterator II = CommonDest->begin();
2176 isa<PHINode>(II); ++II, ++NumPhis)
2177 if (NumPhis > 2) // Disable this xform.
2178 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002179
Chris Lattnerb8245122008-07-13 22:04:41 +00002180 // Finally, if everything is ok, fold the branches to logical ops.
2181 BasicBlock *OtherDest = BI->getSuccessor(BIOp ^ 1);
Andrew Trick6b014382012-08-29 21:46:36 +00002182
David Greene89d6fd32010-01-05 01:26:52 +00002183 DEBUG(dbgs() << "FOLDING BRs:" << *PBI->getParent()
Chris Lattnerbdff5482009-08-23 04:37:46 +00002184 << "AND: " << *BI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00002185
2186
Chris Lattner093a4382008-07-13 22:23:11 +00002187 // If OtherDest *is* BB, then BB is a basic block with a single conditional
2188 // branch in it, where one edge (OtherDest) goes back to itself but the other
2189 // exits. We don't *know* that the program avoids the infinite loop
2190 // (even though that seems likely). If we do this xform naively, we'll end up
2191 // recursively unpeeling the loop. Since we know that (after the xform is
2192 // done) that the block *is* infinite if reached, we just make it an obviously
2193 // infinite loop with no cond branch.
2194 if (OtherDest == BB) {
2195 // Insert it at the end of the function, because it's either code,
2196 // or it won't matter if it's hot. :)
Owen Anderson1d0be152009-08-13 21:58:54 +00002197 BasicBlock *InfLoopBlock = BasicBlock::Create(BB->getContext(),
2198 "infloop", BB->getParent());
Chris Lattner093a4382008-07-13 22:23:11 +00002199 BranchInst::Create(InfLoopBlock, InfLoopBlock);
2200 OtherDest = InfLoopBlock;
Andrew Trick6b014382012-08-29 21:46:36 +00002201 }
2202
David Greene89d6fd32010-01-05 01:26:52 +00002203 DEBUG(dbgs() << *PBI->getParent()->getParent());
Devang Pateld3a17882011-05-19 20:52:46 +00002204
Chris Lattnerb8245122008-07-13 22:04:41 +00002205 // BI may have other predecessors. Because of this, we leave
2206 // it alone, but modify PBI.
Andrew Trick6b014382012-08-29 21:46:36 +00002207
Chris Lattnerb8245122008-07-13 22:04:41 +00002208 // Make sure we get to CommonDest on True&True directions.
2209 Value *PBICond = PBI->getCondition();
Devang Pateld3a17882011-05-19 20:52:46 +00002210 IRBuilder<true, NoFolder> Builder(PBI);
Chris Lattnerb8245122008-07-13 22:04:41 +00002211 if (PBIOp)
Devang Pateld3a17882011-05-19 20:52:46 +00002212 PBICond = Builder.CreateNot(PBICond, PBICond->getName()+".not");
2213
Chris Lattnerb8245122008-07-13 22:04:41 +00002214 Value *BICond = BI->getCondition();
2215 if (BIOp)
Devang Pateld3a17882011-05-19 20:52:46 +00002216 BICond = Builder.CreateNot(BICond, BICond->getName()+".not");
2217
Chris Lattnerb8245122008-07-13 22:04:41 +00002218 // Merge the conditions.
Devang Pateld3a17882011-05-19 20:52:46 +00002219 Value *Cond = Builder.CreateOr(PBICond, BICond, "brmerge");
Andrew Trick6b014382012-08-29 21:46:36 +00002220
Chris Lattnerb8245122008-07-13 22:04:41 +00002221 // Modify PBI to branch on the new condition to the new dests.
2222 PBI->setCondition(Cond);
2223 PBI->setSuccessor(0, CommonDest);
2224 PBI->setSuccessor(1, OtherDest);
Andrew Trick6b014382012-08-29 21:46:36 +00002225
Chris Lattnerb8245122008-07-13 22:04:41 +00002226 // OtherDest may have phi nodes. If so, add an entry from PBI's
2227 // block that are identical to the entries for BI's block.
Chris Lattner6de0a282010-12-14 07:09:42 +00002228 AddPredecessorToBlock(OtherDest, PBI->getParent(), BB);
Andrew Trick6b014382012-08-29 21:46:36 +00002229
Chris Lattnerb8245122008-07-13 22:04:41 +00002230 // We know that the CommonDest already had an edge from PBI to
2231 // it. If it has PHIs though, the PHIs may have different
2232 // entries for BB and PBI's BB. If so, insert a select to make
2233 // them agree.
Chris Lattner6de0a282010-12-14 07:09:42 +00002234 PHINode *PN;
Chris Lattnerb8245122008-07-13 22:04:41 +00002235 for (BasicBlock::iterator II = CommonDest->begin();
2236 (PN = dyn_cast<PHINode>(II)); ++II) {
2237 Value *BIV = PN->getIncomingValueForBlock(BB);
2238 unsigned PBBIdx = PN->getBasicBlockIndex(PBI->getParent());
2239 Value *PBIV = PN->getIncomingValue(PBBIdx);
2240 if (BIV != PBIV) {
2241 // Insert a select in PBI to pick the right value.
Devang Pateld3a17882011-05-19 20:52:46 +00002242 Value *NV = cast<SelectInst>
2243 (Builder.CreateSelect(PBICond, PBIV, BIV, PBIV->getName()+".mux"));
Chris Lattnerb8245122008-07-13 22:04:41 +00002244 PN->setIncomingValue(PBBIdx, NV);
Chris Lattner867661a2008-07-13 21:53:26 +00002245 }
2246 }
Andrew Trick6b014382012-08-29 21:46:36 +00002247
David Greene89d6fd32010-01-05 01:26:52 +00002248 DEBUG(dbgs() << "INTO: " << *PBI->getParent());
2249 DEBUG(dbgs() << *PBI->getParent()->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00002250
Chris Lattnerb8245122008-07-13 22:04:41 +00002251 // This basic block is probably dead. We know it has at least
2252 // one fewer predecessor.
2253 return true;
Chris Lattner867661a2008-07-13 21:53:26 +00002254}
2255
Frits van Bommel65fdded2011-01-11 12:52:11 +00002256// SimplifyTerminatorOnSelect - Simplifies a terminator by replacing it with a
2257// branch to TrueBB if Cond is true or to FalseBB if Cond is false.
2258// Takes care of updating the successors and removing the old terminator.
2259// Also makes sure not to introduce new successors by assuming that edges to
2260// non-successor TrueBBs and FalseBBs aren't reachable.
2261static bool SimplifyTerminatorOnSelect(TerminatorInst *OldTerm, Value *Cond,
2262 BasicBlock *TrueBB, BasicBlock *FalseBB){
2263 // Remove any superfluous successor edges from the CFG.
2264 // First, figure out which successors to preserve.
2265 // If TrueBB and FalseBB are equal, only try to preserve one copy of that
2266 // successor.
2267 BasicBlock *KeepEdge1 = TrueBB;
2268 BasicBlock *KeepEdge2 = TrueBB != FalseBB ? FalseBB : 0;
2269
2270 // Then remove the rest.
2271 for (unsigned I = 0, E = OldTerm->getNumSuccessors(); I != E; ++I) {
2272 BasicBlock *Succ = OldTerm->getSuccessor(I);
2273 // Make sure only to keep exactly one copy of each edge.
2274 if (Succ == KeepEdge1)
2275 KeepEdge1 = 0;
2276 else if (Succ == KeepEdge2)
2277 KeepEdge2 = 0;
2278 else
2279 Succ->removePredecessor(OldTerm->getParent());
2280 }
2281
Devang Pateld3372b82011-05-18 18:43:31 +00002282 IRBuilder<> Builder(OldTerm);
2283 Builder.SetCurrentDebugLocation(OldTerm->getDebugLoc());
2284
Frits van Bommel65fdded2011-01-11 12:52:11 +00002285 // Insert an appropriate new terminator.
2286 if ((KeepEdge1 == 0) && (KeepEdge2 == 0)) {
2287 if (TrueBB == FalseBB)
2288 // We were only looking for one successor, and it was present.
2289 // Create an unconditional branch to it.
Devang Pateld3372b82011-05-18 18:43:31 +00002290 Builder.CreateBr(TrueBB);
Frits van Bommel65fdded2011-01-11 12:52:11 +00002291 else
2292 // We found both of the successors we were looking for.
2293 // Create a conditional branch sharing the condition of the select.
Devang Pateld3372b82011-05-18 18:43:31 +00002294 Builder.CreateCondBr(Cond, TrueBB, FalseBB);
Frits van Bommel65fdded2011-01-11 12:52:11 +00002295 } else if (KeepEdge1 && (KeepEdge2 || TrueBB == FalseBB)) {
2296 // Neither of the selected blocks were successors, so this
2297 // terminator must be unreachable.
2298 new UnreachableInst(OldTerm->getContext(), OldTerm);
2299 } else {
2300 // One of the selected values was a successor, but the other wasn't.
2301 // Insert an unconditional branch to the one that was found;
2302 // the edge to the one that wasn't must be unreachable.
2303 if (KeepEdge1 == 0)
2304 // Only TrueBB was found.
Devang Pateld3372b82011-05-18 18:43:31 +00002305 Builder.CreateBr(TrueBB);
Frits van Bommel65fdded2011-01-11 12:52:11 +00002306 else
2307 // Only FalseBB was found.
Devang Pateld3372b82011-05-18 18:43:31 +00002308 Builder.CreateBr(FalseBB);
Frits van Bommel65fdded2011-01-11 12:52:11 +00002309 }
2310
2311 EraseTerminatorInstAndDCECond(OldTerm);
2312 return true;
2313}
2314
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00002315// SimplifySwitchOnSelect - Replaces
2316// (switch (select cond, X, Y)) on constant X, Y
2317// with a branch - conditional if X and Y lead to distinct BBs,
2318// unconditional otherwise.
2319static bool SimplifySwitchOnSelect(SwitchInst *SI, SelectInst *Select) {
2320 // Check for constant integer values in the select.
2321 ConstantInt *TrueVal = dyn_cast<ConstantInt>(Select->getTrueValue());
2322 ConstantInt *FalseVal = dyn_cast<ConstantInt>(Select->getFalseValue());
2323 if (!TrueVal || !FalseVal)
2324 return false;
2325
2326 // Find the relevant condition and destinations.
2327 Value *Condition = Select->getCondition();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002328 BasicBlock *TrueBB = SI->findCaseValue(TrueVal).getCaseSuccessor();
2329 BasicBlock *FalseBB = SI->findCaseValue(FalseVal).getCaseSuccessor();
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00002330
2331 // Perform the actual simplification.
2332 return SimplifyTerminatorOnSelect(SI, Condition, TrueBB, FalseBB);
2333}
2334
Frits van Bommel7ac40c32010-12-05 18:29:03 +00002335// SimplifyIndirectBrOnSelect - Replaces
2336// (indirectbr (select cond, blockaddress(@fn, BlockA),
2337// blockaddress(@fn, BlockB)))
2338// with
2339// (br cond, BlockA, BlockB).
2340static bool SimplifyIndirectBrOnSelect(IndirectBrInst *IBI, SelectInst *SI) {
2341 // Check that both operands of the select are block addresses.
2342 BlockAddress *TBA = dyn_cast<BlockAddress>(SI->getTrueValue());
2343 BlockAddress *FBA = dyn_cast<BlockAddress>(SI->getFalseValue());
2344 if (!TBA || !FBA)
2345 return false;
2346
2347 // Extract the actual blocks.
2348 BasicBlock *TrueBB = TBA->getBasicBlock();
2349 BasicBlock *FalseBB = FBA->getBasicBlock();
2350
Frits van Bommel65fdded2011-01-11 12:52:11 +00002351 // Perform the actual simplification.
2352 return SimplifyTerminatorOnSelect(IBI, SI->getCondition(), TrueBB, FalseBB);
Frits van Bommel7ac40c32010-12-05 18:29:03 +00002353}
2354
Chris Lattner61c77442010-12-13 03:18:54 +00002355/// TryToSimplifyUncondBranchWithICmpInIt - This is called when we find an icmp
2356/// instruction (a seteq/setne with a constant) as the only instruction in a
2357/// block that ends with an uncond branch. We are looking for a very specific
2358/// pattern that occurs when "A == 1 || A == 2 || A == 3" gets simplified. In
2359/// this case, we merge the first two "or's of icmp" into a switch, but then the
2360/// default value goes to an uncond block with a seteq in it, we get something
2361/// like:
2362///
2363/// switch i8 %A, label %DEFAULT [ i8 1, label %end i8 2, label %end ]
2364/// DEFAULT:
2365/// %tmp = icmp eq i8 %A, 92
2366/// br label %end
2367/// end:
2368/// ... = phi i1 [ true, %entry ], [ %tmp, %DEFAULT ], [ true, %entry ]
Andrew Trick6b014382012-08-29 21:46:36 +00002369///
Chris Lattner61c77442010-12-13 03:18:54 +00002370/// We prefer to split the edge to 'end' so that there is a true/false entry to
2371/// the PHI, merging the third icmp into the switch.
Chris Lattner302ba6f2010-12-14 06:17:25 +00002372static bool TryToSimplifyUncondBranchWithICmpInIt(ICmpInst *ICI,
Devang Patela23812c2011-05-18 18:28:48 +00002373 const TargetData *TD,
2374 IRBuilder<> &Builder) {
Chris Lattner61c77442010-12-13 03:18:54 +00002375 BasicBlock *BB = ICI->getParent();
Devang Patela23812c2011-05-18 18:28:48 +00002376
Chris Lattner61c77442010-12-13 03:18:54 +00002377 // If the block has any PHIs in it or the icmp has multiple uses, it is too
2378 // complex.
2379 if (isa<PHINode>(BB->begin()) || !ICI->hasOneUse()) return false;
2380
2381 Value *V = ICI->getOperand(0);
2382 ConstantInt *Cst = cast<ConstantInt>(ICI->getOperand(1));
Andrew Trick6b014382012-08-29 21:46:36 +00002383
Chris Lattner61c77442010-12-13 03:18:54 +00002384 // The pattern we're looking for is where our only predecessor is a switch on
2385 // 'V' and this block is the default case for the switch. In this case we can
2386 // fold the compared value into the switch to simplify things.
2387 BasicBlock *Pred = BB->getSinglePredecessor();
2388 if (Pred == 0 || !isa<SwitchInst>(Pred->getTerminator())) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002389
Chris Lattner61c77442010-12-13 03:18:54 +00002390 SwitchInst *SI = cast<SwitchInst>(Pred->getTerminator());
2391 if (SI->getCondition() != V)
2392 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002393
Chris Lattner61c77442010-12-13 03:18:54 +00002394 // If BB is reachable on a non-default case, then we simply know the value of
2395 // V in this block. Substitute it and constant fold the icmp instruction
2396 // away.
2397 if (SI->getDefaultDest() != BB) {
2398 ConstantInt *VVal = SI->findCaseDest(BB);
2399 assert(VVal && "Should have a unique destination value");
2400 ICI->setOperand(0, VVal);
Andrew Trick6b014382012-08-29 21:46:36 +00002401
Chris Lattner302ba6f2010-12-14 06:17:25 +00002402 if (Value *V = SimplifyInstruction(ICI, TD)) {
2403 ICI->replaceAllUsesWith(V);
Chris Lattner61c77442010-12-13 03:18:54 +00002404 ICI->eraseFromParent();
2405 }
2406 // BB is now empty, so it is likely to simplify away.
2407 return SimplifyCFG(BB) | true;
2408 }
Andrew Trick6b014382012-08-29 21:46:36 +00002409
Chris Lattnerabf70672010-12-13 03:43:57 +00002410 // Ok, the block is reachable from the default dest. If the constant we're
2411 // comparing exists in one of the other edges, then we can constant fold ICI
2412 // and zap it.
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002413 if (SI->findCaseValue(Cst) != SI->case_default()) {
Chris Lattnerabf70672010-12-13 03:43:57 +00002414 Value *V;
2415 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
2416 V = ConstantInt::getFalse(BB->getContext());
2417 else
2418 V = ConstantInt::getTrue(BB->getContext());
Andrew Trick6b014382012-08-29 21:46:36 +00002419
Chris Lattnerabf70672010-12-13 03:43:57 +00002420 ICI->replaceAllUsesWith(V);
2421 ICI->eraseFromParent();
2422 // BB is now empty, so it is likely to simplify away.
2423 return SimplifyCFG(BB) | true;
2424 }
Andrew Trick6b014382012-08-29 21:46:36 +00002425
Chris Lattner61c77442010-12-13 03:18:54 +00002426 // The use of the icmp has to be in the 'end' block, by the only PHI node in
2427 // the block.
2428 BasicBlock *SuccBlock = BB->getTerminator()->getSuccessor(0);
2429 PHINode *PHIUse = dyn_cast<PHINode>(ICI->use_back());
2430 if (PHIUse == 0 || PHIUse != &SuccBlock->front() ||
2431 isa<PHINode>(++BasicBlock::iterator(PHIUse)))
2432 return false;
2433
2434 // If the icmp is a SETEQ, then the default dest gets false, the new edge gets
2435 // true in the PHI.
2436 Constant *DefaultCst = ConstantInt::getTrue(BB->getContext());
2437 Constant *NewCst = ConstantInt::getFalse(BB->getContext());
2438
2439 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
2440 std::swap(DefaultCst, NewCst);
2441
2442 // Replace ICI (which is used by the PHI for the default value) with true or
2443 // false depending on if it is EQ or NE.
2444 ICI->replaceAllUsesWith(DefaultCst);
2445 ICI->eraseFromParent();
2446
2447 // Okay, the switch goes to this block on a default value. Add an edge from
2448 // the switch to the merge point on the compared value.
2449 BasicBlock *NewBB = BasicBlock::Create(BB->getContext(), "switch.edge",
2450 BB->getParent(), BB);
2451 SI->addCase(Cst, NewBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002452
Chris Lattner61c77442010-12-13 03:18:54 +00002453 // NewBB branches to the phi block, add the uncond branch and the phi entry.
Devang Patela23812c2011-05-18 18:28:48 +00002454 Builder.SetInsertPoint(NewBB);
2455 Builder.SetCurrentDebugLocation(SI->getDebugLoc());
2456 Builder.CreateBr(SuccBlock);
Chris Lattner61c77442010-12-13 03:18:54 +00002457 PHIUse->addIncoming(NewCst, NewBB);
2458 return true;
2459}
2460
Chris Lattner97fdb892010-12-13 05:03:41 +00002461/// SimplifyBranchOnICmpChain - The specified branch is a conditional branch.
2462/// Check to see if it is branching on an or/and chain of icmp instructions, and
2463/// fold it into a switch instruction if so.
Devang Patel02dd5412011-05-18 23:18:47 +00002464static bool SimplifyBranchOnICmpChain(BranchInst *BI, const TargetData *TD,
2465 IRBuilder<> &Builder) {
Chris Lattner97fdb892010-12-13 05:03:41 +00002466 Instruction *Cond = dyn_cast<Instruction>(BI->getCondition());
2467 if (Cond == 0) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002468
2469
Chris Lattner97fdb892010-12-13 05:03:41 +00002470 // Change br (X == 0 | X == 1), T, F into a switch instruction.
2471 // If this is a bunch of seteq's or'd together, or if it's a bunch of
2472 // 'setne's and'ed together, collect them.
2473 Value *CompVal = 0;
2474 std::vector<ConstantInt*> Values;
2475 bool TrueWhenEqual = true;
2476 Value *ExtraCase = 0;
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002477 unsigned UsedICmps = 0;
Andrew Trick6b014382012-08-29 21:46:36 +00002478
Chris Lattner97fdb892010-12-13 05:03:41 +00002479 if (Cond->getOpcode() == Instruction::Or) {
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002480 CompVal = GatherConstantCompares(Cond, Values, ExtraCase, TD, true,
2481 UsedICmps);
Chris Lattner97fdb892010-12-13 05:03:41 +00002482 } else if (Cond->getOpcode() == Instruction::And) {
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002483 CompVal = GatherConstantCompares(Cond, Values, ExtraCase, TD, false,
2484 UsedICmps);
Chris Lattner97fdb892010-12-13 05:03:41 +00002485 TrueWhenEqual = false;
2486 }
Andrew Trick6b014382012-08-29 21:46:36 +00002487
Chris Lattner97fdb892010-12-13 05:03:41 +00002488 // If we didn't have a multiply compared value, fail.
2489 if (CompVal == 0) return false;
2490
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002491 // Avoid turning single icmps into a switch.
2492 if (UsedICmps <= 1)
2493 return false;
2494
Chris Lattner97fdb892010-12-13 05:03:41 +00002495 // There might be duplicate constants in the list, which the switch
2496 // instruction can't handle, remove them now.
2497 array_pod_sort(Values.begin(), Values.end(), ConstantIntSortPredicate);
2498 Values.erase(std::unique(Values.begin(), Values.end()), Values.end());
Andrew Trick6b014382012-08-29 21:46:36 +00002499
Chris Lattner97fdb892010-12-13 05:03:41 +00002500 // If Extra was used, we require at least two switch values to do the
2501 // transformation. A switch with one value is just an cond branch.
2502 if (ExtraCase && Values.size() < 2) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002503
Andrew Trickb1b97832012-08-29 21:46:38 +00002504 // TODO: Preserve branch weight metadata, similarly to how
2505 // FoldValueComparisonIntoPredecessors preserves it.
2506
Chris Lattner97fdb892010-12-13 05:03:41 +00002507 // Figure out which block is which destination.
2508 BasicBlock *DefaultBB = BI->getSuccessor(1);
2509 BasicBlock *EdgeBB = BI->getSuccessor(0);
2510 if (!TrueWhenEqual) std::swap(DefaultBB, EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002511
Chris Lattner97fdb892010-12-13 05:03:41 +00002512 BasicBlock *BB = BI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002513
Chris Lattner302ba6f2010-12-14 06:17:25 +00002514 DEBUG(dbgs() << "Converting 'icmp' chain with " << Values.size()
Chris Lattner117f8cf2010-12-14 05:57:30 +00002515 << " cases into SWITCH. BB is:\n" << *BB);
Andrew Trick6b014382012-08-29 21:46:36 +00002516
Chris Lattner97fdb892010-12-13 05:03:41 +00002517 // If there are any extra values that couldn't be folded into the switch
2518 // then we evaluate them with an explicit branch first. Split the block
2519 // right before the condbr to handle it.
2520 if (ExtraCase) {
2521 BasicBlock *NewBB = BB->splitBasicBlock(BI, "switch.early.test");
2522 // Remove the uncond branch added to the old block.
2523 TerminatorInst *OldTI = BB->getTerminator();
Devang Patel02dd5412011-05-18 23:18:47 +00002524 Builder.SetInsertPoint(OldTI);
2525
Chris Lattner117f8cf2010-12-14 05:57:30 +00002526 if (TrueWhenEqual)
Devang Patel02dd5412011-05-18 23:18:47 +00002527 Builder.CreateCondBr(ExtraCase, EdgeBB, NewBB);
Chris Lattner117f8cf2010-12-14 05:57:30 +00002528 else
Devang Patel02dd5412011-05-18 23:18:47 +00002529 Builder.CreateCondBr(ExtraCase, NewBB, EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002530
Chris Lattner97fdb892010-12-13 05:03:41 +00002531 OldTI->eraseFromParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002532
Chris Lattner97bd89e2010-12-13 05:34:18 +00002533 // If there are PHI nodes in EdgeBB, then we need to add a new entry to them
2534 // for the edge we just added.
Chris Lattner6de0a282010-12-14 07:09:42 +00002535 AddPredecessorToBlock(EdgeBB, BB, NewBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002536
Chris Lattner302ba6f2010-12-14 06:17:25 +00002537 DEBUG(dbgs() << " ** 'icmp' chain unhandled condition: " << *ExtraCase
2538 << "\nEXTRABB = " << *BB);
Chris Lattner97fdb892010-12-13 05:03:41 +00002539 BB = NewBB;
2540 }
Devang Patel02dd5412011-05-18 23:18:47 +00002541
2542 Builder.SetInsertPoint(BI);
Chris Lattner97fdb892010-12-13 05:03:41 +00002543 // Convert pointer to int before we switch.
2544 if (CompVal->getType()->isPointerTy()) {
2545 assert(TD && "Cannot switch on pointer without TargetData");
Devang Patel02dd5412011-05-18 23:18:47 +00002546 CompVal = Builder.CreatePtrToInt(CompVal,
2547 TD->getIntPtrType(CompVal->getContext()),
2548 "magicptr");
Chris Lattner97fdb892010-12-13 05:03:41 +00002549 }
Andrew Trick6b014382012-08-29 21:46:36 +00002550
Chris Lattner97fdb892010-12-13 05:03:41 +00002551 // Create the new switch instruction now.
Devang Patel02dd5412011-05-18 23:18:47 +00002552 SwitchInst *New = Builder.CreateSwitch(CompVal, DefaultBB, Values.size());
Devang Pateld80e8ed2011-05-17 23:29:05 +00002553
Chris Lattner97fdb892010-12-13 05:03:41 +00002554 // Add all of the 'cases' to the switch instruction.
2555 for (unsigned i = 0, e = Values.size(); i != e; ++i)
2556 New->addCase(Values[i], EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002557
Chris Lattner97fdb892010-12-13 05:03:41 +00002558 // We added edges from PI to the EdgeBB. As such, if there were any
2559 // PHI nodes in EdgeBB, they need entries to be added corresponding to
2560 // the number of edges added.
2561 for (BasicBlock::iterator BBI = EdgeBB->begin();
2562 isa<PHINode>(BBI); ++BBI) {
2563 PHINode *PN = cast<PHINode>(BBI);
2564 Value *InVal = PN->getIncomingValueForBlock(BB);
2565 for (unsigned i = 0, e = Values.size()-1; i != e; ++i)
2566 PN->addIncoming(InVal, BB);
2567 }
Andrew Trick6b014382012-08-29 21:46:36 +00002568
Chris Lattner97fdb892010-12-13 05:03:41 +00002569 // Erase the old branch instruction.
2570 EraseTerminatorInstAndDCECond(BI);
Andrew Trick6b014382012-08-29 21:46:36 +00002571
Chris Lattner302ba6f2010-12-14 06:17:25 +00002572 DEBUG(dbgs() << " ** 'icmp' chain result is:\n" << *BB << '\n');
Chris Lattner97fdb892010-12-13 05:03:41 +00002573 return true;
2574}
2575
Duncan Sandsad99ef82011-09-05 12:57:57 +00002576bool SimplifyCFGOpt::SimplifyResume(ResumeInst *RI, IRBuilder<> &Builder) {
2577 // If this is a trivial landing pad that just continues unwinding the caught
2578 // exception then zap the landing pad, turning its invokes into calls.
2579 BasicBlock *BB = RI->getParent();
2580 LandingPadInst *LPInst = dyn_cast<LandingPadInst>(BB->getFirstNonPHI());
2581 if (RI->getValue() != LPInst)
2582 // Not a landing pad, or the resume is not unwinding the exception that
2583 // caused control to branch here.
2584 return false;
2585
2586 // Check that there are no other instructions except for debug intrinsics.
2587 BasicBlock::iterator I = LPInst, E = RI;
2588 while (++I != E)
2589 if (!isa<DbgInfoIntrinsic>(I))
2590 return false;
2591
2592 // Turn all invokes that unwind here into calls and delete the basic block.
2593 for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE;) {
2594 InvokeInst *II = cast<InvokeInst>((*PI++)->getTerminator());
2595 SmallVector<Value*, 8> Args(II->op_begin(), II->op_end() - 3);
2596 // Insert a call instruction before the invoke.
2597 CallInst *Call = CallInst::Create(II->getCalledValue(), Args, "", II);
2598 Call->takeName(II);
2599 Call->setCallingConv(II->getCallingConv());
2600 Call->setAttributes(II->getAttributes());
2601 Call->setDebugLoc(II->getDebugLoc());
2602
2603 // Anything that used the value produced by the invoke instruction now uses
2604 // the value produced by the call instruction. Note that we do this even
2605 // for void functions and calls with no uses so that the callgraph edge is
2606 // updated.
2607 II->replaceAllUsesWith(Call);
2608 BB->removePredecessor(II->getParent());
2609
2610 // Insert a branch to the normal destination right before the invoke.
2611 BranchInst::Create(II->getNormalDest(), II);
2612
2613 // Finally, delete the invoke instruction!
2614 II->eraseFromParent();
2615 }
2616
2617 // The landingpad is now unreachable. Zap it.
2618 BB->eraseFromParent();
2619 return true;
2620}
2621
Devang Patel176ec402011-05-18 21:33:11 +00002622bool SimplifyCFGOpt::SimplifyReturn(ReturnInst *RI, IRBuilder<> &Builder) {
Chris Lattner3d512132010-12-13 06:25:44 +00002623 BasicBlock *BB = RI->getParent();
2624 if (!BB->getFirstNonPHIOrDbg()->isTerminator()) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002625
Chris Lattner3d512132010-12-13 06:25:44 +00002626 // Find predecessors that end with branches.
2627 SmallVector<BasicBlock*, 8> UncondBranchPreds;
2628 SmallVector<BranchInst*, 8> CondBranchPreds;
2629 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
2630 BasicBlock *P = *PI;
2631 TerminatorInst *PTI = P->getTerminator();
2632 if (BranchInst *BI = dyn_cast<BranchInst>(PTI)) {
2633 if (BI->isUnconditional())
2634 UncondBranchPreds.push_back(P);
2635 else
2636 CondBranchPreds.push_back(BI);
2637 }
2638 }
Andrew Trick6b014382012-08-29 21:46:36 +00002639
Chris Lattner3d512132010-12-13 06:25:44 +00002640 // If we found some, do the transformation!
Evan Chengc3f507f2011-01-29 04:46:23 +00002641 if (!UncondBranchPreds.empty() && DupRet) {
Chris Lattner3d512132010-12-13 06:25:44 +00002642 while (!UncondBranchPreds.empty()) {
2643 BasicBlock *Pred = UncondBranchPreds.pop_back_val();
2644 DEBUG(dbgs() << "FOLDING: " << *BB
2645 << "INTO UNCOND BRANCH PRED: " << *Pred);
Evan Chengc3f507f2011-01-29 04:46:23 +00002646 (void)FoldReturnIntoUncondBranch(RI, BB, Pred);
Chris Lattner3d512132010-12-13 06:25:44 +00002647 }
Andrew Trick6b014382012-08-29 21:46:36 +00002648
Chris Lattner3d512132010-12-13 06:25:44 +00002649 // If we eliminated all predecessors of the block, delete the block now.
2650 if (pred_begin(BB) == pred_end(BB))
2651 // We know there are no successors, so just nuke the block.
2652 BB->eraseFromParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002653
Chris Lattner3d512132010-12-13 06:25:44 +00002654 return true;
2655 }
Andrew Trick6b014382012-08-29 21:46:36 +00002656
Chris Lattner3d512132010-12-13 06:25:44 +00002657 // Check out all of the conditional branches going to this return
2658 // instruction. If any of them just select between returns, change the
2659 // branch itself into a select/return pair.
2660 while (!CondBranchPreds.empty()) {
2661 BranchInst *BI = CondBranchPreds.pop_back_val();
Andrew Trick6b014382012-08-29 21:46:36 +00002662
Chris Lattner3d512132010-12-13 06:25:44 +00002663 // Check to see if the non-BB successor is also a return block.
2664 if (isa<ReturnInst>(BI->getSuccessor(0)->getTerminator()) &&
2665 isa<ReturnInst>(BI->getSuccessor(1)->getTerminator()) &&
Devang Patel176ec402011-05-18 21:33:11 +00002666 SimplifyCondBranchToTwoReturns(BI, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00002667 return true;
2668 }
2669 return false;
2670}
2671
Chris Lattner3d512132010-12-13 06:25:44 +00002672bool SimplifyCFGOpt::SimplifyUnreachable(UnreachableInst *UI) {
2673 BasicBlock *BB = UI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002674
Chris Lattner3d512132010-12-13 06:25:44 +00002675 bool Changed = false;
Andrew Trick6b014382012-08-29 21:46:36 +00002676
Chris Lattner3d512132010-12-13 06:25:44 +00002677 // If there are any instructions immediately before the unreachable that can
2678 // be removed, do so.
2679 while (UI != BB->begin()) {
2680 BasicBlock::iterator BBI = UI;
2681 --BBI;
Eli Friedman81763882011-08-15 23:59:28 +00002682 // Do not delete instructions that can have side effects which might cause
2683 // the unreachable to not be reachable; specifically, calls and volatile
2684 // operations may have this effect.
Chris Lattner3d512132010-12-13 06:25:44 +00002685 if (isa<CallInst>(BBI) && !isa<DbgInfoIntrinsic>(BBI)) break;
Eli Friedman81763882011-08-15 23:59:28 +00002686
2687 if (BBI->mayHaveSideEffects()) {
2688 if (StoreInst *SI = dyn_cast<StoreInst>(BBI)) {
2689 if (SI->isVolatile())
2690 break;
2691 } else if (LoadInst *LI = dyn_cast<LoadInst>(BBI)) {
2692 if (LI->isVolatile())
2693 break;
2694 } else if (AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(BBI)) {
2695 if (RMWI->isVolatile())
2696 break;
2697 } else if (AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(BBI)) {
2698 if (CXI->isVolatile())
2699 break;
2700 } else if (!isa<FenceInst>(BBI) && !isa<VAArgInst>(BBI) &&
2701 !isa<LandingPadInst>(BBI)) {
Chris Lattner3d512132010-12-13 06:25:44 +00002702 break;
Eli Friedman81763882011-08-15 23:59:28 +00002703 }
Bill Wendling23b49ba2011-08-16 20:41:17 +00002704 // Note that deleting LandingPad's here is in fact okay, although it
2705 // involves a bit of subtle reasoning. If this inst is a LandingPad,
2706 // all the predecessors of this block will be the unwind edges of Invokes,
2707 // and we can therefore guarantee this block will be erased.
Eli Friedman81763882011-08-15 23:59:28 +00002708 }
2709
Eli Friedman2adc5b62011-03-09 00:48:33 +00002710 // Delete this instruction (any uses are guaranteed to be dead)
2711 if (!BBI->use_empty())
2712 BBI->replaceAllUsesWith(UndefValue::get(BBI->getType()));
Chris Lattner302ba6f2010-12-14 06:17:25 +00002713 BBI->eraseFromParent();
Chris Lattner3d512132010-12-13 06:25:44 +00002714 Changed = true;
2715 }
Andrew Trick6b014382012-08-29 21:46:36 +00002716
Chris Lattner3d512132010-12-13 06:25:44 +00002717 // If the unreachable instruction is the first in the block, take a gander
2718 // at all of the predecessors of this instruction, and simplify them.
2719 if (&BB->front() != UI) return Changed;
Andrew Trick6b014382012-08-29 21:46:36 +00002720
Chris Lattner3d512132010-12-13 06:25:44 +00002721 SmallVector<BasicBlock*, 8> Preds(pred_begin(BB), pred_end(BB));
2722 for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
2723 TerminatorInst *TI = Preds[i]->getTerminator();
Devang Patel1aa89a22011-05-19 00:09:21 +00002724 IRBuilder<> Builder(TI);
Chris Lattner3d512132010-12-13 06:25:44 +00002725 if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
2726 if (BI->isUnconditional()) {
2727 if (BI->getSuccessor(0) == BB) {
2728 new UnreachableInst(TI->getContext(), TI);
2729 TI->eraseFromParent();
2730 Changed = true;
2731 }
2732 } else {
2733 if (BI->getSuccessor(0) == BB) {
Devang Patel1aa89a22011-05-19 00:09:21 +00002734 Builder.CreateBr(BI->getSuccessor(1));
Chris Lattner3d512132010-12-13 06:25:44 +00002735 EraseTerminatorInstAndDCECond(BI);
2736 } else if (BI->getSuccessor(1) == BB) {
Devang Patel1aa89a22011-05-19 00:09:21 +00002737 Builder.CreateBr(BI->getSuccessor(0));
Chris Lattner3d512132010-12-13 06:25:44 +00002738 EraseTerminatorInstAndDCECond(BI);
2739 Changed = true;
2740 }
2741 }
2742 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002743 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002744 i != e; ++i)
2745 if (i.getCaseSuccessor() == BB) {
Chris Lattner3d512132010-12-13 06:25:44 +00002746 BB->removePredecessor(SI->getParent());
2747 SI->removeCase(i);
2748 --i; --e;
2749 Changed = true;
2750 }
2751 // If the default value is unreachable, figure out the most popular
2752 // destination and make it the default.
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00002753 if (SI->getDefaultDest() == BB) {
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00002754 std::map<BasicBlock*, std::pair<unsigned, unsigned> > Popularity;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002755 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002756 i != e; ++i) {
Nick Lewycky9d523102011-12-26 20:37:40 +00002757 std::pair<unsigned, unsigned> &entry =
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002758 Popularity[i.getCaseSuccessor()];
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00002759 if (entry.first == 0) {
2760 entry.first = 1;
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002761 entry.second = i.getCaseIndex();
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00002762 } else {
2763 entry.first++;
2764 }
2765 }
2766
Chris Lattner3d512132010-12-13 06:25:44 +00002767 // Find the most popular block.
2768 unsigned MaxPop = 0;
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00002769 unsigned MaxIndex = 0;
Chris Lattner3d512132010-12-13 06:25:44 +00002770 BasicBlock *MaxBlock = 0;
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00002771 for (std::map<BasicBlock*, std::pair<unsigned, unsigned> >::iterator
Chris Lattner3d512132010-12-13 06:25:44 +00002772 I = Popularity.begin(), E = Popularity.end(); I != E; ++I) {
Andrew Trick6b014382012-08-29 21:46:36 +00002773 if (I->second.first > MaxPop ||
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00002774 (I->second.first == MaxPop && MaxIndex > I->second.second)) {
2775 MaxPop = I->second.first;
2776 MaxIndex = I->second.second;
Chris Lattner3d512132010-12-13 06:25:44 +00002777 MaxBlock = I->first;
2778 }
2779 }
2780 if (MaxBlock) {
2781 // Make this the new default, allowing us to delete any explicit
2782 // edges to it.
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00002783 SI->setDefaultDest(MaxBlock);
Chris Lattner3d512132010-12-13 06:25:44 +00002784 Changed = true;
Andrew Trick6b014382012-08-29 21:46:36 +00002785
Chris Lattner3d512132010-12-13 06:25:44 +00002786 // If MaxBlock has phinodes in it, remove MaxPop-1 entries from
2787 // it.
2788 if (isa<PHINode>(MaxBlock->begin()))
2789 for (unsigned i = 0; i != MaxPop-1; ++i)
2790 MaxBlock->removePredecessor(SI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00002791
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002792 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002793 i != e; ++i)
2794 if (i.getCaseSuccessor() == MaxBlock) {
Chris Lattner3d512132010-12-13 06:25:44 +00002795 SI->removeCase(i);
2796 --i; --e;
2797 }
2798 }
2799 }
2800 } else if (InvokeInst *II = dyn_cast<InvokeInst>(TI)) {
2801 if (II->getUnwindDest() == BB) {
2802 // Convert the invoke to a call instruction. This would be a good
2803 // place to note that the call does not throw though.
Devang Patel1aa89a22011-05-19 00:09:21 +00002804 BranchInst *BI = Builder.CreateBr(II->getNormalDest());
Chris Lattner3d512132010-12-13 06:25:44 +00002805 II->removeFromParent(); // Take out of symbol table
Andrew Trick6b014382012-08-29 21:46:36 +00002806
Chris Lattner3d512132010-12-13 06:25:44 +00002807 // Insert the call now...
2808 SmallVector<Value*, 8> Args(II->op_begin(), II->op_end()-3);
Devang Patel1aa89a22011-05-19 00:09:21 +00002809 Builder.SetInsertPoint(BI);
2810 CallInst *CI = Builder.CreateCall(II->getCalledValue(),
Jay Foada3efbb12011-07-15 08:37:34 +00002811 Args, II->getName());
Chris Lattner3d512132010-12-13 06:25:44 +00002812 CI->setCallingConv(II->getCallingConv());
2813 CI->setAttributes(II->getAttributes());
2814 // If the invoke produced a value, the call does now instead.
2815 II->replaceAllUsesWith(CI);
2816 delete II;
2817 Changed = true;
2818 }
2819 }
2820 }
Andrew Trick6b014382012-08-29 21:46:36 +00002821
Chris Lattner3d512132010-12-13 06:25:44 +00002822 // If this block is now dead, remove it.
2823 if (pred_begin(BB) == pred_end(BB) &&
2824 BB != &BB->getParent()->getEntryBlock()) {
2825 // We know there are no successors, so just nuke the block.
2826 BB->eraseFromParent();
2827 return true;
2828 }
2829
2830 return Changed;
2831}
2832
Benjamin Kramer56442df2011-02-02 15:56:22 +00002833/// TurnSwitchRangeIntoICmp - Turns a switch with that contains only a
2834/// integer range comparison into a sub, an icmp and a branch.
Devang Patel007349d2011-05-18 20:35:38 +00002835static bool TurnSwitchRangeIntoICmp(SwitchInst *SI, IRBuilder<> &Builder) {
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00002836 assert(SI->getNumCases() > 1 && "Degenerate switch?");
Benjamin Kramer56442df2011-02-02 15:56:22 +00002837
Benjamin Kramer042b27f2011-02-03 22:51:41 +00002838 // Make sure all cases point to the same destination and gather the values.
2839 SmallVector<ConstantInt *, 16> Cases;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002840 SwitchInst::CaseIt I = SI->case_begin();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002841 Cases.push_back(I.getCaseValue());
2842 SwitchInst::CaseIt PrevI = I++;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002843 for (SwitchInst::CaseIt E = SI->case_end(); I != E; PrevI = I++) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002844 if (PrevI.getCaseSuccessor() != I.getCaseSuccessor())
Benjamin Kramer042b27f2011-02-03 22:51:41 +00002845 return false;
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002846 Cases.push_back(I.getCaseValue());
Benjamin Kramer042b27f2011-02-03 22:51:41 +00002847 }
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00002848 assert(Cases.size() == SI->getNumCases() && "Not all cases gathered");
Benjamin Kramer042b27f2011-02-03 22:51:41 +00002849
2850 // Sort the case values, then check if they form a range we can transform.
2851 array_pod_sort(Cases.begin(), Cases.end(), ConstantIntSortPredicate);
2852 for (unsigned I = 1, E = Cases.size(); I != E; ++I) {
2853 if (Cases[I-1]->getValue() != Cases[I]->getValue()+1)
2854 return false;
2855 }
2856
2857 Constant *Offset = ConstantExpr::getNeg(Cases.back());
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00002858 Constant *NumCases = ConstantInt::get(Offset->getType(), SI->getNumCases());
Benjamin Kramer56442df2011-02-02 15:56:22 +00002859
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002860 Value *Sub = SI->getCondition();
2861 if (!Offset->isNullValue())
Devang Patel1f5812b2011-05-19 00:13:33 +00002862 Sub = Builder.CreateAdd(Sub, Offset, Sub->getName()+".off");
2863 Value *Cmp = Builder.CreateICmpULT(Sub, NumCases, "switch");
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002864 Builder.CreateCondBr(
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002865 Cmp, SI->case_begin().getCaseSuccessor(), SI->getDefaultDest());
Benjamin Kramer56442df2011-02-02 15:56:22 +00002866
2867 // Prune obsolete incoming values off the successor's PHI nodes.
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002868 for (BasicBlock::iterator BBI = SI->case_begin().getCaseSuccessor()->begin();
Benjamin Kramer56442df2011-02-02 15:56:22 +00002869 isa<PHINode>(BBI); ++BBI) {
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00002870 for (unsigned I = 0, E = SI->getNumCases()-1; I != E; ++I)
Benjamin Kramer56442df2011-02-02 15:56:22 +00002871 cast<PHINode>(BBI)->removeIncomingValue(SI->getParent());
2872 }
2873 SI->eraseFromParent();
2874
2875 return true;
2876}
Chris Lattner3d512132010-12-13 06:25:44 +00002877
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00002878/// EliminateDeadSwitchCases - Compute masked bits for the condition of a switch
2879/// and use it to remove dead cases.
2880static bool EliminateDeadSwitchCases(SwitchInst *SI) {
2881 Value *Cond = SI->getCondition();
2882 unsigned Bits = cast<IntegerType>(Cond->getType())->getBitWidth();
2883 APInt KnownZero(Bits, 0), KnownOne(Bits, 0);
Rafael Espindola26c8dcc2012-04-04 12:51:34 +00002884 ComputeMaskedBits(Cond, KnownZero, KnownOne);
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00002885
2886 // Gather dead cases.
2887 SmallVector<ConstantInt*, 8> DeadCases;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002888 for (SwitchInst::CaseIt I = SI->case_begin(), E = SI->case_end(); I != E; ++I) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002889 if ((I.getCaseValue()->getValue() & KnownZero) != 0 ||
2890 (I.getCaseValue()->getValue() & KnownOne) != KnownOne) {
2891 DeadCases.push_back(I.getCaseValue());
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00002892 DEBUG(dbgs() << "SimplifyCFG: switch case '"
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002893 << I.getCaseValue() << "' is dead.\n");
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00002894 }
2895 }
2896
2897 // Remove dead cases from the switch.
2898 for (unsigned I = 0, E = DeadCases.size(); I != E; ++I) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002899 SwitchInst::CaseIt Case = SI->findCaseValue(DeadCases[I]);
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002900 assert(Case != SI->case_default() &&
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00002901 "Case was not found. Probably mistake in DeadCases forming.");
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00002902 // Prune unused values from PHI nodes.
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002903 Case.getCaseSuccessor()->removePredecessor(SI->getParent());
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00002904 SI->removeCase(Case);
2905 }
2906
2907 return !DeadCases.empty();
2908}
2909
Hans Wennborg448da512011-06-18 10:28:47 +00002910/// FindPHIForConditionForwarding - If BB would be eligible for simplification
2911/// by TryToSimplifyUncondBranchFromEmptyBlock (i.e. it is empty and terminated
2912/// by an unconditional branch), look at the phi node for BB in the successor
2913/// block and see if the incoming value is equal to CaseValue. If so, return
2914/// the phi node, and set PhiIndex to BB's index in the phi node.
2915static PHINode *FindPHIForConditionForwarding(ConstantInt *CaseValue,
2916 BasicBlock *BB,
2917 int *PhiIndex) {
2918 if (BB->getFirstNonPHIOrDbg() != BB->getTerminator())
2919 return NULL; // BB must be empty to be a candidate for simplification.
2920 if (!BB->getSinglePredecessor())
2921 return NULL; // BB must be dominated by the switch.
2922
2923 BranchInst *Branch = dyn_cast<BranchInst>(BB->getTerminator());
2924 if (!Branch || !Branch->isUnconditional())
2925 return NULL; // Terminator must be unconditional branch.
2926
2927 BasicBlock *Succ = Branch->getSuccessor(0);
2928
2929 BasicBlock::iterator I = Succ->begin();
2930 while (PHINode *PHI = dyn_cast<PHINode>(I++)) {
2931 int Idx = PHI->getBasicBlockIndex(BB);
2932 assert(Idx >= 0 && "PHI has no entry for predecessor?");
2933
2934 Value *InValue = PHI->getIncomingValue(Idx);
2935 if (InValue != CaseValue) continue;
2936
2937 *PhiIndex = Idx;
2938 return PHI;
2939 }
2940
2941 return NULL;
2942}
2943
2944/// ForwardSwitchConditionToPHI - Try to forward the condition of a switch
2945/// instruction to a phi node dominated by the switch, if that would mean that
2946/// some of the destination blocks of the switch can be folded away.
2947/// Returns true if a change is made.
2948static bool ForwardSwitchConditionToPHI(SwitchInst *SI) {
2949 typedef DenseMap<PHINode*, SmallVector<int,4> > ForwardingNodesMap;
2950 ForwardingNodesMap ForwardingNodes;
2951
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002952 for (SwitchInst::CaseIt I = SI->case_begin(), E = SI->case_end(); I != E; ++I) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002953 ConstantInt *CaseValue = I.getCaseValue();
2954 BasicBlock *CaseDest = I.getCaseSuccessor();
Hans Wennborg448da512011-06-18 10:28:47 +00002955
2956 int PhiIndex;
2957 PHINode *PHI = FindPHIForConditionForwarding(CaseValue, CaseDest,
2958 &PhiIndex);
2959 if (!PHI) continue;
2960
2961 ForwardingNodes[PHI].push_back(PhiIndex);
2962 }
2963
2964 bool Changed = false;
2965
2966 for (ForwardingNodesMap::iterator I = ForwardingNodes.begin(),
2967 E = ForwardingNodes.end(); I != E; ++I) {
2968 PHINode *Phi = I->first;
2969 SmallVector<int,4> &Indexes = I->second;
2970
2971 if (Indexes.size() < 2) continue;
2972
2973 for (size_t I = 0, E = Indexes.size(); I != E; ++I)
2974 Phi->setIncomingValue(Indexes[I], SI->getCondition());
2975 Changed = true;
2976 }
2977
2978 return Changed;
2979}
2980
Hans Wennborg486270a2012-09-06 09:43:28 +00002981/// ValidLookupTableConstant - Return true if the backend will be able to handle
2982/// initializing an array of constants like C.
Hans Wennborgbf015822012-09-07 08:22:57 +00002983static bool ValidLookupTableConstant(Constant *C) {
Hans Wennborg486270a2012-09-06 09:43:28 +00002984 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
2985 return CE->isGEPWithNoNotionalOverIndexing();
2986
2987 return isa<ConstantFP>(C) ||
2988 isa<ConstantInt>(C) ||
2989 isa<ConstantPointerNull>(C) ||
2990 isa<GlobalValue>(C) ||
2991 isa<UndefValue>(C);
2992}
2993
2994/// GetCaseResulsts - Try to determine the resulting constant values in phi
2995/// nodes at the common destination basic block for one of the case
2996/// destinations of a switch instruction.
2997static bool GetCaseResults(SwitchInst *SI,
2998 BasicBlock *CaseDest,
2999 BasicBlock **CommonDest,
3000 SmallVector<std::pair<PHINode*,Constant*>, 4> &Res) {
3001 // The block from which we enter the common destination.
3002 BasicBlock *Pred = SI->getParent();
3003
3004 // If CaseDest is empty, continue to its successor.
3005 if (CaseDest->getFirstNonPHIOrDbg() == CaseDest->getTerminator() &&
3006 !isa<PHINode>(CaseDest->begin())) {
3007
3008 TerminatorInst *Terminator = CaseDest->getTerminator();
3009 if (Terminator->getNumSuccessors() != 1)
3010 return false;
3011
3012 Pred = CaseDest;
3013 CaseDest = Terminator->getSuccessor(0);
3014 }
3015
3016 // If we did not have a CommonDest before, use the current one.
3017 if (!*CommonDest)
3018 *CommonDest = CaseDest;
3019 // If the destination isn't the common one, abort.
3020 if (CaseDest != *CommonDest)
3021 return false;
3022
3023 // Get the values for this case from phi nodes in the destination block.
3024 BasicBlock::iterator I = (*CommonDest)->begin();
3025 while (PHINode *PHI = dyn_cast<PHINode>(I++)) {
3026 int Idx = PHI->getBasicBlockIndex(Pred);
3027 if (Idx == -1)
3028 continue;
3029
3030 Constant *ConstVal = dyn_cast<Constant>(PHI->getIncomingValue(Idx));
3031 if (!ConstVal)
3032 return false;
3033
3034 // Be conservative about which kinds of constants we support.
3035 if (!ValidLookupTableConstant(ConstVal))
3036 return false;
3037
3038 Res.push_back(std::make_pair(PHI, ConstVal));
3039 }
3040
3041 return true;
3042}
3043
3044/// BuildLookupTable - Build a lookup table with the contents of Results, using
3045/// DefaultResult to fill the holes in the table. If the table ends up
3046/// containing the same result in each element, set *SingleResult to that value
3047/// and return NULL.
3048static GlobalVariable *BuildLookupTable(
3049 Module &M,
3050 uint64_t TableSize,
3051 ConstantInt *Offset,
3052 const std::vector<std::pair<ConstantInt*,Constant*> >& Results,
3053 Constant *DefaultResult,
3054 Constant **SingleResult) {
3055 assert(Results.size() && "Need values to build lookup table");
3056 assert(TableSize >= Results.size() && "Table needs to hold all values");
3057
3058 // If all values in the table are equal, this is that value.
3059 Constant *SameResult = Results.begin()->second;
3060
3061 // Build up the table contents.
3062 std::vector<Constant*> TableContents(TableSize);
3063 for (size_t I = 0, E = Results.size(); I != E; ++I) {
3064 ConstantInt *CaseVal = Results[I].first;
3065 Constant *CaseRes = Results[I].second;
3066
3067 uint64_t Idx = (CaseVal->getValue() - Offset->getValue()).getLimitedValue();
3068 TableContents[Idx] = CaseRes;
3069
3070 if (CaseRes != SameResult)
3071 SameResult = NULL;
3072 }
3073
3074 // Fill in any holes in the table with the default result.
3075 if (Results.size() < TableSize) {
3076 for (unsigned i = 0; i < TableSize; ++i) {
3077 if (!TableContents[i])
3078 TableContents[i] = DefaultResult;
3079 }
3080
3081 if (DefaultResult != SameResult)
3082 SameResult = NULL;
3083 }
3084
3085 // Same result was used in the entire table; just return that.
3086 if (SameResult) {
3087 *SingleResult = SameResult;
3088 return NULL;
3089 }
3090
3091 ArrayType *ArrayTy = ArrayType::get(DefaultResult->getType(), TableSize);
3092 Constant *Initializer = ConstantArray::get(ArrayTy, TableContents);
3093
3094 GlobalVariable *GV = new GlobalVariable(M, ArrayTy, /*constant=*/ true,
3095 GlobalVariable::PrivateLinkage,
3096 Initializer,
3097 "switch.table");
3098 GV->setUnnamedAddr(true);
3099 return GV;
3100}
3101
3102/// SwitchToLookupTable - If the switch is only used to initialize one or more
3103/// phi nodes in a common successor block with different constant values,
3104/// replace the switch with lookup tables.
3105static bool SwitchToLookupTable(SwitchInst *SI,
3106 IRBuilder<> &Builder) {
3107 assert(SI->getNumCases() > 1 && "Degenerate switch?");
3108 // FIXME: Handle unreachable cases.
3109
3110 // FIXME: If the switch is too sparse for a lookup table, perhaps we could
3111 // split off a dense part and build a lookup table for that.
3112
3113 // FIXME: If the results are all integers and the lookup table would fit in a
3114 // target-legal register, we should store them as a bitmap and use shift/mask
3115 // to look up the result.
3116
3117 // FIXME: This creates arrays of GEPs to constant strings, which means each
3118 // GEP needs a runtime relocation in PIC code. We should just build one big
3119 // string and lookup indices into that.
3120
3121 // Ignore the switch if the number of cases are too small.
3122 // This is similar to the check when building jump tables in
3123 // SelectionDAGBuilder::handleJTSwitchCase.
3124 // FIXME: Determine the best cut-off.
3125 if (SI->getNumCases() < 4)
3126 return false;
3127
3128 // Figure out the corresponding result for each case value and phi node in the
3129 // common destination, as well as the the min and max case values.
3130 assert(SI->case_begin() != SI->case_end());
3131 SwitchInst::CaseIt CI = SI->case_begin();
3132 ConstantInt *MinCaseVal = CI.getCaseValue();
3133 ConstantInt *MaxCaseVal = CI.getCaseValue();
3134
3135 BasicBlock *CommonDest = NULL;
3136 typedef std::vector<std::pair<ConstantInt*, Constant*> > ResultListTy;
3137 SmallDenseMap<PHINode*, ResultListTy> ResultLists;
3138 SmallDenseMap<PHINode*, Constant*> DefaultResults;
3139 SmallDenseMap<PHINode*, Type*> ResultTypes;
3140 SmallVector<PHINode*, 4> PHIs;
3141
3142 for (SwitchInst::CaseIt E = SI->case_end(); CI != E; ++CI) {
3143 ConstantInt *CaseVal = CI.getCaseValue();
3144 if (CaseVal->getValue().slt(MinCaseVal->getValue()))
3145 MinCaseVal = CaseVal;
3146 if (CaseVal->getValue().sgt(MaxCaseVal->getValue()))
3147 MaxCaseVal = CaseVal;
3148
3149 // Resulting value at phi nodes for this case value.
3150 typedef SmallVector<std::pair<PHINode*, Constant*>, 4> ResultsTy;
3151 ResultsTy Results;
3152 if (!GetCaseResults(SI, CI.getCaseSuccessor(), &CommonDest, Results))
3153 return false;
3154
3155 // Append the result from this case to the list for each phi.
3156 for (ResultsTy::iterator I = Results.begin(), E = Results.end(); I!=E; ++I) {
3157 if (!ResultLists.count(I->first))
3158 PHIs.push_back(I->first);
3159 ResultLists[I->first].push_back(std::make_pair(CaseVal, I->second));
3160 }
3161 }
3162
3163 // Get the resulting values for the default case.
3164 {
3165 SmallVector<std::pair<PHINode*, Constant*>, 4> DefaultResultsList;
3166 if (!GetCaseResults(SI, SI->getDefaultDest(), &CommonDest, DefaultResultsList))
3167 return false;
3168 for (size_t I = 0, E = DefaultResultsList.size(); I != E; ++I) {
3169 PHINode *PHI = DefaultResultsList[I].first;
3170 Constant *Result = DefaultResultsList[I].second;
3171 DefaultResults[PHI] = Result;
3172 ResultTypes[PHI] = Result->getType();
3173 }
3174 }
3175
3176 APInt RangeSpread = MaxCaseVal->getValue() - MinCaseVal->getValue();
3177 // The table density should be at lest 40%. This is the same criterion as for
3178 // jump tables, see SelectionDAGBuilder::handleJTSwitchCase.
3179 // FIXME: Find the best cut-off.
3180 // Be careful to avoid overlow in the density computation.
3181 if (RangeSpread.zextOrSelf(64).ugt(UINT64_MAX / 4 - 1))
3182 return false;
3183 uint64_t TableSize = RangeSpread.getLimitedValue() + 1;
3184 if (SI->getNumCases() * 10 < TableSize * 4)
3185 return false;
3186
3187 // Build the lookup tables.
3188 SmallDenseMap<PHINode*, GlobalVariable*> LookupTables;
3189 SmallDenseMap<PHINode*, Constant*> SingleResults;
3190
3191 Module &Mod = *CommonDest->getParent()->getParent();
Hans Wennborg3bd51b82012-09-06 10:10:35 +00003192 for (SmallVector<PHINode*, 4>::iterator I = PHIs.begin(), E = PHIs.end();
3193 I != E; ++I) {
3194 PHINode *PHI = *I;
Hans Wennborg486270a2012-09-06 09:43:28 +00003195
3196 Constant *SingleResult = NULL;
Hans Wennborg3bd51b82012-09-06 10:10:35 +00003197 LookupTables[PHI] = BuildLookupTable(Mod, TableSize, MinCaseVal,
3198 ResultLists[PHI], DefaultResults[PHI],
3199 &SingleResult);
Hans Wennborg486270a2012-09-06 09:43:28 +00003200 SingleResults[PHI] = SingleResult;
3201 }
3202
3203 // Create the BB that does the lookups.
3204 BasicBlock *LookupBB = BasicBlock::Create(Mod.getContext(),
3205 "switch.lookup",
3206 CommonDest->getParent(),
3207 CommonDest);
3208
3209 // Check whether the condition value is within the case range, and branch to
3210 // the new BB.
3211 Builder.SetInsertPoint(SI);
3212 Value *TableIndex = Builder.CreateSub(SI->getCondition(), MinCaseVal,
3213 "switch.tableidx");
3214 Value *Cmp = Builder.CreateICmpULT(TableIndex, ConstantInt::get(
3215 MinCaseVal->getType(), TableSize));
3216 Builder.CreateCondBr(Cmp, LookupBB, SI->getDefaultDest());
3217
3218 // Populate the BB that does the lookups.
3219 Builder.SetInsertPoint(LookupBB);
3220 bool ReturnedEarly = false;
3221 for (SmallVector<PHINode*, 4>::iterator I = PHIs.begin(), E = PHIs.end();
3222 I != E; ++I) {
3223 PHINode *PHI = *I;
3224 // There was a single result for this phi; just use that.
3225 if (Constant *SingleResult = SingleResults[PHI]) {
3226 PHI->addIncoming(SingleResult, LookupBB);
3227 continue;
3228 }
3229
3230 Value *GEPIndices[] = { Builder.getInt32(0), TableIndex };
3231 Value *GEP = Builder.CreateInBoundsGEP(LookupTables[PHI], GEPIndices,
3232 "switch.gep");
3233 Value *Result = Builder.CreateLoad(GEP, "switch.load");
3234
3235 // If the result is only going to be used to return from the function,
3236 // we want to do that right here.
3237 if (PHI->hasOneUse() && isa<ReturnInst>(*PHI->use_begin())) {
3238 if (CommonDest->getFirstNonPHIOrDbg() == CommonDest->getTerminator()) {
3239 Builder.CreateRet(Result);
3240 ReturnedEarly = true;
3241 }
3242 }
3243
3244 if (!ReturnedEarly)
3245 PHI->addIncoming(Result, LookupBB);
3246 }
3247
3248 if (!ReturnedEarly)
3249 Builder.CreateBr(CommonDest);
3250
3251 // Remove the switch.
3252 for (unsigned i = 0; i < SI->getNumSuccessors(); ++i) {
3253 BasicBlock *Succ = SI->getSuccessor(i);
3254 if (Succ == SI->getDefaultDest()) continue;
3255 Succ->removePredecessor(SI->getParent());
3256 }
3257 SI->eraseFromParent();
3258
3259 ++NumLookupTables;
3260 return true;
3261}
3262
Devang Patel007349d2011-05-18 20:35:38 +00003263bool SimplifyCFGOpt::SimplifySwitch(SwitchInst *SI, IRBuilder<> &Builder) {
Chris Lattner3d512132010-12-13 06:25:44 +00003264 // If this switch is too complex to want to look at, ignore it.
3265 if (!isValueEqualityComparison(SI))
3266 return false;
3267
3268 BasicBlock *BB = SI->getParent();
3269
3270 // If we only have one predecessor, and if it is a branch on this value,
3271 // see if that predecessor totally determines the outcome of this switch.
3272 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
Devang Patel007349d2011-05-18 20:35:38 +00003273 if (SimplifyEqualityComparisonWithOnlyPredecessor(SI, OnlyPred, Builder))
Chris Lattner021c9d32010-12-13 06:36:51 +00003274 return SimplifyCFG(BB) | true;
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00003275
3276 Value *Cond = SI->getCondition();
3277 if (SelectInst *Select = dyn_cast<SelectInst>(Cond))
3278 if (SimplifySwitchOnSelect(SI, Select))
3279 return SimplifyCFG(BB) | true;
3280
Chris Lattner3d512132010-12-13 06:25:44 +00003281 // If the block only contains the switch, see if we can fold the block
3282 // away into any preds.
3283 BasicBlock::iterator BBI = BB->begin();
3284 // Ignore dbg intrinsics.
3285 while (isa<DbgInfoIntrinsic>(BBI))
3286 ++BBI;
3287 if (SI == &*BBI)
Devang Patelb55d9242011-05-18 20:53:17 +00003288 if (FoldValueComparisonIntoPredecessors(SI, Builder))
Chris Lattner021c9d32010-12-13 06:36:51 +00003289 return SimplifyCFG(BB) | true;
Benjamin Kramer56442df2011-02-02 15:56:22 +00003290
3291 // Try to transform the switch into an icmp and a branch.
Devang Patel007349d2011-05-18 20:35:38 +00003292 if (TurnSwitchRangeIntoICmp(SI, Builder))
Benjamin Kramer56442df2011-02-02 15:56:22 +00003293 return SimplifyCFG(BB) | true;
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003294
3295 // Remove unreachable cases.
3296 if (EliminateDeadSwitchCases(SI))
3297 return SimplifyCFG(BB) | true;
3298
Hans Wennborg448da512011-06-18 10:28:47 +00003299 if (ForwardSwitchConditionToPHI(SI))
3300 return SimplifyCFG(BB) | true;
3301
Hans Wennborg486270a2012-09-06 09:43:28 +00003302 if (SwitchToLookupTable(SI, Builder))
3303 return SimplifyCFG(BB) | true;
3304
Chris Lattner3d512132010-12-13 06:25:44 +00003305 return false;
3306}
3307
3308bool SimplifyCFGOpt::SimplifyIndirectBr(IndirectBrInst *IBI) {
3309 BasicBlock *BB = IBI->getParent();
3310 bool Changed = false;
Andrew Trick6b014382012-08-29 21:46:36 +00003311
Chris Lattner3d512132010-12-13 06:25:44 +00003312 // Eliminate redundant destinations.
3313 SmallPtrSet<Value *, 8> Succs;
3314 for (unsigned i = 0, e = IBI->getNumDestinations(); i != e; ++i) {
3315 BasicBlock *Dest = IBI->getDestination(i);
3316 if (!Dest->hasAddressTaken() || !Succs.insert(Dest)) {
3317 Dest->removePredecessor(BB);
3318 IBI->removeDestination(i);
3319 --i; --e;
3320 Changed = true;
3321 }
Andrew Trick6b014382012-08-29 21:46:36 +00003322 }
Chris Lattner3d512132010-12-13 06:25:44 +00003323
3324 if (IBI->getNumDestinations() == 0) {
3325 // If the indirectbr has no successors, change it to unreachable.
3326 new UnreachableInst(IBI->getContext(), IBI);
3327 EraseTerminatorInstAndDCECond(IBI);
3328 return true;
3329 }
Andrew Trick6b014382012-08-29 21:46:36 +00003330
Chris Lattner3d512132010-12-13 06:25:44 +00003331 if (IBI->getNumDestinations() == 1) {
3332 // If the indirectbr has one successor, change it to a direct branch.
3333 BranchInst::Create(IBI->getDestination(0), IBI);
3334 EraseTerminatorInstAndDCECond(IBI);
3335 return true;
3336 }
Andrew Trick6b014382012-08-29 21:46:36 +00003337
Chris Lattner3d512132010-12-13 06:25:44 +00003338 if (SelectInst *SI = dyn_cast<SelectInst>(IBI->getAddress())) {
3339 if (SimplifyIndirectBrOnSelect(IBI, SI))
3340 return SimplifyCFG(BB) | true;
3341 }
3342 return Changed;
3343}
3344
Devang Patela23812c2011-05-18 18:28:48 +00003345bool SimplifyCFGOpt::SimplifyUncondBranch(BranchInst *BI, IRBuilder<> &Builder){
Chris Lattner3d512132010-12-13 06:25:44 +00003346 BasicBlock *BB = BI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00003347
Chris Lattner3d512132010-12-13 06:25:44 +00003348 // If the Terminator is the only non-phi instruction, simplify the block.
Rafael Espindola77a2c372011-06-30 20:14:24 +00003349 BasicBlock::iterator I = BB->getFirstNonPHIOrDbgOrLifetime();
Chris Lattner3d512132010-12-13 06:25:44 +00003350 if (I->isTerminator() && BB != &BB->getParent()->getEntryBlock() &&
3351 TryToSimplifyUncondBranchFromEmptyBlock(BB))
3352 return true;
Andrew Trick6b014382012-08-29 21:46:36 +00003353
Chris Lattner3d512132010-12-13 06:25:44 +00003354 // If the only instruction in the block is a seteq/setne comparison
3355 // against a constant, try to simplify the block.
3356 if (ICmpInst *ICI = dyn_cast<ICmpInst>(I))
3357 if (ICI->isEquality() && isa<ConstantInt>(ICI->getOperand(1))) {
3358 for (++I; isa<DbgInfoIntrinsic>(I); ++I)
3359 ;
Nick Lewycky9d523102011-12-26 20:37:40 +00003360 if (I->isTerminator() &&
3361 TryToSimplifyUncondBranchWithICmpInIt(ICI, TD, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00003362 return true;
3363 }
Andrew Trick6b014382012-08-29 21:46:36 +00003364
Manman Renee28e0f2012-06-13 05:43:29 +00003365 // If this basic block is ONLY a compare and a branch, and if a predecessor
3366 // branches to us and our successor, fold the comparison into the
3367 // predecessor and use logical operations to update the incoming value
3368 // for PHI nodes in common successor.
3369 if (FoldBranchToCommonDest(BI))
3370 return SimplifyCFG(BB) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003371 return false;
3372}
3373
3374
Devang Patel007349d2011-05-18 20:35:38 +00003375bool SimplifyCFGOpt::SimplifyCondBranch(BranchInst *BI, IRBuilder<> &Builder) {
Chris Lattner3d512132010-12-13 06:25:44 +00003376 BasicBlock *BB = BI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00003377
Chris Lattner3d512132010-12-13 06:25:44 +00003378 // Conditional branch
3379 if (isValueEqualityComparison(BI)) {
3380 // If we only have one predecessor, and if it is a branch on this value,
3381 // see if that predecessor totally determines the outcome of this
3382 // switch.
3383 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
Devang Patel007349d2011-05-18 20:35:38 +00003384 if (SimplifyEqualityComparisonWithOnlyPredecessor(BI, OnlyPred, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00003385 return SimplifyCFG(BB) | true;
Andrew Trick6b014382012-08-29 21:46:36 +00003386
Chris Lattner3d512132010-12-13 06:25:44 +00003387 // This block must be empty, except for the setcond inst, if it exists.
3388 // Ignore dbg intrinsics.
3389 BasicBlock::iterator I = BB->begin();
3390 // Ignore dbg intrinsics.
3391 while (isa<DbgInfoIntrinsic>(I))
3392 ++I;
3393 if (&*I == BI) {
Devang Patelb55d9242011-05-18 20:53:17 +00003394 if (FoldValueComparisonIntoPredecessors(BI, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00003395 return SimplifyCFG(BB) | true;
3396 } else if (&*I == cast<Instruction>(BI->getCondition())){
3397 ++I;
3398 // Ignore dbg intrinsics.
3399 while (isa<DbgInfoIntrinsic>(I))
3400 ++I;
Devang Patelb55d9242011-05-18 20:53:17 +00003401 if (&*I == BI && FoldValueComparisonIntoPredecessors(BI, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00003402 return SimplifyCFG(BB) | true;
3403 }
3404 }
Andrew Trick6b014382012-08-29 21:46:36 +00003405
Chris Lattner3d512132010-12-13 06:25:44 +00003406 // Try to turn "br (X == 0 | X == 1), T, F" into a switch instruction.
Devang Patel02dd5412011-05-18 23:18:47 +00003407 if (SimplifyBranchOnICmpChain(BI, TD, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00003408 return true;
Andrew Trick6b014382012-08-29 21:46:36 +00003409
Dan Gohman3b205172012-01-05 23:58:56 +00003410 // If this basic block is ONLY a compare and a branch, and if a predecessor
3411 // branches to us and one of our successors, fold the comparison into the
3412 // predecessor and use logical operations to pick the right destination.
3413 if (FoldBranchToCommonDest(BI))
3414 return SimplifyCFG(BB) | true;
Andrew Trick6b014382012-08-29 21:46:36 +00003415
Chris Lattner3d512132010-12-13 06:25:44 +00003416 // We have a conditional branch to two blocks that are only reachable
3417 // from BI. We know that the condbr dominates the two blocks, so see if
3418 // there is any identical code in the "then" and "else" blocks. If so, we
3419 // can hoist it up to the branching block.
3420 if (BI->getSuccessor(0)->getSinglePredecessor() != 0) {
3421 if (BI->getSuccessor(1)->getSinglePredecessor() != 0) {
Rafael Espindola216dde92011-05-19 02:26:30 +00003422 if (HoistThenElseCodeToIf(BI))
Chris Lattner3d512132010-12-13 06:25:44 +00003423 return SimplifyCFG(BB) | true;
3424 } else {
3425 // If Successor #1 has multiple preds, we may be able to conditionally
3426 // execute Successor #0 if it branches to successor #1.
3427 TerminatorInst *Succ0TI = BI->getSuccessor(0)->getTerminator();
3428 if (Succ0TI->getNumSuccessors() == 1 &&
3429 Succ0TI->getSuccessor(0) == BI->getSuccessor(1))
Rafael Espindola216dde92011-05-19 02:26:30 +00003430 if (SpeculativelyExecuteBB(BI, BI->getSuccessor(0)))
Chris Lattner3d512132010-12-13 06:25:44 +00003431 return SimplifyCFG(BB) | true;
3432 }
3433 } else if (BI->getSuccessor(1)->getSinglePredecessor() != 0) {
3434 // If Successor #0 has multiple preds, we may be able to conditionally
3435 // execute Successor #1 if it branches to successor #0.
3436 TerminatorInst *Succ1TI = BI->getSuccessor(1)->getTerminator();
3437 if (Succ1TI->getNumSuccessors() == 1 &&
3438 Succ1TI->getSuccessor(0) == BI->getSuccessor(0))
Rafael Espindola216dde92011-05-19 02:26:30 +00003439 if (SpeculativelyExecuteBB(BI, BI->getSuccessor(1)))
Chris Lattner3d512132010-12-13 06:25:44 +00003440 return SimplifyCFG(BB) | true;
3441 }
Andrew Trick6b014382012-08-29 21:46:36 +00003442
Chris Lattner3d512132010-12-13 06:25:44 +00003443 // If this is a branch on a phi node in the current block, thread control
3444 // through this block if any PHI node entries are constants.
3445 if (PHINode *PN = dyn_cast<PHINode>(BI->getCondition()))
3446 if (PN->getParent() == BI->getParent())
Chris Lattner302ba6f2010-12-14 06:17:25 +00003447 if (FoldCondBranchOnPHI(BI, TD))
Chris Lattner3d512132010-12-13 06:25:44 +00003448 return SimplifyCFG(BB) | true;
Andrew Trick6b014382012-08-29 21:46:36 +00003449
Chris Lattner3d512132010-12-13 06:25:44 +00003450 // Scan predecessor blocks for conditional branches.
3451 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
3452 if (BranchInst *PBI = dyn_cast<BranchInst>((*PI)->getTerminator()))
3453 if (PBI != BI && PBI->isConditional())
3454 if (SimplifyCondBranchToCondBranch(PBI, BI))
3455 return SimplifyCFG(BB) | true;
3456
3457 return false;
3458}
3459
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003460/// Check if passing a value to an instruction will cause undefined behavior.
3461static bool passingValueIsAlwaysUndefined(Value *V, Instruction *I) {
3462 Constant *C = dyn_cast<Constant>(V);
3463 if (!C)
3464 return false;
3465
Benjamin Kramer9bb54882011-08-26 02:25:55 +00003466 if (!I->hasOneUse()) // Only look at single-use instructions, for compile time
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003467 return false;
3468
3469 if (C->isNullValue()) {
3470 Instruction *Use = I->use_back();
3471
3472 // Now make sure that there are no instructions in between that can alter
3473 // control flow (eg. calls)
3474 for (BasicBlock::iterator i = ++BasicBlock::iterator(I); &*i != Use; ++i)
Benjamin Kramer9bb54882011-08-26 02:25:55 +00003475 if (i == I->getParent()->end() || i->mayHaveSideEffects())
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003476 return false;
3477
3478 // Look through GEPs. A load from a GEP derived from NULL is still undefined
3479 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Use))
3480 if (GEP->getPointerOperand() == I)
3481 return passingValueIsAlwaysUndefined(V, GEP);
3482
3483 // Look through bitcasts.
3484 if (BitCastInst *BC = dyn_cast<BitCastInst>(Use))
3485 return passingValueIsAlwaysUndefined(V, BC);
3486
Benjamin Kramer9bb54882011-08-26 02:25:55 +00003487 // Load from null is undefined.
3488 if (LoadInst *LI = dyn_cast<LoadInst>(Use))
3489 return LI->getPointerAddressSpace() == 0;
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003490
Benjamin Kramer9bb54882011-08-26 02:25:55 +00003491 // Store to null is undefined.
3492 if (StoreInst *SI = dyn_cast<StoreInst>(Use))
3493 return SI->getPointerAddressSpace() == 0 && SI->getPointerOperand() == I;
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003494 }
3495 return false;
3496}
3497
3498/// If BB has an incoming value that will always trigger undefined behavior
Nick Lewycky9d523102011-12-26 20:37:40 +00003499/// (eg. null pointer dereference), remove the branch leading here.
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003500static bool removeUndefIntroducingPredecessor(BasicBlock *BB) {
3501 for (BasicBlock::iterator i = BB->begin();
3502 PHINode *PHI = dyn_cast<PHINode>(i); ++i)
3503 for (unsigned i = 0, e = PHI->getNumIncomingValues(); i != e; ++i)
3504 if (passingValueIsAlwaysUndefined(PHI->getIncomingValue(i), PHI)) {
3505 TerminatorInst *T = PHI->getIncomingBlock(i)->getTerminator();
3506 IRBuilder<> Builder(T);
3507 if (BranchInst *BI = dyn_cast<BranchInst>(T)) {
3508 BB->removePredecessor(PHI->getIncomingBlock(i));
3509 // Turn uncoditional branches into unreachables and remove the dead
3510 // destination from conditional branches.
3511 if (BI->isUnconditional())
3512 Builder.CreateUnreachable();
3513 else
3514 Builder.CreateBr(BI->getSuccessor(0) == BB ? BI->getSuccessor(1) :
3515 BI->getSuccessor(0));
3516 BI->eraseFromParent();
3517 return true;
3518 }
3519 // TODO: SwitchInst.
3520 }
3521
3522 return false;
3523}
3524
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +00003525bool SimplifyCFGOpt::run(BasicBlock *BB) {
Chris Lattnerdc3602b2003-08-24 18:36:16 +00003526 bool Changed = false;
Chris Lattner01d1ee32002-05-21 20:50:24 +00003527
Chris Lattner302ba6f2010-12-14 06:17:25 +00003528 assert(BB && BB->getParent() && "Block not embedded in function!");
Chris Lattner01d1ee32002-05-21 20:50:24 +00003529 assert(BB->getTerminator() && "Degenerate basic block encountered!");
Chris Lattner01d1ee32002-05-21 20:50:24 +00003530
Dan Gohmane2c6d132010-08-14 00:29:42 +00003531 // Remove basic blocks that have no predecessors (except the entry block)...
3532 // or that just have themself as a predecessor. These are unreachable.
Chris Lattner302ba6f2010-12-14 06:17:25 +00003533 if ((pred_begin(BB) == pred_end(BB) &&
3534 BB != &BB->getParent()->getEntryBlock()) ||
Dan Gohmane2c6d132010-08-14 00:29:42 +00003535 BB->getSinglePredecessor() == BB) {
David Greene89d6fd32010-01-05 01:26:52 +00003536 DEBUG(dbgs() << "Removing BB: \n" << *BB);
Chris Lattner71af9b02008-12-03 06:40:52 +00003537 DeleteDeadBlock(BB);
Chris Lattner01d1ee32002-05-21 20:50:24 +00003538 return true;
3539 }
3540
Chris Lattner694e37f2003-08-17 19:41:53 +00003541 // Check to see if we can constant propagate this terminator instruction
3542 // away...
Frits van Bommel5649ba72011-05-22 16:24:18 +00003543 Changed |= ConstantFoldTerminator(BB, true);
Chris Lattner694e37f2003-08-17 19:41:53 +00003544
Dan Gohman2c635662009-10-30 22:39:04 +00003545 // Check for and eliminate duplicate PHI nodes in this block.
3546 Changed |= EliminateDuplicatePHINodes(BB);
3547
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003548 // Check for and remove branches that will always cause undefined behavior.
3549 Changed |= removeUndefIntroducingPredecessor(BB);
3550
Chris Lattnerddb97a22010-12-13 05:10:48 +00003551 // Merge basic blocks into their predecessor if there is only one distinct
3552 // pred, and if there is only one distinct successor of the predecessor, and
3553 // if there are no PHI nodes.
3554 //
3555 if (MergeBlockIntoPredecessor(BB))
3556 return true;
Andrew Trick6b014382012-08-29 21:46:36 +00003557
Devang Patel3e410c62011-05-18 18:01:27 +00003558 IRBuilder<> Builder(BB);
3559
Dan Gohman882d87d2008-03-11 21:53:06 +00003560 // If there is a trivial two-entry PHI node in this basic block, and we can
3561 // eliminate it, do so now.
3562 if (PHINode *PN = dyn_cast<PHINode>(BB->begin()))
3563 if (PN->getNumIncomingValues() == 2)
Devang Pateld3a17882011-05-19 20:52:46 +00003564 Changed |= FoldTwoEntryPHINode(PN, TD);
Dan Gohman882d87d2008-03-11 21:53:06 +00003565
Devang Patel007349d2011-05-18 20:35:38 +00003566 Builder.SetInsertPoint(BB->getTerminator());
Chris Lattner3d512132010-12-13 06:25:44 +00003567 if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) {
Chris Lattner021c9d32010-12-13 06:36:51 +00003568 if (BI->isUnconditional()) {
Devang Patela23812c2011-05-18 18:28:48 +00003569 if (SimplifyUncondBranch(BI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00003570 } else {
Devang Patel007349d2011-05-18 20:35:38 +00003571 if (SimplifyCondBranch(BI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00003572 }
3573 } else if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
Devang Patel176ec402011-05-18 21:33:11 +00003574 if (SimplifyReturn(RI, Builder)) return true;
Bill Wendlingaa5abe82012-02-06 21:16:41 +00003575 } else if (ResumeInst *RI = dyn_cast<ResumeInst>(BB->getTerminator())) {
3576 if (SimplifyResume(RI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00003577 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
Devang Patel007349d2011-05-18 20:35:38 +00003578 if (SimplifySwitch(SI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00003579 } else if (UnreachableInst *UI =
3580 dyn_cast<UnreachableInst>(BB->getTerminator())) {
3581 if (SimplifyUnreachable(UI)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00003582 } else if (IndirectBrInst *IBI =
3583 dyn_cast<IndirectBrInst>(BB->getTerminator())) {
3584 if (SimplifyIndirectBr(IBI)) return true;
Chris Lattner19831ec2004-02-16 06:35:48 +00003585 }
3586
Chris Lattner694e37f2003-08-17 19:41:53 +00003587 return Changed;
Chris Lattner01d1ee32002-05-21 20:50:24 +00003588}
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +00003589
3590/// SimplifyCFG - This function is used to do simplification of a CFG. For
3591/// example, it adjusts branches to branches to eliminate the extra hop, it
3592/// eliminates unreachable basic blocks, and does other "peephole" optimization
3593/// of the CFG. It returns true if a modification was made.
3594///
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +00003595bool llvm::SimplifyCFG(BasicBlock *BB, const TargetData *TD) {
3596 return SimplifyCFGOpt(TD).run(BB);
3597}