1 //===- LoopStrengthReduce.cpp - Strength Reduce GEPs in Loops -------------===//
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 pass performs a strength reduction on array references inside loops that
11 // have as one or more of their components the loop induction variable. This is
12 // accomplished by creating a new Value to hold the initial value of the array
13 // access for the first iteration, and then creating a new GEP instruction in
14 // the loop to increment the value by the appropriate amount.
16 //===----------------------------------------------------------------------===//
18 #define DEBUG_TYPE "loop-reduce"
19 #include "llvm/Transforms/Scalar.h"
20 #include "llvm/Constants.h"
21 #include "llvm/Instructions.h"
22 #include "llvm/IntrinsicInst.h"
23 #include "llvm/Type.h"
24 #include "llvm/DerivedTypes.h"
25 #include "llvm/Analysis/Dominators.h"
26 #include "llvm/Analysis/LoopInfo.h"
27 #include "llvm/Analysis/LoopPass.h"
28 #include "llvm/Analysis/ScalarEvolutionExpander.h"
29 #include "llvm/Support/CFG.h"
30 #include "llvm/Support/GetElementPtrTypeIterator.h"
31 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
32 #include "llvm/Transforms/Utils/Local.h"
33 #include "llvm/Target/TargetData.h"
34 #include "llvm/ADT/SmallPtrSet.h"
35 #include "llvm/ADT/Statistic.h"
36 #include "llvm/Support/Debug.h"
37 #include "llvm/Support/CommandLine.h"
38 #include "llvm/Support/Compiler.h"
39 #include "llvm/Target/TargetLowering.h"
44 STATISTIC(NumReduced , "Number of GEPs strength reduced");
45 STATISTIC(NumInserted, "Number of PHIs inserted");
46 STATISTIC(NumVariable, "Number of PHIs with variable strides");
47 STATISTIC(NumEliminated , "Number of strides eliminated");
50 // Hidden options for help debugging.
51 cl::opt<bool> AllowPHIIVReuse("lsr-allow-phi-iv-reuse",
52 cl::init(true), cl::Hidden);
59 /// IVStrideUse - Keep track of one use of a strided induction variable, where
60 /// the stride is stored externally. The Offset member keeps track of the
61 /// offset from the IV, User is the actual user of the operand, and
62 /// 'OperandValToReplace' is the operand of the User that is the use.
63 struct VISIBILITY_HIDDEN IVStrideUse {
66 Value *OperandValToReplace;
68 // isUseOfPostIncrementedValue - True if this should use the
69 // post-incremented version of this IV, not the preincremented version.
70 // This can only be set in special cases, such as the terminating setcc
71 // instruction for a loop or uses dominated by the loop.
72 bool isUseOfPostIncrementedValue;
74 IVStrideUse(const SCEVHandle &Offs, Instruction *U, Value *O)
75 : Offset(Offs), User(U), OperandValToReplace(O),
76 isUseOfPostIncrementedValue(false) {}
79 /// IVUsersOfOneStride - This structure keeps track of all instructions that
80 /// have an operand that is based on the trip count multiplied by some stride.
81 /// The stride for all of these users is common and kept external to this
83 struct VISIBILITY_HIDDEN IVUsersOfOneStride {
84 /// Users - Keep track of all of the users of this stride as well as the
85 /// initial value and the operand that uses the IV.
86 std::vector<IVStrideUse> Users;
88 void addUser(const SCEVHandle &Offset,Instruction *User, Value *Operand) {
89 Users.push_back(IVStrideUse(Offset, User, Operand));
93 /// IVInfo - This structure keeps track of one IV expression inserted during
94 /// StrengthReduceStridedIVUsers. It contains the stride, the common base, as
95 /// well as the PHI node and increment value created for rewrite.
96 struct VISIBILITY_HIDDEN IVExpr {
102 IVExpr(const SCEVHandle &stride, const SCEVHandle &base, PHINode *phi,
104 : Stride(stride), Base(base), PHI(phi), IncV(incv) {}
107 /// IVsOfOneStride - This structure keeps track of all IV expression inserted
108 /// during StrengthReduceStridedIVUsers for a particular stride of the IV.
109 struct VISIBILITY_HIDDEN IVsOfOneStride {
110 std::vector<IVExpr> IVs;
112 void addIV(const SCEVHandle &Stride, const SCEVHandle &Base, PHINode *PHI,
114 IVs.push_back(IVExpr(Stride, Base, PHI, IncV));
118 class VISIBILITY_HIDDEN LoopStrengthReduce : public LoopPass {
122 const TargetData *TD;
123 const Type *UIntPtrTy;
126 /// IVUsesByStride - Keep track of all uses of induction variables that we
127 /// are interested in. The key of the map is the stride of the access.
128 std::map<SCEVHandle, IVUsersOfOneStride> IVUsesByStride;
130 /// IVsByStride - Keep track of all IVs that have been inserted for a
131 /// particular stride.
132 std::map<SCEVHandle, IVsOfOneStride> IVsByStride;
134 /// StrideOrder - An ordering of the keys in IVUsesByStride that is stable:
135 /// We use this to iterate over the IVUsesByStride collection without being
136 /// dependent on random ordering of pointers in the process.
137 SmallVector<SCEVHandle, 16> StrideOrder;
139 /// CastedValues - As we need to cast values to uintptr_t, this keeps track
140 /// of the casted version of each value. This is accessed by
141 /// getCastedVersionOf.
142 DenseMap<Value*, Value*> CastedPointers;
144 /// DeadInsts - Keep track of instructions we may have made dead, so that
145 /// we can remove them after we are done working.
146 SmallPtrSet<Instruction*,16> DeadInsts;
148 /// TLI - Keep a pointer of a TargetLowering to consult for determining
149 /// transformation profitability.
150 const TargetLowering *TLI;
153 static char ID; // Pass ID, replacement for typeid
154 explicit LoopStrengthReduce(const TargetLowering *tli = NULL) :
155 LoopPass((intptr_t)&ID), TLI(tli) {
158 bool runOnLoop(Loop *L, LPPassManager &LPM);
160 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
161 // We split critical edges, so we change the CFG. However, we do update
162 // many analyses if they are around.
163 AU.addPreservedID(LoopSimplifyID);
164 AU.addPreserved<LoopInfo>();
165 AU.addPreserved<DominanceFrontier>();
166 AU.addPreserved<DominatorTree>();
168 AU.addRequiredID(LoopSimplifyID);
169 AU.addRequired<LoopInfo>();
170 AU.addRequired<DominatorTree>();
171 AU.addRequired<TargetData>();
172 AU.addRequired<ScalarEvolution>();
175 /// getCastedVersionOf - Return the specified value casted to uintptr_t.
177 Value *getCastedVersionOf(Instruction::CastOps opcode, Value *V);
179 bool AddUsersIfInteresting(Instruction *I, Loop *L,
180 SmallPtrSet<Instruction*,16> &Processed);
181 SCEVHandle GetExpressionSCEV(Instruction *E);
182 ICmpInst *ChangeCompareStride(Loop *L, ICmpInst *Cond,
183 IVStrideUse* &CondUse,
184 const SCEVHandle* &CondStride);
185 void OptimizeIndvars(Loop *L);
186 bool FindIVForUser(ICmpInst *Cond, IVStrideUse *&CondUse,
187 const SCEVHandle *&CondStride);
188 bool RequiresTypeConversion(const Type *Ty, const Type *NewTy);
189 unsigned CheckForIVReuse(bool, bool, const SCEVHandle&,
190 IVExpr&, const Type*,
191 const std::vector<BasedUser>& UsersToProcess);
192 bool ValidStride(bool, int64_t,
193 const std::vector<BasedUser>& UsersToProcess);
194 SCEVHandle CollectIVUsers(const SCEVHandle &Stride,
195 IVUsersOfOneStride &Uses,
197 bool &AllUsesAreAddresses,
198 std::vector<BasedUser> &UsersToProcess);
199 void StrengthReduceStridedIVUsers(const SCEVHandle &Stride,
200 IVUsersOfOneStride &Uses,
201 Loop *L, bool isOnlyStride);
202 void DeleteTriviallyDeadInstructions(SmallPtrSet<Instruction*,16> &Insts);
204 char LoopStrengthReduce::ID = 0;
205 RegisterPass<LoopStrengthReduce> X("loop-reduce", "Loop Strength Reduction");
208 LoopPass *llvm::createLoopStrengthReducePass(const TargetLowering *TLI) {
209 return new LoopStrengthReduce(TLI);
212 /// getCastedVersionOf - Return the specified value casted to uintptr_t. This
213 /// assumes that the Value* V is of integer or pointer type only.
215 Value *LoopStrengthReduce::getCastedVersionOf(Instruction::CastOps opcode,
217 if (V->getType() == UIntPtrTy) return V;
218 if (Constant *CB = dyn_cast<Constant>(V))
219 return ConstantExpr::getCast(opcode, CB, UIntPtrTy);
221 Value *&New = CastedPointers[V];
224 New = SCEVExpander::InsertCastOfTo(opcode, V, UIntPtrTy);
225 DeadInsts.insert(cast<Instruction>(New));
230 /// DeleteTriviallyDeadInstructions - If any of the instructions is the
231 /// specified set are trivially dead, delete them and see if this makes any of
232 /// their operands subsequently dead.
233 void LoopStrengthReduce::
234 DeleteTriviallyDeadInstructions(SmallPtrSet<Instruction*,16> &Insts) {
235 while (!Insts.empty()) {
236 Instruction *I = *Insts.begin();
239 if (PHINode *PN = dyn_cast<PHINode>(I)) {
240 // If all incoming values to the Phi are the same, we can replace the Phi
242 if (Value *PNV = PN->hasConstantValue()) {
243 if (Instruction *U = dyn_cast<Instruction>(PNV))
245 PN->replaceAllUsesWith(PNV);
246 SE->deleteValueFromRecords(PN);
247 PN->eraseFromParent();
253 if (isInstructionTriviallyDead(I)) {
254 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
255 if (Instruction *U = dyn_cast<Instruction>(I->getOperand(i)))
257 SE->deleteValueFromRecords(I);
258 I->eraseFromParent();
265 /// GetExpressionSCEV - Compute and return the SCEV for the specified
267 SCEVHandle LoopStrengthReduce::GetExpressionSCEV(Instruction *Exp) {
268 // Pointer to pointer bitcast instructions return the same value as their
270 if (BitCastInst *BCI = dyn_cast<BitCastInst>(Exp)) {
271 if (SE->hasSCEV(BCI) || !isa<Instruction>(BCI->getOperand(0)))
272 return SE->getSCEV(BCI);
273 SCEVHandle R = GetExpressionSCEV(cast<Instruction>(BCI->getOperand(0)));
278 // Scalar Evolutions doesn't know how to compute SCEV's for GEP instructions.
279 // If this is a GEP that SE doesn't know about, compute it now and insert it.
280 // If this is not a GEP, or if we have already done this computation, just let
282 GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Exp);
283 if (!GEP || SE->hasSCEV(GEP))
284 return SE->getSCEV(Exp);
286 // Analyze all of the subscripts of this getelementptr instruction, looking
287 // for uses that are determined by the trip count of the loop. First, skip
288 // all operands the are not dependent on the IV.
290 // Build up the base expression. Insert an LLVM cast of the pointer to
292 SCEVHandle GEPVal = SE->getUnknown(
293 getCastedVersionOf(Instruction::PtrToInt, GEP->getOperand(0)));
295 gep_type_iterator GTI = gep_type_begin(GEP);
297 for (unsigned i = 1, e = GEP->getNumOperands(); i != e; ++i, ++GTI) {
298 // If this is a use of a recurrence that we can analyze, and it comes before
299 // Op does in the GEP operand list, we will handle this when we process this
301 if (const StructType *STy = dyn_cast<StructType>(*GTI)) {
302 const StructLayout *SL = TD->getStructLayout(STy);
303 unsigned Idx = cast<ConstantInt>(GEP->getOperand(i))->getZExtValue();
304 uint64_t Offset = SL->getElementOffset(Idx);
305 GEPVal = SE->getAddExpr(GEPVal,
306 SE->getIntegerSCEV(Offset, UIntPtrTy));
308 unsigned GEPOpiBits =
309 GEP->getOperand(i)->getType()->getPrimitiveSizeInBits();
310 unsigned IntPtrBits = UIntPtrTy->getPrimitiveSizeInBits();
311 Instruction::CastOps opcode = (GEPOpiBits < IntPtrBits ?
312 Instruction::SExt : (GEPOpiBits > IntPtrBits ? Instruction::Trunc :
313 Instruction::BitCast));
314 Value *OpVal = getCastedVersionOf(opcode, GEP->getOperand(i));
315 SCEVHandle Idx = SE->getSCEV(OpVal);
317 uint64_t TypeSize = TD->getABITypeSize(GTI.getIndexedType());
319 Idx = SE->getMulExpr(Idx,
320 SE->getConstant(ConstantInt::get(UIntPtrTy,
322 GEPVal = SE->getAddExpr(GEPVal, Idx);
326 SE->setSCEV(GEP, GEPVal);
330 /// getSCEVStartAndStride - Compute the start and stride of this expression,
331 /// returning false if the expression is not a start/stride pair, or true if it
332 /// is. The stride must be a loop invariant expression, but the start may be
333 /// a mix of loop invariant and loop variant expressions.
334 static bool getSCEVStartAndStride(const SCEVHandle &SH, Loop *L,
335 SCEVHandle &Start, SCEVHandle &Stride,
336 ScalarEvolution *SE) {
337 SCEVHandle TheAddRec = Start; // Initialize to zero.
339 // If the outer level is an AddExpr, the operands are all start values except
340 // for a nested AddRecExpr.
341 if (SCEVAddExpr *AE = dyn_cast<SCEVAddExpr>(SH)) {
342 for (unsigned i = 0, e = AE->getNumOperands(); i != e; ++i)
343 if (SCEVAddRecExpr *AddRec =
344 dyn_cast<SCEVAddRecExpr>(AE->getOperand(i))) {
345 if (AddRec->getLoop() == L)
346 TheAddRec = SE->getAddExpr(AddRec, TheAddRec);
348 return false; // Nested IV of some sort?
350 Start = SE->getAddExpr(Start, AE->getOperand(i));
353 } else if (isa<SCEVAddRecExpr>(SH)) {
356 return false; // not analyzable.
359 SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(TheAddRec);
360 if (!AddRec || AddRec->getLoop() != L) return false;
362 // FIXME: Generalize to non-affine IV's.
363 if (!AddRec->isAffine()) return false;
365 Start = SE->getAddExpr(Start, AddRec->getOperand(0));
367 if (!isa<SCEVConstant>(AddRec->getOperand(1)))
368 DOUT << "[" << L->getHeader()->getName()
369 << "] Variable stride: " << *AddRec << "\n";
371 Stride = AddRec->getOperand(1);
375 /// IVUseShouldUsePostIncValue - We have discovered a "User" of an IV expression
376 /// and now we need to decide whether the user should use the preinc or post-inc
377 /// value. If this user should use the post-inc version of the IV, return true.
379 /// Choosing wrong here can break dominance properties (if we choose to use the
380 /// post-inc value when we cannot) or it can end up adding extra live-ranges to
381 /// the loop, resulting in reg-reg copies (if we use the pre-inc value when we
382 /// should use the post-inc value).
383 static bool IVUseShouldUsePostIncValue(Instruction *User, Instruction *IV,
384 Loop *L, DominatorTree *DT, Pass *P,
385 SmallPtrSet<Instruction*,16> &DeadInsts){
386 // If the user is in the loop, use the preinc value.
387 if (L->contains(User->getParent())) return false;
389 BasicBlock *LatchBlock = L->getLoopLatch();
391 // Ok, the user is outside of the loop. If it is dominated by the latch
392 // block, use the post-inc value.
393 if (DT->dominates(LatchBlock, User->getParent()))
396 // There is one case we have to be careful of: PHI nodes. These little guys
397 // can live in blocks that do not dominate the latch block, but (since their
398 // uses occur in the predecessor block, not the block the PHI lives in) should
399 // still use the post-inc value. Check for this case now.
400 PHINode *PN = dyn_cast<PHINode>(User);
401 if (!PN) return false; // not a phi, not dominated by latch block.
403 // Look at all of the uses of IV by the PHI node. If any use corresponds to
404 // a block that is not dominated by the latch block, give up and use the
405 // preincremented value.
406 unsigned NumUses = 0;
407 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
408 if (PN->getIncomingValue(i) == IV) {
410 if (!DT->dominates(LatchBlock, PN->getIncomingBlock(i)))
414 // Okay, all uses of IV by PN are in predecessor blocks that really are
415 // dominated by the latch block. Split the critical edges and use the
416 // post-incremented value.
417 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
418 if (PN->getIncomingValue(i) == IV) {
419 SplitCriticalEdge(PN->getIncomingBlock(i), PN->getParent(), P, false);
420 // Splitting the critical edge can reduce the number of entries in this
422 e = PN->getNumIncomingValues();
423 if (--NumUses == 0) break;
426 // PHI node might have become a constant value after SplitCriticalEdge.
427 DeadInsts.insert(User);
434 /// AddUsersIfInteresting - Inspect the specified instruction. If it is a
435 /// reducible SCEV, recursively add its users to the IVUsesByStride set and
436 /// return true. Otherwise, return false.
437 bool LoopStrengthReduce::AddUsersIfInteresting(Instruction *I, Loop *L,
438 SmallPtrSet<Instruction*,16> &Processed) {
439 if (!I->getType()->isInteger() && !isa<PointerType>(I->getType()))
440 return false; // Void and FP expressions cannot be reduced.
441 if (!Processed.insert(I))
442 return true; // Instruction already handled.
444 // Get the symbolic expression for this instruction.
445 SCEVHandle ISE = GetExpressionSCEV(I);
446 if (isa<SCEVCouldNotCompute>(ISE)) return false;
448 // Get the start and stride for this expression.
449 SCEVHandle Start = SE->getIntegerSCEV(0, ISE->getType());
450 SCEVHandle Stride = Start;
451 if (!getSCEVStartAndStride(ISE, L, Start, Stride, SE))
452 return false; // Non-reducible symbolic expression, bail out.
454 std::vector<Instruction *> IUsers;
455 // Collect all I uses now because IVUseShouldUsePostIncValue may
456 // invalidate use_iterator.
457 for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI != E; ++UI)
458 IUsers.push_back(cast<Instruction>(*UI));
460 for (unsigned iused_index = 0, iused_size = IUsers.size();
461 iused_index != iused_size; ++iused_index) {
463 Instruction *User = IUsers[iused_index];
465 // Do not infinitely recurse on PHI nodes.
466 if (isa<PHINode>(User) && Processed.count(User))
469 // If this is an instruction defined in a nested loop, or outside this loop,
470 // don't recurse into it.
471 bool AddUserToIVUsers = false;
472 if (LI->getLoopFor(User->getParent()) != L) {
473 DOUT << "FOUND USER in other loop: " << *User
474 << " OF SCEV: " << *ISE << "\n";
475 AddUserToIVUsers = true;
476 } else if (!AddUsersIfInteresting(User, L, Processed)) {
477 DOUT << "FOUND USER: " << *User
478 << " OF SCEV: " << *ISE << "\n";
479 AddUserToIVUsers = true;
482 if (AddUserToIVUsers) {
483 IVUsersOfOneStride &StrideUses = IVUsesByStride[Stride];
484 if (StrideUses.Users.empty()) // First occurance of this stride?
485 StrideOrder.push_back(Stride);
487 // Okay, we found a user that we cannot reduce. Analyze the instruction
488 // and decide what to do with it. If we are a use inside of the loop, use
489 // the value before incrementation, otherwise use it after incrementation.
490 if (IVUseShouldUsePostIncValue(User, I, L, DT, this, DeadInsts)) {
491 // The value used will be incremented by the stride more than we are
492 // expecting, so subtract this off.
493 SCEVHandle NewStart = SE->getMinusSCEV(Start, Stride);
494 StrideUses.addUser(NewStart, User, I);
495 StrideUses.Users.back().isUseOfPostIncrementedValue = true;
496 DOUT << " USING POSTINC SCEV, START=" << *NewStart<< "\n";
498 StrideUses.addUser(Start, User, I);
506 /// BasedUser - For a particular base value, keep information about how we've
507 /// partitioned the expression so far.
509 /// SE - The current ScalarEvolution object.
512 /// Base - The Base value for the PHI node that needs to be inserted for
513 /// this use. As the use is processed, information gets moved from this
514 /// field to the Imm field (below). BasedUser values are sorted by this
518 /// Inst - The instruction using the induction variable.
521 /// OperandValToReplace - The operand value of Inst to replace with the
523 Value *OperandValToReplace;
525 /// Imm - The immediate value that should be added to the base immediately
526 /// before Inst, because it will be folded into the imm field of the
530 /// EmittedBase - The actual value* to use for the base value of this
531 /// operation. This is null if we should just use zero so far.
534 // isUseOfPostIncrementedValue - True if this should use the
535 // post-incremented version of this IV, not the preincremented version.
536 // This can only be set in special cases, such as the terminating setcc
537 // instruction for a loop and uses outside the loop that are dominated by
539 bool isUseOfPostIncrementedValue;
541 BasedUser(IVStrideUse &IVSU, ScalarEvolution *se)
542 : SE(se), Base(IVSU.Offset), Inst(IVSU.User),
543 OperandValToReplace(IVSU.OperandValToReplace),
544 Imm(SE->getIntegerSCEV(0, Base->getType())), EmittedBase(0),
545 isUseOfPostIncrementedValue(IVSU.isUseOfPostIncrementedValue) {}
547 // Once we rewrite the code to insert the new IVs we want, update the
548 // operands of Inst to use the new expression 'NewBase', with 'Imm' added
550 void RewriteInstructionToUseNewBase(const SCEVHandle &NewBase,
551 SCEVExpander &Rewriter, Loop *L, Pass *P,
552 SmallPtrSet<Instruction*,16> &DeadInsts);
554 Value *InsertCodeForBaseAtPosition(const SCEVHandle &NewBase,
555 SCEVExpander &Rewriter,
556 Instruction *IP, Loop *L);
561 void BasedUser::dump() const {
562 cerr << " Base=" << *Base;
563 cerr << " Imm=" << *Imm;
565 cerr << " EB=" << *EmittedBase;
567 cerr << " Inst: " << *Inst;
570 Value *BasedUser::InsertCodeForBaseAtPosition(const SCEVHandle &NewBase,
571 SCEVExpander &Rewriter,
572 Instruction *IP, Loop *L) {
573 // Figure out where we *really* want to insert this code. In particular, if
574 // the user is inside of a loop that is nested inside of L, we really don't
575 // want to insert this expression before the user, we'd rather pull it out as
576 // many loops as possible.
577 LoopInfo &LI = Rewriter.getLoopInfo();
578 Instruction *BaseInsertPt = IP;
580 // Figure out the most-nested loop that IP is in.
581 Loop *InsertLoop = LI.getLoopFor(IP->getParent());
583 // If InsertLoop is not L, and InsertLoop is nested inside of L, figure out
584 // the preheader of the outer-most loop where NewBase is not loop invariant.
585 while (InsertLoop && NewBase->isLoopInvariant(InsertLoop)) {
586 BaseInsertPt = InsertLoop->getLoopPreheader()->getTerminator();
587 InsertLoop = InsertLoop->getParentLoop();
590 // If there is no immediate value, skip the next part.
591 if (SCEVConstant *SC = dyn_cast<SCEVConstant>(Imm))
592 if (SC->getValue()->isZero())
593 return Rewriter.expandCodeFor(NewBase, BaseInsertPt);
595 Value *Base = Rewriter.expandCodeFor(NewBase, BaseInsertPt);
597 // If we are inserting the base and imm values in the same block, make sure to
598 // adjust the IP position if insertion reused a result.
599 if (IP == BaseInsertPt)
600 IP = Rewriter.getInsertionPoint();
602 // Always emit the immediate (if non-zero) into the same block as the user.
603 SCEVHandle NewValSCEV = SE->getAddExpr(SE->getUnknown(Base), Imm);
604 return Rewriter.expandCodeFor(NewValSCEV, IP);
609 // Once we rewrite the code to insert the new IVs we want, update the
610 // operands of Inst to use the new expression 'NewBase', with 'Imm' added
612 void BasedUser::RewriteInstructionToUseNewBase(const SCEVHandle &NewBase,
613 SCEVExpander &Rewriter, Loop *L, Pass *P,
614 SmallPtrSet<Instruction*,16> &DeadInsts) {
615 if (!isa<PHINode>(Inst)) {
616 // By default, insert code at the user instruction.
617 BasicBlock::iterator InsertPt = Inst;
619 // However, if the Operand is itself an instruction, the (potentially
620 // complex) inserted code may be shared by many users. Because of this, we
621 // want to emit code for the computation of the operand right before its old
622 // computation. This is usually safe, because we obviously used to use the
623 // computation when it was computed in its current block. However, in some
624 // cases (e.g. use of a post-incremented induction variable) the NewBase
625 // value will be pinned to live somewhere after the original computation.
626 // In this case, we have to back off.
627 if (!isUseOfPostIncrementedValue) {
628 if (Instruction *OpInst = dyn_cast<Instruction>(OperandValToReplace)) {
630 while (isa<PHINode>(InsertPt)) ++InsertPt;
633 Value *NewVal = InsertCodeForBaseAtPosition(NewBase, Rewriter, InsertPt, L);
634 // Adjust the type back to match the Inst. Note that we can't use InsertPt
635 // here because the SCEVExpander may have inserted the instructions after
636 // that point, in its efforts to avoid inserting redundant expressions.
637 if (isa<PointerType>(OperandValToReplace->getType())) {
638 NewVal = SCEVExpander::InsertCastOfTo(Instruction::IntToPtr,
640 OperandValToReplace->getType());
642 // Replace the use of the operand Value with the new Phi we just created.
643 Inst->replaceUsesOfWith(OperandValToReplace, NewVal);
644 DOUT << " CHANGED: IMM =" << *Imm;
645 DOUT << " \tNEWBASE =" << *NewBase;
646 DOUT << " \tInst = " << *Inst;
650 // PHI nodes are more complex. We have to insert one copy of the NewBase+Imm
651 // expression into each operand block that uses it. Note that PHI nodes can
652 // have multiple entries for the same predecessor. We use a map to make sure
653 // that a PHI node only has a single Value* for each predecessor (which also
654 // prevents us from inserting duplicate code in some blocks).
655 DenseMap<BasicBlock*, Value*> InsertedCode;
656 PHINode *PN = cast<PHINode>(Inst);
657 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
658 if (PN->getIncomingValue(i) == OperandValToReplace) {
659 // If this is a critical edge, split the edge so that we do not insert the
660 // code on all predecessor/successor paths. We do this unless this is the
661 // canonical backedge for this loop, as this can make some inserted code
662 // be in an illegal position.
663 BasicBlock *PHIPred = PN->getIncomingBlock(i);
664 if (e != 1 && PHIPred->getTerminator()->getNumSuccessors() > 1 &&
665 (PN->getParent() != L->getHeader() || !L->contains(PHIPred))) {
667 // First step, split the critical edge.
668 SplitCriticalEdge(PHIPred, PN->getParent(), P, false);
670 // Next step: move the basic block. In particular, if the PHI node
671 // is outside of the loop, and PredTI is in the loop, we want to
672 // move the block to be immediately before the PHI block, not
673 // immediately after PredTI.
674 if (L->contains(PHIPred) && !L->contains(PN->getParent())) {
675 BasicBlock *NewBB = PN->getIncomingBlock(i);
676 NewBB->moveBefore(PN->getParent());
679 // Splitting the edge can reduce the number of PHI entries we have.
680 e = PN->getNumIncomingValues();
683 Value *&Code = InsertedCode[PN->getIncomingBlock(i)];
685 // Insert the code into the end of the predecessor block.
686 Instruction *InsertPt = PN->getIncomingBlock(i)->getTerminator();
687 Code = InsertCodeForBaseAtPosition(NewBase, Rewriter, InsertPt, L);
689 // Adjust the type back to match the PHI. Note that we can't use
690 // InsertPt here because the SCEVExpander may have inserted its
691 // instructions after that point, in its efforts to avoid inserting
692 // redundant expressions.
693 if (isa<PointerType>(PN->getType())) {
694 Code = SCEVExpander::InsertCastOfTo(Instruction::IntToPtr,
700 // Replace the use of the operand Value with the new Phi we just created.
701 PN->setIncomingValue(i, Code);
706 // PHI node might have become a constant value after SplitCriticalEdge.
707 DeadInsts.insert(Inst);
709 DOUT << " CHANGED: IMM =" << *Imm << " Inst = " << *Inst;
713 /// isTargetConstant - Return true if the following can be referenced by the
714 /// immediate field of a target instruction.
715 static bool isTargetConstant(const SCEVHandle &V, const Type *UseTy,
716 const TargetLowering *TLI) {
717 if (SCEVConstant *SC = dyn_cast<SCEVConstant>(V)) {
718 int64_t VC = SC->getValue()->getSExtValue();
720 TargetLowering::AddrMode AM;
722 return TLI->isLegalAddressingMode(AM, UseTy);
724 // Defaults to PPC. PPC allows a sign-extended 16-bit immediate field.
725 return (VC > -(1 << 16) && VC < (1 << 16)-1);
729 if (SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V))
730 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(SU->getValue()))
731 if (TLI && CE->getOpcode() == Instruction::PtrToInt) {
732 Constant *Op0 = CE->getOperand(0);
733 if (GlobalValue *GV = dyn_cast<GlobalValue>(Op0)) {
734 TargetLowering::AddrMode AM;
736 return TLI->isLegalAddressingMode(AM, UseTy);
742 /// MoveLoopVariantsToImediateField - Move any subexpressions from Val that are
743 /// loop varying to the Imm operand.
744 static void MoveLoopVariantsToImediateField(SCEVHandle &Val, SCEVHandle &Imm,
745 Loop *L, ScalarEvolution *SE) {
746 if (Val->isLoopInvariant(L)) return; // Nothing to do.
748 if (SCEVAddExpr *SAE = dyn_cast<SCEVAddExpr>(Val)) {
749 std::vector<SCEVHandle> NewOps;
750 NewOps.reserve(SAE->getNumOperands());
752 for (unsigned i = 0; i != SAE->getNumOperands(); ++i)
753 if (!SAE->getOperand(i)->isLoopInvariant(L)) {
754 // If this is a loop-variant expression, it must stay in the immediate
755 // field of the expression.
756 Imm = SE->getAddExpr(Imm, SAE->getOperand(i));
758 NewOps.push_back(SAE->getOperand(i));
762 Val = SE->getIntegerSCEV(0, Val->getType());
764 Val = SE->getAddExpr(NewOps);
765 } else if (SCEVAddRecExpr *SARE = dyn_cast<SCEVAddRecExpr>(Val)) {
766 // Try to pull immediates out of the start value of nested addrec's.
767 SCEVHandle Start = SARE->getStart();
768 MoveLoopVariantsToImediateField(Start, Imm, L, SE);
770 std::vector<SCEVHandle> Ops(SARE->op_begin(), SARE->op_end());
772 Val = SE->getAddRecExpr(Ops, SARE->getLoop());
774 // Otherwise, all of Val is variant, move the whole thing over.
775 Imm = SE->getAddExpr(Imm, Val);
776 Val = SE->getIntegerSCEV(0, Val->getType());
781 /// MoveImmediateValues - Look at Val, and pull out any additions of constants
782 /// that can fit into the immediate field of instructions in the target.
783 /// Accumulate these immediate values into the Imm value.
784 static void MoveImmediateValues(const TargetLowering *TLI,
786 SCEVHandle &Val, SCEVHandle &Imm,
787 bool isAddress, Loop *L,
788 ScalarEvolution *SE) {
789 const Type *UseTy = User->getType();
790 if (StoreInst *SI = dyn_cast<StoreInst>(User))
791 UseTy = SI->getOperand(0)->getType();
793 if (SCEVAddExpr *SAE = dyn_cast<SCEVAddExpr>(Val)) {
794 std::vector<SCEVHandle> NewOps;
795 NewOps.reserve(SAE->getNumOperands());
797 for (unsigned i = 0; i != SAE->getNumOperands(); ++i) {
798 SCEVHandle NewOp = SAE->getOperand(i);
799 MoveImmediateValues(TLI, User, NewOp, Imm, isAddress, L, SE);
801 if (!NewOp->isLoopInvariant(L)) {
802 // If this is a loop-variant expression, it must stay in the immediate
803 // field of the expression.
804 Imm = SE->getAddExpr(Imm, NewOp);
806 NewOps.push_back(NewOp);
811 Val = SE->getIntegerSCEV(0, Val->getType());
813 Val = SE->getAddExpr(NewOps);
815 } else if (SCEVAddRecExpr *SARE = dyn_cast<SCEVAddRecExpr>(Val)) {
816 // Try to pull immediates out of the start value of nested addrec's.
817 SCEVHandle Start = SARE->getStart();
818 MoveImmediateValues(TLI, User, Start, Imm, isAddress, L, SE);
820 if (Start != SARE->getStart()) {
821 std::vector<SCEVHandle> Ops(SARE->op_begin(), SARE->op_end());
823 Val = SE->getAddRecExpr(Ops, SARE->getLoop());
826 } else if (SCEVMulExpr *SME = dyn_cast<SCEVMulExpr>(Val)) {
827 // Transform "8 * (4 + v)" -> "32 + 8*V" if "32" fits in the immed field.
828 if (isAddress && isTargetConstant(SME->getOperand(0), UseTy, TLI) &&
829 SME->getNumOperands() == 2 && SME->isLoopInvariant(L)) {
831 SCEVHandle SubImm = SE->getIntegerSCEV(0, Val->getType());
832 SCEVHandle NewOp = SME->getOperand(1);
833 MoveImmediateValues(TLI, User, NewOp, SubImm, isAddress, L, SE);
835 // If we extracted something out of the subexpressions, see if we can
837 if (NewOp != SME->getOperand(1)) {
838 // Scale SubImm up by "8". If the result is a target constant, we are
840 SubImm = SE->getMulExpr(SubImm, SME->getOperand(0));
841 if (isTargetConstant(SubImm, UseTy, TLI)) {
842 // Accumulate the immediate.
843 Imm = SE->getAddExpr(Imm, SubImm);
845 // Update what is left of 'Val'.
846 Val = SE->getMulExpr(SME->getOperand(0), NewOp);
853 // Loop-variant expressions must stay in the immediate field of the
855 if ((isAddress && isTargetConstant(Val, UseTy, TLI)) ||
856 !Val->isLoopInvariant(L)) {
857 Imm = SE->getAddExpr(Imm, Val);
858 Val = SE->getIntegerSCEV(0, Val->getType());
862 // Otherwise, no immediates to move.
866 /// SeparateSubExprs - Decompose Expr into all of the subexpressions that are
867 /// added together. This is used to reassociate common addition subexprs
868 /// together for maximal sharing when rewriting bases.
869 static void SeparateSubExprs(std::vector<SCEVHandle> &SubExprs,
871 ScalarEvolution *SE) {
872 if (SCEVAddExpr *AE = dyn_cast<SCEVAddExpr>(Expr)) {
873 for (unsigned j = 0, e = AE->getNumOperands(); j != e; ++j)
874 SeparateSubExprs(SubExprs, AE->getOperand(j), SE);
875 } else if (SCEVAddRecExpr *SARE = dyn_cast<SCEVAddRecExpr>(Expr)) {
876 SCEVHandle Zero = SE->getIntegerSCEV(0, Expr->getType());
877 if (SARE->getOperand(0) == Zero) {
878 SubExprs.push_back(Expr);
880 // Compute the addrec with zero as its base.
881 std::vector<SCEVHandle> Ops(SARE->op_begin(), SARE->op_end());
882 Ops[0] = Zero; // Start with zero base.
883 SubExprs.push_back(SE->getAddRecExpr(Ops, SARE->getLoop()));
886 SeparateSubExprs(SubExprs, SARE->getOperand(0), SE);
888 } else if (!isa<SCEVConstant>(Expr) ||
889 !cast<SCEVConstant>(Expr)->getValue()->isZero()) {
891 SubExprs.push_back(Expr);
896 /// RemoveCommonExpressionsFromUseBases - Look through all of the uses in Bases,
897 /// removing any common subexpressions from it. Anything truly common is
898 /// removed, accumulated, and returned. This looks for things like (a+b+c) and
899 /// (a+c+d) -> (a+c). The common expression is *removed* from the Bases.
901 RemoveCommonExpressionsFromUseBases(std::vector<BasedUser> &Uses,
902 ScalarEvolution *SE) {
903 unsigned NumUses = Uses.size();
905 // Only one use? Use its base, regardless of what it is!
906 SCEVHandle Zero = SE->getIntegerSCEV(0, Uses[0].Base->getType());
907 SCEVHandle Result = Zero;
909 std::swap(Result, Uses[0].Base);
913 // To find common subexpressions, count how many of Uses use each expression.
914 // If any subexpressions are used Uses.size() times, they are common.
915 std::map<SCEVHandle, unsigned> SubExpressionUseCounts;
917 // UniqueSubExprs - Keep track of all of the subexpressions we see in the
918 // order we see them.
919 std::vector<SCEVHandle> UniqueSubExprs;
921 std::vector<SCEVHandle> SubExprs;
922 for (unsigned i = 0; i != NumUses; ++i) {
923 // If the base is zero (which is common), return zero now, there are no
925 if (Uses[i].Base == Zero) return Zero;
927 // Split the expression into subexprs.
928 SeparateSubExprs(SubExprs, Uses[i].Base, SE);
929 // Add one to SubExpressionUseCounts for each subexpr present.
930 for (unsigned j = 0, e = SubExprs.size(); j != e; ++j)
931 if (++SubExpressionUseCounts[SubExprs[j]] == 1)
932 UniqueSubExprs.push_back(SubExprs[j]);
936 // Now that we know how many times each is used, build Result. Iterate over
937 // UniqueSubexprs so that we have a stable ordering.
938 for (unsigned i = 0, e = UniqueSubExprs.size(); i != e; ++i) {
939 std::map<SCEVHandle, unsigned>::iterator I =
940 SubExpressionUseCounts.find(UniqueSubExprs[i]);
941 assert(I != SubExpressionUseCounts.end() && "Entry not found?");
942 if (I->second == NumUses) { // Found CSE!
943 Result = SE->getAddExpr(Result, I->first);
945 // Remove non-cse's from SubExpressionUseCounts.
946 SubExpressionUseCounts.erase(I);
950 // If we found no CSE's, return now.
951 if (Result == Zero) return Result;
953 // Otherwise, remove all of the CSE's we found from each of the base values.
954 for (unsigned i = 0; i != NumUses; ++i) {
955 // Split the expression into subexprs.
956 SeparateSubExprs(SubExprs, Uses[i].Base, SE);
958 // Remove any common subexpressions.
959 for (unsigned j = 0, e = SubExprs.size(); j != e; ++j)
960 if (SubExpressionUseCounts.count(SubExprs[j])) {
961 SubExprs.erase(SubExprs.begin()+j);
965 // Finally, the non-shared expressions together.
966 if (SubExprs.empty())
969 Uses[i].Base = SE->getAddExpr(SubExprs);
976 /// isZero - returns true if the scalar evolution expression is zero.
978 static bool isZero(const SCEVHandle &V) {
979 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(V))
980 return SC->getValue()->isZero();
984 /// ValidStride - Check whether the given Scale is valid for all loads and
985 /// stores in UsersToProcess.
987 bool LoopStrengthReduce::ValidStride(bool HasBaseReg,
989 const std::vector<BasedUser>& UsersToProcess) {
993 for (unsigned i=0, e = UsersToProcess.size(); i!=e; ++i) {
994 // If this is a load or other access, pass the type of the access in.
995 const Type *AccessTy = Type::VoidTy;
996 if (StoreInst *SI = dyn_cast<StoreInst>(UsersToProcess[i].Inst))
997 AccessTy = SI->getOperand(0)->getType();
998 else if (LoadInst *LI = dyn_cast<LoadInst>(UsersToProcess[i].Inst))
999 AccessTy = LI->getType();
1000 else if (isa<PHINode>(UsersToProcess[i].Inst)) {
1001 if (AllowPHIIVReuse)
1006 TargetLowering::AddrMode AM;
1007 if (SCEVConstant *SC = dyn_cast<SCEVConstant>(UsersToProcess[i].Imm))
1008 AM.BaseOffs = SC->getValue()->getSExtValue();
1009 AM.HasBaseReg = HasBaseReg || !isZero(UsersToProcess[i].Base);
1012 // If load[imm+r*scale] is illegal, bail out.
1013 if (!TLI->isLegalAddressingMode(AM, AccessTy))
1019 /// RequiresTypeConversion - Returns true if converting Ty to NewTy is not
1021 bool LoopStrengthReduce::RequiresTypeConversion(const Type *Ty1,
1025 if (TLI && TLI->isTruncateFree(Ty1, Ty2))
1027 return (!Ty1->canLosslesslyBitCastTo(Ty2) &&
1028 !(isa<PointerType>(Ty2) &&
1029 Ty1->canLosslesslyBitCastTo(UIntPtrTy)) &&
1030 !(isa<PointerType>(Ty1) &&
1031 Ty2->canLosslesslyBitCastTo(UIntPtrTy)));
1034 /// CheckForIVReuse - Returns the multiple if the stride is the multiple
1035 /// of a previous stride and it is a legal value for the target addressing
1036 /// mode scale component and optional base reg. This allows the users of
1037 /// this stride to be rewritten as prev iv * factor. It returns 0 if no
1038 /// reuse is possible.
1039 unsigned LoopStrengthReduce::CheckForIVReuse(bool HasBaseReg,
1040 bool AllUsesAreAddresses,
1041 const SCEVHandle &Stride,
1042 IVExpr &IV, const Type *Ty,
1043 const std::vector<BasedUser>& UsersToProcess) {
1044 if (SCEVConstant *SC = dyn_cast<SCEVConstant>(Stride)) {
1045 int64_t SInt = SC->getValue()->getSExtValue();
1046 for (unsigned NewStride = 0, e = StrideOrder.size(); NewStride != e;
1048 std::map<SCEVHandle, IVsOfOneStride>::iterator SI =
1049 IVsByStride.find(StrideOrder[NewStride]);
1050 if (SI == IVsByStride.end())
1052 int64_t SSInt = cast<SCEVConstant>(SI->first)->getValue()->getSExtValue();
1053 if (SI->first != Stride &&
1054 (unsigned(abs(SInt)) < SSInt || (SInt % SSInt) != 0))
1056 int64_t Scale = SInt / SSInt;
1057 // Check that this stride is valid for all the types used for loads and
1058 // stores; if it can be used for some and not others, we might as well use
1059 // the original stride everywhere, since we have to create the IV for it
1060 // anyway. If the scale is 1, then we don't need to worry about folding
1063 (AllUsesAreAddresses &&
1064 ValidStride(HasBaseReg, Scale, UsersToProcess)))
1065 for (std::vector<IVExpr>::iterator II = SI->second.IVs.begin(),
1066 IE = SI->second.IVs.end(); II != IE; ++II)
1067 // FIXME: Only handle base == 0 for now.
1068 // Only reuse previous IV if it would not require a type conversion.
1069 if (isZero(II->Base) &&
1070 !RequiresTypeConversion(II->Base->getType(), Ty)) {
1079 /// PartitionByIsUseOfPostIncrementedValue - Simple boolean predicate that
1080 /// returns true if Val's isUseOfPostIncrementedValue is true.
1081 static bool PartitionByIsUseOfPostIncrementedValue(const BasedUser &Val) {
1082 return Val.isUseOfPostIncrementedValue;
1085 /// isNonConstantNegative - REturn true if the specified scev is negated, but
1087 static bool isNonConstantNegative(const SCEVHandle &Expr) {
1088 SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Expr);
1089 if (!Mul) return false;
1091 // If there is a constant factor, it will be first.
1092 SCEVConstant *SC = dyn_cast<SCEVConstant>(Mul->getOperand(0));
1093 if (!SC) return false;
1095 // Return true if the value is negative, this matches things like (-42 * V).
1096 return SC->getValue()->getValue().isNegative();
1099 /// isAddress - Returns true if the specified instruction is using the
1100 /// specified value as an address.
1101 static bool isAddressUse(Instruction *Inst, Value *OperandVal) {
1102 bool isAddress = isa<LoadInst>(Inst);
1103 if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
1104 if (SI->getOperand(1) == OperandVal)
1106 } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
1107 // Addressing modes can also be folded into prefetches and a variety
1109 switch (II->getIntrinsicID()) {
1111 case Intrinsic::prefetch:
1112 case Intrinsic::x86_sse2_loadu_dq:
1113 case Intrinsic::x86_sse2_loadu_pd:
1114 case Intrinsic::x86_sse_loadu_ps:
1115 case Intrinsic::x86_sse_storeu_ps:
1116 case Intrinsic::x86_sse2_storeu_pd:
1117 case Intrinsic::x86_sse2_storeu_dq:
1118 case Intrinsic::x86_sse2_storel_dq:
1119 if (II->getOperand(1) == OperandVal)
1122 case Intrinsic::x86_sse2_loadh_pd:
1123 case Intrinsic::x86_sse2_loadl_pd:
1124 if (II->getOperand(2) == OperandVal)
1132 // CollectIVUsers - Transform our list of users and offsets to a bit more
1133 // complex table. In this new vector, each 'BasedUser' contains 'Base' the base
1134 // of the strided accessas well as the old information from Uses. We
1135 // progressively move information from the Base field to the Imm field, until
1136 // we eventually have the full access expression to rewrite the use.
1137 SCEVHandle LoopStrengthReduce::CollectIVUsers(const SCEVHandle &Stride,
1138 IVUsersOfOneStride &Uses,
1140 bool &AllUsesAreAddresses,
1141 std::vector<BasedUser> &UsersToProcess) {
1142 UsersToProcess.reserve(Uses.Users.size());
1143 for (unsigned i = 0, e = Uses.Users.size(); i != e; ++i) {
1144 UsersToProcess.push_back(BasedUser(Uses.Users[i], SE));
1146 // Move any loop invariant operands from the offset field to the immediate
1147 // field of the use, so that we don't try to use something before it is
1149 MoveLoopVariantsToImediateField(UsersToProcess.back().Base,
1150 UsersToProcess.back().Imm, L, SE);
1151 assert(UsersToProcess.back().Base->isLoopInvariant(L) &&
1152 "Base value is not loop invariant!");
1155 // We now have a whole bunch of uses of like-strided induction variables, but
1156 // they might all have different bases. We want to emit one PHI node for this
1157 // stride which we fold as many common expressions (between the IVs) into as
1158 // possible. Start by identifying the common expressions in the base values
1159 // for the strides (e.g. if we have "A+C+B" and "A+B+D" as our bases, find
1160 // "A+B"), emit it to the preheader, then remove the expression from the
1161 // UsersToProcess base values.
1162 SCEVHandle CommonExprs =
1163 RemoveCommonExpressionsFromUseBases(UsersToProcess, SE);
1165 // Next, figure out what we can represent in the immediate fields of
1166 // instructions. If we can represent anything there, move it to the imm
1167 // fields of the BasedUsers. We do this so that it increases the commonality
1168 // of the remaining uses.
1169 unsigned NumPHI = 0;
1170 for (unsigned i = 0, e = UsersToProcess.size(); i != e; ++i) {
1171 // If the user is not in the current loop, this means it is using the exit
1172 // value of the IV. Do not put anything in the base, make sure it's all in
1173 // the immediate field to allow as much factoring as possible.
1174 if (!L->contains(UsersToProcess[i].Inst->getParent())) {
1175 UsersToProcess[i].Imm = SE->getAddExpr(UsersToProcess[i].Imm,
1176 UsersToProcess[i].Base);
1177 UsersToProcess[i].Base =
1178 SE->getIntegerSCEV(0, UsersToProcess[i].Base->getType());
1181 // Addressing modes can be folded into loads and stores. Be careful that
1182 // the store is through the expression, not of the expression though.
1184 bool isAddress = isAddressUse(UsersToProcess[i].Inst,
1185 UsersToProcess[i].OperandValToReplace);
1186 if (isa<PHINode>(UsersToProcess[i].Inst)) {
1191 // If this use isn't an address, then not all uses are addresses.
1192 if (!isAddress && !(AllowPHIIVReuse && isPHI))
1193 AllUsesAreAddresses = false;
1195 MoveImmediateValues(TLI, UsersToProcess[i].Inst, UsersToProcess[i].Base,
1196 UsersToProcess[i].Imm, isAddress, L, SE);
1200 // If one of the use if a PHI node and all other uses are addresses, still
1201 // allow iv reuse. Essentially we are trading one constant multiplication
1202 // for one fewer iv.
1204 AllUsesAreAddresses = false;
1209 /// StrengthReduceStridedIVUsers - Strength reduce all of the users of a single
1210 /// stride of IV. All of the users may have different starting values, and this
1211 /// may not be the only stride (we know it is if isOnlyStride is true).
1212 void LoopStrengthReduce::StrengthReduceStridedIVUsers(const SCEVHandle &Stride,
1213 IVUsersOfOneStride &Uses,
1215 bool isOnlyStride) {
1216 // If all the users are moved to another stride, then there is nothing to do.
1217 if (Uses.Users.size() == 0)
1220 // Keep track if every use in UsersToProcess is an address. If they all are,
1221 // we may be able to rewrite the entire collection of them in terms of a
1222 // smaller-stride IV.
1223 bool AllUsesAreAddresses = true;
1225 // Transform our list of users and offsets to a bit more complex table. In
1226 // this new vector, each 'BasedUser' contains 'Base' the base of the
1227 // strided accessas well as the old information from Uses. We progressively
1228 // move information from the Base field to the Imm field, until we eventually
1229 // have the full access expression to rewrite the use.
1230 std::vector<BasedUser> UsersToProcess;
1231 SCEVHandle CommonExprs = CollectIVUsers(Stride, Uses, L, AllUsesAreAddresses,
1234 // If we managed to find some expressions in common, we'll need to carry
1235 // their value in a register and add it in for each use. This will take up
1236 // a register operand, which potentially restricts what stride values are
1238 bool HaveCommonExprs = !isZero(CommonExprs);
1240 // If all uses are addresses, check if it is possible to reuse an IV with a
1241 // stride that is a factor of this stride. And that the multiple is a number
1242 // that can be encoded in the scale field of the target addressing mode. And
1243 // that we will have a valid instruction after this substition, including the
1244 // immediate field, if any.
1245 PHINode *NewPHI = NULL;
1247 IVExpr ReuseIV(SE->getIntegerSCEV(0, Type::Int32Ty),
1248 SE->getIntegerSCEV(0, Type::Int32Ty),
1250 unsigned RewriteFactor = 0;
1251 RewriteFactor = CheckForIVReuse(HaveCommonExprs, AllUsesAreAddresses,
1252 Stride, ReuseIV, CommonExprs->getType(),
1254 if (RewriteFactor != 0) {
1255 DOUT << "BASED ON IV of STRIDE " << *ReuseIV.Stride
1256 << " and BASE " << *ReuseIV.Base << " :\n";
1257 NewPHI = ReuseIV.PHI;
1258 IncV = ReuseIV.IncV;
1261 const Type *ReplacedTy = CommonExprs->getType();
1263 // Now that we know what we need to do, insert the PHI node itself.
1265 DOUT << "INSERTING IV of TYPE " << *ReplacedTy << " of STRIDE "
1266 << *Stride << " and BASE " << *CommonExprs << ": ";
1268 SCEVExpander Rewriter(*SE, *LI);
1269 SCEVExpander PreheaderRewriter(*SE, *LI);
1271 BasicBlock *Preheader = L->getLoopPreheader();
1272 Instruction *PreInsertPt = Preheader->getTerminator();
1273 Instruction *PhiInsertBefore = L->getHeader()->begin();
1275 BasicBlock *LatchBlock = L->getLoopLatch();
1278 // Emit the initial base value into the loop preheader.
1280 = PreheaderRewriter.expandCodeFor(CommonExprs, PreInsertPt);
1282 if (RewriteFactor == 0) {
1283 // Create a new Phi for this base, and stick it in the loop header.
1284 NewPHI = new PHINode(ReplacedTy, "iv.", PhiInsertBefore);
1287 // Add common base to the new Phi node.
1288 NewPHI->addIncoming(CommonBaseV, Preheader);
1290 // If the stride is negative, insert a sub instead of an add for the
1292 bool isNegative = isNonConstantNegative(Stride);
1293 SCEVHandle IncAmount = Stride;
1295 IncAmount = SE->getNegativeSCEV(Stride);
1297 // Insert the stride into the preheader.
1298 Value *StrideV = PreheaderRewriter.expandCodeFor(IncAmount, PreInsertPt);
1299 if (!isa<ConstantInt>(StrideV)) ++NumVariable;
1301 // Emit the increment of the base value before the terminator of the loop
1302 // latch block, and add it to the Phi node.
1303 SCEVHandle IncExp = SE->getUnknown(StrideV);
1305 IncExp = SE->getNegativeSCEV(IncExp);
1306 IncExp = SE->getAddExpr(SE->getUnknown(NewPHI), IncExp);
1308 IncV = Rewriter.expandCodeFor(IncExp, LatchBlock->getTerminator());
1309 IncV->setName(NewPHI->getName()+".inc");
1310 NewPHI->addIncoming(IncV, LatchBlock);
1312 // Remember this in case a later stride is multiple of this.
1313 IVsByStride[Stride].addIV(Stride, CommonExprs, NewPHI, IncV);
1315 DOUT << " IV=%" << NewPHI->getNameStr() << " INC=%" << IncV->getNameStr();
1317 Constant *C = dyn_cast<Constant>(CommonBaseV);
1319 (!C->isNullValue() &&
1320 !isTargetConstant(SE->getUnknown(CommonBaseV), ReplacedTy, TLI)))
1321 // We want the common base emitted into the preheader! This is just
1322 // using cast as a copy so BitCast (no-op cast) is appropriate
1323 CommonBaseV = new BitCastInst(CommonBaseV, CommonBaseV->getType(),
1324 "commonbase", PreInsertPt);
1328 // We want to emit code for users inside the loop first. To do this, we
1329 // rearrange BasedUser so that the entries at the end have
1330 // isUseOfPostIncrementedValue = false, because we pop off the end of the
1331 // vector (so we handle them first).
1332 std::partition(UsersToProcess.begin(), UsersToProcess.end(),
1333 PartitionByIsUseOfPostIncrementedValue);
1335 // Sort this by base, so that things with the same base are handled
1336 // together. By partitioning first and stable-sorting later, we are
1337 // guaranteed that within each base we will pop off users from within the
1338 // loop before users outside of the loop with a particular base.
1340 // We would like to use stable_sort here, but we can't. The problem is that
1341 // SCEVHandle's don't have a deterministic ordering w.r.t to each other, so
1342 // we don't have anything to do a '<' comparison on. Because we think the
1343 // number of uses is small, do a horrible bubble sort which just relies on
1345 for (unsigned i = 0, e = UsersToProcess.size(); i != e; ++i) {
1346 // Get a base value.
1347 SCEVHandle Base = UsersToProcess[i].Base;
1349 // Compact everything with this base to be consequtive with this one.
1350 for (unsigned j = i+1; j != e; ++j) {
1351 if (UsersToProcess[j].Base == Base) {
1352 std::swap(UsersToProcess[i+1], UsersToProcess[j]);
1358 // Process all the users now. This outer loop handles all bases, the inner
1359 // loop handles all users of a particular base.
1360 while (!UsersToProcess.empty()) {
1361 SCEVHandle Base = UsersToProcess.back().Base;
1363 // Emit the code for Base into the preheader.
1364 Value *BaseV = PreheaderRewriter.expandCodeFor(Base, PreInsertPt);
1366 DOUT << " INSERTING code for BASE = " << *Base << ":";
1367 if (BaseV->hasName())
1368 DOUT << " Result value name = %" << BaseV->getNameStr();
1371 // If BaseV is a constant other than 0, make sure that it gets inserted into
1372 // the preheader, instead of being forward substituted into the uses. We do
1373 // this by forcing a BitCast (noop cast) to be inserted into the preheader
1375 if (Constant *C = dyn_cast<Constant>(BaseV)) {
1376 if (!C->isNullValue() && !isTargetConstant(Base, ReplacedTy, TLI)) {
1377 // We want this constant emitted into the preheader! This is just
1378 // using cast as a copy so BitCast (no-op cast) is appropriate
1379 BaseV = new BitCastInst(BaseV, BaseV->getType(), "preheaderinsert",
1384 // Emit the code to add the immediate offset to the Phi value, just before
1385 // the instructions that we identified as using this stride and base.
1387 // FIXME: Use emitted users to emit other users.
1388 BasedUser &User = UsersToProcess.back();
1390 // If this instruction wants to use the post-incremented value, move it
1391 // after the post-inc and use its value instead of the PHI.
1392 Value *RewriteOp = NewPHI;
1393 if (User.isUseOfPostIncrementedValue) {
1396 // If this user is in the loop, make sure it is the last thing in the
1397 // loop to ensure it is dominated by the increment.
1398 if (L->contains(User.Inst->getParent()))
1399 User.Inst->moveBefore(LatchBlock->getTerminator());
1401 if (RewriteOp->getType() != ReplacedTy) {
1402 Instruction::CastOps opcode = Instruction::Trunc;
1403 if (ReplacedTy->getPrimitiveSizeInBits() ==
1404 RewriteOp->getType()->getPrimitiveSizeInBits())
1405 opcode = Instruction::BitCast;
1406 RewriteOp = SCEVExpander::InsertCastOfTo(opcode, RewriteOp, ReplacedTy);
1409 SCEVHandle RewriteExpr = SE->getUnknown(RewriteOp);
1411 // Clear the SCEVExpander's expression map so that we are guaranteed
1412 // to have the code emitted where we expect it.
1415 // If we are reusing the iv, then it must be multiplied by a constant
1416 // factor take advantage of addressing mode scale component.
1417 if (RewriteFactor != 0) {
1418 RewriteExpr = SE->getMulExpr(SE->getIntegerSCEV(RewriteFactor,
1419 RewriteExpr->getType()),
1422 // The common base is emitted in the loop preheader. But since we
1423 // are reusing an IV, it has not been used to initialize the PHI node.
1424 // Add it to the expression used to rewrite the uses.
1425 if (!isa<ConstantInt>(CommonBaseV) ||
1426 !cast<ConstantInt>(CommonBaseV)->isZero())
1427 RewriteExpr = SE->getAddExpr(RewriteExpr,
1428 SE->getUnknown(CommonBaseV));
1431 // Now that we know what we need to do, insert code before User for the
1432 // immediate and any loop-variant expressions.
1433 if (!isa<ConstantInt>(BaseV) || !cast<ConstantInt>(BaseV)->isZero())
1434 // Add BaseV to the PHI value if needed.
1435 RewriteExpr = SE->getAddExpr(RewriteExpr, SE->getUnknown(BaseV));
1437 User.RewriteInstructionToUseNewBase(RewriteExpr, Rewriter, L, this,
1440 // Mark old value we replaced as possibly dead, so that it is elminated
1441 // if we just replaced the last use of that value.
1442 DeadInsts.insert(cast<Instruction>(User.OperandValToReplace));
1444 UsersToProcess.pop_back();
1447 // If there are any more users to process with the same base, process them
1448 // now. We sorted by base above, so we just have to check the last elt.
1449 } while (!UsersToProcess.empty() && UsersToProcess.back().Base == Base);
1450 // TODO: Next, find out which base index is the most common, pull it out.
1453 // IMPORTANT TODO: Figure out how to partition the IV's with this stride, but
1454 // different starting values, into different PHIs.
1457 /// FindIVForUser - If Cond has an operand that is an expression of an IV,
1458 /// set the IV user and stride information and return true, otherwise return
1460 bool LoopStrengthReduce::FindIVForUser(ICmpInst *Cond, IVStrideUse *&CondUse,
1461 const SCEVHandle *&CondStride) {
1462 for (unsigned Stride = 0, e = StrideOrder.size(); Stride != e && !CondUse;
1464 std::map<SCEVHandle, IVUsersOfOneStride>::iterator SI =
1465 IVUsesByStride.find(StrideOrder[Stride]);
1466 assert(SI != IVUsesByStride.end() && "Stride doesn't exist!");
1468 for (std::vector<IVStrideUse>::iterator UI = SI->second.Users.begin(),
1469 E = SI->second.Users.end(); UI != E; ++UI)
1470 if (UI->User == Cond) {
1471 // NOTE: we could handle setcc instructions with multiple uses here, but
1472 // InstCombine does it as well for simple uses, it's not clear that it
1473 // occurs enough in real life to handle.
1475 CondStride = &SI->first;
1483 // Constant strides come first which in turns are sorted by their absolute
1484 // values. If absolute values are the same, then positive strides comes first.
1486 // 4, -1, X, 1, 2 ==> 1, -1, 2, 4, X
1487 struct StrideCompare {
1488 bool operator()(const SCEVHandle &LHS, const SCEVHandle &RHS) {
1489 SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS);
1490 SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS);
1492 int64_t LV = LHSC->getValue()->getSExtValue();
1493 int64_t RV = RHSC->getValue()->getSExtValue();
1494 uint64_t ALV = (LV < 0) ? -LV : LV;
1495 uint64_t ARV = (RV < 0) ? -RV : RV;
1501 return (LHSC && !RHSC);
1506 /// ChangeCompareStride - If a loop termination compare instruction is the
1507 /// only use of its stride, and the compaison is against a constant value,
1508 /// try eliminate the stride by moving the compare instruction to another
1509 /// stride and change its constant operand accordingly. e.g.
1515 /// if (v2 < 10) goto loop
1520 /// if (v1 < 30) goto loop
1521 ICmpInst *LoopStrengthReduce::ChangeCompareStride(Loop *L, ICmpInst *Cond,
1522 IVStrideUse* &CondUse,
1523 const SCEVHandle* &CondStride) {
1524 if (StrideOrder.size() < 2 ||
1525 IVUsesByStride[*CondStride].Users.size() != 1)
1527 const SCEVConstant *SC = dyn_cast<SCEVConstant>(*CondStride);
1528 if (!SC) return Cond;
1529 ConstantInt *C = dyn_cast<ConstantInt>(Cond->getOperand(1));
1530 if (!C) return Cond;
1532 ICmpInst::Predicate Predicate = Cond->getPredicate();
1533 int64_t CmpSSInt = SC->getValue()->getSExtValue();
1534 int64_t CmpVal = C->getValue().getSExtValue();
1535 unsigned BitWidth = C->getValue().getBitWidth();
1536 uint64_t SignBit = 1ULL << (BitWidth-1);
1537 const Type *CmpTy = C->getType();
1538 const Type *NewCmpTy = NULL;
1539 unsigned TyBits = CmpTy->getPrimitiveSizeInBits();
1540 unsigned NewTyBits = 0;
1541 int64_t NewCmpVal = CmpVal;
1542 SCEVHandle *NewStride = NULL;
1543 Value *NewIncV = NULL;
1546 // Look for a suitable stride / iv as replacement.
1547 std::stable_sort(StrideOrder.begin(), StrideOrder.end(), StrideCompare());
1548 for (unsigned i = 0, e = StrideOrder.size(); i != e; ++i) {
1549 std::map<SCEVHandle, IVUsersOfOneStride>::iterator SI =
1550 IVUsesByStride.find(StrideOrder[i]);
1551 if (!isa<SCEVConstant>(SI->first))
1553 int64_t SSInt = cast<SCEVConstant>(SI->first)->getValue()->getSExtValue();
1554 if (abs(SSInt) <= abs(CmpSSInt) || (SSInt % CmpSSInt) != 0)
1557 Scale = SSInt / CmpSSInt;
1558 NewCmpVal = CmpVal * Scale;
1559 APInt Mul = APInt(BitWidth, NewCmpVal);
1560 // Check for overflow.
1561 if (Mul.getSExtValue() != NewCmpVal) {
1566 // Watch out for overflow.
1567 if (ICmpInst::isSignedPredicate(Predicate) &&
1568 (CmpVal & SignBit) != (NewCmpVal & SignBit))
1571 if (NewCmpVal != CmpVal) {
1572 // Pick the best iv to use trying to avoid a cast.
1574 for (std::vector<IVStrideUse>::iterator UI = SI->second.Users.begin(),
1575 E = SI->second.Users.end(); UI != E; ++UI) {
1576 NewIncV = UI->OperandValToReplace;
1577 if (NewIncV->getType() == CmpTy)
1585 NewCmpTy = NewIncV->getType();
1586 NewTyBits = isa<PointerType>(NewCmpTy)
1587 ? UIntPtrTy->getPrimitiveSizeInBits()
1588 : NewCmpTy->getPrimitiveSizeInBits();
1589 if (RequiresTypeConversion(NewCmpTy, CmpTy)) {
1590 // Check if it is possible to rewrite it using a iv / stride of a smaller
1592 bool TruncOk = false;
1593 if (NewCmpTy->isInteger()) {
1594 unsigned Bits = NewTyBits;
1595 if (ICmpInst::isSignedPredicate(Predicate))
1597 uint64_t Mask = (1ULL << Bits) - 1;
1598 if (((uint64_t)NewCmpVal & Mask) == (uint64_t)NewCmpVal)
1607 // Don't rewrite if use offset is non-constant and the new type is
1608 // of a different type.
1609 // FIXME: too conservative?
1610 if (NewTyBits != TyBits && !isa<SCEVConstant>(CondUse->Offset)) {
1615 bool AllUsesAreAddresses = true;
1616 std::vector<BasedUser> UsersToProcess;
1617 SCEVHandle CommonExprs = CollectIVUsers(SI->first, SI->second, L,
1618 AllUsesAreAddresses,
1620 // Avoid rewriting the compare instruction with an iv of new stride
1621 // if it's likely the new stride uses will be rewritten using the
1622 if (AllUsesAreAddresses &&
1623 ValidStride(!isZero(CommonExprs), Scale, UsersToProcess)) {
1628 // If scale is negative, use inverse predicate unless it's testing
1630 if (Scale < 0 && !Cond->isEquality())
1631 Predicate = ICmpInst::getInversePredicate(Predicate);
1633 NewStride = &StrideOrder[i];
1638 if (NewCmpVal != CmpVal) {
1639 // Create a new compare instruction using new stride / iv.
1640 ICmpInst *OldCond = Cond;
1642 if (!isa<PointerType>(NewCmpTy))
1643 RHS = ConstantInt::get(NewCmpTy, NewCmpVal);
1645 RHS = ConstantInt::get(UIntPtrTy, NewCmpVal);
1646 RHS = SCEVExpander::InsertCastOfTo(Instruction::IntToPtr, RHS, NewCmpTy);
1648 // Insert new compare instruction.
1649 Cond = new ICmpInst(Predicate, NewIncV, RHS);
1650 Cond->setName(L->getHeader()->getName() + ".termcond");
1651 OldCond->getParent()->getInstList().insert(OldCond, Cond);
1653 // Remove the old compare instruction. The old indvar is probably dead too.
1654 DeadInsts.insert(cast<Instruction>(CondUse->OperandValToReplace));
1655 OldCond->replaceAllUsesWith(Cond);
1656 SE->deleteValueFromRecords(OldCond);
1657 OldCond->eraseFromParent();
1659 IVUsesByStride[*CondStride].Users.pop_back();
1660 SCEVHandle NewOffset = TyBits == NewTyBits
1661 ? SE->getMulExpr(CondUse->Offset,
1662 SE->getConstant(ConstantInt::get(CmpTy, Scale)))
1663 : SE->getConstant(ConstantInt::get(NewCmpTy,
1664 cast<SCEVConstant>(CondUse->Offset)->getValue()->getSExtValue()*Scale));
1665 IVUsesByStride[*NewStride].addUser(NewOffset, Cond, NewIncV);
1666 CondUse = &IVUsesByStride[*NewStride].Users.back();
1667 CondStride = NewStride;
1674 // OptimizeIndvars - Now that IVUsesByStride is set up with all of the indvar
1675 // uses in the loop, look to see if we can eliminate some, in favor of using
1676 // common indvars for the different uses.
1677 void LoopStrengthReduce::OptimizeIndvars(Loop *L) {
1678 // TODO: implement optzns here.
1680 // Finally, get the terminating condition for the loop if possible. If we
1681 // can, we want to change it to use a post-incremented version of its
1682 // induction variable, to allow coalescing the live ranges for the IV into
1683 // one register value.
1684 PHINode *SomePHI = cast<PHINode>(L->getHeader()->begin());
1685 BasicBlock *Preheader = L->getLoopPreheader();
1686 BasicBlock *LatchBlock =
1687 SomePHI->getIncomingBlock(SomePHI->getIncomingBlock(0) == Preheader);
1688 BranchInst *TermBr = dyn_cast<BranchInst>(LatchBlock->getTerminator());
1689 if (!TermBr || TermBr->isUnconditional() ||
1690 !isa<ICmpInst>(TermBr->getCondition()))
1692 ICmpInst *Cond = cast<ICmpInst>(TermBr->getCondition());
1694 // Search IVUsesByStride to find Cond's IVUse if there is one.
1695 IVStrideUse *CondUse = 0;
1696 const SCEVHandle *CondStride = 0;
1698 if (!FindIVForUser(Cond, CondUse, CondStride))
1699 return; // setcc doesn't use the IV.
1701 // If possible, change stride and operands of the compare instruction to
1702 // eliminate one stride.
1703 Cond = ChangeCompareStride(L, Cond, CondUse, CondStride);
1705 // It's possible for the setcc instruction to be anywhere in the loop, and
1706 // possible for it to have multiple users. If it is not immediately before
1707 // the latch block branch, move it.
1708 if (&*++BasicBlock::iterator(Cond) != (Instruction*)TermBr) {
1709 if (Cond->hasOneUse()) { // Condition has a single use, just move it.
1710 Cond->moveBefore(TermBr);
1712 // Otherwise, clone the terminating condition and insert into the loopend.
1713 Cond = cast<ICmpInst>(Cond->clone());
1714 Cond->setName(L->getHeader()->getName() + ".termcond");
1715 LatchBlock->getInstList().insert(TermBr, Cond);
1717 // Clone the IVUse, as the old use still exists!
1718 IVUsesByStride[*CondStride].addUser(CondUse->Offset, Cond,
1719 CondUse->OperandValToReplace);
1720 CondUse = &IVUsesByStride[*CondStride].Users.back();
1724 // If we get to here, we know that we can transform the setcc instruction to
1725 // use the post-incremented version of the IV, allowing us to coalesce the
1726 // live ranges for the IV correctly.
1727 CondUse->Offset = SE->getMinusSCEV(CondUse->Offset, *CondStride);
1728 CondUse->isUseOfPostIncrementedValue = true;
1731 bool LoopStrengthReduce::runOnLoop(Loop *L, LPPassManager &LPM) {
1733 LI = &getAnalysis<LoopInfo>();
1734 DT = &getAnalysis<DominatorTree>();
1735 SE = &getAnalysis<ScalarEvolution>();
1736 TD = &getAnalysis<TargetData>();
1737 UIntPtrTy = TD->getIntPtrType();
1739 // Find all uses of induction variables in this loop, and catagorize
1740 // them by stride. Start by finding all of the PHI nodes in the header for
1741 // this loop. If they are induction variables, inspect their uses.
1742 SmallPtrSet<Instruction*,16> Processed; // Don't reprocess instructions.
1743 for (BasicBlock::iterator I = L->getHeader()->begin(); isa<PHINode>(I); ++I)
1744 AddUsersIfInteresting(I, L, Processed);
1746 // If we have nothing to do, return.
1747 if (IVUsesByStride.empty()) return false;
1749 // Optimize induction variables. Some indvar uses can be transformed to use
1750 // strides that will be needed for other purposes. A common example of this
1751 // is the exit test for the loop, which can often be rewritten to use the
1752 // computation of some other indvar to decide when to terminate the loop.
1756 // FIXME: We can widen subreg IV's here for RISC targets. e.g. instead of
1757 // doing computation in byte values, promote to 32-bit values if safe.
1759 // FIXME: Attempt to reuse values across multiple IV's. In particular, we
1760 // could have something like "for(i) { foo(i*8); bar(i*16) }", which should be
1761 // codegened as "for (j = 0;; j+=8) { foo(j); bar(j+j); }" on X86/PPC. Need
1762 // to be careful that IV's are all the same type. Only works for intptr_t
1765 // If we only have one stride, we can more aggressively eliminate some things.
1766 bool HasOneStride = IVUsesByStride.size() == 1;
1769 DOUT << "\nLSR on ";
1773 // IVsByStride keeps IVs for one particular loop.
1774 IVsByStride.clear();
1776 // Sort the StrideOrder so we process larger strides first.
1777 std::stable_sort(StrideOrder.begin(), StrideOrder.end(), StrideCompare());
1779 // Note: this processes each stride/type pair individually. All users passed
1780 // into StrengthReduceStridedIVUsers have the same type AND stride. Also,
1781 // note that we iterate over IVUsesByStride indirectly by using StrideOrder.
1782 // This extra layer of indirection makes the ordering of strides deterministic
1783 // - not dependent on map order.
1784 for (unsigned Stride = 0, e = StrideOrder.size(); Stride != e; ++Stride) {
1785 std::map<SCEVHandle, IVUsersOfOneStride>::iterator SI =
1786 IVUsesByStride.find(StrideOrder[Stride]);
1787 assert(SI != IVUsesByStride.end() && "Stride doesn't exist!");
1788 StrengthReduceStridedIVUsers(SI->first, SI->second, L, HasOneStride);
1791 // Clean up after ourselves
1792 if (!DeadInsts.empty()) {
1793 DeleteTriviallyDeadInstructions(DeadInsts);
1795 BasicBlock::iterator I = L->getHeader()->begin();
1797 while ((PN = dyn_cast<PHINode>(I))) {
1798 ++I; // Preincrement iterator to avoid invalidating it when deleting PN.
1800 // At this point, we know that we have killed one or more GEP
1801 // instructions. It is worth checking to see if the cann indvar is also
1802 // dead, so that we can remove it as well. The requirements for the cann
1803 // indvar to be considered dead are:
1804 // 1. the cann indvar has one use
1805 // 2. the use is an add instruction
1806 // 3. the add has one use
1807 // 4. the add is used by the cann indvar
1808 // If all four cases above are true, then we can remove both the add and
1810 // FIXME: this needs to eliminate an induction variable even if it's being
1811 // compared against some value to decide loop termination.
1812 if (PN->hasOneUse()) {
1813 Instruction *BO = dyn_cast<Instruction>(*PN->use_begin());
1814 if (BO && (isa<BinaryOperator>(BO) || isa<CmpInst>(BO))) {
1815 if (BO->hasOneUse() && PN == *(BO->use_begin())) {
1816 DeadInsts.insert(BO);
1817 // Break the cycle, then delete the PHI.
1818 PN->replaceAllUsesWith(UndefValue::get(PN->getType()));
1819 SE->deleteValueFromRecords(PN);
1820 PN->eraseFromParent();
1825 DeleteTriviallyDeadInstructions(DeadInsts);
1828 CastedPointers.clear();
1829 IVUsesByStride.clear();
1830 StrideOrder.clear();