blob: c4c142301bf29d3b1389ddfa6f94e810b2fa28e5 [file] [log] [blame]
Chris Lattner01d1ee32002-05-21 20:50:24 +00001//===- SimplifyCFG.cpp - Code to perform CFG simplification ---------------===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanfd939082005-04-21 23:48:37 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner01d1ee32002-05-21 20:50:24 +00009//
Chris Lattnerbb190ac2002-10-08 21:36:33 +000010// Peephole optimize the CFG.
Chris Lattner01d1ee32002-05-21 20:50:24 +000011//
12//===----------------------------------------------------------------------===//
13
Chris Lattner218a8222004-06-20 01:13:18 +000014#define DEBUG_TYPE "simplifycfg"
Chris Lattner01d1ee32002-05-21 20:50:24 +000015#include "llvm/Transforms/Utils/Local.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000016#include "llvm/ADT/DenseMap.h"
17#include "llvm/ADT/STLExtras.h"
18#include "llvm/ADT/SetVector.h"
19#include "llvm/ADT/SmallPtrSet.h"
20#include "llvm/ADT/SmallVector.h"
21#include "llvm/ADT/Statistic.h"
22#include "llvm/Analysis/InstructionSimplify.h"
Chandler Carruthbe049292013-01-07 03:08:10 +000023#include "llvm/Analysis/TargetTransformInfo.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000024#include "llvm/Analysis/ValueTracking.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000025#include "llvm/IR/Constants.h"
26#include "llvm/IR/DataLayout.h"
27#include "llvm/IR/DerivedTypes.h"
28#include "llvm/IR/GlobalVariable.h"
29#include "llvm/IR/IRBuilder.h"
30#include "llvm/IR/Instructions.h"
31#include "llvm/IR/IntrinsicInst.h"
32#include "llvm/IR/LLVMContext.h"
33#include "llvm/IR/MDBuilder.h"
34#include "llvm/IR/Metadata.h"
35#include "llvm/IR/Module.h"
36#include "llvm/IR/Operator.h"
37#include "llvm/IR/Type.h"
Chris Lattner302ba6f2010-12-14 06:17:25 +000038#include "llvm/Support/CFG.h"
Evan Chengc3f507f2011-01-29 04:46:23 +000039#include "llvm/Support/CommandLine.h"
Chris Lattnere27db742010-12-17 06:20:15 +000040#include "llvm/Support/ConstantRange.h"
Chris Lattner302ba6f2010-12-14 06:17:25 +000041#include "llvm/Support/Debug.h"
Devang Pateld3a17882011-05-19 20:52:46 +000042#include "llvm/Support/NoFolder.h"
Benjamin Kramer32d15d92013-07-04 14:22:02 +000043#include "llvm/Support/PatternMatch.h"
Chris Lattner302ba6f2010-12-14 06:17:25 +000044#include "llvm/Support/raw_ostream.h"
Chandler Carruth06cb8ed2012-06-29 12:38:19 +000045#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Chris Lattner01d1ee32002-05-21 20:50:24 +000046#include <algorithm>
Chris Lattner698f96f2004-10-18 04:07:22 +000047#include <map>
Chandler Carruthd04a8d42012-12-03 16:50:05 +000048#include <set>
Chris Lattnerf7703df2004-01-09 06:12:26 +000049using namespace llvm;
Benjamin Kramer32d15d92013-07-04 14:22:02 +000050using namespace PatternMatch;
Brian Gaeked0fde302003-11-11 22:41:34 +000051
Peter Collingbourne57808b32011-04-29 18:47:38 +000052static cl::opt<unsigned>
53PHINodeFoldingThreshold("phi-node-folding-threshold", cl::Hidden, cl::init(1),
54 cl::desc("Control the amount of phi node folding to perform (default = 1)"));
55
Evan Chengc3f507f2011-01-29 04:46:23 +000056static cl::opt<bool>
57DupRet("simplifycfg-dup-ret", cl::Hidden, cl::init(false),
58 cl::desc("Duplicate return instructions into unconditional branches"));
59
Manman Ren554da1a2012-09-20 22:37:36 +000060static cl::opt<bool>
61SinkCommon("simplifycfg-sink-common", cl::Hidden, cl::init(true),
62 cl::desc("Sink common instructions down to the end block"));
63
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +000064static cl::opt<bool>
65HoistCondStores("simplifycfg-hoist-cond-stores", cl::Hidden, cl::init(true),
66 cl::desc("Hoist conditional stores if an unconditional store preceeds"));
67
Hans Wennborgd72271c2012-09-26 09:44:49 +000068STATISTIC(NumBitMaps, "Number of switch instructions turned into bitmaps");
Hans Wennborg50b7d702012-09-26 14:01:53 +000069STATISTIC(NumLookupTables, "Number of switch instructions turned into lookup tables");
Manman Ren554da1a2012-09-20 22:37:36 +000070STATISTIC(NumSinkCommons, "Number of common instructions sunk down to the end block");
Hans Wennborg50b7d702012-09-26 14:01:53 +000071STATISTIC(NumSpeculations, "Number of speculative executed instructions");
Evan Cheng502a4f52008-06-12 21:15:59 +000072
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000073namespace {
Eric Christopherc723eb12012-07-02 23:22:21 +000074 /// ValueEqualityComparisonCase - Represents a case of a switch.
75 struct ValueEqualityComparisonCase {
76 ConstantInt *Value;
77 BasicBlock *Dest;
78
79 ValueEqualityComparisonCase(ConstantInt *Value, BasicBlock *Dest)
80 : Value(Value), Dest(Dest) {}
81
82 bool operator<(ValueEqualityComparisonCase RHS) const {
83 // Comparing pointers is ok as we only rely on the order for uniquing.
84 return Value < RHS.Value;
85 }
Benjamin Kramer8e13ded2012-10-14 11:15:42 +000086
87 bool operator==(BasicBlock *RHSDest) const { return Dest == RHSDest; }
Eric Christopherc723eb12012-07-02 23:22:21 +000088 };
89
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000090class SimplifyCFGOpt {
Chandler Carruth5f46c3c2013-01-07 03:53:25 +000091 const TargetTransformInfo &TTI;
Micah Villmow3574eca2012-10-08 16:38:25 +000092 const DataLayout *const TD;
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000093 Value *isValueEqualityComparison(TerminatorInst *TI);
94 BasicBlock *GetValueEqualityComparisonCases(TerminatorInst *TI,
Eric Christopherc723eb12012-07-02 23:22:21 +000095 std::vector<ValueEqualityComparisonCase> &Cases);
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000096 bool SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
Devang Patel007349d2011-05-18 20:35:38 +000097 BasicBlock *Pred,
98 IRBuilder<> &Builder);
Devang Patelb55d9242011-05-18 20:53:17 +000099 bool FoldValueComparisonIntoPredecessors(TerminatorInst *TI,
100 IRBuilder<> &Builder);
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000101
Devang Patel176ec402011-05-18 21:33:11 +0000102 bool SimplifyReturn(ReturnInst *RI, IRBuilder<> &Builder);
Bill Wendlingaa5abe82012-02-06 21:16:41 +0000103 bool SimplifyResume(ResumeInst *RI, IRBuilder<> &Builder);
Chris Lattner3d512132010-12-13 06:25:44 +0000104 bool SimplifyUnreachable(UnreachableInst *UI);
Devang Patel007349d2011-05-18 20:35:38 +0000105 bool SimplifySwitch(SwitchInst *SI, IRBuilder<> &Builder);
Chris Lattner3d512132010-12-13 06:25:44 +0000106 bool SimplifyIndirectBr(IndirectBrInst *IBI);
Devang Patela23812c2011-05-18 18:28:48 +0000107 bool SimplifyUncondBranch(BranchInst *BI, IRBuilder <> &Builder);
Devang Patel007349d2011-05-18 20:35:38 +0000108 bool SimplifyCondBranch(BranchInst *BI, IRBuilder <>&Builder);
Chris Lattner3d512132010-12-13 06:25:44 +0000109
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000110public:
Tom Stellard01d72032013-08-06 02:43:45 +0000111 SimplifyCFGOpt(const TargetTransformInfo &TTI, const DataLayout *TD)
112 : TTI(TTI), TD(TD) {}
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000113 bool run(BasicBlock *BB);
114};
115}
116
Chris Lattner2bdcb562005-08-03 00:19:45 +0000117/// SafeToMergeTerminators - Return true if it is safe to merge these two
118/// terminator instructions together.
119///
120static bool SafeToMergeTerminators(TerminatorInst *SI1, TerminatorInst *SI2) {
121 if (SI1 == SI2) return false; // Can't merge with self!
Andrew Trick6b014382012-08-29 21:46:36 +0000122
Chris Lattner2bdcb562005-08-03 00:19:45 +0000123 // It is not safe to merge these two switch instructions if they have a common
124 // successor, and if that successor has a PHI node, and if *that* PHI node has
125 // conflicting incoming values from the two switch blocks.
126 BasicBlock *SI1BB = SI1->getParent();
127 BasicBlock *SI2BB = SI2->getParent();
Chris Lattnerc9951232007-04-02 01:44:59 +0000128 SmallPtrSet<BasicBlock*, 16> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
Andrew Trick6b014382012-08-29 21:46:36 +0000129
Chris Lattner2bdcb562005-08-03 00:19:45 +0000130 for (succ_iterator I = succ_begin(SI2BB), E = succ_end(SI2BB); I != E; ++I)
131 if (SI1Succs.count(*I))
132 for (BasicBlock::iterator BBI = (*I)->begin();
133 isa<PHINode>(BBI); ++BBI) {
134 PHINode *PN = cast<PHINode>(BBI);
135 if (PN->getIncomingValueForBlock(SI1BB) !=
136 PN->getIncomingValueForBlock(SI2BB))
137 return false;
138 }
Andrew Trick6b014382012-08-29 21:46:36 +0000139
Chris Lattner2bdcb562005-08-03 00:19:45 +0000140 return true;
141}
142
Manman Renee28e0f2012-06-13 05:43:29 +0000143/// isProfitableToFoldUnconditional - Return true if it is safe and profitable
144/// to merge these two terminator instructions together, where SI1 is an
145/// unconditional branch. PhiNodes will store all PHI nodes in common
146/// successors.
147///
148static bool isProfitableToFoldUnconditional(BranchInst *SI1,
149 BranchInst *SI2,
Nick Lewyckyedb58422012-06-24 10:15:42 +0000150 Instruction *Cond,
Manman Renee28e0f2012-06-13 05:43:29 +0000151 SmallVectorImpl<PHINode*> &PhiNodes) {
152 if (SI1 == SI2) return false; // Can't merge with self!
153 assert(SI1->isUnconditional() && SI2->isConditional());
154
155 // We fold the unconditional branch if we can easily update all PHI nodes in
Andrew Trick6b014382012-08-29 21:46:36 +0000156 // common successors:
Manman Renee28e0f2012-06-13 05:43:29 +0000157 // 1> We have a constant incoming value for the conditional branch;
158 // 2> We have "Cond" as the incoming value for the unconditional branch;
159 // 3> SI2->getCondition() and Cond have same operands.
160 CmpInst *Ci2 = dyn_cast<CmpInst>(SI2->getCondition());
161 if (!Ci2) return false;
162 if (!(Cond->getOperand(0) == Ci2->getOperand(0) &&
163 Cond->getOperand(1) == Ci2->getOperand(1)) &&
164 !(Cond->getOperand(0) == Ci2->getOperand(1) &&
165 Cond->getOperand(1) == Ci2->getOperand(0)))
166 return false;
167
168 BasicBlock *SI1BB = SI1->getParent();
169 BasicBlock *SI2BB = SI2->getParent();
170 SmallPtrSet<BasicBlock*, 16> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
171 for (succ_iterator I = succ_begin(SI2BB), E = succ_end(SI2BB); I != E; ++I)
172 if (SI1Succs.count(*I))
173 for (BasicBlock::iterator BBI = (*I)->begin();
174 isa<PHINode>(BBI); ++BBI) {
175 PHINode *PN = cast<PHINode>(BBI);
176 if (PN->getIncomingValueForBlock(SI1BB) != Cond ||
Nick Lewyckyedb58422012-06-24 10:15:42 +0000177 !isa<ConstantInt>(PN->getIncomingValueForBlock(SI2BB)))
Manman Renee28e0f2012-06-13 05:43:29 +0000178 return false;
179 PhiNodes.push_back(PN);
180 }
181 return true;
182}
183
Chris Lattner2bdcb562005-08-03 00:19:45 +0000184/// AddPredecessorToBlock - Update PHI nodes in Succ to indicate that there will
185/// now be entries in it from the 'NewPred' block. The values that will be
186/// flowing into the PHI nodes will be the same as those coming in from
187/// ExistPred, an existing predecessor of Succ.
188static void AddPredecessorToBlock(BasicBlock *Succ, BasicBlock *NewPred,
189 BasicBlock *ExistPred) {
Chris Lattner2bdcb562005-08-03 00:19:45 +0000190 if (!isa<PHINode>(Succ->begin())) return; // Quick exit if nothing to do
Andrew Trick6b014382012-08-29 21:46:36 +0000191
Chris Lattner093a4382008-07-13 22:23:11 +0000192 PHINode *PN;
193 for (BasicBlock::iterator I = Succ->begin();
194 (PN = dyn_cast<PHINode>(I)); ++I)
195 PN->addIncoming(PN->getIncomingValueForBlock(ExistPred), NewPred);
Chris Lattner2bdcb562005-08-03 00:19:45 +0000196}
197
David Majnemerf7dad782013-06-01 19:43:23 +0000198/// ComputeSpeculationCost - Compute an abstract "cost" of speculating the
Dan Gohman3b205172012-01-05 23:58:56 +0000199/// given instruction, which is assumed to be safe to speculate. 1 means
200/// cheap, 2 means less cheap, and UINT_MAX means prohibitively expensive.
201static unsigned ComputeSpeculationCost(const User *I) {
202 assert(isSafeToSpeculativelyExecute(I) &&
203 "Instruction is not safe to speculatively execute!");
204 switch (Operator::getOpcode(I)) {
205 default:
206 // In doubt, be conservative.
207 return UINT_MAX;
208 case Instruction::GetElementPtr:
209 // GEPs are cheap if all indices are constant.
210 if (!cast<GEPOperator>(I)->hasAllConstantIndices())
211 return UINT_MAX;
212 return 1;
213 case Instruction::Load:
214 case Instruction::Add:
215 case Instruction::Sub:
216 case Instruction::And:
217 case Instruction::Or:
218 case Instruction::Xor:
219 case Instruction::Shl:
220 case Instruction::LShr:
221 case Instruction::AShr:
222 case Instruction::ICmp:
223 case Instruction::Trunc:
224 case Instruction::ZExt:
225 case Instruction::SExt:
226 return 1; // These are all cheap.
227
228 case Instruction::Call:
229 case Instruction::Select:
230 return 2;
231 }
232}
233
Bill Wendling5049fa62009-01-19 23:43:56 +0000234/// DominatesMergePoint - If we have a merge point of an "if condition" as
235/// accepted above, return true if the specified value dominates the block. We
236/// don't handle the true generality of domination here, just a special case
237/// which works well enough for us.
238///
239/// If AggressiveInsts is non-null, and if V does not dominate BB, we check to
Peter Collingbournef15907f2011-04-29 18:47:31 +0000240/// see if V (which must be an instruction) and its recursive operands
241/// that do not dominate BB have a combined cost lower than CostRemaining and
242/// are non-trapping. If both are true, the instruction is inserted into the
243/// set and true is returned.
244///
245/// The cost for most non-trapping instructions is defined as 1 except for
246/// Select whose cost is 2.
247///
248/// After this function returns, CostRemaining is decreased by the cost of
249/// V plus its non-dominating operands. If that cost is greater than
250/// CostRemaining, false is returned and CostRemaining is undefined.
Chris Lattner9c078662004-10-14 05:13:36 +0000251static bool DominatesMergePoint(Value *V, BasicBlock *BB,
Peter Collingbournef15907f2011-04-29 18:47:31 +0000252 SmallPtrSet<Instruction*, 4> *AggressiveInsts,
253 unsigned &CostRemaining) {
Chris Lattner570751c2004-04-09 22:50:22 +0000254 Instruction *I = dyn_cast<Instruction>(V);
Chris Lattnerb74b1812006-10-20 00:42:07 +0000255 if (!I) {
256 // Non-instructions all dominate instructions, but not all constantexprs
257 // can be executed unconditionally.
258 if (ConstantExpr *C = dyn_cast<ConstantExpr>(V))
259 if (C->canTrap())
260 return false;
261 return true;
262 }
Chris Lattner570751c2004-04-09 22:50:22 +0000263 BasicBlock *PBB = I->getParent();
Chris Lattner723c66d2004-02-11 03:36:04 +0000264
Chris Lattnerda895d62005-02-27 06:18:25 +0000265 // We don't want to allow weird loops that might have the "if condition" in
Chris Lattner570751c2004-04-09 22:50:22 +0000266 // the bottom of this block.
267 if (PBB == BB) return false;
Chris Lattner723c66d2004-02-11 03:36:04 +0000268
Chris Lattner570751c2004-04-09 22:50:22 +0000269 // If this instruction is defined in a block that contains an unconditional
270 // branch to BB, then it must be in the 'conditional' part of the "if
Chris Lattner44da7ca2010-12-14 07:41:39 +0000271 // statement". If not, it definitely dominates the region.
272 BranchInst *BI = dyn_cast<BranchInst>(PBB->getTerminator());
273 if (BI == 0 || BI->isConditional() || BI->getSuccessor(0) != BB)
274 return true;
Eli Friedman0b79a772009-07-17 04:28:42 +0000275
Chris Lattner44da7ca2010-12-14 07:41:39 +0000276 // If we aren't allowing aggressive promotion anymore, then don't consider
277 // instructions in the 'if region'.
278 if (AggressiveInsts == 0) return false;
Andrew Trick6b014382012-08-29 21:46:36 +0000279
Peter Collingbournef15907f2011-04-29 18:47:31 +0000280 // If we have seen this instruction before, don't count it again.
281 if (AggressiveInsts->count(I)) return true;
282
Chris Lattner44da7ca2010-12-14 07:41:39 +0000283 // Okay, it looks like the instruction IS in the "condition". Check to
284 // see if it's a cheap instruction to unconditionally compute, and if it
285 // only uses stuff defined outside of the condition. If so, hoist it out.
Dan Gohmanf0426602011-12-14 23:49:11 +0000286 if (!isSafeToSpeculativelyExecute(I))
Chris Lattner44da7ca2010-12-14 07:41:39 +0000287 return false;
Misha Brukmanfd939082005-04-21 23:48:37 +0000288
Dan Gohman3b205172012-01-05 23:58:56 +0000289 unsigned Cost = ComputeSpeculationCost(I);
Chris Lattner570751c2004-04-09 22:50:22 +0000290
Peter Collingbournef15907f2011-04-29 18:47:31 +0000291 if (Cost > CostRemaining)
292 return false;
293
294 CostRemaining -= Cost;
295
296 // Okay, we can only really hoist these out if their operands do
297 // not take us over the cost threshold.
Chris Lattner44da7ca2010-12-14 07:41:39 +0000298 for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i)
Peter Collingbournef15907f2011-04-29 18:47:31 +0000299 if (!DominatesMergePoint(*i, BB, AggressiveInsts, CostRemaining))
Chris Lattner44da7ca2010-12-14 07:41:39 +0000300 return false;
301 // Okay, it's safe to do this! Remember this instruction.
302 AggressiveInsts->insert(I);
Chris Lattner723c66d2004-02-11 03:36:04 +0000303 return true;
304}
Chris Lattner01d1ee32002-05-21 20:50:24 +0000305
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000306/// GetConstantInt - Extract ConstantInt from value, looking through IntToPtr
307/// and PointerNullValue. Return NULL if value is not a constant int.
Micah Villmow3574eca2012-10-08 16:38:25 +0000308static ConstantInt *GetConstantInt(Value *V, const DataLayout *TD) {
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000309 // Normal constant int.
310 ConstantInt *CI = dyn_cast<ConstantInt>(V);
Duncan Sands1df98592010-02-16 11:11:14 +0000311 if (CI || !TD || !isa<Constant>(V) || !V->getType()->isPointerTy())
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000312 return CI;
313
314 // This is some kind of pointer constant. Turn it into a pointer-sized
315 // ConstantInt if possible.
Duncan Sands7ed4f942012-10-29 17:31:46 +0000316 IntegerType *PtrTy = cast<IntegerType>(TD->getIntPtrType(V->getType()));
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000317
318 // Null pointer means 0, see SelectionDAGBuilder::getValue(const Value*).
319 if (isa<ConstantPointerNull>(V))
320 return ConstantInt::get(PtrTy, 0);
321
322 // IntToPtr const int.
323 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
324 if (CE->getOpcode() == Instruction::IntToPtr)
325 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(0))) {
326 // The constant is very likely to have the right type already.
327 if (CI->getType() == PtrTy)
328 return CI;
329 else
330 return cast<ConstantInt>
331 (ConstantExpr::getIntegerCast(CI, PtrTy, /*isSigned=*/false));
332 }
333 return 0;
334}
335
Chris Lattner0aa749b2010-12-13 04:26:26 +0000336/// GatherConstantCompares - Given a potentially 'or'd or 'and'd together
337/// collection of icmp eq/ne instructions that compare a value against a
338/// constant, return the value being compared, and stick the constant into the
339/// Values vector.
Chris Lattner28acc132010-12-13 03:30:12 +0000340static Value *
Chris Lattner0aa749b2010-12-13 04:26:26 +0000341GatherConstantCompares(Value *V, std::vector<ConstantInt*> &Vals, Value *&Extra,
Micah Villmow3574eca2012-10-08 16:38:25 +0000342 const DataLayout *TD, bool isEQ, unsigned &UsedICmps) {
Chris Lattner0aa749b2010-12-13 04:26:26 +0000343 Instruction *I = dyn_cast<Instruction>(V);
344 if (I == 0) return 0;
Andrew Trick6b014382012-08-29 21:46:36 +0000345
Chris Lattner7312a222010-12-13 04:50:38 +0000346 // If this is an icmp against a constant, handle this as one of the cases.
Chris Lattner0aa749b2010-12-13 04:26:26 +0000347 if (ICmpInst *ICI = dyn_cast<ICmpInst>(I)) {
Chris Lattnere27db742010-12-17 06:20:15 +0000348 if (ConstantInt *C = GetConstantInt(I->getOperand(1), TD)) {
Benjamin Kramer32d15d92013-07-04 14:22:02 +0000349 Value *RHSVal;
350 ConstantInt *RHSC;
351
Chris Lattnere27db742010-12-17 06:20:15 +0000352 if (ICI->getPredicate() == (isEQ ? ICmpInst::ICMP_EQ:ICmpInst::ICMP_NE)) {
Benjamin Kramer32d15d92013-07-04 14:22:02 +0000353 // (x & ~2^x) == y --> x == y || x == y|2^x
354 // This undoes a transformation done by instcombine to fuse 2 compares.
355 if (match(ICI->getOperand(0),
356 m_And(m_Value(RHSVal), m_ConstantInt(RHSC)))) {
357 APInt Not = ~RHSC->getValue();
358 if (Not.isPowerOf2()) {
359 Vals.push_back(C);
360 Vals.push_back(
361 ConstantInt::get(C->getContext(), C->getValue() | Not));
362 UsedICmps++;
363 return RHSVal;
364 }
365 }
366
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000367 UsedICmps++;
Chris Lattner0aa749b2010-12-13 04:26:26 +0000368 Vals.push_back(C);
369 return I->getOperand(0);
370 }
Andrew Trick6b014382012-08-29 21:46:36 +0000371
Chris Lattnere27db742010-12-17 06:20:15 +0000372 // If we have "x ult 3" comparison, for example, then we can add 0,1,2 to
373 // the set.
374 ConstantRange Span =
Chris Lattnera37029c2010-12-18 20:22:49 +0000375 ConstantRange::makeICmpRegion(ICI->getPredicate(), C->getValue());
Andrew Trick6b014382012-08-29 21:46:36 +0000376
Benjamin Kramer32d15d92013-07-04 14:22:02 +0000377 // Shift the range if the compare is fed by an add. This is the range
378 // compare idiom as emitted by instcombine.
379 bool hasAdd =
380 match(I->getOperand(0), m_Add(m_Value(RHSVal), m_ConstantInt(RHSC)));
381 if (hasAdd)
382 Span = Span.subtract(RHSC->getValue());
383
Chris Lattnere27db742010-12-17 06:20:15 +0000384 // If this is an and/!= check then we want to optimize "x ugt 2" into
385 // x != 0 && x != 1.
386 if (!isEQ)
387 Span = Span.inverse();
Andrew Trick6b014382012-08-29 21:46:36 +0000388
Chris Lattnere27db742010-12-17 06:20:15 +0000389 // If there are a ton of values, we don't want to make a ginormous switch.
Nick Lewyckyf460bf82012-01-19 18:19:42 +0000390 if (Span.getSetSize().ugt(8) || Span.isEmptySet())
Chris Lattnere27db742010-12-17 06:20:15 +0000391 return 0;
Andrew Trick6b014382012-08-29 21:46:36 +0000392
Chris Lattnere27db742010-12-17 06:20:15 +0000393 for (APInt Tmp = Span.getLower(); Tmp != Span.getUpper(); ++Tmp)
394 Vals.push_back(ConstantInt::get(V->getContext(), Tmp));
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000395 UsedICmps++;
Benjamin Kramer32d15d92013-07-04 14:22:02 +0000396 return hasAdd ? RHSVal : I->getOperand(0);
Chris Lattnere27db742010-12-17 06:20:15 +0000397 }
Chris Lattner662269d2010-12-13 04:18:32 +0000398 return 0;
399 }
Andrew Trick6b014382012-08-29 21:46:36 +0000400
Chris Lattner7312a222010-12-13 04:50:38 +0000401 // Otherwise, we can only handle an | or &, depending on isEQ.
Chris Lattner0aa749b2010-12-13 04:26:26 +0000402 if (I->getOpcode() != (isEQ ? Instruction::Or : Instruction::And))
Chris Lattner662269d2010-12-13 04:18:32 +0000403 return 0;
Andrew Trick6b014382012-08-29 21:46:36 +0000404
Chris Lattner7312a222010-12-13 04:50:38 +0000405 unsigned NumValsBeforeLHS = Vals.size();
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000406 unsigned UsedICmpsBeforeLHS = UsedICmps;
Chris Lattner0aa749b2010-12-13 04:26:26 +0000407 if (Value *LHS = GatherConstantCompares(I->getOperand(0), Vals, Extra, TD,
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000408 isEQ, UsedICmps)) {
Chris Lattner7312a222010-12-13 04:50:38 +0000409 unsigned NumVals = Vals.size();
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000410 unsigned UsedICmpsBeforeRHS = UsedICmps;
Chris Lattner0aa749b2010-12-13 04:26:26 +0000411 if (Value *RHS = GatherConstantCompares(I->getOperand(1), Vals, Extra, TD,
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000412 isEQ, UsedICmps)) {
Chris Lattner0aa749b2010-12-13 04:26:26 +0000413 if (LHS == RHS)
414 return LHS;
Chris Lattner92407e52010-12-13 07:41:29 +0000415 Vals.resize(NumVals);
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000416 UsedICmps = UsedICmpsBeforeRHS;
Chris Lattner0aa749b2010-12-13 04:26:26 +0000417 }
Chris Lattner7312a222010-12-13 04:50:38 +0000418
419 // The RHS of the or/and can't be folded in and we haven't used "Extra" yet,
420 // set it and return success.
421 if (Extra == 0 || Extra == I->getOperand(1)) {
422 Extra = I->getOperand(1);
423 return LHS;
424 }
Andrew Trick6b014382012-08-29 21:46:36 +0000425
Chris Lattner7312a222010-12-13 04:50:38 +0000426 Vals.resize(NumValsBeforeLHS);
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000427 UsedICmps = UsedICmpsBeforeLHS;
Chris Lattner7312a222010-12-13 04:50:38 +0000428 return 0;
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000429 }
Andrew Trick6b014382012-08-29 21:46:36 +0000430
Chris Lattner7312a222010-12-13 04:50:38 +0000431 // If the LHS can't be folded in, but Extra is available and RHS can, try to
432 // use LHS as Extra.
433 if (Extra == 0 || Extra == I->getOperand(0)) {
Chris Lattner92407e52010-12-13 07:41:29 +0000434 Value *OldExtra = Extra;
Chris Lattner7312a222010-12-13 04:50:38 +0000435 Extra = I->getOperand(0);
436 if (Value *RHS = GatherConstantCompares(I->getOperand(1), Vals, Extra, TD,
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000437 isEQ, UsedICmps))
Chris Lattner7312a222010-12-13 04:50:38 +0000438 return RHS;
Chris Lattner92407e52010-12-13 07:41:29 +0000439 assert(Vals.size() == NumValsBeforeLHS);
440 Extra = OldExtra;
Chris Lattner7312a222010-12-13 04:50:38 +0000441 }
Andrew Trick6b014382012-08-29 21:46:36 +0000442
Chris Lattner0d560082004-02-24 05:38:11 +0000443 return 0;
444}
Nick Lewycky9d523102011-12-26 20:37:40 +0000445
Eli Friedman080efb82008-12-16 20:54:32 +0000446static void EraseTerminatorInstAndDCECond(TerminatorInst *TI) {
Nick Lewycky9d523102011-12-26 20:37:40 +0000447 Instruction *Cond = 0;
Eli Friedman080efb82008-12-16 20:54:32 +0000448 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
449 Cond = dyn_cast<Instruction>(SI->getCondition());
450 } else if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
451 if (BI->isConditional())
452 Cond = dyn_cast<Instruction>(BI->getCondition());
Frits van Bommel7ac40c32010-12-05 18:29:03 +0000453 } else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(TI)) {
454 Cond = dyn_cast<Instruction>(IBI->getAddress());
Eli Friedman080efb82008-12-16 20:54:32 +0000455 }
456
457 TI->eraseFromParent();
458 if (Cond) RecursivelyDeleteTriviallyDeadInstructions(Cond);
459}
460
Chris Lattner9fd49552008-11-27 23:25:44 +0000461/// isValueEqualityComparison - Return true if the specified terminator checks
462/// to see if a value is equal to constant integer value.
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000463Value *SimplifyCFGOpt::isValueEqualityComparison(TerminatorInst *TI) {
464 Value *CV = 0;
Chris Lattner4bebf082004-03-16 19:45:22 +0000465 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
466 // Do not permit merging of large switch instructions into their
467 // predecessors unless there is only one predecessor.
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000468 if (SI->getNumSuccessors()*std::distance(pred_begin(SI->getParent()),
469 pred_end(SI->getParent())) <= 128)
470 CV = SI->getCondition();
471 } else if (BranchInst *BI = dyn_cast<BranchInst>(TI))
Chris Lattner542f1492004-02-28 21:28:10 +0000472 if (BI->isConditional() && BI->getCondition()->hasOneUse())
Reid Spencere4d87aa2006-12-23 06:05:41 +0000473 if (ICmpInst *ICI = dyn_cast<ICmpInst>(BI->getCondition()))
David Majnemer404fa722013-06-03 20:39:50 +0000474 if (ICI->isEquality() && GetConstantInt(ICI->getOperand(1), TD))
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000475 CV = ICI->getOperand(0);
476
477 // Unwrap any lossless ptrtoint cast.
Chandler Carruthece6c6b2012-11-01 08:07:29 +0000478 if (TD && CV && CV->getType() == TD->getIntPtrType(CV->getContext()))
479 if (PtrToIntInst *PTII = dyn_cast<PtrToIntInst>(CV))
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000480 CV = PTII->getOperand(0);
481 return CV;
Chris Lattner542f1492004-02-28 21:28:10 +0000482}
483
Bill Wendling5049fa62009-01-19 23:43:56 +0000484/// GetValueEqualityComparisonCases - Given a value comparison instruction,
485/// decode all of the 'cases' that it represents and return the 'default' block.
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000486BasicBlock *SimplifyCFGOpt::
Misha Brukmanfd939082005-04-21 23:48:37 +0000487GetValueEqualityComparisonCases(TerminatorInst *TI,
Eric Christopherc723eb12012-07-02 23:22:21 +0000488 std::vector<ValueEqualityComparisonCase>
489 &Cases) {
Chris Lattner542f1492004-02-28 21:28:10 +0000490 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Eric Christopherc723eb12012-07-02 23:22:21 +0000491 Cases.reserve(SI->getNumCases());
492 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end(); i != e; ++i)
493 Cases.push_back(ValueEqualityComparisonCase(i.getCaseValue(),
494 i.getCaseSuccessor()));
Chris Lattner542f1492004-02-28 21:28:10 +0000495 return SI->getDefaultDest();
496 }
Eric Christopherc723eb12012-07-02 23:22:21 +0000497
Chris Lattner542f1492004-02-28 21:28:10 +0000498 BranchInst *BI = cast<BranchInst>(TI);
Reid Spencere4d87aa2006-12-23 06:05:41 +0000499 ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
Eric Christopherc723eb12012-07-02 23:22:21 +0000500 BasicBlock *Succ = BI->getSuccessor(ICI->getPredicate() == ICmpInst::ICMP_NE);
501 Cases.push_back(ValueEqualityComparisonCase(GetConstantInt(ICI->getOperand(1),
502 TD),
503 Succ));
Reid Spencere4d87aa2006-12-23 06:05:41 +0000504 return BI->getSuccessor(ICI->getPredicate() == ICmpInst::ICMP_EQ);
Chris Lattner542f1492004-02-28 21:28:10 +0000505}
506
Eric Christopherc723eb12012-07-02 23:22:21 +0000507
508/// EliminateBlockCases - Given a vector of bb/value pairs, remove any entries
509/// in the list that match the specified block.
510static void EliminateBlockCases(BasicBlock *BB,
511 std::vector<ValueEqualityComparisonCase> &Cases) {
Benjamin Kramer8e13ded2012-10-14 11:15:42 +0000512 Cases.erase(std::remove(Cases.begin(), Cases.end(), BB), Cases.end());
Eric Christopherc723eb12012-07-02 23:22:21 +0000513}
514
515/// ValuesOverlap - Return true if there are any keys in C1 that exist in C2 as
516/// well.
517static bool
518ValuesOverlap(std::vector<ValueEqualityComparisonCase> &C1,
519 std::vector<ValueEqualityComparisonCase > &C2) {
520 std::vector<ValueEqualityComparisonCase> *V1 = &C1, *V2 = &C2;
521
522 // Make V1 be smaller than V2.
523 if (V1->size() > V2->size())
524 std::swap(V1, V2);
525
526 if (V1->size() == 0) return false;
527 if (V1->size() == 1) {
528 // Just scan V2.
529 ConstantInt *TheVal = (*V1)[0].Value;
530 for (unsigned i = 0, e = V2->size(); i != e; ++i)
531 if (TheVal == (*V2)[i].Value)
532 return true;
533 }
534
535 // Otherwise, just sort both lists and compare element by element.
536 array_pod_sort(V1->begin(), V1->end());
537 array_pod_sort(V2->begin(), V2->end());
538 unsigned i1 = 0, i2 = 0, e1 = V1->size(), e2 = V2->size();
539 while (i1 != e1 && i2 != e2) {
540 if ((*V1)[i1].Value == (*V2)[i2].Value)
541 return true;
542 if ((*V1)[i1].Value < (*V2)[i2].Value)
543 ++i1;
544 else
545 ++i2;
546 }
547 return false;
548}
549
Bill Wendling5049fa62009-01-19 23:43:56 +0000550/// SimplifyEqualityComparisonWithOnlyPredecessor - If TI is known to be a
551/// terminator instruction and its block is known to only have a single
552/// predecessor block, check to see if that predecessor is also a value
553/// comparison with the same value, and if that comparison determines the
554/// outcome of this comparison. If so, simplify TI. This does a very limited
555/// form of jump threading.
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000556bool SimplifyCFGOpt::
557SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
Devang Patel007349d2011-05-18 20:35:38 +0000558 BasicBlock *Pred,
559 IRBuilder<> &Builder) {
Chris Lattner623369a2005-02-24 06:17:52 +0000560 Value *PredVal = isValueEqualityComparison(Pred->getTerminator());
561 if (!PredVal) return false; // Not a value comparison in predecessor.
562
563 Value *ThisVal = isValueEqualityComparison(TI);
564 assert(ThisVal && "This isn't a value comparison!!");
565 if (ThisVal != PredVal) return false; // Different predicates.
566
Andrew Trickb1b97832012-08-29 21:46:38 +0000567 // TODO: Preserve branch weight metadata, similarly to how
568 // FoldValueComparisonIntoPredecessors preserves it.
569
Chris Lattner623369a2005-02-24 06:17:52 +0000570 // Find out information about when control will move from Pred to TI's block.
Eric Christopherc723eb12012-07-02 23:22:21 +0000571 std::vector<ValueEqualityComparisonCase> PredCases;
Chris Lattner623369a2005-02-24 06:17:52 +0000572 BasicBlock *PredDef = GetValueEqualityComparisonCases(Pred->getTerminator(),
573 PredCases);
Eric Christopherc723eb12012-07-02 23:22:21 +0000574 EliminateBlockCases(PredDef, PredCases); // Remove default from cases.
Misha Brukmanfd939082005-04-21 23:48:37 +0000575
Chris Lattner623369a2005-02-24 06:17:52 +0000576 // Find information about how control leaves this block.
Eric Christopherc723eb12012-07-02 23:22:21 +0000577 std::vector<ValueEqualityComparisonCase> ThisCases;
Chris Lattner623369a2005-02-24 06:17:52 +0000578 BasicBlock *ThisDef = GetValueEqualityComparisonCases(TI, ThisCases);
Eric Christopherc723eb12012-07-02 23:22:21 +0000579 EliminateBlockCases(ThisDef, ThisCases); // Remove default from cases.
Chris Lattner623369a2005-02-24 06:17:52 +0000580
581 // If TI's block is the default block from Pred's comparison, potentially
582 // simplify TI based on this knowledge.
583 if (PredDef == TI->getParent()) {
584 // If we are here, we know that the value is none of those cases listed in
585 // PredCases. If there are any cases in ThisCases that are in PredCases, we
586 // can simplify TI.
Eric Christopherc723eb12012-07-02 23:22:21 +0000587 if (!ValuesOverlap(PredCases, ThisCases))
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000588 return false;
Andrew Trick6b014382012-08-29 21:46:36 +0000589
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000590 if (isa<BranchInst>(TI)) {
591 // Okay, one of the successors of this condbr is dead. Convert it to a
592 // uncond br.
593 assert(ThisCases.size() == 1 && "Branch can only have one case!");
594 // Insert the new branch.
Devang Patel007349d2011-05-18 20:35:38 +0000595 Instruction *NI = Builder.CreateBr(ThisDef);
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000596 (void) NI;
Chris Lattner623369a2005-02-24 06:17:52 +0000597
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000598 // Remove PHI node entries for the dead edge.
Eric Christopherc723eb12012-07-02 23:22:21 +0000599 ThisCases[0].Dest->removePredecessor(TI->getParent());
Chris Lattner623369a2005-02-24 06:17:52 +0000600
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000601 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
602 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
Chris Lattner623369a2005-02-24 06:17:52 +0000603
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000604 EraseTerminatorInstAndDCECond(TI);
605 return true;
Chris Lattner623369a2005-02-24 06:17:52 +0000606 }
Andrew Trick6b014382012-08-29 21:46:36 +0000607
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000608 SwitchInst *SI = cast<SwitchInst>(TI);
609 // Okay, TI has cases that are statically dead, prune them away.
Eric Christopherc723eb12012-07-02 23:22:21 +0000610 SmallPtrSet<Constant*, 16> DeadCases;
611 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
612 DeadCases.insert(PredCases[i].Value);
Chris Lattner623369a2005-02-24 06:17:52 +0000613
David Greene89d6fd32010-01-05 01:26:52 +0000614 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000615 << "Through successor TI: " << *TI);
Chris Lattner623369a2005-02-24 06:17:52 +0000616
Manman Renad289072012-09-14 21:53:06 +0000617 // Collect branch weights into a vector.
618 SmallVector<uint32_t, 8> Weights;
619 MDNode* MD = SI->getMetadata(LLVMContext::MD_prof);
620 bool HasWeight = MD && (MD->getNumOperands() == 2 + SI->getNumCases());
621 if (HasWeight)
622 for (unsigned MD_i = 1, MD_e = MD->getNumOperands(); MD_i < MD_e;
623 ++MD_i) {
624 ConstantInt* CI = dyn_cast<ConstantInt>(MD->getOperand(MD_i));
625 assert(CI);
626 Weights.push_back(CI->getValue().getZExtValue());
627 }
Eric Christopherc723eb12012-07-02 23:22:21 +0000628 for (SwitchInst::CaseIt i = SI->case_end(), e = SI->case_begin(); i != e;) {
629 --i;
630 if (DeadCases.count(i.getCaseValue())) {
Manman Renad289072012-09-14 21:53:06 +0000631 if (HasWeight) {
632 std::swap(Weights[i.getCaseIndex()+1], Weights.back());
633 Weights.pop_back();
634 }
Eric Christopherc723eb12012-07-02 23:22:21 +0000635 i.getCaseSuccessor()->removePredecessor(TI->getParent());
636 SI->removeCase(i);
637 }
638 }
Manman Rend61d1eb2012-10-11 22:28:34 +0000639 if (HasWeight && Weights.size() >= 2)
Manman Renad289072012-09-14 21:53:06 +0000640 SI->setMetadata(LLVMContext::MD_prof,
641 MDBuilder(SI->getParent()->getContext()).
642 createBranchWeights(Weights));
Eric Christopherc723eb12012-07-02 23:22:21 +0000643
644 DEBUG(dbgs() << "Leaving: " << *TI << "\n");
Chris Lattner623369a2005-02-24 06:17:52 +0000645 return true;
646 }
Andrew Trick6b014382012-08-29 21:46:36 +0000647
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000648 // Otherwise, TI's block must correspond to some matched value. Find out
649 // which value (or set of values) this is.
Eric Christopherc723eb12012-07-02 23:22:21 +0000650 ConstantInt *TIV = 0;
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000651 BasicBlock *TIBB = TI->getParent();
Eric Christopherc723eb12012-07-02 23:22:21 +0000652 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
653 if (PredCases[i].Dest == TIBB) {
654 if (TIV != 0)
655 return false; // Cannot handle multiple values coming to this block.
656 TIV = PredCases[i].Value;
657 }
658 assert(TIV && "No edge from pred to succ?");
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000659
660 // Okay, we found the one constant that our value can be if we get into TI's
661 // BB. Find out which successor will unconditionally be branched to.
Eric Christopherc723eb12012-07-02 23:22:21 +0000662 BasicBlock *TheRealDest = 0;
663 for (unsigned i = 0, e = ThisCases.size(); i != e; ++i)
664 if (ThisCases[i].Value == TIV) {
665 TheRealDest = ThisCases[i].Dest;
666 break;
667 }
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000668
669 // If not handled by any explicit cases, it is handled by the default case.
670 if (TheRealDest == 0) TheRealDest = ThisDef;
671
672 // Remove PHI node entries for dead edges.
673 BasicBlock *CheckEdge = TheRealDest;
674 for (succ_iterator SI = succ_begin(TIBB), e = succ_end(TIBB); SI != e; ++SI)
675 if (*SI != CheckEdge)
676 (*SI)->removePredecessor(TIBB);
677 else
678 CheckEdge = 0;
679
680 // Insert the new branch.
Devang Patel007349d2011-05-18 20:35:38 +0000681 Instruction *NI = Builder.CreateBr(TheRealDest);
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000682 (void) NI;
683
684 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
685 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
686
687 EraseTerminatorInstAndDCECond(TI);
688 return true;
Chris Lattner623369a2005-02-24 06:17:52 +0000689}
690
Dale Johannesenc81f5442009-03-12 21:01:11 +0000691namespace {
692 /// ConstantIntOrdering - This class implements a stable ordering of constant
693 /// integers that does not depend on their address. This is important for
694 /// applications that sort ConstantInt's to ensure uniqueness.
695 struct ConstantIntOrdering {
696 bool operator()(const ConstantInt *LHS, const ConstantInt *RHS) const {
697 return LHS->getValue().ult(RHS->getValue());
698 }
699 };
700}
Dale Johannesena9537cf2009-03-12 01:00:26 +0000701
Chris Lattner6d4d21e2010-12-13 02:00:58 +0000702static int ConstantIntSortPredicate(const void *P1, const void *P2) {
Roman Divacky59324292012-09-05 22:26:57 +0000703 const ConstantInt *LHS = *(const ConstantInt*const*)P1;
704 const ConstantInt *RHS = *(const ConstantInt*const*)P2;
Chris Lattnerba3c8152010-12-15 04:52:41 +0000705 if (LHS->getValue().ult(RHS->getValue()))
706 return 1;
707 if (LHS->getValue() == RHS->getValue())
708 return 0;
709 return -1;
Chris Lattner6d4d21e2010-12-13 02:00:58 +0000710}
711
Andrew Trickb1b97832012-08-29 21:46:38 +0000712static inline bool HasBranchWeights(const Instruction* I) {
713 MDNode* ProfMD = I->getMetadata(LLVMContext::MD_prof);
714 if (ProfMD && ProfMD->getOperand(0))
715 if (MDString* MDS = dyn_cast<MDString>(ProfMD->getOperand(0)))
716 return MDS->getString().equals("branch_weights");
717
718 return false;
719}
720
Manman Ren020aba02012-09-11 17:43:35 +0000721/// Get Weights of a given TerminatorInst, the default weight is at the front
722/// of the vector. If TI is a conditional eq, we need to swap the branch-weight
723/// metadata.
724static void GetBranchWeights(TerminatorInst *TI,
725 SmallVectorImpl<uint64_t> &Weights) {
726 MDNode* MD = TI->getMetadata(LLVMContext::MD_prof);
727 assert(MD);
728 for (unsigned i = 1, e = MD->getNumOperands(); i < e; ++i) {
729 ConstantInt* CI = dyn_cast<ConstantInt>(MD->getOperand(i));
Andrew Trickb1b97832012-08-29 21:46:38 +0000730 assert(CI);
Manman Ren020aba02012-09-11 17:43:35 +0000731 Weights.push_back(CI->getValue().getZExtValue());
Andrew Trickb1b97832012-08-29 21:46:38 +0000732 }
733
Manman Ren020aba02012-09-11 17:43:35 +0000734 // If TI is a conditional eq, the default case is the false case,
735 // and the corresponding branch-weight data is at index 2. We swap the
736 // default weight to be the first entry.
737 if (BranchInst* BI = dyn_cast<BranchInst>(TI)) {
738 assert(Weights.size() == 2);
739 ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
740 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
741 std::swap(Weights.front(), Weights.back());
Andrew Trickb1b97832012-08-29 21:46:38 +0000742 }
743}
744
745/// Sees if any of the weights are too big for a uint32_t, and halves all the
746/// weights if any are.
747static void FitWeights(MutableArrayRef<uint64_t> Weights) {
748 bool Halve = false;
749 for (unsigned i = 0; i < Weights.size(); ++i)
750 if (Weights[i] > UINT_MAX) {
751 Halve = true;
752 break;
753 }
754
755 if (! Halve)
756 return;
757
758 for (unsigned i = 0; i < Weights.size(); ++i)
759 Weights[i] /= 2;
760}
761
Bill Wendling5049fa62009-01-19 23:43:56 +0000762/// FoldValueComparisonIntoPredecessors - The specified terminator is a value
763/// equality comparison instruction (either a switch or a branch on "X == c").
764/// See if any of the predecessors of the terminator block are value comparisons
765/// on the same value. If so, and if safe to do so, fold them together.
Devang Patelb55d9242011-05-18 20:53:17 +0000766bool SimplifyCFGOpt::FoldValueComparisonIntoPredecessors(TerminatorInst *TI,
767 IRBuilder<> &Builder) {
Chris Lattner542f1492004-02-28 21:28:10 +0000768 BasicBlock *BB = TI->getParent();
769 Value *CV = isValueEqualityComparison(TI); // CondVal
770 assert(CV && "Not a comparison?");
771 bool Changed = false;
772
Chris Lattner82442432008-02-18 07:42:56 +0000773 SmallVector<BasicBlock*, 16> Preds(pred_begin(BB), pred_end(BB));
Chris Lattner542f1492004-02-28 21:28:10 +0000774 while (!Preds.empty()) {
Dan Gohmane9d87f42009-05-06 17:22:41 +0000775 BasicBlock *Pred = Preds.pop_back_val();
Misha Brukmanfd939082005-04-21 23:48:37 +0000776
Chris Lattner542f1492004-02-28 21:28:10 +0000777 // See if the predecessor is a comparison with the same value.
778 TerminatorInst *PTI = Pred->getTerminator();
779 Value *PCV = isValueEqualityComparison(PTI); // PredCondVal
780
781 if (PCV == CV && SafeToMergeTerminators(TI, PTI)) {
782 // Figure out which 'cases' to copy from SI to PSI.
Eric Christopherc723eb12012-07-02 23:22:21 +0000783 std::vector<ValueEqualityComparisonCase> BBCases;
Chris Lattner542f1492004-02-28 21:28:10 +0000784 BasicBlock *BBDefault = GetValueEqualityComparisonCases(TI, BBCases);
785
Eric Christopherc723eb12012-07-02 23:22:21 +0000786 std::vector<ValueEqualityComparisonCase> PredCases;
Chris Lattner542f1492004-02-28 21:28:10 +0000787 BasicBlock *PredDefault = GetValueEqualityComparisonCases(PTI, PredCases);
788
789 // Based on whether the default edge from PTI goes to BB or not, fill in
790 // PredCases and PredDefault with the new switch cases we would like to
791 // build.
Chris Lattner82442432008-02-18 07:42:56 +0000792 SmallVector<BasicBlock*, 8> NewSuccessors;
Chris Lattner542f1492004-02-28 21:28:10 +0000793
Andrew Trickb1b97832012-08-29 21:46:38 +0000794 // Update the branch weight metadata along the way
795 SmallVector<uint64_t, 8> Weights;
Andrew Trickb1b97832012-08-29 21:46:38 +0000796 bool PredHasWeights = HasBranchWeights(PTI);
797 bool SuccHasWeights = HasBranchWeights(TI);
798
Manman Ren796d9452012-09-14 19:05:19 +0000799 if (PredHasWeights) {
Manman Ren020aba02012-09-11 17:43:35 +0000800 GetBranchWeights(PTI, Weights);
Andrew Trickc2aa0032012-11-15 18:40:31 +0000801 // branch-weight metadata is inconsistent here.
Manman Ren796d9452012-09-14 19:05:19 +0000802 if (Weights.size() != 1 + PredCases.size())
803 PredHasWeights = SuccHasWeights = false;
804 } else if (SuccHasWeights)
Andrew Trickb1b97832012-08-29 21:46:38 +0000805 // If there are no predecessor weights but there are successor weights,
806 // populate Weights with 1, which will later be scaled to the sum of
807 // successor's weights
808 Weights.assign(1 + PredCases.size(), 1);
Andrew Trickb1b97832012-08-29 21:46:38 +0000809
Manman Ren020aba02012-09-11 17:43:35 +0000810 SmallVector<uint64_t, 8> SuccWeights;
Manman Ren796d9452012-09-14 19:05:19 +0000811 if (SuccHasWeights) {
Manman Ren020aba02012-09-11 17:43:35 +0000812 GetBranchWeights(TI, SuccWeights);
Andrew Trickc2aa0032012-11-15 18:40:31 +0000813 // branch-weight metadata is inconsistent here.
Manman Ren796d9452012-09-14 19:05:19 +0000814 if (SuccWeights.size() != 1 + BBCases.size())
815 PredHasWeights = SuccHasWeights = false;
816 } else if (PredHasWeights)
Manman Ren020aba02012-09-11 17:43:35 +0000817 SuccWeights.assign(1 + BBCases.size(), 1);
Andrew Trickb1b97832012-08-29 21:46:38 +0000818
Chris Lattner542f1492004-02-28 21:28:10 +0000819 if (PredDefault == BB) {
820 // If this is the default destination from PTI, only the edges in TI
821 // that don't occur in PTI, or that branch to BB will be activated.
Eric Christopherc723eb12012-07-02 23:22:21 +0000822 std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
823 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
824 if (PredCases[i].Dest != BB)
825 PTIHandled.insert(PredCases[i].Value);
826 else {
827 // The default destination is BB, we don't need explicit targets.
828 std::swap(PredCases[i], PredCases.back());
Andrew Trickb1b97832012-08-29 21:46:38 +0000829
Manman Ren020aba02012-09-11 17:43:35 +0000830 if (PredHasWeights || SuccHasWeights) {
831 // Increase weight for the default case.
832 Weights[0] += Weights[i+1];
Andrew Trickb1b97832012-08-29 21:46:38 +0000833 std::swap(Weights[i+1], Weights.back());
834 Weights.pop_back();
835 }
836
Eric Christopherc723eb12012-07-02 23:22:21 +0000837 PredCases.pop_back();
838 --i; --e;
839 }
Chris Lattner542f1492004-02-28 21:28:10 +0000840
Eric Christopherc723eb12012-07-02 23:22:21 +0000841 // Reconstruct the new switch statement we will be building.
Chris Lattner542f1492004-02-28 21:28:10 +0000842 if (PredDefault != BBDefault) {
843 PredDefault->removePredecessor(Pred);
844 PredDefault = BBDefault;
845 NewSuccessors.push_back(BBDefault);
846 }
Andrew Trickb1b97832012-08-29 21:46:38 +0000847
Manman Ren020aba02012-09-11 17:43:35 +0000848 unsigned CasesFromPred = Weights.size();
849 uint64_t ValidTotalSuccWeight = 0;
Eric Christopherc723eb12012-07-02 23:22:21 +0000850 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
851 if (!PTIHandled.count(BBCases[i].Value) &&
852 BBCases[i].Dest != BBDefault) {
853 PredCases.push_back(BBCases[i]);
854 NewSuccessors.push_back(BBCases[i].Dest);
Manman Ren020aba02012-09-11 17:43:35 +0000855 if (SuccHasWeights || PredHasWeights) {
856 // The default weight is at index 0, so weight for the ith case
857 // should be at index i+1. Scale the cases from successor by
858 // PredDefaultWeight (Weights[0]).
859 Weights.push_back(Weights[0] * SuccWeights[i+1]);
860 ValidTotalSuccWeight += SuccWeights[i+1];
Andrew Trickb1b97832012-08-29 21:46:38 +0000861 }
Eric Christopherc723eb12012-07-02 23:22:21 +0000862 }
Chris Lattner542f1492004-02-28 21:28:10 +0000863
Manman Ren020aba02012-09-11 17:43:35 +0000864 if (SuccHasWeights || PredHasWeights) {
865 ValidTotalSuccWeight += SuccWeights[0];
866 // Scale the cases from predecessor by ValidTotalSuccWeight.
867 for (unsigned i = 1; i < CasesFromPred; ++i)
868 Weights[i] *= ValidTotalSuccWeight;
869 // Scale the default weight by SuccDefaultWeight (SuccWeights[0]).
870 Weights[0] *= SuccWeights[0];
871 }
Chris Lattner542f1492004-02-28 21:28:10 +0000872 } else {
873 // If this is not the default destination from PSI, only the edges
874 // in SI that occur in PSI with a destination of BB will be
875 // activated.
Eric Christopherc723eb12012-07-02 23:22:21 +0000876 std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
Manman Rena8a2b992012-09-14 17:29:56 +0000877 std::map<ConstantInt*, uint64_t> WeightsForHandled;
Eric Christopherc723eb12012-07-02 23:22:21 +0000878 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
879 if (PredCases[i].Dest == BB) {
880 PTIHandled.insert(PredCases[i].Value);
Manman Rena8a2b992012-09-14 17:29:56 +0000881
882 if (PredHasWeights || SuccHasWeights) {
883 WeightsForHandled[PredCases[i].Value] = Weights[i+1];
884 std::swap(Weights[i+1], Weights.back());
885 Weights.pop_back();
886 }
887
Eric Christopherc723eb12012-07-02 23:22:21 +0000888 std::swap(PredCases[i], PredCases.back());
889 PredCases.pop_back();
890 --i; --e;
891 }
Chris Lattner542f1492004-02-28 21:28:10 +0000892
893 // Okay, now we know which constants were sent to BB from the
894 // predecessor. Figure out where they will all go now.
Eric Christopherc723eb12012-07-02 23:22:21 +0000895 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
896 if (PTIHandled.count(BBCases[i].Value)) {
897 // If this is one we are capable of getting...
Manman Rena8a2b992012-09-14 17:29:56 +0000898 if (PredHasWeights || SuccHasWeights)
899 Weights.push_back(WeightsForHandled[BBCases[i].Value]);
Eric Christopherc723eb12012-07-02 23:22:21 +0000900 PredCases.push_back(BBCases[i]);
901 NewSuccessors.push_back(BBCases[i].Dest);
902 PTIHandled.erase(BBCases[i].Value);// This constant is taken care of
903 }
904
Chris Lattner542f1492004-02-28 21:28:10 +0000905 // If there are any constants vectored to BB that TI doesn't handle,
906 // they must go to the default destination of TI.
Andrew Trick6b014382012-08-29 21:46:36 +0000907 for (std::set<ConstantInt*, ConstantIntOrdering>::iterator I =
Eric Christopherc723eb12012-07-02 23:22:21 +0000908 PTIHandled.begin(),
909 E = PTIHandled.end(); I != E; ++I) {
Andrew Trickdf523d42012-11-15 18:40:29 +0000910 if (PredHasWeights || SuccHasWeights)
911 Weights.push_back(WeightsForHandled[*I]);
Eric Christopherc723eb12012-07-02 23:22:21 +0000912 PredCases.push_back(ValueEqualityComparisonCase(*I, BBDefault));
Chris Lattner542f1492004-02-28 21:28:10 +0000913 NewSuccessors.push_back(BBDefault);
Eric Christopherc723eb12012-07-02 23:22:21 +0000914 }
Chris Lattner542f1492004-02-28 21:28:10 +0000915 }
916
917 // Okay, at this point, we know which new successor Pred will get. Make
918 // sure we update the number of entries in the PHI nodes for these
919 // successors.
920 for (unsigned i = 0, e = NewSuccessors.size(); i != e; ++i)
921 AddPredecessorToBlock(NewSuccessors[i], Pred, BB);
922
Devang Patelb55d9242011-05-18 20:53:17 +0000923 Builder.SetInsertPoint(PTI);
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000924 // Convert pointer to int before we switch.
Duncan Sands1df98592010-02-16 11:11:14 +0000925 if (CV->getType()->isPointerTy()) {
Micah Villmow3574eca2012-10-08 16:38:25 +0000926 assert(TD && "Cannot switch on pointer without DataLayout");
Chandler Carruthece6c6b2012-11-01 08:07:29 +0000927 CV = Builder.CreatePtrToInt(CV, TD->getIntPtrType(CV->getContext()),
Devang Patelb55d9242011-05-18 20:53:17 +0000928 "magicptr");
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000929 }
930
Chris Lattner542f1492004-02-28 21:28:10 +0000931 // Now that the successors are updated, create the new Switch instruction.
Devang Patelb55d9242011-05-18 20:53:17 +0000932 SwitchInst *NewSI = Builder.CreateSwitch(CV, PredDefault,
933 PredCases.size());
Devang Pateld80e8ed2011-05-17 23:29:05 +0000934 NewSI->setDebugLoc(PTI->getDebugLoc());
Eric Christopherc723eb12012-07-02 23:22:21 +0000935 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
936 NewSI->addCase(PredCases[i].Value, PredCases[i].Dest);
Chris Lattner13b2f762005-01-01 16:02:12 +0000937
Andrew Trickb1b97832012-08-29 21:46:38 +0000938 if (PredHasWeights || SuccHasWeights) {
939 // Halve the weights if any of them cannot fit in an uint32_t
940 FitWeights(Weights);
941
942 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
943
944 NewSI->setMetadata(LLVMContext::MD_prof,
945 MDBuilder(BB->getContext()).
946 createBranchWeights(MDWeights));
947 }
948
Eli Friedman080efb82008-12-16 20:54:32 +0000949 EraseTerminatorInstAndDCECond(PTI);
Chris Lattner13b2f762005-01-01 16:02:12 +0000950
Chris Lattner542f1492004-02-28 21:28:10 +0000951 // Okay, last check. If BB is still a successor of PSI, then we must
952 // have an infinite loop case. If so, add an infinitely looping block
953 // to handle the case to preserve the behavior of the code.
954 BasicBlock *InfLoopBlock = 0;
955 for (unsigned i = 0, e = NewSI->getNumSuccessors(); i != e; ++i)
956 if (NewSI->getSuccessor(i) == BB) {
957 if (InfLoopBlock == 0) {
Chris Lattner093a4382008-07-13 22:23:11 +0000958 // Insert it at the end of the function, because it's either code,
Chris Lattner542f1492004-02-28 21:28:10 +0000959 // or it won't matter if it's hot. :)
Owen Anderson1d0be152009-08-13 21:58:54 +0000960 InfLoopBlock = BasicBlock::Create(BB->getContext(),
961 "infloop", BB->getParent());
Gabor Greif051a9502008-04-06 20:25:17 +0000962 BranchInst::Create(InfLoopBlock, InfLoopBlock);
Chris Lattner542f1492004-02-28 21:28:10 +0000963 }
964 NewSI->setSuccessor(i, InfLoopBlock);
965 }
Misha Brukmanfd939082005-04-21 23:48:37 +0000966
Chris Lattner542f1492004-02-28 21:28:10 +0000967 Changed = true;
968 }
969 }
970 return Changed;
971}
972
Dale Johannesenc1f10402009-06-15 20:59:27 +0000973// isSafeToHoistInvoke - If we would need to insert a select that uses the
974// value of this invoke (comments in HoistThenElseCodeToIf explain why we
975// would need to do this), we can't hoist the invoke, as there is nowhere
976// to put the select in this case.
977static bool isSafeToHoistInvoke(BasicBlock *BB1, BasicBlock *BB2,
978 Instruction *I1, Instruction *I2) {
979 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
980 PHINode *PN;
981 for (BasicBlock::iterator BBI = SI->begin();
982 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
983 Value *BB1V = PN->getIncomingValueForBlock(BB1);
984 Value *BB2V = PN->getIncomingValueForBlock(BB2);
985 if (BB1V != BB2V && (BB1V==I1 || BB2V==I2)) {
986 return false;
987 }
988 }
989 }
990 return true;
991}
992
Chris Lattner6306d072005-08-03 17:59:45 +0000993/// HoistThenElseCodeToIf - Given a conditional branch that goes to BB1 and
Chris Lattner37dc9382004-11-30 00:29:14 +0000994/// BB2, hoist any common code in the two blocks up into the branch block. The
995/// caller of this function guarantees that BI's block dominates BB1 and BB2.
Rafael Espindola216dde92011-05-19 02:26:30 +0000996static bool HoistThenElseCodeToIf(BranchInst *BI) {
Chris Lattner37dc9382004-11-30 00:29:14 +0000997 // This does very trivial matching, with limited scanning, to find identical
998 // instructions in the two blocks. In particular, we don't want to get into
999 // O(M*N) situations here where M and N are the sizes of BB1 and BB2. As
1000 // such, we currently just scan for obviously identical instructions in an
1001 // identical order.
1002 BasicBlock *BB1 = BI->getSuccessor(0); // The true destination.
1003 BasicBlock *BB2 = BI->getSuccessor(1); // The false destination
1004
Devang Patel65085cf2009-02-04 00:03:08 +00001005 BasicBlock::iterator BB1_Itr = BB1->begin();
1006 BasicBlock::iterator BB2_Itr = BB2->begin();
1007
1008 Instruction *I1 = BB1_Itr++, *I2 = BB2_Itr++;
Devang Patel949666e2011-04-07 17:27:36 +00001009 // Skip debug info if it is not identical.
1010 DbgInfoIntrinsic *DBI1 = dyn_cast<DbgInfoIntrinsic>(I1);
1011 DbgInfoIntrinsic *DBI2 = dyn_cast<DbgInfoIntrinsic>(I2);
1012 if (!DBI1 || !DBI2 || !DBI1->isIdenticalToWhenDefined(DBI2)) {
1013 while (isa<DbgInfoIntrinsic>(I1))
1014 I1 = BB1_Itr++;
1015 while (isa<DbgInfoIntrinsic>(I2))
1016 I2 = BB2_Itr++;
1017 }
Devang Patelae6c95b2011-04-07 00:30:15 +00001018 if (isa<PHINode>(I1) || !I1->isIdenticalToWhenDefined(I2) ||
Dale Johannesenc1f10402009-06-15 20:59:27 +00001019 (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2)))
Chris Lattner37dc9382004-11-30 00:29:14 +00001020 return false;
1021
Chris Lattner37dc9382004-11-30 00:29:14 +00001022 BasicBlock *BIParent = BI->getParent();
Chris Lattner37dc9382004-11-30 00:29:14 +00001023
David Majnemer3931bdb2013-06-03 20:43:12 +00001024 bool Changed = false;
Chris Lattner37dc9382004-11-30 00:29:14 +00001025 do {
1026 // If we are hoisting the terminator instruction, don't move one (making a
1027 // broken BB), instead clone it, and remove BI.
1028 if (isa<TerminatorInst>(I1))
1029 goto HoistTerminator;
Misha Brukmanfd939082005-04-21 23:48:37 +00001030
Chris Lattner37dc9382004-11-30 00:29:14 +00001031 // For a normal instruction, we just move one to right before the branch,
1032 // then replace all uses of the other with the first. Finally, we remove
1033 // the now redundant second instruction.
1034 BIParent->getInstList().splice(BI, BB1->getInstList(), I1);
1035 if (!I2->use_empty())
1036 I2->replaceAllUsesWith(I1);
Dan Gohman58cfa3b2009-08-25 22:11:20 +00001037 I1->intersectOptionalDataWith(I2);
Chris Lattner302ba6f2010-12-14 06:17:25 +00001038 I2->eraseFromParent();
David Majnemer3931bdb2013-06-03 20:43:12 +00001039 Changed = true;
Misha Brukmanfd939082005-04-21 23:48:37 +00001040
Devang Patel65085cf2009-02-04 00:03:08 +00001041 I1 = BB1_Itr++;
Devang Patel65085cf2009-02-04 00:03:08 +00001042 I2 = BB2_Itr++;
Devang Patel949666e2011-04-07 17:27:36 +00001043 // Skip debug info if it is not identical.
1044 DbgInfoIntrinsic *DBI1 = dyn_cast<DbgInfoIntrinsic>(I1);
1045 DbgInfoIntrinsic *DBI2 = dyn_cast<DbgInfoIntrinsic>(I2);
1046 if (!DBI1 || !DBI2 || !DBI1->isIdenticalToWhenDefined(DBI2)) {
1047 while (isa<DbgInfoIntrinsic>(I1))
1048 I1 = BB1_Itr++;
1049 while (isa<DbgInfoIntrinsic>(I2))
1050 I2 = BB2_Itr++;
1051 }
Devang Patelae6c95b2011-04-07 00:30:15 +00001052 } while (I1->isIdenticalToWhenDefined(I2));
Chris Lattner37dc9382004-11-30 00:29:14 +00001053
1054 return true;
1055
1056HoistTerminator:
Dale Johannesenc1f10402009-06-15 20:59:27 +00001057 // It may not be possible to hoist an invoke.
1058 if (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2))
David Majnemer3931bdb2013-06-03 20:43:12 +00001059 return Changed;
1060
1061 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
1062 PHINode *PN;
1063 for (BasicBlock::iterator BBI = SI->begin();
1064 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
1065 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1066 Value *BB2V = PN->getIncomingValueForBlock(BB2);
1067 if (BB1V == BB2V)
1068 continue;
1069
1070 if (isa<ConstantExpr>(BB1V) && !isSafeToSpeculativelyExecute(BB1V))
1071 return Changed;
1072 if (isa<ConstantExpr>(BB2V) && !isSafeToSpeculativelyExecute(BB2V))
1073 return Changed;
1074 }
1075 }
Dale Johannesenc1f10402009-06-15 20:59:27 +00001076
Chris Lattner37dc9382004-11-30 00:29:14 +00001077 // Okay, it is safe to hoist the terminator.
Nick Lewycky67760642009-09-27 07:38:41 +00001078 Instruction *NT = I1->clone();
Chris Lattner37dc9382004-11-30 00:29:14 +00001079 BIParent->getInstList().insert(BI, NT);
Benjamin Kramerf0127052010-01-05 13:12:22 +00001080 if (!NT->getType()->isVoidTy()) {
Chris Lattner37dc9382004-11-30 00:29:14 +00001081 I1->replaceAllUsesWith(NT);
1082 I2->replaceAllUsesWith(NT);
Chris Lattner86cc4232007-02-11 01:37:51 +00001083 NT->takeName(I1);
Chris Lattner37dc9382004-11-30 00:29:14 +00001084 }
1085
Devang Pateld3a17882011-05-19 20:52:46 +00001086 IRBuilder<true, NoFolder> Builder(NT);
Chris Lattner37dc9382004-11-30 00:29:14 +00001087 // Hoisting one of the terminators from our successor is a great thing.
1088 // Unfortunately, the successors of the if/else blocks may have PHI nodes in
1089 // them. If they do, all PHI entries for BB1/BB2 must agree for all PHI
1090 // nodes, so we insert select instruction to compute the final result.
1091 std::map<std::pair<Value*,Value*>, SelectInst*> InsertedSelects;
1092 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
1093 PHINode *PN;
1094 for (BasicBlock::iterator BBI = SI->begin();
Chris Lattner0f535c62004-11-30 07:47:34 +00001095 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
Chris Lattner37dc9382004-11-30 00:29:14 +00001096 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1097 Value *BB2V = PN->getIncomingValueForBlock(BB2);
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001098 if (BB1V == BB2V) continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001099
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001100 // These values do not agree. Insert a select instruction before NT
1101 // that determines the right value.
1102 SelectInst *&SI = InsertedSelects[std::make_pair(BB1V, BB2V)];
Andrew Trick6b014382012-08-29 21:46:36 +00001103 if (SI == 0)
Devang Pateld3a17882011-05-19 20:52:46 +00001104 SI = cast<SelectInst>
1105 (Builder.CreateSelect(BI->getCondition(), BB1V, BB2V,
1106 BB1V->getName()+"."+BB2V->getName()));
1107
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001108 // Make the PHI node use the select for all incoming values for BB1/BB2
1109 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1110 if (PN->getIncomingBlock(i) == BB1 || PN->getIncomingBlock(i) == BB2)
1111 PN->setIncomingValue(i, SI);
Chris Lattner37dc9382004-11-30 00:29:14 +00001112 }
1113 }
1114
1115 // Update any PHI nodes in our new successors.
1116 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI)
1117 AddPredecessorToBlock(*SI, BIParent, BB1);
Misha Brukmanfd939082005-04-21 23:48:37 +00001118
Eli Friedman080efb82008-12-16 20:54:32 +00001119 EraseTerminatorInstAndDCECond(BI);
Chris Lattner37dc9382004-11-30 00:29:14 +00001120 return true;
1121}
1122
Manman Ren554da1a2012-09-20 22:37:36 +00001123/// SinkThenElseCodeToEnd - Given an unconditional branch that goes to BBEnd,
1124/// check whether BBEnd has only two predecessors and the other predecessor
1125/// ends with an unconditional branch. If it is true, sink any common code
1126/// in the two predecessors to BBEnd.
1127static bool SinkThenElseCodeToEnd(BranchInst *BI1) {
1128 assert(BI1->isUnconditional());
1129 BasicBlock *BB1 = BI1->getParent();
1130 BasicBlock *BBEnd = BI1->getSuccessor(0);
1131
1132 // Check that BBEnd has two predecessors and the other predecessor ends with
1133 // an unconditional branch.
Benjamin Kramerfdb96062012-09-30 21:03:56 +00001134 pred_iterator PI = pred_begin(BBEnd), PE = pred_end(BBEnd);
1135 BasicBlock *Pred0 = *PI++;
1136 if (PI == PE) // Only one predecessor.
Manman Ren554da1a2012-09-20 22:37:36 +00001137 return false;
Benjamin Kramerfdb96062012-09-30 21:03:56 +00001138 BasicBlock *Pred1 = *PI++;
1139 if (PI != PE) // More than two predecessors.
1140 return false;
1141 BasicBlock *BB2 = (Pred0 == BB1) ? Pred1 : Pred0;
Manman Ren554da1a2012-09-20 22:37:36 +00001142 BranchInst *BI2 = dyn_cast<BranchInst>(BB2->getTerminator());
1143 if (!BI2 || !BI2->isUnconditional())
1144 return false;
1145
1146 // Gather the PHI nodes in BBEnd.
1147 std::map<Value*, std::pair<Value*, PHINode*> > MapValueFromBB1ToBB2;
1148 Instruction *FirstNonPhiInBBEnd = 0;
1149 for (BasicBlock::iterator I = BBEnd->begin(), E = BBEnd->end();
1150 I != E; ++I) {
1151 if (PHINode *PN = dyn_cast<PHINode>(I)) {
1152 Value *BB1V = PN->getIncomingValueForBlock(BB1);
Andrew Trickdf523d42012-11-15 18:40:29 +00001153 Value *BB2V = PN->getIncomingValueForBlock(BB2);
Manman Ren554da1a2012-09-20 22:37:36 +00001154 MapValueFromBB1ToBB2[BB1V] = std::make_pair(BB2V, PN);
1155 } else {
1156 FirstNonPhiInBBEnd = &*I;
1157 break;
1158 }
1159 }
1160 if (!FirstNonPhiInBBEnd)
1161 return false;
Andrew Trickdf523d42012-11-15 18:40:29 +00001162
Manman Ren554da1a2012-09-20 22:37:36 +00001163
1164 // This does very trivial matching, with limited scanning, to find identical
1165 // instructions in the two blocks. We scan backward for obviously identical
1166 // instructions in an identical order.
1167 BasicBlock::InstListType::reverse_iterator RI1 = BB1->getInstList().rbegin(),
1168 RE1 = BB1->getInstList().rend(), RI2 = BB2->getInstList().rbegin(),
1169 RE2 = BB2->getInstList().rend();
1170 // Skip debug info.
1171 while (RI1 != RE1 && isa<DbgInfoIntrinsic>(&*RI1)) ++RI1;
1172 if (RI1 == RE1)
1173 return false;
1174 while (RI2 != RE2 && isa<DbgInfoIntrinsic>(&*RI2)) ++RI2;
1175 if (RI2 == RE2)
1176 return false;
1177 // Skip the unconditional branches.
1178 ++RI1;
1179 ++RI2;
1180
1181 bool Changed = false;
1182 while (RI1 != RE1 && RI2 != RE2) {
1183 // Skip debug info.
1184 while (RI1 != RE1 && isa<DbgInfoIntrinsic>(&*RI1)) ++RI1;
1185 if (RI1 == RE1)
1186 return Changed;
1187 while (RI2 != RE2 && isa<DbgInfoIntrinsic>(&*RI2)) ++RI2;
1188 if (RI2 == RE2)
1189 return Changed;
1190
1191 Instruction *I1 = &*RI1, *I2 = &*RI2;
1192 // I1 and I2 should have a single use in the same PHI node, and they
1193 // perform the same operation.
1194 // Cannot move control-flow-involving, volatile loads, vaarg, etc.
1195 if (isa<PHINode>(I1) || isa<PHINode>(I2) ||
1196 isa<TerminatorInst>(I1) || isa<TerminatorInst>(I2) ||
1197 isa<LandingPadInst>(I1) || isa<LandingPadInst>(I2) ||
1198 isa<AllocaInst>(I1) || isa<AllocaInst>(I2) ||
1199 I1->mayHaveSideEffects() || I2->mayHaveSideEffects() ||
1200 I1->mayReadOrWriteMemory() || I2->mayReadOrWriteMemory() ||
1201 !I1->hasOneUse() || !I2->hasOneUse() ||
1202 MapValueFromBB1ToBB2.find(I1) == MapValueFromBB1ToBB2.end() ||
1203 MapValueFromBB1ToBB2[I1].first != I2)
1204 return Changed;
1205
1206 // Check whether we should swap the operands of ICmpInst.
1207 ICmpInst *ICmp1 = dyn_cast<ICmpInst>(I1), *ICmp2 = dyn_cast<ICmpInst>(I2);
1208 bool SwapOpnds = false;
1209 if (ICmp1 && ICmp2 &&
1210 ICmp1->getOperand(0) != ICmp2->getOperand(0) &&
1211 ICmp1->getOperand(1) != ICmp2->getOperand(1) &&
1212 (ICmp1->getOperand(0) == ICmp2->getOperand(1) ||
1213 ICmp1->getOperand(1) == ICmp2->getOperand(0))) {
1214 ICmp2->swapOperands();
1215 SwapOpnds = true;
1216 }
1217 if (!I1->isSameOperationAs(I2)) {
1218 if (SwapOpnds)
1219 ICmp2->swapOperands();
1220 return Changed;
1221 }
1222
1223 // The operands should be either the same or they need to be generated
1224 // with a PHI node after sinking. We only handle the case where there is
1225 // a single pair of different operands.
1226 Value *DifferentOp1 = 0, *DifferentOp2 = 0;
1227 unsigned Op1Idx = 0;
1228 for (unsigned I = 0, E = I1->getNumOperands(); I != E; ++I) {
1229 if (I1->getOperand(I) == I2->getOperand(I))
1230 continue;
1231 // Early exit if we have more-than one pair of different operands or
1232 // the different operand is already in MapValueFromBB1ToBB2.
1233 // Early exit if we need a PHI node to replace a constant.
1234 if (DifferentOp1 ||
1235 MapValueFromBB1ToBB2.find(I1->getOperand(I)) !=
1236 MapValueFromBB1ToBB2.end() ||
1237 isa<Constant>(I1->getOperand(I)) ||
1238 isa<Constant>(I2->getOperand(I))) {
1239 // If we can't sink the instructions, undo the swapping.
1240 if (SwapOpnds)
1241 ICmp2->swapOperands();
1242 return Changed;
1243 }
1244 DifferentOp1 = I1->getOperand(I);
1245 Op1Idx = I;
1246 DifferentOp2 = I2->getOperand(I);
1247 }
1248
1249 // We insert the pair of different operands to MapValueFromBB1ToBB2 and
1250 // remove (I1, I2) from MapValueFromBB1ToBB2.
1251 if (DifferentOp1) {
1252 PHINode *NewPN = PHINode::Create(DifferentOp1->getType(), 2,
1253 DifferentOp1->getName() + ".sink",
1254 BBEnd->begin());
1255 MapValueFromBB1ToBB2[DifferentOp1] = std::make_pair(DifferentOp2, NewPN);
1256 // I1 should use NewPN instead of DifferentOp1.
1257 I1->setOperand(Op1Idx, NewPN);
1258 NewPN->addIncoming(DifferentOp1, BB1);
1259 NewPN->addIncoming(DifferentOp2, BB2);
1260 DEBUG(dbgs() << "Create PHI node " << *NewPN << "\n";);
1261 }
1262 PHINode *OldPN = MapValueFromBB1ToBB2[I1].second;
1263 MapValueFromBB1ToBB2.erase(I1);
1264
1265 DEBUG(dbgs() << "SINK common instructions " << *I1 << "\n";);
1266 DEBUG(dbgs() << " " << *I2 << "\n";);
1267 // We need to update RE1 and RE2 if we are going to sink the first
1268 // instruction in the basic block down.
1269 bool UpdateRE1 = (I1 == BB1->begin()), UpdateRE2 = (I2 == BB2->begin());
1270 // Sink the instruction.
1271 BBEnd->getInstList().splice(FirstNonPhiInBBEnd, BB1->getInstList(), I1);
1272 if (!OldPN->use_empty())
1273 OldPN->replaceAllUsesWith(I1);
1274 OldPN->eraseFromParent();
1275
1276 if (!I2->use_empty())
1277 I2->replaceAllUsesWith(I1);
1278 I1->intersectOptionalDataWith(I2);
1279 I2->eraseFromParent();
1280
1281 if (UpdateRE1)
1282 RE1 = BB1->getInstList().rend();
1283 if (UpdateRE2)
1284 RE2 = BB2->getInstList().rend();
1285 FirstNonPhiInBBEnd = I1;
1286 NumSinkCommons++;
1287 Changed = true;
1288 }
1289 return Changed;
1290}
1291
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001292/// \brief Determine if we can hoist sink a sole store instruction out of a
1293/// conditional block.
1294///
1295/// We are looking for code like the following:
1296/// BrBB:
1297/// store i32 %add, i32* %arrayidx2
1298/// ... // No other stores or function calls (we could be calling a memory
1299/// ... // function).
1300/// %cmp = icmp ult %x, %y
1301/// br i1 %cmp, label %EndBB, label %ThenBB
1302/// ThenBB:
1303/// store i32 %add5, i32* %arrayidx2
1304/// br label EndBB
1305/// EndBB:
1306/// ...
1307/// We are going to transform this into:
1308/// BrBB:
1309/// store i32 %add, i32* %arrayidx2
1310/// ... //
1311/// %cmp = icmp ult %x, %y
1312/// %add.add5 = select i1 %cmp, i32 %add, %add5
1313/// store i32 %add.add5, i32* %arrayidx2
1314/// ...
1315///
1316/// \return The pointer to the value of the previous store if the store can be
1317/// hoisted into the predecessor block. 0 otherwise.
Benjamin Kramer603100d2013-05-23 16:09:15 +00001318static Value *isSafeToSpeculateStore(Instruction *I, BasicBlock *BrBB,
1319 BasicBlock *StoreBB, BasicBlock *EndBB) {
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001320 StoreInst *StoreToHoist = dyn_cast<StoreInst>(I);
1321 if (!StoreToHoist)
1322 return 0;
1323
1324 // Volatile or atomic.
1325 if (!StoreToHoist->isSimple())
1326 return 0;
1327
1328 Value *StorePtr = StoreToHoist->getPointerOperand();
1329
1330 // Look for a store to the same pointer in BrBB.
1331 unsigned MaxNumInstToLookAt = 10;
1332 for (BasicBlock::reverse_iterator RI = BrBB->rbegin(),
1333 RE = BrBB->rend(); RI != RE && (--MaxNumInstToLookAt); ++RI) {
1334 Instruction *CurI = &*RI;
1335
1336 // Could be calling an instruction that effects memory like free().
1337 if (CurI->mayHaveSideEffects() && !isa<StoreInst>(CurI))
1338 return 0;
1339
1340 StoreInst *SI = dyn_cast<StoreInst>(CurI);
1341 // Found the previous store make sure it stores to the same location.
1342 if (SI && SI->getPointerOperand() == StorePtr)
1343 // Found the previous store, return its value operand.
1344 return SI->getValueOperand();
1345 else if (SI)
1346 return 0; // Unknown store.
1347 }
1348
1349 return 0;
1350}
1351
Chandler Carruthc61bc7a2013-01-24 08:05:06 +00001352/// \brief Speculate a conditional basic block flattening the CFG.
Dan Gohman3b205172012-01-05 23:58:56 +00001353///
Chandler Carruthc61bc7a2013-01-24 08:05:06 +00001354/// Note that this is a very risky transform currently. Speculating
1355/// instructions like this is most often not desirable. Instead, there is an MI
1356/// pass which can do it with full awareness of the resource constraints.
1357/// However, some cases are "obvious" and we should do directly. An example of
1358/// this is speculating a single, reasonably cheap instruction.
1359///
1360/// There is only one distinct advantage to flattening the CFG at the IR level:
1361/// it makes very common but simplistic optimizations such as are common in
1362/// instcombine and the DAG combiner more powerful by removing CFG edges and
1363/// modeling their effects with easier to reason about SSA value graphs.
1364///
1365///
1366/// An illustration of this transform is turning this IR:
1367/// \code
1368/// BB:
1369/// %cmp = icmp ult %x, %y
1370/// br i1 %cmp, label %EndBB, label %ThenBB
1371/// ThenBB:
1372/// %sub = sub %x, %y
Dan Gohman3b205172012-01-05 23:58:56 +00001373/// br label BB2
Chandler Carruthc61bc7a2013-01-24 08:05:06 +00001374/// EndBB:
1375/// %phi = phi [ %sub, %ThenBB ], [ 0, %EndBB ]
1376/// ...
1377/// \endcode
1378///
1379/// Into this IR:
1380/// \code
1381/// BB:
1382/// %cmp = icmp ult %x, %y
1383/// %sub = sub %x, %y
1384/// %cond = select i1 %cmp, 0, %sub
1385/// ...
1386/// \endcode
1387///
1388/// \returns true if the conditional block is removed.
Chandler Carruth455151e2013-01-27 06:42:03 +00001389static bool SpeculativelyExecuteBB(BranchInst *BI, BasicBlock *ThenBB) {
Chandler Carruth9e620952013-01-24 08:22:40 +00001390 // Be conservative for now. FP select instruction can often be expensive.
1391 Value *BrCond = BI->getCondition();
1392 if (isa<FCmpInst>(BrCond))
1393 return false;
1394
Chandler Carruth6cf7a912013-01-24 09:59:39 +00001395 BasicBlock *BB = BI->getParent();
1396 BasicBlock *EndBB = ThenBB->getTerminator()->getSuccessor(0);
1397
1398 // If ThenBB is actually on the false edge of the conditional branch, remember
1399 // to swap the select operands later.
1400 bool Invert = false;
1401 if (ThenBB != BI->getSuccessor(0)) {
1402 assert(ThenBB == BI->getSuccessor(1) && "No edge from 'if' block?");
1403 Invert = true;
1404 }
1405 assert(EndBB == BI->getSuccessor(!Invert) && "No edge from to end block");
1406
Chandler Carruthbaf868b2013-01-25 05:40:09 +00001407 // Keep a count of how many times instructions are used within CondBB when
1408 // they are candidates for sinking into CondBB. Specifically:
1409 // - They are defined in BB, and
1410 // - They have no side effects, and
1411 // - All of their uses are in CondBB.
1412 SmallDenseMap<Instruction *, unsigned, 4> SinkCandidateUseCounts;
1413
Chandler Carruth2c107a82013-01-24 11:52:58 +00001414 unsigned SpeculationCost = 0;
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001415 Value *SpeculatedStoreValue = 0;
1416 StoreInst *SpeculatedStore = 0;
Chandler Carruth2c107a82013-01-24 11:52:58 +00001417 for (BasicBlock::iterator BBI = ThenBB->begin(),
1418 BBE = llvm::prior(ThenBB->end());
Devang Patel06b1e672009-03-06 06:00:17 +00001419 BBI != BBE; ++BBI) {
1420 Instruction *I = BBI;
1421 // Skip debug info.
Chandler Carruth2c107a82013-01-24 11:52:58 +00001422 if (isa<DbgInfoIntrinsic>(I))
1423 continue;
Devang Patel06b1e672009-03-06 06:00:17 +00001424
Chandler Carruth2c107a82013-01-24 11:52:58 +00001425 // Only speculatively execution a single instruction (not counting the
1426 // terminator) for now.
Chandler Carruth455151e2013-01-27 06:42:03 +00001427 ++SpeculationCost;
1428 if (SpeculationCost > 1)
Devang Patel06b1e672009-03-06 06:00:17 +00001429 return false;
Dan Gohman3b205172012-01-05 23:58:56 +00001430
Dan Gohman3b205172012-01-05 23:58:56 +00001431 // Don't hoist the instruction if it's unsafe or expensive.
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001432 if (!isSafeToSpeculativelyExecute(I) &&
1433 !(HoistCondStores &&
1434 (SpeculatedStoreValue = isSafeToSpeculateStore(I, BB, ThenBB,
1435 EndBB))))
Dan Gohman3b205172012-01-05 23:58:56 +00001436 return false;
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001437 if (!SpeculatedStoreValue &&
1438 ComputeSpeculationCost(I) > PHINodeFoldingThreshold)
Dan Gohman3b205172012-01-05 23:58:56 +00001439 return false;
1440
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001441 // Store the store speculation candidate.
1442 if (SpeculatedStoreValue)
1443 SpeculatedStore = cast<StoreInst>(I);
1444
Dan Gohman3b205172012-01-05 23:58:56 +00001445 // Do not hoist the instruction if any of its operands are defined but not
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001446 // used in BB. The transformation will prevent the operand from
Dan Gohman3b205172012-01-05 23:58:56 +00001447 // being sunk into the use block.
Chandler Carruth2c107a82013-01-24 11:52:58 +00001448 for (User::op_iterator i = I->op_begin(), e = I->op_end();
Dan Gohman3b205172012-01-05 23:58:56 +00001449 i != e; ++i) {
1450 Instruction *OpI = dyn_cast<Instruction>(*i);
Chandler Carruthbaf868b2013-01-25 05:40:09 +00001451 if (!OpI || OpI->getParent() != BB ||
1452 OpI->mayHaveSideEffects())
1453 continue; // Not a candidate for sinking.
1454
1455 ++SinkCandidateUseCounts[OpI];
Dan Gohman3b205172012-01-05 23:58:56 +00001456 }
1457 }
Evan Cheng4d09efd2008-06-07 08:52:29 +00001458
Chandler Carruthbaf868b2013-01-25 05:40:09 +00001459 // Consider any sink candidates which are only used in CondBB as costs for
1460 // speculation. Note, while we iterate over a DenseMap here, we are summing
1461 // and so iteration order isn't significant.
1462 for (SmallDenseMap<Instruction *, unsigned, 4>::iterator I =
1463 SinkCandidateUseCounts.begin(), E = SinkCandidateUseCounts.end();
1464 I != E; ++I)
1465 if (I->first->getNumUses() == I->second) {
Chandler Carruth455151e2013-01-27 06:42:03 +00001466 ++SpeculationCost;
1467 if (SpeculationCost > 1)
Chandler Carruthbaf868b2013-01-25 05:40:09 +00001468 return false;
1469 }
1470
Chandler Carruth0afa3312013-01-24 10:40:51 +00001471 // Check that the PHI nodes can be converted to selects.
1472 bool HaveRewritablePHIs = false;
Chandler Carruth6cf7a912013-01-24 09:59:39 +00001473 for (BasicBlock::iterator I = EndBB->begin();
Dan Gohman3b205172012-01-05 23:58:56 +00001474 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
Chandler Carruth6cf7a912013-01-24 09:59:39 +00001475 Value *OrigV = PN->getIncomingValueForBlock(BB);
1476 Value *ThenV = PN->getIncomingValueForBlock(ThenBB);
Dan Gohman3b205172012-01-05 23:58:56 +00001477
Rafael Espindolababae052013-06-04 14:11:59 +00001478 // FIXME: Try to remove some of the duplication with HoistThenElseCodeToIf.
Dan Gohman3b205172012-01-05 23:58:56 +00001479 // Skip PHIs which are trivial.
Chandler Carruth6cf7a912013-01-24 09:59:39 +00001480 if (ThenV == OrigV)
Dan Gohman3b205172012-01-05 23:58:56 +00001481 continue;
1482
Chandler Carruth0afa3312013-01-24 10:40:51 +00001483 HaveRewritablePHIs = true;
Rafael Espindolababae052013-06-04 14:11:59 +00001484 ConstantExpr *OrigCE = dyn_cast<ConstantExpr>(OrigV);
1485 ConstantExpr *ThenCE = dyn_cast<ConstantExpr>(ThenV);
1486 if (!OrigCE && !ThenCE)
Chandler Carruth681add72013-01-24 11:53:01 +00001487 continue; // Known safe and cheap.
1488
Rafael Espindolababae052013-06-04 14:11:59 +00001489 if ((ThenCE && !isSafeToSpeculativelyExecute(ThenCE)) ||
1490 (OrigCE && !isSafeToSpeculativelyExecute(OrigCE)))
Chandler Carruth681add72013-01-24 11:53:01 +00001491 return false;
Rafael Espindolababae052013-06-04 14:11:59 +00001492 unsigned OrigCost = OrigCE ? ComputeSpeculationCost(OrigCE) : 0;
1493 unsigned ThenCost = ThenCE ? ComputeSpeculationCost(ThenCE) : 0;
1494 if (OrigCost + ThenCost > 2 * PHINodeFoldingThreshold)
Chandler Carruth681add72013-01-24 11:53:01 +00001495 return false;
Chandler Carruth0afa3312013-01-24 10:40:51 +00001496
Chandler Carruth47d8f6d2013-01-24 12:05:17 +00001497 // Account for the cost of an unfolded ConstantExpr which could end up
1498 // getting expanded into Instructions.
1499 // FIXME: This doesn't account for how many operations are combined in the
Chandler Carruth455151e2013-01-27 06:42:03 +00001500 // constant expression.
1501 ++SpeculationCost;
1502 if (SpeculationCost > 1)
Chandler Carruth0afa3312013-01-24 10:40:51 +00001503 return false;
Evan Cheng4d09efd2008-06-07 08:52:29 +00001504 }
Dan Gohman3b205172012-01-05 23:58:56 +00001505
1506 // If there are no PHIs to process, bail early. This helps ensure idempotence
1507 // as well.
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001508 if (!HaveRewritablePHIs && !(HoistCondStores && SpeculatedStoreValue))
Dan Gohman3b205172012-01-05 23:58:56 +00001509 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001510
Dan Gohman3b205172012-01-05 23:58:56 +00001511 // If we get here, we can hoist the instruction and if-convert.
Chandler Carruth6cf7a912013-01-24 09:59:39 +00001512 DEBUG(dbgs() << "SPECULATIVELY EXECUTING BB" << *ThenBB << "\n";);
Evan Cheng4d09efd2008-06-07 08:52:29 +00001513
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001514 // Insert a select of the value of the speculated store.
1515 if (SpeculatedStoreValue) {
1516 IRBuilder<true, NoFolder> Builder(BI);
1517 Value *TrueV = SpeculatedStore->getValueOperand();
1518 Value *FalseV = SpeculatedStoreValue;
1519 if (Invert)
1520 std::swap(TrueV, FalseV);
1521 Value *S = Builder.CreateSelect(BrCond, TrueV, FalseV, TrueV->getName() +
1522 "." + FalseV->getName());
1523 SpeculatedStore->setOperand(0, S);
1524 }
1525
Chandler Carruth2c107a82013-01-24 11:52:58 +00001526 // Hoist the instructions.
1527 BB->getInstList().splice(BI, ThenBB->getInstList(), ThenBB->begin(),
1528 llvm::prior(ThenBB->end()));
Evan Cheng502a4f52008-06-12 21:15:59 +00001529
Dan Gohman3b205172012-01-05 23:58:56 +00001530 // Insert selects and rewrite the PHI operands.
Devang Pateld3a17882011-05-19 20:52:46 +00001531 IRBuilder<true, NoFolder> Builder(BI);
Chandler Carruth0afa3312013-01-24 10:40:51 +00001532 for (BasicBlock::iterator I = EndBB->begin();
1533 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
1534 unsigned OrigI = PN->getBasicBlockIndex(BB);
1535 unsigned ThenI = PN->getBasicBlockIndex(ThenBB);
1536 Value *OrigV = PN->getIncomingValue(OrigI);
1537 Value *ThenV = PN->getIncomingValue(ThenI);
1538
1539 // Skip PHIs which are trivial.
1540 if (OrigV == ThenV)
1541 continue;
Evan Cheng4d09efd2008-06-07 08:52:29 +00001542
Dan Gohman3b205172012-01-05 23:58:56 +00001543 // Create a select whose true value is the speculatively executed value and
Chandler Carruth0afa3312013-01-24 10:40:51 +00001544 // false value is the preexisting value. Swap them if the branch
1545 // destinations were inverted.
1546 Value *TrueV = ThenV, *FalseV = OrigV;
Dan Gohman3b205172012-01-05 23:58:56 +00001547 if (Invert)
Chandler Carruth0afa3312013-01-24 10:40:51 +00001548 std::swap(TrueV, FalseV);
1549 Value *V = Builder.CreateSelect(BrCond, TrueV, FalseV,
1550 TrueV->getName() + "." + FalseV->getName());
1551 PN->setIncomingValue(OrigI, V);
1552 PN->setIncomingValue(ThenI, V);
Evan Cheng4d09efd2008-06-07 08:52:29 +00001553 }
1554
Evan Cheng502a4f52008-06-12 21:15:59 +00001555 ++NumSpeculations;
Evan Cheng4d09efd2008-06-07 08:52:29 +00001556 return true;
1557}
1558
Chris Lattner2e42e362005-09-20 00:43:16 +00001559/// BlockIsSimpleEnoughToThreadThrough - Return true if we can thread a branch
1560/// across this block.
1561static bool BlockIsSimpleEnoughToThreadThrough(BasicBlock *BB) {
1562 BranchInst *BI = cast<BranchInst>(BB->getTerminator());
Chris Lattnere9487f02005-09-20 01:48:40 +00001563 unsigned Size = 0;
Andrew Trick6b014382012-08-29 21:46:36 +00001564
Devang Patel9200c892009-03-10 18:00:05 +00001565 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
Dale Johannesen8483e542009-03-12 23:18:09 +00001566 if (isa<DbgInfoIntrinsic>(BBI))
1567 continue;
Chris Lattnere9487f02005-09-20 01:48:40 +00001568 if (Size > 10) return false; // Don't clone large BB's.
Dale Johannesen8483e542009-03-12 23:18:09 +00001569 ++Size;
Andrew Trick6b014382012-08-29 21:46:36 +00001570
Dale Johannesen8483e542009-03-12 23:18:09 +00001571 // We can only support instructions that do not define values that are
Chris Lattnere9487f02005-09-20 01:48:40 +00001572 // live outside of the current basic block.
1573 for (Value::use_iterator UI = BBI->use_begin(), E = BBI->use_end();
1574 UI != E; ++UI) {
1575 Instruction *U = cast<Instruction>(*UI);
1576 if (U->getParent() != BB || isa<PHINode>(U)) return false;
1577 }
Andrew Trick6b014382012-08-29 21:46:36 +00001578
Chris Lattner2e42e362005-09-20 00:43:16 +00001579 // Looks ok, continue checking.
1580 }
Chris Lattnere9487f02005-09-20 01:48:40 +00001581
Chris Lattner2e42e362005-09-20 00:43:16 +00001582 return true;
1583}
1584
Chris Lattnereaba3a12005-09-19 23:49:37 +00001585/// FoldCondBranchOnPHI - If we have a conditional branch on a PHI node value
1586/// that is defined in the same block as the branch and if any PHI entries are
1587/// constants, thread edges corresponding to that entry to be branches to their
1588/// ultimate destination.
Micah Villmow3574eca2012-10-08 16:38:25 +00001589static bool FoldCondBranchOnPHI(BranchInst *BI, const DataLayout *TD) {
Chris Lattnereaba3a12005-09-19 23:49:37 +00001590 BasicBlock *BB = BI->getParent();
1591 PHINode *PN = dyn_cast<PHINode>(BI->getCondition());
Chris Lattner9c88d982005-09-19 23:57:04 +00001592 // NOTE: we currently cannot transform this case if the PHI node is used
1593 // outside of the block.
Chris Lattner2e42e362005-09-20 00:43:16 +00001594 if (!PN || PN->getParent() != BB || !PN->hasOneUse())
1595 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001596
Chris Lattnereaba3a12005-09-19 23:49:37 +00001597 // Degenerate case of a single entry PHI.
1598 if (PN->getNumIncomingValues() == 1) {
Chris Lattner29874e02008-12-03 19:44:02 +00001599 FoldSingleEntryPHINodes(PN->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00001600 return true;
Chris Lattnereaba3a12005-09-19 23:49:37 +00001601 }
1602
1603 // Now we know that this block has multiple preds and two succs.
Chris Lattner2e42e362005-09-20 00:43:16 +00001604 if (!BlockIsSimpleEnoughToThreadThrough(BB)) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001605
Chris Lattnereaba3a12005-09-19 23:49:37 +00001606 // Okay, this is a simple enough basic block. See if any phi values are
1607 // constants.
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00001608 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001609 ConstantInt *CB = dyn_cast<ConstantInt>(PN->getIncomingValue(i));
1610 if (CB == 0 || !CB->getType()->isIntegerTy(1)) continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001611
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001612 // Okay, we now know that all edges from PredBB should be revectored to
1613 // branch to RealDest.
1614 BasicBlock *PredBB = PN->getIncomingBlock(i);
1615 BasicBlock *RealDest = BI->getSuccessor(!CB->getZExtValue());
Andrew Trick6b014382012-08-29 21:46:36 +00001616
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001617 if (RealDest == BB) continue; // Skip self loops.
Bill Wendling6a648b82011-06-04 09:42:04 +00001618 // Skip if the predecessor's terminator is an indirect branch.
1619 if (isa<IndirectBrInst>(PredBB->getTerminator())) continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001620
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001621 // The dest block might have PHI nodes, other predecessors and other
1622 // difficult cases. Instead of being smart about this, just insert a new
1623 // block that jumps to the destination block, effectively splitting
1624 // the edge we are about to create.
1625 BasicBlock *EdgeBB = BasicBlock::Create(BB->getContext(),
1626 RealDest->getName()+".critedge",
1627 RealDest->getParent(), RealDest);
1628 BranchInst::Create(RealDest, EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00001629
Chris Lattner6de0a282010-12-14 07:09:42 +00001630 // Update PHI nodes.
1631 AddPredecessorToBlock(RealDest, EdgeBB, BB);
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001632
1633 // BB may have instructions that are being threaded over. Clone these
1634 // instructions into EdgeBB. We know that there will be no uses of the
1635 // cloned instructions outside of EdgeBB.
1636 BasicBlock::iterator InsertPt = EdgeBB->begin();
1637 DenseMap<Value*, Value*> TranslateMap; // Track translated values.
1638 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
1639 if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
1640 TranslateMap[PN] = PN->getIncomingValueForBlock(PredBB);
1641 continue;
1642 }
1643 // Clone the instruction.
1644 Instruction *N = BBI->clone();
1645 if (BBI->hasName()) N->setName(BBI->getName()+".c");
Andrew Trick6b014382012-08-29 21:46:36 +00001646
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001647 // Update operands due to translation.
1648 for (User::op_iterator i = N->op_begin(), e = N->op_end();
1649 i != e; ++i) {
1650 DenseMap<Value*, Value*>::iterator PI = TranslateMap.find(*i);
1651 if (PI != TranslateMap.end())
1652 *i = PI->second;
1653 }
Andrew Trick6b014382012-08-29 21:46:36 +00001654
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001655 // Check for trivial simplification.
Chris Lattner302ba6f2010-12-14 06:17:25 +00001656 if (Value *V = SimplifyInstruction(N, TD)) {
1657 TranslateMap[BBI] = V;
1658 delete N; // Instruction folded away, don't need actual inst
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001659 } else {
1660 // Insert the new instruction into its new home.
1661 EdgeBB->getInstList().insert(InsertPt, N);
1662 if (!BBI->use_empty())
1663 TranslateMap[BBI] = N;
1664 }
1665 }
1666
1667 // Loop over all of the edges from PredBB to BB, changing them to branch
1668 // to EdgeBB instead.
1669 TerminatorInst *PredBBTI = PredBB->getTerminator();
1670 for (unsigned i = 0, e = PredBBTI->getNumSuccessors(); i != e; ++i)
1671 if (PredBBTI->getSuccessor(i) == BB) {
1672 BB->removePredecessor(PredBB);
1673 PredBBTI->setSuccessor(i, EdgeBB);
1674 }
Bill Wendling6a648b82011-06-04 09:42:04 +00001675
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001676 // Recurse, simplifying any other constants.
Chris Lattner302ba6f2010-12-14 06:17:25 +00001677 return FoldCondBranchOnPHI(BI, TD) | true;
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00001678 }
Chris Lattnereaba3a12005-09-19 23:49:37 +00001679
1680 return false;
1681}
1682
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001683/// FoldTwoEntryPHINode - Given a BB that starts with the specified two-entry
1684/// PHI node, see if we can eliminate it.
Micah Villmow3574eca2012-10-08 16:38:25 +00001685static bool FoldTwoEntryPHINode(PHINode *PN, const DataLayout *TD) {
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001686 // Ok, this is a two entry PHI node. Check to see if this is a simple "if
1687 // statement", which has a very simple dominance structure. Basically, we
1688 // are trying to find the condition that is being branched on, which
1689 // subsequently causes this merge to happen. We really want control
1690 // dependence information for this check, but simplifycfg can't keep it up
1691 // to date, and this catches most of the cases we care about anyway.
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001692 BasicBlock *BB = PN->getParent();
1693 BasicBlock *IfTrue, *IfFalse;
1694 Value *IfCond = GetIfCondition(BB, IfTrue, IfFalse);
Chris Lattner60d410d2010-12-14 08:01:53 +00001695 if (!IfCond ||
1696 // Don't bother if the branch will be constant folded trivially.
1697 isa<ConstantInt>(IfCond))
1698 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001699
Chris Lattner822a8792006-11-18 19:19:36 +00001700 // Okay, we found that we can merge this two-entry phi node into a select.
1701 // Doing so would require us to fold *all* two entry phi nodes in this block.
1702 // At some point this becomes non-profitable (particularly if the target
1703 // doesn't support cmov's). Only do this transformation if there are two or
1704 // fewer PHI nodes in this block.
1705 unsigned NumPhis = 0;
1706 for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I); ++NumPhis, ++I)
1707 if (NumPhis > 2)
1708 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001709
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001710 // Loop over the PHI's seeing if we can promote them all to select
1711 // instructions. While we are at it, keep track of the instructions
1712 // that need to be moved to the dominating block.
Chris Lattner44da7ca2010-12-14 07:41:39 +00001713 SmallPtrSet<Instruction*, 4> AggressiveInsts;
Peter Collingbourne57808b32011-04-29 18:47:38 +00001714 unsigned MaxCostVal0 = PHINodeFoldingThreshold,
1715 MaxCostVal1 = PHINodeFoldingThreshold;
Andrew Trick6b014382012-08-29 21:46:36 +00001716
Chris Lattner3aff13b2010-12-14 08:46:09 +00001717 for (BasicBlock::iterator II = BB->begin(); isa<PHINode>(II);) {
1718 PHINode *PN = cast<PHINode>(II++);
Chris Lattner07ff3532010-12-14 07:20:29 +00001719 if (Value *V = SimplifyInstruction(PN, TD)) {
1720 PN->replaceAllUsesWith(V);
Chris Lattner3aff13b2010-12-14 08:46:09 +00001721 PN->eraseFromParent();
Chris Lattner07ff3532010-12-14 07:20:29 +00001722 continue;
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001723 }
Andrew Trick6b014382012-08-29 21:46:36 +00001724
Peter Collingbournef15907f2011-04-29 18:47:31 +00001725 if (!DominatesMergePoint(PN->getIncomingValue(0), BB, &AggressiveInsts,
1726 MaxCostVal0) ||
1727 !DominatesMergePoint(PN->getIncomingValue(1), BB, &AggressiveInsts,
1728 MaxCostVal1))
Chris Lattner07ff3532010-12-14 07:20:29 +00001729 return false;
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001730 }
Andrew Trick6b014382012-08-29 21:46:36 +00001731
Sylvestre Ledruc8e41c52012-07-23 08:51:15 +00001732 // If we folded the first phi, PN dangles at this point. Refresh it. If
Chris Lattner44da7ca2010-12-14 07:41:39 +00001733 // we ran out of PHIs then we simplified them all.
1734 PN = dyn_cast<PHINode>(BB->begin());
1735 if (PN == 0) return true;
Andrew Trick6b014382012-08-29 21:46:36 +00001736
Chris Lattner3aff13b2010-12-14 08:46:09 +00001737 // Don't fold i1 branches on PHIs which contain binary operators. These can
1738 // often be turned into switches and other things.
1739 if (PN->getType()->isIntegerTy(1) &&
1740 (isa<BinaryOperator>(PN->getIncomingValue(0)) ||
1741 isa<BinaryOperator>(PN->getIncomingValue(1)) ||
1742 isa<BinaryOperator>(IfCond)))
1743 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001744
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001745 // If we all PHI nodes are promotable, check to make sure that all
1746 // instructions in the predecessor blocks can be promoted as well. If
1747 // not, we won't be able to get rid of the control flow, so it's not
1748 // worth promoting to select instructions.
Chris Lattner44da7ca2010-12-14 07:41:39 +00001749 BasicBlock *DomBlock = 0;
1750 BasicBlock *IfBlock1 = PN->getIncomingBlock(0);
1751 BasicBlock *IfBlock2 = PN->getIncomingBlock(1);
1752 if (cast<BranchInst>(IfBlock1->getTerminator())->isConditional()) {
1753 IfBlock1 = 0;
1754 } else {
1755 DomBlock = *pred_begin(IfBlock1);
1756 for (BasicBlock::iterator I = IfBlock1->begin();!isa<TerminatorInst>(I);++I)
Devang Patel383d7ed2009-02-03 22:12:02 +00001757 if (!AggressiveInsts.count(I) && !isa<DbgInfoIntrinsic>(I)) {
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001758 // This is not an aggressive instruction that we can promote.
1759 // Because of this, we won't be able to get rid of the control
1760 // flow, so the xform is not worth it.
1761 return false;
1762 }
1763 }
Andrew Trick6b014382012-08-29 21:46:36 +00001764
Chris Lattner44da7ca2010-12-14 07:41:39 +00001765 if (cast<BranchInst>(IfBlock2->getTerminator())->isConditional()) {
1766 IfBlock2 = 0;
1767 } else {
1768 DomBlock = *pred_begin(IfBlock2);
1769 for (BasicBlock::iterator I = IfBlock2->begin();!isa<TerminatorInst>(I);++I)
Devang Patel383d7ed2009-02-03 22:12:02 +00001770 if (!AggressiveInsts.count(I) && !isa<DbgInfoIntrinsic>(I)) {
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001771 // This is not an aggressive instruction that we can promote.
1772 // Because of this, we won't be able to get rid of the control
1773 // flow, so the xform is not worth it.
1774 return false;
1775 }
1776 }
Andrew Trick6b014382012-08-29 21:46:36 +00001777
Chris Lattnere0b18e52010-12-14 07:23:10 +00001778 DEBUG(dbgs() << "FOUND IF CONDITION! " << *IfCond << " T: "
Chris Lattner44da7ca2010-12-14 07:41:39 +00001779 << IfTrue->getName() << " F: " << IfFalse->getName() << "\n");
Andrew Trick6b014382012-08-29 21:46:36 +00001780
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001781 // If we can still promote the PHI nodes after this gauntlet of tests,
1782 // do all of the PHI's now.
Chris Lattner3aff13b2010-12-14 08:46:09 +00001783 Instruction *InsertPt = DomBlock->getTerminator();
Devang Pateld3a17882011-05-19 20:52:46 +00001784 IRBuilder<true, NoFolder> Builder(InsertPt);
Andrew Trick6b014382012-08-29 21:46:36 +00001785
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001786 // Move all 'aggressive' instructions, which are defined in the
1787 // conditional parts of the if's up to the dominating block.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001788 if (IfBlock1)
Chris Lattner3aff13b2010-12-14 08:46:09 +00001789 DomBlock->getInstList().splice(InsertPt,
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001790 IfBlock1->getInstList(), IfBlock1->begin(),
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001791 IfBlock1->getTerminator());
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001792 if (IfBlock2)
Chris Lattner3aff13b2010-12-14 08:46:09 +00001793 DomBlock->getInstList().splice(InsertPt,
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001794 IfBlock2->getInstList(), IfBlock2->begin(),
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001795 IfBlock2->getTerminator());
Andrew Trick6b014382012-08-29 21:46:36 +00001796
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001797 while (PHINode *PN = dyn_cast<PHINode>(BB->begin())) {
1798 // Change the PHI node into a select instruction.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001799 Value *TrueVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfFalse);
1800 Value *FalseVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfTrue);
Andrew Trick6b014382012-08-29 21:46:36 +00001801
1802 SelectInst *NV =
Devang Patelf60364d2011-05-18 18:16:44 +00001803 cast<SelectInst>(Builder.CreateSelect(IfCond, TrueVal, FalseVal, ""));
Chris Lattner86cc4232007-02-11 01:37:51 +00001804 PN->replaceAllUsesWith(NV);
1805 NV->takeName(PN);
Chris Lattner302ba6f2010-12-14 06:17:25 +00001806 PN->eraseFromParent();
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001807 }
Andrew Trick6b014382012-08-29 21:46:36 +00001808
Chris Lattner60d410d2010-12-14 08:01:53 +00001809 // At this point, IfBlock1 and IfBlock2 are both empty, so our if statement
1810 // has been flattened. Change DomBlock to jump directly to our new block to
1811 // avoid other simplifycfg's kicking in on the diamond.
1812 TerminatorInst *OldTI = DomBlock->getTerminator();
Devang Patelf60364d2011-05-18 18:16:44 +00001813 Builder.SetInsertPoint(OldTI);
1814 Builder.CreateBr(BB);
Chris Lattner60d410d2010-12-14 08:01:53 +00001815 OldTI->eraseFromParent();
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001816 return true;
1817}
Chris Lattnereaba3a12005-09-19 23:49:37 +00001818
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001819/// SimplifyCondBranchToTwoReturns - If we found a conditional branch that goes
1820/// to two returning blocks, try to merge them together into one return,
1821/// introducing a select if the return values disagree.
Andrew Trick6b014382012-08-29 21:46:36 +00001822static bool SimplifyCondBranchToTwoReturns(BranchInst *BI,
Devang Patel176ec402011-05-18 21:33:11 +00001823 IRBuilder<> &Builder) {
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001824 assert(BI->isConditional() && "Must be a conditional branch");
1825 BasicBlock *TrueSucc = BI->getSuccessor(0);
1826 BasicBlock *FalseSucc = BI->getSuccessor(1);
1827 ReturnInst *TrueRet = cast<ReturnInst>(TrueSucc->getTerminator());
1828 ReturnInst *FalseRet = cast<ReturnInst>(FalseSucc->getTerminator());
Andrew Trick6b014382012-08-29 21:46:36 +00001829
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001830 // Check to ensure both blocks are empty (just a return) or optionally empty
1831 // with PHI nodes. If there are other instructions, merging would cause extra
1832 // computation on one path or the other.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001833 if (!TrueSucc->getFirstNonPHIOrDbg()->isTerminator())
Devang Patel2cc86a12009-02-05 00:30:42 +00001834 return false;
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001835 if (!FalseSucc->getFirstNonPHIOrDbg()->isTerminator())
Devang Patel2cc86a12009-02-05 00:30:42 +00001836 return false;
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001837
Devang Patel176ec402011-05-18 21:33:11 +00001838 Builder.SetInsertPoint(BI);
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001839 // Okay, we found a branch that is going to two return nodes. If
1840 // there is no return value for this function, just change the
1841 // branch into a return.
1842 if (FalseRet->getNumOperands() == 0) {
1843 TrueSucc->removePredecessor(BI->getParent());
1844 FalseSucc->removePredecessor(BI->getParent());
Devang Patel176ec402011-05-18 21:33:11 +00001845 Builder.CreateRetVoid();
Eli Friedman080efb82008-12-16 20:54:32 +00001846 EraseTerminatorInstAndDCECond(BI);
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001847 return true;
1848 }
Andrew Trick6b014382012-08-29 21:46:36 +00001849
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001850 // Otherwise, figure out what the true and false return values are
1851 // so we can insert a new select instruction.
1852 Value *TrueValue = TrueRet->getReturnValue();
1853 Value *FalseValue = FalseRet->getReturnValue();
Andrew Trick6b014382012-08-29 21:46:36 +00001854
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001855 // Unwrap any PHI nodes in the return blocks.
1856 if (PHINode *TVPN = dyn_cast_or_null<PHINode>(TrueValue))
1857 if (TVPN->getParent() == TrueSucc)
1858 TrueValue = TVPN->getIncomingValueForBlock(BI->getParent());
1859 if (PHINode *FVPN = dyn_cast_or_null<PHINode>(FalseValue))
1860 if (FVPN->getParent() == FalseSucc)
1861 FalseValue = FVPN->getIncomingValueForBlock(BI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00001862
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001863 // In order for this transformation to be safe, we must be able to
1864 // unconditionally execute both operands to the return. This is
1865 // normally the case, but we could have a potentially-trapping
1866 // constant expression that prevents this transformation from being
1867 // safe.
1868 if (ConstantExpr *TCV = dyn_cast_or_null<ConstantExpr>(TrueValue))
1869 if (TCV->canTrap())
1870 return false;
1871 if (ConstantExpr *FCV = dyn_cast_or_null<ConstantExpr>(FalseValue))
1872 if (FCV->canTrap())
1873 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001874
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001875 // Okay, we collected all the mapped values and checked them for sanity, and
1876 // defined to really do this transformation. First, update the CFG.
1877 TrueSucc->removePredecessor(BI->getParent());
1878 FalseSucc->removePredecessor(BI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00001879
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001880 // Insert select instructions where needed.
1881 Value *BrCond = BI->getCondition();
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001882 if (TrueValue) {
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001883 // Insert a select if the results differ.
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001884 if (TrueValue == FalseValue || isa<UndefValue>(FalseValue)) {
1885 } else if (isa<UndefValue>(TrueValue)) {
1886 TrueValue = FalseValue;
1887 } else {
Devang Patel176ec402011-05-18 21:33:11 +00001888 TrueValue = Builder.CreateSelect(BrCond, TrueValue,
1889 FalseValue, "retval");
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001890 }
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001891 }
1892
Andrew Trick6b014382012-08-29 21:46:36 +00001893 Value *RI = !TrueValue ?
Devang Patel176ec402011-05-18 21:33:11 +00001894 Builder.CreateRetVoid() : Builder.CreateRet(TrueValue);
1895
Daniel Dunbare317bcc2009-08-23 10:29:55 +00001896 (void) RI;
Andrew Trick6b014382012-08-29 21:46:36 +00001897
David Greene89d6fd32010-01-05 01:26:52 +00001898 DEBUG(dbgs() << "\nCHANGING BRANCH TO TWO RETURNS INTO SELECT:"
Chris Lattnerbdff5482009-08-23 04:37:46 +00001899 << "\n " << *BI << "NewRet = " << *RI
1900 << "TRUEBLOCK: " << *TrueSucc << "FALSEBLOCK: "<< *FalseSucc);
Andrew Trick6b014382012-08-29 21:46:36 +00001901
Eli Friedman080efb82008-12-16 20:54:32 +00001902 EraseTerminatorInstAndDCECond(BI);
1903
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001904 return true;
1905}
1906
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001907/// ExtractBranchMetadata - Given a conditional BranchInstruction, retrieve the
1908/// probabilities of the branch taking each edge. Fills in the two APInt
1909/// parameters and return true, or returns false if no or invalid metadata was
1910/// found.
1911static bool ExtractBranchMetadata(BranchInst *BI,
Manman Ren062986c2012-09-15 00:39:57 +00001912 uint64_t &ProbTrue, uint64_t &ProbFalse) {
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001913 assert(BI->isConditional() &&
1914 "Looking for probabilities on unconditional branch?");
1915 MDNode *ProfileData = BI->getMetadata(LLVMContext::MD_prof);
Nick Lewycky91968482011-12-27 18:27:22 +00001916 if (!ProfileData || ProfileData->getNumOperands() != 3) return false;
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001917 ConstantInt *CITrue = dyn_cast<ConstantInt>(ProfileData->getOperand(1));
1918 ConstantInt *CIFalse = dyn_cast<ConstantInt>(ProfileData->getOperand(2));
Nick Lewycky91968482011-12-27 18:27:22 +00001919 if (!CITrue || !CIFalse) return false;
Manman Ren062986c2012-09-15 00:39:57 +00001920 ProbTrue = CITrue->getValue().getZExtValue();
1921 ProbFalse = CIFalse->getValue().getZExtValue();
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001922 return true;
1923}
1924
Manman Renee28e0f2012-06-13 05:43:29 +00001925/// checkCSEInPredecessor - Return true if the given instruction is available
1926/// in its predecessor block. If yes, the instruction will be removed.
1927///
Benjamin Kramer23d36222012-07-13 13:25:15 +00001928static bool checkCSEInPredecessor(Instruction *Inst, BasicBlock *PB) {
Manman Renee28e0f2012-06-13 05:43:29 +00001929 if (!isa<BinaryOperator>(Inst) && !isa<CmpInst>(Inst))
1930 return false;
1931 for (BasicBlock::iterator I = PB->begin(), E = PB->end(); I != E; I++) {
1932 Instruction *PBI = &*I;
1933 // Check whether Inst and PBI generate the same value.
1934 if (Inst->isIdenticalTo(PBI)) {
1935 Inst->replaceAllUsesWith(PBI);
1936 Inst->eraseFromParent();
1937 return true;
1938 }
1939 }
1940 return false;
1941}
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00001942
Chris Lattnerc8fbc342011-04-11 23:24:57 +00001943/// FoldBranchToCommonDest - If this basic block is simple enough, and if a
1944/// predecessor branches to us and one of our successors, fold the block into
1945/// the predecessor and use logical operations to pick the right destination.
Dan Gohman4b35f832009-06-27 21:30:38 +00001946bool llvm::FoldBranchToCommonDest(BranchInst *BI) {
Chris Lattner093a4382008-07-13 22:23:11 +00001947 BasicBlock *BB = BI->getParent();
Devang Pateld3a17882011-05-19 20:52:46 +00001948
Manman Renee28e0f2012-06-13 05:43:29 +00001949 Instruction *Cond = 0;
1950 if (BI->isConditional())
1951 Cond = dyn_cast<Instruction>(BI->getCondition());
1952 else {
1953 // For unconditional branch, check for a simple CFG pattern, where
1954 // BB has a single predecessor and BB's successor is also its predecessor's
1955 // successor. If such pattern exisits, check for CSE between BB and its
1956 // predecessor.
1957 if (BasicBlock *PB = BB->getSinglePredecessor())
1958 if (BranchInst *PBI = dyn_cast<BranchInst>(PB->getTerminator()))
1959 if (PBI->isConditional() &&
1960 (BI->getSuccessor(0) == PBI->getSuccessor(0) ||
1961 BI->getSuccessor(0) == PBI->getSuccessor(1))) {
1962 for (BasicBlock::iterator I = BB->begin(), E = BB->end();
1963 I != E; ) {
1964 Instruction *Curr = I++;
1965 if (isa<CmpInst>(Curr)) {
1966 Cond = Curr;
1967 break;
1968 }
1969 // Quit if we can't remove this instruction.
1970 if (!checkCSEInPredecessor(Curr, PB))
1971 return false;
1972 }
1973 }
1974
1975 if (Cond == 0)
1976 return false;
1977 }
Andrew Trick6b014382012-08-29 21:46:36 +00001978
Owen Andersone84178a2010-07-14 19:52:16 +00001979 if (Cond == 0 || (!isa<CmpInst>(Cond) && !isa<BinaryOperator>(Cond)) ||
1980 Cond->getParent() != BB || !Cond->hasOneUse())
1981 return false;
Devang Pateld4181942011-04-06 22:37:20 +00001982
Chris Lattner1347e872008-07-13 21:12:01 +00001983 // Only allow this if the condition is a simple instruction that can be
1984 // executed unconditionally. It must be in the same block as the branch, and
1985 // must be at the front of the block.
Devang Pateld0a203d2009-02-04 21:39:48 +00001986 BasicBlock::iterator FrontIt = BB->front();
Chris Lattner3c6e7462011-04-14 02:44:53 +00001987
Devang Pateld0a203d2009-02-04 21:39:48 +00001988 // Ignore dbg intrinsics.
Chris Lattner3c6e7462011-04-14 02:44:53 +00001989 while (isa<DbgInfoIntrinsic>(FrontIt)) ++FrontIt;
Nick Lewycky9d523102011-12-26 20:37:40 +00001990
Owen Andersone84178a2010-07-14 19:52:16 +00001991 // Allow a single instruction to be hoisted in addition to the compare
1992 // that feeds the branch. We later ensure that any values that _it_ uses
1993 // were also live in the predecessor, so that we don't unnecessarily create
1994 // register pressure or inhibit out-of-order execution.
1995 Instruction *BonusInst = 0;
1996 if (&*FrontIt != Cond &&
Owen Anderson2722dfa2010-07-15 16:38:22 +00001997 FrontIt->hasOneUse() && *FrontIt->use_begin() == Cond &&
Dan Gohmanf0426602011-12-14 23:49:11 +00001998 isSafeToSpeculativelyExecute(FrontIt)) {
Owen Andersone84178a2010-07-14 19:52:16 +00001999 BonusInst = &*FrontIt;
2000 ++FrontIt;
Andrew Trick6b014382012-08-29 21:46:36 +00002001
Chris Lattner3c6e7462011-04-14 02:44:53 +00002002 // Ignore dbg intrinsics.
2003 while (isa<DbgInfoIntrinsic>(FrontIt)) ++FrontIt;
Devang Patel60d490c2011-04-07 23:11:25 +00002004 }
2005
Owen Andersone84178a2010-07-14 19:52:16 +00002006 // Only a single bonus inst is allowed.
2007 if (&*FrontIt != Cond)
2008 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002009
Chris Lattner1347e872008-07-13 21:12:01 +00002010 // Make sure the instruction after the condition is the cond branch.
2011 BasicBlock::iterator CondIt = Cond; ++CondIt;
Chris Lattner3c6e7462011-04-14 02:44:53 +00002012
Devang Pateld0a203d2009-02-04 21:39:48 +00002013 // Ingore dbg intrinsics.
Chris Lattner3c6e7462011-04-14 02:44:53 +00002014 while (isa<DbgInfoIntrinsic>(CondIt)) ++CondIt;
Andrew Trick6b014382012-08-29 21:46:36 +00002015
Chris Lattner3c6e7462011-04-14 02:44:53 +00002016 if (&*CondIt != BI)
Chris Lattner1347e872008-07-13 21:12:01 +00002017 return false;
Chris Lattner6ff645b2009-01-19 23:03:13 +00002018
2019 // Cond is known to be a compare or binary operator. Check to make sure that
2020 // neither operand is a potentially-trapping constant expression.
2021 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(0)))
2022 if (CE->canTrap())
2023 return false;
2024 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(1)))
2025 if (CE->canTrap())
2026 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002027
Chris Lattner1347e872008-07-13 21:12:01 +00002028 // Finally, don't infinitely unroll conditional loops.
2029 BasicBlock *TrueDest = BI->getSuccessor(0);
Manman Renee28e0f2012-06-13 05:43:29 +00002030 BasicBlock *FalseDest = (BI->isConditional()) ? BI->getSuccessor(1) : 0;
Chris Lattner1347e872008-07-13 21:12:01 +00002031 if (TrueDest == BB || FalseDest == BB)
2032 return false;
Devang Pateld4181942011-04-06 22:37:20 +00002033
Chris Lattner1347e872008-07-13 21:12:01 +00002034 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
2035 BasicBlock *PredBlock = *PI;
2036 BranchInst *PBI = dyn_cast<BranchInst>(PredBlock->getTerminator());
Andrew Trick6b014382012-08-29 21:46:36 +00002037
Chris Lattner093a4382008-07-13 22:23:11 +00002038 // Check that we have two conditional branches. If there is a PHI node in
2039 // the common successor, verify that the same value flows in from both
2040 // blocks.
Manman Renee28e0f2012-06-13 05:43:29 +00002041 SmallVector<PHINode*, 4> PHIs;
2042 if (PBI == 0 || PBI->isUnconditional() ||
Andrew Trick6b014382012-08-29 21:46:36 +00002043 (BI->isConditional() &&
Manman Renee28e0f2012-06-13 05:43:29 +00002044 !SafeToMergeTerminators(BI, PBI)) ||
2045 (!BI->isConditional() &&
2046 !isProfitableToFoldUnconditional(BI, PBI, Cond, PHIs)))
Chris Lattner1347e872008-07-13 21:12:01 +00002047 continue;
Andrew Trick6b014382012-08-29 21:46:36 +00002048
Chris Lattner3c6e7462011-04-14 02:44:53 +00002049 // Determine if the two branches share a common destination.
Axel Naumann3780ad82012-09-17 14:20:57 +00002050 Instruction::BinaryOps Opc = Instruction::BinaryOpsEnd;
Chris Lattner3c6e7462011-04-14 02:44:53 +00002051 bool InvertPredCond = false;
Andrew Trick6b014382012-08-29 21:46:36 +00002052
Manman Renee28e0f2012-06-13 05:43:29 +00002053 if (BI->isConditional()) {
2054 if (PBI->getSuccessor(0) == TrueDest)
2055 Opc = Instruction::Or;
2056 else if (PBI->getSuccessor(1) == FalseDest)
2057 Opc = Instruction::And;
2058 else if (PBI->getSuccessor(0) == FalseDest)
2059 Opc = Instruction::And, InvertPredCond = true;
2060 else if (PBI->getSuccessor(1) == TrueDest)
2061 Opc = Instruction::Or, InvertPredCond = true;
2062 else
2063 continue;
2064 } else {
2065 if (PBI->getSuccessor(0) != TrueDest && PBI->getSuccessor(1) != TrueDest)
2066 continue;
2067 }
Chris Lattner3c6e7462011-04-14 02:44:53 +00002068
Owen Andersone84178a2010-07-14 19:52:16 +00002069 // Ensure that any values used in the bonus instruction are also used
2070 // by the terminator of the predecessor. This means that those values
Andrew Trick6b014382012-08-29 21:46:36 +00002071 // must already have been resolved, so we won't be inhibiting the
Owen Andersone84178a2010-07-14 19:52:16 +00002072 // out-of-order core by speculating them earlier.
2073 if (BonusInst) {
2074 // Collect the values used by the bonus inst
2075 SmallPtrSet<Value*, 4> UsedValues;
2076 for (Instruction::op_iterator OI = BonusInst->op_begin(),
2077 OE = BonusInst->op_end(); OI != OE; ++OI) {
Nick Lewycky9d523102011-12-26 20:37:40 +00002078 Value *V = *OI;
Owen Andersone84178a2010-07-14 19:52:16 +00002079 if (!isa<Constant>(V))
2080 UsedValues.insert(V);
2081 }
2082
2083 SmallVector<std::pair<Value*, unsigned>, 4> Worklist;
2084 Worklist.push_back(std::make_pair(PBI->getOperand(0), 0));
Andrew Trick6b014382012-08-29 21:46:36 +00002085
Owen Andersone84178a2010-07-14 19:52:16 +00002086 // Walk up to four levels back up the use-def chain of the predecessor's
2087 // terminator to see if all those values were used. The choice of four
2088 // levels is arbitrary, to provide a compile-time-cost bound.
2089 while (!Worklist.empty()) {
2090 std::pair<Value*, unsigned> Pair = Worklist.back();
2091 Worklist.pop_back();
Andrew Trick6b014382012-08-29 21:46:36 +00002092
Owen Andersone84178a2010-07-14 19:52:16 +00002093 if (Pair.second >= 4) continue;
2094 UsedValues.erase(Pair.first);
2095 if (UsedValues.empty()) break;
Andrew Trick6b014382012-08-29 21:46:36 +00002096
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00002097 if (Instruction *I = dyn_cast<Instruction>(Pair.first)) {
Owen Andersone84178a2010-07-14 19:52:16 +00002098 for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
2099 OI != OE; ++OI)
2100 Worklist.push_back(std::make_pair(OI->get(), Pair.second+1));
Andrew Trick6b014382012-08-29 21:46:36 +00002101 }
Owen Andersone84178a2010-07-14 19:52:16 +00002102 }
Andrew Trick6b014382012-08-29 21:46:36 +00002103
Owen Andersone84178a2010-07-14 19:52:16 +00002104 if (!UsedValues.empty()) return false;
2105 }
Chris Lattner36989092008-07-13 21:20:19 +00002106
David Greene89d6fd32010-01-05 01:26:52 +00002107 DEBUG(dbgs() << "FOLDING BRANCH TO COMMON DEST:\n" << *PBI << *BB);
Andrew Trick6b014382012-08-29 21:46:36 +00002108 IRBuilder<> Builder(PBI);
Devang Pateld3a17882011-05-19 20:52:46 +00002109
Chris Lattner36989092008-07-13 21:20:19 +00002110 // If we need to invert the condition in the pred block to match, do so now.
2111 if (InvertPredCond) {
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00002112 Value *NewCond = PBI->getCondition();
Andrew Trick6b014382012-08-29 21:46:36 +00002113
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00002114 if (NewCond->hasOneUse() && isa<CmpInst>(NewCond)) {
2115 CmpInst *CI = cast<CmpInst>(NewCond);
2116 CI->setPredicate(CI->getInversePredicate());
2117 } else {
Andrew Trick6b014382012-08-29 21:46:36 +00002118 NewCond = Builder.CreateNot(NewCond,
Devang Pateld3a17882011-05-19 20:52:46 +00002119 PBI->getCondition()->getName()+".not");
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00002120 }
Andrew Trick6b014382012-08-29 21:46:36 +00002121
Chris Lattner1347e872008-07-13 21:12:01 +00002122 PBI->setCondition(NewCond);
Nick Lewyckyc9a1aed2011-12-26 20:54:14 +00002123 PBI->swapSuccessors();
Chris Lattner1347e872008-07-13 21:12:01 +00002124 }
Andrew Trick6b014382012-08-29 21:46:36 +00002125
Owen Andersone84178a2010-07-14 19:52:16 +00002126 // If we have a bonus inst, clone it into the predecessor block.
2127 Instruction *NewBonus = 0;
2128 if (BonusInst) {
2129 NewBonus = BonusInst->clone();
2130 PredBlock->getInstList().insert(PBI, NewBonus);
2131 NewBonus->takeName(BonusInst);
2132 BonusInst->setName(BonusInst->getName()+".old");
2133 }
Andrew Trick6b014382012-08-29 21:46:36 +00002134
Chris Lattner36989092008-07-13 21:20:19 +00002135 // Clone Cond into the predecessor basic block, and or/and the
2136 // two conditions together.
Nick Lewycky67760642009-09-27 07:38:41 +00002137 Instruction *New = Cond->clone();
Owen Andersone84178a2010-07-14 19:52:16 +00002138 if (BonusInst) New->replaceUsesOfWith(BonusInst, NewBonus);
Chris Lattner36989092008-07-13 21:20:19 +00002139 PredBlock->getInstList().insert(PBI, New);
2140 New->takeName(Cond);
2141 Cond->setName(New->getName()+".old");
Andrew Trick6b014382012-08-29 21:46:36 +00002142
Manman Renee28e0f2012-06-13 05:43:29 +00002143 if (BI->isConditional()) {
Andrew Trick6b014382012-08-29 21:46:36 +00002144 Instruction *NewCond =
Manman Renee28e0f2012-06-13 05:43:29 +00002145 cast<Instruction>(Builder.CreateBinOp(Opc, PBI->getCondition(),
Devang Pateld3a17882011-05-19 20:52:46 +00002146 New, "or.cond"));
Manman Renee28e0f2012-06-13 05:43:29 +00002147 PBI->setCondition(NewCond);
2148
Manman Ren062986c2012-09-15 00:39:57 +00002149 uint64_t PredTrueWeight, PredFalseWeight, SuccTrueWeight, SuccFalseWeight;
2150 bool PredHasWeights = ExtractBranchMetadata(PBI, PredTrueWeight,
2151 PredFalseWeight);
2152 bool SuccHasWeights = ExtractBranchMetadata(BI, SuccTrueWeight,
2153 SuccFalseWeight);
2154 SmallVector<uint64_t, 8> NewWeights;
2155
Manman Renee28e0f2012-06-13 05:43:29 +00002156 if (PBI->getSuccessor(0) == BB) {
Manman Ren062986c2012-09-15 00:39:57 +00002157 if (PredHasWeights && SuccHasWeights) {
2158 // PBI: br i1 %x, BB, FalseDest
2159 // BI: br i1 %y, TrueDest, FalseDest
2160 //TrueWeight is TrueWeight for PBI * TrueWeight for BI.
2161 NewWeights.push_back(PredTrueWeight * SuccTrueWeight);
2162 //FalseWeight is FalseWeight for PBI * TotalWeight for BI +
2163 // TrueWeight for PBI * FalseWeight for BI.
2164 // We assume that total weights of a BranchInst can fit into 32 bits.
2165 // Therefore, we will not have overflow using 64-bit arithmetic.
2166 NewWeights.push_back(PredFalseWeight * (SuccFalseWeight +
2167 SuccTrueWeight) + PredTrueWeight * SuccFalseWeight);
2168 }
Manman Renee28e0f2012-06-13 05:43:29 +00002169 AddPredecessorToBlock(TrueDest, PredBlock, BB);
2170 PBI->setSuccessor(0, TrueDest);
2171 }
2172 if (PBI->getSuccessor(1) == BB) {
Manman Ren062986c2012-09-15 00:39:57 +00002173 if (PredHasWeights && SuccHasWeights) {
2174 // PBI: br i1 %x, TrueDest, BB
2175 // BI: br i1 %y, TrueDest, FalseDest
2176 //TrueWeight is TrueWeight for PBI * TotalWeight for BI +
2177 // FalseWeight for PBI * TrueWeight for BI.
2178 NewWeights.push_back(PredTrueWeight * (SuccFalseWeight +
2179 SuccTrueWeight) + PredFalseWeight * SuccTrueWeight);
2180 //FalseWeight is FalseWeight for PBI * FalseWeight for BI.
2181 NewWeights.push_back(PredFalseWeight * SuccFalseWeight);
2182 }
Manman Renee28e0f2012-06-13 05:43:29 +00002183 AddPredecessorToBlock(FalseDest, PredBlock, BB);
2184 PBI->setSuccessor(1, FalseDest);
2185 }
Manman Ren062986c2012-09-15 00:39:57 +00002186 if (NewWeights.size() == 2) {
2187 // Halve the weights if any of them cannot fit in an uint32_t
2188 FitWeights(NewWeights);
2189
2190 SmallVector<uint32_t, 8> MDWeights(NewWeights.begin(),NewWeights.end());
2191 PBI->setMetadata(LLVMContext::MD_prof,
2192 MDBuilder(BI->getContext()).
2193 createBranchWeights(MDWeights));
2194 } else
2195 PBI->setMetadata(LLVMContext::MD_prof, NULL);
Manman Renee28e0f2012-06-13 05:43:29 +00002196 } else {
2197 // Update PHI nodes in the common successors.
2198 for (unsigned i = 0, e = PHIs.size(); i != e; ++i) {
Nick Lewyckyedb58422012-06-24 10:15:42 +00002199 ConstantInt *PBI_C = cast<ConstantInt>(
Manman Renee28e0f2012-06-13 05:43:29 +00002200 PHIs[i]->getIncomingValueForBlock(PBI->getParent()));
2201 assert(PBI_C->getType()->isIntegerTy(1));
2202 Instruction *MergedCond = 0;
2203 if (PBI->getSuccessor(0) == TrueDest) {
2204 // Create (PBI_Cond and PBI_C) or (!PBI_Cond and BI_Value)
2205 // PBI_C is true: PBI_Cond or (!PBI_Cond and BI_Value)
2206 // is false: !PBI_Cond and BI_Value
2207 Instruction *NotCond =
2208 cast<Instruction>(Builder.CreateNot(PBI->getCondition(),
2209 "not.cond"));
2210 MergedCond =
2211 cast<Instruction>(Builder.CreateBinOp(Instruction::And,
2212 NotCond, New,
2213 "and.cond"));
2214 if (PBI_C->isOne())
2215 MergedCond =
2216 cast<Instruction>(Builder.CreateBinOp(Instruction::Or,
2217 PBI->getCondition(), MergedCond,
2218 "or.cond"));
2219 } else {
2220 // Create (PBI_Cond and BI_Value) or (!PBI_Cond and PBI_C)
2221 // PBI_C is true: (PBI_Cond and BI_Value) or (!PBI_Cond)
2222 // is false: PBI_Cond and BI_Value
Andrew Trick6b014382012-08-29 21:46:36 +00002223 MergedCond =
Manman Renee28e0f2012-06-13 05:43:29 +00002224 cast<Instruction>(Builder.CreateBinOp(Instruction::And,
2225 PBI->getCondition(), New,
2226 "and.cond"));
2227 if (PBI_C->isOne()) {
2228 Instruction *NotCond =
2229 cast<Instruction>(Builder.CreateNot(PBI->getCondition(),
2230 "not.cond"));
Andrew Trick6b014382012-08-29 21:46:36 +00002231 MergedCond =
Manman Renee28e0f2012-06-13 05:43:29 +00002232 cast<Instruction>(Builder.CreateBinOp(Instruction::Or,
2233 NotCond, MergedCond,
2234 "or.cond"));
2235 }
2236 }
2237 // Update PHI Node.
2238 PHIs[i]->setIncomingValue(PHIs[i]->getBasicBlockIndex(PBI->getParent()),
2239 MergedCond);
2240 }
2241 // Change PBI from Conditional to Unconditional.
2242 BranchInst *New_PBI = BranchInst::Create(TrueDest, PBI);
2243 EraseTerminatorInstAndDCECond(PBI);
2244 PBI = New_PBI;
Chris Lattner36989092008-07-13 21:20:19 +00002245 }
Devang Pateld4181942011-04-06 22:37:20 +00002246
Nick Lewycky06cc66f2011-12-27 04:31:52 +00002247 // TODO: If BB is reachable from all paths through PredBlock, then we
2248 // could replace PBI's branch probabilities with BI's.
2249
Chris Lattner3c6e7462011-04-14 02:44:53 +00002250 // Copy any debug value intrinsics into the end of PredBlock.
2251 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
2252 if (isa<DbgInfoIntrinsic>(*I))
2253 I->clone()->insertBefore(PBI);
Andrew Trick6b014382012-08-29 21:46:36 +00002254
Chris Lattner117f8cf2010-12-14 05:57:30 +00002255 return true;
Chris Lattner1347e872008-07-13 21:12:01 +00002256 }
2257 return false;
2258}
2259
Chris Lattner867661a2008-07-13 21:53:26 +00002260/// SimplifyCondBranchToCondBranch - If we have a conditional branch as a
2261/// predecessor of another block, this function tries to simplify it. We know
2262/// that PBI and BI are both conditional branches, and BI is in one of the
2263/// successor blocks of PBI - PBI branches to BI.
2264static bool SimplifyCondBranchToCondBranch(BranchInst *PBI, BranchInst *BI) {
2265 assert(PBI->isConditional() && BI->isConditional());
2266 BasicBlock *BB = BI->getParent();
Dan Gohman4ae51262009-08-12 16:23:25 +00002267
Chris Lattner867661a2008-07-13 21:53:26 +00002268 // If this block ends with a branch instruction, and if there is a
Andrew Trick6b014382012-08-29 21:46:36 +00002269 // predecessor that ends on a branch of the same condition, make
Chris Lattner867661a2008-07-13 21:53:26 +00002270 // this conditional branch redundant.
2271 if (PBI->getCondition() == BI->getCondition() &&
2272 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
2273 // Okay, the outcome of this conditional branch is statically
2274 // knowable. If this block had a single pred, handle specially.
2275 if (BB->getSinglePredecessor()) {
2276 // Turn this into a branch on constant.
2277 bool CondIsTrue = PBI->getSuccessor(0) == BB;
Andrew Trick6b014382012-08-29 21:46:36 +00002278 BI->setCondition(ConstantInt::get(Type::getInt1Ty(BB->getContext()),
Owen Anderson1d0be152009-08-13 21:58:54 +00002279 CondIsTrue));
Chris Lattner867661a2008-07-13 21:53:26 +00002280 return true; // Nuke the branch on constant.
2281 }
Andrew Trick6b014382012-08-29 21:46:36 +00002282
Chris Lattner867661a2008-07-13 21:53:26 +00002283 // Otherwise, if there are multiple predecessors, insert a PHI that merges
2284 // in the constant and simplify the block result. Subsequent passes of
2285 // simplifycfg will thread the block.
2286 if (BlockIsSimpleEnoughToThreadThrough(BB)) {
Jay Foadd8b4fb42011-03-30 11:19:20 +00002287 pred_iterator PB = pred_begin(BB), PE = pred_end(BB);
Owen Anderson1d0be152009-08-13 21:58:54 +00002288 PHINode *NewPN = PHINode::Create(Type::getInt1Ty(BB->getContext()),
Jay Foad3ecfc862011-03-30 11:28:46 +00002289 std::distance(PB, PE),
Chris Lattner867661a2008-07-13 21:53:26 +00002290 BI->getCondition()->getName() + ".pr",
2291 BB->begin());
Chris Lattnereb388af2008-07-13 21:55:46 +00002292 // Okay, we're going to insert the PHI node. Since PBI is not the only
2293 // predecessor, compute the PHI'd conditional value for all of the preds.
2294 // Any predecessor where the condition is not computable we keep symbolic.
Jay Foadd8b4fb42011-03-30 11:19:20 +00002295 for (pred_iterator PI = PB; PI != PE; ++PI) {
Gabor Greif62539832010-07-12 10:59:23 +00002296 BasicBlock *P = *PI;
2297 if ((PBI = dyn_cast<BranchInst>(P->getTerminator())) &&
Chris Lattner867661a2008-07-13 21:53:26 +00002298 PBI != BI && PBI->isConditional() &&
2299 PBI->getCondition() == BI->getCondition() &&
2300 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
2301 bool CondIsTrue = PBI->getSuccessor(0) == BB;
Andrew Trick6b014382012-08-29 21:46:36 +00002302 NewPN->addIncoming(ConstantInt::get(Type::getInt1Ty(BB->getContext()),
Gabor Greif62539832010-07-12 10:59:23 +00002303 CondIsTrue), P);
Chris Lattner867661a2008-07-13 21:53:26 +00002304 } else {
Gabor Greif62539832010-07-12 10:59:23 +00002305 NewPN->addIncoming(BI->getCondition(), P);
Chris Lattner867661a2008-07-13 21:53:26 +00002306 }
Gabor Greif62539832010-07-12 10:59:23 +00002307 }
Andrew Trick6b014382012-08-29 21:46:36 +00002308
Chris Lattner867661a2008-07-13 21:53:26 +00002309 BI->setCondition(NewPN);
Chris Lattner867661a2008-07-13 21:53:26 +00002310 return true;
2311 }
2312 }
Andrew Trick6b014382012-08-29 21:46:36 +00002313
Chris Lattner867661a2008-07-13 21:53:26 +00002314 // If this is a conditional branch in an empty block, and if any
2315 // predecessors is a conditional branch to one of our destinations,
2316 // fold the conditions into logical ops and one cond br.
Zhou Shenga8d57fe2009-02-26 06:56:37 +00002317 BasicBlock::iterator BBI = BB->begin();
2318 // Ignore dbg intrinsics.
2319 while (isa<DbgInfoIntrinsic>(BBI))
2320 ++BBI;
2321 if (&*BBI != BI)
Chris Lattnerb8245122008-07-13 22:04:41 +00002322 return false;
Chris Lattner63bf29b2009-01-20 01:15:41 +00002323
Andrew Trick6b014382012-08-29 21:46:36 +00002324
Chris Lattner63bf29b2009-01-20 01:15:41 +00002325 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(BI->getCondition()))
2326 if (CE->canTrap())
2327 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002328
Chris Lattnerb8245122008-07-13 22:04:41 +00002329 int PBIOp, BIOp;
2330 if (PBI->getSuccessor(0) == BI->getSuccessor(0))
2331 PBIOp = BIOp = 0;
2332 else if (PBI->getSuccessor(0) == BI->getSuccessor(1))
2333 PBIOp = 0, BIOp = 1;
2334 else if (PBI->getSuccessor(1) == BI->getSuccessor(0))
2335 PBIOp = 1, BIOp = 0;
2336 else if (PBI->getSuccessor(1) == BI->getSuccessor(1))
2337 PBIOp = BIOp = 1;
2338 else
2339 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002340
Chris Lattnerb8245122008-07-13 22:04:41 +00002341 // Check to make sure that the other destination of this branch
2342 // isn't BB itself. If so, this is an infinite loop that will
2343 // keep getting unwound.
2344 if (PBI->getSuccessor(PBIOp) == BB)
2345 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002346
2347 // Do not perform this transformation if it would require
Chris Lattnerb8245122008-07-13 22:04:41 +00002348 // insertion of a large number of select instructions. For targets
2349 // without predication/cmovs, this is a big pessimization.
2350 BasicBlock *CommonDest = PBI->getSuccessor(PBIOp);
Andrew Trick6b014382012-08-29 21:46:36 +00002351
Chris Lattnerb8245122008-07-13 22:04:41 +00002352 unsigned NumPhis = 0;
2353 for (BasicBlock::iterator II = CommonDest->begin();
2354 isa<PHINode>(II); ++II, ++NumPhis)
2355 if (NumPhis > 2) // Disable this xform.
2356 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002357
Chris Lattnerb8245122008-07-13 22:04:41 +00002358 // Finally, if everything is ok, fold the branches to logical ops.
2359 BasicBlock *OtherDest = BI->getSuccessor(BIOp ^ 1);
Andrew Trick6b014382012-08-29 21:46:36 +00002360
David Greene89d6fd32010-01-05 01:26:52 +00002361 DEBUG(dbgs() << "FOLDING BRs:" << *PBI->getParent()
Chris Lattnerbdff5482009-08-23 04:37:46 +00002362 << "AND: " << *BI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00002363
2364
Chris Lattner093a4382008-07-13 22:23:11 +00002365 // If OtherDest *is* BB, then BB is a basic block with a single conditional
2366 // branch in it, where one edge (OtherDest) goes back to itself but the other
2367 // exits. We don't *know* that the program avoids the infinite loop
2368 // (even though that seems likely). If we do this xform naively, we'll end up
2369 // recursively unpeeling the loop. Since we know that (after the xform is
2370 // done) that the block *is* infinite if reached, we just make it an obviously
2371 // infinite loop with no cond branch.
2372 if (OtherDest == BB) {
2373 // Insert it at the end of the function, because it's either code,
2374 // or it won't matter if it's hot. :)
Owen Anderson1d0be152009-08-13 21:58:54 +00002375 BasicBlock *InfLoopBlock = BasicBlock::Create(BB->getContext(),
2376 "infloop", BB->getParent());
Chris Lattner093a4382008-07-13 22:23:11 +00002377 BranchInst::Create(InfLoopBlock, InfLoopBlock);
2378 OtherDest = InfLoopBlock;
Andrew Trick6b014382012-08-29 21:46:36 +00002379 }
2380
David Greene89d6fd32010-01-05 01:26:52 +00002381 DEBUG(dbgs() << *PBI->getParent()->getParent());
Devang Pateld3a17882011-05-19 20:52:46 +00002382
Chris Lattnerb8245122008-07-13 22:04:41 +00002383 // BI may have other predecessors. Because of this, we leave
2384 // it alone, but modify PBI.
Andrew Trick6b014382012-08-29 21:46:36 +00002385
Chris Lattnerb8245122008-07-13 22:04:41 +00002386 // Make sure we get to CommonDest on True&True directions.
2387 Value *PBICond = PBI->getCondition();
Devang Pateld3a17882011-05-19 20:52:46 +00002388 IRBuilder<true, NoFolder> Builder(PBI);
Chris Lattnerb8245122008-07-13 22:04:41 +00002389 if (PBIOp)
Devang Pateld3a17882011-05-19 20:52:46 +00002390 PBICond = Builder.CreateNot(PBICond, PBICond->getName()+".not");
2391
Chris Lattnerb8245122008-07-13 22:04:41 +00002392 Value *BICond = BI->getCondition();
2393 if (BIOp)
Devang Pateld3a17882011-05-19 20:52:46 +00002394 BICond = Builder.CreateNot(BICond, BICond->getName()+".not");
2395
Chris Lattnerb8245122008-07-13 22:04:41 +00002396 // Merge the conditions.
Devang Pateld3a17882011-05-19 20:52:46 +00002397 Value *Cond = Builder.CreateOr(PBICond, BICond, "brmerge");
Andrew Trick6b014382012-08-29 21:46:36 +00002398
Chris Lattnerb8245122008-07-13 22:04:41 +00002399 // Modify PBI to branch on the new condition to the new dests.
2400 PBI->setCondition(Cond);
2401 PBI->setSuccessor(0, CommonDest);
2402 PBI->setSuccessor(1, OtherDest);
Andrew Trick6b014382012-08-29 21:46:36 +00002403
Manman Ren56654032012-09-17 21:30:40 +00002404 // Update branch weight for PBI.
2405 uint64_t PredTrueWeight, PredFalseWeight, SuccTrueWeight, SuccFalseWeight;
2406 bool PredHasWeights = ExtractBranchMetadata(PBI, PredTrueWeight,
2407 PredFalseWeight);
2408 bool SuccHasWeights = ExtractBranchMetadata(BI, SuccTrueWeight,
2409 SuccFalseWeight);
2410 if (PredHasWeights && SuccHasWeights) {
2411 uint64_t PredCommon = PBIOp ? PredFalseWeight : PredTrueWeight;
2412 uint64_t PredOther = PBIOp ?PredTrueWeight : PredFalseWeight;
2413 uint64_t SuccCommon = BIOp ? SuccFalseWeight : SuccTrueWeight;
2414 uint64_t SuccOther = BIOp ? SuccTrueWeight : SuccFalseWeight;
2415 // The weight to CommonDest should be PredCommon * SuccTotal +
2416 // PredOther * SuccCommon.
2417 // The weight to OtherDest should be PredOther * SuccOther.
2418 SmallVector<uint64_t, 2> NewWeights;
2419 NewWeights.push_back(PredCommon * (SuccCommon + SuccOther) +
2420 PredOther * SuccCommon);
2421 NewWeights.push_back(PredOther * SuccOther);
2422 // Halve the weights if any of them cannot fit in an uint32_t
2423 FitWeights(NewWeights);
2424
2425 SmallVector<uint32_t, 2> MDWeights(NewWeights.begin(),NewWeights.end());
2426 PBI->setMetadata(LLVMContext::MD_prof,
2427 MDBuilder(BI->getContext()).
2428 createBranchWeights(MDWeights));
2429 }
2430
Chris Lattnerb8245122008-07-13 22:04:41 +00002431 // OtherDest may have phi nodes. If so, add an entry from PBI's
2432 // block that are identical to the entries for BI's block.
Chris Lattner6de0a282010-12-14 07:09:42 +00002433 AddPredecessorToBlock(OtherDest, PBI->getParent(), BB);
Andrew Trick6b014382012-08-29 21:46:36 +00002434
Chris Lattnerb8245122008-07-13 22:04:41 +00002435 // We know that the CommonDest already had an edge from PBI to
2436 // it. If it has PHIs though, the PHIs may have different
2437 // entries for BB and PBI's BB. If so, insert a select to make
2438 // them agree.
Chris Lattner6de0a282010-12-14 07:09:42 +00002439 PHINode *PN;
Chris Lattnerb8245122008-07-13 22:04:41 +00002440 for (BasicBlock::iterator II = CommonDest->begin();
2441 (PN = dyn_cast<PHINode>(II)); ++II) {
2442 Value *BIV = PN->getIncomingValueForBlock(BB);
2443 unsigned PBBIdx = PN->getBasicBlockIndex(PBI->getParent());
2444 Value *PBIV = PN->getIncomingValue(PBBIdx);
2445 if (BIV != PBIV) {
2446 // Insert a select in PBI to pick the right value.
Devang Pateld3a17882011-05-19 20:52:46 +00002447 Value *NV = cast<SelectInst>
2448 (Builder.CreateSelect(PBICond, PBIV, BIV, PBIV->getName()+".mux"));
Chris Lattnerb8245122008-07-13 22:04:41 +00002449 PN->setIncomingValue(PBBIdx, NV);
Chris Lattner867661a2008-07-13 21:53:26 +00002450 }
2451 }
Andrew Trick6b014382012-08-29 21:46:36 +00002452
David Greene89d6fd32010-01-05 01:26:52 +00002453 DEBUG(dbgs() << "INTO: " << *PBI->getParent());
2454 DEBUG(dbgs() << *PBI->getParent()->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00002455
Chris Lattnerb8245122008-07-13 22:04:41 +00002456 // This basic block is probably dead. We know it has at least
2457 // one fewer predecessor.
2458 return true;
Chris Lattner867661a2008-07-13 21:53:26 +00002459}
2460
Frits van Bommel65fdded2011-01-11 12:52:11 +00002461// SimplifyTerminatorOnSelect - Simplifies a terminator by replacing it with a
2462// branch to TrueBB if Cond is true or to FalseBB if Cond is false.
2463// Takes care of updating the successors and removing the old terminator.
2464// Also makes sure not to introduce new successors by assuming that edges to
2465// non-successor TrueBBs and FalseBBs aren't reachable.
2466static bool SimplifyTerminatorOnSelect(TerminatorInst *OldTerm, Value *Cond,
Manman Renb11cbe62012-09-17 22:28:55 +00002467 BasicBlock *TrueBB, BasicBlock *FalseBB,
2468 uint32_t TrueWeight,
2469 uint32_t FalseWeight){
Frits van Bommel65fdded2011-01-11 12:52:11 +00002470 // Remove any superfluous successor edges from the CFG.
2471 // First, figure out which successors to preserve.
2472 // If TrueBB and FalseBB are equal, only try to preserve one copy of that
2473 // successor.
2474 BasicBlock *KeepEdge1 = TrueBB;
2475 BasicBlock *KeepEdge2 = TrueBB != FalseBB ? FalseBB : 0;
2476
2477 // Then remove the rest.
2478 for (unsigned I = 0, E = OldTerm->getNumSuccessors(); I != E; ++I) {
2479 BasicBlock *Succ = OldTerm->getSuccessor(I);
2480 // Make sure only to keep exactly one copy of each edge.
2481 if (Succ == KeepEdge1)
2482 KeepEdge1 = 0;
2483 else if (Succ == KeepEdge2)
2484 KeepEdge2 = 0;
2485 else
2486 Succ->removePredecessor(OldTerm->getParent());
2487 }
2488
Devang Pateld3372b82011-05-18 18:43:31 +00002489 IRBuilder<> Builder(OldTerm);
2490 Builder.SetCurrentDebugLocation(OldTerm->getDebugLoc());
2491
Frits van Bommel65fdded2011-01-11 12:52:11 +00002492 // Insert an appropriate new terminator.
2493 if ((KeepEdge1 == 0) && (KeepEdge2 == 0)) {
2494 if (TrueBB == FalseBB)
2495 // We were only looking for one successor, and it was present.
2496 // Create an unconditional branch to it.
Devang Pateld3372b82011-05-18 18:43:31 +00002497 Builder.CreateBr(TrueBB);
Manman Renb11cbe62012-09-17 22:28:55 +00002498 else {
Frits van Bommel65fdded2011-01-11 12:52:11 +00002499 // We found both of the successors we were looking for.
2500 // Create a conditional branch sharing the condition of the select.
Manman Renb11cbe62012-09-17 22:28:55 +00002501 BranchInst *NewBI = Builder.CreateCondBr(Cond, TrueBB, FalseBB);
2502 if (TrueWeight != FalseWeight)
2503 NewBI->setMetadata(LLVMContext::MD_prof,
2504 MDBuilder(OldTerm->getContext()).
2505 createBranchWeights(TrueWeight, FalseWeight));
2506 }
Frits van Bommel65fdded2011-01-11 12:52:11 +00002507 } else if (KeepEdge1 && (KeepEdge2 || TrueBB == FalseBB)) {
2508 // Neither of the selected blocks were successors, so this
2509 // terminator must be unreachable.
2510 new UnreachableInst(OldTerm->getContext(), OldTerm);
2511 } else {
2512 // One of the selected values was a successor, but the other wasn't.
2513 // Insert an unconditional branch to the one that was found;
2514 // the edge to the one that wasn't must be unreachable.
2515 if (KeepEdge1 == 0)
2516 // Only TrueBB was found.
Devang Pateld3372b82011-05-18 18:43:31 +00002517 Builder.CreateBr(TrueBB);
Frits van Bommel65fdded2011-01-11 12:52:11 +00002518 else
2519 // Only FalseBB was found.
Devang Pateld3372b82011-05-18 18:43:31 +00002520 Builder.CreateBr(FalseBB);
Frits van Bommel65fdded2011-01-11 12:52:11 +00002521 }
2522
2523 EraseTerminatorInstAndDCECond(OldTerm);
2524 return true;
2525}
2526
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00002527// SimplifySwitchOnSelect - Replaces
2528// (switch (select cond, X, Y)) on constant X, Y
2529// with a branch - conditional if X and Y lead to distinct BBs,
2530// unconditional otherwise.
2531static bool SimplifySwitchOnSelect(SwitchInst *SI, SelectInst *Select) {
2532 // Check for constant integer values in the select.
2533 ConstantInt *TrueVal = dyn_cast<ConstantInt>(Select->getTrueValue());
2534 ConstantInt *FalseVal = dyn_cast<ConstantInt>(Select->getFalseValue());
2535 if (!TrueVal || !FalseVal)
2536 return false;
2537
2538 // Find the relevant condition and destinations.
2539 Value *Condition = Select->getCondition();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002540 BasicBlock *TrueBB = SI->findCaseValue(TrueVal).getCaseSuccessor();
2541 BasicBlock *FalseBB = SI->findCaseValue(FalseVal).getCaseSuccessor();
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00002542
Manman Renb11cbe62012-09-17 22:28:55 +00002543 // Get weight for TrueBB and FalseBB.
2544 uint32_t TrueWeight = 0, FalseWeight = 0;
2545 SmallVector<uint64_t, 8> Weights;
2546 bool HasWeights = HasBranchWeights(SI);
2547 if (HasWeights) {
2548 GetBranchWeights(SI, Weights);
2549 if (Weights.size() == 1 + SI->getNumCases()) {
2550 TrueWeight = (uint32_t)Weights[SI->findCaseValue(TrueVal).
2551 getSuccessorIndex()];
2552 FalseWeight = (uint32_t)Weights[SI->findCaseValue(FalseVal).
2553 getSuccessorIndex()];
2554 }
2555 }
2556
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00002557 // Perform the actual simplification.
Manman Renb11cbe62012-09-17 22:28:55 +00002558 return SimplifyTerminatorOnSelect(SI, Condition, TrueBB, FalseBB,
2559 TrueWeight, FalseWeight);
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00002560}
2561
Frits van Bommel7ac40c32010-12-05 18:29:03 +00002562// SimplifyIndirectBrOnSelect - Replaces
2563// (indirectbr (select cond, blockaddress(@fn, BlockA),
2564// blockaddress(@fn, BlockB)))
2565// with
2566// (br cond, BlockA, BlockB).
2567static bool SimplifyIndirectBrOnSelect(IndirectBrInst *IBI, SelectInst *SI) {
2568 // Check that both operands of the select are block addresses.
2569 BlockAddress *TBA = dyn_cast<BlockAddress>(SI->getTrueValue());
2570 BlockAddress *FBA = dyn_cast<BlockAddress>(SI->getFalseValue());
2571 if (!TBA || !FBA)
2572 return false;
2573
2574 // Extract the actual blocks.
2575 BasicBlock *TrueBB = TBA->getBasicBlock();
2576 BasicBlock *FalseBB = FBA->getBasicBlock();
2577
Frits van Bommel65fdded2011-01-11 12:52:11 +00002578 // Perform the actual simplification.
Manman Renb11cbe62012-09-17 22:28:55 +00002579 return SimplifyTerminatorOnSelect(IBI, SI->getCondition(), TrueBB, FalseBB,
2580 0, 0);
Frits van Bommel7ac40c32010-12-05 18:29:03 +00002581}
2582
Chris Lattner61c77442010-12-13 03:18:54 +00002583/// TryToSimplifyUncondBranchWithICmpInIt - This is called when we find an icmp
2584/// instruction (a seteq/setne with a constant) as the only instruction in a
2585/// block that ends with an uncond branch. We are looking for a very specific
2586/// pattern that occurs when "A == 1 || A == 2 || A == 3" gets simplified. In
2587/// this case, we merge the first two "or's of icmp" into a switch, but then the
2588/// default value goes to an uncond block with a seteq in it, we get something
2589/// like:
2590///
2591/// switch i8 %A, label %DEFAULT [ i8 1, label %end i8 2, label %end ]
2592/// DEFAULT:
2593/// %tmp = icmp eq i8 %A, 92
2594/// br label %end
2595/// end:
2596/// ... = phi i1 [ true, %entry ], [ %tmp, %DEFAULT ], [ true, %entry ]
Andrew Trick6b014382012-08-29 21:46:36 +00002597///
Chris Lattner61c77442010-12-13 03:18:54 +00002598/// We prefer to split the edge to 'end' so that there is a true/false entry to
2599/// the PHI, merging the third icmp into the switch.
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00002600static bool TryToSimplifyUncondBranchWithICmpInIt(
2601 ICmpInst *ICI, IRBuilder<> &Builder, const TargetTransformInfo &TTI,
2602 const DataLayout *TD) {
Chris Lattner61c77442010-12-13 03:18:54 +00002603 BasicBlock *BB = ICI->getParent();
Devang Patela23812c2011-05-18 18:28:48 +00002604
Chris Lattner61c77442010-12-13 03:18:54 +00002605 // If the block has any PHIs in it or the icmp has multiple uses, it is too
2606 // complex.
2607 if (isa<PHINode>(BB->begin()) || !ICI->hasOneUse()) return false;
2608
2609 Value *V = ICI->getOperand(0);
2610 ConstantInt *Cst = cast<ConstantInt>(ICI->getOperand(1));
Andrew Trick6b014382012-08-29 21:46:36 +00002611
Chris Lattner61c77442010-12-13 03:18:54 +00002612 // The pattern we're looking for is where our only predecessor is a switch on
2613 // 'V' and this block is the default case for the switch. In this case we can
2614 // fold the compared value into the switch to simplify things.
2615 BasicBlock *Pred = BB->getSinglePredecessor();
2616 if (Pred == 0 || !isa<SwitchInst>(Pred->getTerminator())) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002617
Chris Lattner61c77442010-12-13 03:18:54 +00002618 SwitchInst *SI = cast<SwitchInst>(Pred->getTerminator());
2619 if (SI->getCondition() != V)
2620 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002621
Chris Lattner61c77442010-12-13 03:18:54 +00002622 // If BB is reachable on a non-default case, then we simply know the value of
2623 // V in this block. Substitute it and constant fold the icmp instruction
2624 // away.
2625 if (SI->getDefaultDest() != BB) {
2626 ConstantInt *VVal = SI->findCaseDest(BB);
2627 assert(VVal && "Should have a unique destination value");
2628 ICI->setOperand(0, VVal);
Andrew Trick6b014382012-08-29 21:46:36 +00002629
Chris Lattner302ba6f2010-12-14 06:17:25 +00002630 if (Value *V = SimplifyInstruction(ICI, TD)) {
2631 ICI->replaceAllUsesWith(V);
Chris Lattner61c77442010-12-13 03:18:54 +00002632 ICI->eraseFromParent();
2633 }
2634 // BB is now empty, so it is likely to simplify away.
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00002635 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner61c77442010-12-13 03:18:54 +00002636 }
Andrew Trick6b014382012-08-29 21:46:36 +00002637
Chris Lattnerabf70672010-12-13 03:43:57 +00002638 // Ok, the block is reachable from the default dest. If the constant we're
2639 // comparing exists in one of the other edges, then we can constant fold ICI
2640 // and zap it.
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002641 if (SI->findCaseValue(Cst) != SI->case_default()) {
Chris Lattnerabf70672010-12-13 03:43:57 +00002642 Value *V;
2643 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
2644 V = ConstantInt::getFalse(BB->getContext());
2645 else
2646 V = ConstantInt::getTrue(BB->getContext());
Andrew Trick6b014382012-08-29 21:46:36 +00002647
Chris Lattnerabf70672010-12-13 03:43:57 +00002648 ICI->replaceAllUsesWith(V);
2649 ICI->eraseFromParent();
2650 // BB is now empty, so it is likely to simplify away.
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00002651 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattnerabf70672010-12-13 03:43:57 +00002652 }
Andrew Trick6b014382012-08-29 21:46:36 +00002653
Chris Lattner61c77442010-12-13 03:18:54 +00002654 // The use of the icmp has to be in the 'end' block, by the only PHI node in
2655 // the block.
2656 BasicBlock *SuccBlock = BB->getTerminator()->getSuccessor(0);
2657 PHINode *PHIUse = dyn_cast<PHINode>(ICI->use_back());
2658 if (PHIUse == 0 || PHIUse != &SuccBlock->front() ||
2659 isa<PHINode>(++BasicBlock::iterator(PHIUse)))
2660 return false;
2661
2662 // If the icmp is a SETEQ, then the default dest gets false, the new edge gets
2663 // true in the PHI.
2664 Constant *DefaultCst = ConstantInt::getTrue(BB->getContext());
2665 Constant *NewCst = ConstantInt::getFalse(BB->getContext());
2666
2667 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
2668 std::swap(DefaultCst, NewCst);
2669
2670 // Replace ICI (which is used by the PHI for the default value) with true or
2671 // false depending on if it is EQ or NE.
2672 ICI->replaceAllUsesWith(DefaultCst);
2673 ICI->eraseFromParent();
2674
2675 // Okay, the switch goes to this block on a default value. Add an edge from
2676 // the switch to the merge point on the compared value.
2677 BasicBlock *NewBB = BasicBlock::Create(BB->getContext(), "switch.edge",
2678 BB->getParent(), BB);
Manman Renb0102772012-09-17 23:07:43 +00002679 SmallVector<uint64_t, 8> Weights;
2680 bool HasWeights = HasBranchWeights(SI);
2681 if (HasWeights) {
2682 GetBranchWeights(SI, Weights);
2683 if (Weights.size() == 1 + SI->getNumCases()) {
2684 // Split weight for default case to case for "Cst".
2685 Weights[0] = (Weights[0]+1) >> 1;
2686 Weights.push_back(Weights[0]);
2687
2688 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
2689 SI->setMetadata(LLVMContext::MD_prof,
2690 MDBuilder(SI->getContext()).
2691 createBranchWeights(MDWeights));
2692 }
2693 }
Chris Lattner61c77442010-12-13 03:18:54 +00002694 SI->addCase(Cst, NewBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002695
Chris Lattner61c77442010-12-13 03:18:54 +00002696 // NewBB branches to the phi block, add the uncond branch and the phi entry.
Devang Patela23812c2011-05-18 18:28:48 +00002697 Builder.SetInsertPoint(NewBB);
2698 Builder.SetCurrentDebugLocation(SI->getDebugLoc());
2699 Builder.CreateBr(SuccBlock);
Chris Lattner61c77442010-12-13 03:18:54 +00002700 PHIUse->addIncoming(NewCst, NewBB);
2701 return true;
2702}
2703
Chris Lattner97fdb892010-12-13 05:03:41 +00002704/// SimplifyBranchOnICmpChain - The specified branch is a conditional branch.
2705/// Check to see if it is branching on an or/and chain of icmp instructions, and
2706/// fold it into a switch instruction if so.
Micah Villmow3574eca2012-10-08 16:38:25 +00002707static bool SimplifyBranchOnICmpChain(BranchInst *BI, const DataLayout *TD,
Devang Patel02dd5412011-05-18 23:18:47 +00002708 IRBuilder<> &Builder) {
Chris Lattner97fdb892010-12-13 05:03:41 +00002709 Instruction *Cond = dyn_cast<Instruction>(BI->getCondition());
2710 if (Cond == 0) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002711
2712
Chris Lattner97fdb892010-12-13 05:03:41 +00002713 // Change br (X == 0 | X == 1), T, F into a switch instruction.
2714 // If this is a bunch of seteq's or'd together, or if it's a bunch of
2715 // 'setne's and'ed together, collect them.
2716 Value *CompVal = 0;
2717 std::vector<ConstantInt*> Values;
2718 bool TrueWhenEqual = true;
2719 Value *ExtraCase = 0;
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002720 unsigned UsedICmps = 0;
Andrew Trick6b014382012-08-29 21:46:36 +00002721
Chris Lattner97fdb892010-12-13 05:03:41 +00002722 if (Cond->getOpcode() == Instruction::Or) {
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002723 CompVal = GatherConstantCompares(Cond, Values, ExtraCase, TD, true,
2724 UsedICmps);
Chris Lattner97fdb892010-12-13 05:03:41 +00002725 } else if (Cond->getOpcode() == Instruction::And) {
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002726 CompVal = GatherConstantCompares(Cond, Values, ExtraCase, TD, false,
2727 UsedICmps);
Chris Lattner97fdb892010-12-13 05:03:41 +00002728 TrueWhenEqual = false;
2729 }
Andrew Trick6b014382012-08-29 21:46:36 +00002730
Chris Lattner97fdb892010-12-13 05:03:41 +00002731 // If we didn't have a multiply compared value, fail.
2732 if (CompVal == 0) return false;
2733
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002734 // Avoid turning single icmps into a switch.
2735 if (UsedICmps <= 1)
2736 return false;
2737
Chris Lattner97fdb892010-12-13 05:03:41 +00002738 // There might be duplicate constants in the list, which the switch
2739 // instruction can't handle, remove them now.
2740 array_pod_sort(Values.begin(), Values.end(), ConstantIntSortPredicate);
2741 Values.erase(std::unique(Values.begin(), Values.end()), Values.end());
Andrew Trick6b014382012-08-29 21:46:36 +00002742
Chris Lattner97fdb892010-12-13 05:03:41 +00002743 // If Extra was used, we require at least two switch values to do the
2744 // transformation. A switch with one value is just an cond branch.
2745 if (ExtraCase && Values.size() < 2) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002746
Andrew Trickb1b97832012-08-29 21:46:38 +00002747 // TODO: Preserve branch weight metadata, similarly to how
2748 // FoldValueComparisonIntoPredecessors preserves it.
2749
Chris Lattner97fdb892010-12-13 05:03:41 +00002750 // Figure out which block is which destination.
2751 BasicBlock *DefaultBB = BI->getSuccessor(1);
2752 BasicBlock *EdgeBB = BI->getSuccessor(0);
2753 if (!TrueWhenEqual) std::swap(DefaultBB, EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002754
Chris Lattner97fdb892010-12-13 05:03:41 +00002755 BasicBlock *BB = BI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002756
Chris Lattner302ba6f2010-12-14 06:17:25 +00002757 DEBUG(dbgs() << "Converting 'icmp' chain with " << Values.size()
Chris Lattner117f8cf2010-12-14 05:57:30 +00002758 << " cases into SWITCH. BB is:\n" << *BB);
Andrew Trick6b014382012-08-29 21:46:36 +00002759
Chris Lattner97fdb892010-12-13 05:03:41 +00002760 // If there are any extra values that couldn't be folded into the switch
2761 // then we evaluate them with an explicit branch first. Split the block
2762 // right before the condbr to handle it.
2763 if (ExtraCase) {
2764 BasicBlock *NewBB = BB->splitBasicBlock(BI, "switch.early.test");
2765 // Remove the uncond branch added to the old block.
2766 TerminatorInst *OldTI = BB->getTerminator();
Devang Patel02dd5412011-05-18 23:18:47 +00002767 Builder.SetInsertPoint(OldTI);
2768
Chris Lattner117f8cf2010-12-14 05:57:30 +00002769 if (TrueWhenEqual)
Devang Patel02dd5412011-05-18 23:18:47 +00002770 Builder.CreateCondBr(ExtraCase, EdgeBB, NewBB);
Chris Lattner117f8cf2010-12-14 05:57:30 +00002771 else
Devang Patel02dd5412011-05-18 23:18:47 +00002772 Builder.CreateCondBr(ExtraCase, NewBB, EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002773
Chris Lattner97fdb892010-12-13 05:03:41 +00002774 OldTI->eraseFromParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002775
Chris Lattner97bd89e2010-12-13 05:34:18 +00002776 // If there are PHI nodes in EdgeBB, then we need to add a new entry to them
2777 // for the edge we just added.
Chris Lattner6de0a282010-12-14 07:09:42 +00002778 AddPredecessorToBlock(EdgeBB, BB, NewBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002779
Chris Lattner302ba6f2010-12-14 06:17:25 +00002780 DEBUG(dbgs() << " ** 'icmp' chain unhandled condition: " << *ExtraCase
2781 << "\nEXTRABB = " << *BB);
Chris Lattner97fdb892010-12-13 05:03:41 +00002782 BB = NewBB;
2783 }
Devang Patel02dd5412011-05-18 23:18:47 +00002784
2785 Builder.SetInsertPoint(BI);
Chris Lattner97fdb892010-12-13 05:03:41 +00002786 // Convert pointer to int before we switch.
2787 if (CompVal->getType()->isPointerTy()) {
Micah Villmow3574eca2012-10-08 16:38:25 +00002788 assert(TD && "Cannot switch on pointer without DataLayout");
Devang Patel02dd5412011-05-18 23:18:47 +00002789 CompVal = Builder.CreatePtrToInt(CompVal,
Chandler Carruthece6c6b2012-11-01 08:07:29 +00002790 TD->getIntPtrType(CompVal->getContext()),
Devang Patel02dd5412011-05-18 23:18:47 +00002791 "magicptr");
Chris Lattner97fdb892010-12-13 05:03:41 +00002792 }
Andrew Trick6b014382012-08-29 21:46:36 +00002793
Chris Lattner97fdb892010-12-13 05:03:41 +00002794 // Create the new switch instruction now.
Devang Patel02dd5412011-05-18 23:18:47 +00002795 SwitchInst *New = Builder.CreateSwitch(CompVal, DefaultBB, Values.size());
Devang Pateld80e8ed2011-05-17 23:29:05 +00002796
Chris Lattner97fdb892010-12-13 05:03:41 +00002797 // Add all of the 'cases' to the switch instruction.
2798 for (unsigned i = 0, e = Values.size(); i != e; ++i)
2799 New->addCase(Values[i], EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002800
Chris Lattner97fdb892010-12-13 05:03:41 +00002801 // We added edges from PI to the EdgeBB. As such, if there were any
2802 // PHI nodes in EdgeBB, they need entries to be added corresponding to
2803 // the number of edges added.
2804 for (BasicBlock::iterator BBI = EdgeBB->begin();
2805 isa<PHINode>(BBI); ++BBI) {
2806 PHINode *PN = cast<PHINode>(BBI);
2807 Value *InVal = PN->getIncomingValueForBlock(BB);
2808 for (unsigned i = 0, e = Values.size()-1; i != e; ++i)
2809 PN->addIncoming(InVal, BB);
2810 }
Andrew Trick6b014382012-08-29 21:46:36 +00002811
Chris Lattner97fdb892010-12-13 05:03:41 +00002812 // Erase the old branch instruction.
2813 EraseTerminatorInstAndDCECond(BI);
Andrew Trick6b014382012-08-29 21:46:36 +00002814
Chris Lattner302ba6f2010-12-14 06:17:25 +00002815 DEBUG(dbgs() << " ** 'icmp' chain result is:\n" << *BB << '\n');
Chris Lattner97fdb892010-12-13 05:03:41 +00002816 return true;
2817}
2818
Duncan Sandsad99ef82011-09-05 12:57:57 +00002819bool SimplifyCFGOpt::SimplifyResume(ResumeInst *RI, IRBuilder<> &Builder) {
2820 // If this is a trivial landing pad that just continues unwinding the caught
2821 // exception then zap the landing pad, turning its invokes into calls.
2822 BasicBlock *BB = RI->getParent();
2823 LandingPadInst *LPInst = dyn_cast<LandingPadInst>(BB->getFirstNonPHI());
2824 if (RI->getValue() != LPInst)
2825 // Not a landing pad, or the resume is not unwinding the exception that
2826 // caused control to branch here.
2827 return false;
2828
2829 // Check that there are no other instructions except for debug intrinsics.
2830 BasicBlock::iterator I = LPInst, E = RI;
2831 while (++I != E)
2832 if (!isa<DbgInfoIntrinsic>(I))
2833 return false;
2834
2835 // Turn all invokes that unwind here into calls and delete the basic block.
Bill Wendlingd5bb2082013-03-11 20:53:00 +00002836 bool InvokeRequiresTableEntry = false;
2837 bool Changed = false;
Duncan Sandsad99ef82011-09-05 12:57:57 +00002838 for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE;) {
2839 InvokeInst *II = cast<InvokeInst>((*PI++)->getTerminator());
Bill Wendlingd5bb2082013-03-11 20:53:00 +00002840
2841 if (II->hasFnAttr(Attribute::UWTable)) {
2842 // Don't remove an `invoke' instruction if the ABI requires an entry into
2843 // the table.
2844 InvokeRequiresTableEntry = true;
2845 continue;
2846 }
2847
Duncan Sandsad99ef82011-09-05 12:57:57 +00002848 SmallVector<Value*, 8> Args(II->op_begin(), II->op_end() - 3);
Bill Wendlingd5bb2082013-03-11 20:53:00 +00002849
Duncan Sandsad99ef82011-09-05 12:57:57 +00002850 // Insert a call instruction before the invoke.
2851 CallInst *Call = CallInst::Create(II->getCalledValue(), Args, "", II);
2852 Call->takeName(II);
2853 Call->setCallingConv(II->getCallingConv());
2854 Call->setAttributes(II->getAttributes());
2855 Call->setDebugLoc(II->getDebugLoc());
2856
2857 // Anything that used the value produced by the invoke instruction now uses
2858 // the value produced by the call instruction. Note that we do this even
2859 // for void functions and calls with no uses so that the callgraph edge is
2860 // updated.
2861 II->replaceAllUsesWith(Call);
2862 BB->removePredecessor(II->getParent());
2863
2864 // Insert a branch to the normal destination right before the invoke.
2865 BranchInst::Create(II->getNormalDest(), II);
2866
2867 // Finally, delete the invoke instruction!
2868 II->eraseFromParent();
Bill Wendlingd5bb2082013-03-11 20:53:00 +00002869 Changed = true;
Duncan Sandsad99ef82011-09-05 12:57:57 +00002870 }
2871
Bill Wendlingd5bb2082013-03-11 20:53:00 +00002872 if (!InvokeRequiresTableEntry)
2873 // The landingpad is now unreachable. Zap it.
2874 BB->eraseFromParent();
2875
2876 return Changed;
Duncan Sandsad99ef82011-09-05 12:57:57 +00002877}
2878
Devang Patel176ec402011-05-18 21:33:11 +00002879bool SimplifyCFGOpt::SimplifyReturn(ReturnInst *RI, IRBuilder<> &Builder) {
Chris Lattner3d512132010-12-13 06:25:44 +00002880 BasicBlock *BB = RI->getParent();
2881 if (!BB->getFirstNonPHIOrDbg()->isTerminator()) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002882
Chris Lattner3d512132010-12-13 06:25:44 +00002883 // Find predecessors that end with branches.
2884 SmallVector<BasicBlock*, 8> UncondBranchPreds;
2885 SmallVector<BranchInst*, 8> CondBranchPreds;
2886 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
2887 BasicBlock *P = *PI;
2888 TerminatorInst *PTI = P->getTerminator();
2889 if (BranchInst *BI = dyn_cast<BranchInst>(PTI)) {
2890 if (BI->isUnconditional())
2891 UncondBranchPreds.push_back(P);
2892 else
2893 CondBranchPreds.push_back(BI);
2894 }
2895 }
Andrew Trick6b014382012-08-29 21:46:36 +00002896
Chris Lattner3d512132010-12-13 06:25:44 +00002897 // If we found some, do the transformation!
Evan Chengc3f507f2011-01-29 04:46:23 +00002898 if (!UncondBranchPreds.empty() && DupRet) {
Chris Lattner3d512132010-12-13 06:25:44 +00002899 while (!UncondBranchPreds.empty()) {
2900 BasicBlock *Pred = UncondBranchPreds.pop_back_val();
2901 DEBUG(dbgs() << "FOLDING: " << *BB
2902 << "INTO UNCOND BRANCH PRED: " << *Pred);
Evan Chengc3f507f2011-01-29 04:46:23 +00002903 (void)FoldReturnIntoUncondBranch(RI, BB, Pred);
Chris Lattner3d512132010-12-13 06:25:44 +00002904 }
Andrew Trick6b014382012-08-29 21:46:36 +00002905
Chris Lattner3d512132010-12-13 06:25:44 +00002906 // If we eliminated all predecessors of the block, delete the block now.
2907 if (pred_begin(BB) == pred_end(BB))
2908 // We know there are no successors, so just nuke the block.
2909 BB->eraseFromParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002910
Chris Lattner3d512132010-12-13 06:25:44 +00002911 return true;
2912 }
Andrew Trick6b014382012-08-29 21:46:36 +00002913
Chris Lattner3d512132010-12-13 06:25:44 +00002914 // Check out all of the conditional branches going to this return
2915 // instruction. If any of them just select between returns, change the
2916 // branch itself into a select/return pair.
2917 while (!CondBranchPreds.empty()) {
2918 BranchInst *BI = CondBranchPreds.pop_back_val();
Andrew Trick6b014382012-08-29 21:46:36 +00002919
Chris Lattner3d512132010-12-13 06:25:44 +00002920 // Check to see if the non-BB successor is also a return block.
2921 if (isa<ReturnInst>(BI->getSuccessor(0)->getTerminator()) &&
2922 isa<ReturnInst>(BI->getSuccessor(1)->getTerminator()) &&
Devang Patel176ec402011-05-18 21:33:11 +00002923 SimplifyCondBranchToTwoReturns(BI, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00002924 return true;
2925 }
2926 return false;
2927}
2928
Chris Lattner3d512132010-12-13 06:25:44 +00002929bool SimplifyCFGOpt::SimplifyUnreachable(UnreachableInst *UI) {
2930 BasicBlock *BB = UI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002931
Chris Lattner3d512132010-12-13 06:25:44 +00002932 bool Changed = false;
Andrew Trick6b014382012-08-29 21:46:36 +00002933
Chris Lattner3d512132010-12-13 06:25:44 +00002934 // If there are any instructions immediately before the unreachable that can
2935 // be removed, do so.
2936 while (UI != BB->begin()) {
2937 BasicBlock::iterator BBI = UI;
2938 --BBI;
Eli Friedman81763882011-08-15 23:59:28 +00002939 // Do not delete instructions that can have side effects which might cause
2940 // the unreachable to not be reachable; specifically, calls and volatile
2941 // operations may have this effect.
Chris Lattner3d512132010-12-13 06:25:44 +00002942 if (isa<CallInst>(BBI) && !isa<DbgInfoIntrinsic>(BBI)) break;
Eli Friedman81763882011-08-15 23:59:28 +00002943
2944 if (BBI->mayHaveSideEffects()) {
2945 if (StoreInst *SI = dyn_cast<StoreInst>(BBI)) {
2946 if (SI->isVolatile())
2947 break;
2948 } else if (LoadInst *LI = dyn_cast<LoadInst>(BBI)) {
2949 if (LI->isVolatile())
2950 break;
2951 } else if (AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(BBI)) {
2952 if (RMWI->isVolatile())
2953 break;
2954 } else if (AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(BBI)) {
2955 if (CXI->isVolatile())
2956 break;
2957 } else if (!isa<FenceInst>(BBI) && !isa<VAArgInst>(BBI) &&
2958 !isa<LandingPadInst>(BBI)) {
Chris Lattner3d512132010-12-13 06:25:44 +00002959 break;
Eli Friedman81763882011-08-15 23:59:28 +00002960 }
Bill Wendling23b49ba2011-08-16 20:41:17 +00002961 // Note that deleting LandingPad's here is in fact okay, although it
2962 // involves a bit of subtle reasoning. If this inst is a LandingPad,
2963 // all the predecessors of this block will be the unwind edges of Invokes,
2964 // and we can therefore guarantee this block will be erased.
Eli Friedman81763882011-08-15 23:59:28 +00002965 }
2966
Eli Friedman2adc5b62011-03-09 00:48:33 +00002967 // Delete this instruction (any uses are guaranteed to be dead)
2968 if (!BBI->use_empty())
2969 BBI->replaceAllUsesWith(UndefValue::get(BBI->getType()));
Chris Lattner302ba6f2010-12-14 06:17:25 +00002970 BBI->eraseFromParent();
Chris Lattner3d512132010-12-13 06:25:44 +00002971 Changed = true;
2972 }
Andrew Trick6b014382012-08-29 21:46:36 +00002973
Chris Lattner3d512132010-12-13 06:25:44 +00002974 // If the unreachable instruction is the first in the block, take a gander
2975 // at all of the predecessors of this instruction, and simplify them.
2976 if (&BB->front() != UI) return Changed;
Andrew Trick6b014382012-08-29 21:46:36 +00002977
Chris Lattner3d512132010-12-13 06:25:44 +00002978 SmallVector<BasicBlock*, 8> Preds(pred_begin(BB), pred_end(BB));
2979 for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
2980 TerminatorInst *TI = Preds[i]->getTerminator();
Devang Patel1aa89a22011-05-19 00:09:21 +00002981 IRBuilder<> Builder(TI);
Chris Lattner3d512132010-12-13 06:25:44 +00002982 if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
2983 if (BI->isUnconditional()) {
2984 if (BI->getSuccessor(0) == BB) {
2985 new UnreachableInst(TI->getContext(), TI);
2986 TI->eraseFromParent();
2987 Changed = true;
2988 }
2989 } else {
2990 if (BI->getSuccessor(0) == BB) {
Devang Patel1aa89a22011-05-19 00:09:21 +00002991 Builder.CreateBr(BI->getSuccessor(1));
Chris Lattner3d512132010-12-13 06:25:44 +00002992 EraseTerminatorInstAndDCECond(BI);
2993 } else if (BI->getSuccessor(1) == BB) {
Devang Patel1aa89a22011-05-19 00:09:21 +00002994 Builder.CreateBr(BI->getSuccessor(0));
Chris Lattner3d512132010-12-13 06:25:44 +00002995 EraseTerminatorInstAndDCECond(BI);
2996 Changed = true;
2997 }
2998 }
2999 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003000 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003001 i != e; ++i)
3002 if (i.getCaseSuccessor() == BB) {
Chris Lattner3d512132010-12-13 06:25:44 +00003003 BB->removePredecessor(SI->getParent());
3004 SI->removeCase(i);
3005 --i; --e;
3006 Changed = true;
3007 }
3008 // If the default value is unreachable, figure out the most popular
3009 // destination and make it the default.
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003010 if (SI->getDefaultDest() == BB) {
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003011 std::map<BasicBlock*, std::pair<unsigned, unsigned> > Popularity;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003012 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003013 i != e; ++i) {
Nick Lewycky9d523102011-12-26 20:37:40 +00003014 std::pair<unsigned, unsigned> &entry =
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003015 Popularity[i.getCaseSuccessor()];
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003016 if (entry.first == 0) {
3017 entry.first = 1;
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003018 entry.second = i.getCaseIndex();
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003019 } else {
3020 entry.first++;
3021 }
3022 }
3023
Chris Lattner3d512132010-12-13 06:25:44 +00003024 // Find the most popular block.
3025 unsigned MaxPop = 0;
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003026 unsigned MaxIndex = 0;
Chris Lattner3d512132010-12-13 06:25:44 +00003027 BasicBlock *MaxBlock = 0;
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003028 for (std::map<BasicBlock*, std::pair<unsigned, unsigned> >::iterator
Chris Lattner3d512132010-12-13 06:25:44 +00003029 I = Popularity.begin(), E = Popularity.end(); I != E; ++I) {
Andrew Trick6b014382012-08-29 21:46:36 +00003030 if (I->second.first > MaxPop ||
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003031 (I->second.first == MaxPop && MaxIndex > I->second.second)) {
3032 MaxPop = I->second.first;
3033 MaxIndex = I->second.second;
Chris Lattner3d512132010-12-13 06:25:44 +00003034 MaxBlock = I->first;
3035 }
3036 }
3037 if (MaxBlock) {
3038 // Make this the new default, allowing us to delete any explicit
3039 // edges to it.
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003040 SI->setDefaultDest(MaxBlock);
Chris Lattner3d512132010-12-13 06:25:44 +00003041 Changed = true;
Andrew Trick6b014382012-08-29 21:46:36 +00003042
Chris Lattner3d512132010-12-13 06:25:44 +00003043 // If MaxBlock has phinodes in it, remove MaxPop-1 entries from
3044 // it.
3045 if (isa<PHINode>(MaxBlock->begin()))
3046 for (unsigned i = 0; i != MaxPop-1; ++i)
3047 MaxBlock->removePredecessor(SI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00003048
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003049 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003050 i != e; ++i)
3051 if (i.getCaseSuccessor() == MaxBlock) {
Chris Lattner3d512132010-12-13 06:25:44 +00003052 SI->removeCase(i);
3053 --i; --e;
3054 }
3055 }
3056 }
3057 } else if (InvokeInst *II = dyn_cast<InvokeInst>(TI)) {
3058 if (II->getUnwindDest() == BB) {
3059 // Convert the invoke to a call instruction. This would be a good
3060 // place to note that the call does not throw though.
Devang Patel1aa89a22011-05-19 00:09:21 +00003061 BranchInst *BI = Builder.CreateBr(II->getNormalDest());
Chris Lattner3d512132010-12-13 06:25:44 +00003062 II->removeFromParent(); // Take out of symbol table
Andrew Trick6b014382012-08-29 21:46:36 +00003063
Chris Lattner3d512132010-12-13 06:25:44 +00003064 // Insert the call now...
3065 SmallVector<Value*, 8> Args(II->op_begin(), II->op_end()-3);
Devang Patel1aa89a22011-05-19 00:09:21 +00003066 Builder.SetInsertPoint(BI);
3067 CallInst *CI = Builder.CreateCall(II->getCalledValue(),
Jay Foada3efbb12011-07-15 08:37:34 +00003068 Args, II->getName());
Chris Lattner3d512132010-12-13 06:25:44 +00003069 CI->setCallingConv(II->getCallingConv());
3070 CI->setAttributes(II->getAttributes());
3071 // If the invoke produced a value, the call does now instead.
3072 II->replaceAllUsesWith(CI);
3073 delete II;
3074 Changed = true;
3075 }
3076 }
3077 }
Andrew Trick6b014382012-08-29 21:46:36 +00003078
Chris Lattner3d512132010-12-13 06:25:44 +00003079 // If this block is now dead, remove it.
3080 if (pred_begin(BB) == pred_end(BB) &&
3081 BB != &BB->getParent()->getEntryBlock()) {
3082 // We know there are no successors, so just nuke the block.
3083 BB->eraseFromParent();
3084 return true;
3085 }
3086
3087 return Changed;
3088}
3089
Benjamin Kramer56442df2011-02-02 15:56:22 +00003090/// TurnSwitchRangeIntoICmp - Turns a switch with that contains only a
3091/// integer range comparison into a sub, an icmp and a branch.
Devang Patel007349d2011-05-18 20:35:38 +00003092static bool TurnSwitchRangeIntoICmp(SwitchInst *SI, IRBuilder<> &Builder) {
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003093 assert(SI->getNumCases() > 1 && "Degenerate switch?");
Benjamin Kramer56442df2011-02-02 15:56:22 +00003094
Benjamin Kramer042b27f2011-02-03 22:51:41 +00003095 // Make sure all cases point to the same destination and gather the values.
3096 SmallVector<ConstantInt *, 16> Cases;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003097 SwitchInst::CaseIt I = SI->case_begin();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003098 Cases.push_back(I.getCaseValue());
3099 SwitchInst::CaseIt PrevI = I++;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003100 for (SwitchInst::CaseIt E = SI->case_end(); I != E; PrevI = I++) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003101 if (PrevI.getCaseSuccessor() != I.getCaseSuccessor())
Benjamin Kramer042b27f2011-02-03 22:51:41 +00003102 return false;
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003103 Cases.push_back(I.getCaseValue());
Benjamin Kramer042b27f2011-02-03 22:51:41 +00003104 }
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003105 assert(Cases.size() == SI->getNumCases() && "Not all cases gathered");
Benjamin Kramer042b27f2011-02-03 22:51:41 +00003106
3107 // Sort the case values, then check if they form a range we can transform.
3108 array_pod_sort(Cases.begin(), Cases.end(), ConstantIntSortPredicate);
3109 for (unsigned I = 1, E = Cases.size(); I != E; ++I) {
3110 if (Cases[I-1]->getValue() != Cases[I]->getValue()+1)
3111 return false;
3112 }
3113
3114 Constant *Offset = ConstantExpr::getNeg(Cases.back());
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003115 Constant *NumCases = ConstantInt::get(Offset->getType(), SI->getNumCases());
Benjamin Kramer56442df2011-02-02 15:56:22 +00003116
Benjamin Kramer33828bc2011-02-07 22:37:28 +00003117 Value *Sub = SI->getCondition();
3118 if (!Offset->isNullValue())
Devang Patel1f5812b2011-05-19 00:13:33 +00003119 Sub = Builder.CreateAdd(Sub, Offset, Sub->getName()+".off");
Hans Wennborga121e242013-04-16 08:35:36 +00003120 Value *Cmp;
3121 // If NumCases overflowed, then all possible values jump to the successor.
3122 if (NumCases->isNullValue() && SI->getNumCases() != 0)
3123 Cmp = ConstantInt::getTrue(SI->getContext());
3124 else
3125 Cmp = Builder.CreateICmpULT(Sub, NumCases, "switch");
Manman Ren222d6192012-09-18 00:47:33 +00003126 BranchInst *NewBI = Builder.CreateCondBr(
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003127 Cmp, SI->case_begin().getCaseSuccessor(), SI->getDefaultDest());
Benjamin Kramer56442df2011-02-02 15:56:22 +00003128
Manman Ren222d6192012-09-18 00:47:33 +00003129 // Update weight for the newly-created conditional branch.
3130 SmallVector<uint64_t, 8> Weights;
3131 bool HasWeights = HasBranchWeights(SI);
3132 if (HasWeights) {
3133 GetBranchWeights(SI, Weights);
3134 if (Weights.size() == 1 + SI->getNumCases()) {
3135 // Combine all weights for the cases to be the true weight of NewBI.
3136 // We assume that the sum of all weights for a Terminator can fit into 32
3137 // bits.
3138 uint32_t NewTrueWeight = 0;
3139 for (unsigned I = 1, E = Weights.size(); I != E; ++I)
3140 NewTrueWeight += (uint32_t)Weights[I];
3141 NewBI->setMetadata(LLVMContext::MD_prof,
3142 MDBuilder(SI->getContext()).
3143 createBranchWeights(NewTrueWeight,
3144 (uint32_t)Weights[0]));
3145 }
3146 }
3147
Benjamin Kramer56442df2011-02-02 15:56:22 +00003148 // Prune obsolete incoming values off the successor's PHI nodes.
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003149 for (BasicBlock::iterator BBI = SI->case_begin().getCaseSuccessor()->begin();
Benjamin Kramer56442df2011-02-02 15:56:22 +00003150 isa<PHINode>(BBI); ++BBI) {
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003151 for (unsigned I = 0, E = SI->getNumCases()-1; I != E; ++I)
Benjamin Kramer56442df2011-02-02 15:56:22 +00003152 cast<PHINode>(BBI)->removeIncomingValue(SI->getParent());
3153 }
3154 SI->eraseFromParent();
3155
3156 return true;
3157}
Chris Lattner3d512132010-12-13 06:25:44 +00003158
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003159/// EliminateDeadSwitchCases - Compute masked bits for the condition of a switch
3160/// and use it to remove dead cases.
3161static bool EliminateDeadSwitchCases(SwitchInst *SI) {
3162 Value *Cond = SI->getCondition();
3163 unsigned Bits = cast<IntegerType>(Cond->getType())->getBitWidth();
3164 APInt KnownZero(Bits, 0), KnownOne(Bits, 0);
Rafael Espindola26c8dcc2012-04-04 12:51:34 +00003165 ComputeMaskedBits(Cond, KnownZero, KnownOne);
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003166
3167 // Gather dead cases.
3168 SmallVector<ConstantInt*, 8> DeadCases;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003169 for (SwitchInst::CaseIt I = SI->case_begin(), E = SI->case_end(); I != E; ++I) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003170 if ((I.getCaseValue()->getValue() & KnownZero) != 0 ||
3171 (I.getCaseValue()->getValue() & KnownOne) != KnownOne) {
3172 DeadCases.push_back(I.getCaseValue());
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003173 DEBUG(dbgs() << "SimplifyCFG: switch case '"
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003174 << I.getCaseValue() << "' is dead.\n");
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003175 }
3176 }
3177
Manman Ren222d6192012-09-18 00:47:33 +00003178 SmallVector<uint64_t, 8> Weights;
3179 bool HasWeight = HasBranchWeights(SI);
3180 if (HasWeight) {
3181 GetBranchWeights(SI, Weights);
3182 HasWeight = (Weights.size() == 1 + SI->getNumCases());
3183 }
3184
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003185 // Remove dead cases from the switch.
3186 for (unsigned I = 0, E = DeadCases.size(); I != E; ++I) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003187 SwitchInst::CaseIt Case = SI->findCaseValue(DeadCases[I]);
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003188 assert(Case != SI->case_default() &&
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003189 "Case was not found. Probably mistake in DeadCases forming.");
Manman Ren222d6192012-09-18 00:47:33 +00003190 if (HasWeight) {
3191 std::swap(Weights[Case.getCaseIndex()+1], Weights.back());
3192 Weights.pop_back();
3193 }
3194
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003195 // Prune unused values from PHI nodes.
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003196 Case.getCaseSuccessor()->removePredecessor(SI->getParent());
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003197 SI->removeCase(Case);
3198 }
Manman Ren222d6192012-09-18 00:47:33 +00003199 if (HasWeight) {
3200 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
3201 SI->setMetadata(LLVMContext::MD_prof,
3202 MDBuilder(SI->getParent()->getContext()).
3203 createBranchWeights(MDWeights));
3204 }
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003205
3206 return !DeadCases.empty();
3207}
3208
Hans Wennborg448da512011-06-18 10:28:47 +00003209/// FindPHIForConditionForwarding - If BB would be eligible for simplification
3210/// by TryToSimplifyUncondBranchFromEmptyBlock (i.e. it is empty and terminated
3211/// by an unconditional branch), look at the phi node for BB in the successor
3212/// block and see if the incoming value is equal to CaseValue. If so, return
3213/// the phi node, and set PhiIndex to BB's index in the phi node.
3214static PHINode *FindPHIForConditionForwarding(ConstantInt *CaseValue,
3215 BasicBlock *BB,
3216 int *PhiIndex) {
3217 if (BB->getFirstNonPHIOrDbg() != BB->getTerminator())
3218 return NULL; // BB must be empty to be a candidate for simplification.
3219 if (!BB->getSinglePredecessor())
3220 return NULL; // BB must be dominated by the switch.
3221
3222 BranchInst *Branch = dyn_cast<BranchInst>(BB->getTerminator());
3223 if (!Branch || !Branch->isUnconditional())
3224 return NULL; // Terminator must be unconditional branch.
3225
3226 BasicBlock *Succ = Branch->getSuccessor(0);
3227
3228 BasicBlock::iterator I = Succ->begin();
3229 while (PHINode *PHI = dyn_cast<PHINode>(I++)) {
3230 int Idx = PHI->getBasicBlockIndex(BB);
3231 assert(Idx >= 0 && "PHI has no entry for predecessor?");
3232
3233 Value *InValue = PHI->getIncomingValue(Idx);
3234 if (InValue != CaseValue) continue;
3235
3236 *PhiIndex = Idx;
3237 return PHI;
3238 }
3239
3240 return NULL;
3241}
3242
3243/// ForwardSwitchConditionToPHI - Try to forward the condition of a switch
3244/// instruction to a phi node dominated by the switch, if that would mean that
3245/// some of the destination blocks of the switch can be folded away.
3246/// Returns true if a change is made.
3247static bool ForwardSwitchConditionToPHI(SwitchInst *SI) {
3248 typedef DenseMap<PHINode*, SmallVector<int,4> > ForwardingNodesMap;
3249 ForwardingNodesMap ForwardingNodes;
3250
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003251 for (SwitchInst::CaseIt I = SI->case_begin(), E = SI->case_end(); I != E; ++I) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003252 ConstantInt *CaseValue = I.getCaseValue();
3253 BasicBlock *CaseDest = I.getCaseSuccessor();
Hans Wennborg448da512011-06-18 10:28:47 +00003254
3255 int PhiIndex;
3256 PHINode *PHI = FindPHIForConditionForwarding(CaseValue, CaseDest,
3257 &PhiIndex);
3258 if (!PHI) continue;
3259
3260 ForwardingNodes[PHI].push_back(PhiIndex);
3261 }
3262
3263 bool Changed = false;
3264
3265 for (ForwardingNodesMap::iterator I = ForwardingNodes.begin(),
3266 E = ForwardingNodes.end(); I != E; ++I) {
3267 PHINode *Phi = I->first;
Craig Toppera0ec3f92013-07-14 04:42:23 +00003268 SmallVectorImpl<int> &Indexes = I->second;
Hans Wennborg448da512011-06-18 10:28:47 +00003269
3270 if (Indexes.size() < 2) continue;
3271
3272 for (size_t I = 0, E = Indexes.size(); I != E; ++I)
3273 Phi->setIncomingValue(Indexes[I], SI->getCondition());
3274 Changed = true;
3275 }
3276
3277 return Changed;
3278}
3279
Hans Wennborg486270a2012-09-06 09:43:28 +00003280/// ValidLookupTableConstant - Return true if the backend will be able to handle
3281/// initializing an array of constants like C.
Hans Wennborgbf015822012-09-07 08:22:57 +00003282static bool ValidLookupTableConstant(Constant *C) {
Hans Wennborg486270a2012-09-06 09:43:28 +00003283 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
3284 return CE->isGEPWithNoNotionalOverIndexing();
3285
3286 return isa<ConstantFP>(C) ||
3287 isa<ConstantInt>(C) ||
3288 isa<ConstantPointerNull>(C) ||
3289 isa<GlobalValue>(C) ||
3290 isa<UndefValue>(C);
3291}
3292
Hans Wennborgef026f12012-10-31 15:14:39 +00003293/// LookupConstant - If V is a Constant, return it. Otherwise, try to look up
Hans Wennborgdaf4cfc2012-10-31 15:31:09 +00003294/// its constant value in ConstantPool, returning 0 if it's not there.
Hans Wennborgef026f12012-10-31 15:14:39 +00003295static Constant *LookupConstant(Value *V,
3296 const SmallDenseMap<Value*, Constant*>& ConstantPool) {
3297 if (Constant *C = dyn_cast<Constant>(V))
3298 return C;
3299 return ConstantPool.lookup(V);
3300}
3301
Hans Wennborge03d9e42012-10-31 13:42:45 +00003302/// ConstantFold - Try to fold instruction I into a constant. This works for
3303/// simple instructions such as binary operations where both operands are
3304/// constant or can be replaced by constants from the ConstantPool. Returns the
Hans Wennborgdaf4cfc2012-10-31 15:31:09 +00003305/// resulting constant on success, 0 otherwise.
Hans Wennborgef026f12012-10-31 15:14:39 +00003306static Constant *ConstantFold(Instruction *I,
Hans Wennborge03d9e42012-10-31 13:42:45 +00003307 const SmallDenseMap<Value*, Constant*>& ConstantPool) {
3308 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(I)) {
Hans Wennborgef026f12012-10-31 15:14:39 +00003309 Constant *A = LookupConstant(BO->getOperand(0), ConstantPool);
3310 if (!A)
3311 return 0;
3312 Constant *B = LookupConstant(BO->getOperand(1), ConstantPool);
3313 if (!B)
3314 return 0;
3315 return ConstantExpr::get(BO->getOpcode(), A, B);
Hans Wennborge03d9e42012-10-31 13:42:45 +00003316 }
3317
3318 if (CmpInst *Cmp = dyn_cast<CmpInst>(I)) {
Hans Wennborgef026f12012-10-31 15:14:39 +00003319 Constant *A = LookupConstant(I->getOperand(0), ConstantPool);
3320 if (!A)
3321 return 0;
3322 Constant *B = LookupConstant(I->getOperand(1), ConstantPool);
3323 if (!B)
3324 return 0;
3325 return ConstantExpr::getCompare(Cmp->getPredicate(), A, B);
Hans Wennborge03d9e42012-10-31 13:42:45 +00003326 }
3327
3328 if (SelectInst *Select = dyn_cast<SelectInst>(I)) {
Hans Wennborgef026f12012-10-31 15:14:39 +00003329 Constant *A = LookupConstant(Select->getCondition(), ConstantPool);
3330 if (!A)
3331 return 0;
3332 if (A->isAllOnesValue())
3333 return LookupConstant(Select->getTrueValue(), ConstantPool);
3334 if (A->isNullValue())
3335 return LookupConstant(Select->getFalseValue(), ConstantPool);
Hans Wennborgdaf4cfc2012-10-31 15:31:09 +00003336 return 0;
Hans Wennborge03d9e42012-10-31 13:42:45 +00003337 }
3338
3339 if (CastInst *Cast = dyn_cast<CastInst>(I)) {
Hans Wennborgef026f12012-10-31 15:14:39 +00003340 Constant *A = LookupConstant(I->getOperand(0), ConstantPool);
3341 if (!A)
3342 return 0;
3343 return ConstantExpr::getCast(Cast->getOpcode(), A, Cast->getDestTy());
Hans Wennborge03d9e42012-10-31 13:42:45 +00003344 }
3345
Hans Wennborgef026f12012-10-31 15:14:39 +00003346 return 0;
Hans Wennborge03d9e42012-10-31 13:42:45 +00003347}
3348
3349/// GetCaseResults - Try to determine the resulting constant values in phi nodes
3350/// at the common destination basic block, *CommonDest, for one of the case
Hans Wennborgdaf4cfc2012-10-31 15:31:09 +00003351/// destionations CaseDest corresponding to value CaseVal (0 for the default
Hans Wennborge03d9e42012-10-31 13:42:45 +00003352/// case), of a switch instruction SI.
Craig Toppera0ec3f92013-07-14 04:42:23 +00003353static bool
3354GetCaseResults(SwitchInst *SI,
3355 ConstantInt *CaseVal,
3356 BasicBlock *CaseDest,
3357 BasicBlock **CommonDest,
3358 SmallVectorImpl<std::pair<PHINode*,Constant*> > &Res) {
Hans Wennborg486270a2012-09-06 09:43:28 +00003359 // The block from which we enter the common destination.
3360 BasicBlock *Pred = SI->getParent();
3361
Hans Wennborge03d9e42012-10-31 13:42:45 +00003362 // If CaseDest is empty except for some side-effect free instructions through
3363 // which we can constant-propagate the CaseVal, continue to its successor.
3364 SmallDenseMap<Value*, Constant*> ConstantPool;
3365 ConstantPool.insert(std::make_pair(SI->getCondition(), CaseVal));
3366 for (BasicBlock::iterator I = CaseDest->begin(), E = CaseDest->end(); I != E;
3367 ++I) {
3368 if (TerminatorInst *T = dyn_cast<TerminatorInst>(I)) {
3369 // If the terminator is a simple branch, continue to the next block.
3370 if (T->getNumSuccessors() != 1)
3371 return false;
3372 Pred = CaseDest;
3373 CaseDest = T->getSuccessor(0);
3374 } else if (isa<DbgInfoIntrinsic>(I)) {
3375 // Skip debug intrinsic.
3376 continue;
3377 } else if (Constant *C = ConstantFold(I, ConstantPool)) {
3378 // Instruction is side-effect free and constant.
3379 ConstantPool.insert(std::make_pair(I, C));
3380 } else {
3381 break;
3382 }
Hans Wennborg486270a2012-09-06 09:43:28 +00003383 }
3384
3385 // If we did not have a CommonDest before, use the current one.
3386 if (!*CommonDest)
3387 *CommonDest = CaseDest;
3388 // If the destination isn't the common one, abort.
3389 if (CaseDest != *CommonDest)
3390 return false;
3391
3392 // Get the values for this case from phi nodes in the destination block.
3393 BasicBlock::iterator I = (*CommonDest)->begin();
3394 while (PHINode *PHI = dyn_cast<PHINode>(I++)) {
3395 int Idx = PHI->getBasicBlockIndex(Pred);
3396 if (Idx == -1)
3397 continue;
3398
Hans Wennborgef026f12012-10-31 15:14:39 +00003399 Constant *ConstVal = LookupConstant(PHI->getIncomingValue(Idx),
3400 ConstantPool);
Hans Wennborge03d9e42012-10-31 13:42:45 +00003401 if (!ConstVal)
Hans Wennborg486270a2012-09-06 09:43:28 +00003402 return false;
3403
Hans Wennborge03d9e42012-10-31 13:42:45 +00003404 // Note: If the constant comes from constant-propagating the case value
3405 // through the CaseDest basic block, it will be safe to remove the
3406 // instructions in that block. They cannot be used (except in the phi nodes
3407 // we visit) outside CaseDest, because that block does not dominate its
3408 // successor. If it did, we would not be in this phi node.
3409
Hans Wennborg486270a2012-09-06 09:43:28 +00003410 // Be conservative about which kinds of constants we support.
3411 if (!ValidLookupTableConstant(ConstVal))
3412 return false;
3413
3414 Res.push_back(std::make_pair(PHI, ConstVal));
3415 }
3416
3417 return true;
3418}
3419
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003420namespace {
3421 /// SwitchLookupTable - This class represents a lookup table that can be used
3422 /// to replace a switch.
3423 class SwitchLookupTable {
3424 public:
3425 /// SwitchLookupTable - Create a lookup table to use as a switch replacement
3426 /// with the contents of Values, using DefaultValue to fill any holes in the
3427 /// table.
3428 SwitchLookupTable(Module &M,
3429 uint64_t TableSize,
3430 ConstantInt *Offset,
Craig Toppera0ec3f92013-07-14 04:42:23 +00003431 const SmallVectorImpl<std::pair<ConstantInt*, Constant*> >& Values,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003432 Constant *DefaultValue,
Micah Villmow3574eca2012-10-08 16:38:25 +00003433 const DataLayout *TD);
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003434
3435 /// BuildLookup - Build instructions with Builder to retrieve the value at
3436 /// the position given by Index in the lookup table.
3437 Value *BuildLookup(Value *Index, IRBuilder<> &Builder);
3438
Hans Wennborgd72271c2012-09-26 09:44:49 +00003439 /// WouldFitInRegister - Return true if a table with TableSize elements of
3440 /// type ElementType would fit in a target-legal register.
Micah Villmow3574eca2012-10-08 16:38:25 +00003441 static bool WouldFitInRegister(const DataLayout *TD,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003442 uint64_t TableSize,
3443 const Type *ElementType);
3444
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003445 private:
3446 // Depending on the contents of the table, it can be represented in
3447 // different ways.
3448 enum {
3449 // For tables where each element contains the same value, we just have to
3450 // store that single value and return it for each lookup.
3451 SingleValueKind,
3452
Hans Wennborgd72271c2012-09-26 09:44:49 +00003453 // For small tables with integer elements, we can pack them into a bitmap
3454 // that fits into a target-legal register. Values are retrieved by
3455 // shift and mask operations.
3456 BitMapKind,
3457
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003458 // The table is stored as an array of values. Values are retrieved by load
3459 // instructions from the table.
3460 ArrayKind
3461 } Kind;
3462
3463 // For SingleValueKind, this is the single value.
3464 Constant *SingleValue;
3465
Hans Wennborgd72271c2012-09-26 09:44:49 +00003466 // For BitMapKind, this is the bitmap.
3467 ConstantInt *BitMap;
3468 IntegerType *BitMapElementTy;
3469
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003470 // For ArrayKind, this is the array.
3471 GlobalVariable *Array;
3472 };
3473}
3474
3475SwitchLookupTable::SwitchLookupTable(Module &M,
3476 uint64_t TableSize,
3477 ConstantInt *Offset,
Craig Toppera0ec3f92013-07-14 04:42:23 +00003478 const SmallVectorImpl<std::pair<ConstantInt*, Constant*> >& Values,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003479 Constant *DefaultValue,
Duncan Sands70465612013-01-23 09:09:50 +00003480 const DataLayout *TD)
3481 : SingleValue(0), BitMap(0), BitMapElementTy(0), Array(0) {
Hans Wennborg565df792012-09-26 11:07:37 +00003482 assert(Values.size() && "Can't build lookup table without values!");
3483 assert(TableSize >= Values.size() && "Can't fit values in table!");
Hans Wennborg486270a2012-09-06 09:43:28 +00003484
3485 // If all values in the table are equal, this is that value.
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003486 SingleValue = Values.begin()->second;
Hans Wennborg486270a2012-09-06 09:43:28 +00003487
3488 // Build up the table contents.
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003489 SmallVector<Constant*, 64> TableContents(TableSize);
3490 for (size_t I = 0, E = Values.size(); I != E; ++I) {
3491 ConstantInt *CaseVal = Values[I].first;
3492 Constant *CaseRes = Values[I].second;
3493 assert(CaseRes->getType() == DefaultValue->getType());
Hans Wennborg486270a2012-09-06 09:43:28 +00003494
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003495 uint64_t Idx = (CaseVal->getValue() - Offset->getValue())
3496 .getLimitedValue();
Hans Wennborg486270a2012-09-06 09:43:28 +00003497 TableContents[Idx] = CaseRes;
3498
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003499 if (CaseRes != SingleValue)
Hans Wennborgef026f12012-10-31 15:14:39 +00003500 SingleValue = 0;
Hans Wennborg486270a2012-09-06 09:43:28 +00003501 }
3502
3503 // Fill in any holes in the table with the default result.
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003504 if (Values.size() < TableSize) {
3505 for (uint64_t I = 0; I < TableSize; ++I) {
3506 if (!TableContents[I])
3507 TableContents[I] = DefaultValue;
Hans Wennborg486270a2012-09-06 09:43:28 +00003508 }
3509
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003510 if (DefaultValue != SingleValue)
Hans Wennborgef026f12012-10-31 15:14:39 +00003511 SingleValue = 0;
Hans Wennborg486270a2012-09-06 09:43:28 +00003512 }
3513
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003514 // If each element in the table contains the same value, we only need to store
3515 // that single value.
3516 if (SingleValue) {
3517 Kind = SingleValueKind;
3518 return;
Hans Wennborg486270a2012-09-06 09:43:28 +00003519 }
3520
Hans Wennborgd72271c2012-09-26 09:44:49 +00003521 // If the type is integer and the table fits in a register, build a bitmap.
3522 if (WouldFitInRegister(TD, TableSize, DefaultValue->getType())) {
3523 IntegerType *IT = cast<IntegerType>(DefaultValue->getType());
3524 APInt TableInt(TableSize * IT->getBitWidth(), 0);
3525 for (uint64_t I = TableSize; I > 0; --I) {
3526 TableInt <<= IT->getBitWidth();
Benjamin Kramer64f27e72012-10-01 11:31:48 +00003527 // Insert values into the bitmap. Undef values are set to zero.
3528 if (!isa<UndefValue>(TableContents[I - 1])) {
3529 ConstantInt *Val = cast<ConstantInt>(TableContents[I - 1]);
3530 TableInt |= Val->getValue().zext(TableInt.getBitWidth());
3531 }
Hans Wennborgd72271c2012-09-26 09:44:49 +00003532 }
3533 BitMap = ConstantInt::get(M.getContext(), TableInt);
3534 BitMapElementTy = IT;
3535 Kind = BitMapKind;
3536 ++NumBitMaps;
3537 return;
3538 }
3539
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003540 // Store the table in an array.
3541 ArrayType *ArrayTy = ArrayType::get(DefaultValue->getType(), TableSize);
Hans Wennborg486270a2012-09-06 09:43:28 +00003542 Constant *Initializer = ConstantArray::get(ArrayTy, TableContents);
3543
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003544 Array = new GlobalVariable(M, ArrayTy, /*constant=*/ true,
3545 GlobalVariable::PrivateLinkage,
3546 Initializer,
3547 "switch.table");
3548 Array->setUnnamedAddr(true);
3549 Kind = ArrayKind;
3550}
3551
3552Value *SwitchLookupTable::BuildLookup(Value *Index, IRBuilder<> &Builder) {
3553 switch (Kind) {
3554 case SingleValueKind:
3555 return SingleValue;
Hans Wennborgd72271c2012-09-26 09:44:49 +00003556 case BitMapKind: {
3557 // Type of the bitmap (e.g. i59).
3558 IntegerType *MapTy = BitMap->getType();
3559
3560 // Cast Index to the same type as the bitmap.
3561 // Note: The Index is <= the number of elements in the table, so
3562 // truncating it to the width of the bitmask is safe.
Hans Wennborg50b7d702012-09-26 14:01:53 +00003563 Value *ShiftAmt = Builder.CreateZExtOrTrunc(Index, MapTy, "switch.cast");
Hans Wennborgd72271c2012-09-26 09:44:49 +00003564
3565 // Multiply the shift amount by the element width.
3566 ShiftAmt = Builder.CreateMul(ShiftAmt,
3567 ConstantInt::get(MapTy, BitMapElementTy->getBitWidth()),
3568 "switch.shiftamt");
3569
3570 // Shift down.
3571 Value *DownShifted = Builder.CreateLShr(BitMap, ShiftAmt,
3572 "switch.downshift");
3573 // Mask off.
3574 return Builder.CreateTrunc(DownShifted, BitMapElementTy,
3575 "switch.masked");
3576 }
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003577 case ArrayKind: {
3578 Value *GEPIndices[] = { Builder.getInt32(0), Index };
3579 Value *GEP = Builder.CreateInBoundsGEP(Array, GEPIndices,
3580 "switch.gep");
3581 return Builder.CreateLoad(GEP, "switch.load");
3582 }
3583 }
3584 llvm_unreachable("Unknown lookup table kind!");
3585}
3586
Micah Villmow3574eca2012-10-08 16:38:25 +00003587bool SwitchLookupTable::WouldFitInRegister(const DataLayout *TD,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003588 uint64_t TableSize,
3589 const Type *ElementType) {
3590 if (!TD)
3591 return false;
3592 const IntegerType *IT = dyn_cast<IntegerType>(ElementType);
3593 if (!IT)
3594 return false;
3595 // FIXME: If the type is wider than it needs to be, e.g. i8 but all values
3596 // are <= 15, we could try to narrow the type.
Benjamin Kramer465251a2012-09-27 18:29:58 +00003597
3598 // Avoid overflow, fitsInLegalInteger uses unsigned int for the width.
3599 if (TableSize >= UINT_MAX/IT->getBitWidth())
3600 return false;
Hans Wennborgd72271c2012-09-26 09:44:49 +00003601 return TD->fitsInLegalInteger(TableSize * IT->getBitWidth());
3602}
3603
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003604/// ShouldBuildLookupTable - Determine whether a lookup table should be built
Hans Wennborgdeb2e9c2013-06-04 11:22:30 +00003605/// for this switch, based on the number of cases, size of the table and the
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003606/// types of the results.
3607static bool ShouldBuildLookupTable(SwitchInst *SI,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003608 uint64_t TableSize,
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003609 const TargetTransformInfo &TTI,
Micah Villmow3574eca2012-10-08 16:38:25 +00003610 const DataLayout *TD,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003611 const SmallDenseMap<PHINode*, Type*>& ResultTypes) {
Hans Wennborg565df792012-09-26 11:07:37 +00003612 if (SI->getNumCases() > TableSize || TableSize >= UINT64_MAX / 10)
3613 return false; // TableSize overflowed, or mul below might overflow.
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003614
Chandler Carruth06ec7212012-11-30 09:26:25 +00003615 bool AllTablesFitInRegister = true;
Evan Cheng40eef5f2012-11-30 02:02:42 +00003616 bool HasIllegalType = false;
Hans Wennborgd72271c2012-09-26 09:44:49 +00003617 for (SmallDenseMap<PHINode*, Type*>::const_iterator I = ResultTypes.begin(),
3618 E = ResultTypes.end(); I != E; ++I) {
Evan Cheng40eef5f2012-11-30 02:02:42 +00003619 Type *Ty = I->second;
Chandler Carruth66ea2f92012-11-30 09:34:29 +00003620
3621 // Saturate this flag to true.
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003622 HasIllegalType = HasIllegalType || !TTI.isTypeLegal(Ty);
Chandler Carruth66ea2f92012-11-30 09:34:29 +00003623
3624 // Saturate this flag to false.
3625 AllTablesFitInRegister = AllTablesFitInRegister &&
3626 SwitchLookupTable::WouldFitInRegister(TD, TableSize, Ty);
3627
3628 // If both flags saturate, we're done. NOTE: This *only* works with
3629 // saturating flags, and all flags have to saturate first due to the
3630 // non-deterministic behavior of iterating over a dense map.
3631 if (HasIllegalType && !AllTablesFitInRegister)
Evan Cheng40eef5f2012-11-30 02:02:42 +00003632 break;
Hans Wennborgd72271c2012-09-26 09:44:49 +00003633 }
Evan Cheng40eef5f2012-11-30 02:02:42 +00003634
Chandler Carruth06ec7212012-11-30 09:26:25 +00003635 // If each table would fit in a register, we should build it anyway.
3636 if (AllTablesFitInRegister)
3637 return true;
3638
3639 // Don't build a table that doesn't fit in-register if it has illegal types.
3640 if (HasIllegalType)
3641 return false;
3642
3643 // The table density should be at least 40%. This is the same criterion as for
3644 // jump tables, see SelectionDAGBuilder::handleJTSwitchCase.
3645 // FIXME: Find the best cut-off.
3646 return SI->getNumCases() * 10 >= TableSize * 4;
Hans Wennborg486270a2012-09-06 09:43:28 +00003647}
3648
3649/// SwitchToLookupTable - If the switch is only used to initialize one or more
3650/// phi nodes in a common successor block with different constant values,
3651/// replace the switch with lookup tables.
3652static bool SwitchToLookupTable(SwitchInst *SI,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003653 IRBuilder<> &Builder,
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003654 const TargetTransformInfo &TTI,
3655 const DataLayout* TD) {
Hans Wennborg486270a2012-09-06 09:43:28 +00003656 assert(SI->getNumCases() > 1 && "Degenerate switch?");
Hans Wennborg04d7d132012-10-30 11:23:25 +00003657
Hans Wennborgb0319962012-11-07 21:35:12 +00003658 // Only build lookup table when we have a target that supports it.
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003659 if (!TTI.shouldBuildLookupTables())
Hans Wennborg04d7d132012-10-30 11:23:25 +00003660 return false;
3661
Hans Wennborg486270a2012-09-06 09:43:28 +00003662 // FIXME: If the switch is too sparse for a lookup table, perhaps we could
3663 // split off a dense part and build a lookup table for that.
3664
Hans Wennborg486270a2012-09-06 09:43:28 +00003665 // FIXME: This creates arrays of GEPs to constant strings, which means each
3666 // GEP needs a runtime relocation in PIC code. We should just build one big
3667 // string and lookup indices into that.
3668
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003669 // Ignore the switch if the number of cases is too small.
Hans Wennborg486270a2012-09-06 09:43:28 +00003670 // This is similar to the check when building jump tables in
3671 // SelectionDAGBuilder::handleJTSwitchCase.
3672 // FIXME: Determine the best cut-off.
3673 if (SI->getNumCases() < 4)
3674 return false;
3675
3676 // Figure out the corresponding result for each case value and phi node in the
3677 // common destination, as well as the the min and max case values.
3678 assert(SI->case_begin() != SI->case_end());
3679 SwitchInst::CaseIt CI = SI->case_begin();
3680 ConstantInt *MinCaseVal = CI.getCaseValue();
3681 ConstantInt *MaxCaseVal = CI.getCaseValue();
3682
Hans Wennborgef026f12012-10-31 15:14:39 +00003683 BasicBlock *CommonDest = 0;
Hans Wennborg2f9fc762012-09-10 07:44:22 +00003684 typedef SmallVector<std::pair<ConstantInt*, Constant*>, 4> ResultListTy;
Hans Wennborg486270a2012-09-06 09:43:28 +00003685 SmallDenseMap<PHINode*, ResultListTy> ResultLists;
3686 SmallDenseMap<PHINode*, Constant*> DefaultResults;
3687 SmallDenseMap<PHINode*, Type*> ResultTypes;
3688 SmallVector<PHINode*, 4> PHIs;
3689
3690 for (SwitchInst::CaseIt E = SI->case_end(); CI != E; ++CI) {
3691 ConstantInt *CaseVal = CI.getCaseValue();
3692 if (CaseVal->getValue().slt(MinCaseVal->getValue()))
3693 MinCaseVal = CaseVal;
3694 if (CaseVal->getValue().sgt(MaxCaseVal->getValue()))
3695 MaxCaseVal = CaseVal;
3696
3697 // Resulting value at phi nodes for this case value.
3698 typedef SmallVector<std::pair<PHINode*, Constant*>, 4> ResultsTy;
3699 ResultsTy Results;
Hans Wennborge03d9e42012-10-31 13:42:45 +00003700 if (!GetCaseResults(SI, CaseVal, CI.getCaseSuccessor(), &CommonDest,
3701 Results))
Hans Wennborg486270a2012-09-06 09:43:28 +00003702 return false;
3703
3704 // Append the result from this case to the list for each phi.
3705 for (ResultsTy::iterator I = Results.begin(), E = Results.end(); I!=E; ++I) {
3706 if (!ResultLists.count(I->first))
3707 PHIs.push_back(I->first);
3708 ResultLists[I->first].push_back(std::make_pair(CaseVal, I->second));
3709 }
3710 }
3711
3712 // Get the resulting values for the default case.
Hans Wennborg2f9fc762012-09-10 07:44:22 +00003713 SmallVector<std::pair<PHINode*, Constant*>, 4> DefaultResultsList;
Hans Wennborgef026f12012-10-31 15:14:39 +00003714 if (!GetCaseResults(SI, 0, SI->getDefaultDest(), &CommonDest,
Hans Wennborge03d9e42012-10-31 13:42:45 +00003715 DefaultResultsList))
Hans Wennborg2f9fc762012-09-10 07:44:22 +00003716 return false;
3717 for (size_t I = 0, E = DefaultResultsList.size(); I != E; ++I) {
3718 PHINode *PHI = DefaultResultsList[I].first;
3719 Constant *Result = DefaultResultsList[I].second;
3720 DefaultResults[PHI] = Result;
3721 ResultTypes[PHI] = Result->getType();
Hans Wennborg486270a2012-09-06 09:43:28 +00003722 }
3723
3724 APInt RangeSpread = MaxCaseVal->getValue() - MinCaseVal->getValue();
Hans Wennborg486270a2012-09-06 09:43:28 +00003725 uint64_t TableSize = RangeSpread.getLimitedValue() + 1;
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003726 if (!ShouldBuildLookupTable(SI, TableSize, TTI, TD, ResultTypes))
Hans Wennborg486270a2012-09-06 09:43:28 +00003727 return false;
3728
Hans Wennborg486270a2012-09-06 09:43:28 +00003729 // Create the BB that does the lookups.
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003730 Module &Mod = *CommonDest->getParent()->getParent();
Hans Wennborg486270a2012-09-06 09:43:28 +00003731 BasicBlock *LookupBB = BasicBlock::Create(Mod.getContext(),
3732 "switch.lookup",
3733 CommonDest->getParent(),
3734 CommonDest);
3735
3736 // Check whether the condition value is within the case range, and branch to
3737 // the new BB.
3738 Builder.SetInsertPoint(SI);
3739 Value *TableIndex = Builder.CreateSub(SI->getCondition(), MinCaseVal,
3740 "switch.tableidx");
3741 Value *Cmp = Builder.CreateICmpULT(TableIndex, ConstantInt::get(
3742 MinCaseVal->getType(), TableSize));
3743 Builder.CreateCondBr(Cmp, LookupBB, SI->getDefaultDest());
3744
3745 // Populate the BB that does the lookups.
3746 Builder.SetInsertPoint(LookupBB);
3747 bool ReturnedEarly = false;
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003748 for (size_t I = 0, E = PHIs.size(); I != E; ++I) {
3749 PHINode *PHI = PHIs[I];
Hans Wennborg486270a2012-09-06 09:43:28 +00003750
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003751 SwitchLookupTable Table(Mod, TableSize, MinCaseVal, ResultLists[PHI],
Hans Wennborgd72271c2012-09-26 09:44:49 +00003752 DefaultResults[PHI], TD);
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003753
3754 Value *Result = Table.BuildLookup(TableIndex, Builder);
Hans Wennborg486270a2012-09-06 09:43:28 +00003755
Hans Wennborg57933e32012-09-19 14:24:21 +00003756 // If the result is used to return immediately from the function, we want to
3757 // do that right here.
3758 if (PHI->hasOneUse() && isa<ReturnInst>(*PHI->use_begin()) &&
3759 *PHI->use_begin() == CommonDest->getFirstNonPHIOrDbg()) {
3760 Builder.CreateRet(Result);
3761 ReturnedEarly = true;
3762 break;
Hans Wennborg486270a2012-09-06 09:43:28 +00003763 }
3764
Hans Wennborg57933e32012-09-19 14:24:21 +00003765 PHI->addIncoming(Result, LookupBB);
Hans Wennborg486270a2012-09-06 09:43:28 +00003766 }
3767
3768 if (!ReturnedEarly)
3769 Builder.CreateBr(CommonDest);
3770
3771 // Remove the switch.
3772 for (unsigned i = 0; i < SI->getNumSuccessors(); ++i) {
3773 BasicBlock *Succ = SI->getSuccessor(i);
3774 if (Succ == SI->getDefaultDest()) continue;
3775 Succ->removePredecessor(SI->getParent());
3776 }
3777 SI->eraseFromParent();
3778
3779 ++NumLookupTables;
3780 return true;
3781}
3782
Devang Patel007349d2011-05-18 20:35:38 +00003783bool SimplifyCFGOpt::SimplifySwitch(SwitchInst *SI, IRBuilder<> &Builder) {
Chris Lattner3d512132010-12-13 06:25:44 +00003784 BasicBlock *BB = SI->getParent();
3785
Jakob Stoklund Olesene5a7a682012-10-25 18:51:15 +00003786 if (isValueEqualityComparison(SI)) {
3787 // If we only have one predecessor, and if it is a branch on this value,
3788 // see if that predecessor totally determines the outcome of this switch.
3789 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
3790 if (SimplifyEqualityComparisonWithOnlyPredecessor(SI, OnlyPred, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003791 return SimplifyCFG(BB, TTI, TD) | true;
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00003792
Jakob Stoklund Olesene5a7a682012-10-25 18:51:15 +00003793 Value *Cond = SI->getCondition();
3794 if (SelectInst *Select = dyn_cast<SelectInst>(Cond))
3795 if (SimplifySwitchOnSelect(SI, Select))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003796 return SimplifyCFG(BB, TTI, TD) | true;
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00003797
Jakob Stoklund Olesene5a7a682012-10-25 18:51:15 +00003798 // If the block only contains the switch, see if we can fold the block
3799 // away into any preds.
3800 BasicBlock::iterator BBI = BB->begin();
3801 // Ignore dbg intrinsics.
3802 while (isa<DbgInfoIntrinsic>(BBI))
3803 ++BBI;
3804 if (SI == &*BBI)
3805 if (FoldValueComparisonIntoPredecessors(SI, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003806 return SimplifyCFG(BB, TTI, TD) | true;
Jakob Stoklund Olesene5a7a682012-10-25 18:51:15 +00003807 }
Benjamin Kramer56442df2011-02-02 15:56:22 +00003808
3809 // Try to transform the switch into an icmp and a branch.
Devang Patel007349d2011-05-18 20:35:38 +00003810 if (TurnSwitchRangeIntoICmp(SI, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003811 return SimplifyCFG(BB, TTI, TD) | true;
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003812
3813 // Remove unreachable cases.
3814 if (EliminateDeadSwitchCases(SI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003815 return SimplifyCFG(BB, TTI, TD) | true;
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003816
Hans Wennborg448da512011-06-18 10:28:47 +00003817 if (ForwardSwitchConditionToPHI(SI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003818 return SimplifyCFG(BB, TTI, TD) | true;
Hans Wennborg448da512011-06-18 10:28:47 +00003819
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003820 if (SwitchToLookupTable(SI, Builder, TTI, TD))
3821 return SimplifyCFG(BB, TTI, TD) | true;
Hans Wennborg486270a2012-09-06 09:43:28 +00003822
Chris Lattner3d512132010-12-13 06:25:44 +00003823 return false;
3824}
3825
3826bool SimplifyCFGOpt::SimplifyIndirectBr(IndirectBrInst *IBI) {
3827 BasicBlock *BB = IBI->getParent();
3828 bool Changed = false;
Andrew Trick6b014382012-08-29 21:46:36 +00003829
Chris Lattner3d512132010-12-13 06:25:44 +00003830 // Eliminate redundant destinations.
3831 SmallPtrSet<Value *, 8> Succs;
3832 for (unsigned i = 0, e = IBI->getNumDestinations(); i != e; ++i) {
3833 BasicBlock *Dest = IBI->getDestination(i);
3834 if (!Dest->hasAddressTaken() || !Succs.insert(Dest)) {
3835 Dest->removePredecessor(BB);
3836 IBI->removeDestination(i);
3837 --i; --e;
3838 Changed = true;
3839 }
Andrew Trick6b014382012-08-29 21:46:36 +00003840 }
Chris Lattner3d512132010-12-13 06:25:44 +00003841
3842 if (IBI->getNumDestinations() == 0) {
3843 // If the indirectbr has no successors, change it to unreachable.
3844 new UnreachableInst(IBI->getContext(), IBI);
3845 EraseTerminatorInstAndDCECond(IBI);
3846 return true;
3847 }
Andrew Trick6b014382012-08-29 21:46:36 +00003848
Chris Lattner3d512132010-12-13 06:25:44 +00003849 if (IBI->getNumDestinations() == 1) {
3850 // If the indirectbr has one successor, change it to a direct branch.
3851 BranchInst::Create(IBI->getDestination(0), IBI);
3852 EraseTerminatorInstAndDCECond(IBI);
3853 return true;
3854 }
Andrew Trick6b014382012-08-29 21:46:36 +00003855
Chris Lattner3d512132010-12-13 06:25:44 +00003856 if (SelectInst *SI = dyn_cast<SelectInst>(IBI->getAddress())) {
3857 if (SimplifyIndirectBrOnSelect(IBI, SI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003858 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003859 }
3860 return Changed;
3861}
3862
Devang Patela23812c2011-05-18 18:28:48 +00003863bool SimplifyCFGOpt::SimplifyUncondBranch(BranchInst *BI, IRBuilder<> &Builder){
Chris Lattner3d512132010-12-13 06:25:44 +00003864 BasicBlock *BB = BI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00003865
Manman Ren554da1a2012-09-20 22:37:36 +00003866 if (SinkCommon && SinkThenElseCodeToEnd(BI))
3867 return true;
3868
Chris Lattner3d512132010-12-13 06:25:44 +00003869 // If the Terminator is the only non-phi instruction, simplify the block.
Rafael Espindola77a2c372011-06-30 20:14:24 +00003870 BasicBlock::iterator I = BB->getFirstNonPHIOrDbgOrLifetime();
Chris Lattner3d512132010-12-13 06:25:44 +00003871 if (I->isTerminator() && BB != &BB->getParent()->getEntryBlock() &&
3872 TryToSimplifyUncondBranchFromEmptyBlock(BB))
3873 return true;
Andrew Trick6b014382012-08-29 21:46:36 +00003874
Chris Lattner3d512132010-12-13 06:25:44 +00003875 // If the only instruction in the block is a seteq/setne comparison
3876 // against a constant, try to simplify the block.
3877 if (ICmpInst *ICI = dyn_cast<ICmpInst>(I))
3878 if (ICI->isEquality() && isa<ConstantInt>(ICI->getOperand(1))) {
3879 for (++I; isa<DbgInfoIntrinsic>(I); ++I)
3880 ;
Nick Lewycky9d523102011-12-26 20:37:40 +00003881 if (I->isTerminator() &&
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003882 TryToSimplifyUncondBranchWithICmpInIt(ICI, Builder, TTI, TD))
Chris Lattner3d512132010-12-13 06:25:44 +00003883 return true;
3884 }
Andrew Trick6b014382012-08-29 21:46:36 +00003885
Manman Renee28e0f2012-06-13 05:43:29 +00003886 // If this basic block is ONLY a compare and a branch, and if a predecessor
3887 // branches to us and our successor, fold the comparison into the
3888 // predecessor and use logical operations to update the incoming value
3889 // for PHI nodes in common successor.
3890 if (FoldBranchToCommonDest(BI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003891 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003892 return false;
3893}
3894
3895
Devang Patel007349d2011-05-18 20:35:38 +00003896bool SimplifyCFGOpt::SimplifyCondBranch(BranchInst *BI, IRBuilder<> &Builder) {
Chris Lattner3d512132010-12-13 06:25:44 +00003897 BasicBlock *BB = BI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00003898
Chris Lattner3d512132010-12-13 06:25:44 +00003899 // Conditional branch
3900 if (isValueEqualityComparison(BI)) {
3901 // If we only have one predecessor, and if it is a branch on this value,
3902 // see if that predecessor totally determines the outcome of this
3903 // switch.
3904 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
Devang Patel007349d2011-05-18 20:35:38 +00003905 if (SimplifyEqualityComparisonWithOnlyPredecessor(BI, OnlyPred, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003906 return SimplifyCFG(BB, TTI, TD) | true;
Andrew Trick6b014382012-08-29 21:46:36 +00003907
Chris Lattner3d512132010-12-13 06:25:44 +00003908 // This block must be empty, except for the setcond inst, if it exists.
3909 // Ignore dbg intrinsics.
3910 BasicBlock::iterator I = BB->begin();
3911 // Ignore dbg intrinsics.
3912 while (isa<DbgInfoIntrinsic>(I))
3913 ++I;
3914 if (&*I == BI) {
Devang Patelb55d9242011-05-18 20:53:17 +00003915 if (FoldValueComparisonIntoPredecessors(BI, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003916 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003917 } else if (&*I == cast<Instruction>(BI->getCondition())){
3918 ++I;
3919 // Ignore dbg intrinsics.
3920 while (isa<DbgInfoIntrinsic>(I))
3921 ++I;
Devang Patelb55d9242011-05-18 20:53:17 +00003922 if (&*I == BI && FoldValueComparisonIntoPredecessors(BI, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003923 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003924 }
3925 }
Andrew Trick6b014382012-08-29 21:46:36 +00003926
Chris Lattner3d512132010-12-13 06:25:44 +00003927 // Try to turn "br (X == 0 | X == 1), T, F" into a switch instruction.
Devang Patel02dd5412011-05-18 23:18:47 +00003928 if (SimplifyBranchOnICmpChain(BI, TD, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00003929 return true;
Andrew Trick6b014382012-08-29 21:46:36 +00003930
Dan Gohman3b205172012-01-05 23:58:56 +00003931 // If this basic block is ONLY a compare and a branch, and if a predecessor
3932 // branches to us and one of our successors, fold the comparison into the
3933 // predecessor and use logical operations to pick the right destination.
3934 if (FoldBranchToCommonDest(BI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003935 return SimplifyCFG(BB, TTI, TD) | true;
Andrew Trick6b014382012-08-29 21:46:36 +00003936
Chris Lattner3d512132010-12-13 06:25:44 +00003937 // We have a conditional branch to two blocks that are only reachable
3938 // from BI. We know that the condbr dominates the two blocks, so see if
3939 // there is any identical code in the "then" and "else" blocks. If so, we
3940 // can hoist it up to the branching block.
3941 if (BI->getSuccessor(0)->getSinglePredecessor() != 0) {
3942 if (BI->getSuccessor(1)->getSinglePredecessor() != 0) {
Rafael Espindola216dde92011-05-19 02:26:30 +00003943 if (HoistThenElseCodeToIf(BI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003944 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003945 } else {
3946 // If Successor #1 has multiple preds, we may be able to conditionally
3947 // execute Successor #0 if it branches to successor #1.
3948 TerminatorInst *Succ0TI = BI->getSuccessor(0)->getTerminator();
3949 if (Succ0TI->getNumSuccessors() == 1 &&
3950 Succ0TI->getSuccessor(0) == BI->getSuccessor(1))
Chandler Carruth455151e2013-01-27 06:42:03 +00003951 if (SpeculativelyExecuteBB(BI, BI->getSuccessor(0)))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003952 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003953 }
3954 } else if (BI->getSuccessor(1)->getSinglePredecessor() != 0) {
3955 // If Successor #0 has multiple preds, we may be able to conditionally
3956 // execute Successor #1 if it branches to successor #0.
3957 TerminatorInst *Succ1TI = BI->getSuccessor(1)->getTerminator();
3958 if (Succ1TI->getNumSuccessors() == 1 &&
3959 Succ1TI->getSuccessor(0) == BI->getSuccessor(0))
Chandler Carruth455151e2013-01-27 06:42:03 +00003960 if (SpeculativelyExecuteBB(BI, BI->getSuccessor(1)))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003961 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003962 }
Andrew Trick6b014382012-08-29 21:46:36 +00003963
Chris Lattner3d512132010-12-13 06:25:44 +00003964 // If this is a branch on a phi node in the current block, thread control
3965 // through this block if any PHI node entries are constants.
3966 if (PHINode *PN = dyn_cast<PHINode>(BI->getCondition()))
3967 if (PN->getParent() == BI->getParent())
Chris Lattner302ba6f2010-12-14 06:17:25 +00003968 if (FoldCondBranchOnPHI(BI, TD))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003969 return SimplifyCFG(BB, TTI, TD) | true;
Andrew Trick6b014382012-08-29 21:46:36 +00003970
Chris Lattner3d512132010-12-13 06:25:44 +00003971 // Scan predecessor blocks for conditional branches.
3972 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
3973 if (BranchInst *PBI = dyn_cast<BranchInst>((*PI)->getTerminator()))
3974 if (PBI != BI && PBI->isConditional())
3975 if (SimplifyCondBranchToCondBranch(PBI, BI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003976 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003977
3978 return false;
3979}
3980
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003981/// Check if passing a value to an instruction will cause undefined behavior.
3982static bool passingValueIsAlwaysUndefined(Value *V, Instruction *I) {
3983 Constant *C = dyn_cast<Constant>(V);
3984 if (!C)
3985 return false;
3986
Benjamin Kramer1e21db62012-10-04 16:11:49 +00003987 if (I->use_empty())
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003988 return false;
3989
3990 if (C->isNullValue()) {
Benjamin Kramer1e21db62012-10-04 16:11:49 +00003991 // Only look at the first use, avoid hurting compile time with long uselists
3992 User *Use = *I->use_begin();
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003993
3994 // Now make sure that there are no instructions in between that can alter
3995 // control flow (eg. calls)
3996 for (BasicBlock::iterator i = ++BasicBlock::iterator(I); &*i != Use; ++i)
Benjamin Kramer9bb54882011-08-26 02:25:55 +00003997 if (i == I->getParent()->end() || i->mayHaveSideEffects())
Benjamin Kramer98d6d232011-08-26 01:22:29 +00003998 return false;
3999
4000 // Look through GEPs. A load from a GEP derived from NULL is still undefined
4001 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Use))
4002 if (GEP->getPointerOperand() == I)
4003 return passingValueIsAlwaysUndefined(V, GEP);
4004
4005 // Look through bitcasts.
4006 if (BitCastInst *BC = dyn_cast<BitCastInst>(Use))
4007 return passingValueIsAlwaysUndefined(V, BC);
4008
Benjamin Kramer9bb54882011-08-26 02:25:55 +00004009 // Load from null is undefined.
4010 if (LoadInst *LI = dyn_cast<LoadInst>(Use))
Andrew Trick119003f2013-03-07 01:03:35 +00004011 if (!LI->isVolatile())
4012 return LI->getPointerAddressSpace() == 0;
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004013
Benjamin Kramer9bb54882011-08-26 02:25:55 +00004014 // Store to null is undefined.
4015 if (StoreInst *SI = dyn_cast<StoreInst>(Use))
Andrew Trick119003f2013-03-07 01:03:35 +00004016 if (!SI->isVolatile())
4017 return SI->getPointerAddressSpace() == 0 && SI->getPointerOperand() == I;
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004018 }
4019 return false;
4020}
4021
4022/// If BB has an incoming value that will always trigger undefined behavior
Nick Lewycky9d523102011-12-26 20:37:40 +00004023/// (eg. null pointer dereference), remove the branch leading here.
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004024static bool removeUndefIntroducingPredecessor(BasicBlock *BB) {
4025 for (BasicBlock::iterator i = BB->begin();
4026 PHINode *PHI = dyn_cast<PHINode>(i); ++i)
4027 for (unsigned i = 0, e = PHI->getNumIncomingValues(); i != e; ++i)
4028 if (passingValueIsAlwaysUndefined(PHI->getIncomingValue(i), PHI)) {
4029 TerminatorInst *T = PHI->getIncomingBlock(i)->getTerminator();
4030 IRBuilder<> Builder(T);
4031 if (BranchInst *BI = dyn_cast<BranchInst>(T)) {
4032 BB->removePredecessor(PHI->getIncomingBlock(i));
4033 // Turn uncoditional branches into unreachables and remove the dead
4034 // destination from conditional branches.
4035 if (BI->isUnconditional())
4036 Builder.CreateUnreachable();
4037 else
4038 Builder.CreateBr(BI->getSuccessor(0) == BB ? BI->getSuccessor(1) :
4039 BI->getSuccessor(0));
4040 BI->eraseFromParent();
4041 return true;
4042 }
4043 // TODO: SwitchInst.
4044 }
4045
4046 return false;
4047}
4048
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +00004049bool SimplifyCFGOpt::run(BasicBlock *BB) {
Chris Lattnerdc3602b2003-08-24 18:36:16 +00004050 bool Changed = false;
Chris Lattner01d1ee32002-05-21 20:50:24 +00004051
Chris Lattner302ba6f2010-12-14 06:17:25 +00004052 assert(BB && BB->getParent() && "Block not embedded in function!");
Chris Lattner01d1ee32002-05-21 20:50:24 +00004053 assert(BB->getTerminator() && "Degenerate basic block encountered!");
Chris Lattner01d1ee32002-05-21 20:50:24 +00004054
Dan Gohmane2c6d132010-08-14 00:29:42 +00004055 // Remove basic blocks that have no predecessors (except the entry block)...
4056 // or that just have themself as a predecessor. These are unreachable.
Chris Lattner302ba6f2010-12-14 06:17:25 +00004057 if ((pred_begin(BB) == pred_end(BB) &&
4058 BB != &BB->getParent()->getEntryBlock()) ||
Dan Gohmane2c6d132010-08-14 00:29:42 +00004059 BB->getSinglePredecessor() == BB) {
David Greene89d6fd32010-01-05 01:26:52 +00004060 DEBUG(dbgs() << "Removing BB: \n" << *BB);
Chris Lattner71af9b02008-12-03 06:40:52 +00004061 DeleteDeadBlock(BB);
Chris Lattner01d1ee32002-05-21 20:50:24 +00004062 return true;
4063 }
4064
Chris Lattner694e37f2003-08-17 19:41:53 +00004065 // Check to see if we can constant propagate this terminator instruction
4066 // away...
Frits van Bommel5649ba72011-05-22 16:24:18 +00004067 Changed |= ConstantFoldTerminator(BB, true);
Chris Lattner694e37f2003-08-17 19:41:53 +00004068
Dan Gohman2c635662009-10-30 22:39:04 +00004069 // Check for and eliminate duplicate PHI nodes in this block.
4070 Changed |= EliminateDuplicatePHINodes(BB);
4071
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004072 // Check for and remove branches that will always cause undefined behavior.
4073 Changed |= removeUndefIntroducingPredecessor(BB);
4074
Chris Lattnerddb97a22010-12-13 05:10:48 +00004075 // Merge basic blocks into their predecessor if there is only one distinct
4076 // pred, and if there is only one distinct successor of the predecessor, and
4077 // if there are no PHI nodes.
4078 //
4079 if (MergeBlockIntoPredecessor(BB))
4080 return true;
Andrew Trick6b014382012-08-29 21:46:36 +00004081
Devang Patel3e410c62011-05-18 18:01:27 +00004082 IRBuilder<> Builder(BB);
4083
Dan Gohman882d87d2008-03-11 21:53:06 +00004084 // If there is a trivial two-entry PHI node in this basic block, and we can
4085 // eliminate it, do so now.
4086 if (PHINode *PN = dyn_cast<PHINode>(BB->begin()))
4087 if (PN->getNumIncomingValues() == 2)
Devang Pateld3a17882011-05-19 20:52:46 +00004088 Changed |= FoldTwoEntryPHINode(PN, TD);
Dan Gohman882d87d2008-03-11 21:53:06 +00004089
Devang Patel007349d2011-05-18 20:35:38 +00004090 Builder.SetInsertPoint(BB->getTerminator());
Chris Lattner3d512132010-12-13 06:25:44 +00004091 if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) {
Chris Lattner021c9d32010-12-13 06:36:51 +00004092 if (BI->isUnconditional()) {
Devang Patela23812c2011-05-18 18:28:48 +00004093 if (SimplifyUncondBranch(BI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00004094 } else {
Devang Patel007349d2011-05-18 20:35:38 +00004095 if (SimplifyCondBranch(BI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00004096 }
4097 } else if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
Devang Patel176ec402011-05-18 21:33:11 +00004098 if (SimplifyReturn(RI, Builder)) return true;
Bill Wendlingaa5abe82012-02-06 21:16:41 +00004099 } else if (ResumeInst *RI = dyn_cast<ResumeInst>(BB->getTerminator())) {
4100 if (SimplifyResume(RI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00004101 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
Devang Patel007349d2011-05-18 20:35:38 +00004102 if (SimplifySwitch(SI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00004103 } else if (UnreachableInst *UI =
4104 dyn_cast<UnreachableInst>(BB->getTerminator())) {
4105 if (SimplifyUnreachable(UI)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00004106 } else if (IndirectBrInst *IBI =
4107 dyn_cast<IndirectBrInst>(BB->getTerminator())) {
4108 if (SimplifyIndirectBr(IBI)) return true;
Chris Lattner19831ec2004-02-16 06:35:48 +00004109 }
4110
Chris Lattner694e37f2003-08-17 19:41:53 +00004111 return Changed;
Chris Lattner01d1ee32002-05-21 20:50:24 +00004112}
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +00004113
4114/// SimplifyCFG - This function is used to do simplification of a CFG. For
4115/// example, it adjusts branches to branches to eliminate the extra hop, it
4116/// eliminates unreachable basic blocks, and does other "peephole" optimization
4117/// of the CFG. It returns true if a modification was made.
4118///
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00004119bool llvm::SimplifyCFG(BasicBlock *BB, const TargetTransformInfo &TTI,
Tom Stellard01d72032013-08-06 02:43:45 +00004120 const DataLayout *TD) {
4121 return SimplifyCFGOpt(TTI, TD).run(BB);
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +00004122}