blob: 0401b9a7f7d841cb6423aca129515b9eae5e6b42 [file] [log] [blame]
Chris Lattner466a0492002-05-21 20:50:24 +00001//===- SimplifyCFG.cpp - Code to perform CFG simplification ---------------===//
Misha Brukmanb1c93172005-04-21 23:48:37 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-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 Brukmanb1c93172005-04-21 23:48:37 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner466a0492002-05-21 20:50:24 +00009//
Chris Lattnera704ac82002-10-08 21:36:33 +000010// Peephole optimize the CFG.
Chris Lattner466a0492002-05-21 20:50:24 +000011//
12//===----------------------------------------------------------------------===//
13
Chris Lattner9734fd02004-06-20 01:13:18 +000014#define DEBUG_TYPE "simplifycfg"
Chris Lattner466a0492002-05-21 20:50:24 +000015#include "llvm/Transforms/Utils/Local.h"
Chandler Carruthed0881b2012-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"
Benjamin Kramer7c302602013-11-12 12:24:36 +000022#include "llvm/Analysis/ConstantFolding.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000023#include "llvm/Analysis/InstructionSimplify.h"
Chandler Carruthd3e73552013-01-07 03:08:10 +000024#include "llvm/Analysis/TargetTransformInfo.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000025#include "llvm/Analysis/ValueTracking.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000026#include "llvm/IR/Constants.h"
27#include "llvm/IR/DataLayout.h"
28#include "llvm/IR/DerivedTypes.h"
29#include "llvm/IR/GlobalVariable.h"
30#include "llvm/IR/IRBuilder.h"
31#include "llvm/IR/Instructions.h"
32#include "llvm/IR/IntrinsicInst.h"
33#include "llvm/IR/LLVMContext.h"
34#include "llvm/IR/MDBuilder.h"
35#include "llvm/IR/Metadata.h"
36#include "llvm/IR/Module.h"
37#include "llvm/IR/Operator.h"
38#include "llvm/IR/Type.h"
Chris Lattnerd7beca32010-12-14 06:17:25 +000039#include "llvm/Support/CFG.h"
Evan Chengd983eba2011-01-29 04:46:23 +000040#include "llvm/Support/CommandLine.h"
Chris Lattnerd14b0f12010-12-17 06:20:15 +000041#include "llvm/Support/ConstantRange.h"
Chris Lattnerd7beca32010-12-14 06:17:25 +000042#include "llvm/Support/Debug.h"
Devang Patel1407fb42011-05-19 20:52:46 +000043#include "llvm/Support/NoFolder.h"
Benjamin Kramer37172222013-07-04 14:22:02 +000044#include "llvm/Support/PatternMatch.h"
Chris Lattnerd7beca32010-12-14 06:17:25 +000045#include "llvm/Support/raw_ostream.h"
Chandler Carruthaafe0912012-06-29 12:38:19 +000046#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Chris Lattner466a0492002-05-21 20:50:24 +000047#include <algorithm>
Chris Lattner5edb2f32004-10-18 04:07:22 +000048#include <map>
Chandler Carruthed0881b2012-12-03 16:50:05 +000049#include <set>
Chris Lattnerdf3c3422004-01-09 06:12:26 +000050using namespace llvm;
Benjamin Kramer37172222013-07-04 14:22:02 +000051using namespace PatternMatch;
Brian Gaeke960707c2003-11-11 22:41:34 +000052
Peter Collingbourne616044a2011-04-29 18:47:38 +000053static cl::opt<unsigned>
54PHINodeFoldingThreshold("phi-node-folding-threshold", cl::Hidden, cl::init(1),
55 cl::desc("Control the amount of phi node folding to perform (default = 1)"));
56
Evan Chengd983eba2011-01-29 04:46:23 +000057static cl::opt<bool>
58DupRet("simplifycfg-dup-ret", cl::Hidden, cl::init(false),
59 cl::desc("Duplicate return instructions into unconditional branches"));
60
Manman Ren93ab6492012-09-20 22:37:36 +000061static cl::opt<bool>
62SinkCommon("simplifycfg-sink-common", cl::Hidden, cl::init(true),
63 cl::desc("Sink common instructions down to the end block"));
64
Alp Tokercb402912014-01-24 17:20:08 +000065static cl::opt<bool> HoistCondStores(
66 "simplifycfg-hoist-cond-stores", cl::Hidden, cl::init(true),
67 cl::desc("Hoist conditional stores if an unconditional store precedes"));
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +000068
Hans Wennborg39583b82012-09-26 09:44:49 +000069STATISTIC(NumBitMaps, "Number of switch instructions turned into bitmaps");
Hans Wennborgcd3a11f2012-09-26 14:01:53 +000070STATISTIC(NumLookupTables, "Number of switch instructions turned into lookup tables");
Manman Ren93ab6492012-09-20 22:37:36 +000071STATISTIC(NumSinkCommons, "Number of common instructions sunk down to the end block");
Hans Wennborgcd3a11f2012-09-26 14:01:53 +000072STATISTIC(NumSpeculations, "Number of speculative executed instructions");
Evan Cheng89553cc2008-06-12 21:15:59 +000073
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +000074namespace {
Eric Christopherb65acc62012-07-02 23:22:21 +000075 /// ValueEqualityComparisonCase - Represents a case of a switch.
76 struct ValueEqualityComparisonCase {
77 ConstantInt *Value;
78 BasicBlock *Dest;
79
80 ValueEqualityComparisonCase(ConstantInt *Value, BasicBlock *Dest)
81 : Value(Value), Dest(Dest) {}
82
83 bool operator<(ValueEqualityComparisonCase RHS) const {
84 // Comparing pointers is ok as we only rely on the order for uniquing.
85 return Value < RHS.Value;
86 }
Benjamin Kramerc5b06782012-10-14 11:15:42 +000087
88 bool operator==(BasicBlock *RHSDest) const { return Dest == RHSDest; }
Eric Christopherb65acc62012-07-02 23:22:21 +000089 };
90
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +000091class SimplifyCFGOpt {
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +000092 const TargetTransformInfo &TTI;
Micah Villmowcdfe20b2012-10-08 16:38:25 +000093 const DataLayout *const TD;
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +000094 Value *isValueEqualityComparison(TerminatorInst *TI);
95 BasicBlock *GetValueEqualityComparisonCases(TerminatorInst *TI,
Eric Christopherb65acc62012-07-02 23:22:21 +000096 std::vector<ValueEqualityComparisonCase> &Cases);
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +000097 bool SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
Devang Patela7ec47d2011-05-18 20:35:38 +000098 BasicBlock *Pred,
99 IRBuilder<> &Builder);
Devang Patel58380552011-05-18 20:53:17 +0000100 bool FoldValueComparisonIntoPredecessors(TerminatorInst *TI,
101 IRBuilder<> &Builder);
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000102
Devang Pateldd14e0f2011-05-18 21:33:11 +0000103 bool SimplifyReturn(ReturnInst *RI, IRBuilder<> &Builder);
Bill Wendlingd5d95b02012-02-06 21:16:41 +0000104 bool SimplifyResume(ResumeInst *RI, IRBuilder<> &Builder);
Chris Lattner25c3af32010-12-13 06:25:44 +0000105 bool SimplifyUnreachable(UnreachableInst *UI);
Devang Patela7ec47d2011-05-18 20:35:38 +0000106 bool SimplifySwitch(SwitchInst *SI, IRBuilder<> &Builder);
Chris Lattner25c3af32010-12-13 06:25:44 +0000107 bool SimplifyIndirectBr(IndirectBrInst *IBI);
Devang Patel767f6932011-05-18 18:28:48 +0000108 bool SimplifyUncondBranch(BranchInst *BI, IRBuilder <> &Builder);
Devang Patela7ec47d2011-05-18 20:35:38 +0000109 bool SimplifyCondBranch(BranchInst *BI, IRBuilder <>&Builder);
Chris Lattner25c3af32010-12-13 06:25:44 +0000110
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000111public:
Tom Stellardaa664d92013-08-06 02:43:45 +0000112 SimplifyCFGOpt(const TargetTransformInfo &TTI, const DataLayout *TD)
113 : TTI(TTI), TD(TD) {}
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000114 bool run(BasicBlock *BB);
115};
116}
117
Chris Lattner76dc2042005-08-03 00:19:45 +0000118/// SafeToMergeTerminators - Return true if it is safe to merge these two
119/// terminator instructions together.
120///
121static bool SafeToMergeTerminators(TerminatorInst *SI1, TerminatorInst *SI2) {
122 if (SI1 == SI2) return false; // Can't merge with self!
Andrew Trickf3cf1932012-08-29 21:46:36 +0000123
Chris Lattner76dc2042005-08-03 00:19:45 +0000124 // It is not safe to merge these two switch instructions if they have a common
125 // successor, and if that successor has a PHI node, and if *that* PHI node has
126 // conflicting incoming values from the two switch blocks.
127 BasicBlock *SI1BB = SI1->getParent();
128 BasicBlock *SI2BB = SI2->getParent();
Chris Lattnerb7b75142007-04-02 01:44:59 +0000129 SmallPtrSet<BasicBlock*, 16> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
Andrew Trickf3cf1932012-08-29 21:46:36 +0000130
Chris Lattner76dc2042005-08-03 00:19:45 +0000131 for (succ_iterator I = succ_begin(SI2BB), E = succ_end(SI2BB); I != E; ++I)
132 if (SI1Succs.count(*I))
133 for (BasicBlock::iterator BBI = (*I)->begin();
134 isa<PHINode>(BBI); ++BBI) {
135 PHINode *PN = cast<PHINode>(BBI);
136 if (PN->getIncomingValueForBlock(SI1BB) !=
137 PN->getIncomingValueForBlock(SI2BB))
138 return false;
139 }
Andrew Trickf3cf1932012-08-29 21:46:36 +0000140
Chris Lattner76dc2042005-08-03 00:19:45 +0000141 return true;
142}
143
Manman Rend33f4ef2012-06-13 05:43:29 +0000144/// isProfitableToFoldUnconditional - Return true if it is safe and profitable
145/// to merge these two terminator instructions together, where SI1 is an
146/// unconditional branch. PhiNodes will store all PHI nodes in common
147/// successors.
148///
149static bool isProfitableToFoldUnconditional(BranchInst *SI1,
150 BranchInst *SI2,
Nick Lewycky0a045bb2012-06-24 10:15:42 +0000151 Instruction *Cond,
Manman Rend33f4ef2012-06-13 05:43:29 +0000152 SmallVectorImpl<PHINode*> &PhiNodes) {
153 if (SI1 == SI2) return false; // Can't merge with self!
154 assert(SI1->isUnconditional() && SI2->isConditional());
155
156 // We fold the unconditional branch if we can easily update all PHI nodes in
Andrew Trickf3cf1932012-08-29 21:46:36 +0000157 // common successors:
Manman Rend33f4ef2012-06-13 05:43:29 +0000158 // 1> We have a constant incoming value for the conditional branch;
159 // 2> We have "Cond" as the incoming value for the unconditional branch;
160 // 3> SI2->getCondition() and Cond have same operands.
161 CmpInst *Ci2 = dyn_cast<CmpInst>(SI2->getCondition());
162 if (!Ci2) return false;
163 if (!(Cond->getOperand(0) == Ci2->getOperand(0) &&
164 Cond->getOperand(1) == Ci2->getOperand(1)) &&
165 !(Cond->getOperand(0) == Ci2->getOperand(1) &&
166 Cond->getOperand(1) == Ci2->getOperand(0)))
167 return false;
168
169 BasicBlock *SI1BB = SI1->getParent();
170 BasicBlock *SI2BB = SI2->getParent();
171 SmallPtrSet<BasicBlock*, 16> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
172 for (succ_iterator I = succ_begin(SI2BB), E = succ_end(SI2BB); I != E; ++I)
173 if (SI1Succs.count(*I))
174 for (BasicBlock::iterator BBI = (*I)->begin();
175 isa<PHINode>(BBI); ++BBI) {
176 PHINode *PN = cast<PHINode>(BBI);
177 if (PN->getIncomingValueForBlock(SI1BB) != Cond ||
Nick Lewycky0a045bb2012-06-24 10:15:42 +0000178 !isa<ConstantInt>(PN->getIncomingValueForBlock(SI2BB)))
Manman Rend33f4ef2012-06-13 05:43:29 +0000179 return false;
180 PhiNodes.push_back(PN);
181 }
182 return true;
183}
184
Chris Lattner76dc2042005-08-03 00:19:45 +0000185/// AddPredecessorToBlock - Update PHI nodes in Succ to indicate that there will
186/// now be entries in it from the 'NewPred' block. The values that will be
187/// flowing into the PHI nodes will be the same as those coming in from
188/// ExistPred, an existing predecessor of Succ.
189static void AddPredecessorToBlock(BasicBlock *Succ, BasicBlock *NewPred,
190 BasicBlock *ExistPred) {
Chris Lattner76dc2042005-08-03 00:19:45 +0000191 if (!isa<PHINode>(Succ->begin())) return; // Quick exit if nothing to do
Andrew Trickf3cf1932012-08-29 21:46:36 +0000192
Chris Lattner80b03a12008-07-13 22:23:11 +0000193 PHINode *PN;
194 for (BasicBlock::iterator I = Succ->begin();
195 (PN = dyn_cast<PHINode>(I)); ++I)
196 PN->addIncoming(PN->getIncomingValueForBlock(ExistPred), NewPred);
Chris Lattner76dc2042005-08-03 00:19:45 +0000197}
198
David Majnemer91142c42013-06-01 19:43:23 +0000199/// ComputeSpeculationCost - Compute an abstract "cost" of speculating the
Dan Gohman5ab9c0a2012-01-05 23:58:56 +0000200/// given instruction, which is assumed to be safe to speculate. 1 means
201/// cheap, 2 means less cheap, and UINT_MAX means prohibitively expensive.
202static unsigned ComputeSpeculationCost(const User *I) {
203 assert(isSafeToSpeculativelyExecute(I) &&
204 "Instruction is not safe to speculatively execute!");
205 switch (Operator::getOpcode(I)) {
206 default:
207 // In doubt, be conservative.
208 return UINT_MAX;
209 case Instruction::GetElementPtr:
210 // GEPs are cheap if all indices are constant.
211 if (!cast<GEPOperator>(I)->hasAllConstantIndices())
212 return UINT_MAX;
213 return 1;
214 case Instruction::Load:
215 case Instruction::Add:
216 case Instruction::Sub:
217 case Instruction::And:
218 case Instruction::Or:
219 case Instruction::Xor:
220 case Instruction::Shl:
221 case Instruction::LShr:
222 case Instruction::AShr:
223 case Instruction::ICmp:
224 case Instruction::Trunc:
225 case Instruction::ZExt:
226 case Instruction::SExt:
227 return 1; // These are all cheap.
228
229 case Instruction::Call:
230 case Instruction::Select:
231 return 2;
232 }
233}
234
Bill Wendlingcaf1d222009-01-19 23:43:56 +0000235/// DominatesMergePoint - If we have a merge point of an "if condition" as
236/// accepted above, return true if the specified value dominates the block. We
237/// don't handle the true generality of domination here, just a special case
238/// which works well enough for us.
239///
240/// If AggressiveInsts is non-null, and if V does not dominate BB, we check to
Peter Collingbournee3511e12011-04-29 18:47:31 +0000241/// see if V (which must be an instruction) and its recursive operands
242/// that do not dominate BB have a combined cost lower than CostRemaining and
243/// are non-trapping. If both are true, the instruction is inserted into the
244/// set and true is returned.
245///
246/// The cost for most non-trapping instructions is defined as 1 except for
247/// Select whose cost is 2.
248///
249/// After this function returns, CostRemaining is decreased by the cost of
250/// V plus its non-dominating operands. If that cost is greater than
251/// CostRemaining, false is returned and CostRemaining is undefined.
Chris Lattner45c35b12004-10-14 05:13:36 +0000252static bool DominatesMergePoint(Value *V, BasicBlock *BB,
Peter Collingbournee3511e12011-04-29 18:47:31 +0000253 SmallPtrSet<Instruction*, 4> *AggressiveInsts,
254 unsigned &CostRemaining) {
Chris Lattner0aa56562004-04-09 22:50:22 +0000255 Instruction *I = dyn_cast<Instruction>(V);
Chris Lattnerb8b11592006-10-20 00:42:07 +0000256 if (!I) {
257 // Non-instructions all dominate instructions, but not all constantexprs
258 // can be executed unconditionally.
259 if (ConstantExpr *C = dyn_cast<ConstantExpr>(V))
260 if (C->canTrap())
261 return false;
262 return true;
263 }
Chris Lattner0aa56562004-04-09 22:50:22 +0000264 BasicBlock *PBB = I->getParent();
Chris Lattner18d1f192004-02-11 03:36:04 +0000265
Chris Lattner0ce80cd2005-02-27 06:18:25 +0000266 // We don't want to allow weird loops that might have the "if condition" in
Chris Lattner0aa56562004-04-09 22:50:22 +0000267 // the bottom of this block.
268 if (PBB == BB) return false;
Chris Lattner18d1f192004-02-11 03:36:04 +0000269
Chris Lattner0aa56562004-04-09 22:50:22 +0000270 // If this instruction is defined in a block that contains an unconditional
271 // branch to BB, then it must be in the 'conditional' part of the "if
Chris Lattner9ac168d2010-12-14 07:41:39 +0000272 // statement". If not, it definitely dominates the region.
273 BranchInst *BI = dyn_cast<BranchInst>(PBB->getTerminator());
274 if (BI == 0 || BI->isConditional() || BI->getSuccessor(0) != BB)
275 return true;
Eli Friedmanb8f6a4f2009-07-17 04:28:42 +0000276
Chris Lattner9ac168d2010-12-14 07:41:39 +0000277 // If we aren't allowing aggressive promotion anymore, then don't consider
278 // instructions in the 'if region'.
279 if (AggressiveInsts == 0) return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +0000280
Peter Collingbournee3511e12011-04-29 18:47:31 +0000281 // If we have seen this instruction before, don't count it again.
282 if (AggressiveInsts->count(I)) return true;
283
Chris Lattner9ac168d2010-12-14 07:41:39 +0000284 // Okay, it looks like the instruction IS in the "condition". Check to
285 // see if it's a cheap instruction to unconditionally compute, and if it
286 // only uses stuff defined outside of the condition. If so, hoist it out.
Dan Gohman75d7d5e2011-12-14 23:49:11 +0000287 if (!isSafeToSpeculativelyExecute(I))
Chris Lattner9ac168d2010-12-14 07:41:39 +0000288 return false;
Misha Brukmanb1c93172005-04-21 23:48:37 +0000289
Dan Gohman5ab9c0a2012-01-05 23:58:56 +0000290 unsigned Cost = ComputeSpeculationCost(I);
Chris Lattner0aa56562004-04-09 22:50:22 +0000291
Peter Collingbournee3511e12011-04-29 18:47:31 +0000292 if (Cost > CostRemaining)
293 return false;
294
295 CostRemaining -= Cost;
296
297 // Okay, we can only really hoist these out if their operands do
298 // not take us over the cost threshold.
Chris Lattner9ac168d2010-12-14 07:41:39 +0000299 for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i)
Peter Collingbournee3511e12011-04-29 18:47:31 +0000300 if (!DominatesMergePoint(*i, BB, AggressiveInsts, CostRemaining))
Chris Lattner9ac168d2010-12-14 07:41:39 +0000301 return false;
302 // Okay, it's safe to do this! Remember this instruction.
303 AggressiveInsts->insert(I);
Chris Lattner18d1f192004-02-11 03:36:04 +0000304 return true;
305}
Chris Lattner466a0492002-05-21 20:50:24 +0000306
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000307/// GetConstantInt - Extract ConstantInt from value, looking through IntToPtr
308/// and PointerNullValue. Return NULL if value is not a constant int.
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000309static ConstantInt *GetConstantInt(Value *V, const DataLayout *TD) {
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000310 // Normal constant int.
311 ConstantInt *CI = dyn_cast<ConstantInt>(V);
Duncan Sands19d0b472010-02-16 11:11:14 +0000312 if (CI || !TD || !isa<Constant>(V) || !V->getType()->isPointerTy())
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000313 return CI;
314
315 // This is some kind of pointer constant. Turn it into a pointer-sized
316 // ConstantInt if possible.
Duncan Sands5bdd9dd2012-10-29 17:31:46 +0000317 IntegerType *PtrTy = cast<IntegerType>(TD->getIntPtrType(V->getType()));
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000318
319 // Null pointer means 0, see SelectionDAGBuilder::getValue(const Value*).
320 if (isa<ConstantPointerNull>(V))
321 return ConstantInt::get(PtrTy, 0);
322
323 // IntToPtr const int.
324 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
325 if (CE->getOpcode() == Instruction::IntToPtr)
326 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(0))) {
327 // The constant is very likely to have the right type already.
328 if (CI->getType() == PtrTy)
329 return CI;
330 else
331 return cast<ConstantInt>
332 (ConstantExpr::getIntegerCast(CI, PtrTy, /*isSigned=*/false));
333 }
334 return 0;
335}
336
Chris Lattner5a177e62010-12-13 04:26:26 +0000337/// GatherConstantCompares - Given a potentially 'or'd or 'and'd together
338/// collection of icmp eq/ne instructions that compare a value against a
339/// constant, return the value being compared, and stick the constant into the
340/// Values vector.
Chris Lattner11dafaa2010-12-13 03:30:12 +0000341static Value *
Chris Lattner5a177e62010-12-13 04:26:26 +0000342GatherConstantCompares(Value *V, std::vector<ConstantInt*> &Vals, Value *&Extra,
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000343 const DataLayout *TD, bool isEQ, unsigned &UsedICmps) {
Chris Lattner5a177e62010-12-13 04:26:26 +0000344 Instruction *I = dyn_cast<Instruction>(V);
345 if (I == 0) return 0;
Andrew Trickf3cf1932012-08-29 21:46:36 +0000346
Chris Lattnera442f242010-12-13 04:50:38 +0000347 // If this is an icmp against a constant, handle this as one of the cases.
Chris Lattner5a177e62010-12-13 04:26:26 +0000348 if (ICmpInst *ICI = dyn_cast<ICmpInst>(I)) {
Chris Lattnerd14b0f12010-12-17 06:20:15 +0000349 if (ConstantInt *C = GetConstantInt(I->getOperand(1), TD)) {
Benjamin Kramer37172222013-07-04 14:22:02 +0000350 Value *RHSVal;
351 ConstantInt *RHSC;
352
Chris Lattnerd14b0f12010-12-17 06:20:15 +0000353 if (ICI->getPredicate() == (isEQ ? ICmpInst::ICMP_EQ:ICmpInst::ICMP_NE)) {
Benjamin Kramer37172222013-07-04 14:22:02 +0000354 // (x & ~2^x) == y --> x == y || x == y|2^x
355 // This undoes a transformation done by instcombine to fuse 2 compares.
356 if (match(ICI->getOperand(0),
357 m_And(m_Value(RHSVal), m_ConstantInt(RHSC)))) {
358 APInt Not = ~RHSC->getValue();
359 if (Not.isPowerOf2()) {
360 Vals.push_back(C);
361 Vals.push_back(
362 ConstantInt::get(C->getContext(), C->getValue() | Not));
363 UsedICmps++;
364 return RHSVal;
365 }
366 }
367
Benjamin Kramer8d6a8c12011-02-07 22:37:28 +0000368 UsedICmps++;
Chris Lattner5a177e62010-12-13 04:26:26 +0000369 Vals.push_back(C);
370 return I->getOperand(0);
371 }
Andrew Trickf3cf1932012-08-29 21:46:36 +0000372
Chris Lattnerd14b0f12010-12-17 06:20:15 +0000373 // If we have "x ult 3" comparison, for example, then we can add 0,1,2 to
374 // the set.
375 ConstantRange Span =
Chris Lattner6b8b4852010-12-18 20:22:49 +0000376 ConstantRange::makeICmpRegion(ICI->getPredicate(), C->getValue());
Andrew Trickf3cf1932012-08-29 21:46:36 +0000377
Benjamin Kramer37172222013-07-04 14:22:02 +0000378 // Shift the range if the compare is fed by an add. This is the range
379 // compare idiom as emitted by instcombine.
380 bool hasAdd =
381 match(I->getOperand(0), m_Add(m_Value(RHSVal), m_ConstantInt(RHSC)));
382 if (hasAdd)
383 Span = Span.subtract(RHSC->getValue());
384
Chris Lattnerd14b0f12010-12-17 06:20:15 +0000385 // If this is an and/!= check then we want to optimize "x ugt 2" into
386 // x != 0 && x != 1.
387 if (!isEQ)
388 Span = Span.inverse();
Andrew Trickf3cf1932012-08-29 21:46:36 +0000389
Chris Lattnerd14b0f12010-12-17 06:20:15 +0000390 // If there are a ton of values, we don't want to make a ginormous switch.
Nick Lewycky219e6bc2012-01-19 18:19:42 +0000391 if (Span.getSetSize().ugt(8) || Span.isEmptySet())
Chris Lattnerd14b0f12010-12-17 06:20:15 +0000392 return 0;
Andrew Trickf3cf1932012-08-29 21:46:36 +0000393
Chris Lattnerd14b0f12010-12-17 06:20:15 +0000394 for (APInt Tmp = Span.getLower(); Tmp != Span.getUpper(); ++Tmp)
395 Vals.push_back(ConstantInt::get(V->getContext(), Tmp));
Benjamin Kramer8d6a8c12011-02-07 22:37:28 +0000396 UsedICmps++;
Benjamin Kramer37172222013-07-04 14:22:02 +0000397 return hasAdd ? RHSVal : I->getOperand(0);
Chris Lattnerd14b0f12010-12-17 06:20:15 +0000398 }
Chris Lattner9b1af512010-12-13 04:18:32 +0000399 return 0;
400 }
Andrew Trickf3cf1932012-08-29 21:46:36 +0000401
Chris Lattnera442f242010-12-13 04:50:38 +0000402 // Otherwise, we can only handle an | or &, depending on isEQ.
Chris Lattner5a177e62010-12-13 04:26:26 +0000403 if (I->getOpcode() != (isEQ ? Instruction::Or : Instruction::And))
Chris Lattner9b1af512010-12-13 04:18:32 +0000404 return 0;
Andrew Trickf3cf1932012-08-29 21:46:36 +0000405
Chris Lattnera442f242010-12-13 04:50:38 +0000406 unsigned NumValsBeforeLHS = Vals.size();
Benjamin Kramer8d6a8c12011-02-07 22:37:28 +0000407 unsigned UsedICmpsBeforeLHS = UsedICmps;
Chris Lattner5a177e62010-12-13 04:26:26 +0000408 if (Value *LHS = GatherConstantCompares(I->getOperand(0), Vals, Extra, TD,
Benjamin Kramer8d6a8c12011-02-07 22:37:28 +0000409 isEQ, UsedICmps)) {
Chris Lattnera442f242010-12-13 04:50:38 +0000410 unsigned NumVals = Vals.size();
Benjamin Kramer8d6a8c12011-02-07 22:37:28 +0000411 unsigned UsedICmpsBeforeRHS = UsedICmps;
Chris Lattner5a177e62010-12-13 04:26:26 +0000412 if (Value *RHS = GatherConstantCompares(I->getOperand(1), Vals, Extra, TD,
Benjamin Kramer8d6a8c12011-02-07 22:37:28 +0000413 isEQ, UsedICmps)) {
Chris Lattner5a177e62010-12-13 04:26:26 +0000414 if (LHS == RHS)
415 return LHS;
Chris Lattner79db3572010-12-13 07:41:29 +0000416 Vals.resize(NumVals);
Benjamin Kramer8d6a8c12011-02-07 22:37:28 +0000417 UsedICmps = UsedICmpsBeforeRHS;
Chris Lattner5a177e62010-12-13 04:26:26 +0000418 }
Chris Lattnera442f242010-12-13 04:50:38 +0000419
420 // The RHS of the or/and can't be folded in and we haven't used "Extra" yet,
421 // set it and return success.
422 if (Extra == 0 || Extra == I->getOperand(1)) {
423 Extra = I->getOperand(1);
424 return LHS;
425 }
Andrew Trickf3cf1932012-08-29 21:46:36 +0000426
Chris Lattnera442f242010-12-13 04:50:38 +0000427 Vals.resize(NumValsBeforeLHS);
Benjamin Kramer8d6a8c12011-02-07 22:37:28 +0000428 UsedICmps = UsedICmpsBeforeLHS;
Chris Lattnera442f242010-12-13 04:50:38 +0000429 return 0;
Anton Korobeynikov1bfd1212008-02-20 11:26:25 +0000430 }
Andrew Trickf3cf1932012-08-29 21:46:36 +0000431
Chris Lattnera442f242010-12-13 04:50:38 +0000432 // If the LHS can't be folded in, but Extra is available and RHS can, try to
433 // use LHS as Extra.
434 if (Extra == 0 || Extra == I->getOperand(0)) {
Chris Lattner79db3572010-12-13 07:41:29 +0000435 Value *OldExtra = Extra;
Chris Lattnera442f242010-12-13 04:50:38 +0000436 Extra = I->getOperand(0);
437 if (Value *RHS = GatherConstantCompares(I->getOperand(1), Vals, Extra, TD,
Benjamin Kramer8d6a8c12011-02-07 22:37:28 +0000438 isEQ, UsedICmps))
Chris Lattnera442f242010-12-13 04:50:38 +0000439 return RHS;
Chris Lattner79db3572010-12-13 07:41:29 +0000440 assert(Vals.size() == NumValsBeforeLHS);
441 Extra = OldExtra;
Chris Lattnera442f242010-12-13 04:50:38 +0000442 }
Andrew Trickf3cf1932012-08-29 21:46:36 +0000443
Chris Lattner6f4b45a2004-02-24 05:38:11 +0000444 return 0;
445}
Nick Lewyckye87d54c2011-12-26 20:37:40 +0000446
Eli Friedmancb61afb2008-12-16 20:54:32 +0000447static void EraseTerminatorInstAndDCECond(TerminatorInst *TI) {
Nick Lewyckye87d54c2011-12-26 20:37:40 +0000448 Instruction *Cond = 0;
Eli Friedmancb61afb2008-12-16 20:54:32 +0000449 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
450 Cond = dyn_cast<Instruction>(SI->getCondition());
451 } else if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
452 if (BI->isConditional())
453 Cond = dyn_cast<Instruction>(BI->getCondition());
Frits van Bommel8fb69ee2010-12-05 18:29:03 +0000454 } else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(TI)) {
455 Cond = dyn_cast<Instruction>(IBI->getAddress());
Eli Friedmancb61afb2008-12-16 20:54:32 +0000456 }
457
458 TI->eraseFromParent();
459 if (Cond) RecursivelyDeleteTriviallyDeadInstructions(Cond);
460}
461
Chris Lattner8e84c122008-11-27 23:25:44 +0000462/// isValueEqualityComparison - Return true if the specified terminator checks
463/// to see if a value is equal to constant integer value.
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000464Value *SimplifyCFGOpt::isValueEqualityComparison(TerminatorInst *TI) {
465 Value *CV = 0;
Chris Lattnera64923a2004-03-16 19:45:22 +0000466 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
467 // Do not permit merging of large switch instructions into their
468 // predecessors unless there is only one predecessor.
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000469 if (SI->getNumSuccessors()*std::distance(pred_begin(SI->getParent()),
470 pred_end(SI->getParent())) <= 128)
471 CV = SI->getCondition();
472 } else if (BranchInst *BI = dyn_cast<BranchInst>(TI))
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000473 if (BI->isConditional() && BI->getCondition()->hasOneUse())
Reid Spencer266e42b2006-12-23 06:05:41 +0000474 if (ICmpInst *ICI = dyn_cast<ICmpInst>(BI->getCondition()))
David Majnemer8e7dd2f2013-06-03 20:39:50 +0000475 if (ICI->isEquality() && GetConstantInt(ICI->getOperand(1), TD))
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000476 CV = ICI->getOperand(0);
477
478 // Unwrap any lossless ptrtoint cast.
Matt Arsenaultfa646592013-10-21 18:55:08 +0000479 if (TD && CV) {
480 if (PtrToIntInst *PTII = dyn_cast<PtrToIntInst>(CV)) {
481 Value *Ptr = PTII->getPointerOperand();
482 if (PTII->getType() == TD->getIntPtrType(Ptr->getType()))
483 CV = Ptr;
484 }
485 }
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000486 return CV;
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000487}
488
Bill Wendlingcaf1d222009-01-19 23:43:56 +0000489/// GetValueEqualityComparisonCases - Given a value comparison instruction,
490/// decode all of the 'cases' that it represents and return the 'default' block.
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000491BasicBlock *SimplifyCFGOpt::
Misha Brukmanb1c93172005-04-21 23:48:37 +0000492GetValueEqualityComparisonCases(TerminatorInst *TI,
Eric Christopherb65acc62012-07-02 23:22:21 +0000493 std::vector<ValueEqualityComparisonCase>
494 &Cases) {
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000495 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Eric Christopherb65acc62012-07-02 23:22:21 +0000496 Cases.reserve(SI->getNumCases());
497 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end(); i != e; ++i)
498 Cases.push_back(ValueEqualityComparisonCase(i.getCaseValue(),
499 i.getCaseSuccessor()));
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000500 return SI->getDefaultDest();
501 }
Eric Christopherb65acc62012-07-02 23:22:21 +0000502
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000503 BranchInst *BI = cast<BranchInst>(TI);
Reid Spencer266e42b2006-12-23 06:05:41 +0000504 ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
Eric Christopherb65acc62012-07-02 23:22:21 +0000505 BasicBlock *Succ = BI->getSuccessor(ICI->getPredicate() == ICmpInst::ICMP_NE);
506 Cases.push_back(ValueEqualityComparisonCase(GetConstantInt(ICI->getOperand(1),
507 TD),
508 Succ));
Reid Spencer266e42b2006-12-23 06:05:41 +0000509 return BI->getSuccessor(ICI->getPredicate() == ICmpInst::ICMP_EQ);
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000510}
511
Eric Christopherb65acc62012-07-02 23:22:21 +0000512
513/// EliminateBlockCases - Given a vector of bb/value pairs, remove any entries
514/// in the list that match the specified block.
515static void EliminateBlockCases(BasicBlock *BB,
516 std::vector<ValueEqualityComparisonCase> &Cases) {
Benjamin Kramerc5b06782012-10-14 11:15:42 +0000517 Cases.erase(std::remove(Cases.begin(), Cases.end(), BB), Cases.end());
Eric Christopherb65acc62012-07-02 23:22:21 +0000518}
519
520/// ValuesOverlap - Return true if there are any keys in C1 that exist in C2 as
521/// well.
522static bool
523ValuesOverlap(std::vector<ValueEqualityComparisonCase> &C1,
524 std::vector<ValueEqualityComparisonCase > &C2) {
525 std::vector<ValueEqualityComparisonCase> *V1 = &C1, *V2 = &C2;
526
527 // Make V1 be smaller than V2.
528 if (V1->size() > V2->size())
529 std::swap(V1, V2);
530
531 if (V1->size() == 0) return false;
532 if (V1->size() == 1) {
533 // Just scan V2.
534 ConstantInt *TheVal = (*V1)[0].Value;
535 for (unsigned i = 0, e = V2->size(); i != e; ++i)
536 if (TheVal == (*V2)[i].Value)
537 return true;
538 }
539
540 // Otherwise, just sort both lists and compare element by element.
541 array_pod_sort(V1->begin(), V1->end());
542 array_pod_sort(V2->begin(), V2->end());
543 unsigned i1 = 0, i2 = 0, e1 = V1->size(), e2 = V2->size();
544 while (i1 != e1 && i2 != e2) {
545 if ((*V1)[i1].Value == (*V2)[i2].Value)
546 return true;
547 if ((*V1)[i1].Value < (*V2)[i2].Value)
548 ++i1;
549 else
550 ++i2;
551 }
552 return false;
553}
554
Bill Wendlingcaf1d222009-01-19 23:43:56 +0000555/// SimplifyEqualityComparisonWithOnlyPredecessor - If TI is known to be a
556/// terminator instruction and its block is known to only have a single
557/// predecessor block, check to see if that predecessor is also a value
558/// comparison with the same value, and if that comparison determines the
559/// outcome of this comparison. If so, simplify TI. This does a very limited
560/// form of jump threading.
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000561bool SimplifyCFGOpt::
562SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
Devang Patela7ec47d2011-05-18 20:35:38 +0000563 BasicBlock *Pred,
564 IRBuilder<> &Builder) {
Chris Lattner1cca9592005-02-24 06:17:52 +0000565 Value *PredVal = isValueEqualityComparison(Pred->getTerminator());
566 if (!PredVal) return false; // Not a value comparison in predecessor.
567
568 Value *ThisVal = isValueEqualityComparison(TI);
569 assert(ThisVal && "This isn't a value comparison!!");
570 if (ThisVal != PredVal) return false; // Different predicates.
571
Andrew Trick3051aa12012-08-29 21:46:38 +0000572 // TODO: Preserve branch weight metadata, similarly to how
573 // FoldValueComparisonIntoPredecessors preserves it.
574
Chris Lattner1cca9592005-02-24 06:17:52 +0000575 // Find out information about when control will move from Pred to TI's block.
Eric Christopherb65acc62012-07-02 23:22:21 +0000576 std::vector<ValueEqualityComparisonCase> PredCases;
Chris Lattner1cca9592005-02-24 06:17:52 +0000577 BasicBlock *PredDef = GetValueEqualityComparisonCases(Pred->getTerminator(),
578 PredCases);
Eric Christopherb65acc62012-07-02 23:22:21 +0000579 EliminateBlockCases(PredDef, PredCases); // Remove default from cases.
Misha Brukmanb1c93172005-04-21 23:48:37 +0000580
Chris Lattner1cca9592005-02-24 06:17:52 +0000581 // Find information about how control leaves this block.
Eric Christopherb65acc62012-07-02 23:22:21 +0000582 std::vector<ValueEqualityComparisonCase> ThisCases;
Chris Lattner1cca9592005-02-24 06:17:52 +0000583 BasicBlock *ThisDef = GetValueEqualityComparisonCases(TI, ThisCases);
Eric Christopherb65acc62012-07-02 23:22:21 +0000584 EliminateBlockCases(ThisDef, ThisCases); // Remove default from cases.
Chris Lattner1cca9592005-02-24 06:17:52 +0000585
586 // If TI's block is the default block from Pred's comparison, potentially
587 // simplify TI based on this knowledge.
588 if (PredDef == TI->getParent()) {
589 // If we are here, we know that the value is none of those cases listed in
590 // PredCases. If there are any cases in ThisCases that are in PredCases, we
591 // can simplify TI.
Eric Christopherb65acc62012-07-02 23:22:21 +0000592 if (!ValuesOverlap(PredCases, ThisCases))
Chris Lattner4088e2b2010-12-13 01:47:07 +0000593 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +0000594
Chris Lattner4088e2b2010-12-13 01:47:07 +0000595 if (isa<BranchInst>(TI)) {
596 // Okay, one of the successors of this condbr is dead. Convert it to a
597 // uncond br.
598 assert(ThisCases.size() == 1 && "Branch can only have one case!");
599 // Insert the new branch.
Devang Patela7ec47d2011-05-18 20:35:38 +0000600 Instruction *NI = Builder.CreateBr(ThisDef);
Chris Lattner4088e2b2010-12-13 01:47:07 +0000601 (void) NI;
Chris Lattner1cca9592005-02-24 06:17:52 +0000602
Chris Lattner4088e2b2010-12-13 01:47:07 +0000603 // Remove PHI node entries for the dead edge.
Eric Christopherb65acc62012-07-02 23:22:21 +0000604 ThisCases[0].Dest->removePredecessor(TI->getParent());
Chris Lattner1cca9592005-02-24 06:17:52 +0000605
Chris Lattner4088e2b2010-12-13 01:47:07 +0000606 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
607 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
Chris Lattner1cca9592005-02-24 06:17:52 +0000608
Chris Lattner4088e2b2010-12-13 01:47:07 +0000609 EraseTerminatorInstAndDCECond(TI);
610 return true;
Chris Lattner1cca9592005-02-24 06:17:52 +0000611 }
Andrew Trickf3cf1932012-08-29 21:46:36 +0000612
Chris Lattner4088e2b2010-12-13 01:47:07 +0000613 SwitchInst *SI = cast<SwitchInst>(TI);
614 // Okay, TI has cases that are statically dead, prune them away.
Eric Christopherb65acc62012-07-02 23:22:21 +0000615 SmallPtrSet<Constant*, 16> DeadCases;
616 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
617 DeadCases.insert(PredCases[i].Value);
Chris Lattner1cca9592005-02-24 06:17:52 +0000618
David Greene725c7c32010-01-05 01:26:52 +0000619 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
Chris Lattner4088e2b2010-12-13 01:47:07 +0000620 << "Through successor TI: " << *TI);
Chris Lattner1cca9592005-02-24 06:17:52 +0000621
Manman Ren8691e522012-09-14 21:53:06 +0000622 // Collect branch weights into a vector.
623 SmallVector<uint32_t, 8> Weights;
624 MDNode* MD = SI->getMetadata(LLVMContext::MD_prof);
625 bool HasWeight = MD && (MD->getNumOperands() == 2 + SI->getNumCases());
626 if (HasWeight)
627 for (unsigned MD_i = 1, MD_e = MD->getNumOperands(); MD_i < MD_e;
628 ++MD_i) {
629 ConstantInt* CI = dyn_cast<ConstantInt>(MD->getOperand(MD_i));
630 assert(CI);
631 Weights.push_back(CI->getValue().getZExtValue());
632 }
Eric Christopherb65acc62012-07-02 23:22:21 +0000633 for (SwitchInst::CaseIt i = SI->case_end(), e = SI->case_begin(); i != e;) {
634 --i;
635 if (DeadCases.count(i.getCaseValue())) {
Manman Ren8691e522012-09-14 21:53:06 +0000636 if (HasWeight) {
637 std::swap(Weights[i.getCaseIndex()+1], Weights.back());
638 Weights.pop_back();
639 }
Eric Christopherb65acc62012-07-02 23:22:21 +0000640 i.getCaseSuccessor()->removePredecessor(TI->getParent());
641 SI->removeCase(i);
642 }
643 }
Manman Ren97c18762012-10-11 22:28:34 +0000644 if (HasWeight && Weights.size() >= 2)
Manman Ren8691e522012-09-14 21:53:06 +0000645 SI->setMetadata(LLVMContext::MD_prof,
646 MDBuilder(SI->getParent()->getContext()).
647 createBranchWeights(Weights));
Eric Christopherb65acc62012-07-02 23:22:21 +0000648
649 DEBUG(dbgs() << "Leaving: " << *TI << "\n");
Chris Lattner1cca9592005-02-24 06:17:52 +0000650 return true;
651 }
Andrew Trickf3cf1932012-08-29 21:46:36 +0000652
Chris Lattner4088e2b2010-12-13 01:47:07 +0000653 // Otherwise, TI's block must correspond to some matched value. Find out
654 // which value (or set of values) this is.
Eric Christopherb65acc62012-07-02 23:22:21 +0000655 ConstantInt *TIV = 0;
Chris Lattner4088e2b2010-12-13 01:47:07 +0000656 BasicBlock *TIBB = TI->getParent();
Eric Christopherb65acc62012-07-02 23:22:21 +0000657 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
658 if (PredCases[i].Dest == TIBB) {
659 if (TIV != 0)
660 return false; // Cannot handle multiple values coming to this block.
661 TIV = PredCases[i].Value;
662 }
663 assert(TIV && "No edge from pred to succ?");
Chris Lattner4088e2b2010-12-13 01:47:07 +0000664
665 // Okay, we found the one constant that our value can be if we get into TI's
666 // BB. Find out which successor will unconditionally be branched to.
Eric Christopherb65acc62012-07-02 23:22:21 +0000667 BasicBlock *TheRealDest = 0;
668 for (unsigned i = 0, e = ThisCases.size(); i != e; ++i)
669 if (ThisCases[i].Value == TIV) {
670 TheRealDest = ThisCases[i].Dest;
671 break;
672 }
Chris Lattner4088e2b2010-12-13 01:47:07 +0000673
674 // If not handled by any explicit cases, it is handled by the default case.
675 if (TheRealDest == 0) TheRealDest = ThisDef;
676
677 // Remove PHI node entries for dead edges.
678 BasicBlock *CheckEdge = TheRealDest;
679 for (succ_iterator SI = succ_begin(TIBB), e = succ_end(TIBB); SI != e; ++SI)
680 if (*SI != CheckEdge)
681 (*SI)->removePredecessor(TIBB);
682 else
683 CheckEdge = 0;
684
685 // Insert the new branch.
Devang Patela7ec47d2011-05-18 20:35:38 +0000686 Instruction *NI = Builder.CreateBr(TheRealDest);
Chris Lattner4088e2b2010-12-13 01:47:07 +0000687 (void) NI;
688
689 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
690 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
691
692 EraseTerminatorInstAndDCECond(TI);
693 return true;
Chris Lattner1cca9592005-02-24 06:17:52 +0000694}
695
Dale Johannesen7f99d222009-03-12 21:01:11 +0000696namespace {
697 /// ConstantIntOrdering - This class implements a stable ordering of constant
698 /// integers that does not depend on their address. This is important for
699 /// applications that sort ConstantInt's to ensure uniqueness.
700 struct ConstantIntOrdering {
701 bool operator()(const ConstantInt *LHS, const ConstantInt *RHS) const {
702 return LHS->getValue().ult(RHS->getValue());
703 }
704 };
705}
Dale Johannesen5a41b2d2009-03-12 01:00:26 +0000706
Benjamin Kramer8817cca2013-09-22 14:09:50 +0000707static int ConstantIntSortPredicate(ConstantInt *const *P1,
708 ConstantInt *const *P2) {
709 const ConstantInt *LHS = *P1;
710 const ConstantInt *RHS = *P2;
Chris Lattnere893e262010-12-15 04:52:41 +0000711 if (LHS->getValue().ult(RHS->getValue()))
712 return 1;
713 if (LHS->getValue() == RHS->getValue())
714 return 0;
715 return -1;
Chris Lattner7c8e6042010-12-13 02:00:58 +0000716}
717
Andrew Trick3051aa12012-08-29 21:46:38 +0000718static inline bool HasBranchWeights(const Instruction* I) {
719 MDNode* ProfMD = I->getMetadata(LLVMContext::MD_prof);
720 if (ProfMD && ProfMD->getOperand(0))
721 if (MDString* MDS = dyn_cast<MDString>(ProfMD->getOperand(0)))
722 return MDS->getString().equals("branch_weights");
723
724 return false;
725}
726
Manman Ren571d9e42012-09-11 17:43:35 +0000727/// Get Weights of a given TerminatorInst, the default weight is at the front
728/// of the vector. If TI is a conditional eq, we need to swap the branch-weight
729/// metadata.
730static void GetBranchWeights(TerminatorInst *TI,
731 SmallVectorImpl<uint64_t> &Weights) {
732 MDNode* MD = TI->getMetadata(LLVMContext::MD_prof);
733 assert(MD);
734 for (unsigned i = 1, e = MD->getNumOperands(); i < e; ++i) {
735 ConstantInt* CI = dyn_cast<ConstantInt>(MD->getOperand(i));
Andrew Trick3051aa12012-08-29 21:46:38 +0000736 assert(CI);
Manman Ren571d9e42012-09-11 17:43:35 +0000737 Weights.push_back(CI->getValue().getZExtValue());
Andrew Trick3051aa12012-08-29 21:46:38 +0000738 }
739
Manman Ren571d9e42012-09-11 17:43:35 +0000740 // If TI is a conditional eq, the default case is the false case,
741 // and the corresponding branch-weight data is at index 2. We swap the
742 // default weight to be the first entry.
743 if (BranchInst* BI = dyn_cast<BranchInst>(TI)) {
744 assert(Weights.size() == 2);
745 ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
746 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
747 std::swap(Weights.front(), Weights.back());
Andrew Trick3051aa12012-08-29 21:46:38 +0000748 }
749}
750
Manman Renf1cb16e2014-01-27 23:39:03 +0000751/// Keep halving the weights until all can fit in uint32_t.
Andrew Trick3051aa12012-08-29 21:46:38 +0000752static void FitWeights(MutableArrayRef<uint64_t> Weights) {
Manman Renf1cb16e2014-01-27 23:39:03 +0000753 while (true) {
754 bool Halve = false;
755 for (unsigned i = 0; i < Weights.size(); ++i)
756 if (Weights[i] > UINT_MAX) {
757 Halve = true;
758 break;
759 }
Andrew Trick3051aa12012-08-29 21:46:38 +0000760
Manman Renf1cb16e2014-01-27 23:39:03 +0000761 if (! Halve)
762 return;
Andrew Trick3051aa12012-08-29 21:46:38 +0000763
Manman Renf1cb16e2014-01-27 23:39:03 +0000764 for (unsigned i = 0; i < Weights.size(); ++i)
765 Weights[i] /= 2;
766 }
Andrew Trick3051aa12012-08-29 21:46:38 +0000767}
768
Bill Wendlingcaf1d222009-01-19 23:43:56 +0000769/// FoldValueComparisonIntoPredecessors - The specified terminator is a value
770/// equality comparison instruction (either a switch or a branch on "X == c").
771/// See if any of the predecessors of the terminator block are value comparisons
772/// on the same value. If so, and if safe to do so, fold them together.
Devang Patel58380552011-05-18 20:53:17 +0000773bool SimplifyCFGOpt::FoldValueComparisonIntoPredecessors(TerminatorInst *TI,
774 IRBuilder<> &Builder) {
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000775 BasicBlock *BB = TI->getParent();
776 Value *CV = isValueEqualityComparison(TI); // CondVal
777 assert(CV && "Not a comparison?");
778 bool Changed = false;
779
Chris Lattner6b39cb92008-02-18 07:42:56 +0000780 SmallVector<BasicBlock*, 16> Preds(pred_begin(BB), pred_end(BB));
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000781 while (!Preds.empty()) {
Dan Gohman9a6fef02009-05-06 17:22:41 +0000782 BasicBlock *Pred = Preds.pop_back_val();
Misha Brukmanb1c93172005-04-21 23:48:37 +0000783
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000784 // See if the predecessor is a comparison with the same value.
785 TerminatorInst *PTI = Pred->getTerminator();
786 Value *PCV = isValueEqualityComparison(PTI); // PredCondVal
787
788 if (PCV == CV && SafeToMergeTerminators(TI, PTI)) {
789 // Figure out which 'cases' to copy from SI to PSI.
Eric Christopherb65acc62012-07-02 23:22:21 +0000790 std::vector<ValueEqualityComparisonCase> BBCases;
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000791 BasicBlock *BBDefault = GetValueEqualityComparisonCases(TI, BBCases);
792
Eric Christopherb65acc62012-07-02 23:22:21 +0000793 std::vector<ValueEqualityComparisonCase> PredCases;
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000794 BasicBlock *PredDefault = GetValueEqualityComparisonCases(PTI, PredCases);
795
796 // Based on whether the default edge from PTI goes to BB or not, fill in
797 // PredCases and PredDefault with the new switch cases we would like to
798 // build.
Chris Lattner6b39cb92008-02-18 07:42:56 +0000799 SmallVector<BasicBlock*, 8> NewSuccessors;
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000800
Andrew Trick3051aa12012-08-29 21:46:38 +0000801 // Update the branch weight metadata along the way
802 SmallVector<uint64_t, 8> Weights;
Andrew Trick3051aa12012-08-29 21:46:38 +0000803 bool PredHasWeights = HasBranchWeights(PTI);
804 bool SuccHasWeights = HasBranchWeights(TI);
805
Manman Ren5e5049d2012-09-14 19:05:19 +0000806 if (PredHasWeights) {
Manman Ren571d9e42012-09-11 17:43:35 +0000807 GetBranchWeights(PTI, Weights);
Andrew Trick7656f6d2012-11-15 18:40:31 +0000808 // branch-weight metadata is inconsistent here.
Manman Ren5e5049d2012-09-14 19:05:19 +0000809 if (Weights.size() != 1 + PredCases.size())
810 PredHasWeights = SuccHasWeights = false;
811 } else if (SuccHasWeights)
Andrew Trick3051aa12012-08-29 21:46:38 +0000812 // If there are no predecessor weights but there are successor weights,
813 // populate Weights with 1, which will later be scaled to the sum of
814 // successor's weights
815 Weights.assign(1 + PredCases.size(), 1);
Andrew Trick3051aa12012-08-29 21:46:38 +0000816
Manman Ren571d9e42012-09-11 17:43:35 +0000817 SmallVector<uint64_t, 8> SuccWeights;
Manman Ren5e5049d2012-09-14 19:05:19 +0000818 if (SuccHasWeights) {
Manman Ren571d9e42012-09-11 17:43:35 +0000819 GetBranchWeights(TI, SuccWeights);
Andrew Trick7656f6d2012-11-15 18:40:31 +0000820 // branch-weight metadata is inconsistent here.
Manman Ren5e5049d2012-09-14 19:05:19 +0000821 if (SuccWeights.size() != 1 + BBCases.size())
822 PredHasWeights = SuccHasWeights = false;
823 } else if (PredHasWeights)
Manman Ren571d9e42012-09-11 17:43:35 +0000824 SuccWeights.assign(1 + BBCases.size(), 1);
Andrew Trick3051aa12012-08-29 21:46:38 +0000825
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000826 if (PredDefault == BB) {
827 // If this is the default destination from PTI, only the edges in TI
828 // that don't occur in PTI, or that branch to BB will be activated.
Eric Christopherb65acc62012-07-02 23:22:21 +0000829 std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
830 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
831 if (PredCases[i].Dest != BB)
832 PTIHandled.insert(PredCases[i].Value);
833 else {
834 // The default destination is BB, we don't need explicit targets.
835 std::swap(PredCases[i], PredCases.back());
Andrew Trick3051aa12012-08-29 21:46:38 +0000836
Manman Ren571d9e42012-09-11 17:43:35 +0000837 if (PredHasWeights || SuccHasWeights) {
838 // Increase weight for the default case.
839 Weights[0] += Weights[i+1];
Andrew Trick3051aa12012-08-29 21:46:38 +0000840 std::swap(Weights[i+1], Weights.back());
841 Weights.pop_back();
842 }
843
Eric Christopherb65acc62012-07-02 23:22:21 +0000844 PredCases.pop_back();
845 --i; --e;
846 }
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000847
Eric Christopherb65acc62012-07-02 23:22:21 +0000848 // Reconstruct the new switch statement we will be building.
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000849 if (PredDefault != BBDefault) {
850 PredDefault->removePredecessor(Pred);
851 PredDefault = BBDefault;
852 NewSuccessors.push_back(BBDefault);
853 }
Andrew Trick3051aa12012-08-29 21:46:38 +0000854
Manman Ren571d9e42012-09-11 17:43:35 +0000855 unsigned CasesFromPred = Weights.size();
856 uint64_t ValidTotalSuccWeight = 0;
Eric Christopherb65acc62012-07-02 23:22:21 +0000857 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
858 if (!PTIHandled.count(BBCases[i].Value) &&
859 BBCases[i].Dest != BBDefault) {
860 PredCases.push_back(BBCases[i]);
861 NewSuccessors.push_back(BBCases[i].Dest);
Manman Ren571d9e42012-09-11 17:43:35 +0000862 if (SuccHasWeights || PredHasWeights) {
863 // The default weight is at index 0, so weight for the ith case
864 // should be at index i+1. Scale the cases from successor by
865 // PredDefaultWeight (Weights[0]).
866 Weights.push_back(Weights[0] * SuccWeights[i+1]);
867 ValidTotalSuccWeight += SuccWeights[i+1];
Andrew Trick3051aa12012-08-29 21:46:38 +0000868 }
Eric Christopherb65acc62012-07-02 23:22:21 +0000869 }
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000870
Manman Ren571d9e42012-09-11 17:43:35 +0000871 if (SuccHasWeights || PredHasWeights) {
872 ValidTotalSuccWeight += SuccWeights[0];
873 // Scale the cases from predecessor by ValidTotalSuccWeight.
874 for (unsigned i = 1; i < CasesFromPred; ++i)
875 Weights[i] *= ValidTotalSuccWeight;
876 // Scale the default weight by SuccDefaultWeight (SuccWeights[0]).
877 Weights[0] *= SuccWeights[0];
878 }
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000879 } else {
880 // If this is not the default destination from PSI, only the edges
881 // in SI that occur in PSI with a destination of BB will be
882 // activated.
Eric Christopherb65acc62012-07-02 23:22:21 +0000883 std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
Manman Rend81b8e82012-09-14 17:29:56 +0000884 std::map<ConstantInt*, uint64_t> WeightsForHandled;
Eric Christopherb65acc62012-07-02 23:22:21 +0000885 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
886 if (PredCases[i].Dest == BB) {
887 PTIHandled.insert(PredCases[i].Value);
Manman Rend81b8e82012-09-14 17:29:56 +0000888
889 if (PredHasWeights || SuccHasWeights) {
890 WeightsForHandled[PredCases[i].Value] = Weights[i+1];
891 std::swap(Weights[i+1], Weights.back());
892 Weights.pop_back();
893 }
894
Eric Christopherb65acc62012-07-02 23:22:21 +0000895 std::swap(PredCases[i], PredCases.back());
896 PredCases.pop_back();
897 --i; --e;
898 }
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000899
900 // Okay, now we know which constants were sent to BB from the
901 // predecessor. Figure out where they will all go now.
Eric Christopherb65acc62012-07-02 23:22:21 +0000902 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
903 if (PTIHandled.count(BBCases[i].Value)) {
904 // If this is one we are capable of getting...
Manman Rend81b8e82012-09-14 17:29:56 +0000905 if (PredHasWeights || SuccHasWeights)
906 Weights.push_back(WeightsForHandled[BBCases[i].Value]);
Eric Christopherb65acc62012-07-02 23:22:21 +0000907 PredCases.push_back(BBCases[i]);
908 NewSuccessors.push_back(BBCases[i].Dest);
909 PTIHandled.erase(BBCases[i].Value);// This constant is taken care of
910 }
911
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000912 // If there are any constants vectored to BB that TI doesn't handle,
913 // they must go to the default destination of TI.
Andrew Trickf3cf1932012-08-29 21:46:36 +0000914 for (std::set<ConstantInt*, ConstantIntOrdering>::iterator I =
Eric Christopherb65acc62012-07-02 23:22:21 +0000915 PTIHandled.begin(),
916 E = PTIHandled.end(); I != E; ++I) {
Andrew Trick90f50292012-11-15 18:40:29 +0000917 if (PredHasWeights || SuccHasWeights)
918 Weights.push_back(WeightsForHandled[*I]);
Eric Christopherb65acc62012-07-02 23:22:21 +0000919 PredCases.push_back(ValueEqualityComparisonCase(*I, BBDefault));
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000920 NewSuccessors.push_back(BBDefault);
Eric Christopherb65acc62012-07-02 23:22:21 +0000921 }
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000922 }
923
924 // Okay, at this point, we know which new successor Pred will get. Make
925 // sure we update the number of entries in the PHI nodes for these
926 // successors.
927 for (unsigned i = 0, e = NewSuccessors.size(); i != e; ++i)
928 AddPredecessorToBlock(NewSuccessors[i], Pred, BB);
929
Devang Patel58380552011-05-18 20:53:17 +0000930 Builder.SetInsertPoint(PTI);
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000931 // Convert pointer to int before we switch.
Duncan Sands19d0b472010-02-16 11:11:14 +0000932 if (CV->getType()->isPointerTy()) {
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000933 assert(TD && "Cannot switch on pointer without DataLayout");
Matt Arsenaultfa646592013-10-21 18:55:08 +0000934 CV = Builder.CreatePtrToInt(CV, TD->getIntPtrType(CV->getType()),
Devang Patel58380552011-05-18 20:53:17 +0000935 "magicptr");
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000936 }
937
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000938 // Now that the successors are updated, create the new Switch instruction.
Devang Patel58380552011-05-18 20:53:17 +0000939 SwitchInst *NewSI = Builder.CreateSwitch(CV, PredDefault,
940 PredCases.size());
Devang Patelb849cd52011-05-17 23:29:05 +0000941 NewSI->setDebugLoc(PTI->getDebugLoc());
Eric Christopherb65acc62012-07-02 23:22:21 +0000942 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
943 NewSI->addCase(PredCases[i].Value, PredCases[i].Dest);
Chris Lattner3215bb62005-01-01 16:02:12 +0000944
Andrew Trick3051aa12012-08-29 21:46:38 +0000945 if (PredHasWeights || SuccHasWeights) {
946 // Halve the weights if any of them cannot fit in an uint32_t
947 FitWeights(Weights);
948
949 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
950
951 NewSI->setMetadata(LLVMContext::MD_prof,
952 MDBuilder(BB->getContext()).
953 createBranchWeights(MDWeights));
954 }
955
Eli Friedmancb61afb2008-12-16 20:54:32 +0000956 EraseTerminatorInstAndDCECond(PTI);
Chris Lattner3215bb62005-01-01 16:02:12 +0000957
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000958 // Okay, last check. If BB is still a successor of PSI, then we must
959 // have an infinite loop case. If so, add an infinitely looping block
960 // to handle the case to preserve the behavior of the code.
961 BasicBlock *InfLoopBlock = 0;
962 for (unsigned i = 0, e = NewSI->getNumSuccessors(); i != e; ++i)
963 if (NewSI->getSuccessor(i) == BB) {
964 if (InfLoopBlock == 0) {
Chris Lattner80b03a12008-07-13 22:23:11 +0000965 // Insert it at the end of the function, because it's either code,
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000966 // or it won't matter if it's hot. :)
Owen Anderson55f1c092009-08-13 21:58:54 +0000967 InfLoopBlock = BasicBlock::Create(BB->getContext(),
968 "infloop", BB->getParent());
Gabor Greife9ecc682008-04-06 20:25:17 +0000969 BranchInst::Create(InfLoopBlock, InfLoopBlock);
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000970 }
971 NewSI->setSuccessor(i, InfLoopBlock);
972 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000973
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000974 Changed = true;
975 }
976 }
977 return Changed;
978}
979
Dale Johannesen9df78ee2009-06-15 20:59:27 +0000980// isSafeToHoistInvoke - If we would need to insert a select that uses the
981// value of this invoke (comments in HoistThenElseCodeToIf explain why we
982// would need to do this), we can't hoist the invoke, as there is nowhere
983// to put the select in this case.
984static bool isSafeToHoistInvoke(BasicBlock *BB1, BasicBlock *BB2,
985 Instruction *I1, Instruction *I2) {
986 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
987 PHINode *PN;
988 for (BasicBlock::iterator BBI = SI->begin();
989 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
990 Value *BB1V = PN->getIncomingValueForBlock(BB1);
991 Value *BB2V = PN->getIncomingValueForBlock(BB2);
992 if (BB1V != BB2V && (BB1V==I1 || BB2V==I2)) {
993 return false;
994 }
995 }
996 }
997 return true;
998}
999
Chris Lattnerd683bdd2005-08-03 17:59:45 +00001000/// HoistThenElseCodeToIf - Given a conditional branch that goes to BB1 and
Chris Lattner389cfac2004-11-30 00:29:14 +00001001/// BB2, hoist any common code in the two blocks up into the branch block. The
1002/// caller of this function guarantees that BI's block dominates BB1 and BB2.
Rafael Espindola964602d2011-05-19 02:26:30 +00001003static bool HoistThenElseCodeToIf(BranchInst *BI) {
Chris Lattner389cfac2004-11-30 00:29:14 +00001004 // This does very trivial matching, with limited scanning, to find identical
1005 // instructions in the two blocks. In particular, we don't want to get into
1006 // O(M*N) situations here where M and N are the sizes of BB1 and BB2. As
1007 // such, we currently just scan for obviously identical instructions in an
1008 // identical order.
1009 BasicBlock *BB1 = BI->getSuccessor(0); // The true destination.
1010 BasicBlock *BB2 = BI->getSuccessor(1); // The false destination
1011
Devang Patelf10e2872009-02-04 00:03:08 +00001012 BasicBlock::iterator BB1_Itr = BB1->begin();
1013 BasicBlock::iterator BB2_Itr = BB2->begin();
1014
1015 Instruction *I1 = BB1_Itr++, *I2 = BB2_Itr++;
Devang Patel197c3522011-04-07 17:27:36 +00001016 // Skip debug info if it is not identical.
1017 DbgInfoIntrinsic *DBI1 = dyn_cast<DbgInfoIntrinsic>(I1);
1018 DbgInfoIntrinsic *DBI2 = dyn_cast<DbgInfoIntrinsic>(I2);
1019 if (!DBI1 || !DBI2 || !DBI1->isIdenticalToWhenDefined(DBI2)) {
1020 while (isa<DbgInfoIntrinsic>(I1))
1021 I1 = BB1_Itr++;
1022 while (isa<DbgInfoIntrinsic>(I2))
1023 I2 = BB2_Itr++;
1024 }
Devang Patele48ddf82011-04-07 00:30:15 +00001025 if (isa<PHINode>(I1) || !I1->isIdenticalToWhenDefined(I2) ||
Dale Johannesen9df78ee2009-06-15 20:59:27 +00001026 (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2)))
Chris Lattner389cfac2004-11-30 00:29:14 +00001027 return false;
1028
Chris Lattner389cfac2004-11-30 00:29:14 +00001029 BasicBlock *BIParent = BI->getParent();
Chris Lattner389cfac2004-11-30 00:29:14 +00001030
David Majnemerc82f27a2013-06-03 20:43:12 +00001031 bool Changed = false;
Chris Lattner389cfac2004-11-30 00:29:14 +00001032 do {
1033 // If we are hoisting the terminator instruction, don't move one (making a
1034 // broken BB), instead clone it, and remove BI.
1035 if (isa<TerminatorInst>(I1))
1036 goto HoistTerminator;
Misha Brukmanb1c93172005-04-21 23:48:37 +00001037
Chris Lattner389cfac2004-11-30 00:29:14 +00001038 // For a normal instruction, we just move one to right before the branch,
1039 // then replace all uses of the other with the first. Finally, we remove
1040 // the now redundant second instruction.
1041 BIParent->getInstList().splice(BI, BB1->getInstList(), I1);
1042 if (!I2->use_empty())
1043 I2->replaceAllUsesWith(I1);
Dan Gohmanc8a27f22009-08-25 22:11:20 +00001044 I1->intersectOptionalDataWith(I2);
Chris Lattnerd7beca32010-12-14 06:17:25 +00001045 I2->eraseFromParent();
David Majnemerc82f27a2013-06-03 20:43:12 +00001046 Changed = true;
Misha Brukmanb1c93172005-04-21 23:48:37 +00001047
Devang Patelf10e2872009-02-04 00:03:08 +00001048 I1 = BB1_Itr++;
Devang Patelf10e2872009-02-04 00:03:08 +00001049 I2 = BB2_Itr++;
Devang Patel197c3522011-04-07 17:27:36 +00001050 // Skip debug info if it is not identical.
1051 DbgInfoIntrinsic *DBI1 = dyn_cast<DbgInfoIntrinsic>(I1);
1052 DbgInfoIntrinsic *DBI2 = dyn_cast<DbgInfoIntrinsic>(I2);
1053 if (!DBI1 || !DBI2 || !DBI1->isIdenticalToWhenDefined(DBI2)) {
1054 while (isa<DbgInfoIntrinsic>(I1))
1055 I1 = BB1_Itr++;
1056 while (isa<DbgInfoIntrinsic>(I2))
1057 I2 = BB2_Itr++;
1058 }
Devang Patele48ddf82011-04-07 00:30:15 +00001059 } while (I1->isIdenticalToWhenDefined(I2));
Chris Lattner389cfac2004-11-30 00:29:14 +00001060
1061 return true;
1062
1063HoistTerminator:
Dale Johannesen9df78ee2009-06-15 20:59:27 +00001064 // It may not be possible to hoist an invoke.
1065 if (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2))
David Majnemerc82f27a2013-06-03 20:43:12 +00001066 return Changed;
1067
1068 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
1069 PHINode *PN;
1070 for (BasicBlock::iterator BBI = SI->begin();
1071 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
1072 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1073 Value *BB2V = PN->getIncomingValueForBlock(BB2);
1074 if (BB1V == BB2V)
1075 continue;
1076
1077 if (isa<ConstantExpr>(BB1V) && !isSafeToSpeculativelyExecute(BB1V))
1078 return Changed;
1079 if (isa<ConstantExpr>(BB2V) && !isSafeToSpeculativelyExecute(BB2V))
1080 return Changed;
1081 }
1082 }
Dale Johannesen9df78ee2009-06-15 20:59:27 +00001083
Chris Lattner389cfac2004-11-30 00:29:14 +00001084 // Okay, it is safe to hoist the terminator.
Nick Lewycky42fb7452009-09-27 07:38:41 +00001085 Instruction *NT = I1->clone();
Chris Lattner389cfac2004-11-30 00:29:14 +00001086 BIParent->getInstList().insert(BI, NT);
Benjamin Kramerccce8ba2010-01-05 13:12:22 +00001087 if (!NT->getType()->isVoidTy()) {
Chris Lattner389cfac2004-11-30 00:29:14 +00001088 I1->replaceAllUsesWith(NT);
1089 I2->replaceAllUsesWith(NT);
Chris Lattner8dd4cae2007-02-11 01:37:51 +00001090 NT->takeName(I1);
Chris Lattner389cfac2004-11-30 00:29:14 +00001091 }
1092
Devang Patel1407fb42011-05-19 20:52:46 +00001093 IRBuilder<true, NoFolder> Builder(NT);
Chris Lattner389cfac2004-11-30 00:29:14 +00001094 // Hoisting one of the terminators from our successor is a great thing.
1095 // Unfortunately, the successors of the if/else blocks may have PHI nodes in
1096 // them. If they do, all PHI entries for BB1/BB2 must agree for all PHI
1097 // nodes, so we insert select instruction to compute the final result.
1098 std::map<std::pair<Value*,Value*>, SelectInst*> InsertedSelects;
1099 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
1100 PHINode *PN;
1101 for (BasicBlock::iterator BBI = SI->begin();
Chris Lattner01944572004-11-30 07:47:34 +00001102 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
Chris Lattner389cfac2004-11-30 00:29:14 +00001103 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1104 Value *BB2V = PN->getIncomingValueForBlock(BB2);
Chris Lattner4088e2b2010-12-13 01:47:07 +00001105 if (BB1V == BB2V) continue;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001106
Chris Lattner4088e2b2010-12-13 01:47:07 +00001107 // These values do not agree. Insert a select instruction before NT
1108 // that determines the right value.
1109 SelectInst *&SI = InsertedSelects[std::make_pair(BB1V, BB2V)];
Andrew Trickf3cf1932012-08-29 21:46:36 +00001110 if (SI == 0)
Devang Patel1407fb42011-05-19 20:52:46 +00001111 SI = cast<SelectInst>
1112 (Builder.CreateSelect(BI->getCondition(), BB1V, BB2V,
1113 BB1V->getName()+"."+BB2V->getName()));
1114
Chris Lattner4088e2b2010-12-13 01:47:07 +00001115 // Make the PHI node use the select for all incoming values for BB1/BB2
1116 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1117 if (PN->getIncomingBlock(i) == BB1 || PN->getIncomingBlock(i) == BB2)
1118 PN->setIncomingValue(i, SI);
Chris Lattner389cfac2004-11-30 00:29:14 +00001119 }
1120 }
1121
1122 // Update any PHI nodes in our new successors.
1123 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI)
1124 AddPredecessorToBlock(*SI, BIParent, BB1);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001125
Eli Friedmancb61afb2008-12-16 20:54:32 +00001126 EraseTerminatorInstAndDCECond(BI);
Chris Lattner389cfac2004-11-30 00:29:14 +00001127 return true;
1128}
1129
Manman Ren93ab6492012-09-20 22:37:36 +00001130/// SinkThenElseCodeToEnd - Given an unconditional branch that goes to BBEnd,
1131/// check whether BBEnd has only two predecessors and the other predecessor
1132/// ends with an unconditional branch. If it is true, sink any common code
1133/// in the two predecessors to BBEnd.
1134static bool SinkThenElseCodeToEnd(BranchInst *BI1) {
1135 assert(BI1->isUnconditional());
1136 BasicBlock *BB1 = BI1->getParent();
1137 BasicBlock *BBEnd = BI1->getSuccessor(0);
1138
1139 // Check that BBEnd has two predecessors and the other predecessor ends with
1140 // an unconditional branch.
Benjamin Kramerf064b652012-09-30 21:03:56 +00001141 pred_iterator PI = pred_begin(BBEnd), PE = pred_end(BBEnd);
1142 BasicBlock *Pred0 = *PI++;
1143 if (PI == PE) // Only one predecessor.
Manman Ren93ab6492012-09-20 22:37:36 +00001144 return false;
Benjamin Kramerf064b652012-09-30 21:03:56 +00001145 BasicBlock *Pred1 = *PI++;
1146 if (PI != PE) // More than two predecessors.
1147 return false;
1148 BasicBlock *BB2 = (Pred0 == BB1) ? Pred1 : Pred0;
Manman Ren93ab6492012-09-20 22:37:36 +00001149 BranchInst *BI2 = dyn_cast<BranchInst>(BB2->getTerminator());
1150 if (!BI2 || !BI2->isUnconditional())
1151 return false;
1152
1153 // Gather the PHI nodes in BBEnd.
1154 std::map<Value*, std::pair<Value*, PHINode*> > MapValueFromBB1ToBB2;
1155 Instruction *FirstNonPhiInBBEnd = 0;
1156 for (BasicBlock::iterator I = BBEnd->begin(), E = BBEnd->end();
1157 I != E; ++I) {
1158 if (PHINode *PN = dyn_cast<PHINode>(I)) {
1159 Value *BB1V = PN->getIncomingValueForBlock(BB1);
Andrew Trick90f50292012-11-15 18:40:29 +00001160 Value *BB2V = PN->getIncomingValueForBlock(BB2);
Manman Ren93ab6492012-09-20 22:37:36 +00001161 MapValueFromBB1ToBB2[BB1V] = std::make_pair(BB2V, PN);
1162 } else {
1163 FirstNonPhiInBBEnd = &*I;
1164 break;
1165 }
1166 }
1167 if (!FirstNonPhiInBBEnd)
1168 return false;
Andrew Trick90f50292012-11-15 18:40:29 +00001169
Manman Ren93ab6492012-09-20 22:37:36 +00001170
1171 // This does very trivial matching, with limited scanning, to find identical
1172 // instructions in the two blocks. We scan backward for obviously identical
1173 // instructions in an identical order.
1174 BasicBlock::InstListType::reverse_iterator RI1 = BB1->getInstList().rbegin(),
1175 RE1 = BB1->getInstList().rend(), RI2 = BB2->getInstList().rbegin(),
1176 RE2 = BB2->getInstList().rend();
1177 // Skip debug info.
1178 while (RI1 != RE1 && isa<DbgInfoIntrinsic>(&*RI1)) ++RI1;
1179 if (RI1 == RE1)
1180 return false;
1181 while (RI2 != RE2 && isa<DbgInfoIntrinsic>(&*RI2)) ++RI2;
1182 if (RI2 == RE2)
1183 return false;
1184 // Skip the unconditional branches.
1185 ++RI1;
1186 ++RI2;
1187
1188 bool Changed = false;
1189 while (RI1 != RE1 && RI2 != RE2) {
1190 // Skip debug info.
1191 while (RI1 != RE1 && isa<DbgInfoIntrinsic>(&*RI1)) ++RI1;
1192 if (RI1 == RE1)
1193 return Changed;
1194 while (RI2 != RE2 && isa<DbgInfoIntrinsic>(&*RI2)) ++RI2;
1195 if (RI2 == RE2)
1196 return Changed;
1197
1198 Instruction *I1 = &*RI1, *I2 = &*RI2;
1199 // I1 and I2 should have a single use in the same PHI node, and they
1200 // perform the same operation.
1201 // Cannot move control-flow-involving, volatile loads, vaarg, etc.
1202 if (isa<PHINode>(I1) || isa<PHINode>(I2) ||
1203 isa<TerminatorInst>(I1) || isa<TerminatorInst>(I2) ||
1204 isa<LandingPadInst>(I1) || isa<LandingPadInst>(I2) ||
1205 isa<AllocaInst>(I1) || isa<AllocaInst>(I2) ||
1206 I1->mayHaveSideEffects() || I2->mayHaveSideEffects() ||
1207 I1->mayReadOrWriteMemory() || I2->mayReadOrWriteMemory() ||
1208 !I1->hasOneUse() || !I2->hasOneUse() ||
1209 MapValueFromBB1ToBB2.find(I1) == MapValueFromBB1ToBB2.end() ||
1210 MapValueFromBB1ToBB2[I1].first != I2)
1211 return Changed;
1212
1213 // Check whether we should swap the operands of ICmpInst.
1214 ICmpInst *ICmp1 = dyn_cast<ICmpInst>(I1), *ICmp2 = dyn_cast<ICmpInst>(I2);
1215 bool SwapOpnds = false;
1216 if (ICmp1 && ICmp2 &&
1217 ICmp1->getOperand(0) != ICmp2->getOperand(0) &&
1218 ICmp1->getOperand(1) != ICmp2->getOperand(1) &&
1219 (ICmp1->getOperand(0) == ICmp2->getOperand(1) ||
1220 ICmp1->getOperand(1) == ICmp2->getOperand(0))) {
1221 ICmp2->swapOperands();
1222 SwapOpnds = true;
1223 }
1224 if (!I1->isSameOperationAs(I2)) {
1225 if (SwapOpnds)
1226 ICmp2->swapOperands();
1227 return Changed;
1228 }
1229
1230 // The operands should be either the same or they need to be generated
1231 // with a PHI node after sinking. We only handle the case where there is
1232 // a single pair of different operands.
1233 Value *DifferentOp1 = 0, *DifferentOp2 = 0;
1234 unsigned Op1Idx = 0;
1235 for (unsigned I = 0, E = I1->getNumOperands(); I != E; ++I) {
1236 if (I1->getOperand(I) == I2->getOperand(I))
1237 continue;
1238 // Early exit if we have more-than one pair of different operands or
1239 // the different operand is already in MapValueFromBB1ToBB2.
1240 // Early exit if we need a PHI node to replace a constant.
1241 if (DifferentOp1 ||
1242 MapValueFromBB1ToBB2.find(I1->getOperand(I)) !=
1243 MapValueFromBB1ToBB2.end() ||
1244 isa<Constant>(I1->getOperand(I)) ||
1245 isa<Constant>(I2->getOperand(I))) {
1246 // If we can't sink the instructions, undo the swapping.
1247 if (SwapOpnds)
1248 ICmp2->swapOperands();
1249 return Changed;
1250 }
1251 DifferentOp1 = I1->getOperand(I);
1252 Op1Idx = I;
1253 DifferentOp2 = I2->getOperand(I);
1254 }
1255
1256 // We insert the pair of different operands to MapValueFromBB1ToBB2 and
1257 // remove (I1, I2) from MapValueFromBB1ToBB2.
1258 if (DifferentOp1) {
1259 PHINode *NewPN = PHINode::Create(DifferentOp1->getType(), 2,
1260 DifferentOp1->getName() + ".sink",
1261 BBEnd->begin());
1262 MapValueFromBB1ToBB2[DifferentOp1] = std::make_pair(DifferentOp2, NewPN);
1263 // I1 should use NewPN instead of DifferentOp1.
1264 I1->setOperand(Op1Idx, NewPN);
1265 NewPN->addIncoming(DifferentOp1, BB1);
1266 NewPN->addIncoming(DifferentOp2, BB2);
1267 DEBUG(dbgs() << "Create PHI node " << *NewPN << "\n";);
1268 }
1269 PHINode *OldPN = MapValueFromBB1ToBB2[I1].second;
1270 MapValueFromBB1ToBB2.erase(I1);
1271
1272 DEBUG(dbgs() << "SINK common instructions " << *I1 << "\n";);
1273 DEBUG(dbgs() << " " << *I2 << "\n";);
1274 // We need to update RE1 and RE2 if we are going to sink the first
1275 // instruction in the basic block down.
1276 bool UpdateRE1 = (I1 == BB1->begin()), UpdateRE2 = (I2 == BB2->begin());
1277 // Sink the instruction.
1278 BBEnd->getInstList().splice(FirstNonPhiInBBEnd, BB1->getInstList(), I1);
1279 if (!OldPN->use_empty())
1280 OldPN->replaceAllUsesWith(I1);
1281 OldPN->eraseFromParent();
1282
1283 if (!I2->use_empty())
1284 I2->replaceAllUsesWith(I1);
1285 I1->intersectOptionalDataWith(I2);
1286 I2->eraseFromParent();
1287
1288 if (UpdateRE1)
1289 RE1 = BB1->getInstList().rend();
1290 if (UpdateRE2)
1291 RE2 = BB2->getInstList().rend();
1292 FirstNonPhiInBBEnd = I1;
1293 NumSinkCommons++;
1294 Changed = true;
1295 }
1296 return Changed;
1297}
1298
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001299/// \brief Determine if we can hoist sink a sole store instruction out of a
1300/// conditional block.
1301///
1302/// We are looking for code like the following:
1303/// BrBB:
1304/// store i32 %add, i32* %arrayidx2
1305/// ... // No other stores or function calls (we could be calling a memory
1306/// ... // function).
1307/// %cmp = icmp ult %x, %y
1308/// br i1 %cmp, label %EndBB, label %ThenBB
1309/// ThenBB:
1310/// store i32 %add5, i32* %arrayidx2
1311/// br label EndBB
1312/// EndBB:
1313/// ...
1314/// We are going to transform this into:
1315/// BrBB:
1316/// store i32 %add, i32* %arrayidx2
1317/// ... //
1318/// %cmp = icmp ult %x, %y
1319/// %add.add5 = select i1 %cmp, i32 %add, %add5
1320/// store i32 %add.add5, i32* %arrayidx2
1321/// ...
1322///
1323/// \return The pointer to the value of the previous store if the store can be
1324/// hoisted into the predecessor block. 0 otherwise.
Benjamin Kramerad5c24f2013-05-23 16:09:15 +00001325static Value *isSafeToSpeculateStore(Instruction *I, BasicBlock *BrBB,
1326 BasicBlock *StoreBB, BasicBlock *EndBB) {
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001327 StoreInst *StoreToHoist = dyn_cast<StoreInst>(I);
1328 if (!StoreToHoist)
1329 return 0;
1330
1331 // Volatile or atomic.
1332 if (!StoreToHoist->isSimple())
1333 return 0;
1334
1335 Value *StorePtr = StoreToHoist->getPointerOperand();
1336
1337 // Look for a store to the same pointer in BrBB.
1338 unsigned MaxNumInstToLookAt = 10;
1339 for (BasicBlock::reverse_iterator RI = BrBB->rbegin(),
1340 RE = BrBB->rend(); RI != RE && (--MaxNumInstToLookAt); ++RI) {
1341 Instruction *CurI = &*RI;
1342
1343 // Could be calling an instruction that effects memory like free().
1344 if (CurI->mayHaveSideEffects() && !isa<StoreInst>(CurI))
1345 return 0;
1346
1347 StoreInst *SI = dyn_cast<StoreInst>(CurI);
1348 // Found the previous store make sure it stores to the same location.
1349 if (SI && SI->getPointerOperand() == StorePtr)
1350 // Found the previous store, return its value operand.
1351 return SI->getValueOperand();
1352 else if (SI)
1353 return 0; // Unknown store.
1354 }
1355
1356 return 0;
1357}
1358
Chandler Carruth8a4a1662013-01-24 08:05:06 +00001359/// \brief Speculate a conditional basic block flattening the CFG.
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001360///
Chandler Carruth8a4a1662013-01-24 08:05:06 +00001361/// Note that this is a very risky transform currently. Speculating
1362/// instructions like this is most often not desirable. Instead, there is an MI
1363/// pass which can do it with full awareness of the resource constraints.
1364/// However, some cases are "obvious" and we should do directly. An example of
1365/// this is speculating a single, reasonably cheap instruction.
1366///
1367/// There is only one distinct advantage to flattening the CFG at the IR level:
1368/// it makes very common but simplistic optimizations such as are common in
1369/// instcombine and the DAG combiner more powerful by removing CFG edges and
1370/// modeling their effects with easier to reason about SSA value graphs.
1371///
1372///
1373/// An illustration of this transform is turning this IR:
1374/// \code
1375/// BB:
1376/// %cmp = icmp ult %x, %y
1377/// br i1 %cmp, label %EndBB, label %ThenBB
1378/// ThenBB:
1379/// %sub = sub %x, %y
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001380/// br label BB2
Chandler Carruth8a4a1662013-01-24 08:05:06 +00001381/// EndBB:
1382/// %phi = phi [ %sub, %ThenBB ], [ 0, %EndBB ]
1383/// ...
1384/// \endcode
1385///
1386/// Into this IR:
1387/// \code
1388/// BB:
1389/// %cmp = icmp ult %x, %y
1390/// %sub = sub %x, %y
1391/// %cond = select i1 %cmp, 0, %sub
1392/// ...
1393/// \endcode
1394///
1395/// \returns true if the conditional block is removed.
Chandler Carruth329b5902013-01-27 06:42:03 +00001396static bool SpeculativelyExecuteBB(BranchInst *BI, BasicBlock *ThenBB) {
Chandler Carruth1d20c022013-01-24 08:22:40 +00001397 // Be conservative for now. FP select instruction can often be expensive.
1398 Value *BrCond = BI->getCondition();
1399 if (isa<FCmpInst>(BrCond))
1400 return false;
1401
Chandler Carruthe2a779f2013-01-24 09:59:39 +00001402 BasicBlock *BB = BI->getParent();
1403 BasicBlock *EndBB = ThenBB->getTerminator()->getSuccessor(0);
1404
1405 // If ThenBB is actually on the false edge of the conditional branch, remember
1406 // to swap the select operands later.
1407 bool Invert = false;
1408 if (ThenBB != BI->getSuccessor(0)) {
1409 assert(ThenBB == BI->getSuccessor(1) && "No edge from 'if' block?");
1410 Invert = true;
1411 }
1412 assert(EndBB == BI->getSuccessor(!Invert) && "No edge from to end block");
1413
Chandler Carruthceff2222013-01-25 05:40:09 +00001414 // Keep a count of how many times instructions are used within CondBB when
1415 // they are candidates for sinking into CondBB. Specifically:
1416 // - They are defined in BB, and
1417 // - They have no side effects, and
1418 // - All of their uses are in CondBB.
1419 SmallDenseMap<Instruction *, unsigned, 4> SinkCandidateUseCounts;
1420
Chandler Carruth7481ca82013-01-24 11:52:58 +00001421 unsigned SpeculationCost = 0;
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001422 Value *SpeculatedStoreValue = 0;
1423 StoreInst *SpeculatedStore = 0;
Chandler Carruth7481ca82013-01-24 11:52:58 +00001424 for (BasicBlock::iterator BBI = ThenBB->begin(),
1425 BBE = llvm::prior(ThenBB->end());
Devang Patel5aed7762009-03-06 06:00:17 +00001426 BBI != BBE; ++BBI) {
1427 Instruction *I = BBI;
1428 // Skip debug info.
Chandler Carruth7481ca82013-01-24 11:52:58 +00001429 if (isa<DbgInfoIntrinsic>(I))
1430 continue;
Devang Patel5aed7762009-03-06 06:00:17 +00001431
Chandler Carruth7481ca82013-01-24 11:52:58 +00001432 // Only speculatively execution a single instruction (not counting the
1433 // terminator) for now.
Chandler Carruth329b5902013-01-27 06:42:03 +00001434 ++SpeculationCost;
1435 if (SpeculationCost > 1)
Devang Patel5aed7762009-03-06 06:00:17 +00001436 return false;
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001437
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001438 // Don't hoist the instruction if it's unsafe or expensive.
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001439 if (!isSafeToSpeculativelyExecute(I) &&
1440 !(HoistCondStores &&
1441 (SpeculatedStoreValue = isSafeToSpeculateStore(I, BB, ThenBB,
1442 EndBB))))
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001443 return false;
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001444 if (!SpeculatedStoreValue &&
1445 ComputeSpeculationCost(I) > PHINodeFoldingThreshold)
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001446 return false;
1447
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001448 // Store the store speculation candidate.
1449 if (SpeculatedStoreValue)
1450 SpeculatedStore = cast<StoreInst>(I);
1451
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001452 // Do not hoist the instruction if any of its operands are defined but not
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001453 // used in BB. The transformation will prevent the operand from
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001454 // being sunk into the use block.
Chandler Carruth7481ca82013-01-24 11:52:58 +00001455 for (User::op_iterator i = I->op_begin(), e = I->op_end();
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001456 i != e; ++i) {
1457 Instruction *OpI = dyn_cast<Instruction>(*i);
Chandler Carruthceff2222013-01-25 05:40:09 +00001458 if (!OpI || OpI->getParent() != BB ||
1459 OpI->mayHaveSideEffects())
1460 continue; // Not a candidate for sinking.
1461
1462 ++SinkCandidateUseCounts[OpI];
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001463 }
1464 }
Evan Cheng89200c92008-06-07 08:52:29 +00001465
Chandler Carruthceff2222013-01-25 05:40:09 +00001466 // Consider any sink candidates which are only used in CondBB as costs for
1467 // speculation. Note, while we iterate over a DenseMap here, we are summing
1468 // and so iteration order isn't significant.
1469 for (SmallDenseMap<Instruction *, unsigned, 4>::iterator I =
1470 SinkCandidateUseCounts.begin(), E = SinkCandidateUseCounts.end();
1471 I != E; ++I)
1472 if (I->first->getNumUses() == I->second) {
Chandler Carruth329b5902013-01-27 06:42:03 +00001473 ++SpeculationCost;
1474 if (SpeculationCost > 1)
Chandler Carruthceff2222013-01-25 05:40:09 +00001475 return false;
1476 }
1477
Chandler Carruth76aacbd2013-01-24 10:40:51 +00001478 // Check that the PHI nodes can be converted to selects.
1479 bool HaveRewritablePHIs = false;
Chandler Carruthe2a779f2013-01-24 09:59:39 +00001480 for (BasicBlock::iterator I = EndBB->begin();
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001481 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
Chandler Carruthe2a779f2013-01-24 09:59:39 +00001482 Value *OrigV = PN->getIncomingValueForBlock(BB);
1483 Value *ThenV = PN->getIncomingValueForBlock(ThenBB);
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001484
Rafael Espindolaa5e536a2013-06-04 14:11:59 +00001485 // FIXME: Try to remove some of the duplication with HoistThenElseCodeToIf.
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001486 // Skip PHIs which are trivial.
Chandler Carruthe2a779f2013-01-24 09:59:39 +00001487 if (ThenV == OrigV)
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001488 continue;
1489
Chandler Carruth76aacbd2013-01-24 10:40:51 +00001490 HaveRewritablePHIs = true;
Rafael Espindolaa5e536a2013-06-04 14:11:59 +00001491 ConstantExpr *OrigCE = dyn_cast<ConstantExpr>(OrigV);
1492 ConstantExpr *ThenCE = dyn_cast<ConstantExpr>(ThenV);
1493 if (!OrigCE && !ThenCE)
Chandler Carruth8a210052013-01-24 11:53:01 +00001494 continue; // Known safe and cheap.
1495
Rafael Espindolaa5e536a2013-06-04 14:11:59 +00001496 if ((ThenCE && !isSafeToSpeculativelyExecute(ThenCE)) ||
1497 (OrigCE && !isSafeToSpeculativelyExecute(OrigCE)))
Chandler Carruth8a210052013-01-24 11:53:01 +00001498 return false;
Rafael Espindolaa5e536a2013-06-04 14:11:59 +00001499 unsigned OrigCost = OrigCE ? ComputeSpeculationCost(OrigCE) : 0;
1500 unsigned ThenCost = ThenCE ? ComputeSpeculationCost(ThenCE) : 0;
1501 if (OrigCost + ThenCost > 2 * PHINodeFoldingThreshold)
Chandler Carruth8a210052013-01-24 11:53:01 +00001502 return false;
Chandler Carruth76aacbd2013-01-24 10:40:51 +00001503
Chandler Carruth01bffaa2013-01-24 12:05:17 +00001504 // Account for the cost of an unfolded ConstantExpr which could end up
1505 // getting expanded into Instructions.
1506 // FIXME: This doesn't account for how many operations are combined in the
Chandler Carruth329b5902013-01-27 06:42:03 +00001507 // constant expression.
1508 ++SpeculationCost;
1509 if (SpeculationCost > 1)
Chandler Carruth76aacbd2013-01-24 10:40:51 +00001510 return false;
Evan Cheng89200c92008-06-07 08:52:29 +00001511 }
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001512
1513 // If there are no PHIs to process, bail early. This helps ensure idempotence
1514 // as well.
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001515 if (!HaveRewritablePHIs && !(HoistCondStores && SpeculatedStoreValue))
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001516 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001517
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001518 // If we get here, we can hoist the instruction and if-convert.
Chandler Carruthe2a779f2013-01-24 09:59:39 +00001519 DEBUG(dbgs() << "SPECULATIVELY EXECUTING BB" << *ThenBB << "\n";);
Evan Cheng89200c92008-06-07 08:52:29 +00001520
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001521 // Insert a select of the value of the speculated store.
1522 if (SpeculatedStoreValue) {
1523 IRBuilder<true, NoFolder> Builder(BI);
1524 Value *TrueV = SpeculatedStore->getValueOperand();
1525 Value *FalseV = SpeculatedStoreValue;
1526 if (Invert)
1527 std::swap(TrueV, FalseV);
1528 Value *S = Builder.CreateSelect(BrCond, TrueV, FalseV, TrueV->getName() +
1529 "." + FalseV->getName());
1530 SpeculatedStore->setOperand(0, S);
1531 }
1532
Chandler Carruth7481ca82013-01-24 11:52:58 +00001533 // Hoist the instructions.
1534 BB->getInstList().splice(BI, ThenBB->getInstList(), ThenBB->begin(),
1535 llvm::prior(ThenBB->end()));
Evan Cheng89553cc2008-06-12 21:15:59 +00001536
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001537 // Insert selects and rewrite the PHI operands.
Devang Patel1407fb42011-05-19 20:52:46 +00001538 IRBuilder<true, NoFolder> Builder(BI);
Chandler Carruth76aacbd2013-01-24 10:40:51 +00001539 for (BasicBlock::iterator I = EndBB->begin();
1540 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
1541 unsigned OrigI = PN->getBasicBlockIndex(BB);
1542 unsigned ThenI = PN->getBasicBlockIndex(ThenBB);
1543 Value *OrigV = PN->getIncomingValue(OrigI);
1544 Value *ThenV = PN->getIncomingValue(ThenI);
1545
1546 // Skip PHIs which are trivial.
1547 if (OrigV == ThenV)
1548 continue;
Evan Cheng89200c92008-06-07 08:52:29 +00001549
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001550 // Create a select whose true value is the speculatively executed value and
Chandler Carruth76aacbd2013-01-24 10:40:51 +00001551 // false value is the preexisting value. Swap them if the branch
1552 // destinations were inverted.
1553 Value *TrueV = ThenV, *FalseV = OrigV;
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001554 if (Invert)
Chandler Carruth76aacbd2013-01-24 10:40:51 +00001555 std::swap(TrueV, FalseV);
1556 Value *V = Builder.CreateSelect(BrCond, TrueV, FalseV,
1557 TrueV->getName() + "." + FalseV->getName());
1558 PN->setIncomingValue(OrigI, V);
1559 PN->setIncomingValue(ThenI, V);
Evan Cheng89200c92008-06-07 08:52:29 +00001560 }
1561
Evan Cheng89553cc2008-06-12 21:15:59 +00001562 ++NumSpeculations;
Evan Cheng89200c92008-06-07 08:52:29 +00001563 return true;
1564}
1565
Tom Stellarde1631dd2013-10-21 20:07:30 +00001566/// \returns True if this block contains a CallInst with the NoDuplicate
1567/// attribute.
1568static bool HasNoDuplicateCall(const BasicBlock *BB) {
1569 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
1570 const CallInst *CI = dyn_cast<CallInst>(I);
1571 if (!CI)
1572 continue;
1573 if (CI->cannotDuplicate())
1574 return true;
1575 }
1576 return false;
1577}
1578
Chris Lattnerf0bd8d02005-09-20 00:43:16 +00001579/// BlockIsSimpleEnoughToThreadThrough - Return true if we can thread a branch
1580/// across this block.
1581static bool BlockIsSimpleEnoughToThreadThrough(BasicBlock *BB) {
1582 BranchInst *BI = cast<BranchInst>(BB->getTerminator());
Chris Lattner6c701062005-09-20 01:48:40 +00001583 unsigned Size = 0;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001584
Devang Patel84fceff2009-03-10 18:00:05 +00001585 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
Dale Johannesened6f5a82009-03-12 23:18:09 +00001586 if (isa<DbgInfoIntrinsic>(BBI))
1587 continue;
Chris Lattner6c701062005-09-20 01:48:40 +00001588 if (Size > 10) return false; // Don't clone large BB's.
Dale Johannesened6f5a82009-03-12 23:18:09 +00001589 ++Size;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001590
Dale Johannesened6f5a82009-03-12 23:18:09 +00001591 // We can only support instructions that do not define values that are
Chris Lattner6c701062005-09-20 01:48:40 +00001592 // live outside of the current basic block.
1593 for (Value::use_iterator UI = BBI->use_begin(), E = BBI->use_end();
1594 UI != E; ++UI) {
1595 Instruction *U = cast<Instruction>(*UI);
1596 if (U->getParent() != BB || isa<PHINode>(U)) return false;
1597 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00001598
Chris Lattnerf0bd8d02005-09-20 00:43:16 +00001599 // Looks ok, continue checking.
1600 }
Chris Lattner6c701062005-09-20 01:48:40 +00001601
Chris Lattnerf0bd8d02005-09-20 00:43:16 +00001602 return true;
1603}
1604
Chris Lattner748f9032005-09-19 23:49:37 +00001605/// FoldCondBranchOnPHI - If we have a conditional branch on a PHI node value
1606/// that is defined in the same block as the branch and if any PHI entries are
1607/// constants, thread edges corresponding to that entry to be branches to their
1608/// ultimate destination.
Micah Villmowcdfe20b2012-10-08 16:38:25 +00001609static bool FoldCondBranchOnPHI(BranchInst *BI, const DataLayout *TD) {
Chris Lattner748f9032005-09-19 23:49:37 +00001610 BasicBlock *BB = BI->getParent();
1611 PHINode *PN = dyn_cast<PHINode>(BI->getCondition());
Chris Lattner049cb442005-09-19 23:57:04 +00001612 // NOTE: we currently cannot transform this case if the PHI node is used
1613 // outside of the block.
Chris Lattnerf0bd8d02005-09-20 00:43:16 +00001614 if (!PN || PN->getParent() != BB || !PN->hasOneUse())
1615 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001616
Chris Lattner748f9032005-09-19 23:49:37 +00001617 // Degenerate case of a single entry PHI.
1618 if (PN->getNumIncomingValues() == 1) {
Chris Lattnerdc3f6f22008-12-03 19:44:02 +00001619 FoldSingleEntryPHINodes(PN->getParent());
Andrew Trickf3cf1932012-08-29 21:46:36 +00001620 return true;
Chris Lattner748f9032005-09-19 23:49:37 +00001621 }
1622
1623 // Now we know that this block has multiple preds and two succs.
Chris Lattnerf0bd8d02005-09-20 00:43:16 +00001624 if (!BlockIsSimpleEnoughToThreadThrough(BB)) return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001625
Tom Stellarde1631dd2013-10-21 20:07:30 +00001626 if (HasNoDuplicateCall(BB)) return false;
1627
Chris Lattner748f9032005-09-19 23:49:37 +00001628 // Okay, this is a simple enough basic block. See if any phi values are
1629 // constants.
Zhou Sheng75b871f2007-01-11 12:24:14 +00001630 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
Chris Lattner4088e2b2010-12-13 01:47:07 +00001631 ConstantInt *CB = dyn_cast<ConstantInt>(PN->getIncomingValue(i));
1632 if (CB == 0 || !CB->getType()->isIntegerTy(1)) continue;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001633
Chris Lattner4088e2b2010-12-13 01:47:07 +00001634 // Okay, we now know that all edges from PredBB should be revectored to
1635 // branch to RealDest.
1636 BasicBlock *PredBB = PN->getIncomingBlock(i);
1637 BasicBlock *RealDest = BI->getSuccessor(!CB->getZExtValue());
Andrew Trickf3cf1932012-08-29 21:46:36 +00001638
Chris Lattner4088e2b2010-12-13 01:47:07 +00001639 if (RealDest == BB) continue; // Skip self loops.
Bill Wendling4f163df2011-06-04 09:42:04 +00001640 // Skip if the predecessor's terminator is an indirect branch.
1641 if (isa<IndirectBrInst>(PredBB->getTerminator())) continue;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001642
Chris Lattner4088e2b2010-12-13 01:47:07 +00001643 // The dest block might have PHI nodes, other predecessors and other
1644 // difficult cases. Instead of being smart about this, just insert a new
1645 // block that jumps to the destination block, effectively splitting
1646 // the edge we are about to create.
1647 BasicBlock *EdgeBB = BasicBlock::Create(BB->getContext(),
1648 RealDest->getName()+".critedge",
1649 RealDest->getParent(), RealDest);
1650 BranchInst::Create(RealDest, EdgeBB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00001651
Chris Lattner0f4d67b2010-12-14 07:09:42 +00001652 // Update PHI nodes.
1653 AddPredecessorToBlock(RealDest, EdgeBB, BB);
Chris Lattner4088e2b2010-12-13 01:47:07 +00001654
1655 // BB may have instructions that are being threaded over. Clone these
1656 // instructions into EdgeBB. We know that there will be no uses of the
1657 // cloned instructions outside of EdgeBB.
1658 BasicBlock::iterator InsertPt = EdgeBB->begin();
1659 DenseMap<Value*, Value*> TranslateMap; // Track translated values.
1660 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
1661 if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
1662 TranslateMap[PN] = PN->getIncomingValueForBlock(PredBB);
1663 continue;
1664 }
1665 // Clone the instruction.
1666 Instruction *N = BBI->clone();
1667 if (BBI->hasName()) N->setName(BBI->getName()+".c");
Andrew Trickf3cf1932012-08-29 21:46:36 +00001668
Chris Lattner4088e2b2010-12-13 01:47:07 +00001669 // Update operands due to translation.
1670 for (User::op_iterator i = N->op_begin(), e = N->op_end();
1671 i != e; ++i) {
1672 DenseMap<Value*, Value*>::iterator PI = TranslateMap.find(*i);
1673 if (PI != TranslateMap.end())
1674 *i = PI->second;
1675 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00001676
Chris Lattner4088e2b2010-12-13 01:47:07 +00001677 // Check for trivial simplification.
Chris Lattnerd7beca32010-12-14 06:17:25 +00001678 if (Value *V = SimplifyInstruction(N, TD)) {
1679 TranslateMap[BBI] = V;
1680 delete N; // Instruction folded away, don't need actual inst
Chris Lattner4088e2b2010-12-13 01:47:07 +00001681 } else {
1682 // Insert the new instruction into its new home.
1683 EdgeBB->getInstList().insert(InsertPt, N);
1684 if (!BBI->use_empty())
1685 TranslateMap[BBI] = N;
1686 }
1687 }
1688
1689 // Loop over all of the edges from PredBB to BB, changing them to branch
1690 // to EdgeBB instead.
1691 TerminatorInst *PredBBTI = PredBB->getTerminator();
1692 for (unsigned i = 0, e = PredBBTI->getNumSuccessors(); i != e; ++i)
1693 if (PredBBTI->getSuccessor(i) == BB) {
1694 BB->removePredecessor(PredBB);
1695 PredBBTI->setSuccessor(i, EdgeBB);
1696 }
Bill Wendling4f163df2011-06-04 09:42:04 +00001697
Chris Lattner4088e2b2010-12-13 01:47:07 +00001698 // Recurse, simplifying any other constants.
Chris Lattnerd7beca32010-12-14 06:17:25 +00001699 return FoldCondBranchOnPHI(BI, TD) | true;
Zhou Sheng75b871f2007-01-11 12:24:14 +00001700 }
Chris Lattner748f9032005-09-19 23:49:37 +00001701
1702 return false;
1703}
1704
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001705/// FoldTwoEntryPHINode - Given a BB that starts with the specified two-entry
1706/// PHI node, see if we can eliminate it.
Micah Villmowcdfe20b2012-10-08 16:38:25 +00001707static bool FoldTwoEntryPHINode(PHINode *PN, const DataLayout *TD) {
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001708 // Ok, this is a two entry PHI node. Check to see if this is a simple "if
1709 // statement", which has a very simple dominance structure. Basically, we
1710 // are trying to find the condition that is being branched on, which
1711 // subsequently causes this merge to happen. We really want control
1712 // dependence information for this check, but simplifycfg can't keep it up
1713 // to date, and this catches most of the cases we care about anyway.
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001714 BasicBlock *BB = PN->getParent();
1715 BasicBlock *IfTrue, *IfFalse;
1716 Value *IfCond = GetIfCondition(BB, IfTrue, IfFalse);
Chris Lattner335f0e42010-12-14 08:01:53 +00001717 if (!IfCond ||
1718 // Don't bother if the branch will be constant folded trivially.
1719 isa<ConstantInt>(IfCond))
1720 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001721
Chris Lattner95adf8f12006-11-18 19:19:36 +00001722 // Okay, we found that we can merge this two-entry phi node into a select.
1723 // Doing so would require us to fold *all* two entry phi nodes in this block.
1724 // At some point this becomes non-profitable (particularly if the target
1725 // doesn't support cmov's). Only do this transformation if there are two or
1726 // fewer PHI nodes in this block.
1727 unsigned NumPhis = 0;
1728 for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I); ++NumPhis, ++I)
1729 if (NumPhis > 2)
1730 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001731
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001732 // Loop over the PHI's seeing if we can promote them all to select
1733 // instructions. While we are at it, keep track of the instructions
1734 // that need to be moved to the dominating block.
Chris Lattner9ac168d2010-12-14 07:41:39 +00001735 SmallPtrSet<Instruction*, 4> AggressiveInsts;
Peter Collingbourne616044a2011-04-29 18:47:38 +00001736 unsigned MaxCostVal0 = PHINodeFoldingThreshold,
1737 MaxCostVal1 = PHINodeFoldingThreshold;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001738
Chris Lattner7499b452010-12-14 08:46:09 +00001739 for (BasicBlock::iterator II = BB->begin(); isa<PHINode>(II);) {
1740 PHINode *PN = cast<PHINode>(II++);
Chris Lattnerb42d2932010-12-14 07:20:29 +00001741 if (Value *V = SimplifyInstruction(PN, TD)) {
1742 PN->replaceAllUsesWith(V);
Chris Lattner7499b452010-12-14 08:46:09 +00001743 PN->eraseFromParent();
Chris Lattnerb42d2932010-12-14 07:20:29 +00001744 continue;
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001745 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00001746
Peter Collingbournee3511e12011-04-29 18:47:31 +00001747 if (!DominatesMergePoint(PN->getIncomingValue(0), BB, &AggressiveInsts,
1748 MaxCostVal0) ||
1749 !DominatesMergePoint(PN->getIncomingValue(1), BB, &AggressiveInsts,
1750 MaxCostVal1))
Chris Lattnerb42d2932010-12-14 07:20:29 +00001751 return false;
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001752 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00001753
Sylvestre Ledru35521e22012-07-23 08:51:15 +00001754 // If we folded the first phi, PN dangles at this point. Refresh it. If
Chris Lattner9ac168d2010-12-14 07:41:39 +00001755 // we ran out of PHIs then we simplified them all.
1756 PN = dyn_cast<PHINode>(BB->begin());
1757 if (PN == 0) return true;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001758
Chris Lattner7499b452010-12-14 08:46:09 +00001759 // Don't fold i1 branches on PHIs which contain binary operators. These can
1760 // often be turned into switches and other things.
1761 if (PN->getType()->isIntegerTy(1) &&
1762 (isa<BinaryOperator>(PN->getIncomingValue(0)) ||
1763 isa<BinaryOperator>(PN->getIncomingValue(1)) ||
1764 isa<BinaryOperator>(IfCond)))
1765 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001766
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001767 // If we all PHI nodes are promotable, check to make sure that all
1768 // instructions in the predecessor blocks can be promoted as well. If
1769 // not, we won't be able to get rid of the control flow, so it's not
1770 // worth promoting to select instructions.
Chris Lattner9ac168d2010-12-14 07:41:39 +00001771 BasicBlock *DomBlock = 0;
1772 BasicBlock *IfBlock1 = PN->getIncomingBlock(0);
1773 BasicBlock *IfBlock2 = PN->getIncomingBlock(1);
1774 if (cast<BranchInst>(IfBlock1->getTerminator())->isConditional()) {
1775 IfBlock1 = 0;
1776 } else {
1777 DomBlock = *pred_begin(IfBlock1);
1778 for (BasicBlock::iterator I = IfBlock1->begin();!isa<TerminatorInst>(I);++I)
Devang Patel2032cad2009-02-03 22:12:02 +00001779 if (!AggressiveInsts.count(I) && !isa<DbgInfoIntrinsic>(I)) {
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001780 // This is not an aggressive instruction that we can promote.
1781 // Because of this, we won't be able to get rid of the control
1782 // flow, so the xform is not worth it.
1783 return false;
1784 }
1785 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00001786
Chris Lattner9ac168d2010-12-14 07:41:39 +00001787 if (cast<BranchInst>(IfBlock2->getTerminator())->isConditional()) {
1788 IfBlock2 = 0;
1789 } else {
1790 DomBlock = *pred_begin(IfBlock2);
1791 for (BasicBlock::iterator I = IfBlock2->begin();!isa<TerminatorInst>(I);++I)
Devang Patel2032cad2009-02-03 22:12:02 +00001792 if (!AggressiveInsts.count(I) && !isa<DbgInfoIntrinsic>(I)) {
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001793 // This is not an aggressive instruction that we can promote.
1794 // Because of this, we won't be able to get rid of the control
1795 // flow, so the xform is not worth it.
1796 return false;
1797 }
1798 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00001799
Chris Lattner9fd838d2010-12-14 07:23:10 +00001800 DEBUG(dbgs() << "FOUND IF CONDITION! " << *IfCond << " T: "
Chris Lattner9ac168d2010-12-14 07:41:39 +00001801 << IfTrue->getName() << " F: " << IfFalse->getName() << "\n");
Andrew Trickf3cf1932012-08-29 21:46:36 +00001802
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001803 // If we can still promote the PHI nodes after this gauntlet of tests,
1804 // do all of the PHI's now.
Chris Lattner7499b452010-12-14 08:46:09 +00001805 Instruction *InsertPt = DomBlock->getTerminator();
Devang Patel1407fb42011-05-19 20:52:46 +00001806 IRBuilder<true, NoFolder> Builder(InsertPt);
Andrew Trickf3cf1932012-08-29 21:46:36 +00001807
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001808 // Move all 'aggressive' instructions, which are defined in the
1809 // conditional parts of the if's up to the dominating block.
Chris Lattner4088e2b2010-12-13 01:47:07 +00001810 if (IfBlock1)
Chris Lattner7499b452010-12-14 08:46:09 +00001811 DomBlock->getInstList().splice(InsertPt,
Chris Lattner4088e2b2010-12-13 01:47:07 +00001812 IfBlock1->getInstList(), IfBlock1->begin(),
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001813 IfBlock1->getTerminator());
Chris Lattner4088e2b2010-12-13 01:47:07 +00001814 if (IfBlock2)
Chris Lattner7499b452010-12-14 08:46:09 +00001815 DomBlock->getInstList().splice(InsertPt,
Chris Lattner4088e2b2010-12-13 01:47:07 +00001816 IfBlock2->getInstList(), IfBlock2->begin(),
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001817 IfBlock2->getTerminator());
Andrew Trickf3cf1932012-08-29 21:46:36 +00001818
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001819 while (PHINode *PN = dyn_cast<PHINode>(BB->begin())) {
1820 // Change the PHI node into a select instruction.
Chris Lattner4088e2b2010-12-13 01:47:07 +00001821 Value *TrueVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfFalse);
1822 Value *FalseVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfTrue);
Andrew Trickf3cf1932012-08-29 21:46:36 +00001823
1824 SelectInst *NV =
Devang Patel5c810ce2011-05-18 18:16:44 +00001825 cast<SelectInst>(Builder.CreateSelect(IfCond, TrueVal, FalseVal, ""));
Chris Lattner8dd4cae2007-02-11 01:37:51 +00001826 PN->replaceAllUsesWith(NV);
1827 NV->takeName(PN);
Chris Lattnerd7beca32010-12-14 06:17:25 +00001828 PN->eraseFromParent();
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001829 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00001830
Chris Lattner335f0e42010-12-14 08:01:53 +00001831 // At this point, IfBlock1 and IfBlock2 are both empty, so our if statement
1832 // has been flattened. Change DomBlock to jump directly to our new block to
1833 // avoid other simplifycfg's kicking in on the diamond.
1834 TerminatorInst *OldTI = DomBlock->getTerminator();
Devang Patel5c810ce2011-05-18 18:16:44 +00001835 Builder.SetInsertPoint(OldTI);
1836 Builder.CreateBr(BB);
Chris Lattner335f0e42010-12-14 08:01:53 +00001837 OldTI->eraseFromParent();
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001838 return true;
1839}
Chris Lattner748f9032005-09-19 23:49:37 +00001840
Chris Lattner86bbf332008-04-24 00:01:19 +00001841/// SimplifyCondBranchToTwoReturns - If we found a conditional branch that goes
1842/// to two returning blocks, try to merge them together into one return,
1843/// introducing a select if the return values disagree.
Andrew Trickf3cf1932012-08-29 21:46:36 +00001844static bool SimplifyCondBranchToTwoReturns(BranchInst *BI,
Devang Pateldd14e0f2011-05-18 21:33:11 +00001845 IRBuilder<> &Builder) {
Chris Lattner86bbf332008-04-24 00:01:19 +00001846 assert(BI->isConditional() && "Must be a conditional branch");
1847 BasicBlock *TrueSucc = BI->getSuccessor(0);
1848 BasicBlock *FalseSucc = BI->getSuccessor(1);
1849 ReturnInst *TrueRet = cast<ReturnInst>(TrueSucc->getTerminator());
1850 ReturnInst *FalseRet = cast<ReturnInst>(FalseSucc->getTerminator());
Andrew Trickf3cf1932012-08-29 21:46:36 +00001851
Chris Lattner86bbf332008-04-24 00:01:19 +00001852 // Check to ensure both blocks are empty (just a return) or optionally empty
1853 // with PHI nodes. If there are other instructions, merging would cause extra
1854 // computation on one path or the other.
Chris Lattner4088e2b2010-12-13 01:47:07 +00001855 if (!TrueSucc->getFirstNonPHIOrDbg()->isTerminator())
Devang Patel086b2122009-02-05 00:30:42 +00001856 return false;
Chris Lattner4088e2b2010-12-13 01:47:07 +00001857 if (!FalseSucc->getFirstNonPHIOrDbg()->isTerminator())
Devang Patel086b2122009-02-05 00:30:42 +00001858 return false;
Chris Lattner86bbf332008-04-24 00:01:19 +00001859
Devang Pateldd14e0f2011-05-18 21:33:11 +00001860 Builder.SetInsertPoint(BI);
Chris Lattner86bbf332008-04-24 00:01:19 +00001861 // Okay, we found a branch that is going to two return nodes. If
1862 // there is no return value for this function, just change the
1863 // branch into a return.
1864 if (FalseRet->getNumOperands() == 0) {
1865 TrueSucc->removePredecessor(BI->getParent());
1866 FalseSucc->removePredecessor(BI->getParent());
Devang Pateldd14e0f2011-05-18 21:33:11 +00001867 Builder.CreateRetVoid();
Eli Friedmancb61afb2008-12-16 20:54:32 +00001868 EraseTerminatorInstAndDCECond(BI);
Chris Lattner86bbf332008-04-24 00:01:19 +00001869 return true;
1870 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00001871
Dan Gohmanfa1211f2008-07-23 00:34:11 +00001872 // Otherwise, figure out what the true and false return values are
1873 // so we can insert a new select instruction.
1874 Value *TrueValue = TrueRet->getReturnValue();
1875 Value *FalseValue = FalseRet->getReturnValue();
Andrew Trickf3cf1932012-08-29 21:46:36 +00001876
Dan Gohmanfa1211f2008-07-23 00:34:11 +00001877 // Unwrap any PHI nodes in the return blocks.
1878 if (PHINode *TVPN = dyn_cast_or_null<PHINode>(TrueValue))
1879 if (TVPN->getParent() == TrueSucc)
1880 TrueValue = TVPN->getIncomingValueForBlock(BI->getParent());
1881 if (PHINode *FVPN = dyn_cast_or_null<PHINode>(FalseValue))
1882 if (FVPN->getParent() == FalseSucc)
1883 FalseValue = FVPN->getIncomingValueForBlock(BI->getParent());
Andrew Trickf3cf1932012-08-29 21:46:36 +00001884
Dan Gohmanfa1211f2008-07-23 00:34:11 +00001885 // In order for this transformation to be safe, we must be able to
1886 // unconditionally execute both operands to the return. This is
1887 // normally the case, but we could have a potentially-trapping
1888 // constant expression that prevents this transformation from being
1889 // safe.
1890 if (ConstantExpr *TCV = dyn_cast_or_null<ConstantExpr>(TrueValue))
1891 if (TCV->canTrap())
1892 return false;
1893 if (ConstantExpr *FCV = dyn_cast_or_null<ConstantExpr>(FalseValue))
1894 if (FCV->canTrap())
1895 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001896
Chris Lattner86bbf332008-04-24 00:01:19 +00001897 // Okay, we collected all the mapped values and checked them for sanity, and
1898 // defined to really do this transformation. First, update the CFG.
1899 TrueSucc->removePredecessor(BI->getParent());
1900 FalseSucc->removePredecessor(BI->getParent());
Andrew Trickf3cf1932012-08-29 21:46:36 +00001901
Chris Lattner86bbf332008-04-24 00:01:19 +00001902 // Insert select instructions where needed.
1903 Value *BrCond = BI->getCondition();
Dan Gohmanfa1211f2008-07-23 00:34:11 +00001904 if (TrueValue) {
Chris Lattner86bbf332008-04-24 00:01:19 +00001905 // Insert a select if the results differ.
Dan Gohmanfa1211f2008-07-23 00:34:11 +00001906 if (TrueValue == FalseValue || isa<UndefValue>(FalseValue)) {
1907 } else if (isa<UndefValue>(TrueValue)) {
1908 TrueValue = FalseValue;
1909 } else {
Devang Pateldd14e0f2011-05-18 21:33:11 +00001910 TrueValue = Builder.CreateSelect(BrCond, TrueValue,
1911 FalseValue, "retval");
Chris Lattner86bbf332008-04-24 00:01:19 +00001912 }
Chris Lattner86bbf332008-04-24 00:01:19 +00001913 }
1914
Andrew Trickf3cf1932012-08-29 21:46:36 +00001915 Value *RI = !TrueValue ?
Devang Pateldd14e0f2011-05-18 21:33:11 +00001916 Builder.CreateRetVoid() : Builder.CreateRet(TrueValue);
1917
Daniel Dunbar5e0a58b2009-08-23 10:29:55 +00001918 (void) RI;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001919
David Greene725c7c32010-01-05 01:26:52 +00001920 DEBUG(dbgs() << "\nCHANGING BRANCH TO TWO RETURNS INTO SELECT:"
Chris Lattnerb25de3f2009-08-23 04:37:46 +00001921 << "\n " << *BI << "NewRet = " << *RI
1922 << "TRUEBLOCK: " << *TrueSucc << "FALSEBLOCK: "<< *FalseSucc);
Andrew Trickf3cf1932012-08-29 21:46:36 +00001923
Eli Friedmancb61afb2008-12-16 20:54:32 +00001924 EraseTerminatorInstAndDCECond(BI);
1925
Chris Lattner86bbf332008-04-24 00:01:19 +00001926 return true;
1927}
1928
Nick Lewyckyc554a9b2011-12-27 04:31:52 +00001929/// ExtractBranchMetadata - Given a conditional BranchInstruction, retrieve the
1930/// probabilities of the branch taking each edge. Fills in the two APInt
1931/// parameters and return true, or returns false if no or invalid metadata was
1932/// found.
1933static bool ExtractBranchMetadata(BranchInst *BI,
Manman Renbfb9d432012-09-15 00:39:57 +00001934 uint64_t &ProbTrue, uint64_t &ProbFalse) {
Nick Lewyckyc554a9b2011-12-27 04:31:52 +00001935 assert(BI->isConditional() &&
1936 "Looking for probabilities on unconditional branch?");
1937 MDNode *ProfileData = BI->getMetadata(LLVMContext::MD_prof);
Nick Lewycky398255e2011-12-27 18:27:22 +00001938 if (!ProfileData || ProfileData->getNumOperands() != 3) return false;
Nick Lewyckyc554a9b2011-12-27 04:31:52 +00001939 ConstantInt *CITrue = dyn_cast<ConstantInt>(ProfileData->getOperand(1));
1940 ConstantInt *CIFalse = dyn_cast<ConstantInt>(ProfileData->getOperand(2));
Nick Lewycky398255e2011-12-27 18:27:22 +00001941 if (!CITrue || !CIFalse) return false;
Manman Renbfb9d432012-09-15 00:39:57 +00001942 ProbTrue = CITrue->getValue().getZExtValue();
1943 ProbFalse = CIFalse->getValue().getZExtValue();
Nick Lewyckyc554a9b2011-12-27 04:31:52 +00001944 return true;
1945}
1946
Manman Rend33f4ef2012-06-13 05:43:29 +00001947/// checkCSEInPredecessor - Return true if the given instruction is available
1948/// in its predecessor block. If yes, the instruction will be removed.
1949///
Benjamin Kramerabbfe692012-07-13 13:25:15 +00001950static bool checkCSEInPredecessor(Instruction *Inst, BasicBlock *PB) {
Manman Rend33f4ef2012-06-13 05:43:29 +00001951 if (!isa<BinaryOperator>(Inst) && !isa<CmpInst>(Inst))
1952 return false;
1953 for (BasicBlock::iterator I = PB->begin(), E = PB->end(); I != E; I++) {
1954 Instruction *PBI = &*I;
1955 // Check whether Inst and PBI generate the same value.
1956 if (Inst->isIdenticalTo(PBI)) {
1957 Inst->replaceAllUsesWith(PBI);
1958 Inst->eraseFromParent();
1959 return true;
1960 }
1961 }
1962 return false;
1963}
Nick Lewycky3c3feaf2012-01-25 09:43:14 +00001964
Chris Lattner7d4cdae2011-04-11 23:24:57 +00001965/// FoldBranchToCommonDest - If this basic block is simple enough, and if a
1966/// predecessor branches to us and one of our successors, fold the block into
1967/// the predecessor and use logical operations to pick the right destination.
Dan Gohmanc8ca4962009-06-27 21:30:38 +00001968bool llvm::FoldBranchToCommonDest(BranchInst *BI) {
Chris Lattner80b03a12008-07-13 22:23:11 +00001969 BasicBlock *BB = BI->getParent();
Devang Patel1407fb42011-05-19 20:52:46 +00001970
Manman Rend33f4ef2012-06-13 05:43:29 +00001971 Instruction *Cond = 0;
1972 if (BI->isConditional())
1973 Cond = dyn_cast<Instruction>(BI->getCondition());
1974 else {
1975 // For unconditional branch, check for a simple CFG pattern, where
1976 // BB has a single predecessor and BB's successor is also its predecessor's
1977 // successor. If such pattern exisits, check for CSE between BB and its
1978 // predecessor.
1979 if (BasicBlock *PB = BB->getSinglePredecessor())
1980 if (BranchInst *PBI = dyn_cast<BranchInst>(PB->getTerminator()))
1981 if (PBI->isConditional() &&
1982 (BI->getSuccessor(0) == PBI->getSuccessor(0) ||
1983 BI->getSuccessor(0) == PBI->getSuccessor(1))) {
1984 for (BasicBlock::iterator I = BB->begin(), E = BB->end();
1985 I != E; ) {
1986 Instruction *Curr = I++;
1987 if (isa<CmpInst>(Curr)) {
1988 Cond = Curr;
1989 break;
1990 }
1991 // Quit if we can't remove this instruction.
1992 if (!checkCSEInPredecessor(Curr, PB))
1993 return false;
1994 }
1995 }
1996
1997 if (Cond == 0)
1998 return false;
1999 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002000
Owen Anderson2cfe9132010-07-14 19:52:16 +00002001 if (Cond == 0 || (!isa<CmpInst>(Cond) && !isa<BinaryOperator>(Cond)) ||
2002 Cond->getParent() != BB || !Cond->hasOneUse())
2003 return false;
Devang Pateld715ec82011-04-06 22:37:20 +00002004
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002005 // Only allow this if the condition is a simple instruction that can be
2006 // executed unconditionally. It must be in the same block as the branch, and
2007 // must be at the front of the block.
Devang Patel916fdce2009-02-04 21:39:48 +00002008 BasicBlock::iterator FrontIt = BB->front();
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002009
Devang Patel916fdce2009-02-04 21:39:48 +00002010 // Ignore dbg intrinsics.
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002011 while (isa<DbgInfoIntrinsic>(FrontIt)) ++FrontIt;
Nick Lewyckye87d54c2011-12-26 20:37:40 +00002012
Owen Anderson2cfe9132010-07-14 19:52:16 +00002013 // Allow a single instruction to be hoisted in addition to the compare
2014 // that feeds the branch. We later ensure that any values that _it_ uses
2015 // were also live in the predecessor, so that we don't unnecessarily create
2016 // register pressure or inhibit out-of-order execution.
2017 Instruction *BonusInst = 0;
2018 if (&*FrontIt != Cond &&
Owen Anderson13700eb2010-07-15 16:38:22 +00002019 FrontIt->hasOneUse() && *FrontIt->use_begin() == Cond &&
Dan Gohman75d7d5e2011-12-14 23:49:11 +00002020 isSafeToSpeculativelyExecute(FrontIt)) {
Owen Anderson2cfe9132010-07-14 19:52:16 +00002021 BonusInst = &*FrontIt;
2022 ++FrontIt;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002023
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002024 // Ignore dbg intrinsics.
2025 while (isa<DbgInfoIntrinsic>(FrontIt)) ++FrontIt;
Devang Patelbc3d8b22011-04-07 23:11:25 +00002026 }
2027
Owen Anderson2cfe9132010-07-14 19:52:16 +00002028 // Only a single bonus inst is allowed.
2029 if (&*FrontIt != Cond)
2030 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002031
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002032 // Make sure the instruction after the condition is the cond branch.
2033 BasicBlock::iterator CondIt = Cond; ++CondIt;
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002034
Devang Patel916fdce2009-02-04 21:39:48 +00002035 // Ingore dbg intrinsics.
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002036 while (isa<DbgInfoIntrinsic>(CondIt)) ++CondIt;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002037
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002038 if (&*CondIt != BI)
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002039 return false;
Chris Lattnerea9f1d32009-01-19 23:03:13 +00002040
2041 // Cond is known to be a compare or binary operator. Check to make sure that
2042 // neither operand is a potentially-trapping constant expression.
2043 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(0)))
2044 if (CE->canTrap())
2045 return false;
2046 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(1)))
2047 if (CE->canTrap())
2048 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002049
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002050 // Finally, don't infinitely unroll conditional loops.
2051 BasicBlock *TrueDest = BI->getSuccessor(0);
Manman Rend33f4ef2012-06-13 05:43:29 +00002052 BasicBlock *FalseDest = (BI->isConditional()) ? BI->getSuccessor(1) : 0;
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002053 if (TrueDest == BB || FalseDest == BB)
2054 return false;
Devang Pateld715ec82011-04-06 22:37:20 +00002055
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002056 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
2057 BasicBlock *PredBlock = *PI;
2058 BranchInst *PBI = dyn_cast<BranchInst>(PredBlock->getTerminator());
Andrew Trickf3cf1932012-08-29 21:46:36 +00002059
Chris Lattner80b03a12008-07-13 22:23:11 +00002060 // Check that we have two conditional branches. If there is a PHI node in
2061 // the common successor, verify that the same value flows in from both
2062 // blocks.
Manman Rend33f4ef2012-06-13 05:43:29 +00002063 SmallVector<PHINode*, 4> PHIs;
2064 if (PBI == 0 || PBI->isUnconditional() ||
Andrew Trickf3cf1932012-08-29 21:46:36 +00002065 (BI->isConditional() &&
Manman Rend33f4ef2012-06-13 05:43:29 +00002066 !SafeToMergeTerminators(BI, PBI)) ||
2067 (!BI->isConditional() &&
2068 !isProfitableToFoldUnconditional(BI, PBI, Cond, PHIs)))
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002069 continue;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002070
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002071 // Determine if the two branches share a common destination.
Axel Naumann4a127062012-09-17 14:20:57 +00002072 Instruction::BinaryOps Opc = Instruction::BinaryOpsEnd;
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002073 bool InvertPredCond = false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002074
Manman Rend33f4ef2012-06-13 05:43:29 +00002075 if (BI->isConditional()) {
2076 if (PBI->getSuccessor(0) == TrueDest)
2077 Opc = Instruction::Or;
2078 else if (PBI->getSuccessor(1) == FalseDest)
2079 Opc = Instruction::And;
2080 else if (PBI->getSuccessor(0) == FalseDest)
2081 Opc = Instruction::And, InvertPredCond = true;
2082 else if (PBI->getSuccessor(1) == TrueDest)
2083 Opc = Instruction::Or, InvertPredCond = true;
2084 else
2085 continue;
2086 } else {
2087 if (PBI->getSuccessor(0) != TrueDest && PBI->getSuccessor(1) != TrueDest)
2088 continue;
2089 }
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002090
Owen Anderson2cfe9132010-07-14 19:52:16 +00002091 // Ensure that any values used in the bonus instruction are also used
2092 // by the terminator of the predecessor. This means that those values
Andrew Trickf3cf1932012-08-29 21:46:36 +00002093 // must already have been resolved, so we won't be inhibiting the
Nadav Rotem53d32212013-11-12 22:37:16 +00002094 // out-of-order core by speculating them earlier. We also allow
2095 // instructions that are used by the terminator's condition because it
2096 // exposes more merging opportunities.
2097 bool UsedByBranch = (BonusInst && BonusInst->hasOneUse() &&
2098 *BonusInst->use_begin() == Cond);
2099
2100 if (BonusInst && !UsedByBranch) {
Owen Anderson2cfe9132010-07-14 19:52:16 +00002101 // Collect the values used by the bonus inst
2102 SmallPtrSet<Value*, 4> UsedValues;
2103 for (Instruction::op_iterator OI = BonusInst->op_begin(),
2104 OE = BonusInst->op_end(); OI != OE; ++OI) {
Nick Lewyckye87d54c2011-12-26 20:37:40 +00002105 Value *V = *OI;
Nadav Rotem5ba1c6c2013-11-10 04:13:31 +00002106 if (!isa<Constant>(V) && !isa<Argument>(V))
Owen Anderson2cfe9132010-07-14 19:52:16 +00002107 UsedValues.insert(V);
2108 }
2109
2110 SmallVector<std::pair<Value*, unsigned>, 4> Worklist;
2111 Worklist.push_back(std::make_pair(PBI->getOperand(0), 0));
Andrew Trickf3cf1932012-08-29 21:46:36 +00002112
Owen Anderson2cfe9132010-07-14 19:52:16 +00002113 // Walk up to four levels back up the use-def chain of the predecessor's
2114 // terminator to see if all those values were used. The choice of four
2115 // levels is arbitrary, to provide a compile-time-cost bound.
2116 while (!Worklist.empty()) {
2117 std::pair<Value*, unsigned> Pair = Worklist.back();
2118 Worklist.pop_back();
Andrew Trickf3cf1932012-08-29 21:46:36 +00002119
Owen Anderson2cfe9132010-07-14 19:52:16 +00002120 if (Pair.second >= 4) continue;
2121 UsedValues.erase(Pair.first);
2122 if (UsedValues.empty()) break;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002123
Chris Lattnerfbeb5582010-12-13 07:00:06 +00002124 if (Instruction *I = dyn_cast<Instruction>(Pair.first)) {
Owen Anderson2cfe9132010-07-14 19:52:16 +00002125 for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
2126 OI != OE; ++OI)
2127 Worklist.push_back(std::make_pair(OI->get(), Pair.second+1));
Andrew Trickf3cf1932012-08-29 21:46:36 +00002128 }
Owen Anderson2cfe9132010-07-14 19:52:16 +00002129 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002130
Owen Anderson2cfe9132010-07-14 19:52:16 +00002131 if (!UsedValues.empty()) return false;
2132 }
Chris Lattner55eaae12008-07-13 21:20:19 +00002133
David Greene725c7c32010-01-05 01:26:52 +00002134 DEBUG(dbgs() << "FOLDING BRANCH TO COMMON DEST:\n" << *PBI << *BB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002135 IRBuilder<> Builder(PBI);
Devang Patel1407fb42011-05-19 20:52:46 +00002136
Chris Lattner55eaae12008-07-13 21:20:19 +00002137 // If we need to invert the condition in the pred block to match, do so now.
2138 if (InvertPredCond) {
Chris Lattnerfbeb5582010-12-13 07:00:06 +00002139 Value *NewCond = PBI->getCondition();
Andrew Trickf3cf1932012-08-29 21:46:36 +00002140
Chris Lattnerfbeb5582010-12-13 07:00:06 +00002141 if (NewCond->hasOneUse() && isa<CmpInst>(NewCond)) {
2142 CmpInst *CI = cast<CmpInst>(NewCond);
2143 CI->setPredicate(CI->getInversePredicate());
2144 } else {
Andrew Trickf3cf1932012-08-29 21:46:36 +00002145 NewCond = Builder.CreateNot(NewCond,
Devang Patel1407fb42011-05-19 20:52:46 +00002146 PBI->getCondition()->getName()+".not");
Chris Lattnerfbeb5582010-12-13 07:00:06 +00002147 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002148
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002149 PBI->setCondition(NewCond);
Nick Lewycky8d302df2011-12-26 20:54:14 +00002150 PBI->swapSuccessors();
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002151 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002152
Owen Anderson2cfe9132010-07-14 19:52:16 +00002153 // If we have a bonus inst, clone it into the predecessor block.
2154 Instruction *NewBonus = 0;
2155 if (BonusInst) {
2156 NewBonus = BonusInst->clone();
2157 PredBlock->getInstList().insert(PBI, NewBonus);
2158 NewBonus->takeName(BonusInst);
2159 BonusInst->setName(BonusInst->getName()+".old");
2160 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002161
Chris Lattner55eaae12008-07-13 21:20:19 +00002162 // Clone Cond into the predecessor basic block, and or/and the
2163 // two conditions together.
Nick Lewycky42fb7452009-09-27 07:38:41 +00002164 Instruction *New = Cond->clone();
Owen Anderson2cfe9132010-07-14 19:52:16 +00002165 if (BonusInst) New->replaceUsesOfWith(BonusInst, NewBonus);
Chris Lattner55eaae12008-07-13 21:20:19 +00002166 PredBlock->getInstList().insert(PBI, New);
2167 New->takeName(Cond);
2168 Cond->setName(New->getName()+".old");
Andrew Trickf3cf1932012-08-29 21:46:36 +00002169
Manman Rend33f4ef2012-06-13 05:43:29 +00002170 if (BI->isConditional()) {
Andrew Trickf3cf1932012-08-29 21:46:36 +00002171 Instruction *NewCond =
Manman Rend33f4ef2012-06-13 05:43:29 +00002172 cast<Instruction>(Builder.CreateBinOp(Opc, PBI->getCondition(),
Devang Patel1407fb42011-05-19 20:52:46 +00002173 New, "or.cond"));
Manman Rend33f4ef2012-06-13 05:43:29 +00002174 PBI->setCondition(NewCond);
2175
Manman Renbfb9d432012-09-15 00:39:57 +00002176 uint64_t PredTrueWeight, PredFalseWeight, SuccTrueWeight, SuccFalseWeight;
2177 bool PredHasWeights = ExtractBranchMetadata(PBI, PredTrueWeight,
2178 PredFalseWeight);
2179 bool SuccHasWeights = ExtractBranchMetadata(BI, SuccTrueWeight,
2180 SuccFalseWeight);
2181 SmallVector<uint64_t, 8> NewWeights;
2182
Manman Rend33f4ef2012-06-13 05:43:29 +00002183 if (PBI->getSuccessor(0) == BB) {
Manman Renbfb9d432012-09-15 00:39:57 +00002184 if (PredHasWeights && SuccHasWeights) {
2185 // PBI: br i1 %x, BB, FalseDest
2186 // BI: br i1 %y, TrueDest, FalseDest
2187 //TrueWeight is TrueWeight for PBI * TrueWeight for BI.
2188 NewWeights.push_back(PredTrueWeight * SuccTrueWeight);
2189 //FalseWeight is FalseWeight for PBI * TotalWeight for BI +
2190 // TrueWeight for PBI * FalseWeight for BI.
2191 // We assume that total weights of a BranchInst can fit into 32 bits.
2192 // Therefore, we will not have overflow using 64-bit arithmetic.
2193 NewWeights.push_back(PredFalseWeight * (SuccFalseWeight +
2194 SuccTrueWeight) + PredTrueWeight * SuccFalseWeight);
2195 }
Manman Rend33f4ef2012-06-13 05:43:29 +00002196 AddPredecessorToBlock(TrueDest, PredBlock, BB);
2197 PBI->setSuccessor(0, TrueDest);
2198 }
2199 if (PBI->getSuccessor(1) == BB) {
Manman Renbfb9d432012-09-15 00:39:57 +00002200 if (PredHasWeights && SuccHasWeights) {
2201 // PBI: br i1 %x, TrueDest, BB
2202 // BI: br i1 %y, TrueDest, FalseDest
2203 //TrueWeight is TrueWeight for PBI * TotalWeight for BI +
2204 // FalseWeight for PBI * TrueWeight for BI.
2205 NewWeights.push_back(PredTrueWeight * (SuccFalseWeight +
2206 SuccTrueWeight) + PredFalseWeight * SuccTrueWeight);
2207 //FalseWeight is FalseWeight for PBI * FalseWeight for BI.
2208 NewWeights.push_back(PredFalseWeight * SuccFalseWeight);
2209 }
Manman Rend33f4ef2012-06-13 05:43:29 +00002210 AddPredecessorToBlock(FalseDest, PredBlock, BB);
2211 PBI->setSuccessor(1, FalseDest);
2212 }
Manman Renbfb9d432012-09-15 00:39:57 +00002213 if (NewWeights.size() == 2) {
2214 // Halve the weights if any of them cannot fit in an uint32_t
2215 FitWeights(NewWeights);
2216
2217 SmallVector<uint32_t, 8> MDWeights(NewWeights.begin(),NewWeights.end());
2218 PBI->setMetadata(LLVMContext::MD_prof,
2219 MDBuilder(BI->getContext()).
2220 createBranchWeights(MDWeights));
2221 } else
2222 PBI->setMetadata(LLVMContext::MD_prof, NULL);
Manman Rend33f4ef2012-06-13 05:43:29 +00002223 } else {
2224 // Update PHI nodes in the common successors.
2225 for (unsigned i = 0, e = PHIs.size(); i != e; ++i) {
Nick Lewycky0a045bb2012-06-24 10:15:42 +00002226 ConstantInt *PBI_C = cast<ConstantInt>(
Manman Rend33f4ef2012-06-13 05:43:29 +00002227 PHIs[i]->getIncomingValueForBlock(PBI->getParent()));
2228 assert(PBI_C->getType()->isIntegerTy(1));
2229 Instruction *MergedCond = 0;
2230 if (PBI->getSuccessor(0) == TrueDest) {
2231 // Create (PBI_Cond and PBI_C) or (!PBI_Cond and BI_Value)
2232 // PBI_C is true: PBI_Cond or (!PBI_Cond and BI_Value)
2233 // is false: !PBI_Cond and BI_Value
2234 Instruction *NotCond =
2235 cast<Instruction>(Builder.CreateNot(PBI->getCondition(),
2236 "not.cond"));
2237 MergedCond =
2238 cast<Instruction>(Builder.CreateBinOp(Instruction::And,
2239 NotCond, New,
2240 "and.cond"));
2241 if (PBI_C->isOne())
2242 MergedCond =
2243 cast<Instruction>(Builder.CreateBinOp(Instruction::Or,
2244 PBI->getCondition(), MergedCond,
2245 "or.cond"));
2246 } else {
2247 // Create (PBI_Cond and BI_Value) or (!PBI_Cond and PBI_C)
2248 // PBI_C is true: (PBI_Cond and BI_Value) or (!PBI_Cond)
2249 // is false: PBI_Cond and BI_Value
Andrew Trickf3cf1932012-08-29 21:46:36 +00002250 MergedCond =
Manman Rend33f4ef2012-06-13 05:43:29 +00002251 cast<Instruction>(Builder.CreateBinOp(Instruction::And,
2252 PBI->getCondition(), New,
2253 "and.cond"));
2254 if (PBI_C->isOne()) {
2255 Instruction *NotCond =
2256 cast<Instruction>(Builder.CreateNot(PBI->getCondition(),
2257 "not.cond"));
Andrew Trickf3cf1932012-08-29 21:46:36 +00002258 MergedCond =
Manman Rend33f4ef2012-06-13 05:43:29 +00002259 cast<Instruction>(Builder.CreateBinOp(Instruction::Or,
2260 NotCond, MergedCond,
2261 "or.cond"));
2262 }
2263 }
2264 // Update PHI Node.
2265 PHIs[i]->setIncomingValue(PHIs[i]->getBasicBlockIndex(PBI->getParent()),
2266 MergedCond);
2267 }
2268 // Change PBI from Conditional to Unconditional.
2269 BranchInst *New_PBI = BranchInst::Create(TrueDest, PBI);
2270 EraseTerminatorInstAndDCECond(PBI);
2271 PBI = New_PBI;
Chris Lattner55eaae12008-07-13 21:20:19 +00002272 }
Devang Pateld715ec82011-04-06 22:37:20 +00002273
Nick Lewyckyc554a9b2011-12-27 04:31:52 +00002274 // TODO: If BB is reachable from all paths through PredBlock, then we
2275 // could replace PBI's branch probabilities with BI's.
2276
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002277 // Copy any debug value intrinsics into the end of PredBlock.
2278 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
2279 if (isa<DbgInfoIntrinsic>(*I))
2280 I->clone()->insertBefore(PBI);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002281
Chris Lattner5a9d59d2010-12-14 05:57:30 +00002282 return true;
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002283 }
2284 return false;
2285}
2286
Chris Lattner9aada1d2008-07-13 21:53:26 +00002287/// SimplifyCondBranchToCondBranch - If we have a conditional branch as a
2288/// predecessor of another block, this function tries to simplify it. We know
2289/// that PBI and BI are both conditional branches, and BI is in one of the
2290/// successor blocks of PBI - PBI branches to BI.
2291static bool SimplifyCondBranchToCondBranch(BranchInst *PBI, BranchInst *BI) {
2292 assert(PBI->isConditional() && BI->isConditional());
2293 BasicBlock *BB = BI->getParent();
Dan Gohman5476cfd2009-08-12 16:23:25 +00002294
Chris Lattner9aada1d2008-07-13 21:53:26 +00002295 // If this block ends with a branch instruction, and if there is a
Andrew Trickf3cf1932012-08-29 21:46:36 +00002296 // predecessor that ends on a branch of the same condition, make
Chris Lattner9aada1d2008-07-13 21:53:26 +00002297 // this conditional branch redundant.
2298 if (PBI->getCondition() == BI->getCondition() &&
2299 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
2300 // Okay, the outcome of this conditional branch is statically
2301 // knowable. If this block had a single pred, handle specially.
2302 if (BB->getSinglePredecessor()) {
2303 // Turn this into a branch on constant.
2304 bool CondIsTrue = PBI->getSuccessor(0) == BB;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002305 BI->setCondition(ConstantInt::get(Type::getInt1Ty(BB->getContext()),
Owen Anderson55f1c092009-08-13 21:58:54 +00002306 CondIsTrue));
Chris Lattner9aada1d2008-07-13 21:53:26 +00002307 return true; // Nuke the branch on constant.
2308 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002309
Chris Lattner9aada1d2008-07-13 21:53:26 +00002310 // Otherwise, if there are multiple predecessors, insert a PHI that merges
2311 // in the constant and simplify the block result. Subsequent passes of
2312 // simplifycfg will thread the block.
2313 if (BlockIsSimpleEnoughToThreadThrough(BB)) {
Jay Foade0938d82011-03-30 11:19:20 +00002314 pred_iterator PB = pred_begin(BB), PE = pred_end(BB);
Owen Anderson55f1c092009-08-13 21:58:54 +00002315 PHINode *NewPN = PHINode::Create(Type::getInt1Ty(BB->getContext()),
Jay Foad52131342011-03-30 11:28:46 +00002316 std::distance(PB, PE),
Chris Lattner9aada1d2008-07-13 21:53:26 +00002317 BI->getCondition()->getName() + ".pr",
2318 BB->begin());
Chris Lattner5eed3722008-07-13 21:55:46 +00002319 // Okay, we're going to insert the PHI node. Since PBI is not the only
2320 // predecessor, compute the PHI'd conditional value for all of the preds.
2321 // Any predecessor where the condition is not computable we keep symbolic.
Jay Foade0938d82011-03-30 11:19:20 +00002322 for (pred_iterator PI = PB; PI != PE; ++PI) {
Gabor Greif8629f122010-07-12 10:59:23 +00002323 BasicBlock *P = *PI;
2324 if ((PBI = dyn_cast<BranchInst>(P->getTerminator())) &&
Chris Lattner9aada1d2008-07-13 21:53:26 +00002325 PBI != BI && PBI->isConditional() &&
2326 PBI->getCondition() == BI->getCondition() &&
2327 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
2328 bool CondIsTrue = PBI->getSuccessor(0) == BB;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002329 NewPN->addIncoming(ConstantInt::get(Type::getInt1Ty(BB->getContext()),
Gabor Greif8629f122010-07-12 10:59:23 +00002330 CondIsTrue), P);
Chris Lattner9aada1d2008-07-13 21:53:26 +00002331 } else {
Gabor Greif8629f122010-07-12 10:59:23 +00002332 NewPN->addIncoming(BI->getCondition(), P);
Chris Lattner9aada1d2008-07-13 21:53:26 +00002333 }
Gabor Greif8629f122010-07-12 10:59:23 +00002334 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002335
Chris Lattner9aada1d2008-07-13 21:53:26 +00002336 BI->setCondition(NewPN);
Chris Lattner9aada1d2008-07-13 21:53:26 +00002337 return true;
2338 }
2339 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002340
Chris Lattner9aada1d2008-07-13 21:53:26 +00002341 // If this is a conditional branch in an empty block, and if any
2342 // predecessors is a conditional branch to one of our destinations,
2343 // fold the conditions into logical ops and one cond br.
Zhou Sheng264e46e2009-02-26 06:56:37 +00002344 BasicBlock::iterator BBI = BB->begin();
2345 // Ignore dbg intrinsics.
2346 while (isa<DbgInfoIntrinsic>(BBI))
2347 ++BBI;
2348 if (&*BBI != BI)
Chris Lattner834ab4e2008-07-13 22:04:41 +00002349 return false;
Chris Lattnerc59945b2009-01-20 01:15:41 +00002350
Andrew Trickf3cf1932012-08-29 21:46:36 +00002351
Chris Lattnerc59945b2009-01-20 01:15:41 +00002352 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(BI->getCondition()))
2353 if (CE->canTrap())
2354 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002355
Chris Lattner834ab4e2008-07-13 22:04:41 +00002356 int PBIOp, BIOp;
2357 if (PBI->getSuccessor(0) == BI->getSuccessor(0))
2358 PBIOp = BIOp = 0;
2359 else if (PBI->getSuccessor(0) == BI->getSuccessor(1))
2360 PBIOp = 0, BIOp = 1;
2361 else if (PBI->getSuccessor(1) == BI->getSuccessor(0))
2362 PBIOp = 1, BIOp = 0;
2363 else if (PBI->getSuccessor(1) == BI->getSuccessor(1))
2364 PBIOp = BIOp = 1;
2365 else
2366 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002367
Chris Lattner834ab4e2008-07-13 22:04:41 +00002368 // Check to make sure that the other destination of this branch
2369 // isn't BB itself. If so, this is an infinite loop that will
2370 // keep getting unwound.
2371 if (PBI->getSuccessor(PBIOp) == BB)
2372 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002373
2374 // Do not perform this transformation if it would require
Chris Lattner834ab4e2008-07-13 22:04:41 +00002375 // insertion of a large number of select instructions. For targets
2376 // without predication/cmovs, this is a big pessimization.
2377 BasicBlock *CommonDest = PBI->getSuccessor(PBIOp);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002378
Chris Lattner834ab4e2008-07-13 22:04:41 +00002379 unsigned NumPhis = 0;
2380 for (BasicBlock::iterator II = CommonDest->begin();
2381 isa<PHINode>(II); ++II, ++NumPhis)
2382 if (NumPhis > 2) // Disable this xform.
2383 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002384
Chris Lattner834ab4e2008-07-13 22:04:41 +00002385 // Finally, if everything is ok, fold the branches to logical ops.
2386 BasicBlock *OtherDest = BI->getSuccessor(BIOp ^ 1);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002387
David Greene725c7c32010-01-05 01:26:52 +00002388 DEBUG(dbgs() << "FOLDING BRs:" << *PBI->getParent()
Chris Lattnerb25de3f2009-08-23 04:37:46 +00002389 << "AND: " << *BI->getParent());
Andrew Trickf3cf1932012-08-29 21:46:36 +00002390
2391
Chris Lattner80b03a12008-07-13 22:23:11 +00002392 // If OtherDest *is* BB, then BB is a basic block with a single conditional
2393 // branch in it, where one edge (OtherDest) goes back to itself but the other
2394 // exits. We don't *know* that the program avoids the infinite loop
2395 // (even though that seems likely). If we do this xform naively, we'll end up
2396 // recursively unpeeling the loop. Since we know that (after the xform is
2397 // done) that the block *is* infinite if reached, we just make it an obviously
2398 // infinite loop with no cond branch.
2399 if (OtherDest == BB) {
2400 // Insert it at the end of the function, because it's either code,
2401 // or it won't matter if it's hot. :)
Owen Anderson55f1c092009-08-13 21:58:54 +00002402 BasicBlock *InfLoopBlock = BasicBlock::Create(BB->getContext(),
2403 "infloop", BB->getParent());
Chris Lattner80b03a12008-07-13 22:23:11 +00002404 BranchInst::Create(InfLoopBlock, InfLoopBlock);
2405 OtherDest = InfLoopBlock;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002406 }
2407
David Greene725c7c32010-01-05 01:26:52 +00002408 DEBUG(dbgs() << *PBI->getParent()->getParent());
Devang Patel1407fb42011-05-19 20:52:46 +00002409
Chris Lattner834ab4e2008-07-13 22:04:41 +00002410 // BI may have other predecessors. Because of this, we leave
2411 // it alone, but modify PBI.
Andrew Trickf3cf1932012-08-29 21:46:36 +00002412
Chris Lattner834ab4e2008-07-13 22:04:41 +00002413 // Make sure we get to CommonDest on True&True directions.
2414 Value *PBICond = PBI->getCondition();
Devang Patel1407fb42011-05-19 20:52:46 +00002415 IRBuilder<true, NoFolder> Builder(PBI);
Chris Lattner834ab4e2008-07-13 22:04:41 +00002416 if (PBIOp)
Devang Patel1407fb42011-05-19 20:52:46 +00002417 PBICond = Builder.CreateNot(PBICond, PBICond->getName()+".not");
2418
Chris Lattner834ab4e2008-07-13 22:04:41 +00002419 Value *BICond = BI->getCondition();
2420 if (BIOp)
Devang Patel1407fb42011-05-19 20:52:46 +00002421 BICond = Builder.CreateNot(BICond, BICond->getName()+".not");
2422
Chris Lattner834ab4e2008-07-13 22:04:41 +00002423 // Merge the conditions.
Devang Patel1407fb42011-05-19 20:52:46 +00002424 Value *Cond = Builder.CreateOr(PBICond, BICond, "brmerge");
Andrew Trickf3cf1932012-08-29 21:46:36 +00002425
Chris Lattner834ab4e2008-07-13 22:04:41 +00002426 // Modify PBI to branch on the new condition to the new dests.
2427 PBI->setCondition(Cond);
2428 PBI->setSuccessor(0, CommonDest);
2429 PBI->setSuccessor(1, OtherDest);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002430
Manman Ren2d4c10f2012-09-17 21:30:40 +00002431 // Update branch weight for PBI.
2432 uint64_t PredTrueWeight, PredFalseWeight, SuccTrueWeight, SuccFalseWeight;
2433 bool PredHasWeights = ExtractBranchMetadata(PBI, PredTrueWeight,
2434 PredFalseWeight);
2435 bool SuccHasWeights = ExtractBranchMetadata(BI, SuccTrueWeight,
2436 SuccFalseWeight);
2437 if (PredHasWeights && SuccHasWeights) {
2438 uint64_t PredCommon = PBIOp ? PredFalseWeight : PredTrueWeight;
2439 uint64_t PredOther = PBIOp ?PredTrueWeight : PredFalseWeight;
2440 uint64_t SuccCommon = BIOp ? SuccFalseWeight : SuccTrueWeight;
2441 uint64_t SuccOther = BIOp ? SuccTrueWeight : SuccFalseWeight;
2442 // The weight to CommonDest should be PredCommon * SuccTotal +
2443 // PredOther * SuccCommon.
2444 // The weight to OtherDest should be PredOther * SuccOther.
2445 SmallVector<uint64_t, 2> NewWeights;
2446 NewWeights.push_back(PredCommon * (SuccCommon + SuccOther) +
2447 PredOther * SuccCommon);
2448 NewWeights.push_back(PredOther * SuccOther);
2449 // Halve the weights if any of them cannot fit in an uint32_t
2450 FitWeights(NewWeights);
2451
2452 SmallVector<uint32_t, 2> MDWeights(NewWeights.begin(),NewWeights.end());
2453 PBI->setMetadata(LLVMContext::MD_prof,
2454 MDBuilder(BI->getContext()).
2455 createBranchWeights(MDWeights));
2456 }
2457
Chris Lattner834ab4e2008-07-13 22:04:41 +00002458 // OtherDest may have phi nodes. If so, add an entry from PBI's
2459 // block that are identical to the entries for BI's block.
Chris Lattner0f4d67b2010-12-14 07:09:42 +00002460 AddPredecessorToBlock(OtherDest, PBI->getParent(), BB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002461
Chris Lattner834ab4e2008-07-13 22:04:41 +00002462 // We know that the CommonDest already had an edge from PBI to
2463 // it. If it has PHIs though, the PHIs may have different
2464 // entries for BB and PBI's BB. If so, insert a select to make
2465 // them agree.
Chris Lattner0f4d67b2010-12-14 07:09:42 +00002466 PHINode *PN;
Chris Lattner834ab4e2008-07-13 22:04:41 +00002467 for (BasicBlock::iterator II = CommonDest->begin();
2468 (PN = dyn_cast<PHINode>(II)); ++II) {
2469 Value *BIV = PN->getIncomingValueForBlock(BB);
2470 unsigned PBBIdx = PN->getBasicBlockIndex(PBI->getParent());
2471 Value *PBIV = PN->getIncomingValue(PBBIdx);
2472 if (BIV != PBIV) {
2473 // Insert a select in PBI to pick the right value.
Devang Patel1407fb42011-05-19 20:52:46 +00002474 Value *NV = cast<SelectInst>
2475 (Builder.CreateSelect(PBICond, PBIV, BIV, PBIV->getName()+".mux"));
Chris Lattner834ab4e2008-07-13 22:04:41 +00002476 PN->setIncomingValue(PBBIdx, NV);
Chris Lattner9aada1d2008-07-13 21:53:26 +00002477 }
2478 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002479
David Greene725c7c32010-01-05 01:26:52 +00002480 DEBUG(dbgs() << "INTO: " << *PBI->getParent());
2481 DEBUG(dbgs() << *PBI->getParent()->getParent());
Andrew Trickf3cf1932012-08-29 21:46:36 +00002482
Chris Lattner834ab4e2008-07-13 22:04:41 +00002483 // This basic block is probably dead. We know it has at least
2484 // one fewer predecessor.
2485 return true;
Chris Lattner9aada1d2008-07-13 21:53:26 +00002486}
2487
Frits van Bommel8e158492011-01-11 12:52:11 +00002488// SimplifyTerminatorOnSelect - Simplifies a terminator by replacing it with a
2489// branch to TrueBB if Cond is true or to FalseBB if Cond is false.
2490// Takes care of updating the successors and removing the old terminator.
2491// Also makes sure not to introduce new successors by assuming that edges to
2492// non-successor TrueBBs and FalseBBs aren't reachable.
2493static bool SimplifyTerminatorOnSelect(TerminatorInst *OldTerm, Value *Cond,
Manman Ren774246a2012-09-17 22:28:55 +00002494 BasicBlock *TrueBB, BasicBlock *FalseBB,
2495 uint32_t TrueWeight,
2496 uint32_t FalseWeight){
Frits van Bommel8e158492011-01-11 12:52:11 +00002497 // Remove any superfluous successor edges from the CFG.
2498 // First, figure out which successors to preserve.
2499 // If TrueBB and FalseBB are equal, only try to preserve one copy of that
2500 // successor.
2501 BasicBlock *KeepEdge1 = TrueBB;
2502 BasicBlock *KeepEdge2 = TrueBB != FalseBB ? FalseBB : 0;
2503
2504 // Then remove the rest.
2505 for (unsigned I = 0, E = OldTerm->getNumSuccessors(); I != E; ++I) {
2506 BasicBlock *Succ = OldTerm->getSuccessor(I);
2507 // Make sure only to keep exactly one copy of each edge.
2508 if (Succ == KeepEdge1)
2509 KeepEdge1 = 0;
2510 else if (Succ == KeepEdge2)
2511 KeepEdge2 = 0;
2512 else
2513 Succ->removePredecessor(OldTerm->getParent());
2514 }
2515
Devang Patel2c2ea222011-05-18 18:43:31 +00002516 IRBuilder<> Builder(OldTerm);
2517 Builder.SetCurrentDebugLocation(OldTerm->getDebugLoc());
2518
Frits van Bommel8e158492011-01-11 12:52:11 +00002519 // Insert an appropriate new terminator.
2520 if ((KeepEdge1 == 0) && (KeepEdge2 == 0)) {
2521 if (TrueBB == FalseBB)
2522 // We were only looking for one successor, and it was present.
2523 // Create an unconditional branch to it.
Devang Patel2c2ea222011-05-18 18:43:31 +00002524 Builder.CreateBr(TrueBB);
Manman Ren774246a2012-09-17 22:28:55 +00002525 else {
Frits van Bommel8e158492011-01-11 12:52:11 +00002526 // We found both of the successors we were looking for.
2527 // Create a conditional branch sharing the condition of the select.
Manman Ren774246a2012-09-17 22:28:55 +00002528 BranchInst *NewBI = Builder.CreateCondBr(Cond, TrueBB, FalseBB);
2529 if (TrueWeight != FalseWeight)
2530 NewBI->setMetadata(LLVMContext::MD_prof,
2531 MDBuilder(OldTerm->getContext()).
2532 createBranchWeights(TrueWeight, FalseWeight));
2533 }
Frits van Bommel8e158492011-01-11 12:52:11 +00002534 } else if (KeepEdge1 && (KeepEdge2 || TrueBB == FalseBB)) {
2535 // Neither of the selected blocks were successors, so this
2536 // terminator must be unreachable.
2537 new UnreachableInst(OldTerm->getContext(), OldTerm);
2538 } else {
2539 // One of the selected values was a successor, but the other wasn't.
2540 // Insert an unconditional branch to the one that was found;
2541 // the edge to the one that wasn't must be unreachable.
2542 if (KeepEdge1 == 0)
2543 // Only TrueBB was found.
Devang Patel2c2ea222011-05-18 18:43:31 +00002544 Builder.CreateBr(TrueBB);
Frits van Bommel8e158492011-01-11 12:52:11 +00002545 else
2546 // Only FalseBB was found.
Devang Patel2c2ea222011-05-18 18:43:31 +00002547 Builder.CreateBr(FalseBB);
Frits van Bommel8e158492011-01-11 12:52:11 +00002548 }
2549
2550 EraseTerminatorInstAndDCECond(OldTerm);
2551 return true;
2552}
2553
Frits van Bommel8ae07992011-02-28 09:44:07 +00002554// SimplifySwitchOnSelect - Replaces
2555// (switch (select cond, X, Y)) on constant X, Y
2556// with a branch - conditional if X and Y lead to distinct BBs,
2557// unconditional otherwise.
2558static bool SimplifySwitchOnSelect(SwitchInst *SI, SelectInst *Select) {
2559 // Check for constant integer values in the select.
2560 ConstantInt *TrueVal = dyn_cast<ConstantInt>(Select->getTrueValue());
2561 ConstantInt *FalseVal = dyn_cast<ConstantInt>(Select->getFalseValue());
2562 if (!TrueVal || !FalseVal)
2563 return false;
2564
2565 // Find the relevant condition and destinations.
2566 Value *Condition = Select->getCondition();
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00002567 BasicBlock *TrueBB = SI->findCaseValue(TrueVal).getCaseSuccessor();
2568 BasicBlock *FalseBB = SI->findCaseValue(FalseVal).getCaseSuccessor();
Frits van Bommel8ae07992011-02-28 09:44:07 +00002569
Manman Ren774246a2012-09-17 22:28:55 +00002570 // Get weight for TrueBB and FalseBB.
2571 uint32_t TrueWeight = 0, FalseWeight = 0;
2572 SmallVector<uint64_t, 8> Weights;
2573 bool HasWeights = HasBranchWeights(SI);
2574 if (HasWeights) {
2575 GetBranchWeights(SI, Weights);
2576 if (Weights.size() == 1 + SI->getNumCases()) {
2577 TrueWeight = (uint32_t)Weights[SI->findCaseValue(TrueVal).
2578 getSuccessorIndex()];
2579 FalseWeight = (uint32_t)Weights[SI->findCaseValue(FalseVal).
2580 getSuccessorIndex()];
2581 }
2582 }
2583
Frits van Bommel8ae07992011-02-28 09:44:07 +00002584 // Perform the actual simplification.
Manman Ren774246a2012-09-17 22:28:55 +00002585 return SimplifyTerminatorOnSelect(SI, Condition, TrueBB, FalseBB,
2586 TrueWeight, FalseWeight);
Frits van Bommel8ae07992011-02-28 09:44:07 +00002587}
2588
Frits van Bommel8fb69ee2010-12-05 18:29:03 +00002589// SimplifyIndirectBrOnSelect - Replaces
2590// (indirectbr (select cond, blockaddress(@fn, BlockA),
2591// blockaddress(@fn, BlockB)))
2592// with
2593// (br cond, BlockA, BlockB).
2594static bool SimplifyIndirectBrOnSelect(IndirectBrInst *IBI, SelectInst *SI) {
2595 // Check that both operands of the select are block addresses.
2596 BlockAddress *TBA = dyn_cast<BlockAddress>(SI->getTrueValue());
2597 BlockAddress *FBA = dyn_cast<BlockAddress>(SI->getFalseValue());
2598 if (!TBA || !FBA)
2599 return false;
2600
2601 // Extract the actual blocks.
2602 BasicBlock *TrueBB = TBA->getBasicBlock();
2603 BasicBlock *FalseBB = FBA->getBasicBlock();
2604
Frits van Bommel8e158492011-01-11 12:52:11 +00002605 // Perform the actual simplification.
Manman Ren774246a2012-09-17 22:28:55 +00002606 return SimplifyTerminatorOnSelect(IBI, SI->getCondition(), TrueBB, FalseBB,
2607 0, 0);
Frits van Bommel8fb69ee2010-12-05 18:29:03 +00002608}
2609
Chris Lattnerd9bacc02010-12-13 03:18:54 +00002610/// TryToSimplifyUncondBranchWithICmpInIt - This is called when we find an icmp
2611/// instruction (a seteq/setne with a constant) as the only instruction in a
2612/// block that ends with an uncond branch. We are looking for a very specific
2613/// pattern that occurs when "A == 1 || A == 2 || A == 3" gets simplified. In
2614/// this case, we merge the first two "or's of icmp" into a switch, but then the
2615/// default value goes to an uncond block with a seteq in it, we get something
2616/// like:
2617///
2618/// switch i8 %A, label %DEFAULT [ i8 1, label %end i8 2, label %end ]
2619/// DEFAULT:
2620/// %tmp = icmp eq i8 %A, 92
2621/// br label %end
2622/// end:
2623/// ... = phi i1 [ true, %entry ], [ %tmp, %DEFAULT ], [ true, %entry ]
Andrew Trickf3cf1932012-08-29 21:46:36 +00002624///
Chris Lattnerd9bacc02010-12-13 03:18:54 +00002625/// We prefer to split the edge to 'end' so that there is a true/false entry to
2626/// the PHI, merging the third icmp into the switch.
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00002627static bool TryToSimplifyUncondBranchWithICmpInIt(
2628 ICmpInst *ICI, IRBuilder<> &Builder, const TargetTransformInfo &TTI,
2629 const DataLayout *TD) {
Chris Lattnerd9bacc02010-12-13 03:18:54 +00002630 BasicBlock *BB = ICI->getParent();
Devang Patel767f6932011-05-18 18:28:48 +00002631
Chris Lattnerd9bacc02010-12-13 03:18:54 +00002632 // If the block has any PHIs in it or the icmp has multiple uses, it is too
2633 // complex.
2634 if (isa<PHINode>(BB->begin()) || !ICI->hasOneUse()) return false;
2635
2636 Value *V = ICI->getOperand(0);
2637 ConstantInt *Cst = cast<ConstantInt>(ICI->getOperand(1));
Andrew Trickf3cf1932012-08-29 21:46:36 +00002638
Chris Lattnerd9bacc02010-12-13 03:18:54 +00002639 // The pattern we're looking for is where our only predecessor is a switch on
2640 // 'V' and this block is the default case for the switch. In this case we can
2641 // fold the compared value into the switch to simplify things.
2642 BasicBlock *Pred = BB->getSinglePredecessor();
2643 if (Pred == 0 || !isa<SwitchInst>(Pred->getTerminator())) return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002644
Chris Lattnerd9bacc02010-12-13 03:18:54 +00002645 SwitchInst *SI = cast<SwitchInst>(Pred->getTerminator());
2646 if (SI->getCondition() != V)
2647 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002648
Chris Lattnerd9bacc02010-12-13 03:18:54 +00002649 // If BB is reachable on a non-default case, then we simply know the value of
2650 // V in this block. Substitute it and constant fold the icmp instruction
2651 // away.
2652 if (SI->getDefaultDest() != BB) {
2653 ConstantInt *VVal = SI->findCaseDest(BB);
2654 assert(VVal && "Should have a unique destination value");
2655 ICI->setOperand(0, VVal);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002656
Chris Lattnerd7beca32010-12-14 06:17:25 +00002657 if (Value *V = SimplifyInstruction(ICI, TD)) {
2658 ICI->replaceAllUsesWith(V);
Chris Lattnerd9bacc02010-12-13 03:18:54 +00002659 ICI->eraseFromParent();
2660 }
2661 // BB is now empty, so it is likely to simplify away.
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00002662 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattnerd9bacc02010-12-13 03:18:54 +00002663 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002664
Chris Lattner62cc76e2010-12-13 03:43:57 +00002665 // Ok, the block is reachable from the default dest. If the constant we're
2666 // comparing exists in one of the other edges, then we can constant fold ICI
2667 // and zap it.
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00002668 if (SI->findCaseValue(Cst) != SI->case_default()) {
Chris Lattner62cc76e2010-12-13 03:43:57 +00002669 Value *V;
2670 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
2671 V = ConstantInt::getFalse(BB->getContext());
2672 else
2673 V = ConstantInt::getTrue(BB->getContext());
Andrew Trickf3cf1932012-08-29 21:46:36 +00002674
Chris Lattner62cc76e2010-12-13 03:43:57 +00002675 ICI->replaceAllUsesWith(V);
2676 ICI->eraseFromParent();
2677 // BB is now empty, so it is likely to simplify away.
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00002678 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner62cc76e2010-12-13 03:43:57 +00002679 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002680
Chris Lattnerd9bacc02010-12-13 03:18:54 +00002681 // The use of the icmp has to be in the 'end' block, by the only PHI node in
2682 // the block.
2683 BasicBlock *SuccBlock = BB->getTerminator()->getSuccessor(0);
2684 PHINode *PHIUse = dyn_cast<PHINode>(ICI->use_back());
2685 if (PHIUse == 0 || PHIUse != &SuccBlock->front() ||
2686 isa<PHINode>(++BasicBlock::iterator(PHIUse)))
2687 return false;
2688
2689 // If the icmp is a SETEQ, then the default dest gets false, the new edge gets
2690 // true in the PHI.
2691 Constant *DefaultCst = ConstantInt::getTrue(BB->getContext());
2692 Constant *NewCst = ConstantInt::getFalse(BB->getContext());
2693
2694 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
2695 std::swap(DefaultCst, NewCst);
2696
2697 // Replace ICI (which is used by the PHI for the default value) with true or
2698 // false depending on if it is EQ or NE.
2699 ICI->replaceAllUsesWith(DefaultCst);
2700 ICI->eraseFromParent();
2701
2702 // Okay, the switch goes to this block on a default value. Add an edge from
2703 // the switch to the merge point on the compared value.
2704 BasicBlock *NewBB = BasicBlock::Create(BB->getContext(), "switch.edge",
2705 BB->getParent(), BB);
Manman Rence48ea72012-09-17 23:07:43 +00002706 SmallVector<uint64_t, 8> Weights;
2707 bool HasWeights = HasBranchWeights(SI);
2708 if (HasWeights) {
2709 GetBranchWeights(SI, Weights);
2710 if (Weights.size() == 1 + SI->getNumCases()) {
2711 // Split weight for default case to case for "Cst".
2712 Weights[0] = (Weights[0]+1) >> 1;
2713 Weights.push_back(Weights[0]);
2714
2715 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
2716 SI->setMetadata(LLVMContext::MD_prof,
2717 MDBuilder(SI->getContext()).
2718 createBranchWeights(MDWeights));
2719 }
2720 }
Chris Lattnerd9bacc02010-12-13 03:18:54 +00002721 SI->addCase(Cst, NewBB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002722
Chris Lattnerd9bacc02010-12-13 03:18:54 +00002723 // NewBB branches to the phi block, add the uncond branch and the phi entry.
Devang Patel767f6932011-05-18 18:28:48 +00002724 Builder.SetInsertPoint(NewBB);
2725 Builder.SetCurrentDebugLocation(SI->getDebugLoc());
2726 Builder.CreateBr(SuccBlock);
Chris Lattnerd9bacc02010-12-13 03:18:54 +00002727 PHIUse->addIncoming(NewCst, NewBB);
2728 return true;
2729}
2730
Chris Lattnera69c4432010-12-13 05:03:41 +00002731/// SimplifyBranchOnICmpChain - The specified branch is a conditional branch.
2732/// Check to see if it is branching on an or/and chain of icmp instructions, and
2733/// fold it into a switch instruction if so.
Micah Villmowcdfe20b2012-10-08 16:38:25 +00002734static bool SimplifyBranchOnICmpChain(BranchInst *BI, const DataLayout *TD,
Devang Patel7de6c4b2011-05-18 23:18:47 +00002735 IRBuilder<> &Builder) {
Chris Lattnera69c4432010-12-13 05:03:41 +00002736 Instruction *Cond = dyn_cast<Instruction>(BI->getCondition());
2737 if (Cond == 0) return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002738
2739
Chris Lattnera69c4432010-12-13 05:03:41 +00002740 // Change br (X == 0 | X == 1), T, F into a switch instruction.
2741 // If this is a bunch of seteq's or'd together, or if it's a bunch of
2742 // 'setne's and'ed together, collect them.
2743 Value *CompVal = 0;
2744 std::vector<ConstantInt*> Values;
2745 bool TrueWhenEqual = true;
2746 Value *ExtraCase = 0;
Benjamin Kramer8d6a8c12011-02-07 22:37:28 +00002747 unsigned UsedICmps = 0;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002748
Chris Lattnera69c4432010-12-13 05:03:41 +00002749 if (Cond->getOpcode() == Instruction::Or) {
Benjamin Kramer8d6a8c12011-02-07 22:37:28 +00002750 CompVal = GatherConstantCompares(Cond, Values, ExtraCase, TD, true,
2751 UsedICmps);
Chris Lattnera69c4432010-12-13 05:03:41 +00002752 } else if (Cond->getOpcode() == Instruction::And) {
Benjamin Kramer8d6a8c12011-02-07 22:37:28 +00002753 CompVal = GatherConstantCompares(Cond, Values, ExtraCase, TD, false,
2754 UsedICmps);
Chris Lattnera69c4432010-12-13 05:03:41 +00002755 TrueWhenEqual = false;
2756 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002757
Chris Lattnera69c4432010-12-13 05:03:41 +00002758 // If we didn't have a multiply compared value, fail.
2759 if (CompVal == 0) return false;
2760
Benjamin Kramer8d6a8c12011-02-07 22:37:28 +00002761 // Avoid turning single icmps into a switch.
2762 if (UsedICmps <= 1)
2763 return false;
2764
Chris Lattnera69c4432010-12-13 05:03:41 +00002765 // There might be duplicate constants in the list, which the switch
2766 // instruction can't handle, remove them now.
2767 array_pod_sort(Values.begin(), Values.end(), ConstantIntSortPredicate);
2768 Values.erase(std::unique(Values.begin(), Values.end()), Values.end());
Andrew Trickf3cf1932012-08-29 21:46:36 +00002769
Chris Lattnera69c4432010-12-13 05:03:41 +00002770 // If Extra was used, we require at least two switch values to do the
2771 // transformation. A switch with one value is just an cond branch.
2772 if (ExtraCase && Values.size() < 2) return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002773
Andrew Trick3051aa12012-08-29 21:46:38 +00002774 // TODO: Preserve branch weight metadata, similarly to how
2775 // FoldValueComparisonIntoPredecessors preserves it.
2776
Chris Lattnera69c4432010-12-13 05:03:41 +00002777 // Figure out which block is which destination.
2778 BasicBlock *DefaultBB = BI->getSuccessor(1);
2779 BasicBlock *EdgeBB = BI->getSuccessor(0);
2780 if (!TrueWhenEqual) std::swap(DefaultBB, EdgeBB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002781
Chris Lattnera69c4432010-12-13 05:03:41 +00002782 BasicBlock *BB = BI->getParent();
Andrew Trickf3cf1932012-08-29 21:46:36 +00002783
Chris Lattnerd7beca32010-12-14 06:17:25 +00002784 DEBUG(dbgs() << "Converting 'icmp' chain with " << Values.size()
Chris Lattner5a9d59d2010-12-14 05:57:30 +00002785 << " cases into SWITCH. BB is:\n" << *BB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002786
Chris Lattnera69c4432010-12-13 05:03:41 +00002787 // If there are any extra values that couldn't be folded into the switch
2788 // then we evaluate them with an explicit branch first. Split the block
2789 // right before the condbr to handle it.
2790 if (ExtraCase) {
2791 BasicBlock *NewBB = BB->splitBasicBlock(BI, "switch.early.test");
2792 // Remove the uncond branch added to the old block.
2793 TerminatorInst *OldTI = BB->getTerminator();
Devang Patel7de6c4b2011-05-18 23:18:47 +00002794 Builder.SetInsertPoint(OldTI);
2795
Chris Lattner5a9d59d2010-12-14 05:57:30 +00002796 if (TrueWhenEqual)
Devang Patel7de6c4b2011-05-18 23:18:47 +00002797 Builder.CreateCondBr(ExtraCase, EdgeBB, NewBB);
Chris Lattner5a9d59d2010-12-14 05:57:30 +00002798 else
Devang Patel7de6c4b2011-05-18 23:18:47 +00002799 Builder.CreateCondBr(ExtraCase, NewBB, EdgeBB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002800
Chris Lattnera69c4432010-12-13 05:03:41 +00002801 OldTI->eraseFromParent();
Andrew Trickf3cf1932012-08-29 21:46:36 +00002802
Chris Lattnercb570f82010-12-13 05:34:18 +00002803 // If there are PHI nodes in EdgeBB, then we need to add a new entry to them
2804 // for the edge we just added.
Chris Lattner0f4d67b2010-12-14 07:09:42 +00002805 AddPredecessorToBlock(EdgeBB, BB, NewBB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002806
Chris Lattnerd7beca32010-12-14 06:17:25 +00002807 DEBUG(dbgs() << " ** 'icmp' chain unhandled condition: " << *ExtraCase
2808 << "\nEXTRABB = " << *BB);
Chris Lattnera69c4432010-12-13 05:03:41 +00002809 BB = NewBB;
2810 }
Devang Patel7de6c4b2011-05-18 23:18:47 +00002811
2812 Builder.SetInsertPoint(BI);
Chris Lattnera69c4432010-12-13 05:03:41 +00002813 // Convert pointer to int before we switch.
2814 if (CompVal->getType()->isPointerTy()) {
Micah Villmowcdfe20b2012-10-08 16:38:25 +00002815 assert(TD && "Cannot switch on pointer without DataLayout");
Devang Patel7de6c4b2011-05-18 23:18:47 +00002816 CompVal = Builder.CreatePtrToInt(CompVal,
Matt Arsenaultfa646592013-10-21 18:55:08 +00002817 TD->getIntPtrType(CompVal->getType()),
Devang Patel7de6c4b2011-05-18 23:18:47 +00002818 "magicptr");
Chris Lattnera69c4432010-12-13 05:03:41 +00002819 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002820
Chris Lattnera69c4432010-12-13 05:03:41 +00002821 // Create the new switch instruction now.
Devang Patel7de6c4b2011-05-18 23:18:47 +00002822 SwitchInst *New = Builder.CreateSwitch(CompVal, DefaultBB, Values.size());
Devang Patelb849cd52011-05-17 23:29:05 +00002823
Chris Lattnera69c4432010-12-13 05:03:41 +00002824 // Add all of the 'cases' to the switch instruction.
2825 for (unsigned i = 0, e = Values.size(); i != e; ++i)
2826 New->addCase(Values[i], EdgeBB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002827
Chris Lattnera69c4432010-12-13 05:03:41 +00002828 // We added edges from PI to the EdgeBB. As such, if there were any
2829 // PHI nodes in EdgeBB, they need entries to be added corresponding to
2830 // the number of edges added.
2831 for (BasicBlock::iterator BBI = EdgeBB->begin();
2832 isa<PHINode>(BBI); ++BBI) {
2833 PHINode *PN = cast<PHINode>(BBI);
2834 Value *InVal = PN->getIncomingValueForBlock(BB);
2835 for (unsigned i = 0, e = Values.size()-1; i != e; ++i)
2836 PN->addIncoming(InVal, BB);
2837 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002838
Chris Lattnera69c4432010-12-13 05:03:41 +00002839 // Erase the old branch instruction.
2840 EraseTerminatorInstAndDCECond(BI);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002841
Chris Lattnerd7beca32010-12-14 06:17:25 +00002842 DEBUG(dbgs() << " ** 'icmp' chain result is:\n" << *BB << '\n');
Chris Lattnera69c4432010-12-13 05:03:41 +00002843 return true;
2844}
2845
Duncan Sands29192d02011-09-05 12:57:57 +00002846bool SimplifyCFGOpt::SimplifyResume(ResumeInst *RI, IRBuilder<> &Builder) {
2847 // If this is a trivial landing pad that just continues unwinding the caught
2848 // exception then zap the landing pad, turning its invokes into calls.
2849 BasicBlock *BB = RI->getParent();
2850 LandingPadInst *LPInst = dyn_cast<LandingPadInst>(BB->getFirstNonPHI());
2851 if (RI->getValue() != LPInst)
2852 // Not a landing pad, or the resume is not unwinding the exception that
2853 // caused control to branch here.
2854 return false;
2855
2856 // Check that there are no other instructions except for debug intrinsics.
2857 BasicBlock::iterator I = LPInst, E = RI;
2858 while (++I != E)
2859 if (!isa<DbgInfoIntrinsic>(I))
2860 return false;
2861
2862 // Turn all invokes that unwind here into calls and delete the basic block.
Bill Wendling9534d882013-03-11 20:53:00 +00002863 bool InvokeRequiresTableEntry = false;
2864 bool Changed = false;
Duncan Sands29192d02011-09-05 12:57:57 +00002865 for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE;) {
2866 InvokeInst *II = cast<InvokeInst>((*PI++)->getTerminator());
Bill Wendling9534d882013-03-11 20:53:00 +00002867
2868 if (II->hasFnAttr(Attribute::UWTable)) {
2869 // Don't remove an `invoke' instruction if the ABI requires an entry into
2870 // the table.
2871 InvokeRequiresTableEntry = true;
2872 continue;
2873 }
2874
Duncan Sands29192d02011-09-05 12:57:57 +00002875 SmallVector<Value*, 8> Args(II->op_begin(), II->op_end() - 3);
Bill Wendling9534d882013-03-11 20:53:00 +00002876
Duncan Sands29192d02011-09-05 12:57:57 +00002877 // Insert a call instruction before the invoke.
2878 CallInst *Call = CallInst::Create(II->getCalledValue(), Args, "", II);
2879 Call->takeName(II);
2880 Call->setCallingConv(II->getCallingConv());
2881 Call->setAttributes(II->getAttributes());
2882 Call->setDebugLoc(II->getDebugLoc());
2883
2884 // Anything that used the value produced by the invoke instruction now uses
2885 // the value produced by the call instruction. Note that we do this even
2886 // for void functions and calls with no uses so that the callgraph edge is
2887 // updated.
2888 II->replaceAllUsesWith(Call);
2889 BB->removePredecessor(II->getParent());
2890
2891 // Insert a branch to the normal destination right before the invoke.
2892 BranchInst::Create(II->getNormalDest(), II);
2893
2894 // Finally, delete the invoke instruction!
2895 II->eraseFromParent();
Bill Wendling9534d882013-03-11 20:53:00 +00002896 Changed = true;
Duncan Sands29192d02011-09-05 12:57:57 +00002897 }
2898
Bill Wendling9534d882013-03-11 20:53:00 +00002899 if (!InvokeRequiresTableEntry)
2900 // The landingpad is now unreachable. Zap it.
2901 BB->eraseFromParent();
2902
2903 return Changed;
Duncan Sands29192d02011-09-05 12:57:57 +00002904}
2905
Devang Pateldd14e0f2011-05-18 21:33:11 +00002906bool SimplifyCFGOpt::SimplifyReturn(ReturnInst *RI, IRBuilder<> &Builder) {
Chris Lattner25c3af32010-12-13 06:25:44 +00002907 BasicBlock *BB = RI->getParent();
2908 if (!BB->getFirstNonPHIOrDbg()->isTerminator()) return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002909
Chris Lattner25c3af32010-12-13 06:25:44 +00002910 // Find predecessors that end with branches.
2911 SmallVector<BasicBlock*, 8> UncondBranchPreds;
2912 SmallVector<BranchInst*, 8> CondBranchPreds;
2913 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
2914 BasicBlock *P = *PI;
2915 TerminatorInst *PTI = P->getTerminator();
2916 if (BranchInst *BI = dyn_cast<BranchInst>(PTI)) {
2917 if (BI->isUnconditional())
2918 UncondBranchPreds.push_back(P);
2919 else
2920 CondBranchPreds.push_back(BI);
2921 }
2922 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002923
Chris Lattner25c3af32010-12-13 06:25:44 +00002924 // If we found some, do the transformation!
Evan Chengd983eba2011-01-29 04:46:23 +00002925 if (!UncondBranchPreds.empty() && DupRet) {
Chris Lattner25c3af32010-12-13 06:25:44 +00002926 while (!UncondBranchPreds.empty()) {
2927 BasicBlock *Pred = UncondBranchPreds.pop_back_val();
2928 DEBUG(dbgs() << "FOLDING: " << *BB
2929 << "INTO UNCOND BRANCH PRED: " << *Pred);
Evan Chengd983eba2011-01-29 04:46:23 +00002930 (void)FoldReturnIntoUncondBranch(RI, BB, Pred);
Chris Lattner25c3af32010-12-13 06:25:44 +00002931 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002932
Chris Lattner25c3af32010-12-13 06:25:44 +00002933 // If we eliminated all predecessors of the block, delete the block now.
2934 if (pred_begin(BB) == pred_end(BB))
2935 // We know there are no successors, so just nuke the block.
2936 BB->eraseFromParent();
Andrew Trickf3cf1932012-08-29 21:46:36 +00002937
Chris Lattner25c3af32010-12-13 06:25:44 +00002938 return true;
2939 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002940
Chris Lattner25c3af32010-12-13 06:25:44 +00002941 // Check out all of the conditional branches going to this return
2942 // instruction. If any of them just select between returns, change the
2943 // branch itself into a select/return pair.
2944 while (!CondBranchPreds.empty()) {
2945 BranchInst *BI = CondBranchPreds.pop_back_val();
Andrew Trickf3cf1932012-08-29 21:46:36 +00002946
Chris Lattner25c3af32010-12-13 06:25:44 +00002947 // Check to see if the non-BB successor is also a return block.
2948 if (isa<ReturnInst>(BI->getSuccessor(0)->getTerminator()) &&
2949 isa<ReturnInst>(BI->getSuccessor(1)->getTerminator()) &&
Devang Pateldd14e0f2011-05-18 21:33:11 +00002950 SimplifyCondBranchToTwoReturns(BI, Builder))
Chris Lattner25c3af32010-12-13 06:25:44 +00002951 return true;
2952 }
2953 return false;
2954}
2955
Chris Lattner25c3af32010-12-13 06:25:44 +00002956bool SimplifyCFGOpt::SimplifyUnreachable(UnreachableInst *UI) {
2957 BasicBlock *BB = UI->getParent();
Andrew Trickf3cf1932012-08-29 21:46:36 +00002958
Chris Lattner25c3af32010-12-13 06:25:44 +00002959 bool Changed = false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002960
Chris Lattner25c3af32010-12-13 06:25:44 +00002961 // If there are any instructions immediately before the unreachable that can
2962 // be removed, do so.
2963 while (UI != BB->begin()) {
2964 BasicBlock::iterator BBI = UI;
2965 --BBI;
Eli Friedman0ffdf2e2011-08-15 23:59:28 +00002966 // Do not delete instructions that can have side effects which might cause
2967 // the unreachable to not be reachable; specifically, calls and volatile
2968 // operations may have this effect.
Chris Lattner25c3af32010-12-13 06:25:44 +00002969 if (isa<CallInst>(BBI) && !isa<DbgInfoIntrinsic>(BBI)) break;
Eli Friedman0ffdf2e2011-08-15 23:59:28 +00002970
2971 if (BBI->mayHaveSideEffects()) {
2972 if (StoreInst *SI = dyn_cast<StoreInst>(BBI)) {
2973 if (SI->isVolatile())
2974 break;
2975 } else if (LoadInst *LI = dyn_cast<LoadInst>(BBI)) {
2976 if (LI->isVolatile())
2977 break;
2978 } else if (AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(BBI)) {
2979 if (RMWI->isVolatile())
2980 break;
2981 } else if (AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(BBI)) {
2982 if (CXI->isVolatile())
2983 break;
2984 } else if (!isa<FenceInst>(BBI) && !isa<VAArgInst>(BBI) &&
2985 !isa<LandingPadInst>(BBI)) {
Chris Lattner25c3af32010-12-13 06:25:44 +00002986 break;
Eli Friedman0ffdf2e2011-08-15 23:59:28 +00002987 }
Bill Wendling55d875f2011-08-16 20:41:17 +00002988 // Note that deleting LandingPad's here is in fact okay, although it
2989 // involves a bit of subtle reasoning. If this inst is a LandingPad,
2990 // all the predecessors of this block will be the unwind edges of Invokes,
2991 // and we can therefore guarantee this block will be erased.
Eli Friedman0ffdf2e2011-08-15 23:59:28 +00002992 }
2993
Eli Friedmanaac35b32011-03-09 00:48:33 +00002994 // Delete this instruction (any uses are guaranteed to be dead)
2995 if (!BBI->use_empty())
2996 BBI->replaceAllUsesWith(UndefValue::get(BBI->getType()));
Chris Lattnerd7beca32010-12-14 06:17:25 +00002997 BBI->eraseFromParent();
Chris Lattner25c3af32010-12-13 06:25:44 +00002998 Changed = true;
2999 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003000
Chris Lattner25c3af32010-12-13 06:25:44 +00003001 // If the unreachable instruction is the first in the block, take a gander
3002 // at all of the predecessors of this instruction, and simplify them.
3003 if (&BB->front() != UI) return Changed;
Andrew Trickf3cf1932012-08-29 21:46:36 +00003004
Chris Lattner25c3af32010-12-13 06:25:44 +00003005 SmallVector<BasicBlock*, 8> Preds(pred_begin(BB), pred_end(BB));
3006 for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
3007 TerminatorInst *TI = Preds[i]->getTerminator();
Devang Patel31458a02011-05-19 00:09:21 +00003008 IRBuilder<> Builder(TI);
Chris Lattner25c3af32010-12-13 06:25:44 +00003009 if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
3010 if (BI->isUnconditional()) {
3011 if (BI->getSuccessor(0) == BB) {
3012 new UnreachableInst(TI->getContext(), TI);
3013 TI->eraseFromParent();
3014 Changed = true;
3015 }
3016 } else {
3017 if (BI->getSuccessor(0) == BB) {
Devang Patel31458a02011-05-19 00:09:21 +00003018 Builder.CreateBr(BI->getSuccessor(1));
Chris Lattner25c3af32010-12-13 06:25:44 +00003019 EraseTerminatorInstAndDCECond(BI);
3020 } else if (BI->getSuccessor(1) == BB) {
Devang Patel31458a02011-05-19 00:09:21 +00003021 Builder.CreateBr(BI->getSuccessor(0));
Chris Lattner25c3af32010-12-13 06:25:44 +00003022 EraseTerminatorInstAndDCECond(BI);
3023 Changed = true;
3024 }
3025 }
3026 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00003027 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003028 i != e; ++i)
3029 if (i.getCaseSuccessor() == BB) {
Chris Lattner25c3af32010-12-13 06:25:44 +00003030 BB->removePredecessor(SI->getParent());
3031 SI->removeCase(i);
3032 --i; --e;
3033 Changed = true;
3034 }
3035 // If the default value is unreachable, figure out the most popular
3036 // destination and make it the default.
Stepan Dyatkovskiy513aaa52012-02-01 07:49:51 +00003037 if (SI->getDefaultDest() == BB) {
Eli Friedmanc4414c62011-03-15 02:23:35 +00003038 std::map<BasicBlock*, std::pair<unsigned, unsigned> > Popularity;
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00003039 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003040 i != e; ++i) {
Nick Lewyckye87d54c2011-12-26 20:37:40 +00003041 std::pair<unsigned, unsigned> &entry =
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003042 Popularity[i.getCaseSuccessor()];
Eli Friedmanc4414c62011-03-15 02:23:35 +00003043 if (entry.first == 0) {
3044 entry.first = 1;
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003045 entry.second = i.getCaseIndex();
Eli Friedmanc4414c62011-03-15 02:23:35 +00003046 } else {
3047 entry.first++;
3048 }
3049 }
3050
Chris Lattner25c3af32010-12-13 06:25:44 +00003051 // Find the most popular block.
3052 unsigned MaxPop = 0;
Eli Friedmanc4414c62011-03-15 02:23:35 +00003053 unsigned MaxIndex = 0;
Chris Lattner25c3af32010-12-13 06:25:44 +00003054 BasicBlock *MaxBlock = 0;
Eli Friedmanc4414c62011-03-15 02:23:35 +00003055 for (std::map<BasicBlock*, std::pair<unsigned, unsigned> >::iterator
Chris Lattner25c3af32010-12-13 06:25:44 +00003056 I = Popularity.begin(), E = Popularity.end(); I != E; ++I) {
Andrew Trickf3cf1932012-08-29 21:46:36 +00003057 if (I->second.first > MaxPop ||
Eli Friedmanc4414c62011-03-15 02:23:35 +00003058 (I->second.first == MaxPop && MaxIndex > I->second.second)) {
3059 MaxPop = I->second.first;
3060 MaxIndex = I->second.second;
Chris Lattner25c3af32010-12-13 06:25:44 +00003061 MaxBlock = I->first;
3062 }
3063 }
3064 if (MaxBlock) {
3065 // Make this the new default, allowing us to delete any explicit
3066 // edges to it.
Stepan Dyatkovskiy513aaa52012-02-01 07:49:51 +00003067 SI->setDefaultDest(MaxBlock);
Chris Lattner25c3af32010-12-13 06:25:44 +00003068 Changed = true;
Andrew Trickf3cf1932012-08-29 21:46:36 +00003069
Chris Lattner25c3af32010-12-13 06:25:44 +00003070 // If MaxBlock has phinodes in it, remove MaxPop-1 entries from
3071 // it.
3072 if (isa<PHINode>(MaxBlock->begin()))
3073 for (unsigned i = 0; i != MaxPop-1; ++i)
3074 MaxBlock->removePredecessor(SI->getParent());
Andrew Trickf3cf1932012-08-29 21:46:36 +00003075
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00003076 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003077 i != e; ++i)
3078 if (i.getCaseSuccessor() == MaxBlock) {
Chris Lattner25c3af32010-12-13 06:25:44 +00003079 SI->removeCase(i);
3080 --i; --e;
3081 }
3082 }
3083 }
3084 } else if (InvokeInst *II = dyn_cast<InvokeInst>(TI)) {
3085 if (II->getUnwindDest() == BB) {
3086 // Convert the invoke to a call instruction. This would be a good
3087 // place to note that the call does not throw though.
Devang Patel31458a02011-05-19 00:09:21 +00003088 BranchInst *BI = Builder.CreateBr(II->getNormalDest());
Chris Lattner25c3af32010-12-13 06:25:44 +00003089 II->removeFromParent(); // Take out of symbol table
Andrew Trickf3cf1932012-08-29 21:46:36 +00003090
Chris Lattner25c3af32010-12-13 06:25:44 +00003091 // Insert the call now...
3092 SmallVector<Value*, 8> Args(II->op_begin(), II->op_end()-3);
Devang Patel31458a02011-05-19 00:09:21 +00003093 Builder.SetInsertPoint(BI);
3094 CallInst *CI = Builder.CreateCall(II->getCalledValue(),
Jay Foad5bd375a2011-07-15 08:37:34 +00003095 Args, II->getName());
Chris Lattner25c3af32010-12-13 06:25:44 +00003096 CI->setCallingConv(II->getCallingConv());
3097 CI->setAttributes(II->getAttributes());
3098 // If the invoke produced a value, the call does now instead.
3099 II->replaceAllUsesWith(CI);
3100 delete II;
3101 Changed = true;
3102 }
3103 }
3104 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003105
Chris Lattner25c3af32010-12-13 06:25:44 +00003106 // If this block is now dead, remove it.
3107 if (pred_begin(BB) == pred_end(BB) &&
3108 BB != &BB->getParent()->getEntryBlock()) {
3109 // We know there are no successors, so just nuke the block.
3110 BB->eraseFromParent();
3111 return true;
3112 }
3113
3114 return Changed;
3115}
3116
Benjamin Kramerf4ea1d52011-02-02 15:56:22 +00003117/// TurnSwitchRangeIntoICmp - Turns a switch with that contains only a
3118/// integer range comparison into a sub, an icmp and a branch.
Devang Patela7ec47d2011-05-18 20:35:38 +00003119static bool TurnSwitchRangeIntoICmp(SwitchInst *SI, IRBuilder<> &Builder) {
Stepan Dyatkovskiy513aaa52012-02-01 07:49:51 +00003120 assert(SI->getNumCases() > 1 && "Degenerate switch?");
Benjamin Kramerf4ea1d52011-02-02 15:56:22 +00003121
Benjamin Kramer62aa46b2011-02-03 22:51:41 +00003122 // Make sure all cases point to the same destination and gather the values.
3123 SmallVector<ConstantInt *, 16> Cases;
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00003124 SwitchInst::CaseIt I = SI->case_begin();
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003125 Cases.push_back(I.getCaseValue());
3126 SwitchInst::CaseIt PrevI = I++;
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00003127 for (SwitchInst::CaseIt E = SI->case_end(); I != E; PrevI = I++) {
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003128 if (PrevI.getCaseSuccessor() != I.getCaseSuccessor())
Benjamin Kramer62aa46b2011-02-03 22:51:41 +00003129 return false;
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003130 Cases.push_back(I.getCaseValue());
Benjamin Kramer62aa46b2011-02-03 22:51:41 +00003131 }
Stepan Dyatkovskiy513aaa52012-02-01 07:49:51 +00003132 assert(Cases.size() == SI->getNumCases() && "Not all cases gathered");
Benjamin Kramer62aa46b2011-02-03 22:51:41 +00003133
3134 // Sort the case values, then check if they form a range we can transform.
3135 array_pod_sort(Cases.begin(), Cases.end(), ConstantIntSortPredicate);
3136 for (unsigned I = 1, E = Cases.size(); I != E; ++I) {
3137 if (Cases[I-1]->getValue() != Cases[I]->getValue()+1)
3138 return false;
3139 }
3140
3141 Constant *Offset = ConstantExpr::getNeg(Cases.back());
Stepan Dyatkovskiy513aaa52012-02-01 07:49:51 +00003142 Constant *NumCases = ConstantInt::get(Offset->getType(), SI->getNumCases());
Benjamin Kramerf4ea1d52011-02-02 15:56:22 +00003143
Benjamin Kramer8d6a8c12011-02-07 22:37:28 +00003144 Value *Sub = SI->getCondition();
3145 if (!Offset->isNullValue())
Devang Patel3015a542011-05-19 00:13:33 +00003146 Sub = Builder.CreateAdd(Sub, Offset, Sub->getName()+".off");
Hans Wennborgc9e1d992013-04-16 08:35:36 +00003147 Value *Cmp;
3148 // If NumCases overflowed, then all possible values jump to the successor.
3149 if (NumCases->isNullValue() && SI->getNumCases() != 0)
3150 Cmp = ConstantInt::getTrue(SI->getContext());
3151 else
3152 Cmp = Builder.CreateICmpULT(Sub, NumCases, "switch");
Manman Ren56575552012-09-18 00:47:33 +00003153 BranchInst *NewBI = Builder.CreateCondBr(
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00003154 Cmp, SI->case_begin().getCaseSuccessor(), SI->getDefaultDest());
Benjamin Kramerf4ea1d52011-02-02 15:56:22 +00003155
Manman Ren56575552012-09-18 00:47:33 +00003156 // Update weight for the newly-created conditional branch.
3157 SmallVector<uint64_t, 8> Weights;
3158 bool HasWeights = HasBranchWeights(SI);
3159 if (HasWeights) {
3160 GetBranchWeights(SI, Weights);
3161 if (Weights.size() == 1 + SI->getNumCases()) {
3162 // Combine all weights for the cases to be the true weight of NewBI.
3163 // We assume that the sum of all weights for a Terminator can fit into 32
3164 // bits.
3165 uint32_t NewTrueWeight = 0;
3166 for (unsigned I = 1, E = Weights.size(); I != E; ++I)
3167 NewTrueWeight += (uint32_t)Weights[I];
3168 NewBI->setMetadata(LLVMContext::MD_prof,
3169 MDBuilder(SI->getContext()).
3170 createBranchWeights(NewTrueWeight,
3171 (uint32_t)Weights[0]));
3172 }
3173 }
3174
Benjamin Kramerf4ea1d52011-02-02 15:56:22 +00003175 // Prune obsolete incoming values off the successor's PHI nodes.
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00003176 for (BasicBlock::iterator BBI = SI->case_begin().getCaseSuccessor()->begin();
Benjamin Kramerf4ea1d52011-02-02 15:56:22 +00003177 isa<PHINode>(BBI); ++BBI) {
Stepan Dyatkovskiy513aaa52012-02-01 07:49:51 +00003178 for (unsigned I = 0, E = SI->getNumCases()-1; I != E; ++I)
Benjamin Kramerf4ea1d52011-02-02 15:56:22 +00003179 cast<PHINode>(BBI)->removeIncomingValue(SI->getParent());
3180 }
3181 SI->eraseFromParent();
3182
3183 return true;
3184}
Chris Lattner25c3af32010-12-13 06:25:44 +00003185
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003186/// EliminateDeadSwitchCases - Compute masked bits for the condition of a switch
3187/// and use it to remove dead cases.
3188static bool EliminateDeadSwitchCases(SwitchInst *SI) {
3189 Value *Cond = SI->getCondition();
Matt Arsenault8227b9f2013-09-06 00:37:24 +00003190 unsigned Bits = Cond->getType()->getIntegerBitWidth();
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003191 APInt KnownZero(Bits, 0), KnownOne(Bits, 0);
Rafael Espindolaba0a6ca2012-04-04 12:51:34 +00003192 ComputeMaskedBits(Cond, KnownZero, KnownOne);
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003193
3194 // Gather dead cases.
3195 SmallVector<ConstantInt*, 8> DeadCases;
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00003196 for (SwitchInst::CaseIt I = SI->case_begin(), E = SI->case_end(); I != E; ++I) {
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003197 if ((I.getCaseValue()->getValue() & KnownZero) != 0 ||
3198 (I.getCaseValue()->getValue() & KnownOne) != KnownOne) {
3199 DeadCases.push_back(I.getCaseValue());
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003200 DEBUG(dbgs() << "SimplifyCFG: switch case '"
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003201 << I.getCaseValue() << "' is dead.\n");
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003202 }
3203 }
3204
Manman Ren56575552012-09-18 00:47:33 +00003205 SmallVector<uint64_t, 8> Weights;
3206 bool HasWeight = HasBranchWeights(SI);
3207 if (HasWeight) {
3208 GetBranchWeights(SI, Weights);
3209 HasWeight = (Weights.size() == 1 + SI->getNumCases());
3210 }
3211
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003212 // Remove dead cases from the switch.
3213 for (unsigned I = 0, E = DeadCases.size(); I != E; ++I) {
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003214 SwitchInst::CaseIt Case = SI->findCaseValue(DeadCases[I]);
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00003215 assert(Case != SI->case_default() &&
Stepan Dyatkovskiy513aaa52012-02-01 07:49:51 +00003216 "Case was not found. Probably mistake in DeadCases forming.");
Manman Ren56575552012-09-18 00:47:33 +00003217 if (HasWeight) {
3218 std::swap(Weights[Case.getCaseIndex()+1], Weights.back());
3219 Weights.pop_back();
3220 }
3221
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003222 // Prune unused values from PHI nodes.
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003223 Case.getCaseSuccessor()->removePredecessor(SI->getParent());
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003224 SI->removeCase(Case);
3225 }
Justin Bogner0ba3f212013-12-20 08:21:30 +00003226 if (HasWeight && Weights.size() >= 2) {
Manman Ren56575552012-09-18 00:47:33 +00003227 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
3228 SI->setMetadata(LLVMContext::MD_prof,
3229 MDBuilder(SI->getParent()->getContext()).
3230 createBranchWeights(MDWeights));
3231 }
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003232
3233 return !DeadCases.empty();
3234}
3235
Hans Wennborg4ab4a8e2011-06-18 10:28:47 +00003236/// FindPHIForConditionForwarding - If BB would be eligible for simplification
3237/// by TryToSimplifyUncondBranchFromEmptyBlock (i.e. it is empty and terminated
3238/// by an unconditional branch), look at the phi node for BB in the successor
3239/// block and see if the incoming value is equal to CaseValue. If so, return
3240/// the phi node, and set PhiIndex to BB's index in the phi node.
3241static PHINode *FindPHIForConditionForwarding(ConstantInt *CaseValue,
3242 BasicBlock *BB,
3243 int *PhiIndex) {
3244 if (BB->getFirstNonPHIOrDbg() != BB->getTerminator())
3245 return NULL; // BB must be empty to be a candidate for simplification.
3246 if (!BB->getSinglePredecessor())
3247 return NULL; // BB must be dominated by the switch.
3248
3249 BranchInst *Branch = dyn_cast<BranchInst>(BB->getTerminator());
3250 if (!Branch || !Branch->isUnconditional())
3251 return NULL; // Terminator must be unconditional branch.
3252
3253 BasicBlock *Succ = Branch->getSuccessor(0);
3254
3255 BasicBlock::iterator I = Succ->begin();
3256 while (PHINode *PHI = dyn_cast<PHINode>(I++)) {
3257 int Idx = PHI->getBasicBlockIndex(BB);
3258 assert(Idx >= 0 && "PHI has no entry for predecessor?");
3259
3260 Value *InValue = PHI->getIncomingValue(Idx);
3261 if (InValue != CaseValue) continue;
3262
3263 *PhiIndex = Idx;
3264 return PHI;
3265 }
3266
3267 return NULL;
3268}
3269
3270/// ForwardSwitchConditionToPHI - Try to forward the condition of a switch
3271/// instruction to a phi node dominated by the switch, if that would mean that
3272/// some of the destination blocks of the switch can be folded away.
3273/// Returns true if a change is made.
3274static bool ForwardSwitchConditionToPHI(SwitchInst *SI) {
3275 typedef DenseMap<PHINode*, SmallVector<int,4> > ForwardingNodesMap;
3276 ForwardingNodesMap ForwardingNodes;
3277
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00003278 for (SwitchInst::CaseIt I = SI->case_begin(), E = SI->case_end(); I != E; ++I) {
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003279 ConstantInt *CaseValue = I.getCaseValue();
3280 BasicBlock *CaseDest = I.getCaseSuccessor();
Hans Wennborg4ab4a8e2011-06-18 10:28:47 +00003281
3282 int PhiIndex;
3283 PHINode *PHI = FindPHIForConditionForwarding(CaseValue, CaseDest,
3284 &PhiIndex);
3285 if (!PHI) continue;
3286
3287 ForwardingNodes[PHI].push_back(PhiIndex);
3288 }
3289
3290 bool Changed = false;
3291
3292 for (ForwardingNodesMap::iterator I = ForwardingNodes.begin(),
3293 E = ForwardingNodes.end(); I != E; ++I) {
3294 PHINode *Phi = I->first;
Craig Topperb94011f2013-07-14 04:42:23 +00003295 SmallVectorImpl<int> &Indexes = I->second;
Hans Wennborg4ab4a8e2011-06-18 10:28:47 +00003296
3297 if (Indexes.size() < 2) continue;
3298
3299 for (size_t I = 0, E = Indexes.size(); I != E; ++I)
3300 Phi->setIncomingValue(Indexes[I], SI->getCondition());
3301 Changed = true;
3302 }
3303
3304 return Changed;
3305}
3306
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003307/// ValidLookupTableConstant - Return true if the backend will be able to handle
3308/// initializing an array of constants like C.
Hans Wennborg08238ad2012-09-07 08:22:57 +00003309static bool ValidLookupTableConstant(Constant *C) {
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003310 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
3311 return CE->isGEPWithNoNotionalOverIndexing();
3312
3313 return isa<ConstantFP>(C) ||
3314 isa<ConstantInt>(C) ||
3315 isa<ConstantPointerNull>(C) ||
3316 isa<GlobalValue>(C) ||
3317 isa<UndefValue>(C);
3318}
3319
Hans Wennborg09acdb92012-10-31 15:14:39 +00003320/// LookupConstant - If V is a Constant, return it. Otherwise, try to look up
Hans Wennborg4fef2fe2012-10-31 15:31:09 +00003321/// its constant value in ConstantPool, returning 0 if it's not there.
Hans Wennborg09acdb92012-10-31 15:14:39 +00003322static Constant *LookupConstant(Value *V,
3323 const SmallDenseMap<Value*, Constant*>& ConstantPool) {
3324 if (Constant *C = dyn_cast<Constant>(V))
3325 return C;
3326 return ConstantPool.lookup(V);
3327}
3328
Hans Wennborg9e74dd92012-10-31 13:42:45 +00003329/// ConstantFold - Try to fold instruction I into a constant. This works for
3330/// simple instructions such as binary operations where both operands are
3331/// constant or can be replaced by constants from the ConstantPool. Returns the
Hans Wennborg4fef2fe2012-10-31 15:31:09 +00003332/// resulting constant on success, 0 otherwise.
Benjamin Kramer7c302602013-11-12 12:24:36 +00003333static Constant *
3334ConstantFold(Instruction *I,
3335 const SmallDenseMap<Value *, Constant *> &ConstantPool,
3336 const DataLayout *DL) {
Hans Wennborg9e74dd92012-10-31 13:42:45 +00003337 if (SelectInst *Select = dyn_cast<SelectInst>(I)) {
Hans Wennborg09acdb92012-10-31 15:14:39 +00003338 Constant *A = LookupConstant(Select->getCondition(), ConstantPool);
3339 if (!A)
3340 return 0;
3341 if (A->isAllOnesValue())
3342 return LookupConstant(Select->getTrueValue(), ConstantPool);
3343 if (A->isNullValue())
3344 return LookupConstant(Select->getFalseValue(), ConstantPool);
Hans Wennborg4fef2fe2012-10-31 15:31:09 +00003345 return 0;
Hans Wennborg9e74dd92012-10-31 13:42:45 +00003346 }
3347
Benjamin Kramer7c302602013-11-12 12:24:36 +00003348 SmallVector<Constant *, 4> COps;
3349 for (unsigned N = 0, E = I->getNumOperands(); N != E; ++N) {
3350 if (Constant *A = LookupConstant(I->getOperand(N), ConstantPool))
3351 COps.push_back(A);
3352 else
Hans Wennborg09acdb92012-10-31 15:14:39 +00003353 return 0;
Hans Wennborg9e74dd92012-10-31 13:42:45 +00003354 }
3355
Benjamin Kramer7c302602013-11-12 12:24:36 +00003356 if (CmpInst *Cmp = dyn_cast<CmpInst>(I))
3357 return ConstantFoldCompareInstOperands(Cmp->getPredicate(), COps[0],
3358 COps[1], DL);
3359
3360 return ConstantFoldInstOperands(I->getOpcode(), I->getType(), COps, DL);
Hans Wennborg9e74dd92012-10-31 13:42:45 +00003361}
3362
3363/// GetCaseResults - Try to determine the resulting constant values in phi nodes
3364/// at the common destination basic block, *CommonDest, for one of the case
Hans Wennborg4fef2fe2012-10-31 15:31:09 +00003365/// destionations CaseDest corresponding to value CaseVal (0 for the default
Hans Wennborg9e74dd92012-10-31 13:42:45 +00003366/// case), of a switch instruction SI.
Craig Topperb94011f2013-07-14 04:42:23 +00003367static bool
3368GetCaseResults(SwitchInst *SI,
3369 ConstantInt *CaseVal,
3370 BasicBlock *CaseDest,
3371 BasicBlock **CommonDest,
Benjamin Kramer7c302602013-11-12 12:24:36 +00003372 SmallVectorImpl<std::pair<PHINode *, Constant *> > &Res,
3373 const DataLayout *DL) {
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003374 // The block from which we enter the common destination.
3375 BasicBlock *Pred = SI->getParent();
3376
Hans Wennborg9e74dd92012-10-31 13:42:45 +00003377 // If CaseDest is empty except for some side-effect free instructions through
3378 // which we can constant-propagate the CaseVal, continue to its successor.
3379 SmallDenseMap<Value*, Constant*> ConstantPool;
3380 ConstantPool.insert(std::make_pair(SI->getCondition(), CaseVal));
3381 for (BasicBlock::iterator I = CaseDest->begin(), E = CaseDest->end(); I != E;
3382 ++I) {
3383 if (TerminatorInst *T = dyn_cast<TerminatorInst>(I)) {
3384 // If the terminator is a simple branch, continue to the next block.
3385 if (T->getNumSuccessors() != 1)
3386 return false;
3387 Pred = CaseDest;
3388 CaseDest = T->getSuccessor(0);
3389 } else if (isa<DbgInfoIntrinsic>(I)) {
3390 // Skip debug intrinsic.
3391 continue;
Benjamin Kramer7c302602013-11-12 12:24:36 +00003392 } else if (Constant *C = ConstantFold(I, ConstantPool, DL)) {
Hans Wennborg9e74dd92012-10-31 13:42:45 +00003393 // Instruction is side-effect free and constant.
3394 ConstantPool.insert(std::make_pair(I, C));
3395 } else {
3396 break;
3397 }
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003398 }
3399
3400 // If we did not have a CommonDest before, use the current one.
3401 if (!*CommonDest)
3402 *CommonDest = CaseDest;
3403 // If the destination isn't the common one, abort.
3404 if (CaseDest != *CommonDest)
3405 return false;
3406
3407 // Get the values for this case from phi nodes in the destination block.
3408 BasicBlock::iterator I = (*CommonDest)->begin();
3409 while (PHINode *PHI = dyn_cast<PHINode>(I++)) {
3410 int Idx = PHI->getBasicBlockIndex(Pred);
3411 if (Idx == -1)
3412 continue;
3413
Hans Wennborg09acdb92012-10-31 15:14:39 +00003414 Constant *ConstVal = LookupConstant(PHI->getIncomingValue(Idx),
3415 ConstantPool);
Hans Wennborg9e74dd92012-10-31 13:42:45 +00003416 if (!ConstVal)
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003417 return false;
3418
Hans Wennborg9e74dd92012-10-31 13:42:45 +00003419 // Note: If the constant comes from constant-propagating the case value
3420 // through the CaseDest basic block, it will be safe to remove the
3421 // instructions in that block. They cannot be used (except in the phi nodes
3422 // we visit) outside CaseDest, because that block does not dominate its
3423 // successor. If it did, we would not be in this phi node.
3424
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003425 // Be conservative about which kinds of constants we support.
3426 if (!ValidLookupTableConstant(ConstVal))
3427 return false;
3428
3429 Res.push_back(std::make_pair(PHI, ConstVal));
3430 }
3431
Hans Wennborgac114a32014-01-12 00:44:41 +00003432 return Res.size() > 0;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003433}
3434
Hans Wennborg776d7122012-09-26 09:34:53 +00003435namespace {
3436 /// SwitchLookupTable - This class represents a lookup table that can be used
3437 /// to replace a switch.
3438 class SwitchLookupTable {
3439 public:
3440 /// SwitchLookupTable - Create a lookup table to use as a switch replacement
3441 /// with the contents of Values, using DefaultValue to fill any holes in the
3442 /// table.
3443 SwitchLookupTable(Module &M,
3444 uint64_t TableSize,
3445 ConstantInt *Offset,
Craig Topperb94011f2013-07-14 04:42:23 +00003446 const SmallVectorImpl<std::pair<ConstantInt*, Constant*> >& Values,
Hans Wennborg39583b82012-09-26 09:44:49 +00003447 Constant *DefaultValue,
Micah Villmowcdfe20b2012-10-08 16:38:25 +00003448 const DataLayout *TD);
Hans Wennborg776d7122012-09-26 09:34:53 +00003449
3450 /// BuildLookup - Build instructions with Builder to retrieve the value at
3451 /// the position given by Index in the lookup table.
3452 Value *BuildLookup(Value *Index, IRBuilder<> &Builder);
3453
Hans Wennborg39583b82012-09-26 09:44:49 +00003454 /// WouldFitInRegister - Return true if a table with TableSize elements of
3455 /// type ElementType would fit in a target-legal register.
Micah Villmowcdfe20b2012-10-08 16:38:25 +00003456 static bool WouldFitInRegister(const DataLayout *TD,
Hans Wennborg39583b82012-09-26 09:44:49 +00003457 uint64_t TableSize,
3458 const Type *ElementType);
3459
Hans Wennborg776d7122012-09-26 09:34:53 +00003460 private:
3461 // Depending on the contents of the table, it can be represented in
3462 // different ways.
3463 enum {
3464 // For tables where each element contains the same value, we just have to
3465 // store that single value and return it for each lookup.
3466 SingleValueKind,
3467
Hans Wennborg39583b82012-09-26 09:44:49 +00003468 // For small tables with integer elements, we can pack them into a bitmap
3469 // that fits into a target-legal register. Values are retrieved by
3470 // shift and mask operations.
3471 BitMapKind,
3472
Hans Wennborg776d7122012-09-26 09:34:53 +00003473 // The table is stored as an array of values. Values are retrieved by load
3474 // instructions from the table.
3475 ArrayKind
3476 } Kind;
3477
3478 // For SingleValueKind, this is the single value.
3479 Constant *SingleValue;
3480
Hans Wennborg39583b82012-09-26 09:44:49 +00003481 // For BitMapKind, this is the bitmap.
3482 ConstantInt *BitMap;
3483 IntegerType *BitMapElementTy;
3484
Hans Wennborg776d7122012-09-26 09:34:53 +00003485 // For ArrayKind, this is the array.
3486 GlobalVariable *Array;
3487 };
3488}
3489
3490SwitchLookupTable::SwitchLookupTable(Module &M,
3491 uint64_t TableSize,
3492 ConstantInt *Offset,
Craig Topperb94011f2013-07-14 04:42:23 +00003493 const SmallVectorImpl<std::pair<ConstantInt*, Constant*> >& Values,
Hans Wennborg39583b82012-09-26 09:44:49 +00003494 Constant *DefaultValue,
Duncan Sands59245452013-01-23 09:09:50 +00003495 const DataLayout *TD)
3496 : SingleValue(0), BitMap(0), BitMapElementTy(0), Array(0) {
Hans Wennborgf2e2c102012-09-26 11:07:37 +00003497 assert(Values.size() && "Can't build lookup table without values!");
3498 assert(TableSize >= Values.size() && "Can't fit values in table!");
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003499
3500 // If all values in the table are equal, this is that value.
Hans Wennborg776d7122012-09-26 09:34:53 +00003501 SingleValue = Values.begin()->second;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003502
Hans Wennborgac114a32014-01-12 00:44:41 +00003503 Type *ValueType = Values.begin()->second->getType();
3504
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003505 // Build up the table contents.
Hans Wennborg776d7122012-09-26 09:34:53 +00003506 SmallVector<Constant*, 64> TableContents(TableSize);
3507 for (size_t I = 0, E = Values.size(); I != E; ++I) {
3508 ConstantInt *CaseVal = Values[I].first;
3509 Constant *CaseRes = Values[I].second;
Hans Wennborgac114a32014-01-12 00:44:41 +00003510 assert(CaseRes->getType() == ValueType);
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003511
Hans Wennborg776d7122012-09-26 09:34:53 +00003512 uint64_t Idx = (CaseVal->getValue() - Offset->getValue())
3513 .getLimitedValue();
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003514 TableContents[Idx] = CaseRes;
3515
Hans Wennborg776d7122012-09-26 09:34:53 +00003516 if (CaseRes != SingleValue)
Hans Wennborg09acdb92012-10-31 15:14:39 +00003517 SingleValue = 0;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003518 }
3519
3520 // Fill in any holes in the table with the default result.
Hans Wennborg776d7122012-09-26 09:34:53 +00003521 if (Values.size() < TableSize) {
Hans Wennborgac114a32014-01-12 00:44:41 +00003522 assert(DefaultValue && "Need a default value to fill the lookup table holes.");
3523 assert(DefaultValue->getType() == ValueType);
Hans Wennborg776d7122012-09-26 09:34:53 +00003524 for (uint64_t I = 0; I < TableSize; ++I) {
3525 if (!TableContents[I])
3526 TableContents[I] = DefaultValue;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003527 }
3528
Hans Wennborg776d7122012-09-26 09:34:53 +00003529 if (DefaultValue != SingleValue)
Hans Wennborg09acdb92012-10-31 15:14:39 +00003530 SingleValue = 0;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003531 }
3532
Hans Wennborg776d7122012-09-26 09:34:53 +00003533 // If each element in the table contains the same value, we only need to store
3534 // that single value.
3535 if (SingleValue) {
3536 Kind = SingleValueKind;
3537 return;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003538 }
3539
Hans Wennborg39583b82012-09-26 09:44:49 +00003540 // If the type is integer and the table fits in a register, build a bitmap.
Hans Wennborgac114a32014-01-12 00:44:41 +00003541 if (WouldFitInRegister(TD, TableSize, ValueType)) {
3542 IntegerType *IT = cast<IntegerType>(ValueType);
Hans Wennborg39583b82012-09-26 09:44:49 +00003543 APInt TableInt(TableSize * IT->getBitWidth(), 0);
3544 for (uint64_t I = TableSize; I > 0; --I) {
3545 TableInt <<= IT->getBitWidth();
Benjamin Kramer9fc3dc72012-10-01 11:31:48 +00003546 // Insert values into the bitmap. Undef values are set to zero.
3547 if (!isa<UndefValue>(TableContents[I - 1])) {
3548 ConstantInt *Val = cast<ConstantInt>(TableContents[I - 1]);
3549 TableInt |= Val->getValue().zext(TableInt.getBitWidth());
3550 }
Hans Wennborg39583b82012-09-26 09:44:49 +00003551 }
3552 BitMap = ConstantInt::get(M.getContext(), TableInt);
3553 BitMapElementTy = IT;
3554 Kind = BitMapKind;
3555 ++NumBitMaps;
3556 return;
3557 }
3558
Hans Wennborg776d7122012-09-26 09:34:53 +00003559 // Store the table in an array.
Hans Wennborgac114a32014-01-12 00:44:41 +00003560 ArrayType *ArrayTy = ArrayType::get(ValueType, TableSize);
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003561 Constant *Initializer = ConstantArray::get(ArrayTy, TableContents);
3562
Hans Wennborg776d7122012-09-26 09:34:53 +00003563 Array = new GlobalVariable(M, ArrayTy, /*constant=*/ true,
3564 GlobalVariable::PrivateLinkage,
3565 Initializer,
3566 "switch.table");
3567 Array->setUnnamedAddr(true);
3568 Kind = ArrayKind;
3569}
3570
3571Value *SwitchLookupTable::BuildLookup(Value *Index, IRBuilder<> &Builder) {
3572 switch (Kind) {
3573 case SingleValueKind:
3574 return SingleValue;
Hans Wennborg39583b82012-09-26 09:44:49 +00003575 case BitMapKind: {
3576 // Type of the bitmap (e.g. i59).
3577 IntegerType *MapTy = BitMap->getType();
3578
3579 // Cast Index to the same type as the bitmap.
3580 // Note: The Index is <= the number of elements in the table, so
3581 // truncating it to the width of the bitmask is safe.
Hans Wennborgcd3a11f2012-09-26 14:01:53 +00003582 Value *ShiftAmt = Builder.CreateZExtOrTrunc(Index, MapTy, "switch.cast");
Hans Wennborg39583b82012-09-26 09:44:49 +00003583
3584 // Multiply the shift amount by the element width.
3585 ShiftAmt = Builder.CreateMul(ShiftAmt,
3586 ConstantInt::get(MapTy, BitMapElementTy->getBitWidth()),
3587 "switch.shiftamt");
3588
3589 // Shift down.
3590 Value *DownShifted = Builder.CreateLShr(BitMap, ShiftAmt,
3591 "switch.downshift");
3592 // Mask off.
3593 return Builder.CreateTrunc(DownShifted, BitMapElementTy,
3594 "switch.masked");
3595 }
Hans Wennborg776d7122012-09-26 09:34:53 +00003596 case ArrayKind: {
3597 Value *GEPIndices[] = { Builder.getInt32(0), Index };
3598 Value *GEP = Builder.CreateInBoundsGEP(Array, GEPIndices,
3599 "switch.gep");
3600 return Builder.CreateLoad(GEP, "switch.load");
3601 }
3602 }
3603 llvm_unreachable("Unknown lookup table kind!");
3604}
3605
Micah Villmowcdfe20b2012-10-08 16:38:25 +00003606bool SwitchLookupTable::WouldFitInRegister(const DataLayout *TD,
Hans Wennborg39583b82012-09-26 09:44:49 +00003607 uint64_t TableSize,
3608 const Type *ElementType) {
3609 if (!TD)
3610 return false;
3611 const IntegerType *IT = dyn_cast<IntegerType>(ElementType);
3612 if (!IT)
3613 return false;
3614 // FIXME: If the type is wider than it needs to be, e.g. i8 but all values
3615 // are <= 15, we could try to narrow the type.
Benjamin Kramerc2081d12012-09-27 18:29:58 +00003616
3617 // Avoid overflow, fitsInLegalInteger uses unsigned int for the width.
3618 if (TableSize >= UINT_MAX/IT->getBitWidth())
3619 return false;
Hans Wennborg39583b82012-09-26 09:44:49 +00003620 return TD->fitsInLegalInteger(TableSize * IT->getBitWidth());
3621}
3622
Hans Wennborg776d7122012-09-26 09:34:53 +00003623/// ShouldBuildLookupTable - Determine whether a lookup table should be built
Hans Wennborg5cf30be2013-06-04 11:22:30 +00003624/// for this switch, based on the number of cases, size of the table and the
Hans Wennborg776d7122012-09-26 09:34:53 +00003625/// types of the results.
3626static bool ShouldBuildLookupTable(SwitchInst *SI,
Hans Wennborg39583b82012-09-26 09:44:49 +00003627 uint64_t TableSize,
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003628 const TargetTransformInfo &TTI,
Micah Villmowcdfe20b2012-10-08 16:38:25 +00003629 const DataLayout *TD,
Hans Wennborg39583b82012-09-26 09:44:49 +00003630 const SmallDenseMap<PHINode*, Type*>& ResultTypes) {
Hans Wennborgf2e2c102012-09-26 11:07:37 +00003631 if (SI->getNumCases() > TableSize || TableSize >= UINT64_MAX / 10)
3632 return false; // TableSize overflowed, or mul below might overflow.
Hans Wennborg776d7122012-09-26 09:34:53 +00003633
Chandler Carruth77d433d2012-11-30 09:26:25 +00003634 bool AllTablesFitInRegister = true;
Evan Cheng65df8082012-11-30 02:02:42 +00003635 bool HasIllegalType = false;
Hans Wennborg39583b82012-09-26 09:44:49 +00003636 for (SmallDenseMap<PHINode*, Type*>::const_iterator I = ResultTypes.begin(),
3637 E = ResultTypes.end(); I != E; ++I) {
Evan Cheng65df8082012-11-30 02:02:42 +00003638 Type *Ty = I->second;
Chandler Carruthd9ef81e2012-11-30 09:34:29 +00003639
3640 // Saturate this flag to true.
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003641 HasIllegalType = HasIllegalType || !TTI.isTypeLegal(Ty);
Chandler Carruthd9ef81e2012-11-30 09:34:29 +00003642
3643 // Saturate this flag to false.
3644 AllTablesFitInRegister = AllTablesFitInRegister &&
3645 SwitchLookupTable::WouldFitInRegister(TD, TableSize, Ty);
3646
3647 // If both flags saturate, we're done. NOTE: This *only* works with
3648 // saturating flags, and all flags have to saturate first due to the
3649 // non-deterministic behavior of iterating over a dense map.
3650 if (HasIllegalType && !AllTablesFitInRegister)
Evan Cheng65df8082012-11-30 02:02:42 +00003651 break;
Hans Wennborg39583b82012-09-26 09:44:49 +00003652 }
Evan Cheng65df8082012-11-30 02:02:42 +00003653
Chandler Carruth77d433d2012-11-30 09:26:25 +00003654 // If each table would fit in a register, we should build it anyway.
3655 if (AllTablesFitInRegister)
3656 return true;
3657
3658 // Don't build a table that doesn't fit in-register if it has illegal types.
3659 if (HasIllegalType)
3660 return false;
3661
3662 // The table density should be at least 40%. This is the same criterion as for
3663 // jump tables, see SelectionDAGBuilder::handleJTSwitchCase.
3664 // FIXME: Find the best cut-off.
3665 return SI->getNumCases() * 10 >= TableSize * 4;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003666}
3667
3668/// SwitchToLookupTable - If the switch is only used to initialize one or more
3669/// phi nodes in a common successor block with different constant values,
3670/// replace the switch with lookup tables.
3671static bool SwitchToLookupTable(SwitchInst *SI,
Hans Wennborg39583b82012-09-26 09:44:49 +00003672 IRBuilder<> &Builder,
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003673 const TargetTransformInfo &TTI,
3674 const DataLayout* TD) {
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003675 assert(SI->getNumCases() > 1 && "Degenerate switch?");
Hans Wennborgf3254832012-10-30 11:23:25 +00003676
Hans Wennborgc3c8d952012-11-07 21:35:12 +00003677 // Only build lookup table when we have a target that supports it.
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003678 if (!TTI.shouldBuildLookupTables())
Hans Wennborgf3254832012-10-30 11:23:25 +00003679 return false;
3680
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003681 // FIXME: If the switch is too sparse for a lookup table, perhaps we could
3682 // split off a dense part and build a lookup table for that.
3683
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003684 // FIXME: This creates arrays of GEPs to constant strings, which means each
3685 // GEP needs a runtime relocation in PIC code. We should just build one big
3686 // string and lookup indices into that.
3687
Hans Wennborg4744ac12014-01-15 05:00:27 +00003688 // Ignore switches with less than three cases. Lookup tables will not make them
3689 // faster, so we don't analyze them.
3690 if (SI->getNumCases() < 3)
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003691 return false;
3692
3693 // Figure out the corresponding result for each case value and phi node in the
3694 // common destination, as well as the the min and max case values.
3695 assert(SI->case_begin() != SI->case_end());
3696 SwitchInst::CaseIt CI = SI->case_begin();
3697 ConstantInt *MinCaseVal = CI.getCaseValue();
3698 ConstantInt *MaxCaseVal = CI.getCaseValue();
3699
Hans Wennborg09acdb92012-10-31 15:14:39 +00003700 BasicBlock *CommonDest = 0;
Hans Wennborg7fd5c8442012-09-10 07:44:22 +00003701 typedef SmallVector<std::pair<ConstantInt*, Constant*>, 4> ResultListTy;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003702 SmallDenseMap<PHINode*, ResultListTy> ResultLists;
3703 SmallDenseMap<PHINode*, Constant*> DefaultResults;
3704 SmallDenseMap<PHINode*, Type*> ResultTypes;
3705 SmallVector<PHINode*, 4> PHIs;
3706
3707 for (SwitchInst::CaseIt E = SI->case_end(); CI != E; ++CI) {
3708 ConstantInt *CaseVal = CI.getCaseValue();
3709 if (CaseVal->getValue().slt(MinCaseVal->getValue()))
3710 MinCaseVal = CaseVal;
3711 if (CaseVal->getValue().sgt(MaxCaseVal->getValue()))
3712 MaxCaseVal = CaseVal;
3713
3714 // Resulting value at phi nodes for this case value.
3715 typedef SmallVector<std::pair<PHINode*, Constant*>, 4> ResultsTy;
3716 ResultsTy Results;
Hans Wennborg9e74dd92012-10-31 13:42:45 +00003717 if (!GetCaseResults(SI, CaseVal, CI.getCaseSuccessor(), &CommonDest,
Benjamin Kramer7c302602013-11-12 12:24:36 +00003718 Results, TD))
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003719 return false;
3720
3721 // Append the result from this case to the list for each phi.
3722 for (ResultsTy::iterator I = Results.begin(), E = Results.end(); I!=E; ++I) {
3723 if (!ResultLists.count(I->first))
3724 PHIs.push_back(I->first);
3725 ResultLists[I->first].push_back(std::make_pair(CaseVal, I->second));
3726 }
3727 }
3728
Hans Wennborgac114a32014-01-12 00:44:41 +00003729 // Keep track of the result types.
3730 for (size_t I = 0, E = PHIs.size(); I != E; ++I) {
3731 PHINode *PHI = PHIs[I];
3732 ResultTypes[PHI] = ResultLists[PHI][0].second->getType();
3733 }
3734
3735 uint64_t NumResults = ResultLists[PHIs[0]].size();
3736 APInt RangeSpread = MaxCaseVal->getValue() - MinCaseVal->getValue();
3737 uint64_t TableSize = RangeSpread.getLimitedValue() + 1;
3738 bool TableHasHoles = (NumResults < TableSize);
3739
3740 // If the table has holes, we need a constant result for the default case.
Hans Wennborg7fd5c8442012-09-10 07:44:22 +00003741 SmallVector<std::pair<PHINode*, Constant*>, 4> DefaultResultsList;
Hans Wennborgac114a32014-01-12 00:44:41 +00003742 if (TableHasHoles && !GetCaseResults(SI, 0, SI->getDefaultDest(), &CommonDest,
3743 DefaultResultsList, TD))
Hans Wennborg7fd5c8442012-09-10 07:44:22 +00003744 return false;
Hans Wennborgac114a32014-01-12 00:44:41 +00003745
Hans Wennborg7fd5c8442012-09-10 07:44:22 +00003746 for (size_t I = 0, E = DefaultResultsList.size(); I != E; ++I) {
3747 PHINode *PHI = DefaultResultsList[I].first;
3748 Constant *Result = DefaultResultsList[I].second;
3749 DefaultResults[PHI] = Result;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003750 }
3751
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003752 if (!ShouldBuildLookupTable(SI, TableSize, TTI, TD, ResultTypes))
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003753 return false;
3754
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003755 // Create the BB that does the lookups.
Hans Wennborg776d7122012-09-26 09:34:53 +00003756 Module &Mod = *CommonDest->getParent()->getParent();
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003757 BasicBlock *LookupBB = BasicBlock::Create(Mod.getContext(),
3758 "switch.lookup",
3759 CommonDest->getParent(),
3760 CommonDest);
3761
Michael Gottesmanc024f322013-10-20 07:04:37 +00003762 // Compute the table index value.
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003763 Builder.SetInsertPoint(SI);
3764 Value *TableIndex = Builder.CreateSub(SI->getCondition(), MinCaseVal,
3765 "switch.tableidx");
Michael Gottesmanc024f322013-10-20 07:04:37 +00003766
3767 // Compute the maximum table size representable by the integer type we are
3768 // switching upon.
Michael Gottesman63c63ac2013-10-21 05:20:11 +00003769 unsigned CaseSize = MinCaseVal->getType()->getPrimitiveSizeInBits();
Hans Wennborgac114a32014-01-12 00:44:41 +00003770 uint64_t MaxTableSize = CaseSize > 63 ? UINT64_MAX : 1ULL << CaseSize;
Michael Gottesmanc024f322013-10-20 07:04:37 +00003771 assert(MaxTableSize >= TableSize &&
3772 "It is impossible for a switch to have more entries than the max "
3773 "representable value of its input integer type's size.");
3774
Michael Gottesman63c63ac2013-10-21 05:20:11 +00003775 // If we have a fully covered lookup table, unconditionally branch to the
3776 // lookup table BB. Otherwise, check if the condition value is within the case
3777 // range. If it is so, branch to the new BB. Otherwise branch to SI's default
3778 // destination.
Michael Gottesmanc024f322013-10-20 07:04:37 +00003779 const bool GeneratingCoveredLookupTable = MaxTableSize == TableSize;
3780 if (GeneratingCoveredLookupTable) {
3781 Builder.CreateBr(LookupBB);
Michael Gottesman63c63ac2013-10-21 05:20:11 +00003782 SI->getDefaultDest()->removePredecessor(SI->getParent());
Michael Gottesmanc024f322013-10-20 07:04:37 +00003783 } else {
3784 Value *Cmp = Builder.CreateICmpULT(TableIndex, ConstantInt::get(
3785 MinCaseVal->getType(), TableSize));
3786 Builder.CreateCondBr(Cmp, LookupBB, SI->getDefaultDest());
3787 }
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003788
3789 // Populate the BB that does the lookups.
3790 Builder.SetInsertPoint(LookupBB);
3791 bool ReturnedEarly = false;
Hans Wennborg776d7122012-09-26 09:34:53 +00003792 for (size_t I = 0, E = PHIs.size(); I != E; ++I) {
3793 PHINode *PHI = PHIs[I];
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003794
Hans Wennborg776d7122012-09-26 09:34:53 +00003795 SwitchLookupTable Table(Mod, TableSize, MinCaseVal, ResultLists[PHI],
Hans Wennborg39583b82012-09-26 09:44:49 +00003796 DefaultResults[PHI], TD);
Hans Wennborg776d7122012-09-26 09:34:53 +00003797
3798 Value *Result = Table.BuildLookup(TableIndex, Builder);
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003799
Hans Wennborgf744fa92012-09-19 14:24:21 +00003800 // If the result is used to return immediately from the function, we want to
3801 // do that right here.
3802 if (PHI->hasOneUse() && isa<ReturnInst>(*PHI->use_begin()) &&
3803 *PHI->use_begin() == CommonDest->getFirstNonPHIOrDbg()) {
3804 Builder.CreateRet(Result);
3805 ReturnedEarly = true;
3806 break;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003807 }
3808
Hans Wennborgf744fa92012-09-19 14:24:21 +00003809 PHI->addIncoming(Result, LookupBB);
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003810 }
3811
3812 if (!ReturnedEarly)
3813 Builder.CreateBr(CommonDest);
3814
3815 // Remove the switch.
Michael Gottesman63c63ac2013-10-21 05:20:11 +00003816 for (unsigned i = 0, e = SI->getNumSuccessors(); i < e; ++i) {
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003817 BasicBlock *Succ = SI->getSuccessor(i);
Michael Gottesmanc024f322013-10-20 07:04:37 +00003818
Michael Gottesman63c63ac2013-10-21 05:20:11 +00003819 if (Succ == SI->getDefaultDest())
Michael Gottesmanc024f322013-10-20 07:04:37 +00003820 continue;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003821 Succ->removePredecessor(SI->getParent());
3822 }
3823 SI->eraseFromParent();
3824
3825 ++NumLookupTables;
3826 return true;
3827}
3828
Devang Patela7ec47d2011-05-18 20:35:38 +00003829bool SimplifyCFGOpt::SimplifySwitch(SwitchInst *SI, IRBuilder<> &Builder) {
Chris Lattner25c3af32010-12-13 06:25:44 +00003830 BasicBlock *BB = SI->getParent();
3831
Jakob Stoklund Olesen977f41a2012-10-25 18:51:15 +00003832 if (isValueEqualityComparison(SI)) {
3833 // If we only have one predecessor, and if it is a branch on this value,
3834 // see if that predecessor totally determines the outcome of this switch.
3835 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
3836 if (SimplifyEqualityComparisonWithOnlyPredecessor(SI, OnlyPred, Builder))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003837 return SimplifyCFG(BB, TTI, TD) | true;
Frits van Bommel8ae07992011-02-28 09:44:07 +00003838
Jakob Stoklund Olesen977f41a2012-10-25 18:51:15 +00003839 Value *Cond = SI->getCondition();
3840 if (SelectInst *Select = dyn_cast<SelectInst>(Cond))
3841 if (SimplifySwitchOnSelect(SI, Select))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003842 return SimplifyCFG(BB, TTI, TD) | true;
Frits van Bommel8ae07992011-02-28 09:44:07 +00003843
Jakob Stoklund Olesen977f41a2012-10-25 18:51:15 +00003844 // If the block only contains the switch, see if we can fold the block
3845 // away into any preds.
3846 BasicBlock::iterator BBI = BB->begin();
3847 // Ignore dbg intrinsics.
3848 while (isa<DbgInfoIntrinsic>(BBI))
3849 ++BBI;
3850 if (SI == &*BBI)
3851 if (FoldValueComparisonIntoPredecessors(SI, Builder))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003852 return SimplifyCFG(BB, TTI, TD) | true;
Jakob Stoklund Olesen977f41a2012-10-25 18:51:15 +00003853 }
Benjamin Kramerf4ea1d52011-02-02 15:56:22 +00003854
3855 // Try to transform the switch into an icmp and a branch.
Devang Patela7ec47d2011-05-18 20:35:38 +00003856 if (TurnSwitchRangeIntoICmp(SI, Builder))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003857 return SimplifyCFG(BB, TTI, TD) | true;
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003858
3859 // Remove unreachable cases.
3860 if (EliminateDeadSwitchCases(SI))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003861 return SimplifyCFG(BB, TTI, TD) | true;
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003862
Hans Wennborg4ab4a8e2011-06-18 10:28:47 +00003863 if (ForwardSwitchConditionToPHI(SI))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003864 return SimplifyCFG(BB, TTI, TD) | true;
Hans Wennborg4ab4a8e2011-06-18 10:28:47 +00003865
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003866 if (SwitchToLookupTable(SI, Builder, TTI, TD))
3867 return SimplifyCFG(BB, TTI, TD) | true;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003868
Chris Lattner25c3af32010-12-13 06:25:44 +00003869 return false;
3870}
3871
3872bool SimplifyCFGOpt::SimplifyIndirectBr(IndirectBrInst *IBI) {
3873 BasicBlock *BB = IBI->getParent();
3874 bool Changed = false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00003875
Chris Lattner25c3af32010-12-13 06:25:44 +00003876 // Eliminate redundant destinations.
3877 SmallPtrSet<Value *, 8> Succs;
3878 for (unsigned i = 0, e = IBI->getNumDestinations(); i != e; ++i) {
3879 BasicBlock *Dest = IBI->getDestination(i);
3880 if (!Dest->hasAddressTaken() || !Succs.insert(Dest)) {
3881 Dest->removePredecessor(BB);
3882 IBI->removeDestination(i);
3883 --i; --e;
3884 Changed = true;
3885 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003886 }
Chris Lattner25c3af32010-12-13 06:25:44 +00003887
3888 if (IBI->getNumDestinations() == 0) {
3889 // If the indirectbr has no successors, change it to unreachable.
3890 new UnreachableInst(IBI->getContext(), IBI);
3891 EraseTerminatorInstAndDCECond(IBI);
3892 return true;
3893 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003894
Chris Lattner25c3af32010-12-13 06:25:44 +00003895 if (IBI->getNumDestinations() == 1) {
3896 // If the indirectbr has one successor, change it to a direct branch.
3897 BranchInst::Create(IBI->getDestination(0), IBI);
3898 EraseTerminatorInstAndDCECond(IBI);
3899 return true;
3900 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003901
Chris Lattner25c3af32010-12-13 06:25:44 +00003902 if (SelectInst *SI = dyn_cast<SelectInst>(IBI->getAddress())) {
3903 if (SimplifyIndirectBrOnSelect(IBI, SI))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003904 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner25c3af32010-12-13 06:25:44 +00003905 }
3906 return Changed;
3907}
3908
Devang Patel767f6932011-05-18 18:28:48 +00003909bool SimplifyCFGOpt::SimplifyUncondBranch(BranchInst *BI, IRBuilder<> &Builder){
Chris Lattner25c3af32010-12-13 06:25:44 +00003910 BasicBlock *BB = BI->getParent();
Andrew Trickf3cf1932012-08-29 21:46:36 +00003911
Manman Ren93ab6492012-09-20 22:37:36 +00003912 if (SinkCommon && SinkThenElseCodeToEnd(BI))
3913 return true;
3914
Chris Lattner25c3af32010-12-13 06:25:44 +00003915 // If the Terminator is the only non-phi instruction, simplify the block.
Rafael Espindolab10a0f22011-06-30 20:14:24 +00003916 BasicBlock::iterator I = BB->getFirstNonPHIOrDbgOrLifetime();
Chris Lattner25c3af32010-12-13 06:25:44 +00003917 if (I->isTerminator() && BB != &BB->getParent()->getEntryBlock() &&
3918 TryToSimplifyUncondBranchFromEmptyBlock(BB))
3919 return true;
Andrew Trickf3cf1932012-08-29 21:46:36 +00003920
Chris Lattner25c3af32010-12-13 06:25:44 +00003921 // If the only instruction in the block is a seteq/setne comparison
3922 // against a constant, try to simplify the block.
3923 if (ICmpInst *ICI = dyn_cast<ICmpInst>(I))
3924 if (ICI->isEquality() && isa<ConstantInt>(ICI->getOperand(1))) {
3925 for (++I; isa<DbgInfoIntrinsic>(I); ++I)
3926 ;
Nick Lewyckye87d54c2011-12-26 20:37:40 +00003927 if (I->isTerminator() &&
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003928 TryToSimplifyUncondBranchWithICmpInIt(ICI, Builder, TTI, TD))
Chris Lattner25c3af32010-12-13 06:25:44 +00003929 return true;
3930 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003931
Manman Rend33f4ef2012-06-13 05:43:29 +00003932 // If this basic block is ONLY a compare and a branch, and if a predecessor
3933 // branches to us and our successor, fold the comparison into the
3934 // predecessor and use logical operations to update the incoming value
3935 // for PHI nodes in common successor.
3936 if (FoldBranchToCommonDest(BI))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003937 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner25c3af32010-12-13 06:25:44 +00003938 return false;
3939}
3940
3941
Devang Patela7ec47d2011-05-18 20:35:38 +00003942bool SimplifyCFGOpt::SimplifyCondBranch(BranchInst *BI, IRBuilder<> &Builder) {
Chris Lattner25c3af32010-12-13 06:25:44 +00003943 BasicBlock *BB = BI->getParent();
Andrew Trickf3cf1932012-08-29 21:46:36 +00003944
Chris Lattner25c3af32010-12-13 06:25:44 +00003945 // Conditional branch
3946 if (isValueEqualityComparison(BI)) {
3947 // If we only have one predecessor, and if it is a branch on this value,
3948 // see if that predecessor totally determines the outcome of this
3949 // switch.
3950 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
Devang Patela7ec47d2011-05-18 20:35:38 +00003951 if (SimplifyEqualityComparisonWithOnlyPredecessor(BI, OnlyPred, Builder))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003952 return SimplifyCFG(BB, TTI, TD) | true;
Andrew Trickf3cf1932012-08-29 21:46:36 +00003953
Chris Lattner25c3af32010-12-13 06:25:44 +00003954 // This block must be empty, except for the setcond inst, if it exists.
3955 // Ignore dbg intrinsics.
3956 BasicBlock::iterator I = BB->begin();
3957 // Ignore dbg intrinsics.
3958 while (isa<DbgInfoIntrinsic>(I))
3959 ++I;
3960 if (&*I == BI) {
Devang Patel58380552011-05-18 20:53:17 +00003961 if (FoldValueComparisonIntoPredecessors(BI, Builder))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003962 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner25c3af32010-12-13 06:25:44 +00003963 } else if (&*I == cast<Instruction>(BI->getCondition())){
3964 ++I;
3965 // Ignore dbg intrinsics.
3966 while (isa<DbgInfoIntrinsic>(I))
3967 ++I;
Devang Patel58380552011-05-18 20:53:17 +00003968 if (&*I == BI && FoldValueComparisonIntoPredecessors(BI, Builder))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003969 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner25c3af32010-12-13 06:25:44 +00003970 }
3971 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003972
Chris Lattner25c3af32010-12-13 06:25:44 +00003973 // Try to turn "br (X == 0 | X == 1), T, F" into a switch instruction.
Devang Patel7de6c4b2011-05-18 23:18:47 +00003974 if (SimplifyBranchOnICmpChain(BI, TD, Builder))
Chris Lattner25c3af32010-12-13 06:25:44 +00003975 return true;
Andrew Trickf3cf1932012-08-29 21:46:36 +00003976
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00003977 // If this basic block is ONLY a compare and a branch, and if a predecessor
3978 // branches to us and one of our successors, fold the comparison into the
3979 // predecessor and use logical operations to pick the right destination.
3980 if (FoldBranchToCommonDest(BI))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003981 return SimplifyCFG(BB, TTI, TD) | true;
Andrew Trickf3cf1932012-08-29 21:46:36 +00003982
Chris Lattner25c3af32010-12-13 06:25:44 +00003983 // We have a conditional branch to two blocks that are only reachable
3984 // from BI. We know that the condbr dominates the two blocks, so see if
3985 // there is any identical code in the "then" and "else" blocks. If so, we
3986 // can hoist it up to the branching block.
3987 if (BI->getSuccessor(0)->getSinglePredecessor() != 0) {
3988 if (BI->getSuccessor(1)->getSinglePredecessor() != 0) {
Rafael Espindola964602d2011-05-19 02:26:30 +00003989 if (HoistThenElseCodeToIf(BI))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003990 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner25c3af32010-12-13 06:25:44 +00003991 } else {
3992 // If Successor #1 has multiple preds, we may be able to conditionally
3993 // execute Successor #0 if it branches to successor #1.
3994 TerminatorInst *Succ0TI = BI->getSuccessor(0)->getTerminator();
3995 if (Succ0TI->getNumSuccessors() == 1 &&
3996 Succ0TI->getSuccessor(0) == BI->getSuccessor(1))
Chandler Carruth329b5902013-01-27 06:42:03 +00003997 if (SpeculativelyExecuteBB(BI, BI->getSuccessor(0)))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003998 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner25c3af32010-12-13 06:25:44 +00003999 }
4000 } else if (BI->getSuccessor(1)->getSinglePredecessor() != 0) {
4001 // If Successor #0 has multiple preds, we may be able to conditionally
4002 // execute Successor #1 if it branches to successor #0.
4003 TerminatorInst *Succ1TI = BI->getSuccessor(1)->getTerminator();
4004 if (Succ1TI->getNumSuccessors() == 1 &&
4005 Succ1TI->getSuccessor(0) == BI->getSuccessor(0))
Chandler Carruth329b5902013-01-27 06:42:03 +00004006 if (SpeculativelyExecuteBB(BI, BI->getSuccessor(1)))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00004007 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner25c3af32010-12-13 06:25:44 +00004008 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00004009
Chris Lattner25c3af32010-12-13 06:25:44 +00004010 // If this is a branch on a phi node in the current block, thread control
4011 // through this block if any PHI node entries are constants.
4012 if (PHINode *PN = dyn_cast<PHINode>(BI->getCondition()))
4013 if (PN->getParent() == BI->getParent())
Chris Lattnerd7beca32010-12-14 06:17:25 +00004014 if (FoldCondBranchOnPHI(BI, TD))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00004015 return SimplifyCFG(BB, TTI, TD) | true;
Andrew Trickf3cf1932012-08-29 21:46:36 +00004016
Chris Lattner25c3af32010-12-13 06:25:44 +00004017 // Scan predecessor blocks for conditional branches.
4018 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
4019 if (BranchInst *PBI = dyn_cast<BranchInst>((*PI)->getTerminator()))
4020 if (PBI != BI && PBI->isConditional())
4021 if (SimplifyCondBranchToCondBranch(PBI, BI))
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00004022 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner25c3af32010-12-13 06:25:44 +00004023
4024 return false;
4025}
4026
Benjamin Kramerfb212a62011-08-26 01:22:29 +00004027/// Check if passing a value to an instruction will cause undefined behavior.
4028static bool passingValueIsAlwaysUndefined(Value *V, Instruction *I) {
4029 Constant *C = dyn_cast<Constant>(V);
4030 if (!C)
4031 return false;
4032
Benjamin Kramerd12e82e2012-10-04 16:11:49 +00004033 if (I->use_empty())
Benjamin Kramerfb212a62011-08-26 01:22:29 +00004034 return false;
4035
4036 if (C->isNullValue()) {
Benjamin Kramerd12e82e2012-10-04 16:11:49 +00004037 // Only look at the first use, avoid hurting compile time with long uselists
4038 User *Use = *I->use_begin();
Benjamin Kramerfb212a62011-08-26 01:22:29 +00004039
4040 // Now make sure that there are no instructions in between that can alter
4041 // control flow (eg. calls)
4042 for (BasicBlock::iterator i = ++BasicBlock::iterator(I); &*i != Use; ++i)
Benjamin Kramer0655b782011-08-26 02:25:55 +00004043 if (i == I->getParent()->end() || i->mayHaveSideEffects())
Benjamin Kramerfb212a62011-08-26 01:22:29 +00004044 return false;
4045
4046 // Look through GEPs. A load from a GEP derived from NULL is still undefined
4047 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Use))
4048 if (GEP->getPointerOperand() == I)
4049 return passingValueIsAlwaysUndefined(V, GEP);
4050
4051 // Look through bitcasts.
4052 if (BitCastInst *BC = dyn_cast<BitCastInst>(Use))
4053 return passingValueIsAlwaysUndefined(V, BC);
4054
Benjamin Kramer0655b782011-08-26 02:25:55 +00004055 // Load from null is undefined.
4056 if (LoadInst *LI = dyn_cast<LoadInst>(Use))
Andrew Tricka0a5ca02013-03-07 01:03:35 +00004057 if (!LI->isVolatile())
4058 return LI->getPointerAddressSpace() == 0;
Benjamin Kramerfb212a62011-08-26 01:22:29 +00004059
Benjamin Kramer0655b782011-08-26 02:25:55 +00004060 // Store to null is undefined.
4061 if (StoreInst *SI = dyn_cast<StoreInst>(Use))
Andrew Tricka0a5ca02013-03-07 01:03:35 +00004062 if (!SI->isVolatile())
4063 return SI->getPointerAddressSpace() == 0 && SI->getPointerOperand() == I;
Benjamin Kramerfb212a62011-08-26 01:22:29 +00004064 }
4065 return false;
4066}
4067
4068/// If BB has an incoming value that will always trigger undefined behavior
Nick Lewyckye87d54c2011-12-26 20:37:40 +00004069/// (eg. null pointer dereference), remove the branch leading here.
Benjamin Kramerfb212a62011-08-26 01:22:29 +00004070static bool removeUndefIntroducingPredecessor(BasicBlock *BB) {
4071 for (BasicBlock::iterator i = BB->begin();
4072 PHINode *PHI = dyn_cast<PHINode>(i); ++i)
4073 for (unsigned i = 0, e = PHI->getNumIncomingValues(); i != e; ++i)
4074 if (passingValueIsAlwaysUndefined(PHI->getIncomingValue(i), PHI)) {
4075 TerminatorInst *T = PHI->getIncomingBlock(i)->getTerminator();
4076 IRBuilder<> Builder(T);
4077 if (BranchInst *BI = dyn_cast<BranchInst>(T)) {
4078 BB->removePredecessor(PHI->getIncomingBlock(i));
4079 // Turn uncoditional branches into unreachables and remove the dead
4080 // destination from conditional branches.
4081 if (BI->isUnconditional())
4082 Builder.CreateUnreachable();
4083 else
4084 Builder.CreateBr(BI->getSuccessor(0) == BB ? BI->getSuccessor(1) :
4085 BI->getSuccessor(0));
4086 BI->eraseFromParent();
4087 return true;
4088 }
4089 // TODO: SwitchInst.
4090 }
4091
4092 return false;
4093}
4094
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +00004095bool SimplifyCFGOpt::run(BasicBlock *BB) {
Chris Lattner3f5823f2003-08-24 18:36:16 +00004096 bool Changed = false;
Chris Lattner466a0492002-05-21 20:50:24 +00004097
Chris Lattnerd7beca32010-12-14 06:17:25 +00004098 assert(BB && BB->getParent() && "Block not embedded in function!");
Chris Lattner466a0492002-05-21 20:50:24 +00004099 assert(BB->getTerminator() && "Degenerate basic block encountered!");
Chris Lattner466a0492002-05-21 20:50:24 +00004100
Dan Gohman4a63fad2010-08-14 00:29:42 +00004101 // Remove basic blocks that have no predecessors (except the entry block)...
4102 // or that just have themself as a predecessor. These are unreachable.
Chris Lattnerd7beca32010-12-14 06:17:25 +00004103 if ((pred_begin(BB) == pred_end(BB) &&
4104 BB != &BB->getParent()->getEntryBlock()) ||
Dan Gohman4a63fad2010-08-14 00:29:42 +00004105 BB->getSinglePredecessor() == BB) {
David Greene725c7c32010-01-05 01:26:52 +00004106 DEBUG(dbgs() << "Removing BB: \n" << *BB);
Chris Lattner7eb270e2008-12-03 06:40:52 +00004107 DeleteDeadBlock(BB);
Chris Lattner466a0492002-05-21 20:50:24 +00004108 return true;
4109 }
4110
Chris Lattner031340a2003-08-17 19:41:53 +00004111 // Check to see if we can constant propagate this terminator instruction
4112 // away...
Frits van Bommelad964552011-05-22 16:24:18 +00004113 Changed |= ConstantFoldTerminator(BB, true);
Chris Lattner031340a2003-08-17 19:41:53 +00004114
Dan Gohman1a951062009-10-30 22:39:04 +00004115 // Check for and eliminate duplicate PHI nodes in this block.
4116 Changed |= EliminateDuplicatePHINodes(BB);
4117
Benjamin Kramerfb212a62011-08-26 01:22:29 +00004118 // Check for and remove branches that will always cause undefined behavior.
4119 Changed |= removeUndefIntroducingPredecessor(BB);
4120
Chris Lattner2e3832d2010-12-13 05:10:48 +00004121 // Merge basic blocks into their predecessor if there is only one distinct
4122 // pred, and if there is only one distinct successor of the predecessor, and
4123 // if there are no PHI nodes.
4124 //
4125 if (MergeBlockIntoPredecessor(BB))
4126 return true;
Andrew Trickf3cf1932012-08-29 21:46:36 +00004127
Devang Patel15ad6762011-05-18 18:01:27 +00004128 IRBuilder<> Builder(BB);
4129
Dan Gohman20af5a02008-03-11 21:53:06 +00004130 // If there is a trivial two-entry PHI node in this basic block, and we can
4131 // eliminate it, do so now.
4132 if (PHINode *PN = dyn_cast<PHINode>(BB->begin()))
4133 if (PN->getNumIncomingValues() == 2)
Devang Patel1407fb42011-05-19 20:52:46 +00004134 Changed |= FoldTwoEntryPHINode(PN, TD);
Dan Gohman20af5a02008-03-11 21:53:06 +00004135
Devang Patela7ec47d2011-05-18 20:35:38 +00004136 Builder.SetInsertPoint(BB->getTerminator());
Chris Lattner25c3af32010-12-13 06:25:44 +00004137 if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) {
Chris Lattner1d057612010-12-13 06:36:51 +00004138 if (BI->isUnconditional()) {
Devang Patel767f6932011-05-18 18:28:48 +00004139 if (SimplifyUncondBranch(BI, Builder)) return true;
Chris Lattner1d057612010-12-13 06:36:51 +00004140 } else {
Devang Patela7ec47d2011-05-18 20:35:38 +00004141 if (SimplifyCondBranch(BI, Builder)) return true;
Chris Lattner1d057612010-12-13 06:36:51 +00004142 }
4143 } else if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
Devang Pateldd14e0f2011-05-18 21:33:11 +00004144 if (SimplifyReturn(RI, Builder)) return true;
Bill Wendlingd5d95b02012-02-06 21:16:41 +00004145 } else if (ResumeInst *RI = dyn_cast<ResumeInst>(BB->getTerminator())) {
4146 if (SimplifyResume(RI, Builder)) return true;
Chris Lattner1d057612010-12-13 06:36:51 +00004147 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
Devang Patela7ec47d2011-05-18 20:35:38 +00004148 if (SimplifySwitch(SI, Builder)) return true;
Chris Lattner1d057612010-12-13 06:36:51 +00004149 } else if (UnreachableInst *UI =
4150 dyn_cast<UnreachableInst>(BB->getTerminator())) {
4151 if (SimplifyUnreachable(UI)) return true;
Chris Lattner1d057612010-12-13 06:36:51 +00004152 } else if (IndirectBrInst *IBI =
4153 dyn_cast<IndirectBrInst>(BB->getTerminator())) {
4154 if (SimplifyIndirectBr(IBI)) return true;
Chris Lattnere42732e2004-02-16 06:35:48 +00004155 }
4156
Chris Lattner031340a2003-08-17 19:41:53 +00004157 return Changed;
Chris Lattner466a0492002-05-21 20:50:24 +00004158}
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +00004159
4160/// SimplifyCFG - This function is used to do simplification of a CFG. For
4161/// example, it adjusts branches to branches to eliminate the extra hop, it
4162/// eliminates unreachable basic blocks, and does other "peephole" optimization
4163/// of the CFG. It returns true if a modification was made.
4164///
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00004165bool llvm::SimplifyCFG(BasicBlock *BB, const TargetTransformInfo &TTI,
Tom Stellardaa664d92013-08-06 02:43:45 +00004166 const DataLayout *TD) {
4167 return SimplifyCFGOpt(TTI, TD).run(BB);
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +00004168}