blob: ff50b12cdb3fb62b743fd82364de9869c5237f92 [file] [log] [blame]
Chris Lattner01d1ee32002-05-21 20:50:24 +00001//===- SimplifyCFG.cpp - Code to perform CFG simplification ---------------===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanfd939082005-04-21 23:48:37 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner01d1ee32002-05-21 20:50:24 +00009//
Chris Lattnerbb190ac2002-10-08 21:36:33 +000010// Peephole optimize the CFG.
Chris Lattner01d1ee32002-05-21 20:50:24 +000011//
12//===----------------------------------------------------------------------===//
13
Chris Lattner218a8222004-06-20 01:13:18 +000014#define DEBUG_TYPE "simplifycfg"
Chris Lattner01d1ee32002-05-21 20:50:24 +000015#include "llvm/Transforms/Utils/Local.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000016#include "llvm/ADT/DenseMap.h"
17#include "llvm/ADT/STLExtras.h"
18#include "llvm/ADT/SetVector.h"
19#include "llvm/ADT/SmallPtrSet.h"
20#include "llvm/ADT/SmallVector.h"
21#include "llvm/ADT/Statistic.h"
Benjamin Kramerf6814372013-11-12 12:24:36 +000022#include "llvm/Analysis/ConstantFolding.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000023#include "llvm/Analysis/InstructionSimplify.h"
Chandler Carruthbe049292013-01-07 03:08:10 +000024#include "llvm/Analysis/TargetTransformInfo.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000025#include "llvm/Analysis/ValueTracking.h"
Chandler Carruth0b8c9a82013-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 Lattner302ba6f2010-12-14 06:17:25 +000039#include "llvm/Support/CFG.h"
Evan Chengc3f507f2011-01-29 04:46:23 +000040#include "llvm/Support/CommandLine.h"
Chris Lattnere27db742010-12-17 06:20:15 +000041#include "llvm/Support/ConstantRange.h"
Chris Lattner302ba6f2010-12-14 06:17:25 +000042#include "llvm/Support/Debug.h"
Devang Pateld3a17882011-05-19 20:52:46 +000043#include "llvm/Support/NoFolder.h"
Benjamin Kramer32d15d92013-07-04 14:22:02 +000044#include "llvm/Support/PatternMatch.h"
Chris Lattner302ba6f2010-12-14 06:17:25 +000045#include "llvm/Support/raw_ostream.h"
Chandler Carruth06cb8ed2012-06-29 12:38:19 +000046#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Chris Lattner01d1ee32002-05-21 20:50:24 +000047#include <algorithm>
Chris Lattner698f96f2004-10-18 04:07:22 +000048#include <map>
Chandler Carruthd04a8d42012-12-03 16:50:05 +000049#include <set>
Chris Lattnerf7703df2004-01-09 06:12:26 +000050using namespace llvm;
Benjamin Kramer32d15d92013-07-04 14:22:02 +000051using namespace PatternMatch;
Brian Gaeked0fde302003-11-11 22:41:34 +000052
Peter Collingbourne57808b32011-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 Chengc3f507f2011-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 Ren554da1a2012-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
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +000065static cl::opt<bool>
66HoistCondStores("simplifycfg-hoist-cond-stores", cl::Hidden, cl::init(true),
67 cl::desc("Hoist conditional stores if an unconditional store preceeds"));
68
Hans Wennborgd72271c2012-09-26 09:44:49 +000069STATISTIC(NumBitMaps, "Number of switch instructions turned into bitmaps");
Hans Wennborg50b7d702012-09-26 14:01:53 +000070STATISTIC(NumLookupTables, "Number of switch instructions turned into lookup tables");
Manman Ren554da1a2012-09-20 22:37:36 +000071STATISTIC(NumSinkCommons, "Number of common instructions sunk down to the end block");
Hans Wennborg50b7d702012-09-26 14:01:53 +000072STATISTIC(NumSpeculations, "Number of speculative executed instructions");
Evan Cheng502a4f52008-06-12 21:15:59 +000073
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000074namespace {
Eric Christopherc723eb12012-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 Kramer8e13ded2012-10-14 11:15:42 +000087
88 bool operator==(BasicBlock *RHSDest) const { return Dest == RHSDest; }
Eric Christopherc723eb12012-07-02 23:22:21 +000089 };
90
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000091class SimplifyCFGOpt {
Chandler Carruth5f46c3c2013-01-07 03:53:25 +000092 const TargetTransformInfo &TTI;
Micah Villmow3574eca2012-10-08 16:38:25 +000093 const DataLayout *const TD;
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000094 Value *isValueEqualityComparison(TerminatorInst *TI);
95 BasicBlock *GetValueEqualityComparisonCases(TerminatorInst *TI,
Eric Christopherc723eb12012-07-02 23:22:21 +000096 std::vector<ValueEqualityComparisonCase> &Cases);
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +000097 bool SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
Devang Patel007349d2011-05-18 20:35:38 +000098 BasicBlock *Pred,
99 IRBuilder<> &Builder);
Devang Patelb55d9242011-05-18 20:53:17 +0000100 bool FoldValueComparisonIntoPredecessors(TerminatorInst *TI,
101 IRBuilder<> &Builder);
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000102
Devang Patel176ec402011-05-18 21:33:11 +0000103 bool SimplifyReturn(ReturnInst *RI, IRBuilder<> &Builder);
Bill Wendlingaa5abe82012-02-06 21:16:41 +0000104 bool SimplifyResume(ResumeInst *RI, IRBuilder<> &Builder);
Chris Lattner3d512132010-12-13 06:25:44 +0000105 bool SimplifyUnreachable(UnreachableInst *UI);
Devang Patel007349d2011-05-18 20:35:38 +0000106 bool SimplifySwitch(SwitchInst *SI, IRBuilder<> &Builder);
Chris Lattner3d512132010-12-13 06:25:44 +0000107 bool SimplifyIndirectBr(IndirectBrInst *IBI);
Devang Patela23812c2011-05-18 18:28:48 +0000108 bool SimplifyUncondBranch(BranchInst *BI, IRBuilder <> &Builder);
Devang Patel007349d2011-05-18 20:35:38 +0000109 bool SimplifyCondBranch(BranchInst *BI, IRBuilder <>&Builder);
Chris Lattner3d512132010-12-13 06:25:44 +0000110
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000111public:
Tom Stellard01d72032013-08-06 02:43:45 +0000112 SimplifyCFGOpt(const TargetTransformInfo &TTI, const DataLayout *TD)
113 : TTI(TTI), TD(TD) {}
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000114 bool run(BasicBlock *BB);
115};
116}
117
Chris Lattner2bdcb562005-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 Trick6b014382012-08-29 21:46:36 +0000123
Chris Lattner2bdcb562005-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 Lattnerc9951232007-04-02 01:44:59 +0000129 SmallPtrSet<BasicBlock*, 16> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
Andrew Trick6b014382012-08-29 21:46:36 +0000130
Chris Lattner2bdcb562005-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 Trick6b014382012-08-29 21:46:36 +0000140
Chris Lattner2bdcb562005-08-03 00:19:45 +0000141 return true;
142}
143
Manman Renee28e0f2012-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 Lewyckyedb58422012-06-24 10:15:42 +0000151 Instruction *Cond,
Manman Renee28e0f2012-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 Trick6b014382012-08-29 21:46:36 +0000157 // common successors:
Manman Renee28e0f2012-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 Lewyckyedb58422012-06-24 10:15:42 +0000178 !isa<ConstantInt>(PN->getIncomingValueForBlock(SI2BB)))
Manman Renee28e0f2012-06-13 05:43:29 +0000179 return false;
180 PhiNodes.push_back(PN);
181 }
182 return true;
183}
184
Chris Lattner2bdcb562005-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 Lattner2bdcb562005-08-03 00:19:45 +0000191 if (!isa<PHINode>(Succ->begin())) return; // Quick exit if nothing to do
Andrew Trick6b014382012-08-29 21:46:36 +0000192
Chris Lattner093a4382008-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 Lattner2bdcb562005-08-03 00:19:45 +0000197}
198
David Majnemerf7dad782013-06-01 19:43:23 +0000199/// ComputeSpeculationCost - Compute an abstract "cost" of speculating the
Dan Gohman3b205172012-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 Wendling5049fa62009-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 Collingbournef15907f2011-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 Lattner9c078662004-10-14 05:13:36 +0000252static bool DominatesMergePoint(Value *V, BasicBlock *BB,
Peter Collingbournef15907f2011-04-29 18:47:31 +0000253 SmallPtrSet<Instruction*, 4> *AggressiveInsts,
254 unsigned &CostRemaining) {
Chris Lattner570751c2004-04-09 22:50:22 +0000255 Instruction *I = dyn_cast<Instruction>(V);
Chris Lattnerb74b1812006-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 Lattner570751c2004-04-09 22:50:22 +0000264 BasicBlock *PBB = I->getParent();
Chris Lattner723c66d2004-02-11 03:36:04 +0000265
Chris Lattnerda895d62005-02-27 06:18:25 +0000266 // We don't want to allow weird loops that might have the "if condition" in
Chris Lattner570751c2004-04-09 22:50:22 +0000267 // the bottom of this block.
268 if (PBB == BB) return false;
Chris Lattner723c66d2004-02-11 03:36:04 +0000269
Chris Lattner570751c2004-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 Lattner44da7ca2010-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 Friedman0b79a772009-07-17 04:28:42 +0000276
Chris Lattner44da7ca2010-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 Trick6b014382012-08-29 21:46:36 +0000280
Peter Collingbournef15907f2011-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 Lattner44da7ca2010-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 Gohmanf0426602011-12-14 23:49:11 +0000287 if (!isSafeToSpeculativelyExecute(I))
Chris Lattner44da7ca2010-12-14 07:41:39 +0000288 return false;
Misha Brukmanfd939082005-04-21 23:48:37 +0000289
Dan Gohman3b205172012-01-05 23:58:56 +0000290 unsigned Cost = ComputeSpeculationCost(I);
Chris Lattner570751c2004-04-09 22:50:22 +0000291
Peter Collingbournef15907f2011-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 Lattner44da7ca2010-12-14 07:41:39 +0000299 for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i)
Peter Collingbournef15907f2011-04-29 18:47:31 +0000300 if (!DominatesMergePoint(*i, BB, AggressiveInsts, CostRemaining))
Chris Lattner44da7ca2010-12-14 07:41:39 +0000301 return false;
302 // Okay, it's safe to do this! Remember this instruction.
303 AggressiveInsts->insert(I);
Chris Lattner723c66d2004-02-11 03:36:04 +0000304 return true;
305}
Chris Lattner01d1ee32002-05-21 20:50:24 +0000306
Jakob Stoklund Olesen58e9ee82010-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 Villmow3574eca2012-10-08 16:38:25 +0000309static ConstantInt *GetConstantInt(Value *V, const DataLayout *TD) {
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000310 // Normal constant int.
311 ConstantInt *CI = dyn_cast<ConstantInt>(V);
Duncan Sands1df98592010-02-16 11:11:14 +0000312 if (CI || !TD || !isa<Constant>(V) || !V->getType()->isPointerTy())
Jakob Stoklund Olesen58e9ee82010-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 Sands7ed4f942012-10-29 17:31:46 +0000317 IntegerType *PtrTy = cast<IntegerType>(TD->getIntPtrType(V->getType()));
Jakob Stoklund Olesen58e9ee82010-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 Lattner0aa749b2010-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 Lattner28acc132010-12-13 03:30:12 +0000341static Value *
Chris Lattner0aa749b2010-12-13 04:26:26 +0000342GatherConstantCompares(Value *V, std::vector<ConstantInt*> &Vals, Value *&Extra,
Micah Villmow3574eca2012-10-08 16:38:25 +0000343 const DataLayout *TD, bool isEQ, unsigned &UsedICmps) {
Chris Lattner0aa749b2010-12-13 04:26:26 +0000344 Instruction *I = dyn_cast<Instruction>(V);
345 if (I == 0) return 0;
Andrew Trick6b014382012-08-29 21:46:36 +0000346
Chris Lattner7312a222010-12-13 04:50:38 +0000347 // If this is an icmp against a constant, handle this as one of the cases.
Chris Lattner0aa749b2010-12-13 04:26:26 +0000348 if (ICmpInst *ICI = dyn_cast<ICmpInst>(I)) {
Chris Lattnere27db742010-12-17 06:20:15 +0000349 if (ConstantInt *C = GetConstantInt(I->getOperand(1), TD)) {
Benjamin Kramer32d15d92013-07-04 14:22:02 +0000350 Value *RHSVal;
351 ConstantInt *RHSC;
352
Chris Lattnere27db742010-12-17 06:20:15 +0000353 if (ICI->getPredicate() == (isEQ ? ICmpInst::ICMP_EQ:ICmpInst::ICMP_NE)) {
Benjamin Kramer32d15d92013-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 Kramer33828bc2011-02-07 22:37:28 +0000368 UsedICmps++;
Chris Lattner0aa749b2010-12-13 04:26:26 +0000369 Vals.push_back(C);
370 return I->getOperand(0);
371 }
Andrew Trick6b014382012-08-29 21:46:36 +0000372
Chris Lattnere27db742010-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 Lattnera37029c2010-12-18 20:22:49 +0000376 ConstantRange::makeICmpRegion(ICI->getPredicate(), C->getValue());
Andrew Trick6b014382012-08-29 21:46:36 +0000377
Benjamin Kramer32d15d92013-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 Lattnere27db742010-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 Trick6b014382012-08-29 21:46:36 +0000389
Chris Lattnere27db742010-12-17 06:20:15 +0000390 // If there are a ton of values, we don't want to make a ginormous switch.
Nick Lewyckyf460bf82012-01-19 18:19:42 +0000391 if (Span.getSetSize().ugt(8) || Span.isEmptySet())
Chris Lattnere27db742010-12-17 06:20:15 +0000392 return 0;
Andrew Trick6b014382012-08-29 21:46:36 +0000393
Chris Lattnere27db742010-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 Kramer33828bc2011-02-07 22:37:28 +0000396 UsedICmps++;
Benjamin Kramer32d15d92013-07-04 14:22:02 +0000397 return hasAdd ? RHSVal : I->getOperand(0);
Chris Lattnere27db742010-12-17 06:20:15 +0000398 }
Chris Lattner662269d2010-12-13 04:18:32 +0000399 return 0;
400 }
Andrew Trick6b014382012-08-29 21:46:36 +0000401
Chris Lattner7312a222010-12-13 04:50:38 +0000402 // Otherwise, we can only handle an | or &, depending on isEQ.
Chris Lattner0aa749b2010-12-13 04:26:26 +0000403 if (I->getOpcode() != (isEQ ? Instruction::Or : Instruction::And))
Chris Lattner662269d2010-12-13 04:18:32 +0000404 return 0;
Andrew Trick6b014382012-08-29 21:46:36 +0000405
Chris Lattner7312a222010-12-13 04:50:38 +0000406 unsigned NumValsBeforeLHS = Vals.size();
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000407 unsigned UsedICmpsBeforeLHS = UsedICmps;
Chris Lattner0aa749b2010-12-13 04:26:26 +0000408 if (Value *LHS = GatherConstantCompares(I->getOperand(0), Vals, Extra, TD,
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000409 isEQ, UsedICmps)) {
Chris Lattner7312a222010-12-13 04:50:38 +0000410 unsigned NumVals = Vals.size();
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000411 unsigned UsedICmpsBeforeRHS = UsedICmps;
Chris Lattner0aa749b2010-12-13 04:26:26 +0000412 if (Value *RHS = GatherConstantCompares(I->getOperand(1), Vals, Extra, TD,
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000413 isEQ, UsedICmps)) {
Chris Lattner0aa749b2010-12-13 04:26:26 +0000414 if (LHS == RHS)
415 return LHS;
Chris Lattner92407e52010-12-13 07:41:29 +0000416 Vals.resize(NumVals);
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000417 UsedICmps = UsedICmpsBeforeRHS;
Chris Lattner0aa749b2010-12-13 04:26:26 +0000418 }
Chris Lattner7312a222010-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 Trick6b014382012-08-29 21:46:36 +0000426
Chris Lattner7312a222010-12-13 04:50:38 +0000427 Vals.resize(NumValsBeforeLHS);
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000428 UsedICmps = UsedICmpsBeforeLHS;
Chris Lattner7312a222010-12-13 04:50:38 +0000429 return 0;
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000430 }
Andrew Trick6b014382012-08-29 21:46:36 +0000431
Chris Lattner7312a222010-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 Lattner92407e52010-12-13 07:41:29 +0000435 Value *OldExtra = Extra;
Chris Lattner7312a222010-12-13 04:50:38 +0000436 Extra = I->getOperand(0);
437 if (Value *RHS = GatherConstantCompares(I->getOperand(1), Vals, Extra, TD,
Benjamin Kramer33828bc2011-02-07 22:37:28 +0000438 isEQ, UsedICmps))
Chris Lattner7312a222010-12-13 04:50:38 +0000439 return RHS;
Chris Lattner92407e52010-12-13 07:41:29 +0000440 assert(Vals.size() == NumValsBeforeLHS);
441 Extra = OldExtra;
Chris Lattner7312a222010-12-13 04:50:38 +0000442 }
Andrew Trick6b014382012-08-29 21:46:36 +0000443
Chris Lattner0d560082004-02-24 05:38:11 +0000444 return 0;
445}
Nick Lewycky9d523102011-12-26 20:37:40 +0000446
Eli Friedman080efb82008-12-16 20:54:32 +0000447static void EraseTerminatorInstAndDCECond(TerminatorInst *TI) {
Nick Lewycky9d523102011-12-26 20:37:40 +0000448 Instruction *Cond = 0;
Eli Friedman080efb82008-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 Bommel7ac40c32010-12-05 18:29:03 +0000454 } else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(TI)) {
455 Cond = dyn_cast<Instruction>(IBI->getAddress());
Eli Friedman080efb82008-12-16 20:54:32 +0000456 }
457
458 TI->eraseFromParent();
459 if (Cond) RecursivelyDeleteTriviallyDeadInstructions(Cond);
460}
461
Chris Lattner9fd49552008-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 Olesen58e9ee82010-02-05 22:03:18 +0000464Value *SimplifyCFGOpt::isValueEqualityComparison(TerminatorInst *TI) {
465 Value *CV = 0;
Chris Lattner4bebf082004-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 Olesen58e9ee82010-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 Lattner542f1492004-02-28 21:28:10 +0000473 if (BI->isConditional() && BI->getCondition()->hasOneUse())
Reid Spencere4d87aa2006-12-23 06:05:41 +0000474 if (ICmpInst *ICI = dyn_cast<ICmpInst>(BI->getCondition()))
David Majnemer404fa722013-06-03 20:39:50 +0000475 if (ICI->isEquality() && GetConstantInt(ICI->getOperand(1), TD))
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000476 CV = ICI->getOperand(0);
477
478 // Unwrap any lossless ptrtoint cast.
Matt Arsenault79de3d72013-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 Olesen58e9ee82010-02-05 22:03:18 +0000486 return CV;
Chris Lattner542f1492004-02-28 21:28:10 +0000487}
488
Bill Wendling5049fa62009-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 Olesen58e9ee82010-02-05 22:03:18 +0000491BasicBlock *SimplifyCFGOpt::
Misha Brukmanfd939082005-04-21 23:48:37 +0000492GetValueEqualityComparisonCases(TerminatorInst *TI,
Eric Christopherc723eb12012-07-02 23:22:21 +0000493 std::vector<ValueEqualityComparisonCase>
494 &Cases) {
Chris Lattner542f1492004-02-28 21:28:10 +0000495 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Eric Christopherc723eb12012-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 Lattner542f1492004-02-28 21:28:10 +0000500 return SI->getDefaultDest();
501 }
Eric Christopherc723eb12012-07-02 23:22:21 +0000502
Chris Lattner542f1492004-02-28 21:28:10 +0000503 BranchInst *BI = cast<BranchInst>(TI);
Reid Spencere4d87aa2006-12-23 06:05:41 +0000504 ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
Eric Christopherc723eb12012-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 Spencere4d87aa2006-12-23 06:05:41 +0000509 return BI->getSuccessor(ICI->getPredicate() == ICmpInst::ICMP_EQ);
Chris Lattner542f1492004-02-28 21:28:10 +0000510}
511
Eric Christopherc723eb12012-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 Kramer8e13ded2012-10-14 11:15:42 +0000517 Cases.erase(std::remove(Cases.begin(), Cases.end(), BB), Cases.end());
Eric Christopherc723eb12012-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 Wendling5049fa62009-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 Olesen58e9ee82010-02-05 22:03:18 +0000561bool SimplifyCFGOpt::
562SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
Devang Patel007349d2011-05-18 20:35:38 +0000563 BasicBlock *Pred,
564 IRBuilder<> &Builder) {
Chris Lattner623369a2005-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 Trickb1b97832012-08-29 21:46:38 +0000572 // TODO: Preserve branch weight metadata, similarly to how
573 // FoldValueComparisonIntoPredecessors preserves it.
574
Chris Lattner623369a2005-02-24 06:17:52 +0000575 // Find out information about when control will move from Pred to TI's block.
Eric Christopherc723eb12012-07-02 23:22:21 +0000576 std::vector<ValueEqualityComparisonCase> PredCases;
Chris Lattner623369a2005-02-24 06:17:52 +0000577 BasicBlock *PredDef = GetValueEqualityComparisonCases(Pred->getTerminator(),
578 PredCases);
Eric Christopherc723eb12012-07-02 23:22:21 +0000579 EliminateBlockCases(PredDef, PredCases); // Remove default from cases.
Misha Brukmanfd939082005-04-21 23:48:37 +0000580
Chris Lattner623369a2005-02-24 06:17:52 +0000581 // Find information about how control leaves this block.
Eric Christopherc723eb12012-07-02 23:22:21 +0000582 std::vector<ValueEqualityComparisonCase> ThisCases;
Chris Lattner623369a2005-02-24 06:17:52 +0000583 BasicBlock *ThisDef = GetValueEqualityComparisonCases(TI, ThisCases);
Eric Christopherc723eb12012-07-02 23:22:21 +0000584 EliminateBlockCases(ThisDef, ThisCases); // Remove default from cases.
Chris Lattner623369a2005-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 Christopherc723eb12012-07-02 23:22:21 +0000592 if (!ValuesOverlap(PredCases, ThisCases))
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000593 return false;
Andrew Trick6b014382012-08-29 21:46:36 +0000594
Chris Lattner9a2b72a2010-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 Patel007349d2011-05-18 20:35:38 +0000600 Instruction *NI = Builder.CreateBr(ThisDef);
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000601 (void) NI;
Chris Lattner623369a2005-02-24 06:17:52 +0000602
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000603 // Remove PHI node entries for the dead edge.
Eric Christopherc723eb12012-07-02 23:22:21 +0000604 ThisCases[0].Dest->removePredecessor(TI->getParent());
Chris Lattner623369a2005-02-24 06:17:52 +0000605
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000606 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
607 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
Chris Lattner623369a2005-02-24 06:17:52 +0000608
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000609 EraseTerminatorInstAndDCECond(TI);
610 return true;
Chris Lattner623369a2005-02-24 06:17:52 +0000611 }
Andrew Trick6b014382012-08-29 21:46:36 +0000612
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000613 SwitchInst *SI = cast<SwitchInst>(TI);
614 // Okay, TI has cases that are statically dead, prune them away.
Eric Christopherc723eb12012-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 Lattner623369a2005-02-24 06:17:52 +0000618
David Greene89d6fd32010-01-05 01:26:52 +0000619 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000620 << "Through successor TI: " << *TI);
Chris Lattner623369a2005-02-24 06:17:52 +0000621
Manman Renad289072012-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 Christopherc723eb12012-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 Renad289072012-09-14 21:53:06 +0000636 if (HasWeight) {
637 std::swap(Weights[i.getCaseIndex()+1], Weights.back());
638 Weights.pop_back();
639 }
Eric Christopherc723eb12012-07-02 23:22:21 +0000640 i.getCaseSuccessor()->removePredecessor(TI->getParent());
641 SI->removeCase(i);
642 }
643 }
Manman Rend61d1eb2012-10-11 22:28:34 +0000644 if (HasWeight && Weights.size() >= 2)
Manman Renad289072012-09-14 21:53:06 +0000645 SI->setMetadata(LLVMContext::MD_prof,
646 MDBuilder(SI->getParent()->getContext()).
647 createBranchWeights(Weights));
Eric Christopherc723eb12012-07-02 23:22:21 +0000648
649 DEBUG(dbgs() << "Leaving: " << *TI << "\n");
Chris Lattner623369a2005-02-24 06:17:52 +0000650 return true;
651 }
Andrew Trick6b014382012-08-29 21:46:36 +0000652
Chris Lattner9a2b72a2010-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 Christopherc723eb12012-07-02 23:22:21 +0000655 ConstantInt *TIV = 0;
Chris Lattner9a2b72a2010-12-13 01:47:07 +0000656 BasicBlock *TIBB = TI->getParent();
Eric Christopherc723eb12012-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 Lattner9a2b72a2010-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 Christopherc723eb12012-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 Lattner9a2b72a2010-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 Patel007349d2011-05-18 20:35:38 +0000686 Instruction *NI = Builder.CreateBr(TheRealDest);
Chris Lattner9a2b72a2010-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 Lattner623369a2005-02-24 06:17:52 +0000694}
695
Dale Johannesenc81f5442009-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 Johannesena9537cf2009-03-12 01:00:26 +0000706
Benjamin Kramer0d293e42013-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 Lattnerba3c8152010-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 Lattner6d4d21e2010-12-13 02:00:58 +0000716}
717
Andrew Trickb1b97832012-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 Ren020aba02012-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 Trickb1b97832012-08-29 21:46:38 +0000736 assert(CI);
Manman Ren020aba02012-09-11 17:43:35 +0000737 Weights.push_back(CI->getValue().getZExtValue());
Andrew Trickb1b97832012-08-29 21:46:38 +0000738 }
739
Manman Ren020aba02012-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 Trickb1b97832012-08-29 21:46:38 +0000748 }
749}
750
751/// Sees if any of the weights are too big for a uint32_t, and halves all the
752/// weights if any are.
753static void FitWeights(MutableArrayRef<uint64_t> Weights) {
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 }
760
761 if (! Halve)
762 return;
763
764 for (unsigned i = 0; i < Weights.size(); ++i)
765 Weights[i] /= 2;
766}
767
Bill Wendling5049fa62009-01-19 23:43:56 +0000768/// FoldValueComparisonIntoPredecessors - The specified terminator is a value
769/// equality comparison instruction (either a switch or a branch on "X == c").
770/// See if any of the predecessors of the terminator block are value comparisons
771/// on the same value. If so, and if safe to do so, fold them together.
Devang Patelb55d9242011-05-18 20:53:17 +0000772bool SimplifyCFGOpt::FoldValueComparisonIntoPredecessors(TerminatorInst *TI,
773 IRBuilder<> &Builder) {
Chris Lattner542f1492004-02-28 21:28:10 +0000774 BasicBlock *BB = TI->getParent();
775 Value *CV = isValueEqualityComparison(TI); // CondVal
776 assert(CV && "Not a comparison?");
777 bool Changed = false;
778
Chris Lattner82442432008-02-18 07:42:56 +0000779 SmallVector<BasicBlock*, 16> Preds(pred_begin(BB), pred_end(BB));
Chris Lattner542f1492004-02-28 21:28:10 +0000780 while (!Preds.empty()) {
Dan Gohmane9d87f42009-05-06 17:22:41 +0000781 BasicBlock *Pred = Preds.pop_back_val();
Misha Brukmanfd939082005-04-21 23:48:37 +0000782
Chris Lattner542f1492004-02-28 21:28:10 +0000783 // See if the predecessor is a comparison with the same value.
784 TerminatorInst *PTI = Pred->getTerminator();
785 Value *PCV = isValueEqualityComparison(PTI); // PredCondVal
786
787 if (PCV == CV && SafeToMergeTerminators(TI, PTI)) {
788 // Figure out which 'cases' to copy from SI to PSI.
Eric Christopherc723eb12012-07-02 23:22:21 +0000789 std::vector<ValueEqualityComparisonCase> BBCases;
Chris Lattner542f1492004-02-28 21:28:10 +0000790 BasicBlock *BBDefault = GetValueEqualityComparisonCases(TI, BBCases);
791
Eric Christopherc723eb12012-07-02 23:22:21 +0000792 std::vector<ValueEqualityComparisonCase> PredCases;
Chris Lattner542f1492004-02-28 21:28:10 +0000793 BasicBlock *PredDefault = GetValueEqualityComparisonCases(PTI, PredCases);
794
795 // Based on whether the default edge from PTI goes to BB or not, fill in
796 // PredCases and PredDefault with the new switch cases we would like to
797 // build.
Chris Lattner82442432008-02-18 07:42:56 +0000798 SmallVector<BasicBlock*, 8> NewSuccessors;
Chris Lattner542f1492004-02-28 21:28:10 +0000799
Andrew Trickb1b97832012-08-29 21:46:38 +0000800 // Update the branch weight metadata along the way
801 SmallVector<uint64_t, 8> Weights;
Andrew Trickb1b97832012-08-29 21:46:38 +0000802 bool PredHasWeights = HasBranchWeights(PTI);
803 bool SuccHasWeights = HasBranchWeights(TI);
804
Manman Ren796d9452012-09-14 19:05:19 +0000805 if (PredHasWeights) {
Manman Ren020aba02012-09-11 17:43:35 +0000806 GetBranchWeights(PTI, Weights);
Andrew Trickc2aa0032012-11-15 18:40:31 +0000807 // branch-weight metadata is inconsistent here.
Manman Ren796d9452012-09-14 19:05:19 +0000808 if (Weights.size() != 1 + PredCases.size())
809 PredHasWeights = SuccHasWeights = false;
810 } else if (SuccHasWeights)
Andrew Trickb1b97832012-08-29 21:46:38 +0000811 // If there are no predecessor weights but there are successor weights,
812 // populate Weights with 1, which will later be scaled to the sum of
813 // successor's weights
814 Weights.assign(1 + PredCases.size(), 1);
Andrew Trickb1b97832012-08-29 21:46:38 +0000815
Manman Ren020aba02012-09-11 17:43:35 +0000816 SmallVector<uint64_t, 8> SuccWeights;
Manman Ren796d9452012-09-14 19:05:19 +0000817 if (SuccHasWeights) {
Manman Ren020aba02012-09-11 17:43:35 +0000818 GetBranchWeights(TI, SuccWeights);
Andrew Trickc2aa0032012-11-15 18:40:31 +0000819 // branch-weight metadata is inconsistent here.
Manman Ren796d9452012-09-14 19:05:19 +0000820 if (SuccWeights.size() != 1 + BBCases.size())
821 PredHasWeights = SuccHasWeights = false;
822 } else if (PredHasWeights)
Manman Ren020aba02012-09-11 17:43:35 +0000823 SuccWeights.assign(1 + BBCases.size(), 1);
Andrew Trickb1b97832012-08-29 21:46:38 +0000824
Chris Lattner542f1492004-02-28 21:28:10 +0000825 if (PredDefault == BB) {
826 // If this is the default destination from PTI, only the edges in TI
827 // that don't occur in PTI, or that branch to BB will be activated.
Eric Christopherc723eb12012-07-02 23:22:21 +0000828 std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
829 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
830 if (PredCases[i].Dest != BB)
831 PTIHandled.insert(PredCases[i].Value);
832 else {
833 // The default destination is BB, we don't need explicit targets.
834 std::swap(PredCases[i], PredCases.back());
Andrew Trickb1b97832012-08-29 21:46:38 +0000835
Manman Ren020aba02012-09-11 17:43:35 +0000836 if (PredHasWeights || SuccHasWeights) {
837 // Increase weight for the default case.
838 Weights[0] += Weights[i+1];
Andrew Trickb1b97832012-08-29 21:46:38 +0000839 std::swap(Weights[i+1], Weights.back());
840 Weights.pop_back();
841 }
842
Eric Christopherc723eb12012-07-02 23:22:21 +0000843 PredCases.pop_back();
844 --i; --e;
845 }
Chris Lattner542f1492004-02-28 21:28:10 +0000846
Eric Christopherc723eb12012-07-02 23:22:21 +0000847 // Reconstruct the new switch statement we will be building.
Chris Lattner542f1492004-02-28 21:28:10 +0000848 if (PredDefault != BBDefault) {
849 PredDefault->removePredecessor(Pred);
850 PredDefault = BBDefault;
851 NewSuccessors.push_back(BBDefault);
852 }
Andrew Trickb1b97832012-08-29 21:46:38 +0000853
Manman Ren020aba02012-09-11 17:43:35 +0000854 unsigned CasesFromPred = Weights.size();
855 uint64_t ValidTotalSuccWeight = 0;
Eric Christopherc723eb12012-07-02 23:22:21 +0000856 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
857 if (!PTIHandled.count(BBCases[i].Value) &&
858 BBCases[i].Dest != BBDefault) {
859 PredCases.push_back(BBCases[i]);
860 NewSuccessors.push_back(BBCases[i].Dest);
Manman Ren020aba02012-09-11 17:43:35 +0000861 if (SuccHasWeights || PredHasWeights) {
862 // The default weight is at index 0, so weight for the ith case
863 // should be at index i+1. Scale the cases from successor by
864 // PredDefaultWeight (Weights[0]).
865 Weights.push_back(Weights[0] * SuccWeights[i+1]);
866 ValidTotalSuccWeight += SuccWeights[i+1];
Andrew Trickb1b97832012-08-29 21:46:38 +0000867 }
Eric Christopherc723eb12012-07-02 23:22:21 +0000868 }
Chris Lattner542f1492004-02-28 21:28:10 +0000869
Manman Ren020aba02012-09-11 17:43:35 +0000870 if (SuccHasWeights || PredHasWeights) {
871 ValidTotalSuccWeight += SuccWeights[0];
872 // Scale the cases from predecessor by ValidTotalSuccWeight.
873 for (unsigned i = 1; i < CasesFromPred; ++i)
874 Weights[i] *= ValidTotalSuccWeight;
875 // Scale the default weight by SuccDefaultWeight (SuccWeights[0]).
876 Weights[0] *= SuccWeights[0];
877 }
Chris Lattner542f1492004-02-28 21:28:10 +0000878 } else {
879 // If this is not the default destination from PSI, only the edges
880 // in SI that occur in PSI with a destination of BB will be
881 // activated.
Eric Christopherc723eb12012-07-02 23:22:21 +0000882 std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
Manman Rena8a2b992012-09-14 17:29:56 +0000883 std::map<ConstantInt*, uint64_t> WeightsForHandled;
Eric Christopherc723eb12012-07-02 23:22:21 +0000884 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
885 if (PredCases[i].Dest == BB) {
886 PTIHandled.insert(PredCases[i].Value);
Manman Rena8a2b992012-09-14 17:29:56 +0000887
888 if (PredHasWeights || SuccHasWeights) {
889 WeightsForHandled[PredCases[i].Value] = Weights[i+1];
890 std::swap(Weights[i+1], Weights.back());
891 Weights.pop_back();
892 }
893
Eric Christopherc723eb12012-07-02 23:22:21 +0000894 std::swap(PredCases[i], PredCases.back());
895 PredCases.pop_back();
896 --i; --e;
897 }
Chris Lattner542f1492004-02-28 21:28:10 +0000898
899 // Okay, now we know which constants were sent to BB from the
900 // predecessor. Figure out where they will all go now.
Eric Christopherc723eb12012-07-02 23:22:21 +0000901 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
902 if (PTIHandled.count(BBCases[i].Value)) {
903 // If this is one we are capable of getting...
Manman Rena8a2b992012-09-14 17:29:56 +0000904 if (PredHasWeights || SuccHasWeights)
905 Weights.push_back(WeightsForHandled[BBCases[i].Value]);
Eric Christopherc723eb12012-07-02 23:22:21 +0000906 PredCases.push_back(BBCases[i]);
907 NewSuccessors.push_back(BBCases[i].Dest);
908 PTIHandled.erase(BBCases[i].Value);// This constant is taken care of
909 }
910
Chris Lattner542f1492004-02-28 21:28:10 +0000911 // If there are any constants vectored to BB that TI doesn't handle,
912 // they must go to the default destination of TI.
Andrew Trick6b014382012-08-29 21:46:36 +0000913 for (std::set<ConstantInt*, ConstantIntOrdering>::iterator I =
Eric Christopherc723eb12012-07-02 23:22:21 +0000914 PTIHandled.begin(),
915 E = PTIHandled.end(); I != E; ++I) {
Andrew Trickdf523d42012-11-15 18:40:29 +0000916 if (PredHasWeights || SuccHasWeights)
917 Weights.push_back(WeightsForHandled[*I]);
Eric Christopherc723eb12012-07-02 23:22:21 +0000918 PredCases.push_back(ValueEqualityComparisonCase(*I, BBDefault));
Chris Lattner542f1492004-02-28 21:28:10 +0000919 NewSuccessors.push_back(BBDefault);
Eric Christopherc723eb12012-07-02 23:22:21 +0000920 }
Chris Lattner542f1492004-02-28 21:28:10 +0000921 }
922
923 // Okay, at this point, we know which new successor Pred will get. Make
924 // sure we update the number of entries in the PHI nodes for these
925 // successors.
926 for (unsigned i = 0, e = NewSuccessors.size(); i != e; ++i)
927 AddPredecessorToBlock(NewSuccessors[i], Pred, BB);
928
Devang Patelb55d9242011-05-18 20:53:17 +0000929 Builder.SetInsertPoint(PTI);
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000930 // Convert pointer to int before we switch.
Duncan Sands1df98592010-02-16 11:11:14 +0000931 if (CV->getType()->isPointerTy()) {
Micah Villmow3574eca2012-10-08 16:38:25 +0000932 assert(TD && "Cannot switch on pointer without DataLayout");
Matt Arsenault79de3d72013-10-21 18:55:08 +0000933 CV = Builder.CreatePtrToInt(CV, TD->getIntPtrType(CV->getType()),
Devang Patelb55d9242011-05-18 20:53:17 +0000934 "magicptr");
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +0000935 }
936
Chris Lattner542f1492004-02-28 21:28:10 +0000937 // Now that the successors are updated, create the new Switch instruction.
Devang Patelb55d9242011-05-18 20:53:17 +0000938 SwitchInst *NewSI = Builder.CreateSwitch(CV, PredDefault,
939 PredCases.size());
Devang Pateld80e8ed2011-05-17 23:29:05 +0000940 NewSI->setDebugLoc(PTI->getDebugLoc());
Eric Christopherc723eb12012-07-02 23:22:21 +0000941 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
942 NewSI->addCase(PredCases[i].Value, PredCases[i].Dest);
Chris Lattner13b2f762005-01-01 16:02:12 +0000943
Andrew Trickb1b97832012-08-29 21:46:38 +0000944 if (PredHasWeights || SuccHasWeights) {
945 // Halve the weights if any of them cannot fit in an uint32_t
946 FitWeights(Weights);
947
948 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
949
950 NewSI->setMetadata(LLVMContext::MD_prof,
951 MDBuilder(BB->getContext()).
952 createBranchWeights(MDWeights));
953 }
954
Eli Friedman080efb82008-12-16 20:54:32 +0000955 EraseTerminatorInstAndDCECond(PTI);
Chris Lattner13b2f762005-01-01 16:02:12 +0000956
Chris Lattner542f1492004-02-28 21:28:10 +0000957 // Okay, last check. If BB is still a successor of PSI, then we must
958 // have an infinite loop case. If so, add an infinitely looping block
959 // to handle the case to preserve the behavior of the code.
960 BasicBlock *InfLoopBlock = 0;
961 for (unsigned i = 0, e = NewSI->getNumSuccessors(); i != e; ++i)
962 if (NewSI->getSuccessor(i) == BB) {
963 if (InfLoopBlock == 0) {
Chris Lattner093a4382008-07-13 22:23:11 +0000964 // Insert it at the end of the function, because it's either code,
Chris Lattner542f1492004-02-28 21:28:10 +0000965 // or it won't matter if it's hot. :)
Owen Anderson1d0be152009-08-13 21:58:54 +0000966 InfLoopBlock = BasicBlock::Create(BB->getContext(),
967 "infloop", BB->getParent());
Gabor Greif051a9502008-04-06 20:25:17 +0000968 BranchInst::Create(InfLoopBlock, InfLoopBlock);
Chris Lattner542f1492004-02-28 21:28:10 +0000969 }
970 NewSI->setSuccessor(i, InfLoopBlock);
971 }
Misha Brukmanfd939082005-04-21 23:48:37 +0000972
Chris Lattner542f1492004-02-28 21:28:10 +0000973 Changed = true;
974 }
975 }
976 return Changed;
977}
978
Dale Johannesenc1f10402009-06-15 20:59:27 +0000979// isSafeToHoistInvoke - If we would need to insert a select that uses the
980// value of this invoke (comments in HoistThenElseCodeToIf explain why we
981// would need to do this), we can't hoist the invoke, as there is nowhere
982// to put the select in this case.
983static bool isSafeToHoistInvoke(BasicBlock *BB1, BasicBlock *BB2,
984 Instruction *I1, Instruction *I2) {
985 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
986 PHINode *PN;
987 for (BasicBlock::iterator BBI = SI->begin();
988 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
989 Value *BB1V = PN->getIncomingValueForBlock(BB1);
990 Value *BB2V = PN->getIncomingValueForBlock(BB2);
991 if (BB1V != BB2V && (BB1V==I1 || BB2V==I2)) {
992 return false;
993 }
994 }
995 }
996 return true;
997}
998
Chris Lattner6306d072005-08-03 17:59:45 +0000999/// HoistThenElseCodeToIf - Given a conditional branch that goes to BB1 and
Chris Lattner37dc9382004-11-30 00:29:14 +00001000/// BB2, hoist any common code in the two blocks up into the branch block. The
1001/// caller of this function guarantees that BI's block dominates BB1 and BB2.
Rafael Espindola216dde92011-05-19 02:26:30 +00001002static bool HoistThenElseCodeToIf(BranchInst *BI) {
Chris Lattner37dc9382004-11-30 00:29:14 +00001003 // This does very trivial matching, with limited scanning, to find identical
1004 // instructions in the two blocks. In particular, we don't want to get into
1005 // O(M*N) situations here where M and N are the sizes of BB1 and BB2. As
1006 // such, we currently just scan for obviously identical instructions in an
1007 // identical order.
1008 BasicBlock *BB1 = BI->getSuccessor(0); // The true destination.
1009 BasicBlock *BB2 = BI->getSuccessor(1); // The false destination
1010
Devang Patel65085cf2009-02-04 00:03:08 +00001011 BasicBlock::iterator BB1_Itr = BB1->begin();
1012 BasicBlock::iterator BB2_Itr = BB2->begin();
1013
1014 Instruction *I1 = BB1_Itr++, *I2 = BB2_Itr++;
Devang Patel949666e2011-04-07 17:27:36 +00001015 // Skip debug info if it is not identical.
1016 DbgInfoIntrinsic *DBI1 = dyn_cast<DbgInfoIntrinsic>(I1);
1017 DbgInfoIntrinsic *DBI2 = dyn_cast<DbgInfoIntrinsic>(I2);
1018 if (!DBI1 || !DBI2 || !DBI1->isIdenticalToWhenDefined(DBI2)) {
1019 while (isa<DbgInfoIntrinsic>(I1))
1020 I1 = BB1_Itr++;
1021 while (isa<DbgInfoIntrinsic>(I2))
1022 I2 = BB2_Itr++;
1023 }
Devang Patelae6c95b2011-04-07 00:30:15 +00001024 if (isa<PHINode>(I1) || !I1->isIdenticalToWhenDefined(I2) ||
Dale Johannesenc1f10402009-06-15 20:59:27 +00001025 (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2)))
Chris Lattner37dc9382004-11-30 00:29:14 +00001026 return false;
1027
Chris Lattner37dc9382004-11-30 00:29:14 +00001028 BasicBlock *BIParent = BI->getParent();
Chris Lattner37dc9382004-11-30 00:29:14 +00001029
David Majnemer3931bdb2013-06-03 20:43:12 +00001030 bool Changed = false;
Chris Lattner37dc9382004-11-30 00:29:14 +00001031 do {
1032 // If we are hoisting the terminator instruction, don't move one (making a
1033 // broken BB), instead clone it, and remove BI.
1034 if (isa<TerminatorInst>(I1))
1035 goto HoistTerminator;
Misha Brukmanfd939082005-04-21 23:48:37 +00001036
Chris Lattner37dc9382004-11-30 00:29:14 +00001037 // For a normal instruction, we just move one to right before the branch,
1038 // then replace all uses of the other with the first. Finally, we remove
1039 // the now redundant second instruction.
1040 BIParent->getInstList().splice(BI, BB1->getInstList(), I1);
1041 if (!I2->use_empty())
1042 I2->replaceAllUsesWith(I1);
Dan Gohman58cfa3b2009-08-25 22:11:20 +00001043 I1->intersectOptionalDataWith(I2);
Chris Lattner302ba6f2010-12-14 06:17:25 +00001044 I2->eraseFromParent();
David Majnemer3931bdb2013-06-03 20:43:12 +00001045 Changed = true;
Misha Brukmanfd939082005-04-21 23:48:37 +00001046
Devang Patel65085cf2009-02-04 00:03:08 +00001047 I1 = BB1_Itr++;
Devang Patel65085cf2009-02-04 00:03:08 +00001048 I2 = BB2_Itr++;
Devang Patel949666e2011-04-07 17:27:36 +00001049 // Skip debug info if it is not identical.
1050 DbgInfoIntrinsic *DBI1 = dyn_cast<DbgInfoIntrinsic>(I1);
1051 DbgInfoIntrinsic *DBI2 = dyn_cast<DbgInfoIntrinsic>(I2);
1052 if (!DBI1 || !DBI2 || !DBI1->isIdenticalToWhenDefined(DBI2)) {
1053 while (isa<DbgInfoIntrinsic>(I1))
1054 I1 = BB1_Itr++;
1055 while (isa<DbgInfoIntrinsic>(I2))
1056 I2 = BB2_Itr++;
1057 }
Devang Patelae6c95b2011-04-07 00:30:15 +00001058 } while (I1->isIdenticalToWhenDefined(I2));
Chris Lattner37dc9382004-11-30 00:29:14 +00001059
1060 return true;
1061
1062HoistTerminator:
Dale Johannesenc1f10402009-06-15 20:59:27 +00001063 // It may not be possible to hoist an invoke.
1064 if (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2))
David Majnemer3931bdb2013-06-03 20:43:12 +00001065 return Changed;
1066
1067 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
1068 PHINode *PN;
1069 for (BasicBlock::iterator BBI = SI->begin();
1070 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
1071 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1072 Value *BB2V = PN->getIncomingValueForBlock(BB2);
1073 if (BB1V == BB2V)
1074 continue;
1075
1076 if (isa<ConstantExpr>(BB1V) && !isSafeToSpeculativelyExecute(BB1V))
1077 return Changed;
1078 if (isa<ConstantExpr>(BB2V) && !isSafeToSpeculativelyExecute(BB2V))
1079 return Changed;
1080 }
1081 }
Dale Johannesenc1f10402009-06-15 20:59:27 +00001082
Chris Lattner37dc9382004-11-30 00:29:14 +00001083 // Okay, it is safe to hoist the terminator.
Nick Lewycky67760642009-09-27 07:38:41 +00001084 Instruction *NT = I1->clone();
Chris Lattner37dc9382004-11-30 00:29:14 +00001085 BIParent->getInstList().insert(BI, NT);
Benjamin Kramerf0127052010-01-05 13:12:22 +00001086 if (!NT->getType()->isVoidTy()) {
Chris Lattner37dc9382004-11-30 00:29:14 +00001087 I1->replaceAllUsesWith(NT);
1088 I2->replaceAllUsesWith(NT);
Chris Lattner86cc4232007-02-11 01:37:51 +00001089 NT->takeName(I1);
Chris Lattner37dc9382004-11-30 00:29:14 +00001090 }
1091
Devang Pateld3a17882011-05-19 20:52:46 +00001092 IRBuilder<true, NoFolder> Builder(NT);
Chris Lattner37dc9382004-11-30 00:29:14 +00001093 // Hoisting one of the terminators from our successor is a great thing.
1094 // Unfortunately, the successors of the if/else blocks may have PHI nodes in
1095 // them. If they do, all PHI entries for BB1/BB2 must agree for all PHI
1096 // nodes, so we insert select instruction to compute the final result.
1097 std::map<std::pair<Value*,Value*>, SelectInst*> InsertedSelects;
1098 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
1099 PHINode *PN;
1100 for (BasicBlock::iterator BBI = SI->begin();
Chris Lattner0f535c62004-11-30 07:47:34 +00001101 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
Chris Lattner37dc9382004-11-30 00:29:14 +00001102 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1103 Value *BB2V = PN->getIncomingValueForBlock(BB2);
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001104 if (BB1V == BB2V) continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001105
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001106 // These values do not agree. Insert a select instruction before NT
1107 // that determines the right value.
1108 SelectInst *&SI = InsertedSelects[std::make_pair(BB1V, BB2V)];
Andrew Trick6b014382012-08-29 21:46:36 +00001109 if (SI == 0)
Devang Pateld3a17882011-05-19 20:52:46 +00001110 SI = cast<SelectInst>
1111 (Builder.CreateSelect(BI->getCondition(), BB1V, BB2V,
1112 BB1V->getName()+"."+BB2V->getName()));
1113
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001114 // Make the PHI node use the select for all incoming values for BB1/BB2
1115 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1116 if (PN->getIncomingBlock(i) == BB1 || PN->getIncomingBlock(i) == BB2)
1117 PN->setIncomingValue(i, SI);
Chris Lattner37dc9382004-11-30 00:29:14 +00001118 }
1119 }
1120
1121 // Update any PHI nodes in our new successors.
1122 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI)
1123 AddPredecessorToBlock(*SI, BIParent, BB1);
Misha Brukmanfd939082005-04-21 23:48:37 +00001124
Eli Friedman080efb82008-12-16 20:54:32 +00001125 EraseTerminatorInstAndDCECond(BI);
Chris Lattner37dc9382004-11-30 00:29:14 +00001126 return true;
1127}
1128
Manman Ren554da1a2012-09-20 22:37:36 +00001129/// SinkThenElseCodeToEnd - Given an unconditional branch that goes to BBEnd,
1130/// check whether BBEnd has only two predecessors and the other predecessor
1131/// ends with an unconditional branch. If it is true, sink any common code
1132/// in the two predecessors to BBEnd.
1133static bool SinkThenElseCodeToEnd(BranchInst *BI1) {
1134 assert(BI1->isUnconditional());
1135 BasicBlock *BB1 = BI1->getParent();
1136 BasicBlock *BBEnd = BI1->getSuccessor(0);
1137
1138 // Check that BBEnd has two predecessors and the other predecessor ends with
1139 // an unconditional branch.
Benjamin Kramerfdb96062012-09-30 21:03:56 +00001140 pred_iterator PI = pred_begin(BBEnd), PE = pred_end(BBEnd);
1141 BasicBlock *Pred0 = *PI++;
1142 if (PI == PE) // Only one predecessor.
Manman Ren554da1a2012-09-20 22:37:36 +00001143 return false;
Benjamin Kramerfdb96062012-09-30 21:03:56 +00001144 BasicBlock *Pred1 = *PI++;
1145 if (PI != PE) // More than two predecessors.
1146 return false;
1147 BasicBlock *BB2 = (Pred0 == BB1) ? Pred1 : Pred0;
Manman Ren554da1a2012-09-20 22:37:36 +00001148 BranchInst *BI2 = dyn_cast<BranchInst>(BB2->getTerminator());
1149 if (!BI2 || !BI2->isUnconditional())
1150 return false;
1151
1152 // Gather the PHI nodes in BBEnd.
1153 std::map<Value*, std::pair<Value*, PHINode*> > MapValueFromBB1ToBB2;
1154 Instruction *FirstNonPhiInBBEnd = 0;
1155 for (BasicBlock::iterator I = BBEnd->begin(), E = BBEnd->end();
1156 I != E; ++I) {
1157 if (PHINode *PN = dyn_cast<PHINode>(I)) {
1158 Value *BB1V = PN->getIncomingValueForBlock(BB1);
Andrew Trickdf523d42012-11-15 18:40:29 +00001159 Value *BB2V = PN->getIncomingValueForBlock(BB2);
Manman Ren554da1a2012-09-20 22:37:36 +00001160 MapValueFromBB1ToBB2[BB1V] = std::make_pair(BB2V, PN);
1161 } else {
1162 FirstNonPhiInBBEnd = &*I;
1163 break;
1164 }
1165 }
1166 if (!FirstNonPhiInBBEnd)
1167 return false;
Andrew Trickdf523d42012-11-15 18:40:29 +00001168
Manman Ren554da1a2012-09-20 22:37:36 +00001169
1170 // This does very trivial matching, with limited scanning, to find identical
1171 // instructions in the two blocks. We scan backward for obviously identical
1172 // instructions in an identical order.
1173 BasicBlock::InstListType::reverse_iterator RI1 = BB1->getInstList().rbegin(),
1174 RE1 = BB1->getInstList().rend(), RI2 = BB2->getInstList().rbegin(),
1175 RE2 = BB2->getInstList().rend();
1176 // Skip debug info.
1177 while (RI1 != RE1 && isa<DbgInfoIntrinsic>(&*RI1)) ++RI1;
1178 if (RI1 == RE1)
1179 return false;
1180 while (RI2 != RE2 && isa<DbgInfoIntrinsic>(&*RI2)) ++RI2;
1181 if (RI2 == RE2)
1182 return false;
1183 // Skip the unconditional branches.
1184 ++RI1;
1185 ++RI2;
1186
1187 bool Changed = false;
1188 while (RI1 != RE1 && RI2 != RE2) {
1189 // Skip debug info.
1190 while (RI1 != RE1 && isa<DbgInfoIntrinsic>(&*RI1)) ++RI1;
1191 if (RI1 == RE1)
1192 return Changed;
1193 while (RI2 != RE2 && isa<DbgInfoIntrinsic>(&*RI2)) ++RI2;
1194 if (RI2 == RE2)
1195 return Changed;
1196
1197 Instruction *I1 = &*RI1, *I2 = &*RI2;
1198 // I1 and I2 should have a single use in the same PHI node, and they
1199 // perform the same operation.
1200 // Cannot move control-flow-involving, volatile loads, vaarg, etc.
1201 if (isa<PHINode>(I1) || isa<PHINode>(I2) ||
1202 isa<TerminatorInst>(I1) || isa<TerminatorInst>(I2) ||
1203 isa<LandingPadInst>(I1) || isa<LandingPadInst>(I2) ||
1204 isa<AllocaInst>(I1) || isa<AllocaInst>(I2) ||
1205 I1->mayHaveSideEffects() || I2->mayHaveSideEffects() ||
1206 I1->mayReadOrWriteMemory() || I2->mayReadOrWriteMemory() ||
1207 !I1->hasOneUse() || !I2->hasOneUse() ||
1208 MapValueFromBB1ToBB2.find(I1) == MapValueFromBB1ToBB2.end() ||
1209 MapValueFromBB1ToBB2[I1].first != I2)
1210 return Changed;
1211
1212 // Check whether we should swap the operands of ICmpInst.
1213 ICmpInst *ICmp1 = dyn_cast<ICmpInst>(I1), *ICmp2 = dyn_cast<ICmpInst>(I2);
1214 bool SwapOpnds = false;
1215 if (ICmp1 && ICmp2 &&
1216 ICmp1->getOperand(0) != ICmp2->getOperand(0) &&
1217 ICmp1->getOperand(1) != ICmp2->getOperand(1) &&
1218 (ICmp1->getOperand(0) == ICmp2->getOperand(1) ||
1219 ICmp1->getOperand(1) == ICmp2->getOperand(0))) {
1220 ICmp2->swapOperands();
1221 SwapOpnds = true;
1222 }
1223 if (!I1->isSameOperationAs(I2)) {
1224 if (SwapOpnds)
1225 ICmp2->swapOperands();
1226 return Changed;
1227 }
1228
1229 // The operands should be either the same or they need to be generated
1230 // with a PHI node after sinking. We only handle the case where there is
1231 // a single pair of different operands.
1232 Value *DifferentOp1 = 0, *DifferentOp2 = 0;
1233 unsigned Op1Idx = 0;
1234 for (unsigned I = 0, E = I1->getNumOperands(); I != E; ++I) {
1235 if (I1->getOperand(I) == I2->getOperand(I))
1236 continue;
1237 // Early exit if we have more-than one pair of different operands or
1238 // the different operand is already in MapValueFromBB1ToBB2.
1239 // Early exit if we need a PHI node to replace a constant.
1240 if (DifferentOp1 ||
1241 MapValueFromBB1ToBB2.find(I1->getOperand(I)) !=
1242 MapValueFromBB1ToBB2.end() ||
1243 isa<Constant>(I1->getOperand(I)) ||
1244 isa<Constant>(I2->getOperand(I))) {
1245 // If we can't sink the instructions, undo the swapping.
1246 if (SwapOpnds)
1247 ICmp2->swapOperands();
1248 return Changed;
1249 }
1250 DifferentOp1 = I1->getOperand(I);
1251 Op1Idx = I;
1252 DifferentOp2 = I2->getOperand(I);
1253 }
1254
1255 // We insert the pair of different operands to MapValueFromBB1ToBB2 and
1256 // remove (I1, I2) from MapValueFromBB1ToBB2.
1257 if (DifferentOp1) {
1258 PHINode *NewPN = PHINode::Create(DifferentOp1->getType(), 2,
1259 DifferentOp1->getName() + ".sink",
1260 BBEnd->begin());
1261 MapValueFromBB1ToBB2[DifferentOp1] = std::make_pair(DifferentOp2, NewPN);
1262 // I1 should use NewPN instead of DifferentOp1.
1263 I1->setOperand(Op1Idx, NewPN);
1264 NewPN->addIncoming(DifferentOp1, BB1);
1265 NewPN->addIncoming(DifferentOp2, BB2);
1266 DEBUG(dbgs() << "Create PHI node " << *NewPN << "\n";);
1267 }
1268 PHINode *OldPN = MapValueFromBB1ToBB2[I1].second;
1269 MapValueFromBB1ToBB2.erase(I1);
1270
1271 DEBUG(dbgs() << "SINK common instructions " << *I1 << "\n";);
1272 DEBUG(dbgs() << " " << *I2 << "\n";);
1273 // We need to update RE1 and RE2 if we are going to sink the first
1274 // instruction in the basic block down.
1275 bool UpdateRE1 = (I1 == BB1->begin()), UpdateRE2 = (I2 == BB2->begin());
1276 // Sink the instruction.
1277 BBEnd->getInstList().splice(FirstNonPhiInBBEnd, BB1->getInstList(), I1);
1278 if (!OldPN->use_empty())
1279 OldPN->replaceAllUsesWith(I1);
1280 OldPN->eraseFromParent();
1281
1282 if (!I2->use_empty())
1283 I2->replaceAllUsesWith(I1);
1284 I1->intersectOptionalDataWith(I2);
1285 I2->eraseFromParent();
1286
1287 if (UpdateRE1)
1288 RE1 = BB1->getInstList().rend();
1289 if (UpdateRE2)
1290 RE2 = BB2->getInstList().rend();
1291 FirstNonPhiInBBEnd = I1;
1292 NumSinkCommons++;
1293 Changed = true;
1294 }
1295 return Changed;
1296}
1297
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001298/// \brief Determine if we can hoist sink a sole store instruction out of a
1299/// conditional block.
1300///
1301/// We are looking for code like the following:
1302/// BrBB:
1303/// store i32 %add, i32* %arrayidx2
1304/// ... // No other stores or function calls (we could be calling a memory
1305/// ... // function).
1306/// %cmp = icmp ult %x, %y
1307/// br i1 %cmp, label %EndBB, label %ThenBB
1308/// ThenBB:
1309/// store i32 %add5, i32* %arrayidx2
1310/// br label EndBB
1311/// EndBB:
1312/// ...
1313/// We are going to transform this into:
1314/// BrBB:
1315/// store i32 %add, i32* %arrayidx2
1316/// ... //
1317/// %cmp = icmp ult %x, %y
1318/// %add.add5 = select i1 %cmp, i32 %add, %add5
1319/// store i32 %add.add5, i32* %arrayidx2
1320/// ...
1321///
1322/// \return The pointer to the value of the previous store if the store can be
1323/// hoisted into the predecessor block. 0 otherwise.
Benjamin Kramer603100d2013-05-23 16:09:15 +00001324static Value *isSafeToSpeculateStore(Instruction *I, BasicBlock *BrBB,
1325 BasicBlock *StoreBB, BasicBlock *EndBB) {
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001326 StoreInst *StoreToHoist = dyn_cast<StoreInst>(I);
1327 if (!StoreToHoist)
1328 return 0;
1329
1330 // Volatile or atomic.
1331 if (!StoreToHoist->isSimple())
1332 return 0;
1333
1334 Value *StorePtr = StoreToHoist->getPointerOperand();
1335
1336 // Look for a store to the same pointer in BrBB.
1337 unsigned MaxNumInstToLookAt = 10;
1338 for (BasicBlock::reverse_iterator RI = BrBB->rbegin(),
1339 RE = BrBB->rend(); RI != RE && (--MaxNumInstToLookAt); ++RI) {
1340 Instruction *CurI = &*RI;
1341
1342 // Could be calling an instruction that effects memory like free().
1343 if (CurI->mayHaveSideEffects() && !isa<StoreInst>(CurI))
1344 return 0;
1345
1346 StoreInst *SI = dyn_cast<StoreInst>(CurI);
1347 // Found the previous store make sure it stores to the same location.
1348 if (SI && SI->getPointerOperand() == StorePtr)
1349 // Found the previous store, return its value operand.
1350 return SI->getValueOperand();
1351 else if (SI)
1352 return 0; // Unknown store.
1353 }
1354
1355 return 0;
1356}
1357
Chandler Carruthc61bc7a2013-01-24 08:05:06 +00001358/// \brief Speculate a conditional basic block flattening the CFG.
Dan Gohman3b205172012-01-05 23:58:56 +00001359///
Chandler Carruthc61bc7a2013-01-24 08:05:06 +00001360/// Note that this is a very risky transform currently. Speculating
1361/// instructions like this is most often not desirable. Instead, there is an MI
1362/// pass which can do it with full awareness of the resource constraints.
1363/// However, some cases are "obvious" and we should do directly. An example of
1364/// this is speculating a single, reasonably cheap instruction.
1365///
1366/// There is only one distinct advantage to flattening the CFG at the IR level:
1367/// it makes very common but simplistic optimizations such as are common in
1368/// instcombine and the DAG combiner more powerful by removing CFG edges and
1369/// modeling their effects with easier to reason about SSA value graphs.
1370///
1371///
1372/// An illustration of this transform is turning this IR:
1373/// \code
1374/// BB:
1375/// %cmp = icmp ult %x, %y
1376/// br i1 %cmp, label %EndBB, label %ThenBB
1377/// ThenBB:
1378/// %sub = sub %x, %y
Dan Gohman3b205172012-01-05 23:58:56 +00001379/// br label BB2
Chandler Carruthc61bc7a2013-01-24 08:05:06 +00001380/// EndBB:
1381/// %phi = phi [ %sub, %ThenBB ], [ 0, %EndBB ]
1382/// ...
1383/// \endcode
1384///
1385/// Into this IR:
1386/// \code
1387/// BB:
1388/// %cmp = icmp ult %x, %y
1389/// %sub = sub %x, %y
1390/// %cond = select i1 %cmp, 0, %sub
1391/// ...
1392/// \endcode
1393///
1394/// \returns true if the conditional block is removed.
Chandler Carruth455151e2013-01-27 06:42:03 +00001395static bool SpeculativelyExecuteBB(BranchInst *BI, BasicBlock *ThenBB) {
Chandler Carruth9e620952013-01-24 08:22:40 +00001396 // Be conservative for now. FP select instruction can often be expensive.
1397 Value *BrCond = BI->getCondition();
1398 if (isa<FCmpInst>(BrCond))
1399 return false;
1400
Chandler Carruth6cf7a912013-01-24 09:59:39 +00001401 BasicBlock *BB = BI->getParent();
1402 BasicBlock *EndBB = ThenBB->getTerminator()->getSuccessor(0);
1403
1404 // If ThenBB is actually on the false edge of the conditional branch, remember
1405 // to swap the select operands later.
1406 bool Invert = false;
1407 if (ThenBB != BI->getSuccessor(0)) {
1408 assert(ThenBB == BI->getSuccessor(1) && "No edge from 'if' block?");
1409 Invert = true;
1410 }
1411 assert(EndBB == BI->getSuccessor(!Invert) && "No edge from to end block");
1412
Chandler Carruthbaf868b2013-01-25 05:40:09 +00001413 // Keep a count of how many times instructions are used within CondBB when
1414 // they are candidates for sinking into CondBB. Specifically:
1415 // - They are defined in BB, and
1416 // - They have no side effects, and
1417 // - All of their uses are in CondBB.
1418 SmallDenseMap<Instruction *, unsigned, 4> SinkCandidateUseCounts;
1419
Chandler Carruth2c107a82013-01-24 11:52:58 +00001420 unsigned SpeculationCost = 0;
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001421 Value *SpeculatedStoreValue = 0;
1422 StoreInst *SpeculatedStore = 0;
Chandler Carruth2c107a82013-01-24 11:52:58 +00001423 for (BasicBlock::iterator BBI = ThenBB->begin(),
1424 BBE = llvm::prior(ThenBB->end());
Devang Patel06b1e672009-03-06 06:00:17 +00001425 BBI != BBE; ++BBI) {
1426 Instruction *I = BBI;
1427 // Skip debug info.
Chandler Carruth2c107a82013-01-24 11:52:58 +00001428 if (isa<DbgInfoIntrinsic>(I))
1429 continue;
Devang Patel06b1e672009-03-06 06:00:17 +00001430
Chandler Carruth2c107a82013-01-24 11:52:58 +00001431 // Only speculatively execution a single instruction (not counting the
1432 // terminator) for now.
Chandler Carruth455151e2013-01-27 06:42:03 +00001433 ++SpeculationCost;
1434 if (SpeculationCost > 1)
Devang Patel06b1e672009-03-06 06:00:17 +00001435 return false;
Dan Gohman3b205172012-01-05 23:58:56 +00001436
Dan Gohman3b205172012-01-05 23:58:56 +00001437 // Don't hoist the instruction if it's unsafe or expensive.
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001438 if (!isSafeToSpeculativelyExecute(I) &&
1439 !(HoistCondStores &&
1440 (SpeculatedStoreValue = isSafeToSpeculateStore(I, BB, ThenBB,
1441 EndBB))))
Dan Gohman3b205172012-01-05 23:58:56 +00001442 return false;
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001443 if (!SpeculatedStoreValue &&
1444 ComputeSpeculationCost(I) > PHINodeFoldingThreshold)
Dan Gohman3b205172012-01-05 23:58:56 +00001445 return false;
1446
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001447 // Store the store speculation candidate.
1448 if (SpeculatedStoreValue)
1449 SpeculatedStore = cast<StoreInst>(I);
1450
Dan Gohman3b205172012-01-05 23:58:56 +00001451 // Do not hoist the instruction if any of its operands are defined but not
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001452 // used in BB. The transformation will prevent the operand from
Dan Gohman3b205172012-01-05 23:58:56 +00001453 // being sunk into the use block.
Chandler Carruth2c107a82013-01-24 11:52:58 +00001454 for (User::op_iterator i = I->op_begin(), e = I->op_end();
Dan Gohman3b205172012-01-05 23:58:56 +00001455 i != e; ++i) {
1456 Instruction *OpI = dyn_cast<Instruction>(*i);
Chandler Carruthbaf868b2013-01-25 05:40:09 +00001457 if (!OpI || OpI->getParent() != BB ||
1458 OpI->mayHaveSideEffects())
1459 continue; // Not a candidate for sinking.
1460
1461 ++SinkCandidateUseCounts[OpI];
Dan Gohman3b205172012-01-05 23:58:56 +00001462 }
1463 }
Evan Cheng4d09efd2008-06-07 08:52:29 +00001464
Chandler Carruthbaf868b2013-01-25 05:40:09 +00001465 // Consider any sink candidates which are only used in CondBB as costs for
1466 // speculation. Note, while we iterate over a DenseMap here, we are summing
1467 // and so iteration order isn't significant.
1468 for (SmallDenseMap<Instruction *, unsigned, 4>::iterator I =
1469 SinkCandidateUseCounts.begin(), E = SinkCandidateUseCounts.end();
1470 I != E; ++I)
1471 if (I->first->getNumUses() == I->second) {
Chandler Carruth455151e2013-01-27 06:42:03 +00001472 ++SpeculationCost;
1473 if (SpeculationCost > 1)
Chandler Carruthbaf868b2013-01-25 05:40:09 +00001474 return false;
1475 }
1476
Chandler Carruth0afa3312013-01-24 10:40:51 +00001477 // Check that the PHI nodes can be converted to selects.
1478 bool HaveRewritablePHIs = false;
Chandler Carruth6cf7a912013-01-24 09:59:39 +00001479 for (BasicBlock::iterator I = EndBB->begin();
Dan Gohman3b205172012-01-05 23:58:56 +00001480 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
Chandler Carruth6cf7a912013-01-24 09:59:39 +00001481 Value *OrigV = PN->getIncomingValueForBlock(BB);
1482 Value *ThenV = PN->getIncomingValueForBlock(ThenBB);
Dan Gohman3b205172012-01-05 23:58:56 +00001483
Rafael Espindolababae052013-06-04 14:11:59 +00001484 // FIXME: Try to remove some of the duplication with HoistThenElseCodeToIf.
Dan Gohman3b205172012-01-05 23:58:56 +00001485 // Skip PHIs which are trivial.
Chandler Carruth6cf7a912013-01-24 09:59:39 +00001486 if (ThenV == OrigV)
Dan Gohman3b205172012-01-05 23:58:56 +00001487 continue;
1488
Chandler Carruth0afa3312013-01-24 10:40:51 +00001489 HaveRewritablePHIs = true;
Rafael Espindolababae052013-06-04 14:11:59 +00001490 ConstantExpr *OrigCE = dyn_cast<ConstantExpr>(OrigV);
1491 ConstantExpr *ThenCE = dyn_cast<ConstantExpr>(ThenV);
1492 if (!OrigCE && !ThenCE)
Chandler Carruth681add72013-01-24 11:53:01 +00001493 continue; // Known safe and cheap.
1494
Rafael Espindolababae052013-06-04 14:11:59 +00001495 if ((ThenCE && !isSafeToSpeculativelyExecute(ThenCE)) ||
1496 (OrigCE && !isSafeToSpeculativelyExecute(OrigCE)))
Chandler Carruth681add72013-01-24 11:53:01 +00001497 return false;
Rafael Espindolababae052013-06-04 14:11:59 +00001498 unsigned OrigCost = OrigCE ? ComputeSpeculationCost(OrigCE) : 0;
1499 unsigned ThenCost = ThenCE ? ComputeSpeculationCost(ThenCE) : 0;
1500 if (OrigCost + ThenCost > 2 * PHINodeFoldingThreshold)
Chandler Carruth681add72013-01-24 11:53:01 +00001501 return false;
Chandler Carruth0afa3312013-01-24 10:40:51 +00001502
Chandler Carruth47d8f6d2013-01-24 12:05:17 +00001503 // Account for the cost of an unfolded ConstantExpr which could end up
1504 // getting expanded into Instructions.
1505 // FIXME: This doesn't account for how many operations are combined in the
Chandler Carruth455151e2013-01-27 06:42:03 +00001506 // constant expression.
1507 ++SpeculationCost;
1508 if (SpeculationCost > 1)
Chandler Carruth0afa3312013-01-24 10:40:51 +00001509 return false;
Evan Cheng4d09efd2008-06-07 08:52:29 +00001510 }
Dan Gohman3b205172012-01-05 23:58:56 +00001511
1512 // If there are no PHIs to process, bail early. This helps ensure idempotence
1513 // as well.
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001514 if (!HaveRewritablePHIs && !(HoistCondStores && SpeculatedStoreValue))
Dan Gohman3b205172012-01-05 23:58:56 +00001515 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001516
Dan Gohman3b205172012-01-05 23:58:56 +00001517 // If we get here, we can hoist the instruction and if-convert.
Chandler Carruth6cf7a912013-01-24 09:59:39 +00001518 DEBUG(dbgs() << "SPECULATIVELY EXECUTING BB" << *ThenBB << "\n";);
Evan Cheng4d09efd2008-06-07 08:52:29 +00001519
Arnold Schwaighofer8228ffe2013-04-29 21:28:24 +00001520 // Insert a select of the value of the speculated store.
1521 if (SpeculatedStoreValue) {
1522 IRBuilder<true, NoFolder> Builder(BI);
1523 Value *TrueV = SpeculatedStore->getValueOperand();
1524 Value *FalseV = SpeculatedStoreValue;
1525 if (Invert)
1526 std::swap(TrueV, FalseV);
1527 Value *S = Builder.CreateSelect(BrCond, TrueV, FalseV, TrueV->getName() +
1528 "." + FalseV->getName());
1529 SpeculatedStore->setOperand(0, S);
1530 }
1531
Chandler Carruth2c107a82013-01-24 11:52:58 +00001532 // Hoist the instructions.
1533 BB->getInstList().splice(BI, ThenBB->getInstList(), ThenBB->begin(),
1534 llvm::prior(ThenBB->end()));
Evan Cheng502a4f52008-06-12 21:15:59 +00001535
Dan Gohman3b205172012-01-05 23:58:56 +00001536 // Insert selects and rewrite the PHI operands.
Devang Pateld3a17882011-05-19 20:52:46 +00001537 IRBuilder<true, NoFolder> Builder(BI);
Chandler Carruth0afa3312013-01-24 10:40:51 +00001538 for (BasicBlock::iterator I = EndBB->begin();
1539 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
1540 unsigned OrigI = PN->getBasicBlockIndex(BB);
1541 unsigned ThenI = PN->getBasicBlockIndex(ThenBB);
1542 Value *OrigV = PN->getIncomingValue(OrigI);
1543 Value *ThenV = PN->getIncomingValue(ThenI);
1544
1545 // Skip PHIs which are trivial.
1546 if (OrigV == ThenV)
1547 continue;
Evan Cheng4d09efd2008-06-07 08:52:29 +00001548
Dan Gohman3b205172012-01-05 23:58:56 +00001549 // Create a select whose true value is the speculatively executed value and
Chandler Carruth0afa3312013-01-24 10:40:51 +00001550 // false value is the preexisting value. Swap them if the branch
1551 // destinations were inverted.
1552 Value *TrueV = ThenV, *FalseV = OrigV;
Dan Gohman3b205172012-01-05 23:58:56 +00001553 if (Invert)
Chandler Carruth0afa3312013-01-24 10:40:51 +00001554 std::swap(TrueV, FalseV);
1555 Value *V = Builder.CreateSelect(BrCond, TrueV, FalseV,
1556 TrueV->getName() + "." + FalseV->getName());
1557 PN->setIncomingValue(OrigI, V);
1558 PN->setIncomingValue(ThenI, V);
Evan Cheng4d09efd2008-06-07 08:52:29 +00001559 }
1560
Evan Cheng502a4f52008-06-12 21:15:59 +00001561 ++NumSpeculations;
Evan Cheng4d09efd2008-06-07 08:52:29 +00001562 return true;
1563}
1564
Tom Stellardf2089e12013-10-21 20:07:30 +00001565/// \returns True if this block contains a CallInst with the NoDuplicate
1566/// attribute.
1567static bool HasNoDuplicateCall(const BasicBlock *BB) {
1568 for (BasicBlock::const_iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
1569 const CallInst *CI = dyn_cast<CallInst>(I);
1570 if (!CI)
1571 continue;
1572 if (CI->cannotDuplicate())
1573 return true;
1574 }
1575 return false;
1576}
1577
Chris Lattner2e42e362005-09-20 00:43:16 +00001578/// BlockIsSimpleEnoughToThreadThrough - Return true if we can thread a branch
1579/// across this block.
1580static bool BlockIsSimpleEnoughToThreadThrough(BasicBlock *BB) {
1581 BranchInst *BI = cast<BranchInst>(BB->getTerminator());
Chris Lattnere9487f02005-09-20 01:48:40 +00001582 unsigned Size = 0;
Andrew Trick6b014382012-08-29 21:46:36 +00001583
Devang Patel9200c892009-03-10 18:00:05 +00001584 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
Dale Johannesen8483e542009-03-12 23:18:09 +00001585 if (isa<DbgInfoIntrinsic>(BBI))
1586 continue;
Chris Lattnere9487f02005-09-20 01:48:40 +00001587 if (Size > 10) return false; // Don't clone large BB's.
Dale Johannesen8483e542009-03-12 23:18:09 +00001588 ++Size;
Andrew Trick6b014382012-08-29 21:46:36 +00001589
Dale Johannesen8483e542009-03-12 23:18:09 +00001590 // We can only support instructions that do not define values that are
Chris Lattnere9487f02005-09-20 01:48:40 +00001591 // live outside of the current basic block.
1592 for (Value::use_iterator UI = BBI->use_begin(), E = BBI->use_end();
1593 UI != E; ++UI) {
1594 Instruction *U = cast<Instruction>(*UI);
1595 if (U->getParent() != BB || isa<PHINode>(U)) return false;
1596 }
Andrew Trick6b014382012-08-29 21:46:36 +00001597
Chris Lattner2e42e362005-09-20 00:43:16 +00001598 // Looks ok, continue checking.
1599 }
Chris Lattnere9487f02005-09-20 01:48:40 +00001600
Chris Lattner2e42e362005-09-20 00:43:16 +00001601 return true;
1602}
1603
Chris Lattnereaba3a12005-09-19 23:49:37 +00001604/// FoldCondBranchOnPHI - If we have a conditional branch on a PHI node value
1605/// that is defined in the same block as the branch and if any PHI entries are
1606/// constants, thread edges corresponding to that entry to be branches to their
1607/// ultimate destination.
Micah Villmow3574eca2012-10-08 16:38:25 +00001608static bool FoldCondBranchOnPHI(BranchInst *BI, const DataLayout *TD) {
Chris Lattnereaba3a12005-09-19 23:49:37 +00001609 BasicBlock *BB = BI->getParent();
1610 PHINode *PN = dyn_cast<PHINode>(BI->getCondition());
Chris Lattner9c88d982005-09-19 23:57:04 +00001611 // NOTE: we currently cannot transform this case if the PHI node is used
1612 // outside of the block.
Chris Lattner2e42e362005-09-20 00:43:16 +00001613 if (!PN || PN->getParent() != BB || !PN->hasOneUse())
1614 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001615
Chris Lattnereaba3a12005-09-19 23:49:37 +00001616 // Degenerate case of a single entry PHI.
1617 if (PN->getNumIncomingValues() == 1) {
Chris Lattner29874e02008-12-03 19:44:02 +00001618 FoldSingleEntryPHINodes(PN->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00001619 return true;
Chris Lattnereaba3a12005-09-19 23:49:37 +00001620 }
1621
1622 // Now we know that this block has multiple preds and two succs.
Chris Lattner2e42e362005-09-20 00:43:16 +00001623 if (!BlockIsSimpleEnoughToThreadThrough(BB)) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001624
Tom Stellardf2089e12013-10-21 20:07:30 +00001625 if (HasNoDuplicateCall(BB)) return false;
1626
Chris Lattnereaba3a12005-09-19 23:49:37 +00001627 // Okay, this is a simple enough basic block. See if any phi values are
1628 // constants.
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00001629 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001630 ConstantInt *CB = dyn_cast<ConstantInt>(PN->getIncomingValue(i));
1631 if (CB == 0 || !CB->getType()->isIntegerTy(1)) continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001632
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001633 // Okay, we now know that all edges from PredBB should be revectored to
1634 // branch to RealDest.
1635 BasicBlock *PredBB = PN->getIncomingBlock(i);
1636 BasicBlock *RealDest = BI->getSuccessor(!CB->getZExtValue());
Andrew Trick6b014382012-08-29 21:46:36 +00001637
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001638 if (RealDest == BB) continue; // Skip self loops.
Bill Wendling6a648b82011-06-04 09:42:04 +00001639 // Skip if the predecessor's terminator is an indirect branch.
1640 if (isa<IndirectBrInst>(PredBB->getTerminator())) continue;
Andrew Trick6b014382012-08-29 21:46:36 +00001641
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001642 // The dest block might have PHI nodes, other predecessors and other
1643 // difficult cases. Instead of being smart about this, just insert a new
1644 // block that jumps to the destination block, effectively splitting
1645 // the edge we are about to create.
1646 BasicBlock *EdgeBB = BasicBlock::Create(BB->getContext(),
1647 RealDest->getName()+".critedge",
1648 RealDest->getParent(), RealDest);
1649 BranchInst::Create(RealDest, EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00001650
Chris Lattner6de0a282010-12-14 07:09:42 +00001651 // Update PHI nodes.
1652 AddPredecessorToBlock(RealDest, EdgeBB, BB);
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001653
1654 // BB may have instructions that are being threaded over. Clone these
1655 // instructions into EdgeBB. We know that there will be no uses of the
1656 // cloned instructions outside of EdgeBB.
1657 BasicBlock::iterator InsertPt = EdgeBB->begin();
1658 DenseMap<Value*, Value*> TranslateMap; // Track translated values.
1659 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
1660 if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
1661 TranslateMap[PN] = PN->getIncomingValueForBlock(PredBB);
1662 continue;
1663 }
1664 // Clone the instruction.
1665 Instruction *N = BBI->clone();
1666 if (BBI->hasName()) N->setName(BBI->getName()+".c");
Andrew Trick6b014382012-08-29 21:46:36 +00001667
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001668 // Update operands due to translation.
1669 for (User::op_iterator i = N->op_begin(), e = N->op_end();
1670 i != e; ++i) {
1671 DenseMap<Value*, Value*>::iterator PI = TranslateMap.find(*i);
1672 if (PI != TranslateMap.end())
1673 *i = PI->second;
1674 }
Andrew Trick6b014382012-08-29 21:46:36 +00001675
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001676 // Check for trivial simplification.
Chris Lattner302ba6f2010-12-14 06:17:25 +00001677 if (Value *V = SimplifyInstruction(N, TD)) {
1678 TranslateMap[BBI] = V;
1679 delete N; // Instruction folded away, don't need actual inst
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001680 } else {
1681 // Insert the new instruction into its new home.
1682 EdgeBB->getInstList().insert(InsertPt, N);
1683 if (!BBI->use_empty())
1684 TranslateMap[BBI] = N;
1685 }
1686 }
1687
1688 // Loop over all of the edges from PredBB to BB, changing them to branch
1689 // to EdgeBB instead.
1690 TerminatorInst *PredBBTI = PredBB->getTerminator();
1691 for (unsigned i = 0, e = PredBBTI->getNumSuccessors(); i != e; ++i)
1692 if (PredBBTI->getSuccessor(i) == BB) {
1693 BB->removePredecessor(PredBB);
1694 PredBBTI->setSuccessor(i, EdgeBB);
1695 }
Bill Wendling6a648b82011-06-04 09:42:04 +00001696
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001697 // Recurse, simplifying any other constants.
Chris Lattner302ba6f2010-12-14 06:17:25 +00001698 return FoldCondBranchOnPHI(BI, TD) | true;
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00001699 }
Chris Lattnereaba3a12005-09-19 23:49:37 +00001700
1701 return false;
1702}
1703
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001704/// FoldTwoEntryPHINode - Given a BB that starts with the specified two-entry
1705/// PHI node, see if we can eliminate it.
Micah Villmow3574eca2012-10-08 16:38:25 +00001706static bool FoldTwoEntryPHINode(PHINode *PN, const DataLayout *TD) {
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001707 // Ok, this is a two entry PHI node. Check to see if this is a simple "if
1708 // statement", which has a very simple dominance structure. Basically, we
1709 // are trying to find the condition that is being branched on, which
1710 // subsequently causes this merge to happen. We really want control
1711 // dependence information for this check, but simplifycfg can't keep it up
1712 // to date, and this catches most of the cases we care about anyway.
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001713 BasicBlock *BB = PN->getParent();
1714 BasicBlock *IfTrue, *IfFalse;
1715 Value *IfCond = GetIfCondition(BB, IfTrue, IfFalse);
Chris Lattner60d410d2010-12-14 08:01:53 +00001716 if (!IfCond ||
1717 // Don't bother if the branch will be constant folded trivially.
1718 isa<ConstantInt>(IfCond))
1719 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001720
Chris Lattner822a8792006-11-18 19:19:36 +00001721 // Okay, we found that we can merge this two-entry phi node into a select.
1722 // Doing so would require us to fold *all* two entry phi nodes in this block.
1723 // At some point this becomes non-profitable (particularly if the target
1724 // doesn't support cmov's). Only do this transformation if there are two or
1725 // fewer PHI nodes in this block.
1726 unsigned NumPhis = 0;
1727 for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I); ++NumPhis, ++I)
1728 if (NumPhis > 2)
1729 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001730
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001731 // Loop over the PHI's seeing if we can promote them all to select
1732 // instructions. While we are at it, keep track of the instructions
1733 // that need to be moved to the dominating block.
Chris Lattner44da7ca2010-12-14 07:41:39 +00001734 SmallPtrSet<Instruction*, 4> AggressiveInsts;
Peter Collingbourne57808b32011-04-29 18:47:38 +00001735 unsigned MaxCostVal0 = PHINodeFoldingThreshold,
1736 MaxCostVal1 = PHINodeFoldingThreshold;
Andrew Trick6b014382012-08-29 21:46:36 +00001737
Chris Lattner3aff13b2010-12-14 08:46:09 +00001738 for (BasicBlock::iterator II = BB->begin(); isa<PHINode>(II);) {
1739 PHINode *PN = cast<PHINode>(II++);
Chris Lattner07ff3532010-12-14 07:20:29 +00001740 if (Value *V = SimplifyInstruction(PN, TD)) {
1741 PN->replaceAllUsesWith(V);
Chris Lattner3aff13b2010-12-14 08:46:09 +00001742 PN->eraseFromParent();
Chris Lattner07ff3532010-12-14 07:20:29 +00001743 continue;
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001744 }
Andrew Trick6b014382012-08-29 21:46:36 +00001745
Peter Collingbournef15907f2011-04-29 18:47:31 +00001746 if (!DominatesMergePoint(PN->getIncomingValue(0), BB, &AggressiveInsts,
1747 MaxCostVal0) ||
1748 !DominatesMergePoint(PN->getIncomingValue(1), BB, &AggressiveInsts,
1749 MaxCostVal1))
Chris Lattner07ff3532010-12-14 07:20:29 +00001750 return false;
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001751 }
Andrew Trick6b014382012-08-29 21:46:36 +00001752
Sylvestre Ledruc8e41c52012-07-23 08:51:15 +00001753 // If we folded the first phi, PN dangles at this point. Refresh it. If
Chris Lattner44da7ca2010-12-14 07:41:39 +00001754 // we ran out of PHIs then we simplified them all.
1755 PN = dyn_cast<PHINode>(BB->begin());
1756 if (PN == 0) return true;
Andrew Trick6b014382012-08-29 21:46:36 +00001757
Chris Lattner3aff13b2010-12-14 08:46:09 +00001758 // Don't fold i1 branches on PHIs which contain binary operators. These can
1759 // often be turned into switches and other things.
1760 if (PN->getType()->isIntegerTy(1) &&
1761 (isa<BinaryOperator>(PN->getIncomingValue(0)) ||
1762 isa<BinaryOperator>(PN->getIncomingValue(1)) ||
1763 isa<BinaryOperator>(IfCond)))
1764 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001765
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001766 // If we all PHI nodes are promotable, check to make sure that all
1767 // instructions in the predecessor blocks can be promoted as well. If
1768 // not, we won't be able to get rid of the control flow, so it's not
1769 // worth promoting to select instructions.
Chris Lattner44da7ca2010-12-14 07:41:39 +00001770 BasicBlock *DomBlock = 0;
1771 BasicBlock *IfBlock1 = PN->getIncomingBlock(0);
1772 BasicBlock *IfBlock2 = PN->getIncomingBlock(1);
1773 if (cast<BranchInst>(IfBlock1->getTerminator())->isConditional()) {
1774 IfBlock1 = 0;
1775 } else {
1776 DomBlock = *pred_begin(IfBlock1);
1777 for (BasicBlock::iterator I = IfBlock1->begin();!isa<TerminatorInst>(I);++I)
Devang Patel383d7ed2009-02-03 22:12:02 +00001778 if (!AggressiveInsts.count(I) && !isa<DbgInfoIntrinsic>(I)) {
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001779 // This is not an aggressive instruction that we can promote.
1780 // Because of this, we won't be able to get rid of the control
1781 // flow, so the xform is not worth it.
1782 return false;
1783 }
1784 }
Andrew Trick6b014382012-08-29 21:46:36 +00001785
Chris Lattner44da7ca2010-12-14 07:41:39 +00001786 if (cast<BranchInst>(IfBlock2->getTerminator())->isConditional()) {
1787 IfBlock2 = 0;
1788 } else {
1789 DomBlock = *pred_begin(IfBlock2);
1790 for (BasicBlock::iterator I = IfBlock2->begin();!isa<TerminatorInst>(I);++I)
Devang Patel383d7ed2009-02-03 22:12:02 +00001791 if (!AggressiveInsts.count(I) && !isa<DbgInfoIntrinsic>(I)) {
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001792 // This is not an aggressive instruction that we can promote.
1793 // Because of this, we won't be able to get rid of the control
1794 // flow, so the xform is not worth it.
1795 return false;
1796 }
1797 }
Andrew Trick6b014382012-08-29 21:46:36 +00001798
Chris Lattnere0b18e52010-12-14 07:23:10 +00001799 DEBUG(dbgs() << "FOUND IF CONDITION! " << *IfCond << " T: "
Chris Lattner44da7ca2010-12-14 07:41:39 +00001800 << IfTrue->getName() << " F: " << IfFalse->getName() << "\n");
Andrew Trick6b014382012-08-29 21:46:36 +00001801
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001802 // If we can still promote the PHI nodes after this gauntlet of tests,
1803 // do all of the PHI's now.
Chris Lattner3aff13b2010-12-14 08:46:09 +00001804 Instruction *InsertPt = DomBlock->getTerminator();
Devang Pateld3a17882011-05-19 20:52:46 +00001805 IRBuilder<true, NoFolder> Builder(InsertPt);
Andrew Trick6b014382012-08-29 21:46:36 +00001806
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001807 // Move all 'aggressive' instructions, which are defined in the
1808 // conditional parts of the if's up to the dominating block.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001809 if (IfBlock1)
Chris Lattner3aff13b2010-12-14 08:46:09 +00001810 DomBlock->getInstList().splice(InsertPt,
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001811 IfBlock1->getInstList(), IfBlock1->begin(),
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001812 IfBlock1->getTerminator());
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001813 if (IfBlock2)
Chris Lattner3aff13b2010-12-14 08:46:09 +00001814 DomBlock->getInstList().splice(InsertPt,
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001815 IfBlock2->getInstList(), IfBlock2->begin(),
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001816 IfBlock2->getTerminator());
Andrew Trick6b014382012-08-29 21:46:36 +00001817
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001818 while (PHINode *PN = dyn_cast<PHINode>(BB->begin())) {
1819 // Change the PHI node into a select instruction.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001820 Value *TrueVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfFalse);
1821 Value *FalseVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfTrue);
Andrew Trick6b014382012-08-29 21:46:36 +00001822
1823 SelectInst *NV =
Devang Patelf60364d2011-05-18 18:16:44 +00001824 cast<SelectInst>(Builder.CreateSelect(IfCond, TrueVal, FalseVal, ""));
Chris Lattner86cc4232007-02-11 01:37:51 +00001825 PN->replaceAllUsesWith(NV);
1826 NV->takeName(PN);
Chris Lattner302ba6f2010-12-14 06:17:25 +00001827 PN->eraseFromParent();
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001828 }
Andrew Trick6b014382012-08-29 21:46:36 +00001829
Chris Lattner60d410d2010-12-14 08:01:53 +00001830 // At this point, IfBlock1 and IfBlock2 are both empty, so our if statement
1831 // has been flattened. Change DomBlock to jump directly to our new block to
1832 // avoid other simplifycfg's kicking in on the diamond.
1833 TerminatorInst *OldTI = DomBlock->getTerminator();
Devang Patelf60364d2011-05-18 18:16:44 +00001834 Builder.SetInsertPoint(OldTI);
1835 Builder.CreateBr(BB);
Chris Lattner60d410d2010-12-14 08:01:53 +00001836 OldTI->eraseFromParent();
Chris Lattnerf58c1a52005-09-23 06:39:30 +00001837 return true;
1838}
Chris Lattnereaba3a12005-09-19 23:49:37 +00001839
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001840/// SimplifyCondBranchToTwoReturns - If we found a conditional branch that goes
1841/// to two returning blocks, try to merge them together into one return,
1842/// introducing a select if the return values disagree.
Andrew Trick6b014382012-08-29 21:46:36 +00001843static bool SimplifyCondBranchToTwoReturns(BranchInst *BI,
Devang Patel176ec402011-05-18 21:33:11 +00001844 IRBuilder<> &Builder) {
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001845 assert(BI->isConditional() && "Must be a conditional branch");
1846 BasicBlock *TrueSucc = BI->getSuccessor(0);
1847 BasicBlock *FalseSucc = BI->getSuccessor(1);
1848 ReturnInst *TrueRet = cast<ReturnInst>(TrueSucc->getTerminator());
1849 ReturnInst *FalseRet = cast<ReturnInst>(FalseSucc->getTerminator());
Andrew Trick6b014382012-08-29 21:46:36 +00001850
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001851 // Check to ensure both blocks are empty (just a return) or optionally empty
1852 // with PHI nodes. If there are other instructions, merging would cause extra
1853 // computation on one path or the other.
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001854 if (!TrueSucc->getFirstNonPHIOrDbg()->isTerminator())
Devang Patel2cc86a12009-02-05 00:30:42 +00001855 return false;
Chris Lattner9a2b72a2010-12-13 01:47:07 +00001856 if (!FalseSucc->getFirstNonPHIOrDbg()->isTerminator())
Devang Patel2cc86a12009-02-05 00:30:42 +00001857 return false;
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001858
Devang Patel176ec402011-05-18 21:33:11 +00001859 Builder.SetInsertPoint(BI);
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001860 // Okay, we found a branch that is going to two return nodes. If
1861 // there is no return value for this function, just change the
1862 // branch into a return.
1863 if (FalseRet->getNumOperands() == 0) {
1864 TrueSucc->removePredecessor(BI->getParent());
1865 FalseSucc->removePredecessor(BI->getParent());
Devang Patel176ec402011-05-18 21:33:11 +00001866 Builder.CreateRetVoid();
Eli Friedman080efb82008-12-16 20:54:32 +00001867 EraseTerminatorInstAndDCECond(BI);
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001868 return true;
1869 }
Andrew Trick6b014382012-08-29 21:46:36 +00001870
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001871 // Otherwise, figure out what the true and false return values are
1872 // so we can insert a new select instruction.
1873 Value *TrueValue = TrueRet->getReturnValue();
1874 Value *FalseValue = FalseRet->getReturnValue();
Andrew Trick6b014382012-08-29 21:46:36 +00001875
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001876 // Unwrap any PHI nodes in the return blocks.
1877 if (PHINode *TVPN = dyn_cast_or_null<PHINode>(TrueValue))
1878 if (TVPN->getParent() == TrueSucc)
1879 TrueValue = TVPN->getIncomingValueForBlock(BI->getParent());
1880 if (PHINode *FVPN = dyn_cast_or_null<PHINode>(FalseValue))
1881 if (FVPN->getParent() == FalseSucc)
1882 FalseValue = FVPN->getIncomingValueForBlock(BI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00001883
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001884 // In order for this transformation to be safe, we must be able to
1885 // unconditionally execute both operands to the return. This is
1886 // normally the case, but we could have a potentially-trapping
1887 // constant expression that prevents this transformation from being
1888 // safe.
1889 if (ConstantExpr *TCV = dyn_cast_or_null<ConstantExpr>(TrueValue))
1890 if (TCV->canTrap())
1891 return false;
1892 if (ConstantExpr *FCV = dyn_cast_or_null<ConstantExpr>(FalseValue))
1893 if (FCV->canTrap())
1894 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00001895
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001896 // Okay, we collected all the mapped values and checked them for sanity, and
1897 // defined to really do this transformation. First, update the CFG.
1898 TrueSucc->removePredecessor(BI->getParent());
1899 FalseSucc->removePredecessor(BI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00001900
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001901 // Insert select instructions where needed.
1902 Value *BrCond = BI->getCondition();
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001903 if (TrueValue) {
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001904 // Insert a select if the results differ.
Dan Gohmanfc74abf2008-07-23 00:34:11 +00001905 if (TrueValue == FalseValue || isa<UndefValue>(FalseValue)) {
1906 } else if (isa<UndefValue>(TrueValue)) {
1907 TrueValue = FalseValue;
1908 } else {
Devang Patel176ec402011-05-18 21:33:11 +00001909 TrueValue = Builder.CreateSelect(BrCond, TrueValue,
1910 FalseValue, "retval");
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001911 }
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001912 }
1913
Andrew Trick6b014382012-08-29 21:46:36 +00001914 Value *RI = !TrueValue ?
Devang Patel176ec402011-05-18 21:33:11 +00001915 Builder.CreateRetVoid() : Builder.CreateRet(TrueValue);
1916
Daniel Dunbare317bcc2009-08-23 10:29:55 +00001917 (void) RI;
Andrew Trick6b014382012-08-29 21:46:36 +00001918
David Greene89d6fd32010-01-05 01:26:52 +00001919 DEBUG(dbgs() << "\nCHANGING BRANCH TO TWO RETURNS INTO SELECT:"
Chris Lattnerbdff5482009-08-23 04:37:46 +00001920 << "\n " << *BI << "NewRet = " << *RI
1921 << "TRUEBLOCK: " << *TrueSucc << "FALSEBLOCK: "<< *FalseSucc);
Andrew Trick6b014382012-08-29 21:46:36 +00001922
Eli Friedman080efb82008-12-16 20:54:32 +00001923 EraseTerminatorInstAndDCECond(BI);
1924
Chris Lattnerc9e495c2008-04-24 00:01:19 +00001925 return true;
1926}
1927
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001928/// ExtractBranchMetadata - Given a conditional BranchInstruction, retrieve the
1929/// probabilities of the branch taking each edge. Fills in the two APInt
1930/// parameters and return true, or returns false if no or invalid metadata was
1931/// found.
1932static bool ExtractBranchMetadata(BranchInst *BI,
Manman Ren062986c2012-09-15 00:39:57 +00001933 uint64_t &ProbTrue, uint64_t &ProbFalse) {
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001934 assert(BI->isConditional() &&
1935 "Looking for probabilities on unconditional branch?");
1936 MDNode *ProfileData = BI->getMetadata(LLVMContext::MD_prof);
Nick Lewycky91968482011-12-27 18:27:22 +00001937 if (!ProfileData || ProfileData->getNumOperands() != 3) return false;
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001938 ConstantInt *CITrue = dyn_cast<ConstantInt>(ProfileData->getOperand(1));
1939 ConstantInt *CIFalse = dyn_cast<ConstantInt>(ProfileData->getOperand(2));
Nick Lewycky91968482011-12-27 18:27:22 +00001940 if (!CITrue || !CIFalse) return false;
Manman Ren062986c2012-09-15 00:39:57 +00001941 ProbTrue = CITrue->getValue().getZExtValue();
1942 ProbFalse = CIFalse->getValue().getZExtValue();
Nick Lewycky06cc66f2011-12-27 04:31:52 +00001943 return true;
1944}
1945
Manman Renee28e0f2012-06-13 05:43:29 +00001946/// checkCSEInPredecessor - Return true if the given instruction is available
1947/// in its predecessor block. If yes, the instruction will be removed.
1948///
Benjamin Kramer23d36222012-07-13 13:25:15 +00001949static bool checkCSEInPredecessor(Instruction *Inst, BasicBlock *PB) {
Manman Renee28e0f2012-06-13 05:43:29 +00001950 if (!isa<BinaryOperator>(Inst) && !isa<CmpInst>(Inst))
1951 return false;
1952 for (BasicBlock::iterator I = PB->begin(), E = PB->end(); I != E; I++) {
1953 Instruction *PBI = &*I;
1954 // Check whether Inst and PBI generate the same value.
1955 if (Inst->isIdenticalTo(PBI)) {
1956 Inst->replaceAllUsesWith(PBI);
1957 Inst->eraseFromParent();
1958 return true;
1959 }
1960 }
1961 return false;
1962}
Nick Lewycky6c00c6a2012-01-25 09:43:14 +00001963
Chris Lattnerc8fbc342011-04-11 23:24:57 +00001964/// FoldBranchToCommonDest - If this basic block is simple enough, and if a
1965/// predecessor branches to us and one of our successors, fold the block into
1966/// the predecessor and use logical operations to pick the right destination.
Dan Gohman4b35f832009-06-27 21:30:38 +00001967bool llvm::FoldBranchToCommonDest(BranchInst *BI) {
Chris Lattner093a4382008-07-13 22:23:11 +00001968 BasicBlock *BB = BI->getParent();
Devang Pateld3a17882011-05-19 20:52:46 +00001969
Manman Renee28e0f2012-06-13 05:43:29 +00001970 Instruction *Cond = 0;
1971 if (BI->isConditional())
1972 Cond = dyn_cast<Instruction>(BI->getCondition());
1973 else {
1974 // For unconditional branch, check for a simple CFG pattern, where
1975 // BB has a single predecessor and BB's successor is also its predecessor's
1976 // successor. If such pattern exisits, check for CSE between BB and its
1977 // predecessor.
1978 if (BasicBlock *PB = BB->getSinglePredecessor())
1979 if (BranchInst *PBI = dyn_cast<BranchInst>(PB->getTerminator()))
1980 if (PBI->isConditional() &&
1981 (BI->getSuccessor(0) == PBI->getSuccessor(0) ||
1982 BI->getSuccessor(0) == PBI->getSuccessor(1))) {
1983 for (BasicBlock::iterator I = BB->begin(), E = BB->end();
1984 I != E; ) {
1985 Instruction *Curr = I++;
1986 if (isa<CmpInst>(Curr)) {
1987 Cond = Curr;
1988 break;
1989 }
1990 // Quit if we can't remove this instruction.
1991 if (!checkCSEInPredecessor(Curr, PB))
1992 return false;
1993 }
1994 }
1995
1996 if (Cond == 0)
1997 return false;
1998 }
Andrew Trick6b014382012-08-29 21:46:36 +00001999
Owen Andersone84178a2010-07-14 19:52:16 +00002000 if (Cond == 0 || (!isa<CmpInst>(Cond) && !isa<BinaryOperator>(Cond)) ||
2001 Cond->getParent() != BB || !Cond->hasOneUse())
2002 return false;
Devang Pateld4181942011-04-06 22:37:20 +00002003
Chris Lattner1347e872008-07-13 21:12:01 +00002004 // Only allow this if the condition is a simple instruction that can be
2005 // executed unconditionally. It must be in the same block as the branch, and
2006 // must be at the front of the block.
Devang Pateld0a203d2009-02-04 21:39:48 +00002007 BasicBlock::iterator FrontIt = BB->front();
Chris Lattner3c6e7462011-04-14 02:44:53 +00002008
Devang Pateld0a203d2009-02-04 21:39:48 +00002009 // Ignore dbg intrinsics.
Chris Lattner3c6e7462011-04-14 02:44:53 +00002010 while (isa<DbgInfoIntrinsic>(FrontIt)) ++FrontIt;
Nick Lewycky9d523102011-12-26 20:37:40 +00002011
Owen Andersone84178a2010-07-14 19:52:16 +00002012 // Allow a single instruction to be hoisted in addition to the compare
2013 // that feeds the branch. We later ensure that any values that _it_ uses
2014 // were also live in the predecessor, so that we don't unnecessarily create
2015 // register pressure or inhibit out-of-order execution.
2016 Instruction *BonusInst = 0;
2017 if (&*FrontIt != Cond &&
Owen Anderson2722dfa2010-07-15 16:38:22 +00002018 FrontIt->hasOneUse() && *FrontIt->use_begin() == Cond &&
Dan Gohmanf0426602011-12-14 23:49:11 +00002019 isSafeToSpeculativelyExecute(FrontIt)) {
Owen Andersone84178a2010-07-14 19:52:16 +00002020 BonusInst = &*FrontIt;
2021 ++FrontIt;
Andrew Trick6b014382012-08-29 21:46:36 +00002022
Chris Lattner3c6e7462011-04-14 02:44:53 +00002023 // Ignore dbg intrinsics.
2024 while (isa<DbgInfoIntrinsic>(FrontIt)) ++FrontIt;
Devang Patel60d490c2011-04-07 23:11:25 +00002025 }
2026
Owen Andersone84178a2010-07-14 19:52:16 +00002027 // Only a single bonus inst is allowed.
2028 if (&*FrontIt != Cond)
2029 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002030
Chris Lattner1347e872008-07-13 21:12:01 +00002031 // Make sure the instruction after the condition is the cond branch.
2032 BasicBlock::iterator CondIt = Cond; ++CondIt;
Chris Lattner3c6e7462011-04-14 02:44:53 +00002033
Devang Pateld0a203d2009-02-04 21:39:48 +00002034 // Ingore dbg intrinsics.
Chris Lattner3c6e7462011-04-14 02:44:53 +00002035 while (isa<DbgInfoIntrinsic>(CondIt)) ++CondIt;
Andrew Trick6b014382012-08-29 21:46:36 +00002036
Chris Lattner3c6e7462011-04-14 02:44:53 +00002037 if (&*CondIt != BI)
Chris Lattner1347e872008-07-13 21:12:01 +00002038 return false;
Chris Lattner6ff645b2009-01-19 23:03:13 +00002039
2040 // Cond is known to be a compare or binary operator. Check to make sure that
2041 // neither operand is a potentially-trapping constant expression.
2042 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(0)))
2043 if (CE->canTrap())
2044 return false;
2045 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(1)))
2046 if (CE->canTrap())
2047 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002048
Chris Lattner1347e872008-07-13 21:12:01 +00002049 // Finally, don't infinitely unroll conditional loops.
2050 BasicBlock *TrueDest = BI->getSuccessor(0);
Manman Renee28e0f2012-06-13 05:43:29 +00002051 BasicBlock *FalseDest = (BI->isConditional()) ? BI->getSuccessor(1) : 0;
Chris Lattner1347e872008-07-13 21:12:01 +00002052 if (TrueDest == BB || FalseDest == BB)
2053 return false;
Devang Pateld4181942011-04-06 22:37:20 +00002054
Chris Lattner1347e872008-07-13 21:12:01 +00002055 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
2056 BasicBlock *PredBlock = *PI;
2057 BranchInst *PBI = dyn_cast<BranchInst>(PredBlock->getTerminator());
Andrew Trick6b014382012-08-29 21:46:36 +00002058
Chris Lattner093a4382008-07-13 22:23:11 +00002059 // Check that we have two conditional branches. If there is a PHI node in
2060 // the common successor, verify that the same value flows in from both
2061 // blocks.
Manman Renee28e0f2012-06-13 05:43:29 +00002062 SmallVector<PHINode*, 4> PHIs;
2063 if (PBI == 0 || PBI->isUnconditional() ||
Andrew Trick6b014382012-08-29 21:46:36 +00002064 (BI->isConditional() &&
Manman Renee28e0f2012-06-13 05:43:29 +00002065 !SafeToMergeTerminators(BI, PBI)) ||
2066 (!BI->isConditional() &&
2067 !isProfitableToFoldUnconditional(BI, PBI, Cond, PHIs)))
Chris Lattner1347e872008-07-13 21:12:01 +00002068 continue;
Andrew Trick6b014382012-08-29 21:46:36 +00002069
Chris Lattner3c6e7462011-04-14 02:44:53 +00002070 // Determine if the two branches share a common destination.
Axel Naumann3780ad82012-09-17 14:20:57 +00002071 Instruction::BinaryOps Opc = Instruction::BinaryOpsEnd;
Chris Lattner3c6e7462011-04-14 02:44:53 +00002072 bool InvertPredCond = false;
Andrew Trick6b014382012-08-29 21:46:36 +00002073
Manman Renee28e0f2012-06-13 05:43:29 +00002074 if (BI->isConditional()) {
2075 if (PBI->getSuccessor(0) == TrueDest)
2076 Opc = Instruction::Or;
2077 else if (PBI->getSuccessor(1) == FalseDest)
2078 Opc = Instruction::And;
2079 else if (PBI->getSuccessor(0) == FalseDest)
2080 Opc = Instruction::And, InvertPredCond = true;
2081 else if (PBI->getSuccessor(1) == TrueDest)
2082 Opc = Instruction::Or, InvertPredCond = true;
2083 else
2084 continue;
2085 } else {
2086 if (PBI->getSuccessor(0) != TrueDest && PBI->getSuccessor(1) != TrueDest)
2087 continue;
2088 }
Chris Lattner3c6e7462011-04-14 02:44:53 +00002089
Owen Andersone84178a2010-07-14 19:52:16 +00002090 // Ensure that any values used in the bonus instruction are also used
2091 // by the terminator of the predecessor. This means that those values
Andrew Trick6b014382012-08-29 21:46:36 +00002092 // must already have been resolved, so we won't be inhibiting the
Nadav Rotemf3bd3ea2013-11-12 22:37:16 +00002093 // out-of-order core by speculating them earlier. We also allow
2094 // instructions that are used by the terminator's condition because it
2095 // exposes more merging opportunities.
2096 bool UsedByBranch = (BonusInst && BonusInst->hasOneUse() &&
2097 *BonusInst->use_begin() == Cond);
2098
2099 if (BonusInst && !UsedByBranch) {
Owen Andersone84178a2010-07-14 19:52:16 +00002100 // Collect the values used by the bonus inst
2101 SmallPtrSet<Value*, 4> UsedValues;
2102 for (Instruction::op_iterator OI = BonusInst->op_begin(),
2103 OE = BonusInst->op_end(); OI != OE; ++OI) {
Nick Lewycky9d523102011-12-26 20:37:40 +00002104 Value *V = *OI;
Nadav Rotem30150a12013-11-10 04:13:31 +00002105 if (!isa<Constant>(V) && !isa<Argument>(V))
Owen Andersone84178a2010-07-14 19:52:16 +00002106 UsedValues.insert(V);
2107 }
2108
2109 SmallVector<std::pair<Value*, unsigned>, 4> Worklist;
2110 Worklist.push_back(std::make_pair(PBI->getOperand(0), 0));
Andrew Trick6b014382012-08-29 21:46:36 +00002111
Owen Andersone84178a2010-07-14 19:52:16 +00002112 // Walk up to four levels back up the use-def chain of the predecessor's
2113 // terminator to see if all those values were used. The choice of four
2114 // levels is arbitrary, to provide a compile-time-cost bound.
2115 while (!Worklist.empty()) {
2116 std::pair<Value*, unsigned> Pair = Worklist.back();
2117 Worklist.pop_back();
Andrew Trick6b014382012-08-29 21:46:36 +00002118
Owen Andersone84178a2010-07-14 19:52:16 +00002119 if (Pair.second >= 4) continue;
2120 UsedValues.erase(Pair.first);
2121 if (UsedValues.empty()) break;
Andrew Trick6b014382012-08-29 21:46:36 +00002122
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00002123 if (Instruction *I = dyn_cast<Instruction>(Pair.first)) {
Owen Andersone84178a2010-07-14 19:52:16 +00002124 for (Instruction::op_iterator OI = I->op_begin(), OE = I->op_end();
2125 OI != OE; ++OI)
2126 Worklist.push_back(std::make_pair(OI->get(), Pair.second+1));
Andrew Trick6b014382012-08-29 21:46:36 +00002127 }
Owen Andersone84178a2010-07-14 19:52:16 +00002128 }
Andrew Trick6b014382012-08-29 21:46:36 +00002129
Owen Andersone84178a2010-07-14 19:52:16 +00002130 if (!UsedValues.empty()) return false;
2131 }
Chris Lattner36989092008-07-13 21:20:19 +00002132
David Greene89d6fd32010-01-05 01:26:52 +00002133 DEBUG(dbgs() << "FOLDING BRANCH TO COMMON DEST:\n" << *PBI << *BB);
Andrew Trick6b014382012-08-29 21:46:36 +00002134 IRBuilder<> Builder(PBI);
Devang Pateld3a17882011-05-19 20:52:46 +00002135
Chris Lattner36989092008-07-13 21:20:19 +00002136 // If we need to invert the condition in the pred block to match, do so now.
2137 if (InvertPredCond) {
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00002138 Value *NewCond = PBI->getCondition();
Andrew Trick6b014382012-08-29 21:46:36 +00002139
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00002140 if (NewCond->hasOneUse() && isa<CmpInst>(NewCond)) {
2141 CmpInst *CI = cast<CmpInst>(NewCond);
2142 CI->setPredicate(CI->getInversePredicate());
2143 } else {
Andrew Trick6b014382012-08-29 21:46:36 +00002144 NewCond = Builder.CreateNot(NewCond,
Devang Pateld3a17882011-05-19 20:52:46 +00002145 PBI->getCondition()->getName()+".not");
Chris Lattnerdaa02ab2010-12-13 07:00:06 +00002146 }
Andrew Trick6b014382012-08-29 21:46:36 +00002147
Chris Lattner1347e872008-07-13 21:12:01 +00002148 PBI->setCondition(NewCond);
Nick Lewyckyc9a1aed2011-12-26 20:54:14 +00002149 PBI->swapSuccessors();
Chris Lattner1347e872008-07-13 21:12:01 +00002150 }
Andrew Trick6b014382012-08-29 21:46:36 +00002151
Owen Andersone84178a2010-07-14 19:52:16 +00002152 // If we have a bonus inst, clone it into the predecessor block.
2153 Instruction *NewBonus = 0;
2154 if (BonusInst) {
2155 NewBonus = BonusInst->clone();
2156 PredBlock->getInstList().insert(PBI, NewBonus);
2157 NewBonus->takeName(BonusInst);
2158 BonusInst->setName(BonusInst->getName()+".old");
2159 }
Andrew Trick6b014382012-08-29 21:46:36 +00002160
Chris Lattner36989092008-07-13 21:20:19 +00002161 // Clone Cond into the predecessor basic block, and or/and the
2162 // two conditions together.
Nick Lewycky67760642009-09-27 07:38:41 +00002163 Instruction *New = Cond->clone();
Owen Andersone84178a2010-07-14 19:52:16 +00002164 if (BonusInst) New->replaceUsesOfWith(BonusInst, NewBonus);
Chris Lattner36989092008-07-13 21:20:19 +00002165 PredBlock->getInstList().insert(PBI, New);
2166 New->takeName(Cond);
2167 Cond->setName(New->getName()+".old");
Andrew Trick6b014382012-08-29 21:46:36 +00002168
Manman Renee28e0f2012-06-13 05:43:29 +00002169 if (BI->isConditional()) {
Andrew Trick6b014382012-08-29 21:46:36 +00002170 Instruction *NewCond =
Manman Renee28e0f2012-06-13 05:43:29 +00002171 cast<Instruction>(Builder.CreateBinOp(Opc, PBI->getCondition(),
Devang Pateld3a17882011-05-19 20:52:46 +00002172 New, "or.cond"));
Manman Renee28e0f2012-06-13 05:43:29 +00002173 PBI->setCondition(NewCond);
2174
Manman Ren062986c2012-09-15 00:39:57 +00002175 uint64_t PredTrueWeight, PredFalseWeight, SuccTrueWeight, SuccFalseWeight;
2176 bool PredHasWeights = ExtractBranchMetadata(PBI, PredTrueWeight,
2177 PredFalseWeight);
2178 bool SuccHasWeights = ExtractBranchMetadata(BI, SuccTrueWeight,
2179 SuccFalseWeight);
2180 SmallVector<uint64_t, 8> NewWeights;
2181
Manman Renee28e0f2012-06-13 05:43:29 +00002182 if (PBI->getSuccessor(0) == BB) {
Manman Ren062986c2012-09-15 00:39:57 +00002183 if (PredHasWeights && SuccHasWeights) {
2184 // PBI: br i1 %x, BB, FalseDest
2185 // BI: br i1 %y, TrueDest, FalseDest
2186 //TrueWeight is TrueWeight for PBI * TrueWeight for BI.
2187 NewWeights.push_back(PredTrueWeight * SuccTrueWeight);
2188 //FalseWeight is FalseWeight for PBI * TotalWeight for BI +
2189 // TrueWeight for PBI * FalseWeight for BI.
2190 // We assume that total weights of a BranchInst can fit into 32 bits.
2191 // Therefore, we will not have overflow using 64-bit arithmetic.
2192 NewWeights.push_back(PredFalseWeight * (SuccFalseWeight +
2193 SuccTrueWeight) + PredTrueWeight * SuccFalseWeight);
2194 }
Manman Renee28e0f2012-06-13 05:43:29 +00002195 AddPredecessorToBlock(TrueDest, PredBlock, BB);
2196 PBI->setSuccessor(0, TrueDest);
2197 }
2198 if (PBI->getSuccessor(1) == BB) {
Manman Ren062986c2012-09-15 00:39:57 +00002199 if (PredHasWeights && SuccHasWeights) {
2200 // PBI: br i1 %x, TrueDest, BB
2201 // BI: br i1 %y, TrueDest, FalseDest
2202 //TrueWeight is TrueWeight for PBI * TotalWeight for BI +
2203 // FalseWeight for PBI * TrueWeight for BI.
2204 NewWeights.push_back(PredTrueWeight * (SuccFalseWeight +
2205 SuccTrueWeight) + PredFalseWeight * SuccTrueWeight);
2206 //FalseWeight is FalseWeight for PBI * FalseWeight for BI.
2207 NewWeights.push_back(PredFalseWeight * SuccFalseWeight);
2208 }
Manman Renee28e0f2012-06-13 05:43:29 +00002209 AddPredecessorToBlock(FalseDest, PredBlock, BB);
2210 PBI->setSuccessor(1, FalseDest);
2211 }
Manman Ren062986c2012-09-15 00:39:57 +00002212 if (NewWeights.size() == 2) {
2213 // Halve the weights if any of them cannot fit in an uint32_t
2214 FitWeights(NewWeights);
2215
2216 SmallVector<uint32_t, 8> MDWeights(NewWeights.begin(),NewWeights.end());
2217 PBI->setMetadata(LLVMContext::MD_prof,
2218 MDBuilder(BI->getContext()).
2219 createBranchWeights(MDWeights));
2220 } else
2221 PBI->setMetadata(LLVMContext::MD_prof, NULL);
Manman Renee28e0f2012-06-13 05:43:29 +00002222 } else {
2223 // Update PHI nodes in the common successors.
2224 for (unsigned i = 0, e = PHIs.size(); i != e; ++i) {
Nick Lewyckyedb58422012-06-24 10:15:42 +00002225 ConstantInt *PBI_C = cast<ConstantInt>(
Manman Renee28e0f2012-06-13 05:43:29 +00002226 PHIs[i]->getIncomingValueForBlock(PBI->getParent()));
2227 assert(PBI_C->getType()->isIntegerTy(1));
2228 Instruction *MergedCond = 0;
2229 if (PBI->getSuccessor(0) == TrueDest) {
2230 // Create (PBI_Cond and PBI_C) or (!PBI_Cond and BI_Value)
2231 // PBI_C is true: PBI_Cond or (!PBI_Cond and BI_Value)
2232 // is false: !PBI_Cond and BI_Value
2233 Instruction *NotCond =
2234 cast<Instruction>(Builder.CreateNot(PBI->getCondition(),
2235 "not.cond"));
2236 MergedCond =
2237 cast<Instruction>(Builder.CreateBinOp(Instruction::And,
2238 NotCond, New,
2239 "and.cond"));
2240 if (PBI_C->isOne())
2241 MergedCond =
2242 cast<Instruction>(Builder.CreateBinOp(Instruction::Or,
2243 PBI->getCondition(), MergedCond,
2244 "or.cond"));
2245 } else {
2246 // Create (PBI_Cond and BI_Value) or (!PBI_Cond and PBI_C)
2247 // PBI_C is true: (PBI_Cond and BI_Value) or (!PBI_Cond)
2248 // is false: PBI_Cond and BI_Value
Andrew Trick6b014382012-08-29 21:46:36 +00002249 MergedCond =
Manman Renee28e0f2012-06-13 05:43:29 +00002250 cast<Instruction>(Builder.CreateBinOp(Instruction::And,
2251 PBI->getCondition(), New,
2252 "and.cond"));
2253 if (PBI_C->isOne()) {
2254 Instruction *NotCond =
2255 cast<Instruction>(Builder.CreateNot(PBI->getCondition(),
2256 "not.cond"));
Andrew Trick6b014382012-08-29 21:46:36 +00002257 MergedCond =
Manman Renee28e0f2012-06-13 05:43:29 +00002258 cast<Instruction>(Builder.CreateBinOp(Instruction::Or,
2259 NotCond, MergedCond,
2260 "or.cond"));
2261 }
2262 }
2263 // Update PHI Node.
2264 PHIs[i]->setIncomingValue(PHIs[i]->getBasicBlockIndex(PBI->getParent()),
2265 MergedCond);
2266 }
2267 // Change PBI from Conditional to Unconditional.
2268 BranchInst *New_PBI = BranchInst::Create(TrueDest, PBI);
2269 EraseTerminatorInstAndDCECond(PBI);
2270 PBI = New_PBI;
Chris Lattner36989092008-07-13 21:20:19 +00002271 }
Devang Pateld4181942011-04-06 22:37:20 +00002272
Nick Lewycky06cc66f2011-12-27 04:31:52 +00002273 // TODO: If BB is reachable from all paths through PredBlock, then we
2274 // could replace PBI's branch probabilities with BI's.
2275
Chris Lattner3c6e7462011-04-14 02:44:53 +00002276 // Copy any debug value intrinsics into the end of PredBlock.
2277 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
2278 if (isa<DbgInfoIntrinsic>(*I))
2279 I->clone()->insertBefore(PBI);
Andrew Trick6b014382012-08-29 21:46:36 +00002280
Chris Lattner117f8cf2010-12-14 05:57:30 +00002281 return true;
Chris Lattner1347e872008-07-13 21:12:01 +00002282 }
2283 return false;
2284}
2285
Chris Lattner867661a2008-07-13 21:53:26 +00002286/// SimplifyCondBranchToCondBranch - If we have a conditional branch as a
2287/// predecessor of another block, this function tries to simplify it. We know
2288/// that PBI and BI are both conditional branches, and BI is in one of the
2289/// successor blocks of PBI - PBI branches to BI.
2290static bool SimplifyCondBranchToCondBranch(BranchInst *PBI, BranchInst *BI) {
2291 assert(PBI->isConditional() && BI->isConditional());
2292 BasicBlock *BB = BI->getParent();
Dan Gohman4ae51262009-08-12 16:23:25 +00002293
Chris Lattner867661a2008-07-13 21:53:26 +00002294 // If this block ends with a branch instruction, and if there is a
Andrew Trick6b014382012-08-29 21:46:36 +00002295 // predecessor that ends on a branch of the same condition, make
Chris Lattner867661a2008-07-13 21:53:26 +00002296 // this conditional branch redundant.
2297 if (PBI->getCondition() == BI->getCondition() &&
2298 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
2299 // Okay, the outcome of this conditional branch is statically
2300 // knowable. If this block had a single pred, handle specially.
2301 if (BB->getSinglePredecessor()) {
2302 // Turn this into a branch on constant.
2303 bool CondIsTrue = PBI->getSuccessor(0) == BB;
Andrew Trick6b014382012-08-29 21:46:36 +00002304 BI->setCondition(ConstantInt::get(Type::getInt1Ty(BB->getContext()),
Owen Anderson1d0be152009-08-13 21:58:54 +00002305 CondIsTrue));
Chris Lattner867661a2008-07-13 21:53:26 +00002306 return true; // Nuke the branch on constant.
2307 }
Andrew Trick6b014382012-08-29 21:46:36 +00002308
Chris Lattner867661a2008-07-13 21:53:26 +00002309 // Otherwise, if there are multiple predecessors, insert a PHI that merges
2310 // in the constant and simplify the block result. Subsequent passes of
2311 // simplifycfg will thread the block.
2312 if (BlockIsSimpleEnoughToThreadThrough(BB)) {
Jay Foadd8b4fb42011-03-30 11:19:20 +00002313 pred_iterator PB = pred_begin(BB), PE = pred_end(BB);
Owen Anderson1d0be152009-08-13 21:58:54 +00002314 PHINode *NewPN = PHINode::Create(Type::getInt1Ty(BB->getContext()),
Jay Foad3ecfc862011-03-30 11:28:46 +00002315 std::distance(PB, PE),
Chris Lattner867661a2008-07-13 21:53:26 +00002316 BI->getCondition()->getName() + ".pr",
2317 BB->begin());
Chris Lattnereb388af2008-07-13 21:55:46 +00002318 // Okay, we're going to insert the PHI node. Since PBI is not the only
2319 // predecessor, compute the PHI'd conditional value for all of the preds.
2320 // Any predecessor where the condition is not computable we keep symbolic.
Jay Foadd8b4fb42011-03-30 11:19:20 +00002321 for (pred_iterator PI = PB; PI != PE; ++PI) {
Gabor Greif62539832010-07-12 10:59:23 +00002322 BasicBlock *P = *PI;
2323 if ((PBI = dyn_cast<BranchInst>(P->getTerminator())) &&
Chris Lattner867661a2008-07-13 21:53:26 +00002324 PBI != BI && PBI->isConditional() &&
2325 PBI->getCondition() == BI->getCondition() &&
2326 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
2327 bool CondIsTrue = PBI->getSuccessor(0) == BB;
Andrew Trick6b014382012-08-29 21:46:36 +00002328 NewPN->addIncoming(ConstantInt::get(Type::getInt1Ty(BB->getContext()),
Gabor Greif62539832010-07-12 10:59:23 +00002329 CondIsTrue), P);
Chris Lattner867661a2008-07-13 21:53:26 +00002330 } else {
Gabor Greif62539832010-07-12 10:59:23 +00002331 NewPN->addIncoming(BI->getCondition(), P);
Chris Lattner867661a2008-07-13 21:53:26 +00002332 }
Gabor Greif62539832010-07-12 10:59:23 +00002333 }
Andrew Trick6b014382012-08-29 21:46:36 +00002334
Chris Lattner867661a2008-07-13 21:53:26 +00002335 BI->setCondition(NewPN);
Chris Lattner867661a2008-07-13 21:53:26 +00002336 return true;
2337 }
2338 }
Andrew Trick6b014382012-08-29 21:46:36 +00002339
Chris Lattner867661a2008-07-13 21:53:26 +00002340 // If this is a conditional branch in an empty block, and if any
2341 // predecessors is a conditional branch to one of our destinations,
2342 // fold the conditions into logical ops and one cond br.
Zhou Shenga8d57fe2009-02-26 06:56:37 +00002343 BasicBlock::iterator BBI = BB->begin();
2344 // Ignore dbg intrinsics.
2345 while (isa<DbgInfoIntrinsic>(BBI))
2346 ++BBI;
2347 if (&*BBI != BI)
Chris Lattnerb8245122008-07-13 22:04:41 +00002348 return false;
Chris Lattner63bf29b2009-01-20 01:15:41 +00002349
Andrew Trick6b014382012-08-29 21:46:36 +00002350
Chris Lattner63bf29b2009-01-20 01:15:41 +00002351 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(BI->getCondition()))
2352 if (CE->canTrap())
2353 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002354
Chris Lattnerb8245122008-07-13 22:04:41 +00002355 int PBIOp, BIOp;
2356 if (PBI->getSuccessor(0) == BI->getSuccessor(0))
2357 PBIOp = BIOp = 0;
2358 else if (PBI->getSuccessor(0) == BI->getSuccessor(1))
2359 PBIOp = 0, BIOp = 1;
2360 else if (PBI->getSuccessor(1) == BI->getSuccessor(0))
2361 PBIOp = 1, BIOp = 0;
2362 else if (PBI->getSuccessor(1) == BI->getSuccessor(1))
2363 PBIOp = BIOp = 1;
2364 else
2365 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002366
Chris Lattnerb8245122008-07-13 22:04:41 +00002367 // Check to make sure that the other destination of this branch
2368 // isn't BB itself. If so, this is an infinite loop that will
2369 // keep getting unwound.
2370 if (PBI->getSuccessor(PBIOp) == BB)
2371 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002372
2373 // Do not perform this transformation if it would require
Chris Lattnerb8245122008-07-13 22:04:41 +00002374 // insertion of a large number of select instructions. For targets
2375 // without predication/cmovs, this is a big pessimization.
2376 BasicBlock *CommonDest = PBI->getSuccessor(PBIOp);
Andrew Trick6b014382012-08-29 21:46:36 +00002377
Chris Lattnerb8245122008-07-13 22:04:41 +00002378 unsigned NumPhis = 0;
2379 for (BasicBlock::iterator II = CommonDest->begin();
2380 isa<PHINode>(II); ++II, ++NumPhis)
2381 if (NumPhis > 2) // Disable this xform.
2382 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002383
Chris Lattnerb8245122008-07-13 22:04:41 +00002384 // Finally, if everything is ok, fold the branches to logical ops.
2385 BasicBlock *OtherDest = BI->getSuccessor(BIOp ^ 1);
Andrew Trick6b014382012-08-29 21:46:36 +00002386
David Greene89d6fd32010-01-05 01:26:52 +00002387 DEBUG(dbgs() << "FOLDING BRs:" << *PBI->getParent()
Chris Lattnerbdff5482009-08-23 04:37:46 +00002388 << "AND: " << *BI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00002389
2390
Chris Lattner093a4382008-07-13 22:23:11 +00002391 // If OtherDest *is* BB, then BB is a basic block with a single conditional
2392 // branch in it, where one edge (OtherDest) goes back to itself but the other
2393 // exits. We don't *know* that the program avoids the infinite loop
2394 // (even though that seems likely). If we do this xform naively, we'll end up
2395 // recursively unpeeling the loop. Since we know that (after the xform is
2396 // done) that the block *is* infinite if reached, we just make it an obviously
2397 // infinite loop with no cond branch.
2398 if (OtherDest == BB) {
2399 // Insert it at the end of the function, because it's either code,
2400 // or it won't matter if it's hot. :)
Owen Anderson1d0be152009-08-13 21:58:54 +00002401 BasicBlock *InfLoopBlock = BasicBlock::Create(BB->getContext(),
2402 "infloop", BB->getParent());
Chris Lattner093a4382008-07-13 22:23:11 +00002403 BranchInst::Create(InfLoopBlock, InfLoopBlock);
2404 OtherDest = InfLoopBlock;
Andrew Trick6b014382012-08-29 21:46:36 +00002405 }
2406
David Greene89d6fd32010-01-05 01:26:52 +00002407 DEBUG(dbgs() << *PBI->getParent()->getParent());
Devang Pateld3a17882011-05-19 20:52:46 +00002408
Chris Lattnerb8245122008-07-13 22:04:41 +00002409 // BI may have other predecessors. Because of this, we leave
2410 // it alone, but modify PBI.
Andrew Trick6b014382012-08-29 21:46:36 +00002411
Chris Lattnerb8245122008-07-13 22:04:41 +00002412 // Make sure we get to CommonDest on True&True directions.
2413 Value *PBICond = PBI->getCondition();
Devang Pateld3a17882011-05-19 20:52:46 +00002414 IRBuilder<true, NoFolder> Builder(PBI);
Chris Lattnerb8245122008-07-13 22:04:41 +00002415 if (PBIOp)
Devang Pateld3a17882011-05-19 20:52:46 +00002416 PBICond = Builder.CreateNot(PBICond, PBICond->getName()+".not");
2417
Chris Lattnerb8245122008-07-13 22:04:41 +00002418 Value *BICond = BI->getCondition();
2419 if (BIOp)
Devang Pateld3a17882011-05-19 20:52:46 +00002420 BICond = Builder.CreateNot(BICond, BICond->getName()+".not");
2421
Chris Lattnerb8245122008-07-13 22:04:41 +00002422 // Merge the conditions.
Devang Pateld3a17882011-05-19 20:52:46 +00002423 Value *Cond = Builder.CreateOr(PBICond, BICond, "brmerge");
Andrew Trick6b014382012-08-29 21:46:36 +00002424
Chris Lattnerb8245122008-07-13 22:04:41 +00002425 // Modify PBI to branch on the new condition to the new dests.
2426 PBI->setCondition(Cond);
2427 PBI->setSuccessor(0, CommonDest);
2428 PBI->setSuccessor(1, OtherDest);
Andrew Trick6b014382012-08-29 21:46:36 +00002429
Manman Ren56654032012-09-17 21:30:40 +00002430 // Update branch weight for PBI.
2431 uint64_t PredTrueWeight, PredFalseWeight, SuccTrueWeight, SuccFalseWeight;
2432 bool PredHasWeights = ExtractBranchMetadata(PBI, PredTrueWeight,
2433 PredFalseWeight);
2434 bool SuccHasWeights = ExtractBranchMetadata(BI, SuccTrueWeight,
2435 SuccFalseWeight);
2436 if (PredHasWeights && SuccHasWeights) {
2437 uint64_t PredCommon = PBIOp ? PredFalseWeight : PredTrueWeight;
2438 uint64_t PredOther = PBIOp ?PredTrueWeight : PredFalseWeight;
2439 uint64_t SuccCommon = BIOp ? SuccFalseWeight : SuccTrueWeight;
2440 uint64_t SuccOther = BIOp ? SuccTrueWeight : SuccFalseWeight;
2441 // The weight to CommonDest should be PredCommon * SuccTotal +
2442 // PredOther * SuccCommon.
2443 // The weight to OtherDest should be PredOther * SuccOther.
2444 SmallVector<uint64_t, 2> NewWeights;
2445 NewWeights.push_back(PredCommon * (SuccCommon + SuccOther) +
2446 PredOther * SuccCommon);
2447 NewWeights.push_back(PredOther * SuccOther);
2448 // Halve the weights if any of them cannot fit in an uint32_t
2449 FitWeights(NewWeights);
2450
2451 SmallVector<uint32_t, 2> MDWeights(NewWeights.begin(),NewWeights.end());
2452 PBI->setMetadata(LLVMContext::MD_prof,
2453 MDBuilder(BI->getContext()).
2454 createBranchWeights(MDWeights));
2455 }
2456
Chris Lattnerb8245122008-07-13 22:04:41 +00002457 // OtherDest may have phi nodes. If so, add an entry from PBI's
2458 // block that are identical to the entries for BI's block.
Chris Lattner6de0a282010-12-14 07:09:42 +00002459 AddPredecessorToBlock(OtherDest, PBI->getParent(), BB);
Andrew Trick6b014382012-08-29 21:46:36 +00002460
Chris Lattnerb8245122008-07-13 22:04:41 +00002461 // We know that the CommonDest already had an edge from PBI to
2462 // it. If it has PHIs though, the PHIs may have different
2463 // entries for BB and PBI's BB. If so, insert a select to make
2464 // them agree.
Chris Lattner6de0a282010-12-14 07:09:42 +00002465 PHINode *PN;
Chris Lattnerb8245122008-07-13 22:04:41 +00002466 for (BasicBlock::iterator II = CommonDest->begin();
2467 (PN = dyn_cast<PHINode>(II)); ++II) {
2468 Value *BIV = PN->getIncomingValueForBlock(BB);
2469 unsigned PBBIdx = PN->getBasicBlockIndex(PBI->getParent());
2470 Value *PBIV = PN->getIncomingValue(PBBIdx);
2471 if (BIV != PBIV) {
2472 // Insert a select in PBI to pick the right value.
Devang Pateld3a17882011-05-19 20:52:46 +00002473 Value *NV = cast<SelectInst>
2474 (Builder.CreateSelect(PBICond, PBIV, BIV, PBIV->getName()+".mux"));
Chris Lattnerb8245122008-07-13 22:04:41 +00002475 PN->setIncomingValue(PBBIdx, NV);
Chris Lattner867661a2008-07-13 21:53:26 +00002476 }
2477 }
Andrew Trick6b014382012-08-29 21:46:36 +00002478
David Greene89d6fd32010-01-05 01:26:52 +00002479 DEBUG(dbgs() << "INTO: " << *PBI->getParent());
2480 DEBUG(dbgs() << *PBI->getParent()->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00002481
Chris Lattnerb8245122008-07-13 22:04:41 +00002482 // This basic block is probably dead. We know it has at least
2483 // one fewer predecessor.
2484 return true;
Chris Lattner867661a2008-07-13 21:53:26 +00002485}
2486
Frits van Bommel65fdded2011-01-11 12:52:11 +00002487// SimplifyTerminatorOnSelect - Simplifies a terminator by replacing it with a
2488// branch to TrueBB if Cond is true or to FalseBB if Cond is false.
2489// Takes care of updating the successors and removing the old terminator.
2490// Also makes sure not to introduce new successors by assuming that edges to
2491// non-successor TrueBBs and FalseBBs aren't reachable.
2492static bool SimplifyTerminatorOnSelect(TerminatorInst *OldTerm, Value *Cond,
Manman Renb11cbe62012-09-17 22:28:55 +00002493 BasicBlock *TrueBB, BasicBlock *FalseBB,
2494 uint32_t TrueWeight,
2495 uint32_t FalseWeight){
Frits van Bommel65fdded2011-01-11 12:52:11 +00002496 // Remove any superfluous successor edges from the CFG.
2497 // First, figure out which successors to preserve.
2498 // If TrueBB and FalseBB are equal, only try to preserve one copy of that
2499 // successor.
2500 BasicBlock *KeepEdge1 = TrueBB;
2501 BasicBlock *KeepEdge2 = TrueBB != FalseBB ? FalseBB : 0;
2502
2503 // Then remove the rest.
2504 for (unsigned I = 0, E = OldTerm->getNumSuccessors(); I != E; ++I) {
2505 BasicBlock *Succ = OldTerm->getSuccessor(I);
2506 // Make sure only to keep exactly one copy of each edge.
2507 if (Succ == KeepEdge1)
2508 KeepEdge1 = 0;
2509 else if (Succ == KeepEdge2)
2510 KeepEdge2 = 0;
2511 else
2512 Succ->removePredecessor(OldTerm->getParent());
2513 }
2514
Devang Pateld3372b82011-05-18 18:43:31 +00002515 IRBuilder<> Builder(OldTerm);
2516 Builder.SetCurrentDebugLocation(OldTerm->getDebugLoc());
2517
Frits van Bommel65fdded2011-01-11 12:52:11 +00002518 // Insert an appropriate new terminator.
2519 if ((KeepEdge1 == 0) && (KeepEdge2 == 0)) {
2520 if (TrueBB == FalseBB)
2521 // We were only looking for one successor, and it was present.
2522 // Create an unconditional branch to it.
Devang Pateld3372b82011-05-18 18:43:31 +00002523 Builder.CreateBr(TrueBB);
Manman Renb11cbe62012-09-17 22:28:55 +00002524 else {
Frits van Bommel65fdded2011-01-11 12:52:11 +00002525 // We found both of the successors we were looking for.
2526 // Create a conditional branch sharing the condition of the select.
Manman Renb11cbe62012-09-17 22:28:55 +00002527 BranchInst *NewBI = Builder.CreateCondBr(Cond, TrueBB, FalseBB);
2528 if (TrueWeight != FalseWeight)
2529 NewBI->setMetadata(LLVMContext::MD_prof,
2530 MDBuilder(OldTerm->getContext()).
2531 createBranchWeights(TrueWeight, FalseWeight));
2532 }
Frits van Bommel65fdded2011-01-11 12:52:11 +00002533 } else if (KeepEdge1 && (KeepEdge2 || TrueBB == FalseBB)) {
2534 // Neither of the selected blocks were successors, so this
2535 // terminator must be unreachable.
2536 new UnreachableInst(OldTerm->getContext(), OldTerm);
2537 } else {
2538 // One of the selected values was a successor, but the other wasn't.
2539 // Insert an unconditional branch to the one that was found;
2540 // the edge to the one that wasn't must be unreachable.
2541 if (KeepEdge1 == 0)
2542 // Only TrueBB was found.
Devang Pateld3372b82011-05-18 18:43:31 +00002543 Builder.CreateBr(TrueBB);
Frits van Bommel65fdded2011-01-11 12:52:11 +00002544 else
2545 // Only FalseBB was found.
Devang Pateld3372b82011-05-18 18:43:31 +00002546 Builder.CreateBr(FalseBB);
Frits van Bommel65fdded2011-01-11 12:52:11 +00002547 }
2548
2549 EraseTerminatorInstAndDCECond(OldTerm);
2550 return true;
2551}
2552
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00002553// SimplifySwitchOnSelect - Replaces
2554// (switch (select cond, X, Y)) on constant X, Y
2555// with a branch - conditional if X and Y lead to distinct BBs,
2556// unconditional otherwise.
2557static bool SimplifySwitchOnSelect(SwitchInst *SI, SelectInst *Select) {
2558 // Check for constant integer values in the select.
2559 ConstantInt *TrueVal = dyn_cast<ConstantInt>(Select->getTrueValue());
2560 ConstantInt *FalseVal = dyn_cast<ConstantInt>(Select->getFalseValue());
2561 if (!TrueVal || !FalseVal)
2562 return false;
2563
2564 // Find the relevant condition and destinations.
2565 Value *Condition = Select->getCondition();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00002566 BasicBlock *TrueBB = SI->findCaseValue(TrueVal).getCaseSuccessor();
2567 BasicBlock *FalseBB = SI->findCaseValue(FalseVal).getCaseSuccessor();
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00002568
Manman Renb11cbe62012-09-17 22:28:55 +00002569 // Get weight for TrueBB and FalseBB.
2570 uint32_t TrueWeight = 0, FalseWeight = 0;
2571 SmallVector<uint64_t, 8> Weights;
2572 bool HasWeights = HasBranchWeights(SI);
2573 if (HasWeights) {
2574 GetBranchWeights(SI, Weights);
2575 if (Weights.size() == 1 + SI->getNumCases()) {
2576 TrueWeight = (uint32_t)Weights[SI->findCaseValue(TrueVal).
2577 getSuccessorIndex()];
2578 FalseWeight = (uint32_t)Weights[SI->findCaseValue(FalseVal).
2579 getSuccessorIndex()];
2580 }
2581 }
2582
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00002583 // Perform the actual simplification.
Manman Renb11cbe62012-09-17 22:28:55 +00002584 return SimplifyTerminatorOnSelect(SI, Condition, TrueBB, FalseBB,
2585 TrueWeight, FalseWeight);
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00002586}
2587
Frits van Bommel7ac40c32010-12-05 18:29:03 +00002588// SimplifyIndirectBrOnSelect - Replaces
2589// (indirectbr (select cond, blockaddress(@fn, BlockA),
2590// blockaddress(@fn, BlockB)))
2591// with
2592// (br cond, BlockA, BlockB).
2593static bool SimplifyIndirectBrOnSelect(IndirectBrInst *IBI, SelectInst *SI) {
2594 // Check that both operands of the select are block addresses.
2595 BlockAddress *TBA = dyn_cast<BlockAddress>(SI->getTrueValue());
2596 BlockAddress *FBA = dyn_cast<BlockAddress>(SI->getFalseValue());
2597 if (!TBA || !FBA)
2598 return false;
2599
2600 // Extract the actual blocks.
2601 BasicBlock *TrueBB = TBA->getBasicBlock();
2602 BasicBlock *FalseBB = FBA->getBasicBlock();
2603
Frits van Bommel65fdded2011-01-11 12:52:11 +00002604 // Perform the actual simplification.
Manman Renb11cbe62012-09-17 22:28:55 +00002605 return SimplifyTerminatorOnSelect(IBI, SI->getCondition(), TrueBB, FalseBB,
2606 0, 0);
Frits van Bommel7ac40c32010-12-05 18:29:03 +00002607}
2608
Chris Lattner61c77442010-12-13 03:18:54 +00002609/// TryToSimplifyUncondBranchWithICmpInIt - This is called when we find an icmp
2610/// instruction (a seteq/setne with a constant) as the only instruction in a
2611/// block that ends with an uncond branch. We are looking for a very specific
2612/// pattern that occurs when "A == 1 || A == 2 || A == 3" gets simplified. In
2613/// this case, we merge the first two "or's of icmp" into a switch, but then the
2614/// default value goes to an uncond block with a seteq in it, we get something
2615/// like:
2616///
2617/// switch i8 %A, label %DEFAULT [ i8 1, label %end i8 2, label %end ]
2618/// DEFAULT:
2619/// %tmp = icmp eq i8 %A, 92
2620/// br label %end
2621/// end:
2622/// ... = phi i1 [ true, %entry ], [ %tmp, %DEFAULT ], [ true, %entry ]
Andrew Trick6b014382012-08-29 21:46:36 +00002623///
Chris Lattner61c77442010-12-13 03:18:54 +00002624/// We prefer to split the edge to 'end' so that there is a true/false entry to
2625/// the PHI, merging the third icmp into the switch.
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00002626static bool TryToSimplifyUncondBranchWithICmpInIt(
2627 ICmpInst *ICI, IRBuilder<> &Builder, const TargetTransformInfo &TTI,
2628 const DataLayout *TD) {
Chris Lattner61c77442010-12-13 03:18:54 +00002629 BasicBlock *BB = ICI->getParent();
Devang Patela23812c2011-05-18 18:28:48 +00002630
Chris Lattner61c77442010-12-13 03:18:54 +00002631 // If the block has any PHIs in it or the icmp has multiple uses, it is too
2632 // complex.
2633 if (isa<PHINode>(BB->begin()) || !ICI->hasOneUse()) return false;
2634
2635 Value *V = ICI->getOperand(0);
2636 ConstantInt *Cst = cast<ConstantInt>(ICI->getOperand(1));
Andrew Trick6b014382012-08-29 21:46:36 +00002637
Chris Lattner61c77442010-12-13 03:18:54 +00002638 // The pattern we're looking for is where our only predecessor is a switch on
2639 // 'V' and this block is the default case for the switch. In this case we can
2640 // fold the compared value into the switch to simplify things.
2641 BasicBlock *Pred = BB->getSinglePredecessor();
2642 if (Pred == 0 || !isa<SwitchInst>(Pred->getTerminator())) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002643
Chris Lattner61c77442010-12-13 03:18:54 +00002644 SwitchInst *SI = cast<SwitchInst>(Pred->getTerminator());
2645 if (SI->getCondition() != V)
2646 return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002647
Chris Lattner61c77442010-12-13 03:18:54 +00002648 // If BB is reachable on a non-default case, then we simply know the value of
2649 // V in this block. Substitute it and constant fold the icmp instruction
2650 // away.
2651 if (SI->getDefaultDest() != BB) {
2652 ConstantInt *VVal = SI->findCaseDest(BB);
2653 assert(VVal && "Should have a unique destination value");
2654 ICI->setOperand(0, VVal);
Andrew Trick6b014382012-08-29 21:46:36 +00002655
Chris Lattner302ba6f2010-12-14 06:17:25 +00002656 if (Value *V = SimplifyInstruction(ICI, TD)) {
2657 ICI->replaceAllUsesWith(V);
Chris Lattner61c77442010-12-13 03:18:54 +00002658 ICI->eraseFromParent();
2659 }
2660 // BB is now empty, so it is likely to simplify away.
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00002661 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner61c77442010-12-13 03:18:54 +00002662 }
Andrew Trick6b014382012-08-29 21:46:36 +00002663
Chris Lattnerabf70672010-12-13 03:43:57 +00002664 // Ok, the block is reachable from the default dest. If the constant we're
2665 // comparing exists in one of the other edges, then we can constant fold ICI
2666 // and zap it.
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00002667 if (SI->findCaseValue(Cst) != SI->case_default()) {
Chris Lattnerabf70672010-12-13 03:43:57 +00002668 Value *V;
2669 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
2670 V = ConstantInt::getFalse(BB->getContext());
2671 else
2672 V = ConstantInt::getTrue(BB->getContext());
Andrew Trick6b014382012-08-29 21:46:36 +00002673
Chris Lattnerabf70672010-12-13 03:43:57 +00002674 ICI->replaceAllUsesWith(V);
2675 ICI->eraseFromParent();
2676 // BB is now empty, so it is likely to simplify away.
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00002677 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattnerabf70672010-12-13 03:43:57 +00002678 }
Andrew Trick6b014382012-08-29 21:46:36 +00002679
Chris Lattner61c77442010-12-13 03:18:54 +00002680 // The use of the icmp has to be in the 'end' block, by the only PHI node in
2681 // the block.
2682 BasicBlock *SuccBlock = BB->getTerminator()->getSuccessor(0);
2683 PHINode *PHIUse = dyn_cast<PHINode>(ICI->use_back());
2684 if (PHIUse == 0 || PHIUse != &SuccBlock->front() ||
2685 isa<PHINode>(++BasicBlock::iterator(PHIUse)))
2686 return false;
2687
2688 // If the icmp is a SETEQ, then the default dest gets false, the new edge gets
2689 // true in the PHI.
2690 Constant *DefaultCst = ConstantInt::getTrue(BB->getContext());
2691 Constant *NewCst = ConstantInt::getFalse(BB->getContext());
2692
2693 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
2694 std::swap(DefaultCst, NewCst);
2695
2696 // Replace ICI (which is used by the PHI for the default value) with true or
2697 // false depending on if it is EQ or NE.
2698 ICI->replaceAllUsesWith(DefaultCst);
2699 ICI->eraseFromParent();
2700
2701 // Okay, the switch goes to this block on a default value. Add an edge from
2702 // the switch to the merge point on the compared value.
2703 BasicBlock *NewBB = BasicBlock::Create(BB->getContext(), "switch.edge",
2704 BB->getParent(), BB);
Manman Renb0102772012-09-17 23:07:43 +00002705 SmallVector<uint64_t, 8> Weights;
2706 bool HasWeights = HasBranchWeights(SI);
2707 if (HasWeights) {
2708 GetBranchWeights(SI, Weights);
2709 if (Weights.size() == 1 + SI->getNumCases()) {
2710 // Split weight for default case to case for "Cst".
2711 Weights[0] = (Weights[0]+1) >> 1;
2712 Weights.push_back(Weights[0]);
2713
2714 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
2715 SI->setMetadata(LLVMContext::MD_prof,
2716 MDBuilder(SI->getContext()).
2717 createBranchWeights(MDWeights));
2718 }
2719 }
Chris Lattner61c77442010-12-13 03:18:54 +00002720 SI->addCase(Cst, NewBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002721
Chris Lattner61c77442010-12-13 03:18:54 +00002722 // NewBB branches to the phi block, add the uncond branch and the phi entry.
Devang Patela23812c2011-05-18 18:28:48 +00002723 Builder.SetInsertPoint(NewBB);
2724 Builder.SetCurrentDebugLocation(SI->getDebugLoc());
2725 Builder.CreateBr(SuccBlock);
Chris Lattner61c77442010-12-13 03:18:54 +00002726 PHIUse->addIncoming(NewCst, NewBB);
2727 return true;
2728}
2729
Chris Lattner97fdb892010-12-13 05:03:41 +00002730/// SimplifyBranchOnICmpChain - The specified branch is a conditional branch.
2731/// Check to see if it is branching on an or/and chain of icmp instructions, and
2732/// fold it into a switch instruction if so.
Micah Villmow3574eca2012-10-08 16:38:25 +00002733static bool SimplifyBranchOnICmpChain(BranchInst *BI, const DataLayout *TD,
Devang Patel02dd5412011-05-18 23:18:47 +00002734 IRBuilder<> &Builder) {
Chris Lattner97fdb892010-12-13 05:03:41 +00002735 Instruction *Cond = dyn_cast<Instruction>(BI->getCondition());
2736 if (Cond == 0) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002737
2738
Chris Lattner97fdb892010-12-13 05:03:41 +00002739 // Change br (X == 0 | X == 1), T, F into a switch instruction.
2740 // If this is a bunch of seteq's or'd together, or if it's a bunch of
2741 // 'setne's and'ed together, collect them.
2742 Value *CompVal = 0;
2743 std::vector<ConstantInt*> Values;
2744 bool TrueWhenEqual = true;
2745 Value *ExtraCase = 0;
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002746 unsigned UsedICmps = 0;
Andrew Trick6b014382012-08-29 21:46:36 +00002747
Chris Lattner97fdb892010-12-13 05:03:41 +00002748 if (Cond->getOpcode() == Instruction::Or) {
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002749 CompVal = GatherConstantCompares(Cond, Values, ExtraCase, TD, true,
2750 UsedICmps);
Chris Lattner97fdb892010-12-13 05:03:41 +00002751 } else if (Cond->getOpcode() == Instruction::And) {
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002752 CompVal = GatherConstantCompares(Cond, Values, ExtraCase, TD, false,
2753 UsedICmps);
Chris Lattner97fdb892010-12-13 05:03:41 +00002754 TrueWhenEqual = false;
2755 }
Andrew Trick6b014382012-08-29 21:46:36 +00002756
Chris Lattner97fdb892010-12-13 05:03:41 +00002757 // If we didn't have a multiply compared value, fail.
2758 if (CompVal == 0) return false;
2759
Benjamin Kramer33828bc2011-02-07 22:37:28 +00002760 // Avoid turning single icmps into a switch.
2761 if (UsedICmps <= 1)
2762 return false;
2763
Chris Lattner97fdb892010-12-13 05:03:41 +00002764 // There might be duplicate constants in the list, which the switch
2765 // instruction can't handle, remove them now.
2766 array_pod_sort(Values.begin(), Values.end(), ConstantIntSortPredicate);
2767 Values.erase(std::unique(Values.begin(), Values.end()), Values.end());
Andrew Trick6b014382012-08-29 21:46:36 +00002768
Chris Lattner97fdb892010-12-13 05:03:41 +00002769 // If Extra was used, we require at least two switch values to do the
2770 // transformation. A switch with one value is just an cond branch.
2771 if (ExtraCase && Values.size() < 2) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002772
Andrew Trickb1b97832012-08-29 21:46:38 +00002773 // TODO: Preserve branch weight metadata, similarly to how
2774 // FoldValueComparisonIntoPredecessors preserves it.
2775
Chris Lattner97fdb892010-12-13 05:03:41 +00002776 // Figure out which block is which destination.
2777 BasicBlock *DefaultBB = BI->getSuccessor(1);
2778 BasicBlock *EdgeBB = BI->getSuccessor(0);
2779 if (!TrueWhenEqual) std::swap(DefaultBB, EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002780
Chris Lattner97fdb892010-12-13 05:03:41 +00002781 BasicBlock *BB = BI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002782
Chris Lattner302ba6f2010-12-14 06:17:25 +00002783 DEBUG(dbgs() << "Converting 'icmp' chain with " << Values.size()
Chris Lattner117f8cf2010-12-14 05:57:30 +00002784 << " cases into SWITCH. BB is:\n" << *BB);
Andrew Trick6b014382012-08-29 21:46:36 +00002785
Chris Lattner97fdb892010-12-13 05:03:41 +00002786 // If there are any extra values that couldn't be folded into the switch
2787 // then we evaluate them with an explicit branch first. Split the block
2788 // right before the condbr to handle it.
2789 if (ExtraCase) {
2790 BasicBlock *NewBB = BB->splitBasicBlock(BI, "switch.early.test");
2791 // Remove the uncond branch added to the old block.
2792 TerminatorInst *OldTI = BB->getTerminator();
Devang Patel02dd5412011-05-18 23:18:47 +00002793 Builder.SetInsertPoint(OldTI);
2794
Chris Lattner117f8cf2010-12-14 05:57:30 +00002795 if (TrueWhenEqual)
Devang Patel02dd5412011-05-18 23:18:47 +00002796 Builder.CreateCondBr(ExtraCase, EdgeBB, NewBB);
Chris Lattner117f8cf2010-12-14 05:57:30 +00002797 else
Devang Patel02dd5412011-05-18 23:18:47 +00002798 Builder.CreateCondBr(ExtraCase, NewBB, EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002799
Chris Lattner97fdb892010-12-13 05:03:41 +00002800 OldTI->eraseFromParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002801
Chris Lattner97bd89e2010-12-13 05:34:18 +00002802 // If there are PHI nodes in EdgeBB, then we need to add a new entry to them
2803 // for the edge we just added.
Chris Lattner6de0a282010-12-14 07:09:42 +00002804 AddPredecessorToBlock(EdgeBB, BB, NewBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002805
Chris Lattner302ba6f2010-12-14 06:17:25 +00002806 DEBUG(dbgs() << " ** 'icmp' chain unhandled condition: " << *ExtraCase
2807 << "\nEXTRABB = " << *BB);
Chris Lattner97fdb892010-12-13 05:03:41 +00002808 BB = NewBB;
2809 }
Devang Patel02dd5412011-05-18 23:18:47 +00002810
2811 Builder.SetInsertPoint(BI);
Chris Lattner97fdb892010-12-13 05:03:41 +00002812 // Convert pointer to int before we switch.
2813 if (CompVal->getType()->isPointerTy()) {
Micah Villmow3574eca2012-10-08 16:38:25 +00002814 assert(TD && "Cannot switch on pointer without DataLayout");
Devang Patel02dd5412011-05-18 23:18:47 +00002815 CompVal = Builder.CreatePtrToInt(CompVal,
Matt Arsenault79de3d72013-10-21 18:55:08 +00002816 TD->getIntPtrType(CompVal->getType()),
Devang Patel02dd5412011-05-18 23:18:47 +00002817 "magicptr");
Chris Lattner97fdb892010-12-13 05:03:41 +00002818 }
Andrew Trick6b014382012-08-29 21:46:36 +00002819
Chris Lattner97fdb892010-12-13 05:03:41 +00002820 // Create the new switch instruction now.
Devang Patel02dd5412011-05-18 23:18:47 +00002821 SwitchInst *New = Builder.CreateSwitch(CompVal, DefaultBB, Values.size());
Devang Pateld80e8ed2011-05-17 23:29:05 +00002822
Chris Lattner97fdb892010-12-13 05:03:41 +00002823 // Add all of the 'cases' to the switch instruction.
2824 for (unsigned i = 0, e = Values.size(); i != e; ++i)
2825 New->addCase(Values[i], EdgeBB);
Andrew Trick6b014382012-08-29 21:46:36 +00002826
Chris Lattner97fdb892010-12-13 05:03:41 +00002827 // We added edges from PI to the EdgeBB. As such, if there were any
2828 // PHI nodes in EdgeBB, they need entries to be added corresponding to
2829 // the number of edges added.
2830 for (BasicBlock::iterator BBI = EdgeBB->begin();
2831 isa<PHINode>(BBI); ++BBI) {
2832 PHINode *PN = cast<PHINode>(BBI);
2833 Value *InVal = PN->getIncomingValueForBlock(BB);
2834 for (unsigned i = 0, e = Values.size()-1; i != e; ++i)
2835 PN->addIncoming(InVal, BB);
2836 }
Andrew Trick6b014382012-08-29 21:46:36 +00002837
Chris Lattner97fdb892010-12-13 05:03:41 +00002838 // Erase the old branch instruction.
2839 EraseTerminatorInstAndDCECond(BI);
Andrew Trick6b014382012-08-29 21:46:36 +00002840
Chris Lattner302ba6f2010-12-14 06:17:25 +00002841 DEBUG(dbgs() << " ** 'icmp' chain result is:\n" << *BB << '\n');
Chris Lattner97fdb892010-12-13 05:03:41 +00002842 return true;
2843}
2844
Duncan Sandsad99ef82011-09-05 12:57:57 +00002845bool SimplifyCFGOpt::SimplifyResume(ResumeInst *RI, IRBuilder<> &Builder) {
2846 // If this is a trivial landing pad that just continues unwinding the caught
2847 // exception then zap the landing pad, turning its invokes into calls.
2848 BasicBlock *BB = RI->getParent();
2849 LandingPadInst *LPInst = dyn_cast<LandingPadInst>(BB->getFirstNonPHI());
2850 if (RI->getValue() != LPInst)
2851 // Not a landing pad, or the resume is not unwinding the exception that
2852 // caused control to branch here.
2853 return false;
2854
2855 // Check that there are no other instructions except for debug intrinsics.
2856 BasicBlock::iterator I = LPInst, E = RI;
2857 while (++I != E)
2858 if (!isa<DbgInfoIntrinsic>(I))
2859 return false;
2860
2861 // Turn all invokes that unwind here into calls and delete the basic block.
Bill Wendlingd5bb2082013-03-11 20:53:00 +00002862 bool InvokeRequiresTableEntry = false;
2863 bool Changed = false;
Duncan Sandsad99ef82011-09-05 12:57:57 +00002864 for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE;) {
2865 InvokeInst *II = cast<InvokeInst>((*PI++)->getTerminator());
Bill Wendlingd5bb2082013-03-11 20:53:00 +00002866
2867 if (II->hasFnAttr(Attribute::UWTable)) {
2868 // Don't remove an `invoke' instruction if the ABI requires an entry into
2869 // the table.
2870 InvokeRequiresTableEntry = true;
2871 continue;
2872 }
2873
Duncan Sandsad99ef82011-09-05 12:57:57 +00002874 SmallVector<Value*, 8> Args(II->op_begin(), II->op_end() - 3);
Bill Wendlingd5bb2082013-03-11 20:53:00 +00002875
Duncan Sandsad99ef82011-09-05 12:57:57 +00002876 // Insert a call instruction before the invoke.
2877 CallInst *Call = CallInst::Create(II->getCalledValue(), Args, "", II);
2878 Call->takeName(II);
2879 Call->setCallingConv(II->getCallingConv());
2880 Call->setAttributes(II->getAttributes());
2881 Call->setDebugLoc(II->getDebugLoc());
2882
2883 // Anything that used the value produced by the invoke instruction now uses
2884 // the value produced by the call instruction. Note that we do this even
2885 // for void functions and calls with no uses so that the callgraph edge is
2886 // updated.
2887 II->replaceAllUsesWith(Call);
2888 BB->removePredecessor(II->getParent());
2889
2890 // Insert a branch to the normal destination right before the invoke.
2891 BranchInst::Create(II->getNormalDest(), II);
2892
2893 // Finally, delete the invoke instruction!
2894 II->eraseFromParent();
Bill Wendlingd5bb2082013-03-11 20:53:00 +00002895 Changed = true;
Duncan Sandsad99ef82011-09-05 12:57:57 +00002896 }
2897
Bill Wendlingd5bb2082013-03-11 20:53:00 +00002898 if (!InvokeRequiresTableEntry)
2899 // The landingpad is now unreachable. Zap it.
2900 BB->eraseFromParent();
2901
2902 return Changed;
Duncan Sandsad99ef82011-09-05 12:57:57 +00002903}
2904
Devang Patel176ec402011-05-18 21:33:11 +00002905bool SimplifyCFGOpt::SimplifyReturn(ReturnInst *RI, IRBuilder<> &Builder) {
Chris Lattner3d512132010-12-13 06:25:44 +00002906 BasicBlock *BB = RI->getParent();
2907 if (!BB->getFirstNonPHIOrDbg()->isTerminator()) return false;
Andrew Trick6b014382012-08-29 21:46:36 +00002908
Chris Lattner3d512132010-12-13 06:25:44 +00002909 // Find predecessors that end with branches.
2910 SmallVector<BasicBlock*, 8> UncondBranchPreds;
2911 SmallVector<BranchInst*, 8> CondBranchPreds;
2912 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
2913 BasicBlock *P = *PI;
2914 TerminatorInst *PTI = P->getTerminator();
2915 if (BranchInst *BI = dyn_cast<BranchInst>(PTI)) {
2916 if (BI->isUnconditional())
2917 UncondBranchPreds.push_back(P);
2918 else
2919 CondBranchPreds.push_back(BI);
2920 }
2921 }
Andrew Trick6b014382012-08-29 21:46:36 +00002922
Chris Lattner3d512132010-12-13 06:25:44 +00002923 // If we found some, do the transformation!
Evan Chengc3f507f2011-01-29 04:46:23 +00002924 if (!UncondBranchPreds.empty() && DupRet) {
Chris Lattner3d512132010-12-13 06:25:44 +00002925 while (!UncondBranchPreds.empty()) {
2926 BasicBlock *Pred = UncondBranchPreds.pop_back_val();
2927 DEBUG(dbgs() << "FOLDING: " << *BB
2928 << "INTO UNCOND BRANCH PRED: " << *Pred);
Evan Chengc3f507f2011-01-29 04:46:23 +00002929 (void)FoldReturnIntoUncondBranch(RI, BB, Pred);
Chris Lattner3d512132010-12-13 06:25:44 +00002930 }
Andrew Trick6b014382012-08-29 21:46:36 +00002931
Chris Lattner3d512132010-12-13 06:25:44 +00002932 // If we eliminated all predecessors of the block, delete the block now.
2933 if (pred_begin(BB) == pred_end(BB))
2934 // We know there are no successors, so just nuke the block.
2935 BB->eraseFromParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002936
Chris Lattner3d512132010-12-13 06:25:44 +00002937 return true;
2938 }
Andrew Trick6b014382012-08-29 21:46:36 +00002939
Chris Lattner3d512132010-12-13 06:25:44 +00002940 // Check out all of the conditional branches going to this return
2941 // instruction. If any of them just select between returns, change the
2942 // branch itself into a select/return pair.
2943 while (!CondBranchPreds.empty()) {
2944 BranchInst *BI = CondBranchPreds.pop_back_val();
Andrew Trick6b014382012-08-29 21:46:36 +00002945
Chris Lattner3d512132010-12-13 06:25:44 +00002946 // Check to see if the non-BB successor is also a return block.
2947 if (isa<ReturnInst>(BI->getSuccessor(0)->getTerminator()) &&
2948 isa<ReturnInst>(BI->getSuccessor(1)->getTerminator()) &&
Devang Patel176ec402011-05-18 21:33:11 +00002949 SimplifyCondBranchToTwoReturns(BI, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00002950 return true;
2951 }
2952 return false;
2953}
2954
Chris Lattner3d512132010-12-13 06:25:44 +00002955bool SimplifyCFGOpt::SimplifyUnreachable(UnreachableInst *UI) {
2956 BasicBlock *BB = UI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00002957
Chris Lattner3d512132010-12-13 06:25:44 +00002958 bool Changed = false;
Andrew Trick6b014382012-08-29 21:46:36 +00002959
Chris Lattner3d512132010-12-13 06:25:44 +00002960 // If there are any instructions immediately before the unreachable that can
2961 // be removed, do so.
2962 while (UI != BB->begin()) {
2963 BasicBlock::iterator BBI = UI;
2964 --BBI;
Eli Friedman81763882011-08-15 23:59:28 +00002965 // Do not delete instructions that can have side effects which might cause
2966 // the unreachable to not be reachable; specifically, calls and volatile
2967 // operations may have this effect.
Chris Lattner3d512132010-12-13 06:25:44 +00002968 if (isa<CallInst>(BBI) && !isa<DbgInfoIntrinsic>(BBI)) break;
Eli Friedman81763882011-08-15 23:59:28 +00002969
2970 if (BBI->mayHaveSideEffects()) {
2971 if (StoreInst *SI = dyn_cast<StoreInst>(BBI)) {
2972 if (SI->isVolatile())
2973 break;
2974 } else if (LoadInst *LI = dyn_cast<LoadInst>(BBI)) {
2975 if (LI->isVolatile())
2976 break;
2977 } else if (AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(BBI)) {
2978 if (RMWI->isVolatile())
2979 break;
2980 } else if (AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(BBI)) {
2981 if (CXI->isVolatile())
2982 break;
2983 } else if (!isa<FenceInst>(BBI) && !isa<VAArgInst>(BBI) &&
2984 !isa<LandingPadInst>(BBI)) {
Chris Lattner3d512132010-12-13 06:25:44 +00002985 break;
Eli Friedman81763882011-08-15 23:59:28 +00002986 }
Bill Wendling23b49ba2011-08-16 20:41:17 +00002987 // Note that deleting LandingPad's here is in fact okay, although it
2988 // involves a bit of subtle reasoning. If this inst is a LandingPad,
2989 // all the predecessors of this block will be the unwind edges of Invokes,
2990 // and we can therefore guarantee this block will be erased.
Eli Friedman81763882011-08-15 23:59:28 +00002991 }
2992
Eli Friedman2adc5b62011-03-09 00:48:33 +00002993 // Delete this instruction (any uses are guaranteed to be dead)
2994 if (!BBI->use_empty())
2995 BBI->replaceAllUsesWith(UndefValue::get(BBI->getType()));
Chris Lattner302ba6f2010-12-14 06:17:25 +00002996 BBI->eraseFromParent();
Chris Lattner3d512132010-12-13 06:25:44 +00002997 Changed = true;
2998 }
Andrew Trick6b014382012-08-29 21:46:36 +00002999
Chris Lattner3d512132010-12-13 06:25:44 +00003000 // If the unreachable instruction is the first in the block, take a gander
3001 // at all of the predecessors of this instruction, and simplify them.
3002 if (&BB->front() != UI) return Changed;
Andrew Trick6b014382012-08-29 21:46:36 +00003003
Chris Lattner3d512132010-12-13 06:25:44 +00003004 SmallVector<BasicBlock*, 8> Preds(pred_begin(BB), pred_end(BB));
3005 for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
3006 TerminatorInst *TI = Preds[i]->getTerminator();
Devang Patel1aa89a22011-05-19 00:09:21 +00003007 IRBuilder<> Builder(TI);
Chris Lattner3d512132010-12-13 06:25:44 +00003008 if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
3009 if (BI->isUnconditional()) {
3010 if (BI->getSuccessor(0) == BB) {
3011 new UnreachableInst(TI->getContext(), TI);
3012 TI->eraseFromParent();
3013 Changed = true;
3014 }
3015 } else {
3016 if (BI->getSuccessor(0) == BB) {
Devang Patel1aa89a22011-05-19 00:09:21 +00003017 Builder.CreateBr(BI->getSuccessor(1));
Chris Lattner3d512132010-12-13 06:25:44 +00003018 EraseTerminatorInstAndDCECond(BI);
3019 } else if (BI->getSuccessor(1) == BB) {
Devang Patel1aa89a22011-05-19 00:09:21 +00003020 Builder.CreateBr(BI->getSuccessor(0));
Chris Lattner3d512132010-12-13 06:25:44 +00003021 EraseTerminatorInstAndDCECond(BI);
3022 Changed = true;
3023 }
3024 }
3025 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003026 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003027 i != e; ++i)
3028 if (i.getCaseSuccessor() == BB) {
Chris Lattner3d512132010-12-13 06:25:44 +00003029 BB->removePredecessor(SI->getParent());
3030 SI->removeCase(i);
3031 --i; --e;
3032 Changed = true;
3033 }
3034 // If the default value is unreachable, figure out the most popular
3035 // destination and make it the default.
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003036 if (SI->getDefaultDest() == BB) {
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003037 std::map<BasicBlock*, std::pair<unsigned, unsigned> > Popularity;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003038 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003039 i != e; ++i) {
Nick Lewycky9d523102011-12-26 20:37:40 +00003040 std::pair<unsigned, unsigned> &entry =
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003041 Popularity[i.getCaseSuccessor()];
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003042 if (entry.first == 0) {
3043 entry.first = 1;
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003044 entry.second = i.getCaseIndex();
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003045 } else {
3046 entry.first++;
3047 }
3048 }
3049
Chris Lattner3d512132010-12-13 06:25:44 +00003050 // Find the most popular block.
3051 unsigned MaxPop = 0;
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003052 unsigned MaxIndex = 0;
Chris Lattner3d512132010-12-13 06:25:44 +00003053 BasicBlock *MaxBlock = 0;
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003054 for (std::map<BasicBlock*, std::pair<unsigned, unsigned> >::iterator
Chris Lattner3d512132010-12-13 06:25:44 +00003055 I = Popularity.begin(), E = Popularity.end(); I != E; ++I) {
Andrew Trick6b014382012-08-29 21:46:36 +00003056 if (I->second.first > MaxPop ||
Eli Friedmanb1a6eab2011-03-15 02:23:35 +00003057 (I->second.first == MaxPop && MaxIndex > I->second.second)) {
3058 MaxPop = I->second.first;
3059 MaxIndex = I->second.second;
Chris Lattner3d512132010-12-13 06:25:44 +00003060 MaxBlock = I->first;
3061 }
3062 }
3063 if (MaxBlock) {
3064 // Make this the new default, allowing us to delete any explicit
3065 // edges to it.
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003066 SI->setDefaultDest(MaxBlock);
Chris Lattner3d512132010-12-13 06:25:44 +00003067 Changed = true;
Andrew Trick6b014382012-08-29 21:46:36 +00003068
Chris Lattner3d512132010-12-13 06:25:44 +00003069 // If MaxBlock has phinodes in it, remove MaxPop-1 entries from
3070 // it.
3071 if (isa<PHINode>(MaxBlock->begin()))
3072 for (unsigned i = 0; i != MaxPop-1; ++i)
3073 MaxBlock->removePredecessor(SI->getParent());
Andrew Trick6b014382012-08-29 21:46:36 +00003074
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003075 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003076 i != e; ++i)
3077 if (i.getCaseSuccessor() == MaxBlock) {
Chris Lattner3d512132010-12-13 06:25:44 +00003078 SI->removeCase(i);
3079 --i; --e;
3080 }
3081 }
3082 }
3083 } else if (InvokeInst *II = dyn_cast<InvokeInst>(TI)) {
3084 if (II->getUnwindDest() == BB) {
3085 // Convert the invoke to a call instruction. This would be a good
3086 // place to note that the call does not throw though.
Devang Patel1aa89a22011-05-19 00:09:21 +00003087 BranchInst *BI = Builder.CreateBr(II->getNormalDest());
Chris Lattner3d512132010-12-13 06:25:44 +00003088 II->removeFromParent(); // Take out of symbol table
Andrew Trick6b014382012-08-29 21:46:36 +00003089
Chris Lattner3d512132010-12-13 06:25:44 +00003090 // Insert the call now...
3091 SmallVector<Value*, 8> Args(II->op_begin(), II->op_end()-3);
Devang Patel1aa89a22011-05-19 00:09:21 +00003092 Builder.SetInsertPoint(BI);
3093 CallInst *CI = Builder.CreateCall(II->getCalledValue(),
Jay Foada3efbb12011-07-15 08:37:34 +00003094 Args, II->getName());
Chris Lattner3d512132010-12-13 06:25:44 +00003095 CI->setCallingConv(II->getCallingConv());
3096 CI->setAttributes(II->getAttributes());
3097 // If the invoke produced a value, the call does now instead.
3098 II->replaceAllUsesWith(CI);
3099 delete II;
3100 Changed = true;
3101 }
3102 }
3103 }
Andrew Trick6b014382012-08-29 21:46:36 +00003104
Chris Lattner3d512132010-12-13 06:25:44 +00003105 // If this block is now dead, remove it.
3106 if (pred_begin(BB) == pred_end(BB) &&
3107 BB != &BB->getParent()->getEntryBlock()) {
3108 // We know there are no successors, so just nuke the block.
3109 BB->eraseFromParent();
3110 return true;
3111 }
3112
3113 return Changed;
3114}
3115
Benjamin Kramer56442df2011-02-02 15:56:22 +00003116/// TurnSwitchRangeIntoICmp - Turns a switch with that contains only a
3117/// integer range comparison into a sub, an icmp and a branch.
Devang Patel007349d2011-05-18 20:35:38 +00003118static bool TurnSwitchRangeIntoICmp(SwitchInst *SI, IRBuilder<> &Builder) {
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003119 assert(SI->getNumCases() > 1 && "Degenerate switch?");
Benjamin Kramer56442df2011-02-02 15:56:22 +00003120
Benjamin Kramer042b27f2011-02-03 22:51:41 +00003121 // Make sure all cases point to the same destination and gather the values.
3122 SmallVector<ConstantInt *, 16> Cases;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003123 SwitchInst::CaseIt I = SI->case_begin();
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003124 Cases.push_back(I.getCaseValue());
3125 SwitchInst::CaseIt PrevI = I++;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003126 for (SwitchInst::CaseIt E = SI->case_end(); I != E; PrevI = I++) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003127 if (PrevI.getCaseSuccessor() != I.getCaseSuccessor())
Benjamin Kramer042b27f2011-02-03 22:51:41 +00003128 return false;
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003129 Cases.push_back(I.getCaseValue());
Benjamin Kramer042b27f2011-02-03 22:51:41 +00003130 }
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003131 assert(Cases.size() == SI->getNumCases() && "Not all cases gathered");
Benjamin Kramer042b27f2011-02-03 22:51:41 +00003132
3133 // Sort the case values, then check if they form a range we can transform.
3134 array_pod_sort(Cases.begin(), Cases.end(), ConstantIntSortPredicate);
3135 for (unsigned I = 1, E = Cases.size(); I != E; ++I) {
3136 if (Cases[I-1]->getValue() != Cases[I]->getValue()+1)
3137 return false;
3138 }
3139
3140 Constant *Offset = ConstantExpr::getNeg(Cases.back());
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003141 Constant *NumCases = ConstantInt::get(Offset->getType(), SI->getNumCases());
Benjamin Kramer56442df2011-02-02 15:56:22 +00003142
Benjamin Kramer33828bc2011-02-07 22:37:28 +00003143 Value *Sub = SI->getCondition();
3144 if (!Offset->isNullValue())
Devang Patel1f5812b2011-05-19 00:13:33 +00003145 Sub = Builder.CreateAdd(Sub, Offset, Sub->getName()+".off");
Hans Wennborga121e242013-04-16 08:35:36 +00003146 Value *Cmp;
3147 // If NumCases overflowed, then all possible values jump to the successor.
3148 if (NumCases->isNullValue() && SI->getNumCases() != 0)
3149 Cmp = ConstantInt::getTrue(SI->getContext());
3150 else
3151 Cmp = Builder.CreateICmpULT(Sub, NumCases, "switch");
Manman Ren222d6192012-09-18 00:47:33 +00003152 BranchInst *NewBI = Builder.CreateCondBr(
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003153 Cmp, SI->case_begin().getCaseSuccessor(), SI->getDefaultDest());
Benjamin Kramer56442df2011-02-02 15:56:22 +00003154
Manman Ren222d6192012-09-18 00:47:33 +00003155 // Update weight for the newly-created conditional branch.
3156 SmallVector<uint64_t, 8> Weights;
3157 bool HasWeights = HasBranchWeights(SI);
3158 if (HasWeights) {
3159 GetBranchWeights(SI, Weights);
3160 if (Weights.size() == 1 + SI->getNumCases()) {
3161 // Combine all weights for the cases to be the true weight of NewBI.
3162 // We assume that the sum of all weights for a Terminator can fit into 32
3163 // bits.
3164 uint32_t NewTrueWeight = 0;
3165 for (unsigned I = 1, E = Weights.size(); I != E; ++I)
3166 NewTrueWeight += (uint32_t)Weights[I];
3167 NewBI->setMetadata(LLVMContext::MD_prof,
3168 MDBuilder(SI->getContext()).
3169 createBranchWeights(NewTrueWeight,
3170 (uint32_t)Weights[0]));
3171 }
3172 }
3173
Benjamin Kramer56442df2011-02-02 15:56:22 +00003174 // Prune obsolete incoming values off the successor's PHI nodes.
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003175 for (BasicBlock::iterator BBI = SI->case_begin().getCaseSuccessor()->begin();
Benjamin Kramer56442df2011-02-02 15:56:22 +00003176 isa<PHINode>(BBI); ++BBI) {
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003177 for (unsigned I = 0, E = SI->getNumCases()-1; I != E; ++I)
Benjamin Kramer56442df2011-02-02 15:56:22 +00003178 cast<PHINode>(BBI)->removeIncomingValue(SI->getParent());
3179 }
3180 SI->eraseFromParent();
3181
3182 return true;
3183}
Chris Lattner3d512132010-12-13 06:25:44 +00003184
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003185/// EliminateDeadSwitchCases - Compute masked bits for the condition of a switch
3186/// and use it to remove dead cases.
3187static bool EliminateDeadSwitchCases(SwitchInst *SI) {
3188 Value *Cond = SI->getCondition();
Matt Arsenault4598bd52013-09-06 00:37:24 +00003189 unsigned Bits = Cond->getType()->getIntegerBitWidth();
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003190 APInt KnownZero(Bits, 0), KnownOne(Bits, 0);
Rafael Espindola26c8dcc2012-04-04 12:51:34 +00003191 ComputeMaskedBits(Cond, KnownZero, KnownOne);
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003192
3193 // Gather dead cases.
3194 SmallVector<ConstantInt*, 8> DeadCases;
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003195 for (SwitchInst::CaseIt I = SI->case_begin(), E = SI->case_end(); I != E; ++I) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003196 if ((I.getCaseValue()->getValue() & KnownZero) != 0 ||
3197 (I.getCaseValue()->getValue() & KnownOne) != KnownOne) {
3198 DeadCases.push_back(I.getCaseValue());
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003199 DEBUG(dbgs() << "SimplifyCFG: switch case '"
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003200 << I.getCaseValue() << "' is dead.\n");
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003201 }
3202 }
3203
Manman Ren222d6192012-09-18 00:47:33 +00003204 SmallVector<uint64_t, 8> Weights;
3205 bool HasWeight = HasBranchWeights(SI);
3206 if (HasWeight) {
3207 GetBranchWeights(SI, Weights);
3208 HasWeight = (Weights.size() == 1 + SI->getNumCases());
3209 }
3210
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003211 // Remove dead cases from the switch.
3212 for (unsigned I = 0, E = DeadCases.size(); I != E; ++I) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003213 SwitchInst::CaseIt Case = SI->findCaseValue(DeadCases[I]);
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003214 assert(Case != SI->case_default() &&
Stepan Dyatkovskiy24473122012-02-01 07:49:51 +00003215 "Case was not found. Probably mistake in DeadCases forming.");
Manman Ren222d6192012-09-18 00:47:33 +00003216 if (HasWeight) {
3217 std::swap(Weights[Case.getCaseIndex()+1], Weights.back());
3218 Weights.pop_back();
3219 }
3220
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003221 // Prune unused values from PHI nodes.
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003222 Case.getCaseSuccessor()->removePredecessor(SI->getParent());
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003223 SI->removeCase(Case);
3224 }
Manman Ren222d6192012-09-18 00:47:33 +00003225 if (HasWeight) {
3226 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
3227 SI->setMetadata(LLVMContext::MD_prof,
3228 MDBuilder(SI->getParent()->getContext()).
3229 createBranchWeights(MDWeights));
3230 }
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003231
3232 return !DeadCases.empty();
3233}
3234
Hans Wennborg448da512011-06-18 10:28:47 +00003235/// FindPHIForConditionForwarding - If BB would be eligible for simplification
3236/// by TryToSimplifyUncondBranchFromEmptyBlock (i.e. it is empty and terminated
3237/// by an unconditional branch), look at the phi node for BB in the successor
3238/// block and see if the incoming value is equal to CaseValue. If so, return
3239/// the phi node, and set PhiIndex to BB's index in the phi node.
3240static PHINode *FindPHIForConditionForwarding(ConstantInt *CaseValue,
3241 BasicBlock *BB,
3242 int *PhiIndex) {
3243 if (BB->getFirstNonPHIOrDbg() != BB->getTerminator())
3244 return NULL; // BB must be empty to be a candidate for simplification.
3245 if (!BB->getSinglePredecessor())
3246 return NULL; // BB must be dominated by the switch.
3247
3248 BranchInst *Branch = dyn_cast<BranchInst>(BB->getTerminator());
3249 if (!Branch || !Branch->isUnconditional())
3250 return NULL; // Terminator must be unconditional branch.
3251
3252 BasicBlock *Succ = Branch->getSuccessor(0);
3253
3254 BasicBlock::iterator I = Succ->begin();
3255 while (PHINode *PHI = dyn_cast<PHINode>(I++)) {
3256 int Idx = PHI->getBasicBlockIndex(BB);
3257 assert(Idx >= 0 && "PHI has no entry for predecessor?");
3258
3259 Value *InValue = PHI->getIncomingValue(Idx);
3260 if (InValue != CaseValue) continue;
3261
3262 *PhiIndex = Idx;
3263 return PHI;
3264 }
3265
3266 return NULL;
3267}
3268
3269/// ForwardSwitchConditionToPHI - Try to forward the condition of a switch
3270/// instruction to a phi node dominated by the switch, if that would mean that
3271/// some of the destination blocks of the switch can be folded away.
3272/// Returns true if a change is made.
3273static bool ForwardSwitchConditionToPHI(SwitchInst *SI) {
3274 typedef DenseMap<PHINode*, SmallVector<int,4> > ForwardingNodesMap;
3275 ForwardingNodesMap ForwardingNodes;
3276
Stepan Dyatkovskiy3d3abe02012-03-11 06:09:17 +00003277 for (SwitchInst::CaseIt I = SI->case_begin(), E = SI->case_end(); I != E; ++I) {
Stepan Dyatkovskiyc10fa6c2012-03-08 07:06:20 +00003278 ConstantInt *CaseValue = I.getCaseValue();
3279 BasicBlock *CaseDest = I.getCaseSuccessor();
Hans Wennborg448da512011-06-18 10:28:47 +00003280
3281 int PhiIndex;
3282 PHINode *PHI = FindPHIForConditionForwarding(CaseValue, CaseDest,
3283 &PhiIndex);
3284 if (!PHI) continue;
3285
3286 ForwardingNodes[PHI].push_back(PhiIndex);
3287 }
3288
3289 bool Changed = false;
3290
3291 for (ForwardingNodesMap::iterator I = ForwardingNodes.begin(),
3292 E = ForwardingNodes.end(); I != E; ++I) {
3293 PHINode *Phi = I->first;
Craig Toppera0ec3f92013-07-14 04:42:23 +00003294 SmallVectorImpl<int> &Indexes = I->second;
Hans Wennborg448da512011-06-18 10:28:47 +00003295
3296 if (Indexes.size() < 2) continue;
3297
3298 for (size_t I = 0, E = Indexes.size(); I != E; ++I)
3299 Phi->setIncomingValue(Indexes[I], SI->getCondition());
3300 Changed = true;
3301 }
3302
3303 return Changed;
3304}
3305
Hans Wennborg486270a2012-09-06 09:43:28 +00003306/// ValidLookupTableConstant - Return true if the backend will be able to handle
3307/// initializing an array of constants like C.
Hans Wennborgbf015822012-09-07 08:22:57 +00003308static bool ValidLookupTableConstant(Constant *C) {
Hans Wennborg486270a2012-09-06 09:43:28 +00003309 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
3310 return CE->isGEPWithNoNotionalOverIndexing();
3311
3312 return isa<ConstantFP>(C) ||
3313 isa<ConstantInt>(C) ||
3314 isa<ConstantPointerNull>(C) ||
3315 isa<GlobalValue>(C) ||
3316 isa<UndefValue>(C);
3317}
3318
Hans Wennborgef026f12012-10-31 15:14:39 +00003319/// LookupConstant - If V is a Constant, return it. Otherwise, try to look up
Hans Wennborgdaf4cfc2012-10-31 15:31:09 +00003320/// its constant value in ConstantPool, returning 0 if it's not there.
Hans Wennborgef026f12012-10-31 15:14:39 +00003321static Constant *LookupConstant(Value *V,
3322 const SmallDenseMap<Value*, Constant*>& ConstantPool) {
3323 if (Constant *C = dyn_cast<Constant>(V))
3324 return C;
3325 return ConstantPool.lookup(V);
3326}
3327
Hans Wennborge03d9e42012-10-31 13:42:45 +00003328/// ConstantFold - Try to fold instruction I into a constant. This works for
3329/// simple instructions such as binary operations where both operands are
3330/// constant or can be replaced by constants from the ConstantPool. Returns the
Hans Wennborgdaf4cfc2012-10-31 15:31:09 +00003331/// resulting constant on success, 0 otherwise.
Benjamin Kramerf6814372013-11-12 12:24:36 +00003332static Constant *
3333ConstantFold(Instruction *I,
3334 const SmallDenseMap<Value *, Constant *> &ConstantPool,
3335 const DataLayout *DL) {
Hans Wennborge03d9e42012-10-31 13:42:45 +00003336 if (SelectInst *Select = dyn_cast<SelectInst>(I)) {
Hans Wennborgef026f12012-10-31 15:14:39 +00003337 Constant *A = LookupConstant(Select->getCondition(), ConstantPool);
3338 if (!A)
3339 return 0;
3340 if (A->isAllOnesValue())
3341 return LookupConstant(Select->getTrueValue(), ConstantPool);
3342 if (A->isNullValue())
3343 return LookupConstant(Select->getFalseValue(), ConstantPool);
Hans Wennborgdaf4cfc2012-10-31 15:31:09 +00003344 return 0;
Hans Wennborge03d9e42012-10-31 13:42:45 +00003345 }
3346
Benjamin Kramerf6814372013-11-12 12:24:36 +00003347 SmallVector<Constant *, 4> COps;
3348 for (unsigned N = 0, E = I->getNumOperands(); N != E; ++N) {
3349 if (Constant *A = LookupConstant(I->getOperand(N), ConstantPool))
3350 COps.push_back(A);
3351 else
Hans Wennborgef026f12012-10-31 15:14:39 +00003352 return 0;
Hans Wennborge03d9e42012-10-31 13:42:45 +00003353 }
3354
Benjamin Kramerf6814372013-11-12 12:24:36 +00003355 if (CmpInst *Cmp = dyn_cast<CmpInst>(I))
3356 return ConstantFoldCompareInstOperands(Cmp->getPredicate(), COps[0],
3357 COps[1], DL);
3358
3359 return ConstantFoldInstOperands(I->getOpcode(), I->getType(), COps, DL);
Hans Wennborge03d9e42012-10-31 13:42:45 +00003360}
3361
3362/// GetCaseResults - Try to determine the resulting constant values in phi nodes
3363/// at the common destination basic block, *CommonDest, for one of the case
Hans Wennborgdaf4cfc2012-10-31 15:31:09 +00003364/// destionations CaseDest corresponding to value CaseVal (0 for the default
Hans Wennborge03d9e42012-10-31 13:42:45 +00003365/// case), of a switch instruction SI.
Craig Toppera0ec3f92013-07-14 04:42:23 +00003366static bool
3367GetCaseResults(SwitchInst *SI,
3368 ConstantInt *CaseVal,
3369 BasicBlock *CaseDest,
3370 BasicBlock **CommonDest,
Benjamin Kramerf6814372013-11-12 12:24:36 +00003371 SmallVectorImpl<std::pair<PHINode *, Constant *> > &Res,
3372 const DataLayout *DL) {
Hans Wennborg486270a2012-09-06 09:43:28 +00003373 // The block from which we enter the common destination.
3374 BasicBlock *Pred = SI->getParent();
3375
Hans Wennborge03d9e42012-10-31 13:42:45 +00003376 // If CaseDest is empty except for some side-effect free instructions through
3377 // which we can constant-propagate the CaseVal, continue to its successor.
3378 SmallDenseMap<Value*, Constant*> ConstantPool;
3379 ConstantPool.insert(std::make_pair(SI->getCondition(), CaseVal));
3380 for (BasicBlock::iterator I = CaseDest->begin(), E = CaseDest->end(); I != E;
3381 ++I) {
3382 if (TerminatorInst *T = dyn_cast<TerminatorInst>(I)) {
3383 // If the terminator is a simple branch, continue to the next block.
3384 if (T->getNumSuccessors() != 1)
3385 return false;
3386 Pred = CaseDest;
3387 CaseDest = T->getSuccessor(0);
3388 } else if (isa<DbgInfoIntrinsic>(I)) {
3389 // Skip debug intrinsic.
3390 continue;
Benjamin Kramerf6814372013-11-12 12:24:36 +00003391 } else if (Constant *C = ConstantFold(I, ConstantPool, DL)) {
Hans Wennborge03d9e42012-10-31 13:42:45 +00003392 // Instruction is side-effect free and constant.
3393 ConstantPool.insert(std::make_pair(I, C));
3394 } else {
3395 break;
3396 }
Hans Wennborg486270a2012-09-06 09:43:28 +00003397 }
3398
3399 // If we did not have a CommonDest before, use the current one.
3400 if (!*CommonDest)
3401 *CommonDest = CaseDest;
3402 // If the destination isn't the common one, abort.
3403 if (CaseDest != *CommonDest)
3404 return false;
3405
3406 // Get the values for this case from phi nodes in the destination block.
3407 BasicBlock::iterator I = (*CommonDest)->begin();
3408 while (PHINode *PHI = dyn_cast<PHINode>(I++)) {
3409 int Idx = PHI->getBasicBlockIndex(Pred);
3410 if (Idx == -1)
3411 continue;
3412
Hans Wennborgef026f12012-10-31 15:14:39 +00003413 Constant *ConstVal = LookupConstant(PHI->getIncomingValue(Idx),
3414 ConstantPool);
Hans Wennborge03d9e42012-10-31 13:42:45 +00003415 if (!ConstVal)
Hans Wennborg486270a2012-09-06 09:43:28 +00003416 return false;
3417
Hans Wennborge03d9e42012-10-31 13:42:45 +00003418 // Note: If the constant comes from constant-propagating the case value
3419 // through the CaseDest basic block, it will be safe to remove the
3420 // instructions in that block. They cannot be used (except in the phi nodes
3421 // we visit) outside CaseDest, because that block does not dominate its
3422 // successor. If it did, we would not be in this phi node.
3423
Hans Wennborg486270a2012-09-06 09:43:28 +00003424 // Be conservative about which kinds of constants we support.
3425 if (!ValidLookupTableConstant(ConstVal))
3426 return false;
3427
3428 Res.push_back(std::make_pair(PHI, ConstVal));
3429 }
3430
3431 return true;
3432}
3433
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003434namespace {
3435 /// SwitchLookupTable - This class represents a lookup table that can be used
3436 /// to replace a switch.
3437 class SwitchLookupTable {
3438 public:
3439 /// SwitchLookupTable - Create a lookup table to use as a switch replacement
3440 /// with the contents of Values, using DefaultValue to fill any holes in the
3441 /// table.
3442 SwitchLookupTable(Module &M,
3443 uint64_t TableSize,
3444 ConstantInt *Offset,
Craig Toppera0ec3f92013-07-14 04:42:23 +00003445 const SmallVectorImpl<std::pair<ConstantInt*, Constant*> >& Values,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003446 Constant *DefaultValue,
Micah Villmow3574eca2012-10-08 16:38:25 +00003447 const DataLayout *TD);
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003448
3449 /// BuildLookup - Build instructions with Builder to retrieve the value at
3450 /// the position given by Index in the lookup table.
3451 Value *BuildLookup(Value *Index, IRBuilder<> &Builder);
3452
Hans Wennborgd72271c2012-09-26 09:44:49 +00003453 /// WouldFitInRegister - Return true if a table with TableSize elements of
3454 /// type ElementType would fit in a target-legal register.
Micah Villmow3574eca2012-10-08 16:38:25 +00003455 static bool WouldFitInRegister(const DataLayout *TD,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003456 uint64_t TableSize,
3457 const Type *ElementType);
3458
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003459 private:
3460 // Depending on the contents of the table, it can be represented in
3461 // different ways.
3462 enum {
3463 // For tables where each element contains the same value, we just have to
3464 // store that single value and return it for each lookup.
3465 SingleValueKind,
3466
Hans Wennborgd72271c2012-09-26 09:44:49 +00003467 // For small tables with integer elements, we can pack them into a bitmap
3468 // that fits into a target-legal register. Values are retrieved by
3469 // shift and mask operations.
3470 BitMapKind,
3471
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003472 // The table is stored as an array of values. Values are retrieved by load
3473 // instructions from the table.
3474 ArrayKind
3475 } Kind;
3476
3477 // For SingleValueKind, this is the single value.
3478 Constant *SingleValue;
3479
Hans Wennborgd72271c2012-09-26 09:44:49 +00003480 // For BitMapKind, this is the bitmap.
3481 ConstantInt *BitMap;
3482 IntegerType *BitMapElementTy;
3483
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003484 // For ArrayKind, this is the array.
3485 GlobalVariable *Array;
3486 };
3487}
3488
3489SwitchLookupTable::SwitchLookupTable(Module &M,
3490 uint64_t TableSize,
3491 ConstantInt *Offset,
Craig Toppera0ec3f92013-07-14 04:42:23 +00003492 const SmallVectorImpl<std::pair<ConstantInt*, Constant*> >& Values,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003493 Constant *DefaultValue,
Duncan Sands70465612013-01-23 09:09:50 +00003494 const DataLayout *TD)
3495 : SingleValue(0), BitMap(0), BitMapElementTy(0), Array(0) {
Hans Wennborg565df792012-09-26 11:07:37 +00003496 assert(Values.size() && "Can't build lookup table without values!");
3497 assert(TableSize >= Values.size() && "Can't fit values in table!");
Hans Wennborg486270a2012-09-06 09:43:28 +00003498
3499 // If all values in the table are equal, this is that value.
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003500 SingleValue = Values.begin()->second;
Hans Wennborg486270a2012-09-06 09:43:28 +00003501
3502 // Build up the table contents.
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003503 SmallVector<Constant*, 64> TableContents(TableSize);
3504 for (size_t I = 0, E = Values.size(); I != E; ++I) {
3505 ConstantInt *CaseVal = Values[I].first;
3506 Constant *CaseRes = Values[I].second;
3507 assert(CaseRes->getType() == DefaultValue->getType());
Hans Wennborg486270a2012-09-06 09:43:28 +00003508
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003509 uint64_t Idx = (CaseVal->getValue() - Offset->getValue())
3510 .getLimitedValue();
Hans Wennborg486270a2012-09-06 09:43:28 +00003511 TableContents[Idx] = CaseRes;
3512
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003513 if (CaseRes != SingleValue)
Hans Wennborgef026f12012-10-31 15:14:39 +00003514 SingleValue = 0;
Hans Wennborg486270a2012-09-06 09:43:28 +00003515 }
3516
3517 // Fill in any holes in the table with the default result.
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003518 if (Values.size() < TableSize) {
3519 for (uint64_t I = 0; I < TableSize; ++I) {
3520 if (!TableContents[I])
3521 TableContents[I] = DefaultValue;
Hans Wennborg486270a2012-09-06 09:43:28 +00003522 }
3523
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003524 if (DefaultValue != SingleValue)
Hans Wennborgef026f12012-10-31 15:14:39 +00003525 SingleValue = 0;
Hans Wennborg486270a2012-09-06 09:43:28 +00003526 }
3527
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003528 // If each element in the table contains the same value, we only need to store
3529 // that single value.
3530 if (SingleValue) {
3531 Kind = SingleValueKind;
3532 return;
Hans Wennborg486270a2012-09-06 09:43:28 +00003533 }
3534
Hans Wennborgd72271c2012-09-26 09:44:49 +00003535 // If the type is integer and the table fits in a register, build a bitmap.
3536 if (WouldFitInRegister(TD, TableSize, DefaultValue->getType())) {
3537 IntegerType *IT = cast<IntegerType>(DefaultValue->getType());
3538 APInt TableInt(TableSize * IT->getBitWidth(), 0);
3539 for (uint64_t I = TableSize; I > 0; --I) {
3540 TableInt <<= IT->getBitWidth();
Benjamin Kramer64f27e72012-10-01 11:31:48 +00003541 // Insert values into the bitmap. Undef values are set to zero.
3542 if (!isa<UndefValue>(TableContents[I - 1])) {
3543 ConstantInt *Val = cast<ConstantInt>(TableContents[I - 1]);
3544 TableInt |= Val->getValue().zext(TableInt.getBitWidth());
3545 }
Hans Wennborgd72271c2012-09-26 09:44:49 +00003546 }
3547 BitMap = ConstantInt::get(M.getContext(), TableInt);
3548 BitMapElementTy = IT;
3549 Kind = BitMapKind;
3550 ++NumBitMaps;
3551 return;
3552 }
3553
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003554 // Store the table in an array.
3555 ArrayType *ArrayTy = ArrayType::get(DefaultValue->getType(), TableSize);
Hans Wennborg486270a2012-09-06 09:43:28 +00003556 Constant *Initializer = ConstantArray::get(ArrayTy, TableContents);
3557
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003558 Array = new GlobalVariable(M, ArrayTy, /*constant=*/ true,
3559 GlobalVariable::PrivateLinkage,
3560 Initializer,
3561 "switch.table");
3562 Array->setUnnamedAddr(true);
3563 Kind = ArrayKind;
3564}
3565
3566Value *SwitchLookupTable::BuildLookup(Value *Index, IRBuilder<> &Builder) {
3567 switch (Kind) {
3568 case SingleValueKind:
3569 return SingleValue;
Hans Wennborgd72271c2012-09-26 09:44:49 +00003570 case BitMapKind: {
3571 // Type of the bitmap (e.g. i59).
3572 IntegerType *MapTy = BitMap->getType();
3573
3574 // Cast Index to the same type as the bitmap.
3575 // Note: The Index is <= the number of elements in the table, so
3576 // truncating it to the width of the bitmask is safe.
Hans Wennborg50b7d702012-09-26 14:01:53 +00003577 Value *ShiftAmt = Builder.CreateZExtOrTrunc(Index, MapTy, "switch.cast");
Hans Wennborgd72271c2012-09-26 09:44:49 +00003578
3579 // Multiply the shift amount by the element width.
3580 ShiftAmt = Builder.CreateMul(ShiftAmt,
3581 ConstantInt::get(MapTy, BitMapElementTy->getBitWidth()),
3582 "switch.shiftamt");
3583
3584 // Shift down.
3585 Value *DownShifted = Builder.CreateLShr(BitMap, ShiftAmt,
3586 "switch.downshift");
3587 // Mask off.
3588 return Builder.CreateTrunc(DownShifted, BitMapElementTy,
3589 "switch.masked");
3590 }
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003591 case ArrayKind: {
3592 Value *GEPIndices[] = { Builder.getInt32(0), Index };
3593 Value *GEP = Builder.CreateInBoundsGEP(Array, GEPIndices,
3594 "switch.gep");
3595 return Builder.CreateLoad(GEP, "switch.load");
3596 }
3597 }
3598 llvm_unreachable("Unknown lookup table kind!");
3599}
3600
Micah Villmow3574eca2012-10-08 16:38:25 +00003601bool SwitchLookupTable::WouldFitInRegister(const DataLayout *TD,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003602 uint64_t TableSize,
3603 const Type *ElementType) {
3604 if (!TD)
3605 return false;
3606 const IntegerType *IT = dyn_cast<IntegerType>(ElementType);
3607 if (!IT)
3608 return false;
3609 // FIXME: If the type is wider than it needs to be, e.g. i8 but all values
3610 // are <= 15, we could try to narrow the type.
Benjamin Kramer465251a2012-09-27 18:29:58 +00003611
3612 // Avoid overflow, fitsInLegalInteger uses unsigned int for the width.
3613 if (TableSize >= UINT_MAX/IT->getBitWidth())
3614 return false;
Hans Wennborgd72271c2012-09-26 09:44:49 +00003615 return TD->fitsInLegalInteger(TableSize * IT->getBitWidth());
3616}
3617
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003618/// ShouldBuildLookupTable - Determine whether a lookup table should be built
Hans Wennborgdeb2e9c2013-06-04 11:22:30 +00003619/// for this switch, based on the number of cases, size of the table and the
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003620/// types of the results.
3621static bool ShouldBuildLookupTable(SwitchInst *SI,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003622 uint64_t TableSize,
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003623 const TargetTransformInfo &TTI,
Micah Villmow3574eca2012-10-08 16:38:25 +00003624 const DataLayout *TD,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003625 const SmallDenseMap<PHINode*, Type*>& ResultTypes) {
Hans Wennborg565df792012-09-26 11:07:37 +00003626 if (SI->getNumCases() > TableSize || TableSize >= UINT64_MAX / 10)
3627 return false; // TableSize overflowed, or mul below might overflow.
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003628
Chandler Carruth06ec7212012-11-30 09:26:25 +00003629 bool AllTablesFitInRegister = true;
Evan Cheng40eef5f2012-11-30 02:02:42 +00003630 bool HasIllegalType = false;
Hans Wennborgd72271c2012-09-26 09:44:49 +00003631 for (SmallDenseMap<PHINode*, Type*>::const_iterator I = ResultTypes.begin(),
3632 E = ResultTypes.end(); I != E; ++I) {
Evan Cheng40eef5f2012-11-30 02:02:42 +00003633 Type *Ty = I->second;
Chandler Carruth66ea2f92012-11-30 09:34:29 +00003634
3635 // Saturate this flag to true.
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003636 HasIllegalType = HasIllegalType || !TTI.isTypeLegal(Ty);
Chandler Carruth66ea2f92012-11-30 09:34:29 +00003637
3638 // Saturate this flag to false.
3639 AllTablesFitInRegister = AllTablesFitInRegister &&
3640 SwitchLookupTable::WouldFitInRegister(TD, TableSize, Ty);
3641
3642 // If both flags saturate, we're done. NOTE: This *only* works with
3643 // saturating flags, and all flags have to saturate first due to the
3644 // non-deterministic behavior of iterating over a dense map.
3645 if (HasIllegalType && !AllTablesFitInRegister)
Evan Cheng40eef5f2012-11-30 02:02:42 +00003646 break;
Hans Wennborgd72271c2012-09-26 09:44:49 +00003647 }
Evan Cheng40eef5f2012-11-30 02:02:42 +00003648
Chandler Carruth06ec7212012-11-30 09:26:25 +00003649 // If each table would fit in a register, we should build it anyway.
3650 if (AllTablesFitInRegister)
3651 return true;
3652
3653 // Don't build a table that doesn't fit in-register if it has illegal types.
3654 if (HasIllegalType)
3655 return false;
3656
3657 // The table density should be at least 40%. This is the same criterion as for
3658 // jump tables, see SelectionDAGBuilder::handleJTSwitchCase.
3659 // FIXME: Find the best cut-off.
3660 return SI->getNumCases() * 10 >= TableSize * 4;
Hans Wennborg486270a2012-09-06 09:43:28 +00003661}
3662
3663/// SwitchToLookupTable - If the switch is only used to initialize one or more
3664/// phi nodes in a common successor block with different constant values,
3665/// replace the switch with lookup tables.
3666static bool SwitchToLookupTable(SwitchInst *SI,
Hans Wennborgd72271c2012-09-26 09:44:49 +00003667 IRBuilder<> &Builder,
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003668 const TargetTransformInfo &TTI,
3669 const DataLayout* TD) {
Hans Wennborg486270a2012-09-06 09:43:28 +00003670 assert(SI->getNumCases() > 1 && "Degenerate switch?");
Hans Wennborg04d7d132012-10-30 11:23:25 +00003671
Hans Wennborgb0319962012-11-07 21:35:12 +00003672 // Only build lookup table when we have a target that supports it.
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003673 if (!TTI.shouldBuildLookupTables())
Hans Wennborg04d7d132012-10-30 11:23:25 +00003674 return false;
3675
Hans Wennborg486270a2012-09-06 09:43:28 +00003676 // FIXME: If the switch is too sparse for a lookup table, perhaps we could
3677 // split off a dense part and build a lookup table for that.
3678
Hans Wennborg486270a2012-09-06 09:43:28 +00003679 // FIXME: This creates arrays of GEPs to constant strings, which means each
3680 // GEP needs a runtime relocation in PIC code. We should just build one big
3681 // string and lookup indices into that.
3682
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003683 // Ignore the switch if the number of cases is too small.
Hans Wennborg486270a2012-09-06 09:43:28 +00003684 // This is similar to the check when building jump tables in
3685 // SelectionDAGBuilder::handleJTSwitchCase.
3686 // FIXME: Determine the best cut-off.
3687 if (SI->getNumCases() < 4)
3688 return false;
3689
3690 // Figure out the corresponding result for each case value and phi node in the
3691 // common destination, as well as the the min and max case values.
3692 assert(SI->case_begin() != SI->case_end());
3693 SwitchInst::CaseIt CI = SI->case_begin();
3694 ConstantInt *MinCaseVal = CI.getCaseValue();
3695 ConstantInt *MaxCaseVal = CI.getCaseValue();
3696
Hans Wennborgef026f12012-10-31 15:14:39 +00003697 BasicBlock *CommonDest = 0;
Hans Wennborg2f9fc762012-09-10 07:44:22 +00003698 typedef SmallVector<std::pair<ConstantInt*, Constant*>, 4> ResultListTy;
Hans Wennborg486270a2012-09-06 09:43:28 +00003699 SmallDenseMap<PHINode*, ResultListTy> ResultLists;
3700 SmallDenseMap<PHINode*, Constant*> DefaultResults;
3701 SmallDenseMap<PHINode*, Type*> ResultTypes;
3702 SmallVector<PHINode*, 4> PHIs;
3703
3704 for (SwitchInst::CaseIt E = SI->case_end(); CI != E; ++CI) {
3705 ConstantInt *CaseVal = CI.getCaseValue();
3706 if (CaseVal->getValue().slt(MinCaseVal->getValue()))
3707 MinCaseVal = CaseVal;
3708 if (CaseVal->getValue().sgt(MaxCaseVal->getValue()))
3709 MaxCaseVal = CaseVal;
3710
3711 // Resulting value at phi nodes for this case value.
3712 typedef SmallVector<std::pair<PHINode*, Constant*>, 4> ResultsTy;
3713 ResultsTy Results;
Hans Wennborge03d9e42012-10-31 13:42:45 +00003714 if (!GetCaseResults(SI, CaseVal, CI.getCaseSuccessor(), &CommonDest,
Benjamin Kramerf6814372013-11-12 12:24:36 +00003715 Results, TD))
Hans Wennborg486270a2012-09-06 09:43:28 +00003716 return false;
3717
3718 // Append the result from this case to the list for each phi.
3719 for (ResultsTy::iterator I = Results.begin(), E = Results.end(); I!=E; ++I) {
3720 if (!ResultLists.count(I->first))
3721 PHIs.push_back(I->first);
3722 ResultLists[I->first].push_back(std::make_pair(CaseVal, I->second));
3723 }
3724 }
3725
3726 // Get the resulting values for the default case.
Hans Wennborg2f9fc762012-09-10 07:44:22 +00003727 SmallVector<std::pair<PHINode*, Constant*>, 4> DefaultResultsList;
Hans Wennborgef026f12012-10-31 15:14:39 +00003728 if (!GetCaseResults(SI, 0, SI->getDefaultDest(), &CommonDest,
Benjamin Kramerf6814372013-11-12 12:24:36 +00003729 DefaultResultsList, TD))
Hans Wennborg2f9fc762012-09-10 07:44:22 +00003730 return false;
3731 for (size_t I = 0, E = DefaultResultsList.size(); I != E; ++I) {
3732 PHINode *PHI = DefaultResultsList[I].first;
3733 Constant *Result = DefaultResultsList[I].second;
3734 DefaultResults[PHI] = Result;
3735 ResultTypes[PHI] = Result->getType();
Hans Wennborg486270a2012-09-06 09:43:28 +00003736 }
3737
3738 APInt RangeSpread = MaxCaseVal->getValue() - MinCaseVal->getValue();
Hans Wennborg486270a2012-09-06 09:43:28 +00003739 uint64_t TableSize = RangeSpread.getLimitedValue() + 1;
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003740 if (!ShouldBuildLookupTable(SI, TableSize, TTI, TD, ResultTypes))
Hans Wennborg486270a2012-09-06 09:43:28 +00003741 return false;
3742
Hans Wennborg486270a2012-09-06 09:43:28 +00003743 // Create the BB that does the lookups.
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003744 Module &Mod = *CommonDest->getParent()->getParent();
Hans Wennborg486270a2012-09-06 09:43:28 +00003745 BasicBlock *LookupBB = BasicBlock::Create(Mod.getContext(),
3746 "switch.lookup",
3747 CommonDest->getParent(),
3748 CommonDest);
3749
Michael Gottesman0b5fad62013-10-20 07:04:37 +00003750 // Compute the table index value.
Hans Wennborg486270a2012-09-06 09:43:28 +00003751 Builder.SetInsertPoint(SI);
3752 Value *TableIndex = Builder.CreateSub(SI->getCondition(), MinCaseVal,
3753 "switch.tableidx");
Michael Gottesman0b5fad62013-10-20 07:04:37 +00003754
3755 // Compute the maximum table size representable by the integer type we are
3756 // switching upon.
Michael Gottesman6701bb72013-10-21 05:20:11 +00003757 unsigned CaseSize = MinCaseVal->getType()->getPrimitiveSizeInBits();
3758 uint64_t MaxTableSize = CaseSize > 63? UINT64_MAX : 1ULL << CaseSize;
Michael Gottesman0b5fad62013-10-20 07:04:37 +00003759 assert(MaxTableSize >= TableSize &&
3760 "It is impossible for a switch to have more entries than the max "
3761 "representable value of its input integer type's size.");
3762
Michael Gottesman6701bb72013-10-21 05:20:11 +00003763 // If we have a fully covered lookup table, unconditionally branch to the
3764 // lookup table BB. Otherwise, check if the condition value is within the case
3765 // range. If it is so, branch to the new BB. Otherwise branch to SI's default
3766 // destination.
Michael Gottesman0b5fad62013-10-20 07:04:37 +00003767 const bool GeneratingCoveredLookupTable = MaxTableSize == TableSize;
3768 if (GeneratingCoveredLookupTable) {
3769 Builder.CreateBr(LookupBB);
Michael Gottesman6701bb72013-10-21 05:20:11 +00003770 SI->getDefaultDest()->removePredecessor(SI->getParent());
Michael Gottesman0b5fad62013-10-20 07:04:37 +00003771 } else {
3772 Value *Cmp = Builder.CreateICmpULT(TableIndex, ConstantInt::get(
3773 MinCaseVal->getType(), TableSize));
3774 Builder.CreateCondBr(Cmp, LookupBB, SI->getDefaultDest());
3775 }
Hans Wennborg486270a2012-09-06 09:43:28 +00003776
3777 // Populate the BB that does the lookups.
3778 Builder.SetInsertPoint(LookupBB);
3779 bool ReturnedEarly = false;
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003780 for (size_t I = 0, E = PHIs.size(); I != E; ++I) {
3781 PHINode *PHI = PHIs[I];
Hans Wennborg486270a2012-09-06 09:43:28 +00003782
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003783 SwitchLookupTable Table(Mod, TableSize, MinCaseVal, ResultLists[PHI],
Hans Wennborgd72271c2012-09-26 09:44:49 +00003784 DefaultResults[PHI], TD);
Hans Wennborgdb5dbf02012-09-26 09:34:53 +00003785
3786 Value *Result = Table.BuildLookup(TableIndex, Builder);
Hans Wennborg486270a2012-09-06 09:43:28 +00003787
Hans Wennborg57933e32012-09-19 14:24:21 +00003788 // If the result is used to return immediately from the function, we want to
3789 // do that right here.
3790 if (PHI->hasOneUse() && isa<ReturnInst>(*PHI->use_begin()) &&
3791 *PHI->use_begin() == CommonDest->getFirstNonPHIOrDbg()) {
3792 Builder.CreateRet(Result);
3793 ReturnedEarly = true;
3794 break;
Hans Wennborg486270a2012-09-06 09:43:28 +00003795 }
3796
Hans Wennborg57933e32012-09-19 14:24:21 +00003797 PHI->addIncoming(Result, LookupBB);
Hans Wennborg486270a2012-09-06 09:43:28 +00003798 }
3799
3800 if (!ReturnedEarly)
3801 Builder.CreateBr(CommonDest);
3802
3803 // Remove the switch.
Michael Gottesman6701bb72013-10-21 05:20:11 +00003804 for (unsigned i = 0, e = SI->getNumSuccessors(); i < e; ++i) {
Hans Wennborg486270a2012-09-06 09:43:28 +00003805 BasicBlock *Succ = SI->getSuccessor(i);
Michael Gottesman0b5fad62013-10-20 07:04:37 +00003806
Michael Gottesman6701bb72013-10-21 05:20:11 +00003807 if (Succ == SI->getDefaultDest())
Michael Gottesman0b5fad62013-10-20 07:04:37 +00003808 continue;
Hans Wennborg486270a2012-09-06 09:43:28 +00003809 Succ->removePredecessor(SI->getParent());
3810 }
3811 SI->eraseFromParent();
3812
3813 ++NumLookupTables;
3814 return true;
3815}
3816
Devang Patel007349d2011-05-18 20:35:38 +00003817bool SimplifyCFGOpt::SimplifySwitch(SwitchInst *SI, IRBuilder<> &Builder) {
Chris Lattner3d512132010-12-13 06:25:44 +00003818 BasicBlock *BB = SI->getParent();
3819
Jakob Stoklund Olesene5a7a682012-10-25 18:51:15 +00003820 if (isValueEqualityComparison(SI)) {
3821 // If we only have one predecessor, and if it is a branch on this value,
3822 // see if that predecessor totally determines the outcome of this switch.
3823 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
3824 if (SimplifyEqualityComparisonWithOnlyPredecessor(SI, OnlyPred, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003825 return SimplifyCFG(BB, TTI, TD) | true;
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00003826
Jakob Stoklund Olesene5a7a682012-10-25 18:51:15 +00003827 Value *Cond = SI->getCondition();
3828 if (SelectInst *Select = dyn_cast<SelectInst>(Cond))
3829 if (SimplifySwitchOnSelect(SI, Select))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003830 return SimplifyCFG(BB, TTI, TD) | true;
Frits van Bommelf7b2a9d2011-02-28 09:44:07 +00003831
Jakob Stoklund Olesene5a7a682012-10-25 18:51:15 +00003832 // If the block only contains the switch, see if we can fold the block
3833 // away into any preds.
3834 BasicBlock::iterator BBI = BB->begin();
3835 // Ignore dbg intrinsics.
3836 while (isa<DbgInfoIntrinsic>(BBI))
3837 ++BBI;
3838 if (SI == &*BBI)
3839 if (FoldValueComparisonIntoPredecessors(SI, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003840 return SimplifyCFG(BB, TTI, TD) | true;
Jakob Stoklund Olesene5a7a682012-10-25 18:51:15 +00003841 }
Benjamin Kramer56442df2011-02-02 15:56:22 +00003842
3843 // Try to transform the switch into an icmp and a branch.
Devang Patel007349d2011-05-18 20:35:38 +00003844 if (TurnSwitchRangeIntoICmp(SI, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003845 return SimplifyCFG(BB, TTI, TD) | true;
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003846
3847 // Remove unreachable cases.
3848 if (EliminateDeadSwitchCases(SI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003849 return SimplifyCFG(BB, TTI, TD) | true;
Benjamin Kramer10fcfb52011-05-14 15:57:25 +00003850
Hans Wennborg448da512011-06-18 10:28:47 +00003851 if (ForwardSwitchConditionToPHI(SI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003852 return SimplifyCFG(BB, TTI, TD) | true;
Hans Wennborg448da512011-06-18 10:28:47 +00003853
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003854 if (SwitchToLookupTable(SI, Builder, TTI, TD))
3855 return SimplifyCFG(BB, TTI, TD) | true;
Hans Wennborg486270a2012-09-06 09:43:28 +00003856
Chris Lattner3d512132010-12-13 06:25:44 +00003857 return false;
3858}
3859
3860bool SimplifyCFGOpt::SimplifyIndirectBr(IndirectBrInst *IBI) {
3861 BasicBlock *BB = IBI->getParent();
3862 bool Changed = false;
Andrew Trick6b014382012-08-29 21:46:36 +00003863
Chris Lattner3d512132010-12-13 06:25:44 +00003864 // Eliminate redundant destinations.
3865 SmallPtrSet<Value *, 8> Succs;
3866 for (unsigned i = 0, e = IBI->getNumDestinations(); i != e; ++i) {
3867 BasicBlock *Dest = IBI->getDestination(i);
3868 if (!Dest->hasAddressTaken() || !Succs.insert(Dest)) {
3869 Dest->removePredecessor(BB);
3870 IBI->removeDestination(i);
3871 --i; --e;
3872 Changed = true;
3873 }
Andrew Trick6b014382012-08-29 21:46:36 +00003874 }
Chris Lattner3d512132010-12-13 06:25:44 +00003875
3876 if (IBI->getNumDestinations() == 0) {
3877 // If the indirectbr has no successors, change it to unreachable.
3878 new UnreachableInst(IBI->getContext(), IBI);
3879 EraseTerminatorInstAndDCECond(IBI);
3880 return true;
3881 }
Andrew Trick6b014382012-08-29 21:46:36 +00003882
Chris Lattner3d512132010-12-13 06:25:44 +00003883 if (IBI->getNumDestinations() == 1) {
3884 // If the indirectbr has one successor, change it to a direct branch.
3885 BranchInst::Create(IBI->getDestination(0), IBI);
3886 EraseTerminatorInstAndDCECond(IBI);
3887 return true;
3888 }
Andrew Trick6b014382012-08-29 21:46:36 +00003889
Chris Lattner3d512132010-12-13 06:25:44 +00003890 if (SelectInst *SI = dyn_cast<SelectInst>(IBI->getAddress())) {
3891 if (SimplifyIndirectBrOnSelect(IBI, SI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003892 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003893 }
3894 return Changed;
3895}
3896
Devang Patela23812c2011-05-18 18:28:48 +00003897bool SimplifyCFGOpt::SimplifyUncondBranch(BranchInst *BI, IRBuilder<> &Builder){
Chris Lattner3d512132010-12-13 06:25:44 +00003898 BasicBlock *BB = BI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00003899
Manman Ren554da1a2012-09-20 22:37:36 +00003900 if (SinkCommon && SinkThenElseCodeToEnd(BI))
3901 return true;
3902
Chris Lattner3d512132010-12-13 06:25:44 +00003903 // If the Terminator is the only non-phi instruction, simplify the block.
Rafael Espindola77a2c372011-06-30 20:14:24 +00003904 BasicBlock::iterator I = BB->getFirstNonPHIOrDbgOrLifetime();
Chris Lattner3d512132010-12-13 06:25:44 +00003905 if (I->isTerminator() && BB != &BB->getParent()->getEntryBlock() &&
3906 TryToSimplifyUncondBranchFromEmptyBlock(BB))
3907 return true;
Andrew Trick6b014382012-08-29 21:46:36 +00003908
Chris Lattner3d512132010-12-13 06:25:44 +00003909 // If the only instruction in the block is a seteq/setne comparison
3910 // against a constant, try to simplify the block.
3911 if (ICmpInst *ICI = dyn_cast<ICmpInst>(I))
3912 if (ICI->isEquality() && isa<ConstantInt>(ICI->getOperand(1))) {
3913 for (++I; isa<DbgInfoIntrinsic>(I); ++I)
3914 ;
Nick Lewycky9d523102011-12-26 20:37:40 +00003915 if (I->isTerminator() &&
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003916 TryToSimplifyUncondBranchWithICmpInIt(ICI, Builder, TTI, TD))
Chris Lattner3d512132010-12-13 06:25:44 +00003917 return true;
3918 }
Andrew Trick6b014382012-08-29 21:46:36 +00003919
Manman Renee28e0f2012-06-13 05:43:29 +00003920 // If this basic block is ONLY a compare and a branch, and if a predecessor
3921 // branches to us and our successor, fold the comparison into the
3922 // predecessor and use logical operations to update the incoming value
3923 // for PHI nodes in common successor.
3924 if (FoldBranchToCommonDest(BI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003925 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003926 return false;
3927}
3928
3929
Devang Patel007349d2011-05-18 20:35:38 +00003930bool SimplifyCFGOpt::SimplifyCondBranch(BranchInst *BI, IRBuilder<> &Builder) {
Chris Lattner3d512132010-12-13 06:25:44 +00003931 BasicBlock *BB = BI->getParent();
Andrew Trick6b014382012-08-29 21:46:36 +00003932
Chris Lattner3d512132010-12-13 06:25:44 +00003933 // Conditional branch
3934 if (isValueEqualityComparison(BI)) {
3935 // If we only have one predecessor, and if it is a branch on this value,
3936 // see if that predecessor totally determines the outcome of this
3937 // switch.
3938 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
Devang Patel007349d2011-05-18 20:35:38 +00003939 if (SimplifyEqualityComparisonWithOnlyPredecessor(BI, OnlyPred, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003940 return SimplifyCFG(BB, TTI, TD) | true;
Andrew Trick6b014382012-08-29 21:46:36 +00003941
Chris Lattner3d512132010-12-13 06:25:44 +00003942 // This block must be empty, except for the setcond inst, if it exists.
3943 // Ignore dbg intrinsics.
3944 BasicBlock::iterator I = BB->begin();
3945 // Ignore dbg intrinsics.
3946 while (isa<DbgInfoIntrinsic>(I))
3947 ++I;
3948 if (&*I == BI) {
Devang Patelb55d9242011-05-18 20:53:17 +00003949 if (FoldValueComparisonIntoPredecessors(BI, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003950 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003951 } else if (&*I == cast<Instruction>(BI->getCondition())){
3952 ++I;
3953 // Ignore dbg intrinsics.
3954 while (isa<DbgInfoIntrinsic>(I))
3955 ++I;
Devang Patelb55d9242011-05-18 20:53:17 +00003956 if (&*I == BI && FoldValueComparisonIntoPredecessors(BI, Builder))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003957 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003958 }
3959 }
Andrew Trick6b014382012-08-29 21:46:36 +00003960
Chris Lattner3d512132010-12-13 06:25:44 +00003961 // Try to turn "br (X == 0 | X == 1), T, F" into a switch instruction.
Devang Patel02dd5412011-05-18 23:18:47 +00003962 if (SimplifyBranchOnICmpChain(BI, TD, Builder))
Chris Lattner3d512132010-12-13 06:25:44 +00003963 return true;
Andrew Trick6b014382012-08-29 21:46:36 +00003964
Dan Gohman3b205172012-01-05 23:58:56 +00003965 // If this basic block is ONLY a compare and a branch, and if a predecessor
3966 // branches to us and one of our successors, fold the comparison into the
3967 // predecessor and use logical operations to pick the right destination.
3968 if (FoldBranchToCommonDest(BI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003969 return SimplifyCFG(BB, TTI, TD) | true;
Andrew Trick6b014382012-08-29 21:46:36 +00003970
Chris Lattner3d512132010-12-13 06:25:44 +00003971 // We have a conditional branch to two blocks that are only reachable
3972 // from BI. We know that the condbr dominates the two blocks, so see if
3973 // there is any identical code in the "then" and "else" blocks. If so, we
3974 // can hoist it up to the branching block.
3975 if (BI->getSuccessor(0)->getSinglePredecessor() != 0) {
3976 if (BI->getSuccessor(1)->getSinglePredecessor() != 0) {
Rafael Espindola216dde92011-05-19 02:26:30 +00003977 if (HoistThenElseCodeToIf(BI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003978 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003979 } else {
3980 // If Successor #1 has multiple preds, we may be able to conditionally
3981 // execute Successor #0 if it branches to successor #1.
3982 TerminatorInst *Succ0TI = BI->getSuccessor(0)->getTerminator();
3983 if (Succ0TI->getNumSuccessors() == 1 &&
3984 Succ0TI->getSuccessor(0) == BI->getSuccessor(1))
Chandler Carruth455151e2013-01-27 06:42:03 +00003985 if (SpeculativelyExecuteBB(BI, BI->getSuccessor(0)))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003986 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003987 }
3988 } else if (BI->getSuccessor(1)->getSinglePredecessor() != 0) {
3989 // If Successor #0 has multiple preds, we may be able to conditionally
3990 // execute Successor #1 if it branches to successor #0.
3991 TerminatorInst *Succ1TI = BI->getSuccessor(1)->getTerminator();
3992 if (Succ1TI->getNumSuccessors() == 1 &&
3993 Succ1TI->getSuccessor(0) == BI->getSuccessor(0))
Chandler Carruth455151e2013-01-27 06:42:03 +00003994 if (SpeculativelyExecuteBB(BI, BI->getSuccessor(1)))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00003995 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00003996 }
Andrew Trick6b014382012-08-29 21:46:36 +00003997
Chris Lattner3d512132010-12-13 06:25:44 +00003998 // If this is a branch on a phi node in the current block, thread control
3999 // through this block if any PHI node entries are constants.
4000 if (PHINode *PN = dyn_cast<PHINode>(BI->getCondition()))
4001 if (PN->getParent() == BI->getParent())
Chris Lattner302ba6f2010-12-14 06:17:25 +00004002 if (FoldCondBranchOnPHI(BI, TD))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00004003 return SimplifyCFG(BB, TTI, TD) | true;
Andrew Trick6b014382012-08-29 21:46:36 +00004004
Chris Lattner3d512132010-12-13 06:25:44 +00004005 // Scan predecessor blocks for conditional branches.
4006 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
4007 if (BranchInst *PBI = dyn_cast<BranchInst>((*PI)->getTerminator()))
4008 if (PBI != BI && PBI->isConditional())
4009 if (SimplifyCondBranchToCondBranch(PBI, BI))
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00004010 return SimplifyCFG(BB, TTI, TD) | true;
Chris Lattner3d512132010-12-13 06:25:44 +00004011
4012 return false;
4013}
4014
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004015/// Check if passing a value to an instruction will cause undefined behavior.
4016static bool passingValueIsAlwaysUndefined(Value *V, Instruction *I) {
4017 Constant *C = dyn_cast<Constant>(V);
4018 if (!C)
4019 return false;
4020
Benjamin Kramer1e21db62012-10-04 16:11:49 +00004021 if (I->use_empty())
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004022 return false;
4023
4024 if (C->isNullValue()) {
Benjamin Kramer1e21db62012-10-04 16:11:49 +00004025 // Only look at the first use, avoid hurting compile time with long uselists
4026 User *Use = *I->use_begin();
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004027
4028 // Now make sure that there are no instructions in between that can alter
4029 // control flow (eg. calls)
4030 for (BasicBlock::iterator i = ++BasicBlock::iterator(I); &*i != Use; ++i)
Benjamin Kramer9bb54882011-08-26 02:25:55 +00004031 if (i == I->getParent()->end() || i->mayHaveSideEffects())
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004032 return false;
4033
4034 // Look through GEPs. A load from a GEP derived from NULL is still undefined
4035 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Use))
4036 if (GEP->getPointerOperand() == I)
4037 return passingValueIsAlwaysUndefined(V, GEP);
4038
4039 // Look through bitcasts.
4040 if (BitCastInst *BC = dyn_cast<BitCastInst>(Use))
4041 return passingValueIsAlwaysUndefined(V, BC);
4042
Benjamin Kramer9bb54882011-08-26 02:25:55 +00004043 // Load from null is undefined.
4044 if (LoadInst *LI = dyn_cast<LoadInst>(Use))
Andrew Trick119003f2013-03-07 01:03:35 +00004045 if (!LI->isVolatile())
4046 return LI->getPointerAddressSpace() == 0;
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004047
Benjamin Kramer9bb54882011-08-26 02:25:55 +00004048 // Store to null is undefined.
4049 if (StoreInst *SI = dyn_cast<StoreInst>(Use))
Andrew Trick119003f2013-03-07 01:03:35 +00004050 if (!SI->isVolatile())
4051 return SI->getPointerAddressSpace() == 0 && SI->getPointerOperand() == I;
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004052 }
4053 return false;
4054}
4055
4056/// If BB has an incoming value that will always trigger undefined behavior
Nick Lewycky9d523102011-12-26 20:37:40 +00004057/// (eg. null pointer dereference), remove the branch leading here.
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004058static bool removeUndefIntroducingPredecessor(BasicBlock *BB) {
4059 for (BasicBlock::iterator i = BB->begin();
4060 PHINode *PHI = dyn_cast<PHINode>(i); ++i)
4061 for (unsigned i = 0, e = PHI->getNumIncomingValues(); i != e; ++i)
4062 if (passingValueIsAlwaysUndefined(PHI->getIncomingValue(i), PHI)) {
4063 TerminatorInst *T = PHI->getIncomingBlock(i)->getTerminator();
4064 IRBuilder<> Builder(T);
4065 if (BranchInst *BI = dyn_cast<BranchInst>(T)) {
4066 BB->removePredecessor(PHI->getIncomingBlock(i));
4067 // Turn uncoditional branches into unreachables and remove the dead
4068 // destination from conditional branches.
4069 if (BI->isUnconditional())
4070 Builder.CreateUnreachable();
4071 else
4072 Builder.CreateBr(BI->getSuccessor(0) == BB ? BI->getSuccessor(1) :
4073 BI->getSuccessor(0));
4074 BI->eraseFromParent();
4075 return true;
4076 }
4077 // TODO: SwitchInst.
4078 }
4079
4080 return false;
4081}
4082
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +00004083bool SimplifyCFGOpt::run(BasicBlock *BB) {
Chris Lattnerdc3602b2003-08-24 18:36:16 +00004084 bool Changed = false;
Chris Lattner01d1ee32002-05-21 20:50:24 +00004085
Chris Lattner302ba6f2010-12-14 06:17:25 +00004086 assert(BB && BB->getParent() && "Block not embedded in function!");
Chris Lattner01d1ee32002-05-21 20:50:24 +00004087 assert(BB->getTerminator() && "Degenerate basic block encountered!");
Chris Lattner01d1ee32002-05-21 20:50:24 +00004088
Dan Gohmane2c6d132010-08-14 00:29:42 +00004089 // Remove basic blocks that have no predecessors (except the entry block)...
4090 // or that just have themself as a predecessor. These are unreachable.
Chris Lattner302ba6f2010-12-14 06:17:25 +00004091 if ((pred_begin(BB) == pred_end(BB) &&
4092 BB != &BB->getParent()->getEntryBlock()) ||
Dan Gohmane2c6d132010-08-14 00:29:42 +00004093 BB->getSinglePredecessor() == BB) {
David Greene89d6fd32010-01-05 01:26:52 +00004094 DEBUG(dbgs() << "Removing BB: \n" << *BB);
Chris Lattner71af9b02008-12-03 06:40:52 +00004095 DeleteDeadBlock(BB);
Chris Lattner01d1ee32002-05-21 20:50:24 +00004096 return true;
4097 }
4098
Chris Lattner694e37f2003-08-17 19:41:53 +00004099 // Check to see if we can constant propagate this terminator instruction
4100 // away...
Frits van Bommel5649ba72011-05-22 16:24:18 +00004101 Changed |= ConstantFoldTerminator(BB, true);
Chris Lattner694e37f2003-08-17 19:41:53 +00004102
Dan Gohman2c635662009-10-30 22:39:04 +00004103 // Check for and eliminate duplicate PHI nodes in this block.
4104 Changed |= EliminateDuplicatePHINodes(BB);
4105
Benjamin Kramer98d6d232011-08-26 01:22:29 +00004106 // Check for and remove branches that will always cause undefined behavior.
4107 Changed |= removeUndefIntroducingPredecessor(BB);
4108
Chris Lattnerddb97a22010-12-13 05:10:48 +00004109 // Merge basic blocks into their predecessor if there is only one distinct
4110 // pred, and if there is only one distinct successor of the predecessor, and
4111 // if there are no PHI nodes.
4112 //
4113 if (MergeBlockIntoPredecessor(BB))
4114 return true;
Andrew Trick6b014382012-08-29 21:46:36 +00004115
Devang Patel3e410c62011-05-18 18:01:27 +00004116 IRBuilder<> Builder(BB);
4117
Dan Gohman882d87d2008-03-11 21:53:06 +00004118 // If there is a trivial two-entry PHI node in this basic block, and we can
4119 // eliminate it, do so now.
4120 if (PHINode *PN = dyn_cast<PHINode>(BB->begin()))
4121 if (PN->getNumIncomingValues() == 2)
Devang Pateld3a17882011-05-19 20:52:46 +00004122 Changed |= FoldTwoEntryPHINode(PN, TD);
Dan Gohman882d87d2008-03-11 21:53:06 +00004123
Devang Patel007349d2011-05-18 20:35:38 +00004124 Builder.SetInsertPoint(BB->getTerminator());
Chris Lattner3d512132010-12-13 06:25:44 +00004125 if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) {
Chris Lattner021c9d32010-12-13 06:36:51 +00004126 if (BI->isUnconditional()) {
Devang Patela23812c2011-05-18 18:28:48 +00004127 if (SimplifyUncondBranch(BI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00004128 } else {
Devang Patel007349d2011-05-18 20:35:38 +00004129 if (SimplifyCondBranch(BI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00004130 }
4131 } else if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
Devang Patel176ec402011-05-18 21:33:11 +00004132 if (SimplifyReturn(RI, Builder)) return true;
Bill Wendlingaa5abe82012-02-06 21:16:41 +00004133 } else if (ResumeInst *RI = dyn_cast<ResumeInst>(BB->getTerminator())) {
4134 if (SimplifyResume(RI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00004135 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
Devang Patel007349d2011-05-18 20:35:38 +00004136 if (SimplifySwitch(SI, Builder)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00004137 } else if (UnreachableInst *UI =
4138 dyn_cast<UnreachableInst>(BB->getTerminator())) {
4139 if (SimplifyUnreachable(UI)) return true;
Chris Lattner021c9d32010-12-13 06:36:51 +00004140 } else if (IndirectBrInst *IBI =
4141 dyn_cast<IndirectBrInst>(BB->getTerminator())) {
4142 if (SimplifyIndirectBr(IBI)) return true;
Chris Lattner19831ec2004-02-16 06:35:48 +00004143 }
4144
Chris Lattner694e37f2003-08-17 19:41:53 +00004145 return Changed;
Chris Lattner01d1ee32002-05-21 20:50:24 +00004146}
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +00004147
4148/// SimplifyCFG - This function is used to do simplification of a CFG. For
4149/// example, it adjusts branches to branches to eliminate the extra hop, it
4150/// eliminates unreachable basic blocks, and does other "peephole" optimization
4151/// of the CFG. It returns true if a modification was made.
4152///
Chandler Carruth5f46c3c2013-01-07 03:53:25 +00004153bool llvm::SimplifyCFG(BasicBlock *BB, const TargetTransformInfo &TTI,
Tom Stellard01d72032013-08-06 02:43:45 +00004154 const DataLayout *TD) {
4155 return SimplifyCFGOpt(TTI, TD).run(BB);
Jakob Stoklund Olesen58e9ee82010-02-05 22:03:18 +00004156}