blob: 01f7c81b7d3ddc199703ebd04bab511461c18602 [file] [log] [blame]
Chris Lattner466a0492002-05-21 20:50:24 +00001//===- SimplifyCFG.cpp - Code to perform CFG simplification ---------------===//
Misha Brukmanb1c93172005-04-21 23:48:37 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanb1c93172005-04-21 23:48:37 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner466a0492002-05-21 20:50:24 +00009//
Chris Lattnera704ac82002-10-08 21:36:33 +000010// Peephole optimize the CFG.
Chris Lattner466a0492002-05-21 20:50:24 +000011//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/Transforms/Utils/Local.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000015#include "llvm/ADT/DenseMap.h"
16#include "llvm/ADT/STLExtras.h"
James Molloy4de84dd2015-11-04 15:28:04 +000017#include "llvm/ADT/SetOperations.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000018#include "llvm/ADT/SetVector.h"
19#include "llvm/ADT/SmallPtrSet.h"
20#include "llvm/ADT/SmallVector.h"
21#include "llvm/ADT/Statistic.h"
Benjamin Kramer7c302602013-11-12 12:24:36 +000022#include "llvm/Analysis/ConstantFolding.h"
Joseph Tremoulet0d808882016-01-05 02:37:41 +000023#include "llvm/Analysis/EHPersonalities.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000024#include "llvm/Analysis/InstructionSimplify.h"
Chandler Carruthd3e73552013-01-07 03:08:10 +000025#include "llvm/Analysis/TargetTransformInfo.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000026#include "llvm/Analysis/ValueTracking.h"
Chandler Carruth1305dc32014-03-04 11:45:46 +000027#include "llvm/IR/CFG.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000028#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000029#include "llvm/IR/Constants.h"
30#include "llvm/IR/DataLayout.h"
31#include "llvm/IR/DerivedTypes.h"
32#include "llvm/IR/GlobalVariable.h"
33#include "llvm/IR/IRBuilder.h"
34#include "llvm/IR/Instructions.h"
35#include "llvm/IR/IntrinsicInst.h"
36#include "llvm/IR/LLVMContext.h"
37#include "llvm/IR/MDBuilder.h"
38#include "llvm/IR/Metadata.h"
39#include "llvm/IR/Module.h"
Chandler Carruth64396b02014-03-04 12:05:47 +000040#include "llvm/IR/NoFolder.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000041#include "llvm/IR/Operator.h"
Chandler Carruth820a9082014-03-04 11:08:18 +000042#include "llvm/IR/PatternMatch.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000043#include "llvm/IR/Type.h"
Evan Chengd983eba2011-01-29 04:46:23 +000044#include "llvm/Support/CommandLine.h"
Chris Lattnerd7beca32010-12-14 06:17:25 +000045#include "llvm/Support/Debug.h"
46#include "llvm/Support/raw_ostream.h"
Chandler Carruthaafe0912012-06-29 12:38:19 +000047#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Jingyue Wufc029672014-09-30 22:23:38 +000048#include "llvm/Transforms/Utils/ValueMapper.h"
Chris Lattner466a0492002-05-21 20:50:24 +000049#include <algorithm>
Chris Lattner5edb2f32004-10-18 04:07:22 +000050#include <map>
Chandler Carruthed0881b2012-12-03 16:50:05 +000051#include <set>
Chris Lattnerdf3c3422004-01-09 06:12:26 +000052using namespace llvm;
Benjamin Kramer37172222013-07-04 14:22:02 +000053using namespace PatternMatch;
Brian Gaeke960707c2003-11-11 22:41:34 +000054
Chandler Carruth964daaa2014-04-22 02:55:47 +000055#define DEBUG_TYPE "simplifycfg"
56
James Molloy1b6207e2015-02-13 10:48:30 +000057// Chosen as 2 so as to be cheap, but still to have enough power to fold
58// a select, so the "clamp" idiom (of a min followed by a max) will be caught.
59// To catch this, we need to fold a compare and a select, hence '2' being the
60// minimum reasonable default.
Peter Collingbourne616044a2011-04-29 18:47:38 +000061static cl::opt<unsigned>
James Molloy1b6207e2015-02-13 10:48:30 +000062PHINodeFoldingThreshold("phi-node-folding-threshold", cl::Hidden, cl::init(2),
63 cl::desc("Control the amount of phi node folding to perform (default = 2)"));
Peter Collingbourne616044a2011-04-29 18:47:38 +000064
Evan Chengd983eba2011-01-29 04:46:23 +000065static cl::opt<bool>
66DupRet("simplifycfg-dup-ret", cl::Hidden, cl::init(false),
67 cl::desc("Duplicate return instructions into unconditional branches"));
68
Manman Ren93ab6492012-09-20 22:37:36 +000069static cl::opt<bool>
70SinkCommon("simplifycfg-sink-common", cl::Hidden, cl::init(true),
71 cl::desc("Sink common instructions down to the end block"));
72
Alp Tokercb402912014-01-24 17:20:08 +000073static cl::opt<bool> HoistCondStores(
74 "simplifycfg-hoist-cond-stores", cl::Hidden, cl::init(true),
75 cl::desc("Hoist conditional stores if an unconditional store precedes"));
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +000076
James Molloy4de84dd2015-11-04 15:28:04 +000077static cl::opt<bool> MergeCondStores(
78 "simplifycfg-merge-cond-stores", cl::Hidden, cl::init(true),
79 cl::desc("Hoist conditional stores even if an unconditional store does not "
80 "precede - hoist multiple conditional stores into a single "
81 "predicated store"));
82
83static cl::opt<bool> MergeCondStoresAggressively(
84 "simplifycfg-merge-cond-stores-aggressively", cl::Hidden, cl::init(false),
85 cl::desc("When merging conditional stores, do so even if the resultant "
86 "basic blocks are unlikely to be if-converted as a result"));
87
David Majnemerfccf5c62016-01-27 02:59:41 +000088static cl::opt<bool> SpeculateOneExpensiveInst(
89 "speculate-one-expensive-inst", cl::Hidden, cl::init(true),
90 cl::desc("Allow exactly one expensive instruction to be speculatively "
91 "executed"));
92
Sanjay Patel5264cc72016-01-27 19:22:45 +000093static cl::opt<unsigned> MaxSpeculationDepth(
94 "max-speculation-depth", cl::Hidden, cl::init(10),
95 cl::desc("Limit maximum recursion depth when calculating costs of "
96 "speculatively executed instructions"));
97
Hans Wennborg39583b82012-09-26 09:44:49 +000098STATISTIC(NumBitMaps, "Number of switch instructions turned into bitmaps");
Erik Eckstein105374f2014-11-17 09:13:57 +000099STATISTIC(NumLinearMaps, "Number of switch instructions turned into linear mapping");
Hans Wennborgcd3a11f2012-09-26 14:01:53 +0000100STATISTIC(NumLookupTables, "Number of switch instructions turned into lookup tables");
Hans Wennborgb73c0b02014-03-12 18:35:40 +0000101STATISTIC(NumLookupTablesHoles, "Number of switch instructions turned into lookup tables (holes checked)");
Erik Eckstein0d86c762014-11-27 15:13:14 +0000102STATISTIC(NumTableCmpReuses, "Number of reused switch table lookup compares");
Manman Ren93ab6492012-09-20 22:37:36 +0000103STATISTIC(NumSinkCommons, "Number of common instructions sunk down to the end block");
Hans Wennborgcd3a11f2012-09-26 14:01:53 +0000104STATISTIC(NumSpeculations, "Number of speculative executed instructions");
Evan Cheng89553cc2008-06-12 21:15:59 +0000105
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000106namespace {
Marcello Maggioni5bbe3df2014-10-14 01:58:26 +0000107 // The first field contains the value that the switch produces when a certain
Sanjay Patel9361d352015-09-10 16:31:19 +0000108 // case group is selected, and the second field is a vector containing the
109 // cases composing the case group.
Marcello Maggioni5bbe3df2014-10-14 01:58:26 +0000110 typedef SmallVector<std::pair<Constant *, SmallVector<ConstantInt *, 4>>, 2>
111 SwitchCaseResultVectorTy;
112 // The first field contains the phi node that generates a result of the switch
Sanjay Patel9361d352015-09-10 16:31:19 +0000113 // and the second field contains the value generated for a certain case in the
114 // switch for that PHI.
Marcello Maggioni5bbe3df2014-10-14 01:58:26 +0000115 typedef SmallVector<std::pair<PHINode *, Constant *>, 4> SwitchCaseResultsTy;
116
Eric Christopherb65acc62012-07-02 23:22:21 +0000117 /// ValueEqualityComparisonCase - Represents a case of a switch.
118 struct ValueEqualityComparisonCase {
119 ConstantInt *Value;
120 BasicBlock *Dest;
121
122 ValueEqualityComparisonCase(ConstantInt *Value, BasicBlock *Dest)
123 : Value(Value), Dest(Dest) {}
124
125 bool operator<(ValueEqualityComparisonCase RHS) const {
126 // Comparing pointers is ok as we only rely on the order for uniquing.
127 return Value < RHS.Value;
128 }
Benjamin Kramerc5b06782012-10-14 11:15:42 +0000129
130 bool operator==(BasicBlock *RHSDest) const { return Dest == RHSDest; }
Eric Christopherb65acc62012-07-02 23:22:21 +0000131 };
132
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000133class SimplifyCFGOpt {
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +0000134 const TargetTransformInfo &TTI;
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000135 const DataLayout &DL;
Jingyue Wufc029672014-09-30 22:23:38 +0000136 unsigned BonusInstThreshold;
Chandler Carruth66b31302015-01-04 12:03:27 +0000137 AssumptionCache *AC;
Hyojin Sung4673f102016-03-29 04:08:57 +0000138 SmallPtrSetImpl<BasicBlock *> *LoopHeaders;
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000139 Value *isValueEqualityComparison(TerminatorInst *TI);
140 BasicBlock *GetValueEqualityComparisonCases(TerminatorInst *TI,
Eric Christopherb65acc62012-07-02 23:22:21 +0000141 std::vector<ValueEqualityComparisonCase> &Cases);
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000142 bool SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
Devang Patela7ec47d2011-05-18 20:35:38 +0000143 BasicBlock *Pred,
144 IRBuilder<> &Builder);
Devang Patel58380552011-05-18 20:53:17 +0000145 bool FoldValueComparisonIntoPredecessors(TerminatorInst *TI,
146 IRBuilder<> &Builder);
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000147
Devang Pateldd14e0f2011-05-18 21:33:11 +0000148 bool SimplifyReturn(ReturnInst *RI, IRBuilder<> &Builder);
Bill Wendlingd5d95b02012-02-06 21:16:41 +0000149 bool SimplifyResume(ResumeInst *RI, IRBuilder<> &Builder);
Chen Li1689c2f2016-01-10 05:48:01 +0000150 bool SimplifySingleResume(ResumeInst *RI);
151 bool SimplifyCommonResume(ResumeInst *RI);
Andrew Kaylor50e4e862015-09-04 23:39:40 +0000152 bool SimplifyCleanupReturn(CleanupReturnInst *RI);
Chris Lattner25c3af32010-12-13 06:25:44 +0000153 bool SimplifyUnreachable(UnreachableInst *UI);
Devang Patela7ec47d2011-05-18 20:35:38 +0000154 bool SimplifySwitch(SwitchInst *SI, IRBuilder<> &Builder);
Chris Lattner25c3af32010-12-13 06:25:44 +0000155 bool SimplifyIndirectBr(IndirectBrInst *IBI);
Devang Patel767f6932011-05-18 18:28:48 +0000156 bool SimplifyUncondBranch(BranchInst *BI, IRBuilder <> &Builder);
Devang Patela7ec47d2011-05-18 20:35:38 +0000157 bool SimplifyCondBranch(BranchInst *BI, IRBuilder <>&Builder);
Chris Lattner25c3af32010-12-13 06:25:44 +0000158
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000159public:
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000160 SimplifyCFGOpt(const TargetTransformInfo &TTI, const DataLayout &DL,
Hyojin Sung4673f102016-03-29 04:08:57 +0000161 unsigned BonusInstThreshold, AssumptionCache *AC,
162 SmallPtrSetImpl<BasicBlock *> *LoopHeaders)
163 : TTI(TTI), DL(DL), BonusInstThreshold(BonusInstThreshold), AC(AC),
164 LoopHeaders(LoopHeaders) {}
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000165 bool run(BasicBlock *BB);
166};
Alexander Kornienkof00654e2015-06-23 09:49:53 +0000167}
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000168
Sanjay Patel09159b8f2015-06-24 20:40:57 +0000169/// Return true if it is safe to merge these two
Chris Lattner76dc2042005-08-03 00:19:45 +0000170/// terminator instructions together.
Chris Lattner76dc2042005-08-03 00:19:45 +0000171static bool SafeToMergeTerminators(TerminatorInst *SI1, TerminatorInst *SI2) {
172 if (SI1 == SI2) return false; // Can't merge with self!
Andrew Trickf3cf1932012-08-29 21:46:36 +0000173
Chris Lattner76dc2042005-08-03 00:19:45 +0000174 // It is not safe to merge these two switch instructions if they have a common
175 // successor, and if that successor has a PHI node, and if *that* PHI node has
176 // conflicting incoming values from the two switch blocks.
177 BasicBlock *SI1BB = SI1->getParent();
178 BasicBlock *SI2BB = SI2->getParent();
Chris Lattnerb7b75142007-04-02 01:44:59 +0000179 SmallPtrSet<BasicBlock*, 16> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
Andrew Trickf3cf1932012-08-29 21:46:36 +0000180
Sanjay Patel5781d842016-03-12 16:52:17 +0000181 for (BasicBlock *Succ : successors(SI2BB))
182 if (SI1Succs.count(Succ))
183 for (BasicBlock::iterator BBI = Succ->begin(); isa<PHINode>(BBI); ++BBI) {
Chris Lattner76dc2042005-08-03 00:19:45 +0000184 PHINode *PN = cast<PHINode>(BBI);
185 if (PN->getIncomingValueForBlock(SI1BB) !=
186 PN->getIncomingValueForBlock(SI2BB))
187 return false;
188 }
Andrew Trickf3cf1932012-08-29 21:46:36 +0000189
Chris Lattner76dc2042005-08-03 00:19:45 +0000190 return true;
191}
192
Sanjay Patel09159b8f2015-06-24 20:40:57 +0000193/// Return true if it is safe and profitable to merge these two terminator
194/// instructions together, where SI1 is an unconditional branch. PhiNodes will
195/// store all PHI nodes in common successors.
Manman Rend33f4ef2012-06-13 05:43:29 +0000196static bool isProfitableToFoldUnconditional(BranchInst *SI1,
197 BranchInst *SI2,
Nick Lewycky0a045bb2012-06-24 10:15:42 +0000198 Instruction *Cond,
Manman Rend33f4ef2012-06-13 05:43:29 +0000199 SmallVectorImpl<PHINode*> &PhiNodes) {
200 if (SI1 == SI2) return false; // Can't merge with self!
201 assert(SI1->isUnconditional() && SI2->isConditional());
202
203 // We fold the unconditional branch if we can easily update all PHI nodes in
Andrew Trickf3cf1932012-08-29 21:46:36 +0000204 // common successors:
Manman Rend33f4ef2012-06-13 05:43:29 +0000205 // 1> We have a constant incoming value for the conditional branch;
206 // 2> We have "Cond" as the incoming value for the unconditional branch;
207 // 3> SI2->getCondition() and Cond have same operands.
208 CmpInst *Ci2 = dyn_cast<CmpInst>(SI2->getCondition());
209 if (!Ci2) return false;
210 if (!(Cond->getOperand(0) == Ci2->getOperand(0) &&
211 Cond->getOperand(1) == Ci2->getOperand(1)) &&
212 !(Cond->getOperand(0) == Ci2->getOperand(1) &&
213 Cond->getOperand(1) == Ci2->getOperand(0)))
214 return false;
215
216 BasicBlock *SI1BB = SI1->getParent();
217 BasicBlock *SI2BB = SI2->getParent();
218 SmallPtrSet<BasicBlock*, 16> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
Sanjay Patel5781d842016-03-12 16:52:17 +0000219 for (BasicBlock *Succ : successors(SI2BB))
220 if (SI1Succs.count(Succ))
221 for (BasicBlock::iterator BBI = Succ->begin(); isa<PHINode>(BBI); ++BBI) {
Manman Rend33f4ef2012-06-13 05:43:29 +0000222 PHINode *PN = cast<PHINode>(BBI);
223 if (PN->getIncomingValueForBlock(SI1BB) != Cond ||
Nick Lewycky0a045bb2012-06-24 10:15:42 +0000224 !isa<ConstantInt>(PN->getIncomingValueForBlock(SI2BB)))
Manman Rend33f4ef2012-06-13 05:43:29 +0000225 return false;
226 PhiNodes.push_back(PN);
227 }
228 return true;
229}
230
Sanjay Patel09159b8f2015-06-24 20:40:57 +0000231/// Update PHI nodes in Succ to indicate that there will now be entries in it
232/// from the 'NewPred' block. The values that will be flowing into the PHI nodes
233/// will be the same as those coming in from ExistPred, an existing predecessor
234/// of Succ.
Chris Lattner76dc2042005-08-03 00:19:45 +0000235static void AddPredecessorToBlock(BasicBlock *Succ, BasicBlock *NewPred,
236 BasicBlock *ExistPred) {
Chris Lattner76dc2042005-08-03 00:19:45 +0000237 if (!isa<PHINode>(Succ->begin())) return; // Quick exit if nothing to do
Andrew Trickf3cf1932012-08-29 21:46:36 +0000238
Chris Lattner80b03a12008-07-13 22:23:11 +0000239 PHINode *PN;
Sanjay Patel5781d842016-03-12 16:52:17 +0000240 for (BasicBlock::iterator I = Succ->begin(); (PN = dyn_cast<PHINode>(I)); ++I)
Chris Lattner80b03a12008-07-13 22:23:11 +0000241 PN->addIncoming(PN->getIncomingValueForBlock(ExistPred), NewPred);
Chris Lattner76dc2042005-08-03 00:19:45 +0000242}
243
Sanjay Patel09159b8f2015-06-24 20:40:57 +0000244/// Compute an abstract "cost" of speculating the given instruction,
245/// which is assumed to be safe to speculate. TCC_Free means cheap,
246/// TCC_Basic means less cheap, and TCC_Expensive means prohibitively
James Molloy7c336572015-02-11 12:15:41 +0000247/// expensive.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000248static unsigned ComputeSpeculationCost(const User *I,
James Molloy7c336572015-02-11 12:15:41 +0000249 const TargetTransformInfo &TTI) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000250 assert(isSafeToSpeculativelyExecute(I) &&
Dan Gohman5ab9c0a2012-01-05 23:58:56 +0000251 "Instruction is not safe to speculatively execute!");
James Molloy7c336572015-02-11 12:15:41 +0000252 return TTI.getUserCost(I);
Dan Gohman5ab9c0a2012-01-05 23:58:56 +0000253}
Sanjay Patelf9b77632015-09-15 15:24:42 +0000254
Sanjay Patel09159b8f2015-06-24 20:40:57 +0000255/// If we have a merge point of an "if condition" as accepted above,
256/// return true if the specified value dominates the block. We
Bill Wendlingcaf1d222009-01-19 23:43:56 +0000257/// don't handle the true generality of domination here, just a special case
258/// which works well enough for us.
259///
260/// If AggressiveInsts is non-null, and if V does not dominate BB, we check to
Peter Collingbournee3511e12011-04-29 18:47:31 +0000261/// see if V (which must be an instruction) and its recursive operands
262/// that do not dominate BB have a combined cost lower than CostRemaining and
263/// are non-trapping. If both are true, the instruction is inserted into the
264/// set and true is returned.
265///
266/// The cost for most non-trapping instructions is defined as 1 except for
267/// Select whose cost is 2.
268///
269/// After this function returns, CostRemaining is decreased by the cost of
270/// V plus its non-dominating operands. If that cost is greater than
271/// CostRemaining, false is returned and CostRemaining is undefined.
Chris Lattner45c35b12004-10-14 05:13:36 +0000272static bool DominatesMergePoint(Value *V, BasicBlock *BB,
Craig Topper71b7b682014-08-21 05:55:13 +0000273 SmallPtrSetImpl<Instruction*> *AggressiveInsts,
Hal Finkela995f922014-07-10 14:41:31 +0000274 unsigned &CostRemaining,
David Majnemerfccf5c62016-01-27 02:59:41 +0000275 const TargetTransformInfo &TTI,
276 unsigned Depth = 0) {
Sanjay Patel5264cc72016-01-27 19:22:45 +0000277 // It is possible to hit a zero-cost cycle (phi/gep instructions for example),
278 // so limit the recursion depth.
279 // TODO: While this recursion limit does prevent pathological behavior, it
280 // would be better to track visited instructions to avoid cycles.
281 if (Depth == MaxSpeculationDepth)
282 return false;
283
Chris Lattner0aa56562004-04-09 22:50:22 +0000284 Instruction *I = dyn_cast<Instruction>(V);
Chris Lattnerb8b11592006-10-20 00:42:07 +0000285 if (!I) {
286 // Non-instructions all dominate instructions, but not all constantexprs
287 // can be executed unconditionally.
288 if (ConstantExpr *C = dyn_cast<ConstantExpr>(V))
289 if (C->canTrap())
290 return false;
291 return true;
292 }
Chris Lattner0aa56562004-04-09 22:50:22 +0000293 BasicBlock *PBB = I->getParent();
Chris Lattner18d1f192004-02-11 03:36:04 +0000294
Chris Lattner0ce80cd2005-02-27 06:18:25 +0000295 // We don't want to allow weird loops that might have the "if condition" in
Chris Lattner0aa56562004-04-09 22:50:22 +0000296 // the bottom of this block.
297 if (PBB == BB) return false;
Chris Lattner18d1f192004-02-11 03:36:04 +0000298
Chris Lattner0aa56562004-04-09 22:50:22 +0000299 // If this instruction is defined in a block that contains an unconditional
300 // branch to BB, then it must be in the 'conditional' part of the "if
Chris Lattner9ac168d2010-12-14 07:41:39 +0000301 // statement". If not, it definitely dominates the region.
302 BranchInst *BI = dyn_cast<BranchInst>(PBB->getTerminator());
Craig Topperf40110f2014-04-25 05:29:35 +0000303 if (!BI || BI->isConditional() || BI->getSuccessor(0) != BB)
Chris Lattner9ac168d2010-12-14 07:41:39 +0000304 return true;
Eli Friedmanb8f6a4f2009-07-17 04:28:42 +0000305
Chris Lattner9ac168d2010-12-14 07:41:39 +0000306 // If we aren't allowing aggressive promotion anymore, then don't consider
307 // instructions in the 'if region'.
Craig Topperf40110f2014-04-25 05:29:35 +0000308 if (!AggressiveInsts) return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +0000309
Peter Collingbournee3511e12011-04-29 18:47:31 +0000310 // If we have seen this instruction before, don't count it again.
311 if (AggressiveInsts->count(I)) return true;
312
Chris Lattner9ac168d2010-12-14 07:41:39 +0000313 // Okay, it looks like the instruction IS in the "condition". Check to
314 // see if it's a cheap instruction to unconditionally compute, and if it
315 // only uses stuff defined outside of the condition. If so, hoist it out.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000316 if (!isSafeToSpeculativelyExecute(I))
Chris Lattner9ac168d2010-12-14 07:41:39 +0000317 return false;
Misha Brukmanb1c93172005-04-21 23:48:37 +0000318
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000319 unsigned Cost = ComputeSpeculationCost(I, TTI);
Chris Lattner0aa56562004-04-09 22:50:22 +0000320
David Majnemerfccf5c62016-01-27 02:59:41 +0000321 // Allow exactly one instruction to be speculated regardless of its cost
322 // (as long as it is safe to do so).
323 // This is intended to flatten the CFG even if the instruction is a division
324 // or other expensive operation. The speculation of an expensive instruction
325 // is expected to be undone in CodeGenPrepare if the speculation has not
326 // enabled further IR optimizations.
327 if (Cost > CostRemaining &&
328 (!SpeculateOneExpensiveInst || !AggressiveInsts->empty() || Depth > 0))
Peter Collingbournee3511e12011-04-29 18:47:31 +0000329 return false;
330
David Majnemerfccf5c62016-01-27 02:59:41 +0000331 // Avoid unsigned wrap.
332 CostRemaining = (Cost > CostRemaining) ? 0 : CostRemaining - Cost;
Peter Collingbournee3511e12011-04-29 18:47:31 +0000333
334 // Okay, we can only really hoist these out if their operands do
335 // not take us over the cost threshold.
Chris Lattner9ac168d2010-12-14 07:41:39 +0000336 for (User::op_iterator i = I->op_begin(), e = I->op_end(); i != e; ++i)
David Majnemerfccf5c62016-01-27 02:59:41 +0000337 if (!DominatesMergePoint(*i, BB, AggressiveInsts, CostRemaining, TTI,
338 Depth + 1))
Chris Lattner9ac168d2010-12-14 07:41:39 +0000339 return false;
340 // Okay, it's safe to do this! Remember this instruction.
341 AggressiveInsts->insert(I);
Chris Lattner18d1f192004-02-11 03:36:04 +0000342 return true;
343}
Chris Lattner466a0492002-05-21 20:50:24 +0000344
Sanjay Patel09159b8f2015-06-24 20:40:57 +0000345/// Extract ConstantInt from value, looking through IntToPtr
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000346/// and PointerNullValue. Return NULL if value is not a constant int.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000347static ConstantInt *GetConstantInt(Value *V, const DataLayout &DL) {
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000348 // Normal constant int.
349 ConstantInt *CI = dyn_cast<ConstantInt>(V);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000350 if (CI || !isa<Constant>(V) || !V->getType()->isPointerTy())
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000351 return CI;
352
353 // This is some kind of pointer constant. Turn it into a pointer-sized
354 // ConstantInt if possible.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000355 IntegerType *PtrTy = cast<IntegerType>(DL.getIntPtrType(V->getType()));
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000356
357 // Null pointer means 0, see SelectionDAGBuilder::getValue(const Value*).
358 if (isa<ConstantPointerNull>(V))
359 return ConstantInt::get(PtrTy, 0);
360
361 // IntToPtr const int.
362 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
363 if (CE->getOpcode() == Instruction::IntToPtr)
364 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(0))) {
365 // The constant is very likely to have the right type already.
366 if (CI->getType() == PtrTy)
367 return CI;
368 else
369 return cast<ConstantInt>
370 (ConstantExpr::getIntegerCast(CI, PtrTy, /*isSigned=*/false));
371 }
Craig Topperf40110f2014-04-25 05:29:35 +0000372 return nullptr;
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000373}
374
Mehdi Aminiffd01002014-11-20 22:40:25 +0000375namespace {
Mehdi Amini9a25cb82014-11-19 20:09:11 +0000376
Mehdi Aminiffd01002014-11-20 22:40:25 +0000377/// Given a chain of or (||) or and (&&) comparison of a value against a
378/// constant, this will try to recover the information required for a switch
379/// structure.
380/// It will depth-first traverse the chain of comparison, seeking for patterns
381/// like %a == 12 or %a < 4 and combine them to produce a set of integer
382/// representing the different cases for the switch.
383/// Note that if the chain is composed of '||' it will build the set of elements
384/// that matches the comparisons (i.e. any of this value validate the chain)
385/// while for a chain of '&&' it will build the set elements that make the test
386/// fail.
387struct ConstantComparesGatherer {
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000388 const DataLayout &DL;
Mehdi Aminiffd01002014-11-20 22:40:25 +0000389 Value *CompValue; /// Value found for the switch comparison
390 Value *Extra; /// Extra clause to be checked before the switch
391 SmallVector<ConstantInt *, 8> Vals; /// Set of integers to match in switch
392 unsigned UsedICmps; /// Number of comparisons matched in the and/or chain
Timur Iskhodzhanov71526a32014-11-20 12:36:43 +0000393
Mehdi Aminiffd01002014-11-20 22:40:25 +0000394 /// Construct and compute the result for the comparison instruction Cond
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000395 ConstantComparesGatherer(Instruction *Cond, const DataLayout &DL)
396 : DL(DL), CompValue(nullptr), Extra(nullptr), UsedICmps(0) {
397 gather(Cond);
Mehdi Amini9a25cb82014-11-19 20:09:11 +0000398 }
399
Mehdi Aminiffd01002014-11-20 22:40:25 +0000400 /// Prevent copy
Aaron Ballmanf9a18972015-02-15 22:54:22 +0000401 ConstantComparesGatherer(const ConstantComparesGatherer &) = delete;
Mehdi Aminiffd01002014-11-20 22:40:25 +0000402 ConstantComparesGatherer &
Aaron Ballmanf9a18972015-02-15 22:54:22 +0000403 operator=(const ConstantComparesGatherer &) = delete;
Mehdi Amini9a25cb82014-11-19 20:09:11 +0000404
Mehdi Aminiffd01002014-11-20 22:40:25 +0000405private:
Mehdi Amini9a25cb82014-11-19 20:09:11 +0000406
Mehdi Aminiffd01002014-11-20 22:40:25 +0000407 /// Try to set the current value used for the comparison, it succeeds only if
408 /// it wasn't set before or if the new value is the same as the old one
409 bool setValueOnce(Value *NewVal) {
Sanjay Patel2e002772016-03-12 18:05:53 +0000410 if (CompValue && CompValue != NewVal) return false;
Mehdi Aminiffd01002014-11-20 22:40:25 +0000411 CompValue = NewVal;
412 return (CompValue != nullptr);
413 }
414
415 /// Try to match Instruction "I" as a comparison against a constant and
416 /// populates the array Vals with the set of values that match (or do not
417 /// match depending on isEQ).
418 /// Return false on failure. On success, the Value the comparison matched
419 /// against is placed in CompValue.
420 /// If CompValue is already set, the function is expected to fail if a match
421 /// is found but the value compared to is different.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000422 bool matchInstruction(Instruction *I, bool isEQ) {
Mehdi Aminiffd01002014-11-20 22:40:25 +0000423 // If this is an icmp against a constant, handle this as one of the cases.
424 ICmpInst *ICI;
425 ConstantInt *C;
426 if (!((ICI = dyn_cast<ICmpInst>(I)) &&
427 (C = GetConstantInt(I->getOperand(1), DL)))) {
428 return false;
429 }
430
431 Value *RHSVal;
432 ConstantInt *RHSC;
433
434 // Pattern match a special case
David Majnemerc761afd2016-01-27 02:43:28 +0000435 // (x & ~2^z) == y --> x == y || x == y|2^z
Mehdi Aminiffd01002014-11-20 22:40:25 +0000436 // This undoes a transformation done by instcombine to fuse 2 compares.
437 if (ICI->getPredicate() == (isEQ ? ICmpInst::ICMP_EQ:ICmpInst::ICMP_NE)) {
438 if (match(ICI->getOperand(0),
439 m_And(m_Value(RHSVal), m_ConstantInt(RHSC)))) {
440 APInt Not = ~RHSC->getValue();
David Majnemerc761afd2016-01-27 02:43:28 +0000441 if (Not.isPowerOf2() && C->getValue().isPowerOf2() &&
442 Not != C->getValue()) {
Mehdi Aminiffd01002014-11-20 22:40:25 +0000443 // If we already have a value for the switch, it has to match!
444 if(!setValueOnce(RHSVal))
445 return false;
446
447 Vals.push_back(C);
448 Vals.push_back(ConstantInt::get(C->getContext(),
449 C->getValue() | Not));
450 UsedICmps++;
451 return true;
452 }
Mehdi Amini9a25cb82014-11-19 20:09:11 +0000453 }
Mehdi Aminiffd01002014-11-20 22:40:25 +0000454
455 // If we already have a value for the switch, it has to match!
456 if(!setValueOnce(ICI->getOperand(0)))
457 return false;
458
459 UsedICmps++;
460 Vals.push_back(C);
461 return ICI->getOperand(0);
462 }
463
464 // If we have "x ult 3", for example, then we can add 0,1,2 to the set.
Sanjoy Das7182d362015-03-18 00:41:24 +0000465 ConstantRange Span = ConstantRange::makeAllowedICmpRegion(
466 ICI->getPredicate(), C->getValue());
Mehdi Aminiffd01002014-11-20 22:40:25 +0000467
468 // Shift the range if the compare is fed by an add. This is the range
469 // compare idiom as emitted by instcombine.
470 Value *CandidateVal = I->getOperand(0);
471 if(match(I->getOperand(0), m_Add(m_Value(RHSVal), m_ConstantInt(RHSC)))) {
472 Span = Span.subtract(RHSC->getValue());
473 CandidateVal = RHSVal;
474 }
475
476 // If this is an and/!= check, then we are looking to build the set of
477 // value that *don't* pass the and chain. I.e. to turn "x ugt 2" into
478 // x != 0 && x != 1.
479 if (!isEQ)
480 Span = Span.inverse();
481
482 // If there are a ton of values, we don't want to make a ginormous switch.
483 if (Span.getSetSize().ugt(8) || Span.isEmptySet()) {
484 return false;
Mehdi Amini9a25cb82014-11-19 20:09:11 +0000485 }
486
487 // If we already have a value for the switch, it has to match!
Mehdi Aminiffd01002014-11-20 22:40:25 +0000488 if(!setValueOnce(CandidateVal))
489 return false;
490
491 // Add all values from the range to the set
492 for (APInt Tmp = Span.getLower(); Tmp != Span.getUpper(); ++Tmp)
493 Vals.push_back(ConstantInt::get(I->getContext(), Tmp));
Mehdi Amini9a25cb82014-11-19 20:09:11 +0000494
495 UsedICmps++;
Mehdi Aminiffd01002014-11-20 22:40:25 +0000496 return true;
497
Mehdi Amini9a25cb82014-11-19 20:09:11 +0000498 }
499
Sanjay Patel09159b8f2015-06-24 20:40:57 +0000500 /// Given a potentially 'or'd or 'and'd together collection of icmp
Mehdi Aminiffd01002014-11-20 22:40:25 +0000501 /// eq/ne/lt/gt instructions that compare a value against a constant, extract
502 /// the value being compared, and stick the list constants into the Vals
503 /// vector.
504 /// One "Extra" case is allowed to differ from the other.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000505 void gather(Value *V) {
Mehdi Aminiffd01002014-11-20 22:40:25 +0000506 Instruction *I = dyn_cast<Instruction>(V);
507 bool isEQ = (I->getOpcode() == Instruction::Or);
Mehdi Amini9a25cb82014-11-19 20:09:11 +0000508
Mehdi Aminiffd01002014-11-20 22:40:25 +0000509 // Keep a stack (SmallVector for efficiency) for depth-first traversal
510 SmallVector<Value *, 8> DFT;
Gerolf Hoflehner2432bd02016-02-03 23:54:25 +0000511 SmallPtrSet<Value *, 8> Visited;
Mehdi Amini9a25cb82014-11-19 20:09:11 +0000512
Mehdi Aminiffd01002014-11-20 22:40:25 +0000513 // Initialize
Gerolf Hoflehner2432bd02016-02-03 23:54:25 +0000514 Visited.insert(V);
Mehdi Aminiffd01002014-11-20 22:40:25 +0000515 DFT.push_back(V);
Mehdi Amini9a25cb82014-11-19 20:09:11 +0000516
Mehdi Aminiffd01002014-11-20 22:40:25 +0000517 while(!DFT.empty()) {
518 V = DFT.pop_back_val();
Mehdi Amini9a25cb82014-11-19 20:09:11 +0000519
Mehdi Aminiffd01002014-11-20 22:40:25 +0000520 if (Instruction *I = dyn_cast<Instruction>(V)) {
521 // If it is a || (or && depending on isEQ), process the operands.
522 if (I->getOpcode() == (isEQ ? Instruction::Or : Instruction::And)) {
Gerolf Hoflehner2432bd02016-02-03 23:54:25 +0000523 if (Visited.insert(I->getOperand(1)).second)
524 DFT.push_back(I->getOperand(1));
525 if (Visited.insert(I->getOperand(0)).second)
526 DFT.push_back(I->getOperand(0));
Mehdi Aminiffd01002014-11-20 22:40:25 +0000527 continue;
528 }
Mehdi Amini9a25cb82014-11-19 20:09:11 +0000529
Mehdi Aminiffd01002014-11-20 22:40:25 +0000530 // Try to match the current instruction
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000531 if (matchInstruction(I, isEQ))
Mehdi Aminiffd01002014-11-20 22:40:25 +0000532 // Match succeed, continue the loop
533 continue;
Mehdi Amini9a25cb82014-11-19 20:09:11 +0000534 }
Timur Iskhodzhanov71526a32014-11-20 12:36:43 +0000535
Mehdi Aminiffd01002014-11-20 22:40:25 +0000536 // One element of the sequence of || (or &&) could not be match as a
537 // comparison against the same value as the others.
538 // We allow only one "Extra" case to be checked before the switch
539 if (!Extra) {
540 Extra = V;
Timur Iskhodzhanov71526a32014-11-20 12:36:43 +0000541 continue;
542 }
Mehdi Aminiffd01002014-11-20 22:40:25 +0000543 // Failed to parse a proper sequence, abort now
544 CompValue = nullptr;
545 break;
Chris Lattner5a177e62010-12-13 04:26:26 +0000546 }
Anton Korobeynikov1bfd1212008-02-20 11:26:25 +0000547 }
Mehdi Aminiffd01002014-11-20 22:40:25 +0000548};
Timur Iskhodzhanov71526a32014-11-20 12:36:43 +0000549
Alexander Kornienkof00654e2015-06-23 09:49:53 +0000550}
Nick Lewyckye87d54c2011-12-26 20:37:40 +0000551
Eli Friedmancb61afb2008-12-16 20:54:32 +0000552static void EraseTerminatorInstAndDCECond(TerminatorInst *TI) {
Craig Topperf40110f2014-04-25 05:29:35 +0000553 Instruction *Cond = nullptr;
Eli Friedmancb61afb2008-12-16 20:54:32 +0000554 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
555 Cond = dyn_cast<Instruction>(SI->getCondition());
556 } else if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
557 if (BI->isConditional())
558 Cond = dyn_cast<Instruction>(BI->getCondition());
Frits van Bommel8fb69ee2010-12-05 18:29:03 +0000559 } else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(TI)) {
560 Cond = dyn_cast<Instruction>(IBI->getAddress());
Eli Friedmancb61afb2008-12-16 20:54:32 +0000561 }
562
563 TI->eraseFromParent();
564 if (Cond) RecursivelyDeleteTriviallyDeadInstructions(Cond);
565}
566
Sanjay Patel09159b8f2015-06-24 20:40:57 +0000567/// Return true if the specified terminator checks
Chris Lattner8e84c122008-11-27 23:25:44 +0000568/// to see if a value is equal to constant integer value.
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000569Value *SimplifyCFGOpt::isValueEqualityComparison(TerminatorInst *TI) {
Craig Topperf40110f2014-04-25 05:29:35 +0000570 Value *CV = nullptr;
Chris Lattnera64923a2004-03-16 19:45:22 +0000571 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
572 // Do not permit merging of large switch instructions into their
573 // predecessors unless there is only one predecessor.
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000574 if (SI->getNumSuccessors()*std::distance(pred_begin(SI->getParent()),
575 pred_end(SI->getParent())) <= 128)
576 CV = SI->getCondition();
577 } else if (BranchInst *BI = dyn_cast<BranchInst>(TI))
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000578 if (BI->isConditional() && BI->getCondition()->hasOneUse())
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000579 if (ICmpInst *ICI = dyn_cast<ICmpInst>(BI->getCondition())) {
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000580 if (ICI->isEquality() && GetConstantInt(ICI->getOperand(1), DL))
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000581 CV = ICI->getOperand(0);
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000582 }
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000583
584 // Unwrap any lossless ptrtoint cast.
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000585 if (CV) {
Matt Arsenaultfa646592013-10-21 18:55:08 +0000586 if (PtrToIntInst *PTII = dyn_cast<PtrToIntInst>(CV)) {
587 Value *Ptr = PTII->getPointerOperand();
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000588 if (PTII->getType() == DL.getIntPtrType(Ptr->getType()))
Matt Arsenaultfa646592013-10-21 18:55:08 +0000589 CV = Ptr;
590 }
591 }
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000592 return CV;
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000593}
594
Sanjay Patel09159b8f2015-06-24 20:40:57 +0000595/// Given a value comparison instruction,
Bill Wendlingcaf1d222009-01-19 23:43:56 +0000596/// decode all of the 'cases' that it represents and return the 'default' block.
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000597BasicBlock *SimplifyCFGOpt::
Misha Brukmanb1c93172005-04-21 23:48:37 +0000598GetValueEqualityComparisonCases(TerminatorInst *TI,
Eric Christopherb65acc62012-07-02 23:22:21 +0000599 std::vector<ValueEqualityComparisonCase>
600 &Cases) {
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000601 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Eric Christopherb65acc62012-07-02 23:22:21 +0000602 Cases.reserve(SI->getNumCases());
603 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end(); i != e; ++i)
604 Cases.push_back(ValueEqualityComparisonCase(i.getCaseValue(),
605 i.getCaseSuccessor()));
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000606 return SI->getDefaultDest();
607 }
Eric Christopherb65acc62012-07-02 23:22:21 +0000608
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000609 BranchInst *BI = cast<BranchInst>(TI);
Reid Spencer266e42b2006-12-23 06:05:41 +0000610 ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
Eric Christopherb65acc62012-07-02 23:22:21 +0000611 BasicBlock *Succ = BI->getSuccessor(ICI->getPredicate() == ICmpInst::ICMP_NE);
612 Cases.push_back(ValueEqualityComparisonCase(GetConstantInt(ICI->getOperand(1),
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000613 DL),
Eric Christopherb65acc62012-07-02 23:22:21 +0000614 Succ));
Reid Spencer266e42b2006-12-23 06:05:41 +0000615 return BI->getSuccessor(ICI->getPredicate() == ICmpInst::ICMP_EQ);
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000616}
617
Eric Christopherb65acc62012-07-02 23:22:21 +0000618
Sanjay Patel09159b8f2015-06-24 20:40:57 +0000619/// Given a vector of bb/value pairs, remove any entries
Eric Christopherb65acc62012-07-02 23:22:21 +0000620/// in the list that match the specified block.
621static void EliminateBlockCases(BasicBlock *BB,
622 std::vector<ValueEqualityComparisonCase> &Cases) {
Benjamin Kramerc5b06782012-10-14 11:15:42 +0000623 Cases.erase(std::remove(Cases.begin(), Cases.end(), BB), Cases.end());
Eric Christopherb65acc62012-07-02 23:22:21 +0000624}
625
Sanjay Patel09159b8f2015-06-24 20:40:57 +0000626/// Return true if there are any keys in C1 that exist in C2 as well.
Eric Christopherb65acc62012-07-02 23:22:21 +0000627static bool
628ValuesOverlap(std::vector<ValueEqualityComparisonCase> &C1,
629 std::vector<ValueEqualityComparisonCase > &C2) {
630 std::vector<ValueEqualityComparisonCase> *V1 = &C1, *V2 = &C2;
631
632 // Make V1 be smaller than V2.
633 if (V1->size() > V2->size())
634 std::swap(V1, V2);
635
636 if (V1->size() == 0) return false;
637 if (V1->size() == 1) {
638 // Just scan V2.
639 ConstantInt *TheVal = (*V1)[0].Value;
640 for (unsigned i = 0, e = V2->size(); i != e; ++i)
641 if (TheVal == (*V2)[i].Value)
642 return true;
643 }
644
645 // Otherwise, just sort both lists and compare element by element.
646 array_pod_sort(V1->begin(), V1->end());
647 array_pod_sort(V2->begin(), V2->end());
648 unsigned i1 = 0, i2 = 0, e1 = V1->size(), e2 = V2->size();
649 while (i1 != e1 && i2 != e2) {
650 if ((*V1)[i1].Value == (*V2)[i2].Value)
651 return true;
652 if ((*V1)[i1].Value < (*V2)[i2].Value)
653 ++i1;
654 else
655 ++i2;
656 }
657 return false;
658}
659
Sanjay Patel09159b8f2015-06-24 20:40:57 +0000660/// If TI is known to be a terminator instruction and its block is known to
661/// only have a single predecessor block, check to see if that predecessor is
662/// also a value comparison with the same value, and if that comparison
663/// determines the outcome of this comparison. If so, simplify TI. This does a
664/// very limited form of jump threading.
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +0000665bool SimplifyCFGOpt::
666SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
Devang Patela7ec47d2011-05-18 20:35:38 +0000667 BasicBlock *Pred,
668 IRBuilder<> &Builder) {
Chris Lattner1cca9592005-02-24 06:17:52 +0000669 Value *PredVal = isValueEqualityComparison(Pred->getTerminator());
670 if (!PredVal) return false; // Not a value comparison in predecessor.
671
672 Value *ThisVal = isValueEqualityComparison(TI);
673 assert(ThisVal && "This isn't a value comparison!!");
674 if (ThisVal != PredVal) return false; // Different predicates.
675
Andrew Trick3051aa12012-08-29 21:46:38 +0000676 // TODO: Preserve branch weight metadata, similarly to how
677 // FoldValueComparisonIntoPredecessors preserves it.
678
Chris Lattner1cca9592005-02-24 06:17:52 +0000679 // Find out information about when control will move from Pred to TI's block.
Eric Christopherb65acc62012-07-02 23:22:21 +0000680 std::vector<ValueEqualityComparisonCase> PredCases;
Chris Lattner1cca9592005-02-24 06:17:52 +0000681 BasicBlock *PredDef = GetValueEqualityComparisonCases(Pred->getTerminator(),
682 PredCases);
Eric Christopherb65acc62012-07-02 23:22:21 +0000683 EliminateBlockCases(PredDef, PredCases); // Remove default from cases.
Misha Brukmanb1c93172005-04-21 23:48:37 +0000684
Chris Lattner1cca9592005-02-24 06:17:52 +0000685 // Find information about how control leaves this block.
Eric Christopherb65acc62012-07-02 23:22:21 +0000686 std::vector<ValueEqualityComparisonCase> ThisCases;
Chris Lattner1cca9592005-02-24 06:17:52 +0000687 BasicBlock *ThisDef = GetValueEqualityComparisonCases(TI, ThisCases);
Eric Christopherb65acc62012-07-02 23:22:21 +0000688 EliminateBlockCases(ThisDef, ThisCases); // Remove default from cases.
Chris Lattner1cca9592005-02-24 06:17:52 +0000689
690 // If TI's block is the default block from Pred's comparison, potentially
691 // simplify TI based on this knowledge.
692 if (PredDef == TI->getParent()) {
693 // If we are here, we know that the value is none of those cases listed in
694 // PredCases. If there are any cases in ThisCases that are in PredCases, we
695 // can simplify TI.
Eric Christopherb65acc62012-07-02 23:22:21 +0000696 if (!ValuesOverlap(PredCases, ThisCases))
Chris Lattner4088e2b2010-12-13 01:47:07 +0000697 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +0000698
Chris Lattner4088e2b2010-12-13 01:47:07 +0000699 if (isa<BranchInst>(TI)) {
700 // Okay, one of the successors of this condbr is dead. Convert it to a
701 // uncond br.
702 assert(ThisCases.size() == 1 && "Branch can only have one case!");
703 // Insert the new branch.
Devang Patela7ec47d2011-05-18 20:35:38 +0000704 Instruction *NI = Builder.CreateBr(ThisDef);
Chris Lattner4088e2b2010-12-13 01:47:07 +0000705 (void) NI;
Chris Lattner1cca9592005-02-24 06:17:52 +0000706
Chris Lattner4088e2b2010-12-13 01:47:07 +0000707 // Remove PHI node entries for the dead edge.
Eric Christopherb65acc62012-07-02 23:22:21 +0000708 ThisCases[0].Dest->removePredecessor(TI->getParent());
Chris Lattner1cca9592005-02-24 06:17:52 +0000709
Chris Lattner4088e2b2010-12-13 01:47:07 +0000710 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
711 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
Chris Lattner1cca9592005-02-24 06:17:52 +0000712
Chris Lattner4088e2b2010-12-13 01:47:07 +0000713 EraseTerminatorInstAndDCECond(TI);
714 return true;
Chris Lattner1cca9592005-02-24 06:17:52 +0000715 }
Andrew Trickf3cf1932012-08-29 21:46:36 +0000716
Chris Lattner4088e2b2010-12-13 01:47:07 +0000717 SwitchInst *SI = cast<SwitchInst>(TI);
718 // Okay, TI has cases that are statically dead, prune them away.
Eric Christopherb65acc62012-07-02 23:22:21 +0000719 SmallPtrSet<Constant*, 16> DeadCases;
720 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
721 DeadCases.insert(PredCases[i].Value);
Chris Lattner1cca9592005-02-24 06:17:52 +0000722
David Greene725c7c32010-01-05 01:26:52 +0000723 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
Chris Lattner4088e2b2010-12-13 01:47:07 +0000724 << "Through successor TI: " << *TI);
Chris Lattner1cca9592005-02-24 06:17:52 +0000725
Manman Ren8691e522012-09-14 21:53:06 +0000726 // Collect branch weights into a vector.
727 SmallVector<uint32_t, 8> Weights;
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +0000728 MDNode *MD = SI->getMetadata(LLVMContext::MD_prof);
Manman Ren8691e522012-09-14 21:53:06 +0000729 bool HasWeight = MD && (MD->getNumOperands() == 2 + SI->getNumCases());
730 if (HasWeight)
731 for (unsigned MD_i = 1, MD_e = MD->getNumOperands(); MD_i < MD_e;
732 ++MD_i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000733 ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(MD_i));
Manman Ren8691e522012-09-14 21:53:06 +0000734 Weights.push_back(CI->getValue().getZExtValue());
735 }
Eric Christopherb65acc62012-07-02 23:22:21 +0000736 for (SwitchInst::CaseIt i = SI->case_end(), e = SI->case_begin(); i != e;) {
737 --i;
738 if (DeadCases.count(i.getCaseValue())) {
Manman Ren8691e522012-09-14 21:53:06 +0000739 if (HasWeight) {
740 std::swap(Weights[i.getCaseIndex()+1], Weights.back());
741 Weights.pop_back();
742 }
Eric Christopherb65acc62012-07-02 23:22:21 +0000743 i.getCaseSuccessor()->removePredecessor(TI->getParent());
744 SI->removeCase(i);
745 }
746 }
Manman Ren97c18762012-10-11 22:28:34 +0000747 if (HasWeight && Weights.size() >= 2)
Manman Ren8691e522012-09-14 21:53:06 +0000748 SI->setMetadata(LLVMContext::MD_prof,
749 MDBuilder(SI->getParent()->getContext()).
750 createBranchWeights(Weights));
Eric Christopherb65acc62012-07-02 23:22:21 +0000751
752 DEBUG(dbgs() << "Leaving: " << *TI << "\n");
Chris Lattner1cca9592005-02-24 06:17:52 +0000753 return true;
754 }
Andrew Trickf3cf1932012-08-29 21:46:36 +0000755
Chris Lattner4088e2b2010-12-13 01:47:07 +0000756 // Otherwise, TI's block must correspond to some matched value. Find out
757 // which value (or set of values) this is.
Craig Topperf40110f2014-04-25 05:29:35 +0000758 ConstantInt *TIV = nullptr;
Chris Lattner4088e2b2010-12-13 01:47:07 +0000759 BasicBlock *TIBB = TI->getParent();
Eric Christopherb65acc62012-07-02 23:22:21 +0000760 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
761 if (PredCases[i].Dest == TIBB) {
Craig Topperf40110f2014-04-25 05:29:35 +0000762 if (TIV)
Eric Christopherb65acc62012-07-02 23:22:21 +0000763 return false; // Cannot handle multiple values coming to this block.
764 TIV = PredCases[i].Value;
765 }
766 assert(TIV && "No edge from pred to succ?");
Chris Lattner4088e2b2010-12-13 01:47:07 +0000767
768 // Okay, we found the one constant that our value can be if we get into TI's
769 // BB. Find out which successor will unconditionally be branched to.
Craig Topperf40110f2014-04-25 05:29:35 +0000770 BasicBlock *TheRealDest = nullptr;
Eric Christopherb65acc62012-07-02 23:22:21 +0000771 for (unsigned i = 0, e = ThisCases.size(); i != e; ++i)
772 if (ThisCases[i].Value == TIV) {
773 TheRealDest = ThisCases[i].Dest;
774 break;
775 }
Chris Lattner4088e2b2010-12-13 01:47:07 +0000776
777 // If not handled by any explicit cases, it is handled by the default case.
Craig Topperf40110f2014-04-25 05:29:35 +0000778 if (!TheRealDest) TheRealDest = ThisDef;
Chris Lattner4088e2b2010-12-13 01:47:07 +0000779
780 // Remove PHI node entries for dead edges.
781 BasicBlock *CheckEdge = TheRealDest;
Sanjay Patel5781d842016-03-12 16:52:17 +0000782 for (BasicBlock *Succ : successors(TIBB))
783 if (Succ != CheckEdge)
784 Succ->removePredecessor(TIBB);
Chris Lattner4088e2b2010-12-13 01:47:07 +0000785 else
Craig Topperf40110f2014-04-25 05:29:35 +0000786 CheckEdge = nullptr;
Chris Lattner4088e2b2010-12-13 01:47:07 +0000787
788 // Insert the new branch.
Devang Patela7ec47d2011-05-18 20:35:38 +0000789 Instruction *NI = Builder.CreateBr(TheRealDest);
Chris Lattner4088e2b2010-12-13 01:47:07 +0000790 (void) NI;
791
792 DEBUG(dbgs() << "Threading pred instr: " << *Pred->getTerminator()
793 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
794
795 EraseTerminatorInstAndDCECond(TI);
796 return true;
Chris Lattner1cca9592005-02-24 06:17:52 +0000797}
798
Dale Johannesen7f99d222009-03-12 21:01:11 +0000799namespace {
Sanjay Patel09159b8f2015-06-24 20:40:57 +0000800 /// This class implements a stable ordering of constant
Dale Johannesen7f99d222009-03-12 21:01:11 +0000801 /// integers that does not depend on their address. This is important for
802 /// applications that sort ConstantInt's to ensure uniqueness.
803 struct ConstantIntOrdering {
804 bool operator()(const ConstantInt *LHS, const ConstantInt *RHS) const {
805 return LHS->getValue().ult(RHS->getValue());
806 }
807 };
808}
Dale Johannesen5a41b2d2009-03-12 01:00:26 +0000809
Benjamin Kramer8817cca2013-09-22 14:09:50 +0000810static int ConstantIntSortPredicate(ConstantInt *const *P1,
811 ConstantInt *const *P2) {
812 const ConstantInt *LHS = *P1;
813 const ConstantInt *RHS = *P2;
Benjamin Kramer7d537ae2016-02-20 10:40:42 +0000814 if (LHS == RHS)
Chris Lattnere893e262010-12-15 04:52:41 +0000815 return 0;
Benjamin Kramer7d537ae2016-02-20 10:40:42 +0000816 return LHS->getValue().ult(RHS->getValue()) ? 1 : -1;
Chris Lattner7c8e6042010-12-13 02:00:58 +0000817}
818
Andrew Trick3051aa12012-08-29 21:46:38 +0000819static inline bool HasBranchWeights(const Instruction* I) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +0000820 MDNode *ProfMD = I->getMetadata(LLVMContext::MD_prof);
Andrew Trick3051aa12012-08-29 21:46:38 +0000821 if (ProfMD && ProfMD->getOperand(0))
822 if (MDString* MDS = dyn_cast<MDString>(ProfMD->getOperand(0)))
823 return MDS->getString().equals("branch_weights");
824
825 return false;
826}
827
Manman Ren571d9e42012-09-11 17:43:35 +0000828/// Get Weights of a given TerminatorInst, the default weight is at the front
829/// of the vector. If TI is a conditional eq, we need to swap the branch-weight
830/// metadata.
831static void GetBranchWeights(TerminatorInst *TI,
832 SmallVectorImpl<uint64_t> &Weights) {
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +0000833 MDNode *MD = TI->getMetadata(LLVMContext::MD_prof);
Manman Ren571d9e42012-09-11 17:43:35 +0000834 assert(MD);
835 for (unsigned i = 1, e = MD->getNumOperands(); i < e; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000836 ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(i));
Manman Ren571d9e42012-09-11 17:43:35 +0000837 Weights.push_back(CI->getValue().getZExtValue());
Andrew Trick3051aa12012-08-29 21:46:38 +0000838 }
839
Manman Ren571d9e42012-09-11 17:43:35 +0000840 // If TI is a conditional eq, the default case is the false case,
841 // and the corresponding branch-weight data is at index 2. We swap the
842 // default weight to be the first entry.
843 if (BranchInst* BI = dyn_cast<BranchInst>(TI)) {
844 assert(Weights.size() == 2);
845 ICmpInst *ICI = cast<ICmpInst>(BI->getCondition());
846 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
847 std::swap(Weights.front(), Weights.back());
Andrew Trick3051aa12012-08-29 21:46:38 +0000848 }
849}
850
Manman Renf1cb16e2014-01-27 23:39:03 +0000851/// Keep halving the weights until all can fit in uint32_t.
Andrew Trick3051aa12012-08-29 21:46:38 +0000852static void FitWeights(MutableArrayRef<uint64_t> Weights) {
Benjamin Kramer79da9412014-03-09 14:42:55 +0000853 uint64_t Max = *std::max_element(Weights.begin(), Weights.end());
854 if (Max > UINT_MAX) {
855 unsigned Offset = 32 - countLeadingZeros(Max);
856 for (uint64_t &I : Weights)
857 I >>= Offset;
Manman Renf1cb16e2014-01-27 23:39:03 +0000858 }
Andrew Trick3051aa12012-08-29 21:46:38 +0000859}
860
Sanjay Patel09159b8f2015-06-24 20:40:57 +0000861/// The specified terminator is a value equality comparison instruction
862/// (either a switch or a branch on "X == c").
Bill Wendlingcaf1d222009-01-19 23:43:56 +0000863/// See if any of the predecessors of the terminator block are value comparisons
864/// on the same value. If so, and if safe to do so, fold them together.
Devang Patel58380552011-05-18 20:53:17 +0000865bool SimplifyCFGOpt::FoldValueComparisonIntoPredecessors(TerminatorInst *TI,
866 IRBuilder<> &Builder) {
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000867 BasicBlock *BB = TI->getParent();
868 Value *CV = isValueEqualityComparison(TI); // CondVal
869 assert(CV && "Not a comparison?");
870 bool Changed = false;
871
Chris Lattner6b39cb92008-02-18 07:42:56 +0000872 SmallVector<BasicBlock*, 16> Preds(pred_begin(BB), pred_end(BB));
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000873 while (!Preds.empty()) {
Dan Gohman9a6fef02009-05-06 17:22:41 +0000874 BasicBlock *Pred = Preds.pop_back_val();
Misha Brukmanb1c93172005-04-21 23:48:37 +0000875
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000876 // See if the predecessor is a comparison with the same value.
877 TerminatorInst *PTI = Pred->getTerminator();
878 Value *PCV = isValueEqualityComparison(PTI); // PredCondVal
879
880 if (PCV == CV && SafeToMergeTerminators(TI, PTI)) {
881 // Figure out which 'cases' to copy from SI to PSI.
Eric Christopherb65acc62012-07-02 23:22:21 +0000882 std::vector<ValueEqualityComparisonCase> BBCases;
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000883 BasicBlock *BBDefault = GetValueEqualityComparisonCases(TI, BBCases);
884
Eric Christopherb65acc62012-07-02 23:22:21 +0000885 std::vector<ValueEqualityComparisonCase> PredCases;
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000886 BasicBlock *PredDefault = GetValueEqualityComparisonCases(PTI, PredCases);
887
888 // Based on whether the default edge from PTI goes to BB or not, fill in
889 // PredCases and PredDefault with the new switch cases we would like to
890 // build.
Chris Lattner6b39cb92008-02-18 07:42:56 +0000891 SmallVector<BasicBlock*, 8> NewSuccessors;
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000892
Andrew Trick3051aa12012-08-29 21:46:38 +0000893 // Update the branch weight metadata along the way
894 SmallVector<uint64_t, 8> Weights;
Andrew Trick3051aa12012-08-29 21:46:38 +0000895 bool PredHasWeights = HasBranchWeights(PTI);
896 bool SuccHasWeights = HasBranchWeights(TI);
897
Manman Ren5e5049d2012-09-14 19:05:19 +0000898 if (PredHasWeights) {
Manman Ren571d9e42012-09-11 17:43:35 +0000899 GetBranchWeights(PTI, Weights);
Andrew Trick7656f6d2012-11-15 18:40:31 +0000900 // branch-weight metadata is inconsistent here.
Manman Ren5e5049d2012-09-14 19:05:19 +0000901 if (Weights.size() != 1 + PredCases.size())
902 PredHasWeights = SuccHasWeights = false;
903 } else if (SuccHasWeights)
Andrew Trick3051aa12012-08-29 21:46:38 +0000904 // If there are no predecessor weights but there are successor weights,
905 // populate Weights with 1, which will later be scaled to the sum of
906 // successor's weights
907 Weights.assign(1 + PredCases.size(), 1);
Andrew Trick3051aa12012-08-29 21:46:38 +0000908
Manman Ren571d9e42012-09-11 17:43:35 +0000909 SmallVector<uint64_t, 8> SuccWeights;
Manman Ren5e5049d2012-09-14 19:05:19 +0000910 if (SuccHasWeights) {
Manman Ren571d9e42012-09-11 17:43:35 +0000911 GetBranchWeights(TI, SuccWeights);
Andrew Trick7656f6d2012-11-15 18:40:31 +0000912 // branch-weight metadata is inconsistent here.
Manman Ren5e5049d2012-09-14 19:05:19 +0000913 if (SuccWeights.size() != 1 + BBCases.size())
914 PredHasWeights = SuccHasWeights = false;
915 } else if (PredHasWeights)
Manman Ren571d9e42012-09-11 17:43:35 +0000916 SuccWeights.assign(1 + BBCases.size(), 1);
Andrew Trick3051aa12012-08-29 21:46:38 +0000917
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000918 if (PredDefault == BB) {
919 // If this is the default destination from PTI, only the edges in TI
920 // that don't occur in PTI, or that branch to BB will be activated.
Eric Christopherb65acc62012-07-02 23:22:21 +0000921 std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
922 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
923 if (PredCases[i].Dest != BB)
924 PTIHandled.insert(PredCases[i].Value);
925 else {
926 // The default destination is BB, we don't need explicit targets.
927 std::swap(PredCases[i], PredCases.back());
Andrew Trick3051aa12012-08-29 21:46:38 +0000928
Manman Ren571d9e42012-09-11 17:43:35 +0000929 if (PredHasWeights || SuccHasWeights) {
930 // Increase weight for the default case.
931 Weights[0] += Weights[i+1];
Andrew Trick3051aa12012-08-29 21:46:38 +0000932 std::swap(Weights[i+1], Weights.back());
933 Weights.pop_back();
934 }
935
Eric Christopherb65acc62012-07-02 23:22:21 +0000936 PredCases.pop_back();
937 --i; --e;
938 }
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000939
Eric Christopherb65acc62012-07-02 23:22:21 +0000940 // Reconstruct the new switch statement we will be building.
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000941 if (PredDefault != BBDefault) {
942 PredDefault->removePredecessor(Pred);
943 PredDefault = BBDefault;
944 NewSuccessors.push_back(BBDefault);
945 }
Andrew Trick3051aa12012-08-29 21:46:38 +0000946
Manman Ren571d9e42012-09-11 17:43:35 +0000947 unsigned CasesFromPred = Weights.size();
948 uint64_t ValidTotalSuccWeight = 0;
Eric Christopherb65acc62012-07-02 23:22:21 +0000949 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
950 if (!PTIHandled.count(BBCases[i].Value) &&
951 BBCases[i].Dest != BBDefault) {
952 PredCases.push_back(BBCases[i]);
953 NewSuccessors.push_back(BBCases[i].Dest);
Manman Ren571d9e42012-09-11 17:43:35 +0000954 if (SuccHasWeights || PredHasWeights) {
955 // The default weight is at index 0, so weight for the ith case
956 // should be at index i+1. Scale the cases from successor by
957 // PredDefaultWeight (Weights[0]).
958 Weights.push_back(Weights[0] * SuccWeights[i+1]);
959 ValidTotalSuccWeight += SuccWeights[i+1];
Andrew Trick3051aa12012-08-29 21:46:38 +0000960 }
Eric Christopherb65acc62012-07-02 23:22:21 +0000961 }
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000962
Manman Ren571d9e42012-09-11 17:43:35 +0000963 if (SuccHasWeights || PredHasWeights) {
964 ValidTotalSuccWeight += SuccWeights[0];
965 // Scale the cases from predecessor by ValidTotalSuccWeight.
966 for (unsigned i = 1; i < CasesFromPred; ++i)
967 Weights[i] *= ValidTotalSuccWeight;
968 // Scale the default weight by SuccDefaultWeight (SuccWeights[0]).
969 Weights[0] *= SuccWeights[0];
970 }
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000971 } else {
972 // If this is not the default destination from PSI, only the edges
973 // in SI that occur in PSI with a destination of BB will be
974 // activated.
Eric Christopherb65acc62012-07-02 23:22:21 +0000975 std::set<ConstantInt*, ConstantIntOrdering> PTIHandled;
Manman Rend81b8e82012-09-14 17:29:56 +0000976 std::map<ConstantInt*, uint64_t> WeightsForHandled;
Eric Christopherb65acc62012-07-02 23:22:21 +0000977 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
978 if (PredCases[i].Dest == BB) {
979 PTIHandled.insert(PredCases[i].Value);
Manman Rend81b8e82012-09-14 17:29:56 +0000980
981 if (PredHasWeights || SuccHasWeights) {
982 WeightsForHandled[PredCases[i].Value] = Weights[i+1];
983 std::swap(Weights[i+1], Weights.back());
984 Weights.pop_back();
985 }
986
Eric Christopherb65acc62012-07-02 23:22:21 +0000987 std::swap(PredCases[i], PredCases.back());
988 PredCases.pop_back();
989 --i; --e;
990 }
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000991
992 // Okay, now we know which constants were sent to BB from the
993 // predecessor. Figure out where they will all go now.
Eric Christopherb65acc62012-07-02 23:22:21 +0000994 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
995 if (PTIHandled.count(BBCases[i].Value)) {
996 // If this is one we are capable of getting...
Manman Rend81b8e82012-09-14 17:29:56 +0000997 if (PredHasWeights || SuccHasWeights)
998 Weights.push_back(WeightsForHandled[BBCases[i].Value]);
Eric Christopherb65acc62012-07-02 23:22:21 +0000999 PredCases.push_back(BBCases[i]);
1000 NewSuccessors.push_back(BBCases[i].Dest);
1001 PTIHandled.erase(BBCases[i].Value);// This constant is taken care of
1002 }
1003
Chris Lattnerd3e6ae22004-02-28 21:28:10 +00001004 // If there are any constants vectored to BB that TI doesn't handle,
1005 // they must go to the default destination of TI.
Andrew Trickf3cf1932012-08-29 21:46:36 +00001006 for (std::set<ConstantInt*, ConstantIntOrdering>::iterator I =
Eric Christopherb65acc62012-07-02 23:22:21 +00001007 PTIHandled.begin(),
1008 E = PTIHandled.end(); I != E; ++I) {
Andrew Trick90f50292012-11-15 18:40:29 +00001009 if (PredHasWeights || SuccHasWeights)
1010 Weights.push_back(WeightsForHandled[*I]);
Eric Christopherb65acc62012-07-02 23:22:21 +00001011 PredCases.push_back(ValueEqualityComparisonCase(*I, BBDefault));
Chris Lattnerd3e6ae22004-02-28 21:28:10 +00001012 NewSuccessors.push_back(BBDefault);
Eric Christopherb65acc62012-07-02 23:22:21 +00001013 }
Chris Lattnerd3e6ae22004-02-28 21:28:10 +00001014 }
1015
1016 // Okay, at this point, we know which new successor Pred will get. Make
1017 // sure we update the number of entries in the PHI nodes for these
1018 // successors.
Sanjay Patelf4b34b72015-09-10 16:25:38 +00001019 for (BasicBlock *NewSuccessor : NewSuccessors)
1020 AddPredecessorToBlock(NewSuccessor, Pred, BB);
Chris Lattnerd3e6ae22004-02-28 21:28:10 +00001021
Devang Patel58380552011-05-18 20:53:17 +00001022 Builder.SetInsertPoint(PTI);
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +00001023 // Convert pointer to int before we switch.
Duncan Sands19d0b472010-02-16 11:11:14 +00001024 if (CV->getType()->isPointerTy()) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001025 CV = Builder.CreatePtrToInt(CV, DL.getIntPtrType(CV->getType()),
Devang Patel58380552011-05-18 20:53:17 +00001026 "magicptr");
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +00001027 }
1028
Chris Lattnerd3e6ae22004-02-28 21:28:10 +00001029 // Now that the successors are updated, create the new Switch instruction.
Devang Patel58380552011-05-18 20:53:17 +00001030 SwitchInst *NewSI = Builder.CreateSwitch(CV, PredDefault,
1031 PredCases.size());
Devang Patelb849cd52011-05-17 23:29:05 +00001032 NewSI->setDebugLoc(PTI->getDebugLoc());
Sanjay Patel5e7bd912015-09-10 16:15:21 +00001033 for (ValueEqualityComparisonCase &V : PredCases)
1034 NewSI->addCase(V.Value, V.Dest);
Chris Lattner3215bb62005-01-01 16:02:12 +00001035
Andrew Trick3051aa12012-08-29 21:46:38 +00001036 if (PredHasWeights || SuccHasWeights) {
1037 // Halve the weights if any of them cannot fit in an uint32_t
1038 FitWeights(Weights);
1039
1040 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
1041
1042 NewSI->setMetadata(LLVMContext::MD_prof,
1043 MDBuilder(BB->getContext()).
1044 createBranchWeights(MDWeights));
1045 }
1046
Eli Friedmancb61afb2008-12-16 20:54:32 +00001047 EraseTerminatorInstAndDCECond(PTI);
Chris Lattner3215bb62005-01-01 16:02:12 +00001048
Chris Lattnerd3e6ae22004-02-28 21:28:10 +00001049 // Okay, last check. If BB is still a successor of PSI, then we must
1050 // have an infinite loop case. If so, add an infinitely looping block
1051 // to handle the case to preserve the behavior of the code.
Craig Topperf40110f2014-04-25 05:29:35 +00001052 BasicBlock *InfLoopBlock = nullptr;
Chris Lattnerd3e6ae22004-02-28 21:28:10 +00001053 for (unsigned i = 0, e = NewSI->getNumSuccessors(); i != e; ++i)
1054 if (NewSI->getSuccessor(i) == BB) {
Craig Topperf40110f2014-04-25 05:29:35 +00001055 if (!InfLoopBlock) {
Chris Lattner80b03a12008-07-13 22:23:11 +00001056 // Insert it at the end of the function, because it's either code,
Chris Lattnerd3e6ae22004-02-28 21:28:10 +00001057 // or it won't matter if it's hot. :)
Owen Anderson55f1c092009-08-13 21:58:54 +00001058 InfLoopBlock = BasicBlock::Create(BB->getContext(),
1059 "infloop", BB->getParent());
Gabor Greife9ecc682008-04-06 20:25:17 +00001060 BranchInst::Create(InfLoopBlock, InfLoopBlock);
Chris Lattnerd3e6ae22004-02-28 21:28:10 +00001061 }
1062 NewSI->setSuccessor(i, InfLoopBlock);
1063 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00001064
Chris Lattnerd3e6ae22004-02-28 21:28:10 +00001065 Changed = true;
1066 }
1067 }
1068 return Changed;
1069}
1070
Sanjay Patel09159b8f2015-06-24 20:40:57 +00001071// If we would need to insert a select that uses the value of this invoke
1072// (comments in HoistThenElseCodeToIf explain why we would need to do this), we
1073// can't hoist the invoke, as there is nowhere to put the select in this case.
Dale Johannesen9df78ee2009-06-15 20:59:27 +00001074static bool isSafeToHoistInvoke(BasicBlock *BB1, BasicBlock *BB2,
1075 Instruction *I1, Instruction *I2) {
Sanjay Patel5781d842016-03-12 16:52:17 +00001076 for (BasicBlock *Succ : successors(BB1)) {
Dale Johannesen9df78ee2009-06-15 20:59:27 +00001077 PHINode *PN;
Sanjay Patel5781d842016-03-12 16:52:17 +00001078 for (BasicBlock::iterator BBI = Succ->begin();
Dale Johannesen9df78ee2009-06-15 20:59:27 +00001079 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
1080 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1081 Value *BB2V = PN->getIncomingValueForBlock(BB2);
1082 if (BB1V != BB2V && (BB1V==I1 || BB2V==I2)) {
1083 return false;
1084 }
1085 }
1086 }
1087 return true;
1088}
1089
Arnold Schwaighoferd7d010e2014-10-10 01:27:02 +00001090static bool passingValueIsAlwaysUndefined(Value *V, Instruction *I);
1091
Sanjay Patel09159b8f2015-06-24 20:40:57 +00001092/// Given a conditional branch that goes to BB1 and BB2, hoist any common code
1093/// in the two blocks up into the branch block. The caller of this function
1094/// guarantees that BI's block dominates BB1 and BB2.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001095static bool HoistThenElseCodeToIf(BranchInst *BI,
Chad Rosier54390052015-02-23 19:15:16 +00001096 const TargetTransformInfo &TTI) {
Chris Lattner389cfac2004-11-30 00:29:14 +00001097 // This does very trivial matching, with limited scanning, to find identical
1098 // instructions in the two blocks. In particular, we don't want to get into
1099 // O(M*N) situations here where M and N are the sizes of BB1 and BB2. As
1100 // such, we currently just scan for obviously identical instructions in an
1101 // identical order.
1102 BasicBlock *BB1 = BI->getSuccessor(0); // The true destination.
1103 BasicBlock *BB2 = BI->getSuccessor(1); // The false destination
1104
Devang Patelf10e2872009-02-04 00:03:08 +00001105 BasicBlock::iterator BB1_Itr = BB1->begin();
1106 BasicBlock::iterator BB2_Itr = BB2->begin();
1107
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001108 Instruction *I1 = &*BB1_Itr++, *I2 = &*BB2_Itr++;
Devang Patel197c3522011-04-07 17:27:36 +00001109 // Skip debug info if it is not identical.
1110 DbgInfoIntrinsic *DBI1 = dyn_cast<DbgInfoIntrinsic>(I1);
1111 DbgInfoIntrinsic *DBI2 = dyn_cast<DbgInfoIntrinsic>(I2);
1112 if (!DBI1 || !DBI2 || !DBI1->isIdenticalToWhenDefined(DBI2)) {
1113 while (isa<DbgInfoIntrinsic>(I1))
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001114 I1 = &*BB1_Itr++;
Devang Patel197c3522011-04-07 17:27:36 +00001115 while (isa<DbgInfoIntrinsic>(I2))
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001116 I2 = &*BB2_Itr++;
Devang Patel197c3522011-04-07 17:27:36 +00001117 }
Devang Patele48ddf82011-04-07 00:30:15 +00001118 if (isa<PHINode>(I1) || !I1->isIdenticalToWhenDefined(I2) ||
Dale Johannesen9df78ee2009-06-15 20:59:27 +00001119 (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2)))
Chris Lattner389cfac2004-11-30 00:29:14 +00001120 return false;
1121
Chris Lattner389cfac2004-11-30 00:29:14 +00001122 BasicBlock *BIParent = BI->getParent();
Chris Lattner389cfac2004-11-30 00:29:14 +00001123
David Majnemerc82f27a2013-06-03 20:43:12 +00001124 bool Changed = false;
Chris Lattner389cfac2004-11-30 00:29:14 +00001125 do {
1126 // If we are hoisting the terminator instruction, don't move one (making a
1127 // broken BB), instead clone it, and remove BI.
1128 if (isa<TerminatorInst>(I1))
1129 goto HoistTerminator;
Misha Brukmanb1c93172005-04-21 23:48:37 +00001130
Chad Rosier54390052015-02-23 19:15:16 +00001131 if (!TTI.isProfitableToHoist(I1) || !TTI.isProfitableToHoist(I2))
1132 return Changed;
1133
Chris Lattner389cfac2004-11-30 00:29:14 +00001134 // For a normal instruction, we just move one to right before the branch,
1135 // then replace all uses of the other with the first. Finally, we remove
1136 // the now redundant second instruction.
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001137 BIParent->getInstList().splice(BI->getIterator(), BB1->getInstList(), I1);
Chris Lattner389cfac2004-11-30 00:29:14 +00001138 if (!I2->use_empty())
1139 I2->replaceAllUsesWith(I1);
Dan Gohmanc8a27f22009-08-25 22:11:20 +00001140 I1->intersectOptionalDataWith(I2);
Rafael Espindolaea46c322014-08-15 15:46:38 +00001141 unsigned KnownIDs[] = {
Piotr Padlewskidc9b2cf2015-10-02 22:12:22 +00001142 LLVMContext::MD_tbaa, LLVMContext::MD_range,
1143 LLVMContext::MD_fpmath, LLVMContext::MD_invariant_load,
Artur Pilipenko5c5011d2015-11-02 17:53:51 +00001144 LLVMContext::MD_nonnull, LLVMContext::MD_invariant_group,
1145 LLVMContext::MD_align, LLVMContext::MD_dereferenceable,
Hal Finkele4c0c162016-04-26 02:06:06 +00001146 LLVMContext::MD_dereferenceable_or_null,
1147 LLVMContext::MD_mem_parallel_loop_access};
Rafael Espindolaea46c322014-08-15 15:46:38 +00001148 combineMetadata(I1, I2, KnownIDs);
Chris Lattnerd7beca32010-12-14 06:17:25 +00001149 I2->eraseFromParent();
David Majnemerc82f27a2013-06-03 20:43:12 +00001150 Changed = true;
Misha Brukmanb1c93172005-04-21 23:48:37 +00001151
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001152 I1 = &*BB1_Itr++;
1153 I2 = &*BB2_Itr++;
Devang Patel197c3522011-04-07 17:27:36 +00001154 // Skip debug info if it is not identical.
1155 DbgInfoIntrinsic *DBI1 = dyn_cast<DbgInfoIntrinsic>(I1);
1156 DbgInfoIntrinsic *DBI2 = dyn_cast<DbgInfoIntrinsic>(I2);
1157 if (!DBI1 || !DBI2 || !DBI1->isIdenticalToWhenDefined(DBI2)) {
1158 while (isa<DbgInfoIntrinsic>(I1))
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001159 I1 = &*BB1_Itr++;
Devang Patel197c3522011-04-07 17:27:36 +00001160 while (isa<DbgInfoIntrinsic>(I2))
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001161 I2 = &*BB2_Itr++;
Devang Patel197c3522011-04-07 17:27:36 +00001162 }
Devang Patele48ddf82011-04-07 00:30:15 +00001163 } while (I1->isIdenticalToWhenDefined(I2));
Chris Lattner389cfac2004-11-30 00:29:14 +00001164
1165 return true;
1166
1167HoistTerminator:
Dale Johannesen9df78ee2009-06-15 20:59:27 +00001168 // It may not be possible to hoist an invoke.
1169 if (isa<InvokeInst>(I1) && !isSafeToHoistInvoke(BB1, BB2, I1, I2))
David Majnemerc82f27a2013-06-03 20:43:12 +00001170 return Changed;
1171
Sanjay Patel5781d842016-03-12 16:52:17 +00001172 for (BasicBlock *Succ : successors(BB1)) {
David Majnemerc82f27a2013-06-03 20:43:12 +00001173 PHINode *PN;
Sanjay Patel5781d842016-03-12 16:52:17 +00001174 for (BasicBlock::iterator BBI = Succ->begin();
David Majnemerc82f27a2013-06-03 20:43:12 +00001175 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
1176 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1177 Value *BB2V = PN->getIncomingValueForBlock(BB2);
1178 if (BB1V == BB2V)
1179 continue;
1180
Arnold Schwaighoferd7d010e2014-10-10 01:27:02 +00001181 // Check for passingValueIsAlwaysUndefined here because we would rather
1182 // eliminate undefined control flow then converting it to a select.
1183 if (passingValueIsAlwaysUndefined(BB1V, PN) ||
1184 passingValueIsAlwaysUndefined(BB2V, PN))
1185 return Changed;
1186
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001187 if (isa<ConstantExpr>(BB1V) && !isSafeToSpeculativelyExecute(BB1V))
David Majnemerc82f27a2013-06-03 20:43:12 +00001188 return Changed;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001189 if (isa<ConstantExpr>(BB2V) && !isSafeToSpeculativelyExecute(BB2V))
David Majnemerc82f27a2013-06-03 20:43:12 +00001190 return Changed;
1191 }
1192 }
Dale Johannesen9df78ee2009-06-15 20:59:27 +00001193
Chris Lattner389cfac2004-11-30 00:29:14 +00001194 // Okay, it is safe to hoist the terminator.
Nick Lewycky42fb7452009-09-27 07:38:41 +00001195 Instruction *NT = I1->clone();
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001196 BIParent->getInstList().insert(BI->getIterator(), NT);
Benjamin Kramerccce8ba2010-01-05 13:12:22 +00001197 if (!NT->getType()->isVoidTy()) {
Chris Lattner389cfac2004-11-30 00:29:14 +00001198 I1->replaceAllUsesWith(NT);
1199 I2->replaceAllUsesWith(NT);
Chris Lattner8dd4cae2007-02-11 01:37:51 +00001200 NT->takeName(I1);
Chris Lattner389cfac2004-11-30 00:29:14 +00001201 }
1202
Mehdi Aminiba9fba82016-03-13 21:05:13 +00001203 IRBuilder<NoFolder> Builder(NT);
Chris Lattner389cfac2004-11-30 00:29:14 +00001204 // Hoisting one of the terminators from our successor is a great thing.
1205 // Unfortunately, the successors of the if/else blocks may have PHI nodes in
1206 // them. If they do, all PHI entries for BB1/BB2 must agree for all PHI
1207 // nodes, so we insert select instruction to compute the final result.
1208 std::map<std::pair<Value*,Value*>, SelectInst*> InsertedSelects;
Sanjay Patel5781d842016-03-12 16:52:17 +00001209 for (BasicBlock *Succ : successors(BB1)) {
Chris Lattner389cfac2004-11-30 00:29:14 +00001210 PHINode *PN;
Sanjay Patel5781d842016-03-12 16:52:17 +00001211 for (BasicBlock::iterator BBI = Succ->begin();
Chris Lattner01944572004-11-30 07:47:34 +00001212 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
Chris Lattner389cfac2004-11-30 00:29:14 +00001213 Value *BB1V = PN->getIncomingValueForBlock(BB1);
1214 Value *BB2V = PN->getIncomingValueForBlock(BB2);
Chris Lattner4088e2b2010-12-13 01:47:07 +00001215 if (BB1V == BB2V) continue;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001216
Chris Lattner4088e2b2010-12-13 01:47:07 +00001217 // These values do not agree. Insert a select instruction before NT
1218 // that determines the right value.
1219 SelectInst *&SI = InsertedSelects[std::make_pair(BB1V, BB2V)];
Craig Topperf40110f2014-04-25 05:29:35 +00001220 if (!SI)
Devang Patel1407fb42011-05-19 20:52:46 +00001221 SI = cast<SelectInst>
1222 (Builder.CreateSelect(BI->getCondition(), BB1V, BB2V,
Sanjay Patel29dea0d2016-04-26 23:15:48 +00001223 BB1V->getName() + "." + BB2V->getName(), BI));
Devang Patel1407fb42011-05-19 20:52:46 +00001224
Chris Lattner4088e2b2010-12-13 01:47:07 +00001225 // Make the PHI node use the select for all incoming values for BB1/BB2
1226 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1227 if (PN->getIncomingBlock(i) == BB1 || PN->getIncomingBlock(i) == BB2)
1228 PN->setIncomingValue(i, SI);
Chris Lattner389cfac2004-11-30 00:29:14 +00001229 }
1230 }
1231
1232 // Update any PHI nodes in our new successors.
Sanjay Patel5781d842016-03-12 16:52:17 +00001233 for (BasicBlock *Succ : successors(BB1))
1234 AddPredecessorToBlock(Succ, BIParent, BB1);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001235
Eli Friedmancb61afb2008-12-16 20:54:32 +00001236 EraseTerminatorInstAndDCECond(BI);
Chris Lattner389cfac2004-11-30 00:29:14 +00001237 return true;
1238}
1239
Sanjay Patel09159b8f2015-06-24 20:40:57 +00001240/// Given an unconditional branch that goes to BBEnd,
Manman Ren93ab6492012-09-20 22:37:36 +00001241/// check whether BBEnd has only two predecessors and the other predecessor
1242/// ends with an unconditional branch. If it is true, sink any common code
1243/// in the two predecessors to BBEnd.
1244static bool SinkThenElseCodeToEnd(BranchInst *BI1) {
1245 assert(BI1->isUnconditional());
1246 BasicBlock *BB1 = BI1->getParent();
1247 BasicBlock *BBEnd = BI1->getSuccessor(0);
1248
1249 // Check that BBEnd has two predecessors and the other predecessor ends with
1250 // an unconditional branch.
Benjamin Kramerf064b652012-09-30 21:03:56 +00001251 pred_iterator PI = pred_begin(BBEnd), PE = pred_end(BBEnd);
1252 BasicBlock *Pred0 = *PI++;
1253 if (PI == PE) // Only one predecessor.
Manman Ren93ab6492012-09-20 22:37:36 +00001254 return false;
Benjamin Kramerf064b652012-09-30 21:03:56 +00001255 BasicBlock *Pred1 = *PI++;
1256 if (PI != PE) // More than two predecessors.
1257 return false;
1258 BasicBlock *BB2 = (Pred0 == BB1) ? Pred1 : Pred0;
Manman Ren93ab6492012-09-20 22:37:36 +00001259 BranchInst *BI2 = dyn_cast<BranchInst>(BB2->getTerminator());
1260 if (!BI2 || !BI2->isUnconditional())
1261 return false;
1262
1263 // Gather the PHI nodes in BBEnd.
Michael Liao5313da32014-12-23 08:26:55 +00001264 SmallDenseMap<std::pair<Value *, Value *>, PHINode *> JointValueMap;
Craig Topperf40110f2014-04-25 05:29:35 +00001265 Instruction *FirstNonPhiInBBEnd = nullptr;
Michael Liao5313da32014-12-23 08:26:55 +00001266 for (BasicBlock::iterator I = BBEnd->begin(), E = BBEnd->end(); I != E; ++I) {
Manman Ren93ab6492012-09-20 22:37:36 +00001267 if (PHINode *PN = dyn_cast<PHINode>(I)) {
1268 Value *BB1V = PN->getIncomingValueForBlock(BB1);
Andrew Trick90f50292012-11-15 18:40:29 +00001269 Value *BB2V = PN->getIncomingValueForBlock(BB2);
Michael Liao5313da32014-12-23 08:26:55 +00001270 JointValueMap[std::make_pair(BB1V, BB2V)] = PN;
Manman Ren93ab6492012-09-20 22:37:36 +00001271 } else {
1272 FirstNonPhiInBBEnd = &*I;
1273 break;
1274 }
1275 }
1276 if (!FirstNonPhiInBBEnd)
1277 return false;
Andrew Trick90f50292012-11-15 18:40:29 +00001278
Manman Ren93ab6492012-09-20 22:37:36 +00001279 // This does very trivial matching, with limited scanning, to find identical
1280 // instructions in the two blocks. We scan backward for obviously identical
1281 // instructions in an identical order.
1282 BasicBlock::InstListType::reverse_iterator RI1 = BB1->getInstList().rbegin(),
Michael Liao5313da32014-12-23 08:26:55 +00001283 RE1 = BB1->getInstList().rend(),
1284 RI2 = BB2->getInstList().rbegin(),
1285 RE2 = BB2->getInstList().rend();
Manman Ren93ab6492012-09-20 22:37:36 +00001286 // Skip debug info.
1287 while (RI1 != RE1 && isa<DbgInfoIntrinsic>(&*RI1)) ++RI1;
1288 if (RI1 == RE1)
1289 return false;
1290 while (RI2 != RE2 && isa<DbgInfoIntrinsic>(&*RI2)) ++RI2;
1291 if (RI2 == RE2)
1292 return false;
1293 // Skip the unconditional branches.
1294 ++RI1;
1295 ++RI2;
1296
1297 bool Changed = false;
1298 while (RI1 != RE1 && RI2 != RE2) {
1299 // Skip debug info.
1300 while (RI1 != RE1 && isa<DbgInfoIntrinsic>(&*RI1)) ++RI1;
1301 if (RI1 == RE1)
1302 return Changed;
1303 while (RI2 != RE2 && isa<DbgInfoIntrinsic>(&*RI2)) ++RI2;
1304 if (RI2 == RE2)
1305 return Changed;
1306
1307 Instruction *I1 = &*RI1, *I2 = &*RI2;
Michael Liao5313da32014-12-23 08:26:55 +00001308 auto InstPair = std::make_pair(I1, I2);
Manman Ren93ab6492012-09-20 22:37:36 +00001309 // I1 and I2 should have a single use in the same PHI node, and they
1310 // perform the same operation.
1311 // Cannot move control-flow-involving, volatile loads, vaarg, etc.
1312 if (isa<PHINode>(I1) || isa<PHINode>(I2) ||
1313 isa<TerminatorInst>(I1) || isa<TerminatorInst>(I2) ||
David Majnemerba275f92015-08-19 19:54:02 +00001314 I1->isEHPad() || I2->isEHPad() ||
Manman Ren93ab6492012-09-20 22:37:36 +00001315 isa<AllocaInst>(I1) || isa<AllocaInst>(I2) ||
1316 I1->mayHaveSideEffects() || I2->mayHaveSideEffects() ||
1317 I1->mayReadOrWriteMemory() || I2->mayReadOrWriteMemory() ||
1318 !I1->hasOneUse() || !I2->hasOneUse() ||
Michael Liao5313da32014-12-23 08:26:55 +00001319 !JointValueMap.count(InstPair))
Manman Ren93ab6492012-09-20 22:37:36 +00001320 return Changed;
1321
1322 // Check whether we should swap the operands of ICmpInst.
Michael Liao5313da32014-12-23 08:26:55 +00001323 // TODO: Add support of communativity.
Manman Ren93ab6492012-09-20 22:37:36 +00001324 ICmpInst *ICmp1 = dyn_cast<ICmpInst>(I1), *ICmp2 = dyn_cast<ICmpInst>(I2);
1325 bool SwapOpnds = false;
1326 if (ICmp1 && ICmp2 &&
1327 ICmp1->getOperand(0) != ICmp2->getOperand(0) &&
1328 ICmp1->getOperand(1) != ICmp2->getOperand(1) &&
1329 (ICmp1->getOperand(0) == ICmp2->getOperand(1) ||
1330 ICmp1->getOperand(1) == ICmp2->getOperand(0))) {
1331 ICmp2->swapOperands();
1332 SwapOpnds = true;
1333 }
1334 if (!I1->isSameOperationAs(I2)) {
1335 if (SwapOpnds)
1336 ICmp2->swapOperands();
1337 return Changed;
1338 }
1339
1340 // The operands should be either the same or they need to be generated
1341 // with a PHI node after sinking. We only handle the case where there is
1342 // a single pair of different operands.
Craig Topperf40110f2014-04-25 05:29:35 +00001343 Value *DifferentOp1 = nullptr, *DifferentOp2 = nullptr;
Michael Liao5313da32014-12-23 08:26:55 +00001344 unsigned Op1Idx = ~0U;
Manman Ren93ab6492012-09-20 22:37:36 +00001345 for (unsigned I = 0, E = I1->getNumOperands(); I != E; ++I) {
1346 if (I1->getOperand(I) == I2->getOperand(I))
1347 continue;
Michael Liao5313da32014-12-23 08:26:55 +00001348 // Early exit if we have more-than one pair of different operands or if
1349 // we need a PHI node to replace a constant.
1350 if (Op1Idx != ~0U ||
Manman Ren93ab6492012-09-20 22:37:36 +00001351 isa<Constant>(I1->getOperand(I)) ||
1352 isa<Constant>(I2->getOperand(I))) {
1353 // If we can't sink the instructions, undo the swapping.
1354 if (SwapOpnds)
1355 ICmp2->swapOperands();
1356 return Changed;
1357 }
1358 DifferentOp1 = I1->getOperand(I);
1359 Op1Idx = I;
1360 DifferentOp2 = I2->getOperand(I);
1361 }
1362
Michael Liao5313da32014-12-23 08:26:55 +00001363 DEBUG(dbgs() << "SINK common instructions " << *I1 << "\n");
1364 DEBUG(dbgs() << " " << *I2 << "\n");
1365
1366 // We insert the pair of different operands to JointValueMap and
1367 // remove (I1, I2) from JointValueMap.
1368 if (Op1Idx != ~0U) {
1369 auto &NewPN = JointValueMap[std::make_pair(DifferentOp1, DifferentOp2)];
1370 if (!NewPN) {
1371 NewPN =
1372 PHINode::Create(DifferentOp1->getType(), 2,
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001373 DifferentOp1->getName() + ".sink", &BBEnd->front());
Michael Liao5313da32014-12-23 08:26:55 +00001374 NewPN->addIncoming(DifferentOp1, BB1);
1375 NewPN->addIncoming(DifferentOp2, BB2);
1376 DEBUG(dbgs() << "Create PHI node " << *NewPN << "\n";);
1377 }
Manman Ren93ab6492012-09-20 22:37:36 +00001378 // I1 should use NewPN instead of DifferentOp1.
1379 I1->setOperand(Op1Idx, NewPN);
Manman Ren93ab6492012-09-20 22:37:36 +00001380 }
Michael Liao5313da32014-12-23 08:26:55 +00001381 PHINode *OldPN = JointValueMap[InstPair];
1382 JointValueMap.erase(InstPair);
Manman Ren93ab6492012-09-20 22:37:36 +00001383
Manman Ren93ab6492012-09-20 22:37:36 +00001384 // We need to update RE1 and RE2 if we are going to sink the first
1385 // instruction in the basic block down.
Duncan P. N. Exon Smithe9bc5792016-02-21 20:39:50 +00001386 bool UpdateRE1 = (I1 == &BB1->front()), UpdateRE2 = (I2 == &BB2->front());
Manman Ren93ab6492012-09-20 22:37:36 +00001387 // Sink the instruction.
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001388 BBEnd->getInstList().splice(FirstNonPhiInBBEnd->getIterator(),
1389 BB1->getInstList(), I1);
Manman Ren93ab6492012-09-20 22:37:36 +00001390 if (!OldPN->use_empty())
1391 OldPN->replaceAllUsesWith(I1);
1392 OldPN->eraseFromParent();
1393
1394 if (!I2->use_empty())
1395 I2->replaceAllUsesWith(I1);
1396 I1->intersectOptionalDataWith(I2);
Philip Reamesd92c2a72014-10-22 16:37:13 +00001397 // TODO: Use combineMetadata here to preserve what metadata we can
1398 // (analogous to the hoisting case above).
Manman Ren93ab6492012-09-20 22:37:36 +00001399 I2->eraseFromParent();
1400
1401 if (UpdateRE1)
1402 RE1 = BB1->getInstList().rend();
1403 if (UpdateRE2)
1404 RE2 = BB2->getInstList().rend();
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001405 FirstNonPhiInBBEnd = &*I1;
Manman Ren93ab6492012-09-20 22:37:36 +00001406 NumSinkCommons++;
1407 Changed = true;
1408 }
1409 return Changed;
1410}
1411
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001412/// \brief Determine if we can hoist sink a sole store instruction out of a
1413/// conditional block.
1414///
1415/// We are looking for code like the following:
1416/// BrBB:
1417/// store i32 %add, i32* %arrayidx2
1418/// ... // No other stores or function calls (we could be calling a memory
1419/// ... // function).
1420/// %cmp = icmp ult %x, %y
1421/// br i1 %cmp, label %EndBB, label %ThenBB
1422/// ThenBB:
1423/// store i32 %add5, i32* %arrayidx2
1424/// br label EndBB
1425/// EndBB:
1426/// ...
1427/// We are going to transform this into:
1428/// BrBB:
1429/// store i32 %add, i32* %arrayidx2
1430/// ... //
1431/// %cmp = icmp ult %x, %y
1432/// %add.add5 = select i1 %cmp, i32 %add, %add5
1433/// store i32 %add.add5, i32* %arrayidx2
1434/// ...
1435///
1436/// \return The pointer to the value of the previous store if the store can be
1437/// hoisted into the predecessor block. 0 otherwise.
Benjamin Kramerad5c24f2013-05-23 16:09:15 +00001438static Value *isSafeToSpeculateStore(Instruction *I, BasicBlock *BrBB,
1439 BasicBlock *StoreBB, BasicBlock *EndBB) {
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001440 StoreInst *StoreToHoist = dyn_cast<StoreInst>(I);
1441 if (!StoreToHoist)
Craig Topperf40110f2014-04-25 05:29:35 +00001442 return nullptr;
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001443
1444 // Volatile or atomic.
1445 if (!StoreToHoist->isSimple())
Craig Topperf40110f2014-04-25 05:29:35 +00001446 return nullptr;
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001447
1448 Value *StorePtr = StoreToHoist->getPointerOperand();
1449
1450 // Look for a store to the same pointer in BrBB.
1451 unsigned MaxNumInstToLookAt = 10;
1452 for (BasicBlock::reverse_iterator RI = BrBB->rbegin(),
1453 RE = BrBB->rend(); RI != RE && (--MaxNumInstToLookAt); ++RI) {
1454 Instruction *CurI = &*RI;
1455
1456 // Could be calling an instruction that effects memory like free().
1457 if (CurI->mayHaveSideEffects() && !isa<StoreInst>(CurI))
Craig Topperf40110f2014-04-25 05:29:35 +00001458 return nullptr;
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001459
1460 StoreInst *SI = dyn_cast<StoreInst>(CurI);
1461 // Found the previous store make sure it stores to the same location.
1462 if (SI && SI->getPointerOperand() == StorePtr)
1463 // Found the previous store, return its value operand.
1464 return SI->getValueOperand();
1465 else if (SI)
Craig Topperf40110f2014-04-25 05:29:35 +00001466 return nullptr; // Unknown store.
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001467 }
1468
Craig Topperf40110f2014-04-25 05:29:35 +00001469 return nullptr;
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001470}
1471
Chandler Carruth8a4a1662013-01-24 08:05:06 +00001472/// \brief Speculate a conditional basic block flattening the CFG.
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001473///
Chandler Carruth8a4a1662013-01-24 08:05:06 +00001474/// Note that this is a very risky transform currently. Speculating
1475/// instructions like this is most often not desirable. Instead, there is an MI
1476/// pass which can do it with full awareness of the resource constraints.
1477/// However, some cases are "obvious" and we should do directly. An example of
1478/// this is speculating a single, reasonably cheap instruction.
1479///
1480/// There is only one distinct advantage to flattening the CFG at the IR level:
1481/// it makes very common but simplistic optimizations such as are common in
1482/// instcombine and the DAG combiner more powerful by removing CFG edges and
1483/// modeling their effects with easier to reason about SSA value graphs.
1484///
1485///
1486/// An illustration of this transform is turning this IR:
1487/// \code
1488/// BB:
1489/// %cmp = icmp ult %x, %y
1490/// br i1 %cmp, label %EndBB, label %ThenBB
1491/// ThenBB:
1492/// %sub = sub %x, %y
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001493/// br label BB2
Chandler Carruth8a4a1662013-01-24 08:05:06 +00001494/// EndBB:
1495/// %phi = phi [ %sub, %ThenBB ], [ 0, %EndBB ]
1496/// ...
1497/// \endcode
1498///
1499/// Into this IR:
1500/// \code
1501/// BB:
1502/// %cmp = icmp ult %x, %y
1503/// %sub = sub %x, %y
1504/// %cond = select i1 %cmp, 0, %sub
1505/// ...
1506/// \endcode
1507///
1508/// \returns true if the conditional block is removed.
Hal Finkela995f922014-07-10 14:41:31 +00001509static bool SpeculativelyExecuteBB(BranchInst *BI, BasicBlock *ThenBB,
James Molloy7c336572015-02-11 12:15:41 +00001510 const TargetTransformInfo &TTI) {
Chandler Carruth1d20c022013-01-24 08:22:40 +00001511 // Be conservative for now. FP select instruction can often be expensive.
1512 Value *BrCond = BI->getCondition();
1513 if (isa<FCmpInst>(BrCond))
1514 return false;
1515
Chandler Carruthe2a779f2013-01-24 09:59:39 +00001516 BasicBlock *BB = BI->getParent();
1517 BasicBlock *EndBB = ThenBB->getTerminator()->getSuccessor(0);
1518
1519 // If ThenBB is actually on the false edge of the conditional branch, remember
1520 // to swap the select operands later.
1521 bool Invert = false;
1522 if (ThenBB != BI->getSuccessor(0)) {
1523 assert(ThenBB == BI->getSuccessor(1) && "No edge from 'if' block?");
1524 Invert = true;
1525 }
1526 assert(EndBB == BI->getSuccessor(!Invert) && "No edge from to end block");
1527
Chandler Carruthceff2222013-01-25 05:40:09 +00001528 // Keep a count of how many times instructions are used within CondBB when
1529 // they are candidates for sinking into CondBB. Specifically:
1530 // - They are defined in BB, and
1531 // - They have no side effects, and
1532 // - All of their uses are in CondBB.
1533 SmallDenseMap<Instruction *, unsigned, 4> SinkCandidateUseCounts;
1534
Chandler Carruth7481ca82013-01-24 11:52:58 +00001535 unsigned SpeculationCost = 0;
Craig Topperf40110f2014-04-25 05:29:35 +00001536 Value *SpeculatedStoreValue = nullptr;
1537 StoreInst *SpeculatedStore = nullptr;
Chandler Carruth7481ca82013-01-24 11:52:58 +00001538 for (BasicBlock::iterator BBI = ThenBB->begin(),
Benjamin Kramerb6d0bd42014-03-02 12:27:27 +00001539 BBE = std::prev(ThenBB->end());
Devang Patel5aed7762009-03-06 06:00:17 +00001540 BBI != BBE; ++BBI) {
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001541 Instruction *I = &*BBI;
Devang Patel5aed7762009-03-06 06:00:17 +00001542 // Skip debug info.
Chandler Carruth7481ca82013-01-24 11:52:58 +00001543 if (isa<DbgInfoIntrinsic>(I))
1544 continue;
Devang Patel5aed7762009-03-06 06:00:17 +00001545
Mark Lacey274f48b2015-04-12 18:18:51 +00001546 // Only speculatively execute a single instruction (not counting the
Chandler Carruth7481ca82013-01-24 11:52:58 +00001547 // terminator) for now.
Chandler Carruth329b5902013-01-27 06:42:03 +00001548 ++SpeculationCost;
1549 if (SpeculationCost > 1)
Devang Patel5aed7762009-03-06 06:00:17 +00001550 return false;
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001551
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001552 // Don't hoist the instruction if it's unsafe or expensive.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001553 if (!isSafeToSpeculativelyExecute(I) &&
1554 !(HoistCondStores && (SpeculatedStoreValue = isSafeToSpeculateStore(
1555 I, BB, ThenBB, EndBB))))
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001556 return false;
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001557 if (!SpeculatedStoreValue &&
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001558 ComputeSpeculationCost(I, TTI) >
1559 PHINodeFoldingThreshold * TargetTransformInfo::TCC_Basic)
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001560 return false;
1561
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001562 // Store the store speculation candidate.
1563 if (SpeculatedStoreValue)
1564 SpeculatedStore = cast<StoreInst>(I);
1565
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001566 // Do not hoist the instruction if any of its operands are defined but not
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001567 // used in BB. The transformation will prevent the operand from
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001568 // being sunk into the use block.
Chandler Carruth7481ca82013-01-24 11:52:58 +00001569 for (User::op_iterator i = I->op_begin(), e = I->op_end();
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001570 i != e; ++i) {
1571 Instruction *OpI = dyn_cast<Instruction>(*i);
Chandler Carruthceff2222013-01-25 05:40:09 +00001572 if (!OpI || OpI->getParent() != BB ||
1573 OpI->mayHaveSideEffects())
1574 continue; // Not a candidate for sinking.
1575
1576 ++SinkCandidateUseCounts[OpI];
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001577 }
1578 }
Evan Cheng89200c92008-06-07 08:52:29 +00001579
Chandler Carruthceff2222013-01-25 05:40:09 +00001580 // Consider any sink candidates which are only used in CondBB as costs for
1581 // speculation. Note, while we iterate over a DenseMap here, we are summing
1582 // and so iteration order isn't significant.
1583 for (SmallDenseMap<Instruction *, unsigned, 4>::iterator I =
1584 SinkCandidateUseCounts.begin(), E = SinkCandidateUseCounts.end();
1585 I != E; ++I)
1586 if (I->first->getNumUses() == I->second) {
Chandler Carruth329b5902013-01-27 06:42:03 +00001587 ++SpeculationCost;
1588 if (SpeculationCost > 1)
Chandler Carruthceff2222013-01-25 05:40:09 +00001589 return false;
1590 }
1591
Chandler Carruth76aacbd2013-01-24 10:40:51 +00001592 // Check that the PHI nodes can be converted to selects.
1593 bool HaveRewritablePHIs = false;
Chandler Carruthe2a779f2013-01-24 09:59:39 +00001594 for (BasicBlock::iterator I = EndBB->begin();
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001595 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
Chandler Carruthe2a779f2013-01-24 09:59:39 +00001596 Value *OrigV = PN->getIncomingValueForBlock(BB);
1597 Value *ThenV = PN->getIncomingValueForBlock(ThenBB);
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001598
Rafael Espindolaa5e536a2013-06-04 14:11:59 +00001599 // FIXME: Try to remove some of the duplication with HoistThenElseCodeToIf.
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001600 // Skip PHIs which are trivial.
Chandler Carruthe2a779f2013-01-24 09:59:39 +00001601 if (ThenV == OrigV)
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001602 continue;
1603
Arnold Schwaighoferd7d010e2014-10-10 01:27:02 +00001604 // Don't convert to selects if we could remove undefined behavior instead.
1605 if (passingValueIsAlwaysUndefined(OrigV, PN) ||
1606 passingValueIsAlwaysUndefined(ThenV, PN))
1607 return false;
1608
Chandler Carruth76aacbd2013-01-24 10:40:51 +00001609 HaveRewritablePHIs = true;
Rafael Espindolaa5e536a2013-06-04 14:11:59 +00001610 ConstantExpr *OrigCE = dyn_cast<ConstantExpr>(OrigV);
1611 ConstantExpr *ThenCE = dyn_cast<ConstantExpr>(ThenV);
1612 if (!OrigCE && !ThenCE)
Chandler Carruth8a210052013-01-24 11:53:01 +00001613 continue; // Known safe and cheap.
1614
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001615 if ((ThenCE && !isSafeToSpeculativelyExecute(ThenCE)) ||
1616 (OrigCE && !isSafeToSpeculativelyExecute(OrigCE)))
Chandler Carruth8a210052013-01-24 11:53:01 +00001617 return false;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001618 unsigned OrigCost = OrigCE ? ComputeSpeculationCost(OrigCE, TTI) : 0;
1619 unsigned ThenCost = ThenCE ? ComputeSpeculationCost(ThenCE, TTI) : 0;
James Molloy7c336572015-02-11 12:15:41 +00001620 unsigned MaxCost = 2 * PHINodeFoldingThreshold *
1621 TargetTransformInfo::TCC_Basic;
1622 if (OrigCost + ThenCost > MaxCost)
Chandler Carruth8a210052013-01-24 11:53:01 +00001623 return false;
Chandler Carruth76aacbd2013-01-24 10:40:51 +00001624
Chandler Carruth01bffaa2013-01-24 12:05:17 +00001625 // Account for the cost of an unfolded ConstantExpr which could end up
1626 // getting expanded into Instructions.
1627 // FIXME: This doesn't account for how many operations are combined in the
Chandler Carruth329b5902013-01-27 06:42:03 +00001628 // constant expression.
1629 ++SpeculationCost;
1630 if (SpeculationCost > 1)
Chandler Carruth76aacbd2013-01-24 10:40:51 +00001631 return false;
Evan Cheng89200c92008-06-07 08:52:29 +00001632 }
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001633
1634 // If there are no PHIs to process, bail early. This helps ensure idempotence
1635 // as well.
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001636 if (!HaveRewritablePHIs && !(HoistCondStores && SpeculatedStoreValue))
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001637 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001638
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001639 // If we get here, we can hoist the instruction and if-convert.
Chandler Carruthe2a779f2013-01-24 09:59:39 +00001640 DEBUG(dbgs() << "SPECULATIVELY EXECUTING BB" << *ThenBB << "\n";);
Evan Cheng89200c92008-06-07 08:52:29 +00001641
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001642 // Insert a select of the value of the speculated store.
1643 if (SpeculatedStoreValue) {
Mehdi Aminiba9fba82016-03-13 21:05:13 +00001644 IRBuilder<NoFolder> Builder(BI);
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001645 Value *TrueV = SpeculatedStore->getValueOperand();
1646 Value *FalseV = SpeculatedStoreValue;
1647 if (Invert)
1648 std::swap(TrueV, FalseV);
Sanjay Patel796db352016-03-26 23:30:50 +00001649 Value *S = Builder.CreateSelect(
1650 BrCond, TrueV, FalseV, TrueV->getName() + "." + FalseV->getName(), BI);
Arnold Schwaighofer474df6d2013-04-29 21:28:24 +00001651 SpeculatedStore->setOperand(0, S);
1652 }
1653
Igor Laevsky7310c682015-11-18 14:50:18 +00001654 // Metadata can be dependent on the condition we are hoisting above.
1655 // Conservatively strip all metadata on the instruction.
1656 for (auto &I: *ThenBB)
1657 I.dropUnknownNonDebugMetadata();
1658
Chandler Carruth7481ca82013-01-24 11:52:58 +00001659 // Hoist the instructions.
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001660 BB->getInstList().splice(BI->getIterator(), ThenBB->getInstList(),
1661 ThenBB->begin(), std::prev(ThenBB->end()));
Evan Cheng89553cc2008-06-12 21:15:59 +00001662
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001663 // Insert selects and rewrite the PHI operands.
Mehdi Aminiba9fba82016-03-13 21:05:13 +00001664 IRBuilder<NoFolder> Builder(BI);
Chandler Carruth76aacbd2013-01-24 10:40:51 +00001665 for (BasicBlock::iterator I = EndBB->begin();
1666 PHINode *PN = dyn_cast<PHINode>(I); ++I) {
1667 unsigned OrigI = PN->getBasicBlockIndex(BB);
1668 unsigned ThenI = PN->getBasicBlockIndex(ThenBB);
1669 Value *OrigV = PN->getIncomingValue(OrigI);
1670 Value *ThenV = PN->getIncomingValue(ThenI);
1671
1672 // Skip PHIs which are trivial.
1673 if (OrigV == ThenV)
1674 continue;
Evan Cheng89200c92008-06-07 08:52:29 +00001675
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001676 // Create a select whose true value is the speculatively executed value and
Chandler Carruth76aacbd2013-01-24 10:40:51 +00001677 // false value is the preexisting value. Swap them if the branch
1678 // destinations were inverted.
1679 Value *TrueV = ThenV, *FalseV = OrigV;
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00001680 if (Invert)
Chandler Carruth76aacbd2013-01-24 10:40:51 +00001681 std::swap(TrueV, FalseV);
Sanjay Patelf11ab052016-04-15 15:32:12 +00001682 Value *V = Builder.CreateSelect(
1683 BrCond, TrueV, FalseV, TrueV->getName() + "." + FalseV->getName(), BI);
Chandler Carruth76aacbd2013-01-24 10:40:51 +00001684 PN->setIncomingValue(OrigI, V);
1685 PN->setIncomingValue(ThenI, V);
Evan Cheng89200c92008-06-07 08:52:29 +00001686 }
1687
Evan Cheng89553cc2008-06-12 21:15:59 +00001688 ++NumSpeculations;
Evan Cheng89200c92008-06-07 08:52:29 +00001689 return true;
1690}
1691
Sanjay Patel09159b8f2015-06-24 20:40:57 +00001692/// Return true if we can thread a branch across this block.
Chris Lattnerf0bd8d02005-09-20 00:43:16 +00001693static bool BlockIsSimpleEnoughToThreadThrough(BasicBlock *BB) {
1694 BranchInst *BI = cast<BranchInst>(BB->getTerminator());
Chris Lattner6c701062005-09-20 01:48:40 +00001695 unsigned Size = 0;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001696
Devang Patel84fceff2009-03-10 18:00:05 +00001697 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
Dale Johannesened6f5a82009-03-12 23:18:09 +00001698 if (isa<DbgInfoIntrinsic>(BBI))
1699 continue;
Chris Lattner6c701062005-09-20 01:48:40 +00001700 if (Size > 10) return false; // Don't clone large BB's.
Dale Johannesened6f5a82009-03-12 23:18:09 +00001701 ++Size;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001702
Dale Johannesened6f5a82009-03-12 23:18:09 +00001703 // We can only support instructions that do not define values that are
Chris Lattner6c701062005-09-20 01:48:40 +00001704 // live outside of the current basic block.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001705 for (User *U : BBI->users()) {
1706 Instruction *UI = cast<Instruction>(U);
1707 if (UI->getParent() != BB || isa<PHINode>(UI)) return false;
Chris Lattner6c701062005-09-20 01:48:40 +00001708 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00001709
Chris Lattnerf0bd8d02005-09-20 00:43:16 +00001710 // Looks ok, continue checking.
1711 }
Chris Lattner6c701062005-09-20 01:48:40 +00001712
Chris Lattnerf0bd8d02005-09-20 00:43:16 +00001713 return true;
1714}
1715
Sanjay Patel09159b8f2015-06-24 20:40:57 +00001716/// If we have a conditional branch on a PHI node value that is defined in the
1717/// same block as the branch and if any PHI entries are constants, thread edges
1718/// corresponding to that entry to be branches to their ultimate destination.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001719static bool FoldCondBranchOnPHI(BranchInst *BI, const DataLayout &DL) {
Chris Lattner748f9032005-09-19 23:49:37 +00001720 BasicBlock *BB = BI->getParent();
1721 PHINode *PN = dyn_cast<PHINode>(BI->getCondition());
Chris Lattner049cb442005-09-19 23:57:04 +00001722 // NOTE: we currently cannot transform this case if the PHI node is used
1723 // outside of the block.
Chris Lattnerf0bd8d02005-09-20 00:43:16 +00001724 if (!PN || PN->getParent() != BB || !PN->hasOneUse())
1725 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001726
Chris Lattner748f9032005-09-19 23:49:37 +00001727 // Degenerate case of a single entry PHI.
1728 if (PN->getNumIncomingValues() == 1) {
Chris Lattnerdc3f6f22008-12-03 19:44:02 +00001729 FoldSingleEntryPHINodes(PN->getParent());
Andrew Trickf3cf1932012-08-29 21:46:36 +00001730 return true;
Chris Lattner748f9032005-09-19 23:49:37 +00001731 }
1732
1733 // Now we know that this block has multiple preds and two succs.
Chris Lattnerf0bd8d02005-09-20 00:43:16 +00001734 if (!BlockIsSimpleEnoughToThreadThrough(BB)) return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001735
Justin Lebardb639492016-02-12 21:01:36 +00001736 // Can't fold blocks that contain noduplicate or convergent calls.
1737 if (llvm::any_of(*BB, [](const Instruction &I) {
1738 const CallInst *CI = dyn_cast<CallInst>(&I);
1739 return CI && (CI->cannotDuplicate() || CI->isConvergent());
1740 }))
1741 return false;
Tom Stellarde1631dd2013-10-21 20:07:30 +00001742
Chris Lattner748f9032005-09-19 23:49:37 +00001743 // Okay, this is a simple enough basic block. See if any phi values are
1744 // constants.
Zhou Sheng75b871f2007-01-11 12:24:14 +00001745 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
Chris Lattner4088e2b2010-12-13 01:47:07 +00001746 ConstantInt *CB = dyn_cast<ConstantInt>(PN->getIncomingValue(i));
Craig Topperf40110f2014-04-25 05:29:35 +00001747 if (!CB || !CB->getType()->isIntegerTy(1)) continue;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001748
Chris Lattner4088e2b2010-12-13 01:47:07 +00001749 // Okay, we now know that all edges from PredBB should be revectored to
1750 // branch to RealDest.
1751 BasicBlock *PredBB = PN->getIncomingBlock(i);
1752 BasicBlock *RealDest = BI->getSuccessor(!CB->getZExtValue());
Andrew Trickf3cf1932012-08-29 21:46:36 +00001753
Chris Lattner4088e2b2010-12-13 01:47:07 +00001754 if (RealDest == BB) continue; // Skip self loops.
Bill Wendling4f163df2011-06-04 09:42:04 +00001755 // Skip if the predecessor's terminator is an indirect branch.
1756 if (isa<IndirectBrInst>(PredBB->getTerminator())) continue;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001757
Chris Lattner4088e2b2010-12-13 01:47:07 +00001758 // The dest block might have PHI nodes, other predecessors and other
1759 // difficult cases. Instead of being smart about this, just insert a new
1760 // block that jumps to the destination block, effectively splitting
1761 // the edge we are about to create.
1762 BasicBlock *EdgeBB = BasicBlock::Create(BB->getContext(),
1763 RealDest->getName()+".critedge",
1764 RealDest->getParent(), RealDest);
1765 BranchInst::Create(RealDest, EdgeBB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00001766
Chris Lattner0f4d67b2010-12-14 07:09:42 +00001767 // Update PHI nodes.
1768 AddPredecessorToBlock(RealDest, EdgeBB, BB);
Chris Lattner4088e2b2010-12-13 01:47:07 +00001769
1770 // BB may have instructions that are being threaded over. Clone these
1771 // instructions into EdgeBB. We know that there will be no uses of the
1772 // cloned instructions outside of EdgeBB.
1773 BasicBlock::iterator InsertPt = EdgeBB->begin();
1774 DenseMap<Value*, Value*> TranslateMap; // Track translated values.
1775 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
1776 if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
1777 TranslateMap[PN] = PN->getIncomingValueForBlock(PredBB);
1778 continue;
1779 }
1780 // Clone the instruction.
1781 Instruction *N = BBI->clone();
1782 if (BBI->hasName()) N->setName(BBI->getName()+".c");
Andrew Trickf3cf1932012-08-29 21:46:36 +00001783
Chris Lattner4088e2b2010-12-13 01:47:07 +00001784 // Update operands due to translation.
1785 for (User::op_iterator i = N->op_begin(), e = N->op_end();
1786 i != e; ++i) {
1787 DenseMap<Value*, Value*>::iterator PI = TranslateMap.find(*i);
1788 if (PI != TranslateMap.end())
1789 *i = PI->second;
1790 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00001791
Chris Lattner4088e2b2010-12-13 01:47:07 +00001792 // Check for trivial simplification.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001793 if (Value *V = SimplifyInstruction(N, DL)) {
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001794 TranslateMap[&*BBI] = V;
Chris Lattnerd7beca32010-12-14 06:17:25 +00001795 delete N; // Instruction folded away, don't need actual inst
Chris Lattner4088e2b2010-12-13 01:47:07 +00001796 } else {
1797 // Insert the new instruction into its new home.
1798 EdgeBB->getInstList().insert(InsertPt, N);
1799 if (!BBI->use_empty())
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001800 TranslateMap[&*BBI] = N;
Chris Lattner4088e2b2010-12-13 01:47:07 +00001801 }
1802 }
1803
1804 // Loop over all of the edges from PredBB to BB, changing them to branch
1805 // to EdgeBB instead.
1806 TerminatorInst *PredBBTI = PredBB->getTerminator();
1807 for (unsigned i = 0, e = PredBBTI->getNumSuccessors(); i != e; ++i)
1808 if (PredBBTI->getSuccessor(i) == BB) {
1809 BB->removePredecessor(PredBB);
1810 PredBBTI->setSuccessor(i, EdgeBB);
1811 }
Bill Wendling4f163df2011-06-04 09:42:04 +00001812
Chris Lattner4088e2b2010-12-13 01:47:07 +00001813 // Recurse, simplifying any other constants.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001814 return FoldCondBranchOnPHI(BI, DL) | true;
Zhou Sheng75b871f2007-01-11 12:24:14 +00001815 }
Chris Lattner748f9032005-09-19 23:49:37 +00001816
1817 return false;
1818}
1819
Sanjay Patel09159b8f2015-06-24 20:40:57 +00001820/// Given a BB that starts with the specified two-entry PHI node,
1821/// see if we can eliminate it.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001822static bool FoldTwoEntryPHINode(PHINode *PN, const TargetTransformInfo &TTI,
1823 const DataLayout &DL) {
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001824 // Ok, this is a two entry PHI node. Check to see if this is a simple "if
1825 // statement", which has a very simple dominance structure. Basically, we
1826 // are trying to find the condition that is being branched on, which
1827 // subsequently causes this merge to happen. We really want control
1828 // dependence information for this check, but simplifycfg can't keep it up
1829 // to date, and this catches most of the cases we care about anyway.
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001830 BasicBlock *BB = PN->getParent();
1831 BasicBlock *IfTrue, *IfFalse;
1832 Value *IfCond = GetIfCondition(BB, IfTrue, IfFalse);
Chris Lattner335f0e42010-12-14 08:01:53 +00001833 if (!IfCond ||
1834 // Don't bother if the branch will be constant folded trivially.
1835 isa<ConstantInt>(IfCond))
1836 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001837
Chris Lattner95adf8f12006-11-18 19:19:36 +00001838 // Okay, we found that we can merge this two-entry phi node into a select.
1839 // Doing so would require us to fold *all* two entry phi nodes in this block.
1840 // At some point this becomes non-profitable (particularly if the target
1841 // doesn't support cmov's). Only do this transformation if there are two or
1842 // fewer PHI nodes in this block.
1843 unsigned NumPhis = 0;
1844 for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I); ++NumPhis, ++I)
1845 if (NumPhis > 2)
1846 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001847
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001848 // Loop over the PHI's seeing if we can promote them all to select
1849 // instructions. While we are at it, keep track of the instructions
1850 // that need to be moved to the dominating block.
Chris Lattner9ac168d2010-12-14 07:41:39 +00001851 SmallPtrSet<Instruction*, 4> AggressiveInsts;
Peter Collingbourne616044a2011-04-29 18:47:38 +00001852 unsigned MaxCostVal0 = PHINodeFoldingThreshold,
1853 MaxCostVal1 = PHINodeFoldingThreshold;
James Molloy7c336572015-02-11 12:15:41 +00001854 MaxCostVal0 *= TargetTransformInfo::TCC_Basic;
1855 MaxCostVal1 *= TargetTransformInfo::TCC_Basic;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001856
Chris Lattner7499b452010-12-14 08:46:09 +00001857 for (BasicBlock::iterator II = BB->begin(); isa<PHINode>(II);) {
1858 PHINode *PN = cast<PHINode>(II++);
Rafael Espindola37dc9e12014-02-21 00:06:31 +00001859 if (Value *V = SimplifyInstruction(PN, DL)) {
Chris Lattnerb42d2932010-12-14 07:20:29 +00001860 PN->replaceAllUsesWith(V);
Chris Lattner7499b452010-12-14 08:46:09 +00001861 PN->eraseFromParent();
Chris Lattnerb42d2932010-12-14 07:20:29 +00001862 continue;
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001863 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00001864
Peter Collingbournee3511e12011-04-29 18:47:31 +00001865 if (!DominatesMergePoint(PN->getIncomingValue(0), BB, &AggressiveInsts,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001866 MaxCostVal0, TTI) ||
Peter Collingbournee3511e12011-04-29 18:47:31 +00001867 !DominatesMergePoint(PN->getIncomingValue(1), BB, &AggressiveInsts,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001868 MaxCostVal1, TTI))
Chris Lattnerb42d2932010-12-14 07:20:29 +00001869 return false;
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001870 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00001871
Sylvestre Ledru35521e22012-07-23 08:51:15 +00001872 // If we folded the first phi, PN dangles at this point. Refresh it. If
Chris Lattner9ac168d2010-12-14 07:41:39 +00001873 // we ran out of PHIs then we simplified them all.
1874 PN = dyn_cast<PHINode>(BB->begin());
Craig Topperf40110f2014-04-25 05:29:35 +00001875 if (!PN) return true;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001876
Chris Lattner7499b452010-12-14 08:46:09 +00001877 // Don't fold i1 branches on PHIs which contain binary operators. These can
1878 // often be turned into switches and other things.
1879 if (PN->getType()->isIntegerTy(1) &&
1880 (isa<BinaryOperator>(PN->getIncomingValue(0)) ||
1881 isa<BinaryOperator>(PN->getIncomingValue(1)) ||
1882 isa<BinaryOperator>(IfCond)))
1883 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00001884
Sanjay Patel2e002772016-03-12 18:05:53 +00001885 // If all PHI nodes are promotable, check to make sure that all instructions
1886 // in the predecessor blocks can be promoted as well. If not, we won't be able
1887 // to get rid of the control flow, so it's not worth promoting to select
1888 // instructions.
Craig Topperf40110f2014-04-25 05:29:35 +00001889 BasicBlock *DomBlock = nullptr;
Chris Lattner9ac168d2010-12-14 07:41:39 +00001890 BasicBlock *IfBlock1 = PN->getIncomingBlock(0);
1891 BasicBlock *IfBlock2 = PN->getIncomingBlock(1);
1892 if (cast<BranchInst>(IfBlock1->getTerminator())->isConditional()) {
Craig Topperf40110f2014-04-25 05:29:35 +00001893 IfBlock1 = nullptr;
Chris Lattner9ac168d2010-12-14 07:41:39 +00001894 } else {
1895 DomBlock = *pred_begin(IfBlock1);
1896 for (BasicBlock::iterator I = IfBlock1->begin();!isa<TerminatorInst>(I);++I)
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001897 if (!AggressiveInsts.count(&*I) && !isa<DbgInfoIntrinsic>(I)) {
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001898 // This is not an aggressive instruction that we can promote.
Sanjay Patel2e002772016-03-12 18:05:53 +00001899 // Because of this, we won't be able to get rid of the control flow, so
1900 // the xform is not worth it.
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001901 return false;
1902 }
1903 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00001904
Chris Lattner9ac168d2010-12-14 07:41:39 +00001905 if (cast<BranchInst>(IfBlock2->getTerminator())->isConditional()) {
Craig Topperf40110f2014-04-25 05:29:35 +00001906 IfBlock2 = nullptr;
Chris Lattner9ac168d2010-12-14 07:41:39 +00001907 } else {
1908 DomBlock = *pred_begin(IfBlock2);
1909 for (BasicBlock::iterator I = IfBlock2->begin();!isa<TerminatorInst>(I);++I)
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001910 if (!AggressiveInsts.count(&*I) && !isa<DbgInfoIntrinsic>(I)) {
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001911 // This is not an aggressive instruction that we can promote.
Sanjay Patel2e002772016-03-12 18:05:53 +00001912 // Because of this, we won't be able to get rid of the control flow, so
1913 // the xform is not worth it.
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001914 return false;
1915 }
1916 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00001917
Chris Lattner9fd838d2010-12-14 07:23:10 +00001918 DEBUG(dbgs() << "FOUND IF CONDITION! " << *IfCond << " T: "
Chris Lattner9ac168d2010-12-14 07:41:39 +00001919 << IfTrue->getName() << " F: " << IfFalse->getName() << "\n");
Andrew Trickf3cf1932012-08-29 21:46:36 +00001920
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001921 // If we can still promote the PHI nodes after this gauntlet of tests,
1922 // do all of the PHI's now.
Chris Lattner7499b452010-12-14 08:46:09 +00001923 Instruction *InsertPt = DomBlock->getTerminator();
Mehdi Aminiba9fba82016-03-13 21:05:13 +00001924 IRBuilder<NoFolder> Builder(InsertPt);
Andrew Trickf3cf1932012-08-29 21:46:36 +00001925
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001926 // Move all 'aggressive' instructions, which are defined in the
1927 // conditional parts of the if's up to the dominating block.
Chris Lattner4088e2b2010-12-13 01:47:07 +00001928 if (IfBlock1)
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001929 DomBlock->getInstList().splice(InsertPt->getIterator(),
Chris Lattner4088e2b2010-12-13 01:47:07 +00001930 IfBlock1->getInstList(), IfBlock1->begin(),
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001931 IfBlock1->getTerminator()->getIterator());
Chris Lattner4088e2b2010-12-13 01:47:07 +00001932 if (IfBlock2)
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001933 DomBlock->getInstList().splice(InsertPt->getIterator(),
Chris Lattner4088e2b2010-12-13 01:47:07 +00001934 IfBlock2->getInstList(), IfBlock2->begin(),
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00001935 IfBlock2->getTerminator()->getIterator());
Andrew Trickf3cf1932012-08-29 21:46:36 +00001936
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001937 while (PHINode *PN = dyn_cast<PHINode>(BB->begin())) {
1938 // Change the PHI node into a select instruction.
Chris Lattner4088e2b2010-12-13 01:47:07 +00001939 Value *TrueVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfFalse);
1940 Value *FalseVal = PN->getIncomingValue(PN->getIncomingBlock(0) == IfTrue);
Andrew Trickf3cf1932012-08-29 21:46:36 +00001941
Sanjay Patel9e23fed2016-03-17 15:30:52 +00001942 Value *Sel = Builder.CreateSelect(IfCond, TrueVal, FalseVal, "", InsertPt);
1943 PN->replaceAllUsesWith(Sel);
1944 Sel->takeName(PN);
Chris Lattnerd7beca32010-12-14 06:17:25 +00001945 PN->eraseFromParent();
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001946 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00001947
Chris Lattner335f0e42010-12-14 08:01:53 +00001948 // At this point, IfBlock1 and IfBlock2 are both empty, so our if statement
1949 // has been flattened. Change DomBlock to jump directly to our new block to
1950 // avoid other simplifycfg's kicking in on the diamond.
1951 TerminatorInst *OldTI = DomBlock->getTerminator();
Devang Patel5c810ce2011-05-18 18:16:44 +00001952 Builder.SetInsertPoint(OldTI);
1953 Builder.CreateBr(BB);
Chris Lattner335f0e42010-12-14 08:01:53 +00001954 OldTI->eraseFromParent();
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001955 return true;
1956}
Chris Lattner748f9032005-09-19 23:49:37 +00001957
Sanjay Patel09159b8f2015-06-24 20:40:57 +00001958/// If we found a conditional branch that goes to two returning blocks,
1959/// try to merge them together into one return,
Chris Lattner86bbf332008-04-24 00:01:19 +00001960/// introducing a select if the return values disagree.
Andrew Trickf3cf1932012-08-29 21:46:36 +00001961static bool SimplifyCondBranchToTwoReturns(BranchInst *BI,
Devang Pateldd14e0f2011-05-18 21:33:11 +00001962 IRBuilder<> &Builder) {
Chris Lattner86bbf332008-04-24 00:01:19 +00001963 assert(BI->isConditional() && "Must be a conditional branch");
1964 BasicBlock *TrueSucc = BI->getSuccessor(0);
1965 BasicBlock *FalseSucc = BI->getSuccessor(1);
1966 ReturnInst *TrueRet = cast<ReturnInst>(TrueSucc->getTerminator());
1967 ReturnInst *FalseRet = cast<ReturnInst>(FalseSucc->getTerminator());
Andrew Trickf3cf1932012-08-29 21:46:36 +00001968
Chris Lattner86bbf332008-04-24 00:01:19 +00001969 // Check to ensure both blocks are empty (just a return) or optionally empty
1970 // with PHI nodes. If there are other instructions, merging would cause extra
1971 // computation on one path or the other.
Chris Lattner4088e2b2010-12-13 01:47:07 +00001972 if (!TrueSucc->getFirstNonPHIOrDbg()->isTerminator())
Devang Patel086b2122009-02-05 00:30:42 +00001973 return false;
Chris Lattner4088e2b2010-12-13 01:47:07 +00001974 if (!FalseSucc->getFirstNonPHIOrDbg()->isTerminator())
Devang Patel086b2122009-02-05 00:30:42 +00001975 return false;
Chris Lattner86bbf332008-04-24 00:01:19 +00001976
Devang Pateldd14e0f2011-05-18 21:33:11 +00001977 Builder.SetInsertPoint(BI);
Chris Lattner86bbf332008-04-24 00:01:19 +00001978 // Okay, we found a branch that is going to two return nodes. If
1979 // there is no return value for this function, just change the
1980 // branch into a return.
1981 if (FalseRet->getNumOperands() == 0) {
1982 TrueSucc->removePredecessor(BI->getParent());
1983 FalseSucc->removePredecessor(BI->getParent());
Devang Pateldd14e0f2011-05-18 21:33:11 +00001984 Builder.CreateRetVoid();
Eli Friedmancb61afb2008-12-16 20:54:32 +00001985 EraseTerminatorInstAndDCECond(BI);
Chris Lattner86bbf332008-04-24 00:01:19 +00001986 return true;
1987 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00001988
Dan Gohmanfa1211f2008-07-23 00:34:11 +00001989 // Otherwise, figure out what the true and false return values are
1990 // so we can insert a new select instruction.
1991 Value *TrueValue = TrueRet->getReturnValue();
1992 Value *FalseValue = FalseRet->getReturnValue();
Andrew Trickf3cf1932012-08-29 21:46:36 +00001993
Dan Gohmanfa1211f2008-07-23 00:34:11 +00001994 // Unwrap any PHI nodes in the return blocks.
1995 if (PHINode *TVPN = dyn_cast_or_null<PHINode>(TrueValue))
1996 if (TVPN->getParent() == TrueSucc)
1997 TrueValue = TVPN->getIncomingValueForBlock(BI->getParent());
1998 if (PHINode *FVPN = dyn_cast_or_null<PHINode>(FalseValue))
1999 if (FVPN->getParent() == FalseSucc)
2000 FalseValue = FVPN->getIncomingValueForBlock(BI->getParent());
Andrew Trickf3cf1932012-08-29 21:46:36 +00002001
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002002 // In order for this transformation to be safe, we must be able to
2003 // unconditionally execute both operands to the return. This is
2004 // normally the case, but we could have a potentially-trapping
2005 // constant expression that prevents this transformation from being
2006 // safe.
2007 if (ConstantExpr *TCV = dyn_cast_or_null<ConstantExpr>(TrueValue))
2008 if (TCV->canTrap())
2009 return false;
2010 if (ConstantExpr *FCV = dyn_cast_or_null<ConstantExpr>(FalseValue))
2011 if (FCV->canTrap())
2012 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002013
Chris Lattner86bbf332008-04-24 00:01:19 +00002014 // Okay, we collected all the mapped values and checked them for sanity, and
2015 // defined to really do this transformation. First, update the CFG.
2016 TrueSucc->removePredecessor(BI->getParent());
2017 FalseSucc->removePredecessor(BI->getParent());
Andrew Trickf3cf1932012-08-29 21:46:36 +00002018
Chris Lattner86bbf332008-04-24 00:01:19 +00002019 // Insert select instructions where needed.
2020 Value *BrCond = BI->getCondition();
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002021 if (TrueValue) {
Chris Lattner86bbf332008-04-24 00:01:19 +00002022 // Insert a select if the results differ.
Dan Gohmanfa1211f2008-07-23 00:34:11 +00002023 if (TrueValue == FalseValue || isa<UndefValue>(FalseValue)) {
2024 } else if (isa<UndefValue>(TrueValue)) {
2025 TrueValue = FalseValue;
2026 } else {
Devang Pateldd14e0f2011-05-18 21:33:11 +00002027 TrueValue = Builder.CreateSelect(BrCond, TrueValue,
2028 FalseValue, "retval");
Chris Lattner86bbf332008-04-24 00:01:19 +00002029 }
Chris Lattner86bbf332008-04-24 00:01:19 +00002030 }
2031
Andrew Trickf3cf1932012-08-29 21:46:36 +00002032 Value *RI = !TrueValue ?
Devang Pateldd14e0f2011-05-18 21:33:11 +00002033 Builder.CreateRetVoid() : Builder.CreateRet(TrueValue);
2034
Daniel Dunbar5e0a58b2009-08-23 10:29:55 +00002035 (void) RI;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002036
David Greene725c7c32010-01-05 01:26:52 +00002037 DEBUG(dbgs() << "\nCHANGING BRANCH TO TWO RETURNS INTO SELECT:"
Chris Lattnerb25de3f2009-08-23 04:37:46 +00002038 << "\n " << *BI << "NewRet = " << *RI
2039 << "TRUEBLOCK: " << *TrueSucc << "FALSEBLOCK: "<< *FalseSucc);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002040
Eli Friedmancb61afb2008-12-16 20:54:32 +00002041 EraseTerminatorInstAndDCECond(BI);
2042
Chris Lattner86bbf332008-04-24 00:01:19 +00002043 return true;
2044}
2045
Sanjay Patel09159b8f2015-06-24 20:40:57 +00002046/// Return true if the given instruction is available
Manman Rend33f4ef2012-06-13 05:43:29 +00002047/// in its predecessor block. If yes, the instruction will be removed.
Benjamin Kramerabbfe692012-07-13 13:25:15 +00002048static bool checkCSEInPredecessor(Instruction *Inst, BasicBlock *PB) {
Manman Rend33f4ef2012-06-13 05:43:29 +00002049 if (!isa<BinaryOperator>(Inst) && !isa<CmpInst>(Inst))
2050 return false;
2051 for (BasicBlock::iterator I = PB->begin(), E = PB->end(); I != E; I++) {
2052 Instruction *PBI = &*I;
2053 // Check whether Inst and PBI generate the same value.
2054 if (Inst->isIdenticalTo(PBI)) {
2055 Inst->replaceAllUsesWith(PBI);
2056 Inst->eraseFromParent();
2057 return true;
2058 }
2059 }
2060 return false;
2061}
Nick Lewycky3c3feaf2012-01-25 09:43:14 +00002062
Sanjay Patel09159b8f2015-06-24 20:40:57 +00002063/// If this basic block is simple enough, and if a predecessor branches to us
2064/// and one of our successors, fold the block into the predecessor and use
2065/// logical operations to pick the right destination.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00002066bool llvm::FoldBranchToCommonDest(BranchInst *BI, unsigned BonusInstThreshold) {
Chris Lattner80b03a12008-07-13 22:23:11 +00002067 BasicBlock *BB = BI->getParent();
Devang Patel1407fb42011-05-19 20:52:46 +00002068
Craig Topperf40110f2014-04-25 05:29:35 +00002069 Instruction *Cond = nullptr;
Manman Rend33f4ef2012-06-13 05:43:29 +00002070 if (BI->isConditional())
2071 Cond = dyn_cast<Instruction>(BI->getCondition());
2072 else {
2073 // For unconditional branch, check for a simple CFG pattern, where
2074 // BB has a single predecessor and BB's successor is also its predecessor's
2075 // successor. If such pattern exisits, check for CSE between BB and its
2076 // predecessor.
2077 if (BasicBlock *PB = BB->getSinglePredecessor())
2078 if (BranchInst *PBI = dyn_cast<BranchInst>(PB->getTerminator()))
2079 if (PBI->isConditional() &&
2080 (BI->getSuccessor(0) == PBI->getSuccessor(0) ||
2081 BI->getSuccessor(0) == PBI->getSuccessor(1))) {
2082 for (BasicBlock::iterator I = BB->begin(), E = BB->end();
2083 I != E; ) {
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00002084 Instruction *Curr = &*I++;
Manman Rend33f4ef2012-06-13 05:43:29 +00002085 if (isa<CmpInst>(Curr)) {
2086 Cond = Curr;
2087 break;
2088 }
2089 // Quit if we can't remove this instruction.
2090 if (!checkCSEInPredecessor(Curr, PB))
2091 return false;
2092 }
2093 }
2094
Craig Topperf40110f2014-04-25 05:29:35 +00002095 if (!Cond)
Manman Rend33f4ef2012-06-13 05:43:29 +00002096 return false;
2097 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002098
Craig Topperf40110f2014-04-25 05:29:35 +00002099 if (!Cond || (!isa<CmpInst>(Cond) && !isa<BinaryOperator>(Cond)) ||
2100 Cond->getParent() != BB || !Cond->hasOneUse())
Sanjay Patel2e002772016-03-12 18:05:53 +00002101 return false;
Devang Pateld715ec82011-04-06 22:37:20 +00002102
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002103 // Make sure the instruction after the condition is the cond branch.
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00002104 BasicBlock::iterator CondIt = ++Cond->getIterator();
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002105
Sanjay Patel0a2ada72014-07-06 23:10:24 +00002106 // Ignore dbg intrinsics.
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002107 while (isa<DbgInfoIntrinsic>(CondIt)) ++CondIt;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002108
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002109 if (&*CondIt != BI)
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002110 return false;
Chris Lattnerea9f1d32009-01-19 23:03:13 +00002111
Jingyue Wufc029672014-09-30 22:23:38 +00002112 // Only allow this transformation if computing the condition doesn't involve
2113 // too many instructions and these involved instructions can be executed
2114 // unconditionally. We denote all involved instructions except the condition
2115 // as "bonus instructions", and only allow this transformation when the
2116 // number of the bonus instructions does not exceed a certain threshold.
2117 unsigned NumBonusInsts = 0;
Duncan P. N. Exon Smithe9bc5792016-02-21 20:39:50 +00002118 for (auto I = BB->begin(); Cond != &*I; ++I) {
Jingyue Wufc029672014-09-30 22:23:38 +00002119 // Ignore dbg intrinsics.
2120 if (isa<DbgInfoIntrinsic>(I))
2121 continue;
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00002122 if (!I->hasOneUse() || !isSafeToSpeculativelyExecute(&*I))
Jingyue Wufc029672014-09-30 22:23:38 +00002123 return false;
2124 // I has only one use and can be executed unconditionally.
2125 Instruction *User = dyn_cast<Instruction>(I->user_back());
2126 if (User == nullptr || User->getParent() != BB)
2127 return false;
2128 // I is used in the same BB. Since BI uses Cond and doesn't have more slots
2129 // to use any other instruction, User must be an instruction between next(I)
2130 // and Cond.
2131 ++NumBonusInsts;
2132 // Early exits once we reach the limit.
2133 if (NumBonusInsts > BonusInstThreshold)
2134 return false;
2135 }
2136
Chris Lattnerea9f1d32009-01-19 23:03:13 +00002137 // Cond is known to be a compare or binary operator. Check to make sure that
2138 // neither operand is a potentially-trapping constant expression.
2139 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(0)))
2140 if (CE->canTrap())
2141 return false;
2142 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(Cond->getOperand(1)))
2143 if (CE->canTrap())
2144 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002145
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002146 // Finally, don't infinitely unroll conditional loops.
2147 BasicBlock *TrueDest = BI->getSuccessor(0);
Craig Topperf40110f2014-04-25 05:29:35 +00002148 BasicBlock *FalseDest = (BI->isConditional()) ? BI->getSuccessor(1) : nullptr;
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002149 if (TrueDest == BB || FalseDest == BB)
2150 return false;
Devang Pateld715ec82011-04-06 22:37:20 +00002151
Duncan P. N. Exon Smith6c990152014-07-21 17:06:51 +00002152 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
2153 BasicBlock *PredBlock = *PI;
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002154 BranchInst *PBI = dyn_cast<BranchInst>(PredBlock->getTerminator());
Andrew Trickf3cf1932012-08-29 21:46:36 +00002155
Chris Lattner80b03a12008-07-13 22:23:11 +00002156 // Check that we have two conditional branches. If there is a PHI node in
2157 // the common successor, verify that the same value flows in from both
2158 // blocks.
Manman Rend33f4ef2012-06-13 05:43:29 +00002159 SmallVector<PHINode*, 4> PHIs;
Craig Topperf40110f2014-04-25 05:29:35 +00002160 if (!PBI || PBI->isUnconditional() ||
Andrew Trickf3cf1932012-08-29 21:46:36 +00002161 (BI->isConditional() &&
Manman Rend33f4ef2012-06-13 05:43:29 +00002162 !SafeToMergeTerminators(BI, PBI)) ||
2163 (!BI->isConditional() &&
2164 !isProfitableToFoldUnconditional(BI, PBI, Cond, PHIs)))
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002165 continue;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002166
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002167 // Determine if the two branches share a common destination.
Axel Naumann4a127062012-09-17 14:20:57 +00002168 Instruction::BinaryOps Opc = Instruction::BinaryOpsEnd;
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002169 bool InvertPredCond = false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002170
Manman Rend33f4ef2012-06-13 05:43:29 +00002171 if (BI->isConditional()) {
Richard Trieu7a083812016-02-18 22:09:30 +00002172 if (PBI->getSuccessor(0) == TrueDest) {
Manman Rend33f4ef2012-06-13 05:43:29 +00002173 Opc = Instruction::Or;
Richard Trieu7a083812016-02-18 22:09:30 +00002174 } else if (PBI->getSuccessor(1) == FalseDest) {
Manman Rend33f4ef2012-06-13 05:43:29 +00002175 Opc = Instruction::And;
Richard Trieu7a083812016-02-18 22:09:30 +00002176 } else if (PBI->getSuccessor(0) == FalseDest) {
2177 Opc = Instruction::And;
2178 InvertPredCond = true;
2179 } else if (PBI->getSuccessor(1) == TrueDest) {
2180 Opc = Instruction::Or;
2181 InvertPredCond = true;
2182 } else {
Manman Rend33f4ef2012-06-13 05:43:29 +00002183 continue;
Richard Trieu7a083812016-02-18 22:09:30 +00002184 }
Manman Rend33f4ef2012-06-13 05:43:29 +00002185 } else {
2186 if (PBI->getSuccessor(0) != TrueDest && PBI->getSuccessor(1) != TrueDest)
2187 continue;
2188 }
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002189
David Greene725c7c32010-01-05 01:26:52 +00002190 DEBUG(dbgs() << "FOLDING BRANCH TO COMMON DEST:\n" << *PBI << *BB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002191 IRBuilder<> Builder(PBI);
Devang Patel1407fb42011-05-19 20:52:46 +00002192
Chris Lattner55eaae12008-07-13 21:20:19 +00002193 // If we need to invert the condition in the pred block to match, do so now.
2194 if (InvertPredCond) {
Chris Lattnerfbeb5582010-12-13 07:00:06 +00002195 Value *NewCond = PBI->getCondition();
Andrew Trickf3cf1932012-08-29 21:46:36 +00002196
Chris Lattnerfbeb5582010-12-13 07:00:06 +00002197 if (NewCond->hasOneUse() && isa<CmpInst>(NewCond)) {
2198 CmpInst *CI = cast<CmpInst>(NewCond);
2199 CI->setPredicate(CI->getInversePredicate());
2200 } else {
Andrew Trickf3cf1932012-08-29 21:46:36 +00002201 NewCond = Builder.CreateNot(NewCond,
Devang Patel1407fb42011-05-19 20:52:46 +00002202 PBI->getCondition()->getName()+".not");
Chris Lattnerfbeb5582010-12-13 07:00:06 +00002203 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002204
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002205 PBI->setCondition(NewCond);
Nick Lewycky8d302df2011-12-26 20:54:14 +00002206 PBI->swapSuccessors();
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002207 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002208
Jingyue Wufc029672014-09-30 22:23:38 +00002209 // If we have bonus instructions, clone them into the predecessor block.
Sanjay Pateladb110c2015-06-24 20:07:50 +00002210 // Note that there may be multiple predecessor blocks, so we cannot move
Jingyue Wufc029672014-09-30 22:23:38 +00002211 // bonus instructions to a predecessor block.
2212 ValueToValueMapTy VMap; // maps original values to cloned values
2213 // We already make sure Cond is the last instruction before BI. Therefore,
Sanjay Pateladb110c2015-06-24 20:07:50 +00002214 // all instructions before Cond other than DbgInfoIntrinsic are bonus
Jingyue Wufc029672014-09-30 22:23:38 +00002215 // instructions.
Duncan P. N. Exon Smithe9bc5792016-02-21 20:39:50 +00002216 for (auto BonusInst = BB->begin(); Cond != &*BonusInst; ++BonusInst) {
Jingyue Wufc029672014-09-30 22:23:38 +00002217 if (isa<DbgInfoIntrinsic>(BonusInst))
2218 continue;
2219 Instruction *NewBonusInst = BonusInst->clone();
2220 RemapInstruction(NewBonusInst, VMap,
Duncan P. N. Exon Smithda68cbc2016-04-07 00:26:43 +00002221 RF_NoModuleLevelChanges | RF_IgnoreMissingLocals);
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00002222 VMap[&*BonusInst] = NewBonusInst;
Rafael Espindolaab73c492014-01-28 16:56:46 +00002223
2224 // If we moved a load, we cannot any longer claim any knowledge about
2225 // its potential value. The previous information might have been valid
2226 // only given the branch precondition.
2227 // For an analogous reason, we must also drop all the metadata whose
2228 // semantics we don't understand.
Adrian Prantlcbdfdb72015-08-20 22:00:30 +00002229 NewBonusInst->dropUnknownNonDebugMetadata();
Rafael Espindolaab73c492014-01-28 16:56:46 +00002230
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00002231 PredBlock->getInstList().insert(PBI->getIterator(), NewBonusInst);
2232 NewBonusInst->takeName(&*BonusInst);
Jingyue Wufc029672014-09-30 22:23:38 +00002233 BonusInst->setName(BonusInst->getName() + ".old");
Owen Anderson2cfe9132010-07-14 19:52:16 +00002234 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002235
Chris Lattner55eaae12008-07-13 21:20:19 +00002236 // Clone Cond into the predecessor basic block, and or/and the
2237 // two conditions together.
Nick Lewycky42fb7452009-09-27 07:38:41 +00002238 Instruction *New = Cond->clone();
Jingyue Wufc029672014-09-30 22:23:38 +00002239 RemapInstruction(New, VMap,
Duncan P. N. Exon Smithda68cbc2016-04-07 00:26:43 +00002240 RF_NoModuleLevelChanges | RF_IgnoreMissingLocals);
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00002241 PredBlock->getInstList().insert(PBI->getIterator(), New);
Chris Lattner55eaae12008-07-13 21:20:19 +00002242 New->takeName(Cond);
Jingyue Wufc029672014-09-30 22:23:38 +00002243 Cond->setName(New->getName() + ".old");
Andrew Trickf3cf1932012-08-29 21:46:36 +00002244
Manman Rend33f4ef2012-06-13 05:43:29 +00002245 if (BI->isConditional()) {
Andrew Trickf3cf1932012-08-29 21:46:36 +00002246 Instruction *NewCond =
Manman Rend33f4ef2012-06-13 05:43:29 +00002247 cast<Instruction>(Builder.CreateBinOp(Opc, PBI->getCondition(),
Devang Patel1407fb42011-05-19 20:52:46 +00002248 New, "or.cond"));
Manman Rend33f4ef2012-06-13 05:43:29 +00002249 PBI->setCondition(NewCond);
2250
Manman Renbfb9d432012-09-15 00:39:57 +00002251 uint64_t PredTrueWeight, PredFalseWeight, SuccTrueWeight, SuccFalseWeight;
Sanjay Pateldc88bd62016-04-23 20:01:22 +00002252 bool PredHasWeights =
2253 PBI->extractProfMetadata(PredTrueWeight, PredFalseWeight);
2254 bool SuccHasWeights =
2255 BI->extractProfMetadata(SuccTrueWeight, SuccFalseWeight);
Manman Renbfb9d432012-09-15 00:39:57 +00002256 SmallVector<uint64_t, 8> NewWeights;
2257
Manman Rend33f4ef2012-06-13 05:43:29 +00002258 if (PBI->getSuccessor(0) == BB) {
Manman Renbfb9d432012-09-15 00:39:57 +00002259 if (PredHasWeights && SuccHasWeights) {
2260 // PBI: br i1 %x, BB, FalseDest
2261 // BI: br i1 %y, TrueDest, FalseDest
2262 //TrueWeight is TrueWeight for PBI * TrueWeight for BI.
2263 NewWeights.push_back(PredTrueWeight * SuccTrueWeight);
2264 //FalseWeight is FalseWeight for PBI * TotalWeight for BI +
2265 // TrueWeight for PBI * FalseWeight for BI.
2266 // We assume that total weights of a BranchInst can fit into 32 bits.
2267 // Therefore, we will not have overflow using 64-bit arithmetic.
2268 NewWeights.push_back(PredFalseWeight * (SuccFalseWeight +
2269 SuccTrueWeight) + PredTrueWeight * SuccFalseWeight);
2270 }
Manman Rend33f4ef2012-06-13 05:43:29 +00002271 AddPredecessorToBlock(TrueDest, PredBlock, BB);
2272 PBI->setSuccessor(0, TrueDest);
2273 }
2274 if (PBI->getSuccessor(1) == BB) {
Manman Renbfb9d432012-09-15 00:39:57 +00002275 if (PredHasWeights && SuccHasWeights) {
2276 // PBI: br i1 %x, TrueDest, BB
2277 // BI: br i1 %y, TrueDest, FalseDest
2278 //TrueWeight is TrueWeight for PBI * TotalWeight for BI +
2279 // FalseWeight for PBI * TrueWeight for BI.
2280 NewWeights.push_back(PredTrueWeight * (SuccFalseWeight +
2281 SuccTrueWeight) + PredFalseWeight * SuccTrueWeight);
2282 //FalseWeight is FalseWeight for PBI * FalseWeight for BI.
2283 NewWeights.push_back(PredFalseWeight * SuccFalseWeight);
2284 }
Manman Rend33f4ef2012-06-13 05:43:29 +00002285 AddPredecessorToBlock(FalseDest, PredBlock, BB);
2286 PBI->setSuccessor(1, FalseDest);
2287 }
Manman Renbfb9d432012-09-15 00:39:57 +00002288 if (NewWeights.size() == 2) {
2289 // Halve the weights if any of them cannot fit in an uint32_t
2290 FitWeights(NewWeights);
2291
2292 SmallVector<uint32_t, 8> MDWeights(NewWeights.begin(),NewWeights.end());
2293 PBI->setMetadata(LLVMContext::MD_prof,
2294 MDBuilder(BI->getContext()).
2295 createBranchWeights(MDWeights));
2296 } else
Craig Topperf40110f2014-04-25 05:29:35 +00002297 PBI->setMetadata(LLVMContext::MD_prof, nullptr);
Manman Rend33f4ef2012-06-13 05:43:29 +00002298 } else {
2299 // Update PHI nodes in the common successors.
2300 for (unsigned i = 0, e = PHIs.size(); i != e; ++i) {
Nick Lewycky0a045bb2012-06-24 10:15:42 +00002301 ConstantInt *PBI_C = cast<ConstantInt>(
Manman Rend33f4ef2012-06-13 05:43:29 +00002302 PHIs[i]->getIncomingValueForBlock(PBI->getParent()));
2303 assert(PBI_C->getType()->isIntegerTy(1));
Craig Topperf40110f2014-04-25 05:29:35 +00002304 Instruction *MergedCond = nullptr;
Manman Rend33f4ef2012-06-13 05:43:29 +00002305 if (PBI->getSuccessor(0) == TrueDest) {
2306 // Create (PBI_Cond and PBI_C) or (!PBI_Cond and BI_Value)
2307 // PBI_C is true: PBI_Cond or (!PBI_Cond and BI_Value)
2308 // is false: !PBI_Cond and BI_Value
2309 Instruction *NotCond =
2310 cast<Instruction>(Builder.CreateNot(PBI->getCondition(),
2311 "not.cond"));
2312 MergedCond =
2313 cast<Instruction>(Builder.CreateBinOp(Instruction::And,
2314 NotCond, New,
2315 "and.cond"));
2316 if (PBI_C->isOne())
2317 MergedCond =
2318 cast<Instruction>(Builder.CreateBinOp(Instruction::Or,
2319 PBI->getCondition(), MergedCond,
2320 "or.cond"));
2321 } else {
2322 // Create (PBI_Cond and BI_Value) or (!PBI_Cond and PBI_C)
2323 // PBI_C is true: (PBI_Cond and BI_Value) or (!PBI_Cond)
2324 // is false: PBI_Cond and BI_Value
Andrew Trickf3cf1932012-08-29 21:46:36 +00002325 MergedCond =
Manman Rend33f4ef2012-06-13 05:43:29 +00002326 cast<Instruction>(Builder.CreateBinOp(Instruction::And,
2327 PBI->getCondition(), New,
2328 "and.cond"));
2329 if (PBI_C->isOne()) {
2330 Instruction *NotCond =
2331 cast<Instruction>(Builder.CreateNot(PBI->getCondition(),
2332 "not.cond"));
Andrew Trickf3cf1932012-08-29 21:46:36 +00002333 MergedCond =
Manman Rend33f4ef2012-06-13 05:43:29 +00002334 cast<Instruction>(Builder.CreateBinOp(Instruction::Or,
2335 NotCond, MergedCond,
2336 "or.cond"));
2337 }
2338 }
2339 // Update PHI Node.
2340 PHIs[i]->setIncomingValue(PHIs[i]->getBasicBlockIndex(PBI->getParent()),
2341 MergedCond);
2342 }
2343 // Change PBI from Conditional to Unconditional.
2344 BranchInst *New_PBI = BranchInst::Create(TrueDest, PBI);
2345 EraseTerminatorInstAndDCECond(PBI);
2346 PBI = New_PBI;
Chris Lattner55eaae12008-07-13 21:20:19 +00002347 }
Devang Pateld715ec82011-04-06 22:37:20 +00002348
Nick Lewyckyc554a9b2011-12-27 04:31:52 +00002349 // TODO: If BB is reachable from all paths through PredBlock, then we
2350 // could replace PBI's branch probabilities with BI's.
2351
Chris Lattnerfba5cdf2011-04-14 02:44:53 +00002352 // Copy any debug value intrinsics into the end of PredBlock.
2353 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
2354 if (isa<DbgInfoIntrinsic>(*I))
2355 I->clone()->insertBefore(PBI);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002356
Chris Lattner5a9d59d2010-12-14 05:57:30 +00002357 return true;
Chris Lattner2e25b8f2008-07-13 21:12:01 +00002358 }
2359 return false;
2360}
2361
James Molloy4de84dd2015-11-04 15:28:04 +00002362// If there is only one store in BB1 and BB2, return it, otherwise return
2363// nullptr.
2364static StoreInst *findUniqueStoreInBlocks(BasicBlock *BB1, BasicBlock *BB2) {
2365 StoreInst *S = nullptr;
2366 for (auto *BB : {BB1, BB2}) {
2367 if (!BB)
2368 continue;
2369 for (auto &I : *BB)
2370 if (auto *SI = dyn_cast<StoreInst>(&I)) {
2371 if (S)
2372 // Multiple stores seen.
2373 return nullptr;
2374 else
2375 S = SI;
2376 }
2377 }
2378 return S;
2379}
2380
2381static Value *ensureValueAvailableInSuccessor(Value *V, BasicBlock *BB,
2382 Value *AlternativeV = nullptr) {
2383 // PHI is going to be a PHI node that allows the value V that is defined in
2384 // BB to be referenced in BB's only successor.
2385 //
2386 // If AlternativeV is nullptr, the only value we care about in PHI is V. It
2387 // doesn't matter to us what the other operand is (it'll never get used). We
2388 // could just create a new PHI with an undef incoming value, but that could
2389 // increase register pressure if EarlyCSE/InstCombine can't fold it with some
2390 // other PHI. So here we directly look for some PHI in BB's successor with V
2391 // as an incoming operand. If we find one, we use it, else we create a new
2392 // one.
2393 //
2394 // If AlternativeV is not nullptr, we care about both incoming values in PHI.
2395 // PHI must be exactly: phi <ty> [ %BB, %V ], [ %OtherBB, %AlternativeV]
2396 // where OtherBB is the single other predecessor of BB's only successor.
2397 PHINode *PHI = nullptr;
2398 BasicBlock *Succ = BB->getSingleSuccessor();
2399
2400 for (auto I = Succ->begin(); isa<PHINode>(I); ++I)
2401 if (cast<PHINode>(I)->getIncomingValueForBlock(BB) == V) {
2402 PHI = cast<PHINode>(I);
2403 if (!AlternativeV)
2404 break;
2405
2406 assert(std::distance(pred_begin(Succ), pred_end(Succ)) == 2);
2407 auto PredI = pred_begin(Succ);
2408 BasicBlock *OtherPredBB = *PredI == BB ? *++PredI : *PredI;
2409 if (PHI->getIncomingValueForBlock(OtherPredBB) == AlternativeV)
2410 break;
2411 PHI = nullptr;
2412 }
2413 if (PHI)
2414 return PHI;
2415
James Molloy3d21dcf2015-12-16 14:12:44 +00002416 // If V is not an instruction defined in BB, just return it.
2417 if (!AlternativeV &&
2418 (!isa<Instruction>(V) || cast<Instruction>(V)->getParent() != BB))
2419 return V;
2420
Duncan P. N. Exon Smith83c4b682015-11-07 00:01:16 +00002421 PHI = PHINode::Create(V->getType(), 2, "simplifycfg.merge", &Succ->front());
James Molloy4de84dd2015-11-04 15:28:04 +00002422 PHI->addIncoming(V, BB);
2423 for (BasicBlock *PredBB : predecessors(Succ))
2424 if (PredBB != BB)
2425 PHI->addIncoming(AlternativeV ? AlternativeV : UndefValue::get(V->getType()),
2426 PredBB);
2427 return PHI;
2428}
2429
2430static bool mergeConditionalStoreToAddress(BasicBlock *PTB, BasicBlock *PFB,
2431 BasicBlock *QTB, BasicBlock *QFB,
2432 BasicBlock *PostBB, Value *Address,
2433 bool InvertPCond, bool InvertQCond) {
2434 auto IsaBitcastOfPointerType = [](const Instruction &I) {
2435 return Operator::getOpcode(&I) == Instruction::BitCast &&
2436 I.getType()->isPointerTy();
2437 };
2438
2439 // If we're not in aggressive mode, we only optimize if we have some
2440 // confidence that by optimizing we'll allow P and/or Q to be if-converted.
2441 auto IsWorthwhile = [&](BasicBlock *BB) {
2442 if (!BB)
2443 return true;
2444 // Heuristic: if the block can be if-converted/phi-folded and the
2445 // instructions inside are all cheap (arithmetic/GEPs), it's worthwhile to
2446 // thread this store.
James Molloy9e959ac2015-11-05 08:40:19 +00002447 unsigned N = 0;
2448 for (auto &I : *BB) {
2449 // Cheap instructions viable for folding.
2450 if (isa<BinaryOperator>(I) || isa<GetElementPtrInst>(I) ||
2451 isa<StoreInst>(I))
2452 ++N;
2453 // Free instructions.
2454 else if (isa<TerminatorInst>(I) || isa<DbgInfoIntrinsic>(I) ||
2455 IsaBitcastOfPointerType(I))
2456 continue;
2457 else
James Molloy4de84dd2015-11-04 15:28:04 +00002458 return false;
James Molloy9e959ac2015-11-05 08:40:19 +00002459 }
2460 return N <= PHINodeFoldingThreshold;
James Molloy4de84dd2015-11-04 15:28:04 +00002461 };
2462
2463 if (!MergeCondStoresAggressively && (!IsWorthwhile(PTB) ||
2464 !IsWorthwhile(PFB) ||
2465 !IsWorthwhile(QTB) ||
2466 !IsWorthwhile(QFB)))
2467 return false;
2468
2469 // For every pointer, there must be exactly two stores, one coming from
2470 // PTB or PFB, and the other from QTB or QFB. We don't support more than one
2471 // store (to any address) in PTB,PFB or QTB,QFB.
2472 // FIXME: We could relax this restriction with a bit more work and performance
2473 // testing.
2474 StoreInst *PStore = findUniqueStoreInBlocks(PTB, PFB);
2475 StoreInst *QStore = findUniqueStoreInBlocks(QTB, QFB);
2476 if (!PStore || !QStore)
2477 return false;
2478
2479 // Now check the stores are compatible.
2480 if (!QStore->isUnordered() || !PStore->isUnordered())
2481 return false;
2482
2483 // Check that sinking the store won't cause program behavior changes. Sinking
2484 // the store out of the Q blocks won't change any behavior as we're sinking
2485 // from a block to its unconditional successor. But we're moving a store from
2486 // the P blocks down through the middle block (QBI) and past both QFB and QTB.
2487 // So we need to check that there are no aliasing loads or stores in
2488 // QBI, QTB and QFB. We also need to check there are no conflicting memory
2489 // operations between PStore and the end of its parent block.
2490 //
2491 // The ideal way to do this is to query AliasAnalysis, but we don't
2492 // preserve AA currently so that is dangerous. Be super safe and just
2493 // check there are no other memory operations at all.
2494 for (auto &I : *QFB->getSinglePredecessor())
2495 if (I.mayReadOrWriteMemory())
2496 return false;
2497 for (auto &I : *QFB)
2498 if (&I != QStore && I.mayReadOrWriteMemory())
2499 return false;
2500 if (QTB)
2501 for (auto &I : *QTB)
2502 if (&I != QStore && I.mayReadOrWriteMemory())
2503 return false;
2504 for (auto I = BasicBlock::iterator(PStore), E = PStore->getParent()->end();
2505 I != E; ++I)
2506 if (&*I != PStore && I->mayReadOrWriteMemory())
2507 return false;
2508
2509 // OK, we're going to sink the stores to PostBB. The store has to be
2510 // conditional though, so first create the predicate.
2511 Value *PCond = cast<BranchInst>(PFB->getSinglePredecessor()->getTerminator())
2512 ->getCondition();
2513 Value *QCond = cast<BranchInst>(QFB->getSinglePredecessor()->getTerminator())
2514 ->getCondition();
2515
2516 Value *PPHI = ensureValueAvailableInSuccessor(PStore->getValueOperand(),
2517 PStore->getParent());
2518 Value *QPHI = ensureValueAvailableInSuccessor(QStore->getValueOperand(),
2519 QStore->getParent(), PPHI);
2520
Duncan P. N. Exon Smith83c4b682015-11-07 00:01:16 +00002521 IRBuilder<> QB(&*PostBB->getFirstInsertionPt());
2522
James Molloy4de84dd2015-11-04 15:28:04 +00002523 Value *PPred = PStore->getParent() == PTB ? PCond : QB.CreateNot(PCond);
2524 Value *QPred = QStore->getParent() == QTB ? QCond : QB.CreateNot(QCond);
2525
2526 if (InvertPCond)
2527 PPred = QB.CreateNot(PPred);
2528 if (InvertQCond)
2529 QPred = QB.CreateNot(QPred);
2530 Value *CombinedPred = QB.CreateOr(PPred, QPred);
2531
Duncan P. N. Exon Smith83c4b682015-11-07 00:01:16 +00002532 auto *T =
2533 SplitBlockAndInsertIfThen(CombinedPred, &*QB.GetInsertPoint(), false);
James Molloy4de84dd2015-11-04 15:28:04 +00002534 QB.SetInsertPoint(T);
2535 StoreInst *SI = cast<StoreInst>(QB.CreateStore(QPHI, Address));
2536 AAMDNodes AAMD;
2537 PStore->getAAMetadata(AAMD, /*Merge=*/false);
2538 PStore->getAAMetadata(AAMD, /*Merge=*/true);
2539 SI->setAAMetadata(AAMD);
2540
2541 QStore->eraseFromParent();
2542 PStore->eraseFromParent();
2543
2544 return true;
2545}
2546
2547static bool mergeConditionalStores(BranchInst *PBI, BranchInst *QBI) {
2548 // The intention here is to find diamonds or triangles (see below) where each
2549 // conditional block contains a store to the same address. Both of these
2550 // stores are conditional, so they can't be unconditionally sunk. But it may
2551 // be profitable to speculatively sink the stores into one merged store at the
2552 // end, and predicate the merged store on the union of the two conditions of
2553 // PBI and QBI.
2554 //
2555 // This can reduce the number of stores executed if both of the conditions are
2556 // true, and can allow the blocks to become small enough to be if-converted.
2557 // This optimization will also chain, so that ladders of test-and-set
2558 // sequences can be if-converted away.
2559 //
2560 // We only deal with simple diamonds or triangles:
2561 //
2562 // PBI or PBI or a combination of the two
2563 // / \ | \
2564 // PTB PFB | PFB
2565 // \ / | /
2566 // QBI QBI
2567 // / \ | \
2568 // QTB QFB | QFB
2569 // \ / | /
2570 // PostBB PostBB
2571 //
2572 // We model triangles as a type of diamond with a nullptr "true" block.
2573 // Triangles are canonicalized so that the fallthrough edge is represented by
2574 // a true condition, as in the diagram above.
2575 //
2576 BasicBlock *PTB = PBI->getSuccessor(0);
2577 BasicBlock *PFB = PBI->getSuccessor(1);
2578 BasicBlock *QTB = QBI->getSuccessor(0);
2579 BasicBlock *QFB = QBI->getSuccessor(1);
2580 BasicBlock *PostBB = QFB->getSingleSuccessor();
2581
2582 bool InvertPCond = false, InvertQCond = false;
2583 // Canonicalize fallthroughs to the true branches.
2584 if (PFB == QBI->getParent()) {
2585 std::swap(PFB, PTB);
2586 InvertPCond = true;
2587 }
2588 if (QFB == PostBB) {
2589 std::swap(QFB, QTB);
2590 InvertQCond = true;
2591 }
2592
2593 // From this point on we can assume PTB or QTB may be fallthroughs but PFB
2594 // and QFB may not. Model fallthroughs as a nullptr block.
2595 if (PTB == QBI->getParent())
2596 PTB = nullptr;
2597 if (QTB == PostBB)
2598 QTB = nullptr;
2599
2600 // Legality bailouts. We must have at least the non-fallthrough blocks and
2601 // the post-dominating block, and the non-fallthroughs must only have one
2602 // predecessor.
2603 auto HasOnePredAndOneSucc = [](BasicBlock *BB, BasicBlock *P, BasicBlock *S) {
2604 return BB->getSinglePredecessor() == P &&
2605 BB->getSingleSuccessor() == S;
2606 };
2607 if (!PostBB ||
2608 !HasOnePredAndOneSucc(PFB, PBI->getParent(), QBI->getParent()) ||
2609 !HasOnePredAndOneSucc(QFB, QBI->getParent(), PostBB))
2610 return false;
2611 if ((PTB && !HasOnePredAndOneSucc(PTB, PBI->getParent(), QBI->getParent())) ||
2612 (QTB && !HasOnePredAndOneSucc(QTB, QBI->getParent(), PostBB)))
2613 return false;
2614 if (PostBB->getNumUses() != 2 || QBI->getParent()->getNumUses() != 2)
2615 return false;
2616
2617 // OK, this is a sequence of two diamonds or triangles.
2618 // Check if there are stores in PTB or PFB that are repeated in QTB or QFB.
2619 SmallPtrSet<Value *,4> PStoreAddresses, QStoreAddresses;
2620 for (auto *BB : {PTB, PFB}) {
2621 if (!BB)
2622 continue;
2623 for (auto &I : *BB)
2624 if (StoreInst *SI = dyn_cast<StoreInst>(&I))
2625 PStoreAddresses.insert(SI->getPointerOperand());
2626 }
2627 for (auto *BB : {QTB, QFB}) {
2628 if (!BB)
2629 continue;
2630 for (auto &I : *BB)
2631 if (StoreInst *SI = dyn_cast<StoreInst>(&I))
2632 QStoreAddresses.insert(SI->getPointerOperand());
2633 }
2634
2635 set_intersect(PStoreAddresses, QStoreAddresses);
2636 // set_intersect mutates PStoreAddresses in place. Rename it here to make it
2637 // clear what it contains.
2638 auto &CommonAddresses = PStoreAddresses;
2639
2640 bool Changed = false;
2641 for (auto *Address : CommonAddresses)
2642 Changed |= mergeConditionalStoreToAddress(
2643 PTB, PFB, QTB, QFB, PostBB, Address, InvertPCond, InvertQCond);
2644 return Changed;
2645}
2646
Sanjay Patel09159b8f2015-06-24 20:40:57 +00002647/// If we have a conditional branch as a predecessor of another block,
2648/// this function tries to simplify it. We know
Chris Lattner9aada1d2008-07-13 21:53:26 +00002649/// that PBI and BI are both conditional branches, and BI is in one of the
2650/// successor blocks of PBI - PBI branches to BI.
Philip Reamesb42db212015-10-14 22:46:19 +00002651static bool SimplifyCondBranchToCondBranch(BranchInst *PBI, BranchInst *BI,
2652 const DataLayout &DL) {
Chris Lattner9aada1d2008-07-13 21:53:26 +00002653 assert(PBI->isConditional() && BI->isConditional());
2654 BasicBlock *BB = BI->getParent();
Dan Gohman5476cfd2009-08-12 16:23:25 +00002655
Chris Lattner9aada1d2008-07-13 21:53:26 +00002656 // If this block ends with a branch instruction, and if there is a
Andrew Trickf3cf1932012-08-29 21:46:36 +00002657 // predecessor that ends on a branch of the same condition, make
Chris Lattner9aada1d2008-07-13 21:53:26 +00002658 // this conditional branch redundant.
2659 if (PBI->getCondition() == BI->getCondition() &&
2660 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
2661 // Okay, the outcome of this conditional branch is statically
2662 // knowable. If this block had a single pred, handle specially.
2663 if (BB->getSinglePredecessor()) {
2664 // Turn this into a branch on constant.
2665 bool CondIsTrue = PBI->getSuccessor(0) == BB;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002666 BI->setCondition(ConstantInt::get(Type::getInt1Ty(BB->getContext()),
Owen Anderson55f1c092009-08-13 21:58:54 +00002667 CondIsTrue));
Chris Lattner9aada1d2008-07-13 21:53:26 +00002668 return true; // Nuke the branch on constant.
2669 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002670
Chris Lattner9aada1d2008-07-13 21:53:26 +00002671 // Otherwise, if there are multiple predecessors, insert a PHI that merges
2672 // in the constant and simplify the block result. Subsequent passes of
2673 // simplifycfg will thread the block.
2674 if (BlockIsSimpleEnoughToThreadThrough(BB)) {
Jay Foade0938d82011-03-30 11:19:20 +00002675 pred_iterator PB = pred_begin(BB), PE = pred_end(BB);
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00002676 PHINode *NewPN = PHINode::Create(
2677 Type::getInt1Ty(BB->getContext()), std::distance(PB, PE),
2678 BI->getCondition()->getName() + ".pr", &BB->front());
Chris Lattner5eed3722008-07-13 21:55:46 +00002679 // Okay, we're going to insert the PHI node. Since PBI is not the only
2680 // predecessor, compute the PHI'd conditional value for all of the preds.
2681 // Any predecessor where the condition is not computable we keep symbolic.
Jay Foade0938d82011-03-30 11:19:20 +00002682 for (pred_iterator PI = PB; PI != PE; ++PI) {
Gabor Greif8629f122010-07-12 10:59:23 +00002683 BasicBlock *P = *PI;
2684 if ((PBI = dyn_cast<BranchInst>(P->getTerminator())) &&
Chris Lattner9aada1d2008-07-13 21:53:26 +00002685 PBI != BI && PBI->isConditional() &&
2686 PBI->getCondition() == BI->getCondition() &&
2687 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
2688 bool CondIsTrue = PBI->getSuccessor(0) == BB;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002689 NewPN->addIncoming(ConstantInt::get(Type::getInt1Ty(BB->getContext()),
Gabor Greif8629f122010-07-12 10:59:23 +00002690 CondIsTrue), P);
Chris Lattner9aada1d2008-07-13 21:53:26 +00002691 } else {
Gabor Greif8629f122010-07-12 10:59:23 +00002692 NewPN->addIncoming(BI->getCondition(), P);
Chris Lattner9aada1d2008-07-13 21:53:26 +00002693 }
Gabor Greif8629f122010-07-12 10:59:23 +00002694 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002695
Chris Lattner9aada1d2008-07-13 21:53:26 +00002696 BI->setCondition(NewPN);
Chris Lattner9aada1d2008-07-13 21:53:26 +00002697 return true;
2698 }
2699 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002700
Philip Reamesb42db212015-10-14 22:46:19 +00002701 if (auto *CE = dyn_cast<ConstantExpr>(BI->getCondition()))
2702 if (CE->canTrap())
2703 return false;
2704
Philip Reames846e3e42015-10-29 03:11:49 +00002705 // If BI is reached from the true path of PBI and PBI's condition implies
2706 // BI's condition, we know the direction of the BI branch.
Chad Rosiere2cbd132016-04-25 17:23:36 +00002707 if ((PBI->getSuccessor(0) == BI->getParent() ||
2708 PBI->getSuccessor(1) == BI->getParent()) &&
Philip Reames846e3e42015-10-29 03:11:49 +00002709 PBI->getSuccessor(0) != PBI->getSuccessor(1) &&
2710 BB->getSinglePredecessor()) {
Chad Rosiere2cbd132016-04-25 17:23:36 +00002711 bool FalseDest = PBI->getSuccessor(1) == BI->getParent();
2712 Optional<bool> Implication = isImpliedCondition(
2713 PBI->getCondition(), BI->getCondition(), DL, FalseDest);
Chad Rosier41dd31f2016-04-20 19:15:26 +00002714 if (Implication) {
2715 // Turn this into a branch on constant.
2716 auto *OldCond = BI->getCondition();
2717 ConstantInt *CI = *Implication ? ConstantInt::getTrue(BB->getContext())
2718 : ConstantInt::getFalse(BB->getContext());
2719 BI->setCondition(CI);
2720 RecursivelyDeleteTriviallyDeadInstructions(OldCond);
2721 return true; // Nuke the branch on constant.
2722 }
Philip Reames846e3e42015-10-29 03:11:49 +00002723 }
2724
James Molloy4de84dd2015-11-04 15:28:04 +00002725 // If both branches are conditional and both contain stores to the same
2726 // address, remove the stores from the conditionals and create a conditional
2727 // merged store at the end.
2728 if (MergeCondStores && mergeConditionalStores(PBI, BI))
2729 return true;
2730
Chris Lattner9aada1d2008-07-13 21:53:26 +00002731 // If this is a conditional branch in an empty block, and if any
Sanjay Patel0a2ada72014-07-06 23:10:24 +00002732 // predecessors are a conditional branch to one of our destinations,
Chris Lattner9aada1d2008-07-13 21:53:26 +00002733 // fold the conditions into logical ops and one cond br.
Zhou Sheng264e46e2009-02-26 06:56:37 +00002734 BasicBlock::iterator BBI = BB->begin();
2735 // Ignore dbg intrinsics.
2736 while (isa<DbgInfoIntrinsic>(BBI))
2737 ++BBI;
2738 if (&*BBI != BI)
Chris Lattner834ab4e2008-07-13 22:04:41 +00002739 return false;
Chris Lattnerc59945b2009-01-20 01:15:41 +00002740
Chris Lattner834ab4e2008-07-13 22:04:41 +00002741 int PBIOp, BIOp;
Richard Trieu7a083812016-02-18 22:09:30 +00002742 if (PBI->getSuccessor(0) == BI->getSuccessor(0)) {
2743 PBIOp = 0;
2744 BIOp = 0;
2745 } else if (PBI->getSuccessor(0) == BI->getSuccessor(1)) {
2746 PBIOp = 0;
2747 BIOp = 1;
2748 } else if (PBI->getSuccessor(1) == BI->getSuccessor(0)) {
2749 PBIOp = 1;
2750 BIOp = 0;
2751 } else if (PBI->getSuccessor(1) == BI->getSuccessor(1)) {
2752 PBIOp = 1;
2753 BIOp = 1;
2754 } else {
Chris Lattner834ab4e2008-07-13 22:04:41 +00002755 return false;
Richard Trieu7a083812016-02-18 22:09:30 +00002756 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002757
Chris Lattner834ab4e2008-07-13 22:04:41 +00002758 // Check to make sure that the other destination of this branch
2759 // isn't BB itself. If so, this is an infinite loop that will
2760 // keep getting unwound.
2761 if (PBI->getSuccessor(PBIOp) == BB)
2762 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002763
2764 // Do not perform this transformation if it would require
Chris Lattner834ab4e2008-07-13 22:04:41 +00002765 // insertion of a large number of select instructions. For targets
2766 // without predication/cmovs, this is a big pessimization.
Andrew Trickf3cf1932012-08-29 21:46:36 +00002767
Sanjay Patela932da82014-07-07 21:19:00 +00002768 // Also do not perform this transformation if any phi node in the common
2769 // destination block can trap when reached by BB or PBB (PR17073). In that
2770 // case, it would be unsafe to hoist the operation into a select instruction.
2771
2772 BasicBlock *CommonDest = PBI->getSuccessor(PBIOp);
Chris Lattner834ab4e2008-07-13 22:04:41 +00002773 unsigned NumPhis = 0;
2774 for (BasicBlock::iterator II = CommonDest->begin();
Sanjay Patela932da82014-07-07 21:19:00 +00002775 isa<PHINode>(II); ++II, ++NumPhis) {
Chris Lattner834ab4e2008-07-13 22:04:41 +00002776 if (NumPhis > 2) // Disable this xform.
2777 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002778
Sanjay Patela932da82014-07-07 21:19:00 +00002779 PHINode *PN = cast<PHINode>(II);
2780 Value *BIV = PN->getIncomingValueForBlock(BB);
2781 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(BIV))
2782 if (CE->canTrap())
2783 return false;
2784
2785 unsigned PBBIdx = PN->getBasicBlockIndex(PBI->getParent());
2786 Value *PBIV = PN->getIncomingValue(PBBIdx);
2787 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(PBIV))
2788 if (CE->canTrap())
2789 return false;
2790 }
2791
Chris Lattner834ab4e2008-07-13 22:04:41 +00002792 // Finally, if everything is ok, fold the branches to logical ops.
Sanjay Patela932da82014-07-07 21:19:00 +00002793 BasicBlock *OtherDest = BI->getSuccessor(BIOp ^ 1);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002794
David Greene725c7c32010-01-05 01:26:52 +00002795 DEBUG(dbgs() << "FOLDING BRs:" << *PBI->getParent()
Chris Lattnerb25de3f2009-08-23 04:37:46 +00002796 << "AND: " << *BI->getParent());
Andrew Trickf3cf1932012-08-29 21:46:36 +00002797
2798
Chris Lattner80b03a12008-07-13 22:23:11 +00002799 // If OtherDest *is* BB, then BB is a basic block with a single conditional
2800 // branch in it, where one edge (OtherDest) goes back to itself but the other
2801 // exits. We don't *know* that the program avoids the infinite loop
2802 // (even though that seems likely). If we do this xform naively, we'll end up
2803 // recursively unpeeling the loop. Since we know that (after the xform is
2804 // done) that the block *is* infinite if reached, we just make it an obviously
2805 // infinite loop with no cond branch.
2806 if (OtherDest == BB) {
2807 // Insert it at the end of the function, because it's either code,
2808 // or it won't matter if it's hot. :)
Owen Anderson55f1c092009-08-13 21:58:54 +00002809 BasicBlock *InfLoopBlock = BasicBlock::Create(BB->getContext(),
2810 "infloop", BB->getParent());
Chris Lattner80b03a12008-07-13 22:23:11 +00002811 BranchInst::Create(InfLoopBlock, InfLoopBlock);
2812 OtherDest = InfLoopBlock;
Andrew Trickf3cf1932012-08-29 21:46:36 +00002813 }
2814
David Greene725c7c32010-01-05 01:26:52 +00002815 DEBUG(dbgs() << *PBI->getParent()->getParent());
Devang Patel1407fb42011-05-19 20:52:46 +00002816
Chris Lattner834ab4e2008-07-13 22:04:41 +00002817 // BI may have other predecessors. Because of this, we leave
2818 // it alone, but modify PBI.
Andrew Trickf3cf1932012-08-29 21:46:36 +00002819
Chris Lattner834ab4e2008-07-13 22:04:41 +00002820 // Make sure we get to CommonDest on True&True directions.
2821 Value *PBICond = PBI->getCondition();
Mehdi Aminiba9fba82016-03-13 21:05:13 +00002822 IRBuilder<NoFolder> Builder(PBI);
Chris Lattner834ab4e2008-07-13 22:04:41 +00002823 if (PBIOp)
Devang Patel1407fb42011-05-19 20:52:46 +00002824 PBICond = Builder.CreateNot(PBICond, PBICond->getName()+".not");
2825
Chris Lattner834ab4e2008-07-13 22:04:41 +00002826 Value *BICond = BI->getCondition();
2827 if (BIOp)
Devang Patel1407fb42011-05-19 20:52:46 +00002828 BICond = Builder.CreateNot(BICond, BICond->getName()+".not");
2829
Chris Lattner834ab4e2008-07-13 22:04:41 +00002830 // Merge the conditions.
Devang Patel1407fb42011-05-19 20:52:46 +00002831 Value *Cond = Builder.CreateOr(PBICond, BICond, "brmerge");
Andrew Trickf3cf1932012-08-29 21:46:36 +00002832
Chris Lattner834ab4e2008-07-13 22:04:41 +00002833 // Modify PBI to branch on the new condition to the new dests.
2834 PBI->setCondition(Cond);
2835 PBI->setSuccessor(0, CommonDest);
2836 PBI->setSuccessor(1, OtherDest);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002837
Manman Ren2d4c10f2012-09-17 21:30:40 +00002838 // Update branch weight for PBI.
2839 uint64_t PredTrueWeight, PredFalseWeight, SuccTrueWeight, SuccFalseWeight;
Sanjay Pateldc88bd62016-04-23 20:01:22 +00002840 bool PredHasWeights =
2841 PBI->extractProfMetadata(PredTrueWeight, PredFalseWeight);
2842 bool SuccHasWeights =
2843 BI->extractProfMetadata(SuccTrueWeight, SuccFalseWeight);
Manman Ren2d4c10f2012-09-17 21:30:40 +00002844 if (PredHasWeights && SuccHasWeights) {
2845 uint64_t PredCommon = PBIOp ? PredFalseWeight : PredTrueWeight;
2846 uint64_t PredOther = PBIOp ?PredTrueWeight : PredFalseWeight;
2847 uint64_t SuccCommon = BIOp ? SuccFalseWeight : SuccTrueWeight;
2848 uint64_t SuccOther = BIOp ? SuccTrueWeight : SuccFalseWeight;
2849 // The weight to CommonDest should be PredCommon * SuccTotal +
2850 // PredOther * SuccCommon.
2851 // The weight to OtherDest should be PredOther * SuccOther.
Benjamin Kramerea68a942015-02-19 15:26:17 +00002852 uint64_t NewWeights[2] = {PredCommon * (SuccCommon + SuccOther) +
2853 PredOther * SuccCommon,
2854 PredOther * SuccOther};
Manman Ren2d4c10f2012-09-17 21:30:40 +00002855 // Halve the weights if any of them cannot fit in an uint32_t
2856 FitWeights(NewWeights);
2857
Manman Ren2d4c10f2012-09-17 21:30:40 +00002858 PBI->setMetadata(LLVMContext::MD_prof,
Benjamin Kramerea68a942015-02-19 15:26:17 +00002859 MDBuilder(BI->getContext())
2860 .createBranchWeights(NewWeights[0], NewWeights[1]));
Manman Ren2d4c10f2012-09-17 21:30:40 +00002861 }
2862
Chris Lattner834ab4e2008-07-13 22:04:41 +00002863 // OtherDest may have phi nodes. If so, add an entry from PBI's
2864 // block that are identical to the entries for BI's block.
Chris Lattner0f4d67b2010-12-14 07:09:42 +00002865 AddPredecessorToBlock(OtherDest, PBI->getParent(), BB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00002866
Chris Lattner834ab4e2008-07-13 22:04:41 +00002867 // We know that the CommonDest already had an edge from PBI to
2868 // it. If it has PHIs though, the PHIs may have different
2869 // entries for BB and PBI's BB. If so, insert a select to make
2870 // them agree.
Chris Lattner0f4d67b2010-12-14 07:09:42 +00002871 PHINode *PN;
Chris Lattner834ab4e2008-07-13 22:04:41 +00002872 for (BasicBlock::iterator II = CommonDest->begin();
2873 (PN = dyn_cast<PHINode>(II)); ++II) {
2874 Value *BIV = PN->getIncomingValueForBlock(BB);
2875 unsigned PBBIdx = PN->getBasicBlockIndex(PBI->getParent());
2876 Value *PBIV = PN->getIncomingValue(PBBIdx);
2877 if (BIV != PBIV) {
2878 // Insert a select in PBI to pick the right value.
Devang Patel1407fb42011-05-19 20:52:46 +00002879 Value *NV = cast<SelectInst>
Sanjay Patel2e002772016-03-12 18:05:53 +00002880 (Builder.CreateSelect(PBICond, PBIV, BIV, PBIV->getName() + ".mux"));
Chris Lattner834ab4e2008-07-13 22:04:41 +00002881 PN->setIncomingValue(PBBIdx, NV);
Chris Lattner9aada1d2008-07-13 21:53:26 +00002882 }
2883 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00002884
David Greene725c7c32010-01-05 01:26:52 +00002885 DEBUG(dbgs() << "INTO: " << *PBI->getParent());
2886 DEBUG(dbgs() << *PBI->getParent()->getParent());
Andrew Trickf3cf1932012-08-29 21:46:36 +00002887
Chris Lattner834ab4e2008-07-13 22:04:41 +00002888 // This basic block is probably dead. We know it has at least
2889 // one fewer predecessor.
2890 return true;
Chris Lattner9aada1d2008-07-13 21:53:26 +00002891}
2892
Sanjay Patel09159b8f2015-06-24 20:40:57 +00002893// Simplifies a terminator by replacing it with a branch to TrueBB if Cond is
2894// true or to FalseBB if Cond is false.
Frits van Bommel8e158492011-01-11 12:52:11 +00002895// Takes care of updating the successors and removing the old terminator.
2896// Also makes sure not to introduce new successors by assuming that edges to
2897// non-successor TrueBBs and FalseBBs aren't reachable.
2898static bool SimplifyTerminatorOnSelect(TerminatorInst *OldTerm, Value *Cond,
Manman Ren774246a2012-09-17 22:28:55 +00002899 BasicBlock *TrueBB, BasicBlock *FalseBB,
2900 uint32_t TrueWeight,
2901 uint32_t FalseWeight){
Frits van Bommel8e158492011-01-11 12:52:11 +00002902 // Remove any superfluous successor edges from the CFG.
2903 // First, figure out which successors to preserve.
2904 // If TrueBB and FalseBB are equal, only try to preserve one copy of that
2905 // successor.
2906 BasicBlock *KeepEdge1 = TrueBB;
Craig Topperf40110f2014-04-25 05:29:35 +00002907 BasicBlock *KeepEdge2 = TrueBB != FalseBB ? FalseBB : nullptr;
Frits van Bommel8e158492011-01-11 12:52:11 +00002908
2909 // Then remove the rest.
Pete Cooperebcd7482015-08-06 20:22:46 +00002910 for (BasicBlock *Succ : OldTerm->successors()) {
Frits van Bommel8e158492011-01-11 12:52:11 +00002911 // Make sure only to keep exactly one copy of each edge.
2912 if (Succ == KeepEdge1)
Craig Topperf40110f2014-04-25 05:29:35 +00002913 KeepEdge1 = nullptr;
Frits van Bommel8e158492011-01-11 12:52:11 +00002914 else if (Succ == KeepEdge2)
Craig Topperf40110f2014-04-25 05:29:35 +00002915 KeepEdge2 = nullptr;
Frits van Bommel8e158492011-01-11 12:52:11 +00002916 else
David Majnemerdc3b67b2015-10-21 18:22:24 +00002917 Succ->removePredecessor(OldTerm->getParent(),
2918 /*DontDeleteUselessPHIs=*/true);
Frits van Bommel8e158492011-01-11 12:52:11 +00002919 }
2920
Devang Patel2c2ea222011-05-18 18:43:31 +00002921 IRBuilder<> Builder(OldTerm);
2922 Builder.SetCurrentDebugLocation(OldTerm->getDebugLoc());
2923
Frits van Bommel8e158492011-01-11 12:52:11 +00002924 // Insert an appropriate new terminator.
Craig Topperf40110f2014-04-25 05:29:35 +00002925 if (!KeepEdge1 && !KeepEdge2) {
Frits van Bommel8e158492011-01-11 12:52:11 +00002926 if (TrueBB == FalseBB)
2927 // We were only looking for one successor, and it was present.
2928 // Create an unconditional branch to it.
Devang Patel2c2ea222011-05-18 18:43:31 +00002929 Builder.CreateBr(TrueBB);
Manman Ren774246a2012-09-17 22:28:55 +00002930 else {
Frits van Bommel8e158492011-01-11 12:52:11 +00002931 // We found both of the successors we were looking for.
2932 // Create a conditional branch sharing the condition of the select.
Manman Ren774246a2012-09-17 22:28:55 +00002933 BranchInst *NewBI = Builder.CreateCondBr(Cond, TrueBB, FalseBB);
2934 if (TrueWeight != FalseWeight)
2935 NewBI->setMetadata(LLVMContext::MD_prof,
2936 MDBuilder(OldTerm->getContext()).
2937 createBranchWeights(TrueWeight, FalseWeight));
2938 }
Frits van Bommel8e158492011-01-11 12:52:11 +00002939 } else if (KeepEdge1 && (KeepEdge2 || TrueBB == FalseBB)) {
2940 // Neither of the selected blocks were successors, so this
2941 // terminator must be unreachable.
2942 new UnreachableInst(OldTerm->getContext(), OldTerm);
2943 } else {
2944 // One of the selected values was a successor, but the other wasn't.
2945 // Insert an unconditional branch to the one that was found;
2946 // the edge to the one that wasn't must be unreachable.
Craig Topperf40110f2014-04-25 05:29:35 +00002947 if (!KeepEdge1)
Frits van Bommel8e158492011-01-11 12:52:11 +00002948 // Only TrueBB was found.
Devang Patel2c2ea222011-05-18 18:43:31 +00002949 Builder.CreateBr(TrueBB);
Frits van Bommel8e158492011-01-11 12:52:11 +00002950 else
2951 // Only FalseBB was found.
Devang Patel2c2ea222011-05-18 18:43:31 +00002952 Builder.CreateBr(FalseBB);
Frits van Bommel8e158492011-01-11 12:52:11 +00002953 }
2954
2955 EraseTerminatorInstAndDCECond(OldTerm);
2956 return true;
2957}
2958
Sanjay Patel09159b8f2015-06-24 20:40:57 +00002959// Replaces
Frits van Bommel8ae07992011-02-28 09:44:07 +00002960// (switch (select cond, X, Y)) on constant X, Y
2961// with a branch - conditional if X and Y lead to distinct BBs,
2962// unconditional otherwise.
2963static bool SimplifySwitchOnSelect(SwitchInst *SI, SelectInst *Select) {
2964 // Check for constant integer values in the select.
2965 ConstantInt *TrueVal = dyn_cast<ConstantInt>(Select->getTrueValue());
2966 ConstantInt *FalseVal = dyn_cast<ConstantInt>(Select->getFalseValue());
2967 if (!TrueVal || !FalseVal)
2968 return false;
2969
2970 // Find the relevant condition and destinations.
2971 Value *Condition = Select->getCondition();
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00002972 BasicBlock *TrueBB = SI->findCaseValue(TrueVal).getCaseSuccessor();
2973 BasicBlock *FalseBB = SI->findCaseValue(FalseVal).getCaseSuccessor();
Frits van Bommel8ae07992011-02-28 09:44:07 +00002974
Manman Ren774246a2012-09-17 22:28:55 +00002975 // Get weight for TrueBB and FalseBB.
2976 uint32_t TrueWeight = 0, FalseWeight = 0;
2977 SmallVector<uint64_t, 8> Weights;
2978 bool HasWeights = HasBranchWeights(SI);
2979 if (HasWeights) {
2980 GetBranchWeights(SI, Weights);
2981 if (Weights.size() == 1 + SI->getNumCases()) {
2982 TrueWeight = (uint32_t)Weights[SI->findCaseValue(TrueVal).
2983 getSuccessorIndex()];
2984 FalseWeight = (uint32_t)Weights[SI->findCaseValue(FalseVal).
2985 getSuccessorIndex()];
2986 }
2987 }
2988
Frits van Bommel8ae07992011-02-28 09:44:07 +00002989 // Perform the actual simplification.
Manman Ren774246a2012-09-17 22:28:55 +00002990 return SimplifyTerminatorOnSelect(SI, Condition, TrueBB, FalseBB,
2991 TrueWeight, FalseWeight);
Frits van Bommel8ae07992011-02-28 09:44:07 +00002992}
2993
Sanjay Patel09159b8f2015-06-24 20:40:57 +00002994// Replaces
Frits van Bommel8fb69ee2010-12-05 18:29:03 +00002995// (indirectbr (select cond, blockaddress(@fn, BlockA),
2996// blockaddress(@fn, BlockB)))
2997// with
2998// (br cond, BlockA, BlockB).
2999static bool SimplifyIndirectBrOnSelect(IndirectBrInst *IBI, SelectInst *SI) {
3000 // Check that both operands of the select are block addresses.
3001 BlockAddress *TBA = dyn_cast<BlockAddress>(SI->getTrueValue());
3002 BlockAddress *FBA = dyn_cast<BlockAddress>(SI->getFalseValue());
3003 if (!TBA || !FBA)
3004 return false;
3005
3006 // Extract the actual blocks.
3007 BasicBlock *TrueBB = TBA->getBasicBlock();
3008 BasicBlock *FalseBB = FBA->getBasicBlock();
3009
Frits van Bommel8e158492011-01-11 12:52:11 +00003010 // Perform the actual simplification.
Manman Ren774246a2012-09-17 22:28:55 +00003011 return SimplifyTerminatorOnSelect(IBI, SI->getCondition(), TrueBB, FalseBB,
3012 0, 0);
Frits van Bommel8fb69ee2010-12-05 18:29:03 +00003013}
3014
Sanjay Patel09159b8f2015-06-24 20:40:57 +00003015/// This is called when we find an icmp instruction
3016/// (a seteq/setne with a constant) as the only instruction in a
Chris Lattnerd9bacc02010-12-13 03:18:54 +00003017/// block that ends with an uncond branch. We are looking for a very specific
3018/// pattern that occurs when "A == 1 || A == 2 || A == 3" gets simplified. In
3019/// this case, we merge the first two "or's of icmp" into a switch, but then the
3020/// default value goes to an uncond block with a seteq in it, we get something
3021/// like:
3022///
3023/// switch i8 %A, label %DEFAULT [ i8 1, label %end i8 2, label %end ]
3024/// DEFAULT:
3025/// %tmp = icmp eq i8 %A, 92
3026/// br label %end
3027/// end:
3028/// ... = phi i1 [ true, %entry ], [ %tmp, %DEFAULT ], [ true, %entry ]
Andrew Trickf3cf1932012-08-29 21:46:36 +00003029///
Chris Lattnerd9bacc02010-12-13 03:18:54 +00003030/// We prefer to split the edge to 'end' so that there is a true/false entry to
3031/// the PHI, merging the third icmp into the switch.
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00003032static bool TryToSimplifyUncondBranchWithICmpInIt(
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003033 ICmpInst *ICI, IRBuilder<> &Builder, const DataLayout &DL,
3034 const TargetTransformInfo &TTI, unsigned BonusInstThreshold,
3035 AssumptionCache *AC) {
Chris Lattnerd9bacc02010-12-13 03:18:54 +00003036 BasicBlock *BB = ICI->getParent();
Devang Patel767f6932011-05-18 18:28:48 +00003037
Chris Lattnerd9bacc02010-12-13 03:18:54 +00003038 // If the block has any PHIs in it or the icmp has multiple uses, it is too
3039 // complex.
3040 if (isa<PHINode>(BB->begin()) || !ICI->hasOneUse()) return false;
3041
3042 Value *V = ICI->getOperand(0);
3043 ConstantInt *Cst = cast<ConstantInt>(ICI->getOperand(1));
Andrew Trickf3cf1932012-08-29 21:46:36 +00003044
Chris Lattnerd9bacc02010-12-13 03:18:54 +00003045 // The pattern we're looking for is where our only predecessor is a switch on
3046 // 'V' and this block is the default case for the switch. In this case we can
3047 // fold the compared value into the switch to simplify things.
3048 BasicBlock *Pred = BB->getSinglePredecessor();
Craig Topperf40110f2014-04-25 05:29:35 +00003049 if (!Pred || !isa<SwitchInst>(Pred->getTerminator())) return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00003050
Chris Lattnerd9bacc02010-12-13 03:18:54 +00003051 SwitchInst *SI = cast<SwitchInst>(Pred->getTerminator());
3052 if (SI->getCondition() != V)
3053 return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00003054
Chris Lattnerd9bacc02010-12-13 03:18:54 +00003055 // If BB is reachable on a non-default case, then we simply know the value of
3056 // V in this block. Substitute it and constant fold the icmp instruction
3057 // away.
3058 if (SI->getDefaultDest() != BB) {
3059 ConstantInt *VVal = SI->findCaseDest(BB);
3060 assert(VVal && "Should have a unique destination value");
3061 ICI->setOperand(0, VVal);
Andrew Trickf3cf1932012-08-29 21:46:36 +00003062
Rafael Espindola37dc9e12014-02-21 00:06:31 +00003063 if (Value *V = SimplifyInstruction(ICI, DL)) {
Chris Lattnerd7beca32010-12-14 06:17:25 +00003064 ICI->replaceAllUsesWith(V);
Chris Lattnerd9bacc02010-12-13 03:18:54 +00003065 ICI->eraseFromParent();
3066 }
3067 // BB is now empty, so it is likely to simplify away.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003068 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Chris Lattnerd9bacc02010-12-13 03:18:54 +00003069 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003070
Chris Lattner62cc76e2010-12-13 03:43:57 +00003071 // Ok, the block is reachable from the default dest. If the constant we're
3072 // comparing exists in one of the other edges, then we can constant fold ICI
3073 // and zap it.
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00003074 if (SI->findCaseValue(Cst) != SI->case_default()) {
Chris Lattner62cc76e2010-12-13 03:43:57 +00003075 Value *V;
3076 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
3077 V = ConstantInt::getFalse(BB->getContext());
3078 else
3079 V = ConstantInt::getTrue(BB->getContext());
Andrew Trickf3cf1932012-08-29 21:46:36 +00003080
Chris Lattner62cc76e2010-12-13 03:43:57 +00003081 ICI->replaceAllUsesWith(V);
3082 ICI->eraseFromParent();
3083 // BB is now empty, so it is likely to simplify away.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003084 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Chris Lattner62cc76e2010-12-13 03:43:57 +00003085 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003086
Chris Lattnerd9bacc02010-12-13 03:18:54 +00003087 // The use of the icmp has to be in the 'end' block, by the only PHI node in
3088 // the block.
3089 BasicBlock *SuccBlock = BB->getTerminator()->getSuccessor(0);
Chandler Carruthcdf47882014-03-09 03:16:01 +00003090 PHINode *PHIUse = dyn_cast<PHINode>(ICI->user_back());
Craig Topperf40110f2014-04-25 05:29:35 +00003091 if (PHIUse == nullptr || PHIUse != &SuccBlock->front() ||
Chris Lattnerd9bacc02010-12-13 03:18:54 +00003092 isa<PHINode>(++BasicBlock::iterator(PHIUse)))
3093 return false;
3094
3095 // If the icmp is a SETEQ, then the default dest gets false, the new edge gets
3096 // true in the PHI.
3097 Constant *DefaultCst = ConstantInt::getTrue(BB->getContext());
3098 Constant *NewCst = ConstantInt::getFalse(BB->getContext());
3099
3100 if (ICI->getPredicate() == ICmpInst::ICMP_EQ)
3101 std::swap(DefaultCst, NewCst);
3102
3103 // Replace ICI (which is used by the PHI for the default value) with true or
3104 // false depending on if it is EQ or NE.
3105 ICI->replaceAllUsesWith(DefaultCst);
3106 ICI->eraseFromParent();
3107
3108 // Okay, the switch goes to this block on a default value. Add an edge from
3109 // the switch to the merge point on the compared value.
3110 BasicBlock *NewBB = BasicBlock::Create(BB->getContext(), "switch.edge",
3111 BB->getParent(), BB);
Manman Rence48ea72012-09-17 23:07:43 +00003112 SmallVector<uint64_t, 8> Weights;
3113 bool HasWeights = HasBranchWeights(SI);
3114 if (HasWeights) {
3115 GetBranchWeights(SI, Weights);
3116 if (Weights.size() == 1 + SI->getNumCases()) {
3117 // Split weight for default case to case for "Cst".
3118 Weights[0] = (Weights[0]+1) >> 1;
3119 Weights.push_back(Weights[0]);
3120
3121 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
3122 SI->setMetadata(LLVMContext::MD_prof,
3123 MDBuilder(SI->getContext()).
3124 createBranchWeights(MDWeights));
3125 }
3126 }
Chris Lattnerd9bacc02010-12-13 03:18:54 +00003127 SI->addCase(Cst, NewBB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00003128
Chris Lattnerd9bacc02010-12-13 03:18:54 +00003129 // NewBB branches to the phi block, add the uncond branch and the phi entry.
Devang Patel767f6932011-05-18 18:28:48 +00003130 Builder.SetInsertPoint(NewBB);
3131 Builder.SetCurrentDebugLocation(SI->getDebugLoc());
3132 Builder.CreateBr(SuccBlock);
Chris Lattnerd9bacc02010-12-13 03:18:54 +00003133 PHIUse->addIncoming(NewCst, NewBB);
3134 return true;
3135}
3136
Sanjay Patel09159b8f2015-06-24 20:40:57 +00003137/// The specified branch is a conditional branch.
Chris Lattnera69c4432010-12-13 05:03:41 +00003138/// Check to see if it is branching on an or/and chain of icmp instructions, and
3139/// fold it into a switch instruction if so.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003140static bool SimplifyBranchOnICmpChain(BranchInst *BI, IRBuilder<> &Builder,
3141 const DataLayout &DL) {
Chris Lattnera69c4432010-12-13 05:03:41 +00003142 Instruction *Cond = dyn_cast<Instruction>(BI->getCondition());
Craig Topperf40110f2014-04-25 05:29:35 +00003143 if (!Cond) return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00003144
Chris Lattnera69c4432010-12-13 05:03:41 +00003145 // Change br (X == 0 | X == 1), T, F into a switch instruction.
3146 // If this is a bunch of seteq's or'd together, or if it's a bunch of
3147 // 'setne's and'ed together, collect them.
Andrew Trickf3cf1932012-08-29 21:46:36 +00003148
Mehdi Amini9a25cb82014-11-19 20:09:11 +00003149 // Try to gather values from a chain of and/or to be turned into a switch
Mehdi Aminiffd01002014-11-20 22:40:25 +00003150 ConstantComparesGatherer ConstantCompare(Cond, DL);
3151 // Unpack the result
3152 SmallVectorImpl<ConstantInt*> &Values = ConstantCompare.Vals;
3153 Value *CompVal = ConstantCompare.CompValue;
3154 unsigned UsedICmps = ConstantCompare.UsedICmps;
3155 Value *ExtraCase = ConstantCompare.Extra;
Andrew Trickf3cf1932012-08-29 21:46:36 +00003156
Chris Lattnera69c4432010-12-13 05:03:41 +00003157 // If we didn't have a multiply compared value, fail.
Craig Topperf40110f2014-04-25 05:29:35 +00003158 if (!CompVal) return false;
Chris Lattnera69c4432010-12-13 05:03:41 +00003159
Benjamin Kramer8d6a8c12011-02-07 22:37:28 +00003160 // Avoid turning single icmps into a switch.
3161 if (UsedICmps <= 1)
3162 return false;
3163
Mehdi Aminiffd01002014-11-20 22:40:25 +00003164 bool TrueWhenEqual = (Cond->getOpcode() == Instruction::Or);
3165
Chris Lattnera69c4432010-12-13 05:03:41 +00003166 // There might be duplicate constants in the list, which the switch
3167 // instruction can't handle, remove them now.
3168 array_pod_sort(Values.begin(), Values.end(), ConstantIntSortPredicate);
3169 Values.erase(std::unique(Values.begin(), Values.end()), Values.end());
Andrew Trickf3cf1932012-08-29 21:46:36 +00003170
Chris Lattnera69c4432010-12-13 05:03:41 +00003171 // If Extra was used, we require at least two switch values to do the
Sanjay Patel59661452015-09-10 15:14:34 +00003172 // transformation. A switch with one value is just a conditional branch.
Chris Lattnera69c4432010-12-13 05:03:41 +00003173 if (ExtraCase && Values.size() < 2) return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00003174
Andrew Trick3051aa12012-08-29 21:46:38 +00003175 // TODO: Preserve branch weight metadata, similarly to how
3176 // FoldValueComparisonIntoPredecessors preserves it.
3177
Chris Lattnera69c4432010-12-13 05:03:41 +00003178 // Figure out which block is which destination.
3179 BasicBlock *DefaultBB = BI->getSuccessor(1);
3180 BasicBlock *EdgeBB = BI->getSuccessor(0);
3181 if (!TrueWhenEqual) std::swap(DefaultBB, EdgeBB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00003182
Chris Lattnera69c4432010-12-13 05:03:41 +00003183 BasicBlock *BB = BI->getParent();
Andrew Trickf3cf1932012-08-29 21:46:36 +00003184
Chris Lattnerd7beca32010-12-14 06:17:25 +00003185 DEBUG(dbgs() << "Converting 'icmp' chain with " << Values.size()
Chris Lattner5a9d59d2010-12-14 05:57:30 +00003186 << " cases into SWITCH. BB is:\n" << *BB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00003187
Chris Lattnera69c4432010-12-13 05:03:41 +00003188 // If there are any extra values that couldn't be folded into the switch
3189 // then we evaluate them with an explicit branch first. Split the block
3190 // right before the condbr to handle it.
3191 if (ExtraCase) {
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00003192 BasicBlock *NewBB =
3193 BB->splitBasicBlock(BI->getIterator(), "switch.early.test");
Chris Lattnera69c4432010-12-13 05:03:41 +00003194 // Remove the uncond branch added to the old block.
3195 TerminatorInst *OldTI = BB->getTerminator();
Devang Patel7de6c4b2011-05-18 23:18:47 +00003196 Builder.SetInsertPoint(OldTI);
3197
Chris Lattner5a9d59d2010-12-14 05:57:30 +00003198 if (TrueWhenEqual)
Devang Patel7de6c4b2011-05-18 23:18:47 +00003199 Builder.CreateCondBr(ExtraCase, EdgeBB, NewBB);
Chris Lattner5a9d59d2010-12-14 05:57:30 +00003200 else
Devang Patel7de6c4b2011-05-18 23:18:47 +00003201 Builder.CreateCondBr(ExtraCase, NewBB, EdgeBB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00003202
Chris Lattnera69c4432010-12-13 05:03:41 +00003203 OldTI->eraseFromParent();
Andrew Trickf3cf1932012-08-29 21:46:36 +00003204
Chris Lattnercb570f82010-12-13 05:34:18 +00003205 // If there are PHI nodes in EdgeBB, then we need to add a new entry to them
3206 // for the edge we just added.
Chris Lattner0f4d67b2010-12-14 07:09:42 +00003207 AddPredecessorToBlock(EdgeBB, BB, NewBB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00003208
Chris Lattnerd7beca32010-12-14 06:17:25 +00003209 DEBUG(dbgs() << " ** 'icmp' chain unhandled condition: " << *ExtraCase
3210 << "\nEXTRABB = " << *BB);
Chris Lattnera69c4432010-12-13 05:03:41 +00003211 BB = NewBB;
3212 }
Devang Patel7de6c4b2011-05-18 23:18:47 +00003213
3214 Builder.SetInsertPoint(BI);
Chris Lattnera69c4432010-12-13 05:03:41 +00003215 // Convert pointer to int before we switch.
3216 if (CompVal->getType()->isPointerTy()) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003217 CompVal = Builder.CreatePtrToInt(
3218 CompVal, DL.getIntPtrType(CompVal->getType()), "magicptr");
Chris Lattnera69c4432010-12-13 05:03:41 +00003219 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003220
Chris Lattnera69c4432010-12-13 05:03:41 +00003221 // Create the new switch instruction now.
Devang Patel7de6c4b2011-05-18 23:18:47 +00003222 SwitchInst *New = Builder.CreateSwitch(CompVal, DefaultBB, Values.size());
Devang Patelb849cd52011-05-17 23:29:05 +00003223
Chris Lattnera69c4432010-12-13 05:03:41 +00003224 // Add all of the 'cases' to the switch instruction.
3225 for (unsigned i = 0, e = Values.size(); i != e; ++i)
3226 New->addCase(Values[i], EdgeBB);
Andrew Trickf3cf1932012-08-29 21:46:36 +00003227
Chris Lattnera69c4432010-12-13 05:03:41 +00003228 // We added edges from PI to the EdgeBB. As such, if there were any
3229 // PHI nodes in EdgeBB, they need entries to be added corresponding to
3230 // the number of edges added.
3231 for (BasicBlock::iterator BBI = EdgeBB->begin();
3232 isa<PHINode>(BBI); ++BBI) {
3233 PHINode *PN = cast<PHINode>(BBI);
3234 Value *InVal = PN->getIncomingValueForBlock(BB);
3235 for (unsigned i = 0, e = Values.size()-1; i != e; ++i)
3236 PN->addIncoming(InVal, BB);
3237 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003238
Chris Lattnera69c4432010-12-13 05:03:41 +00003239 // Erase the old branch instruction.
3240 EraseTerminatorInstAndDCECond(BI);
Andrew Trickf3cf1932012-08-29 21:46:36 +00003241
Chris Lattnerd7beca32010-12-14 06:17:25 +00003242 DEBUG(dbgs() << " ** 'icmp' chain result is:\n" << *BB << '\n');
Chris Lattnera69c4432010-12-13 05:03:41 +00003243 return true;
3244}
3245
Duncan Sands29192d02011-09-05 12:57:57 +00003246bool SimplifyCFGOpt::SimplifyResume(ResumeInst *RI, IRBuilder<> &Builder) {
Chen Li1689c2f2016-01-10 05:48:01 +00003247 if (isa<PHINode>(RI->getValue()))
3248 return SimplifyCommonResume(RI);
3249 else if (isa<LandingPadInst>(RI->getParent()->getFirstNonPHI()) &&
3250 RI->getValue() == RI->getParent()->getFirstNonPHI())
3251 // The resume must unwind the exception that caused control to branch here.
3252 return SimplifySingleResume(RI);
Chen Li509ff212016-01-11 19:20:53 +00003253
3254 return false;
Chen Li1689c2f2016-01-10 05:48:01 +00003255}
3256
3257// Simplify resume that is shared by several landing pads (phi of landing pad).
3258bool SimplifyCFGOpt::SimplifyCommonResume(ResumeInst *RI) {
3259 BasicBlock *BB = RI->getParent();
3260
3261 // Check that there are no other instructions except for debug intrinsics
3262 // between the phi of landing pads (RI->getValue()) and resume instruction.
3263 BasicBlock::iterator I = cast<Instruction>(RI->getValue())->getIterator(),
3264 E = RI->getIterator();
3265 while (++I != E)
3266 if (!isa<DbgInfoIntrinsic>(I))
3267 return false;
3268
3269 SmallSet<BasicBlock *, 4> TrivialUnwindBlocks;
3270 auto *PhiLPInst = cast<PHINode>(RI->getValue());
3271
3272 // Check incoming blocks to see if any of them are trivial.
3273 for (unsigned Idx = 0, End = PhiLPInst->getNumIncomingValues();
3274 Idx != End; Idx++) {
3275 auto *IncomingBB = PhiLPInst->getIncomingBlock(Idx);
3276 auto *IncomingValue = PhiLPInst->getIncomingValue(Idx);
3277
3278 // If the block has other successors, we can not delete it because
3279 // it has other dependents.
3280 if (IncomingBB->getUniqueSuccessor() != BB)
3281 continue;
3282
3283 auto *LandingPad =
3284 dyn_cast<LandingPadInst>(IncomingBB->getFirstNonPHI());
3285 // Not the landing pad that caused the control to branch here.
3286 if (IncomingValue != LandingPad)
3287 continue;
3288
3289 bool isTrivial = true;
3290
3291 I = IncomingBB->getFirstNonPHI()->getIterator();
3292 E = IncomingBB->getTerminator()->getIterator();
3293 while (++I != E)
3294 if (!isa<DbgInfoIntrinsic>(I)) {
3295 isTrivial = false;
3296 break;
3297 }
3298
3299 if (isTrivial)
3300 TrivialUnwindBlocks.insert(IncomingBB);
3301 }
3302
3303 // If no trivial unwind blocks, don't do any simplifications.
3304 if (TrivialUnwindBlocks.empty()) return false;
3305
3306 // Turn all invokes that unwind here into calls.
3307 for (auto *TrivialBB : TrivialUnwindBlocks) {
3308 // Blocks that will be simplified should be removed from the phi node.
3309 // Note there could be multiple edges to the resume block, and we need
3310 // to remove them all.
3311 while (PhiLPInst->getBasicBlockIndex(TrivialBB) != -1)
3312 BB->removePredecessor(TrivialBB, true);
3313
3314 for (pred_iterator PI = pred_begin(TrivialBB), PE = pred_end(TrivialBB);
3315 PI != PE;) {
3316 BasicBlock *Pred = *PI++;
3317 removeUnwindEdge(Pred);
3318 }
3319
3320 // In each SimplifyCFG run, only the current processed block can be erased.
3321 // Otherwise, it will break the iteration of SimplifyCFG pass. So instead
3322 // of erasing TrivialBB, we only remove the branch to the common resume
3323 // block so that we can later erase the resume block since it has no
3324 // predecessors.
3325 TrivialBB->getTerminator()->eraseFromParent();
3326 new UnreachableInst(RI->getContext(), TrivialBB);
3327 }
3328
3329 // Delete the resume block if all its predecessors have been removed.
3330 if (pred_empty(BB))
3331 BB->eraseFromParent();
3332
3333 return !TrivialUnwindBlocks.empty();
3334}
3335
3336// Simplify resume that is only used by a single (non-phi) landing pad.
3337bool SimplifyCFGOpt::SimplifySingleResume(ResumeInst *RI) {
Duncan Sands29192d02011-09-05 12:57:57 +00003338 BasicBlock *BB = RI->getParent();
3339 LandingPadInst *LPInst = dyn_cast<LandingPadInst>(BB->getFirstNonPHI());
Chen Li1689c2f2016-01-10 05:48:01 +00003340 assert (RI->getValue() == LPInst &&
3341 "Resume must unwind the exception that caused control to here");
Duncan Sands29192d02011-09-05 12:57:57 +00003342
Chen Li7009cd32015-10-23 21:13:01 +00003343 // Check that there are no other instructions except for debug intrinsics.
3344 BasicBlock::iterator I = LPInst->getIterator(), E = RI->getIterator();
Duncan Sands29192d02011-09-05 12:57:57 +00003345 while (++I != E)
3346 if (!isa<DbgInfoIntrinsic>(I))
3347 return false;
3348
Chen Lic6e28782015-10-22 20:48:38 +00003349 // Turn all invokes that unwind here into calls and delete the basic block.
Chen Li7009cd32015-10-23 21:13:01 +00003350 for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE;) {
3351 BasicBlock *Pred = *PI++;
3352 removeUnwindEdge(Pred);
Chen Lic6e28782015-10-22 20:48:38 +00003353 }
3354
Chen Li7009cd32015-10-23 21:13:01 +00003355 // The landingpad is now unreachable. Zap it.
3356 BB->eraseFromParent();
Hyojin Sung4673f102016-03-29 04:08:57 +00003357 if (LoopHeaders) LoopHeaders->erase(BB);
Chen Li7009cd32015-10-23 21:13:01 +00003358 return true;
Duncan Sands29192d02011-09-05 12:57:57 +00003359}
3360
David Majnemer1efa23d2016-02-20 01:07:45 +00003361static bool removeEmptyCleanup(CleanupReturnInst *RI) {
Andrew Kaylor50e4e862015-09-04 23:39:40 +00003362 // If this is a trivial cleanup pad that executes no instructions, it can be
3363 // eliminated. If the cleanup pad continues to the caller, any predecessor
3364 // that is an EH pad will be updated to continue to the caller and any
3365 // predecessor that terminates with an invoke instruction will have its invoke
3366 // instruction converted to a call instruction. If the cleanup pad being
3367 // simplified does not continue to the caller, each predecessor will be
3368 // updated to continue to the unwind destination of the cleanup pad being
3369 // simplified.
3370 BasicBlock *BB = RI->getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003371 CleanupPadInst *CPInst = RI->getCleanupPad();
3372 if (CPInst->getParent() != BB)
Andrew Kaylor50e4e862015-09-04 23:39:40 +00003373 // This isn't an empty cleanup.
3374 return false;
3375
3376 // Check that there are no other instructions except for debug intrinsics.
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00003377 BasicBlock::iterator I = CPInst->getIterator(), E = RI->getIterator();
Andrew Kaylor50e4e862015-09-04 23:39:40 +00003378 while (++I != E)
3379 if (!isa<DbgInfoIntrinsic>(I))
3380 return false;
3381
David Majnemer8a1c45d2015-12-12 05:38:55 +00003382 // If the cleanup return we are simplifying unwinds to the caller, this will
3383 // set UnwindDest to nullptr.
Andrew Kaylor50e4e862015-09-04 23:39:40 +00003384 BasicBlock *UnwindDest = RI->getUnwindDest();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003385 Instruction *DestEHPad = UnwindDest ? UnwindDest->getFirstNonPHI() : nullptr;
Andrew Kaylor50e4e862015-09-04 23:39:40 +00003386
3387 // We're about to remove BB from the control flow. Before we do, sink any
3388 // PHINodes into the unwind destination. Doing this before changing the
3389 // control flow avoids some potentially slow checks, since we can currently
3390 // be certain that UnwindDest and BB have no common predecessors (since they
3391 // are both EH pads).
3392 if (UnwindDest) {
3393 // First, go through the PHI nodes in UnwindDest and update any nodes that
3394 // reference the block we are removing
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00003395 for (BasicBlock::iterator I = UnwindDest->begin(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003396 IE = DestEHPad->getIterator();
Andrew Kaylor50e4e862015-09-04 23:39:40 +00003397 I != IE; ++I) {
3398 PHINode *DestPN = cast<PHINode>(I);
James Molloy4de84dd2015-11-04 15:28:04 +00003399
Andrew Kaylor2a9a6d82015-09-05 01:00:51 +00003400 int Idx = DestPN->getBasicBlockIndex(BB);
Andrew Kaylor50e4e862015-09-04 23:39:40 +00003401 // Since BB unwinds to UnwindDest, it has to be in the PHI node.
Craig Topper02a55d72015-09-05 04:49:44 +00003402 assert(Idx != -1);
Andrew Kaylor50e4e862015-09-04 23:39:40 +00003403 // This PHI node has an incoming value that corresponds to a control
3404 // path through the cleanup pad we are removing. If the incoming
3405 // value is in the cleanup pad, it must be a PHINode (because we
3406 // verified above that the block is otherwise empty). Otherwise, the
3407 // value is either a constant or a value that dominates the cleanup
3408 // pad being removed.
3409 //
3410 // Because BB and UnwindDest are both EH pads, all of their
3411 // predecessors must unwind to these blocks, and since no instruction
3412 // can have multiple unwind destinations, there will be no overlap in
3413 // incoming blocks between SrcPN and DestPN.
3414 Value *SrcVal = DestPN->getIncomingValue(Idx);
3415 PHINode *SrcPN = dyn_cast<PHINode>(SrcVal);
3416
3417 // Remove the entry for the block we are deleting.
3418 DestPN->removeIncomingValue(Idx, false);
3419
3420 if (SrcPN && SrcPN->getParent() == BB) {
3421 // If the incoming value was a PHI node in the cleanup pad we are
3422 // removing, we need to merge that PHI node's incoming values into
3423 // DestPN.
James Molloy4de84dd2015-11-04 15:28:04 +00003424 for (unsigned SrcIdx = 0, SrcE = SrcPN->getNumIncomingValues();
Andrew Kaylor50e4e862015-09-04 23:39:40 +00003425 SrcIdx != SrcE; ++SrcIdx) {
3426 DestPN->addIncoming(SrcPN->getIncomingValue(SrcIdx),
3427 SrcPN->getIncomingBlock(SrcIdx));
3428 }
3429 } else {
3430 // Otherwise, the incoming value came from above BB and
3431 // so we can just reuse it. We must associate all of BB's
3432 // predecessors with this value.
3433 for (auto *pred : predecessors(BB)) {
3434 DestPN->addIncoming(SrcVal, pred);
3435 }
3436 }
3437 }
3438
3439 // Sink any remaining PHI nodes directly into UnwindDest.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003440 Instruction *InsertPt = DestEHPad;
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00003441 for (BasicBlock::iterator I = BB->begin(),
3442 IE = BB->getFirstNonPHI()->getIterator();
Andrew Kaylor50e4e862015-09-04 23:39:40 +00003443 I != IE;) {
3444 // The iterator must be incremented here because the instructions are
3445 // being moved to another block.
3446 PHINode *PN = cast<PHINode>(I++);
3447 if (PN->use_empty())
3448 // If the PHI node has no uses, just leave it. It will be erased
3449 // when we erase BB below.
3450 continue;
3451
3452 // Otherwise, sink this PHI node into UnwindDest.
3453 // Any predecessors to UnwindDest which are not already represented
3454 // must be back edges which inherit the value from the path through
3455 // BB. In this case, the PHI value must reference itself.
3456 for (auto *pred : predecessors(UnwindDest))
3457 if (pred != BB)
3458 PN->addIncoming(PN, pred);
3459 PN->moveBefore(InsertPt);
3460 }
3461 }
3462
3463 for (pred_iterator PI = pred_begin(BB), PE = pred_end(BB); PI != PE;) {
3464 // The iterator must be updated here because we are removing this pred.
3465 BasicBlock *PredBB = *PI++;
Andrew Kaylor50e4e862015-09-04 23:39:40 +00003466 if (UnwindDest == nullptr) {
Joseph Tremoulet09af67a2015-09-27 01:47:46 +00003467 removeUnwindEdge(PredBB);
Andrew Kaylor50e4e862015-09-04 23:39:40 +00003468 } else {
Andrew Kaylor50e4e862015-09-04 23:39:40 +00003469 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulet09af67a2015-09-27 01:47:46 +00003470 TI->replaceUsesOfWith(BB, UnwindDest);
Andrew Kaylor50e4e862015-09-04 23:39:40 +00003471 }
3472 }
3473
3474 // The cleanup pad is now unreachable. Zap it.
3475 BB->eraseFromParent();
3476 return true;
3477}
3478
David Majnemer1efa23d2016-02-20 01:07:45 +00003479// Try to merge two cleanuppads together.
3480static bool mergeCleanupPad(CleanupReturnInst *RI) {
3481 // Skip any cleanuprets which unwind to caller, there is nothing to merge
3482 // with.
3483 BasicBlock *UnwindDest = RI->getUnwindDest();
3484 if (!UnwindDest)
3485 return false;
3486
3487 // This cleanupret isn't the only predecessor of this cleanuppad, it wouldn't
3488 // be safe to merge without code duplication.
3489 if (UnwindDest->getSinglePredecessor() != RI->getParent())
3490 return false;
3491
3492 // Verify that our cleanuppad's unwind destination is another cleanuppad.
3493 auto *SuccessorCleanupPad = dyn_cast<CleanupPadInst>(&UnwindDest->front());
3494 if (!SuccessorCleanupPad)
3495 return false;
3496
3497 CleanupPadInst *PredecessorCleanupPad = RI->getCleanupPad();
3498 // Replace any uses of the successor cleanupad with the predecessor pad
3499 // The only cleanuppad uses should be this cleanupret, it's cleanupret and
3500 // funclet bundle operands.
3501 SuccessorCleanupPad->replaceAllUsesWith(PredecessorCleanupPad);
3502 // Remove the old cleanuppad.
3503 SuccessorCleanupPad->eraseFromParent();
3504 // Now, we simply replace the cleanupret with a branch to the unwind
3505 // destination.
3506 BranchInst::Create(UnwindDest, RI->getParent());
3507 RI->eraseFromParent();
3508
3509 return true;
3510}
3511
3512bool SimplifyCFGOpt::SimplifyCleanupReturn(CleanupReturnInst *RI) {
David Majnemeree0cbbb2016-02-24 17:30:48 +00003513 // It is possible to transiantly have an undef cleanuppad operand because we
3514 // have deleted some, but not all, dead blocks.
3515 // Eventually, this block will be deleted.
3516 if (isa<UndefValue>(RI->getOperand(0)))
3517 return false;
3518
David Majnemer1efa23d2016-02-20 01:07:45 +00003519 if (removeEmptyCleanup(RI))
3520 return true;
3521
3522 if (mergeCleanupPad(RI))
3523 return true;
3524
3525 return false;
3526}
3527
Devang Pateldd14e0f2011-05-18 21:33:11 +00003528bool SimplifyCFGOpt::SimplifyReturn(ReturnInst *RI, IRBuilder<> &Builder) {
Chris Lattner25c3af32010-12-13 06:25:44 +00003529 BasicBlock *BB = RI->getParent();
3530 if (!BB->getFirstNonPHIOrDbg()->isTerminator()) return false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00003531
Chris Lattner25c3af32010-12-13 06:25:44 +00003532 // Find predecessors that end with branches.
3533 SmallVector<BasicBlock*, 8> UncondBranchPreds;
3534 SmallVector<BranchInst*, 8> CondBranchPreds;
Duncan P. N. Exon Smith6c990152014-07-21 17:06:51 +00003535 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
3536 BasicBlock *P = *PI;
Chris Lattner25c3af32010-12-13 06:25:44 +00003537 TerminatorInst *PTI = P->getTerminator();
3538 if (BranchInst *BI = dyn_cast<BranchInst>(PTI)) {
3539 if (BI->isUnconditional())
3540 UncondBranchPreds.push_back(P);
3541 else
3542 CondBranchPreds.push_back(BI);
3543 }
3544 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003545
Chris Lattner25c3af32010-12-13 06:25:44 +00003546 // If we found some, do the transformation!
Evan Chengd983eba2011-01-29 04:46:23 +00003547 if (!UncondBranchPreds.empty() && DupRet) {
Chris Lattner25c3af32010-12-13 06:25:44 +00003548 while (!UncondBranchPreds.empty()) {
3549 BasicBlock *Pred = UncondBranchPreds.pop_back_val();
3550 DEBUG(dbgs() << "FOLDING: " << *BB
3551 << "INTO UNCOND BRANCH PRED: " << *Pred);
Evan Chengd983eba2011-01-29 04:46:23 +00003552 (void)FoldReturnIntoUncondBranch(RI, BB, Pred);
Chris Lattner25c3af32010-12-13 06:25:44 +00003553 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003554
Chris Lattner25c3af32010-12-13 06:25:44 +00003555 // If we eliminated all predecessors of the block, delete the block now.
Hyojin Sung4673f102016-03-29 04:08:57 +00003556 if (pred_empty(BB)) {
Chris Lattner25c3af32010-12-13 06:25:44 +00003557 // We know there are no successors, so just nuke the block.
3558 BB->eraseFromParent();
Hyojin Sung4673f102016-03-29 04:08:57 +00003559 if (LoopHeaders) LoopHeaders->erase(BB);
3560 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003561
Chris Lattner25c3af32010-12-13 06:25:44 +00003562 return true;
3563 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003564
Chris Lattner25c3af32010-12-13 06:25:44 +00003565 // Check out all of the conditional branches going to this return
3566 // instruction. If any of them just select between returns, change the
3567 // branch itself into a select/return pair.
3568 while (!CondBranchPreds.empty()) {
3569 BranchInst *BI = CondBranchPreds.pop_back_val();
Andrew Trickf3cf1932012-08-29 21:46:36 +00003570
Chris Lattner25c3af32010-12-13 06:25:44 +00003571 // Check to see if the non-BB successor is also a return block.
3572 if (isa<ReturnInst>(BI->getSuccessor(0)->getTerminator()) &&
3573 isa<ReturnInst>(BI->getSuccessor(1)->getTerminator()) &&
Devang Pateldd14e0f2011-05-18 21:33:11 +00003574 SimplifyCondBranchToTwoReturns(BI, Builder))
Chris Lattner25c3af32010-12-13 06:25:44 +00003575 return true;
3576 }
3577 return false;
3578}
3579
Chris Lattner25c3af32010-12-13 06:25:44 +00003580bool SimplifyCFGOpt::SimplifyUnreachable(UnreachableInst *UI) {
3581 BasicBlock *BB = UI->getParent();
Andrew Trickf3cf1932012-08-29 21:46:36 +00003582
Chris Lattner25c3af32010-12-13 06:25:44 +00003583 bool Changed = false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00003584
Chris Lattner25c3af32010-12-13 06:25:44 +00003585 // If there are any instructions immediately before the unreachable that can
3586 // be removed, do so.
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00003587 while (UI->getIterator() != BB->begin()) {
3588 BasicBlock::iterator BBI = UI->getIterator();
Chris Lattner25c3af32010-12-13 06:25:44 +00003589 --BBI;
Eli Friedman0ffdf2e2011-08-15 23:59:28 +00003590 // Do not delete instructions that can have side effects which might cause
3591 // the unreachable to not be reachable; specifically, calls and volatile
3592 // operations may have this effect.
Chris Lattner25c3af32010-12-13 06:25:44 +00003593 if (isa<CallInst>(BBI) && !isa<DbgInfoIntrinsic>(BBI)) break;
Eli Friedman0ffdf2e2011-08-15 23:59:28 +00003594
3595 if (BBI->mayHaveSideEffects()) {
Joseph Tremoulet0d808882016-01-05 02:37:41 +00003596 if (auto *SI = dyn_cast<StoreInst>(BBI)) {
Eli Friedman0ffdf2e2011-08-15 23:59:28 +00003597 if (SI->isVolatile())
3598 break;
Joseph Tremoulet0d808882016-01-05 02:37:41 +00003599 } else if (auto *LI = dyn_cast<LoadInst>(BBI)) {
Eli Friedman0ffdf2e2011-08-15 23:59:28 +00003600 if (LI->isVolatile())
3601 break;
Joseph Tremoulet0d808882016-01-05 02:37:41 +00003602 } else if (auto *RMWI = dyn_cast<AtomicRMWInst>(BBI)) {
Eli Friedman0ffdf2e2011-08-15 23:59:28 +00003603 if (RMWI->isVolatile())
3604 break;
Joseph Tremoulet0d808882016-01-05 02:37:41 +00003605 } else if (auto *CXI = dyn_cast<AtomicCmpXchgInst>(BBI)) {
Eli Friedman0ffdf2e2011-08-15 23:59:28 +00003606 if (CXI->isVolatile())
3607 break;
Joseph Tremoulet0d808882016-01-05 02:37:41 +00003608 } else if (isa<CatchPadInst>(BBI)) {
3609 // A catchpad may invoke exception object constructors and such, which
3610 // in some languages can be arbitrary code, so be conservative by
3611 // default.
3612 // For CoreCLR, it just involves a type test, so can be removed.
3613 if (classifyEHPersonality(BB->getParent()->getPersonalityFn()) !=
3614 EHPersonality::CoreCLR)
3615 break;
Eli Friedman0ffdf2e2011-08-15 23:59:28 +00003616 } else if (!isa<FenceInst>(BBI) && !isa<VAArgInst>(BBI) &&
3617 !isa<LandingPadInst>(BBI)) {
Chris Lattner25c3af32010-12-13 06:25:44 +00003618 break;
Eli Friedman0ffdf2e2011-08-15 23:59:28 +00003619 }
Bill Wendling55d875f2011-08-16 20:41:17 +00003620 // Note that deleting LandingPad's here is in fact okay, although it
3621 // involves a bit of subtle reasoning. If this inst is a LandingPad,
3622 // all the predecessors of this block will be the unwind edges of Invokes,
3623 // and we can therefore guarantee this block will be erased.
Eli Friedman0ffdf2e2011-08-15 23:59:28 +00003624 }
3625
Eli Friedmanaac35b32011-03-09 00:48:33 +00003626 // Delete this instruction (any uses are guaranteed to be dead)
3627 if (!BBI->use_empty())
3628 BBI->replaceAllUsesWith(UndefValue::get(BBI->getType()));
Chris Lattnerd7beca32010-12-14 06:17:25 +00003629 BBI->eraseFromParent();
Chris Lattner25c3af32010-12-13 06:25:44 +00003630 Changed = true;
3631 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003632
Chris Lattner25c3af32010-12-13 06:25:44 +00003633 // If the unreachable instruction is the first in the block, take a gander
3634 // at all of the predecessors of this instruction, and simplify them.
3635 if (&BB->front() != UI) return Changed;
Andrew Trickf3cf1932012-08-29 21:46:36 +00003636
Chris Lattner25c3af32010-12-13 06:25:44 +00003637 SmallVector<BasicBlock*, 8> Preds(pred_begin(BB), pred_end(BB));
3638 for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
3639 TerminatorInst *TI = Preds[i]->getTerminator();
Devang Patel31458a02011-05-19 00:09:21 +00003640 IRBuilder<> Builder(TI);
Joseph Tremoulet0d808882016-01-05 02:37:41 +00003641 if (auto *BI = dyn_cast<BranchInst>(TI)) {
Chris Lattner25c3af32010-12-13 06:25:44 +00003642 if (BI->isUnconditional()) {
3643 if (BI->getSuccessor(0) == BB) {
3644 new UnreachableInst(TI->getContext(), TI);
3645 TI->eraseFromParent();
3646 Changed = true;
3647 }
3648 } else {
3649 if (BI->getSuccessor(0) == BB) {
Devang Patel31458a02011-05-19 00:09:21 +00003650 Builder.CreateBr(BI->getSuccessor(1));
Chris Lattner25c3af32010-12-13 06:25:44 +00003651 EraseTerminatorInstAndDCECond(BI);
3652 } else if (BI->getSuccessor(1) == BB) {
Devang Patel31458a02011-05-19 00:09:21 +00003653 Builder.CreateBr(BI->getSuccessor(0));
Chris Lattner25c3af32010-12-13 06:25:44 +00003654 EraseTerminatorInstAndDCECond(BI);
3655 Changed = true;
3656 }
3657 }
Joseph Tremoulet0d808882016-01-05 02:37:41 +00003658 } else if (auto *SI = dyn_cast<SwitchInst>(TI)) {
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00003659 for (SwitchInst::CaseIt i = SI->case_begin(), e = SI->case_end();
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003660 i != e; ++i)
3661 if (i.getCaseSuccessor() == BB) {
Chris Lattner25c3af32010-12-13 06:25:44 +00003662 BB->removePredecessor(SI->getParent());
3663 SI->removeCase(i);
3664 --i; --e;
3665 Changed = true;
3666 }
Joseph Tremoulet0d808882016-01-05 02:37:41 +00003667 } else if (auto *II = dyn_cast<InvokeInst>(TI)) {
3668 if (II->getUnwindDest() == BB) {
3669 removeUnwindEdge(TI->getParent());
3670 Changed = true;
3671 }
3672 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3673 if (CSI->getUnwindDest() == BB) {
3674 removeUnwindEdge(TI->getParent());
3675 Changed = true;
3676 continue;
3677 }
3678
3679 for (CatchSwitchInst::handler_iterator I = CSI->handler_begin(),
3680 E = CSI->handler_end();
3681 I != E; ++I) {
3682 if (*I == BB) {
3683 CSI->removeHandler(I);
3684 --I;
3685 --E;
3686 Changed = true;
3687 }
3688 }
3689 if (CSI->getNumHandlers() == 0) {
3690 BasicBlock *CatchSwitchBB = CSI->getParent();
3691 if (CSI->hasUnwindDest()) {
3692 // Redirect preds to the unwind dest
3693 CatchSwitchBB->replaceAllUsesWith(CSI->getUnwindDest());
3694 } else {
3695 // Rewrite all preds to unwind to caller (or from invoke to call).
3696 SmallVector<BasicBlock *, 8> EHPreds(predecessors(CatchSwitchBB));
3697 for (BasicBlock *EHPred : EHPreds)
3698 removeUnwindEdge(EHPred);
3699 }
3700 // The catchswitch is no longer reachable.
3701 new UnreachableInst(CSI->getContext(), CSI);
3702 CSI->eraseFromParent();
3703 Changed = true;
3704 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003705 } else if (isa<CleanupReturnInst>(TI)) {
Joseph Tremoulet09af67a2015-09-27 01:47:46 +00003706 new UnreachableInst(TI->getContext(), TI);
3707 TI->eraseFromParent();
3708 Changed = true;
Chris Lattner25c3af32010-12-13 06:25:44 +00003709 }
3710 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00003711
Chris Lattner25c3af32010-12-13 06:25:44 +00003712 // If this block is now dead, remove it.
Ramkumar Ramachandra40c3e032015-01-13 03:46:47 +00003713 if (pred_empty(BB) &&
Chris Lattner25c3af32010-12-13 06:25:44 +00003714 BB != &BB->getParent()->getEntryBlock()) {
3715 // We know there are no successors, so just nuke the block.
3716 BB->eraseFromParent();
Hyojin Sung4673f102016-03-29 04:08:57 +00003717 if (LoopHeaders) LoopHeaders->erase(BB);
Chris Lattner25c3af32010-12-13 06:25:44 +00003718 return true;
3719 }
3720
3721 return Changed;
3722}
3723
Hans Wennborg68000082015-01-26 19:52:32 +00003724static bool CasesAreContiguous(SmallVectorImpl<ConstantInt *> &Cases) {
3725 assert(Cases.size() >= 1);
3726
3727 array_pod_sort(Cases.begin(), Cases.end(), ConstantIntSortPredicate);
3728 for (size_t I = 1, E = Cases.size(); I != E; ++I) {
3729 if (Cases[I - 1]->getValue() != Cases[I]->getValue() + 1)
3730 return false;
3731 }
3732 return true;
3733}
3734
3735/// Turn a switch with two reachable destinations into an integer range
3736/// comparison and branch.
Devang Patela7ec47d2011-05-18 20:35:38 +00003737static bool TurnSwitchRangeIntoICmp(SwitchInst *SI, IRBuilder<> &Builder) {
Stepan Dyatkovskiy513aaa52012-02-01 07:49:51 +00003738 assert(SI->getNumCases() > 1 && "Degenerate switch?");
Benjamin Kramerf4ea1d52011-02-02 15:56:22 +00003739
Hans Wennborg68000082015-01-26 19:52:32 +00003740 bool HasDefault =
3741 !isa<UnreachableInst>(SI->getDefaultDest()->getFirstNonPHIOrDbg());
Benjamin Kramer62aa46b2011-02-03 22:51:41 +00003742
Hans Wennborg68000082015-01-26 19:52:32 +00003743 // Partition the cases into two sets with different destinations.
3744 BasicBlock *DestA = HasDefault ? SI->getDefaultDest() : nullptr;
3745 BasicBlock *DestB = nullptr;
3746 SmallVector <ConstantInt *, 16> CasesA;
3747 SmallVector <ConstantInt *, 16> CasesB;
3748
3749 for (SwitchInst::CaseIt I : SI->cases()) {
3750 BasicBlock *Dest = I.getCaseSuccessor();
3751 if (!DestA) DestA = Dest;
3752 if (Dest == DestA) {
3753 CasesA.push_back(I.getCaseValue());
3754 continue;
3755 }
3756 if (!DestB) DestB = Dest;
3757 if (Dest == DestB) {
3758 CasesB.push_back(I.getCaseValue());
3759 continue;
3760 }
3761 return false; // More than two destinations.
Benjamin Kramer62aa46b2011-02-03 22:51:41 +00003762 }
3763
Hans Wennborg68000082015-01-26 19:52:32 +00003764 assert(DestA && DestB && "Single-destination switch should have been folded.");
3765 assert(DestA != DestB);
3766 assert(DestB != SI->getDefaultDest());
3767 assert(!CasesB.empty() && "There must be non-default cases.");
3768 assert(!CasesA.empty() || HasDefault);
3769
3770 // Figure out if one of the sets of cases form a contiguous range.
3771 SmallVectorImpl<ConstantInt *> *ContiguousCases = nullptr;
3772 BasicBlock *ContiguousDest = nullptr;
3773 BasicBlock *OtherDest = nullptr;
3774 if (!CasesA.empty() && CasesAreContiguous(CasesA)) {
3775 ContiguousCases = &CasesA;
3776 ContiguousDest = DestA;
3777 OtherDest = DestB;
3778 } else if (CasesAreContiguous(CasesB)) {
3779 ContiguousCases = &CasesB;
3780 ContiguousDest = DestB;
3781 OtherDest = DestA;
3782 } else
3783 return false;
3784
3785 // Start building the compare and branch.
3786
3787 Constant *Offset = ConstantExpr::getNeg(ContiguousCases->back());
3788 Constant *NumCases = ConstantInt::get(Offset->getType(), ContiguousCases->size());
Benjamin Kramerf4ea1d52011-02-02 15:56:22 +00003789
Benjamin Kramer8d6a8c12011-02-07 22:37:28 +00003790 Value *Sub = SI->getCondition();
3791 if (!Offset->isNullValue())
Hans Wennborg68000082015-01-26 19:52:32 +00003792 Sub = Builder.CreateAdd(Sub, Offset, Sub->getName() + ".off");
3793
Hans Wennborgc9e1d992013-04-16 08:35:36 +00003794 Value *Cmp;
3795 // If NumCases overflowed, then all possible values jump to the successor.
Hans Wennborg68000082015-01-26 19:52:32 +00003796 if (NumCases->isNullValue() && !ContiguousCases->empty())
Hans Wennborgc9e1d992013-04-16 08:35:36 +00003797 Cmp = ConstantInt::getTrue(SI->getContext());
3798 else
3799 Cmp = Builder.CreateICmpULT(Sub, NumCases, "switch");
Hans Wennborg68000082015-01-26 19:52:32 +00003800 BranchInst *NewBI = Builder.CreateCondBr(Cmp, ContiguousDest, OtherDest);
Benjamin Kramerf4ea1d52011-02-02 15:56:22 +00003801
Manman Ren56575552012-09-18 00:47:33 +00003802 // Update weight for the newly-created conditional branch.
Hans Wennborg68000082015-01-26 19:52:32 +00003803 if (HasBranchWeights(SI)) {
3804 SmallVector<uint64_t, 8> Weights;
Manman Ren56575552012-09-18 00:47:33 +00003805 GetBranchWeights(SI, Weights);
3806 if (Weights.size() == 1 + SI->getNumCases()) {
Hans Wennborg68000082015-01-26 19:52:32 +00003807 uint64_t TrueWeight = 0;
3808 uint64_t FalseWeight = 0;
3809 for (size_t I = 0, E = Weights.size(); I != E; ++I) {
3810 if (SI->getSuccessor(I) == ContiguousDest)
3811 TrueWeight += Weights[I];
3812 else
3813 FalseWeight += Weights[I];
3814 }
3815 while (TrueWeight > UINT32_MAX || FalseWeight > UINT32_MAX) {
3816 TrueWeight /= 2;
3817 FalseWeight /= 2;
3818 }
Manman Ren56575552012-09-18 00:47:33 +00003819 NewBI->setMetadata(LLVMContext::MD_prof,
Hans Wennborg68000082015-01-26 19:52:32 +00003820 MDBuilder(SI->getContext()).createBranchWeights(
3821 (uint32_t)TrueWeight, (uint32_t)FalseWeight));
Manman Ren56575552012-09-18 00:47:33 +00003822 }
3823 }
3824
Hans Wennborg68000082015-01-26 19:52:32 +00003825 // Prune obsolete incoming values off the successors' PHI nodes.
3826 for (auto BBI = ContiguousDest->begin(); isa<PHINode>(BBI); ++BBI) {
3827 unsigned PreviousEdges = ContiguousCases->size();
3828 if (ContiguousDest == SI->getDefaultDest()) ++PreviousEdges;
3829 for (unsigned I = 0, E = PreviousEdges - 1; I != E; ++I)
Benjamin Kramerf4ea1d52011-02-02 15:56:22 +00003830 cast<PHINode>(BBI)->removeIncomingValue(SI->getParent());
3831 }
Hans Wennborg68000082015-01-26 19:52:32 +00003832 for (auto BBI = OtherDest->begin(); isa<PHINode>(BBI); ++BBI) {
3833 unsigned PreviousEdges = SI->getNumCases() - ContiguousCases->size();
3834 if (OtherDest == SI->getDefaultDest()) ++PreviousEdges;
3835 for (unsigned I = 0, E = PreviousEdges - 1; I != E; ++I)
3836 cast<PHINode>(BBI)->removeIncomingValue(SI->getParent());
3837 }
3838
3839 // Drop the switch.
Benjamin Kramerf4ea1d52011-02-02 15:56:22 +00003840 SI->eraseFromParent();
3841
3842 return true;
3843}
Chris Lattner25c3af32010-12-13 06:25:44 +00003844
Sanjay Patel09159b8f2015-06-24 20:40:57 +00003845/// Compute masked bits for the condition of a switch
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003846/// and use it to remove dead cases.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00003847static bool EliminateDeadSwitchCases(SwitchInst *SI, AssumptionCache *AC,
3848 const DataLayout &DL) {
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003849 Value *Cond = SI->getCondition();
Matt Arsenault8227b9f2013-09-06 00:37:24 +00003850 unsigned Bits = Cond->getType()->getIntegerBitWidth();
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003851 APInt KnownZero(Bits, 0), KnownOne(Bits, 0);
Chandler Carruth66b31302015-01-04 12:03:27 +00003852 computeKnownBits(Cond, KnownZero, KnownOne, DL, 0, AC, SI);
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003853
3854 // Gather dead cases.
3855 SmallVector<ConstantInt*, 8> DeadCases;
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00003856 for (SwitchInst::CaseIt I = SI->case_begin(), E = SI->case_end(); I != E; ++I) {
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003857 if ((I.getCaseValue()->getValue() & KnownZero) != 0 ||
3858 (I.getCaseValue()->getValue() & KnownOne) != KnownOne) {
3859 DeadCases.push_back(I.getCaseValue());
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003860 DEBUG(dbgs() << "SimplifyCFG: switch case '"
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003861 << I.getCaseValue() << "' is dead.\n");
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003862 }
3863 }
3864
Philip Reames98a2dab2015-08-26 23:56:46 +00003865 // If we can prove that the cases must cover all possible values, the
Philip Reames05370132015-09-10 17:44:47 +00003866 // default destination becomes dead and we can remove it. If we know some
3867 // of the bits in the value, we can use that to more precisely compute the
3868 // number of possible unique case values.
Philip Reames98a2dab2015-08-26 23:56:46 +00003869 bool HasDefault =
3870 !isa<UnreachableInst>(SI->getDefaultDest()->getFirstNonPHIOrDbg());
Philip Reames05370132015-09-10 17:44:47 +00003871 const unsigned NumUnknownBits = Bits -
3872 (KnownZero.Or(KnownOne)).countPopulation();
Filipe Cabecinhas48b090a2015-09-10 22:34:39 +00003873 assert(NumUnknownBits <= Bits);
Philip Reames05370132015-09-10 17:44:47 +00003874 if (HasDefault && DeadCases.empty() &&
3875 NumUnknownBits < 64 /* avoid overflow */ &&
3876 SI->getNumCases() == (1ULL << NumUnknownBits)) {
Philip Reames98a2dab2015-08-26 23:56:46 +00003877 DEBUG(dbgs() << "SimplifyCFG: switch default is dead.\n");
3878 BasicBlock *NewDefault = SplitBlockPredecessors(SI->getDefaultDest(),
3879 SI->getParent(), "");
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00003880 SI->setDefaultDest(&*NewDefault);
3881 SplitBlock(&*NewDefault, &NewDefault->front());
Philip Reames98a2dab2015-08-26 23:56:46 +00003882 auto *OldTI = NewDefault->getTerminator();
3883 new UnreachableInst(SI->getContext(), OldTI);
3884 EraseTerminatorInstAndDCECond(OldTI);
3885 return true;
3886 }
3887
Manman Ren56575552012-09-18 00:47:33 +00003888 SmallVector<uint64_t, 8> Weights;
3889 bool HasWeight = HasBranchWeights(SI);
3890 if (HasWeight) {
3891 GetBranchWeights(SI, Weights);
3892 HasWeight = (Weights.size() == 1 + SI->getNumCases());
3893 }
3894
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003895 // Remove dead cases from the switch.
3896 for (unsigned I = 0, E = DeadCases.size(); I != E; ++I) {
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003897 SwitchInst::CaseIt Case = SI->findCaseValue(DeadCases[I]);
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00003898 assert(Case != SI->case_default() &&
Stepan Dyatkovskiy513aaa52012-02-01 07:49:51 +00003899 "Case was not found. Probably mistake in DeadCases forming.");
Manman Ren56575552012-09-18 00:47:33 +00003900 if (HasWeight) {
3901 std::swap(Weights[Case.getCaseIndex()+1], Weights.back());
3902 Weights.pop_back();
3903 }
3904
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003905 // Prune unused values from PHI nodes.
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003906 Case.getCaseSuccessor()->removePredecessor(SI->getParent());
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003907 SI->removeCase(Case);
3908 }
Justin Bogner0ba3f212013-12-20 08:21:30 +00003909 if (HasWeight && Weights.size() >= 2) {
Manman Ren56575552012-09-18 00:47:33 +00003910 SmallVector<uint32_t, 8> MDWeights(Weights.begin(), Weights.end());
3911 SI->setMetadata(LLVMContext::MD_prof,
3912 MDBuilder(SI->getParent()->getContext()).
3913 createBranchWeights(MDWeights));
3914 }
Benjamin Kramerd96205c2011-05-14 15:57:25 +00003915
3916 return !DeadCases.empty();
3917}
3918
Sanjay Patel09159b8f2015-06-24 20:40:57 +00003919/// If BB would be eligible for simplification by
3920/// TryToSimplifyUncondBranchFromEmptyBlock (i.e. it is empty and terminated
Hans Wennborg4ab4a8e2011-06-18 10:28:47 +00003921/// by an unconditional branch), look at the phi node for BB in the successor
3922/// block and see if the incoming value is equal to CaseValue. If so, return
3923/// the phi node, and set PhiIndex to BB's index in the phi node.
3924static PHINode *FindPHIForConditionForwarding(ConstantInt *CaseValue,
3925 BasicBlock *BB,
3926 int *PhiIndex) {
3927 if (BB->getFirstNonPHIOrDbg() != BB->getTerminator())
Craig Topperf40110f2014-04-25 05:29:35 +00003928 return nullptr; // BB must be empty to be a candidate for simplification.
Hans Wennborg4ab4a8e2011-06-18 10:28:47 +00003929 if (!BB->getSinglePredecessor())
Craig Topperf40110f2014-04-25 05:29:35 +00003930 return nullptr; // BB must be dominated by the switch.
Hans Wennborg4ab4a8e2011-06-18 10:28:47 +00003931
3932 BranchInst *Branch = dyn_cast<BranchInst>(BB->getTerminator());
3933 if (!Branch || !Branch->isUnconditional())
Craig Topperf40110f2014-04-25 05:29:35 +00003934 return nullptr; // Terminator must be unconditional branch.
Hans Wennborg4ab4a8e2011-06-18 10:28:47 +00003935
3936 BasicBlock *Succ = Branch->getSuccessor(0);
3937
3938 BasicBlock::iterator I = Succ->begin();
3939 while (PHINode *PHI = dyn_cast<PHINode>(I++)) {
3940 int Idx = PHI->getBasicBlockIndex(BB);
3941 assert(Idx >= 0 && "PHI has no entry for predecessor?");
3942
3943 Value *InValue = PHI->getIncomingValue(Idx);
3944 if (InValue != CaseValue) continue;
3945
3946 *PhiIndex = Idx;
3947 return PHI;
3948 }
3949
Craig Topperf40110f2014-04-25 05:29:35 +00003950 return nullptr;
Hans Wennborg4ab4a8e2011-06-18 10:28:47 +00003951}
3952
Sanjay Patel09159b8f2015-06-24 20:40:57 +00003953/// Try to forward the condition of a switch instruction to a phi node
3954/// dominated by the switch, if that would mean that some of the destination
3955/// blocks of the switch can be folded away.
Hans Wennborg4ab4a8e2011-06-18 10:28:47 +00003956/// Returns true if a change is made.
3957static bool ForwardSwitchConditionToPHI(SwitchInst *SI) {
3958 typedef DenseMap<PHINode*, SmallVector<int,4> > ForwardingNodesMap;
3959 ForwardingNodesMap ForwardingNodes;
3960
Stepan Dyatkovskiy97b02fc2012-03-11 06:09:17 +00003961 for (SwitchInst::CaseIt I = SI->case_begin(), E = SI->case_end(); I != E; ++I) {
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00003962 ConstantInt *CaseValue = I.getCaseValue();
3963 BasicBlock *CaseDest = I.getCaseSuccessor();
Hans Wennborg4ab4a8e2011-06-18 10:28:47 +00003964
3965 int PhiIndex;
3966 PHINode *PHI = FindPHIForConditionForwarding(CaseValue, CaseDest,
3967 &PhiIndex);
3968 if (!PHI) continue;
3969
3970 ForwardingNodes[PHI].push_back(PhiIndex);
3971 }
3972
3973 bool Changed = false;
3974
3975 for (ForwardingNodesMap::iterator I = ForwardingNodes.begin(),
3976 E = ForwardingNodes.end(); I != E; ++I) {
3977 PHINode *Phi = I->first;
Craig Topperb94011f2013-07-14 04:42:23 +00003978 SmallVectorImpl<int> &Indexes = I->second;
Hans Wennborg4ab4a8e2011-06-18 10:28:47 +00003979
3980 if (Indexes.size() < 2) continue;
3981
3982 for (size_t I = 0, E = Indexes.size(); I != E; ++I)
3983 Phi->setIncomingValue(Indexes[I], SI->getCondition());
3984 Changed = true;
3985 }
3986
3987 return Changed;
3988}
3989
Sanjay Patel09159b8f2015-06-24 20:40:57 +00003990/// Return true if the backend will be able to handle
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003991/// initializing an array of constants like C.
Hans Wennborg08238ad2012-09-07 08:22:57 +00003992static bool ValidLookupTableConstant(Constant *C) {
Hans Wennborg4dc89512014-06-20 00:38:12 +00003993 if (C->isThreadDependent())
3994 return false;
3995 if (C->isDLLImportDependent())
3996 return false;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00003997
Hans Wennborgb03ebfb2014-06-26 00:30:52 +00003998 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
3999 return CE->isGEPWithNoNotionalOverIndexing();
4000
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004001 return isa<ConstantFP>(C) ||
4002 isa<ConstantInt>(C) ||
4003 isa<ConstantPointerNull>(C) ||
4004 isa<GlobalValue>(C) ||
4005 isa<UndefValue>(C);
4006}
4007
Sanjay Patel09159b8f2015-06-24 20:40:57 +00004008/// If V is a Constant, return it. Otherwise, try to look up
Hans Wennborg4fef2fe2012-10-31 15:31:09 +00004009/// its constant value in ConstantPool, returning 0 if it's not there.
Hans Wennborg09acdb92012-10-31 15:14:39 +00004010static Constant *LookupConstant(Value *V,
4011 const SmallDenseMap<Value*, Constant*>& ConstantPool) {
4012 if (Constant *C = dyn_cast<Constant>(V))
4013 return C;
4014 return ConstantPool.lookup(V);
4015}
4016
Sanjay Patel09159b8f2015-06-24 20:40:57 +00004017/// Try to fold instruction I into a constant. This works for
Hans Wennborg9e74dd92012-10-31 13:42:45 +00004018/// simple instructions such as binary operations where both operands are
4019/// constant or can be replaced by constants from the ConstantPool. Returns the
Hans Wennborg4fef2fe2012-10-31 15:31:09 +00004020/// resulting constant on success, 0 otherwise.
Benjamin Kramer7c302602013-11-12 12:24:36 +00004021static Constant *
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004022ConstantFold(Instruction *I, const DataLayout &DL,
4023 const SmallDenseMap<Value *, Constant *> &ConstantPool) {
Hans Wennborg9e74dd92012-10-31 13:42:45 +00004024 if (SelectInst *Select = dyn_cast<SelectInst>(I)) {
Hans Wennborg09acdb92012-10-31 15:14:39 +00004025 Constant *A = LookupConstant(Select->getCondition(), ConstantPool);
4026 if (!A)
Craig Topperf40110f2014-04-25 05:29:35 +00004027 return nullptr;
Hans Wennborg09acdb92012-10-31 15:14:39 +00004028 if (A->isAllOnesValue())
4029 return LookupConstant(Select->getTrueValue(), ConstantPool);
4030 if (A->isNullValue())
4031 return LookupConstant(Select->getFalseValue(), ConstantPool);
Craig Topperf40110f2014-04-25 05:29:35 +00004032 return nullptr;
Hans Wennborg9e74dd92012-10-31 13:42:45 +00004033 }
4034
Benjamin Kramer7c302602013-11-12 12:24:36 +00004035 SmallVector<Constant *, 4> COps;
4036 for (unsigned N = 0, E = I->getNumOperands(); N != E; ++N) {
4037 if (Constant *A = LookupConstant(I->getOperand(N), ConstantPool))
4038 COps.push_back(A);
4039 else
Craig Topperf40110f2014-04-25 05:29:35 +00004040 return nullptr;
Hans Wennborg9e74dd92012-10-31 13:42:45 +00004041 }
4042
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004043 if (CmpInst *Cmp = dyn_cast<CmpInst>(I)) {
Benjamin Kramer7c302602013-11-12 12:24:36 +00004044 return ConstantFoldCompareInstOperands(Cmp->getPredicate(), COps[0],
4045 COps[1], DL);
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004046 }
Benjamin Kramer7c302602013-11-12 12:24:36 +00004047
Manuel Jacobe9024592016-01-21 06:33:22 +00004048 return ConstantFoldInstOperands(I, COps, DL);
Hans Wennborg9e74dd92012-10-31 13:42:45 +00004049}
4050
Sanjay Patel09159b8f2015-06-24 20:40:57 +00004051/// Try to determine the resulting constant values in phi nodes
Hans Wennborg9e74dd92012-10-31 13:42:45 +00004052/// at the common destination basic block, *CommonDest, for one of the case
Hans Wennborg4fef2fe2012-10-31 15:31:09 +00004053/// destionations CaseDest corresponding to value CaseVal (0 for the default
Hans Wennborg9e74dd92012-10-31 13:42:45 +00004054/// case), of a switch instruction SI.
Craig Topperb94011f2013-07-14 04:42:23 +00004055static bool
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004056GetCaseResults(SwitchInst *SI, ConstantInt *CaseVal, BasicBlock *CaseDest,
Craig Topperb94011f2013-07-14 04:42:23 +00004057 BasicBlock **CommonDest,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004058 SmallVectorImpl<std::pair<PHINode *, Constant *>> &Res,
4059 const DataLayout &DL) {
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004060 // The block from which we enter the common destination.
4061 BasicBlock *Pred = SI->getParent();
4062
Hans Wennborg9e74dd92012-10-31 13:42:45 +00004063 // If CaseDest is empty except for some side-effect free instructions through
4064 // which we can constant-propagate the CaseVal, continue to its successor.
4065 SmallDenseMap<Value*, Constant*> ConstantPool;
4066 ConstantPool.insert(std::make_pair(SI->getCondition(), CaseVal));
4067 for (BasicBlock::iterator I = CaseDest->begin(), E = CaseDest->end(); I != E;
4068 ++I) {
4069 if (TerminatorInst *T = dyn_cast<TerminatorInst>(I)) {
4070 // If the terminator is a simple branch, continue to the next block.
4071 if (T->getNumSuccessors() != 1)
4072 return false;
4073 Pred = CaseDest;
4074 CaseDest = T->getSuccessor(0);
4075 } else if (isa<DbgInfoIntrinsic>(I)) {
4076 // Skip debug intrinsic.
4077 continue;
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00004078 } else if (Constant *C = ConstantFold(&*I, DL, ConstantPool)) {
Hans Wennborg9e74dd92012-10-31 13:42:45 +00004079 // Instruction is side-effect free and constant.
Hans Wennborgdcc6e5b2015-01-09 22:13:31 +00004080
4081 // If the instruction has uses outside this block or a phi node slot for
4082 // the block, it is not safe to bypass the instruction since it would then
4083 // no longer dominate all its uses.
4084 for (auto &Use : I->uses()) {
4085 User *User = Use.getUser();
4086 if (Instruction *I = dyn_cast<Instruction>(User))
4087 if (I->getParent() == CaseDest)
4088 continue;
4089 if (PHINode *Phi = dyn_cast<PHINode>(User))
4090 if (Phi->getIncomingBlock(Use) == CaseDest)
4091 continue;
4092 return false;
4093 }
4094
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00004095 ConstantPool.insert(std::make_pair(&*I, C));
Hans Wennborg9e74dd92012-10-31 13:42:45 +00004096 } else {
4097 break;
4098 }
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004099 }
4100
4101 // If we did not have a CommonDest before, use the current one.
4102 if (!*CommonDest)
4103 *CommonDest = CaseDest;
4104 // If the destination isn't the common one, abort.
4105 if (CaseDest != *CommonDest)
4106 return false;
4107
4108 // Get the values for this case from phi nodes in the destination block.
4109 BasicBlock::iterator I = (*CommonDest)->begin();
4110 while (PHINode *PHI = dyn_cast<PHINode>(I++)) {
4111 int Idx = PHI->getBasicBlockIndex(Pred);
4112 if (Idx == -1)
4113 continue;
4114
Hans Wennborg09acdb92012-10-31 15:14:39 +00004115 Constant *ConstVal = LookupConstant(PHI->getIncomingValue(Idx),
4116 ConstantPool);
Hans Wennborg9e74dd92012-10-31 13:42:45 +00004117 if (!ConstVal)
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004118 return false;
4119
4120 // Be conservative about which kinds of constants we support.
4121 if (!ValidLookupTableConstant(ConstVal))
4122 return false;
4123
4124 Res.push_back(std::make_pair(PHI, ConstVal));
4125 }
4126
Hans Wennborgac114a32014-01-12 00:44:41 +00004127 return Res.size() > 0;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004128}
4129
Sanjay Patel09159b8f2015-06-24 20:40:57 +00004130// Helper function used to add CaseVal to the list of cases that generate
4131// Result.
Marcello Maggioni5bbe3df2014-10-14 01:58:26 +00004132static void MapCaseToResult(ConstantInt *CaseVal,
4133 SwitchCaseResultVectorTy &UniqueResults,
4134 Constant *Result) {
4135 for (auto &I : UniqueResults) {
4136 if (I.first == Result) {
4137 I.second.push_back(CaseVal);
4138 return;
4139 }
4140 }
4141 UniqueResults.push_back(std::make_pair(Result,
4142 SmallVector<ConstantInt*, 4>(1, CaseVal)));
4143}
4144
Sanjay Patel09159b8f2015-06-24 20:40:57 +00004145// Helper function that initializes a map containing
Marcello Maggioni5bbe3df2014-10-14 01:58:26 +00004146// results for the PHI node of the common destination block for a switch
4147// instruction. Returns false if multiple PHI nodes have been found or if
4148// there is not a common destination block for the switch.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004149static bool InitializeUniqueCases(SwitchInst *SI, PHINode *&PHI,
4150 BasicBlock *&CommonDest,
4151 SwitchCaseResultVectorTy &UniqueResults,
4152 Constant *&DefaultResult,
4153 const DataLayout &DL) {
Marcello Maggioni5bbe3df2014-10-14 01:58:26 +00004154 for (auto &I : SI->cases()) {
4155 ConstantInt *CaseVal = I.getCaseValue();
4156
4157 // Resulting value at phi nodes for this case value.
4158 SwitchCaseResultsTy Results;
4159 if (!GetCaseResults(SI, CaseVal, I.getCaseSuccessor(), &CommonDest, Results,
4160 DL))
4161 return false;
4162
4163 // Only one value per case is permitted
4164 if (Results.size() > 1)
4165 return false;
4166 MapCaseToResult(CaseVal, UniqueResults, Results.begin()->second);
4167
4168 // Check the PHI consistency.
4169 if (!PHI)
4170 PHI = Results[0].first;
4171 else if (PHI != Results[0].first)
4172 return false;
4173 }
4174 // Find the default result value.
4175 SmallVector<std::pair<PHINode *, Constant *>, 1> DefaultResults;
4176 BasicBlock *DefaultDest = SI->getDefaultDest();
4177 GetCaseResults(SI, nullptr, SI->getDefaultDest(), &CommonDest, DefaultResults,
4178 DL);
4179 // If the default value is not found abort unless the default destination
4180 // is unreachable.
4181 DefaultResult =
4182 DefaultResults.size() == 1 ? DefaultResults.begin()->second : nullptr;
4183 if ((!DefaultResult &&
4184 !isa<UnreachableInst>(DefaultDest->getFirstNonPHIOrDbg())))
4185 return false;
4186
4187 return true;
4188}
4189
Sanjay Patel09159b8f2015-06-24 20:40:57 +00004190// Helper function that checks if it is possible to transform a switch with only
4191// two cases (or two cases + default) that produces a result into a select.
Marcello Maggioni5bbe3df2014-10-14 01:58:26 +00004192// Example:
4193// switch (a) {
4194// case 10: %0 = icmp eq i32 %a, 10
4195// return 10; %1 = select i1 %0, i32 10, i32 4
4196// case 20: ----> %2 = icmp eq i32 %a, 20
4197// return 2; %3 = select i1 %2, i32 2, i32 %1
4198// default:
4199// return 4;
4200// }
4201static Value *
4202ConvertTwoCaseSwitch(const SwitchCaseResultVectorTy &ResultVector,
4203 Constant *DefaultResult, Value *Condition,
4204 IRBuilder<> &Builder) {
4205 assert(ResultVector.size() == 2 &&
4206 "We should have exactly two unique results at this point");
4207 // If we are selecting between only two cases transform into a simple
4208 // select or a two-way select if default is possible.
4209 if (ResultVector[0].second.size() == 1 &&
4210 ResultVector[1].second.size() == 1) {
4211 ConstantInt *const FirstCase = ResultVector[0].second[0];
4212 ConstantInt *const SecondCase = ResultVector[1].second[0];
4213
4214 bool DefaultCanTrigger = DefaultResult;
4215 Value *SelectValue = ResultVector[1].first;
4216 if (DefaultCanTrigger) {
4217 Value *const ValueCompare =
4218 Builder.CreateICmpEQ(Condition, SecondCase, "switch.selectcmp");
4219 SelectValue = Builder.CreateSelect(ValueCompare, ResultVector[1].first,
4220 DefaultResult, "switch.select");
4221 }
4222 Value *const ValueCompare =
4223 Builder.CreateICmpEQ(Condition, FirstCase, "switch.selectcmp");
4224 return Builder.CreateSelect(ValueCompare, ResultVector[0].first, SelectValue,
4225 "switch.select");
4226 }
4227
4228 return nullptr;
4229}
4230
Sanjay Patel09159b8f2015-06-24 20:40:57 +00004231// Helper function to cleanup a switch instruction that has been converted into
4232// a select, fixing up PHI nodes and basic blocks.
Marcello Maggioni5bbe3df2014-10-14 01:58:26 +00004233static void RemoveSwitchAfterSelectConversion(SwitchInst *SI, PHINode *PHI,
4234 Value *SelectValue,
4235 IRBuilder<> &Builder) {
4236 BasicBlock *SelectBB = SI->getParent();
4237 while (PHI->getBasicBlockIndex(SelectBB) >= 0)
4238 PHI->removeIncomingValue(SelectBB);
4239 PHI->addIncoming(SelectValue, SelectBB);
4240
4241 Builder.CreateBr(PHI->getParent());
4242
4243 // Remove the switch.
4244 for (unsigned i = 0, e = SI->getNumSuccessors(); i < e; ++i) {
4245 BasicBlock *Succ = SI->getSuccessor(i);
4246
4247 if (Succ == PHI->getParent())
4248 continue;
4249 Succ->removePredecessor(SelectBB);
4250 }
4251 SI->eraseFromParent();
4252}
4253
Sanjay Patel09159b8f2015-06-24 20:40:57 +00004254/// If the switch is only used to initialize one or more
Marcello Maggioni5bbe3df2014-10-14 01:58:26 +00004255/// phi nodes in a common successor block with only two different
4256/// constant values, replace the switch with select.
4257static bool SwitchToSelect(SwitchInst *SI, IRBuilder<> &Builder,
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004258 AssumptionCache *AC, const DataLayout &DL) {
Marcello Maggioni5bbe3df2014-10-14 01:58:26 +00004259 Value *const Cond = SI->getCondition();
4260 PHINode *PHI = nullptr;
4261 BasicBlock *CommonDest = nullptr;
4262 Constant *DefaultResult;
4263 SwitchCaseResultVectorTy UniqueResults;
4264 // Collect all the cases that will deliver the same value from the switch.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004265 if (!InitializeUniqueCases(SI, PHI, CommonDest, UniqueResults, DefaultResult,
4266 DL))
Marcello Maggioni5bbe3df2014-10-14 01:58:26 +00004267 return false;
4268 // Selects choose between maximum two values.
4269 if (UniqueResults.size() != 2)
4270 return false;
4271 assert(PHI != nullptr && "PHI for value select not found");
4272
4273 Builder.SetInsertPoint(SI);
4274 Value *SelectValue = ConvertTwoCaseSwitch(
4275 UniqueResults,
4276 DefaultResult, Cond, Builder);
4277 if (SelectValue) {
4278 RemoveSwitchAfterSelectConversion(SI, PHI, SelectValue, Builder);
4279 return true;
4280 }
4281 // The switch couldn't be converted into a select.
4282 return false;
4283}
4284
Hans Wennborg776d7122012-09-26 09:34:53 +00004285namespace {
Sanjay Patel09159b8f2015-06-24 20:40:57 +00004286 /// This class represents a lookup table that can be used to replace a switch.
Hans Wennborg776d7122012-09-26 09:34:53 +00004287 class SwitchLookupTable {
4288 public:
Sanjay Patel09159b8f2015-06-24 20:40:57 +00004289 /// Create a lookup table to use as a switch replacement with the contents
4290 /// of Values, using DefaultValue to fill any holes in the table.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004291 SwitchLookupTable(
4292 Module &M, uint64_t TableSize, ConstantInt *Offset,
4293 const SmallVectorImpl<std::pair<ConstantInt *, Constant *>> &Values,
4294 Constant *DefaultValue, const DataLayout &DL);
Hans Wennborg776d7122012-09-26 09:34:53 +00004295
Sanjay Patel09159b8f2015-06-24 20:40:57 +00004296 /// Build instructions with Builder to retrieve the value at
Hans Wennborg776d7122012-09-26 09:34:53 +00004297 /// the position given by Index in the lookup table.
Manman Ren4d189fb2014-07-24 21:13:20 +00004298 Value *BuildLookup(Value *Index, IRBuilder<> &Builder);
Hans Wennborg776d7122012-09-26 09:34:53 +00004299
Sanjay Patel09159b8f2015-06-24 20:40:57 +00004300 /// Return true if a table with TableSize elements of
Hans Wennborg39583b82012-09-26 09:44:49 +00004301 /// type ElementType would fit in a target-legal register.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004302 static bool WouldFitInRegister(const DataLayout &DL, uint64_t TableSize,
Craig Toppere3dcce92015-08-01 22:20:21 +00004303 Type *ElementType);
Hans Wennborg39583b82012-09-26 09:44:49 +00004304
Hans Wennborg776d7122012-09-26 09:34:53 +00004305 private:
4306 // Depending on the contents of the table, it can be represented in
4307 // different ways.
4308 enum {
4309 // For tables where each element contains the same value, we just have to
4310 // store that single value and return it for each lookup.
4311 SingleValueKind,
4312
Erik Eckstein105374f2014-11-17 09:13:57 +00004313 // For tables where there is a linear relationship between table index
4314 // and values. We calculate the result with a simple multiplication
4315 // and addition instead of a table lookup.
4316 LinearMapKind,
4317
Hans Wennborg39583b82012-09-26 09:44:49 +00004318 // For small tables with integer elements, we can pack them into a bitmap
4319 // that fits into a target-legal register. Values are retrieved by
4320 // shift and mask operations.
4321 BitMapKind,
4322
Hans Wennborg776d7122012-09-26 09:34:53 +00004323 // The table is stored as an array of values. Values are retrieved by load
4324 // instructions from the table.
4325 ArrayKind
4326 } Kind;
4327
4328 // For SingleValueKind, this is the single value.
4329 Constant *SingleValue;
4330
Hans Wennborg39583b82012-09-26 09:44:49 +00004331 // For BitMapKind, this is the bitmap.
4332 ConstantInt *BitMap;
4333 IntegerType *BitMapElementTy;
4334
Erik Eckstein105374f2014-11-17 09:13:57 +00004335 // For LinearMapKind, these are the constants used to derive the value.
4336 ConstantInt *LinearOffset;
4337 ConstantInt *LinearMultiplier;
4338
Hans Wennborg776d7122012-09-26 09:34:53 +00004339 // For ArrayKind, this is the array.
4340 GlobalVariable *Array;
4341 };
Alexander Kornienkof00654e2015-06-23 09:49:53 +00004342}
Hans Wennborg776d7122012-09-26 09:34:53 +00004343
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004344SwitchLookupTable::SwitchLookupTable(
4345 Module &M, uint64_t TableSize, ConstantInt *Offset,
4346 const SmallVectorImpl<std::pair<ConstantInt *, Constant *>> &Values,
4347 Constant *DefaultValue, const DataLayout &DL)
Craig Topperf40110f2014-04-25 05:29:35 +00004348 : SingleValue(nullptr), BitMap(nullptr), BitMapElementTy(nullptr),
Erik Eckstein105374f2014-11-17 09:13:57 +00004349 LinearOffset(nullptr), LinearMultiplier(nullptr), Array(nullptr) {
Hans Wennborgf2e2c102012-09-26 11:07:37 +00004350 assert(Values.size() && "Can't build lookup table without values!");
4351 assert(TableSize >= Values.size() && "Can't fit values in table!");
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004352
4353 // If all values in the table are equal, this is that value.
Hans Wennborg776d7122012-09-26 09:34:53 +00004354 SingleValue = Values.begin()->second;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004355
Hans Wennborgac114a32014-01-12 00:44:41 +00004356 Type *ValueType = Values.begin()->second->getType();
4357
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004358 // Build up the table contents.
Hans Wennborg776d7122012-09-26 09:34:53 +00004359 SmallVector<Constant*, 64> TableContents(TableSize);
4360 for (size_t I = 0, E = Values.size(); I != E; ++I) {
4361 ConstantInt *CaseVal = Values[I].first;
4362 Constant *CaseRes = Values[I].second;
Hans Wennborgac114a32014-01-12 00:44:41 +00004363 assert(CaseRes->getType() == ValueType);
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004364
Hans Wennborg776d7122012-09-26 09:34:53 +00004365 uint64_t Idx = (CaseVal->getValue() - Offset->getValue())
4366 .getLimitedValue();
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004367 TableContents[Idx] = CaseRes;
4368
Hans Wennborg776d7122012-09-26 09:34:53 +00004369 if (CaseRes != SingleValue)
Craig Topperf40110f2014-04-25 05:29:35 +00004370 SingleValue = nullptr;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004371 }
4372
4373 // Fill in any holes in the table with the default result.
Hans Wennborg776d7122012-09-26 09:34:53 +00004374 if (Values.size() < TableSize) {
Marcello Maggioni89c05ad2014-07-03 08:29:06 +00004375 assert(DefaultValue &&
4376 "Need a default value to fill the lookup table holes.");
Hans Wennborgac114a32014-01-12 00:44:41 +00004377 assert(DefaultValue->getType() == ValueType);
Hans Wennborg776d7122012-09-26 09:34:53 +00004378 for (uint64_t I = 0; I < TableSize; ++I) {
4379 if (!TableContents[I])
4380 TableContents[I] = DefaultValue;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004381 }
4382
Hans Wennborg776d7122012-09-26 09:34:53 +00004383 if (DefaultValue != SingleValue)
Craig Topperf40110f2014-04-25 05:29:35 +00004384 SingleValue = nullptr;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004385 }
4386
Hans Wennborg776d7122012-09-26 09:34:53 +00004387 // If each element in the table contains the same value, we only need to store
4388 // that single value.
4389 if (SingleValue) {
4390 Kind = SingleValueKind;
4391 return;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004392 }
4393
Erik Eckstein105374f2014-11-17 09:13:57 +00004394 // Check if we can derive the value with a linear transformation from the
4395 // table index.
4396 if (isa<IntegerType>(ValueType)) {
4397 bool LinearMappingPossible = true;
4398 APInt PrevVal;
4399 APInt DistToPrev;
4400 assert(TableSize >= 2 && "Should be a SingleValue table.");
4401 // Check if there is the same distance between two consecutive values.
4402 for (uint64_t I = 0; I < TableSize; ++I) {
4403 ConstantInt *ConstVal = dyn_cast<ConstantInt>(TableContents[I]);
4404 if (!ConstVal) {
4405 // This is an undef. We could deal with it, but undefs in lookup tables
4406 // are very seldom. It's probably not worth the additional complexity.
4407 LinearMappingPossible = false;
4408 break;
4409 }
4410 APInt Val = ConstVal->getValue();
4411 if (I != 0) {
4412 APInt Dist = Val - PrevVal;
4413 if (I == 1) {
4414 DistToPrev = Dist;
4415 } else if (Dist != DistToPrev) {
4416 LinearMappingPossible = false;
4417 break;
4418 }
4419 }
4420 PrevVal = Val;
4421 }
4422 if (LinearMappingPossible) {
4423 LinearOffset = cast<ConstantInt>(TableContents[0]);
4424 LinearMultiplier = ConstantInt::get(M.getContext(), DistToPrev);
4425 Kind = LinearMapKind;
4426 ++NumLinearMaps;
4427 return;
4428 }
4429 }
4430
Hans Wennborg39583b82012-09-26 09:44:49 +00004431 // If the type is integer and the table fits in a register, build a bitmap.
Rafael Espindola37dc9e12014-02-21 00:06:31 +00004432 if (WouldFitInRegister(DL, TableSize, ValueType)) {
Hans Wennborgac114a32014-01-12 00:44:41 +00004433 IntegerType *IT = cast<IntegerType>(ValueType);
Hans Wennborg39583b82012-09-26 09:44:49 +00004434 APInt TableInt(TableSize * IT->getBitWidth(), 0);
4435 for (uint64_t I = TableSize; I > 0; --I) {
4436 TableInt <<= IT->getBitWidth();
Benjamin Kramer9fc3dc72012-10-01 11:31:48 +00004437 // Insert values into the bitmap. Undef values are set to zero.
4438 if (!isa<UndefValue>(TableContents[I - 1])) {
4439 ConstantInt *Val = cast<ConstantInt>(TableContents[I - 1]);
4440 TableInt |= Val->getValue().zext(TableInt.getBitWidth());
4441 }
Hans Wennborg39583b82012-09-26 09:44:49 +00004442 }
4443 BitMap = ConstantInt::get(M.getContext(), TableInt);
4444 BitMapElementTy = IT;
4445 Kind = BitMapKind;
4446 ++NumBitMaps;
4447 return;
4448 }
4449
Hans Wennborg776d7122012-09-26 09:34:53 +00004450 // Store the table in an array.
Hans Wennborgac114a32014-01-12 00:44:41 +00004451 ArrayType *ArrayTy = ArrayType::get(ValueType, TableSize);
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004452 Constant *Initializer = ConstantArray::get(ArrayTy, TableContents);
4453
Hans Wennborg776d7122012-09-26 09:34:53 +00004454 Array = new GlobalVariable(M, ArrayTy, /*constant=*/ true,
4455 GlobalVariable::PrivateLinkage,
4456 Initializer,
4457 "switch.table");
4458 Array->setUnnamedAddr(true);
4459 Kind = ArrayKind;
4460}
4461
Manman Ren4d189fb2014-07-24 21:13:20 +00004462Value *SwitchLookupTable::BuildLookup(Value *Index, IRBuilder<> &Builder) {
Hans Wennborg776d7122012-09-26 09:34:53 +00004463 switch (Kind) {
4464 case SingleValueKind:
4465 return SingleValue;
Erik Eckstein105374f2014-11-17 09:13:57 +00004466 case LinearMapKind: {
4467 // Derive the result value from the input value.
4468 Value *Result = Builder.CreateIntCast(Index, LinearMultiplier->getType(),
4469 false, "switch.idx.cast");
4470 if (!LinearMultiplier->isOne())
4471 Result = Builder.CreateMul(Result, LinearMultiplier, "switch.idx.mult");
4472 if (!LinearOffset->isZero())
4473 Result = Builder.CreateAdd(Result, LinearOffset, "switch.offset");
4474 return Result;
4475 }
Hans Wennborg39583b82012-09-26 09:44:49 +00004476 case BitMapKind: {
4477 // Type of the bitmap (e.g. i59).
4478 IntegerType *MapTy = BitMap->getType();
4479
4480 // Cast Index to the same type as the bitmap.
4481 // Note: The Index is <= the number of elements in the table, so
4482 // truncating it to the width of the bitmask is safe.
Hans Wennborgcd3a11f2012-09-26 14:01:53 +00004483 Value *ShiftAmt = Builder.CreateZExtOrTrunc(Index, MapTy, "switch.cast");
Hans Wennborg39583b82012-09-26 09:44:49 +00004484
4485 // Multiply the shift amount by the element width.
4486 ShiftAmt = Builder.CreateMul(ShiftAmt,
4487 ConstantInt::get(MapTy, BitMapElementTy->getBitWidth()),
4488 "switch.shiftamt");
4489
4490 // Shift down.
4491 Value *DownShifted = Builder.CreateLShr(BitMap, ShiftAmt,
4492 "switch.downshift");
4493 // Mask off.
4494 return Builder.CreateTrunc(DownShifted, BitMapElementTy,
4495 "switch.masked");
4496 }
Hans Wennborg776d7122012-09-26 09:34:53 +00004497 case ArrayKind: {
Manman Renedc60372014-07-23 23:13:23 +00004498 // Make sure the table index will not overflow when treated as signed.
Manman Ren4d189fb2014-07-24 21:13:20 +00004499 IntegerType *IT = cast<IntegerType>(Index->getType());
4500 uint64_t TableSize = Array->getInitializer()->getType()
4501 ->getArrayNumElements();
4502 if (TableSize > (1ULL << (IT->getBitWidth() - 1)))
4503 Index = Builder.CreateZExt(Index,
4504 IntegerType::get(IT->getContext(),
4505 IT->getBitWidth() + 1),
4506 "switch.tableidx.zext");
Manman Renedc60372014-07-23 23:13:23 +00004507
Hans Wennborg776d7122012-09-26 09:34:53 +00004508 Value *GEPIndices[] = { Builder.getInt32(0), Index };
David Blaikieaa41cd52015-04-03 21:33:42 +00004509 Value *GEP = Builder.CreateInBoundsGEP(Array->getValueType(), Array,
4510 GEPIndices, "switch.gep");
Hans Wennborg776d7122012-09-26 09:34:53 +00004511 return Builder.CreateLoad(GEP, "switch.load");
4512 }
4513 }
4514 llvm_unreachable("Unknown lookup table kind!");
4515}
4516
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004517bool SwitchLookupTable::WouldFitInRegister(const DataLayout &DL,
Hans Wennborg39583b82012-09-26 09:44:49 +00004518 uint64_t TableSize,
Craig Toppere3dcce92015-08-01 22:20:21 +00004519 Type *ElementType) {
4520 auto *IT = dyn_cast<IntegerType>(ElementType);
Hans Wennborg39583b82012-09-26 09:44:49 +00004521 if (!IT)
4522 return false;
4523 // FIXME: If the type is wider than it needs to be, e.g. i8 but all values
4524 // are <= 15, we could try to narrow the type.
Benjamin Kramerc2081d12012-09-27 18:29:58 +00004525
4526 // Avoid overflow, fitsInLegalInteger uses unsigned int for the width.
4527 if (TableSize >= UINT_MAX/IT->getBitWidth())
4528 return false;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004529 return DL.fitsInLegalInteger(TableSize * IT->getBitWidth());
Hans Wennborg39583b82012-09-26 09:44:49 +00004530}
4531
Sanjay Patel09159b8f2015-06-24 20:40:57 +00004532/// Determine whether a lookup table should be built for this switch, based on
4533/// the number of cases, size of the table, and the types of the results.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004534static bool
4535ShouldBuildLookupTable(SwitchInst *SI, uint64_t TableSize,
4536 const TargetTransformInfo &TTI, const DataLayout &DL,
4537 const SmallDenseMap<PHINode *, Type *> &ResultTypes) {
Hans Wennborgf2e2c102012-09-26 11:07:37 +00004538 if (SI->getNumCases() > TableSize || TableSize >= UINT64_MAX / 10)
4539 return false; // TableSize overflowed, or mul below might overflow.
Hans Wennborg776d7122012-09-26 09:34:53 +00004540
Chandler Carruth77d433d2012-11-30 09:26:25 +00004541 bool AllTablesFitInRegister = true;
Evan Cheng65df8082012-11-30 02:02:42 +00004542 bool HasIllegalType = false;
Hans Wennborga6a11a92014-11-18 02:37:11 +00004543 for (const auto &I : ResultTypes) {
4544 Type *Ty = I.second;
Chandler Carruthd9ef81e2012-11-30 09:34:29 +00004545
4546 // Saturate this flag to true.
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00004547 HasIllegalType = HasIllegalType || !TTI.isTypeLegal(Ty);
Chandler Carruthd9ef81e2012-11-30 09:34:29 +00004548
4549 // Saturate this flag to false.
4550 AllTablesFitInRegister = AllTablesFitInRegister &&
Rafael Espindola37dc9e12014-02-21 00:06:31 +00004551 SwitchLookupTable::WouldFitInRegister(DL, TableSize, Ty);
Chandler Carruthd9ef81e2012-11-30 09:34:29 +00004552
4553 // If both flags saturate, we're done. NOTE: This *only* works with
4554 // saturating flags, and all flags have to saturate first due to the
4555 // non-deterministic behavior of iterating over a dense map.
4556 if (HasIllegalType && !AllTablesFitInRegister)
Evan Cheng65df8082012-11-30 02:02:42 +00004557 break;
Hans Wennborg39583b82012-09-26 09:44:49 +00004558 }
Evan Cheng65df8082012-11-30 02:02:42 +00004559
Chandler Carruth77d433d2012-11-30 09:26:25 +00004560 // If each table would fit in a register, we should build it anyway.
4561 if (AllTablesFitInRegister)
4562 return true;
4563
4564 // Don't build a table that doesn't fit in-register if it has illegal types.
4565 if (HasIllegalType)
4566 return false;
4567
4568 // The table density should be at least 40%. This is the same criterion as for
4569 // jump tables, see SelectionDAGBuilder::handleJTSwitchCase.
4570 // FIXME: Find the best cut-off.
4571 return SI->getNumCases() * 10 >= TableSize * 4;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004572}
4573
Erik Eckstein0d86c762014-11-27 15:13:14 +00004574/// Try to reuse the switch table index compare. Following pattern:
4575/// \code
4576/// if (idx < tablesize)
4577/// r = table[idx]; // table does not contain default_value
4578/// else
4579/// r = default_value;
4580/// if (r != default_value)
4581/// ...
4582/// \endcode
4583/// Is optimized to:
4584/// \code
4585/// cond = idx < tablesize;
4586/// if (cond)
4587/// r = table[idx];
4588/// else
4589/// r = default_value;
4590/// if (cond)
4591/// ...
4592/// \endcode
4593/// Jump threading will then eliminate the second if(cond).
4594static void reuseTableCompare(User *PhiUser, BasicBlock *PhiBlock,
4595 BranchInst *RangeCheckBranch, Constant *DefaultValue,
4596 const SmallVectorImpl<std::pair<ConstantInt*, Constant*> >& Values) {
4597
4598 ICmpInst *CmpInst = dyn_cast<ICmpInst>(PhiUser);
4599 if (!CmpInst)
4600 return;
4601
4602 // We require that the compare is in the same block as the phi so that jump
4603 // threading can do its work afterwards.
4604 if (CmpInst->getParent() != PhiBlock)
4605 return;
4606
4607 Constant *CmpOp1 = dyn_cast<Constant>(CmpInst->getOperand(1));
4608 if (!CmpOp1)
4609 return;
4610
4611 Value *RangeCmp = RangeCheckBranch->getCondition();
4612 Constant *TrueConst = ConstantInt::getTrue(RangeCmp->getType());
4613 Constant *FalseConst = ConstantInt::getFalse(RangeCmp->getType());
4614
4615 // Check if the compare with the default value is constant true or false.
4616 Constant *DefaultConst = ConstantExpr::getICmp(CmpInst->getPredicate(),
4617 DefaultValue, CmpOp1, true);
4618 if (DefaultConst != TrueConst && DefaultConst != FalseConst)
4619 return;
4620
4621 // Check if the compare with the case values is distinct from the default
4622 // compare result.
4623 for (auto ValuePair : Values) {
4624 Constant *CaseConst = ConstantExpr::getICmp(CmpInst->getPredicate(),
4625 ValuePair.second, CmpOp1, true);
4626 if (!CaseConst || CaseConst == DefaultConst)
4627 return;
4628 assert((CaseConst == TrueConst || CaseConst == FalseConst) &&
4629 "Expect true or false as compare result.");
4630 }
James Molloy4de84dd2015-11-04 15:28:04 +00004631
Erik Eckstein0d86c762014-11-27 15:13:14 +00004632 // Check if the branch instruction dominates the phi node. It's a simple
4633 // dominance check, but sufficient for our needs.
4634 // Although this check is invariant in the calling loops, it's better to do it
4635 // at this late stage. Practically we do it at most once for a switch.
4636 BasicBlock *BranchBlock = RangeCheckBranch->getParent();
4637 for (auto PI = pred_begin(PhiBlock), E = pred_end(PhiBlock); PI != E; ++PI) {
4638 BasicBlock *Pred = *PI;
4639 if (Pred != BranchBlock && Pred->getUniquePredecessor() != BranchBlock)
4640 return;
4641 }
4642
4643 if (DefaultConst == FalseConst) {
4644 // The compare yields the same result. We can replace it.
4645 CmpInst->replaceAllUsesWith(RangeCmp);
4646 ++NumTableCmpReuses;
4647 } else {
4648 // The compare yields the same result, just inverted. We can replace it.
4649 Value *InvertedTableCmp = BinaryOperator::CreateXor(RangeCmp,
4650 ConstantInt::get(RangeCmp->getType(), 1), "inverted.cmp",
4651 RangeCheckBranch);
4652 CmpInst->replaceAllUsesWith(InvertedTableCmp);
4653 ++NumTableCmpReuses;
4654 }
4655}
4656
Sanjay Patel09159b8f2015-06-24 20:40:57 +00004657/// If the switch is only used to initialize one or more phi nodes in a common
4658/// successor block with different constant values, replace the switch with
4659/// lookup tables.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004660static bool SwitchToLookupTable(SwitchInst *SI, IRBuilder<> &Builder,
4661 const DataLayout &DL,
4662 const TargetTransformInfo &TTI) {
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004663 assert(SI->getNumCases() > 1 && "Degenerate switch?");
Hans Wennborgf3254832012-10-30 11:23:25 +00004664
Hans Wennborgc3c8d952012-11-07 21:35:12 +00004665 // Only build lookup table when we have a target that supports it.
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00004666 if (!TTI.shouldBuildLookupTables())
Hans Wennborgf3254832012-10-30 11:23:25 +00004667 return false;
4668
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004669 // FIXME: If the switch is too sparse for a lookup table, perhaps we could
4670 // split off a dense part and build a lookup table for that.
4671
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004672 // FIXME: This creates arrays of GEPs to constant strings, which means each
4673 // GEP needs a runtime relocation in PIC code. We should just build one big
4674 // string and lookup indices into that.
4675
Hans Wennborg4744ac12014-01-15 05:00:27 +00004676 // Ignore switches with less than three cases. Lookup tables will not make them
4677 // faster, so we don't analyze them.
4678 if (SI->getNumCases() < 3)
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004679 return false;
4680
4681 // Figure out the corresponding result for each case value and phi node in the
Eric Christopher572e03a2015-06-19 01:53:21 +00004682 // common destination, as well as the min and max case values.
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004683 assert(SI->case_begin() != SI->case_end());
4684 SwitchInst::CaseIt CI = SI->case_begin();
4685 ConstantInt *MinCaseVal = CI.getCaseValue();
4686 ConstantInt *MaxCaseVal = CI.getCaseValue();
4687
Craig Topperf40110f2014-04-25 05:29:35 +00004688 BasicBlock *CommonDest = nullptr;
Hans Wennborg7fd5c8442012-09-10 07:44:22 +00004689 typedef SmallVector<std::pair<ConstantInt*, Constant*>, 4> ResultListTy;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004690 SmallDenseMap<PHINode*, ResultListTy> ResultLists;
4691 SmallDenseMap<PHINode*, Constant*> DefaultResults;
4692 SmallDenseMap<PHINode*, Type*> ResultTypes;
4693 SmallVector<PHINode*, 4> PHIs;
4694
4695 for (SwitchInst::CaseIt E = SI->case_end(); CI != E; ++CI) {
4696 ConstantInt *CaseVal = CI.getCaseValue();
4697 if (CaseVal->getValue().slt(MinCaseVal->getValue()))
4698 MinCaseVal = CaseVal;
4699 if (CaseVal->getValue().sgt(MaxCaseVal->getValue()))
4700 MaxCaseVal = CaseVal;
4701
4702 // Resulting value at phi nodes for this case value.
4703 typedef SmallVector<std::pair<PHINode*, Constant*>, 4> ResultsTy;
4704 ResultsTy Results;
Hans Wennborg9e74dd92012-10-31 13:42:45 +00004705 if (!GetCaseResults(SI, CaseVal, CI.getCaseSuccessor(), &CommonDest,
Rafael Espindola37dc9e12014-02-21 00:06:31 +00004706 Results, DL))
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004707 return false;
4708
4709 // Append the result from this case to the list for each phi.
Hans Wennborga6a11a92014-11-18 02:37:11 +00004710 for (const auto &I : Results) {
4711 PHINode *PHI = I.first;
4712 Constant *Value = I.second;
4713 if (!ResultLists.count(PHI))
4714 PHIs.push_back(PHI);
4715 ResultLists[PHI].push_back(std::make_pair(CaseVal, Value));
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004716 }
4717 }
4718
Hans Wennborgac114a32014-01-12 00:44:41 +00004719 // Keep track of the result types.
Hans Wennborga6a11a92014-11-18 02:37:11 +00004720 for (PHINode *PHI : PHIs) {
Hans Wennborgac114a32014-01-12 00:44:41 +00004721 ResultTypes[PHI] = ResultLists[PHI][0].second->getType();
4722 }
4723
4724 uint64_t NumResults = ResultLists[PHIs[0]].size();
4725 APInt RangeSpread = MaxCaseVal->getValue() - MinCaseVal->getValue();
4726 uint64_t TableSize = RangeSpread.getLimitedValue() + 1;
4727 bool TableHasHoles = (NumResults < TableSize);
4728
Hans Wennborgb73c0b02014-03-12 18:35:40 +00004729 // If the table has holes, we need a constant result for the default case
4730 // or a bitmask that fits in a register.
Hans Wennborg7fd5c8442012-09-10 07:44:22 +00004731 SmallVector<std::pair<PHINode*, Constant*>, 4> DefaultResultsList;
Erik Eckstein0d86c762014-11-27 15:13:14 +00004732 bool HasDefaultResults = GetCaseResults(SI, nullptr, SI->getDefaultDest(),
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004733 &CommonDest, DefaultResultsList, DL);
Hans Wennborga6a11a92014-11-18 02:37:11 +00004734
Hans Wennborgb73c0b02014-03-12 18:35:40 +00004735 bool NeedMask = (TableHasHoles && !HasDefaultResults);
4736 if (NeedMask) {
4737 // As an extra penalty for the validity test we require more cases.
4738 if (SI->getNumCases() < 4) // FIXME: Find best threshold value (benchmark).
4739 return false;
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004740 if (!DL.fitsInLegalInteger(TableSize))
Hans Wennborgb73c0b02014-03-12 18:35:40 +00004741 return false;
4742 }
Hans Wennborgac114a32014-01-12 00:44:41 +00004743
Hans Wennborga6a11a92014-11-18 02:37:11 +00004744 for (const auto &I : DefaultResultsList) {
4745 PHINode *PHI = I.first;
4746 Constant *Result = I.second;
Hans Wennborg7fd5c8442012-09-10 07:44:22 +00004747 DefaultResults[PHI] = Result;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004748 }
4749
Rafael Espindola37dc9e12014-02-21 00:06:31 +00004750 if (!ShouldBuildLookupTable(SI, TableSize, TTI, DL, ResultTypes))
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004751 return false;
4752
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004753 // Create the BB that does the lookups.
Hans Wennborg776d7122012-09-26 09:34:53 +00004754 Module &Mod = *CommonDest->getParent()->getParent();
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004755 BasicBlock *LookupBB = BasicBlock::Create(Mod.getContext(),
4756 "switch.lookup",
4757 CommonDest->getParent(),
4758 CommonDest);
4759
Michael Gottesmanc024f322013-10-20 07:04:37 +00004760 // Compute the table index value.
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004761 Builder.SetInsertPoint(SI);
4762 Value *TableIndex = Builder.CreateSub(SI->getCondition(), MinCaseVal,
4763 "switch.tableidx");
Michael Gottesmanc024f322013-10-20 07:04:37 +00004764
4765 // Compute the maximum table size representable by the integer type we are
4766 // switching upon.
Michael Gottesman63c63ac2013-10-21 05:20:11 +00004767 unsigned CaseSize = MinCaseVal->getType()->getPrimitiveSizeInBits();
Hans Wennborgac114a32014-01-12 00:44:41 +00004768 uint64_t MaxTableSize = CaseSize > 63 ? UINT64_MAX : 1ULL << CaseSize;
Michael Gottesmanc024f322013-10-20 07:04:37 +00004769 assert(MaxTableSize >= TableSize &&
4770 "It is impossible for a switch to have more entries than the max "
4771 "representable value of its input integer type's size.");
4772
Hans Wennborgb64cb272015-01-26 19:52:34 +00004773 // If the default destination is unreachable, or if the lookup table covers
4774 // all values of the conditional variable, branch directly to the lookup table
4775 // BB. Otherwise, check that the condition is within the case range.
4776 const bool DefaultIsReachable =
4777 !isa<UnreachableInst>(SI->getDefaultDest()->getFirstNonPHIOrDbg());
4778 const bool GeneratingCoveredLookupTable = (MaxTableSize == TableSize);
Erik Eckstein0d86c762014-11-27 15:13:14 +00004779 BranchInst *RangeCheckBranch = nullptr;
4780
Hans Wennborgb64cb272015-01-26 19:52:34 +00004781 if (!DefaultIsReachable || GeneratingCoveredLookupTable) {
Michael Gottesmanc024f322013-10-20 07:04:37 +00004782 Builder.CreateBr(LookupBB);
Hans Wennborg86ac6302015-04-24 20:57:56 +00004783 // Note: We call removeProdecessor later since we need to be able to get the
4784 // PHI value for the default case in case we're using a bit mask.
Michael Gottesmanc024f322013-10-20 07:04:37 +00004785 } else {
4786 Value *Cmp = Builder.CreateICmpULT(TableIndex, ConstantInt::get(
Manman Renedc60372014-07-23 23:13:23 +00004787 MinCaseVal->getType(), TableSize));
Erik Eckstein0d86c762014-11-27 15:13:14 +00004788 RangeCheckBranch = Builder.CreateCondBr(Cmp, LookupBB, SI->getDefaultDest());
Michael Gottesmanc024f322013-10-20 07:04:37 +00004789 }
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004790
4791 // Populate the BB that does the lookups.
4792 Builder.SetInsertPoint(LookupBB);
Hans Wennborgb73c0b02014-03-12 18:35:40 +00004793
4794 if (NeedMask) {
4795 // Before doing the lookup we do the hole check.
4796 // The LookupBB is therefore re-purposed to do the hole check
4797 // and we create a new LookupBB.
4798 BasicBlock *MaskBB = LookupBB;
4799 MaskBB->setName("switch.hole_check");
4800 LookupBB = BasicBlock::Create(Mod.getContext(),
4801 "switch.lookup",
4802 CommonDest->getParent(),
4803 CommonDest);
4804
Juergen Ributzkac9591e92014-11-17 19:39:56 +00004805 // Make the mask's bitwidth at least 8bit and a power-of-2 to avoid
4806 // unnecessary illegal types.
4807 uint64_t TableSizePowOf2 = NextPowerOf2(std::max(7ULL, TableSize - 1ULL));
4808 APInt MaskInt(TableSizePowOf2, 0);
4809 APInt One(TableSizePowOf2, 1);
Hans Wennborgb73c0b02014-03-12 18:35:40 +00004810 // Build bitmask; fill in a 1 bit for every case.
Hans Wennborgb73c0b02014-03-12 18:35:40 +00004811 const ResultListTy &ResultList = ResultLists[PHIs[0]];
4812 for (size_t I = 0, E = ResultList.size(); I != E; ++I) {
4813 uint64_t Idx = (ResultList[I].first->getValue() -
4814 MinCaseVal->getValue()).getLimitedValue();
4815 MaskInt |= One << Idx;
4816 }
4817 ConstantInt *TableMask = ConstantInt::get(Mod.getContext(), MaskInt);
4818
4819 // Get the TableIndex'th bit of the bitmask.
4820 // If this bit is 0 (meaning hole) jump to the default destination,
4821 // else continue with table lookup.
4822 IntegerType *MapTy = TableMask->getType();
4823 Value *MaskIndex = Builder.CreateZExtOrTrunc(TableIndex, MapTy,
4824 "switch.maskindex");
4825 Value *Shifted = Builder.CreateLShr(TableMask, MaskIndex,
4826 "switch.shifted");
4827 Value *LoBit = Builder.CreateTrunc(Shifted,
4828 Type::getInt1Ty(Mod.getContext()),
4829 "switch.lobit");
4830 Builder.CreateCondBr(LoBit, LookupBB, SI->getDefaultDest());
4831
4832 Builder.SetInsertPoint(LookupBB);
4833 AddPredecessorToBlock(SI->getDefaultDest(), MaskBB, SI->getParent());
4834 }
4835
Hans Wennborg86ac6302015-04-24 20:57:56 +00004836 if (!DefaultIsReachable || GeneratingCoveredLookupTable) {
4837 // We cached PHINodes in PHIs, to avoid accessing deleted PHINodes later,
4838 // do not delete PHINodes here.
4839 SI->getDefaultDest()->removePredecessor(SI->getParent(),
4840 /*DontDeleteUselessPHIs=*/true);
4841 }
4842
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004843 bool ReturnedEarly = false;
Hans Wennborg776d7122012-09-26 09:34:53 +00004844 for (size_t I = 0, E = PHIs.size(); I != E; ++I) {
4845 PHINode *PHI = PHIs[I];
Erik Eckstein0d86c762014-11-27 15:13:14 +00004846 const ResultListTy &ResultList = ResultLists[PHI];
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004847
Hans Wennborgb73c0b02014-03-12 18:35:40 +00004848 // If using a bitmask, use any value to fill the lookup table holes.
4849 Constant *DV = NeedMask ? ResultLists[PHI][0].second : DefaultResults[PHI];
Erik Eckstein0d86c762014-11-27 15:13:14 +00004850 SwitchLookupTable Table(Mod, TableSize, MinCaseVal, ResultList, DV, DL);
Hans Wennborg776d7122012-09-26 09:34:53 +00004851
Manman Ren4d189fb2014-07-24 21:13:20 +00004852 Value *Result = Table.BuildLookup(TableIndex, Builder);
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004853
Hans Wennborgf744fa92012-09-19 14:24:21 +00004854 // If the result is used to return immediately from the function, we want to
4855 // do that right here.
Chandler Carruthcdf47882014-03-09 03:16:01 +00004856 if (PHI->hasOneUse() && isa<ReturnInst>(*PHI->user_begin()) &&
4857 PHI->user_back() == CommonDest->getFirstNonPHIOrDbg()) {
Hans Wennborgf744fa92012-09-19 14:24:21 +00004858 Builder.CreateRet(Result);
4859 ReturnedEarly = true;
4860 break;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004861 }
4862
Erik Eckstein0d86c762014-11-27 15:13:14 +00004863 // Do a small peephole optimization: re-use the switch table compare if
4864 // possible.
4865 if (!TableHasHoles && HasDefaultResults && RangeCheckBranch) {
4866 BasicBlock *PhiBlock = PHI->getParent();
4867 // Search for compare instructions which use the phi.
4868 for (auto *User : PHI->users()) {
4869 reuseTableCompare(User, PhiBlock, RangeCheckBranch, DV, ResultList);
4870 }
4871 }
4872
Hans Wennborgf744fa92012-09-19 14:24:21 +00004873 PHI->addIncoming(Result, LookupBB);
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004874 }
4875
4876 if (!ReturnedEarly)
4877 Builder.CreateBr(CommonDest);
4878
4879 // Remove the switch.
Michael Gottesman63c63ac2013-10-21 05:20:11 +00004880 for (unsigned i = 0, e = SI->getNumSuccessors(); i < e; ++i) {
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004881 BasicBlock *Succ = SI->getSuccessor(i);
Michael Gottesmanc024f322013-10-20 07:04:37 +00004882
Michael Gottesman63c63ac2013-10-21 05:20:11 +00004883 if (Succ == SI->getDefaultDest())
Michael Gottesmanc024f322013-10-20 07:04:37 +00004884 continue;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004885 Succ->removePredecessor(SI->getParent());
4886 }
4887 SI->eraseFromParent();
4888
4889 ++NumLookupTables;
Hans Wennborgb73c0b02014-03-12 18:35:40 +00004890 if (NeedMask)
4891 ++NumLookupTablesHoles;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004892 return true;
4893}
4894
Devang Patela7ec47d2011-05-18 20:35:38 +00004895bool SimplifyCFGOpt::SimplifySwitch(SwitchInst *SI, IRBuilder<> &Builder) {
Chris Lattner25c3af32010-12-13 06:25:44 +00004896 BasicBlock *BB = SI->getParent();
4897
Jakob Stoklund Olesen977f41a2012-10-25 18:51:15 +00004898 if (isValueEqualityComparison(SI)) {
4899 // If we only have one predecessor, and if it is a branch on this value,
4900 // see if that predecessor totally determines the outcome of this switch.
4901 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
4902 if (SimplifyEqualityComparisonWithOnlyPredecessor(SI, OnlyPred, Builder))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004903 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Frits van Bommel8ae07992011-02-28 09:44:07 +00004904
Jakob Stoklund Olesen977f41a2012-10-25 18:51:15 +00004905 Value *Cond = SI->getCondition();
4906 if (SelectInst *Select = dyn_cast<SelectInst>(Cond))
4907 if (SimplifySwitchOnSelect(SI, Select))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004908 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Frits van Bommel8ae07992011-02-28 09:44:07 +00004909
Jakob Stoklund Olesen977f41a2012-10-25 18:51:15 +00004910 // If the block only contains the switch, see if we can fold the block
4911 // away into any preds.
4912 BasicBlock::iterator BBI = BB->begin();
4913 // Ignore dbg intrinsics.
4914 while (isa<DbgInfoIntrinsic>(BBI))
4915 ++BBI;
4916 if (SI == &*BBI)
4917 if (FoldValueComparisonIntoPredecessors(SI, Builder))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004918 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Jakob Stoklund Olesen977f41a2012-10-25 18:51:15 +00004919 }
Benjamin Kramerf4ea1d52011-02-02 15:56:22 +00004920
4921 // Try to transform the switch into an icmp and a branch.
Devang Patela7ec47d2011-05-18 20:35:38 +00004922 if (TurnSwitchRangeIntoICmp(SI, Builder))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004923 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Benjamin Kramerd96205c2011-05-14 15:57:25 +00004924
4925 // Remove unreachable cases.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004926 if (EliminateDeadSwitchCases(SI, AC, DL))
4927 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Benjamin Kramerd96205c2011-05-14 15:57:25 +00004928
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004929 if (SwitchToSelect(SI, Builder, AC, DL))
4930 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Marcello Maggioni5bbe3df2014-10-14 01:58:26 +00004931
Hans Wennborg4ab4a8e2011-06-18 10:28:47 +00004932 if (ForwardSwitchConditionToPHI(SI))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004933 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Hans Wennborg4ab4a8e2011-06-18 10:28:47 +00004934
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004935 if (SwitchToLookupTable(SI, Builder, DL, TTI))
4936 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Hans Wennborg8a62fc52012-09-06 09:43:28 +00004937
Chris Lattner25c3af32010-12-13 06:25:44 +00004938 return false;
4939}
4940
4941bool SimplifyCFGOpt::SimplifyIndirectBr(IndirectBrInst *IBI) {
4942 BasicBlock *BB = IBI->getParent();
4943 bool Changed = false;
Andrew Trickf3cf1932012-08-29 21:46:36 +00004944
Chris Lattner25c3af32010-12-13 06:25:44 +00004945 // Eliminate redundant destinations.
4946 SmallPtrSet<Value *, 8> Succs;
4947 for (unsigned i = 0, e = IBI->getNumDestinations(); i != e; ++i) {
4948 BasicBlock *Dest = IBI->getDestination(i);
David Blaikie70573dc2014-11-19 07:49:26 +00004949 if (!Dest->hasAddressTaken() || !Succs.insert(Dest).second) {
Chris Lattner25c3af32010-12-13 06:25:44 +00004950 Dest->removePredecessor(BB);
4951 IBI->removeDestination(i);
4952 --i; --e;
4953 Changed = true;
4954 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00004955 }
Chris Lattner25c3af32010-12-13 06:25:44 +00004956
4957 if (IBI->getNumDestinations() == 0) {
4958 // If the indirectbr has no successors, change it to unreachable.
4959 new UnreachableInst(IBI->getContext(), IBI);
4960 EraseTerminatorInstAndDCECond(IBI);
4961 return true;
4962 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00004963
Chris Lattner25c3af32010-12-13 06:25:44 +00004964 if (IBI->getNumDestinations() == 1) {
4965 // If the indirectbr has one successor, change it to a direct branch.
4966 BranchInst::Create(IBI->getDestination(0), IBI);
4967 EraseTerminatorInstAndDCECond(IBI);
4968 return true;
4969 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00004970
Chris Lattner25c3af32010-12-13 06:25:44 +00004971 if (SelectInst *SI = dyn_cast<SelectInst>(IBI->getAddress())) {
4972 if (SimplifyIndirectBrOnSelect(IBI, SI))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00004973 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Chris Lattner25c3af32010-12-13 06:25:44 +00004974 }
4975 return Changed;
4976}
4977
Philip Reames2b969d72015-03-24 22:28:45 +00004978/// Given an block with only a single landing pad and a unconditional branch
4979/// try to find another basic block which this one can be merged with. This
4980/// handles cases where we have multiple invokes with unique landing pads, but
4981/// a shared handler.
4982///
4983/// We specifically choose to not worry about merging non-empty blocks
4984/// here. That is a PRE/scheduling problem and is best solved elsewhere. In
4985/// practice, the optimizer produces empty landing pad blocks quite frequently
4986/// when dealing with exception dense code. (see: instcombine, gvn, if-else
4987/// sinking in this file)
4988///
4989/// This is primarily a code size optimization. We need to avoid performing
4990/// any transform which might inhibit optimization (such as our ability to
4991/// specialize a particular handler via tail commoning). We do this by not
4992/// merging any blocks which require us to introduce a phi. Since the same
4993/// values are flowing through both blocks, we don't loose any ability to
4994/// specialize. If anything, we make such specialization more likely.
4995///
4996/// TODO - This transformation could remove entries from a phi in the target
4997/// block when the inputs in the phi are the same for the two blocks being
4998/// merged. In some cases, this could result in removal of the PHI entirely.
4999static bool TryToMergeLandingPad(LandingPadInst *LPad, BranchInst *BI,
5000 BasicBlock *BB) {
5001 auto Succ = BB->getUniqueSuccessor();
5002 assert(Succ);
5003 // If there's a phi in the successor block, we'd likely have to introduce
5004 // a phi into the merged landing pad block.
5005 if (isa<PHINode>(*Succ->begin()))
5006 return false;
5007
5008 for (BasicBlock *OtherPred : predecessors(Succ)) {
5009 if (BB == OtherPred)
5010 continue;
5011 BasicBlock::iterator I = OtherPred->begin();
5012 LandingPadInst *LPad2 = dyn_cast<LandingPadInst>(I);
5013 if (!LPad2 || !LPad2->isIdenticalTo(LPad))
5014 continue;
5015 for (++I; isa<DbgInfoIntrinsic>(I); ++I) {}
5016 BranchInst *BI2 = dyn_cast<BranchInst>(I);
5017 if (!BI2 || !BI2->isIdenticalTo(BI))
5018 continue;
5019
David Majnemer1efa23d2016-02-20 01:07:45 +00005020 // We've found an identical block. Update our predecessors to take that
Philip Reames2b969d72015-03-24 22:28:45 +00005021 // path instead and make ourselves dead.
5022 SmallSet<BasicBlock *, 16> Preds;
5023 Preds.insert(pred_begin(BB), pred_end(BB));
5024 for (BasicBlock *Pred : Preds) {
5025 InvokeInst *II = cast<InvokeInst>(Pred->getTerminator());
5026 assert(II->getNormalDest() != BB &&
5027 II->getUnwindDest() == BB && "unexpected successor");
5028 II->setUnwindDest(OtherPred);
5029 }
5030
5031 // The debug info in OtherPred doesn't cover the merged control flow that
5032 // used to go through BB. We need to delete it or update it.
5033 for (auto I = OtherPred->begin(), E = OtherPred->end();
5034 I != E;) {
5035 Instruction &Inst = *I; I++;
5036 if (isa<DbgInfoIntrinsic>(Inst))
5037 Inst.eraseFromParent();
5038 }
5039
5040 SmallSet<BasicBlock *, 16> Succs;
5041 Succs.insert(succ_begin(BB), succ_end(BB));
5042 for (BasicBlock *Succ : Succs) {
5043 Succ->removePredecessor(BB);
5044 }
5045
5046 IRBuilder<> Builder(BI);
5047 Builder.CreateUnreachable();
5048 BI->eraseFromParent();
5049 return true;
5050 }
5051 return false;
5052}
5053
Devang Patel767f6932011-05-18 18:28:48 +00005054bool SimplifyCFGOpt::SimplifyUncondBranch(BranchInst *BI, IRBuilder<> &Builder){
Chris Lattner25c3af32010-12-13 06:25:44 +00005055 BasicBlock *BB = BI->getParent();
Andrew Trickf3cf1932012-08-29 21:46:36 +00005056
Manman Ren93ab6492012-09-20 22:37:36 +00005057 if (SinkCommon && SinkThenElseCodeToEnd(BI))
5058 return true;
5059
Chris Lattner25c3af32010-12-13 06:25:44 +00005060 // If the Terminator is the only non-phi instruction, simplify the block.
Hyojin Sung4673f102016-03-29 04:08:57 +00005061 // if LoopHeader is provided, check if the block is a loop header
5062 // (This is for early invocations before loop simplify and vectorization
5063 // to keep canonical loop forms for nested loops.
5064 // These blocks can be eliminated when the pass is invoked later
5065 // in the back-end.)
Duncan P. N. Exon Smith5b4c8372015-10-13 02:39:05 +00005066 BasicBlock::iterator I = BB->getFirstNonPHIOrDbg()->getIterator();
Chris Lattner25c3af32010-12-13 06:25:44 +00005067 if (I->isTerminator() && BB != &BB->getParent()->getEntryBlock() &&
Hans Wennborge9134892016-04-11 20:35:01 +00005068 (!LoopHeaders || !LoopHeaders->count(BB)) &&
Chris Lattner25c3af32010-12-13 06:25:44 +00005069 TryToSimplifyUncondBranchFromEmptyBlock(BB))
5070 return true;
Andrew Trickf3cf1932012-08-29 21:46:36 +00005071
Chris Lattner25c3af32010-12-13 06:25:44 +00005072 // If the only instruction in the block is a seteq/setne comparison
5073 // against a constant, try to simplify the block.
5074 if (ICmpInst *ICI = dyn_cast<ICmpInst>(I))
5075 if (ICI->isEquality() && isa<ConstantInt>(ICI->getOperand(1))) {
5076 for (++I; isa<DbgInfoIntrinsic>(I); ++I)
5077 ;
Nick Lewyckye87d54c2011-12-26 20:37:40 +00005078 if (I->isTerminator() &&
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005079 TryToSimplifyUncondBranchWithICmpInIt(ICI, Builder, DL, TTI,
5080 BonusInstThreshold, AC))
Chris Lattner25c3af32010-12-13 06:25:44 +00005081 return true;
5082 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00005083
Philip Reames2b969d72015-03-24 22:28:45 +00005084 // See if we can merge an empty landing pad block with another which is
5085 // equivalent.
5086 if (LandingPadInst *LPad = dyn_cast<LandingPadInst>(I)) {
5087 for (++I; isa<DbgInfoIntrinsic>(I); ++I) {}
5088 if (I->isTerminator() &&
5089 TryToMergeLandingPad(LPad, BI, BB))
5090 return true;
5091 }
5092
Manman Rend33f4ef2012-06-13 05:43:29 +00005093 // If this basic block is ONLY a compare and a branch, and if a predecessor
5094 // branches to us and our successor, fold the comparison into the
5095 // predecessor and use logical operations to update the incoming value
5096 // for PHI nodes in common successor.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005097 if (FoldBranchToCommonDest(BI, BonusInstThreshold))
5098 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Chris Lattner25c3af32010-12-13 06:25:44 +00005099 return false;
5100}
5101
James Molloy4de84dd2015-11-04 15:28:04 +00005102static BasicBlock *allPredecessorsComeFromSameSource(BasicBlock *BB) {
5103 BasicBlock *PredPred = nullptr;
5104 for (auto *P : predecessors(BB)) {
5105 BasicBlock *PPred = P->getSinglePredecessor();
5106 if (!PPred || (PredPred && PredPred != PPred))
5107 return nullptr;
5108 PredPred = PPred;
5109 }
5110 return PredPred;
5111}
Chris Lattner25c3af32010-12-13 06:25:44 +00005112
Devang Patela7ec47d2011-05-18 20:35:38 +00005113bool SimplifyCFGOpt::SimplifyCondBranch(BranchInst *BI, IRBuilder<> &Builder) {
Chris Lattner25c3af32010-12-13 06:25:44 +00005114 BasicBlock *BB = BI->getParent();
Andrew Trickf3cf1932012-08-29 21:46:36 +00005115
Chris Lattner25c3af32010-12-13 06:25:44 +00005116 // Conditional branch
5117 if (isValueEqualityComparison(BI)) {
5118 // If we only have one predecessor, and if it is a branch on this value,
5119 // see if that predecessor totally determines the outcome of this
5120 // switch.
5121 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
Devang Patela7ec47d2011-05-18 20:35:38 +00005122 if (SimplifyEqualityComparisonWithOnlyPredecessor(BI, OnlyPred, Builder))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005123 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Andrew Trickf3cf1932012-08-29 21:46:36 +00005124
Chris Lattner25c3af32010-12-13 06:25:44 +00005125 // This block must be empty, except for the setcond inst, if it exists.
5126 // Ignore dbg intrinsics.
5127 BasicBlock::iterator I = BB->begin();
5128 // Ignore dbg intrinsics.
5129 while (isa<DbgInfoIntrinsic>(I))
5130 ++I;
5131 if (&*I == BI) {
Devang Patel58380552011-05-18 20:53:17 +00005132 if (FoldValueComparisonIntoPredecessors(BI, Builder))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005133 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Chris Lattner25c3af32010-12-13 06:25:44 +00005134 } else if (&*I == cast<Instruction>(BI->getCondition())){
5135 ++I;
5136 // Ignore dbg intrinsics.
5137 while (isa<DbgInfoIntrinsic>(I))
5138 ++I;
Devang Patel58380552011-05-18 20:53:17 +00005139 if (&*I == BI && FoldValueComparisonIntoPredecessors(BI, Builder))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005140 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Chris Lattner25c3af32010-12-13 06:25:44 +00005141 }
5142 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00005143
Chris Lattner25c3af32010-12-13 06:25:44 +00005144 // Try to turn "br (X == 0 | X == 1), T, F" into a switch instruction.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005145 if (SimplifyBranchOnICmpChain(BI, Builder, DL))
Chris Lattner25c3af32010-12-13 06:25:44 +00005146 return true;
Andrew Trickf3cf1932012-08-29 21:46:36 +00005147
Dan Gohman5ab9c0a2012-01-05 23:58:56 +00005148 // If this basic block is ONLY a compare and a branch, and if a predecessor
5149 // branches to us and one of our successors, fold the comparison into the
5150 // predecessor and use logical operations to pick the right destination.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005151 if (FoldBranchToCommonDest(BI, BonusInstThreshold))
5152 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Andrew Trickf3cf1932012-08-29 21:46:36 +00005153
Chris Lattner25c3af32010-12-13 06:25:44 +00005154 // We have a conditional branch to two blocks that are only reachable
5155 // from BI. We know that the condbr dominates the two blocks, so see if
5156 // there is any identical code in the "then" and "else" blocks. If so, we
5157 // can hoist it up to the branching block.
Craig Topperf40110f2014-04-25 05:29:35 +00005158 if (BI->getSuccessor(0)->getSinglePredecessor()) {
5159 if (BI->getSuccessor(1)->getSinglePredecessor()) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005160 if (HoistThenElseCodeToIf(BI, TTI))
5161 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Chris Lattner25c3af32010-12-13 06:25:44 +00005162 } else {
5163 // If Successor #1 has multiple preds, we may be able to conditionally
Sanjay Patel0a2ada72014-07-06 23:10:24 +00005164 // execute Successor #0 if it branches to Successor #1.
Chris Lattner25c3af32010-12-13 06:25:44 +00005165 TerminatorInst *Succ0TI = BI->getSuccessor(0)->getTerminator();
5166 if (Succ0TI->getNumSuccessors() == 1 &&
5167 Succ0TI->getSuccessor(0) == BI->getSuccessor(1))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005168 if (SpeculativelyExecuteBB(BI, BI->getSuccessor(0), TTI))
5169 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Chris Lattner25c3af32010-12-13 06:25:44 +00005170 }
Craig Topperf40110f2014-04-25 05:29:35 +00005171 } else if (BI->getSuccessor(1)->getSinglePredecessor()) {
Chris Lattner25c3af32010-12-13 06:25:44 +00005172 // If Successor #0 has multiple preds, we may be able to conditionally
Sanjay Patel0a2ada72014-07-06 23:10:24 +00005173 // execute Successor #1 if it branches to Successor #0.
Chris Lattner25c3af32010-12-13 06:25:44 +00005174 TerminatorInst *Succ1TI = BI->getSuccessor(1)->getTerminator();
5175 if (Succ1TI->getNumSuccessors() == 1 &&
5176 Succ1TI->getSuccessor(0) == BI->getSuccessor(0))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005177 if (SpeculativelyExecuteBB(BI, BI->getSuccessor(1), TTI))
5178 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Chris Lattner25c3af32010-12-13 06:25:44 +00005179 }
Andrew Trickf3cf1932012-08-29 21:46:36 +00005180
Chris Lattner25c3af32010-12-13 06:25:44 +00005181 // If this is a branch on a phi node in the current block, thread control
5182 // through this block if any PHI node entries are constants.
5183 if (PHINode *PN = dyn_cast<PHINode>(BI->getCondition()))
5184 if (PN->getParent() == BI->getParent())
Rafael Espindola37dc9e12014-02-21 00:06:31 +00005185 if (FoldCondBranchOnPHI(BI, DL))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005186 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Andrew Trickf3cf1932012-08-29 21:46:36 +00005187
Chris Lattner25c3af32010-12-13 06:25:44 +00005188 // Scan predecessor blocks for conditional branches.
Duncan P. N. Exon Smith6c990152014-07-21 17:06:51 +00005189 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
5190 if (BranchInst *PBI = dyn_cast<BranchInst>((*PI)->getTerminator()))
Chris Lattner25c3af32010-12-13 06:25:44 +00005191 if (PBI != BI && PBI->isConditional())
Philip Reamesb42db212015-10-14 22:46:19 +00005192 if (SimplifyCondBranchToCondBranch(PBI, BI, DL))
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005193 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
Chris Lattner25c3af32010-12-13 06:25:44 +00005194
James Molloy4de84dd2015-11-04 15:28:04 +00005195 // Look for diamond patterns.
5196 if (MergeCondStores)
5197 if (BasicBlock *PrevBB = allPredecessorsComeFromSameSource(BB))
5198 if (BranchInst *PBI = dyn_cast<BranchInst>(PrevBB->getTerminator()))
5199 if (PBI != BI && PBI->isConditional())
5200 if (mergeConditionalStores(PBI, BI))
5201 return SimplifyCFG(BB, TTI, BonusInstThreshold, AC) | true;
5202
Chris Lattner25c3af32010-12-13 06:25:44 +00005203 return false;
5204}
5205
Benjamin Kramerfb212a62011-08-26 01:22:29 +00005206/// Check if passing a value to an instruction will cause undefined behavior.
5207static bool passingValueIsAlwaysUndefined(Value *V, Instruction *I) {
5208 Constant *C = dyn_cast<Constant>(V);
5209 if (!C)
5210 return false;
5211
Benjamin Kramerd12e82e2012-10-04 16:11:49 +00005212 if (I->use_empty())
Benjamin Kramerfb212a62011-08-26 01:22:29 +00005213 return false;
5214
5215 if (C->isNullValue()) {
Benjamin Kramerd12e82e2012-10-04 16:11:49 +00005216 // Only look at the first use, avoid hurting compile time with long uselists
Chandler Carruthcdf47882014-03-09 03:16:01 +00005217 User *Use = *I->user_begin();
Benjamin Kramerfb212a62011-08-26 01:22:29 +00005218
5219 // Now make sure that there are no instructions in between that can alter
5220 // control flow (eg. calls)
5221 for (BasicBlock::iterator i = ++BasicBlock::iterator(I); &*i != Use; ++i)
Benjamin Kramer0655b782011-08-26 02:25:55 +00005222 if (i == I->getParent()->end() || i->mayHaveSideEffects())
Benjamin Kramerfb212a62011-08-26 01:22:29 +00005223 return false;
5224
5225 // Look through GEPs. A load from a GEP derived from NULL is still undefined
5226 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Use))
5227 if (GEP->getPointerOperand() == I)
5228 return passingValueIsAlwaysUndefined(V, GEP);
5229
5230 // Look through bitcasts.
5231 if (BitCastInst *BC = dyn_cast<BitCastInst>(Use))
5232 return passingValueIsAlwaysUndefined(V, BC);
5233
Benjamin Kramer0655b782011-08-26 02:25:55 +00005234 // Load from null is undefined.
5235 if (LoadInst *LI = dyn_cast<LoadInst>(Use))
Andrew Tricka0a5ca02013-03-07 01:03:35 +00005236 if (!LI->isVolatile())
5237 return LI->getPointerAddressSpace() == 0;
Benjamin Kramerfb212a62011-08-26 01:22:29 +00005238
Benjamin Kramer0655b782011-08-26 02:25:55 +00005239 // Store to null is undefined.
5240 if (StoreInst *SI = dyn_cast<StoreInst>(Use))
Andrew Tricka0a5ca02013-03-07 01:03:35 +00005241 if (!SI->isVolatile())
5242 return SI->getPointerAddressSpace() == 0 && SI->getPointerOperand() == I;
Benjamin Kramerfb212a62011-08-26 01:22:29 +00005243 }
5244 return false;
5245}
5246
5247/// If BB has an incoming value that will always trigger undefined behavior
Nick Lewyckye87d54c2011-12-26 20:37:40 +00005248/// (eg. null pointer dereference), remove the branch leading here.
Benjamin Kramerfb212a62011-08-26 01:22:29 +00005249static bool removeUndefIntroducingPredecessor(BasicBlock *BB) {
5250 for (BasicBlock::iterator i = BB->begin();
5251 PHINode *PHI = dyn_cast<PHINode>(i); ++i)
5252 for (unsigned i = 0, e = PHI->getNumIncomingValues(); i != e; ++i)
5253 if (passingValueIsAlwaysUndefined(PHI->getIncomingValue(i), PHI)) {
5254 TerminatorInst *T = PHI->getIncomingBlock(i)->getTerminator();
5255 IRBuilder<> Builder(T);
5256 if (BranchInst *BI = dyn_cast<BranchInst>(T)) {
5257 BB->removePredecessor(PHI->getIncomingBlock(i));
5258 // Turn uncoditional branches into unreachables and remove the dead
5259 // destination from conditional branches.
5260 if (BI->isUnconditional())
5261 Builder.CreateUnreachable();
5262 else
5263 Builder.CreateBr(BI->getSuccessor(0) == BB ? BI->getSuccessor(1) :
5264 BI->getSuccessor(0));
5265 BI->eraseFromParent();
5266 return true;
5267 }
5268 // TODO: SwitchInst.
5269 }
5270
5271 return false;
5272}
5273
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +00005274bool SimplifyCFGOpt::run(BasicBlock *BB) {
Chris Lattner3f5823f2003-08-24 18:36:16 +00005275 bool Changed = false;
Chris Lattner466a0492002-05-21 20:50:24 +00005276
Chris Lattnerd7beca32010-12-14 06:17:25 +00005277 assert(BB && BB->getParent() && "Block not embedded in function!");
Chris Lattner466a0492002-05-21 20:50:24 +00005278 assert(BB->getTerminator() && "Degenerate basic block encountered!");
Chris Lattner466a0492002-05-21 20:50:24 +00005279
Dan Gohman4a63fad2010-08-14 00:29:42 +00005280 // Remove basic blocks that have no predecessors (except the entry block)...
5281 // or that just have themself as a predecessor. These are unreachable.
Ramkumar Ramachandra181233b2015-01-13 04:17:47 +00005282 if ((pred_empty(BB) &&
Chris Lattnerd7beca32010-12-14 06:17:25 +00005283 BB != &BB->getParent()->getEntryBlock()) ||
Dan Gohman4a63fad2010-08-14 00:29:42 +00005284 BB->getSinglePredecessor() == BB) {
David Majnemeree0cbbb2016-02-24 17:30:48 +00005285 DEBUG(dbgs() << "Removing BB: \n" << *BB);
5286 DeleteDeadBlock(BB);
5287 return true;
Chris Lattner466a0492002-05-21 20:50:24 +00005288 }
5289
Chris Lattner031340a2003-08-17 19:41:53 +00005290 // Check to see if we can constant propagate this terminator instruction
5291 // away...
Frits van Bommelad964552011-05-22 16:24:18 +00005292 Changed |= ConstantFoldTerminator(BB, true);
Chris Lattner031340a2003-08-17 19:41:53 +00005293
Dan Gohman1a951062009-10-30 22:39:04 +00005294 // Check for and eliminate duplicate PHI nodes in this block.
5295 Changed |= EliminateDuplicatePHINodes(BB);
5296
Benjamin Kramerfb212a62011-08-26 01:22:29 +00005297 // Check for and remove branches that will always cause undefined behavior.
5298 Changed |= removeUndefIntroducingPredecessor(BB);
5299
Chris Lattner2e3832d2010-12-13 05:10:48 +00005300 // Merge basic blocks into their predecessor if there is only one distinct
5301 // pred, and if there is only one distinct successor of the predecessor, and
5302 // if there are no PHI nodes.
5303 //
5304 if (MergeBlockIntoPredecessor(BB))
5305 return true;
Andrew Trickf3cf1932012-08-29 21:46:36 +00005306
Devang Patel15ad6762011-05-18 18:01:27 +00005307 IRBuilder<> Builder(BB);
5308
Dan Gohman20af5a02008-03-11 21:53:06 +00005309 // If there is a trivial two-entry PHI node in this basic block, and we can
5310 // eliminate it, do so now.
5311 if (PHINode *PN = dyn_cast<PHINode>(BB->begin()))
5312 if (PN->getNumIncomingValues() == 2)
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005313 Changed |= FoldTwoEntryPHINode(PN, TTI, DL);
Dan Gohman20af5a02008-03-11 21:53:06 +00005314
Devang Patela7ec47d2011-05-18 20:35:38 +00005315 Builder.SetInsertPoint(BB->getTerminator());
Chris Lattner25c3af32010-12-13 06:25:44 +00005316 if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) {
Chris Lattner1d057612010-12-13 06:36:51 +00005317 if (BI->isUnconditional()) {
Devang Patel767f6932011-05-18 18:28:48 +00005318 if (SimplifyUncondBranch(BI, Builder)) return true;
Chris Lattner1d057612010-12-13 06:36:51 +00005319 } else {
Devang Patela7ec47d2011-05-18 20:35:38 +00005320 if (SimplifyCondBranch(BI, Builder)) return true;
Chris Lattner1d057612010-12-13 06:36:51 +00005321 }
5322 } else if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
Devang Pateldd14e0f2011-05-18 21:33:11 +00005323 if (SimplifyReturn(RI, Builder)) return true;
Bill Wendlingd5d95b02012-02-06 21:16:41 +00005324 } else if (ResumeInst *RI = dyn_cast<ResumeInst>(BB->getTerminator())) {
5325 if (SimplifyResume(RI, Builder)) return true;
Andrew Kaylor50e4e862015-09-04 23:39:40 +00005326 } else if (CleanupReturnInst *RI =
5327 dyn_cast<CleanupReturnInst>(BB->getTerminator())) {
5328 if (SimplifyCleanupReturn(RI)) return true;
Chris Lattner1d057612010-12-13 06:36:51 +00005329 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
Devang Patela7ec47d2011-05-18 20:35:38 +00005330 if (SimplifySwitch(SI, Builder)) return true;
Chris Lattner1d057612010-12-13 06:36:51 +00005331 } else if (UnreachableInst *UI =
5332 dyn_cast<UnreachableInst>(BB->getTerminator())) {
5333 if (SimplifyUnreachable(UI)) return true;
Chris Lattner1d057612010-12-13 06:36:51 +00005334 } else if (IndirectBrInst *IBI =
5335 dyn_cast<IndirectBrInst>(BB->getTerminator())) {
5336 if (SimplifyIndirectBr(IBI)) return true;
Chris Lattnere42732e2004-02-16 06:35:48 +00005337 }
5338
Chris Lattner031340a2003-08-17 19:41:53 +00005339 return Changed;
Chris Lattner466a0492002-05-21 20:50:24 +00005340}
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +00005341
Sanjay Patel09159b8f2015-06-24 20:40:57 +00005342/// This function is used to do simplification of a CFG.
5343/// For example, it adjusts branches to branches to eliminate the extra hop,
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +00005344/// eliminates unreachable basic blocks, and does other "peephole" optimization
5345/// of the CFG. It returns true if a modification was made.
5346///
Chandler Carruth0b4ef9c2013-01-07 03:53:25 +00005347bool llvm::SimplifyCFG(BasicBlock *BB, const TargetTransformInfo &TTI,
Hyojin Sung4673f102016-03-29 04:08:57 +00005348 unsigned BonusInstThreshold, AssumptionCache *AC,
5349 SmallPtrSetImpl<BasicBlock *> *LoopHeaders) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +00005350 return SimplifyCFGOpt(TTI, BB->getModule()->getDataLayout(),
Hyojin Sung4673f102016-03-29 04:08:57 +00005351 BonusInstThreshold, AC, LoopHeaders).run(BB);
Jakob Stoklund Olesen916f48a2010-02-05 22:03:18 +00005352}