blob: 678652d6462eb6722780ec6f8cbd9a6c94021eaf [file] [log] [blame]
Chris Lattner18f16092004-04-19 18:07:02 +00001//===-- LoopUnswitch.cpp - Hoist loop-invariant conditionals in loop ------===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
Chris Lattner18f16092004-04-19 18:07:02 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanfd939082005-04-21 23:48:37 +00007//
Chris Lattner18f16092004-04-19 18:07:02 +00008//===----------------------------------------------------------------------===//
9//
10// This pass transforms loops that contain branches on loop-invariant conditions
11// to have multiple loops. For example, it turns the left into the right code:
12//
13// for (...) if (lic)
14// A for (...)
15// if (lic) A; B; C
16// B else
17// C for (...)
18// A; C
19//
20// This can increase the size of the code exponentially (doubling it every time
21// a loop is unswitched) so we only unswitch if the resultant code will be
22// smaller than a threshold.
23//
24// This pass expects LICM to be run before it to hoist invariant conditions out
25// of the loop, to make the unswitching opportunity obvious.
26//
27//===----------------------------------------------------------------------===//
28
29#define DEBUG_TYPE "loop-unswitch"
30#include "llvm/Transforms/Scalar.h"
31#include "llvm/Constants.h"
Reid Spencerc1030572007-01-19 21:13:56 +000032#include "llvm/DerivedTypes.h"
Chris Lattner18f16092004-04-19 18:07:02 +000033#include "llvm/Function.h"
34#include "llvm/Instructions.h"
Dan Gohman597c5e22009-10-13 20:12:23 +000035#include "llvm/Analysis/InlineCost.h"
Chris Lattner4f1f6f62010-04-20 05:33:18 +000036#include "llvm/Analysis/InstructionSimplify.h"
Chris Lattner18f16092004-04-19 18:07:02 +000037#include "llvm/Analysis/LoopInfo.h"
Devang Patel1bc89362007-03-07 00:26:10 +000038#include "llvm/Analysis/LoopPass.h"
Devang Patelcce624a2007-06-28 00:49:00 +000039#include "llvm/Analysis/Dominators.h"
Cameron Zwarich71132af2011-02-11 06:08:28 +000040#include "llvm/Analysis/ScalarEvolution.h"
Chris Lattner18f16092004-04-19 18:07:02 +000041#include "llvm/Transforms/Utils/Cloning.h"
42#include "llvm/Transforms/Utils/Local.h"
Chris Lattner81be2e92006-02-10 19:08:15 +000043#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000044#include "llvm/ADT/Statistic.h"
Devang Patelfb688d42007-02-26 20:22:50 +000045#include "llvm/ADT/SmallPtrSet.h"
Chris Lattnera3522002008-12-01 06:52:57 +000046#include "llvm/ADT/STLExtras.h"
Chris Lattnere487abb2006-02-09 20:15:48 +000047#include "llvm/Support/CommandLine.h"
Reid Spencer9133fe22007-02-05 23:32:05 +000048#include "llvm/Support/Debug.h"
Daniel Dunbarce63ffb2009-07-25 00:23:56 +000049#include "llvm/Support/raw_ostream.h"
Alkis Evlogimenos20aa4742004-09-03 18:19:51 +000050#include <algorithm>
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +000051#include <map>
Chris Lattner2f4b8982006-02-09 19:14:52 +000052#include <set>
Chris Lattner18f16092004-04-19 18:07:02 +000053using namespace llvm;
54
Chris Lattner0e5f4992006-12-19 21:40:18 +000055STATISTIC(NumBranches, "Number of branches unswitched");
56STATISTIC(NumSwitches, "Number of switches unswitched");
57STATISTIC(NumSelects , "Number of selects unswitched");
58STATISTIC(NumTrivial , "Number of unswitches that are trivial");
59STATISTIC(NumSimplify, "Number of simplifications of unswitched code");
Stepan Dyatkovskiy88c5c422012-01-11 08:40:51 +000060STATISTIC(TotalInsts, "Total number of instructions analyzed");
Chris Lattner0e5f4992006-12-19 21:40:18 +000061
Stepan Dyatkovskiy27bf5602012-01-16 20:48:04 +000062// The specific value of 100 here was chosen based only on intuition and a
Dan Gohmanb24f6c72009-10-13 17:50:43 +000063// few specific examples.
Dan Gohman844731a2008-05-13 00:00:25 +000064static cl::opt<unsigned>
65Threshold("loop-unswitch-threshold", cl::desc("Max loop size to unswitch"),
Stepan Dyatkovskiy88c5c422012-01-11 08:40:51 +000066 cl::init(100), cl::Hidden);
Chris Lattnere487abb2006-02-09 20:15:48 +000067
Dan Gohman844731a2008-05-13 00:00:25 +000068namespace {
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +000069
70 class LUAnalysisCache {
71
72 typedef DenseMap<const SwitchInst*, SmallPtrSet<const Value *, 8> >
73 UnswitchedValsMap;
74
75 typedef UnswitchedValsMap::iterator UnswitchedValsIt;
76
77 struct LoopProperties {
78 unsigned CanBeUnswitchedCount;
79 unsigned SizeEstimation;
80 UnswitchedValsMap UnswitchedVals;
81 };
82
83 // Here we use std::map instead of DenseMap, since we need to keep valid
84 // LoopProperties pointer for current loop for better performance.
85 typedef std::map<const Loop*, LoopProperties> LoopPropsMap;
86 typedef LoopPropsMap::iterator LoopPropsMapIt;
87
88 LoopPropsMap LoopsProperties;
89 UnswitchedValsMap* CurLoopInstructions;
90 LoopProperties* CurrentLoopProperties;
91
92 // Max size of code we can produce on remained iterations.
93 unsigned MaxSize;
94
95 public:
96
97 LUAnalysisCache() :
98 CurLoopInstructions(NULL), CurrentLoopProperties(NULL),
99 MaxSize(Threshold)
100 {}
101
102 // Analyze loop. Check its size, calculate is it possible to unswitch
103 // it. Returns true if we can unswitch this loop.
104 bool countLoop(const Loop* L);
105
106 // Clean all data related to given loop.
107 void forgetLoop(const Loop* L);
108
109 // Mark case value as unswitched.
110 // Since SI instruction can be partly unswitched, in order to avoid
111 // extra unswitching in cloned loops keep track all unswitched values.
112 void setUnswitched(const SwitchInst* SI, const Value* V);
113
114 // Check was this case value unswitched before or not.
115 bool isUnswitched(const SwitchInst* SI, const Value* V);
116
117 // Clone all loop-unswitch related loop properties.
118 // Redistribute unswitching quotas.
119 // Note, that new loop data is stored inside the VMap.
120 void cloneData(const Loop* NewLoop, const Loop* OldLoop,
121 const ValueToValueMapTy& VMap);
122 };
123
Chris Lattner3e8b6632009-09-02 06:11:42 +0000124 class LoopUnswitch : public LoopPass {
Chris Lattner18f16092004-04-19 18:07:02 +0000125 LoopInfo *LI; // Loop information
Devang Patel1bc89362007-03-07 00:26:10 +0000126 LPPassManager *LPM;
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000127
Devang Patel1bc89362007-03-07 00:26:10 +0000128 // LoopProcessWorklist - Used to check if second loop needs processing
129 // after RewriteLoopBodyWithConditionConstant rewrites first loop.
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000130 std::vector<Loop*> LoopProcessWorklist;
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000131
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000132 LUAnalysisCache BranchesInfo;
Devang Patel743f7e82007-06-06 00:21:03 +0000133
134 bool OptimizeForSize;
Devang Patel6f62af62007-07-30 23:07:10 +0000135 bool redoLoop;
Devang Patel5c4cd0d2007-10-05 22:29:34 +0000136
Devang Patele6962df2008-07-02 01:18:13 +0000137 Loop *currentLoop;
Devang Patel5c4cd0d2007-10-05 22:29:34 +0000138 DominatorTree *DT;
Devang Patele6962df2008-07-02 01:18:13 +0000139 BasicBlock *loopHeader;
140 BasicBlock *loopPreheader;
Devang Patel5c4cd0d2007-10-05 22:29:34 +0000141
Devang Patel1e41f6d2008-07-02 01:44:29 +0000142 // LoopBlocks contains all of the basic blocks of the loop, including the
143 // preheader of the loop, the body of the loop, and the exit blocks of the
144 // loop, in that order.
145 std::vector<BasicBlock*> LoopBlocks;
146 // NewBlocks contained cloned copy of basic blocks from LoopBlocks.
147 std::vector<BasicBlock*> NewBlocks;
Devang Patel77a01132008-07-03 17:37:52 +0000148
Chris Lattner18f16092004-04-19 18:07:02 +0000149 public:
Devang Patel19974732007-05-03 01:11:54 +0000150 static char ID; // Pass ID, replacement for typeid
Dan Gohmanc2bbfc12007-08-01 15:32:29 +0000151 explicit LoopUnswitch(bool Os = false) :
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000152 LoopPass(ID), OptimizeForSize(Os), redoLoop(false),
Chris Lattnerea109232010-08-29 17:23:19 +0000153 currentLoop(NULL), DT(NULL), loopHeader(NULL),
Owen Anderson081c34b2010-10-19 17:21:58 +0000154 loopPreheader(NULL) {
155 initializeLoopUnswitchPass(*PassRegistry::getPassRegistry());
156 }
Devang Patel794fd752007-05-01 21:15:47 +0000157
Devang Patel1bc89362007-03-07 00:26:10 +0000158 bool runOnLoop(Loop *L, LPPassManager &LPM);
Devang Patele6962df2008-07-02 01:18:13 +0000159 bool processCurrentLoop();
Chris Lattner18f16092004-04-19 18:07:02 +0000160
161 /// This transformation requires natural loop information & requires that
Chris Lattnerea109232010-08-29 17:23:19 +0000162 /// loop preheaders be inserted into the CFG.
Chris Lattner18f16092004-04-19 18:07:02 +0000163 ///
164 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
165 AU.addRequiredID(LoopSimplifyID);
Chris Lattnerf4f5f4e2006-02-09 22:15:42 +0000166 AU.addPreservedID(LoopSimplifyID);
Chris Lattner18f16092004-04-19 18:07:02 +0000167 AU.addRequired<LoopInfo>();
168 AU.addPreserved<LoopInfo>();
Owen Anderson6edf3992006-06-12 21:49:21 +0000169 AU.addRequiredID(LCSSAID);
Devang Patel15c260a2007-07-31 08:03:26 +0000170 AU.addPreservedID(LCSSAID);
Devang Patel4be7d292008-07-03 06:48:21 +0000171 AU.addPreserved<DominatorTree>();
Cameron Zwarich71132af2011-02-11 06:08:28 +0000172 AU.addPreserved<ScalarEvolution>();
Chris Lattner18f16092004-04-19 18:07:02 +0000173 }
174
175 private:
Devang Patel15c260a2007-07-31 08:03:26 +0000176
Dan Gohman5c89b522009-09-08 15:45:00 +0000177 virtual void releaseMemory() {
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000178 BranchesInfo.forgetLoop(currentLoop);
Dan Gohman5c89b522009-09-08 15:45:00 +0000179 }
180
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000181 /// RemoveLoopFromWorklist - If the specified loop is on the loop worklist,
182 /// remove it.
183 void RemoveLoopFromWorklist(Loop *L) {
184 std::vector<Loop*>::iterator I = std::find(LoopProcessWorklist.begin(),
185 LoopProcessWorklist.end(), L);
186 if (I != LoopProcessWorklist.end())
187 LoopProcessWorklist.erase(I);
188 }
Chad Rosiera816bf72011-12-22 21:10:46 +0000189
Devang Patele6962df2008-07-02 01:18:13 +0000190 void initLoopData() {
191 loopHeader = currentLoop->getHeader();
192 loopPreheader = currentLoop->getLoopPreheader();
193 }
194
Chris Lattner48a80b02008-04-21 00:25:49 +0000195 /// Split all of the edges from inside the loop to their exit blocks.
196 /// Update the appropriate Phi nodes as we do so.
Devang Patel77a01132008-07-03 17:37:52 +0000197 void SplitExitEdges(Loop *L, const SmallVector<BasicBlock *, 8> &ExitBlocks);
Devang Patel5c4cd0d2007-10-05 22:29:34 +0000198
Devang Patele6962df2008-07-02 01:18:13 +0000199 bool UnswitchIfProfitable(Value *LoopCond, Constant *Val);
Chris Lattnerf4412d82006-02-18 01:27:45 +0000200 void UnswitchTrivialCondition(Loop *L, Value *Cond, Constant *Val,
Chris Lattnerbd28e3f2006-02-22 06:37:14 +0000201 BasicBlock *ExitBlock);
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000202 void UnswitchNontrivialCondition(Value *LIC, Constant *OnVal, Loop *L);
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000203
204 void RewriteLoopBodyWithConditionConstant(Loop *L, Value *LIC,
205 Constant *Val, bool isEqual);
Devang Patelcce624a2007-06-28 00:49:00 +0000206
207 void EmitPreheaderBranchOnCondition(Value *LIC, Constant *Val,
208 BasicBlock *TrueDest,
209 BasicBlock *FalseDest,
210 Instruction *InsertPt);
211
Devang Patel15c260a2007-07-31 08:03:26 +0000212 void SimplifyCode(std::vector<Instruction*> &Worklist, Loop *L);
Chris Lattnerdb410242006-02-18 02:42:34 +0000213 void RemoveBlockIfDead(BasicBlock *BB,
Devang Patel15c260a2007-07-31 08:03:26 +0000214 std::vector<Instruction*> &Worklist, Loop *l);
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000215 void RemoveLoopFromHierarchy(Loop *L);
Devang Patele6962df2008-07-02 01:18:13 +0000216 bool IsTrivialUnswitchCondition(Value *Cond, Constant **Val = 0,
217 BasicBlock **LoopExit = 0);
218
Chris Lattner18f16092004-04-19 18:07:02 +0000219 };
Chris Lattner18f16092004-04-19 18:07:02 +0000220}
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000221
222// Analyze loop. Check its size, calculate is it possible to unswitch
223// it. Returns true if we can unswitch this loop.
224bool LUAnalysisCache::countLoop(const Loop* L) {
225
226 std::pair<LoopPropsMapIt, bool> InsertRes =
227 LoopsProperties.insert(std::make_pair(L, LoopProperties()));
228
229 LoopProperties& Props = InsertRes.first->second;
230
231 if (InsertRes.second) {
232 // New loop.
233
234 // Limit the number of instructions to avoid causing significant code
235 // expansion, and the number of basic blocks, to avoid loops with
236 // large numbers of branches which cause loop unswitching to go crazy.
237 // This is a very ad-hoc heuristic.
238
239 // FIXME: This is overly conservative because it does not take into
240 // consideration code simplification opportunities and code that can
241 // be shared by the resultant unswitched loops.
242 CodeMetrics Metrics;
243 for (Loop::block_iterator I = L->block_begin(),
244 E = L->block_end();
245 I != E; ++I)
246 Metrics.analyzeBasicBlock(*I);
247
248 Props.SizeEstimation = std::min(Metrics.NumInsts, Metrics.NumBlocks * 5);
249 Props.CanBeUnswitchedCount = MaxSize / (Props.SizeEstimation);
250 MaxSize -= Props.SizeEstimation * Props.CanBeUnswitchedCount;
251 }
252
253 if (!Props.CanBeUnswitchedCount) {
254 DEBUG(dbgs() << "NOT unswitching loop %"
255 << L->getHeader()->getName() << ", cost too high: "
256 << L->getBlocks().size() << "\n");
257
258 return false;
259 }
260
261 // Be careful. This links are good only before new loop addition.
262 CurrentLoopProperties = &Props;
263 CurLoopInstructions = &Props.UnswitchedVals;
264
265 return true;
266}
267
268// Clean all data related to given loop.
269void LUAnalysisCache::forgetLoop(const Loop* L) {
270
271 LoopPropsMapIt LIt = LoopsProperties.find(L);
272
273 if (LIt != LoopsProperties.end()) {
274 LoopProperties& Props = LIt->second;
275 MaxSize += Props.CanBeUnswitchedCount * Props.SizeEstimation;
276 LoopsProperties.erase(LIt);
277 }
278
279 CurrentLoopProperties = NULL;
280 CurLoopInstructions = NULL;
281}
282
283// Mark case value as unswitched.
284// Since SI instruction can be partly unswitched, in order to avoid
285// extra unswitching in cloned loops keep track all unswitched values.
286void LUAnalysisCache::setUnswitched(const SwitchInst* SI, const Value* V) {
287 (*CurLoopInstructions)[SI].insert(V);
288}
289
290// Check was this case value unswitched before or not.
291bool LUAnalysisCache::isUnswitched(const SwitchInst* SI, const Value* V) {
292 return (*CurLoopInstructions)[SI].count(V);
293}
294
295// Clone all loop-unswitch related loop properties.
296// Redistribute unswitching quotas.
297// Note, that new loop data is stored inside the VMap.
298void LUAnalysisCache::cloneData(const Loop* NewLoop, const Loop* OldLoop,
299 const ValueToValueMapTy& VMap) {
300
301 LoopProperties& NewLoopProps = LoopsProperties[NewLoop];
302 LoopProperties& OldLoopProps = *CurrentLoopProperties;
303 UnswitchedValsMap& Insts = OldLoopProps.UnswitchedVals;
304
305 // Reallocate "can-be-unswitched quota"
306
307 --OldLoopProps.CanBeUnswitchedCount;
308 unsigned Quota = OldLoopProps.CanBeUnswitchedCount;
309 NewLoopProps.CanBeUnswitchedCount = Quota / 2;
310 OldLoopProps.CanBeUnswitchedCount = Quota - Quota / 2;
311
312 NewLoopProps.SizeEstimation = OldLoopProps.SizeEstimation;
313
314 // Clone unswitched values info:
315 // for new loop switches we clone info about values that was
316 // already unswitched and has redundant successors.
317 for (UnswitchedValsIt I = Insts.begin(); I != Insts.end(); ++I) {
318 const SwitchInst* OldInst = I->first;
319 Value* NewI = VMap.lookup(OldInst);
320 const SwitchInst* NewInst = cast_or_null<SwitchInst>(NewI);
321 assert(NewInst && "All instructions that are in SrcBB must be in VMap.");
322
323 NewLoopProps.UnswitchedVals[NewInst] = OldLoopProps.UnswitchedVals[OldInst];
324 }
325}
326
Dan Gohman844731a2008-05-13 00:00:25 +0000327char LoopUnswitch::ID = 0;
Owen Anderson2ab36d32010-10-12 19:48:12 +0000328INITIALIZE_PASS_BEGIN(LoopUnswitch, "loop-unswitch", "Unswitch loops",
329 false, false)
330INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
331INITIALIZE_PASS_DEPENDENCY(LoopInfo)
332INITIALIZE_PASS_DEPENDENCY(LCSSA)
Owen Anderson2ab36d32010-10-12 19:48:12 +0000333INITIALIZE_PASS_END(LoopUnswitch, "loop-unswitch", "Unswitch loops",
334 false, false)
Chris Lattner18f16092004-04-19 18:07:02 +0000335
Daniel Dunbar394f0442008-10-22 23:32:42 +0000336Pass *llvm::createLoopUnswitchPass(bool Os) {
Devang Patel743f7e82007-06-06 00:21:03 +0000337 return new LoopUnswitch(Os);
338}
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000339
340/// FindLIVLoopCondition - Cond is a condition that occurs in L. If it is
341/// invariant in the loop, or has an invariant piece, return the invariant.
342/// Otherwise, return null.
343static Value *FindLIVLoopCondition(Value *Cond, Loop *L, bool &Changed) {
Stepan Dyatkovskiy88c5c422012-01-11 08:40:51 +0000344
345 // We started analyze new instruction, increment scanned instructions counter.
346 ++TotalInsts;
347
Chris Lattner3d606bb2010-02-02 02:26:54 +0000348 // We can never unswitch on vector conditions.
Duncan Sands1df98592010-02-16 11:11:14 +0000349 if (Cond->getType()->isVectorTy())
Chris Lattner3d606bb2010-02-02 02:26:54 +0000350 return 0;
351
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000352 // Constants should be folded, not unswitched on!
Dan Gohmana1fcd772008-10-17 00:56:52 +0000353 if (isa<Constant>(Cond)) return 0;
Devang Patel558f1b82007-06-28 00:44:10 +0000354
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000355 // TODO: Handle: br (VARIANT|INVARIANT).
Devang Patel265ca5d2008-11-03 19:38:07 +0000356
Dan Gohman0df6e092009-07-14 01:37:59 +0000357 // Hoist simple values out.
Dan Gohmanbdc017e2009-07-15 01:25:43 +0000358 if (L->makeLoopInvariant(Cond, Changed))
Dan Gohman0df6e092009-07-14 01:37:59 +0000359 return Cond;
Dan Gohman0df6e092009-07-14 01:37:59 +0000360
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000361 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Cond))
362 if (BO->getOpcode() == Instruction::And ||
363 BO->getOpcode() == Instruction::Or) {
364 // If either the left or right side is invariant, we can unswitch on this,
365 // which will cause the branch to go away in one loop and the condition to
366 // simplify in the other one.
367 if (Value *LHS = FindLIVLoopCondition(BO->getOperand(0), L, Changed))
368 return LHS;
369 if (Value *RHS = FindLIVLoopCondition(BO->getOperand(1), L, Changed))
370 return RHS;
371 }
Devang Patel5c4cd0d2007-10-05 22:29:34 +0000372
373 return 0;
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000374}
375
Devang Patel1bc89362007-03-07 00:26:10 +0000376bool LoopUnswitch::runOnLoop(Loop *L, LPPassManager &LPM_Ref) {
Devang Patel1bc89362007-03-07 00:26:10 +0000377 LI = &getAnalysis<LoopInfo>();
378 LPM = &LPM_Ref;
Duncan Sands1465d612009-01-28 13:14:17 +0000379 DT = getAnalysisIfAvailable<DominatorTree>();
Devang Patele6962df2008-07-02 01:18:13 +0000380 currentLoop = L;
Devang Pateldeafefa2008-09-04 22:43:59 +0000381 Function *F = currentLoop->getHeader()->getParent();
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000382 bool Changed = false;
Devang Patel6f62af62007-07-30 23:07:10 +0000383 do {
Dan Gohmanbbf81d82010-03-10 19:38:49 +0000384 assert(currentLoop->isLCSSAForm(*DT));
Devang Patel6f62af62007-07-30 23:07:10 +0000385 redoLoop = false;
Devang Patele6962df2008-07-02 01:18:13 +0000386 Changed |= processCurrentLoop();
Devang Patel6f62af62007-07-30 23:07:10 +0000387 } while(redoLoop);
388
Devang Pateldeafefa2008-09-04 22:43:59 +0000389 if (Changed) {
390 // FIXME: Reconstruct dom info, because it is not preserved properly.
391 if (DT)
392 DT->runOnFunction(*F);
Devang Pateldeafefa2008-09-04 22:43:59 +0000393 }
Devang Patel6f62af62007-07-30 23:07:10 +0000394 return Changed;
395}
396
Devang Patele6962df2008-07-02 01:18:13 +0000397/// processCurrentLoop - Do actual work and unswitch loop if possible
398/// and profitable.
399bool LoopUnswitch::processCurrentLoop() {
Devang Patel6f62af62007-07-30 23:07:10 +0000400 bool Changed = false;
Stepan Dyatkovskiy88c5c422012-01-11 08:40:51 +0000401
402 initLoopData();
403
404 // If LoopSimplify was unable to form a preheader, don't do any unswitching.
405 if (!loopPreheader)
406 return false;
407
408 LLVMContext &Context = loopHeader->getContext();
409
410 // Probably we reach the quota of branches for this loop. If so
411 // stop unswitching.
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000412 if (!BranchesInfo.countLoop(currentLoop))
Stepan Dyatkovskiy88c5c422012-01-11 08:40:51 +0000413 return false;
Devang Patel6f62af62007-07-30 23:07:10 +0000414
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000415 // Loop over all of the basic blocks in the loop. If we find an interior
416 // block that is branching on a loop-invariant condition, we can unswitch this
417 // loop.
Devang Patele6962df2008-07-02 01:18:13 +0000418 for (Loop::block_iterator I = currentLoop->block_begin(),
Chris Lattner9e185802010-04-05 21:18:32 +0000419 E = currentLoop->block_end(); I != E; ++I) {
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000420 TerminatorInst *TI = (*I)->getTerminator();
421 if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
422 // If this isn't branching on an invariant condition, we can't unswitch
423 // it.
424 if (BI->isConditional()) {
425 // See if this, or some part of it, is loop invariant. If so, we can
426 // unswitch on it if we desire.
Devang Patele6962df2008-07-02 01:18:13 +0000427 Value *LoopCond = FindLIVLoopCondition(BI->getCondition(),
428 currentLoop, Changed);
429 if (LoopCond && UnswitchIfProfitable(LoopCond,
Owen Anderson5defacc2009-07-31 17:39:07 +0000430 ConstantInt::getTrue(Context))) {
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000431 ++NumBranches;
432 return true;
433 }
434 }
435 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Devang Patele6962df2008-07-02 01:18:13 +0000436 Value *LoopCond = FindLIVLoopCondition(SI->getCondition(),
437 currentLoop, Changed);
Chad Rosiera816bf72011-12-22 21:10:46 +0000438 unsigned NumCases = SI->getNumCases();
439 if (LoopCond && NumCases > 1) {
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000440 // Find a value to unswitch on:
441 // FIXME: this should chose the most expensive case!
Nick Lewycky444f2972011-06-03 06:27:15 +0000442 // FIXME: scan for a case with a non-critical edge?
Chad Rosiera816bf72011-12-22 21:10:46 +0000443 Constant *UnswitchVal = NULL;
444
Devang Patel52956922007-02-26 19:31:58 +0000445 // Do not process same value again and again.
Chad Rosiera816bf72011-12-22 21:10:46 +0000446 // At this point we have some cases already unswitched and
447 // some not yet unswitched. Let's find the first not yet unswitched one.
448 for (unsigned i = 1; i < NumCases; ++i) {
449 Constant* UnswitchValCandidate = SI->getCaseValue(i);
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000450 if (!BranchesInfo.isUnswitched(SI, UnswitchValCandidate)) {
Chad Rosiera816bf72011-12-22 21:10:46 +0000451 UnswitchVal = UnswitchValCandidate;
452 break;
453 }
454 }
455
456 if (!UnswitchVal)
Devang Patel52956922007-02-26 19:31:58 +0000457 continue;
Devang Patel52956922007-02-26 19:31:58 +0000458
Devang Patele6962df2008-07-02 01:18:13 +0000459 if (UnswitchIfProfitable(LoopCond, UnswitchVal)) {
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000460 ++NumSwitches;
461 return true;
462 }
463 }
464 }
465
466 // Scan the instructions to check for unswitchable values.
467 for (BasicBlock::iterator BBI = (*I)->begin(), E = (*I)->end();
468 BBI != E; ++BBI)
469 if (SelectInst *SI = dyn_cast<SelectInst>(BBI)) {
Devang Patele6962df2008-07-02 01:18:13 +0000470 Value *LoopCond = FindLIVLoopCondition(SI->getCondition(),
471 currentLoop, Changed);
472 if (LoopCond && UnswitchIfProfitable(LoopCond,
Owen Anderson5defacc2009-07-31 17:39:07 +0000473 ConstantInt::getTrue(Context))) {
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000474 ++NumSelects;
475 return true;
476 }
477 }
478 }
Chris Lattner18f16092004-04-19 18:07:02 +0000479 return Changed;
480}
481
Dan Gohmanb0a57212010-09-01 21:46:45 +0000482/// isTrivialLoopExitBlock - Check to see if all paths from BB exit the
483/// loop with no side effects (including infinite loops).
Chris Lattner4e132392006-02-15 22:03:36 +0000484///
Dan Gohmanb0a57212010-09-01 21:46:45 +0000485/// If true, we return true and set ExitBB to the block we
Chris Lattner4e132392006-02-15 22:03:36 +0000486/// exit through.
487///
488static bool isTrivialLoopExitBlockHelper(Loop *L, BasicBlock *BB,
489 BasicBlock *&ExitBB,
490 std::set<BasicBlock*> &Visited) {
Chris Lattner0017d482006-02-17 06:39:56 +0000491 if (!Visited.insert(BB).second) {
Nick Lewycky8a5641d2011-12-23 23:49:25 +0000492 // Already visited. Without more analysis, this could indicate an infinite
493 // loop.
Dan Gohmanb0a57212010-09-01 21:46:45 +0000494 return false;
Chris Lattner0017d482006-02-17 06:39:56 +0000495 } else if (!L->contains(BB)) {
496 // Otherwise, this is a loop exit, this is fine so long as this is the
497 // first exit.
498 if (ExitBB != 0) return false;
499 ExitBB = BB;
Edward O'Callaghan25798432009-11-25 05:38:41 +0000500 return true;
Chris Lattner0017d482006-02-17 06:39:56 +0000501 }
502
503 // Otherwise, this is an unvisited intra-loop node. Check all successors.
Chris Lattner4e132392006-02-15 22:03:36 +0000504 for (succ_iterator SI = succ_begin(BB), E = succ_end(BB); SI != E; ++SI) {
Chris Lattner0017d482006-02-17 06:39:56 +0000505 // Check to see if the successor is a trivial loop exit.
506 if (!isTrivialLoopExitBlockHelper(L, *SI, ExitBB, Visited))
507 return false;
Chris Lattner708e1a52006-02-10 02:30:37 +0000508 }
Chris Lattner4e132392006-02-15 22:03:36 +0000509
510 // Okay, everything after this looks good, check to make sure that this block
511 // doesn't include any side effects.
Chris Lattnera48654e2006-02-15 22:52:05 +0000512 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
Duncan Sands7af1c782009-05-06 06:49:50 +0000513 if (I->mayHaveSideEffects())
Chris Lattner4e132392006-02-15 22:03:36 +0000514 return false;
515
516 return true;
Chris Lattner708e1a52006-02-10 02:30:37 +0000517}
518
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000519/// isTrivialLoopExitBlock - Return true if the specified block unconditionally
520/// leads to an exit from the specified loop, and has no side-effects in the
521/// process. If so, return the block that is exited to, otherwise return null.
Chris Lattner4e132392006-02-15 22:03:36 +0000522static BasicBlock *isTrivialLoopExitBlock(Loop *L, BasicBlock *BB) {
523 std::set<BasicBlock*> Visited;
Dan Gohmanb0a57212010-09-01 21:46:45 +0000524 Visited.insert(L->getHeader()); // Branches to header make infinite loops.
Chris Lattner4e132392006-02-15 22:03:36 +0000525 BasicBlock *ExitBB = 0;
526 if (isTrivialLoopExitBlockHelper(L, BB, ExitBB, Visited))
527 return ExitBB;
528 return 0;
529}
Chris Lattner708e1a52006-02-10 02:30:37 +0000530
Chris Lattner4c41d492006-02-10 01:24:09 +0000531/// IsTrivialUnswitchCondition - Check to see if this unswitch condition is
532/// trivial: that is, that the condition controls whether or not the loop does
533/// anything at all. If this is a trivial condition, unswitching produces no
534/// code duplications (equivalently, it produces a simpler loop and a new empty
535/// loop, which gets deleted).
536///
Chris Lattnerbd28e3f2006-02-22 06:37:14 +0000537/// If this is a trivial condition, return true, otherwise return false. When
538/// returning true, this sets Cond and Val to the condition that controls the
539/// trivial condition: when Cond dynamically equals Val, the loop is known to
540/// exit. Finally, this sets LoopExit to the BB that the loop exits to when
541/// Cond == Val.
542///
Devang Patele6962df2008-07-02 01:18:13 +0000543bool LoopUnswitch::IsTrivialUnswitchCondition(Value *Cond, Constant **Val,
544 BasicBlock **LoopExit) {
545 BasicBlock *Header = currentLoop->getHeader();
Chris Lattnera48654e2006-02-15 22:52:05 +0000546 TerminatorInst *HeaderTerm = Header->getTerminator();
Owen Andersone922c022009-07-22 00:24:57 +0000547 LLVMContext &Context = Header->getContext();
Chris Lattnerbd28e3f2006-02-22 06:37:14 +0000548
Chris Lattnera48654e2006-02-15 22:52:05 +0000549 BasicBlock *LoopExitBB = 0;
550 if (BranchInst *BI = dyn_cast<BranchInst>(HeaderTerm)) {
551 // If the header block doesn't end with a conditional branch on Cond, we
552 // can't handle it.
553 if (!BI->isConditional() || BI->getCondition() != Cond)
554 return false;
Chris Lattner4c41d492006-02-10 01:24:09 +0000555
Dan Gohmanb0a57212010-09-01 21:46:45 +0000556 // Check to see if a successor of the branch is guaranteed to
557 // exit through a unique exit block without having any
Chris Lattnera48654e2006-02-15 22:52:05 +0000558 // side-effects. If so, determine the value of Cond that causes it to do
559 // this.
Devang Patele6962df2008-07-02 01:18:13 +0000560 if ((LoopExitBB = isTrivialLoopExitBlock(currentLoop,
561 BI->getSuccessor(0)))) {
Owen Anderson5defacc2009-07-31 17:39:07 +0000562 if (Val) *Val = ConstantInt::getTrue(Context);
Devang Patele6962df2008-07-02 01:18:13 +0000563 } else if ((LoopExitBB = isTrivialLoopExitBlock(currentLoop,
564 BI->getSuccessor(1)))) {
Owen Anderson5defacc2009-07-31 17:39:07 +0000565 if (Val) *Val = ConstantInt::getFalse(Context);
Chris Lattnera48654e2006-02-15 22:52:05 +0000566 }
567 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(HeaderTerm)) {
568 // If this isn't a switch on Cond, we can't handle it.
569 if (SI->getCondition() != Cond) return false;
570
571 // Check to see if a successor of the switch is guaranteed to go to the
572 // latch block or exit through a one exit block without having any
573 // side-effects. If so, determine the value of Cond that causes it to do
Chad Rosiera816bf72011-12-22 21:10:46 +0000574 // this.
575 // Note that we can't trivially unswitch on the default case or
576 // on already unswitched cases.
577 for (unsigned i = 1, e = SI->getNumSuccessors(); i != e; ++i) {
578 BasicBlock* LoopExitCandidate;
579 if ((LoopExitCandidate = isTrivialLoopExitBlock(currentLoop,
Devang Patele6962df2008-07-02 01:18:13 +0000580 SI->getSuccessor(i)))) {
Chris Lattnera48654e2006-02-15 22:52:05 +0000581 // Okay, we found a trivial case, remember the value that is trivial.
Chad Rosiera816bf72011-12-22 21:10:46 +0000582 ConstantInt* CaseVal = SI->getCaseValue(i);
583
584 // Check that it was not unswitched before, since already unswitched
585 // trivial vals are looks trivial too.
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000586 if (BranchesInfo.isUnswitched(SI, CaseVal))
Chad Rosiera816bf72011-12-22 21:10:46 +0000587 continue;
588 LoopExitBB = LoopExitCandidate;
589 if (Val) *Val = CaseVal;
Chris Lattnera48654e2006-02-15 22:52:05 +0000590 break;
591 }
Chad Rosiera816bf72011-12-22 21:10:46 +0000592 }
Chris Lattner4e132392006-02-15 22:03:36 +0000593 }
594
Chris Lattnerf8bf1162006-02-22 23:55:00 +0000595 // If we didn't find a single unique LoopExit block, or if the loop exit block
596 // contains phi nodes, this isn't trivial.
597 if (!LoopExitBB || isa<PHINode>(LoopExitBB->begin()))
Chris Lattner4e132392006-02-15 22:03:36 +0000598 return false; // Can't handle this.
Chris Lattner4c41d492006-02-10 01:24:09 +0000599
Chris Lattnera48654e2006-02-15 22:52:05 +0000600 if (LoopExit) *LoopExit = LoopExitBB;
Chris Lattner4c41d492006-02-10 01:24:09 +0000601
602 // We already know that nothing uses any scalar values defined inside of this
603 // loop. As such, we just have to check to see if this loop will execute any
604 // side-effecting instructions (e.g. stores, calls, volatile loads) in the
Chris Lattner4e132392006-02-15 22:03:36 +0000605 // part of the loop that the code *would* execute. We already checked the
606 // tail, check the header now.
Chris Lattner4c41d492006-02-10 01:24:09 +0000607 for (BasicBlock::iterator I = Header->begin(), E = Header->end(); I != E; ++I)
Duncan Sands7af1c782009-05-06 06:49:50 +0000608 if (I->mayHaveSideEffects())
Chris Lattnerdd3ee6d2006-02-10 02:01:22 +0000609 return false;
Chris Lattnerdd3ee6d2006-02-10 02:01:22 +0000610 return true;
Chris Lattner4c41d492006-02-10 01:24:09 +0000611}
612
Devang Patele6962df2008-07-02 01:18:13 +0000613/// UnswitchIfProfitable - We have found that we can unswitch currentLoop when
Chris Lattnerc2358092006-02-11 00:43:37 +0000614/// LoopCond == Val to simplify the loop. If we decide that this is profitable,
615/// unswitch the loop, reprocess the pieces, then return true.
Chris Lattner3d606bb2010-02-02 02:26:54 +0000616bool LoopUnswitch::UnswitchIfProfitable(Value *LoopCond, Constant *Val) {
Devang Patel10b359c2008-09-04 18:55:13 +0000617
Dan Gohmanf68d0c12009-12-09 22:55:01 +0000618 Function *F = loopHeader->getParent();
619
Evan Cheng02720242010-04-03 02:23:43 +0000620 Constant *CondVal = 0;
621 BasicBlock *ExitBlock = 0;
Devang Patele6962df2008-07-02 01:18:13 +0000622 if (IsTrivialUnswitchCondition(LoopCond, &CondVal, &ExitBlock)) {
Evan Cheng02720242010-04-03 02:23:43 +0000623 // If the condition is trivial, always unswitch. There is no code growth
624 // for this case.
Devang Patele6962df2008-07-02 01:18:13 +0000625 UnswitchTrivialCondition(currentLoop, LoopCond, CondVal, ExitBlock);
Evan Cheng02720242010-04-03 02:23:43 +0000626 return true;
Chris Lattnerc2358092006-02-11 00:43:37 +0000627 }
Devang Patel4be7d292008-07-03 06:48:21 +0000628
Evan Cheng02720242010-04-03 02:23:43 +0000629 // Check to see if it would be profitable to unswitch current loop.
630
631 // Do not do non-trivial unswitch while optimizing for size.
632 if (OptimizeForSize || F->hasFnAttr(Attribute::OptimizeForSize))
633 return false;
634
Evan Cheng02720242010-04-03 02:23:43 +0000635 UnswitchNontrivialCondition(LoopCond, Val, currentLoop);
Chris Lattnerc2358092006-02-11 00:43:37 +0000636 return true;
637}
638
Chris Lattner18f16092004-04-19 18:07:02 +0000639/// CloneLoop - Recursively clone the specified loop and all of its children,
640/// mapping the blocks with the specified map.
Rafael Espindola1ed219a2010-10-13 01:36:30 +0000641static Loop *CloneLoop(Loop *L, Loop *PL, ValueToValueMapTy &VM,
Devang Patel1bc89362007-03-07 00:26:10 +0000642 LoopInfo *LI, LPPassManager *LPM) {
Chris Lattner18f16092004-04-19 18:07:02 +0000643 Loop *New = new Loop();
Devang Patel1bc89362007-03-07 00:26:10 +0000644 LPM->insertLoop(New, PL);
Chris Lattner18f16092004-04-19 18:07:02 +0000645
646 // Add all of the blocks in L to the new loop.
647 for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
648 I != E; ++I)
649 if (LI->getLoopFor(*I) == L)
Owen Andersond735ee82007-11-27 03:43:35 +0000650 New->addBasicBlockToLoop(cast<BasicBlock>(VM[*I]), LI->getBase());
Chris Lattner18f16092004-04-19 18:07:02 +0000651
652 // Add all of the subloops to the new loop.
653 for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
Devang Patel1bc89362007-03-07 00:26:10 +0000654 CloneLoop(*I, New, VM, LI, LPM);
Misha Brukmanfd939082005-04-21 23:48:37 +0000655
Chris Lattner18f16092004-04-19 18:07:02 +0000656 return New;
657}
658
Chris Lattnerfed5d9d2006-02-15 00:07:43 +0000659/// EmitPreheaderBranchOnCondition - Emit a conditional branch on two values
660/// if LIC == Val, branch to TrueDst, otherwise branch to FalseDest. Insert the
661/// code immediately before InsertPt.
Devang Patelcce624a2007-06-28 00:49:00 +0000662void LoopUnswitch::EmitPreheaderBranchOnCondition(Value *LIC, Constant *Val,
663 BasicBlock *TrueDest,
664 BasicBlock *FalseDest,
665 Instruction *InsertPt) {
Chris Lattnerfed5d9d2006-02-15 00:07:43 +0000666 // Insert a conditional branch on LIC to the two preheaders. The original
667 // code is the true version and the new code is the false version.
668 Value *BranchVal = LIC;
Owen Anderson1d0be152009-08-13 21:58:54 +0000669 if (!isa<ConstantInt>(Val) ||
670 Val->getType() != Type::getInt1Ty(LIC->getContext()))
Benjamin Kramera9390a42011-09-27 20:39:19 +0000671 BranchVal = new ICmpInst(InsertPt, ICmpInst::ICMP_EQ, LIC, Val);
Owen Anderson5defacc2009-07-31 17:39:07 +0000672 else if (Val != ConstantInt::getTrue(Val->getContext()))
Chris Lattnerfed5d9d2006-02-15 00:07:43 +0000673 // We want to enter the new loop when the condition is true.
674 std::swap(TrueDest, FalseDest);
Chris Lattnerfed5d9d2006-02-15 00:07:43 +0000675
676 // Insert the new branch.
Dan Gohman5c89b522009-09-08 15:45:00 +0000677 BranchInst *BI = BranchInst::Create(TrueDest, FalseDest, BranchVal, InsertPt);
678
679 // If either edge is critical, split it. This helps preserve LoopSimplify
680 // form for enclosing loops.
681 SplitCriticalEdge(BI, 0, this);
682 SplitCriticalEdge(BI, 1, this);
Chris Lattnerfed5d9d2006-02-15 00:07:43 +0000683}
684
Chris Lattner4c41d492006-02-10 01:24:09 +0000685/// UnswitchTrivialCondition - Given a loop that has a trivial unswitchable
686/// condition in it (a cond branch from its header block to its latch block,
687/// where the path through the loop that doesn't execute its body has no
688/// side-effects), unswitch it. This doesn't involve any code duplication, just
689/// moving the conditional branch outside of the loop and updating loop info.
690void LoopUnswitch::UnswitchTrivialCondition(Loop *L, Value *Cond,
Chris Lattnerbd28e3f2006-02-22 06:37:14 +0000691 Constant *Val,
Chris Lattnerdd3ee6d2006-02-10 02:01:22 +0000692 BasicBlock *ExitBlock) {
David Greened4c56fb2010-01-05 01:27:04 +0000693 DEBUG(dbgs() << "loop-unswitch: Trivial-Unswitch loop %"
Daniel Dunbarce63ffb2009-07-25 00:23:56 +0000694 << loopHeader->getName() << " [" << L->getBlocks().size()
695 << " blocks] in Function " << L->getHeader()->getParent()->getName()
696 << " on cond: " << *Val << " == " << *Cond << "\n");
Chris Lattner4d1ca942006-02-10 01:36:35 +0000697
Chris Lattnerb2bc3152006-02-10 23:16:39 +0000698 // First step, split the preheader, so that we know that there is a safe place
Devang Patele6962df2008-07-02 01:18:13 +0000699 // to insert the conditional branch. We will change loopPreheader to have a
Chris Lattner4c41d492006-02-10 01:24:09 +0000700 // conditional branch on Cond.
Devang Patele6962df2008-07-02 01:18:13 +0000701 BasicBlock *NewPH = SplitEdge(loopPreheader, loopHeader, this);
Chris Lattner4c41d492006-02-10 01:24:09 +0000702
703 // Now that we have a place to insert the conditional branch, create a place
Chris Lattnerdd3ee6d2006-02-10 02:01:22 +0000704 // to branch to: this is the exit block out of the loop that we should
705 // short-circuit to.
Chris Lattner4c41d492006-02-10 01:24:09 +0000706
Chris Lattner4e132392006-02-15 22:03:36 +0000707 // Split this block now, so that the loop maintains its exit block, and so
708 // that the jump from the preheader can execute the contents of the exit block
709 // without actually branching to it (the exit block should be dominated by the
710 // loop header, not the preheader).
Chris Lattnerdd3ee6d2006-02-10 02:01:22 +0000711 assert(!L->contains(ExitBlock) && "Exit block is in the loop?");
Devang Patel05c1dc62007-07-06 22:03:47 +0000712 BasicBlock *NewExit = SplitBlock(ExitBlock, ExitBlock->begin(), this);
Chris Lattnerb2bc3152006-02-10 23:16:39 +0000713
Chris Lattner4c41d492006-02-10 01:24:09 +0000714 // Okay, now we have a position to branch from and a position to branch to,
715 // insert the new conditional branch.
Chris Lattnerbd28e3f2006-02-22 06:37:14 +0000716 EmitPreheaderBranchOnCondition(Cond, Val, NewExit, NewPH,
Devang Patele6962df2008-07-02 01:18:13 +0000717 loopPreheader->getTerminator());
Devang Patele6962df2008-07-02 01:18:13 +0000718 LPM->deleteSimpleAnalysisValue(loopPreheader->getTerminator(), L);
719 loopPreheader->getTerminator()->eraseFromParent();
Chris Lattner4c41d492006-02-10 01:24:09 +0000720
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000721 // We need to reprocess this loop, it could be unswitched again.
Devang Patel6f62af62007-07-30 23:07:10 +0000722 redoLoop = true;
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000723
Chris Lattner4c41d492006-02-10 01:24:09 +0000724 // Now that we know that the loop is never entered when this condition is a
725 // particular value, rewrite the loop with this info. We know that this will
726 // at least eliminate the old branch.
Chris Lattnerbd28e3f2006-02-22 06:37:14 +0000727 RewriteLoopBodyWithConditionConstant(L, Cond, Val, false);
Chris Lattner3dd4c402006-02-14 01:01:41 +0000728 ++NumTrivial;
Chris Lattner4c41d492006-02-10 01:24:09 +0000729}
730
Chris Lattner48a80b02008-04-21 00:25:49 +0000731/// SplitExitEdges - Split all of the edges from inside the loop to their exit
732/// blocks. Update the appropriate Phi nodes as we do so.
733void LoopUnswitch::SplitExitEdges(Loop *L,
Chris Lattner9e185802010-04-05 21:18:32 +0000734 const SmallVector<BasicBlock *, 8> &ExitBlocks){
Devang Patel5c4cd0d2007-10-05 22:29:34 +0000735
Chris Lattner4c41d492006-02-10 01:24:09 +0000736 for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
Chris Lattnerb2bc3152006-02-10 23:16:39 +0000737 BasicBlock *ExitBlock = ExitBlocks[i];
Dan Gohman5c89b522009-09-08 15:45:00 +0000738 SmallVector<BasicBlock *, 4> Preds(pred_begin(ExitBlock),
739 pred_end(ExitBlock));
Bill Wendlingd5520982011-09-27 00:59:31 +0000740
Nick Lewycky444f2972011-06-03 06:27:15 +0000741 // Although SplitBlockPredecessors doesn't preserve loop-simplify in
742 // general, if we call it on all predecessors of all exits then it does.
Bill Wendlingd5520982011-09-27 00:59:31 +0000743 if (!ExitBlock->isLandingPad()) {
Jakub Staszak2fac1d52011-12-09 21:19:53 +0000744 SplitBlockPredecessors(ExitBlock, Preds, ".us-lcssa", this);
Bill Wendlingd5520982011-09-27 00:59:31 +0000745 } else {
746 SmallVector<BasicBlock*, 2> NewBBs;
747 SplitLandingPadPredecessors(ExitBlock, Preds, ".us-lcssa", ".us-lcssa",
748 this, NewBBs);
749 }
Chris Lattner4c41d492006-02-10 01:24:09 +0000750 }
Devang Patelf476e8e2007-10-03 21:16:08 +0000751}
752
Devang Patelc1e26602007-10-03 21:17:43 +0000753/// UnswitchNontrivialCondition - We determined that the loop is profitable
754/// to unswitch when LIC equal Val. Split it into loop versions and test the
755/// condition outside of either loop. Return the loops created as Out1/Out2.
Devang Patelf476e8e2007-10-03 21:16:08 +0000756void LoopUnswitch::UnswitchNontrivialCondition(Value *LIC, Constant *Val,
757 Loop *L) {
Devang Patele6962df2008-07-02 01:18:13 +0000758 Function *F = loopHeader->getParent();
David Greened4c56fb2010-01-05 01:27:04 +0000759 DEBUG(dbgs() << "loop-unswitch: Unswitching loop %"
Daniel Dunbarce63ffb2009-07-25 00:23:56 +0000760 << loopHeader->getName() << " [" << L->getBlocks().size()
761 << " blocks] in Function " << F->getName()
762 << " when '" << *Val << "' == " << *LIC << "\n");
Devang Patelf476e8e2007-10-03 21:16:08 +0000763
Cameron Zwarich71132af2011-02-11 06:08:28 +0000764 if (ScalarEvolution *SE = getAnalysisIfAvailable<ScalarEvolution>())
765 SE->forgetLoop(L);
766
Devang Patel1e41f6d2008-07-02 01:44:29 +0000767 LoopBlocks.clear();
768 NewBlocks.clear();
Devang Patelf476e8e2007-10-03 21:16:08 +0000769
770 // First step, split the preheader and exit blocks, and add these blocks to
771 // the LoopBlocks list.
Devang Patele6962df2008-07-02 01:18:13 +0000772 BasicBlock *NewPreheader = SplitEdge(loopPreheader, loopHeader, this);
Devang Patelf476e8e2007-10-03 21:16:08 +0000773 LoopBlocks.push_back(NewPreheader);
774
775 // We want the loop to come after the preheader, but before the exit blocks.
776 LoopBlocks.insert(LoopBlocks.end(), L->block_begin(), L->block_end());
777
778 SmallVector<BasicBlock*, 8> ExitBlocks;
779 L->getUniqueExitBlocks(ExitBlocks);
780
781 // Split all of the edges from inside the loop to their exit blocks. Update
782 // the appropriate Phi nodes as we do so.
Devang Patel77a01132008-07-03 17:37:52 +0000783 SplitExitEdges(L, ExitBlocks);
Devang Patelf476e8e2007-10-03 21:16:08 +0000784
Chris Lattnerb2bc3152006-02-10 23:16:39 +0000785 // The exit blocks may have been changed due to edge splitting, recompute.
786 ExitBlocks.clear();
Devang Patel4b8f36f2006-08-29 22:29:16 +0000787 L->getUniqueExitBlocks(ExitBlocks);
788
Chris Lattnerb2bc3152006-02-10 23:16:39 +0000789 // Add exit blocks to the loop blocks.
790 LoopBlocks.insert(LoopBlocks.end(), ExitBlocks.begin(), ExitBlocks.end());
Chris Lattner18f16092004-04-19 18:07:02 +0000791
792 // Next step, clone all of the basic blocks that make up the loop (including
793 // the loop preheader and exit blocks), keeping track of the mapping between
794 // the instructions and blocks.
Chris Lattner18f16092004-04-19 18:07:02 +0000795 NewBlocks.reserve(LoopBlocks.size());
Rafael Espindola1ed219a2010-10-13 01:36:30 +0000796 ValueToValueMapTy VMap;
Chris Lattner18f16092004-04-19 18:07:02 +0000797 for (unsigned i = 0, e = LoopBlocks.size(); i != e; ++i) {
Devang Patele9916a32010-06-24 00:33:28 +0000798 BasicBlock *NewBB = CloneBasicBlock(LoopBlocks[i], VMap, ".us", F);
Chad Rosiera816bf72011-12-22 21:10:46 +0000799
Evan Cheng0f1666b2010-04-05 21:16:25 +0000800 NewBlocks.push_back(NewBB);
Devang Patele9916a32010-06-24 00:33:28 +0000801 VMap[LoopBlocks[i]] = NewBB; // Keep the BB mapping.
Evan Cheng0f1666b2010-04-05 21:16:25 +0000802 LPM->cloneBasicBlockSimpleAnalysis(LoopBlocks[i], NewBB, L);
Chris Lattner18f16092004-04-19 18:07:02 +0000803 }
804
805 // Splice the newly inserted blocks into the function right before the
806 // original preheader.
Evan Cheng0f1666b2010-04-05 21:16:25 +0000807 F->getBasicBlockList().splice(NewPreheader, F->getBasicBlockList(),
Chris Lattner18f16092004-04-19 18:07:02 +0000808 NewBlocks[0], F->end());
809
810 // Now we create the new Loop object for the versioned loop.
Devang Patele9916a32010-06-24 00:33:28 +0000811 Loop *NewLoop = CloneLoop(L, L->getParentLoop(), VMap, LI, LPM);
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000812
813 // Recalculate unswitching quota, inherit simplified switches info for NewBB,
814 // Probably clone more loop-unswitch related loop properties.
815 BranchesInfo.cloneData(NewLoop, L, VMap);
816
Chris Lattnere8255932006-02-10 23:26:14 +0000817 Loop *ParentLoop = L->getParentLoop();
818 if (ParentLoop) {
Chris Lattner18f16092004-04-19 18:07:02 +0000819 // Make sure to add the cloned preheader and exit blocks to the parent loop
820 // as well.
Owen Andersond735ee82007-11-27 03:43:35 +0000821 ParentLoop->addBasicBlockToLoop(NewBlocks[0], LI->getBase());
Chris Lattnere8255932006-02-10 23:26:14 +0000822 }
Bill Wendlingd5520982011-09-27 00:59:31 +0000823
Chris Lattnere8255932006-02-10 23:26:14 +0000824 for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
Devang Patele9916a32010-06-24 00:33:28 +0000825 BasicBlock *NewExit = cast<BasicBlock>(VMap[ExitBlocks[i]]);
Chris Lattner25cae0f2006-02-18 00:55:32 +0000826 // The new exit block should be in the same loop as the old one.
827 if (Loop *ExitBBLoop = LI->getLoopFor(ExitBlocks[i]))
Owen Andersond735ee82007-11-27 03:43:35 +0000828 ExitBBLoop->addBasicBlockToLoop(NewExit, LI->getBase());
Chris Lattnere8255932006-02-10 23:26:14 +0000829
830 assert(NewExit->getTerminator()->getNumSuccessors() == 1 &&
831 "Exit block should have been split to have one successor!");
832 BasicBlock *ExitSucc = NewExit->getTerminator()->getSuccessor(0);
Devang Patel77a01132008-07-03 17:37:52 +0000833
Chris Lattnere8255932006-02-10 23:26:14 +0000834 // If the successor of the exit block had PHI nodes, add an entry for
835 // NewExit.
836 PHINode *PN;
Evan Cheng0f1666b2010-04-05 21:16:25 +0000837 for (BasicBlock::iterator I = ExitSucc->begin(); isa<PHINode>(I); ++I) {
838 PN = cast<PHINode>(I);
Chris Lattnere8255932006-02-10 23:26:14 +0000839 Value *V = PN->getIncomingValueForBlock(ExitBlocks[i]);
Rafael Espindola1ed219a2010-10-13 01:36:30 +0000840 ValueToValueMapTy::iterator It = VMap.find(V);
Devang Patele9916a32010-06-24 00:33:28 +0000841 if (It != VMap.end()) V = It->second;
Chris Lattnere8255932006-02-10 23:26:14 +0000842 PN->addIncoming(V, NewExit);
843 }
Bill Wendlingd5520982011-09-27 00:59:31 +0000844
845 if (LandingPadInst *LPad = NewExit->getLandingPadInst()) {
846 PN = PHINode::Create(LPad->getType(), 0, "",
847 ExitSucc->getFirstInsertionPt());
848
849 for (pred_iterator I = pred_begin(ExitSucc), E = pred_end(ExitSucc);
850 I != E; ++I) {
851 BasicBlock *BB = *I;
852 LandingPadInst *LPI = BB->getLandingPadInst();
853 LPI->replaceAllUsesWith(PN);
854 PN->addIncoming(LPI, BB);
855 }
856 }
Chris Lattner18f16092004-04-19 18:07:02 +0000857 }
858
859 // Rewrite the code to refer to itself.
Nick Lewycky280a6e62008-04-25 16:53:59 +0000860 for (unsigned i = 0, e = NewBlocks.size(); i != e; ++i)
861 for (BasicBlock::iterator I = NewBlocks[i]->begin(),
862 E = NewBlocks[i]->end(); I != E; ++I)
Chris Lattnerb5fa5fc2011-01-08 08:15:20 +0000863 RemapInstruction(I, VMap,RF_NoModuleLevelChanges|RF_IgnoreMissingEntries);
Chris Lattner2f4b8982006-02-09 19:14:52 +0000864
Chris Lattner18f16092004-04-19 18:07:02 +0000865 // Rewrite the original preheader to select between versions of the loop.
Devang Patele6962df2008-07-02 01:18:13 +0000866 BranchInst *OldBR = cast<BranchInst>(loopPreheader->getTerminator());
Chris Lattnerfed5d9d2006-02-15 00:07:43 +0000867 assert(OldBR->isUnconditional() && OldBR->getSuccessor(0) == LoopBlocks[0] &&
Chris Lattner18f16092004-04-19 18:07:02 +0000868 "Preheader splitting did not work correctly!");
Chris Lattner18f16092004-04-19 18:07:02 +0000869
Chris Lattnerfed5d9d2006-02-15 00:07:43 +0000870 // Emit the new branch that selects between the two versions of this loop.
871 EmitPreheaderBranchOnCondition(LIC, Val, NewBlocks[0], LoopBlocks[0], OldBR);
Devang Patel15c260a2007-07-31 08:03:26 +0000872 LPM->deleteSimpleAnalysisValue(OldBR, L);
Devang Patel9ee49c52007-09-20 23:45:50 +0000873 OldBR->eraseFromParent();
Devang Patel1ff61382007-08-02 15:25:57 +0000874
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000875 LoopProcessWorklist.push_back(NewLoop);
Devang Patel6f62af62007-07-30 23:07:10 +0000876 redoLoop = true;
Chris Lattner18f16092004-04-19 18:07:02 +0000877
Chris Lattnera78130c2010-04-20 05:09:16 +0000878 // Keep a WeakVH holding onto LIC. If the first call to RewriteLoopBody
879 // deletes the instruction (for example by simplifying a PHI that feeds into
880 // the condition that we're unswitching on), we don't rewrite the second
881 // iteration.
882 WeakVH LICHandle(LIC);
883
Chris Lattner18f16092004-04-19 18:07:02 +0000884 // Now we rewrite the original code to know that the condition is true and the
885 // new code to know that the condition is false.
Evan Cheng0f1666b2010-04-05 21:16:25 +0000886 RewriteLoopBodyWithConditionConstant(L, LIC, Val, false);
Devang Patel77a01132008-07-03 17:37:52 +0000887
Chris Lattnera78130c2010-04-20 05:09:16 +0000888 // It's possible that simplifying one loop could cause the other to be
889 // changed to another value or a constant. If its a constant, don't simplify
890 // it.
891 if (!LoopProcessWorklist.empty() && LoopProcessWorklist.back() == NewLoop &&
892 LICHandle && !isa<Constant>(LICHandle))
893 RewriteLoopBodyWithConditionConstant(NewLoop, LICHandle, Val, true);
Chris Lattner18f16092004-04-19 18:07:02 +0000894}
895
Chris Lattner52221f72006-02-17 00:31:07 +0000896/// RemoveFromWorklist - Remove all instances of I from the worklist vector
897/// specified.
898static void RemoveFromWorklist(Instruction *I,
899 std::vector<Instruction*> &Worklist) {
900 std::vector<Instruction*>::iterator WI = std::find(Worklist.begin(),
901 Worklist.end(), I);
902 while (WI != Worklist.end()) {
903 unsigned Offset = WI-Worklist.begin();
904 Worklist.erase(WI);
905 WI = std::find(Worklist.begin()+Offset, Worklist.end(), I);
906 }
907}
908
909/// ReplaceUsesOfWith - When we find that I really equals V, remove I from the
910/// program, replacing all uses with V and update the worklist.
911static void ReplaceUsesOfWith(Instruction *I, Value *V,
Devang Patel15c260a2007-07-31 08:03:26 +0000912 std::vector<Instruction*> &Worklist,
913 Loop *L, LPPassManager *LPM) {
David Greened4c56fb2010-01-05 01:27:04 +0000914 DEBUG(dbgs() << "Replace with '" << *V << "': " << *I);
Chris Lattner52221f72006-02-17 00:31:07 +0000915
916 // Add uses to the worklist, which may be dead now.
917 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
918 if (Instruction *Use = dyn_cast<Instruction>(I->getOperand(i)))
919 Worklist.push_back(Use);
920
921 // Add users to the worklist which may be simplified now.
922 for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
923 UI != E; ++UI)
924 Worklist.push_back(cast<Instruction>(*UI));
Devang Patel15c260a2007-07-31 08:03:26 +0000925 LPM->deleteSimpleAnalysisValue(I, L);
Chris Lattner52221f72006-02-17 00:31:07 +0000926 RemoveFromWorklist(I, Worklist);
Devang Patel9ee49c52007-09-20 23:45:50 +0000927 I->replaceAllUsesWith(V);
928 I->eraseFromParent();
Chris Lattner52221f72006-02-17 00:31:07 +0000929 ++NumSimplify;
930}
931
Chris Lattnerdb410242006-02-18 02:42:34 +0000932/// RemoveBlockIfDead - If the specified block is dead, remove it, update loop
933/// information, and remove any dead successors it has.
934///
935void LoopUnswitch::RemoveBlockIfDead(BasicBlock *BB,
Devang Patel15c260a2007-07-31 08:03:26 +0000936 std::vector<Instruction*> &Worklist,
937 Loop *L) {
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000938 if (pred_begin(BB) != pred_end(BB)) {
939 // This block isn't dead, since an edge to BB was just removed, see if there
940 // are any easy simplifications we can do now.
941 if (BasicBlock *Pred = BB->getSinglePredecessor()) {
942 // If it has one pred, fold phi nodes in BB.
943 while (isa<PHINode>(BB->begin()))
944 ReplaceUsesOfWith(BB->begin(),
945 cast<PHINode>(BB->begin())->getIncomingValue(0),
Devang Patel15c260a2007-07-31 08:03:26 +0000946 Worklist, L, LPM);
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000947
948 // If this is the header of a loop and the only pred is the latch, we now
949 // have an unreachable loop.
950 if (Loop *L = LI->getLoopFor(BB))
Devang Patele6962df2008-07-02 01:18:13 +0000951 if (loopHeader == BB && L->contains(Pred)) {
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000952 // Remove the branch from the latch to the header block, this makes
953 // the header dead, which will make the latch dead (because the header
954 // dominates the latch).
Devang Patel15c260a2007-07-31 08:03:26 +0000955 LPM->deleteSimpleAnalysisValue(Pred->getTerminator(), L);
Devang Patel9ee49c52007-09-20 23:45:50 +0000956 Pred->getTerminator()->eraseFromParent();
Owen Anderson1d0be152009-08-13 21:58:54 +0000957 new UnreachableInst(BB->getContext(), Pred);
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000958
959 // The loop is now broken, remove it from LI.
960 RemoveLoopFromHierarchy(L);
961
962 // Reprocess the header, which now IS dead.
Devang Patel15c260a2007-07-31 08:03:26 +0000963 RemoveBlockIfDead(BB, Worklist, L);
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000964 return;
965 }
966
967 // If pred ends in a uncond branch, add uncond branch to worklist so that
968 // the two blocks will get merged.
969 if (BranchInst *BI = dyn_cast<BranchInst>(Pred->getTerminator()))
970 if (BI->isUnconditional())
971 Worklist.push_back(BI);
972 }
973 return;
974 }
Chris Lattner52221f72006-02-17 00:31:07 +0000975
David Greened4c56fb2010-01-05 01:27:04 +0000976 DEBUG(dbgs() << "Nuking dead block: " << *BB);
Chris Lattnerdb410242006-02-18 02:42:34 +0000977
978 // Remove the instructions in the basic block from the worklist.
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000979 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
Chris Lattnerdb410242006-02-18 02:42:34 +0000980 RemoveFromWorklist(I, Worklist);
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000981
982 // Anything that uses the instructions in this basic block should have their
983 // uses replaced with undefs.
Devang Patel228ebd02009-10-13 22:56:32 +0000984 // If I is not void type then replaceAllUsesWith undef.
985 // This allows ValueHandlers and custom metadata to adjust itself.
Devang Patel9674d152009-10-14 17:29:00 +0000986 if (!I->getType()->isVoidTy())
Devang Patel228ebd02009-10-13 22:56:32 +0000987 I->replaceAllUsesWith(UndefValue::get(I->getType()));
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000988 }
Chris Lattnerdb410242006-02-18 02:42:34 +0000989
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000990 // If this is the edge to the header block for a loop, remove the loop and
991 // promote all subloops.
Chris Lattnerdb410242006-02-18 02:42:34 +0000992 if (Loop *BBLoop = LI->getLoopFor(BB)) {
Evan Cheng424641e2011-05-24 23:12:57 +0000993 if (BBLoop->getLoopLatch() == BB) {
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000994 RemoveLoopFromHierarchy(BBLoop);
Evan Cheng424641e2011-05-24 23:12:57 +0000995 if (currentLoop == BBLoop) {
996 currentLoop = 0;
997 redoLoop = false;
998 }
999 }
Chris Lattnerdb410242006-02-18 02:42:34 +00001000 }
1001
1002 // Remove the block from the loop info, which removes it from any loops it
1003 // was in.
1004 LI->removeBlock(BB);
1005
1006
1007 // Remove phi node entries in successors for this block.
1008 TerminatorInst *TI = BB->getTerminator();
Chris Lattnera3522002008-12-01 06:52:57 +00001009 SmallVector<BasicBlock*, 4> Succs;
Chris Lattnerdb410242006-02-18 02:42:34 +00001010 for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i) {
1011 Succs.push_back(TI->getSuccessor(i));
1012 TI->getSuccessor(i)->removePredecessor(BB);
Chris Lattnerf4412d82006-02-18 01:27:45 +00001013 }
1014
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001015 // Unique the successors, remove anything with multiple uses.
Chris Lattnera3522002008-12-01 06:52:57 +00001016 array_pod_sort(Succs.begin(), Succs.end());
Chris Lattnerdb410242006-02-18 02:42:34 +00001017 Succs.erase(std::unique(Succs.begin(), Succs.end()), Succs.end());
1018
1019 // Remove the basic block, including all of the instructions contained in it.
Devang Patel15c260a2007-07-31 08:03:26 +00001020 LPM->deleteSimpleAnalysisValue(BB, L);
Devang Patel9ee49c52007-09-20 23:45:50 +00001021 BB->eraseFromParent();
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001022 // Remove successor blocks here that are not dead, so that we know we only
1023 // have dead blocks in this list. Nondead blocks have a way of becoming dead,
1024 // then getting removed before we revisit them, which is badness.
1025 //
1026 for (unsigned i = 0; i != Succs.size(); ++i)
1027 if (pred_begin(Succs[i]) != pred_end(Succs[i])) {
1028 // One exception is loop headers. If this block was the preheader for a
1029 // loop, then we DO want to visit the loop so the loop gets deleted.
1030 // We know that if the successor is a loop header, that this loop had to
1031 // be the preheader: the case where this was the latch block was handled
1032 // above and headers can only have two predecessors.
1033 if (!LI->isLoopHeader(Succs[i])) {
1034 Succs.erase(Succs.begin()+i);
1035 --i;
1036 }
1037 }
1038
Chris Lattnerdb410242006-02-18 02:42:34 +00001039 for (unsigned i = 0, e = Succs.size(); i != e; ++i)
Devang Patel15c260a2007-07-31 08:03:26 +00001040 RemoveBlockIfDead(Succs[i], Worklist, L);
Chris Lattnerf4412d82006-02-18 01:27:45 +00001041}
Chris Lattner52221f72006-02-17 00:31:07 +00001042
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001043/// RemoveLoopFromHierarchy - We have discovered that the specified loop has
1044/// become unwrapped, either because the backedge was deleted, or because the
1045/// edge into the header was removed. If the edge into the header from the
1046/// latch block was removed, the loop is unwrapped but subloops are still alive,
1047/// so they just reparent loops. If the loops are actually dead, they will be
1048/// removed later.
1049void LoopUnswitch::RemoveLoopFromHierarchy(Loop *L) {
Devang Patel1bc89362007-03-07 00:26:10 +00001050 LPM->deleteLoopFromQueue(L);
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001051 RemoveLoopFromWorklist(L);
1052}
1053
Chris Lattnerc2358092006-02-11 00:43:37 +00001054// RewriteLoopBodyWithConditionConstant - We know either that the value LIC has
1055// the value specified by Val in the specified loop, or we know it does NOT have
1056// that value. Rewrite any uses of LIC or of properties correlated to it.
Chris Lattner18f16092004-04-19 18:07:02 +00001057void LoopUnswitch::RewriteLoopBodyWithConditionConstant(Loop *L, Value *LIC,
Chris Lattnerc2358092006-02-11 00:43:37 +00001058 Constant *Val,
1059 bool IsEqual) {
Chris Lattner4c41d492006-02-10 01:24:09 +00001060 assert(!isa<Constant>(LIC) && "Why are we unswitching on a constant?");
Chris Lattnerc2358092006-02-11 00:43:37 +00001061
Chris Lattner18f16092004-04-19 18:07:02 +00001062 // FIXME: Support correlated properties, like:
1063 // for (...)
1064 // if (li1 < li2)
1065 // ...
1066 // if (li1 > li2)
1067 // ...
Chris Lattnerc2358092006-02-11 00:43:37 +00001068
Chris Lattner708e1a52006-02-10 02:30:37 +00001069 // FOLD boolean conditions (X|LIC), (X&LIC). Fold conditional branches,
1070 // selects, switches.
Chris Lattner52221f72006-02-17 00:31:07 +00001071 std::vector<Instruction*> Worklist;
Owen Andersone922c022009-07-22 00:24:57 +00001072 LLVMContext &Context = Val->getContext();
1073
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001074
Chris Lattner52221f72006-02-17 00:31:07 +00001075 // If we know that LIC == Val, or that LIC == NotVal, just replace uses of LIC
1076 // in the loop with the appropriate one directly.
Owen Anderson1d0be152009-08-13 21:58:54 +00001077 if (IsEqual || (isa<ConstantInt>(Val) &&
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00001078 Val->getType()->isIntegerTy(1))) {
Chris Lattnerbd28e3f2006-02-22 06:37:14 +00001079 Value *Replacement;
1080 if (IsEqual)
1081 Replacement = Val;
1082 else
Owen Anderson1d0be152009-08-13 21:58:54 +00001083 Replacement = ConstantInt::get(Type::getInt1Ty(Val->getContext()),
Reid Spencer579dca12007-01-12 04:24:46 +00001084 !cast<ConstantInt>(Val)->getZExtValue());
Chris Lattner52221f72006-02-17 00:31:07 +00001085
Evan Cheng424641e2011-05-24 23:12:57 +00001086 for (Value::use_iterator UI = LIC->use_begin(), E = LIC->use_end();
1087 UI != E; ++UI) {
Evan Cheng21d378d2011-05-24 23:47:50 +00001088 Instruction *U = dyn_cast<Instruction>(*UI);
1089 if (!U || !L->contains(U))
Evan Cheng424641e2011-05-24 23:12:57 +00001090 continue;
Evan Cheng424641e2011-05-24 23:12:57 +00001091 Worklist.push_back(U);
1092 }
Stepan Dyatkovskiybe4c8442011-11-29 20:34:39 +00001093
1094 for (std::vector<Instruction*>::iterator UI = Worklist.begin();
1095 UI != Worklist.end(); ++UI)
1096 (*UI)->replaceUsesOfWith(LIC, Replacement);
1097
Chris Lattner9e185802010-04-05 21:18:32 +00001098 SimplifyCode(Worklist, L);
1099 return;
1100 }
1101
1102 // Otherwise, we don't know the precise value of LIC, but we do know that it
1103 // is certainly NOT "Val". As such, simplify any uses in the loop that we
1104 // can. This case occurs when we unswitch switch statements.
Evan Cheng424641e2011-05-24 23:12:57 +00001105 for (Value::use_iterator UI = LIC->use_begin(), E = LIC->use_end();
1106 UI != E; ++UI) {
Evan Cheng21d378d2011-05-24 23:47:50 +00001107 Instruction *U = dyn_cast<Instruction>(*UI);
1108 if (!U || !L->contains(U))
Chris Lattner9e185802010-04-05 21:18:32 +00001109 continue;
Chris Lattner52221f72006-02-17 00:31:07 +00001110
Chris Lattner9e185802010-04-05 21:18:32 +00001111 Worklist.push_back(U);
Chris Lattner52221f72006-02-17 00:31:07 +00001112
Chris Lattner9e185802010-04-05 21:18:32 +00001113 // TODO: We could do other simplifications, for example, turning
1114 // 'icmp eq LIC, Val' -> false.
1115
1116 // If we know that LIC is not Val, use this info to simplify code.
1117 SwitchInst *SI = dyn_cast<SwitchInst>(U);
1118 if (SI == 0 || !isa<ConstantInt>(Val)) continue;
1119
1120 unsigned DeadCase = SI->findCaseValue(cast<ConstantInt>(Val));
1121 if (DeadCase == 0) continue; // Default case is live for multiple values.
1122
1123 // Found a dead case value. Don't remove PHI nodes in the
1124 // successor if they become single-entry, those PHI nodes may
1125 // be in the Users list.
Nick Lewycky444f2972011-06-03 06:27:15 +00001126
Evan Cheng424641e2011-05-24 23:12:57 +00001127 BasicBlock *Switch = SI->getParent();
1128 BasicBlock *SISucc = SI->getSuccessor(DeadCase);
1129 BasicBlock *Latch = L->getLoopLatch();
Chad Rosiera816bf72011-12-22 21:10:46 +00001130
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +00001131 BranchesInfo.setUnswitched(SI, Val);
Chad Rosiera816bf72011-12-22 21:10:46 +00001132
Nick Lewycky444f2972011-06-03 06:27:15 +00001133 if (!SI->findCaseDest(SISucc)) continue; // Edge is critical.
Evan Cheng237d10d2011-05-25 18:17:13 +00001134 // If the DeadCase successor dominates the loop latch, then the
1135 // transformation isn't safe since it will delete the sole predecessor edge
1136 // to the latch.
1137 if (Latch && DT->dominates(SISucc, Latch))
1138 continue;
Evan Cheng424641e2011-05-24 23:12:57 +00001139
Chris Lattner9e185802010-04-05 21:18:32 +00001140 // FIXME: This is a hack. We need to keep the successor around
1141 // and hooked up so as to preserve the loop structure, because
1142 // trying to update it is complicated. So instead we preserve the
1143 // loop structure and put the block on a dead code path.
Evan Cheng424641e2011-05-24 23:12:57 +00001144 SplitEdge(Switch, SISucc, this);
Chris Lattner9e185802010-04-05 21:18:32 +00001145 // Compute the successors instead of relying on the return value
1146 // of SplitEdge, since it may have split the switch successor
1147 // after PHI nodes.
1148 BasicBlock *NewSISucc = SI->getSuccessor(DeadCase);
1149 BasicBlock *OldSISucc = *succ_begin(NewSISucc);
1150 // Create an "unreachable" destination.
1151 BasicBlock *Abort = BasicBlock::Create(Context, "us-unreachable",
1152 Switch->getParent(),
1153 OldSISucc);
1154 new UnreachableInst(Context, Abort);
1155 // Force the new case destination to branch to the "unreachable"
1156 // block while maintaining a (dead) CFG edge to the old block.
1157 NewSISucc->getTerminator()->eraseFromParent();
1158 BranchInst::Create(Abort, OldSISucc,
1159 ConstantInt::getTrue(Context), NewSISucc);
1160 // Release the PHI operands for this edge.
1161 for (BasicBlock::iterator II = NewSISucc->begin();
1162 PHINode *PN = dyn_cast<PHINode>(II); ++II)
1163 PN->setIncomingValue(PN->getBasicBlockIndex(Switch),
1164 UndefValue::get(PN->getType()));
1165 // Tell the domtree about the new block. We don't fully update the
1166 // domtree here -- instead we force it to do a full recomputation
1167 // after the pass is complete -- but we do need to inform it of
1168 // new blocks.
1169 if (DT)
1170 DT->addNewBlock(Abort, NewSISucc);
Chris Lattner52221f72006-02-17 00:31:07 +00001171 }
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001172
Devang Patel15c260a2007-07-31 08:03:26 +00001173 SimplifyCode(Worklist, L);
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001174}
1175
Mike Stumpc02f0d72009-09-09 17:57:16 +00001176/// SimplifyCode - Okay, now that we have simplified some instructions in the
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001177/// loop, walk over it and constant prop, dce, and fold control flow where
1178/// possible. Note that this is effectively a very simple loop-structure-aware
1179/// optimizer. During processing of this loop, L could very well be deleted, so
1180/// it must not be used.
1181///
1182/// FIXME: When the loop optimizer is more mature, separate this out to a new
1183/// pass.
1184///
Devang Patel15c260a2007-07-31 08:03:26 +00001185void LoopUnswitch::SimplifyCode(std::vector<Instruction*> &Worklist, Loop *L) {
Chris Lattner52221f72006-02-17 00:31:07 +00001186 while (!Worklist.empty()) {
1187 Instruction *I = Worklist.back();
1188 Worklist.pop_back();
Duncan Sands0f827632010-11-23 20:24:21 +00001189
Chris Lattner52221f72006-02-17 00:31:07 +00001190 // Simple DCE.
1191 if (isInstructionTriviallyDead(I)) {
David Greened4c56fb2010-01-05 01:27:04 +00001192 DEBUG(dbgs() << "Remove dead instruction '" << *I);
Chris Lattner52221f72006-02-17 00:31:07 +00001193
1194 // Add uses to the worklist, which may be dead now.
1195 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
1196 if (Instruction *Use = dyn_cast<Instruction>(I->getOperand(i)))
1197 Worklist.push_back(Use);
Devang Patel15c260a2007-07-31 08:03:26 +00001198 LPM->deleteSimpleAnalysisValue(I, L);
Chris Lattner52221f72006-02-17 00:31:07 +00001199 RemoveFromWorklist(I, Worklist);
Devang Patel9ee49c52007-09-20 23:45:50 +00001200 I->eraseFromParent();
Chris Lattner52221f72006-02-17 00:31:07 +00001201 ++NumSimplify;
1202 continue;
1203 }
Duncan Sandsd0c6f3d2010-11-18 19:59:41 +00001204
Chris Lattner4f1f6f62010-04-20 05:33:18 +00001205 // See if instruction simplification can hack this up. This is common for
1206 // things like "select false, X, Y" after unswitching made the condition be
1207 // 'false'.
Chad Rosier618c1db2011-12-01 03:08:23 +00001208 if (Value *V = SimplifyInstruction(I, 0, 0, DT))
Duncan Sandsd0c6f3d2010-11-18 19:59:41 +00001209 if (LI->replacementPreservesLCSSAForm(I, V)) {
1210 ReplaceUsesOfWith(I, V, Worklist, L, LPM);
1211 continue;
1212 }
1213
Chris Lattner52221f72006-02-17 00:31:07 +00001214 // Special case hacks that appear commonly in unswitched code.
Chris Lattner4f1f6f62010-04-20 05:33:18 +00001215 if (BranchInst *BI = dyn_cast<BranchInst>(I)) {
Chris Lattner52221f72006-02-17 00:31:07 +00001216 if (BI->isUnconditional()) {
1217 // If BI's parent is the only pred of the successor, fold the two blocks
1218 // together.
1219 BasicBlock *Pred = BI->getParent();
1220 BasicBlock *Succ = BI->getSuccessor(0);
1221 BasicBlock *SinglePred = Succ->getSinglePredecessor();
1222 if (!SinglePred) continue; // Nothing to do.
1223 assert(SinglePred == Pred && "CFG broken");
1224
David Greened4c56fb2010-01-05 01:27:04 +00001225 DEBUG(dbgs() << "Merging blocks: " << Pred->getName() << " <- "
Daniel Dunbarce63ffb2009-07-25 00:23:56 +00001226 << Succ->getName() << "\n");
Chris Lattner52221f72006-02-17 00:31:07 +00001227
1228 // Resolve any single entry PHI nodes in Succ.
1229 while (PHINode *PN = dyn_cast<PHINode>(Succ->begin()))
Devang Patel15c260a2007-07-31 08:03:26 +00001230 ReplaceUsesOfWith(PN, PN->getIncomingValue(0), Worklist, L, LPM);
Chris Lattner52221f72006-02-17 00:31:07 +00001231
Jay Foad95c3e482011-06-23 09:09:15 +00001232 // If Succ has any successors with PHI nodes, update them to have
1233 // entries coming from Pred instead of Succ.
1234 Succ->replaceAllUsesWith(Pred);
1235
Chris Lattner52221f72006-02-17 00:31:07 +00001236 // Move all of the successor contents from Succ to Pred.
1237 Pred->getInstList().splice(BI, Succ->getInstList(), Succ->begin(),
1238 Succ->end());
Devang Patel15c260a2007-07-31 08:03:26 +00001239 LPM->deleteSimpleAnalysisValue(BI, L);
Devang Patel9ee49c52007-09-20 23:45:50 +00001240 BI->eraseFromParent();
Chris Lattner52221f72006-02-17 00:31:07 +00001241 RemoveFromWorklist(BI, Worklist);
1242
Chris Lattner52221f72006-02-17 00:31:07 +00001243 // Remove Succ from the loop tree.
1244 LI->removeBlock(Succ);
Devang Patel15c260a2007-07-31 08:03:26 +00001245 LPM->deleteSimpleAnalysisValue(Succ, L);
Devang Patel9ee49c52007-09-20 23:45:50 +00001246 Succ->eraseFromParent();
Chris Lattnerf4412d82006-02-18 01:27:45 +00001247 ++NumSimplify;
Chris Lattner4f1f6f62010-04-20 05:33:18 +00001248 continue;
Chris Lattner9e185802010-04-05 21:18:32 +00001249 }
1250
1251 if (ConstantInt *CB = dyn_cast<ConstantInt>(BI->getCondition())){
Chris Lattnerdb410242006-02-18 02:42:34 +00001252 // Conditional branch. Turn it into an unconditional branch, then
1253 // remove dead blocks.
Chris Lattner4f1f6f62010-04-20 05:33:18 +00001254 continue; // FIXME: Enable.
Chris Lattnerbd28e3f2006-02-22 06:37:14 +00001255
David Greened4c56fb2010-01-05 01:27:04 +00001256 DEBUG(dbgs() << "Folded branch: " << *BI);
Reid Spencer579dca12007-01-12 04:24:46 +00001257 BasicBlock *DeadSucc = BI->getSuccessor(CB->getZExtValue());
1258 BasicBlock *LiveSucc = BI->getSuccessor(!CB->getZExtValue());
Chris Lattnerdb410242006-02-18 02:42:34 +00001259 DeadSucc->removePredecessor(BI->getParent(), true);
Gabor Greif051a9502008-04-06 20:25:17 +00001260 Worklist.push_back(BranchInst::Create(LiveSucc, BI));
Devang Patel15c260a2007-07-31 08:03:26 +00001261 LPM->deleteSimpleAnalysisValue(BI, L);
Devang Patel9ee49c52007-09-20 23:45:50 +00001262 BI->eraseFromParent();
Chris Lattnerdb410242006-02-18 02:42:34 +00001263 RemoveFromWorklist(BI, Worklist);
1264 ++NumSimplify;
1265
Devang Patel15c260a2007-07-31 08:03:26 +00001266 RemoveBlockIfDead(DeadSucc, Worklist, L);
Chris Lattner52221f72006-02-17 00:31:07 +00001267 }
Chris Lattner4f1f6f62010-04-20 05:33:18 +00001268 continue;
Chris Lattner52221f72006-02-17 00:31:07 +00001269 }
1270 }
Chris Lattner18f16092004-04-19 18:07:02 +00001271}