blob: 2591dbf726227b5562d83727ab299f619eed6c0b [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
Manman Ren020aba02012-09-11 17:43:35 +0000755/// Get Weights of a given TerminatorInst, the default weight is at the front
756/// of the vector. If TI is a conditional eq, we need to swap the branch-weight
757/// metadata.
758static void GetBranchWeights(TerminatorInst *TI,
759 SmallVectorImpl<uint64_t> &Weights) {
760 MDNode* MD = TI->getMetadata(LLVMContext::MD_prof);
761 assert(MD);
762 for (unsigned i = 1, e = MD->getNumOperands(); i < e; ++i) {
763 ConstantInt* CI = dyn_cast<ConstantInt>(MD->getOperand(i));
Andrew Trickb1b97832012-08-29 21:46:38 +0000764 assert(CI);
Manman Ren020aba02012-09-11 17:43:35 +0000765 Weights.push_back(CI->getValue().getZExtValue());
Andrew Trickb1b97832012-08-29 21:46:38 +0000766 }
767
Manman Ren020aba02012-09-11 17:43:35 +0000768 // If TI is a conditional eq, the default case is the false case,
769 // and the corresponding branch-weight data is at index 2. We swap the
770 // default weight to be the first entry.
771 if (BranchInst* BI = dyn_cast<BranchInst>(TI)) {
772 assert(Weights.size() == 2);
773 ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
774 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
775 std::swap(Weights.front(), Weights.back());
Andrew Trickb1b97832012-08-29 21:46:38 +0000776 }
777}
778
779/// Sees if any of the weights are too big for a uint32_t, and halves all the
780/// weights if any are.
781static void FitWeights(MutableArrayRef<uint64_t> Weights) {
782 bool Halve = false;
783 for (unsigned i = 0; i < Weights.size(); ++i)
784 if (Weights[i] > UINT_MAX) {
785 Halve = true;
786 break;
787 }
788
789 if (! Halve)
790 return;
791
792 for (unsigned i = 0; i < Weights.size(); ++i)
793 Weights[i] /= 2;
794}
795
Bill Wendling5049fa62009-01-19 23:43:56 +0000796/// FoldValueComparisonIntoPredecessors - The specified terminator is a value
797/// equality comparison instruction (either a switch or a branch on "X == c").
798/// See if any of the predecessors of the terminator block are value comparisons
799/// on the same value. If so, and if safe to do so, fold them together.
Devang Patelb55d9242011-05-18 20:53:17 +0000800bool SimplifyCFGOpt::FoldValueComparisonIntoPredecessors(TerminatorInst *TI,
801 IRBuilder<> &Builder) {
Chris Lattner542f1492004-02-28 21:28:10 +0000802 BasicBlock *BB = TI->getParent();
803 Value *CV = isValueEqualityComparison(TI); // CondVal
804 assert(CV && "Not a comparison?");
805 bool Changed = false;
806
Chris Lattner82442432008-02-18 07:42:56 +0000807 SmallVector<BasicBlock*, 16> Preds(pred_begin(BB), pred_end(BB));
Chris Lattner542f1492004-02-28 21:28:10 +0000808 while (!Preds.empty()) {
Dan Gohmane9d87f42009-05-06 17:22:41 +0000809 BasicBlock *Pred = Preds.pop_back_val();
Misha Brukmanfd939082005-04-21 23:48:37 +0000810
Chris Lattner542f1492004-02-28 21:28:10 +0000811 // See if the predecessor is a comparison with the same value.
812 TerminatorInst *PTI = Pred->getTerminator();
813 Value *PCV = isValueEqualityComparison(PTI); // PredCondVal
814
815 if (PCV == CV && SafeToMergeTerminators(TI, PTI)) {
816 // Figure out which 'cases' to copy from SI to PSI.
Eric Christopherc723eb12012-07-02 23:22:21 +0000817 std::vector<ValueEqualityComparisonCase> BBCases;
Chris Lattner542f1492004-02-28 21:28:10 +0000818 BasicBlock *BBDefault = GetValueEqualityComparisonCases(TI, BBCases);
819
Eric Christopherc723eb12012-07-02 23:22:21 +0000820 std::vector<ValueEqualityComparisonCase> PredCases;
Chris Lattner542f1492004-02-28 21:28:10 +0000821 BasicBlock *PredDefault = GetValueEqualityComparisonCases(PTI, PredCases);
822
823 // Based on whether the default edge from PTI goes to BB or not, fill in
824 // PredCases and PredDefault with the new switch cases we would like to
825 // build.
Chris Lattner82442432008-02-18 07:42:56 +0000826 SmallVector<BasicBlock*, 8> NewSuccessors;
Chris Lattner542f1492004-02-28 21:28:10 +0000827
Andrew Trickb1b97832012-08-29 21:46:38 +0000828 // Update the branch weight metadata along the way
829 SmallVector<uint64_t, 8> Weights;
Andrew Trickb1b97832012-08-29 21:46:38 +0000830 bool PredHasWeights = HasBranchWeights(PTI);
831 bool SuccHasWeights = HasBranchWeights(TI);
832
Manman Ren020aba02012-09-11 17:43:35 +0000833 if (PredHasWeights)
834 GetBranchWeights(PTI, Weights);
835 else if (SuccHasWeights)
Andrew Trickb1b97832012-08-29 21:46:38 +0000836 // If there are no predecessor weights but there are successor weights,
837 // populate Weights with 1, which will later be scaled to the sum of
838 // successor's weights
839 Weights.assign(1 + PredCases.size(), 1);
Andrew Trickb1b97832012-08-29 21:46:38 +0000840
Manman Ren020aba02012-09-11 17:43:35 +0000841 SmallVector<uint64_t, 8> SuccWeights;
842 if (SuccHasWeights)
843 GetBranchWeights(TI, SuccWeights);
844 else if (PredHasWeights)
845 SuccWeights.assign(1 + BBCases.size(), 1);
Andrew Trickb1b97832012-08-29 21:46:38 +0000846
Chris Lattner542f1492004-02-28 21:28:10 +0000847 if (PredDefault == BB) {
848 // If this is the default destination from PTI, only the edges in TI
849 // that don't occur in PTI, or that branch to BB will be activated.
Eric Christopherc723eb12012-07-02 23:22:21 +0000850 std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
851 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
852 if (PredCases[i].Dest != BB)
853 PTIHandled.insert(PredCases[i].Value);
854 else {
855 // The default destination is BB, we don't need explicit targets.
856 std::swap(PredCases[i], PredCases.back());
Andrew Trickb1b97832012-08-29 21:46:38 +0000857
Manman Ren020aba02012-09-11 17:43:35 +0000858 if (PredHasWeights || SuccHasWeights) {
859 // Increase weight for the default case.
860 Weights[0] += Weights[i+1];
Andrew Trickb1b97832012-08-29 21:46:38 +0000861 std::swap(Weights[i+1], Weights.back());
862 Weights.pop_back();
863 }
864
Eric Christopherc723eb12012-07-02 23:22:21 +0000865 PredCases.pop_back();
866 --i; --e;
867 }
Chris Lattner542f1492004-02-28 21:28:10 +0000868
Eric Christopherc723eb12012-07-02 23:22:21 +0000869 // Reconstruct the new switch statement we will be building.
Chris Lattner542f1492004-02-28 21:28:10 +0000870 if (PredDefault != BBDefault) {
871 PredDefault->removePredecessor(Pred);
872 PredDefault = BBDefault;
873 NewSuccessors.push_back(BBDefault);
874 }
Andrew Trickb1b97832012-08-29 21:46:38 +0000875
Manman Ren020aba02012-09-11 17:43:35 +0000876 unsigned CasesFromPred = Weights.size();
877 uint64_t ValidTotalSuccWeight = 0;
Eric Christopherc723eb12012-07-02 23:22:21 +0000878 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
879 if (!PTIHandled.count(BBCases[i].Value) &&
880 BBCases[i].Dest != BBDefault) {
881 PredCases.push_back(BBCases[i]);
882 NewSuccessors.push_back(BBCases[i].Dest);
Manman Ren020aba02012-09-11 17:43:35 +0000883 if (SuccHasWeights || PredHasWeights) {
884 // The default weight is at index 0, so weight for the ith case
885 // should be at index i+1. Scale the cases from successor by
886 // PredDefaultWeight (Weights[0]).
887 Weights.push_back(Weights[0] * SuccWeights[i+1]);
888 ValidTotalSuccWeight += SuccWeights[i+1];
Andrew Trickb1b97832012-08-29 21:46:38 +0000889 }
Eric Christopherc723eb12012-07-02 23:22:21 +0000890 }
Chris Lattner542f1492004-02-28 21:28:10 +0000891
Manman Ren020aba02012-09-11 17:43:35 +0000892 if (SuccHasWeights || PredHasWeights) {
893 ValidTotalSuccWeight += SuccWeights[0];
894 // Scale the cases from predecessor by ValidTotalSuccWeight.
895 for (unsigned i = 1; i < CasesFromPred; ++i)
896 Weights[i] *= ValidTotalSuccWeight;
897 // Scale the default weight by SuccDefaultWeight (SuccWeights[0]).
898 Weights[0] *= SuccWeights[0];
899 }
Chris Lattner542f1492004-02-28 21:28:10 +0000900 } else {
901 // If this is not the default destination from PSI, only the edges
902 // in SI that occur in PSI with a destination of BB will be
903 // activated.
Eric Christopherc723eb12012-07-02 23:22:21 +0000904 std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
Manman Rena8a2b992012-09-14 17:29:56 +0000905 std::map<ConstantInt*, uint64_t> WeightsForHandled;
Eric Christopherc723eb12012-07-02 23:22:21 +0000906 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
907 if (PredCases[i].Dest == BB) {
908 PTIHandled.insert(PredCases[i].Value);
Manman Rena8a2b992012-09-14 17:29:56 +0000909
910 if (PredHasWeights || SuccHasWeights) {
911 WeightsForHandled[PredCases[i].Value] = Weights[i+1];
912 std::swap(Weights[i+1], Weights.back());
913 Weights.pop_back();
914 }
915
Eric Christopherc723eb12012-07-02 23:22:21 +0000916 std::swap(PredCases[i], PredCases.back());
917 PredCases.pop_back();
918 --i; --e;
919 }
Chris Lattner542f1492004-02-28 21:28:10 +0000920
921 // Okay, now we know which constants were sent to BB from the
922 // predecessor. Figure out where they will all go now.
Eric Christopherc723eb12012-07-02 23:22:21 +0000923 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
924 if (PTIHandled.count(BBCases[i].Value)) {
925 // If this is one we are capable of getting...
Manman Rena8a2b992012-09-14 17:29:56 +0000926 if (PredHasWeights || SuccHasWeights)
927 Weights.push_back(WeightsForHandled[BBCases[i].Value]);
Eric Christopherc723eb12012-07-02 23:22:21 +0000928 PredCases.push_back(BBCases[i]);
929 NewSuccessors.push_back(BBCases[i].Dest);
930 PTIHandled.erase(BBCases[i].Value);// This constant is taken care of
931 }
932
Chris Lattner542f1492004-02-28 21:28:10 +0000933 // If there are any constants vectored to BB that TI doesn't handle,
934 // they must go to the default destination of TI.
Andrew Trick6b014382012-08-29 21:46:36 +0000935 for (std::set<ConstantInt*, ConstantIntOrdering>::iterator I =
Eric Christopherc723eb12012-07-02 23:22:21 +0000936 PTIHandled.begin(),
937 E = PTIHandled.end(); I != E; ++I) {
Manman Rena8a2b992012-09-14 17:29:56 +0000938 if (PredHasWeights || SuccHasWeights)
939 Weights.push_back(WeightsForHandled[*I]);
Eric Christopherc723eb12012-07-02 23:22:21 +0000940 PredCases.push_back(ValueEqualityComparisonCase(*I, BBDefault));
Chris Lattner542f1492004-02-28 21:28:10 +0000941 NewSuccessors.push_back(BBDefault);
Eric Christopherc723eb12012-07-02 23:22:21 +0000942 }
Chris Lattner542f1492004-02-28 21:28:10 +0000943 }
944
945 // Okay, at this point, we know which new successor Pred will get. Make
946 // sure we update the number of entries in the PHI nodes for these
947 // successors.
948 for (unsigned i = 0, e = NewSuccessors.size(); i != e; ++i)
949 AddPredecessorToBlock(NewSuccessors[i], Pred, BB);
950
Devang Patelb55d9242011-05-18 20:53:17 +0000951 Builder.SetInsertPoint(PTI);
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000952 // Convert pointer to int before we switch.
Duncan Sands1df98592010-02-16 11:11:14 +0000953 if (CV->getType()->isPointerTy()) {
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000954 assert(TD && "Cannot switch on pointer without TargetData");
Devang Patelb55d9242011-05-18 20:53:17 +0000955 CV = Builder.CreatePtrToInt(CV, TD->getIntPtrType(CV->getContext()),
956 "magicptr");
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000957 }
958
Chris Lattner542f1492004-02-28 21:28:10 +0000959 // Now that the successors are updated, create the new Switch instruction.
Devang Patelb55d9242011-05-18 20:53:17 +0000960 SwitchInst *NewSI = Builder.CreateSwitch(CV, PredDefault,
961 PredCases.size());
Devang Pateld80e8ed2011-05-17 23:29:05 +0000962 NewSI->setDebugLoc(PTI->getDebugLoc());
Eric Christopherc723eb12012-07-02 23:22:21 +0000963 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
964 NewSI->addCase(PredCases[i].Value, PredCases[i].Dest);
Chris Lattner13b2f762005-01-01 16:02:12 +0000965
Andrew Trickb1b97832012-08-29 21:46:38 +0000966 if (PredHasWeights || SuccHasWeights) {
967 // Halve the weights if any of them cannot fit in an uint32_t
968 FitWeights(Weights);
969
970 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
971
972 NewSI->setMetadata(LLVMContext::MD_prof,
973 MDBuilder(BB->getContext()).
974 createBranchWeights(MDWeights));
975 }
976
Eli Friedman080efb82008-12-16 20:54:32 +0000977 EraseTerminatorInstAndDCECond(PTI);
Chris Lattner13b2f762005-01-01 16:02:12 +0000978
Chris Lattner542f1492004-02-28 21:28:10 +0000979 // Okay, last check. If BB is still a successor of PSI, then we must
980 // have an infinite loop case. If so, add an infinitely looping block
981 // to handle the case to preserve the behavior of the code.
982 BasicBlock *InfLoopBlock = 0;
983 for (unsigned i = 0, e = NewSI->getNumSuccessors(); i != e; ++i)
984 if (NewSI->getSuccessor(i) == BB) {
985 if (InfLoopBlock == 0) {
Chris Lattner093a4382008-07-13 22:23:11 +0000986 // Insert it at the end of the function, because it's either code,
Chris Lattner542f1492004-02-28 21:28:10 +0000987 // or it won't matter if it's hot. :)
Owen Anderson1d0be152009-08-13 21:58:54 +0000988 InfLoopBlock = BasicBlock::Create(BB->getContext(),
989 "infloop", BB->getParent());
Gabor Greif051a9502008-04-06 20:25:17 +0000990 BranchInst::Create(InfLoopBlock, InfLoopBlock);
Chris Lattner542f1492004-02-28 21:28:10 +0000991 }
992 NewSI->setSuccessor(i, InfLoopBlock);
993 }
Misha Brukmanfd939082005-04-21 23:48:37 +0000994
Chris Lattner542f1492004-02-28 21:28:10 +0000995 Changed = true;
996 }
997 }
998 return Changed;
999}
1000
Dale Johannesenc1f10402009-06-15 20:59:27 +00001001// isSafeToHoistInvoke - If we would need to insert a select that uses the
1002// value of this invoke (comments in HoistThenElseCodeToIf explain why we
1003// would need to do this), we can't hoist the invoke, as there is nowhere
1004// to put the select in this case.
1005static bool isSafeToHoistInvoke(BasicBlock *BB1, BasicBlock *BB2,
1006 Instruction *I1, Instruction *I2) {
1007 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
1008 PHINode *PN;
1009 for (BasicBlock::iterator BBI = SI->begin();
1010 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
1011 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1012 Value *BB2V = PN->getIncomingValueForBlock(BB2);
1013 if (BB1V != BB2V && (BB1V==I1 || BB2V==I2)) {
1014 return false;
1015 }
1016 }
1017 }
1018 return true;
1019}
1020
Chris Lattner6306d072005-08-03 17:59:45 +00001021/// HoistThenElseCodeToIf - Given a conditional branch that goes to BB1 and
Chris Lattner37dc9382004-11-30 00:29:14 +00001022/// BB2, hoist any common code in the two blocks up into the branch block. The
1023/// caller of this function guarantees that BI's block dominates BB1 and BB2.
Rafael Espindola216dde92011-05-19 02:26:30 +00001024static bool HoistThenElseCodeToIf(BranchInst *BI) {
Chris Lattner37dc9382004-11-30 00:29:14 +00001025 // This does very trivial matching, with limited scanning, to find identical
1026 // instructions in the two blocks. In particular, we don't want to get into
1027 // O(M*N) situations here where M and N are the sizes of BB1 and BB2. As
1028 // such, we currently just scan for obviously identical instructions in an
1029 // identical order.
1030 BasicBlock *BB1 = BI->getSuccessor(0); // The true destination.
1031 BasicBlock *BB2 = BI->getSuccessor(1); // The false destination
1032
Devang Patel65085cf2009-02-04 00:03:08 +00001033 BasicBlock::iterator BB1_Itr = BB1->begin();
1034 BasicBlock::iterator BB2_Itr = BB2->begin();
1035
1036 Instruction *I1 = BB1_Itr++, *I2 = BB2_Itr++;
Devang Patel949666e2011-04-07 17:27:36 +00001037 // Skip debug info if it is not identical.
1038 DbgInfoIntrinsic *DBI1 = dyn_cast<DbgInfoIntrinsic>(I1);
1039 DbgInfoIntrinsic *DBI2 = dyn_cast<DbgInfoIntrinsic>(I2);
1040 if (!DBI1 || !DBI2 || !DBI1->isIdenticalToWhenDefined(DBI2)) {
1041 while (isa<DbgInfoIntrinsic>(I1))
1042 I1 = BB1_Itr++;
1043 while (isa<DbgInfoIntrinsic>(I2))
1044 I2 = BB2_Itr++;
1045 }
Devang Patelae6c95b2011-04-07 00:30:15 +00001046 if (isa<PHINode>(I1) || !I1->isIdenticalToWhenDefined(I2) ||
Dale Johannesenc1f10402009-06-15 20:59:27 +00001047 (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2)))
Chris Lattner37dc9382004-11-30 00:29:14 +00001048 return false;
1049
1050 // If we get here, we can hoist at least one instruction.
1051 BasicBlock *BIParent = BI->getParent();
Chris Lattner37dc9382004-11-30 00:29:14 +00001052
1053 do {
1054 // If we are hoisting the terminator instruction, don't move one (making a
1055 // broken BB), instead clone it, and remove BI.
1056 if (isa<TerminatorInst>(I1))
1057 goto HoistTerminator;
Misha Brukmanfd939082005-04-21 23:48:37 +00001058
Chris Lattner37dc9382004-11-30 00:29:14 +00001059 // For a normal instruction, we just move one to right before the branch,
1060 // then replace all uses of the other with the first. Finally, we remove
1061 // the now redundant second instruction.
1062 BIParent->getInstList().splice(BI, BB1->getInstList(), I1);
1063 if (!I2->use_empty())
1064 I2->replaceAllUsesWith(I1);
Dan Gohman58cfa3b2009-08-25 22:11:20 +00001065 I1->intersectOptionalDataWith(I2);
Chris Lattner302ba6f2010-12-14 06:17:25 +00001066 I2->eraseFromParent();
Misha Brukmanfd939082005-04-21 23:48:37 +00001067
Devang Patel65085cf2009-02-04 00:03:08 +00001068 I1 = BB1_Itr++;
Devang Patel65085cf2009-02-04 00:03:08 +00001069 I2 = BB2_Itr++;
Devang Patel949666e2011-04-07 17:27:36 +00001070 // Skip debug info if it is not identical.
1071 DbgInfoIntrinsic *DBI1 = dyn_cast<DbgInfoIntrinsic>(I1);
1072 DbgInfoIntrinsic *DBI2 = dyn_cast<DbgInfoIntrinsic>(I2);
1073 if (!DBI1 || !DBI2 || !DBI1->isIdenticalToWhenDefined(DBI2)) {
1074 while (isa<DbgInfoIntrinsic>(I1))
1075 I1 = BB1_Itr++;
1076 while (isa<DbgInfoIntrinsic>(I2))
1077 I2 = BB2_Itr++;
1078 }
Devang Patelae6c95b2011-04-07 00:30:15 +00001079 } while (I1->isIdenticalToWhenDefined(I2));
Chris Lattner37dc9382004-11-30 00:29:14 +00001080
1081 return true;
1082
1083HoistTerminator:
Dale Johannesenc1f10402009-06-15 20:59:27 +00001084 // It may not be possible to hoist an invoke.
1085 if (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2))
1086 return true;
1087
Chris Lattner37dc9382004-11-30 00:29:14 +00001088 // Okay, it is safe to hoist the terminator.
Nick Lewycky67760642009-09-27 07:38:41 +00001089 Instruction *NT = I1->clone();
Chris Lattner37dc9382004-11-30 00:29:14 +00001090 BIParent->getInstList().insert(BI, NT);
Benjamin Kramerf0127052010-01-05 13:12:22 +00001091 if (!NT->getType()->isVoidTy()) {
Chris Lattner37dc9382004-11-30 00:29:14 +00001092 I1->replaceAllUsesWith(NT);
1093 I2->replaceAllUsesWith(NT);
Chris Lattner86cc4232007-02-11 01:37:51 +00001094 NT->takeName(I1);
Chris Lattner37dc9382004-11-30 00:29:14 +00001095 }
1096
Devang Pateld3a17882011-05-19 20:52:46 +00001097 IRBuilder<true, NoFolder> Builder(NT);
Chris Lattner37dc9382004-11-30 00:29:14 +00001098 // Hoisting one of the terminators from our successor is a great thing.
1099 // Unfortunately, the successors of the if/else blocks may have PHI nodes in
1100 // them. If they do, all PHI entries for BB1/BB2 must agree for all PHI
1101 // nodes, so we insert select instruction to compute the final result.
1102 std::map<std::pair<Value*,Value*>, SelectInst*> InsertedSelects;
1103 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
1104 PHINode *PN;
1105 for (BasicBlock::iterator BBI = SI->begin();
Chris Lattner0f535c62004-11-30 07:47:34 +00001106 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
Chris Lattner37dc9382004-11-30 00:29:14 +00001107 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1108 Value *BB2V = PN->getIncomingValueForBlock(BB2);
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001109 if (BB1V == BB2V) continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001110
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001111 // These values do not agree. Insert a select instruction before NT
1112 // that determines the right value.
1113 SelectInst *&SI = InsertedSelects[std::make_pair(BB1V, BB2V)];
Andrew Trick6b014382012-08-29 21:46:36 +00001114 if (SI == 0)
Devang Pateld3a17882011-05-19 20:52:46 +00001115 SI = cast<SelectInst>
1116 (Builder.CreateSelect(BI->getCondition(), BB1V, BB2V,
1117 BB1V->getName()+"."+BB2V->getName()));
1118
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001119 // Make the PHI node use the select for all incoming values for BB1/BB2
1120 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1121 if (PN->getIncomingBlock(i) == BB1 || PN->getIncomingBlock(i) == BB2)
1122 PN->setIncomingValue(i, SI);
Chris Lattner37dc9382004-11-30 00:29:14 +00001123 }
1124 }
1125
1126 // Update any PHI nodes in our new successors.
1127 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI)
1128 AddPredecessorToBlock(*SI, BIParent, BB1);
Misha Brukmanfd939082005-04-21 23:48:37 +00001129
Eli Friedman080efb82008-12-16 20:54:32 +00001130 EraseTerminatorInstAndDCECond(BI);
Chris Lattner37dc9382004-11-30 00:29:14 +00001131 return true;
1132}
1133
Evan Cheng4d09efd2008-06-07 08:52:29 +00001134/// SpeculativelyExecuteBB - Given a conditional branch that goes to BB1
1135/// and an BB2 and the only successor of BB1 is BB2, hoist simple code
1136/// (for now, restricted to a single instruction that's side effect free) from
1137/// the BB1 into the branch block to speculatively execute it.
Dan Gohman3b205172012-01-05 23:58:56 +00001138///
1139/// Turn
1140/// BB:
1141/// %t1 = icmp
1142/// br i1 %t1, label %BB1, label %BB2
1143/// BB1:
1144/// %t3 = add %t2, c
1145/// br label BB2
1146/// BB2:
1147/// =>
1148/// BB:
1149/// %t1 = icmp
1150/// %t4 = add %t2, c
1151/// %t3 = select i1 %t1, %t2, %t3
Rafael Espindola216dde92011-05-19 02:26:30 +00001152static bool SpeculativelyExecuteBB(BranchInst *BI, BasicBlock *BB1) {
Evan Cheng4d09efd2008-06-07 08:52:29 +00001153 // Only speculatively execution a single instruction (not counting the
1154 // terminator) for now.
Devang Patel06b1e672009-03-06 06:00:17 +00001155 Instruction *HInst = NULL;
1156 Instruction *Term = BB1->getTerminator();
1157 for (BasicBlock::iterator BBI = BB1->begin(), BBE = BB1->end();
1158 BBI != BBE; ++BBI) {
1159 Instruction *I = BBI;
1160 // Skip debug info.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001161 if (isa<DbgInfoIntrinsic>(I)) continue;
1162 if (I == Term) break;
Devang Patel06b1e672009-03-06 06:00:17 +00001163
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001164 if (HInst)
Devang Patel06b1e672009-03-06 06:00:17 +00001165 return false;
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001166 HInst = I;
Devang Patel06b1e672009-03-06 06:00:17 +00001167 }
Dan Gohman3b205172012-01-05 23:58:56 +00001168
1169 BasicBlock *BIParent = BI->getParent();
1170
1171 // Check the instruction to be hoisted, if there is one.
1172 if (HInst) {
1173 // Don't hoist the instruction if it's unsafe or expensive.
1174 if (!isSafeToSpeculativelyExecute(HInst))
1175 return false;
1176 if (ComputeSpeculationCost(HInst) > PHINodeFoldingThreshold)
1177 return false;
1178
1179 // Do not hoist the instruction if any of its operands are defined but not
1180 // used in this BB. The transformation will prevent the operand from
1181 // being sunk into the use block.
Andrew Trick6b014382012-08-29 21:46:36 +00001182 for (User::op_iterator i = HInst->op_begin(), e = HInst->op_end();
Dan Gohman3b205172012-01-05 23:58:56 +00001183 i != e; ++i) {
1184 Instruction *OpI = dyn_cast<Instruction>(*i);
1185 if (OpI && OpI->getParent() == BIParent &&
1186 !OpI->mayHaveSideEffects() &&
1187 !OpI->isUsedInBasicBlock(BIParent))
1188 return false;
1189 }
1190 }
Evan Cheng4d09efd2008-06-07 08:52:29 +00001191
Evan Cheng797d9512008-06-11 19:18:20 +00001192 // Be conservative for now. FP select instruction can often be expensive.
1193 Value *BrCond = BI->getCondition();
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001194 if (isa<FCmpInst>(BrCond))
Evan Cheng797d9512008-06-11 19:18:20 +00001195 return false;
1196
Evan Cheng4d09efd2008-06-07 08:52:29 +00001197 // If BB1 is actually on the false edge of the conditional branch, remember
1198 // to swap the select operands later.
1199 bool Invert = false;
1200 if (BB1 != BI->getSuccessor(0)) {
1201 assert(BB1 == BI->getSuccessor(1) && "No edge from 'if' block?");
1202 Invert = true;
1203 }
1204
Dan Gohman3b205172012-01-05 23:58:56 +00001205 // Collect interesting PHIs, and scan for hazards.
1206 SmallSetVector<std::pair<Value *, Value *>, 4> PHIs;
Chris Lattner6fe73bb2009-01-19 00:36:37 +00001207 BasicBlock *BB2 = BB1->getTerminator()->getSuccessor(0);
Dan Gohman3b205172012-01-05 23:58:56 +00001208 for (BasicBlock::iterator I = BB2->begin();
1209 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
1210 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1211 Value *BIParentV = PN->getIncomingValueForBlock(BIParent);
1212
1213 // Skip PHIs which are trivial.
1214 if (BB1V == BIParentV)
1215 continue;
1216
1217 // Check for saftey.
1218 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(BB1V)) {
1219 // An unfolded ConstantExpr could end up getting expanded into
1220 // Instructions. Don't speculate this and another instruction at
1221 // the same time.
1222 if (HInst)
1223 return false;
1224 if (!isSafeToSpeculativelyExecute(CE))
1225 return false;
1226 if (ComputeSpeculationCost(CE) > PHINodeFoldingThreshold)
1227 return false;
1228 }
1229
1230 // Ok, we may insert a select for this PHI.
1231 PHIs.insert(std::make_pair(BB1V, BIParentV));
Evan Cheng4d09efd2008-06-07 08:52:29 +00001232 }
Dan Gohman3b205172012-01-05 23:58:56 +00001233
1234 // If there are no PHIs to process, bail early. This helps ensure idempotence
1235 // as well.
1236 if (PHIs.empty())
1237 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001238
Dan Gohman3b205172012-01-05 23:58:56 +00001239 // If we get here, we can hoist the instruction and if-convert.
1240 DEBUG(dbgs() << "SPECULATIVELY EXECUTING BB" << *BB1 << "\n";);
Evan Cheng4d09efd2008-06-07 08:52:29 +00001241
Dan Gohman3b205172012-01-05 23:58:56 +00001242 // Hoist the instruction.
1243 if (HInst)
1244 BIParent->getInstList().splice(BI, BB1->getInstList(), HInst);
Evan Cheng502a4f52008-06-12 21:15:59 +00001245
Dan Gohman3b205172012-01-05 23:58:56 +00001246 // Insert selects and rewrite the PHI operands.
Devang Pateld3a17882011-05-19 20:52:46 +00001247 IRBuilder<true, NoFolder> Builder(BI);
Dan Gohman3b205172012-01-05 23:58:56 +00001248 for (unsigned i = 0, e = PHIs.size(); i != e; ++i) {
1249 Value *TrueV = PHIs[i].first;
1250 Value *FalseV = PHIs[i].second;
Evan Cheng4d09efd2008-06-07 08:52:29 +00001251
Dan Gohman3b205172012-01-05 23:58:56 +00001252 // Create a select whose true value is the speculatively executed value and
1253 // false value is the previously determined FalseV.
1254 SelectInst *SI;
1255 if (Invert)
1256 SI = cast<SelectInst>
1257 (Builder.CreateSelect(BrCond, FalseV, TrueV,
1258 FalseV->getName() + "." + TrueV->getName()));
1259 else
1260 SI = cast<SelectInst>
1261 (Builder.CreateSelect(BrCond, TrueV, FalseV,
1262 TrueV->getName() + "." + FalseV->getName()));
1263
1264 // Make the PHI node use the select for all incoming values for "then" and
1265 // "if" blocks.
1266 for (BasicBlock::iterator I = BB2->begin();
1267 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
1268 unsigned BB1I = PN->getBasicBlockIndex(BB1);
1269 unsigned BIParentI = PN->getBasicBlockIndex(BIParent);
1270 Value *BB1V = PN->getIncomingValue(BB1I);
1271 Value *BIParentV = PN->getIncomingValue(BIParentI);
1272 if (TrueV == BB1V && FalseV == BIParentV) {
1273 PN->setIncomingValue(BB1I, SI);
1274 PN->setIncomingValue(BIParentI, SI);
1275 }
1276 }
Evan Cheng4d09efd2008-06-07 08:52:29 +00001277 }
1278
Evan Cheng502a4f52008-06-12 21:15:59 +00001279 ++NumSpeculations;
Evan Cheng4d09efd2008-06-07 08:52:29 +00001280 return true;
1281}
1282
Chris Lattner2e42e362005-09-20 00:43:16 +00001283/// BlockIsSimpleEnoughToThreadThrough - Return true if we can thread a branch
1284/// across this block.
1285static bool BlockIsSimpleEnoughToThreadThrough(BasicBlock *BB) {
1286 BranchInst *BI = cast<BranchInst>(BB->getTerminator());
Chris Lattnere9487f02005-09-20 01:48:40 +00001287 unsigned Size = 0;
Andrew Trick6b014382012-08-29 21:46:36 +00001288
Devang Patel9200c892009-03-10 18:00:05 +00001289 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
Dale Johannesen8483e542009-03-12 23:18:09 +00001290 if (isa<DbgInfoIntrinsic>(BBI))
1291 continue;
Chris Lattnere9487f02005-09-20 01:48:40 +00001292 if (Size > 10) return false; // Don't clone large BB's.
Dale Johannesen8483e542009-03-12 23:18:09 +00001293 ++Size;
Andrew Trick6b014382012-08-29 21:46:36 +00001294
Dale Johannesen8483e542009-03-12 23:18:09 +00001295 // We can only support instructions that do not define values that are
Chris Lattnere9487f02005-09-20 01:48:40 +00001296 // live outside of the current basic block.
1297 for (Value::use_iterator UI = BBI->use_begin(), E = BBI->use_end();
1298 UI != E; ++UI) {
1299 Instruction *U = cast<Instruction>(*UI);
1300 if (U->getParent() != BB || isa<PHINode>(U)) return false;
1301 }
Andrew Trick6b014382012-08-29 21:46:36 +00001302
Chris Lattner2e42e362005-09-20 00:43:16 +00001303 // Looks ok, continue checking.
1304 }
Chris Lattnere9487f02005-09-20 01:48:40 +00001305
Chris Lattner2e42e362005-09-20 00:43:16 +00001306 return true;
1307}
1308
Chris Lattnereaba3a12005-09-19 23:49:37 +00001309/// FoldCondBranchOnPHI - If we have a conditional branch on a PHI node value
1310/// that is defined in the same block as the branch and if any PHI entries are
1311/// constants, thread edges corresponding to that entry to be branches to their
1312/// ultimate destination.
Chris Lattner302ba6f2010-12-14 06:17:25 +00001313static bool FoldCondBranchOnPHI(BranchInst *BI, const TargetData *TD) {
Chris Lattnereaba3a12005-09-19 23:49:37 +00001314 BasicBlock *BB = BI->getParent();
1315 PHINode *PN = dyn_cast<PHINode>(BI->getCondition());
Chris Lattner9c88d982005-09-19 23:57:04 +00001316 // NOTE: we currently cannot transform this case if the PHI node is used
1317 // outside of the block.
Chris Lattner2e42e362005-09-20 00:43:16 +00001318 if (!PN || PN->getParent() != BB || !PN->hasOneUse())
1319 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001320
Chris Lattnereaba3a12005-09-19 23:49:37 +00001321 // Degenerate case of a single entry PHI.
1322 if (PN->getNumIncomingValues() == 1) {
Chris Lattner29874e02008-12-03 19:44:02 +00001323 FoldSingleEntryPHINodes(PN->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00001324 return true;
Chris Lattnereaba3a12005-09-19 23:49:37 +00001325 }
1326
1327 // Now we know that this block has multiple preds and two succs.
Chris Lattner2e42e362005-09-20 00:43:16 +00001328 if (!BlockIsSimpleEnoughToThreadThrough(BB)) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001329
Chris Lattnereaba3a12005-09-19 23:49:37 +00001330 // Okay, this is a simple enough basic block. See if any phi values are
1331 // constants.
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00001332 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001333 ConstantInt *CB = dyn_cast<ConstantInt>(PN->getIncomingValue(i));
1334 if (CB == 0 || !CB->getType()->isIntegerTy(1)) continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001335
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001336 // Okay, we now know that all edges from PredBB should be revectored to
1337 // branch to RealDest.
1338 BasicBlock *PredBB = PN->getIncomingBlock(i);
1339 BasicBlock *RealDest = BI->getSuccessor(!CB->getZExtValue());
Andrew Trick6b014382012-08-29 21:46:36 +00001340
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001341 if (RealDest == BB) continue; // Skip self loops.
Bill Wendling6a648b82011-06-04 09:42:04 +00001342 // Skip if the predecessor's terminator is an indirect branch.
1343 if (isa<IndirectBrInst>(PredBB->getTerminator())) continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001344
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001345 // The dest block might have PHI nodes, other predecessors and other
1346 // difficult cases. Instead of being smart about this, just insert a new
1347 // block that jumps to the destination block, effectively splitting
1348 // the edge we are about to create.
1349 BasicBlock *EdgeBB = BasicBlock::Create(BB->getContext(),
1350 RealDest->getName()+".critedge",
1351 RealDest->getParent(), RealDest);
1352 BranchInst::Create(RealDest, EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00001353
Chris Lattner6de0a282010-12-14 07:09:42 +00001354 // Update PHI nodes.
1355 AddPredecessorToBlock(RealDest, EdgeBB, BB);
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001356
1357 // BB may have instructions that are being threaded over. Clone these
1358 // instructions into EdgeBB. We know that there will be no uses of the
1359 // cloned instructions outside of EdgeBB.
1360 BasicBlock::iterator InsertPt = EdgeBB->begin();
1361 DenseMap<Value*, Value*> TranslateMap; // Track translated values.
1362 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
1363 if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
1364 TranslateMap[PN] = PN->getIncomingValueForBlock(PredBB);
1365 continue;
1366 }
1367 // Clone the instruction.
1368 Instruction *N = BBI->clone();
1369 if (BBI->hasName()) N->setName(BBI->getName()+".c");
Andrew Trick6b014382012-08-29 21:46:36 +00001370
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001371 // Update operands due to translation.
1372 for (User::op_iterator i = N->op_begin(), e = N->op_end();
1373 i != e; ++i) {
1374 DenseMap<Value*, Value*>::iterator PI = TranslateMap.find(*i);
1375 if (PI != TranslateMap.end())
1376 *i = PI->second;
1377 }
Andrew Trick6b014382012-08-29 21:46:36 +00001378
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001379 // Check for trivial simplification.
Chris Lattner302ba6f2010-12-14 06:17:25 +00001380 if (Value *V = SimplifyInstruction(N, TD)) {
1381 TranslateMap[BBI] = V;
1382 delete N; // Instruction folded away, don't need actual inst
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001383 } else {
1384 // Insert the new instruction into its new home.
1385 EdgeBB->getInstList().insert(InsertPt, N);
1386 if (!BBI->use_empty())
1387 TranslateMap[BBI] = N;
1388 }
1389 }
1390
1391 // Loop over all of the edges from PredBB to BB, changing them to branch
1392 // to EdgeBB instead.
1393 TerminatorInst *PredBBTI = PredBB->getTerminator();
1394 for (unsigned i = 0, e = PredBBTI->getNumSuccessors(); i != e; ++i)
1395 if (PredBBTI->getSuccessor(i) == BB) {
1396 BB->removePredecessor(PredBB);
1397 PredBBTI->setSuccessor(i, EdgeBB);
1398 }
Bill Wendling6a648b82011-06-04 09:42:04 +00001399
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001400 // Recurse, simplifying any other constants.
Chris Lattner302ba6f2010-12-14 06:17:25 +00001401 return FoldCondBranchOnPHI(BI, TD) | true;
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00001402 }
Chris Lattnereaba3a12005-09-19 23:49:37 +00001403
1404 return false;
1405}
1406
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001407/// FoldTwoEntryPHINode - Given a BB that starts with the specified two-entry
1408/// PHI node, see if we can eliminate it.
Devang Pateld3a17882011-05-19 20:52:46 +00001409static bool FoldTwoEntryPHINode(PHINode *PN, const TargetData *TD) {
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001410 // Ok, this is a two entry PHI node. Check to see if this is a simple "if
1411 // statement", which has a very simple dominance structure. Basically, we
1412 // are trying to find the condition that is being branched on, which
1413 // subsequently causes this merge to happen. We really want control
1414 // dependence information for this check, but simplifycfg can't keep it up
1415 // to date, and this catches most of the cases we care about anyway.
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001416 BasicBlock *BB = PN->getParent();
1417 BasicBlock *IfTrue, *IfFalse;
1418 Value *IfCond = GetIfCondition(BB, IfTrue, IfFalse);
Chris Lattner60d410d2010-12-14 08:01:53 +00001419 if (!IfCond ||
1420 // Don't bother if the branch will be constant folded trivially.
1421 isa<ConstantInt>(IfCond))
1422 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001423
Chris Lattner822a8792006-11-18 19:19:36 +00001424 // Okay, we found that we can merge this two-entry phi node into a select.
1425 // Doing so would require us to fold *all* two entry phi nodes in this block.
1426 // At some point this becomes non-profitable (particularly if the target
1427 // doesn't support cmov's). Only do this transformation if there are two or
1428 // fewer PHI nodes in this block.
1429 unsigned NumPhis = 0;
1430 for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I); ++NumPhis, ++I)
1431 if (NumPhis > 2)
1432 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001433
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001434 // Loop over the PHI's seeing if we can promote them all to select
1435 // instructions. While we are at it, keep track of the instructions
1436 // that need to be moved to the dominating block.
Chris Lattner44da7ca2010-12-14 07:41:39 +00001437 SmallPtrSet<Instruction*, 4> AggressiveInsts;
Peter Collingbourne57808b32011-04-29 18:47:38 +00001438 unsigned MaxCostVal0 = PHINodeFoldingThreshold,
1439 MaxCostVal1 = PHINodeFoldingThreshold;
Andrew Trick6b014382012-08-29 21:46:36 +00001440
Chris Lattner3aff13b2010-12-14 08:46:09 +00001441 for (BasicBlock::iterator II = BB->begin(); isa<PHINode>(II);) {
1442 PHINode *PN = cast<PHINode>(II++);
Chris Lattner07ff3532010-12-14 07:20:29 +00001443 if (Value *V = SimplifyInstruction(PN, TD)) {
1444 PN->replaceAllUsesWith(V);
Chris Lattner3aff13b2010-12-14 08:46:09 +00001445 PN->eraseFromParent();
Chris Lattner07ff3532010-12-14 07:20:29 +00001446 continue;
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001447 }
Andrew Trick6b014382012-08-29 21:46:36 +00001448
Peter Collingbournef15907f2011-04-29 18:47:31 +00001449 if (!DominatesMergePoint(PN->getIncomingValue(0), BB, &AggressiveInsts,
1450 MaxCostVal0) ||
1451 !DominatesMergePoint(PN->getIncomingValue(1), BB, &AggressiveInsts,
1452 MaxCostVal1))
Chris Lattner07ff3532010-12-14 07:20:29 +00001453 return false;
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001454 }
Andrew Trick6b014382012-08-29 21:46:36 +00001455
Sylvestre Ledruc8e41c52012-07-23 08:51:15 +00001456 // If we folded the first phi, PN dangles at this point. Refresh it. If
Chris Lattner44da7ca2010-12-14 07:41:39 +00001457 // we ran out of PHIs then we simplified them all.
1458 PN = dyn_cast<PHINode>(BB->begin());
1459 if (PN == 0) return true;
Andrew Trick6b014382012-08-29 21:46:36 +00001460
Chris Lattner3aff13b2010-12-14 08:46:09 +00001461 // Don't fold i1 branches on PHIs which contain binary operators. These can
1462 // often be turned into switches and other things.
1463 if (PN->getType()->isIntegerTy(1) &&
1464 (isa<BinaryOperator>(PN->getIncomingValue(0)) ||
1465 isa<BinaryOperator>(PN->getIncomingValue(1)) ||
1466 isa<BinaryOperator>(IfCond)))
1467 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001468
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001469 // If we all PHI nodes are promotable, check to make sure that all
1470 // instructions in the predecessor blocks can be promoted as well. If
1471 // not, we won't be able to get rid of the control flow, so it's not
1472 // worth promoting to select instructions.
Chris Lattner44da7ca2010-12-14 07:41:39 +00001473 BasicBlock *DomBlock = 0;
1474 BasicBlock *IfBlock1 = PN->getIncomingBlock(0);
1475 BasicBlock *IfBlock2 = PN->getIncomingBlock(1);
1476 if (cast<BranchInst>(IfBlock1->getTerminator())->isConditional()) {
1477 IfBlock1 = 0;
1478 } else {
1479 DomBlock = *pred_begin(IfBlock1);
1480 for (BasicBlock::iterator I = IfBlock1->begin();!isa<TerminatorInst>(I);++I)
Devang Patel383d7ed2009-02-03 22:12:02 +00001481 if (!AggressiveInsts.count(I) && !isa<DbgInfoIntrinsic>(I)) {
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001482 // This is not an aggressive instruction that we can promote.
1483 // Because of this, we won't be able to get rid of the control
1484 // flow, so the xform is not worth it.
1485 return false;
1486 }
1487 }
Andrew Trick6b014382012-08-29 21:46:36 +00001488
Chris Lattner44da7ca2010-12-14 07:41:39 +00001489 if (cast<BranchInst>(IfBlock2->getTerminator())->isConditional()) {
1490 IfBlock2 = 0;
1491 } else {
1492 DomBlock = *pred_begin(IfBlock2);
1493 for (BasicBlock::iterator I = IfBlock2->begin();!isa<TerminatorInst>(I);++I)
Devang Patel383d7ed2009-02-03 22:12:02 +00001494 if (!AggressiveInsts.count(I) && !isa<DbgInfoIntrinsic>(I)) {
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001495 // This is not an aggressive instruction that we can promote.
1496 // Because of this, we won't be able to get rid of the control
1497 // flow, so the xform is not worth it.
1498 return false;
1499 }
1500 }
Andrew Trick6b014382012-08-29 21:46:36 +00001501
Chris Lattnere0b18e52010-12-14 07:23:10 +00001502 DEBUG(dbgs() << "FOUND IF CONDITION! " << *IfCond << " T: "
Chris Lattner44da7ca2010-12-14 07:41:39 +00001503 << IfTrue->getName() << " F: " << IfFalse->getName() << "\n");
Andrew Trick6b014382012-08-29 21:46:36 +00001504
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001505 // If we can still promote the PHI nodes after this gauntlet of tests,
1506 // do all of the PHI's now.
Chris Lattner3aff13b2010-12-14 08:46:09 +00001507 Instruction *InsertPt = DomBlock->getTerminator();
Devang Pateld3a17882011-05-19 20:52:46 +00001508 IRBuilder<true, NoFolder> Builder(InsertPt);
Andrew Trick6b014382012-08-29 21:46:36 +00001509
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001510 // Move all 'aggressive' instructions, which are defined in the
1511 // conditional parts of the if's up to the dominating block.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001512 if (IfBlock1)
Chris Lattner3aff13b2010-12-14 08:46:09 +00001513 DomBlock->getInstList().splice(InsertPt,
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001514 IfBlock1->getInstList(), IfBlock1->begin(),
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001515 IfBlock1->getTerminator());
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001516 if (IfBlock2)
Chris Lattner3aff13b2010-12-14 08:46:09 +00001517 DomBlock->getInstList().splice(InsertPt,
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001518 IfBlock2->getInstList(), IfBlock2->begin(),
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001519 IfBlock2->getTerminator());
Andrew Trick6b014382012-08-29 21:46:36 +00001520
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001521 while (PHINode *PN = dyn_cast<PHINode>(BB->begin())) {
1522 // Change the PHI node into a select instruction.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001523 Value *TrueVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfFalse);
1524 Value *FalseVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfTrue);
Andrew Trick6b014382012-08-29 21:46:36 +00001525
1526 SelectInst *NV =
Devang Patelf60364d2011-05-18 18:16:44 +00001527 cast<SelectInst>(Builder.CreateSelect(IfCond, TrueVal, FalseVal, ""));
Chris Lattner86cc4232007-02-11 01:37:51 +00001528 PN->replaceAllUsesWith(NV);
1529 NV->takeName(PN);
Chris Lattner302ba6f2010-12-14 06:17:25 +00001530 PN->eraseFromParent();
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001531 }
Andrew Trick6b014382012-08-29 21:46:36 +00001532
Chris Lattner60d410d2010-12-14 08:01:53 +00001533 // At this point, IfBlock1 and IfBlock2 are both empty, so our if statement
1534 // has been flattened. Change DomBlock to jump directly to our new block to
1535 // avoid other simplifycfg's kicking in on the diamond.
1536 TerminatorInst *OldTI = DomBlock->getTerminator();
Devang Patelf60364d2011-05-18 18:16:44 +00001537 Builder.SetInsertPoint(OldTI);
1538 Builder.CreateBr(BB);
Chris Lattner60d410d2010-12-14 08:01:53 +00001539 OldTI->eraseFromParent();
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001540 return true;
1541}
Chris Lattnereaba3a12005-09-19 23:49:37 +00001542
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001543/// SimplifyCondBranchToTwoReturns - If we found a conditional branch that goes
1544/// to two returning blocks, try to merge them together into one return,
1545/// introducing a select if the return values disagree.
Andrew Trick6b014382012-08-29 21:46:36 +00001546static bool SimplifyCondBranchToTwoReturns(BranchInst *BI,
Devang Patel176ec402011-05-18 21:33:11 +00001547 IRBuilder<> &Builder) {
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001548 assert(BI->isConditional() && "Must be a conditional branch");
1549 BasicBlock *TrueSucc = BI->getSuccessor(0);
1550 BasicBlock *FalseSucc = BI->getSuccessor(1);
1551 ReturnInst *TrueRet = cast<ReturnInst>(TrueSucc->getTerminator());
1552 ReturnInst *FalseRet = cast<ReturnInst>(FalseSucc->getTerminator());
Andrew Trick6b014382012-08-29 21:46:36 +00001553
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001554 // Check to ensure both blocks are empty (just a return) or optionally empty
1555 // with PHI nodes. If there are other instructions, merging would cause extra
1556 // computation on one path or the other.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001557 if (!TrueSucc->getFirstNonPHIOrDbg()->isTerminator())
Devang Patel2cc86a12009-02-05 00:30:42 +00001558 return false;
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001559 if (!FalseSucc->getFirstNonPHIOrDbg()->isTerminator())
Devang Patel2cc86a12009-02-05 00:30:42 +00001560 return false;
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001561
Devang Patel176ec402011-05-18 21:33:11 +00001562 Builder.SetInsertPoint(BI);
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001563 // Okay, we found a branch that is going to two return nodes. If
1564 // there is no return value for this function, just change the
1565 // branch into a return.
1566 if (FalseRet->getNumOperands() == 0) {
1567 TrueSucc->removePredecessor(BI->getParent());
1568 FalseSucc->removePredecessor(BI->getParent());
Devang Patel176ec402011-05-18 21:33:11 +00001569 Builder.CreateRetVoid();
Eli Friedman080efb82008-12-16 20:54:32 +00001570 EraseTerminatorInstAndDCECond(BI);
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001571 return true;
1572 }
Andrew Trick6b014382012-08-29 21:46:36 +00001573
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001574 // Otherwise, figure out what the true and false return values are
1575 // so we can insert a new select instruction.
1576 Value *TrueValue = TrueRet->getReturnValue();
1577 Value *FalseValue = FalseRet->getReturnValue();
Andrew Trick6b014382012-08-29 21:46:36 +00001578
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001579 // Unwrap any PHI nodes in the return blocks.
1580 if (PHINode *TVPN = dyn_cast_or_null<PHINode>(TrueValue))
1581 if (TVPN->getParent() == TrueSucc)
1582 TrueValue = TVPN->getIncomingValueForBlock(BI->getParent());
1583 if (PHINode *FVPN = dyn_cast_or_null<PHINode>(FalseValue))
1584 if (FVPN->getParent() == FalseSucc)
1585 FalseValue = FVPN->getIncomingValueForBlock(BI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00001586
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001587 // In order for this transformation to be safe, we must be able to
1588 // unconditionally execute both operands to the return. This is
1589 // normally the case, but we could have a potentially-trapping
1590 // constant expression that prevents this transformation from being
1591 // safe.
1592 if (ConstantExpr *TCV = dyn_cast_or_null<ConstantExpr>(TrueValue))
1593 if (TCV->canTrap())
1594 return false;
1595 if (ConstantExpr *FCV = dyn_cast_or_null<ConstantExpr>(FalseValue))
1596 if (FCV->canTrap())
1597 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001598
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001599 // Okay, we collected all the mapped values and checked them for sanity, and
1600 // defined to really do this transformation. First, update the CFG.
1601 TrueSucc->removePredecessor(BI->getParent());
1602 FalseSucc->removePredecessor(BI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00001603
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001604 // Insert select instructions where needed.
1605 Value *BrCond = BI->getCondition();
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001606 if (TrueValue) {
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001607 // Insert a select if the results differ.
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001608 if (TrueValue == FalseValue || isa<UndefValue>(FalseValue)) {
1609 } else if (isa<UndefValue>(TrueValue)) {
1610 TrueValue = FalseValue;
1611 } else {
Devang Patel176ec402011-05-18 21:33:11 +00001612 TrueValue = Builder.CreateSelect(BrCond, TrueValue,
1613 FalseValue, "retval");
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001614 }
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001615 }
1616
Andrew Trick6b014382012-08-29 21:46:36 +00001617 Value *RI = !TrueValue ?
Devang Patel176ec402011-05-18 21:33:11 +00001618 Builder.CreateRetVoid() : Builder.CreateRet(TrueValue);
1619
Daniel Dunbare317bcc2009-08-23 10:29:55 +00001620 (void) RI;
Andrew Trick6b014382012-08-29 21:46:36 +00001621
David Greene89d6fd32010-01-05 01:26:52 +00001622 DEBUG(dbgs() << "\nCHANGING BRANCH TO TWO RETURNS INTO SELECT:"
Chris Lattnerbdff5482009-08-23 04:37:46 +00001623 << "\n " << *BI << "NewRet = " << *RI
1624 << "TRUEBLOCK: " << *TrueSucc << "FALSEBLOCK: "<< *FalseSucc);
Andrew Trick6b014382012-08-29 21:46:36 +00001625
Eli Friedman080efb82008-12-16 20:54:32 +00001626 EraseTerminatorInstAndDCECond(BI);
1627
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001628 return true;
1629}
1630
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001631/// ExtractBranchMetadata - Given a conditional BranchInstruction, retrieve the
1632/// probabilities of the branch taking each edge. Fills in the two APInt
1633/// parameters and return true, or returns false if no or invalid metadata was
1634/// found.
1635static bool ExtractBranchMetadata(BranchInst *BI,
1636 APInt &ProbTrue, APInt &ProbFalse) {
1637 assert(BI->isConditional() &&
1638 "Looking for probabilities on unconditional branch?");
1639 MDNode *ProfileData = BI->getMetadata(LLVMContext::MD_prof);
Nick Lewycky91968482011-12-27 18:27:22 +00001640 if (!ProfileData || ProfileData->getNumOperands() != 3) return false;
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001641 ConstantInt *CITrue = dyn_cast<ConstantInt>(ProfileData->getOperand(1));
1642 ConstantInt *CIFalse = dyn_cast<ConstantInt>(ProfileData->getOperand(2));
Nick Lewycky91968482011-12-27 18:27:22 +00001643 if (!CITrue || !CIFalse) return false;
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001644 ProbTrue = CITrue->getValue();
1645 ProbFalse = CIFalse->getValue();
1646 assert(ProbTrue.getBitWidth() == 32 && ProbFalse.getBitWidth() == 32 &&
1647 "Branch probability metadata must be 32-bit integers");
1648 return true;
1649}
1650
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00001651/// MultiplyAndLosePrecision - Multiplies A and B, then returns the result. In
1652/// the event of overflow, logically-shifts all four inputs right until the
1653/// multiply fits.
1654static APInt MultiplyAndLosePrecision(APInt &A, APInt &B, APInt &C, APInt &D,
1655 unsigned &BitsLost) {
1656 BitsLost = 0;
1657 bool Overflow = false;
1658 APInt Result = A.umul_ov(B, Overflow);
1659 if (Overflow) {
1660 APInt MaxB = APInt::getMaxValue(A.getBitWidth()).udiv(A);
1661 do {
1662 B = B.lshr(1);
1663 ++BitsLost;
1664 } while (B.ugt(MaxB));
1665 A = A.lshr(BitsLost);
1666 C = C.lshr(BitsLost);
1667 D = D.lshr(BitsLost);
1668 Result = A * B;
1669 }
1670 return Result;
1671}
1672
Manman Renee28e0f2012-06-13 05:43:29 +00001673/// checkCSEInPredecessor - Return true if the given instruction is available
1674/// in its predecessor block. If yes, the instruction will be removed.
1675///
Benjamin Kramer23d36222012-07-13 13:25:15 +00001676static bool checkCSEInPredecessor(Instruction *Inst, BasicBlock *PB) {
Manman Renee28e0f2012-06-13 05:43:29 +00001677 if (!isa<BinaryOperator>(Inst) && !isa<CmpInst>(Inst))
1678 return false;
1679 for (BasicBlock::iterator I = PB->begin(), E = PB->end(); I != E; I++) {
1680 Instruction *PBI = &*I;
1681 // Check whether Inst and PBI generate the same value.
1682 if (Inst->isIdenticalTo(PBI)) {
1683 Inst->replaceAllUsesWith(PBI);
1684 Inst->eraseFromParent();
1685 return true;
1686 }
1687 }
1688 return false;
1689}
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00001690
Chris Lattnerc8fbc342011-04-11 23:24:57 +00001691/// FoldBranchToCommonDest - If this basic block is simple enough, and if a
1692/// predecessor branches to us and one of our successors, fold the block into
1693/// the predecessor and use logical operations to pick the right destination.
Dan Gohman4b35f832009-06-27 21:30:38 +00001694bool llvm::FoldBranchToCommonDest(BranchInst *BI) {
Chris Lattner093a4382008-07-13 22:23:11 +00001695 BasicBlock *BB = BI->getParent();
Devang Pateld3a17882011-05-19 20:52:46 +00001696
Manman Renee28e0f2012-06-13 05:43:29 +00001697 Instruction *Cond = 0;
1698 if (BI->isConditional())
1699 Cond = dyn_cast<Instruction>(BI->getCondition());
1700 else {
1701 // For unconditional branch, check for a simple CFG pattern, where
1702 // BB has a single predecessor and BB's successor is also its predecessor's
1703 // successor. If such pattern exisits, check for CSE between BB and its
1704 // predecessor.
1705 if (BasicBlock *PB = BB->getSinglePredecessor())
1706 if (BranchInst *PBI = dyn_cast<BranchInst>(PB->getTerminator()))
1707 if (PBI->isConditional() &&
1708 (BI->getSuccessor(0) == PBI->getSuccessor(0) ||
1709 BI->getSuccessor(0) == PBI->getSuccessor(1))) {
1710 for (BasicBlock::iterator I = BB->begin(), E = BB->end();
1711 I != E; ) {
1712 Instruction *Curr = I++;
1713 if (isa<CmpInst>(Curr)) {
1714 Cond = Curr;
1715 break;
1716 }
1717 // Quit if we can't remove this instruction.
1718 if (!checkCSEInPredecessor(Curr, PB))
1719 return false;
1720 }
1721 }
1722
1723 if (Cond == 0)
1724 return false;
1725 }
Andrew Trick6b014382012-08-29 21:46:36 +00001726
Owen Andersone84178a2010-07-14 19:52:16 +00001727 if (Cond == 0 || (!isa<CmpInst>(Cond) && !isa<BinaryOperator>(Cond)) ||
1728 Cond->getParent() != BB || !Cond->hasOneUse())
1729 return false;
Devang Pateld4181942011-04-06 22:37:20 +00001730
Chris Lattner1347e872008-07-13 21:12:01 +00001731 // Only allow this if the condition is a simple instruction that can be
1732 // executed unconditionally. It must be in the same block as the branch, and
1733 // must be at the front of the block.
Devang Pateld0a203d2009-02-04 21:39:48 +00001734 BasicBlock::iterator FrontIt = BB->front();
Chris Lattner3c6e7462011-04-14 02:44:53 +00001735
Devang Pateld0a203d2009-02-04 21:39:48 +00001736 // Ignore dbg intrinsics.
Chris Lattner3c6e7462011-04-14 02:44:53 +00001737 while (isa<DbgInfoIntrinsic>(FrontIt)) ++FrontIt;
Nick Lewycky9d523102011-12-26 20:37:40 +00001738
Owen Andersone84178a2010-07-14 19:52:16 +00001739 // Allow a single instruction to be hoisted in addition to the compare
1740 // that feeds the branch. We later ensure that any values that _it_ uses
1741 // were also live in the predecessor, so that we don't unnecessarily create
1742 // register pressure or inhibit out-of-order execution.
1743 Instruction *BonusInst = 0;
1744 if (&*FrontIt != Cond &&
Owen Anderson2722dfa2010-07-15 16:38:22 +00001745 FrontIt->hasOneUse() && *FrontIt->use_begin() == Cond &&
Dan Gohmanf0426602011-12-14 23:49:11 +00001746 isSafeToSpeculativelyExecute(FrontIt)) {
Owen Andersone84178a2010-07-14 19:52:16 +00001747 BonusInst = &*FrontIt;
1748 ++FrontIt;
Andrew Trick6b014382012-08-29 21:46:36 +00001749
Chris Lattner3c6e7462011-04-14 02:44:53 +00001750 // Ignore dbg intrinsics.
1751 while (isa<DbgInfoIntrinsic>(FrontIt)) ++FrontIt;
Devang Patel60d490c2011-04-07 23:11:25 +00001752 }
1753
Owen Andersone84178a2010-07-14 19:52:16 +00001754 // Only a single bonus inst is allowed.
1755 if (&*FrontIt != Cond)
1756 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001757
Chris Lattner1347e872008-07-13 21:12:01 +00001758 // Make sure the instruction after the condition is the cond branch.
1759 BasicBlock::iterator CondIt = Cond; ++CondIt;
Chris Lattner3c6e7462011-04-14 02:44:53 +00001760
Devang Pateld0a203d2009-02-04 21:39:48 +00001761 // Ingore dbg intrinsics.
Chris Lattner3c6e7462011-04-14 02:44:53 +00001762 while (isa<DbgInfoIntrinsic>(CondIt)) ++CondIt;
Andrew Trick6b014382012-08-29 21:46:36 +00001763
Chris Lattner3c6e7462011-04-14 02:44:53 +00001764 if (&*CondIt != BI)
Chris Lattner1347e872008-07-13 21:12:01 +00001765 return false;
Chris Lattner6ff645b2009-01-19 23:03:13 +00001766
1767 // Cond is known to be a compare or binary operator. Check to make sure that
1768 // neither operand is a potentially-trapping constant expression.
1769 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(0)))
1770 if (CE->canTrap())
1771 return false;
1772 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(1)))
1773 if (CE->canTrap())
1774 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001775
Chris Lattner1347e872008-07-13 21:12:01 +00001776 // Finally, don't infinitely unroll conditional loops.
1777 BasicBlock *TrueDest = BI->getSuccessor(0);
Manman Renee28e0f2012-06-13 05:43:29 +00001778 BasicBlock *FalseDest = (BI->isConditional()) ? BI->getSuccessor(1) : 0;
Chris Lattner1347e872008-07-13 21:12:01 +00001779 if (TrueDest == BB || FalseDest == BB)
1780 return false;
Devang Pateld4181942011-04-06 22:37:20 +00001781
Chris Lattner1347e872008-07-13 21:12:01 +00001782 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
1783 BasicBlock *PredBlock = *PI;
1784 BranchInst *PBI = dyn_cast<BranchInst>(PredBlock->getTerminator());
Andrew Trick6b014382012-08-29 21:46:36 +00001785
Chris Lattner093a4382008-07-13 22:23:11 +00001786 // Check that we have two conditional branches. If there is a PHI node in
1787 // the common successor, verify that the same value flows in from both
1788 // blocks.
Manman Renee28e0f2012-06-13 05:43:29 +00001789 SmallVector<PHINode*, 4> PHIs;
1790 if (PBI == 0 || PBI->isUnconditional() ||
Andrew Trick6b014382012-08-29 21:46:36 +00001791 (BI->isConditional() &&
Manman Renee28e0f2012-06-13 05:43:29 +00001792 !SafeToMergeTerminators(BI, PBI)) ||
1793 (!BI->isConditional() &&
1794 !isProfitableToFoldUnconditional(BI, PBI, Cond, PHIs)))
Chris Lattner1347e872008-07-13 21:12:01 +00001795 continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001796
Chris Lattner3c6e7462011-04-14 02:44:53 +00001797 // Determine if the two branches share a common destination.
1798 Instruction::BinaryOps Opc;
1799 bool InvertPredCond = false;
Andrew Trick6b014382012-08-29 21:46:36 +00001800
Manman Renee28e0f2012-06-13 05:43:29 +00001801 if (BI->isConditional()) {
1802 if (PBI->getSuccessor(0) == TrueDest)
1803 Opc = Instruction::Or;
1804 else if (PBI->getSuccessor(1) == FalseDest)
1805 Opc = Instruction::And;
1806 else if (PBI->getSuccessor(0) == FalseDest)
1807 Opc = Instruction::And, InvertPredCond = true;
1808 else if (PBI->getSuccessor(1) == TrueDest)
1809 Opc = Instruction::Or, InvertPredCond = true;
1810 else
1811 continue;
1812 } else {
1813 if (PBI->getSuccessor(0) != TrueDest && PBI->getSuccessor(1) != TrueDest)
1814 continue;
1815 }
Chris Lattner3c6e7462011-04-14 02:44:53 +00001816
Owen Andersone84178a2010-07-14 19:52:16 +00001817 // Ensure that any values used in the bonus instruction are also used
1818 // by the terminator of the predecessor. This means that those values
Andrew Trick6b014382012-08-29 21:46:36 +00001819 // must already have been resolved, so we won't be inhibiting the
Owen Andersone84178a2010-07-14 19:52:16 +00001820 // out-of-order core by speculating them earlier.
1821 if (BonusInst) {
1822 // Collect the values used by the bonus inst
1823 SmallPtrSet<Value*, 4> UsedValues;
1824 for (Instruction::op_iterator OI = BonusInst->op_begin(),
1825 OE = BonusInst->op_end(); OI != OE; ++OI) {
Nick Lewycky9d523102011-12-26 20:37:40 +00001826 Value *V = *OI;
Owen Andersone84178a2010-07-14 19:52:16 +00001827 if (!isa<Constant>(V))
1828 UsedValues.insert(V);
1829 }
1830
1831 SmallVector<std::pair<Value*, unsigned>, 4> Worklist;
1832 Worklist.push_back(std::make_pair(PBI->getOperand(0), 0));
Andrew Trick6b014382012-08-29 21:46:36 +00001833
Owen Andersone84178a2010-07-14 19:52:16 +00001834 // Walk up to four levels back up the use-def chain of the predecessor's
1835 // terminator to see if all those values were used. The choice of four
1836 // levels is arbitrary, to provide a compile-time-cost bound.
1837 while (!Worklist.empty()) {
1838 std::pair<Value*, unsigned> Pair = Worklist.back();
1839 Worklist.pop_back();
Andrew Trick6b014382012-08-29 21:46:36 +00001840
Owen Andersone84178a2010-07-14 19:52:16 +00001841 if (Pair.second >= 4) continue;
1842 UsedValues.erase(Pair.first);
1843 if (UsedValues.empty()) break;
Andrew Trick6b014382012-08-29 21:46:36 +00001844
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00001845 if (Instruction *I = dyn_cast<Instruction>(Pair.first)) {
Owen Andersone84178a2010-07-14 19:52:16 +00001846 for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
1847 OI != OE; ++OI)
1848 Worklist.push_back(std::make_pair(OI->get(), Pair.second+1));
Andrew Trick6b014382012-08-29 21:46:36 +00001849 }
Owen Andersone84178a2010-07-14 19:52:16 +00001850 }
Andrew Trick6b014382012-08-29 21:46:36 +00001851
Owen Andersone84178a2010-07-14 19:52:16 +00001852 if (!UsedValues.empty()) return false;
1853 }
Chris Lattner36989092008-07-13 21:20:19 +00001854
David Greene89d6fd32010-01-05 01:26:52 +00001855 DEBUG(dbgs() << "FOLDING BRANCH TO COMMON DEST:\n" << *PBI << *BB);
Andrew Trick6b014382012-08-29 21:46:36 +00001856 IRBuilder<> Builder(PBI);
Devang Pateld3a17882011-05-19 20:52:46 +00001857
Chris Lattner36989092008-07-13 21:20:19 +00001858 // If we need to invert the condition in the pred block to match, do so now.
1859 if (InvertPredCond) {
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00001860 Value *NewCond = PBI->getCondition();
Andrew Trick6b014382012-08-29 21:46:36 +00001861
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00001862 if (NewCond->hasOneUse() && isa<CmpInst>(NewCond)) {
1863 CmpInst *CI = cast<CmpInst>(NewCond);
1864 CI->setPredicate(CI->getInversePredicate());
1865 } else {
Andrew Trick6b014382012-08-29 21:46:36 +00001866 NewCond = Builder.CreateNot(NewCond,
Devang Pateld3a17882011-05-19 20:52:46 +00001867 PBI->getCondition()->getName()+".not");
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00001868 }
Andrew Trick6b014382012-08-29 21:46:36 +00001869
Chris Lattner1347e872008-07-13 21:12:01 +00001870 PBI->setCondition(NewCond);
Nick Lewyckyc9a1aed2011-12-26 20:54:14 +00001871 PBI->swapSuccessors();
Chris Lattner1347e872008-07-13 21:12:01 +00001872 }
Andrew Trick6b014382012-08-29 21:46:36 +00001873
Owen Andersone84178a2010-07-14 19:52:16 +00001874 // If we have a bonus inst, clone it into the predecessor block.
1875 Instruction *NewBonus = 0;
1876 if (BonusInst) {
1877 NewBonus = BonusInst->clone();
1878 PredBlock->getInstList().insert(PBI, NewBonus);
1879 NewBonus->takeName(BonusInst);
1880 BonusInst->setName(BonusInst->getName()+".old");
1881 }
Andrew Trick6b014382012-08-29 21:46:36 +00001882
Chris Lattner36989092008-07-13 21:20:19 +00001883 // Clone Cond into the predecessor basic block, and or/and the
1884 // two conditions together.
Nick Lewycky67760642009-09-27 07:38:41 +00001885 Instruction *New = Cond->clone();
Owen Andersone84178a2010-07-14 19:52:16 +00001886 if (BonusInst) New->replaceUsesOfWith(BonusInst, NewBonus);
Chris Lattner36989092008-07-13 21:20:19 +00001887 PredBlock->getInstList().insert(PBI, New);
1888 New->takeName(Cond);
1889 Cond->setName(New->getName()+".old");
Andrew Trick6b014382012-08-29 21:46:36 +00001890
Manman Renee28e0f2012-06-13 05:43:29 +00001891 if (BI->isConditional()) {
Andrew Trick6b014382012-08-29 21:46:36 +00001892 Instruction *NewCond =
Manman Renee28e0f2012-06-13 05:43:29 +00001893 cast<Instruction>(Builder.CreateBinOp(Opc, PBI->getCondition(),
Devang Pateld3a17882011-05-19 20:52:46 +00001894 New, "or.cond"));
Manman Renee28e0f2012-06-13 05:43:29 +00001895 PBI->setCondition(NewCond);
1896
1897 if (PBI->getSuccessor(0) == BB) {
1898 AddPredecessorToBlock(TrueDest, PredBlock, BB);
1899 PBI->setSuccessor(0, TrueDest);
1900 }
1901 if (PBI->getSuccessor(1) == BB) {
1902 AddPredecessorToBlock(FalseDest, PredBlock, BB);
1903 PBI->setSuccessor(1, FalseDest);
1904 }
1905 } else {
1906 // Update PHI nodes in the common successors.
1907 for (unsigned i = 0, e = PHIs.size(); i != e; ++i) {
Nick Lewyckyedb58422012-06-24 10:15:42 +00001908 ConstantInt *PBI_C = cast<ConstantInt>(
Manman Renee28e0f2012-06-13 05:43:29 +00001909 PHIs[i]->getIncomingValueForBlock(PBI->getParent()));
1910 assert(PBI_C->getType()->isIntegerTy(1));
1911 Instruction *MergedCond = 0;
1912 if (PBI->getSuccessor(0) == TrueDest) {
1913 // Create (PBI_Cond and PBI_C) or (!PBI_Cond and BI_Value)
1914 // PBI_C is true: PBI_Cond or (!PBI_Cond and BI_Value)
1915 // is false: !PBI_Cond and BI_Value
1916 Instruction *NotCond =
1917 cast<Instruction>(Builder.CreateNot(PBI->getCondition(),
1918 "not.cond"));
1919 MergedCond =
1920 cast<Instruction>(Builder.CreateBinOp(Instruction::And,
1921 NotCond, New,
1922 "and.cond"));
1923 if (PBI_C->isOne())
1924 MergedCond =
1925 cast<Instruction>(Builder.CreateBinOp(Instruction::Or,
1926 PBI->getCondition(), MergedCond,
1927 "or.cond"));
1928 } else {
1929 // Create (PBI_Cond and BI_Value) or (!PBI_Cond and PBI_C)
1930 // PBI_C is true: (PBI_Cond and BI_Value) or (!PBI_Cond)
1931 // is false: PBI_Cond and BI_Value
Andrew Trick6b014382012-08-29 21:46:36 +00001932 MergedCond =
Manman Renee28e0f2012-06-13 05:43:29 +00001933 cast<Instruction>(Builder.CreateBinOp(Instruction::And,
1934 PBI->getCondition(), New,
1935 "and.cond"));
1936 if (PBI_C->isOne()) {
1937 Instruction *NotCond =
1938 cast<Instruction>(Builder.CreateNot(PBI->getCondition(),
1939 "not.cond"));
Andrew Trick6b014382012-08-29 21:46:36 +00001940 MergedCond =
Manman Renee28e0f2012-06-13 05:43:29 +00001941 cast<Instruction>(Builder.CreateBinOp(Instruction::Or,
1942 NotCond, MergedCond,
1943 "or.cond"));
1944 }
1945 }
1946 // Update PHI Node.
1947 PHIs[i]->setIncomingValue(PHIs[i]->getBasicBlockIndex(PBI->getParent()),
1948 MergedCond);
1949 }
1950 // Change PBI from Conditional to Unconditional.
1951 BranchInst *New_PBI = BranchInst::Create(TrueDest, PBI);
1952 EraseTerminatorInstAndDCECond(PBI);
1953 PBI = New_PBI;
Chris Lattner36989092008-07-13 21:20:19 +00001954 }
Devang Pateld4181942011-04-06 22:37:20 +00001955
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001956 // TODO: If BB is reachable from all paths through PredBlock, then we
1957 // could replace PBI's branch probabilities with BI's.
1958
1959 // Merge probability data into PredBlock's branch.
1960 APInt A, B, C, D;
Manman Renee28e0f2012-06-13 05:43:29 +00001961 if (PBI->isConditional() && BI->isConditional() &&
1962 ExtractBranchMetadata(PBI, C, D) && ExtractBranchMetadata(BI, A, B)) {
Nick Lewycky8da7ddf2011-12-28 06:57:32 +00001963 // Given IR which does:
1964 // bbA:
1965 // br i1 %x, label %bbB, label %bbC
1966 // bbB:
1967 // br i1 %y, label %bbD, label %bbC
1968 // Let's call the probability that we take the edge from %bbA to %bbB
1969 // 'a', from %bbA to %bbC, 'b', from %bbB to %bbD 'c' and from %bbB to
1970 // %bbC probability 'd'.
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001971 //
Nick Lewycky8da7ddf2011-12-28 06:57:32 +00001972 // We transform the IR into:
1973 // bbA:
1974 // br i1 %z, label %bbD, label %bbC
1975 // where the probability of going to %bbD is (a*c) and going to bbC is
1976 // (b+a*d).
1977 //
1978 // Probabilities aren't stored as ratios directly. Using branch weights,
1979 // we get:
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001980 // (a*c)% = A*C, (b+(a*d))% = A*D+B*C+B*D.
1981
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00001982 // In the event of overflow, we want to drop the LSB of the input
1983 // probabilities.
1984 unsigned BitsLost;
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001985
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00001986 // Ignore overflow result on ProbTrue.
1987 APInt ProbTrue = MultiplyAndLosePrecision(A, C, B, D, BitsLost);
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001988
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00001989 APInt Tmp1 = MultiplyAndLosePrecision(B, D, A, C, BitsLost);
1990 if (BitsLost) {
1991 ProbTrue = ProbTrue.lshr(BitsLost*2);
1992 }
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001993
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00001994 APInt Tmp2 = MultiplyAndLosePrecision(A, D, C, B, BitsLost);
1995 if (BitsLost) {
1996 ProbTrue = ProbTrue.lshr(BitsLost*2);
1997 Tmp1 = Tmp1.lshr(BitsLost*2);
1998 }
1999
2000 APInt Tmp3 = MultiplyAndLosePrecision(B, C, A, D, BitsLost);
2001 if (BitsLost) {
2002 ProbTrue = ProbTrue.lshr(BitsLost*2);
2003 Tmp1 = Tmp1.lshr(BitsLost*2);
2004 Tmp2 = Tmp2.lshr(BitsLost*2);
2005 }
2006
2007 bool Overflow1 = false, Overflow2 = false;
2008 APInt Tmp4 = Tmp2.uadd_ov(Tmp3, Overflow1);
2009 APInt ProbFalse = Tmp4.uadd_ov(Tmp1, Overflow2);
2010
2011 if (Overflow1 || Overflow2) {
2012 ProbTrue = ProbTrue.lshr(1);
2013 Tmp1 = Tmp1.lshr(1);
2014 Tmp2 = Tmp2.lshr(1);
2015 Tmp3 = Tmp3.lshr(1);
2016 Tmp4 = Tmp2 + Tmp3;
2017 ProbFalse = Tmp4 + Tmp1;
2018 }
2019
2020 // The sum of branch weights must fit in 32-bits.
2021 if (ProbTrue.isNegative() && ProbFalse.isNegative()) {
2022 ProbTrue = ProbTrue.lshr(1);
2023 ProbFalse = ProbFalse.lshr(1);
2024 }
2025
2026 if (ProbTrue != ProbFalse) {
2027 // Normalize the result.
2028 APInt GCD = APIntOps::GreatestCommonDivisor(ProbTrue, ProbFalse);
2029 ProbTrue = ProbTrue.udiv(GCD);
2030 ProbFalse = ProbFalse.udiv(GCD);
2031
Benjamin Kramer937338c2012-05-26 13:59:43 +00002032 MDBuilder MDB(BI->getContext());
2033 MDNode *N = MDB.createBranchWeights(ProbTrue.getZExtValue(),
2034 ProbFalse.getZExtValue());
2035 PBI->setMetadata(LLVMContext::MD_prof, N);
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00002036 } else {
2037 PBI->setMetadata(LLVMContext::MD_prof, NULL);
Nick Lewycky06cc66f2011-12-27 04:31:52 +00002038 }
2039 } else {
2040 PBI->setMetadata(LLVMContext::MD_prof, NULL);
2041 }
2042
Chris Lattner3c6e7462011-04-14 02:44:53 +00002043 // Copy any debug value intrinsics into the end of PredBlock.
2044 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
2045 if (isa<DbgInfoIntrinsic>(*I))
2046 I->clone()->insertBefore(PBI);
Andrew Trick6b014382012-08-29 21:46:36 +00002047
Chris Lattner117f8cf2010-12-14 05:57:30 +00002048 return true;
Chris Lattner1347e872008-07-13 21:12:01 +00002049 }
2050 return false;
2051}
2052
Chris Lattner867661a2008-07-13 21:53:26 +00002053/// SimplifyCondBranchToCondBranch - If we have a conditional branch as a
2054/// predecessor of another block, this function tries to simplify it. We know
2055/// that PBI and BI are both conditional branches, and BI is in one of the
2056/// successor blocks of PBI - PBI branches to BI.
2057static bool SimplifyCondBranchToCondBranch(BranchInst *PBI, BranchInst *BI) {
2058 assert(PBI->isConditional() && BI->isConditional());
2059 BasicBlock *BB = BI->getParent();
Dan Gohman4ae51262009-08-12 16:23:25 +00002060
Chris Lattner867661a2008-07-13 21:53:26 +00002061 // If this block ends with a branch instruction, and if there is a
Andrew Trick6b014382012-08-29 21:46:36 +00002062 // predecessor that ends on a branch of the same condition, make
Chris Lattner867661a2008-07-13 21:53:26 +00002063 // this conditional branch redundant.
2064 if (PBI->getCondition() == BI->getCondition() &&
2065 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
2066 // Okay, the outcome of this conditional branch is statically
2067 // knowable. If this block had a single pred, handle specially.
2068 if (BB->getSinglePredecessor()) {
2069 // Turn this into a branch on constant.
2070 bool CondIsTrue = PBI->getSuccessor(0) == BB;
Andrew Trick6b014382012-08-29 21:46:36 +00002071 BI->setCondition(ConstantInt::get(Type::getInt1Ty(BB->getContext()),
Owen Anderson1d0be152009-08-13 21:58:54 +00002072 CondIsTrue));
Chris Lattner867661a2008-07-13 21:53:26 +00002073 return true; // Nuke the branch on constant.
2074 }
Andrew Trick6b014382012-08-29 21:46:36 +00002075
Chris Lattner867661a2008-07-13 21:53:26 +00002076 // Otherwise, if there are multiple predecessors, insert a PHI that merges
2077 // in the constant and simplify the block result. Subsequent passes of
2078 // simplifycfg will thread the block.
2079 if (BlockIsSimpleEnoughToThreadThrough(BB)) {
Jay Foadd8b4fb42011-03-30 11:19:20 +00002080 pred_iterator PB = pred_begin(BB), PE = pred_end(BB);
Owen Anderson1d0be152009-08-13 21:58:54 +00002081 PHINode *NewPN = PHINode::Create(Type::getInt1Ty(BB->getContext()),
Jay Foad3ecfc862011-03-30 11:28:46 +00002082 std::distance(PB, PE),
Chris Lattner867661a2008-07-13 21:53:26 +00002083 BI->getCondition()->getName() + ".pr",
2084 BB->begin());
Chris Lattnereb388af2008-07-13 21:55:46 +00002085 // Okay, we're going to insert the PHI node. Since PBI is not the only
2086 // predecessor, compute the PHI'd conditional value for all of the preds.
2087 // Any predecessor where the condition is not computable we keep symbolic.
Jay Foadd8b4fb42011-03-30 11:19:20 +00002088 for (pred_iterator PI = PB; PI != PE; ++PI) {
Gabor Greif62539832010-07-12 10:59:23 +00002089 BasicBlock *P = *PI;
2090 if ((PBI = dyn_cast<BranchInst>(P->getTerminator())) &&
Chris Lattner867661a2008-07-13 21:53:26 +00002091 PBI != BI && PBI->isConditional() &&
2092 PBI->getCondition() == BI->getCondition() &&
2093 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
2094 bool CondIsTrue = PBI->getSuccessor(0) == BB;
Andrew Trick6b014382012-08-29 21:46:36 +00002095 NewPN->addIncoming(ConstantInt::get(Type::getInt1Ty(BB->getContext()),
Gabor Greif62539832010-07-12 10:59:23 +00002096 CondIsTrue), P);
Chris Lattner867661a2008-07-13 21:53:26 +00002097 } else {
Gabor Greif62539832010-07-12 10:59:23 +00002098 NewPN->addIncoming(BI->getCondition(), P);
Chris Lattner867661a2008-07-13 21:53:26 +00002099 }
Gabor Greif62539832010-07-12 10:59:23 +00002100 }
Andrew Trick6b014382012-08-29 21:46:36 +00002101
Chris Lattner867661a2008-07-13 21:53:26 +00002102 BI->setCondition(NewPN);
Chris Lattner867661a2008-07-13 21:53:26 +00002103 return true;
2104 }
2105 }
Andrew Trick6b014382012-08-29 21:46:36 +00002106
Chris Lattner867661a2008-07-13 21:53:26 +00002107 // If this is a conditional branch in an empty block, and if any
2108 // predecessors is a conditional branch to one of our destinations,
2109 // fold the conditions into logical ops and one cond br.
Zhou Shenga8d57fe2009-02-26 06:56:37 +00002110 BasicBlock::iterator BBI = BB->begin();
2111 // Ignore dbg intrinsics.
2112 while (isa<DbgInfoIntrinsic>(BBI))
2113 ++BBI;
2114 if (&*BBI != BI)
Chris Lattnerb8245122008-07-13 22:04:41 +00002115 return false;
Chris Lattner63bf29b2009-01-20 01:15:41 +00002116
Andrew Trick6b014382012-08-29 21:46:36 +00002117
Chris Lattner63bf29b2009-01-20 01:15:41 +00002118 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(BI->getCondition()))
2119 if (CE->canTrap())
2120 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002121
Chris Lattnerb8245122008-07-13 22:04:41 +00002122 int PBIOp, BIOp;
2123 if (PBI->getSuccessor(0) == BI->getSuccessor(0))
2124 PBIOp = BIOp = 0;
2125 else if (PBI->getSuccessor(0) == BI->getSuccessor(1))
2126 PBIOp = 0, BIOp = 1;
2127 else if (PBI->getSuccessor(1) == BI->getSuccessor(0))
2128 PBIOp = 1, BIOp = 0;
2129 else if (PBI->getSuccessor(1) == BI->getSuccessor(1))
2130 PBIOp = BIOp = 1;
2131 else
2132 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002133
Chris Lattnerb8245122008-07-13 22:04:41 +00002134 // Check to make sure that the other destination of this branch
2135 // isn't BB itself. If so, this is an infinite loop that will
2136 // keep getting unwound.
2137 if (PBI->getSuccessor(PBIOp) == BB)
2138 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002139
2140 // Do not perform this transformation if it would require
Chris Lattnerb8245122008-07-13 22:04:41 +00002141 // insertion of a large number of select instructions. For targets
2142 // without predication/cmovs, this is a big pessimization.
2143 BasicBlock *CommonDest = PBI->getSuccessor(PBIOp);
Andrew Trick6b014382012-08-29 21:46:36 +00002144
Chris Lattnerb8245122008-07-13 22:04:41 +00002145 unsigned NumPhis = 0;
2146 for (BasicBlock::iterator II = CommonDest->begin();
2147 isa<PHINode>(II); ++II, ++NumPhis)
2148 if (NumPhis > 2) // Disable this xform.
2149 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002150
Chris Lattnerb8245122008-07-13 22:04:41 +00002151 // Finally, if everything is ok, fold the branches to logical ops.
2152 BasicBlock *OtherDest = BI->getSuccessor(BIOp ^ 1);
Andrew Trick6b014382012-08-29 21:46:36 +00002153
David Greene89d6fd32010-01-05 01:26:52 +00002154 DEBUG(dbgs() << "FOLDING BRs:" << *PBI->getParent()
Chris Lattnerbdff5482009-08-23 04:37:46 +00002155 << "AND: " << *BI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00002156
2157
Chris Lattner093a4382008-07-13 22:23:11 +00002158 // If OtherDest *is* BB, then BB is a basic block with a single conditional
2159 // branch in it, where one edge (OtherDest) goes back to itself but the other
2160 // exits. We don't *know* that the program avoids the infinite loop
2161 // (even though that seems likely). If we do this xform naively, we'll end up
2162 // recursively unpeeling the loop. Since we know that (after the xform is
2163 // done) that the block *is* infinite if reached, we just make it an obviously
2164 // infinite loop with no cond branch.
2165 if (OtherDest == BB) {
2166 // Insert it at the end of the function, because it's either code,
2167 // or it won't matter if it's hot. :)
Owen Anderson1d0be152009-08-13 21:58:54 +00002168 BasicBlock *InfLoopBlock = BasicBlock::Create(BB->getContext(),
2169 "infloop", BB->getParent());
Chris Lattner093a4382008-07-13 22:23:11 +00002170 BranchInst::Create(InfLoopBlock, InfLoopBlock);
2171 OtherDest = InfLoopBlock;
Andrew Trick6b014382012-08-29 21:46:36 +00002172 }
2173
David Greene89d6fd32010-01-05 01:26:52 +00002174 DEBUG(dbgs() << *PBI->getParent()->getParent());
Devang Pateld3a17882011-05-19 20:52:46 +00002175
Chris Lattnerb8245122008-07-13 22:04:41 +00002176 // BI may have other predecessors. Because of this, we leave
2177 // it alone, but modify PBI.
Andrew Trick6b014382012-08-29 21:46:36 +00002178
Chris Lattnerb8245122008-07-13 22:04:41 +00002179 // Make sure we get to CommonDest on True&True directions.
2180 Value *PBICond = PBI->getCondition();
Devang Pateld3a17882011-05-19 20:52:46 +00002181 IRBuilder<true, NoFolder> Builder(PBI);
Chris Lattnerb8245122008-07-13 22:04:41 +00002182 if (PBIOp)
Devang Pateld3a17882011-05-19 20:52:46 +00002183 PBICond = Builder.CreateNot(PBICond, PBICond->getName()+".not");
2184
Chris Lattnerb8245122008-07-13 22:04:41 +00002185 Value *BICond = BI->getCondition();
2186 if (BIOp)
Devang Pateld3a17882011-05-19 20:52:46 +00002187 BICond = Builder.CreateNot(BICond, BICond->getName()+".not");
2188
Chris Lattnerb8245122008-07-13 22:04:41 +00002189 // Merge the conditions.
Devang Pateld3a17882011-05-19 20:52:46 +00002190 Value *Cond = Builder.CreateOr(PBICond, BICond, "brmerge");
Andrew Trick6b014382012-08-29 21:46:36 +00002191
Chris Lattnerb8245122008-07-13 22:04:41 +00002192 // Modify PBI to branch on the new condition to the new dests.
2193 PBI->setCondition(Cond);
2194 PBI->setSuccessor(0, CommonDest);
2195 PBI->setSuccessor(1, OtherDest);
Andrew Trick6b014382012-08-29 21:46:36 +00002196
Chris Lattnerb8245122008-07-13 22:04:41 +00002197 // OtherDest may have phi nodes. If so, add an entry from PBI's
2198 // block that are identical to the entries for BI's block.
Chris Lattner6de0a282010-12-14 07:09:42 +00002199 AddPredecessorToBlock(OtherDest, PBI->getParent(), BB);
Andrew Trick6b014382012-08-29 21:46:36 +00002200
Chris Lattnerb8245122008-07-13 22:04:41 +00002201 // We know that the CommonDest already had an edge from PBI to
2202 // it. If it has PHIs though, the PHIs may have different
2203 // entries for BB and PBI's BB. If so, insert a select to make
2204 // them agree.
Chris Lattner6de0a282010-12-14 07:09:42 +00002205 PHINode *PN;
Chris Lattnerb8245122008-07-13 22:04:41 +00002206 for (BasicBlock::iterator II = CommonDest->begin();
2207 (PN = dyn_cast<PHINode>(II)); ++II) {
2208 Value *BIV = PN->getIncomingValueForBlock(BB);
2209 unsigned PBBIdx = PN->getBasicBlockIndex(PBI->getParent());
2210 Value *PBIV = PN->getIncomingValue(PBBIdx);
2211 if (BIV != PBIV) {
2212 // Insert a select in PBI to pick the right value.
Devang Pateld3a17882011-05-19 20:52:46 +00002213 Value *NV = cast<SelectInst>
2214 (Builder.CreateSelect(PBICond, PBIV, BIV, PBIV->getName()+".mux"));
Chris Lattnerb8245122008-07-13 22:04:41 +00002215 PN->setIncomingValue(PBBIdx, NV);
Chris Lattner867661a2008-07-13 21:53:26 +00002216 }
2217 }
Andrew Trick6b014382012-08-29 21:46:36 +00002218
David Greene89d6fd32010-01-05 01:26:52 +00002219 DEBUG(dbgs() << "INTO: " << *PBI->getParent());
2220 DEBUG(dbgs() << *PBI->getParent()->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00002221
Chris Lattnerb8245122008-07-13 22:04:41 +00002222 // This basic block is probably dead. We know it has at least
2223 // one fewer predecessor.
2224 return true;
Chris Lattner867661a2008-07-13 21:53:26 +00002225}
2226
Frits van Bommel65fdded2011-01-11 12:52:11 +00002227// SimplifyTerminatorOnSelect - Simplifies a terminator by replacing it with a
2228// branch to TrueBB if Cond is true or to FalseBB if Cond is false.
2229// Takes care of updating the successors and removing the old terminator.
2230// Also makes sure not to introduce new successors by assuming that edges to
2231// non-successor TrueBBs and FalseBBs aren't reachable.
2232static bool SimplifyTerminatorOnSelect(TerminatorInst *OldTerm, Value *Cond,
2233 BasicBlock *TrueBB, BasicBlock *FalseBB){
2234 // Remove any superfluous successor edges from the CFG.
2235 // First, figure out which successors to preserve.
2236 // If TrueBB and FalseBB are equal, only try to preserve one copy of that
2237 // successor.
2238 BasicBlock *KeepEdge1 = TrueBB;
2239 BasicBlock *KeepEdge2 = TrueBB != FalseBB ? FalseBB : 0;
2240
2241 // Then remove the rest.
2242 for (unsigned I = 0, E = OldTerm->getNumSuccessors(); I != E; ++I) {
2243 BasicBlock *Succ = OldTerm->getSuccessor(I);
2244 // Make sure only to keep exactly one copy of each edge.
2245 if (Succ == KeepEdge1)
2246 KeepEdge1 = 0;
2247 else if (Succ == KeepEdge2)
2248 KeepEdge2 = 0;
2249 else
2250 Succ->removePredecessor(OldTerm->getParent());
2251 }
2252
Devang Pateld3372b82011-05-18 18:43:31 +00002253 IRBuilder<> Builder(OldTerm);
2254 Builder.SetCurrentDebugLocation(OldTerm->getDebugLoc());
2255
Frits van Bommel65fdded2011-01-11 12:52:11 +00002256 // Insert an appropriate new terminator.
2257 if ((KeepEdge1 == 0) && (KeepEdge2 == 0)) {
2258 if (TrueBB == FalseBB)
2259 // We were only looking for one successor, and it was present.
2260 // Create an unconditional branch to it.
Devang Pateld3372b82011-05-18 18:43:31 +00002261 Builder.CreateBr(TrueBB);
Frits van Bommel65fdded2011-01-11 12:52:11 +00002262 else
2263 // We found both of the successors we were looking for.
2264 // Create a conditional branch sharing the condition of the select.
Devang Pateld3372b82011-05-18 18:43:31 +00002265 Builder.CreateCondBr(Cond, TrueBB, FalseBB);
Frits van Bommel65fdded2011-01-11 12:52:11 +00002266 } else if (KeepEdge1 && (KeepEdge2 || TrueBB == FalseBB)) {
2267 // Neither of the selected blocks were successors, so this
2268 // terminator must be unreachable.
2269 new UnreachableInst(OldTerm->getContext(), OldTerm);
2270 } else {
2271 // One of the selected values was a successor, but the other wasn't.
2272 // Insert an unconditional branch to the one that was found;
2273 // the edge to the one that wasn't must be unreachable.
2274 if (KeepEdge1 == 0)
2275 // Only TrueBB was found.
Devang Pateld3372b82011-05-18 18:43:31 +00002276 Builder.CreateBr(TrueBB);
Frits van Bommel65fdded2011-01-11 12:52:11 +00002277 else
2278 // Only FalseBB was found.
Devang Pateld3372b82011-05-18 18:43:31 +00002279 Builder.CreateBr(FalseBB);
Frits van Bommel65fdded2011-01-11 12:52:11 +00002280 }
2281
2282 EraseTerminatorInstAndDCECond(OldTerm);
2283 return true;
2284}
2285
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00002286// SimplifySwitchOnSelect - Replaces
2287// (switch (select cond, X, Y)) on constant X, Y
2288// with a branch - conditional if X and Y lead to distinct BBs,
2289// unconditional otherwise.
2290static bool SimplifySwitchOnSelect(SwitchInst *SI, SelectInst *Select) {
2291 // Check for constant integer values in the select.
2292 ConstantInt *TrueVal = dyn_cast<ConstantInt>(Select->getTrueValue());
2293 ConstantInt *FalseVal = dyn_cast<ConstantInt>(Select->getFalseValue());
2294 if (!TrueVal || !FalseVal)
2295 return false;
2296
2297 // Find the relevant condition and destinations.
2298 Value *Condition = Select->getCondition();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002299 BasicBlock *TrueBB = SI->findCaseValue(TrueVal).getCaseSuccessor();
2300 BasicBlock *FalseBB = SI->findCaseValue(FalseVal).getCaseSuccessor();
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00002301
2302 // Perform the actual simplification.
2303 return SimplifyTerminatorOnSelect(SI, Condition, TrueBB, FalseBB);
2304}
2305
Frits van Bommel7ac40c32010-12-05 18:29:03 +00002306// SimplifyIndirectBrOnSelect - Replaces
2307// (indirectbr (select cond, blockaddress(@fn, BlockA),
2308// blockaddress(@fn, BlockB)))
2309// with
2310// (br cond, BlockA, BlockB).
2311static bool SimplifyIndirectBrOnSelect(IndirectBrInst *IBI, SelectInst *SI) {
2312 // Check that both operands of the select are block addresses.
2313 BlockAddress *TBA = dyn_cast<BlockAddress>(SI->getTrueValue());
2314 BlockAddress *FBA = dyn_cast<BlockAddress>(SI->getFalseValue());
2315 if (!TBA || !FBA)
2316 return false;
2317
2318 // Extract the actual blocks.
2319 BasicBlock *TrueBB = TBA->getBasicBlock();
2320 BasicBlock *FalseBB = FBA->getBasicBlock();
2321
Frits van Bommel65fdded2011-01-11 12:52:11 +00002322 // Perform the actual simplification.
2323 return SimplifyTerminatorOnSelect(IBI, SI->getCondition(), TrueBB, FalseBB);
Frits van Bommel7ac40c32010-12-05 18:29:03 +00002324}
2325
Chris Lattner61c77442010-12-13 03:18:54 +00002326/// TryToSimplifyUncondBranchWithICmpInIt - This is called when we find an icmp
2327/// instruction (a seteq/setne with a constant) as the only instruction in a
2328/// block that ends with an uncond branch. We are looking for a very specific
2329/// pattern that occurs when "A == 1 || A == 2 || A == 3" gets simplified. In
2330/// this case, we merge the first two "or's of icmp" into a switch, but then the
2331/// default value goes to an uncond block with a seteq in it, we get something
2332/// like:
2333///
2334/// switch i8 %A, label %DEFAULT [ i8 1, label %end i8 2, label %end ]
2335/// DEFAULT:
2336/// %tmp = icmp eq i8 %A, 92
2337/// br label %end
2338/// end:
2339/// ... = phi i1 [ true, %entry ], [ %tmp, %DEFAULT ], [ true, %entry ]
Andrew Trick6b014382012-08-29 21:46:36 +00002340///
Chris Lattner61c77442010-12-13 03:18:54 +00002341/// We prefer to split the edge to 'end' so that there is a true/false entry to
2342/// the PHI, merging the third icmp into the switch.
Chris Lattner302ba6f2010-12-14 06:17:25 +00002343static bool TryToSimplifyUncondBranchWithICmpInIt(ICmpInst *ICI,
Devang Patela23812c2011-05-18 18:28:48 +00002344 const TargetData *TD,
2345 IRBuilder<> &Builder) {
Chris Lattner61c77442010-12-13 03:18:54 +00002346 BasicBlock *BB = ICI->getParent();
Devang Patela23812c2011-05-18 18:28:48 +00002347
Chris Lattner61c77442010-12-13 03:18:54 +00002348 // If the block has any PHIs in it or the icmp has multiple uses, it is too
2349 // complex.
2350 if (isa<PHINode>(BB->begin()) || !ICI->hasOneUse()) return false;
2351
2352 Value *V = ICI->getOperand(0);
2353 ConstantInt *Cst = cast<ConstantInt>(ICI->getOperand(1));
Andrew Trick6b014382012-08-29 21:46:36 +00002354
Chris Lattner61c77442010-12-13 03:18:54 +00002355 // The pattern we're looking for is where our only predecessor is a switch on
2356 // 'V' and this block is the default case for the switch. In this case we can
2357 // fold the compared value into the switch to simplify things.
2358 BasicBlock *Pred = BB->getSinglePredecessor();
2359 if (Pred == 0 || !isa<SwitchInst>(Pred->getTerminator())) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002360
Chris Lattner61c77442010-12-13 03:18:54 +00002361 SwitchInst *SI = cast<SwitchInst>(Pred->getTerminator());
2362 if (SI->getCondition() != V)
2363 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002364
Chris Lattner61c77442010-12-13 03:18:54 +00002365 // If BB is reachable on a non-default case, then we simply know the value of
2366 // V in this block. Substitute it and constant fold the icmp instruction
2367 // away.
2368 if (SI->getDefaultDest() != BB) {
2369 ConstantInt *VVal = SI->findCaseDest(BB);
2370 assert(VVal && "Should have a unique destination value");
2371 ICI->setOperand(0, VVal);
Andrew Trick6b014382012-08-29 21:46:36 +00002372
Chris Lattner302ba6f2010-12-14 06:17:25 +00002373 if (Value *V = SimplifyInstruction(ICI, TD)) {
2374 ICI->replaceAllUsesWith(V);
Chris Lattner61c77442010-12-13 03:18:54 +00002375 ICI->eraseFromParent();
2376 }
2377 // BB is now empty, so it is likely to simplify away.
2378 return SimplifyCFG(BB) | true;
2379 }
Andrew Trick6b014382012-08-29 21:46:36 +00002380
Chris Lattnerabf70672010-12-13 03:43:57 +00002381 // Ok, the block is reachable from the default dest. If the constant we're
2382 // comparing exists in one of the other edges, then we can constant fold ICI
2383 // and zap it.
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002384 if (SI->findCaseValue(Cst) != SI->case_default()) {
Chris Lattnerabf70672010-12-13 03:43:57 +00002385 Value *V;
2386 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
2387 V = ConstantInt::getFalse(BB->getContext());
2388 else
2389 V = ConstantInt::getTrue(BB->getContext());
Andrew Trick6b014382012-08-29 21:46:36 +00002390
Chris Lattnerabf70672010-12-13 03:43:57 +00002391 ICI->replaceAllUsesWith(V);
2392 ICI->eraseFromParent();
2393 // BB is now empty, so it is likely to simplify away.
2394 return SimplifyCFG(BB) | true;
2395 }
Andrew Trick6b014382012-08-29 21:46:36 +00002396
Chris Lattner61c77442010-12-13 03:18:54 +00002397 // The use of the icmp has to be in the 'end' block, by the only PHI node in
2398 // the block.
2399 BasicBlock *SuccBlock = BB->getTerminator()->getSuccessor(0);
2400 PHINode *PHIUse = dyn_cast<PHINode>(ICI->use_back());
2401 if (PHIUse == 0 || PHIUse != &SuccBlock->front() ||
2402 isa<PHINode>(++BasicBlock::iterator(PHIUse)))
2403 return false;
2404
2405 // If the icmp is a SETEQ, then the default dest gets false, the new edge gets
2406 // true in the PHI.
2407 Constant *DefaultCst = ConstantInt::getTrue(BB->getContext());
2408 Constant *NewCst = ConstantInt::getFalse(BB->getContext());
2409
2410 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
2411 std::swap(DefaultCst, NewCst);
2412
2413 // Replace ICI (which is used by the PHI for the default value) with true or
2414 // false depending on if it is EQ or NE.
2415 ICI->replaceAllUsesWith(DefaultCst);
2416 ICI->eraseFromParent();
2417
2418 // Okay, the switch goes to this block on a default value. Add an edge from
2419 // the switch to the merge point on the compared value.
2420 BasicBlock *NewBB = BasicBlock::Create(BB->getContext(), "switch.edge",
2421 BB->getParent(), BB);
2422 SI->addCase(Cst, NewBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002423
Chris Lattner61c77442010-12-13 03:18:54 +00002424 // NewBB branches to the phi block, add the uncond branch and the phi entry.
Devang Patela23812c2011-05-18 18:28:48 +00002425 Builder.SetInsertPoint(NewBB);
2426 Builder.SetCurrentDebugLocation(SI->getDebugLoc());
2427 Builder.CreateBr(SuccBlock);
Chris Lattner61c77442010-12-13 03:18:54 +00002428 PHIUse->addIncoming(NewCst, NewBB);
2429 return true;
2430}
2431
Chris Lattner97fdb892010-12-13 05:03:41 +00002432/// SimplifyBranchOnICmpChain - The specified branch is a conditional branch.
2433/// Check to see if it is branching on an or/and chain of icmp instructions, and
2434/// fold it into a switch instruction if so.
Devang Patel02dd5412011-05-18 23:18:47 +00002435static bool SimplifyBranchOnICmpChain(BranchInst *BI, const TargetData *TD,
2436 IRBuilder<> &Builder) {
Chris Lattner97fdb892010-12-13 05:03:41 +00002437 Instruction *Cond = dyn_cast<Instruction>(BI->getCondition());
2438 if (Cond == 0) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002439
2440
Chris Lattner97fdb892010-12-13 05:03:41 +00002441 // Change br (X == 0 | X == 1), T, F into a switch instruction.
2442 // If this is a bunch of seteq's or'd together, or if it's a bunch of
2443 // 'setne's and'ed together, collect them.
2444 Value *CompVal = 0;
2445 std::vector<ConstantInt*> Values;
2446 bool TrueWhenEqual = true;
2447 Value *ExtraCase = 0;
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002448 unsigned UsedICmps = 0;
Andrew Trick6b014382012-08-29 21:46:36 +00002449
Chris Lattner97fdb892010-12-13 05:03:41 +00002450 if (Cond->getOpcode() == Instruction::Or) {
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002451 CompVal = GatherConstantCompares(Cond, Values, ExtraCase, TD, true,
2452 UsedICmps);
Chris Lattner97fdb892010-12-13 05:03:41 +00002453 } else if (Cond->getOpcode() == Instruction::And) {
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002454 CompVal = GatherConstantCompares(Cond, Values, ExtraCase, TD, false,
2455 UsedICmps);
Chris Lattner97fdb892010-12-13 05:03:41 +00002456 TrueWhenEqual = false;
2457 }
Andrew Trick6b014382012-08-29 21:46:36 +00002458
Chris Lattner97fdb892010-12-13 05:03:41 +00002459 // If we didn't have a multiply compared value, fail.
2460 if (CompVal == 0) return false;
2461
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002462 // Avoid turning single icmps into a switch.
2463 if (UsedICmps <= 1)
2464 return false;
2465
Chris Lattner97fdb892010-12-13 05:03:41 +00002466 // There might be duplicate constants in the list, which the switch
2467 // instruction can't handle, remove them now.
2468 array_pod_sort(Values.begin(), Values.end(), ConstantIntSortPredicate);
2469 Values.erase(std::unique(Values.begin(), Values.end()), Values.end());
Andrew Trick6b014382012-08-29 21:46:36 +00002470
Chris Lattner97fdb892010-12-13 05:03:41 +00002471 // If Extra was used, we require at least two switch values to do the
2472 // transformation. A switch with one value is just an cond branch.
2473 if (ExtraCase && Values.size() < 2) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002474
Andrew Trickb1b97832012-08-29 21:46:38 +00002475 // TODO: Preserve branch weight metadata, similarly to how
2476 // FoldValueComparisonIntoPredecessors preserves it.
2477
Chris Lattner97fdb892010-12-13 05:03:41 +00002478 // Figure out which block is which destination.
2479 BasicBlock *DefaultBB = BI->getSuccessor(1);
2480 BasicBlock *EdgeBB = BI->getSuccessor(0);
2481 if (!TrueWhenEqual) std::swap(DefaultBB, EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002482
Chris Lattner97fdb892010-12-13 05:03:41 +00002483 BasicBlock *BB = BI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002484
Chris Lattner302ba6f2010-12-14 06:17:25 +00002485 DEBUG(dbgs() << "Converting 'icmp' chain with " << Values.size()
Chris Lattner117f8cf2010-12-14 05:57:30 +00002486 << " cases into SWITCH. BB is:\n" << *BB);
Andrew Trick6b014382012-08-29 21:46:36 +00002487
Chris Lattner97fdb892010-12-13 05:03:41 +00002488 // If there are any extra values that couldn't be folded into the switch
2489 // then we evaluate them with an explicit branch first. Split the block
2490 // right before the condbr to handle it.
2491 if (ExtraCase) {
2492 BasicBlock *NewBB = BB->splitBasicBlock(BI, "switch.early.test");
2493 // Remove the uncond branch added to the old block.
2494 TerminatorInst *OldTI = BB->getTerminator();
Devang Patel02dd5412011-05-18 23:18:47 +00002495 Builder.SetInsertPoint(OldTI);
2496
Chris Lattner117f8cf2010-12-14 05:57:30 +00002497 if (TrueWhenEqual)
Devang Patel02dd5412011-05-18 23:18:47 +00002498 Builder.CreateCondBr(ExtraCase, EdgeBB, NewBB);
Chris Lattner117f8cf2010-12-14 05:57:30 +00002499 else
Devang Patel02dd5412011-05-18 23:18:47 +00002500 Builder.CreateCondBr(ExtraCase, NewBB, EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002501
Chris Lattner97fdb892010-12-13 05:03:41 +00002502 OldTI->eraseFromParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002503
Chris Lattner97bd89e2010-12-13 05:34:18 +00002504 // If there are PHI nodes in EdgeBB, then we need to add a new entry to them
2505 // for the edge we just added.
Chris Lattner6de0a282010-12-14 07:09:42 +00002506 AddPredecessorToBlock(EdgeBB, BB, NewBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002507
Chris Lattner302ba6f2010-12-14 06:17:25 +00002508 DEBUG(dbgs() << " ** 'icmp' chain unhandled condition: " << *ExtraCase
2509 << "\nEXTRABB = " << *BB);
Chris Lattner97fdb892010-12-13 05:03:41 +00002510 BB = NewBB;
2511 }
Devang Patel02dd5412011-05-18 23:18:47 +00002512
2513 Builder.SetInsertPoint(BI);
Chris Lattner97fdb892010-12-13 05:03:41 +00002514 // Convert pointer to int before we switch.
2515 if (CompVal->getType()->isPointerTy()) {
2516 assert(TD && "Cannot switch on pointer without TargetData");
Devang Patel02dd5412011-05-18 23:18:47 +00002517 CompVal = Builder.CreatePtrToInt(CompVal,
2518 TD->getIntPtrType(CompVal->getContext()),
2519 "magicptr");
Chris Lattner97fdb892010-12-13 05:03:41 +00002520 }
Andrew Trick6b014382012-08-29 21:46:36 +00002521
Chris Lattner97fdb892010-12-13 05:03:41 +00002522 // Create the new switch instruction now.
Devang Patel02dd5412011-05-18 23:18:47 +00002523 SwitchInst *New = Builder.CreateSwitch(CompVal, DefaultBB, Values.size());
Devang Pateld80e8ed2011-05-17 23:29:05 +00002524
Chris Lattner97fdb892010-12-13 05:03:41 +00002525 // Add all of the 'cases' to the switch instruction.
2526 for (unsigned i = 0, e = Values.size(); i != e; ++i)
2527 New->addCase(Values[i], EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002528
Chris Lattner97fdb892010-12-13 05:03:41 +00002529 // We added edges from PI to the EdgeBB. As such, if there were any
2530 // PHI nodes in EdgeBB, they need entries to be added corresponding to
2531 // the number of edges added.
2532 for (BasicBlock::iterator BBI = EdgeBB->begin();
2533 isa<PHINode>(BBI); ++BBI) {
2534 PHINode *PN = cast<PHINode>(BBI);
2535 Value *InVal = PN->getIncomingValueForBlock(BB);
2536 for (unsigned i = 0, e = Values.size()-1; i != e; ++i)
2537 PN->addIncoming(InVal, BB);
2538 }
Andrew Trick6b014382012-08-29 21:46:36 +00002539
Chris Lattner97fdb892010-12-13 05:03:41 +00002540 // Erase the old branch instruction.
2541 EraseTerminatorInstAndDCECond(BI);
Andrew Trick6b014382012-08-29 21:46:36 +00002542
Chris Lattner302ba6f2010-12-14 06:17:25 +00002543 DEBUG(dbgs() << " ** 'icmp' chain result is:\n" << *BB << '\n');
Chris Lattner97fdb892010-12-13 05:03:41 +00002544 return true;
2545}
2546
Duncan Sandsad99ef82011-09-05 12:57:57 +00002547bool SimplifyCFGOpt::SimplifyResume(ResumeInst *RI, IRBuilder<> &Builder) {
2548 // If this is a trivial landing pad that just continues unwinding the caught
2549 // exception then zap the landing pad, turning its invokes into calls.
2550 BasicBlock *BB = RI->getParent();
2551 LandingPadInst *LPInst = dyn_cast<LandingPadInst>(BB->getFirstNonPHI());
2552 if (RI->getValue() != LPInst)
2553 // Not a landing pad, or the resume is not unwinding the exception that
2554 // caused control to branch here.
2555 return false;
2556
2557 // Check that there are no other instructions except for debug intrinsics.
2558 BasicBlock::iterator I = LPInst, E = RI;
2559 while (++I != E)
2560 if (!isa<DbgInfoIntrinsic>(I))
2561 return false;
2562
2563 // Turn all invokes that unwind here into calls and delete the basic block.
2564 for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE;) {
2565 InvokeInst *II = cast<InvokeInst>((*PI++)->getTerminator());
2566 SmallVector<Value*, 8> Args(II->op_begin(), II->op_end() - 3);
2567 // Insert a call instruction before the invoke.
2568 CallInst *Call = CallInst::Create(II->getCalledValue(), Args, "", II);
2569 Call->takeName(II);
2570 Call->setCallingConv(II->getCallingConv());
2571 Call->setAttributes(II->getAttributes());
2572 Call->setDebugLoc(II->getDebugLoc());
2573
2574 // Anything that used the value produced by the invoke instruction now uses
2575 // the value produced by the call instruction. Note that we do this even
2576 // for void functions and calls with no uses so that the callgraph edge is
2577 // updated.
2578 II->replaceAllUsesWith(Call);
2579 BB->removePredecessor(II->getParent());
2580
2581 // Insert a branch to the normal destination right before the invoke.
2582 BranchInst::Create(II->getNormalDest(), II);
2583
2584 // Finally, delete the invoke instruction!
2585 II->eraseFromParent();
2586 }
2587
2588 // The landingpad is now unreachable. Zap it.
2589 BB->eraseFromParent();
2590 return true;
2591}
2592
Devang Patel176ec402011-05-18 21:33:11 +00002593bool SimplifyCFGOpt::SimplifyReturn(ReturnInst *RI, IRBuilder<> &Builder) {
Chris Lattner3d512132010-12-13 06:25:44 +00002594 BasicBlock *BB = RI->getParent();
2595 if (!BB->getFirstNonPHIOrDbg()->isTerminator()) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002596
Chris Lattner3d512132010-12-13 06:25:44 +00002597 // Find predecessors that end with branches.
2598 SmallVector<BasicBlock*, 8> UncondBranchPreds;
2599 SmallVector<BranchInst*, 8> CondBranchPreds;
2600 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
2601 BasicBlock *P = *PI;
2602 TerminatorInst *PTI = P->getTerminator();
2603 if (BranchInst *BI = dyn_cast<BranchInst>(PTI)) {
2604 if (BI->isUnconditional())
2605 UncondBranchPreds.push_back(P);
2606 else
2607 CondBranchPreds.push_back(BI);
2608 }
2609 }
Andrew Trick6b014382012-08-29 21:46:36 +00002610
Chris Lattner3d512132010-12-13 06:25:44 +00002611 // If we found some, do the transformation!
Evan Chengc3f507f2011-01-29 04:46:23 +00002612 if (!UncondBranchPreds.empty() && DupRet) {
Chris Lattner3d512132010-12-13 06:25:44 +00002613 while (!UncondBranchPreds.empty()) {
2614 BasicBlock *Pred = UncondBranchPreds.pop_back_val();
2615 DEBUG(dbgs() << "FOLDING: " << *BB
2616 << "INTO UNCOND BRANCH PRED: " << *Pred);
Evan Chengc3f507f2011-01-29 04:46:23 +00002617 (void)FoldReturnIntoUncondBranch(RI, BB, Pred);
Chris Lattner3d512132010-12-13 06:25:44 +00002618 }
Andrew Trick6b014382012-08-29 21:46:36 +00002619
Chris Lattner3d512132010-12-13 06:25:44 +00002620 // If we eliminated all predecessors of the block, delete the block now.
2621 if (pred_begin(BB) == pred_end(BB))
2622 // We know there are no successors, so just nuke the block.
2623 BB->eraseFromParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002624
Chris Lattner3d512132010-12-13 06:25:44 +00002625 return true;
2626 }
Andrew Trick6b014382012-08-29 21:46:36 +00002627
Chris Lattner3d512132010-12-13 06:25:44 +00002628 // Check out all of the conditional branches going to this return
2629 // instruction. If any of them just select between returns, change the
2630 // branch itself into a select/return pair.
2631 while (!CondBranchPreds.empty()) {
2632 BranchInst *BI = CondBranchPreds.pop_back_val();
Andrew Trick6b014382012-08-29 21:46:36 +00002633
Chris Lattner3d512132010-12-13 06:25:44 +00002634 // Check to see if the non-BB successor is also a return block.
2635 if (isa<ReturnInst>(BI->getSuccessor(0)->getTerminator()) &&
2636 isa<ReturnInst>(BI->getSuccessor(1)->getTerminator()) &&
Devang Patel176ec402011-05-18 21:33:11 +00002637 SimplifyCondBranchToTwoReturns(BI, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00002638 return true;
2639 }
2640 return false;
2641}
2642
Chris Lattner3d512132010-12-13 06:25:44 +00002643bool SimplifyCFGOpt::SimplifyUnreachable(UnreachableInst *UI) {
2644 BasicBlock *BB = UI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002645
Chris Lattner3d512132010-12-13 06:25:44 +00002646 bool Changed = false;
Andrew Trick6b014382012-08-29 21:46:36 +00002647
Chris Lattner3d512132010-12-13 06:25:44 +00002648 // If there are any instructions immediately before the unreachable that can
2649 // be removed, do so.
2650 while (UI != BB->begin()) {
2651 BasicBlock::iterator BBI = UI;
2652 --BBI;
Eli Friedman81763882011-08-15 23:59:28 +00002653 // Do not delete instructions that can have side effects which might cause
2654 // the unreachable to not be reachable; specifically, calls and volatile
2655 // operations may have this effect.
Chris Lattner3d512132010-12-13 06:25:44 +00002656 if (isa<CallInst>(BBI) && !isa<DbgInfoIntrinsic>(BBI)) break;
Eli Friedman81763882011-08-15 23:59:28 +00002657
2658 if (BBI->mayHaveSideEffects()) {
2659 if (StoreInst *SI = dyn_cast<StoreInst>(BBI)) {
2660 if (SI->isVolatile())
2661 break;
2662 } else if (LoadInst *LI = dyn_cast<LoadInst>(BBI)) {
2663 if (LI->isVolatile())
2664 break;
2665 } else if (AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(BBI)) {
2666 if (RMWI->isVolatile())
2667 break;
2668 } else if (AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(BBI)) {
2669 if (CXI->isVolatile())
2670 break;
2671 } else if (!isa<FenceInst>(BBI) && !isa<VAArgInst>(BBI) &&
2672 !isa<LandingPadInst>(BBI)) {
Chris Lattner3d512132010-12-13 06:25:44 +00002673 break;
Eli Friedman81763882011-08-15 23:59:28 +00002674 }
Bill Wendling23b49ba2011-08-16 20:41:17 +00002675 // Note that deleting LandingPad's here is in fact okay, although it
2676 // involves a bit of subtle reasoning. If this inst is a LandingPad,
2677 // all the predecessors of this block will be the unwind edges of Invokes,
2678 // and we can therefore guarantee this block will be erased.
Eli Friedman81763882011-08-15 23:59:28 +00002679 }
2680
Eli Friedman2adc5b62011-03-09 00:48:33 +00002681 // Delete this instruction (any uses are guaranteed to be dead)
2682 if (!BBI->use_empty())
2683 BBI->replaceAllUsesWith(UndefValue::get(BBI->getType()));
Chris Lattner302ba6f2010-12-14 06:17:25 +00002684 BBI->eraseFromParent();
Chris Lattner3d512132010-12-13 06:25:44 +00002685 Changed = true;
2686 }
Andrew Trick6b014382012-08-29 21:46:36 +00002687
Chris Lattner3d512132010-12-13 06:25:44 +00002688 // If the unreachable instruction is the first in the block, take a gander
2689 // at all of the predecessors of this instruction, and simplify them.
2690 if (&BB->front() != UI) return Changed;
Andrew Trick6b014382012-08-29 21:46:36 +00002691
Chris Lattner3d512132010-12-13 06:25:44 +00002692 SmallVector<BasicBlock*, 8> Preds(pred_begin(BB), pred_end(BB));
2693 for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
2694 TerminatorInst *TI = Preds[i]->getTerminator();
Devang Patel1aa89a22011-05-19 00:09:21 +00002695 IRBuilder<> Builder(TI);
Chris Lattner3d512132010-12-13 06:25:44 +00002696 if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
2697 if (BI->isUnconditional()) {
2698 if (BI->getSuccessor(0) == BB) {
2699 new UnreachableInst(TI->getContext(), TI);
2700 TI->eraseFromParent();
2701 Changed = true;
2702 }
2703 } else {
2704 if (BI->getSuccessor(0) == BB) {
Devang Patel1aa89a22011-05-19 00:09:21 +00002705 Builder.CreateBr(BI->getSuccessor(1));
Chris Lattner3d512132010-12-13 06:25:44 +00002706 EraseTerminatorInstAndDCECond(BI);
2707 } else if (BI->getSuccessor(1) == BB) {
Devang Patel1aa89a22011-05-19 00:09:21 +00002708 Builder.CreateBr(BI->getSuccessor(0));
Chris Lattner3d512132010-12-13 06:25:44 +00002709 EraseTerminatorInstAndDCECond(BI);
2710 Changed = true;
2711 }
2712 }
2713 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002714 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002715 i != e; ++i)
2716 if (i.getCaseSuccessor() == BB) {
Chris Lattner3d512132010-12-13 06:25:44 +00002717 BB->removePredecessor(SI->getParent());
2718 SI->removeCase(i);
2719 --i; --e;
2720 Changed = true;
2721 }
2722 // If the default value is unreachable, figure out the most popular
2723 // destination and make it the default.
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00002724 if (SI->getDefaultDest() == BB) {
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00002725 std::map<BasicBlock*, std::pair<unsigned, unsigned> > Popularity;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002726 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002727 i != e; ++i) {
Nick Lewycky9d523102011-12-26 20:37:40 +00002728 std::pair<unsigned, unsigned> &entry =
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002729 Popularity[i.getCaseSuccessor()];
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00002730 if (entry.first == 0) {
2731 entry.first = 1;
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002732 entry.second = i.getCaseIndex();
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00002733 } else {
2734 entry.first++;
2735 }
2736 }
2737
Chris Lattner3d512132010-12-13 06:25:44 +00002738 // Find the most popular block.
2739 unsigned MaxPop = 0;
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00002740 unsigned MaxIndex = 0;
Chris Lattner3d512132010-12-13 06:25:44 +00002741 BasicBlock *MaxBlock = 0;
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00002742 for (std::map<BasicBlock*, std::pair<unsigned, unsigned> >::iterator
Chris Lattner3d512132010-12-13 06:25:44 +00002743 I = Popularity.begin(), E = Popularity.end(); I != E; ++I) {
Andrew Trick6b014382012-08-29 21:46:36 +00002744 if (I->second.first > MaxPop ||
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00002745 (I->second.first == MaxPop && MaxIndex > I->second.second)) {
2746 MaxPop = I->second.first;
2747 MaxIndex = I->second.second;
Chris Lattner3d512132010-12-13 06:25:44 +00002748 MaxBlock = I->first;
2749 }
2750 }
2751 if (MaxBlock) {
2752 // Make this the new default, allowing us to delete any explicit
2753 // edges to it.
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00002754 SI->setDefaultDest(MaxBlock);
Chris Lattner3d512132010-12-13 06:25:44 +00002755 Changed = true;
Andrew Trick6b014382012-08-29 21:46:36 +00002756
Chris Lattner3d512132010-12-13 06:25:44 +00002757 // If MaxBlock has phinodes in it, remove MaxPop-1 entries from
2758 // it.
2759 if (isa<PHINode>(MaxBlock->begin()))
2760 for (unsigned i = 0; i != MaxPop-1; ++i)
2761 MaxBlock->removePredecessor(SI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00002762
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002763 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002764 i != e; ++i)
2765 if (i.getCaseSuccessor() == MaxBlock) {
Chris Lattner3d512132010-12-13 06:25:44 +00002766 SI->removeCase(i);
2767 --i; --e;
2768 }
2769 }
2770 }
2771 } else if (InvokeInst *II = dyn_cast<InvokeInst>(TI)) {
2772 if (II->getUnwindDest() == BB) {
2773 // Convert the invoke to a call instruction. This would be a good
2774 // place to note that the call does not throw though.
Devang Patel1aa89a22011-05-19 00:09:21 +00002775 BranchInst *BI = Builder.CreateBr(II->getNormalDest());
Chris Lattner3d512132010-12-13 06:25:44 +00002776 II->removeFromParent(); // Take out of symbol table
Andrew Trick6b014382012-08-29 21:46:36 +00002777
Chris Lattner3d512132010-12-13 06:25:44 +00002778 // Insert the call now...
2779 SmallVector<Value*, 8> Args(II->op_begin(), II->op_end()-3);
Devang Patel1aa89a22011-05-19 00:09:21 +00002780 Builder.SetInsertPoint(BI);
2781 CallInst *CI = Builder.CreateCall(II->getCalledValue(),
Jay Foada3efbb12011-07-15 08:37:34 +00002782 Args, II->getName());
Chris Lattner3d512132010-12-13 06:25:44 +00002783 CI->setCallingConv(II->getCallingConv());
2784 CI->setAttributes(II->getAttributes());
2785 // If the invoke produced a value, the call does now instead.
2786 II->replaceAllUsesWith(CI);
2787 delete II;
2788 Changed = true;
2789 }
2790 }
2791 }
Andrew Trick6b014382012-08-29 21:46:36 +00002792
Chris Lattner3d512132010-12-13 06:25:44 +00002793 // If this block is now dead, remove it.
2794 if (pred_begin(BB) == pred_end(BB) &&
2795 BB != &BB->getParent()->getEntryBlock()) {
2796 // We know there are no successors, so just nuke the block.
2797 BB->eraseFromParent();
2798 return true;
2799 }
2800
2801 return Changed;
2802}
2803
Benjamin Kramer56442df2011-02-02 15:56:22 +00002804/// TurnSwitchRangeIntoICmp - Turns a switch with that contains only a
2805/// integer range comparison into a sub, an icmp and a branch.
Devang Patel007349d2011-05-18 20:35:38 +00002806static bool TurnSwitchRangeIntoICmp(SwitchInst *SI, IRBuilder<> &Builder) {
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00002807 assert(SI->getNumCases() > 1 && "Degenerate switch?");
Benjamin Kramer56442df2011-02-02 15:56:22 +00002808
Benjamin Kramer042b27f2011-02-03 22:51:41 +00002809 // Make sure all cases point to the same destination and gather the values.
2810 SmallVector<ConstantInt *, 16> Cases;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002811 SwitchInst::CaseIt I = SI->case_begin();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002812 Cases.push_back(I.getCaseValue());
2813 SwitchInst::CaseIt PrevI = I++;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002814 for (SwitchInst::CaseIt E = SI->case_end(); I != E; PrevI = I++) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002815 if (PrevI.getCaseSuccessor() != I.getCaseSuccessor())
Benjamin Kramer042b27f2011-02-03 22:51:41 +00002816 return false;
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002817 Cases.push_back(I.getCaseValue());
Benjamin Kramer042b27f2011-02-03 22:51:41 +00002818 }
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00002819 assert(Cases.size() == SI->getNumCases() && "Not all cases gathered");
Benjamin Kramer042b27f2011-02-03 22:51:41 +00002820
2821 // Sort the case values, then check if they form a range we can transform.
2822 array_pod_sort(Cases.begin(), Cases.end(), ConstantIntSortPredicate);
2823 for (unsigned I = 1, E = Cases.size(); I != E; ++I) {
2824 if (Cases[I-1]->getValue() != Cases[I]->getValue()+1)
2825 return false;
2826 }
2827
2828 Constant *Offset = ConstantExpr::getNeg(Cases.back());
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00002829 Constant *NumCases = ConstantInt::get(Offset->getType(), SI->getNumCases());
Benjamin Kramer56442df2011-02-02 15:56:22 +00002830
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002831 Value *Sub = SI->getCondition();
2832 if (!Offset->isNullValue())
Devang Patel1f5812b2011-05-19 00:13:33 +00002833 Sub = Builder.CreateAdd(Sub, Offset, Sub->getName()+".off");
2834 Value *Cmp = Builder.CreateICmpULT(Sub, NumCases, "switch");
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002835 Builder.CreateCondBr(
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002836 Cmp, SI->case_begin().getCaseSuccessor(), SI->getDefaultDest());
Benjamin Kramer56442df2011-02-02 15:56:22 +00002837
2838 // Prune obsolete incoming values off the successor's PHI nodes.
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002839 for (BasicBlock::iterator BBI = SI->case_begin().getCaseSuccessor()->begin();
Benjamin Kramer56442df2011-02-02 15:56:22 +00002840 isa<PHINode>(BBI); ++BBI) {
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00002841 for (unsigned I = 0, E = SI->getNumCases()-1; I != E; ++I)
Benjamin Kramer56442df2011-02-02 15:56:22 +00002842 cast<PHINode>(BBI)->removeIncomingValue(SI->getParent());
2843 }
2844 SI->eraseFromParent();
2845
2846 return true;
2847}
Chris Lattner3d512132010-12-13 06:25:44 +00002848
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00002849/// EliminateDeadSwitchCases - Compute masked bits for the condition of a switch
2850/// and use it to remove dead cases.
2851static bool EliminateDeadSwitchCases(SwitchInst *SI) {
2852 Value *Cond = SI->getCondition();
2853 unsigned Bits = cast<IntegerType>(Cond->getType())->getBitWidth();
2854 APInt KnownZero(Bits, 0), KnownOne(Bits, 0);
Rafael Espindola26c8dcc2012-04-04 12:51:34 +00002855 ComputeMaskedBits(Cond, KnownZero, KnownOne);
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00002856
2857 // Gather dead cases.
2858 SmallVector<ConstantInt*, 8> DeadCases;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002859 for (SwitchInst::CaseIt I = SI->case_begin(), E = SI->case_end(); I != E; ++I) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002860 if ((I.getCaseValue()->getValue() & KnownZero) != 0 ||
2861 (I.getCaseValue()->getValue() & KnownOne) != KnownOne) {
2862 DeadCases.push_back(I.getCaseValue());
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00002863 DEBUG(dbgs() << "SimplifyCFG: switch case '"
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002864 << I.getCaseValue() << "' is dead.\n");
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00002865 }
2866 }
2867
2868 // Remove dead cases from the switch.
2869 for (unsigned I = 0, E = DeadCases.size(); I != E; ++I) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002870 SwitchInst::CaseIt Case = SI->findCaseValue(DeadCases[I]);
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002871 assert(Case != SI->case_default() &&
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00002872 "Case was not found. Probably mistake in DeadCases forming.");
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00002873 // Prune unused values from PHI nodes.
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002874 Case.getCaseSuccessor()->removePredecessor(SI->getParent());
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00002875 SI->removeCase(Case);
2876 }
2877
2878 return !DeadCases.empty();
2879}
2880
Hans Wennborg448da512011-06-18 10:28:47 +00002881/// FindPHIForConditionForwarding - If BB would be eligible for simplification
2882/// by TryToSimplifyUncondBranchFromEmptyBlock (i.e. it is empty and terminated
2883/// by an unconditional branch), look at the phi node for BB in the successor
2884/// block and see if the incoming value is equal to CaseValue. If so, return
2885/// the phi node, and set PhiIndex to BB's index in the phi node.
2886static PHINode *FindPHIForConditionForwarding(ConstantInt *CaseValue,
2887 BasicBlock *BB,
2888 int *PhiIndex) {
2889 if (BB->getFirstNonPHIOrDbg() != BB->getTerminator())
2890 return NULL; // BB must be empty to be a candidate for simplification.
2891 if (!BB->getSinglePredecessor())
2892 return NULL; // BB must be dominated by the switch.
2893
2894 BranchInst *Branch = dyn_cast<BranchInst>(BB->getTerminator());
2895 if (!Branch || !Branch->isUnconditional())
2896 return NULL; // Terminator must be unconditional branch.
2897
2898 BasicBlock *Succ = Branch->getSuccessor(0);
2899
2900 BasicBlock::iterator I = Succ->begin();
2901 while (PHINode *PHI = dyn_cast<PHINode>(I++)) {
2902 int Idx = PHI->getBasicBlockIndex(BB);
2903 assert(Idx >= 0 && "PHI has no entry for predecessor?");
2904
2905 Value *InValue = PHI->getIncomingValue(Idx);
2906 if (InValue != CaseValue) continue;
2907
2908 *PhiIndex = Idx;
2909 return PHI;
2910 }
2911
2912 return NULL;
2913}
2914
2915/// ForwardSwitchConditionToPHI - Try to forward the condition of a switch
2916/// instruction to a phi node dominated by the switch, if that would mean that
2917/// some of the destination blocks of the switch can be folded away.
2918/// Returns true if a change is made.
2919static bool ForwardSwitchConditionToPHI(SwitchInst *SI) {
2920 typedef DenseMap<PHINode*, SmallVector<int,4> > ForwardingNodesMap;
2921 ForwardingNodesMap ForwardingNodes;
2922
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002923 for (SwitchInst::CaseIt I = SI->case_begin(), E = SI->case_end(); I != E; ++I) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002924 ConstantInt *CaseValue = I.getCaseValue();
2925 BasicBlock *CaseDest = I.getCaseSuccessor();
Hans Wennborg448da512011-06-18 10:28:47 +00002926
2927 int PhiIndex;
2928 PHINode *PHI = FindPHIForConditionForwarding(CaseValue, CaseDest,
2929 &PhiIndex);
2930 if (!PHI) continue;
2931
2932 ForwardingNodes[PHI].push_back(PhiIndex);
2933 }
2934
2935 bool Changed = false;
2936
2937 for (ForwardingNodesMap::iterator I = ForwardingNodes.begin(),
2938 E = ForwardingNodes.end(); I != E; ++I) {
2939 PHINode *Phi = I->first;
2940 SmallVector<int,4> &Indexes = I->second;
2941
2942 if (Indexes.size() < 2) continue;
2943
2944 for (size_t I = 0, E = Indexes.size(); I != E; ++I)
2945 Phi->setIncomingValue(Indexes[I], SI->getCondition());
2946 Changed = true;
2947 }
2948
2949 return Changed;
2950}
2951
Hans Wennborg486270a2012-09-06 09:43:28 +00002952/// ValidLookupTableConstant - Return true if the backend will be able to handle
2953/// initializing an array of constants like C.
Hans Wennborgbf015822012-09-07 08:22:57 +00002954static bool ValidLookupTableConstant(Constant *C) {
Hans Wennborg486270a2012-09-06 09:43:28 +00002955 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
2956 return CE->isGEPWithNoNotionalOverIndexing();
2957
2958 return isa<ConstantFP>(C) ||
2959 isa<ConstantInt>(C) ||
2960 isa<ConstantPointerNull>(C) ||
2961 isa<GlobalValue>(C) ||
2962 isa<UndefValue>(C);
2963}
2964
2965/// GetCaseResulsts - Try to determine the resulting constant values in phi
2966/// nodes at the common destination basic block for one of the case
2967/// destinations of a switch instruction.
2968static bool GetCaseResults(SwitchInst *SI,
2969 BasicBlock *CaseDest,
2970 BasicBlock **CommonDest,
2971 SmallVector<std::pair<PHINode*,Constant*>, 4> &Res) {
2972 // The block from which we enter the common destination.
2973 BasicBlock *Pred = SI->getParent();
2974
2975 // If CaseDest is empty, continue to its successor.
2976 if (CaseDest->getFirstNonPHIOrDbg() == CaseDest->getTerminator() &&
2977 !isa<PHINode>(CaseDest->begin())) {
2978
2979 TerminatorInst *Terminator = CaseDest->getTerminator();
2980 if (Terminator->getNumSuccessors() != 1)
2981 return false;
2982
2983 Pred = CaseDest;
2984 CaseDest = Terminator->getSuccessor(0);
2985 }
2986
2987 // If we did not have a CommonDest before, use the current one.
2988 if (!*CommonDest)
2989 *CommonDest = CaseDest;
2990 // If the destination isn't the common one, abort.
2991 if (CaseDest != *CommonDest)
2992 return false;
2993
2994 // Get the values for this case from phi nodes in the destination block.
2995 BasicBlock::iterator I = (*CommonDest)->begin();
2996 while (PHINode *PHI = dyn_cast<PHINode>(I++)) {
2997 int Idx = PHI->getBasicBlockIndex(Pred);
2998 if (Idx == -1)
2999 continue;
3000
3001 Constant *ConstVal = dyn_cast<Constant>(PHI->getIncomingValue(Idx));
3002 if (!ConstVal)
3003 return false;
3004
3005 // Be conservative about which kinds of constants we support.
3006 if (!ValidLookupTableConstant(ConstVal))
3007 return false;
3008
3009 Res.push_back(std::make_pair(PHI, ConstVal));
3010 }
3011
3012 return true;
3013}
3014
3015/// BuildLookupTable - Build a lookup table with the contents of Results, using
3016/// DefaultResult to fill the holes in the table. If the table ends up
3017/// containing the same result in each element, set *SingleResult to that value
3018/// and return NULL.
Hans Wennborg2f9fc762012-09-10 07:44:22 +00003019static GlobalVariable *BuildLookupTable(Module &M,
3020 uint64_t TableSize,
3021 ConstantInt *Offset,
3022 const SmallVector<std::pair<ConstantInt*, Constant*>, 4>& Results,
3023 Constant *DefaultResult,
3024 Constant **SingleResult) {
Hans Wennborg486270a2012-09-06 09:43:28 +00003025 assert(Results.size() && "Need values to build lookup table");
3026 assert(TableSize >= Results.size() && "Table needs to hold all values");
3027
3028 // If all values in the table are equal, this is that value.
3029 Constant *SameResult = Results.begin()->second;
3030
3031 // Build up the table contents.
3032 std::vector<Constant*> TableContents(TableSize);
3033 for (size_t I = 0, E = Results.size(); I != E; ++I) {
3034 ConstantInt *CaseVal = Results[I].first;
3035 Constant *CaseRes = Results[I].second;
3036
3037 uint64_t Idx = (CaseVal->getValue() - Offset->getValue()).getLimitedValue();
3038 TableContents[Idx] = CaseRes;
3039
3040 if (CaseRes != SameResult)
3041 SameResult = NULL;
3042 }
3043
3044 // Fill in any holes in the table with the default result.
3045 if (Results.size() < TableSize) {
3046 for (unsigned i = 0; i < TableSize; ++i) {
3047 if (!TableContents[i])
3048 TableContents[i] = DefaultResult;
3049 }
3050
3051 if (DefaultResult != SameResult)
3052 SameResult = NULL;
3053 }
3054
3055 // Same result was used in the entire table; just return that.
3056 if (SameResult) {
3057 *SingleResult = SameResult;
3058 return NULL;
3059 }
3060
3061 ArrayType *ArrayTy = ArrayType::get(DefaultResult->getType(), TableSize);
3062 Constant *Initializer = ConstantArray::get(ArrayTy, TableContents);
3063
3064 GlobalVariable *GV = new GlobalVariable(M, ArrayTy, /*constant=*/ true,
3065 GlobalVariable::PrivateLinkage,
3066 Initializer,
3067 "switch.table");
3068 GV->setUnnamedAddr(true);
3069 return GV;
3070}
3071
3072/// SwitchToLookupTable - If the switch is only used to initialize one or more
3073/// phi nodes in a common successor block with different constant values,
3074/// replace the switch with lookup tables.
3075static bool SwitchToLookupTable(SwitchInst *SI,
3076 IRBuilder<> &Builder) {
3077 assert(SI->getNumCases() > 1 && "Degenerate switch?");
3078 // FIXME: Handle unreachable cases.
3079
3080 // FIXME: If the switch is too sparse for a lookup table, perhaps we could
3081 // split off a dense part and build a lookup table for that.
3082
3083 // FIXME: If the results are all integers and the lookup table would fit in a
3084 // target-legal register, we should store them as a bitmap and use shift/mask
3085 // to look up the result.
3086
3087 // FIXME: This creates arrays of GEPs to constant strings, which means each
3088 // GEP needs a runtime relocation in PIC code. We should just build one big
3089 // string and lookup indices into that.
3090
3091 // Ignore the switch if the number of cases are too small.
3092 // This is similar to the check when building jump tables in
3093 // SelectionDAGBuilder::handleJTSwitchCase.
3094 // FIXME: Determine the best cut-off.
3095 if (SI->getNumCases() < 4)
3096 return false;
3097
3098 // Figure out the corresponding result for each case value and phi node in the
3099 // common destination, as well as the the min and max case values.
3100 assert(SI->case_begin() != SI->case_end());
3101 SwitchInst::CaseIt CI = SI->case_begin();
3102 ConstantInt *MinCaseVal = CI.getCaseValue();
3103 ConstantInt *MaxCaseVal = CI.getCaseValue();
3104
3105 BasicBlock *CommonDest = NULL;
Hans Wennborg2f9fc762012-09-10 07:44:22 +00003106 typedef SmallVector<std::pair<ConstantInt*, Constant*>, 4> ResultListTy;
Hans Wennborg486270a2012-09-06 09:43:28 +00003107 SmallDenseMap<PHINode*, ResultListTy> ResultLists;
3108 SmallDenseMap<PHINode*, Constant*> DefaultResults;
3109 SmallDenseMap<PHINode*, Type*> ResultTypes;
3110 SmallVector<PHINode*, 4> PHIs;
3111
3112 for (SwitchInst::CaseIt E = SI->case_end(); CI != E; ++CI) {
3113 ConstantInt *CaseVal = CI.getCaseValue();
3114 if (CaseVal->getValue().slt(MinCaseVal->getValue()))
3115 MinCaseVal = CaseVal;
3116 if (CaseVal->getValue().sgt(MaxCaseVal->getValue()))
3117 MaxCaseVal = CaseVal;
3118
3119 // Resulting value at phi nodes for this case value.
3120 typedef SmallVector<std::pair<PHINode*, Constant*>, 4> ResultsTy;
3121 ResultsTy Results;
3122 if (!GetCaseResults(SI, CI.getCaseSuccessor(), &CommonDest, Results))
3123 return false;
3124
3125 // Append the result from this case to the list for each phi.
3126 for (ResultsTy::iterator I = Results.begin(), E = Results.end(); I!=E; ++I) {
3127 if (!ResultLists.count(I->first))
3128 PHIs.push_back(I->first);
3129 ResultLists[I->first].push_back(std::make_pair(CaseVal, I->second));
3130 }
3131 }
3132
3133 // Get the resulting values for the default case.
Hans Wennborg2f9fc762012-09-10 07:44:22 +00003134 SmallVector<std::pair<PHINode*, Constant*>, 4> DefaultResultsList;
3135 if (!GetCaseResults(SI, SI->getDefaultDest(), &CommonDest, DefaultResultsList))
3136 return false;
3137 for (size_t I = 0, E = DefaultResultsList.size(); I != E; ++I) {
3138 PHINode *PHI = DefaultResultsList[I].first;
3139 Constant *Result = DefaultResultsList[I].second;
3140 DefaultResults[PHI] = Result;
3141 ResultTypes[PHI] = Result->getType();
Hans Wennborg486270a2012-09-06 09:43:28 +00003142 }
3143
3144 APInt RangeSpread = MaxCaseVal->getValue() - MinCaseVal->getValue();
3145 // The table density should be at lest 40%. This is the same criterion as for
3146 // jump tables, see SelectionDAGBuilder::handleJTSwitchCase.
3147 // FIXME: Find the best cut-off.
3148 // Be careful to avoid overlow in the density computation.
3149 if (RangeSpread.zextOrSelf(64).ugt(UINT64_MAX / 4 - 1))
3150 return false;
3151 uint64_t TableSize = RangeSpread.getLimitedValue() + 1;
3152 if (SI->getNumCases() * 10 < TableSize * 4)
3153 return false;
3154
3155 // Build the lookup tables.
3156 SmallDenseMap<PHINode*, GlobalVariable*> LookupTables;
3157 SmallDenseMap<PHINode*, Constant*> SingleResults;
3158
3159 Module &Mod = *CommonDest->getParent()->getParent();
Hans Wennborg3bd51b82012-09-06 10:10:35 +00003160 for (SmallVector<PHINode*, 4>::iterator I = PHIs.begin(), E = PHIs.end();
3161 I != E; ++I) {
3162 PHINode *PHI = *I;
Hans Wennborg486270a2012-09-06 09:43:28 +00003163
3164 Constant *SingleResult = NULL;
Hans Wennborg3bd51b82012-09-06 10:10:35 +00003165 LookupTables[PHI] = BuildLookupTable(Mod, TableSize, MinCaseVal,
3166 ResultLists[PHI], DefaultResults[PHI],
3167 &SingleResult);
Hans Wennborg486270a2012-09-06 09:43:28 +00003168 SingleResults[PHI] = SingleResult;
3169 }
3170
3171 // Create the BB that does the lookups.
3172 BasicBlock *LookupBB = BasicBlock::Create(Mod.getContext(),
3173 "switch.lookup",
3174 CommonDest->getParent(),
3175 CommonDest);
3176
3177 // Check whether the condition value is within the case range, and branch to
3178 // the new BB.
3179 Builder.SetInsertPoint(SI);
3180 Value *TableIndex = Builder.CreateSub(SI->getCondition(), MinCaseVal,
3181 "switch.tableidx");
3182 Value *Cmp = Builder.CreateICmpULT(TableIndex, ConstantInt::get(
3183 MinCaseVal->getType(), TableSize));
3184 Builder.CreateCondBr(Cmp, LookupBB, SI->getDefaultDest());
3185
3186 // Populate the BB that does the lookups.
3187 Builder.SetInsertPoint(LookupBB);
3188 bool ReturnedEarly = false;
3189 for (SmallVector<PHINode*, 4>::iterator I = PHIs.begin(), E = PHIs.end();
3190 I != E; ++I) {
3191 PHINode *PHI = *I;
3192 // There was a single result for this phi; just use that.
3193 if (Constant *SingleResult = SingleResults[PHI]) {
3194 PHI->addIncoming(SingleResult, LookupBB);
3195 continue;
3196 }
3197
3198 Value *GEPIndices[] = { Builder.getInt32(0), TableIndex };
3199 Value *GEP = Builder.CreateInBoundsGEP(LookupTables[PHI], GEPIndices,
3200 "switch.gep");
3201 Value *Result = Builder.CreateLoad(GEP, "switch.load");
3202
3203 // If the result is only going to be used to return from the function,
3204 // we want to do that right here.
3205 if (PHI->hasOneUse() && isa<ReturnInst>(*PHI->use_begin())) {
3206 if (CommonDest->getFirstNonPHIOrDbg() == CommonDest->getTerminator()) {
3207 Builder.CreateRet(Result);
3208 ReturnedEarly = true;
3209 }
3210 }
3211
3212 if (!ReturnedEarly)
3213 PHI->addIncoming(Result, LookupBB);
3214 }
3215
3216 if (!ReturnedEarly)
3217 Builder.CreateBr(CommonDest);
3218
3219 // Remove the switch.
3220 for (unsigned i = 0; i < SI->getNumSuccessors(); ++i) {
3221 BasicBlock *Succ = SI->getSuccessor(i);
3222 if (Succ == SI->getDefaultDest()) continue;
3223 Succ->removePredecessor(SI->getParent());
3224 }
3225 SI->eraseFromParent();
3226
3227 ++NumLookupTables;
3228 return true;
3229}
3230
Devang Patel007349d2011-05-18 20:35:38 +00003231bool SimplifyCFGOpt::SimplifySwitch(SwitchInst *SI, IRBuilder<> &Builder) {
Chris Lattner3d512132010-12-13 06:25:44 +00003232 // If this switch is too complex to want to look at, ignore it.
3233 if (!isValueEqualityComparison(SI))
3234 return false;
3235
3236 BasicBlock *BB = SI->getParent();
3237
3238 // If we only have one predecessor, and if it is a branch on this value,
3239 // see if that predecessor totally determines the outcome of this switch.
3240 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
Devang Patel007349d2011-05-18 20:35:38 +00003241 if (SimplifyEqualityComparisonWithOnlyPredecessor(SI, OnlyPred, Builder))
Chris Lattner021c9d32010-12-13 06:36:51 +00003242 return SimplifyCFG(BB) | true;
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00003243
3244 Value *Cond = SI->getCondition();
3245 if (SelectInst *Select = dyn_cast<SelectInst>(Cond))
3246 if (SimplifySwitchOnSelect(SI, Select))
3247 return SimplifyCFG(BB) | true;
3248
Chris Lattner3d512132010-12-13 06:25:44 +00003249 // If the block only contains the switch, see if we can fold the block
3250 // away into any preds.
3251 BasicBlock::iterator BBI = BB->begin();
3252 // Ignore dbg intrinsics.
3253 while (isa<DbgInfoIntrinsic>(BBI))
3254 ++BBI;
3255 if (SI == &*BBI)
Devang Patelb55d9242011-05-18 20:53:17 +00003256 if (FoldValueComparisonIntoPredecessors(SI, Builder))
Chris Lattner021c9d32010-12-13 06:36:51 +00003257 return SimplifyCFG(BB) | true;
Benjamin Kramer56442df2011-02-02 15:56:22 +00003258
3259 // Try to transform the switch into an icmp and a branch.
Devang Patel007349d2011-05-18 20:35:38 +00003260 if (TurnSwitchRangeIntoICmp(SI, Builder))
Benjamin Kramer56442df2011-02-02 15:56:22 +00003261 return SimplifyCFG(BB) | true;
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003262
3263 // Remove unreachable cases.
3264 if (EliminateDeadSwitchCases(SI))
3265 return SimplifyCFG(BB) | true;
3266
Hans Wennborg448da512011-06-18 10:28:47 +00003267 if (ForwardSwitchConditionToPHI(SI))
3268 return SimplifyCFG(BB) | true;
3269
Hans Wennborg486270a2012-09-06 09:43:28 +00003270 if (SwitchToLookupTable(SI, Builder))
3271 return SimplifyCFG(BB) | true;
3272
Chris Lattner3d512132010-12-13 06:25:44 +00003273 return false;
3274}
3275
3276bool SimplifyCFGOpt::SimplifyIndirectBr(IndirectBrInst *IBI) {
3277 BasicBlock *BB = IBI->getParent();
3278 bool Changed = false;
Andrew Trick6b014382012-08-29 21:46:36 +00003279
Chris Lattner3d512132010-12-13 06:25:44 +00003280 // Eliminate redundant destinations.
3281 SmallPtrSet<Value *, 8> Succs;
3282 for (unsigned i = 0, e = IBI->getNumDestinations(); i != e; ++i) {
3283 BasicBlock *Dest = IBI->getDestination(i);
3284 if (!Dest->hasAddressTaken() || !Succs.insert(Dest)) {
3285 Dest->removePredecessor(BB);
3286 IBI->removeDestination(i);
3287 --i; --e;
3288 Changed = true;
3289 }
Andrew Trick6b014382012-08-29 21:46:36 +00003290 }
Chris Lattner3d512132010-12-13 06:25:44 +00003291
3292 if (IBI->getNumDestinations() == 0) {
3293 // If the indirectbr has no successors, change it to unreachable.
3294 new UnreachableInst(IBI->getContext(), IBI);
3295 EraseTerminatorInstAndDCECond(IBI);
3296 return true;
3297 }
Andrew Trick6b014382012-08-29 21:46:36 +00003298
Chris Lattner3d512132010-12-13 06:25:44 +00003299 if (IBI->getNumDestinations() == 1) {
3300 // If the indirectbr has one successor, change it to a direct branch.
3301 BranchInst::Create(IBI->getDestination(0), IBI);
3302 EraseTerminatorInstAndDCECond(IBI);
3303 return true;
3304 }
Andrew Trick6b014382012-08-29 21:46:36 +00003305
Chris Lattner3d512132010-12-13 06:25:44 +00003306 if (SelectInst *SI = dyn_cast<SelectInst>(IBI->getAddress())) {
3307 if (SimplifyIndirectBrOnSelect(IBI, SI))
3308 return SimplifyCFG(BB) | true;
3309 }
3310 return Changed;
3311}
3312
Devang Patela23812c2011-05-18 18:28:48 +00003313bool SimplifyCFGOpt::SimplifyUncondBranch(BranchInst *BI, IRBuilder<> &Builder){
Chris Lattner3d512132010-12-13 06:25:44 +00003314 BasicBlock *BB = BI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00003315
Chris Lattner3d512132010-12-13 06:25:44 +00003316 // If the Terminator is the only non-phi instruction, simplify the block.
Rafael Espindola77a2c372011-06-30 20:14:24 +00003317 BasicBlock::iterator I = BB->getFirstNonPHIOrDbgOrLifetime();
Chris Lattner3d512132010-12-13 06:25:44 +00003318 if (I->isTerminator() && BB != &BB->getParent()->getEntryBlock() &&
3319 TryToSimplifyUncondBranchFromEmptyBlock(BB))
3320 return true;
Andrew Trick6b014382012-08-29 21:46:36 +00003321
Chris Lattner3d512132010-12-13 06:25:44 +00003322 // If the only instruction in the block is a seteq/setne comparison
3323 // against a constant, try to simplify the block.
3324 if (ICmpInst *ICI = dyn_cast<ICmpInst>(I))
3325 if (ICI->isEquality() && isa<ConstantInt>(ICI->getOperand(1))) {
3326 for (++I; isa<DbgInfoIntrinsic>(I); ++I)
3327 ;
Nick Lewycky9d523102011-12-26 20:37:40 +00003328 if (I->isTerminator() &&
3329 TryToSimplifyUncondBranchWithICmpInIt(ICI, TD, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00003330 return true;
3331 }
Andrew Trick6b014382012-08-29 21:46:36 +00003332
Manman Renee28e0f2012-06-13 05:43:29 +00003333 // If this basic block is ONLY a compare and a branch, and if a predecessor
3334 // branches to us and our successor, fold the comparison into the
3335 // predecessor and use logical operations to update the incoming value
3336 // for PHI nodes in common successor.
3337 if (FoldBranchToCommonDest(BI))
3338 return SimplifyCFG(BB) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003339 return false;
3340}
3341
3342
Devang Patel007349d2011-05-18 20:35:38 +00003343bool SimplifyCFGOpt::SimplifyCondBranch(BranchInst *BI, IRBuilder<> &Builder) {
Chris Lattner3d512132010-12-13 06:25:44 +00003344 BasicBlock *BB = BI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00003345
Chris Lattner3d512132010-12-13 06:25:44 +00003346 // Conditional branch
3347 if (isValueEqualityComparison(BI)) {
3348 // If we only have one predecessor, and if it is a branch on this value,
3349 // see if that predecessor totally determines the outcome of this
3350 // switch.
3351 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
Devang Patel007349d2011-05-18 20:35:38 +00003352 if (SimplifyEqualityComparisonWithOnlyPredecessor(BI, OnlyPred, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00003353 return SimplifyCFG(BB) | true;
Andrew Trick6b014382012-08-29 21:46:36 +00003354
Chris Lattner3d512132010-12-13 06:25:44 +00003355 // This block must be empty, except for the setcond inst, if it exists.
3356 // Ignore dbg intrinsics.
3357 BasicBlock::iterator I = BB->begin();
3358 // Ignore dbg intrinsics.
3359 while (isa<DbgInfoIntrinsic>(I))
3360 ++I;
3361 if (&*I == BI) {
Devang Patelb55d9242011-05-18 20:53:17 +00003362 if (FoldValueComparisonIntoPredecessors(BI, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00003363 return SimplifyCFG(BB) | true;
3364 } else if (&*I == cast<Instruction>(BI->getCondition())){
3365 ++I;
3366 // Ignore dbg intrinsics.
3367 while (isa<DbgInfoIntrinsic>(I))
3368 ++I;
Devang Patelb55d9242011-05-18 20:53:17 +00003369 if (&*I == BI && FoldValueComparisonIntoPredecessors(BI, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00003370 return SimplifyCFG(BB) | true;
3371 }
3372 }
Andrew Trick6b014382012-08-29 21:46:36 +00003373
Chris Lattner3d512132010-12-13 06:25:44 +00003374 // Try to turn "br (X == 0 | X == 1), T, F" into a switch instruction.
Devang Patel02dd5412011-05-18 23:18:47 +00003375 if (SimplifyBranchOnICmpChain(BI, TD, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00003376 return true;
Andrew Trick6b014382012-08-29 21:46:36 +00003377
Dan Gohman3b205172012-01-05 23:58:56 +00003378 // If this basic block is ONLY a compare and a branch, and if a predecessor
3379 // branches to us and one of our successors, fold the comparison into the
3380 // predecessor and use logical operations to pick the right destination.
3381 if (FoldBranchToCommonDest(BI))
3382 return SimplifyCFG(BB) | true;
Andrew Trick6b014382012-08-29 21:46:36 +00003383
Chris Lattner3d512132010-12-13 06:25:44 +00003384 // We have a conditional branch to two blocks that are only reachable
3385 // from BI. We know that the condbr dominates the two blocks, so see if
3386 // there is any identical code in the "then" and "else" blocks. If so, we
3387 // can hoist it up to the branching block.
3388 if (BI->getSuccessor(0)->getSinglePredecessor() != 0) {
3389 if (BI->getSuccessor(1)->getSinglePredecessor() != 0) {
Rafael Espindola216dde92011-05-19 02:26:30 +00003390 if (HoistThenElseCodeToIf(BI))
Chris Lattner3d512132010-12-13 06:25:44 +00003391 return SimplifyCFG(BB) | true;
3392 } else {
3393 // If Successor #1 has multiple preds, we may be able to conditionally
3394 // execute Successor #0 if it branches to successor #1.
3395 TerminatorInst *Succ0TI = BI->getSuccessor(0)->getTerminator();
3396 if (Succ0TI->getNumSuccessors() == 1 &&
3397 Succ0TI->getSuccessor(0) == BI->getSuccessor(1))
Rafael Espindola216dde92011-05-19 02:26:30 +00003398 if (SpeculativelyExecuteBB(BI, BI->getSuccessor(0)))
Chris Lattner3d512132010-12-13 06:25:44 +00003399 return SimplifyCFG(BB) | true;
3400 }
3401 } else if (BI->getSuccessor(1)->getSinglePredecessor() != 0) {
3402 // If Successor #0 has multiple preds, we may be able to conditionally
3403 // execute Successor #1 if it branches to successor #0.
3404 TerminatorInst *Succ1TI = BI->getSuccessor(1)->getTerminator();
3405 if (Succ1TI->getNumSuccessors() == 1 &&
3406 Succ1TI->getSuccessor(0) == BI->getSuccessor(0))
Rafael Espindola216dde92011-05-19 02:26:30 +00003407 if (SpeculativelyExecuteBB(BI, BI->getSuccessor(1)))
Chris Lattner3d512132010-12-13 06:25:44 +00003408 return SimplifyCFG(BB) | true;
3409 }
Andrew Trick6b014382012-08-29 21:46:36 +00003410
Chris Lattner3d512132010-12-13 06:25:44 +00003411 // If this is a branch on a phi node in the current block, thread control
3412 // through this block if any PHI node entries are constants.
3413 if (PHINode *PN = dyn_cast<PHINode>(BI->getCondition()))
3414 if (PN->getParent() == BI->getParent())
Chris Lattner302ba6f2010-12-14 06:17:25 +00003415 if (FoldCondBranchOnPHI(BI, TD))
Chris Lattner3d512132010-12-13 06:25:44 +00003416 return SimplifyCFG(BB) | true;
Andrew Trick6b014382012-08-29 21:46:36 +00003417
Chris Lattner3d512132010-12-13 06:25:44 +00003418 // Scan predecessor blocks for conditional branches.
3419 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
3420 if (BranchInst *PBI = dyn_cast<BranchInst>((*PI)->getTerminator()))
3421 if (PBI != BI && PBI->isConditional())
3422 if (SimplifyCondBranchToCondBranch(PBI, BI))
3423 return SimplifyCFG(BB) | true;
3424
3425 return false;
3426}
3427
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003428/// Check if passing a value to an instruction will cause undefined behavior.
3429static bool passingValueIsAlwaysUndefined(Value *V, Instruction *I) {
3430 Constant *C = dyn_cast<Constant>(V);
3431 if (!C)
3432 return false;
3433
Benjamin Kramer9bb54882011-08-26 02:25:55 +00003434 if (!I->hasOneUse()) // Only look at single-use instructions, for compile time
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003435 return false;
3436
3437 if (C->isNullValue()) {
3438 Instruction *Use = I->use_back();
3439
3440 // Now make sure that there are no instructions in between that can alter
3441 // control flow (eg. calls)
3442 for (BasicBlock::iterator i = ++BasicBlock::iterator(I); &*i != Use; ++i)
Benjamin Kramer9bb54882011-08-26 02:25:55 +00003443 if (i == I->getParent()->end() || i->mayHaveSideEffects())
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003444 return false;
3445
3446 // Look through GEPs. A load from a GEP derived from NULL is still undefined
3447 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Use))
3448 if (GEP->getPointerOperand() == I)
3449 return passingValueIsAlwaysUndefined(V, GEP);
3450
3451 // Look through bitcasts.
3452 if (BitCastInst *BC = dyn_cast<BitCastInst>(Use))
3453 return passingValueIsAlwaysUndefined(V, BC);
3454
Benjamin Kramer9bb54882011-08-26 02:25:55 +00003455 // Load from null is undefined.
3456 if (LoadInst *LI = dyn_cast<LoadInst>(Use))
3457 return LI->getPointerAddressSpace() == 0;
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003458
Benjamin Kramer9bb54882011-08-26 02:25:55 +00003459 // Store to null is undefined.
3460 if (StoreInst *SI = dyn_cast<StoreInst>(Use))
3461 return SI->getPointerAddressSpace() == 0 && SI->getPointerOperand() == I;
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003462 }
3463 return false;
3464}
3465
3466/// If BB has an incoming value that will always trigger undefined behavior
Nick Lewycky9d523102011-12-26 20:37:40 +00003467/// (eg. null pointer dereference), remove the branch leading here.
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003468static bool removeUndefIntroducingPredecessor(BasicBlock *BB) {
3469 for (BasicBlock::iterator i = BB->begin();
3470 PHINode *PHI = dyn_cast<PHINode>(i); ++i)
3471 for (unsigned i = 0, e = PHI->getNumIncomingValues(); i != e; ++i)
3472 if (passingValueIsAlwaysUndefined(PHI->getIncomingValue(i), PHI)) {
3473 TerminatorInst *T = PHI->getIncomingBlock(i)->getTerminator();
3474 IRBuilder<> Builder(T);
3475 if (BranchInst *BI = dyn_cast<BranchInst>(T)) {
3476 BB->removePredecessor(PHI->getIncomingBlock(i));
3477 // Turn uncoditional branches into unreachables and remove the dead
3478 // destination from conditional branches.
3479 if (BI->isUnconditional())
3480 Builder.CreateUnreachable();
3481 else
3482 Builder.CreateBr(BI->getSuccessor(0) == BB ? BI->getSuccessor(1) :
3483 BI->getSuccessor(0));
3484 BI->eraseFromParent();
3485 return true;
3486 }
3487 // TODO: SwitchInst.
3488 }
3489
3490 return false;
3491}
3492
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +00003493bool SimplifyCFGOpt::run(BasicBlock *BB) {
Chris Lattnerdc3602b2003-08-24 18:36:16 +00003494 bool Changed = false;
Chris Lattner01d1ee32002-05-21 20:50:24 +00003495
Chris Lattner302ba6f2010-12-14 06:17:25 +00003496 assert(BB && BB->getParent() && "Block not embedded in function!");
Chris Lattner01d1ee32002-05-21 20:50:24 +00003497 assert(BB->getTerminator() && "Degenerate basic block encountered!");
Chris Lattner01d1ee32002-05-21 20:50:24 +00003498
Dan Gohmane2c6d132010-08-14 00:29:42 +00003499 // Remove basic blocks that have no predecessors (except the entry block)...
3500 // or that just have themself as a predecessor. These are unreachable.
Chris Lattner302ba6f2010-12-14 06:17:25 +00003501 if ((pred_begin(BB) == pred_end(BB) &&
3502 BB != &BB->getParent()->getEntryBlock()) ||
Dan Gohmane2c6d132010-08-14 00:29:42 +00003503 BB->getSinglePredecessor() == BB) {
David Greene89d6fd32010-01-05 01:26:52 +00003504 DEBUG(dbgs() << "Removing BB: \n" << *BB);
Chris Lattner71af9b02008-12-03 06:40:52 +00003505 DeleteDeadBlock(BB);
Chris Lattner01d1ee32002-05-21 20:50:24 +00003506 return true;
3507 }
3508
Chris Lattner694e37f2003-08-17 19:41:53 +00003509 // Check to see if we can constant propagate this terminator instruction
3510 // away...
Frits van Bommel5649ba72011-05-22 16:24:18 +00003511 Changed |= ConstantFoldTerminator(BB, true);
Chris Lattner694e37f2003-08-17 19:41:53 +00003512
Dan Gohman2c635662009-10-30 22:39:04 +00003513 // Check for and eliminate duplicate PHI nodes in this block.
3514 Changed |= EliminateDuplicatePHINodes(BB);
3515
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003516 // Check for and remove branches that will always cause undefined behavior.
3517 Changed |= removeUndefIntroducingPredecessor(BB);
3518
Chris Lattnerddb97a22010-12-13 05:10:48 +00003519 // Merge basic blocks into their predecessor if there is only one distinct
3520 // pred, and if there is only one distinct successor of the predecessor, and
3521 // if there are no PHI nodes.
3522 //
3523 if (MergeBlockIntoPredecessor(BB))
3524 return true;
Andrew Trick6b014382012-08-29 21:46:36 +00003525
Devang Patel3e410c62011-05-18 18:01:27 +00003526 IRBuilder<> Builder(BB);
3527
Dan Gohman882d87d2008-03-11 21:53:06 +00003528 // If there is a trivial two-entry PHI node in this basic block, and we can
3529 // eliminate it, do so now.
3530 if (PHINode *PN = dyn_cast<PHINode>(BB->begin()))
3531 if (PN->getNumIncomingValues() == 2)
Devang Pateld3a17882011-05-19 20:52:46 +00003532 Changed |= FoldTwoEntryPHINode(PN, TD);
Dan Gohman882d87d2008-03-11 21:53:06 +00003533
Devang Patel007349d2011-05-18 20:35:38 +00003534 Builder.SetInsertPoint(BB->getTerminator());
Chris Lattner3d512132010-12-13 06:25:44 +00003535 if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) {
Chris Lattner021c9d32010-12-13 06:36:51 +00003536 if (BI->isUnconditional()) {
Devang Patela23812c2011-05-18 18:28:48 +00003537 if (SimplifyUncondBranch(BI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00003538 } else {
Devang Patel007349d2011-05-18 20:35:38 +00003539 if (SimplifyCondBranch(BI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00003540 }
3541 } else if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
Devang Patel176ec402011-05-18 21:33:11 +00003542 if (SimplifyReturn(RI, Builder)) return true;
Bill Wendlingaa5abe82012-02-06 21:16:41 +00003543 } else if (ResumeInst *RI = dyn_cast<ResumeInst>(BB->getTerminator())) {
3544 if (SimplifyResume(RI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00003545 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
Devang Patel007349d2011-05-18 20:35:38 +00003546 if (SimplifySwitch(SI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00003547 } else if (UnreachableInst *UI =
3548 dyn_cast<UnreachableInst>(BB->getTerminator())) {
3549 if (SimplifyUnreachable(UI)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00003550 } else if (IndirectBrInst *IBI =
3551 dyn_cast<IndirectBrInst>(BB->getTerminator())) {
3552 if (SimplifyIndirectBr(IBI)) return true;
Chris Lattner19831ec2004-02-16 06:35:48 +00003553 }
3554
Chris Lattner694e37f2003-08-17 19:41:53 +00003555 return Changed;
Chris Lattner01d1ee32002-05-21 20:50:24 +00003556}
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +00003557
3558/// SimplifyCFG - This function is used to do simplification of a CFG. For
3559/// example, it adjusts branches to branches to eliminate the extra hop, it
3560/// eliminates unreachable basic blocks, and does other "peephole" optimization
3561/// of the CFG. It returns true if a modification was made.
3562///
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +00003563bool llvm::SimplifyCFG(BasicBlock *BB, const TargetData *TD) {
3564 return SimplifyCFGOpt(TD).run(BB);
3565}