blob: 99f5e7fd66b5038c9038f03e282215d727d06f23 [file] [log] [blame]
Chris Lattner6148c022001-12-03 17:28:42 +00001//===- IndVarSimplify.cpp - Induction Variable Elimination ----------------===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanfd939082005-04-21 23:48:37 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner6148c022001-12-03 17:28:42 +00009//
Chris Lattner40bf8b42004-04-02 20:24:31 +000010// This transformation analyzes and transforms the induction variables (and
11// computations derived from them) into simpler forms suitable for subsequent
12// analysis and transformation.
13//
Reid Spencer47a53ac2006-08-18 09:01:07 +000014// This transformation makes the following changes to each loop with an
Chris Lattner40bf8b42004-04-02 20:24:31 +000015// identifiable induction variable:
16// 1. All loops are transformed to have a SINGLE canonical induction variable
17// which starts at zero and steps by one.
18// 2. The canonical induction variable is guaranteed to be the first PHI node
19// in the loop header block.
Dan Gohmanea73f3c2009-06-14 22:38:41 +000020// 3. The canonical induction variable is guaranteed to be in a wide enough
21// type so that IV expressions need not be (directly) zero-extended or
22// sign-extended.
23// 4. Any pointer arithmetic recurrences are raised to use array subscripts.
Chris Lattner40bf8b42004-04-02 20:24:31 +000024//
25// If the trip count of a loop is computable, this pass also makes the following
26// changes:
27// 1. The exit condition for the loop is canonicalized to compare the
28// induction value against the exit value. This turns loops like:
29// 'for (i = 7; i*i < 1000; ++i)' into 'for (i = 0; i != 25; ++i)'
30// 2. Any use outside of the loop of an expression derived from the indvar
31// is changed to compute the derived value outside of the loop, eliminating
32// the dependence on the exit value of the induction variable. If the only
33// purpose of the loop is to compute the exit value of some derived
34// expression, this transformation will make the loop dead.
35//
36// This transformation should be followed by strength reduction after all of the
Dan Gohmanc2c4cbf2009-05-19 20:38:47 +000037// desired loop transformations have been performed.
Chris Lattner6148c022001-12-03 17:28:42 +000038//
39//===----------------------------------------------------------------------===//
40
Chris Lattner0e5f4992006-12-19 21:40:18 +000041#define DEBUG_TYPE "indvars"
Chris Lattner022103b2002-05-07 20:03:00 +000042#include "llvm/Transforms/Scalar.h"
Chris Lattner40bf8b42004-04-02 20:24:31 +000043#include "llvm/BasicBlock.h"
Chris Lattner59fdaee2004-04-15 15:21:43 +000044#include "llvm/Constants.h"
Chris Lattner18b3c972003-12-22 05:02:01 +000045#include "llvm/Instructions.h"
Devang Patel7b9f6b12010-03-15 22:23:03 +000046#include "llvm/IntrinsicInst.h"
Owen Andersond672ecb2009-07-03 00:17:18 +000047#include "llvm/LLVMContext.h"
Chris Lattner40bf8b42004-04-02 20:24:31 +000048#include "llvm/Type.h"
Dan Gohman81db61a2009-05-12 02:17:14 +000049#include "llvm/Analysis/Dominators.h"
50#include "llvm/Analysis/IVUsers.h"
Nate Begeman36f891b2005-07-30 00:12:19 +000051#include "llvm/Analysis/ScalarEvolutionExpander.h"
John Criswell47df12d2003-12-18 17:19:19 +000052#include "llvm/Analysis/LoopInfo.h"
Devang Patel5ee99972007-03-07 06:39:01 +000053#include "llvm/Analysis/LoopPass.h"
Chris Lattner455889a2002-02-12 22:39:50 +000054#include "llvm/Support/CFG.h"
Chris Lattneree4f13a2007-01-07 01:14:12 +000055#include "llvm/Support/Debug.h"
Chris Lattnerbdff5482009-08-23 04:37:46 +000056#include "llvm/Support/raw_ostream.h"
John Criswell47df12d2003-12-18 17:19:19 +000057#include "llvm/Transforms/Utils/Local.h"
Dan Gohman81db61a2009-05-12 02:17:14 +000058#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Andrew Trick37da4082011-05-04 02:10:13 +000059#include "llvm/Target/TargetData.h"
Reid Spencera54b7cb2007-01-12 07:05:14 +000060#include "llvm/ADT/SmallVector.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000061#include "llvm/ADT/Statistic.h"
Dan Gohman81db61a2009-05-12 02:17:14 +000062#include "llvm/ADT/STLExtras.h"
John Criswell47df12d2003-12-18 17:19:19 +000063using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000064
Chris Lattner0e5f4992006-12-19 21:40:18 +000065STATISTIC(NumRemoved , "Number of aux indvars removed");
Andrew Trick37da4082011-05-04 02:10:13 +000066STATISTIC(NumWidened , "Number of indvars widened");
Chris Lattner0e5f4992006-12-19 21:40:18 +000067STATISTIC(NumInserted, "Number of canonical indvars added");
68STATISTIC(NumReplaced, "Number of exit values replaced");
69STATISTIC(NumLFTR , "Number of loop exit tests replaced");
Chris Lattner3324e712003-12-22 03:58:44 +000070
Andrew Trick37da4082011-05-04 02:10:13 +000071// DisableIVRewrite mode currently affects IVUsers, so is defined in libAnalysis
72// and referenced here.
73namespace llvm {
74 extern bool DisableIVRewrite;
75}
76
Chris Lattner0e5f4992006-12-19 21:40:18 +000077namespace {
Chris Lattner3e8b6632009-09-02 06:11:42 +000078 class IndVarSimplify : public LoopPass {
Dan Gohman81db61a2009-05-12 02:17:14 +000079 IVUsers *IU;
Chris Lattner40bf8b42004-04-02 20:24:31 +000080 LoopInfo *LI;
81 ScalarEvolution *SE;
Dan Gohmande53dc02009-06-27 05:16:57 +000082 DominatorTree *DT;
Andrew Trick37da4082011-05-04 02:10:13 +000083 TargetData *TD;
Andrew Trickb12a7542011-03-17 23:51:11 +000084 SmallVector<WeakVH, 16> DeadInsts;
Chris Lattner15cad752003-12-23 07:47:09 +000085 bool Changed;
Chris Lattner3324e712003-12-22 03:58:44 +000086 public:
Devang Patel794fd752007-05-01 21:15:47 +000087
Dan Gohman5668cf72009-07-15 01:26:32 +000088 static char ID; // Pass identification, replacement for typeid
Andrew Trick37da4082011-05-04 02:10:13 +000089 IndVarSimplify() : LoopPass(ID), IU(0), LI(0), SE(0), DT(0), TD(0) {
Owen Anderson081c34b2010-10-19 17:21:58 +000090 initializeIndVarSimplifyPass(*PassRegistry::getPassRegistry());
91 }
Devang Patel794fd752007-05-01 21:15:47 +000092
Dan Gohman5668cf72009-07-15 01:26:32 +000093 virtual bool runOnLoop(Loop *L, LPPassManager &LPM);
Dan Gohman60f8a632009-02-17 20:49:49 +000094
Dan Gohman5668cf72009-07-15 01:26:32 +000095 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
96 AU.addRequired<DominatorTree>();
97 AU.addRequired<LoopInfo>();
98 AU.addRequired<ScalarEvolution>();
99 AU.addRequiredID(LoopSimplifyID);
100 AU.addRequiredID(LCSSAID);
101 AU.addRequired<IVUsers>();
102 AU.addPreserved<ScalarEvolution>();
103 AU.addPreservedID(LoopSimplifyID);
104 AU.addPreservedID(LCSSAID);
105 AU.addPreserved<IVUsers>();
106 AU.setPreservesCFG();
107 }
Chris Lattner15cad752003-12-23 07:47:09 +0000108
Chris Lattner40bf8b42004-04-02 20:24:31 +0000109 private:
Andrew Trickb12a7542011-03-17 23:51:11 +0000110 bool isValidRewrite(Value *FromVal, Value *ToVal);
Devang Patel5ee99972007-03-07 06:39:01 +0000111
Andrew Trickaeee4612011-05-12 00:04:28 +0000112 void SimplifyIVUsers();
113 void EliminateIVComparison(ICmpInst *ICmp, Value *IVOperand);
114 void EliminateIVRemainder(BinaryOperator *Rem,
115 Value *IVOperand,
116 bool isSigned);
Dan Gohman60f8a632009-02-17 20:49:49 +0000117 void RewriteNonIntegerIVs(Loop *L);
Andrew Trick37da4082011-05-04 02:10:13 +0000118 const Type *WidenIVs(Loop *L, SCEVExpander &Rewriter);
Dan Gohman60f8a632009-02-17 20:49:49 +0000119
Andrew Trick4dfdf242011-05-03 22:24:10 +0000120 bool canExpandBackedgeTakenCount(Loop *L,
121 const SCEV *BackedgeTakenCount);
122
Dan Gohman0bba49c2009-07-07 17:06:11 +0000123 ICmpInst *LinearFunctionTestReplace(Loop *L, const SCEV *BackedgeTakenCount,
Andrew Trick4dfdf242011-05-03 22:24:10 +0000124 PHINode *IndVar,
125 SCEVExpander &Rewriter);
Andrew Trick37da4082011-05-04 02:10:13 +0000126
Dan Gohman454d26d2010-02-22 04:11:59 +0000127 void RewriteLoopExitValues(Loop *L, SCEVExpander &Rewriter);
Chris Lattner40bf8b42004-04-02 20:24:31 +0000128
Dan Gohman454d26d2010-02-22 04:11:59 +0000129 void RewriteIVExpressions(Loop *L, SCEVExpander &Rewriter);
Devang Pateld22a8492008-09-09 21:41:07 +0000130
Dan Gohman667d7872009-06-26 22:53:46 +0000131 void SinkUnusedInvariants(Loop *L);
Dan Gohman81db61a2009-05-12 02:17:14 +0000132
133 void HandleFloatingPointIV(Loop *L, PHINode *PH);
Chris Lattner3324e712003-12-22 03:58:44 +0000134 };
Chris Lattner5e761402002-09-10 05:24:05 +0000135}
Chris Lattner394437f2001-12-04 04:32:29 +0000136
Dan Gohman844731a2008-05-13 00:00:25 +0000137char IndVarSimplify::ID = 0;
Owen Anderson2ab36d32010-10-12 19:48:12 +0000138INITIALIZE_PASS_BEGIN(IndVarSimplify, "indvars",
Andrew Trick37da4082011-05-04 02:10:13 +0000139 "Induction Variable Simplification", false, false)
Owen Anderson2ab36d32010-10-12 19:48:12 +0000140INITIALIZE_PASS_DEPENDENCY(DominatorTree)
141INITIALIZE_PASS_DEPENDENCY(LoopInfo)
142INITIALIZE_PASS_DEPENDENCY(ScalarEvolution)
143INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
144INITIALIZE_PASS_DEPENDENCY(LCSSA)
145INITIALIZE_PASS_DEPENDENCY(IVUsers)
146INITIALIZE_PASS_END(IndVarSimplify, "indvars",
Andrew Trick37da4082011-05-04 02:10:13 +0000147 "Induction Variable Simplification", false, false)
Dan Gohman844731a2008-05-13 00:00:25 +0000148
Daniel Dunbar394f0442008-10-22 23:32:42 +0000149Pass *llvm::createIndVarSimplifyPass() {
Chris Lattner3324e712003-12-22 03:58:44 +0000150 return new IndVarSimplify();
Chris Lattner394437f2001-12-04 04:32:29 +0000151}
152
Andrew Trickb12a7542011-03-17 23:51:11 +0000153/// isValidRewrite - Return true if the SCEV expansion generated by the
154/// rewriter can replace the original value. SCEV guarantees that it
155/// produces the same value, but the way it is produced may be illegal IR.
156/// Ideally, this function will only be called for verification.
157bool IndVarSimplify::isValidRewrite(Value *FromVal, Value *ToVal) {
158 // If an SCEV expression subsumed multiple pointers, its expansion could
159 // reassociate the GEP changing the base pointer. This is illegal because the
160 // final address produced by a GEP chain must be inbounds relative to its
161 // underlying object. Otherwise basic alias analysis, among other things,
162 // could fail in a dangerous way. Ultimately, SCEV will be improved to avoid
163 // producing an expression involving multiple pointers. Until then, we must
164 // bail out here.
165 //
166 // Retrieve the pointer operand of the GEP. Don't use GetUnderlyingObject
167 // because it understands lcssa phis while SCEV does not.
168 Value *FromPtr = FromVal;
169 Value *ToPtr = ToVal;
170 if (GEPOperator *GEP = dyn_cast<GEPOperator>(FromVal)) {
171 FromPtr = GEP->getPointerOperand();
172 }
173 if (GEPOperator *GEP = dyn_cast<GEPOperator>(ToVal)) {
174 ToPtr = GEP->getPointerOperand();
175 }
176 if (FromPtr != FromVal || ToPtr != ToVal) {
177 // Quickly check the common case
178 if (FromPtr == ToPtr)
179 return true;
180
181 // SCEV may have rewritten an expression that produces the GEP's pointer
182 // operand. That's ok as long as the pointer operand has the same base
183 // pointer. Unlike GetUnderlyingObject(), getPointerBase() will find the
184 // base of a recurrence. This handles the case in which SCEV expansion
185 // converts a pointer type recurrence into a nonrecurrent pointer base
186 // indexed by an integer recurrence.
187 const SCEV *FromBase = SE->getPointerBase(SE->getSCEV(FromPtr));
188 const SCEV *ToBase = SE->getPointerBase(SE->getSCEV(ToPtr));
189 if (FromBase == ToBase)
190 return true;
191
192 DEBUG(dbgs() << "INDVARS: GEP rewrite bail out "
193 << *FromBase << " != " << *ToBase << "\n");
194
195 return false;
196 }
197 return true;
198}
199
Andrew Trick4dfdf242011-05-03 22:24:10 +0000200/// canExpandBackedgeTakenCount - Return true if this loop's backedge taken
201/// count expression can be safely and cheaply expanded into an instruction
202/// sequence that can be used by LinearFunctionTestReplace.
203bool IndVarSimplify::
204canExpandBackedgeTakenCount(Loop *L,
205 const SCEV *BackedgeTakenCount) {
206 if (isa<SCEVCouldNotCompute>(BackedgeTakenCount) ||
207 BackedgeTakenCount->isZero())
208 return false;
209
210 if (!L->getExitingBlock())
211 return false;
212
213 // Can't rewrite non-branch yet.
214 BranchInst *BI = dyn_cast<BranchInst>(L->getExitingBlock()->getTerminator());
215 if (!BI)
216 return false;
217
Dan Gohmanca9b7032010-04-12 21:13:43 +0000218 // Special case: If the backedge-taken count is a UDiv, it's very likely a
219 // UDiv that ScalarEvolution produced in order to compute a precise
220 // expression, rather than a UDiv from the user's code. If we can't find a
221 // UDiv in the code with some simple searching, assume the former and forego
222 // rewriting the loop.
223 if (isa<SCEVUDivExpr>(BackedgeTakenCount)) {
224 ICmpInst *OrigCond = dyn_cast<ICmpInst>(BI->getCondition());
Andrew Trick37da4082011-05-04 02:10:13 +0000225 if (!OrigCond) return false;
Dan Gohmanca9b7032010-04-12 21:13:43 +0000226 const SCEV *R = SE->getSCEV(OrigCond->getOperand(1));
Dan Gohmandeff6212010-05-03 22:09:21 +0000227 R = SE->getMinusSCEV(R, SE->getConstant(R->getType(), 1));
Dan Gohmanca9b7032010-04-12 21:13:43 +0000228 if (R != BackedgeTakenCount) {
229 const SCEV *L = SE->getSCEV(OrigCond->getOperand(0));
Dan Gohmandeff6212010-05-03 22:09:21 +0000230 L = SE->getMinusSCEV(L, SE->getConstant(L->getType(), 1));
Dan Gohmanca9b7032010-04-12 21:13:43 +0000231 if (L != BackedgeTakenCount)
Andrew Trick4dfdf242011-05-03 22:24:10 +0000232 return false;
Dan Gohmanca9b7032010-04-12 21:13:43 +0000233 }
234 }
Andrew Trick4dfdf242011-05-03 22:24:10 +0000235 return true;
236}
237
238/// LinearFunctionTestReplace - This method rewrites the exit condition of the
239/// loop to be a canonical != comparison against the incremented loop induction
240/// variable. This pass is able to rewrite the exit tests of any loop where the
241/// SCEV analysis can determine a loop-invariant trip count of the loop, which
242/// is actually a much broader range than just linear tests.
243ICmpInst *IndVarSimplify::
244LinearFunctionTestReplace(Loop *L,
245 const SCEV *BackedgeTakenCount,
246 PHINode *IndVar,
247 SCEVExpander &Rewriter) {
248 assert(canExpandBackedgeTakenCount(L, BackedgeTakenCount) && "precondition");
249 BranchInst *BI = cast<BranchInst>(L->getExitingBlock()->getTerminator());
Dan Gohmanca9b7032010-04-12 21:13:43 +0000250
Chris Lattnerd2440572004-04-15 20:26:22 +0000251 // If the exiting block is not the same as the backedge block, we must compare
252 // against the preincremented value, otherwise we prefer to compare against
253 // the post-incremented value.
Dan Gohmanc2390b12009-02-12 22:19:27 +0000254 Value *CmpIndVar;
Dan Gohman0bba49c2009-07-07 17:06:11 +0000255 const SCEV *RHS = BackedgeTakenCount;
Andrew Trick4dfdf242011-05-03 22:24:10 +0000256 if (L->getExitingBlock() == L->getLoopLatch()) {
Dan Gohman46bdfb02009-02-24 18:55:53 +0000257 // Add one to the "backedge-taken" count to get the trip count.
258 // If this addition may overflow, we have to be more pessimistic and
259 // cast the induction variable before doing the add.
Dan Gohmandeff6212010-05-03 22:09:21 +0000260 const SCEV *Zero = SE->getConstant(BackedgeTakenCount->getType(), 0);
Dan Gohman0bba49c2009-07-07 17:06:11 +0000261 const SCEV *N =
Dan Gohman46bdfb02009-02-24 18:55:53 +0000262 SE->getAddExpr(BackedgeTakenCount,
Dan Gohmandeff6212010-05-03 22:09:21 +0000263 SE->getConstant(BackedgeTakenCount->getType(), 1));
Dan Gohmanc2390b12009-02-12 22:19:27 +0000264 if ((isa<SCEVConstant>(N) && !N->isZero()) ||
Dan Gohman3948d0b2010-04-11 19:27:13 +0000265 SE->isLoopEntryGuardedByCond(L, ICmpInst::ICMP_NE, N, Zero)) {
Dan Gohmanc2390b12009-02-12 22:19:27 +0000266 // No overflow. Cast the sum.
Dan Gohman46bdfb02009-02-24 18:55:53 +0000267 RHS = SE->getTruncateOrZeroExtend(N, IndVar->getType());
Dan Gohmanc2390b12009-02-12 22:19:27 +0000268 } else {
269 // Potential overflow. Cast before doing the add.
Dan Gohman46bdfb02009-02-24 18:55:53 +0000270 RHS = SE->getTruncateOrZeroExtend(BackedgeTakenCount,
271 IndVar->getType());
272 RHS = SE->getAddExpr(RHS,
Dan Gohmandeff6212010-05-03 22:09:21 +0000273 SE->getConstant(IndVar->getType(), 1));
Dan Gohmanc2390b12009-02-12 22:19:27 +0000274 }
Chris Lattner59fdaee2004-04-15 15:21:43 +0000275
Dan Gohman46bdfb02009-02-24 18:55:53 +0000276 // The BackedgeTaken expression contains the number of times that the
277 // backedge branches to the loop header. This is one less than the
278 // number of times the loop executes, so use the incremented indvar.
Andrew Trick4dfdf242011-05-03 22:24:10 +0000279 CmpIndVar = IndVar->getIncomingValueForBlock(L->getExitingBlock());
Chris Lattnerd2440572004-04-15 20:26:22 +0000280 } else {
281 // We have to use the preincremented value...
Dan Gohman46bdfb02009-02-24 18:55:53 +0000282 RHS = SE->getTruncateOrZeroExtend(BackedgeTakenCount,
283 IndVar->getType());
Dan Gohmanc2390b12009-02-12 22:19:27 +0000284 CmpIndVar = IndVar;
Chris Lattnerd2440572004-04-15 20:26:22 +0000285 }
Chris Lattner59fdaee2004-04-15 15:21:43 +0000286
Dan Gohman667d7872009-06-26 22:53:46 +0000287 // Expand the code for the iteration count.
Dan Gohman17ead4f2010-11-17 21:23:15 +0000288 assert(SE->isLoopInvariant(RHS, L) &&
Dan Gohman40a5a1b2009-06-24 01:18:18 +0000289 "Computed iteration count is not loop invariant!");
Dan Gohman667d7872009-06-26 22:53:46 +0000290 Value *ExitCnt = Rewriter.expandCodeFor(RHS, IndVar->getType(), BI);
Chris Lattner40bf8b42004-04-02 20:24:31 +0000291
Reid Spencere4d87aa2006-12-23 06:05:41 +0000292 // Insert a new icmp_ne or icmp_eq instruction before the branch.
293 ICmpInst::Predicate Opcode;
Chris Lattner40bf8b42004-04-02 20:24:31 +0000294 if (L->contains(BI->getSuccessor(0)))
Reid Spencere4d87aa2006-12-23 06:05:41 +0000295 Opcode = ICmpInst::ICMP_NE;
Chris Lattner40bf8b42004-04-02 20:24:31 +0000296 else
Reid Spencere4d87aa2006-12-23 06:05:41 +0000297 Opcode = ICmpInst::ICMP_EQ;
Chris Lattner40bf8b42004-04-02 20:24:31 +0000298
David Greenef67ef312010-01-05 01:27:06 +0000299 DEBUG(dbgs() << "INDVARS: Rewriting loop exit condition to:\n"
Chris Lattnerbdff5482009-08-23 04:37:46 +0000300 << " LHS:" << *CmpIndVar << '\n'
301 << " op:\t"
302 << (Opcode == ICmpInst::ICMP_NE ? "!=" : "==") << "\n"
303 << " RHS:\t" << *RHS << "\n");
Dan Gohmanc2390b12009-02-12 22:19:27 +0000304
Owen Anderson333c4002009-07-09 23:48:35 +0000305 ICmpInst *Cond = new ICmpInst(BI, Opcode, CmpIndVar, ExitCnt, "exitcond");
Dan Gohman81db61a2009-05-12 02:17:14 +0000306
Dan Gohman24440802010-02-22 02:07:36 +0000307 Value *OrigCond = BI->getCondition();
Dan Gohman95bdbfa2009-05-24 19:11:38 +0000308 // It's tempting to use replaceAllUsesWith here to fully replace the old
309 // comparison, but that's not immediately safe, since users of the old
310 // comparison may not be dominated by the new comparison. Instead, just
311 // update the branch to use the new comparison; in the common case this
312 // will make old comparison dead.
313 BI->setCondition(Cond);
Andrew Trick88e92cf2011-04-28 17:30:04 +0000314 DeadInsts.push_back(OrigCond);
Dan Gohman81db61a2009-05-12 02:17:14 +0000315
Chris Lattner40bf8b42004-04-02 20:24:31 +0000316 ++NumLFTR;
317 Changed = true;
Dan Gohman81db61a2009-05-12 02:17:14 +0000318 return Cond;
Chris Lattner40bf8b42004-04-02 20:24:31 +0000319}
320
Chris Lattner40bf8b42004-04-02 20:24:31 +0000321/// RewriteLoopExitValues - Check to see if this loop has a computable
322/// loop-invariant execution count. If so, this means that we can compute the
323/// final value of any expressions that are recurrent in the loop, and
324/// substitute the exit values from the loop into any instructions outside of
325/// the loop that use the final values of the current expressions.
Dan Gohman81db61a2009-05-12 02:17:14 +0000326///
327/// This is mostly redundant with the regular IndVarSimplify activities that
328/// happen later, except that it's more powerful in some cases, because it's
329/// able to brute-force evaluate arbitrary instructions as long as they have
330/// constant operands at the beginning of the loop.
Chris Lattnerf1859892011-01-09 02:16:18 +0000331void IndVarSimplify::RewriteLoopExitValues(Loop *L, SCEVExpander &Rewriter) {
Dan Gohman81db61a2009-05-12 02:17:14 +0000332 // Verify the input to the pass in already in LCSSA form.
Dan Gohmanbbf81d82010-03-10 19:38:49 +0000333 assert(L->isLCSSAForm(*DT));
Dan Gohman81db61a2009-05-12 02:17:14 +0000334
Devang Patelb7211a22007-08-21 00:31:24 +0000335 SmallVector<BasicBlock*, 8> ExitBlocks;
Chris Lattner9f3d7382007-03-04 03:43:23 +0000336 L->getUniqueExitBlocks(ExitBlocks);
Misha Brukmanfd939082005-04-21 23:48:37 +0000337
Chris Lattner9f3d7382007-03-04 03:43:23 +0000338 // Find all values that are computed inside the loop, but used outside of it.
339 // Because of LCSSA, these values will only occur in LCSSA PHI Nodes. Scan
340 // the exit blocks of the loop to find them.
341 for (unsigned i = 0, e = ExitBlocks.size(); i != e; ++i) {
342 BasicBlock *ExitBB = ExitBlocks[i];
Dan Gohmancafb8132009-02-17 19:13:57 +0000343
Chris Lattner9f3d7382007-03-04 03:43:23 +0000344 // If there are no PHI nodes in this exit block, then no values defined
345 // inside the loop are used on this path, skip it.
346 PHINode *PN = dyn_cast<PHINode>(ExitBB->begin());
347 if (!PN) continue;
Dan Gohmancafb8132009-02-17 19:13:57 +0000348
Chris Lattner9f3d7382007-03-04 03:43:23 +0000349 unsigned NumPreds = PN->getNumIncomingValues();
Dan Gohmancafb8132009-02-17 19:13:57 +0000350
Chris Lattner9f3d7382007-03-04 03:43:23 +0000351 // Iterate over all of the PHI nodes.
352 BasicBlock::iterator BBI = ExitBB->begin();
353 while ((PN = dyn_cast<PHINode>(BBI++))) {
Torok Edwin3790fb02009-05-24 19:36:09 +0000354 if (PN->use_empty())
355 continue; // dead use, don't replace it
Dan Gohman814f2b22010-02-18 21:34:02 +0000356
357 // SCEV only supports integer expressions for now.
358 if (!PN->getType()->isIntegerTy() && !PN->getType()->isPointerTy())
359 continue;
360
Dale Johannesen45a2d7d2010-02-19 07:14:22 +0000361 // It's necessary to tell ScalarEvolution about this explicitly so that
362 // it can walk the def-use list and forget all SCEVs, as it may not be
363 // watching the PHI itself. Once the new exit value is in place, there
364 // may not be a def-use connection between the loop and every instruction
365 // which got a SCEVAddRecExpr for that loop.
366 SE->forgetValue(PN);
367
Chris Lattner9f3d7382007-03-04 03:43:23 +0000368 // Iterate over all of the values in all the PHI nodes.
369 for (unsigned i = 0; i != NumPreds; ++i) {
370 // If the value being merged in is not integer or is not defined
371 // in the loop, skip it.
372 Value *InVal = PN->getIncomingValue(i);
Dan Gohman814f2b22010-02-18 21:34:02 +0000373 if (!isa<Instruction>(InVal))
Chris Lattner9f3d7382007-03-04 03:43:23 +0000374 continue;
Chris Lattner40bf8b42004-04-02 20:24:31 +0000375
Chris Lattner9f3d7382007-03-04 03:43:23 +0000376 // If this pred is for a subloop, not L itself, skip it.
Dan Gohmancafb8132009-02-17 19:13:57 +0000377 if (LI->getLoopFor(PN->getIncomingBlock(i)) != L)
Chris Lattner9f3d7382007-03-04 03:43:23 +0000378 continue; // The Block is in a subloop, skip it.
379
380 // Check that InVal is defined in the loop.
381 Instruction *Inst = cast<Instruction>(InVal);
Dan Gohman92329c72009-12-18 01:24:09 +0000382 if (!L->contains(Inst))
Chris Lattner9f3d7382007-03-04 03:43:23 +0000383 continue;
Dan Gohmancafb8132009-02-17 19:13:57 +0000384
Chris Lattner9f3d7382007-03-04 03:43:23 +0000385 // Okay, this instruction has a user outside of the current loop
386 // and varies predictably *inside* the loop. Evaluate the value it
387 // contains when the loop exits, if possible.
Dan Gohman0bba49c2009-07-07 17:06:11 +0000388 const SCEV *ExitValue = SE->getSCEVAtScope(Inst, L->getParentLoop());
Dan Gohman17ead4f2010-11-17 21:23:15 +0000389 if (!SE->isLoopInvariant(ExitValue, L))
Chris Lattner9f3d7382007-03-04 03:43:23 +0000390 continue;
Chris Lattner9caed542007-03-04 01:00:28 +0000391
Dan Gohman667d7872009-06-26 22:53:46 +0000392 Value *ExitVal = Rewriter.expandCodeFor(ExitValue, PN->getType(), Inst);
Dan Gohmancafb8132009-02-17 19:13:57 +0000393
David Greenef67ef312010-01-05 01:27:06 +0000394 DEBUG(dbgs() << "INDVARS: RLEV: AfterLoopVal = " << *ExitVal << '\n'
Chris Lattnerbdff5482009-08-23 04:37:46 +0000395 << " LoopVal = " << *Inst << "\n");
Chris Lattner9f3d7382007-03-04 03:43:23 +0000396
Andrew Trickb12a7542011-03-17 23:51:11 +0000397 if (!isValidRewrite(Inst, ExitVal)) {
398 DeadInsts.push_back(ExitVal);
399 continue;
400 }
401 Changed = true;
402 ++NumReplaced;
403
Chris Lattner9f3d7382007-03-04 03:43:23 +0000404 PN->setIncomingValue(i, ExitVal);
Dan Gohmancafb8132009-02-17 19:13:57 +0000405
Dan Gohman81db61a2009-05-12 02:17:14 +0000406 // If this instruction is dead now, delete it.
407 RecursivelyDeleteTriviallyDeadInstructions(Inst);
Dan Gohmancafb8132009-02-17 19:13:57 +0000408
Dan Gohman65d1e2b2009-07-14 01:09:02 +0000409 if (NumPreds == 1) {
410 // Completely replace a single-pred PHI. This is safe, because the
411 // NewVal won't be variant in the loop, so we don't need an LCSSA phi
412 // node anymore.
Chris Lattner9f3d7382007-03-04 03:43:23 +0000413 PN->replaceAllUsesWith(ExitVal);
Dan Gohman81db61a2009-05-12 02:17:14 +0000414 RecursivelyDeleteTriviallyDeadInstructions(PN);
Chris Lattnerc9838f22007-03-03 22:48:48 +0000415 }
416 }
Dan Gohman65d1e2b2009-07-14 01:09:02 +0000417 if (NumPreds != 1) {
Dan Gohman667d7872009-06-26 22:53:46 +0000418 // Clone the PHI and delete the original one. This lets IVUsers and
419 // any other maps purge the original user from their records.
Devang Patel50b6e332009-10-27 22:16:29 +0000420 PHINode *NewPN = cast<PHINode>(PN->clone());
Dan Gohman667d7872009-06-26 22:53:46 +0000421 NewPN->takeName(PN);
422 NewPN->insertBefore(PN);
423 PN->replaceAllUsesWith(NewPN);
424 PN->eraseFromParent();
425 }
Chris Lattnerc9838f22007-03-03 22:48:48 +0000426 }
427 }
Dan Gohman472fdf72010-03-20 03:53:53 +0000428
429 // The insertion point instruction may have been deleted; clear it out
430 // so that the rewriter doesn't trip over it later.
431 Rewriter.clearInsertPoint();
Chris Lattner40bf8b42004-04-02 20:24:31 +0000432}
433
Dan Gohman60f8a632009-02-17 20:49:49 +0000434void IndVarSimplify::RewriteNonIntegerIVs(Loop *L) {
Dan Gohman2d1be872009-04-16 03:18:22 +0000435 // First step. Check to see if there are any floating-point recurrences.
Chris Lattner40bf8b42004-04-02 20:24:31 +0000436 // If there are, change them into integer recurrences, permitting analysis by
437 // the SCEV routines.
438 //
Chris Lattnerf1859892011-01-09 02:16:18 +0000439 BasicBlock *Header = L->getHeader();
Misha Brukmanfd939082005-04-21 23:48:37 +0000440
Dan Gohman81db61a2009-05-12 02:17:14 +0000441 SmallVector<WeakVH, 8> PHIs;
442 for (BasicBlock::iterator I = Header->begin();
443 PHINode *PN = dyn_cast<PHINode>(I); ++I)
444 PHIs.push_back(PN);
445
446 for (unsigned i = 0, e = PHIs.size(); i != e; ++i)
Gabor Greifea4894a2010-09-18 11:53:39 +0000447 if (PHINode *PN = dyn_cast_or_null<PHINode>(&*PHIs[i]))
Dan Gohman81db61a2009-05-12 02:17:14 +0000448 HandleFloatingPointIV(L, PN);
Chris Lattner40bf8b42004-04-02 20:24:31 +0000449
Dan Gohman2d1be872009-04-16 03:18:22 +0000450 // If the loop previously had floating-point IV, ScalarEvolution
Dan Gohman60f8a632009-02-17 20:49:49 +0000451 // may not have been able to compute a trip count. Now that we've done some
452 // re-writing, the trip count may be computable.
453 if (Changed)
Dan Gohman4c7279a2009-10-31 15:04:55 +0000454 SE->forgetLoop(L);
Dale Johannesenc671d892009-04-15 23:31:51 +0000455}
456
Andrew Trickaeee4612011-05-12 00:04:28 +0000457/// SimplifyIVUsers - Iteratively perform simplification on IVUsers within this
458/// loop. IVUsers is treated as a worklist. Each successive simplification may
459/// push more users which may themselves be candidates for simplification.
460void IndVarSimplify::SimplifyIVUsers() {
Andrew Trick14ba1ff2011-05-13 01:12:21 +0000461 for (IVUsers::iterator I = IU->begin(); I != IU->end(); ++I) {
Andrew Trickaeee4612011-05-12 00:04:28 +0000462 Instruction *UseInst = I->getUser();
463 Value *IVOperand = I->getOperandValToReplace();
Dan Gohman931e3452010-04-12 02:21:50 +0000464
Andrew Trickaeee4612011-05-12 00:04:28 +0000465 if (ICmpInst *ICmp = dyn_cast<ICmpInst>(UseInst)) {
466 EliminateIVComparison(ICmp, IVOperand);
Dan Gohman931e3452010-04-12 02:21:50 +0000467 continue;
Andrew Trickaeee4612011-05-12 00:04:28 +0000468 }
Dan Gohman931e3452010-04-12 02:21:50 +0000469
Andrew Trickaeee4612011-05-12 00:04:28 +0000470 if (BinaryOperator *Rem = dyn_cast<BinaryOperator>(UseInst)) {
471 bool isSigned = Rem->getOpcode() == Instruction::SRem;
472 if (isSigned || Rem->getOpcode() == Instruction::URem) {
473 EliminateIVRemainder(Rem, IVOperand, isSigned);
474 continue;
475 }
476 }
Dan Gohman931e3452010-04-12 02:21:50 +0000477 }
478}
479
Andrew Trickaeee4612011-05-12 00:04:28 +0000480void IndVarSimplify::EliminateIVComparison(ICmpInst *ICmp, Value *IVOperand) {
481 unsigned IVOperIdx = 0;
482 ICmpInst::Predicate Pred = ICmp->getPredicate();
483 if (IVOperand != ICmp->getOperand(0)) {
484 // Swapped
485 assert(IVOperand == ICmp->getOperand(1) && "Can't find IVOperand");
486 IVOperIdx = 1;
487 Pred = ICmpInst::getSwappedPredicate(Pred);
Dan Gohmana590b792010-04-13 01:46:36 +0000488 }
Andrew Trickaeee4612011-05-12 00:04:28 +0000489
490 // Get the SCEVs for the ICmp operands.
491 const SCEV *S = SE->getSCEV(ICmp->getOperand(IVOperIdx));
492 const SCEV *X = SE->getSCEV(ICmp->getOperand(1 - IVOperIdx));
493
494 // Simplify unnecessary loops away.
495 const Loop *ICmpLoop = LI->getLoopFor(ICmp->getParent());
496 S = SE->getSCEVAtScope(S, ICmpLoop);
497 X = SE->getSCEVAtScope(X, ICmpLoop);
498
499 // If the condition is always true or always false, replace it with
500 // a constant value.
501 if (SE->isKnownPredicate(Pred, S, X))
502 ICmp->replaceAllUsesWith(ConstantInt::getTrue(ICmp->getContext()));
503 else if (SE->isKnownPredicate(ICmpInst::getInversePredicate(Pred), S, X))
504 ICmp->replaceAllUsesWith(ConstantInt::getFalse(ICmp->getContext()));
505 else
506 return;
507
508 DEBUG(dbgs() << "INDVARS: Eliminated comparison: " << *ICmp << '\n');
509 DeadInsts.push_back(ICmp);
510}
511
512void IndVarSimplify::EliminateIVRemainder(BinaryOperator *Rem,
513 Value *IVOperand,
514 bool isSigned) {
515 // We're only interested in the case where we know something about
516 // the numerator.
517 if (IVOperand != Rem->getOperand(0))
518 return;
519
520 // Get the SCEVs for the ICmp operands.
521 const SCEV *S = SE->getSCEV(Rem->getOperand(0));
522 const SCEV *X = SE->getSCEV(Rem->getOperand(1));
523
524 // Simplify unnecessary loops away.
525 const Loop *ICmpLoop = LI->getLoopFor(Rem->getParent());
526 S = SE->getSCEVAtScope(S, ICmpLoop);
527 X = SE->getSCEVAtScope(X, ICmpLoop);
528
529 // i % n --> i if i is in [0,n).
530 if ((!isSigned || SE->isKnownNonNegative(S)) &&
531 SE->isKnownPredicate(isSigned ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT,
532 S, X))
533 Rem->replaceAllUsesWith(Rem->getOperand(0));
534 else {
535 // (i+1) % n --> (i+1)==n?0:(i+1) if i is in [0,n).
536 const SCEV *LessOne =
537 SE->getMinusSCEV(S, SE->getConstant(S->getType(), 1));
538 if (isSigned && !SE->isKnownNonNegative(LessOne))
539 return;
540
541 if (!SE->isKnownPredicate(isSigned ?
542 ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT,
543 LessOne, X))
544 return;
545
546 ICmpInst *ICmp = new ICmpInst(Rem, ICmpInst::ICMP_EQ,
547 Rem->getOperand(0), Rem->getOperand(1),
548 "tmp");
549 SelectInst *Sel =
550 SelectInst::Create(ICmp,
551 ConstantInt::get(Rem->getType(), 0),
552 Rem->getOperand(0), "tmp", Rem);
553 Rem->replaceAllUsesWith(Sel);
554 }
555
556 // Inform IVUsers about the new users.
557 if (Instruction *I = dyn_cast<Instruction>(Rem->getOperand(0)))
558 IU->AddUsersIfInteresting(I);
559
560 DEBUG(dbgs() << "INDVARS: Simplified rem: " << *Rem << '\n');
561 DeadInsts.push_back(Rem);
Dan Gohmana590b792010-04-13 01:46:36 +0000562}
563
Dan Gohmanc2390b12009-02-12 22:19:27 +0000564bool IndVarSimplify::runOnLoop(Loop *L, LPPassManager &LPM) {
Dan Gohmana5283822010-06-18 01:35:11 +0000565 // If LoopSimplify form is not available, stay out of trouble. Some notes:
566 // - LSR currently only supports LoopSimplify-form loops. Indvars'
567 // canonicalization can be a pessimization without LSR to "clean up"
568 // afterwards.
569 // - We depend on having a preheader; in particular,
570 // Loop::getCanonicalInductionVariable only supports loops with preheaders,
571 // and we're in trouble if we can't find the induction variable even when
572 // we've manually inserted one.
573 if (!L->isLoopSimplifyForm())
574 return false;
575
Dan Gohman81db61a2009-05-12 02:17:14 +0000576 IU = &getAnalysis<IVUsers>();
Devang Patel5ee99972007-03-07 06:39:01 +0000577 LI = &getAnalysis<LoopInfo>();
578 SE = &getAnalysis<ScalarEvolution>();
Dan Gohmande53dc02009-06-27 05:16:57 +0000579 DT = &getAnalysis<DominatorTree>();
Andrew Trick37da4082011-05-04 02:10:13 +0000580 TD = getAnalysisIfAvailable<TargetData>();
581
Andrew Trickb12a7542011-03-17 23:51:11 +0000582 DeadInsts.clear();
Devang Patel5ee99972007-03-07 06:39:01 +0000583 Changed = false;
Dan Gohman60f8a632009-02-17 20:49:49 +0000584
Dan Gohman2d1be872009-04-16 03:18:22 +0000585 // If there are any floating-point recurrences, attempt to
Dan Gohman60f8a632009-02-17 20:49:49 +0000586 // transform them to use integer recurrences.
587 RewriteNonIntegerIVs(L);
588
Dan Gohman0bba49c2009-07-07 17:06:11 +0000589 const SCEV *BackedgeTakenCount = SE->getBackedgeTakenCount(L);
Chris Lattner9caed542007-03-04 01:00:28 +0000590
Dan Gohman667d7872009-06-26 22:53:46 +0000591 // Create a rewriter object which we'll use to transform the code with.
592 SCEVExpander Rewriter(*SE);
Andrew Trick37da4082011-05-04 02:10:13 +0000593 if (DisableIVRewrite)
594 Rewriter.disableCanonicalMode();
595
596 const Type *LargestType = 0;
597 if (DisableIVRewrite) {
598 LargestType = WidenIVs(L, Rewriter);
599 }
Dan Gohman667d7872009-06-26 22:53:46 +0000600
Chris Lattner40bf8b42004-04-02 20:24:31 +0000601 // Check to see if this loop has a computable loop-invariant execution count.
602 // If so, this means that we can compute the final value of any expressions
603 // that are recurrent in the loop, and substitute the exit values from the
604 // loop into any instructions outside of the loop that use the final values of
605 // the current expressions.
Chris Lattner3dec1f22002-05-10 15:38:35 +0000606 //
Dan Gohman46bdfb02009-02-24 18:55:53 +0000607 if (!isa<SCEVCouldNotCompute>(BackedgeTakenCount))
Dan Gohman454d26d2010-02-22 04:11:59 +0000608 RewriteLoopExitValues(L, Rewriter);
Chris Lattner6148c022001-12-03 17:28:42 +0000609
Andrew Trickaeee4612011-05-12 00:04:28 +0000610 SimplifyIVUsers();
Dan Gohmana590b792010-04-13 01:46:36 +0000611
Dan Gohman81db61a2009-05-12 02:17:14 +0000612 // Compute the type of the largest recurrence expression, and decide whether
613 // a canonical induction variable should be inserted.
Dan Gohman81db61a2009-05-12 02:17:14 +0000614 bool NeedCannIV = false;
Andrew Trick4dfdf242011-05-03 22:24:10 +0000615 bool ExpandBECount = canExpandBackedgeTakenCount(L, BackedgeTakenCount);
616 if (ExpandBECount) {
Dan Gohman81db61a2009-05-12 02:17:14 +0000617 // If we have a known trip count and a single exit block, we'll be
618 // rewriting the loop exit test condition below, which requires a
619 // canonical induction variable.
Andrew Trick4dfdf242011-05-03 22:24:10 +0000620 NeedCannIV = true;
621 const Type *Ty = BackedgeTakenCount->getType();
622 if (!LargestType ||
623 SE->getTypeSizeInBits(Ty) >
624 SE->getTypeSizeInBits(LargestType))
625 LargestType = SE->getEffectiveSCEVType(Ty);
Chris Lattnerf50af082004-04-17 18:08:33 +0000626 }
Dan Gohman572645c2010-02-12 10:34:29 +0000627 for (IVUsers::const_iterator I = IU->begin(), E = IU->end(); I != E; ++I) {
Andrew Trick4dfdf242011-05-03 22:24:10 +0000628 NeedCannIV = true;
Dan Gohman572645c2010-02-12 10:34:29 +0000629 const Type *Ty =
630 SE->getEffectiveSCEVType(I->getOperandValToReplace()->getType());
Dan Gohmanc2390b12009-02-12 22:19:27 +0000631 if (!LargestType ||
Dan Gohman81db61a2009-05-12 02:17:14 +0000632 SE->getTypeSizeInBits(Ty) >
Andrew Trick37da4082011-05-04 02:10:13 +0000633 SE->getTypeSizeInBits(LargestType))
634 LargestType = SE->getEffectiveSCEVType(Ty);
635 }
636 if (!DisableIVRewrite) {
637 for (IVUsers::const_iterator I = IU->begin(), E = IU->end(); I != E; ++I) {
638 NeedCannIV = true;
639 const Type *Ty =
640 SE->getEffectiveSCEVType(I->getOperandValToReplace()->getType());
641 if (!LargestType ||
642 SE->getTypeSizeInBits(Ty) >
Dan Gohmanaf79fb52009-04-21 01:07:12 +0000643 SE->getTypeSizeInBits(LargestType))
Andrew Trick37da4082011-05-04 02:10:13 +0000644 LargestType = Ty;
645 }
Chris Lattner6148c022001-12-03 17:28:42 +0000646 }
647
Dan Gohmanf451cb82010-02-10 16:03:48 +0000648 // Now that we know the largest of the induction variable expressions
Dan Gohman81db61a2009-05-12 02:17:14 +0000649 // in this loop, insert a canonical induction variable of the largest size.
Dan Gohman43ef3fb2010-07-20 17:18:52 +0000650 PHINode *IndVar = 0;
Dan Gohman81db61a2009-05-12 02:17:14 +0000651 if (NeedCannIV) {
Dan Gohman85669632010-02-25 06:57:05 +0000652 // Check to see if the loop already has any canonical-looking induction
653 // variables. If any are present and wider than the planned canonical
654 // induction variable, temporarily remove them, so that the Rewriter
655 // doesn't attempt to reuse them.
656 SmallVector<PHINode *, 2> OldCannIVs;
657 while (PHINode *OldCannIV = L->getCanonicalInductionVariable()) {
Dan Gohman4d8414f2009-06-13 16:25:49 +0000658 if (SE->getTypeSizeInBits(OldCannIV->getType()) >
659 SE->getTypeSizeInBits(LargestType))
660 OldCannIV->removeFromParent();
661 else
Dan Gohman85669632010-02-25 06:57:05 +0000662 break;
663 OldCannIVs.push_back(OldCannIV);
Dan Gohman4d8414f2009-06-13 16:25:49 +0000664 }
665
Dan Gohman667d7872009-06-26 22:53:46 +0000666 IndVar = Rewriter.getOrInsertCanonicalInductionVariable(L, LargestType);
Dan Gohman4d8414f2009-06-13 16:25:49 +0000667
Dan Gohmanc2390b12009-02-12 22:19:27 +0000668 ++NumInserted;
669 Changed = true;
David Greenef67ef312010-01-05 01:27:06 +0000670 DEBUG(dbgs() << "INDVARS: New CanIV: " << *IndVar << '\n');
Dan Gohman4d8414f2009-06-13 16:25:49 +0000671
672 // Now that the official induction variable is established, reinsert
Dan Gohman85669632010-02-25 06:57:05 +0000673 // any old canonical-looking variables after it so that the IR remains
674 // consistent. They will be deleted as part of the dead-PHI deletion at
Dan Gohman4d8414f2009-06-13 16:25:49 +0000675 // the end of the pass.
Dan Gohman85669632010-02-25 06:57:05 +0000676 while (!OldCannIVs.empty()) {
677 PHINode *OldCannIV = OldCannIVs.pop_back_val();
678 OldCannIV->insertBefore(L->getHeader()->getFirstNonPHI());
679 }
Dan Gohmand19534a2007-06-15 14:38:12 +0000680 }
Chris Lattner15cad752003-12-23 07:47:09 +0000681
Dan Gohmanc2390b12009-02-12 22:19:27 +0000682 // If we have a trip count expression, rewrite the loop's exit condition
683 // using it. We can currently only handle loops with a single exit.
Dan Gohman81db61a2009-05-12 02:17:14 +0000684 ICmpInst *NewICmp = 0;
Andrew Trick4dfdf242011-05-03 22:24:10 +0000685 if (ExpandBECount) {
686 assert(canExpandBackedgeTakenCount(L, BackedgeTakenCount) &&
687 "canonical IV disrupted BackedgeTaken expansion");
Dan Gohman81db61a2009-05-12 02:17:14 +0000688 assert(NeedCannIV &&
689 "LinearFunctionTestReplace requires a canonical induction variable");
Andrew Trick4dfdf242011-05-03 22:24:10 +0000690 NewICmp = LinearFunctionTestReplace(L, BackedgeTakenCount, IndVar,
691 Rewriter);
Chris Lattnerfcb81f52004-04-22 14:59:40 +0000692 }
Andrew Trickb12a7542011-03-17 23:51:11 +0000693 // Rewrite IV-derived expressions.
Andrew Trick37da4082011-05-04 02:10:13 +0000694 if (!DisableIVRewrite)
695 RewriteIVExpressions(L, Rewriter);
Dan Gohmanc2390b12009-02-12 22:19:27 +0000696
Andrew Trickb12a7542011-03-17 23:51:11 +0000697 // Clear the rewriter cache, because values that are in the rewriter's cache
698 // can be deleted in the loop below, causing the AssertingVH in the cache to
699 // trigger.
700 Rewriter.clear();
701
702 // Now that we're done iterating through lists, clean up any instructions
703 // which are now dead.
704 while (!DeadInsts.empty())
705 if (Instruction *Inst =
706 dyn_cast_or_null<Instruction>(&*DeadInsts.pop_back_val()))
707 RecursivelyDeleteTriviallyDeadInstructions(Inst);
708
Dan Gohman667d7872009-06-26 22:53:46 +0000709 // The Rewriter may not be used from this point on.
Torok Edwin3d431382009-05-24 20:08:21 +0000710
Dan Gohman81db61a2009-05-12 02:17:14 +0000711 // Loop-invariant instructions in the preheader that aren't used in the
712 // loop may be sunk below the loop to reduce register pressure.
Dan Gohman667d7872009-06-26 22:53:46 +0000713 SinkUnusedInvariants(L);
Dan Gohman81db61a2009-05-12 02:17:14 +0000714
715 // For completeness, inform IVUsers of the IV use in the newly-created
716 // loop exit test instruction.
717 if (NewICmp)
718 IU->AddUsersIfInteresting(cast<Instruction>(NewICmp->getOperand(0)));
719
720 // Clean up dead instructions.
Dan Gohman9fff2182010-01-05 16:31:45 +0000721 Changed |= DeleteDeadPHIs(L->getHeader());
Dan Gohman81db61a2009-05-12 02:17:14 +0000722 // Check a post-condition.
Dan Gohmanbbf81d82010-03-10 19:38:49 +0000723 assert(L->isLCSSAForm(*DT) && "Indvars did not leave the loop in lcssa form!");
Devang Patel5ee99972007-03-07 06:39:01 +0000724 return Changed;
Chris Lattner6148c022001-12-03 17:28:42 +0000725}
Devang Pateld22a8492008-09-09 21:41:07 +0000726
Dan Gohman448db1c2010-04-07 22:27:08 +0000727// FIXME: It is an extremely bad idea to indvar substitute anything more
728// complex than affine induction variables. Doing so will put expensive
729// polynomial evaluations inside of the loop, and the str reduction pass
730// currently can only reduce affine polynomials. For now just disable
731// indvar subst on anything more complex than an affine addrec, unless
732// it can be expanded to a trivial value.
Dan Gohman17ead4f2010-11-17 21:23:15 +0000733static bool isSafe(const SCEV *S, const Loop *L, ScalarEvolution *SE) {
Dan Gohman448db1c2010-04-07 22:27:08 +0000734 // Loop-invariant values are safe.
Dan Gohman17ead4f2010-11-17 21:23:15 +0000735 if (SE->isLoopInvariant(S, L)) return true;
Dan Gohman448db1c2010-04-07 22:27:08 +0000736
737 // Affine addrecs are safe. Non-affine are not, because LSR doesn't know how
738 // to transform them into efficient code.
739 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S))
740 return AR->isAffine();
741
742 // An add is safe it all its operands are safe.
743 if (const SCEVCommutativeExpr *Commutative = dyn_cast<SCEVCommutativeExpr>(S)) {
744 for (SCEVCommutativeExpr::op_iterator I = Commutative->op_begin(),
745 E = Commutative->op_end(); I != E; ++I)
Dan Gohman17ead4f2010-11-17 21:23:15 +0000746 if (!isSafe(*I, L, SE)) return false;
Dan Gohman448db1c2010-04-07 22:27:08 +0000747 return true;
748 }
Andrew Trickead71d52011-03-17 23:46:48 +0000749
Dan Gohman448db1c2010-04-07 22:27:08 +0000750 // A cast is safe if its operand is.
751 if (const SCEVCastExpr *C = dyn_cast<SCEVCastExpr>(S))
Dan Gohman17ead4f2010-11-17 21:23:15 +0000752 return isSafe(C->getOperand(), L, SE);
Dan Gohman448db1c2010-04-07 22:27:08 +0000753
754 // A udiv is safe if its operands are.
755 if (const SCEVUDivExpr *UD = dyn_cast<SCEVUDivExpr>(S))
Dan Gohman17ead4f2010-11-17 21:23:15 +0000756 return isSafe(UD->getLHS(), L, SE) &&
757 isSafe(UD->getRHS(), L, SE);
Dan Gohman448db1c2010-04-07 22:27:08 +0000758
759 // SCEVUnknown is always safe.
760 if (isa<SCEVUnknown>(S))
761 return true;
762
763 // Nothing else is safe.
764 return false;
765}
766
Andrew Trick37da4082011-05-04 02:10:13 +0000767/// Widen the type of any induction variables that are sign/zero extended and
768/// remove the [sz]ext uses.
769///
770/// FIXME: This may currently create extra IVs which could increase regpressure
771/// (without LSR to cleanup).
772///
773/// FIXME: may factor this with RewriteIVExpressions once it stabilizes.
774const Type *IndVarSimplify::WidenIVs(Loop *L, SCEVExpander &Rewriter) {
775 const Type *LargestType = 0;
776 for (IVUsers::iterator UI = IU->begin(), E = IU->end(); UI != E; ++UI) {
777 Instruction *ExtInst = UI->getUser();
778 if (!isa<SExtInst>(ExtInst) && !isa<ZExtInst>(ExtInst))
779 continue;
780 const SCEV *AR = SE->getSCEV(ExtInst);
781 // Only widen this IV is SCEV tells us it's safe.
782 if (!isa<SCEVAddRecExpr>(AR) && !isa<SCEVAddExpr>(AR))
783 continue;
784
785 if (!L->contains(UI->getUser())) {
786 const SCEV *ExitVal = SE->getSCEVAtScope(AR, L->getParentLoop());
787 if (SE->isLoopInvariant(ExitVal, L))
788 AR = ExitVal;
789 }
790
791 // Only expand affine recurences.
792 if (!isSafe(AR, L, SE))
793 continue;
794
795 const Type *Ty =
796 SE->getEffectiveSCEVType(ExtInst->getType());
797
798 // Only remove [sz]ext if the wide IV is still a native type.
799 //
800 // FIXME: We may be able to remove the copy of this logic in
801 // IVUsers::AddUsersIfInteresting.
802 uint64_t Width = SE->getTypeSizeInBits(Ty);
803 if (Width > 64 || (TD && !TD->isLegalInteger(Width)))
804 continue;
805
806 // Now expand it into actual Instructions and patch it into place.
807 //
808 // FIXME: avoid creating a new IV.
809 Value *NewVal = Rewriter.expandCodeFor(AR, Ty, ExtInst);
810
811 DEBUG(dbgs() << "INDVARS: Widened IV '" << *AR << "' " << *ExtInst << '\n'
812 << " into = " << *NewVal << "\n");
813
814 if (!isValidRewrite(ExtInst, NewVal)) {
815 DeadInsts.push_back(NewVal);
816 continue;
817 }
818
819 ++NumWidened;
820 Changed = true;
821
822 if (!LargestType ||
823 SE->getTypeSizeInBits(Ty) >
824 SE->getTypeSizeInBits(LargestType))
825 LargestType = Ty;
826
827 SE->forgetValue(ExtInst);
828
829 // Patch the new value into place.
830 if (ExtInst->hasName())
831 NewVal->takeName(ExtInst);
832 ExtInst->replaceAllUsesWith(NewVal);
833
834 // The old value may be dead now.
835 DeadInsts.push_back(ExtInst);
836
837 // UI is a linked list iterator, so AddUsersIfInteresting effectively pushes
838 // nodes on the worklist.
839 IU->AddUsersIfInteresting(ExtInst);
840 }
841 return LargestType;
842}
843
Dan Gohman454d26d2010-02-22 04:11:59 +0000844void IndVarSimplify::RewriteIVExpressions(Loop *L, SCEVExpander &Rewriter) {
Dan Gohman81db61a2009-05-12 02:17:14 +0000845 // Rewrite all induction variable expressions in terms of the canonical
846 // induction variable.
847 //
848 // If there were induction variables of other sizes or offsets, manually
849 // add the offsets to the primary induction variable and cast, avoiding
850 // the need for the code evaluation methods to insert induction variables
851 // of different sizes.
Dan Gohman572645c2010-02-12 10:34:29 +0000852 for (IVUsers::iterator UI = IU->begin(), E = IU->end(); UI != E; ++UI) {
Dan Gohman572645c2010-02-12 10:34:29 +0000853 Value *Op = UI->getOperandValToReplace();
854 const Type *UseTy = Op->getType();
855 Instruction *User = UI->getUser();
Dan Gohman81db61a2009-05-12 02:17:14 +0000856
Dan Gohman572645c2010-02-12 10:34:29 +0000857 // Compute the final addrec to expand into code.
858 const SCEV *AR = IU->getReplacementExpr(*UI);
Dan Gohman81db61a2009-05-12 02:17:14 +0000859
Dan Gohman572645c2010-02-12 10:34:29 +0000860 // Evaluate the expression out of the loop, if possible.
861 if (!L->contains(UI->getUser())) {
862 const SCEV *ExitVal = SE->getSCEVAtScope(AR, L->getParentLoop());
Dan Gohman17ead4f2010-11-17 21:23:15 +0000863 if (SE->isLoopInvariant(ExitVal, L))
Dan Gohman572645c2010-02-12 10:34:29 +0000864 AR = ExitVal;
Dan Gohman81db61a2009-05-12 02:17:14 +0000865 }
Dan Gohman572645c2010-02-12 10:34:29 +0000866
867 // FIXME: It is an extremely bad idea to indvar substitute anything more
868 // complex than affine induction variables. Doing so will put expensive
869 // polynomial evaluations inside of the loop, and the str reduction pass
870 // currently can only reduce affine polynomials. For now just disable
871 // indvar subst on anything more complex than an affine addrec, unless
872 // it can be expanded to a trivial value.
Dan Gohman17ead4f2010-11-17 21:23:15 +0000873 if (!isSafe(AR, L, SE))
Dan Gohman572645c2010-02-12 10:34:29 +0000874 continue;
875
876 // Determine the insertion point for this user. By default, insert
877 // immediately before the user. The SCEVExpander class will automatically
878 // hoist loop invariants out of the loop. For PHI nodes, there may be
879 // multiple uses, so compute the nearest common dominator for the
880 // incoming blocks.
881 Instruction *InsertPt = User;
882 if (PHINode *PHI = dyn_cast<PHINode>(InsertPt))
883 for (unsigned i = 0, e = PHI->getNumIncomingValues(); i != e; ++i)
884 if (PHI->getIncomingValue(i) == Op) {
885 if (InsertPt == User)
886 InsertPt = PHI->getIncomingBlock(i)->getTerminator();
887 else
888 InsertPt =
889 DT->findNearestCommonDominator(InsertPt->getParent(),
890 PHI->getIncomingBlock(i))
891 ->getTerminator();
892 }
893
894 // Now expand it into actual Instructions and patch it into place.
895 Value *NewVal = Rewriter.expandCodeFor(AR, UseTy, InsertPt);
896
Andrew Trickb12a7542011-03-17 23:51:11 +0000897 DEBUG(dbgs() << "INDVARS: Rewrote IV '" << *AR << "' " << *Op << '\n'
898 << " into = " << *NewVal << "\n");
899
900 if (!isValidRewrite(Op, NewVal)) {
901 DeadInsts.push_back(NewVal);
902 continue;
903 }
Dan Gohmand7bfd002010-04-02 14:48:31 +0000904 // Inform ScalarEvolution that this value is changing. The change doesn't
905 // affect its value, but it does potentially affect which use lists the
906 // value will be on after the replacement, which affects ScalarEvolution's
907 // ability to walk use lists and drop dangling pointers when a value is
908 // deleted.
909 SE->forgetValue(User);
910
Dan Gohman572645c2010-02-12 10:34:29 +0000911 // Patch the new value into place.
912 if (Op->hasName())
913 NewVal->takeName(Op);
914 User->replaceUsesOfWith(Op, NewVal);
915 UI->setOperandValToReplace(NewVal);
Andrew Trickb12a7542011-03-17 23:51:11 +0000916
Dan Gohman572645c2010-02-12 10:34:29 +0000917 ++NumRemoved;
918 Changed = true;
919
920 // The old value may be dead now.
921 DeadInsts.push_back(Op);
Dan Gohman81db61a2009-05-12 02:17:14 +0000922 }
Dan Gohman81db61a2009-05-12 02:17:14 +0000923}
924
925/// If there's a single exit block, sink any loop-invariant values that
926/// were defined in the preheader but not used inside the loop into the
927/// exit block to reduce register pressure in the loop.
Dan Gohman667d7872009-06-26 22:53:46 +0000928void IndVarSimplify::SinkUnusedInvariants(Loop *L) {
Dan Gohman81db61a2009-05-12 02:17:14 +0000929 BasicBlock *ExitBlock = L->getExitBlock();
930 if (!ExitBlock) return;
931
Dan Gohman81db61a2009-05-12 02:17:14 +0000932 BasicBlock *Preheader = L->getLoopPreheader();
Dan Gohman03e896b2009-11-05 21:11:53 +0000933 if (!Preheader) return;
934
935 Instruction *InsertPt = ExitBlock->getFirstNonPHI();
Dan Gohman81db61a2009-05-12 02:17:14 +0000936 BasicBlock::iterator I = Preheader->getTerminator();
937 while (I != Preheader->begin()) {
938 --I;
Dan Gohman667d7872009-06-26 22:53:46 +0000939 // New instructions were inserted at the end of the preheader.
940 if (isa<PHINode>(I))
Dan Gohman81db61a2009-05-12 02:17:14 +0000941 break;
Bill Wendling87a10f52010-03-23 21:15:59 +0000942
Eli Friedman0c77db32009-07-15 22:48:29 +0000943 // Don't move instructions which might have side effects, since the side
Bill Wendling87a10f52010-03-23 21:15:59 +0000944 // effects need to complete before instructions inside the loop. Also don't
945 // move instructions which might read memory, since the loop may modify
946 // memory. Note that it's okay if the instruction might have undefined
947 // behavior: LoopSimplify guarantees that the preheader dominates the exit
948 // block.
Eli Friedman0c77db32009-07-15 22:48:29 +0000949 if (I->mayHaveSideEffects() || I->mayReadFromMemory())
Dan Gohman667d7872009-06-26 22:53:46 +0000950 continue;
Bill Wendling87a10f52010-03-23 21:15:59 +0000951
Devang Patel7b9f6b12010-03-15 22:23:03 +0000952 // Skip debug info intrinsics.
953 if (isa<DbgInfoIntrinsic>(I))
954 continue;
Bill Wendling87a10f52010-03-23 21:15:59 +0000955
Dan Gohman76f497a2009-08-25 17:42:10 +0000956 // Don't sink static AllocaInsts out of the entry block, which would
957 // turn them into dynamic allocas!
958 if (AllocaInst *AI = dyn_cast<AllocaInst>(I))
959 if (AI->isStaticAlloca())
960 continue;
Bill Wendling87a10f52010-03-23 21:15:59 +0000961
Dan Gohman81db61a2009-05-12 02:17:14 +0000962 // Determine if there is a use in or before the loop (direct or
963 // otherwise).
964 bool UsedInLoop = false;
965 for (Value::use_iterator UI = I->use_begin(), UE = I->use_end();
966 UI != UE; ++UI) {
Gabor Greif76560182010-07-09 15:40:10 +0000967 User *U = *UI;
968 BasicBlock *UseBB = cast<Instruction>(U)->getParent();
969 if (PHINode *P = dyn_cast<PHINode>(U)) {
Dan Gohman81db61a2009-05-12 02:17:14 +0000970 unsigned i =
971 PHINode::getIncomingValueNumForOperand(UI.getOperandNo());
972 UseBB = P->getIncomingBlock(i);
973 }
974 if (UseBB == Preheader || L->contains(UseBB)) {
975 UsedInLoop = true;
976 break;
977 }
978 }
Bill Wendling87a10f52010-03-23 21:15:59 +0000979
Dan Gohman81db61a2009-05-12 02:17:14 +0000980 // If there is, the def must remain in the preheader.
981 if (UsedInLoop)
982 continue;
Bill Wendling87a10f52010-03-23 21:15:59 +0000983
Dan Gohman81db61a2009-05-12 02:17:14 +0000984 // Otherwise, sink it to the exit block.
985 Instruction *ToMove = I;
986 bool Done = false;
Bill Wendling87a10f52010-03-23 21:15:59 +0000987
988 if (I != Preheader->begin()) {
989 // Skip debug info intrinsics.
990 do {
991 --I;
992 } while (isa<DbgInfoIntrinsic>(I) && I != Preheader->begin());
993
994 if (isa<DbgInfoIntrinsic>(I) && I == Preheader->begin())
995 Done = true;
996 } else {
Dan Gohman81db61a2009-05-12 02:17:14 +0000997 Done = true;
Bill Wendling87a10f52010-03-23 21:15:59 +0000998 }
999
Dan Gohman667d7872009-06-26 22:53:46 +00001000 ToMove->moveBefore(InsertPt);
Bill Wendling87a10f52010-03-23 21:15:59 +00001001 if (Done) break;
Dan Gohman667d7872009-06-26 22:53:46 +00001002 InsertPt = ToMove;
Dan Gohman81db61a2009-05-12 02:17:14 +00001003 }
1004}
1005
Chris Lattnerbbb91492010-04-03 06:41:49 +00001006/// ConvertToSInt - Convert APF to an integer, if possible.
1007static bool ConvertToSInt(const APFloat &APF, int64_t &IntVal) {
Devang Patelcd402332008-11-17 23:27:13 +00001008 bool isExact = false;
Evan Cheng794a7db2008-11-26 01:11:57 +00001009 if (&APF.getSemantics() == &APFloat::PPCDoubleDouble)
1010 return false;
Chris Lattnerbbb91492010-04-03 06:41:49 +00001011 // See if we can convert this to an int64_t
1012 uint64_t UIntVal;
1013 if (APF.convertToInteger(&UIntVal, 64, true, APFloat::rmTowardZero,
1014 &isExact) != APFloat::opOK || !isExact)
Devang Patelcd402332008-11-17 23:27:13 +00001015 return false;
Chris Lattnerbbb91492010-04-03 06:41:49 +00001016 IntVal = UIntVal;
Devang Patelcd402332008-11-17 23:27:13 +00001017 return true;
Devang Patelcd402332008-11-17 23:27:13 +00001018}
1019
Devang Patel58d43d42008-11-03 18:32:19 +00001020/// HandleFloatingPointIV - If the loop has floating induction variable
1021/// then insert corresponding integer induction variable if possible.
Devang Patel84e35152008-11-17 21:32:02 +00001022/// For example,
1023/// for(double i = 0; i < 10000; ++i)
1024/// bar(i)
1025/// is converted into
1026/// for(int i = 0; i < 10000; ++i)
1027/// bar((double)i);
1028///
Chris Lattnerc91961e2010-04-03 06:17:08 +00001029void IndVarSimplify::HandleFloatingPointIV(Loop *L, PHINode *PN) {
1030 unsigned IncomingEdge = L->contains(PN->getIncomingBlock(0));
Devang Patel84e35152008-11-17 21:32:02 +00001031 unsigned BackEdge = IncomingEdge^1;
Dan Gohmancafb8132009-02-17 19:13:57 +00001032
Devang Patel84e35152008-11-17 21:32:02 +00001033 // Check incoming value.
Chris Lattnerc4f7e802010-04-03 06:05:10 +00001034 ConstantFP *InitValueVal =
Chris Lattnerc91961e2010-04-03 06:17:08 +00001035 dyn_cast<ConstantFP>(PN->getIncomingValue(IncomingEdge));
Chris Lattner96fd7662010-04-03 07:18:48 +00001036
Chris Lattnerbbb91492010-04-03 06:41:49 +00001037 int64_t InitValue;
Chris Lattner96fd7662010-04-03 07:18:48 +00001038 if (!InitValueVal || !ConvertToSInt(InitValueVal->getValueAPF(), InitValue))
Devang Patelcd402332008-11-17 23:27:13 +00001039 return;
1040
Chris Lattnerc91961e2010-04-03 06:17:08 +00001041 // Check IV increment. Reject this PN if increment operation is not
Devang Patelcd402332008-11-17 23:27:13 +00001042 // an add or increment value can not be represented by an integer.
Dan Gohmancafb8132009-02-17 19:13:57 +00001043 BinaryOperator *Incr =
Chris Lattnerc91961e2010-04-03 06:17:08 +00001044 dyn_cast<BinaryOperator>(PN->getIncomingValue(BackEdge));
Chris Lattner07aa76a2010-04-03 05:54:59 +00001045 if (Incr == 0 || Incr->getOpcode() != Instruction::FAdd) return;
Andrew Trickead71d52011-03-17 23:46:48 +00001046
Chris Lattner07aa76a2010-04-03 05:54:59 +00001047 // If this is not an add of the PHI with a constantfp, or if the constant fp
1048 // is not an integer, bail out.
Chris Lattnerc4f7e802010-04-03 06:05:10 +00001049 ConstantFP *IncValueVal = dyn_cast<ConstantFP>(Incr->getOperand(1));
Chris Lattner96fd7662010-04-03 07:18:48 +00001050 int64_t IncValue;
Chris Lattnerc91961e2010-04-03 06:17:08 +00001051 if (IncValueVal == 0 || Incr->getOperand(0) != PN ||
Chris Lattner96fd7662010-04-03 07:18:48 +00001052 !ConvertToSInt(IncValueVal->getValueAPF(), IncValue))
Devang Patelcd402332008-11-17 23:27:13 +00001053 return;
Dan Gohmancafb8132009-02-17 19:13:57 +00001054
Chris Lattnerc91961e2010-04-03 06:17:08 +00001055 // Check Incr uses. One user is PN and the other user is an exit condition
Chris Lattner07aa76a2010-04-03 05:54:59 +00001056 // used by the conditional terminator.
Devang Patel84e35152008-11-17 21:32:02 +00001057 Value::use_iterator IncrUse = Incr->use_begin();
Gabor Greif96f1d8e2010-07-22 13:36:47 +00001058 Instruction *U1 = cast<Instruction>(*IncrUse++);
Devang Patel84e35152008-11-17 21:32:02 +00001059 if (IncrUse == Incr->use_end()) return;
Gabor Greif96f1d8e2010-07-22 13:36:47 +00001060 Instruction *U2 = cast<Instruction>(*IncrUse++);
Devang Patel84e35152008-11-17 21:32:02 +00001061 if (IncrUse != Incr->use_end()) return;
Dan Gohmancafb8132009-02-17 19:13:57 +00001062
Chris Lattner07aa76a2010-04-03 05:54:59 +00001063 // Find exit condition, which is an fcmp. If it doesn't exist, or if it isn't
1064 // only used by a branch, we can't transform it.
Chris Lattnerca703bd2010-04-03 06:11:07 +00001065 FCmpInst *Compare = dyn_cast<FCmpInst>(U1);
1066 if (!Compare)
1067 Compare = dyn_cast<FCmpInst>(U2);
1068 if (Compare == 0 || !Compare->hasOneUse() ||
1069 !isa<BranchInst>(Compare->use_back()))
Chris Lattner07aa76a2010-04-03 05:54:59 +00001070 return;
Andrew Trickead71d52011-03-17 23:46:48 +00001071
Chris Lattnerca703bd2010-04-03 06:11:07 +00001072 BranchInst *TheBr = cast<BranchInst>(Compare->use_back());
Devang Patel84e35152008-11-17 21:32:02 +00001073
Chris Lattnerd52c0722010-04-03 07:21:39 +00001074 // We need to verify that the branch actually controls the iteration count
1075 // of the loop. If not, the new IV can overflow and no one will notice.
1076 // The branch block must be in the loop and one of the successors must be out
1077 // of the loop.
1078 assert(TheBr->isConditional() && "Can't use fcmp if not conditional");
1079 if (!L->contains(TheBr->getParent()) ||
1080 (L->contains(TheBr->getSuccessor(0)) &&
1081 L->contains(TheBr->getSuccessor(1))))
1082 return;
Andrew Trickead71d52011-03-17 23:46:48 +00001083
1084
Chris Lattner07aa76a2010-04-03 05:54:59 +00001085 // If it isn't a comparison with an integer-as-fp (the exit value), we can't
1086 // transform it.
Chris Lattnerca703bd2010-04-03 06:11:07 +00001087 ConstantFP *ExitValueVal = dyn_cast<ConstantFP>(Compare->getOperand(1));
Chris Lattnerbbb91492010-04-03 06:41:49 +00001088 int64_t ExitValue;
1089 if (ExitValueVal == 0 ||
1090 !ConvertToSInt(ExitValueVal->getValueAPF(), ExitValue))
Devang Patel84e35152008-11-17 21:32:02 +00001091 return;
Andrew Trickead71d52011-03-17 23:46:48 +00001092
Devang Patel84e35152008-11-17 21:32:02 +00001093 // Find new predicate for integer comparison.
1094 CmpInst::Predicate NewPred = CmpInst::BAD_ICMP_PREDICATE;
Chris Lattnerca703bd2010-04-03 06:11:07 +00001095 switch (Compare->getPredicate()) {
Chris Lattnerc4f7e802010-04-03 06:05:10 +00001096 default: return; // Unknown comparison.
Devang Patel84e35152008-11-17 21:32:02 +00001097 case CmpInst::FCMP_OEQ:
Chris Lattnerc4f7e802010-04-03 06:05:10 +00001098 case CmpInst::FCMP_UEQ: NewPred = CmpInst::ICMP_EQ; break;
Chris Lattner96fd7662010-04-03 07:18:48 +00001099 case CmpInst::FCMP_ONE:
1100 case CmpInst::FCMP_UNE: NewPred = CmpInst::ICMP_NE; break;
Devang Patel84e35152008-11-17 21:32:02 +00001101 case CmpInst::FCMP_OGT:
Chris Lattnera40e4a02010-04-03 06:25:21 +00001102 case CmpInst::FCMP_UGT: NewPred = CmpInst::ICMP_SGT; break;
Devang Patel84e35152008-11-17 21:32:02 +00001103 case CmpInst::FCMP_OGE:
Chris Lattnera40e4a02010-04-03 06:25:21 +00001104 case CmpInst::FCMP_UGE: NewPred = CmpInst::ICMP_SGE; break;
Devang Patel84e35152008-11-17 21:32:02 +00001105 case CmpInst::FCMP_OLT:
Chris Lattner43b85272010-04-03 06:30:03 +00001106 case CmpInst::FCMP_ULT: NewPred = CmpInst::ICMP_SLT; break;
Devang Patel84e35152008-11-17 21:32:02 +00001107 case CmpInst::FCMP_OLE:
Chris Lattner43b85272010-04-03 06:30:03 +00001108 case CmpInst::FCMP_ULE: NewPred = CmpInst::ICMP_SLE; break;
Devang Patel58d43d42008-11-03 18:32:19 +00001109 }
Andrew Trickead71d52011-03-17 23:46:48 +00001110
Chris Lattner96fd7662010-04-03 07:18:48 +00001111 // We convert the floating point induction variable to a signed i32 value if
1112 // we can. This is only safe if the comparison will not overflow in a way
1113 // that won't be trapped by the integer equivalent operations. Check for this
1114 // now.
1115 // TODO: We could use i64 if it is native and the range requires it.
Andrew Trickead71d52011-03-17 23:46:48 +00001116
Chris Lattner96fd7662010-04-03 07:18:48 +00001117 // The start/stride/exit values must all fit in signed i32.
1118 if (!isInt<32>(InitValue) || !isInt<32>(IncValue) || !isInt<32>(ExitValue))
1119 return;
1120
1121 // If not actually striding (add x, 0.0), avoid touching the code.
1122 if (IncValue == 0)
1123 return;
1124
1125 // Positive and negative strides have different safety conditions.
1126 if (IncValue > 0) {
1127 // If we have a positive stride, we require the init to be less than the
1128 // exit value and an equality or less than comparison.
1129 if (InitValue >= ExitValue ||
1130 NewPred == CmpInst::ICMP_SGT || NewPred == CmpInst::ICMP_SGE)
1131 return;
Andrew Trickead71d52011-03-17 23:46:48 +00001132
Chris Lattner96fd7662010-04-03 07:18:48 +00001133 uint32_t Range = uint32_t(ExitValue-InitValue);
1134 if (NewPred == CmpInst::ICMP_SLE) {
1135 // Normalize SLE -> SLT, check for infinite loop.
1136 if (++Range == 0) return; // Range overflows.
1137 }
Andrew Trickead71d52011-03-17 23:46:48 +00001138
Chris Lattner96fd7662010-04-03 07:18:48 +00001139 unsigned Leftover = Range % uint32_t(IncValue);
Andrew Trickead71d52011-03-17 23:46:48 +00001140
Chris Lattner96fd7662010-04-03 07:18:48 +00001141 // If this is an equality comparison, we require that the strided value
1142 // exactly land on the exit value, otherwise the IV condition will wrap
1143 // around and do things the fp IV wouldn't.
1144 if ((NewPred == CmpInst::ICMP_EQ || NewPred == CmpInst::ICMP_NE) &&
1145 Leftover != 0)
1146 return;
Andrew Trickead71d52011-03-17 23:46:48 +00001147
Chris Lattner96fd7662010-04-03 07:18:48 +00001148 // If the stride would wrap around the i32 before exiting, we can't
1149 // transform the IV.
1150 if (Leftover != 0 && int32_t(ExitValue+IncValue) < ExitValue)
1151 return;
Andrew Trickead71d52011-03-17 23:46:48 +00001152
Chris Lattner96fd7662010-04-03 07:18:48 +00001153 } else {
1154 // If we have a negative stride, we require the init to be greater than the
1155 // exit value and an equality or greater than comparison.
1156 if (InitValue >= ExitValue ||
1157 NewPred == CmpInst::ICMP_SLT || NewPred == CmpInst::ICMP_SLE)
1158 return;
Andrew Trickead71d52011-03-17 23:46:48 +00001159
Chris Lattner96fd7662010-04-03 07:18:48 +00001160 uint32_t Range = uint32_t(InitValue-ExitValue);
1161 if (NewPred == CmpInst::ICMP_SGE) {
1162 // Normalize SGE -> SGT, check for infinite loop.
1163 if (++Range == 0) return; // Range overflows.
1164 }
Andrew Trickead71d52011-03-17 23:46:48 +00001165
Chris Lattner96fd7662010-04-03 07:18:48 +00001166 unsigned Leftover = Range % uint32_t(-IncValue);
Andrew Trickead71d52011-03-17 23:46:48 +00001167
Chris Lattner96fd7662010-04-03 07:18:48 +00001168 // If this is an equality comparison, we require that the strided value
1169 // exactly land on the exit value, otherwise the IV condition will wrap
1170 // around and do things the fp IV wouldn't.
1171 if ((NewPred == CmpInst::ICMP_EQ || NewPred == CmpInst::ICMP_NE) &&
1172 Leftover != 0)
1173 return;
Andrew Trickead71d52011-03-17 23:46:48 +00001174
Chris Lattner96fd7662010-04-03 07:18:48 +00001175 // If the stride would wrap around the i32 before exiting, we can't
1176 // transform the IV.
1177 if (Leftover != 0 && int32_t(ExitValue+IncValue) > ExitValue)
1178 return;
1179 }
Andrew Trickead71d52011-03-17 23:46:48 +00001180
Chris Lattner96fd7662010-04-03 07:18:48 +00001181 const IntegerType *Int32Ty = Type::getInt32Ty(PN->getContext());
Dan Gohmancafb8132009-02-17 19:13:57 +00001182
Chris Lattnerbbb91492010-04-03 06:41:49 +00001183 // Insert new integer induction variable.
Jay Foad3ecfc862011-03-30 11:28:46 +00001184 PHINode *NewPHI = PHINode::Create(Int32Ty, 2, PN->getName()+".int", PN);
Chris Lattnerc4f7e802010-04-03 06:05:10 +00001185 NewPHI->addIncoming(ConstantInt::get(Int32Ty, InitValue),
Chris Lattnerc91961e2010-04-03 06:17:08 +00001186 PN->getIncomingBlock(IncomingEdge));
Devang Patel84e35152008-11-17 21:32:02 +00001187
Chris Lattnerc4f7e802010-04-03 06:05:10 +00001188 Value *NewAdd =
Chris Lattner96fd7662010-04-03 07:18:48 +00001189 BinaryOperator::CreateAdd(NewPHI, ConstantInt::get(Int32Ty, IncValue),
Chris Lattnerc4f7e802010-04-03 06:05:10 +00001190 Incr->getName()+".int", Incr);
Chris Lattnerc91961e2010-04-03 06:17:08 +00001191 NewPHI->addIncoming(NewAdd, PN->getIncomingBlock(BackEdge));
Devang Patel84e35152008-11-17 21:32:02 +00001192
Chris Lattnerca703bd2010-04-03 06:11:07 +00001193 ICmpInst *NewCompare = new ICmpInst(TheBr, NewPred, NewAdd,
1194 ConstantInt::get(Int32Ty, ExitValue),
1195 Compare->getName());
Dan Gohmancafb8132009-02-17 19:13:57 +00001196
Chris Lattnerc91961e2010-04-03 06:17:08 +00001197 // In the following deletions, PN may become dead and may be deleted.
Dan Gohman81db61a2009-05-12 02:17:14 +00001198 // Use a WeakVH to observe whether this happens.
Chris Lattnerc91961e2010-04-03 06:17:08 +00001199 WeakVH WeakPH = PN;
Dan Gohman81db61a2009-05-12 02:17:14 +00001200
Chris Lattnerca703bd2010-04-03 06:11:07 +00001201 // Delete the old floating point exit comparison. The branch starts using the
1202 // new comparison.
1203 NewCompare->takeName(Compare);
1204 Compare->replaceAllUsesWith(NewCompare);
1205 RecursivelyDeleteTriviallyDeadInstructions(Compare);
Dan Gohmancafb8132009-02-17 19:13:57 +00001206
Chris Lattnerca703bd2010-04-03 06:11:07 +00001207 // Delete the old floating point increment.
Owen Anderson9e9a0d52009-07-30 23:03:37 +00001208 Incr->replaceAllUsesWith(UndefValue::get(Incr->getType()));
Dan Gohman81db61a2009-05-12 02:17:14 +00001209 RecursivelyDeleteTriviallyDeadInstructions(Incr);
Dan Gohmancafb8132009-02-17 19:13:57 +00001210
Chris Lattner70c0d4f2010-04-03 06:16:22 +00001211 // If the FP induction variable still has uses, this is because something else
1212 // in the loop uses its value. In order to canonicalize the induction
1213 // variable, we chose to eliminate the IV and rewrite it in terms of an
1214 // int->fp cast.
1215 //
1216 // We give preference to sitofp over uitofp because it is faster on most
1217 // platforms.
1218 if (WeakPH) {
Chris Lattnera40e4a02010-04-03 06:25:21 +00001219 Value *Conv = new SIToFPInst(NewPHI, PN->getType(), "indvar.conv",
1220 PN->getParent()->getFirstNonPHI());
1221 PN->replaceAllUsesWith(Conv);
Chris Lattnerc91961e2010-04-03 06:17:08 +00001222 RecursivelyDeleteTriviallyDeadInstructions(PN);
Devang Patelcd402332008-11-17 23:27:13 +00001223 }
Devang Patel58d43d42008-11-03 18:32:19 +00001224
Dan Gohman81db61a2009-05-12 02:17:14 +00001225 // Add a new IVUsers entry for the newly-created integer PHI.
1226 IU->AddUsersIfInteresting(NewPHI);
1227}