1 //===- IVUsers.cpp - Induction Variable Users -------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements bookkeeping for "interesting" users of expressions
11 // computed from induction variables.
13 //===----------------------------------------------------------------------===//
15 #define DEBUG_TYPE "iv-users"
16 #include "llvm/Analysis/IVUsers.h"
17 #include "llvm/Constants.h"
18 #include "llvm/Instructions.h"
19 #include "llvm/Type.h"
20 #include "llvm/DerivedTypes.h"
21 #include "llvm/Analysis/Dominators.h"
22 #include "llvm/Analysis/LoopPass.h"
23 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
24 #include "llvm/ADT/STLExtras.h"
25 #include "llvm/Support/Debug.h"
26 #include "llvm/Support/raw_ostream.h"
31 static RegisterPass<IVUsers>
32 X("iv-users", "Induction Variable Users", false, true);
34 Pass *llvm::createIVUsersPass() {
38 /// containsAddRecFromDifferentLoop - Determine whether expression S involves a
39 /// subexpression that is an AddRec from a loop other than L. An outer loop
40 /// of L is OK, but not an inner loop nor a disjoint loop.
41 static bool containsAddRecFromDifferentLoop(const SCEV *S, Loop *L) {
42 // This is very common, put it first.
43 if (isa<SCEVConstant>(S))
45 if (const SCEVCommutativeExpr *AE = dyn_cast<SCEVCommutativeExpr>(S)) {
46 for (unsigned int i=0; i< AE->getNumOperands(); i++)
47 if (containsAddRecFromDifferentLoop(AE->getOperand(i), L))
51 if (const SCEVAddRecExpr *AE = dyn_cast<SCEVAddRecExpr>(S)) {
52 if (const Loop *newLoop = AE->getLoop()) {
55 // if newLoop is an outer loop of L, this is OK.
56 if (newLoop->contains(L))
61 if (const SCEVUDivExpr *DE = dyn_cast<SCEVUDivExpr>(S))
62 return containsAddRecFromDifferentLoop(DE->getLHS(), L) ||
63 containsAddRecFromDifferentLoop(DE->getRHS(), L);
65 // SCEVSDivExpr has been backed out temporarily, but will be back; we'll
66 // need this when it is.
67 if (const SCEVSDivExpr *DE = dyn_cast<SCEVSDivExpr>(S))
68 return containsAddRecFromDifferentLoop(DE->getLHS(), L) ||
69 containsAddRecFromDifferentLoop(DE->getRHS(), L);
71 if (const SCEVCastExpr *CE = dyn_cast<SCEVCastExpr>(S))
72 return containsAddRecFromDifferentLoop(CE->getOperand(), L);
76 /// getSCEVStartAndStride - Compute the start and stride of this expression,
77 /// returning false if the expression is not a start/stride pair, or true if it
78 /// is. The stride must be a loop invariant expression, but the start may be
79 /// a mix of loop invariant and loop variant expressions. The start cannot,
80 /// however, contain an AddRec from a different loop, unless that loop is an
81 /// outer loop of the current loop.
82 static bool getSCEVStartAndStride(const SCEV *&SH, Loop *L, Loop *UseLoop,
83 const SCEV *&Start, const SCEV *&Stride,
84 ScalarEvolution *SE, DominatorTree *DT) {
85 const SCEV *TheAddRec = Start; // Initialize to zero.
87 // If the outer level is an AddExpr, the operands are all start values except
88 // for a nested AddRecExpr.
89 if (const SCEVAddExpr *AE = dyn_cast<SCEVAddExpr>(SH)) {
90 for (unsigned i = 0, e = AE->getNumOperands(); i != e; ++i)
91 if (const SCEVAddRecExpr *AddRec =
92 dyn_cast<SCEVAddRecExpr>(AE->getOperand(i))) {
93 if (AddRec->getLoop() == L)
94 TheAddRec = SE->getAddExpr(AddRec, TheAddRec);
96 return false; // Nested IV of some sort?
98 Start = SE->getAddExpr(Start, AE->getOperand(i));
100 } else if (isa<SCEVAddRecExpr>(SH)) {
103 return false; // not analyzable.
106 const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(TheAddRec);
107 if (!AddRec || AddRec->getLoop() != L) return false;
109 // Use getSCEVAtScope to attempt to simplify other loops out of
111 const SCEV *AddRecStart = AddRec->getStart();
112 AddRecStart = SE->getSCEVAtScope(AddRecStart, UseLoop);
113 const SCEV *AddRecStride = AddRec->getStepRecurrence(*SE);
115 // FIXME: If Start contains an SCEVAddRecExpr from a different loop, other
116 // than an outer loop of the current loop, reject it. LSR has no concept of
117 // operating on more than one loop at a time so don't confuse it with such
119 if (containsAddRecFromDifferentLoop(AddRecStart, L))
122 Start = SE->getAddExpr(Start, AddRecStart);
124 // If stride is an instruction, make sure it properly dominates the header.
125 // Otherwise we could end up with a use before def situation.
126 if (!isa<SCEVConstant>(AddRecStride)) {
127 BasicBlock *Header = L->getHeader();
128 if (!AddRecStride->properlyDominates(Header, DT))
132 WriteAsOperand(dbgs(), L->getHeader(), /*PrintType=*/false);
133 dbgs() << "] Variable stride: " << *AddRec << "\n");
136 Stride = AddRecStride;
140 /// IVUseShouldUsePostIncValue - We have discovered a "User" of an IV expression
141 /// and now we need to decide whether the user should use the preinc or post-inc
142 /// value. If this user should use the post-inc version of the IV, return true.
144 /// Choosing wrong here can break dominance properties (if we choose to use the
145 /// post-inc value when we cannot) or it can end up adding extra live-ranges to
146 /// the loop, resulting in reg-reg copies (if we use the pre-inc value when we
147 /// should use the post-inc value).
148 static bool IVUseShouldUsePostIncValue(Instruction *User, Instruction *IV,
149 Loop *L, LoopInfo *LI, DominatorTree *DT,
151 // If the user is in the loop, use the preinc value.
152 if (L->contains(User)) return false;
154 BasicBlock *LatchBlock = L->getLoopLatch();
158 // Ok, the user is outside of the loop. If it is dominated by the latch
159 // block, use the post-inc value.
160 if (DT->dominates(LatchBlock, User->getParent()))
163 // There is one case we have to be careful of: PHI nodes. These little guys
164 // can live in blocks that are not dominated by the latch block, but (since
165 // their uses occur in the predecessor block, not the block the PHI lives in)
166 // should still use the post-inc value. Check for this case now.
167 PHINode *PN = dyn_cast<PHINode>(User);
168 if (!PN) return false; // not a phi, not dominated by latch block.
170 // Look at all of the uses of IV by the PHI node. If any use corresponds to
171 // a block that is not dominated by the latch block, give up and use the
172 // preincremented value.
173 unsigned NumUses = 0;
174 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
175 if (PN->getIncomingValue(i) == IV) {
177 if (!DT->dominates(LatchBlock, PN->getIncomingBlock(i)))
181 // Okay, all uses of IV by PN are in predecessor blocks that really are
182 // dominated by the latch block. Use the post-incremented value.
186 /// AddUsersIfInteresting - Inspect the specified instruction. If it is a
187 /// reducible SCEV, recursively add its users to the IVUsesByStride set and
188 /// return true. Otherwise, return false.
189 bool IVUsers::AddUsersIfInteresting(Instruction *I) {
190 if (!SE->isSCEVable(I->getType()))
191 return false; // Void and FP expressions cannot be reduced.
193 // LSR is not APInt clean, do not touch integers bigger than 64-bits.
194 if (SE->getTypeSizeInBits(I->getType()) > 64)
197 if (!Processed.insert(I))
198 return true; // Instruction already handled.
200 // Get the symbolic expression for this instruction.
201 const SCEV *ISE = SE->getSCEV(I);
202 if (isa<SCEVCouldNotCompute>(ISE)) return false;
204 // Get the start and stride for this expression.
205 Loop *UseLoop = LI->getLoopFor(I->getParent());
206 const SCEV *Start = SE->getIntegerSCEV(0, ISE->getType());
207 const SCEV *Stride = Start;
209 if (!getSCEVStartAndStride(ISE, L, UseLoop, Start, Stride, SE, DT))
210 return false; // Non-reducible symbolic expression, bail out.
212 // Keep things simple. Don't touch loop-variant strides.
213 if (!Stride->isLoopInvariant(L) && L->contains(I))
216 SmallPtrSet<Instruction *, 4> UniqueUsers;
217 for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
219 Instruction *User = cast<Instruction>(*UI);
220 if (!UniqueUsers.insert(User))
223 // Do not infinitely recurse on PHI nodes.
224 if (isa<PHINode>(User) && Processed.count(User))
227 // Descend recursively, but not into PHI nodes outside the current loop.
228 // It's important to see the entire expression outside the loop to get
229 // choices that depend on addressing mode use right, although we won't
230 // consider references ouside the loop in all cases.
231 // If User is already in Processed, we don't want to recurse into it again,
232 // but do want to record a second reference in the same instruction.
233 bool AddUserToIVUsers = false;
234 if (LI->getLoopFor(User->getParent()) != L) {
235 if (isa<PHINode>(User) || Processed.count(User) ||
236 !AddUsersIfInteresting(User)) {
237 DEBUG(dbgs() << "FOUND USER in other loop: " << *User << '\n'
238 << " OF SCEV: " << *ISE << '\n');
239 AddUserToIVUsers = true;
241 } else if (Processed.count(User) ||
242 !AddUsersIfInteresting(User)) {
243 DEBUG(dbgs() << "FOUND USER: " << *User << '\n'
244 << " OF SCEV: " << *ISE << '\n');
245 AddUserToIVUsers = true;
248 if (AddUserToIVUsers) {
249 IVUsersOfOneStride *StrideUses = IVUsesByStride[Stride];
250 if (!StrideUses) { // First occurrence of this stride?
251 StrideOrder.push_back(Stride);
252 StrideUses = new IVUsersOfOneStride(Stride);
253 IVUses.push_back(StrideUses);
254 IVUsesByStride[Stride] = StrideUses;
257 // Okay, we found a user that we cannot reduce. Analyze the instruction
258 // and decide what to do with it. If we are a use inside of the loop, use
259 // the value before incrementation, otherwise use it after incrementation.
260 if (IVUseShouldUsePostIncValue(User, I, L, LI, DT, this)) {
261 // The value used will be incremented by the stride more than we are
262 // expecting, so subtract this off.
263 const SCEV *NewStart = SE->getMinusSCEV(Start, Stride);
264 StrideUses->addUser(NewStart, User, I);
265 StrideUses->Users.back().setIsUseOfPostIncrementedValue(true);
266 DEBUG(dbgs() << " USING POSTINC SCEV, START=" << *NewStart<< "\n");
268 StrideUses->addUser(Start, User, I);
275 void IVUsers::AddUser(const SCEV *Stride, const SCEV *Offset,
276 Instruction *User, Value *Operand) {
277 IVUsersOfOneStride *StrideUses = IVUsesByStride[Stride];
278 if (!StrideUses) { // First occurrence of this stride?
279 StrideOrder.push_back(Stride);
280 StrideUses = new IVUsersOfOneStride(Stride);
281 IVUses.push_back(StrideUses);
282 IVUsesByStride[Stride] = StrideUses;
284 IVUsesByStride[Stride]->addUser(Offset, User, Operand);
291 void IVUsers::getAnalysisUsage(AnalysisUsage &AU) const {
292 AU.addRequired<LoopInfo>();
293 AU.addRequired<DominatorTree>();
294 AU.addRequired<ScalarEvolution>();
295 AU.setPreservesAll();
298 bool IVUsers::runOnLoop(Loop *l, LPPassManager &LPM) {
301 LI = &getAnalysis<LoopInfo>();
302 DT = &getAnalysis<DominatorTree>();
303 SE = &getAnalysis<ScalarEvolution>();
305 // Find all uses of induction variables in this loop, and categorize
306 // them by stride. Start by finding all of the PHI nodes in the header for
307 // this loop. If they are induction variables, inspect their uses.
308 for (BasicBlock::iterator I = L->getHeader()->begin(); isa<PHINode>(I); ++I)
309 AddUsersIfInteresting(I);
314 /// getReplacementExpr - Return a SCEV expression which computes the
315 /// value of the OperandValToReplace of the given IVStrideUse.
316 const SCEV *IVUsers::getReplacementExpr(const IVStrideUse &U) const {
318 const SCEV *RetVal = SE->getIntegerSCEV(0, U.getParent()->Stride->getType());
319 // Create the basic add recurrence.
320 RetVal = SE->getAddRecExpr(RetVal, U.getParent()->Stride, L);
321 // Add the offset in a separate step, because it may be loop-variant.
322 RetVal = SE->getAddExpr(RetVal, U.getOffset());
323 // For uses of post-incremented values, add an extra stride to compute
324 // the actual replacement value.
325 if (U.isUseOfPostIncrementedValue())
326 RetVal = SE->getAddExpr(RetVal, U.getParent()->Stride);
330 /// getCanonicalExpr - Return a SCEV expression which computes the
331 /// value of the SCEV of the given IVStrideUse, ignoring the
332 /// isUseOfPostIncrementedValue flag.
333 const SCEV *IVUsers::getCanonicalExpr(const IVStrideUse &U) const {
335 const SCEV *RetVal = SE->getIntegerSCEV(0, U.getParent()->Stride->getType());
336 // Create the basic add recurrence.
337 RetVal = SE->getAddRecExpr(RetVal, U.getParent()->Stride, L);
338 // Add the offset in a separate step, because it may be loop-variant.
339 RetVal = SE->getAddExpr(RetVal, U.getOffset());
343 void IVUsers::print(raw_ostream &OS, const Module *M) const {
344 OS << "IV Users for loop ";
345 WriteAsOperand(OS, L->getHeader(), false);
346 if (SE->hasLoopInvariantBackedgeTakenCount(L)) {
347 OS << " with backedge-taken count "
348 << *SE->getBackedgeTakenCount(L);
352 for (unsigned Stride = 0, e = StrideOrder.size(); Stride != e; ++Stride) {
353 std::map<const SCEV *, IVUsersOfOneStride*>::const_iterator SI =
354 IVUsesByStride.find(StrideOrder[Stride]);
355 assert(SI != IVUsesByStride.end() && "Stride doesn't exist!");
356 OS << " Stride " << *SI->first->getType() << " " << *SI->first << ":\n";
358 for (ilist<IVStrideUse>::const_iterator UI = SI->second->Users.begin(),
359 E = SI->second->Users.end(); UI != E; ++UI) {
361 WriteAsOperand(OS, UI->getOperandValToReplace(), false);
363 OS << *getReplacementExpr(*UI);
364 if (UI->isUseOfPostIncrementedValue())
367 UI->getUser()->print(OS);
373 void IVUsers::dump() const {
377 void IVUsers::releaseMemory() {
378 IVUsesByStride.clear();
384 void IVStrideUse::deleted() {
385 // Remove this user from the list.
386 Parent->Users.erase(this);