blob: 3ccb27276ddc502026ac20d1075edb51c4ae4867 [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
Dan Gohmanb24f6c72009-10-13 17:50:43 +000062// The specific value of 50 here was chosen based only on intuition and a
63// 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
132 // TODO: This few lines are here for cosmetic purposes only.
133 // Will be removed with the next commit.
Eli Friedman09a536a2012-01-13 22:34:39 +0000134 struct LoopProperties {
135 unsigned CanBeUnswitchedCount;
136 unsigned SizeEstimation;
137 };
138
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000139 // TODO: This few lines are here for cosmetic purposes only.
140 // Will be removed with the next commit.
Eli Friedman09a536a2012-01-13 22:34:39 +0000141 typedef DenseMap<const Loop*, LoopProperties> LoopPropsMap;
142 typedef LoopPropsMap::iterator LoopPropsMapIt;
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000143 LoopPropsMap LoopsProperties;
Eli Friedman09a536a2012-01-13 22:34:39 +0000144
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000145 LUAnalysisCache BranchesInfo;
Devang Patel743f7e82007-06-06 00:21:03 +0000146
147 bool OptimizeForSize;
Devang Patel6f62af62007-07-30 23:07:10 +0000148 bool redoLoop;
Devang Patel5c4cd0d2007-10-05 22:29:34 +0000149
Devang Patele6962df2008-07-02 01:18:13 +0000150 Loop *currentLoop;
Devang Patel5c4cd0d2007-10-05 22:29:34 +0000151 DominatorTree *DT;
Devang Patele6962df2008-07-02 01:18:13 +0000152 BasicBlock *loopHeader;
153 BasicBlock *loopPreheader;
Devang Patel5c4cd0d2007-10-05 22:29:34 +0000154
Devang Patel1e41f6d2008-07-02 01:44:29 +0000155 // LoopBlocks contains all of the basic blocks of the loop, including the
156 // preheader of the loop, the body of the loop, and the exit blocks of the
157 // loop, in that order.
158 std::vector<BasicBlock*> LoopBlocks;
159 // NewBlocks contained cloned copy of basic blocks from LoopBlocks.
160 std::vector<BasicBlock*> NewBlocks;
Devang Patel77a01132008-07-03 17:37:52 +0000161
Chris Lattner18f16092004-04-19 18:07:02 +0000162 public:
Devang Patel19974732007-05-03 01:11:54 +0000163 static char ID; // Pass ID, replacement for typeid
Dan Gohmanc2bbfc12007-08-01 15:32:29 +0000164 explicit LoopUnswitch(bool Os = false) :
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000165 LoopPass(ID), OptimizeForSize(Os), redoLoop(false),
Chris Lattnerea109232010-08-29 17:23:19 +0000166 currentLoop(NULL), DT(NULL), loopHeader(NULL),
Owen Anderson081c34b2010-10-19 17:21:58 +0000167 loopPreheader(NULL) {
168 initializeLoopUnswitchPass(*PassRegistry::getPassRegistry());
169 }
Devang Patel794fd752007-05-01 21:15:47 +0000170
Devang Patel1bc89362007-03-07 00:26:10 +0000171 bool runOnLoop(Loop *L, LPPassManager &LPM);
Devang Patele6962df2008-07-02 01:18:13 +0000172 bool processCurrentLoop();
Chris Lattner18f16092004-04-19 18:07:02 +0000173
174 /// This transformation requires natural loop information & requires that
Chris Lattnerea109232010-08-29 17:23:19 +0000175 /// loop preheaders be inserted into the CFG.
Chris Lattner18f16092004-04-19 18:07:02 +0000176 ///
177 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
178 AU.addRequiredID(LoopSimplifyID);
Chris Lattnerf4f5f4e2006-02-09 22:15:42 +0000179 AU.addPreservedID(LoopSimplifyID);
Chris Lattner18f16092004-04-19 18:07:02 +0000180 AU.addRequired<LoopInfo>();
181 AU.addPreserved<LoopInfo>();
Owen Anderson6edf3992006-06-12 21:49:21 +0000182 AU.addRequiredID(LCSSAID);
Devang Patel15c260a2007-07-31 08:03:26 +0000183 AU.addPreservedID(LCSSAID);
Devang Patel4be7d292008-07-03 06:48:21 +0000184 AU.addPreserved<DominatorTree>();
Cameron Zwarich71132af2011-02-11 06:08:28 +0000185 AU.addPreserved<ScalarEvolution>();
Chris Lattner18f16092004-04-19 18:07:02 +0000186 }
187
188 private:
Devang Patel15c260a2007-07-31 08:03:26 +0000189
Dan Gohman5c89b522009-09-08 15:45:00 +0000190 virtual void releaseMemory() {
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000191 BranchesInfo.forgetLoop(currentLoop);
Dan Gohman5c89b522009-09-08 15:45:00 +0000192 }
193
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000194 /// RemoveLoopFromWorklist - If the specified loop is on the loop worklist,
195 /// remove it.
196 void RemoveLoopFromWorklist(Loop *L) {
197 std::vector<Loop*>::iterator I = std::find(LoopProcessWorklist.begin(),
198 LoopProcessWorklist.end(), L);
199 if (I != LoopProcessWorklist.end())
200 LoopProcessWorklist.erase(I);
201 }
Chad Rosiera816bf72011-12-22 21:10:46 +0000202
Devang Patele6962df2008-07-02 01:18:13 +0000203 void initLoopData() {
204 loopHeader = currentLoop->getHeader();
205 loopPreheader = currentLoop->getLoopPreheader();
206 }
207
Chris Lattner48a80b02008-04-21 00:25:49 +0000208 /// Split all of the edges from inside the loop to their exit blocks.
209 /// Update the appropriate Phi nodes as we do so.
Devang Patel77a01132008-07-03 17:37:52 +0000210 void SplitExitEdges(Loop *L, const SmallVector<BasicBlock *, 8> &ExitBlocks);
Devang Patel5c4cd0d2007-10-05 22:29:34 +0000211
Devang Patele6962df2008-07-02 01:18:13 +0000212 bool UnswitchIfProfitable(Value *LoopCond, Constant *Val);
Chris Lattnerf4412d82006-02-18 01:27:45 +0000213 void UnswitchTrivialCondition(Loop *L, Value *Cond, Constant *Val,
Chris Lattnerbd28e3f2006-02-22 06:37:14 +0000214 BasicBlock *ExitBlock);
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000215 void UnswitchNontrivialCondition(Value *LIC, Constant *OnVal, Loop *L);
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000216
217 void RewriteLoopBodyWithConditionConstant(Loop *L, Value *LIC,
218 Constant *Val, bool isEqual);
Devang Patelcce624a2007-06-28 00:49:00 +0000219
220 void EmitPreheaderBranchOnCondition(Value *LIC, Constant *Val,
221 BasicBlock *TrueDest,
222 BasicBlock *FalseDest,
223 Instruction *InsertPt);
224
Devang Patel15c260a2007-07-31 08:03:26 +0000225 void SimplifyCode(std::vector<Instruction*> &Worklist, Loop *L);
Chris Lattnerdb410242006-02-18 02:42:34 +0000226 void RemoveBlockIfDead(BasicBlock *BB,
Devang Patel15c260a2007-07-31 08:03:26 +0000227 std::vector<Instruction*> &Worklist, Loop *l);
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000228 void RemoveLoopFromHierarchy(Loop *L);
Devang Patele6962df2008-07-02 01:18:13 +0000229 bool IsTrivialUnswitchCondition(Value *Cond, Constant **Val = 0,
230 BasicBlock **LoopExit = 0);
231
Chris Lattner18f16092004-04-19 18:07:02 +0000232 };
Chris Lattner18f16092004-04-19 18:07:02 +0000233}
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000234
235// Analyze loop. Check its size, calculate is it possible to unswitch
236// it. Returns true if we can unswitch this loop.
237bool LUAnalysisCache::countLoop(const Loop* L) {
238
239 std::pair<LoopPropsMapIt, bool> InsertRes =
240 LoopsProperties.insert(std::make_pair(L, LoopProperties()));
241
242 LoopProperties& Props = InsertRes.first->second;
243
244 if (InsertRes.second) {
245 // New loop.
246
247 // Limit the number of instructions to avoid causing significant code
248 // expansion, and the number of basic blocks, to avoid loops with
249 // large numbers of branches which cause loop unswitching to go crazy.
250 // This is a very ad-hoc heuristic.
251
252 // FIXME: This is overly conservative because it does not take into
253 // consideration code simplification opportunities and code that can
254 // be shared by the resultant unswitched loops.
255 CodeMetrics Metrics;
256 for (Loop::block_iterator I = L->block_begin(),
257 E = L->block_end();
258 I != E; ++I)
259 Metrics.analyzeBasicBlock(*I);
260
261 Props.SizeEstimation = std::min(Metrics.NumInsts, Metrics.NumBlocks * 5);
262 Props.CanBeUnswitchedCount = MaxSize / (Props.SizeEstimation);
263 MaxSize -= Props.SizeEstimation * Props.CanBeUnswitchedCount;
264 }
265
266 if (!Props.CanBeUnswitchedCount) {
267 DEBUG(dbgs() << "NOT unswitching loop %"
268 << L->getHeader()->getName() << ", cost too high: "
269 << L->getBlocks().size() << "\n");
270
271 return false;
272 }
273
274 // Be careful. This links are good only before new loop addition.
275 CurrentLoopProperties = &Props;
276 CurLoopInstructions = &Props.UnswitchedVals;
277
278 return true;
279}
280
281// Clean all data related to given loop.
282void LUAnalysisCache::forgetLoop(const Loop* L) {
283
284 LoopPropsMapIt LIt = LoopsProperties.find(L);
285
286 if (LIt != LoopsProperties.end()) {
287 LoopProperties& Props = LIt->second;
288 MaxSize += Props.CanBeUnswitchedCount * Props.SizeEstimation;
289 LoopsProperties.erase(LIt);
290 }
291
292 CurrentLoopProperties = NULL;
293 CurLoopInstructions = NULL;
294}
295
296// Mark case value as unswitched.
297// Since SI instruction can be partly unswitched, in order to avoid
298// extra unswitching in cloned loops keep track all unswitched values.
299void LUAnalysisCache::setUnswitched(const SwitchInst* SI, const Value* V) {
300 (*CurLoopInstructions)[SI].insert(V);
301}
302
303// Check was this case value unswitched before or not.
304bool LUAnalysisCache::isUnswitched(const SwitchInst* SI, const Value* V) {
305 return (*CurLoopInstructions)[SI].count(V);
306}
307
308// Clone all loop-unswitch related loop properties.
309// Redistribute unswitching quotas.
310// Note, that new loop data is stored inside the VMap.
311void LUAnalysisCache::cloneData(const Loop* NewLoop, const Loop* OldLoop,
312 const ValueToValueMapTy& VMap) {
313
314 LoopProperties& NewLoopProps = LoopsProperties[NewLoop];
315 LoopProperties& OldLoopProps = *CurrentLoopProperties;
316 UnswitchedValsMap& Insts = OldLoopProps.UnswitchedVals;
317
318 // Reallocate "can-be-unswitched quota"
319
320 --OldLoopProps.CanBeUnswitchedCount;
321 unsigned Quota = OldLoopProps.CanBeUnswitchedCount;
322 NewLoopProps.CanBeUnswitchedCount = Quota / 2;
323 OldLoopProps.CanBeUnswitchedCount = Quota - Quota / 2;
324
325 NewLoopProps.SizeEstimation = OldLoopProps.SizeEstimation;
326
327 // Clone unswitched values info:
328 // for new loop switches we clone info about values that was
329 // already unswitched and has redundant successors.
330 for (UnswitchedValsIt I = Insts.begin(); I != Insts.end(); ++I) {
331 const SwitchInst* OldInst = I->first;
332 Value* NewI = VMap.lookup(OldInst);
333 const SwitchInst* NewInst = cast_or_null<SwitchInst>(NewI);
334 assert(NewInst && "All instructions that are in SrcBB must be in VMap.");
335
336 NewLoopProps.UnswitchedVals[NewInst] = OldLoopProps.UnswitchedVals[OldInst];
337 }
338}
339
Dan Gohman844731a2008-05-13 00:00:25 +0000340char LoopUnswitch::ID = 0;
Owen Anderson2ab36d32010-10-12 19:48:12 +0000341INITIALIZE_PASS_BEGIN(LoopUnswitch, "loop-unswitch", "Unswitch loops",
342 false, false)
343INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
344INITIALIZE_PASS_DEPENDENCY(LoopInfo)
345INITIALIZE_PASS_DEPENDENCY(LCSSA)
Owen Anderson2ab36d32010-10-12 19:48:12 +0000346INITIALIZE_PASS_END(LoopUnswitch, "loop-unswitch", "Unswitch loops",
347 false, false)
Chris Lattner18f16092004-04-19 18:07:02 +0000348
Daniel Dunbar394f0442008-10-22 23:32:42 +0000349Pass *llvm::createLoopUnswitchPass(bool Os) {
Devang Patel743f7e82007-06-06 00:21:03 +0000350 return new LoopUnswitch(Os);
351}
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000352
353/// FindLIVLoopCondition - Cond is a condition that occurs in L. If it is
354/// invariant in the loop, or has an invariant piece, return the invariant.
355/// Otherwise, return null.
356static Value *FindLIVLoopCondition(Value *Cond, Loop *L, bool &Changed) {
Stepan Dyatkovskiy88c5c422012-01-11 08:40:51 +0000357
358 // We started analyze new instruction, increment scanned instructions counter.
359 ++TotalInsts;
360
Chris Lattner3d606bb2010-02-02 02:26:54 +0000361 // We can never unswitch on vector conditions.
Duncan Sands1df98592010-02-16 11:11:14 +0000362 if (Cond->getType()->isVectorTy())
Chris Lattner3d606bb2010-02-02 02:26:54 +0000363 return 0;
364
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000365 // Constants should be folded, not unswitched on!
Dan Gohmana1fcd772008-10-17 00:56:52 +0000366 if (isa<Constant>(Cond)) return 0;
Devang Patel558f1b82007-06-28 00:44:10 +0000367
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000368 // TODO: Handle: br (VARIANT|INVARIANT).
Devang Patel265ca5d2008-11-03 19:38:07 +0000369
Dan Gohman0df6e092009-07-14 01:37:59 +0000370 // Hoist simple values out.
Dan Gohmanbdc017e2009-07-15 01:25:43 +0000371 if (L->makeLoopInvariant(Cond, Changed))
Dan Gohman0df6e092009-07-14 01:37:59 +0000372 return Cond;
Dan Gohman0df6e092009-07-14 01:37:59 +0000373
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000374 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(Cond))
375 if (BO->getOpcode() == Instruction::And ||
376 BO->getOpcode() == Instruction::Or) {
377 // If either the left or right side is invariant, we can unswitch on this,
378 // which will cause the branch to go away in one loop and the condition to
379 // simplify in the other one.
380 if (Value *LHS = FindLIVLoopCondition(BO->getOperand(0), L, Changed))
381 return LHS;
382 if (Value *RHS = FindLIVLoopCondition(BO->getOperand(1), L, Changed))
383 return RHS;
384 }
Devang Patel5c4cd0d2007-10-05 22:29:34 +0000385
386 return 0;
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000387}
388
Devang Patel1bc89362007-03-07 00:26:10 +0000389bool LoopUnswitch::runOnLoop(Loop *L, LPPassManager &LPM_Ref) {
Devang Patel1bc89362007-03-07 00:26:10 +0000390 LI = &getAnalysis<LoopInfo>();
391 LPM = &LPM_Ref;
Duncan Sands1465d612009-01-28 13:14:17 +0000392 DT = getAnalysisIfAvailable<DominatorTree>();
Devang Patele6962df2008-07-02 01:18:13 +0000393 currentLoop = L;
Devang Pateldeafefa2008-09-04 22:43:59 +0000394 Function *F = currentLoop->getHeader()->getParent();
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000395 bool Changed = false;
Devang Patel6f62af62007-07-30 23:07:10 +0000396 do {
Dan Gohmanbbf81d82010-03-10 19:38:49 +0000397 assert(currentLoop->isLCSSAForm(*DT));
Devang Patel6f62af62007-07-30 23:07:10 +0000398 redoLoop = false;
Devang Patele6962df2008-07-02 01:18:13 +0000399 Changed |= processCurrentLoop();
Devang Patel6f62af62007-07-30 23:07:10 +0000400 } while(redoLoop);
401
Devang Pateldeafefa2008-09-04 22:43:59 +0000402 if (Changed) {
403 // FIXME: Reconstruct dom info, because it is not preserved properly.
404 if (DT)
405 DT->runOnFunction(*F);
Devang Pateldeafefa2008-09-04 22:43:59 +0000406 }
Devang Patel6f62af62007-07-30 23:07:10 +0000407 return Changed;
408}
409
Devang Patele6962df2008-07-02 01:18:13 +0000410/// processCurrentLoop - Do actual work and unswitch loop if possible
411/// and profitable.
412bool LoopUnswitch::processCurrentLoop() {
Devang Patel6f62af62007-07-30 23:07:10 +0000413 bool Changed = false;
Stepan Dyatkovskiy88c5c422012-01-11 08:40:51 +0000414
415 initLoopData();
416
417 // If LoopSimplify was unable to form a preheader, don't do any unswitching.
418 if (!loopPreheader)
419 return false;
420
421 LLVMContext &Context = loopHeader->getContext();
422
423 // Probably we reach the quota of branches for this loop. If so
424 // stop unswitching.
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000425 if (!BranchesInfo.countLoop(currentLoop))
Stepan Dyatkovskiy88c5c422012-01-11 08:40:51 +0000426 return false;
Devang Patel6f62af62007-07-30 23:07:10 +0000427
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000428 // Loop over all of the basic blocks in the loop. If we find an interior
429 // block that is branching on a loop-invariant condition, we can unswitch this
430 // loop.
Devang Patele6962df2008-07-02 01:18:13 +0000431 for (Loop::block_iterator I = currentLoop->block_begin(),
Chris Lattner9e185802010-04-05 21:18:32 +0000432 E = currentLoop->block_end(); I != E; ++I) {
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000433 TerminatorInst *TI = (*I)->getTerminator();
434 if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
435 // If this isn't branching on an invariant condition, we can't unswitch
436 // it.
437 if (BI->isConditional()) {
438 // See if this, or some part of it, is loop invariant. If so, we can
439 // unswitch on it if we desire.
Devang Patele6962df2008-07-02 01:18:13 +0000440 Value *LoopCond = FindLIVLoopCondition(BI->getCondition(),
441 currentLoop, Changed);
442 if (LoopCond && UnswitchIfProfitable(LoopCond,
Owen Anderson5defacc2009-07-31 17:39:07 +0000443 ConstantInt::getTrue(Context))) {
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000444 ++NumBranches;
445 return true;
446 }
447 }
448 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
Devang Patele6962df2008-07-02 01:18:13 +0000449 Value *LoopCond = FindLIVLoopCondition(SI->getCondition(),
450 currentLoop, Changed);
Chad Rosiera816bf72011-12-22 21:10:46 +0000451 unsigned NumCases = SI->getNumCases();
452 if (LoopCond && NumCases > 1) {
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000453 // Find a value to unswitch on:
454 // FIXME: this should chose the most expensive case!
Nick Lewycky444f2972011-06-03 06:27:15 +0000455 // FIXME: scan for a case with a non-critical edge?
Chad Rosiera816bf72011-12-22 21:10:46 +0000456 Constant *UnswitchVal = NULL;
457
Devang Patel52956922007-02-26 19:31:58 +0000458 // Do not process same value again and again.
Chad Rosiera816bf72011-12-22 21:10:46 +0000459 // At this point we have some cases already unswitched and
460 // some not yet unswitched. Let's find the first not yet unswitched one.
461 for (unsigned i = 1; i < NumCases; ++i) {
462 Constant* UnswitchValCandidate = SI->getCaseValue(i);
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000463 if (!BranchesInfo.isUnswitched(SI, UnswitchValCandidate)) {
Chad Rosiera816bf72011-12-22 21:10:46 +0000464 UnswitchVal = UnswitchValCandidate;
465 break;
466 }
467 }
468
469 if (!UnswitchVal)
Devang Patel52956922007-02-26 19:31:58 +0000470 continue;
Devang Patel52956922007-02-26 19:31:58 +0000471
Devang Patele6962df2008-07-02 01:18:13 +0000472 if (UnswitchIfProfitable(LoopCond, UnswitchVal)) {
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000473 ++NumSwitches;
474 return true;
475 }
476 }
477 }
478
479 // Scan the instructions to check for unswitchable values.
480 for (BasicBlock::iterator BBI = (*I)->begin(), E = (*I)->end();
481 BBI != E; ++BBI)
482 if (SelectInst *SI = dyn_cast<SelectInst>(BBI)) {
Devang Patele6962df2008-07-02 01:18:13 +0000483 Value *LoopCond = FindLIVLoopCondition(SI->getCondition(),
484 currentLoop, Changed);
485 if (LoopCond && UnswitchIfProfitable(LoopCond,
Owen Anderson5defacc2009-07-31 17:39:07 +0000486 ConstantInt::getTrue(Context))) {
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000487 ++NumSelects;
488 return true;
489 }
490 }
491 }
Chris Lattner18f16092004-04-19 18:07:02 +0000492 return Changed;
493}
494
Dan Gohmanb0a57212010-09-01 21:46:45 +0000495/// isTrivialLoopExitBlock - Check to see if all paths from BB exit the
496/// loop with no side effects (including infinite loops).
Chris Lattner4e132392006-02-15 22:03:36 +0000497///
Dan Gohmanb0a57212010-09-01 21:46:45 +0000498/// If true, we return true and set ExitBB to the block we
Chris Lattner4e132392006-02-15 22:03:36 +0000499/// exit through.
500///
501static bool isTrivialLoopExitBlockHelper(Loop *L, BasicBlock *BB,
502 BasicBlock *&ExitBB,
503 std::set<BasicBlock*> &Visited) {
Chris Lattner0017d482006-02-17 06:39:56 +0000504 if (!Visited.insert(BB).second) {
Nick Lewycky8a5641d2011-12-23 23:49:25 +0000505 // Already visited. Without more analysis, this could indicate an infinite
506 // loop.
Dan Gohmanb0a57212010-09-01 21:46:45 +0000507 return false;
Chris Lattner0017d482006-02-17 06:39:56 +0000508 } else if (!L->contains(BB)) {
509 // Otherwise, this is a loop exit, this is fine so long as this is the
510 // first exit.
511 if (ExitBB != 0) return false;
512 ExitBB = BB;
Edward O'Callaghan25798432009-11-25 05:38:41 +0000513 return true;
Chris Lattner0017d482006-02-17 06:39:56 +0000514 }
515
516 // Otherwise, this is an unvisited intra-loop node. Check all successors.
Chris Lattner4e132392006-02-15 22:03:36 +0000517 for (succ_iterator SI = succ_begin(BB), E = succ_end(BB); SI != E; ++SI) {
Chris Lattner0017d482006-02-17 06:39:56 +0000518 // Check to see if the successor is a trivial loop exit.
519 if (!isTrivialLoopExitBlockHelper(L, *SI, ExitBB, Visited))
520 return false;
Chris Lattner708e1a52006-02-10 02:30:37 +0000521 }
Chris Lattner4e132392006-02-15 22:03:36 +0000522
523 // Okay, everything after this looks good, check to make sure that this block
524 // doesn't include any side effects.
Chris Lattnera48654e2006-02-15 22:52:05 +0000525 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I)
Duncan Sands7af1c782009-05-06 06:49:50 +0000526 if (I->mayHaveSideEffects())
Chris Lattner4e132392006-02-15 22:03:36 +0000527 return false;
528
529 return true;
Chris Lattner708e1a52006-02-10 02:30:37 +0000530}
531
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000532/// isTrivialLoopExitBlock - Return true if the specified block unconditionally
533/// leads to an exit from the specified loop, and has no side-effects in the
534/// process. If so, return the block that is exited to, otherwise return null.
Chris Lattner4e132392006-02-15 22:03:36 +0000535static BasicBlock *isTrivialLoopExitBlock(Loop *L, BasicBlock *BB) {
536 std::set<BasicBlock*> Visited;
Dan Gohmanb0a57212010-09-01 21:46:45 +0000537 Visited.insert(L->getHeader()); // Branches to header make infinite loops.
Chris Lattner4e132392006-02-15 22:03:36 +0000538 BasicBlock *ExitBB = 0;
539 if (isTrivialLoopExitBlockHelper(L, BB, ExitBB, Visited))
540 return ExitBB;
541 return 0;
542}
Chris Lattner708e1a52006-02-10 02:30:37 +0000543
Chris Lattner4c41d492006-02-10 01:24:09 +0000544/// IsTrivialUnswitchCondition - Check to see if this unswitch condition is
545/// trivial: that is, that the condition controls whether or not the loop does
546/// anything at all. If this is a trivial condition, unswitching produces no
547/// code duplications (equivalently, it produces a simpler loop and a new empty
548/// loop, which gets deleted).
549///
Chris Lattnerbd28e3f2006-02-22 06:37:14 +0000550/// If this is a trivial condition, return true, otherwise return false. When
551/// returning true, this sets Cond and Val to the condition that controls the
552/// trivial condition: when Cond dynamically equals Val, the loop is known to
553/// exit. Finally, this sets LoopExit to the BB that the loop exits to when
554/// Cond == Val.
555///
Devang Patele6962df2008-07-02 01:18:13 +0000556bool LoopUnswitch::IsTrivialUnswitchCondition(Value *Cond, Constant **Val,
557 BasicBlock **LoopExit) {
558 BasicBlock *Header = currentLoop->getHeader();
Chris Lattnera48654e2006-02-15 22:52:05 +0000559 TerminatorInst *HeaderTerm = Header->getTerminator();
Owen Andersone922c022009-07-22 00:24:57 +0000560 LLVMContext &Context = Header->getContext();
Chris Lattnerbd28e3f2006-02-22 06:37:14 +0000561
Chris Lattnera48654e2006-02-15 22:52:05 +0000562 BasicBlock *LoopExitBB = 0;
563 if (BranchInst *BI = dyn_cast<BranchInst>(HeaderTerm)) {
564 // If the header block doesn't end with a conditional branch on Cond, we
565 // can't handle it.
566 if (!BI->isConditional() || BI->getCondition() != Cond)
567 return false;
Chris Lattner4c41d492006-02-10 01:24:09 +0000568
Dan Gohmanb0a57212010-09-01 21:46:45 +0000569 // Check to see if a successor of the branch is guaranteed to
570 // exit through a unique exit block without having any
Chris Lattnera48654e2006-02-15 22:52:05 +0000571 // side-effects. If so, determine the value of Cond that causes it to do
572 // this.
Devang Patele6962df2008-07-02 01:18:13 +0000573 if ((LoopExitBB = isTrivialLoopExitBlock(currentLoop,
574 BI->getSuccessor(0)))) {
Owen Anderson5defacc2009-07-31 17:39:07 +0000575 if (Val) *Val = ConstantInt::getTrue(Context);
Devang Patele6962df2008-07-02 01:18:13 +0000576 } else if ((LoopExitBB = isTrivialLoopExitBlock(currentLoop,
577 BI->getSuccessor(1)))) {
Owen Anderson5defacc2009-07-31 17:39:07 +0000578 if (Val) *Val = ConstantInt::getFalse(Context);
Chris Lattnera48654e2006-02-15 22:52:05 +0000579 }
580 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(HeaderTerm)) {
581 // If this isn't a switch on Cond, we can't handle it.
582 if (SI->getCondition() != Cond) return false;
583
584 // Check to see if a successor of the switch is guaranteed to go to the
585 // latch block or exit through a one exit block without having any
586 // side-effects. If so, determine the value of Cond that causes it to do
Chad Rosiera816bf72011-12-22 21:10:46 +0000587 // this.
588 // Note that we can't trivially unswitch on the default case or
589 // on already unswitched cases.
590 for (unsigned i = 1, e = SI->getNumSuccessors(); i != e; ++i) {
591 BasicBlock* LoopExitCandidate;
592 if ((LoopExitCandidate = isTrivialLoopExitBlock(currentLoop,
Devang Patele6962df2008-07-02 01:18:13 +0000593 SI->getSuccessor(i)))) {
Chris Lattnera48654e2006-02-15 22:52:05 +0000594 // Okay, we found a trivial case, remember the value that is trivial.
Chad Rosiera816bf72011-12-22 21:10:46 +0000595 ConstantInt* CaseVal = SI->getCaseValue(i);
596
597 // Check that it was not unswitched before, since already unswitched
598 // trivial vals are looks trivial too.
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000599 if (BranchesInfo.isUnswitched(SI, CaseVal))
Chad Rosiera816bf72011-12-22 21:10:46 +0000600 continue;
601 LoopExitBB = LoopExitCandidate;
602 if (Val) *Val = CaseVal;
Chris Lattnera48654e2006-02-15 22:52:05 +0000603 break;
604 }
Chad Rosiera816bf72011-12-22 21:10:46 +0000605 }
Chris Lattner4e132392006-02-15 22:03:36 +0000606 }
607
Chris Lattnerf8bf1162006-02-22 23:55:00 +0000608 // If we didn't find a single unique LoopExit block, or if the loop exit block
609 // contains phi nodes, this isn't trivial.
610 if (!LoopExitBB || isa<PHINode>(LoopExitBB->begin()))
Chris Lattner4e132392006-02-15 22:03:36 +0000611 return false; // Can't handle this.
Chris Lattner4c41d492006-02-10 01:24:09 +0000612
Chris Lattnera48654e2006-02-15 22:52:05 +0000613 if (LoopExit) *LoopExit = LoopExitBB;
Chris Lattner4c41d492006-02-10 01:24:09 +0000614
615 // We already know that nothing uses any scalar values defined inside of this
616 // loop. As such, we just have to check to see if this loop will execute any
617 // side-effecting instructions (e.g. stores, calls, volatile loads) in the
Chris Lattner4e132392006-02-15 22:03:36 +0000618 // part of the loop that the code *would* execute. We already checked the
619 // tail, check the header now.
Chris Lattner4c41d492006-02-10 01:24:09 +0000620 for (BasicBlock::iterator I = Header->begin(), E = Header->end(); I != E; ++I)
Duncan Sands7af1c782009-05-06 06:49:50 +0000621 if (I->mayHaveSideEffects())
Chris Lattnerdd3ee6d2006-02-10 02:01:22 +0000622 return false;
Chris Lattnerdd3ee6d2006-02-10 02:01:22 +0000623 return true;
Chris Lattner4c41d492006-02-10 01:24:09 +0000624}
625
Devang Patele6962df2008-07-02 01:18:13 +0000626/// UnswitchIfProfitable - We have found that we can unswitch currentLoop when
Chris Lattnerc2358092006-02-11 00:43:37 +0000627/// LoopCond == Val to simplify the loop. If we decide that this is profitable,
628/// unswitch the loop, reprocess the pieces, then return true.
Chris Lattner3d606bb2010-02-02 02:26:54 +0000629bool LoopUnswitch::UnswitchIfProfitable(Value *LoopCond, Constant *Val) {
Devang Patel10b359c2008-09-04 18:55:13 +0000630
Dan Gohmanf68d0c12009-12-09 22:55:01 +0000631 Function *F = loopHeader->getParent();
632
Evan Cheng02720242010-04-03 02:23:43 +0000633 Constant *CondVal = 0;
634 BasicBlock *ExitBlock = 0;
Devang Patele6962df2008-07-02 01:18:13 +0000635 if (IsTrivialUnswitchCondition(LoopCond, &CondVal, &ExitBlock)) {
Evan Cheng02720242010-04-03 02:23:43 +0000636 // If the condition is trivial, always unswitch. There is no code growth
637 // for this case.
Devang Patele6962df2008-07-02 01:18:13 +0000638 UnswitchTrivialCondition(currentLoop, LoopCond, CondVal, ExitBlock);
Evan Cheng02720242010-04-03 02:23:43 +0000639 return true;
Chris Lattnerc2358092006-02-11 00:43:37 +0000640 }
Devang Patel4be7d292008-07-03 06:48:21 +0000641
Evan Cheng02720242010-04-03 02:23:43 +0000642 // Check to see if it would be profitable to unswitch current loop.
643
644 // Do not do non-trivial unswitch while optimizing for size.
645 if (OptimizeForSize || F->hasFnAttr(Attribute::OptimizeForSize))
646 return false;
647
Evan Cheng02720242010-04-03 02:23:43 +0000648 UnswitchNontrivialCondition(LoopCond, Val, currentLoop);
Chris Lattnerc2358092006-02-11 00:43:37 +0000649 return true;
650}
651
Chris Lattner18f16092004-04-19 18:07:02 +0000652/// CloneLoop - Recursively clone the specified loop and all of its children,
653/// mapping the blocks with the specified map.
Rafael Espindola1ed219a2010-10-13 01:36:30 +0000654static Loop *CloneLoop(Loop *L, Loop *PL, ValueToValueMapTy &VM,
Devang Patel1bc89362007-03-07 00:26:10 +0000655 LoopInfo *LI, LPPassManager *LPM) {
Chris Lattner18f16092004-04-19 18:07:02 +0000656 Loop *New = new Loop();
Devang Patel1bc89362007-03-07 00:26:10 +0000657 LPM->insertLoop(New, PL);
Chris Lattner18f16092004-04-19 18:07:02 +0000658
659 // Add all of the blocks in L to the new loop.
660 for (Loop::block_iterator I = L->block_begin(), E = L->block_end();
661 I != E; ++I)
662 if (LI->getLoopFor(*I) == L)
Owen Andersond735ee82007-11-27 03:43:35 +0000663 New->addBasicBlockToLoop(cast<BasicBlock>(VM[*I]), LI->getBase());
Chris Lattner18f16092004-04-19 18:07:02 +0000664
665 // Add all of the subloops to the new loop.
666 for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
Devang Patel1bc89362007-03-07 00:26:10 +0000667 CloneLoop(*I, New, VM, LI, LPM);
Misha Brukmanfd939082005-04-21 23:48:37 +0000668
Chris Lattner18f16092004-04-19 18:07:02 +0000669 return New;
670}
671
Chris Lattnerfed5d9d2006-02-15 00:07:43 +0000672/// EmitPreheaderBranchOnCondition - Emit a conditional branch on two values
673/// if LIC == Val, branch to TrueDst, otherwise branch to FalseDest. Insert the
674/// code immediately before InsertPt.
Devang Patelcce624a2007-06-28 00:49:00 +0000675void LoopUnswitch::EmitPreheaderBranchOnCondition(Value *LIC, Constant *Val,
676 BasicBlock *TrueDest,
677 BasicBlock *FalseDest,
678 Instruction *InsertPt) {
Chris Lattnerfed5d9d2006-02-15 00:07:43 +0000679 // Insert a conditional branch on LIC to the two preheaders. The original
680 // code is the true version and the new code is the false version.
681 Value *BranchVal = LIC;
Owen Anderson1d0be152009-08-13 21:58:54 +0000682 if (!isa<ConstantInt>(Val) ||
683 Val->getType() != Type::getInt1Ty(LIC->getContext()))
Benjamin Kramera9390a42011-09-27 20:39:19 +0000684 BranchVal = new ICmpInst(InsertPt, ICmpInst::ICMP_EQ, LIC, Val);
Owen Anderson5defacc2009-07-31 17:39:07 +0000685 else if (Val != ConstantInt::getTrue(Val->getContext()))
Chris Lattnerfed5d9d2006-02-15 00:07:43 +0000686 // We want to enter the new loop when the condition is true.
687 std::swap(TrueDest, FalseDest);
Chris Lattnerfed5d9d2006-02-15 00:07:43 +0000688
689 // Insert the new branch.
Dan Gohman5c89b522009-09-08 15:45:00 +0000690 BranchInst *BI = BranchInst::Create(TrueDest, FalseDest, BranchVal, InsertPt);
691
692 // If either edge is critical, split it. This helps preserve LoopSimplify
693 // form for enclosing loops.
694 SplitCriticalEdge(BI, 0, this);
695 SplitCriticalEdge(BI, 1, this);
Chris Lattnerfed5d9d2006-02-15 00:07:43 +0000696}
697
Chris Lattner4c41d492006-02-10 01:24:09 +0000698/// UnswitchTrivialCondition - Given a loop that has a trivial unswitchable
699/// condition in it (a cond branch from its header block to its latch block,
700/// where the path through the loop that doesn't execute its body has no
701/// side-effects), unswitch it. This doesn't involve any code duplication, just
702/// moving the conditional branch outside of the loop and updating loop info.
703void LoopUnswitch::UnswitchTrivialCondition(Loop *L, Value *Cond,
Chris Lattnerbd28e3f2006-02-22 06:37:14 +0000704 Constant *Val,
Chris Lattnerdd3ee6d2006-02-10 02:01:22 +0000705 BasicBlock *ExitBlock) {
David Greened4c56fb2010-01-05 01:27:04 +0000706 DEBUG(dbgs() << "loop-unswitch: Trivial-Unswitch loop %"
Daniel Dunbarce63ffb2009-07-25 00:23:56 +0000707 << loopHeader->getName() << " [" << L->getBlocks().size()
708 << " blocks] in Function " << L->getHeader()->getParent()->getName()
709 << " on cond: " << *Val << " == " << *Cond << "\n");
Chris Lattner4d1ca942006-02-10 01:36:35 +0000710
Chris Lattnerb2bc3152006-02-10 23:16:39 +0000711 // First step, split the preheader, so that we know that there is a safe place
Devang Patele6962df2008-07-02 01:18:13 +0000712 // to insert the conditional branch. We will change loopPreheader to have a
Chris Lattner4c41d492006-02-10 01:24:09 +0000713 // conditional branch on Cond.
Devang Patele6962df2008-07-02 01:18:13 +0000714 BasicBlock *NewPH = SplitEdge(loopPreheader, loopHeader, this);
Chris Lattner4c41d492006-02-10 01:24:09 +0000715
716 // Now that we have a place to insert the conditional branch, create a place
Chris Lattnerdd3ee6d2006-02-10 02:01:22 +0000717 // to branch to: this is the exit block out of the loop that we should
718 // short-circuit to.
Chris Lattner4c41d492006-02-10 01:24:09 +0000719
Chris Lattner4e132392006-02-15 22:03:36 +0000720 // Split this block now, so that the loop maintains its exit block, and so
721 // that the jump from the preheader can execute the contents of the exit block
722 // without actually branching to it (the exit block should be dominated by the
723 // loop header, not the preheader).
Chris Lattnerdd3ee6d2006-02-10 02:01:22 +0000724 assert(!L->contains(ExitBlock) && "Exit block is in the loop?");
Devang Patel05c1dc62007-07-06 22:03:47 +0000725 BasicBlock *NewExit = SplitBlock(ExitBlock, ExitBlock->begin(), this);
Chris Lattnerb2bc3152006-02-10 23:16:39 +0000726
Chris Lattner4c41d492006-02-10 01:24:09 +0000727 // Okay, now we have a position to branch from and a position to branch to,
728 // insert the new conditional branch.
Chris Lattnerbd28e3f2006-02-22 06:37:14 +0000729 EmitPreheaderBranchOnCondition(Cond, Val, NewExit, NewPH,
Devang Patele6962df2008-07-02 01:18:13 +0000730 loopPreheader->getTerminator());
Devang Patele6962df2008-07-02 01:18:13 +0000731 LPM->deleteSimpleAnalysisValue(loopPreheader->getTerminator(), L);
732 loopPreheader->getTerminator()->eraseFromParent();
Chris Lattner4c41d492006-02-10 01:24:09 +0000733
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000734 // We need to reprocess this loop, it could be unswitched again.
Devang Patel6f62af62007-07-30 23:07:10 +0000735 redoLoop = true;
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000736
Chris Lattner4c41d492006-02-10 01:24:09 +0000737 // Now that we know that the loop is never entered when this condition is a
738 // particular value, rewrite the loop with this info. We know that this will
739 // at least eliminate the old branch.
Chris Lattnerbd28e3f2006-02-22 06:37:14 +0000740 RewriteLoopBodyWithConditionConstant(L, Cond, Val, false);
Chris Lattner3dd4c402006-02-14 01:01:41 +0000741 ++NumTrivial;
Chris Lattner4c41d492006-02-10 01:24:09 +0000742}
743
Chris Lattner48a80b02008-04-21 00:25:49 +0000744/// SplitExitEdges - Split all of the edges from inside the loop to their exit
745/// blocks. Update the appropriate Phi nodes as we do so.
746void LoopUnswitch::SplitExitEdges(Loop *L,
Chris Lattner9e185802010-04-05 21:18:32 +0000747 const SmallVector<BasicBlock *, 8> &ExitBlocks){
Devang Patel5c4cd0d2007-10-05 22:29:34 +0000748
Chris Lattner4c41d492006-02-10 01:24:09 +0000749 for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
Chris Lattnerb2bc3152006-02-10 23:16:39 +0000750 BasicBlock *ExitBlock = ExitBlocks[i];
Dan Gohman5c89b522009-09-08 15:45:00 +0000751 SmallVector<BasicBlock *, 4> Preds(pred_begin(ExitBlock),
752 pred_end(ExitBlock));
Bill Wendlingd5520982011-09-27 00:59:31 +0000753
Nick Lewycky444f2972011-06-03 06:27:15 +0000754 // Although SplitBlockPredecessors doesn't preserve loop-simplify in
755 // general, if we call it on all predecessors of all exits then it does.
Bill Wendlingd5520982011-09-27 00:59:31 +0000756 if (!ExitBlock->isLandingPad()) {
Jakub Staszak2fac1d52011-12-09 21:19:53 +0000757 SplitBlockPredecessors(ExitBlock, Preds, ".us-lcssa", this);
Bill Wendlingd5520982011-09-27 00:59:31 +0000758 } else {
759 SmallVector<BasicBlock*, 2> NewBBs;
760 SplitLandingPadPredecessors(ExitBlock, Preds, ".us-lcssa", ".us-lcssa",
761 this, NewBBs);
762 }
Chris Lattner4c41d492006-02-10 01:24:09 +0000763 }
Devang Patelf476e8e2007-10-03 21:16:08 +0000764}
765
Devang Patelc1e26602007-10-03 21:17:43 +0000766/// UnswitchNontrivialCondition - We determined that the loop is profitable
767/// to unswitch when LIC equal Val. Split it into loop versions and test the
768/// condition outside of either loop. Return the loops created as Out1/Out2.
Devang Patelf476e8e2007-10-03 21:16:08 +0000769void LoopUnswitch::UnswitchNontrivialCondition(Value *LIC, Constant *Val,
770 Loop *L) {
Devang Patele6962df2008-07-02 01:18:13 +0000771 Function *F = loopHeader->getParent();
David Greened4c56fb2010-01-05 01:27:04 +0000772 DEBUG(dbgs() << "loop-unswitch: Unswitching loop %"
Daniel Dunbarce63ffb2009-07-25 00:23:56 +0000773 << loopHeader->getName() << " [" << L->getBlocks().size()
774 << " blocks] in Function " << F->getName()
775 << " when '" << *Val << "' == " << *LIC << "\n");
Devang Patelf476e8e2007-10-03 21:16:08 +0000776
Cameron Zwarich71132af2011-02-11 06:08:28 +0000777 if (ScalarEvolution *SE = getAnalysisIfAvailable<ScalarEvolution>())
778 SE->forgetLoop(L);
779
Devang Patel1e41f6d2008-07-02 01:44:29 +0000780 LoopBlocks.clear();
781 NewBlocks.clear();
Devang Patelf476e8e2007-10-03 21:16:08 +0000782
783 // First step, split the preheader and exit blocks, and add these blocks to
784 // the LoopBlocks list.
Devang Patele6962df2008-07-02 01:18:13 +0000785 BasicBlock *NewPreheader = SplitEdge(loopPreheader, loopHeader, this);
Devang Patelf476e8e2007-10-03 21:16:08 +0000786 LoopBlocks.push_back(NewPreheader);
787
788 // We want the loop to come after the preheader, but before the exit blocks.
789 LoopBlocks.insert(LoopBlocks.end(), L->block_begin(), L->block_end());
790
791 SmallVector<BasicBlock*, 8> ExitBlocks;
792 L->getUniqueExitBlocks(ExitBlocks);
793
794 // Split all of the edges from inside the loop to their exit blocks. Update
795 // the appropriate Phi nodes as we do so.
Devang Patel77a01132008-07-03 17:37:52 +0000796 SplitExitEdges(L, ExitBlocks);
Devang Patelf476e8e2007-10-03 21:16:08 +0000797
Chris Lattnerb2bc3152006-02-10 23:16:39 +0000798 // The exit blocks may have been changed due to edge splitting, recompute.
799 ExitBlocks.clear();
Devang Patel4b8f36f2006-08-29 22:29:16 +0000800 L->getUniqueExitBlocks(ExitBlocks);
801
Chris Lattnerb2bc3152006-02-10 23:16:39 +0000802 // Add exit blocks to the loop blocks.
803 LoopBlocks.insert(LoopBlocks.end(), ExitBlocks.begin(), ExitBlocks.end());
Chris Lattner18f16092004-04-19 18:07:02 +0000804
805 // Next step, clone all of the basic blocks that make up the loop (including
806 // the loop preheader and exit blocks), keeping track of the mapping between
807 // the instructions and blocks.
Chris Lattner18f16092004-04-19 18:07:02 +0000808 NewBlocks.reserve(LoopBlocks.size());
Rafael Espindola1ed219a2010-10-13 01:36:30 +0000809 ValueToValueMapTy VMap;
Chris Lattner18f16092004-04-19 18:07:02 +0000810 for (unsigned i = 0, e = LoopBlocks.size(); i != e; ++i) {
Devang Patele9916a32010-06-24 00:33:28 +0000811 BasicBlock *NewBB = CloneBasicBlock(LoopBlocks[i], VMap, ".us", F);
Chad Rosiera816bf72011-12-22 21:10:46 +0000812
Evan Cheng0f1666b2010-04-05 21:16:25 +0000813 NewBlocks.push_back(NewBB);
Devang Patele9916a32010-06-24 00:33:28 +0000814 VMap[LoopBlocks[i]] = NewBB; // Keep the BB mapping.
Evan Cheng0f1666b2010-04-05 21:16:25 +0000815 LPM->cloneBasicBlockSimpleAnalysis(LoopBlocks[i], NewBB, L);
Chris Lattner18f16092004-04-19 18:07:02 +0000816 }
817
818 // Splice the newly inserted blocks into the function right before the
819 // original preheader.
Evan Cheng0f1666b2010-04-05 21:16:25 +0000820 F->getBasicBlockList().splice(NewPreheader, F->getBasicBlockList(),
Chris Lattner18f16092004-04-19 18:07:02 +0000821 NewBlocks[0], F->end());
822
823 // Now we create the new Loop object for the versioned loop.
Devang Patele9916a32010-06-24 00:33:28 +0000824 Loop *NewLoop = CloneLoop(L, L->getParentLoop(), VMap, LI, LPM);
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +0000825
826 // Recalculate unswitching quota, inherit simplified switches info for NewBB,
827 // Probably clone more loop-unswitch related loop properties.
828 BranchesInfo.cloneData(NewLoop, L, VMap);
829
Chris Lattnere8255932006-02-10 23:26:14 +0000830 Loop *ParentLoop = L->getParentLoop();
831 if (ParentLoop) {
Chris Lattner18f16092004-04-19 18:07:02 +0000832 // Make sure to add the cloned preheader and exit blocks to the parent loop
833 // as well.
Owen Andersond735ee82007-11-27 03:43:35 +0000834 ParentLoop->addBasicBlockToLoop(NewBlocks[0], LI->getBase());
Chris Lattnere8255932006-02-10 23:26:14 +0000835 }
Bill Wendlingd5520982011-09-27 00:59:31 +0000836
Chris Lattnere8255932006-02-10 23:26:14 +0000837 for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
Devang Patele9916a32010-06-24 00:33:28 +0000838 BasicBlock *NewExit = cast<BasicBlock>(VMap[ExitBlocks[i]]);
Chris Lattner25cae0f2006-02-18 00:55:32 +0000839 // The new exit block should be in the same loop as the old one.
840 if (Loop *ExitBBLoop = LI->getLoopFor(ExitBlocks[i]))
Owen Andersond735ee82007-11-27 03:43:35 +0000841 ExitBBLoop->addBasicBlockToLoop(NewExit, LI->getBase());
Chris Lattnere8255932006-02-10 23:26:14 +0000842
843 assert(NewExit->getTerminator()->getNumSuccessors() == 1 &&
844 "Exit block should have been split to have one successor!");
845 BasicBlock *ExitSucc = NewExit->getTerminator()->getSuccessor(0);
Devang Patel77a01132008-07-03 17:37:52 +0000846
Chris Lattnere8255932006-02-10 23:26:14 +0000847 // If the successor of the exit block had PHI nodes, add an entry for
848 // NewExit.
849 PHINode *PN;
Evan Cheng0f1666b2010-04-05 21:16:25 +0000850 for (BasicBlock::iterator I = ExitSucc->begin(); isa<PHINode>(I); ++I) {
851 PN = cast<PHINode>(I);
Chris Lattnere8255932006-02-10 23:26:14 +0000852 Value *V = PN->getIncomingValueForBlock(ExitBlocks[i]);
Rafael Espindola1ed219a2010-10-13 01:36:30 +0000853 ValueToValueMapTy::iterator It = VMap.find(V);
Devang Patele9916a32010-06-24 00:33:28 +0000854 if (It != VMap.end()) V = It->second;
Chris Lattnere8255932006-02-10 23:26:14 +0000855 PN->addIncoming(V, NewExit);
856 }
Bill Wendlingd5520982011-09-27 00:59:31 +0000857
858 if (LandingPadInst *LPad = NewExit->getLandingPadInst()) {
859 PN = PHINode::Create(LPad->getType(), 0, "",
860 ExitSucc->getFirstInsertionPt());
861
862 for (pred_iterator I = pred_begin(ExitSucc), E = pred_end(ExitSucc);
863 I != E; ++I) {
864 BasicBlock *BB = *I;
865 LandingPadInst *LPI = BB->getLandingPadInst();
866 LPI->replaceAllUsesWith(PN);
867 PN->addIncoming(LPI, BB);
868 }
869 }
Chris Lattner18f16092004-04-19 18:07:02 +0000870 }
871
872 // Rewrite the code to refer to itself.
Nick Lewycky280a6e62008-04-25 16:53:59 +0000873 for (unsigned i = 0, e = NewBlocks.size(); i != e; ++i)
874 for (BasicBlock::iterator I = NewBlocks[i]->begin(),
875 E = NewBlocks[i]->end(); I != E; ++I)
Chris Lattnerb5fa5fc2011-01-08 08:15:20 +0000876 RemapInstruction(I, VMap,RF_NoModuleLevelChanges|RF_IgnoreMissingEntries);
Chris Lattner2f4b8982006-02-09 19:14:52 +0000877
Chris Lattner18f16092004-04-19 18:07:02 +0000878 // Rewrite the original preheader to select between versions of the loop.
Devang Patele6962df2008-07-02 01:18:13 +0000879 BranchInst *OldBR = cast<BranchInst>(loopPreheader->getTerminator());
Chris Lattnerfed5d9d2006-02-15 00:07:43 +0000880 assert(OldBR->isUnconditional() && OldBR->getSuccessor(0) == LoopBlocks[0] &&
Chris Lattner18f16092004-04-19 18:07:02 +0000881 "Preheader splitting did not work correctly!");
Chris Lattner18f16092004-04-19 18:07:02 +0000882
Chris Lattnerfed5d9d2006-02-15 00:07:43 +0000883 // Emit the new branch that selects between the two versions of this loop.
884 EmitPreheaderBranchOnCondition(LIC, Val, NewBlocks[0], LoopBlocks[0], OldBR);
Devang Patel15c260a2007-07-31 08:03:26 +0000885 LPM->deleteSimpleAnalysisValue(OldBR, L);
Devang Patel9ee49c52007-09-20 23:45:50 +0000886 OldBR->eraseFromParent();
Devang Patel1ff61382007-08-02 15:25:57 +0000887
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000888 LoopProcessWorklist.push_back(NewLoop);
Devang Patel6f62af62007-07-30 23:07:10 +0000889 redoLoop = true;
Chris Lattner18f16092004-04-19 18:07:02 +0000890
Chris Lattnera78130c2010-04-20 05:09:16 +0000891 // Keep a WeakVH holding onto LIC. If the first call to RewriteLoopBody
892 // deletes the instruction (for example by simplifying a PHI that feeds into
893 // the condition that we're unswitching on), we don't rewrite the second
894 // iteration.
895 WeakVH LICHandle(LIC);
896
Chris Lattner18f16092004-04-19 18:07:02 +0000897 // Now we rewrite the original code to know that the condition is true and the
898 // new code to know that the condition is false.
Evan Cheng0f1666b2010-04-05 21:16:25 +0000899 RewriteLoopBodyWithConditionConstant(L, LIC, Val, false);
Devang Patel77a01132008-07-03 17:37:52 +0000900
Chris Lattnera78130c2010-04-20 05:09:16 +0000901 // It's possible that simplifying one loop could cause the other to be
902 // changed to another value or a constant. If its a constant, don't simplify
903 // it.
904 if (!LoopProcessWorklist.empty() && LoopProcessWorklist.back() == NewLoop &&
905 LICHandle && !isa<Constant>(LICHandle))
906 RewriteLoopBodyWithConditionConstant(NewLoop, LICHandle, Val, true);
Chris Lattner18f16092004-04-19 18:07:02 +0000907}
908
Chris Lattner52221f72006-02-17 00:31:07 +0000909/// RemoveFromWorklist - Remove all instances of I from the worklist vector
910/// specified.
911static void RemoveFromWorklist(Instruction *I,
912 std::vector<Instruction*> &Worklist) {
913 std::vector<Instruction*>::iterator WI = std::find(Worklist.begin(),
914 Worklist.end(), I);
915 while (WI != Worklist.end()) {
916 unsigned Offset = WI-Worklist.begin();
917 Worklist.erase(WI);
918 WI = std::find(Worklist.begin()+Offset, Worklist.end(), I);
919 }
920}
921
922/// ReplaceUsesOfWith - When we find that I really equals V, remove I from the
923/// program, replacing all uses with V and update the worklist.
924static void ReplaceUsesOfWith(Instruction *I, Value *V,
Devang Patel15c260a2007-07-31 08:03:26 +0000925 std::vector<Instruction*> &Worklist,
926 Loop *L, LPPassManager *LPM) {
David Greened4c56fb2010-01-05 01:27:04 +0000927 DEBUG(dbgs() << "Replace with '" << *V << "': " << *I);
Chris Lattner52221f72006-02-17 00:31:07 +0000928
929 // Add uses to the worklist, which may be dead now.
930 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
931 if (Instruction *Use = dyn_cast<Instruction>(I->getOperand(i)))
932 Worklist.push_back(Use);
933
934 // Add users to the worklist which may be simplified now.
935 for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
936 UI != E; ++UI)
937 Worklist.push_back(cast<Instruction>(*UI));
Devang Patel15c260a2007-07-31 08:03:26 +0000938 LPM->deleteSimpleAnalysisValue(I, L);
Chris Lattner52221f72006-02-17 00:31:07 +0000939 RemoveFromWorklist(I, Worklist);
Devang Patel9ee49c52007-09-20 23:45:50 +0000940 I->replaceAllUsesWith(V);
941 I->eraseFromParent();
Chris Lattner52221f72006-02-17 00:31:07 +0000942 ++NumSimplify;
943}
944
Chris Lattnerdb410242006-02-18 02:42:34 +0000945/// RemoveBlockIfDead - If the specified block is dead, remove it, update loop
946/// information, and remove any dead successors it has.
947///
948void LoopUnswitch::RemoveBlockIfDead(BasicBlock *BB,
Devang Patel15c260a2007-07-31 08:03:26 +0000949 std::vector<Instruction*> &Worklist,
950 Loop *L) {
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000951 if (pred_begin(BB) != pred_end(BB)) {
952 // This block isn't dead, since an edge to BB was just removed, see if there
953 // are any easy simplifications we can do now.
954 if (BasicBlock *Pred = BB->getSinglePredecessor()) {
955 // If it has one pred, fold phi nodes in BB.
956 while (isa<PHINode>(BB->begin()))
957 ReplaceUsesOfWith(BB->begin(),
958 cast<PHINode>(BB->begin())->getIncomingValue(0),
Devang Patel15c260a2007-07-31 08:03:26 +0000959 Worklist, L, LPM);
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000960
961 // If this is the header of a loop and the only pred is the latch, we now
962 // have an unreachable loop.
963 if (Loop *L = LI->getLoopFor(BB))
Devang Patele6962df2008-07-02 01:18:13 +0000964 if (loopHeader == BB && L->contains(Pred)) {
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000965 // Remove the branch from the latch to the header block, this makes
966 // the header dead, which will make the latch dead (because the header
967 // dominates the latch).
Devang Patel15c260a2007-07-31 08:03:26 +0000968 LPM->deleteSimpleAnalysisValue(Pred->getTerminator(), L);
Devang Patel9ee49c52007-09-20 23:45:50 +0000969 Pred->getTerminator()->eraseFromParent();
Owen Anderson1d0be152009-08-13 21:58:54 +0000970 new UnreachableInst(BB->getContext(), Pred);
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000971
972 // The loop is now broken, remove it from LI.
973 RemoveLoopFromHierarchy(L);
974
975 // Reprocess the header, which now IS dead.
Devang Patel15c260a2007-07-31 08:03:26 +0000976 RemoveBlockIfDead(BB, Worklist, L);
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000977 return;
978 }
979
980 // If pred ends in a uncond branch, add uncond branch to worklist so that
981 // the two blocks will get merged.
982 if (BranchInst *BI = dyn_cast<BranchInst>(Pred->getTerminator()))
983 if (BI->isUnconditional())
984 Worklist.push_back(BI);
985 }
986 return;
987 }
Chris Lattner52221f72006-02-17 00:31:07 +0000988
David Greened4c56fb2010-01-05 01:27:04 +0000989 DEBUG(dbgs() << "Nuking dead block: " << *BB);
Chris Lattnerdb410242006-02-18 02:42:34 +0000990
991 // Remove the instructions in the basic block from the worklist.
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000992 for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
Chris Lattnerdb410242006-02-18 02:42:34 +0000993 RemoveFromWorklist(I, Worklist);
Chris Lattnera6fc94b2006-02-18 07:57:38 +0000994
995 // Anything that uses the instructions in this basic block should have their
996 // uses replaced with undefs.
Devang Patel228ebd02009-10-13 22:56:32 +0000997 // If I is not void type then replaceAllUsesWith undef.
998 // This allows ValueHandlers and custom metadata to adjust itself.
Devang Patel9674d152009-10-14 17:29:00 +0000999 if (!I->getType()->isVoidTy())
Devang Patel228ebd02009-10-13 22:56:32 +00001000 I->replaceAllUsesWith(UndefValue::get(I->getType()));
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001001 }
Chris Lattnerdb410242006-02-18 02:42:34 +00001002
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001003 // If this is the edge to the header block for a loop, remove the loop and
1004 // promote all subloops.
Chris Lattnerdb410242006-02-18 02:42:34 +00001005 if (Loop *BBLoop = LI->getLoopFor(BB)) {
Evan Cheng424641e2011-05-24 23:12:57 +00001006 if (BBLoop->getLoopLatch() == BB) {
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001007 RemoveLoopFromHierarchy(BBLoop);
Evan Cheng424641e2011-05-24 23:12:57 +00001008 if (currentLoop == BBLoop) {
1009 currentLoop = 0;
1010 redoLoop = false;
1011 }
1012 }
Chris Lattnerdb410242006-02-18 02:42:34 +00001013 }
1014
1015 // Remove the block from the loop info, which removes it from any loops it
1016 // was in.
1017 LI->removeBlock(BB);
1018
1019
1020 // Remove phi node entries in successors for this block.
1021 TerminatorInst *TI = BB->getTerminator();
Chris Lattnera3522002008-12-01 06:52:57 +00001022 SmallVector<BasicBlock*, 4> Succs;
Chris Lattnerdb410242006-02-18 02:42:34 +00001023 for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i) {
1024 Succs.push_back(TI->getSuccessor(i));
1025 TI->getSuccessor(i)->removePredecessor(BB);
Chris Lattnerf4412d82006-02-18 01:27:45 +00001026 }
1027
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001028 // Unique the successors, remove anything with multiple uses.
Chris Lattnera3522002008-12-01 06:52:57 +00001029 array_pod_sort(Succs.begin(), Succs.end());
Chris Lattnerdb410242006-02-18 02:42:34 +00001030 Succs.erase(std::unique(Succs.begin(), Succs.end()), Succs.end());
1031
1032 // Remove the basic block, including all of the instructions contained in it.
Devang Patel15c260a2007-07-31 08:03:26 +00001033 LPM->deleteSimpleAnalysisValue(BB, L);
Devang Patel9ee49c52007-09-20 23:45:50 +00001034 BB->eraseFromParent();
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001035 // Remove successor blocks here that are not dead, so that we know we only
1036 // have dead blocks in this list. Nondead blocks have a way of becoming dead,
1037 // then getting removed before we revisit them, which is badness.
1038 //
1039 for (unsigned i = 0; i != Succs.size(); ++i)
1040 if (pred_begin(Succs[i]) != pred_end(Succs[i])) {
1041 // One exception is loop headers. If this block was the preheader for a
1042 // loop, then we DO want to visit the loop so the loop gets deleted.
1043 // We know that if the successor is a loop header, that this loop had to
1044 // be the preheader: the case where this was the latch block was handled
1045 // above and headers can only have two predecessors.
1046 if (!LI->isLoopHeader(Succs[i])) {
1047 Succs.erase(Succs.begin()+i);
1048 --i;
1049 }
1050 }
1051
Chris Lattnerdb410242006-02-18 02:42:34 +00001052 for (unsigned i = 0, e = Succs.size(); i != e; ++i)
Devang Patel15c260a2007-07-31 08:03:26 +00001053 RemoveBlockIfDead(Succs[i], Worklist, L);
Chris Lattnerf4412d82006-02-18 01:27:45 +00001054}
Chris Lattner52221f72006-02-17 00:31:07 +00001055
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001056/// RemoveLoopFromHierarchy - We have discovered that the specified loop has
1057/// become unwrapped, either because the backedge was deleted, or because the
1058/// edge into the header was removed. If the edge into the header from the
1059/// latch block was removed, the loop is unwrapped but subloops are still alive,
1060/// so they just reparent loops. If the loops are actually dead, they will be
1061/// removed later.
1062void LoopUnswitch::RemoveLoopFromHierarchy(Loop *L) {
Devang Patel1bc89362007-03-07 00:26:10 +00001063 LPM->deleteLoopFromQueue(L);
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001064 RemoveLoopFromWorklist(L);
1065}
1066
Chris Lattnerc2358092006-02-11 00:43:37 +00001067// RewriteLoopBodyWithConditionConstant - We know either that the value LIC has
1068// the value specified by Val in the specified loop, or we know it does NOT have
1069// that value. Rewrite any uses of LIC or of properties correlated to it.
Chris Lattner18f16092004-04-19 18:07:02 +00001070void LoopUnswitch::RewriteLoopBodyWithConditionConstant(Loop *L, Value *LIC,
Chris Lattnerc2358092006-02-11 00:43:37 +00001071 Constant *Val,
1072 bool IsEqual) {
Chris Lattner4c41d492006-02-10 01:24:09 +00001073 assert(!isa<Constant>(LIC) && "Why are we unswitching on a constant?");
Chris Lattnerc2358092006-02-11 00:43:37 +00001074
Chris Lattner18f16092004-04-19 18:07:02 +00001075 // FIXME: Support correlated properties, like:
1076 // for (...)
1077 // if (li1 < li2)
1078 // ...
1079 // if (li1 > li2)
1080 // ...
Chris Lattnerc2358092006-02-11 00:43:37 +00001081
Chris Lattner708e1a52006-02-10 02:30:37 +00001082 // FOLD boolean conditions (X|LIC), (X&LIC). Fold conditional branches,
1083 // selects, switches.
Chris Lattner52221f72006-02-17 00:31:07 +00001084 std::vector<Instruction*> Worklist;
Owen Andersone922c022009-07-22 00:24:57 +00001085 LLVMContext &Context = Val->getContext();
1086
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001087
Chris Lattner52221f72006-02-17 00:31:07 +00001088 // If we know that LIC == Val, or that LIC == NotVal, just replace uses of LIC
1089 // in the loop with the appropriate one directly.
Owen Anderson1d0be152009-08-13 21:58:54 +00001090 if (IsEqual || (isa<ConstantInt>(Val) &&
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00001091 Val->getType()->isIntegerTy(1))) {
Chris Lattnerbd28e3f2006-02-22 06:37:14 +00001092 Value *Replacement;
1093 if (IsEqual)
1094 Replacement = Val;
1095 else
Owen Anderson1d0be152009-08-13 21:58:54 +00001096 Replacement = ConstantInt::get(Type::getInt1Ty(Val->getContext()),
Reid Spencer579dca12007-01-12 04:24:46 +00001097 !cast<ConstantInt>(Val)->getZExtValue());
Chris Lattner52221f72006-02-17 00:31:07 +00001098
Evan Cheng424641e2011-05-24 23:12:57 +00001099 for (Value::use_iterator UI = LIC->use_begin(), E = LIC->use_end();
1100 UI != E; ++UI) {
Evan Cheng21d378d2011-05-24 23:47:50 +00001101 Instruction *U = dyn_cast<Instruction>(*UI);
1102 if (!U || !L->contains(U))
Evan Cheng424641e2011-05-24 23:12:57 +00001103 continue;
Evan Cheng424641e2011-05-24 23:12:57 +00001104 Worklist.push_back(U);
1105 }
Stepan Dyatkovskiybe4c8442011-11-29 20:34:39 +00001106
1107 for (std::vector<Instruction*>::iterator UI = Worklist.begin();
1108 UI != Worklist.end(); ++UI)
1109 (*UI)->replaceUsesOfWith(LIC, Replacement);
1110
Chris Lattner9e185802010-04-05 21:18:32 +00001111 SimplifyCode(Worklist, L);
1112 return;
1113 }
1114
1115 // Otherwise, we don't know the precise value of LIC, but we do know that it
1116 // is certainly NOT "Val". As such, simplify any uses in the loop that we
1117 // can. This case occurs when we unswitch switch statements.
Evan Cheng424641e2011-05-24 23:12:57 +00001118 for (Value::use_iterator UI = LIC->use_begin(), E = LIC->use_end();
1119 UI != E; ++UI) {
Evan Cheng21d378d2011-05-24 23:47:50 +00001120 Instruction *U = dyn_cast<Instruction>(*UI);
1121 if (!U || !L->contains(U))
Chris Lattner9e185802010-04-05 21:18:32 +00001122 continue;
Chris Lattner52221f72006-02-17 00:31:07 +00001123
Chris Lattner9e185802010-04-05 21:18:32 +00001124 Worklist.push_back(U);
Chris Lattner52221f72006-02-17 00:31:07 +00001125
Chris Lattner9e185802010-04-05 21:18:32 +00001126 // TODO: We could do other simplifications, for example, turning
1127 // 'icmp eq LIC, Val' -> false.
1128
1129 // If we know that LIC is not Val, use this info to simplify code.
1130 SwitchInst *SI = dyn_cast<SwitchInst>(U);
1131 if (SI == 0 || !isa<ConstantInt>(Val)) continue;
1132
1133 unsigned DeadCase = SI->findCaseValue(cast<ConstantInt>(Val));
1134 if (DeadCase == 0) continue; // Default case is live for multiple values.
1135
1136 // Found a dead case value. Don't remove PHI nodes in the
1137 // successor if they become single-entry, those PHI nodes may
1138 // be in the Users list.
Nick Lewycky444f2972011-06-03 06:27:15 +00001139
Evan Cheng424641e2011-05-24 23:12:57 +00001140 BasicBlock *Switch = SI->getParent();
1141 BasicBlock *SISucc = SI->getSuccessor(DeadCase);
1142 BasicBlock *Latch = L->getLoopLatch();
Chad Rosiera816bf72011-12-22 21:10:46 +00001143
Stepan Dyatkovskiy209287d2012-01-15 09:44:07 +00001144 BranchesInfo.setUnswitched(SI, Val);
Chad Rosiera816bf72011-12-22 21:10:46 +00001145
Nick Lewycky444f2972011-06-03 06:27:15 +00001146 if (!SI->findCaseDest(SISucc)) continue; // Edge is critical.
Evan Cheng237d10d2011-05-25 18:17:13 +00001147 // If the DeadCase successor dominates the loop latch, then the
1148 // transformation isn't safe since it will delete the sole predecessor edge
1149 // to the latch.
1150 if (Latch && DT->dominates(SISucc, Latch))
1151 continue;
Evan Cheng424641e2011-05-24 23:12:57 +00001152
Chris Lattner9e185802010-04-05 21:18:32 +00001153 // FIXME: This is a hack. We need to keep the successor around
1154 // and hooked up so as to preserve the loop structure, because
1155 // trying to update it is complicated. So instead we preserve the
1156 // loop structure and put the block on a dead code path.
Evan Cheng424641e2011-05-24 23:12:57 +00001157 SplitEdge(Switch, SISucc, this);
Chris Lattner9e185802010-04-05 21:18:32 +00001158 // Compute the successors instead of relying on the return value
1159 // of SplitEdge, since it may have split the switch successor
1160 // after PHI nodes.
1161 BasicBlock *NewSISucc = SI->getSuccessor(DeadCase);
1162 BasicBlock *OldSISucc = *succ_begin(NewSISucc);
1163 // Create an "unreachable" destination.
1164 BasicBlock *Abort = BasicBlock::Create(Context, "us-unreachable",
1165 Switch->getParent(),
1166 OldSISucc);
1167 new UnreachableInst(Context, Abort);
1168 // Force the new case destination to branch to the "unreachable"
1169 // block while maintaining a (dead) CFG edge to the old block.
1170 NewSISucc->getTerminator()->eraseFromParent();
1171 BranchInst::Create(Abort, OldSISucc,
1172 ConstantInt::getTrue(Context), NewSISucc);
1173 // Release the PHI operands for this edge.
1174 for (BasicBlock::iterator II = NewSISucc->begin();
1175 PHINode *PN = dyn_cast<PHINode>(II); ++II)
1176 PN->setIncomingValue(PN->getBasicBlockIndex(Switch),
1177 UndefValue::get(PN->getType()));
1178 // Tell the domtree about the new block. We don't fully update the
1179 // domtree here -- instead we force it to do a full recomputation
1180 // after the pass is complete -- but we do need to inform it of
1181 // new blocks.
1182 if (DT)
1183 DT->addNewBlock(Abort, NewSISucc);
Chris Lattner52221f72006-02-17 00:31:07 +00001184 }
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001185
Devang Patel15c260a2007-07-31 08:03:26 +00001186 SimplifyCode(Worklist, L);
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001187}
1188
Mike Stumpc02f0d72009-09-09 17:57:16 +00001189/// SimplifyCode - Okay, now that we have simplified some instructions in the
Chris Lattnera6fc94b2006-02-18 07:57:38 +00001190/// loop, walk over it and constant prop, dce, and fold control flow where
1191/// possible. Note that this is effectively a very simple loop-structure-aware
1192/// optimizer. During processing of this loop, L could very well be deleted, so
1193/// it must not be used.
1194///
1195/// FIXME: When the loop optimizer is more mature, separate this out to a new
1196/// pass.
1197///
Devang Patel15c260a2007-07-31 08:03:26 +00001198void LoopUnswitch::SimplifyCode(std::vector<Instruction*> &Worklist, Loop *L) {
Chris Lattner52221f72006-02-17 00:31:07 +00001199 while (!Worklist.empty()) {
1200 Instruction *I = Worklist.back();
1201 Worklist.pop_back();
Duncan Sands0f827632010-11-23 20:24:21 +00001202
Chris Lattner52221f72006-02-17 00:31:07 +00001203 // Simple DCE.
1204 if (isInstructionTriviallyDead(I)) {
David Greened4c56fb2010-01-05 01:27:04 +00001205 DEBUG(dbgs() << "Remove dead instruction '" << *I);
Chris Lattner52221f72006-02-17 00:31:07 +00001206
1207 // Add uses to the worklist, which may be dead now.
1208 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
1209 if (Instruction *Use = dyn_cast<Instruction>(I->getOperand(i)))
1210 Worklist.push_back(Use);
Devang Patel15c260a2007-07-31 08:03:26 +00001211 LPM->deleteSimpleAnalysisValue(I, L);
Chris Lattner52221f72006-02-17 00:31:07 +00001212 RemoveFromWorklist(I, Worklist);
Devang Patel9ee49c52007-09-20 23:45:50 +00001213 I->eraseFromParent();
Chris Lattner52221f72006-02-17 00:31:07 +00001214 ++NumSimplify;
1215 continue;
1216 }
Duncan Sandsd0c6f3d2010-11-18 19:59:41 +00001217
Chris Lattner4f1f6f62010-04-20 05:33:18 +00001218 // See if instruction simplification can hack this up. This is common for
1219 // things like "select false, X, Y" after unswitching made the condition be
1220 // 'false'.
Chad Rosier618c1db2011-12-01 03:08:23 +00001221 if (Value *V = SimplifyInstruction(I, 0, 0, DT))
Duncan Sandsd0c6f3d2010-11-18 19:59:41 +00001222 if (LI->replacementPreservesLCSSAForm(I, V)) {
1223 ReplaceUsesOfWith(I, V, Worklist, L, LPM);
1224 continue;
1225 }
1226
Chris Lattner52221f72006-02-17 00:31:07 +00001227 // Special case hacks that appear commonly in unswitched code.
Chris Lattner4f1f6f62010-04-20 05:33:18 +00001228 if (BranchInst *BI = dyn_cast<BranchInst>(I)) {
Chris Lattner52221f72006-02-17 00:31:07 +00001229 if (BI->isUnconditional()) {
1230 // If BI's parent is the only pred of the successor, fold the two blocks
1231 // together.
1232 BasicBlock *Pred = BI->getParent();
1233 BasicBlock *Succ = BI->getSuccessor(0);
1234 BasicBlock *SinglePred = Succ->getSinglePredecessor();
1235 if (!SinglePred) continue; // Nothing to do.
1236 assert(SinglePred == Pred && "CFG broken");
1237
David Greened4c56fb2010-01-05 01:27:04 +00001238 DEBUG(dbgs() << "Merging blocks: " << Pred->getName() << " <- "
Daniel Dunbarce63ffb2009-07-25 00:23:56 +00001239 << Succ->getName() << "\n");
Chris Lattner52221f72006-02-17 00:31:07 +00001240
1241 // Resolve any single entry PHI nodes in Succ.
1242 while (PHINode *PN = dyn_cast<PHINode>(Succ->begin()))
Devang Patel15c260a2007-07-31 08:03:26 +00001243 ReplaceUsesOfWith(PN, PN->getIncomingValue(0), Worklist, L, LPM);
Chris Lattner52221f72006-02-17 00:31:07 +00001244
Jay Foad95c3e482011-06-23 09:09:15 +00001245 // If Succ has any successors with PHI nodes, update them to have
1246 // entries coming from Pred instead of Succ.
1247 Succ->replaceAllUsesWith(Pred);
1248
Chris Lattner52221f72006-02-17 00:31:07 +00001249 // Move all of the successor contents from Succ to Pred.
1250 Pred->getInstList().splice(BI, Succ->getInstList(), Succ->begin(),
1251 Succ->end());
Devang Patel15c260a2007-07-31 08:03:26 +00001252 LPM->deleteSimpleAnalysisValue(BI, L);
Devang Patel9ee49c52007-09-20 23:45:50 +00001253 BI->eraseFromParent();
Chris Lattner52221f72006-02-17 00:31:07 +00001254 RemoveFromWorklist(BI, Worklist);
1255
Chris Lattner52221f72006-02-17 00:31:07 +00001256 // Remove Succ from the loop tree.
1257 LI->removeBlock(Succ);
Devang Patel15c260a2007-07-31 08:03:26 +00001258 LPM->deleteSimpleAnalysisValue(Succ, L);
Devang Patel9ee49c52007-09-20 23:45:50 +00001259 Succ->eraseFromParent();
Chris Lattnerf4412d82006-02-18 01:27:45 +00001260 ++NumSimplify;
Chris Lattner4f1f6f62010-04-20 05:33:18 +00001261 continue;
Chris Lattner9e185802010-04-05 21:18:32 +00001262 }
1263
1264 if (ConstantInt *CB = dyn_cast<ConstantInt>(BI->getCondition())){
Chris Lattnerdb410242006-02-18 02:42:34 +00001265 // Conditional branch. Turn it into an unconditional branch, then
1266 // remove dead blocks.
Chris Lattner4f1f6f62010-04-20 05:33:18 +00001267 continue; // FIXME: Enable.
Chris Lattnerbd28e3f2006-02-22 06:37:14 +00001268
David Greened4c56fb2010-01-05 01:27:04 +00001269 DEBUG(dbgs() << "Folded branch: " << *BI);
Reid Spencer579dca12007-01-12 04:24:46 +00001270 BasicBlock *DeadSucc = BI->getSuccessor(CB->getZExtValue());
1271 BasicBlock *LiveSucc = BI->getSuccessor(!CB->getZExtValue());
Chris Lattnerdb410242006-02-18 02:42:34 +00001272 DeadSucc->removePredecessor(BI->getParent(), true);
Gabor Greif051a9502008-04-06 20:25:17 +00001273 Worklist.push_back(BranchInst::Create(LiveSucc, BI));
Devang Patel15c260a2007-07-31 08:03:26 +00001274 LPM->deleteSimpleAnalysisValue(BI, L);
Devang Patel9ee49c52007-09-20 23:45:50 +00001275 BI->eraseFromParent();
Chris Lattnerdb410242006-02-18 02:42:34 +00001276 RemoveFromWorklist(BI, Worklist);
1277 ++NumSimplify;
1278
Devang Patel15c260a2007-07-31 08:03:26 +00001279 RemoveBlockIfDead(DeadSucc, Worklist, L);
Chris Lattner52221f72006-02-17 00:31:07 +00001280 }
Chris Lattner4f1f6f62010-04-20 05:33:18 +00001281 continue;
Chris Lattner52221f72006-02-17 00:31:07 +00001282 }
1283 }
Chris Lattner18f16092004-04-19 18:07:02 +00001284}