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/Compiler.h"
38 #include "llvm/Target/TargetLowering.h"
43 STATISTIC(NumReduced , "Number of GEPs strength reduced");
44 STATISTIC(NumInserted, "Number of PHIs inserted");
45 STATISTIC(NumVariable, "Number of PHIs with variable strides");
46 STATISTIC(NumEliminated, "Number of strides eliminated");
47 STATISTIC(NumShadow, "Number of Shadow IVs optimized");
53 /// IVStrideUse - Keep track of one use of a strided induction variable, where
54 /// the stride is stored externally. The Offset member keeps track of the
55 /// offset from the IV, User is the actual user of the operand, and
56 /// 'OperandValToReplace' is the operand of the User that is the use.
57 struct VISIBILITY_HIDDEN IVStrideUse {
60 Value *OperandValToReplace;
62 // isUseOfPostIncrementedValue - True if this should use the
63 // post-incremented version of this IV, not the preincremented version.
64 // This can only be set in special cases, such as the terminating setcc
65 // instruction for a loop or uses dominated by the loop.
66 bool isUseOfPostIncrementedValue;
68 IVStrideUse(const SCEVHandle &Offs, Instruction *U, Value *O)
69 : Offset(Offs), User(U), OperandValToReplace(O),
70 isUseOfPostIncrementedValue(false) {}
73 /// IVUsersOfOneStride - This structure keeps track of all instructions that
74 /// have an operand that is based on the trip count multiplied by some stride.
75 /// The stride for all of these users is common and kept external to this
77 struct VISIBILITY_HIDDEN IVUsersOfOneStride {
78 /// Users - Keep track of all of the users of this stride as well as the
79 /// initial value and the operand that uses the IV.
80 std::vector<IVStrideUse> Users;
82 void addUser(const SCEVHandle &Offset,Instruction *User, Value *Operand) {
83 Users.push_back(IVStrideUse(Offset, User, Operand));
87 /// IVInfo - This structure keeps track of one IV expression inserted during
88 /// StrengthReduceStridedIVUsers. It contains the stride, the common base, as
89 /// well as the PHI node and increment value created for rewrite.
90 struct VISIBILITY_HIDDEN IVExpr {
96 IVExpr(const SCEVHandle &stride, const SCEVHandle &base, PHINode *phi,
98 : Stride(stride), Base(base), PHI(phi), IncV(incv) {}
101 /// IVsOfOneStride - This structure keeps track of all IV expression inserted
102 /// during StrengthReduceStridedIVUsers for a particular stride of the IV.
103 struct VISIBILITY_HIDDEN IVsOfOneStride {
104 std::vector<IVExpr> IVs;
106 void addIV(const SCEVHandle &Stride, const SCEVHandle &Base, PHINode *PHI,
108 IVs.push_back(IVExpr(Stride, Base, PHI, IncV));
112 class VISIBILITY_HIDDEN LoopStrengthReduce : public LoopPass {
116 const TargetData *TD;
117 const Type *UIntPtrTy;
120 /// IVUsesByStride - Keep track of all uses of induction variables that we
121 /// are interested in. The key of the map is the stride of the access.
122 std::map<SCEVHandle, IVUsersOfOneStride> IVUsesByStride;
124 /// IVsByStride - Keep track of all IVs that have been inserted for a
125 /// particular stride.
126 std::map<SCEVHandle, IVsOfOneStride> IVsByStride;
128 /// StrideOrder - An ordering of the keys in IVUsesByStride that is stable:
129 /// We use this to iterate over the IVUsesByStride collection without being
130 /// dependent on random ordering of pointers in the process.
131 SmallVector<SCEVHandle, 16> StrideOrder;
133 /// CastedValues - As we need to cast values to uintptr_t, this keeps track
134 /// of the casted version of each value. This is accessed by
135 /// getCastedVersionOf.
136 DenseMap<Value*, Value*> CastedPointers;
138 /// DeadInsts - Keep track of instructions we may have made dead, so that
139 /// we can remove them after we are done working.
140 SmallVector<Instruction*, 16> DeadInsts;
142 /// TLI - Keep a pointer of a TargetLowering to consult for determining
143 /// transformation profitability.
144 const TargetLowering *TLI;
147 static char ID; // Pass ID, replacement for typeid
148 explicit LoopStrengthReduce(const TargetLowering *tli = NULL) :
149 LoopPass(&ID), TLI(tli) {
152 bool runOnLoop(Loop *L, LPPassManager &LPM);
154 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
155 // We split critical edges, so we change the CFG. However, we do update
156 // many analyses if they are around.
157 AU.addPreservedID(LoopSimplifyID);
158 AU.addPreserved<LoopInfo>();
159 AU.addPreserved<DominanceFrontier>();
160 AU.addPreserved<DominatorTree>();
162 AU.addRequiredID(LoopSimplifyID);
163 AU.addRequired<LoopInfo>();
164 AU.addRequired<DominatorTree>();
165 AU.addRequired<TargetData>();
166 AU.addRequired<ScalarEvolution>();
167 AU.addPreserved<ScalarEvolution>();
170 /// getCastedVersionOf - Return the specified value casted to uintptr_t.
172 Value *getCastedVersionOf(Instruction::CastOps opcode, Value *V);
174 bool AddUsersIfInteresting(Instruction *I, Loop *L,
175 SmallPtrSet<Instruction*,16> &Processed);
176 SCEVHandle GetExpressionSCEV(Instruction *E);
177 ICmpInst *ChangeCompareStride(Loop *L, ICmpInst *Cond,
178 IVStrideUse* &CondUse,
179 const SCEVHandle* &CondStride);
180 void OptimizeIndvars(Loop *L);
182 /// OptimizeShadowIV - If IV is used in a int-to-float cast
183 /// inside the loop then try to eliminate the cast opeation.
184 void OptimizeShadowIV(Loop *L);
186 /// OptimizeSMax - Rewrite the loop's terminating condition
187 /// if it uses an smax computation.
188 ICmpInst *OptimizeSMax(Loop *L, ICmpInst *Cond,
189 IVStrideUse* &CondUse);
191 bool FindIVUserForCond(ICmpInst *Cond, IVStrideUse *&CondUse,
192 const SCEVHandle *&CondStride);
193 bool RequiresTypeConversion(const Type *Ty, const Type *NewTy);
194 unsigned CheckForIVReuse(bool, bool, const SCEVHandle&,
195 IVExpr&, const Type*,
196 const std::vector<BasedUser>& UsersToProcess);
197 bool ValidStride(bool, int64_t,
198 const std::vector<BasedUser>& UsersToProcess);
199 SCEVHandle CollectIVUsers(const SCEVHandle &Stride,
200 IVUsersOfOneStride &Uses,
202 bool &AllUsesAreAddresses,
203 std::vector<BasedUser> &UsersToProcess);
204 void StrengthReduceStridedIVUsers(const SCEVHandle &Stride,
205 IVUsersOfOneStride &Uses,
206 Loop *L, bool isOnlyStride);
207 void DeleteTriviallyDeadInstructions();
211 char LoopStrengthReduce::ID = 0;
212 static RegisterPass<LoopStrengthReduce>
213 X("loop-reduce", "Loop Strength Reduction");
215 Pass *llvm::createLoopStrengthReducePass(const TargetLowering *TLI) {
216 return new LoopStrengthReduce(TLI);
219 /// getCastedVersionOf - Return the specified value casted to uintptr_t. This
220 /// assumes that the Value* V is of integer or pointer type only.
222 Value *LoopStrengthReduce::getCastedVersionOf(Instruction::CastOps opcode,
224 if (V->getType() == UIntPtrTy) return V;
225 if (Constant *CB = dyn_cast<Constant>(V))
226 return ConstantExpr::getCast(opcode, CB, UIntPtrTy);
228 Value *&New = CastedPointers[V];
231 New = SCEVExpander::InsertCastOfTo(opcode, V, UIntPtrTy);
232 DeadInsts.push_back(cast<Instruction>(New));
237 /// DeleteTriviallyDeadInstructions - If any of the instructions is the
238 /// specified set are trivially dead, delete them and see if this makes any of
239 /// their operands subsequently dead.
240 void LoopStrengthReduce::DeleteTriviallyDeadInstructions() {
241 if (DeadInsts.empty()) return;
243 // Sort the deadinsts list so that we can trivially eliminate duplicates as we
244 // go. The code below never adds a non-dead instruction to the worklist, but
245 // callers may not be so careful.
246 array_pod_sort(DeadInsts.begin(), DeadInsts.end());
248 // Drop duplicate instructions and those with uses.
249 for (unsigned i = 0, e = DeadInsts.size()-1; i < e; ++i) {
250 Instruction *I = DeadInsts[i];
251 if (!I->use_empty()) DeadInsts[i] = 0;
252 while (DeadInsts[i+1] == I && i != e)
256 while (!DeadInsts.empty()) {
257 Instruction *I = DeadInsts.back();
258 DeadInsts.pop_back();
260 if (I == 0 || !isInstructionTriviallyDead(I))
263 SE->deleteValueFromRecords(I);
265 for (User::op_iterator OI = I->op_begin(), E = I->op_end(); OI != E; ++OI) {
266 if (Instruction *U = dyn_cast<Instruction>(*OI)) {
269 DeadInsts.push_back(U);
273 I->eraseFromParent();
279 /// GetExpressionSCEV - Compute and return the SCEV for the specified
281 SCEVHandle LoopStrengthReduce::GetExpressionSCEV(Instruction *Exp) {
282 // Pointer to pointer bitcast instructions return the same value as their
284 if (BitCastInst *BCI = dyn_cast<BitCastInst>(Exp)) {
285 if (SE->hasSCEV(BCI) || !isa<Instruction>(BCI->getOperand(0)))
286 return SE->getSCEV(BCI);
287 SCEVHandle R = GetExpressionSCEV(cast<Instruction>(BCI->getOperand(0)));
292 // Scalar Evolutions doesn't know how to compute SCEV's for GEP instructions.
293 // If this is a GEP that SE doesn't know about, compute it now and insert it.
294 // If this is not a GEP, or if we have already done this computation, just let
296 GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(Exp);
297 if (!GEP || SE->hasSCEV(GEP))
298 return SE->getSCEV(Exp);
300 // Analyze all of the subscripts of this getelementptr instruction, looking
301 // for uses that are determined by the trip count of the loop. First, skip
302 // all operands the are not dependent on the IV.
304 // Build up the base expression. Insert an LLVM cast of the pointer to
306 SCEVHandle GEPVal = SE->getUnknown(
307 getCastedVersionOf(Instruction::PtrToInt, GEP->getOperand(0)));
309 gep_type_iterator GTI = gep_type_begin(GEP);
311 for (User::op_iterator i = GEP->op_begin() + 1, e = GEP->op_end();
312 i != e; ++i, ++GTI) {
313 // If this is a use of a recurrence that we can analyze, and it comes before
314 // Op does in the GEP operand list, we will handle this when we process this
316 if (const StructType *STy = dyn_cast<StructType>(*GTI)) {
317 const StructLayout *SL = TD->getStructLayout(STy);
318 unsigned Idx = cast<ConstantInt>(*i)->getZExtValue();
319 uint64_t Offset = SL->getElementOffset(Idx);
320 GEPVal = SE->getAddExpr(GEPVal,
321 SE->getIntegerSCEV(Offset, UIntPtrTy));
323 unsigned GEPOpiBits =
324 (*i)->getType()->getPrimitiveSizeInBits();
325 unsigned IntPtrBits = UIntPtrTy->getPrimitiveSizeInBits();
326 Instruction::CastOps opcode = (GEPOpiBits < IntPtrBits ?
327 Instruction::SExt : (GEPOpiBits > IntPtrBits ? Instruction::Trunc :
328 Instruction::BitCast));
329 Value *OpVal = getCastedVersionOf(opcode, *i);
330 SCEVHandle Idx = SE->getSCEV(OpVal);
332 uint64_t TypeSize = TD->getABITypeSize(GTI.getIndexedType());
334 Idx = SE->getMulExpr(Idx,
335 SE->getConstant(ConstantInt::get(UIntPtrTy,
337 GEPVal = SE->getAddExpr(GEPVal, Idx);
341 SE->setSCEV(GEP, GEPVal);
345 /// getSCEVStartAndStride - Compute the start and stride of this expression,
346 /// returning false if the expression is not a start/stride pair, or true if it
347 /// is. The stride must be a loop invariant expression, but the start may be
348 /// a mix of loop invariant and loop variant expressions.
349 static bool getSCEVStartAndStride(const SCEVHandle &SH, Loop *L,
350 SCEVHandle &Start, SCEVHandle &Stride,
351 ScalarEvolution *SE) {
352 SCEVHandle TheAddRec = Start; // Initialize to zero.
354 // If the outer level is an AddExpr, the operands are all start values except
355 // for a nested AddRecExpr.
356 if (SCEVAddExpr *AE = dyn_cast<SCEVAddExpr>(SH)) {
357 for (unsigned i = 0, e = AE->getNumOperands(); i != e; ++i)
358 if (SCEVAddRecExpr *AddRec =
359 dyn_cast<SCEVAddRecExpr>(AE->getOperand(i))) {
360 if (AddRec->getLoop() == L)
361 TheAddRec = SE->getAddExpr(AddRec, TheAddRec);
363 return false; // Nested IV of some sort?
365 Start = SE->getAddExpr(Start, AE->getOperand(i));
368 } else if (isa<SCEVAddRecExpr>(SH)) {
371 return false; // not analyzable.
374 SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(TheAddRec);
375 if (!AddRec || AddRec->getLoop() != L) return false;
377 // FIXME: Generalize to non-affine IV's.
378 if (!AddRec->isAffine()) return false;
380 Start = SE->getAddExpr(Start, AddRec->getOperand(0));
382 if (!isa<SCEVConstant>(AddRec->getOperand(1)))
383 DOUT << "[" << L->getHeader()->getName()
384 << "] Variable stride: " << *AddRec << "\n";
386 Stride = AddRec->getOperand(1);
390 /// IVUseShouldUsePostIncValue - We have discovered a "User" of an IV expression
391 /// and now we need to decide whether the user should use the preinc or post-inc
392 /// value. If this user should use the post-inc version of the IV, return true.
394 /// Choosing wrong here can break dominance properties (if we choose to use the
395 /// post-inc value when we cannot) or it can end up adding extra live-ranges to
396 /// the loop, resulting in reg-reg copies (if we use the pre-inc value when we
397 /// should use the post-inc value).
398 static bool IVUseShouldUsePostIncValue(Instruction *User, Instruction *IV,
399 Loop *L, DominatorTree *DT, Pass *P,
400 SmallVectorImpl<Instruction*> &DeadInsts){
401 // If the user is in the loop, use the preinc value.
402 if (L->contains(User->getParent())) return false;
404 BasicBlock *LatchBlock = L->getLoopLatch();
406 // Ok, the user is outside of the loop. If it is dominated by the latch
407 // block, use the post-inc value.
408 if (DT->dominates(LatchBlock, User->getParent()))
411 // There is one case we have to be careful of: PHI nodes. These little guys
412 // can live in blocks that do not dominate the latch block, but (since their
413 // uses occur in the predecessor block, not the block the PHI lives in) should
414 // still use the post-inc value. Check for this case now.
415 PHINode *PN = dyn_cast<PHINode>(User);
416 if (!PN) return false; // not a phi, not dominated by latch block.
418 // Look at all of the uses of IV by the PHI node. If any use corresponds to
419 // a block that is not dominated by the latch block, give up and use the
420 // preincremented value.
421 unsigned NumUses = 0;
422 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
423 if (PN->getIncomingValue(i) == IV) {
425 if (!DT->dominates(LatchBlock, PN->getIncomingBlock(i)))
429 // Okay, all uses of IV by PN are in predecessor blocks that really are
430 // dominated by the latch block. Split the critical edges and use the
431 // post-incremented value.
432 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
433 if (PN->getIncomingValue(i) == IV) {
434 SplitCriticalEdge(PN->getIncomingBlock(i), PN->getParent(), P, false);
435 // Splitting the critical edge can reduce the number of entries in this
437 e = PN->getNumIncomingValues();
438 if (--NumUses == 0) break;
441 // PHI node might have become a constant value after SplitCriticalEdge.
442 DeadInsts.push_back(User);
449 /// AddUsersIfInteresting - Inspect the specified instruction. If it is a
450 /// reducible SCEV, recursively add its users to the IVUsesByStride set and
451 /// return true. Otherwise, return false.
452 bool LoopStrengthReduce::AddUsersIfInteresting(Instruction *I, Loop *L,
453 SmallPtrSet<Instruction*,16> &Processed) {
454 if (!I->getType()->isInteger() && !isa<PointerType>(I->getType()))
455 return false; // Void and FP expressions cannot be reduced.
456 if (!Processed.insert(I))
457 return true; // Instruction already handled.
459 // Get the symbolic expression for this instruction.
460 SCEVHandle ISE = GetExpressionSCEV(I);
461 if (isa<SCEVCouldNotCompute>(ISE)) return false;
463 // Get the start and stride for this expression.
464 SCEVHandle Start = SE->getIntegerSCEV(0, ISE->getType());
465 SCEVHandle Stride = Start;
466 if (!getSCEVStartAndStride(ISE, L, Start, Stride, SE))
467 return false; // Non-reducible symbolic expression, bail out.
469 std::vector<Instruction *> IUsers;
470 // Collect all I uses now because IVUseShouldUsePostIncValue may
471 // invalidate use_iterator.
472 for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI != E; ++UI)
473 IUsers.push_back(cast<Instruction>(*UI));
475 for (unsigned iused_index = 0, iused_size = IUsers.size();
476 iused_index != iused_size; ++iused_index) {
478 Instruction *User = IUsers[iused_index];
480 // Do not infinitely recurse on PHI nodes.
481 if (isa<PHINode>(User) && Processed.count(User))
484 // If this is an instruction defined in a nested loop, or outside this loop,
485 // don't recurse into it.
486 bool AddUserToIVUsers = false;
487 if (LI->getLoopFor(User->getParent()) != L) {
488 DOUT << "FOUND USER in other loop: " << *User
489 << " OF SCEV: " << *ISE << "\n";
490 AddUserToIVUsers = true;
491 } else if (!AddUsersIfInteresting(User, L, Processed)) {
492 DOUT << "FOUND USER: " << *User
493 << " OF SCEV: " << *ISE << "\n";
494 AddUserToIVUsers = true;
497 if (AddUserToIVUsers) {
498 IVUsersOfOneStride &StrideUses = IVUsesByStride[Stride];
499 if (StrideUses.Users.empty()) // First occurance of this stride?
500 StrideOrder.push_back(Stride);
502 // Okay, we found a user that we cannot reduce. Analyze the instruction
503 // and decide what to do with it. If we are a use inside of the loop, use
504 // the value before incrementation, otherwise use it after incrementation.
505 if (IVUseShouldUsePostIncValue(User, I, L, DT, this, DeadInsts)) {
506 // The value used will be incremented by the stride more than we are
507 // expecting, so subtract this off.
508 SCEVHandle NewStart = SE->getMinusSCEV(Start, Stride);
509 StrideUses.addUser(NewStart, User, I);
510 StrideUses.Users.back().isUseOfPostIncrementedValue = true;
511 DOUT << " USING POSTINC SCEV, START=" << *NewStart<< "\n";
513 StrideUses.addUser(Start, User, I);
521 /// BasedUser - For a particular base value, keep information about how we've
522 /// partitioned the expression so far.
524 /// SE - The current ScalarEvolution object.
527 /// Base - The Base value for the PHI node that needs to be inserted for
528 /// this use. As the use is processed, information gets moved from this
529 /// field to the Imm field (below). BasedUser values are sorted by this
533 /// Inst - The instruction using the induction variable.
536 /// OperandValToReplace - The operand value of Inst to replace with the
538 Value *OperandValToReplace;
540 /// Imm - The immediate value that should be added to the base immediately
541 /// before Inst, because it will be folded into the imm field of the
545 // isUseOfPostIncrementedValue - True if this should use the
546 // post-incremented version of this IV, not the preincremented version.
547 // This can only be set in special cases, such as the terminating setcc
548 // instruction for a loop and uses outside the loop that are dominated by
550 bool isUseOfPostIncrementedValue;
552 BasedUser(IVStrideUse &IVSU, ScalarEvolution *se)
553 : SE(se), Base(IVSU.Offset), Inst(IVSU.User),
554 OperandValToReplace(IVSU.OperandValToReplace),
555 Imm(SE->getIntegerSCEV(0, Base->getType())),
556 isUseOfPostIncrementedValue(IVSU.isUseOfPostIncrementedValue) {}
558 // Once we rewrite the code to insert the new IVs we want, update the
559 // operands of Inst to use the new expression 'NewBase', with 'Imm' added
561 void RewriteInstructionToUseNewBase(const SCEVHandle &NewBase,
562 Instruction *InsertPt,
563 SCEVExpander &Rewriter, Loop *L, Pass *P,
564 SmallVectorImpl<Instruction*> &DeadInsts);
566 Value *InsertCodeForBaseAtPosition(const SCEVHandle &NewBase,
567 SCEVExpander &Rewriter,
568 Instruction *IP, Loop *L);
573 void BasedUser::dump() const {
574 cerr << " Base=" << *Base;
575 cerr << " Imm=" << *Imm;
576 cerr << " Inst: " << *Inst;
579 Value *BasedUser::InsertCodeForBaseAtPosition(const SCEVHandle &NewBase,
580 SCEVExpander &Rewriter,
581 Instruction *IP, Loop *L) {
582 // Figure out where we *really* want to insert this code. In particular, if
583 // the user is inside of a loop that is nested inside of L, we really don't
584 // want to insert this expression before the user, we'd rather pull it out as
585 // many loops as possible.
586 LoopInfo &LI = Rewriter.getLoopInfo();
587 Instruction *BaseInsertPt = IP;
589 // Figure out the most-nested loop that IP is in.
590 Loop *InsertLoop = LI.getLoopFor(IP->getParent());
592 // If InsertLoop is not L, and InsertLoop is nested inside of L, figure out
593 // the preheader of the outer-most loop where NewBase is not loop invariant.
594 if (L->contains(IP->getParent()))
595 while (InsertLoop && NewBase->isLoopInvariant(InsertLoop)) {
596 BaseInsertPt = InsertLoop->getLoopPreheader()->getTerminator();
597 InsertLoop = InsertLoop->getParentLoop();
600 // If there is no immediate value, skip the next part.
602 return Rewriter.expandCodeFor(NewBase, BaseInsertPt);
604 Value *Base = Rewriter.expandCodeFor(NewBase, BaseInsertPt);
606 // If we are inserting the base and imm values in the same block, make sure to
607 // adjust the IP position if insertion reused a result.
608 if (IP == BaseInsertPt)
609 IP = Rewriter.getInsertionPoint();
611 // Always emit the immediate (if non-zero) into the same block as the user.
612 SCEVHandle NewValSCEV = SE->getAddExpr(SE->getUnknown(Base), Imm);
613 return Rewriter.expandCodeFor(NewValSCEV, IP);
618 // Once we rewrite the code to insert the new IVs we want, update the
619 // operands of Inst to use the new expression 'NewBase', with 'Imm' added
620 // to it. NewBasePt is the last instruction which contributes to the
621 // value of NewBase in the case that it's a diffferent instruction from
622 // the PHI that NewBase is computed from, or null otherwise.
624 void BasedUser::RewriteInstructionToUseNewBase(const SCEVHandle &NewBase,
625 Instruction *NewBasePt,
626 SCEVExpander &Rewriter, Loop *L, Pass *P,
627 SmallVectorImpl<Instruction*> &DeadInsts){
628 if (!isa<PHINode>(Inst)) {
629 // By default, insert code at the user instruction.
630 BasicBlock::iterator InsertPt = Inst;
632 // However, if the Operand is itself an instruction, the (potentially
633 // complex) inserted code may be shared by many users. Because of this, we
634 // want to emit code for the computation of the operand right before its old
635 // computation. This is usually safe, because we obviously used to use the
636 // computation when it was computed in its current block. However, in some
637 // cases (e.g. use of a post-incremented induction variable) the NewBase
638 // value will be pinned to live somewhere after the original computation.
639 // In this case, we have to back off.
641 // If this is a use outside the loop (which means after, since it is based
642 // on a loop indvar) we use the post-incremented value, so that we don't
643 // artificially make the preinc value live out the bottom of the loop.
644 if (!isUseOfPostIncrementedValue && L->contains(Inst->getParent())) {
645 if (NewBasePt && isa<PHINode>(OperandValToReplace)) {
646 InsertPt = NewBasePt;
648 } else if (Instruction *OpInst
649 = dyn_cast<Instruction>(OperandValToReplace)) {
651 while (isa<PHINode>(InsertPt)) ++InsertPt;
654 Value *NewVal = InsertCodeForBaseAtPosition(NewBase, Rewriter, InsertPt, L);
655 // Adjust the type back to match the Inst. Note that we can't use InsertPt
656 // here because the SCEVExpander may have inserted the instructions after
657 // that point, in its efforts to avoid inserting redundant expressions.
658 if (isa<PointerType>(OperandValToReplace->getType())) {
659 NewVal = SCEVExpander::InsertCastOfTo(Instruction::IntToPtr,
661 OperandValToReplace->getType());
663 // Replace the use of the operand Value with the new Phi we just created.
664 Inst->replaceUsesOfWith(OperandValToReplace, NewVal);
665 DOUT << " CHANGED: IMM =" << *Imm;
666 DOUT << " \tNEWBASE =" << *NewBase;
667 DOUT << " \tInst = " << *Inst;
671 // PHI nodes are more complex. We have to insert one copy of the NewBase+Imm
672 // expression into each operand block that uses it. Note that PHI nodes can
673 // have multiple entries for the same predecessor. We use a map to make sure
674 // that a PHI node only has a single Value* for each predecessor (which also
675 // prevents us from inserting duplicate code in some blocks).
676 DenseMap<BasicBlock*, Value*> InsertedCode;
677 PHINode *PN = cast<PHINode>(Inst);
678 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
679 if (PN->getIncomingValue(i) == OperandValToReplace) {
680 // If this is a critical edge, split the edge so that we do not insert the
681 // code on all predecessor/successor paths. We do this unless this is the
682 // canonical backedge for this loop, as this can make some inserted code
683 // be in an illegal position.
684 BasicBlock *PHIPred = PN->getIncomingBlock(i);
685 if (e != 1 && PHIPred->getTerminator()->getNumSuccessors() > 1 &&
686 (PN->getParent() != L->getHeader() || !L->contains(PHIPred))) {
688 // First step, split the critical edge.
689 SplitCriticalEdge(PHIPred, PN->getParent(), P, false);
691 // Next step: move the basic block. In particular, if the PHI node
692 // is outside of the loop, and PredTI is in the loop, we want to
693 // move the block to be immediately before the PHI block, not
694 // immediately after PredTI.
695 if (L->contains(PHIPred) && !L->contains(PN->getParent())) {
696 BasicBlock *NewBB = PN->getIncomingBlock(i);
697 NewBB->moveBefore(PN->getParent());
700 // Splitting the edge can reduce the number of PHI entries we have.
701 e = PN->getNumIncomingValues();
704 Value *&Code = InsertedCode[PN->getIncomingBlock(i)];
706 // Insert the code into the end of the predecessor block.
707 Instruction *InsertPt = PN->getIncomingBlock(i)->getTerminator();
708 Code = InsertCodeForBaseAtPosition(NewBase, Rewriter, InsertPt, L);
710 // Adjust the type back to match the PHI. Note that we can't use
711 // InsertPt here because the SCEVExpander may have inserted its
712 // instructions after that point, in its efforts to avoid inserting
713 // redundant expressions.
714 if (isa<PointerType>(PN->getType())) {
715 Code = SCEVExpander::InsertCastOfTo(Instruction::IntToPtr,
721 // Replace the use of the operand Value with the new Phi we just created.
722 PN->setIncomingValue(i, Code);
727 // PHI node might have become a constant value after SplitCriticalEdge.
728 DeadInsts.push_back(Inst);
730 DOUT << " CHANGED: IMM =" << *Imm << " Inst = " << *Inst;
734 /// isTargetConstant - Return true if the following can be referenced by the
735 /// immediate field of a target instruction.
736 static bool isTargetConstant(const SCEVHandle &V, const Type *UseTy,
737 const TargetLowering *TLI) {
738 if (SCEVConstant *SC = dyn_cast<SCEVConstant>(V)) {
739 int64_t VC = SC->getValue()->getSExtValue();
741 TargetLowering::AddrMode AM;
743 return TLI->isLegalAddressingMode(AM, UseTy);
745 // Defaults to PPC. PPC allows a sign-extended 16-bit immediate field.
746 return (VC > -(1 << 16) && VC < (1 << 16)-1);
750 if (SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V))
751 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(SU->getValue()))
752 if (TLI && CE->getOpcode() == Instruction::PtrToInt) {
753 Constant *Op0 = CE->getOperand(0);
754 if (GlobalValue *GV = dyn_cast<GlobalValue>(Op0)) {
755 TargetLowering::AddrMode AM;
757 return TLI->isLegalAddressingMode(AM, UseTy);
763 /// MoveLoopVariantsToImmediateField - Move any subexpressions from Val that are
764 /// loop varying to the Imm operand.
765 static void MoveLoopVariantsToImmediateField(SCEVHandle &Val, SCEVHandle &Imm,
766 Loop *L, ScalarEvolution *SE) {
767 if (Val->isLoopInvariant(L)) return; // Nothing to do.
769 if (SCEVAddExpr *SAE = dyn_cast<SCEVAddExpr>(Val)) {
770 std::vector<SCEVHandle> NewOps;
771 NewOps.reserve(SAE->getNumOperands());
773 for (unsigned i = 0; i != SAE->getNumOperands(); ++i)
774 if (!SAE->getOperand(i)->isLoopInvariant(L)) {
775 // If this is a loop-variant expression, it must stay in the immediate
776 // field of the expression.
777 Imm = SE->getAddExpr(Imm, SAE->getOperand(i));
779 NewOps.push_back(SAE->getOperand(i));
783 Val = SE->getIntegerSCEV(0, Val->getType());
785 Val = SE->getAddExpr(NewOps);
786 } else if (SCEVAddRecExpr *SARE = dyn_cast<SCEVAddRecExpr>(Val)) {
787 // Try to pull immediates out of the start value of nested addrec's.
788 SCEVHandle Start = SARE->getStart();
789 MoveLoopVariantsToImmediateField(Start, Imm, L, SE);
791 std::vector<SCEVHandle> Ops(SARE->op_begin(), SARE->op_end());
793 Val = SE->getAddRecExpr(Ops, SARE->getLoop());
795 // Otherwise, all of Val is variant, move the whole thing over.
796 Imm = SE->getAddExpr(Imm, Val);
797 Val = SE->getIntegerSCEV(0, Val->getType());
802 /// MoveImmediateValues - Look at Val, and pull out any additions of constants
803 /// that can fit into the immediate field of instructions in the target.
804 /// Accumulate these immediate values into the Imm value.
805 static void MoveImmediateValues(const TargetLowering *TLI,
807 SCEVHandle &Val, SCEVHandle &Imm,
808 bool isAddress, Loop *L,
809 ScalarEvolution *SE) {
810 const Type *UseTy = User->getType();
811 if (StoreInst *SI = dyn_cast<StoreInst>(User))
812 UseTy = SI->getOperand(0)->getType();
814 if (SCEVAddExpr *SAE = dyn_cast<SCEVAddExpr>(Val)) {
815 std::vector<SCEVHandle> NewOps;
816 NewOps.reserve(SAE->getNumOperands());
818 for (unsigned i = 0; i != SAE->getNumOperands(); ++i) {
819 SCEVHandle NewOp = SAE->getOperand(i);
820 MoveImmediateValues(TLI, User, NewOp, Imm, isAddress, L, SE);
822 if (!NewOp->isLoopInvariant(L)) {
823 // If this is a loop-variant expression, it must stay in the immediate
824 // field of the expression.
825 Imm = SE->getAddExpr(Imm, NewOp);
827 NewOps.push_back(NewOp);
832 Val = SE->getIntegerSCEV(0, Val->getType());
834 Val = SE->getAddExpr(NewOps);
836 } else if (SCEVAddRecExpr *SARE = dyn_cast<SCEVAddRecExpr>(Val)) {
837 // Try to pull immediates out of the start value of nested addrec's.
838 SCEVHandle Start = SARE->getStart();
839 MoveImmediateValues(TLI, User, Start, Imm, isAddress, L, SE);
841 if (Start != SARE->getStart()) {
842 std::vector<SCEVHandle> Ops(SARE->op_begin(), SARE->op_end());
844 Val = SE->getAddRecExpr(Ops, SARE->getLoop());
847 } else if (SCEVMulExpr *SME = dyn_cast<SCEVMulExpr>(Val)) {
848 // Transform "8 * (4 + v)" -> "32 + 8*V" if "32" fits in the immed field.
849 if (isAddress && isTargetConstant(SME->getOperand(0), UseTy, TLI) &&
850 SME->getNumOperands() == 2 && SME->isLoopInvariant(L)) {
852 SCEVHandle SubImm = SE->getIntegerSCEV(0, Val->getType());
853 SCEVHandle NewOp = SME->getOperand(1);
854 MoveImmediateValues(TLI, User, NewOp, SubImm, isAddress, L, SE);
856 // If we extracted something out of the subexpressions, see if we can
858 if (NewOp != SME->getOperand(1)) {
859 // Scale SubImm up by "8". If the result is a target constant, we are
861 SubImm = SE->getMulExpr(SubImm, SME->getOperand(0));
862 if (isTargetConstant(SubImm, UseTy, TLI)) {
863 // Accumulate the immediate.
864 Imm = SE->getAddExpr(Imm, SubImm);
866 // Update what is left of 'Val'.
867 Val = SE->getMulExpr(SME->getOperand(0), NewOp);
874 // Loop-variant expressions must stay in the immediate field of the
876 if ((isAddress && isTargetConstant(Val, UseTy, TLI)) ||
877 !Val->isLoopInvariant(L)) {
878 Imm = SE->getAddExpr(Imm, Val);
879 Val = SE->getIntegerSCEV(0, Val->getType());
883 // Otherwise, no immediates to move.
887 /// SeparateSubExprs - Decompose Expr into all of the subexpressions that are
888 /// added together. This is used to reassociate common addition subexprs
889 /// together for maximal sharing when rewriting bases.
890 static void SeparateSubExprs(std::vector<SCEVHandle> &SubExprs,
892 ScalarEvolution *SE) {
893 if (SCEVAddExpr *AE = dyn_cast<SCEVAddExpr>(Expr)) {
894 for (unsigned j = 0, e = AE->getNumOperands(); j != e; ++j)
895 SeparateSubExprs(SubExprs, AE->getOperand(j), SE);
896 } else if (SCEVAddRecExpr *SARE = dyn_cast<SCEVAddRecExpr>(Expr)) {
897 SCEVHandle Zero = SE->getIntegerSCEV(0, Expr->getType());
898 if (SARE->getOperand(0) == Zero) {
899 SubExprs.push_back(Expr);
901 // Compute the addrec with zero as its base.
902 std::vector<SCEVHandle> Ops(SARE->op_begin(), SARE->op_end());
903 Ops[0] = Zero; // Start with zero base.
904 SubExprs.push_back(SE->getAddRecExpr(Ops, SARE->getLoop()));
907 SeparateSubExprs(SubExprs, SARE->getOperand(0), SE);
909 } else if (!Expr->isZero()) {
911 SubExprs.push_back(Expr);
916 /// RemoveCommonExpressionsFromUseBases - Look through all of the uses in Bases,
917 /// removing any common subexpressions from it. Anything truly common is
918 /// removed, accumulated, and returned. This looks for things like (a+b+c) and
919 /// (a+c+d) and computes the common (a+c) subexpression. The common expression
920 /// is *removed* from the Bases and returned.
922 RemoveCommonExpressionsFromUseBases(std::vector<BasedUser> &Uses,
923 ScalarEvolution *SE, Loop *L) {
924 unsigned NumUses = Uses.size();
926 // Only one use? This is a very common case, so we handle it specially and
928 SCEVHandle Zero = SE->getIntegerSCEV(0, Uses[0].Base->getType());
929 SCEVHandle Result = Zero;
931 // If the use is inside the loop, use its base, regardless of what it is:
932 // it is clearly shared across all the IV's. If the use is outside the loop
933 // (which means after it) we don't want to factor anything *into* the loop,
934 // so just use 0 as the base.
935 if (L->contains(Uses[0].Inst->getParent()))
936 std::swap(Result, Uses[0].Base);
940 // To find common subexpressions, count how many of Uses use each expression.
941 // If any subexpressions are used Uses.size() times, they are common.
942 std::map<SCEVHandle, unsigned> SubExpressionUseCounts;
944 // UniqueSubExprs - Keep track of all of the subexpressions we see in the
945 // order we see them.
946 std::vector<SCEVHandle> UniqueSubExprs;
948 std::vector<SCEVHandle> SubExprs;
949 unsigned NumUsesInsideLoop = 0;
950 for (unsigned i = 0; i != NumUses; ++i) {
951 // If the user is outside the loop, just ignore it for base computation.
952 // Since the user is outside the loop, it must be *after* the loop (if it
953 // were before, it could not be based on the loop IV). We don't want users
954 // after the loop to affect base computation of values *inside* the loop,
955 // because we can always add their offsets to the result IV after the loop
956 // is done, ensuring we get good code inside the loop.
957 if (!L->contains(Uses[i].Inst->getParent()))
961 // If the base is zero (which is common), return zero now, there are no
963 if (Uses[i].Base == Zero) return Zero;
965 // Split the expression into subexprs.
966 SeparateSubExprs(SubExprs, Uses[i].Base, SE);
967 // Add one to SubExpressionUseCounts for each subexpr present.
968 for (unsigned j = 0, e = SubExprs.size(); j != e; ++j)
969 if (++SubExpressionUseCounts[SubExprs[j]] == 1)
970 UniqueSubExprs.push_back(SubExprs[j]);
974 // Now that we know how many times each is used, build Result. Iterate over
975 // UniqueSubexprs so that we have a stable ordering.
976 for (unsigned i = 0, e = UniqueSubExprs.size(); i != e; ++i) {
977 std::map<SCEVHandle, unsigned>::iterator I =
978 SubExpressionUseCounts.find(UniqueSubExprs[i]);
979 assert(I != SubExpressionUseCounts.end() && "Entry not found?");
980 if (I->second == NumUsesInsideLoop) // Found CSE!
981 Result = SE->getAddExpr(Result, I->first);
983 // Remove non-cse's from SubExpressionUseCounts.
984 SubExpressionUseCounts.erase(I);
987 // If we found no CSE's, return now.
988 if (Result == Zero) return Result;
990 // Otherwise, remove all of the CSE's we found from each of the base values.
991 for (unsigned i = 0; i != NumUses; ++i) {
992 // Uses outside the loop don't necessarily include the common base, but
993 // the final IV value coming into those uses does. Instead of trying to
994 // remove the pieces of the common base, which might not be there,
995 // subtract off the base to compensate for this.
996 if (!L->contains(Uses[i].Inst->getParent())) {
997 Uses[i].Base = SE->getMinusSCEV(Uses[i].Base, Result);
1001 // Split the expression into subexprs.
1002 SeparateSubExprs(SubExprs, Uses[i].Base, SE);
1004 // Remove any common subexpressions.
1005 for (unsigned j = 0, e = SubExprs.size(); j != e; ++j)
1006 if (SubExpressionUseCounts.count(SubExprs[j])) {
1007 SubExprs.erase(SubExprs.begin()+j);
1011 // Finally, add the non-shared expressions together.
1012 if (SubExprs.empty())
1013 Uses[i].Base = Zero;
1015 Uses[i].Base = SE->getAddExpr(SubExprs);
1022 /// ValidStride - Check whether the given Scale is valid for all loads and
1023 /// stores in UsersToProcess.
1025 bool LoopStrengthReduce::ValidStride(bool HasBaseReg,
1027 const std::vector<BasedUser>& UsersToProcess) {
1031 for (unsigned i=0, e = UsersToProcess.size(); i!=e; ++i) {
1032 // If this is a load or other access, pass the type of the access in.
1033 const Type *AccessTy = Type::VoidTy;
1034 if (StoreInst *SI = dyn_cast<StoreInst>(UsersToProcess[i].Inst))
1035 AccessTy = SI->getOperand(0)->getType();
1036 else if (LoadInst *LI = dyn_cast<LoadInst>(UsersToProcess[i].Inst))
1037 AccessTy = LI->getType();
1038 else if (isa<PHINode>(UsersToProcess[i].Inst))
1041 TargetLowering::AddrMode AM;
1042 if (SCEVConstant *SC = dyn_cast<SCEVConstant>(UsersToProcess[i].Imm))
1043 AM.BaseOffs = SC->getValue()->getSExtValue();
1044 AM.HasBaseReg = HasBaseReg || !UsersToProcess[i].Base->isZero();
1047 // If load[imm+r*scale] is illegal, bail out.
1048 if (!TLI->isLegalAddressingMode(AM, AccessTy))
1054 /// RequiresTypeConversion - Returns true if converting Ty to NewTy is not
1056 bool LoopStrengthReduce::RequiresTypeConversion(const Type *Ty1,
1060 if (TLI && TLI->isTruncateFree(Ty1, Ty2))
1062 return (!Ty1->canLosslesslyBitCastTo(Ty2) &&
1063 !(isa<PointerType>(Ty2) &&
1064 Ty1->canLosslesslyBitCastTo(UIntPtrTy)) &&
1065 !(isa<PointerType>(Ty1) &&
1066 Ty2->canLosslesslyBitCastTo(UIntPtrTy)));
1069 /// CheckForIVReuse - Returns the multiple if the stride is the multiple
1070 /// of a previous stride and it is a legal value for the target addressing
1071 /// mode scale component and optional base reg. This allows the users of
1072 /// this stride to be rewritten as prev iv * factor. It returns 0 if no
1073 /// reuse is possible.
1074 unsigned LoopStrengthReduce::CheckForIVReuse(bool HasBaseReg,
1075 bool AllUsesAreAddresses,
1076 const SCEVHandle &Stride,
1077 IVExpr &IV, const Type *Ty,
1078 const std::vector<BasedUser>& UsersToProcess) {
1079 if (SCEVConstant *SC = dyn_cast<SCEVConstant>(Stride)) {
1080 int64_t SInt = SC->getValue()->getSExtValue();
1081 for (unsigned NewStride = 0, e = StrideOrder.size(); NewStride != e;
1083 std::map<SCEVHandle, IVsOfOneStride>::iterator SI =
1084 IVsByStride.find(StrideOrder[NewStride]);
1085 if (SI == IVsByStride.end())
1087 int64_t SSInt = cast<SCEVConstant>(SI->first)->getValue()->getSExtValue();
1088 if (SI->first != Stride &&
1089 (unsigned(abs(SInt)) < SSInt || (SInt % SSInt) != 0))
1091 int64_t Scale = SInt / SSInt;
1092 // Check that this stride is valid for all the types used for loads and
1093 // stores; if it can be used for some and not others, we might as well use
1094 // the original stride everywhere, since we have to create the IV for it
1095 // anyway. If the scale is 1, then we don't need to worry about folding
1098 (AllUsesAreAddresses &&
1099 ValidStride(HasBaseReg, Scale, UsersToProcess)))
1100 for (std::vector<IVExpr>::iterator II = SI->second.IVs.begin(),
1101 IE = SI->second.IVs.end(); II != IE; ++II)
1102 // FIXME: Only handle base == 0 for now.
1103 // Only reuse previous IV if it would not require a type conversion.
1104 if (II->Base->isZero() &&
1105 !RequiresTypeConversion(II->Base->getType(), Ty)) {
1114 /// PartitionByIsUseOfPostIncrementedValue - Simple boolean predicate that
1115 /// returns true if Val's isUseOfPostIncrementedValue is true.
1116 static bool PartitionByIsUseOfPostIncrementedValue(const BasedUser &Val) {
1117 return Val.isUseOfPostIncrementedValue;
1120 /// isNonConstantNegative - Return true if the specified scev is negated, but
1122 static bool isNonConstantNegative(const SCEVHandle &Expr) {
1123 SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Expr);
1124 if (!Mul) return false;
1126 // If there is a constant factor, it will be first.
1127 SCEVConstant *SC = dyn_cast<SCEVConstant>(Mul->getOperand(0));
1128 if (!SC) return false;
1130 // Return true if the value is negative, this matches things like (-42 * V).
1131 return SC->getValue()->getValue().isNegative();
1134 /// isAddress - Returns true if the specified instruction is using the
1135 /// specified value as an address.
1136 static bool isAddressUse(Instruction *Inst, Value *OperandVal) {
1137 bool isAddress = isa<LoadInst>(Inst);
1138 if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
1139 if (SI->getOperand(1) == OperandVal)
1141 } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
1142 // Addressing modes can also be folded into prefetches and a variety
1144 switch (II->getIntrinsicID()) {
1146 case Intrinsic::prefetch:
1147 case Intrinsic::x86_sse2_loadu_dq:
1148 case Intrinsic::x86_sse2_loadu_pd:
1149 case Intrinsic::x86_sse_loadu_ps:
1150 case Intrinsic::x86_sse_storeu_ps:
1151 case Intrinsic::x86_sse2_storeu_pd:
1152 case Intrinsic::x86_sse2_storeu_dq:
1153 case Intrinsic::x86_sse2_storel_dq:
1154 if (II->getOperand(1) == OperandVal)
1162 // CollectIVUsers - Transform our list of users and offsets to a bit more
1163 // complex table. In this new vector, each 'BasedUser' contains 'Base', the base
1164 // of the strided accesses, as well as the old information from Uses. We
1165 // progressively move information from the Base field to the Imm field, until
1166 // we eventually have the full access expression to rewrite the use.
1167 SCEVHandle LoopStrengthReduce::CollectIVUsers(const SCEVHandle &Stride,
1168 IVUsersOfOneStride &Uses,
1170 bool &AllUsesAreAddresses,
1171 std::vector<BasedUser> &UsersToProcess) {
1172 UsersToProcess.reserve(Uses.Users.size());
1173 for (unsigned i = 0, e = Uses.Users.size(); i != e; ++i) {
1174 UsersToProcess.push_back(BasedUser(Uses.Users[i], SE));
1176 // Move any loop variant operands from the offset field to the immediate
1177 // field of the use, so that we don't try to use something before it is
1179 MoveLoopVariantsToImmediateField(UsersToProcess.back().Base,
1180 UsersToProcess.back().Imm, L, SE);
1181 assert(UsersToProcess.back().Base->isLoopInvariant(L) &&
1182 "Base value is not loop invariant!");
1185 // We now have a whole bunch of uses of like-strided induction variables, but
1186 // they might all have different bases. We want to emit one PHI node for this
1187 // stride which we fold as many common expressions (between the IVs) into as
1188 // possible. Start by identifying the common expressions in the base values
1189 // for the strides (e.g. if we have "A+C+B" and "A+B+D" as our bases, find
1190 // "A+B"), emit it to the preheader, then remove the expression from the
1191 // UsersToProcess base values.
1192 SCEVHandle CommonExprs =
1193 RemoveCommonExpressionsFromUseBases(UsersToProcess, SE, L);
1195 // Next, figure out what we can represent in the immediate fields of
1196 // instructions. If we can represent anything there, move it to the imm
1197 // fields of the BasedUsers. We do this so that it increases the commonality
1198 // of the remaining uses.
1199 unsigned NumPHI = 0;
1200 for (unsigned i = 0, e = UsersToProcess.size(); i != e; ++i) {
1201 // If the user is not in the current loop, this means it is using the exit
1202 // value of the IV. Do not put anything in the base, make sure it's all in
1203 // the immediate field to allow as much factoring as possible.
1204 if (!L->contains(UsersToProcess[i].Inst->getParent())) {
1205 UsersToProcess[i].Imm = SE->getAddExpr(UsersToProcess[i].Imm,
1206 UsersToProcess[i].Base);
1207 UsersToProcess[i].Base =
1208 SE->getIntegerSCEV(0, UsersToProcess[i].Base->getType());
1211 // Addressing modes can be folded into loads and stores. Be careful that
1212 // the store is through the expression, not of the expression though.
1214 bool isAddress = isAddressUse(UsersToProcess[i].Inst,
1215 UsersToProcess[i].OperandValToReplace);
1216 if (isa<PHINode>(UsersToProcess[i].Inst)) {
1221 // If this use isn't an address, then not all uses are addresses.
1222 if (!isAddress && !isPHI)
1223 AllUsesAreAddresses = false;
1225 MoveImmediateValues(TLI, UsersToProcess[i].Inst, UsersToProcess[i].Base,
1226 UsersToProcess[i].Imm, isAddress, L, SE);
1230 // If one of the use if a PHI node and all other uses are addresses, still
1231 // allow iv reuse. Essentially we are trading one constant multiplication
1232 // for one fewer iv.
1234 AllUsesAreAddresses = false;
1239 /// StrengthReduceStridedIVUsers - Strength reduce all of the users of a single
1240 /// stride of IV. All of the users may have different starting values, and this
1241 /// may not be the only stride (we know it is if isOnlyStride is true).
1242 void LoopStrengthReduce::StrengthReduceStridedIVUsers(const SCEVHandle &Stride,
1243 IVUsersOfOneStride &Uses,
1245 bool isOnlyStride) {
1246 // If all the users are moved to another stride, then there is nothing to do.
1247 if (Uses.Users.empty())
1250 // Keep track if every use in UsersToProcess is an address. If they all are,
1251 // we may be able to rewrite the entire collection of them in terms of a
1252 // smaller-stride IV.
1253 bool AllUsesAreAddresses = true;
1255 // Transform our list of users and offsets to a bit more complex table. In
1256 // this new vector, each 'BasedUser' contains 'Base' the base of the
1257 // strided accessas well as the old information from Uses. We progressively
1258 // move information from the Base field to the Imm field, until we eventually
1259 // have the full access expression to rewrite the use.
1260 std::vector<BasedUser> UsersToProcess;
1261 SCEVHandle CommonExprs = CollectIVUsers(Stride, Uses, L, AllUsesAreAddresses,
1264 // If we managed to find some expressions in common, we'll need to carry
1265 // their value in a register and add it in for each use. This will take up
1266 // a register operand, which potentially restricts what stride values are
1268 bool HaveCommonExprs = !CommonExprs->isZero();
1270 // If all uses are addresses, check if it is possible to reuse an IV with a
1271 // stride that is a factor of this stride. And that the multiple is a number
1272 // that can be encoded in the scale field of the target addressing mode. And
1273 // that we will have a valid instruction after this substition, including the
1274 // immediate field, if any.
1275 PHINode *NewPHI = NULL;
1277 IVExpr ReuseIV(SE->getIntegerSCEV(0, Type::Int32Ty),
1278 SE->getIntegerSCEV(0, Type::Int32Ty),
1280 unsigned RewriteFactor = 0;
1281 RewriteFactor = CheckForIVReuse(HaveCommonExprs, AllUsesAreAddresses,
1282 Stride, ReuseIV, CommonExprs->getType(),
1284 if (RewriteFactor != 0) {
1285 DOUT << "BASED ON IV of STRIDE " << *ReuseIV.Stride
1286 << " and BASE " << *ReuseIV.Base << " :\n";
1287 NewPHI = ReuseIV.PHI;
1288 IncV = ReuseIV.IncV;
1291 const Type *ReplacedTy = CommonExprs->getType();
1293 // Now that we know what we need to do, insert the PHI node itself.
1295 DOUT << "INSERTING IV of TYPE " << *ReplacedTy << " of STRIDE "
1296 << *Stride << " and BASE " << *CommonExprs << ": ";
1298 SCEVExpander Rewriter(*SE, *LI);
1299 SCEVExpander PreheaderRewriter(*SE, *LI);
1301 BasicBlock *Preheader = L->getLoopPreheader();
1302 Instruction *PreInsertPt = Preheader->getTerminator();
1303 Instruction *PhiInsertBefore = L->getHeader()->begin();
1305 BasicBlock *LatchBlock = L->getLoopLatch();
1308 // Emit the initial base value into the loop preheader.
1310 = PreheaderRewriter.expandCodeFor(CommonExprs, PreInsertPt);
1312 if (RewriteFactor == 0) {
1313 // Create a new Phi for this base, and stick it in the loop header.
1314 NewPHI = PHINode::Create(ReplacedTy, "iv.", PhiInsertBefore);
1317 // Add common base to the new Phi node.
1318 NewPHI->addIncoming(CommonBaseV, Preheader);
1320 // If the stride is negative, insert a sub instead of an add for the
1322 bool isNegative = isNonConstantNegative(Stride);
1323 SCEVHandle IncAmount = Stride;
1325 IncAmount = SE->getNegativeSCEV(Stride);
1327 // Insert the stride into the preheader.
1328 Value *StrideV = PreheaderRewriter.expandCodeFor(IncAmount, PreInsertPt);
1329 if (!isa<ConstantInt>(StrideV)) ++NumVariable;
1331 // Emit the increment of the base value before the terminator of the loop
1332 // latch block, and add it to the Phi node.
1333 SCEVHandle IncExp = SE->getUnknown(StrideV);
1335 IncExp = SE->getNegativeSCEV(IncExp);
1336 IncExp = SE->getAddExpr(SE->getUnknown(NewPHI), IncExp);
1338 IncV = Rewriter.expandCodeFor(IncExp, LatchBlock->getTerminator());
1339 IncV->setName(NewPHI->getName()+".inc");
1340 NewPHI->addIncoming(IncV, LatchBlock);
1342 // Remember this in case a later stride is multiple of this.
1343 IVsByStride[Stride].addIV(Stride, CommonExprs, NewPHI, IncV);
1345 DOUT << " IV=%" << NewPHI->getNameStr() << " INC=%" << IncV->getNameStr();
1347 Constant *C = dyn_cast<Constant>(CommonBaseV);
1349 (!C->isNullValue() &&
1350 !isTargetConstant(SE->getUnknown(CommonBaseV), ReplacedTy, TLI)))
1351 // We want the common base emitted into the preheader! This is just
1352 // using cast as a copy so BitCast (no-op cast) is appropriate
1353 CommonBaseV = new BitCastInst(CommonBaseV, CommonBaseV->getType(),
1354 "commonbase", PreInsertPt);
1358 // We want to emit code for users inside the loop first. To do this, we
1359 // rearrange BasedUser so that the entries at the end have
1360 // isUseOfPostIncrementedValue = false, because we pop off the end of the
1361 // vector (so we handle them first).
1362 std::partition(UsersToProcess.begin(), UsersToProcess.end(),
1363 PartitionByIsUseOfPostIncrementedValue);
1365 // Sort this by base, so that things with the same base are handled
1366 // together. By partitioning first and stable-sorting later, we are
1367 // guaranteed that within each base we will pop off users from within the
1368 // loop before users outside of the loop with a particular base.
1370 // We would like to use stable_sort here, but we can't. The problem is that
1371 // SCEVHandle's don't have a deterministic ordering w.r.t to each other, so
1372 // we don't have anything to do a '<' comparison on. Because we think the
1373 // number of uses is small, do a horrible bubble sort which just relies on
1375 for (unsigned i = 0, e = UsersToProcess.size(); i != e; ++i) {
1376 // Get a base value.
1377 SCEVHandle Base = UsersToProcess[i].Base;
1379 // Compact everything with this base to be consequtive with this one.
1380 for (unsigned j = i+1; j != e; ++j) {
1381 if (UsersToProcess[j].Base == Base) {
1382 std::swap(UsersToProcess[i+1], UsersToProcess[j]);
1388 // Process all the users now. This outer loop handles all bases, the inner
1389 // loop handles all users of a particular base.
1390 while (!UsersToProcess.empty()) {
1391 SCEVHandle Base = UsersToProcess.back().Base;
1393 // Emit the code for Base into the preheader.
1394 Value *BaseV = PreheaderRewriter.expandCodeFor(Base, PreInsertPt);
1396 DOUT << " INSERTING code for BASE = " << *Base << ":";
1397 if (BaseV->hasName())
1398 DOUT << " Result value name = %" << BaseV->getNameStr();
1401 // If BaseV is a constant other than 0, make sure that it gets inserted into
1402 // the preheader, instead of being forward substituted into the uses. We do
1403 // this by forcing a BitCast (noop cast) to be inserted into the preheader
1405 if (Constant *C = dyn_cast<Constant>(BaseV)) {
1406 if (!C->isNullValue() && !isTargetConstant(Base, ReplacedTy, TLI)) {
1407 // We want this constant emitted into the preheader! This is just
1408 // using cast as a copy so BitCast (no-op cast) is appropriate
1409 BaseV = new BitCastInst(BaseV, BaseV->getType(), "preheaderinsert",
1414 // Emit the code to add the immediate offset to the Phi value, just before
1415 // the instructions that we identified as using this stride and base.
1417 // FIXME: Use emitted users to emit other users.
1418 BasedUser &User = UsersToProcess.back();
1420 // If this instruction wants to use the post-incremented value, move it
1421 // after the post-inc and use its value instead of the PHI.
1422 Value *RewriteOp = NewPHI;
1423 if (User.isUseOfPostIncrementedValue) {
1426 // If this user is in the loop, make sure it is the last thing in the
1427 // loop to ensure it is dominated by the increment.
1428 if (L->contains(User.Inst->getParent()))
1429 User.Inst->moveBefore(LatchBlock->getTerminator());
1431 if (RewriteOp->getType() != ReplacedTy) {
1432 Instruction::CastOps opcode = Instruction::Trunc;
1433 if (ReplacedTy->getPrimitiveSizeInBits() ==
1434 RewriteOp->getType()->getPrimitiveSizeInBits())
1435 opcode = Instruction::BitCast;
1436 RewriteOp = SCEVExpander::InsertCastOfTo(opcode, RewriteOp, ReplacedTy);
1439 SCEVHandle RewriteExpr = SE->getUnknown(RewriteOp);
1441 // If we had to insert new instrutions for RewriteOp, we have to
1442 // consider that they may not have been able to end up immediately
1443 // next to RewriteOp, because non-PHI instructions may never precede
1444 // PHI instructions in a block. In this case, remember where the last
1445 // instruction was inserted so that if we're replacing a different
1446 // PHI node, we can use the later point to expand the final
1448 Instruction *NewBasePt = dyn_cast<Instruction>(RewriteOp);
1449 if (RewriteOp == NewPHI) NewBasePt = 0;
1451 // Clear the SCEVExpander's expression map so that we are guaranteed
1452 // to have the code emitted where we expect it.
1455 // If we are reusing the iv, then it must be multiplied by a constant
1456 // factor take advantage of addressing mode scale component.
1457 if (RewriteFactor != 0) {
1458 RewriteExpr = SE->getMulExpr(SE->getIntegerSCEV(RewriteFactor,
1459 RewriteExpr->getType()),
1462 // The common base is emitted in the loop preheader. But since we
1463 // are reusing an IV, it has not been used to initialize the PHI node.
1464 // Add it to the expression used to rewrite the uses.
1465 if (!isa<ConstantInt>(CommonBaseV) ||
1466 !cast<ConstantInt>(CommonBaseV)->isZero())
1467 RewriteExpr = SE->getAddExpr(RewriteExpr,
1468 SE->getUnknown(CommonBaseV));
1471 // Now that we know what we need to do, insert code before User for the
1472 // immediate and any loop-variant expressions.
1473 if (!isa<ConstantInt>(BaseV) || !cast<ConstantInt>(BaseV)->isZero())
1474 // Add BaseV to the PHI value if needed.
1475 RewriteExpr = SE->getAddExpr(RewriteExpr, SE->getUnknown(BaseV));
1477 User.RewriteInstructionToUseNewBase(RewriteExpr, NewBasePt,
1481 // Mark old value we replaced as possibly dead, so that it is eliminated
1482 // if we just replaced the last use of that value.
1483 DeadInsts.push_back(cast<Instruction>(User.OperandValToReplace));
1485 UsersToProcess.pop_back();
1488 // If there are any more users to process with the same base, process them
1489 // now. We sorted by base above, so we just have to check the last elt.
1490 } while (!UsersToProcess.empty() && UsersToProcess.back().Base == Base);
1491 // TODO: Next, find out which base index is the most common, pull it out.
1494 // IMPORTANT TODO: Figure out how to partition the IV's with this stride, but
1495 // different starting values, into different PHIs.
1498 /// FindIVUserForCond - If Cond has an operand that is an expression of an IV,
1499 /// set the IV user and stride information and return true, otherwise return
1501 bool LoopStrengthReduce::FindIVUserForCond(ICmpInst *Cond, IVStrideUse *&CondUse,
1502 const SCEVHandle *&CondStride) {
1503 for (unsigned Stride = 0, e = StrideOrder.size(); Stride != e && !CondUse;
1505 std::map<SCEVHandle, IVUsersOfOneStride>::iterator SI =
1506 IVUsesByStride.find(StrideOrder[Stride]);
1507 assert(SI != IVUsesByStride.end() && "Stride doesn't exist!");
1509 for (std::vector<IVStrideUse>::iterator UI = SI->second.Users.begin(),
1510 E = SI->second.Users.end(); UI != E; ++UI)
1511 if (UI->User == Cond) {
1512 // NOTE: we could handle setcc instructions with multiple uses here, but
1513 // InstCombine does it as well for simple uses, it's not clear that it
1514 // occurs enough in real life to handle.
1516 CondStride = &SI->first;
1524 // Constant strides come first which in turns are sorted by their absolute
1525 // values. If absolute values are the same, then positive strides comes first.
1527 // 4, -1, X, 1, 2 ==> 1, -1, 2, 4, X
1528 struct StrideCompare {
1529 bool operator()(const SCEVHandle &LHS, const SCEVHandle &RHS) {
1530 SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS);
1531 SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS);
1533 int64_t LV = LHSC->getValue()->getSExtValue();
1534 int64_t RV = RHSC->getValue()->getSExtValue();
1535 uint64_t ALV = (LV < 0) ? -LV : LV;
1536 uint64_t ARV = (RV < 0) ? -RV : RV;
1542 return (LHSC && !RHSC);
1547 /// ChangeCompareStride - If a loop termination compare instruction is the
1548 /// only use of its stride, and the compaison is against a constant value,
1549 /// try eliminate the stride by moving the compare instruction to another
1550 /// stride and change its constant operand accordingly. e.g.
1556 /// if (v2 < 10) goto loop
1561 /// if (v1 < 30) goto loop
1562 ICmpInst *LoopStrengthReduce::ChangeCompareStride(Loop *L, ICmpInst *Cond,
1563 IVStrideUse* &CondUse,
1564 const SCEVHandle* &CondStride) {
1565 if (StrideOrder.size() < 2 ||
1566 IVUsesByStride[*CondStride].Users.size() != 1)
1568 const SCEVConstant *SC = dyn_cast<SCEVConstant>(*CondStride);
1569 if (!SC) return Cond;
1570 ConstantInt *C = dyn_cast<ConstantInt>(Cond->getOperand(1));
1571 if (!C) return Cond;
1573 ICmpInst::Predicate Predicate = Cond->getPredicate();
1574 int64_t CmpSSInt = SC->getValue()->getSExtValue();
1575 int64_t CmpVal = C->getValue().getSExtValue();
1576 unsigned BitWidth = C->getValue().getBitWidth();
1577 uint64_t SignBit = 1ULL << (BitWidth-1);
1578 const Type *CmpTy = C->getType();
1579 const Type *NewCmpTy = NULL;
1580 unsigned TyBits = CmpTy->getPrimitiveSizeInBits();
1581 unsigned NewTyBits = 0;
1582 int64_t NewCmpVal = CmpVal;
1583 SCEVHandle *NewStride = NULL;
1584 Value *NewIncV = NULL;
1587 // Check stride constant and the comparision constant signs to detect
1589 if ((CmpVal & SignBit) != (CmpSSInt & SignBit))
1592 // Look for a suitable stride / iv as replacement.
1593 std::stable_sort(StrideOrder.begin(), StrideOrder.end(), StrideCompare());
1594 for (unsigned i = 0, e = StrideOrder.size(); i != e; ++i) {
1595 std::map<SCEVHandle, IVUsersOfOneStride>::iterator SI =
1596 IVUsesByStride.find(StrideOrder[i]);
1597 if (!isa<SCEVConstant>(SI->first))
1599 int64_t SSInt = cast<SCEVConstant>(SI->first)->getValue()->getSExtValue();
1600 if (abs(SSInt) <= abs(CmpSSInt) || (SSInt % CmpSSInt) != 0)
1603 Scale = SSInt / CmpSSInt;
1604 NewCmpVal = CmpVal * Scale;
1605 APInt Mul = APInt(BitWidth, NewCmpVal);
1606 // Check for overflow.
1607 if (Mul.getSExtValue() != NewCmpVal) {
1612 // Watch out for overflow.
1613 if (ICmpInst::isSignedPredicate(Predicate) &&
1614 (CmpVal & SignBit) != (NewCmpVal & SignBit))
1617 if (NewCmpVal != CmpVal) {
1618 // Pick the best iv to use trying to avoid a cast.
1620 for (std::vector<IVStrideUse>::iterator UI = SI->second.Users.begin(),
1621 E = SI->second.Users.end(); UI != E; ++UI) {
1622 NewIncV = UI->OperandValToReplace;
1623 if (NewIncV->getType() == CmpTy)
1631 NewCmpTy = NewIncV->getType();
1632 NewTyBits = isa<PointerType>(NewCmpTy)
1633 ? UIntPtrTy->getPrimitiveSizeInBits()
1634 : NewCmpTy->getPrimitiveSizeInBits();
1635 if (RequiresTypeConversion(NewCmpTy, CmpTy)) {
1636 // Check if it is possible to rewrite it using
1637 // an iv / stride of a smaller integer type.
1638 bool TruncOk = false;
1639 if (NewCmpTy->isInteger()) {
1640 unsigned Bits = NewTyBits;
1641 if (ICmpInst::isSignedPredicate(Predicate))
1643 uint64_t Mask = (1ULL << Bits) - 1;
1644 if (((uint64_t)NewCmpVal & Mask) == (uint64_t)NewCmpVal)
1653 // Don't rewrite if use offset is non-constant and the new type is
1654 // of a different type.
1655 // FIXME: too conservative?
1656 if (NewTyBits != TyBits && !isa<SCEVConstant>(CondUse->Offset)) {
1661 bool AllUsesAreAddresses = true;
1662 std::vector<BasedUser> UsersToProcess;
1663 SCEVHandle CommonExprs = CollectIVUsers(SI->first, SI->second, L,
1664 AllUsesAreAddresses,
1666 // Avoid rewriting the compare instruction with an iv of new stride
1667 // if it's likely the new stride uses will be rewritten using the
1668 if (AllUsesAreAddresses &&
1669 ValidStride(!CommonExprs->isZero(), Scale, UsersToProcess)) {
1674 // If scale is negative, use swapped predicate unless it's testing
1676 if (Scale < 0 && !Cond->isEquality())
1677 Predicate = ICmpInst::getSwappedPredicate(Predicate);
1679 NewStride = &StrideOrder[i];
1684 // Forgo this transformation if it the increment happens to be
1685 // unfortunately positioned after the condition, and the condition
1686 // has multiple uses which prevent it from being moved immediately
1687 // before the branch. See
1688 // test/Transforms/LoopStrengthReduce/change-compare-stride-trickiness-*.ll
1689 // for an example of this situation.
1690 if (!Cond->hasOneUse()) {
1691 for (BasicBlock::iterator I = Cond, E = Cond->getParent()->end();
1697 if (NewCmpVal != CmpVal) {
1698 // Create a new compare instruction using new stride / iv.
1699 ICmpInst *OldCond = Cond;
1701 if (!isa<PointerType>(NewCmpTy))
1702 RHS = ConstantInt::get(NewCmpTy, NewCmpVal);
1704 RHS = ConstantInt::get(UIntPtrTy, NewCmpVal);
1705 RHS = SCEVExpander::InsertCastOfTo(Instruction::IntToPtr, RHS, NewCmpTy);
1707 // Insert new compare instruction.
1708 Cond = new ICmpInst(Predicate, NewIncV, RHS,
1709 L->getHeader()->getName() + ".termcond",
1712 // Remove the old compare instruction. The old indvar is probably dead too.
1713 DeadInsts.push_back(cast<Instruction>(CondUse->OperandValToReplace));
1714 SE->deleteValueFromRecords(OldCond);
1715 OldCond->replaceAllUsesWith(Cond);
1716 OldCond->eraseFromParent();
1718 IVUsesByStride[*CondStride].Users.pop_back();
1719 SCEVHandle NewOffset = TyBits == NewTyBits
1720 ? SE->getMulExpr(CondUse->Offset,
1721 SE->getConstant(ConstantInt::get(CmpTy, Scale)))
1722 : SE->getConstant(ConstantInt::get(NewCmpTy,
1723 cast<SCEVConstant>(CondUse->Offset)->getValue()->getSExtValue()*Scale));
1724 IVUsesByStride[*NewStride].addUser(NewOffset, Cond, NewIncV);
1725 CondUse = &IVUsesByStride[*NewStride].Users.back();
1726 CondStride = NewStride;
1733 /// OptimizeSMax - Rewrite the loop's terminating condition if it uses
1734 /// an smax computation.
1736 /// This is a narrow solution to a specific, but acute, problem. For loops
1742 /// } while (++i < n);
1744 /// where the comparison is signed, the trip count isn't just 'n', because
1745 /// 'n' could be negative. And unfortunately this can come up even for loops
1746 /// where the user didn't use a C do-while loop. For example, seemingly
1747 /// well-behaved top-test loops will commonly be lowered like this:
1753 /// } while (++i < n);
1756 /// and then it's possible for subsequent optimization to obscure the if
1757 /// test in such a way that indvars can't find it.
1759 /// When indvars can't find the if test in loops like this, it creates a
1760 /// signed-max expression, which allows it to give the loop a canonical
1761 /// induction variable:
1764 /// smax = n < 1 ? 1 : n;
1767 /// } while (++i != smax);
1769 /// Canonical induction variables are necessary because the loop passes
1770 /// are designed around them. The most obvious example of this is the
1771 /// LoopInfo analysis, which doesn't remember trip count values. It
1772 /// expects to be able to rediscover the trip count each time it is
1773 /// needed, and it does this using a simple analyis that only succeeds if
1774 /// the loop has a canonical induction variable.
1776 /// However, when it comes time to generate code, the maximum operation
1777 /// can be quite costly, especially if it's inside of an outer loop.
1779 /// This function solves this problem by detecting this type of loop and
1780 /// rewriting their conditions from ICMP_NE back to ICMP_SLT, and deleting
1781 /// the instructions for the maximum computation.
1783 ICmpInst *LoopStrengthReduce::OptimizeSMax(Loop *L, ICmpInst *Cond,
1784 IVStrideUse* &CondUse) {
1785 // Check that the loop matches the pattern we're looking for.
1786 if (Cond->getPredicate() != CmpInst::ICMP_EQ &&
1787 Cond->getPredicate() != CmpInst::ICMP_NE)
1790 SelectInst *Sel = dyn_cast<SelectInst>(Cond->getOperand(1));
1791 if (!Sel || !Sel->hasOneUse()) return Cond;
1793 SCEVHandle IterationCount = SE->getIterationCount(L);
1794 if (isa<SCEVCouldNotCompute>(IterationCount))
1796 SCEVHandle One = SE->getIntegerSCEV(1, IterationCount->getType());
1798 // Adjust for an annoying getIterationCount quirk.
1799 IterationCount = SE->getAddExpr(IterationCount, One);
1801 // Check for a max calculation that matches the pattern.
1802 SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(IterationCount);
1803 if (!SMax || SMax != SE->getSCEV(Sel)) return Cond;
1805 SCEVHandle SMaxLHS = SMax->getOperand(0);
1806 SCEVHandle SMaxRHS = SMax->getOperand(1);
1807 if (!SMaxLHS || SMaxLHS != One) return Cond;
1809 // Check the relevant induction variable for conformance to
1811 SCEVHandle IV = SE->getSCEV(Cond->getOperand(0));
1812 SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(IV);
1813 if (!AR || !AR->isAffine() ||
1814 AR->getStart() != One ||
1815 AR->getStepRecurrence(*SE) != One)
1818 // Check the right operand of the select, and remember it, as it will
1819 // be used in the new comparison instruction.
1821 if (SE->getSCEV(Sel->getOperand(1)) == SMaxRHS)
1822 NewRHS = Sel->getOperand(1);
1823 else if (SE->getSCEV(Sel->getOperand(2)) == SMaxRHS)
1824 NewRHS = Sel->getOperand(2);
1825 if (!NewRHS) return Cond;
1827 // Ok, everything looks ok to change the condition into an SLT or SGE and
1828 // delete the max calculation.
1830 new ICmpInst(Cond->getPredicate() == CmpInst::ICMP_NE ?
1833 Cond->getOperand(0), NewRHS, "scmp", Cond);
1835 // Delete the max calculation instructions.
1836 SE->deleteValueFromRecords(Cond);
1837 Cond->replaceAllUsesWith(NewCond);
1838 Cond->eraseFromParent();
1839 Instruction *Cmp = cast<Instruction>(Sel->getOperand(0));
1840 SE->deleteValueFromRecords(Sel);
1841 Sel->eraseFromParent();
1842 if (Cmp->use_empty()) {
1843 SE->deleteValueFromRecords(Cmp);
1844 Cmp->eraseFromParent();
1846 CondUse->User = NewCond;
1850 /// OptimizeShadowIV - If IV is used in a int-to-float cast
1851 /// inside the loop then try to eliminate the cast opeation.
1852 void LoopStrengthReduce::OptimizeShadowIV(Loop *L) {
1854 SCEVHandle IterationCount = SE->getIterationCount(L);
1855 if (isa<SCEVCouldNotCompute>(IterationCount))
1858 for (unsigned Stride = 0, e = StrideOrder.size(); Stride != e;
1860 std::map<SCEVHandle, IVUsersOfOneStride>::iterator SI =
1861 IVUsesByStride.find(StrideOrder[Stride]);
1862 assert(SI != IVUsesByStride.end() && "Stride doesn't exist!");
1863 if (!isa<SCEVConstant>(SI->first))
1866 for (std::vector<IVStrideUse>::iterator UI = SI->second.Users.begin(),
1867 E = SI->second.Users.end(); UI != E; /* empty */) {
1868 std::vector<IVStrideUse>::iterator CandidateUI = UI;
1870 Instruction *ShadowUse = CandidateUI->User;
1871 const Type *DestTy = NULL;
1873 /* If shadow use is a int->float cast then insert a second IV
1874 to eliminate this cast.
1876 for (unsigned i = 0; i < n; ++i)
1882 for (unsigned i = 0; i < n; ++i, ++d)
1885 if (UIToFPInst *UCast = dyn_cast<UIToFPInst>(CandidateUI->User))
1886 DestTy = UCast->getDestTy();
1887 else if (SIToFPInst *SCast = dyn_cast<SIToFPInst>(CandidateUI->User))
1888 DestTy = SCast->getDestTy();
1889 if (!DestTy) continue;
1892 /* If target does not support DestTy natively then do not apply
1893 this transformation. */
1894 MVT DVT = TLI->getValueType(DestTy);
1895 if (!TLI->isTypeLegal(DVT)) continue;
1898 PHINode *PH = dyn_cast<PHINode>(ShadowUse->getOperand(0));
1900 if (PH->getNumIncomingValues() != 2) continue;
1902 const Type *SrcTy = PH->getType();
1903 int Mantissa = DestTy->getFPMantissaWidth();
1904 if (Mantissa == -1) continue;
1905 if ((int)TD->getTypeSizeInBits(SrcTy) > Mantissa)
1908 unsigned Entry, Latch;
1909 if (PH->getIncomingBlock(0) == L->getLoopPreheader()) {
1917 ConstantInt *Init = dyn_cast<ConstantInt>(PH->getIncomingValue(Entry));
1918 if (!Init) continue;
1919 ConstantFP *NewInit = ConstantFP::get(DestTy, Init->getZExtValue());
1921 BinaryOperator *Incr =
1922 dyn_cast<BinaryOperator>(PH->getIncomingValue(Latch));
1923 if (!Incr) continue;
1924 if (Incr->getOpcode() != Instruction::Add
1925 && Incr->getOpcode() != Instruction::Sub)
1928 /* Initialize new IV, double d = 0.0 in above example. */
1929 ConstantInt *C = NULL;
1930 if (Incr->getOperand(0) == PH)
1931 C = dyn_cast<ConstantInt>(Incr->getOperand(1));
1932 else if (Incr->getOperand(1) == PH)
1933 C = dyn_cast<ConstantInt>(Incr->getOperand(0));
1939 /* Add new PHINode. */
1940 PHINode *NewPH = PHINode::Create(DestTy, "IV.S.", PH);
1942 /* create new increment. '++d' in above example. */
1943 ConstantFP *CFP = ConstantFP::get(DestTy, C->getZExtValue());
1944 BinaryOperator *NewIncr =
1945 BinaryOperator::Create(Incr->getOpcode(),
1946 NewPH, CFP, "IV.S.next.", Incr);
1948 NewPH->addIncoming(NewInit, PH->getIncomingBlock(Entry));
1949 NewPH->addIncoming(NewIncr, PH->getIncomingBlock(Latch));
1951 /* Remove cast operation */
1952 SE->deleteValueFromRecords(ShadowUse);
1953 ShadowUse->replaceAllUsesWith(NewPH);
1954 ShadowUse->eraseFromParent();
1955 SI->second.Users.erase(CandidateUI);
1962 // OptimizeIndvars - Now that IVUsesByStride is set up with all of the indvar
1963 // uses in the loop, look to see if we can eliminate some, in favor of using
1964 // common indvars for the different uses.
1965 void LoopStrengthReduce::OptimizeIndvars(Loop *L) {
1966 // TODO: implement optzns here.
1968 OptimizeShadowIV(L);
1970 // Finally, get the terminating condition for the loop if possible. If we
1971 // can, we want to change it to use a post-incremented version of its
1972 // induction variable, to allow coalescing the live ranges for the IV into
1973 // one register value.
1974 PHINode *SomePHI = cast<PHINode>(L->getHeader()->begin());
1975 BasicBlock *Preheader = L->getLoopPreheader();
1976 BasicBlock *LatchBlock =
1977 SomePHI->getIncomingBlock(SomePHI->getIncomingBlock(0) == Preheader);
1978 BranchInst *TermBr = dyn_cast<BranchInst>(LatchBlock->getTerminator());
1979 if (!TermBr || TermBr->isUnconditional() ||
1980 !isa<ICmpInst>(TermBr->getCondition()))
1982 ICmpInst *Cond = cast<ICmpInst>(TermBr->getCondition());
1984 // Search IVUsesByStride to find Cond's IVUse if there is one.
1985 IVStrideUse *CondUse = 0;
1986 const SCEVHandle *CondStride = 0;
1988 if (!FindIVUserForCond(Cond, CondUse, CondStride))
1989 return; // setcc doesn't use the IV.
1991 // If the trip count is computed in terms of an smax (due to ScalarEvolution
1992 // being unable to find a sufficient guard, for example), change the loop
1993 // comparison to use SLT instead of NE.
1994 Cond = OptimizeSMax(L, Cond, CondUse);
1996 // If possible, change stride and operands of the compare instruction to
1997 // eliminate one stride.
1998 Cond = ChangeCompareStride(L, Cond, CondUse, CondStride);
2000 // It's possible for the setcc instruction to be anywhere in the loop, and
2001 // possible for it to have multiple users. If it is not immediately before
2002 // the latch block branch, move it.
2003 if (&*++BasicBlock::iterator(Cond) != (Instruction*)TermBr) {
2004 if (Cond->hasOneUse()) { // Condition has a single use, just move it.
2005 Cond->moveBefore(TermBr);
2007 // Otherwise, clone the terminating condition and insert into the loopend.
2008 Cond = cast<ICmpInst>(Cond->clone());
2009 Cond->setName(L->getHeader()->getName() + ".termcond");
2010 LatchBlock->getInstList().insert(TermBr, Cond);
2012 // Clone the IVUse, as the old use still exists!
2013 IVUsesByStride[*CondStride].addUser(CondUse->Offset, Cond,
2014 CondUse->OperandValToReplace);
2015 CondUse = &IVUsesByStride[*CondStride].Users.back();
2019 // If we get to here, we know that we can transform the setcc instruction to
2020 // use the post-incremented version of the IV, allowing us to coalesce the
2021 // live ranges for the IV correctly.
2022 CondUse->Offset = SE->getMinusSCEV(CondUse->Offset, *CondStride);
2023 CondUse->isUseOfPostIncrementedValue = true;
2027 bool LoopStrengthReduce::runOnLoop(Loop *L, LPPassManager &LPM) {
2029 LI = &getAnalysis<LoopInfo>();
2030 DT = &getAnalysis<DominatorTree>();
2031 SE = &getAnalysis<ScalarEvolution>();
2032 TD = &getAnalysis<TargetData>();
2033 UIntPtrTy = TD->getIntPtrType();
2036 // Find all uses of induction variables in this loop, and catagorize
2037 // them by stride. Start by finding all of the PHI nodes in the header for
2038 // this loop. If they are induction variables, inspect their uses.
2039 SmallPtrSet<Instruction*,16> Processed; // Don't reprocess instructions.
2040 for (BasicBlock::iterator I = L->getHeader()->begin(); isa<PHINode>(I); ++I)
2041 AddUsersIfInteresting(I, L, Processed);
2043 if (!IVUsesByStride.empty()) {
2044 // Optimize induction variables. Some indvar uses can be transformed to use
2045 // strides that will be needed for other purposes. A common example of this
2046 // is the exit test for the loop, which can often be rewritten to use the
2047 // computation of some other indvar to decide when to terminate the loop.
2050 // FIXME: We can widen subreg IV's here for RISC targets. e.g. instead of
2051 // doing computation in byte values, promote to 32-bit values if safe.
2053 // FIXME: Attempt to reuse values across multiple IV's. In particular, we
2054 // could have something like "for(i) { foo(i*8); bar(i*16) }", which should
2055 // be codegened as "for (j = 0;; j+=8) { foo(j); bar(j+j); }" on X86/PPC.
2056 // Need to be careful that IV's are all the same type. Only works for
2057 // intptr_t indvars.
2059 // If we only have one stride, we can more aggressively eliminate some
2061 bool HasOneStride = IVUsesByStride.size() == 1;
2064 DOUT << "\nLSR on ";
2068 // IVsByStride keeps IVs for one particular loop.
2069 assert(IVsByStride.empty() && "Stale entries in IVsByStride?");
2071 // Sort the StrideOrder so we process larger strides first.
2072 std::stable_sort(StrideOrder.begin(), StrideOrder.end(), StrideCompare());
2074 // Note: this processes each stride/type pair individually. All users
2075 // passed into StrengthReduceStridedIVUsers have the same type AND stride.
2076 // Also, note that we iterate over IVUsesByStride indirectly by using
2077 // StrideOrder. This extra layer of indirection makes the ordering of
2078 // strides deterministic - not dependent on map order.
2079 for (unsigned Stride = 0, e = StrideOrder.size(); Stride != e; ++Stride) {
2080 std::map<SCEVHandle, IVUsersOfOneStride>::iterator SI =
2081 IVUsesByStride.find(StrideOrder[Stride]);
2082 assert(SI != IVUsesByStride.end() && "Stride doesn't exist!");
2083 StrengthReduceStridedIVUsers(SI->first, SI->second, L, HasOneStride);
2087 // We're done analyzing this loop; release all the state we built up for it.
2088 CastedPointers.clear();
2089 IVUsesByStride.clear();
2090 IVsByStride.clear();
2091 StrideOrder.clear();
2093 // Clean up after ourselves
2094 if (!DeadInsts.empty()) {
2095 DeleteTriviallyDeadInstructions();
2097 BasicBlock::iterator I = L->getHeader()->begin();
2098 while (PHINode *PN = dyn_cast<PHINode>(I++)) {
2099 // At this point, we know that we have killed one or more IV users.
2100 // It is worth checking to see if the cannonical indvar is also
2101 // dead, so that we can remove it as well.
2103 // We can remove a PHI if it is on a cycle in the def-use graph
2104 // where each node in the cycle has degree one, i.e. only one use,
2105 // and is an instruction with no side effects.
2107 // FIXME: this needs to eliminate an induction variable even if it's being
2108 // compared against some value to decide loop termination.
2109 if (!PN->hasOneUse())
2112 SmallPtrSet<PHINode *, 4> PHIs;
2113 for (Instruction *J = dyn_cast<Instruction>(*PN->use_begin());
2114 J && J->hasOneUse() && !J->mayWriteToMemory();
2115 J = dyn_cast<Instruction>(*J->use_begin())) {
2116 // If we find the original PHI, we've discovered a cycle.
2118 // Break the cycle and mark the PHI for deletion.
2119 SE->deleteValueFromRecords(PN);
2120 PN->replaceAllUsesWith(UndefValue::get(PN->getType()));
2121 DeadInsts.push_back(PN);
2125 // If we find a PHI more than once, we're on a cycle that
2126 // won't prove fruitful.
2127 if (isa<PHINode>(J) && !PHIs.insert(cast<PHINode>(J)))
2131 DeleteTriviallyDeadInstructions();