1 //===- LoopStrengthReduce.cpp - Strength Reduce IVs 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 transformation analyzes and transforms the induction variables (and
11 // computations derived from them) into forms suitable for efficient execution
14 // This pass performs a strength reduction on array references inside loops that
15 // have as one or more of their components the loop induction variable, it
16 // rewrites expressions to take advantage of scaled-index addressing modes
17 // available on the target, and it performs a variety of other optimizations
18 // related to loop induction variables.
20 //===----------------------------------------------------------------------===//
22 #define DEBUG_TYPE "loop-reduce"
23 #include "llvm/Transforms/Scalar.h"
24 #include "llvm/Constants.h"
25 #include "llvm/Instructions.h"
26 #include "llvm/IntrinsicInst.h"
27 #include "llvm/Type.h"
28 #include "llvm/DerivedTypes.h"
29 #include "llvm/Analysis/Dominators.h"
30 #include "llvm/Analysis/IVUsers.h"
31 #include "llvm/Analysis/LoopInfo.h"
32 #include "llvm/Analysis/LoopPass.h"
33 #include "llvm/Analysis/ScalarEvolutionExpander.h"
34 #include "llvm/Transforms/Utils/AddrModeMatcher.h"
35 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
36 #include "llvm/Transforms/Utils/Local.h"
37 #include "llvm/ADT/Statistic.h"
38 #include "llvm/Support/CFG.h"
39 #include "llvm/Support/Debug.h"
40 #include "llvm/Support/Compiler.h"
41 #include "llvm/Support/CommandLine.h"
42 #include "llvm/Support/ValueHandle.h"
43 #include "llvm/Target/TargetLowering.h"
47 STATISTIC(NumReduced , "Number of IV uses strength reduced");
48 STATISTIC(NumInserted, "Number of PHIs inserted");
49 STATISTIC(NumVariable, "Number of PHIs with variable strides");
50 STATISTIC(NumEliminated, "Number of strides eliminated");
51 STATISTIC(NumShadow, "Number of Shadow IVs optimized");
52 STATISTIC(NumImmSunk, "Number of common expr immediates sunk into uses");
53 STATISTIC(NumLoopCond, "Number of loop terminating conds optimized");
55 static cl::opt<bool> EnableFullLSRMode("enable-full-lsr",
63 /// IVInfo - This structure keeps track of one IV expression inserted during
64 /// StrengthReduceStridedIVUsers. It contains the stride, the common base, as
65 /// well as the PHI node and increment value created for rewrite.
66 struct VISIBILITY_HIDDEN IVExpr {
71 IVExpr(const SCEV* const stride, const SCEV* const base, PHINode *phi)
72 : Stride(stride), Base(base), PHI(phi) {}
75 /// IVsOfOneStride - This structure keeps track of all IV expression inserted
76 /// during StrengthReduceStridedIVUsers for a particular stride of the IV.
77 struct VISIBILITY_HIDDEN IVsOfOneStride {
78 std::vector<IVExpr> IVs;
80 void addIV(const SCEV* const Stride, const SCEV* const Base, PHINode *PHI) {
81 IVs.push_back(IVExpr(Stride, Base, PHI));
85 class VISIBILITY_HIDDEN LoopStrengthReduce : public LoopPass {
92 /// IVsByStride - Keep track of all IVs that have been inserted for a
93 /// particular stride.
94 std::map<const SCEV*, IVsOfOneStride> IVsByStride;
96 /// StrideNoReuse - Keep track of all the strides whose ivs cannot be
97 /// reused (nor should they be rewritten to reuse other strides).
98 SmallSet<const SCEV*, 4> StrideNoReuse;
100 /// DeadInsts - Keep track of instructions we may have made dead, so that
101 /// we can remove them after we are done working.
102 SmallVector<WeakVH, 16> DeadInsts;
104 /// TLI - Keep a pointer of a TargetLowering to consult for determining
105 /// transformation profitability.
106 const TargetLowering *TLI;
109 static char ID; // Pass ID, replacement for typeid
110 explicit LoopStrengthReduce(const TargetLowering *tli = NULL) :
111 LoopPass(&ID), TLI(tli) {
114 bool runOnLoop(Loop *L, LPPassManager &LPM);
116 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
117 // We split critical edges, so we change the CFG. However, we do update
118 // many analyses if they are around.
119 AU.addPreservedID(LoopSimplifyID);
120 AU.addPreserved<LoopInfo>();
121 AU.addPreserved<DominanceFrontier>();
122 AU.addPreserved<DominatorTree>();
124 AU.addRequiredID(LoopSimplifyID);
125 AU.addRequired<LoopInfo>();
126 AU.addRequired<DominatorTree>();
127 AU.addRequired<ScalarEvolution>();
128 AU.addPreserved<ScalarEvolution>();
129 AU.addRequired<IVUsers>();
130 AU.addPreserved<IVUsers>();
134 ICmpInst *ChangeCompareStride(Loop *L, ICmpInst *Cond,
135 IVStrideUse* &CondUse,
136 const SCEV* const * &CondStride);
138 void OptimizeIndvars(Loop *L);
139 void OptimizeLoopCountIV(Loop *L);
140 void OptimizeLoopTermCond(Loop *L);
142 /// OptimizeShadowIV - If IV is used in a int-to-float cast
143 /// inside the loop then try to eliminate the cast opeation.
144 void OptimizeShadowIV(Loop *L);
146 /// OptimizeMax - Rewrite the loop's terminating condition
147 /// if it uses a max computation.
148 ICmpInst *OptimizeMax(Loop *L, ICmpInst *Cond,
149 IVStrideUse* &CondUse);
151 bool FindIVUserForCond(ICmpInst *Cond, IVStrideUse *&CondUse,
152 const SCEV* const * &CondStride);
153 bool RequiresTypeConversion(const Type *Ty, const Type *NewTy);
154 const SCEV* CheckForIVReuse(bool, bool, bool, const SCEV* const&,
155 IVExpr&, const Type*,
156 const std::vector<BasedUser>& UsersToProcess);
157 bool ValidScale(bool, int64_t,
158 const std::vector<BasedUser>& UsersToProcess);
159 bool ValidOffset(bool, int64_t, int64_t,
160 const std::vector<BasedUser>& UsersToProcess);
161 const SCEV* CollectIVUsers(const SCEV* const &Stride,
162 IVUsersOfOneStride &Uses,
164 bool &AllUsesAreAddresses,
165 bool &AllUsesAreOutsideLoop,
166 std::vector<BasedUser> &UsersToProcess);
167 bool ShouldUseFullStrengthReductionMode(
168 const std::vector<BasedUser> &UsersToProcess,
170 bool AllUsesAreAddresses,
172 void PrepareToStrengthReduceFully(
173 std::vector<BasedUser> &UsersToProcess,
175 const SCEV* CommonExprs,
177 SCEVExpander &PreheaderRewriter);
178 void PrepareToStrengthReduceFromSmallerStride(
179 std::vector<BasedUser> &UsersToProcess,
181 const IVExpr &ReuseIV,
182 Instruction *PreInsertPt);
183 void PrepareToStrengthReduceWithNewPhi(
184 std::vector<BasedUser> &UsersToProcess,
186 const SCEV* CommonExprs,
188 Instruction *IVIncInsertPt,
190 SCEVExpander &PreheaderRewriter);
191 void StrengthReduceStridedIVUsers(const SCEV* const &Stride,
192 IVUsersOfOneStride &Uses,
194 void DeleteTriviallyDeadInstructions();
198 char LoopStrengthReduce::ID = 0;
199 static RegisterPass<LoopStrengthReduce>
200 X("loop-reduce", "Loop Strength Reduction");
202 Pass *llvm::createLoopStrengthReducePass(const TargetLowering *TLI) {
203 return new LoopStrengthReduce(TLI);
206 /// DeleteTriviallyDeadInstructions - If any of the instructions is the
207 /// specified set are trivially dead, delete them and see if this makes any of
208 /// their operands subsequently dead.
209 void LoopStrengthReduce::DeleteTriviallyDeadInstructions() {
210 if (DeadInsts.empty()) return;
212 while (!DeadInsts.empty()) {
213 Instruction *I = dyn_cast_or_null<Instruction>(DeadInsts.back());
214 DeadInsts.pop_back();
216 if (I == 0 || !isInstructionTriviallyDead(I))
219 for (User::op_iterator OI = I->op_begin(), E = I->op_end(); OI != E; ++OI) {
220 if (Instruction *U = dyn_cast<Instruction>(*OI)) {
223 DeadInsts.push_back(U);
227 I->eraseFromParent();
232 /// containsAddRecFromDifferentLoop - Determine whether expression S involves a
233 /// subexpression that is an AddRec from a loop other than L. An outer loop
234 /// of L is OK, but not an inner loop nor a disjoint loop.
235 static bool containsAddRecFromDifferentLoop(const SCEV* S, Loop *L) {
236 // This is very common, put it first.
237 if (isa<SCEVConstant>(S))
239 if (const SCEVCommutativeExpr *AE = dyn_cast<SCEVCommutativeExpr>(S)) {
240 for (unsigned int i=0; i< AE->getNumOperands(); i++)
241 if (containsAddRecFromDifferentLoop(AE->getOperand(i), L))
245 if (const SCEVAddRecExpr *AE = dyn_cast<SCEVAddRecExpr>(S)) {
246 if (const Loop *newLoop = AE->getLoop()) {
249 // if newLoop is an outer loop of L, this is OK.
250 if (!LoopInfoBase<BasicBlock>::isNotAlreadyContainedIn(L, newLoop))
255 if (const SCEVUDivExpr *DE = dyn_cast<SCEVUDivExpr>(S))
256 return containsAddRecFromDifferentLoop(DE->getLHS(), L) ||
257 containsAddRecFromDifferentLoop(DE->getRHS(), L);
259 // SCEVSDivExpr has been backed out temporarily, but will be back; we'll
260 // need this when it is.
261 if (const SCEVSDivExpr *DE = dyn_cast<SCEVSDivExpr>(S))
262 return containsAddRecFromDifferentLoop(DE->getLHS(), L) ||
263 containsAddRecFromDifferentLoop(DE->getRHS(), L);
265 if (const SCEVCastExpr *CE = dyn_cast<SCEVCastExpr>(S))
266 return containsAddRecFromDifferentLoop(CE->getOperand(), L);
270 /// isAddressUse - Returns true if the specified instruction is using the
271 /// specified value as an address.
272 static bool isAddressUse(Instruction *Inst, Value *OperandVal) {
273 bool isAddress = isa<LoadInst>(Inst);
274 if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
275 if (SI->getOperand(1) == OperandVal)
277 } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
278 // Addressing modes can also be folded into prefetches and a variety
280 switch (II->getIntrinsicID()) {
282 case Intrinsic::prefetch:
283 case Intrinsic::x86_sse2_loadu_dq:
284 case Intrinsic::x86_sse2_loadu_pd:
285 case Intrinsic::x86_sse_loadu_ps:
286 case Intrinsic::x86_sse_storeu_ps:
287 case Intrinsic::x86_sse2_storeu_pd:
288 case Intrinsic::x86_sse2_storeu_dq:
289 case Intrinsic::x86_sse2_storel_dq:
290 if (II->getOperand(1) == OperandVal)
298 /// getAccessType - Return the type of the memory being accessed.
299 static const Type *getAccessType(const Instruction *Inst) {
300 const Type *AccessTy = Inst->getType();
301 if (const StoreInst *SI = dyn_cast<StoreInst>(Inst))
302 AccessTy = SI->getOperand(0)->getType();
303 else if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
304 // Addressing modes can also be folded into prefetches and a variety
306 switch (II->getIntrinsicID()) {
308 case Intrinsic::x86_sse_storeu_ps:
309 case Intrinsic::x86_sse2_storeu_pd:
310 case Intrinsic::x86_sse2_storeu_dq:
311 case Intrinsic::x86_sse2_storel_dq:
312 AccessTy = II->getOperand(1)->getType();
320 /// BasedUser - For a particular base value, keep information about how we've
321 /// partitioned the expression so far.
323 /// SE - The current ScalarEvolution object.
326 /// Base - The Base value for the PHI node that needs to be inserted for
327 /// this use. As the use is processed, information gets moved from this
328 /// field to the Imm field (below). BasedUser values are sorted by this
332 /// Inst - The instruction using the induction variable.
335 /// OperandValToReplace - The operand value of Inst to replace with the
337 Value *OperandValToReplace;
339 /// Imm - The immediate value that should be added to the base immediately
340 /// before Inst, because it will be folded into the imm field of the
341 /// instruction. This is also sometimes used for loop-variant values that
342 /// must be added inside the loop.
345 /// Phi - The induction variable that performs the striding that
346 /// should be used for this user.
349 // isUseOfPostIncrementedValue - True if this should use the
350 // post-incremented version of this IV, not the preincremented version.
351 // This can only be set in special cases, such as the terminating setcc
352 // instruction for a loop and uses outside the loop that are dominated by
354 bool isUseOfPostIncrementedValue;
356 BasedUser(IVStrideUse &IVSU, ScalarEvolution *se)
357 : SE(se), Base(IVSU.getOffset()), Inst(IVSU.getUser()),
358 OperandValToReplace(IVSU.getOperandValToReplace()),
359 Imm(SE->getIntegerSCEV(0, Base->getType())),
360 isUseOfPostIncrementedValue(IVSU.isUseOfPostIncrementedValue()) {}
362 // Once we rewrite the code to insert the new IVs we want, update the
363 // operands of Inst to use the new expression 'NewBase', with 'Imm' added
365 void RewriteInstructionToUseNewBase(const SCEV* const &NewBase,
366 Instruction *InsertPt,
367 SCEVExpander &Rewriter, Loop *L, Pass *P,
369 SmallVectorImpl<WeakVH> &DeadInsts);
371 Value *InsertCodeForBaseAtPosition(const SCEV* const &NewBase,
373 SCEVExpander &Rewriter,
374 Instruction *IP, Loop *L,
380 void BasedUser::dump() const {
381 cerr << " Base=" << *Base;
382 cerr << " Imm=" << *Imm;
383 cerr << " Inst: " << *Inst;
386 Value *BasedUser::InsertCodeForBaseAtPosition(const SCEV* const &NewBase,
388 SCEVExpander &Rewriter,
389 Instruction *IP, Loop *L,
391 // Figure out where we *really* want to insert this code. In particular, if
392 // the user is inside of a loop that is nested inside of L, we really don't
393 // want to insert this expression before the user, we'd rather pull it out as
394 // many loops as possible.
395 Instruction *BaseInsertPt = IP;
397 // Figure out the most-nested loop that IP is in.
398 Loop *InsertLoop = LI.getLoopFor(IP->getParent());
400 // If InsertLoop is not L, and InsertLoop is nested inside of L, figure out
401 // the preheader of the outer-most loop where NewBase is not loop invariant.
402 if (L->contains(IP->getParent()))
403 while (InsertLoop && NewBase->isLoopInvariant(InsertLoop)) {
404 BaseInsertPt = InsertLoop->getLoopPreheader()->getTerminator();
405 InsertLoop = InsertLoop->getParentLoop();
408 Value *Base = Rewriter.expandCodeFor(NewBase, 0, BaseInsertPt);
410 const SCEV* NewValSCEV = SE->getUnknown(Base);
412 // Always emit the immediate into the same block as the user.
413 NewValSCEV = SE->getAddExpr(NewValSCEV, Imm);
415 return Rewriter.expandCodeFor(NewValSCEV, Ty, IP);
419 // Once we rewrite the code to insert the new IVs we want, update the
420 // operands of Inst to use the new expression 'NewBase', with 'Imm' added
421 // to it. NewBasePt is the last instruction which contributes to the
422 // value of NewBase in the case that it's a diffferent instruction from
423 // the PHI that NewBase is computed from, or null otherwise.
425 void BasedUser::RewriteInstructionToUseNewBase(const SCEV* const &NewBase,
426 Instruction *NewBasePt,
427 SCEVExpander &Rewriter, Loop *L, Pass *P,
429 SmallVectorImpl<WeakVH> &DeadInsts) {
430 if (!isa<PHINode>(Inst)) {
431 // By default, insert code at the user instruction.
432 BasicBlock::iterator InsertPt = Inst;
434 // However, if the Operand is itself an instruction, the (potentially
435 // complex) inserted code may be shared by many users. Because of this, we
436 // want to emit code for the computation of the operand right before its old
437 // computation. This is usually safe, because we obviously used to use the
438 // computation when it was computed in its current block. However, in some
439 // cases (e.g. use of a post-incremented induction variable) the NewBase
440 // value will be pinned to live somewhere after the original computation.
441 // In this case, we have to back off.
443 // If this is a use outside the loop (which means after, since it is based
444 // on a loop indvar) we use the post-incremented value, so that we don't
445 // artificially make the preinc value live out the bottom of the loop.
446 if (!isUseOfPostIncrementedValue && L->contains(Inst->getParent())) {
447 if (NewBasePt && isa<PHINode>(OperandValToReplace)) {
448 InsertPt = NewBasePt;
450 } else if (Instruction *OpInst
451 = dyn_cast<Instruction>(OperandValToReplace)) {
453 while (isa<PHINode>(InsertPt)) ++InsertPt;
456 Value *NewVal = InsertCodeForBaseAtPosition(NewBase,
457 OperandValToReplace->getType(),
458 Rewriter, InsertPt, L, LI);
459 // Replace the use of the operand Value with the new Phi we just created.
460 Inst->replaceUsesOfWith(OperandValToReplace, NewVal);
462 DOUT << " Replacing with ";
463 DEBUG(WriteAsOperand(*DOUT, NewVal, /*PrintType=*/false));
464 DOUT << ", which has value " << *NewBase << " plus IMM " << *Imm << "\n";
468 // PHI nodes are more complex. We have to insert one copy of the NewBase+Imm
469 // expression into each operand block that uses it. Note that PHI nodes can
470 // have multiple entries for the same predecessor. We use a map to make sure
471 // that a PHI node only has a single Value* for each predecessor (which also
472 // prevents us from inserting duplicate code in some blocks).
473 DenseMap<BasicBlock*, Value*> InsertedCode;
474 PHINode *PN = cast<PHINode>(Inst);
475 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
476 if (PN->getIncomingValue(i) == OperandValToReplace) {
477 // If the original expression is outside the loop, put the replacement
478 // code in the same place as the original expression,
479 // which need not be an immediate predecessor of this PHI. This way we
480 // need only one copy of it even if it is referenced multiple times in
481 // the PHI. We don't do this when the original expression is inside the
482 // loop because multiple copies sometimes do useful sinking of code in
484 Instruction *OldLoc = dyn_cast<Instruction>(OperandValToReplace);
485 if (L->contains(OldLoc->getParent())) {
486 // If this is a critical edge, split the edge so that we do not insert
487 // the code on all predecessor/successor paths. We do this unless this
488 // is the canonical backedge for this loop, as this can make some
489 // inserted code be in an illegal position.
490 BasicBlock *PHIPred = PN->getIncomingBlock(i);
491 if (e != 1 && PHIPred->getTerminator()->getNumSuccessors() > 1 &&
492 (PN->getParent() != L->getHeader() || !L->contains(PHIPred))) {
494 // First step, split the critical edge.
495 SplitCriticalEdge(PHIPred, PN->getParent(), P, false);
497 // Next step: move the basic block. In particular, if the PHI node
498 // is outside of the loop, and PredTI is in the loop, we want to
499 // move the block to be immediately before the PHI block, not
500 // immediately after PredTI.
501 if (L->contains(PHIPred) && !L->contains(PN->getParent())) {
502 BasicBlock *NewBB = PN->getIncomingBlock(i);
503 NewBB->moveBefore(PN->getParent());
506 // Splitting the edge can reduce the number of PHI entries we have.
507 e = PN->getNumIncomingValues();
510 Value *&Code = InsertedCode[PN->getIncomingBlock(i)];
512 // Insert the code into the end of the predecessor block.
513 Instruction *InsertPt = (L->contains(OldLoc->getParent())) ?
514 PN->getIncomingBlock(i)->getTerminator() :
515 OldLoc->getParent()->getTerminator();
516 Code = InsertCodeForBaseAtPosition(NewBase, PN->getType(),
517 Rewriter, InsertPt, L, LI);
519 DOUT << " Changing PHI use to ";
520 DEBUG(WriteAsOperand(*DOUT, Code, /*PrintType=*/false));
521 DOUT << ", which has value " << *NewBase << " plus IMM " << *Imm << "\n";
524 // Replace the use of the operand Value with the new Phi we just created.
525 PN->setIncomingValue(i, Code);
530 // PHI node might have become a constant value after SplitCriticalEdge.
531 DeadInsts.push_back(Inst);
535 /// fitsInAddressMode - Return true if V can be subsumed within an addressing
536 /// mode, and does not need to be put in a register first.
537 static bool fitsInAddressMode(const SCEV* const &V, const Type *AccessTy,
538 const TargetLowering *TLI, bool HasBaseReg) {
539 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(V)) {
540 int64_t VC = SC->getValue()->getSExtValue();
542 TargetLowering::AddrMode AM;
544 AM.HasBaseReg = HasBaseReg;
545 return TLI->isLegalAddressingMode(AM, AccessTy);
547 // Defaults to PPC. PPC allows a sign-extended 16-bit immediate field.
548 return (VC > -(1 << 16) && VC < (1 << 16)-1);
552 if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V))
553 if (GlobalValue *GV = dyn_cast<GlobalValue>(SU->getValue())) {
555 TargetLowering::AddrMode AM;
557 AM.HasBaseReg = HasBaseReg;
558 return TLI->isLegalAddressingMode(AM, AccessTy);
560 // Default: assume global addresses are not legal.
567 /// MoveLoopVariantsToImmediateField - Move any subexpressions from Val that are
568 /// loop varying to the Imm operand.
569 static void MoveLoopVariantsToImmediateField(const SCEV* &Val, const SCEV* &Imm,
570 Loop *L, ScalarEvolution *SE) {
571 if (Val->isLoopInvariant(L)) return; // Nothing to do.
573 if (const SCEVAddExpr *SAE = dyn_cast<SCEVAddExpr>(Val)) {
574 SmallVector<const SCEV*, 4> NewOps;
575 NewOps.reserve(SAE->getNumOperands());
577 for (unsigned i = 0; i != SAE->getNumOperands(); ++i)
578 if (!SAE->getOperand(i)->isLoopInvariant(L)) {
579 // If this is a loop-variant expression, it must stay in the immediate
580 // field of the expression.
581 Imm = SE->getAddExpr(Imm, SAE->getOperand(i));
583 NewOps.push_back(SAE->getOperand(i));
587 Val = SE->getIntegerSCEV(0, Val->getType());
589 Val = SE->getAddExpr(NewOps);
590 } else if (const SCEVAddRecExpr *SARE = dyn_cast<SCEVAddRecExpr>(Val)) {
591 // Try to pull immediates out of the start value of nested addrec's.
592 const SCEV* Start = SARE->getStart();
593 MoveLoopVariantsToImmediateField(Start, Imm, L, SE);
595 SmallVector<const SCEV*, 4> Ops(SARE->op_begin(), SARE->op_end());
597 Val = SE->getAddRecExpr(Ops, SARE->getLoop());
599 // Otherwise, all of Val is variant, move the whole thing over.
600 Imm = SE->getAddExpr(Imm, Val);
601 Val = SE->getIntegerSCEV(0, Val->getType());
606 /// MoveImmediateValues - Look at Val, and pull out any additions of constants
607 /// that can fit into the immediate field of instructions in the target.
608 /// Accumulate these immediate values into the Imm value.
609 static void MoveImmediateValues(const TargetLowering *TLI,
610 const Type *AccessTy,
611 const SCEV* &Val, const SCEV* &Imm,
612 bool isAddress, Loop *L,
613 ScalarEvolution *SE) {
614 if (const SCEVAddExpr *SAE = dyn_cast<SCEVAddExpr>(Val)) {
615 SmallVector<const SCEV*, 4> NewOps;
616 NewOps.reserve(SAE->getNumOperands());
618 for (unsigned i = 0; i != SAE->getNumOperands(); ++i) {
619 const SCEV* NewOp = SAE->getOperand(i);
620 MoveImmediateValues(TLI, AccessTy, NewOp, Imm, isAddress, L, SE);
622 if (!NewOp->isLoopInvariant(L)) {
623 // If this is a loop-variant expression, it must stay in the immediate
624 // field of the expression.
625 Imm = SE->getAddExpr(Imm, NewOp);
627 NewOps.push_back(NewOp);
632 Val = SE->getIntegerSCEV(0, Val->getType());
634 Val = SE->getAddExpr(NewOps);
636 } else if (const SCEVAddRecExpr *SARE = dyn_cast<SCEVAddRecExpr>(Val)) {
637 // Try to pull immediates out of the start value of nested addrec's.
638 const SCEV* Start = SARE->getStart();
639 MoveImmediateValues(TLI, AccessTy, Start, Imm, isAddress, L, SE);
641 if (Start != SARE->getStart()) {
642 SmallVector<const SCEV*, 4> Ops(SARE->op_begin(), SARE->op_end());
644 Val = SE->getAddRecExpr(Ops, SARE->getLoop());
647 } else if (const SCEVMulExpr *SME = dyn_cast<SCEVMulExpr>(Val)) {
648 // Transform "8 * (4 + v)" -> "32 + 8*V" if "32" fits in the immed field.
650 fitsInAddressMode(SME->getOperand(0), AccessTy, TLI, false) &&
651 SME->getNumOperands() == 2 && SME->isLoopInvariant(L)) {
653 const SCEV* SubImm = SE->getIntegerSCEV(0, Val->getType());
654 const SCEV* NewOp = SME->getOperand(1);
655 MoveImmediateValues(TLI, AccessTy, NewOp, SubImm, isAddress, L, SE);
657 // If we extracted something out of the subexpressions, see if we can
659 if (NewOp != SME->getOperand(1)) {
660 // Scale SubImm up by "8". If the result is a target constant, we are
662 SubImm = SE->getMulExpr(SubImm, SME->getOperand(0));
663 if (fitsInAddressMode(SubImm, AccessTy, TLI, false)) {
664 // Accumulate the immediate.
665 Imm = SE->getAddExpr(Imm, SubImm);
667 // Update what is left of 'Val'.
668 Val = SE->getMulExpr(SME->getOperand(0), NewOp);
675 // Loop-variant expressions must stay in the immediate field of the
677 if ((isAddress && fitsInAddressMode(Val, AccessTy, TLI, false)) ||
678 !Val->isLoopInvariant(L)) {
679 Imm = SE->getAddExpr(Imm, Val);
680 Val = SE->getIntegerSCEV(0, Val->getType());
684 // Otherwise, no immediates to move.
687 static void MoveImmediateValues(const TargetLowering *TLI,
689 const SCEV* &Val, const SCEV* &Imm,
690 bool isAddress, Loop *L,
691 ScalarEvolution *SE) {
692 const Type *AccessTy = getAccessType(User);
693 MoveImmediateValues(TLI, AccessTy, Val, Imm, isAddress, L, SE);
696 /// SeparateSubExprs - Decompose Expr into all of the subexpressions that are
697 /// added together. This is used to reassociate common addition subexprs
698 /// together for maximal sharing when rewriting bases.
699 static void SeparateSubExprs(SmallVector<const SCEV*, 16> &SubExprs,
701 ScalarEvolution *SE) {
702 if (const SCEVAddExpr *AE = dyn_cast<SCEVAddExpr>(Expr)) {
703 for (unsigned j = 0, e = AE->getNumOperands(); j != e; ++j)
704 SeparateSubExprs(SubExprs, AE->getOperand(j), SE);
705 } else if (const SCEVAddRecExpr *SARE = dyn_cast<SCEVAddRecExpr>(Expr)) {
706 const SCEV* Zero = SE->getIntegerSCEV(0, Expr->getType());
707 if (SARE->getOperand(0) == Zero) {
708 SubExprs.push_back(Expr);
710 // Compute the addrec with zero as its base.
711 SmallVector<const SCEV*, 4> Ops(SARE->op_begin(), SARE->op_end());
712 Ops[0] = Zero; // Start with zero base.
713 SubExprs.push_back(SE->getAddRecExpr(Ops, SARE->getLoop()));
716 SeparateSubExprs(SubExprs, SARE->getOperand(0), SE);
718 } else if (!Expr->isZero()) {
720 SubExprs.push_back(Expr);
724 // This is logically local to the following function, but C++ says we have
725 // to make it file scope.
726 struct SubExprUseData { unsigned Count; bool notAllUsesAreFree; };
728 /// RemoveCommonExpressionsFromUseBases - Look through all of the Bases of all
729 /// the Uses, removing any common subexpressions, except that if all such
730 /// subexpressions can be folded into an addressing mode for all uses inside
731 /// the loop (this case is referred to as "free" in comments herein) we do
732 /// not remove anything. This looks for things like (a+b+c) and
733 /// (a+c+d) and computes the common (a+c) subexpression. The common expression
734 /// is *removed* from the Bases and returned.
736 RemoveCommonExpressionsFromUseBases(std::vector<BasedUser> &Uses,
737 ScalarEvolution *SE, Loop *L,
738 const TargetLowering *TLI) {
739 unsigned NumUses = Uses.size();
741 // Only one use? This is a very common case, so we handle it specially and
743 const SCEV* Zero = SE->getIntegerSCEV(0, Uses[0].Base->getType());
744 const SCEV* Result = Zero;
745 const SCEV* FreeResult = Zero;
747 // If the use is inside the loop, use its base, regardless of what it is:
748 // it is clearly shared across all the IV's. If the use is outside the loop
749 // (which means after it) we don't want to factor anything *into* the loop,
750 // so just use 0 as the base.
751 if (L->contains(Uses[0].Inst->getParent()))
752 std::swap(Result, Uses[0].Base);
756 // To find common subexpressions, count how many of Uses use each expression.
757 // If any subexpressions are used Uses.size() times, they are common.
758 // Also track whether all uses of each expression can be moved into an
759 // an addressing mode "for free"; such expressions are left within the loop.
760 // struct SubExprUseData { unsigned Count; bool notAllUsesAreFree; };
761 std::map<const SCEV*, SubExprUseData> SubExpressionUseData;
763 // UniqueSubExprs - Keep track of all of the subexpressions we see in the
764 // order we see them.
765 SmallVector<const SCEV*, 16> UniqueSubExprs;
767 SmallVector<const SCEV*, 16> SubExprs;
768 unsigned NumUsesInsideLoop = 0;
769 for (unsigned i = 0; i != NumUses; ++i) {
770 // If the user is outside the loop, just ignore it for base computation.
771 // Since the user is outside the loop, it must be *after* the loop (if it
772 // were before, it could not be based on the loop IV). We don't want users
773 // after the loop to affect base computation of values *inside* the loop,
774 // because we can always add their offsets to the result IV after the loop
775 // is done, ensuring we get good code inside the loop.
776 if (!L->contains(Uses[i].Inst->getParent()))
780 // If the base is zero (which is common), return zero now, there are no
782 if (Uses[i].Base == Zero) return Zero;
784 // If this use is as an address we may be able to put CSEs in the addressing
785 // mode rather than hoisting them.
786 bool isAddrUse = isAddressUse(Uses[i].Inst, Uses[i].OperandValToReplace);
787 // We may need the AccessTy below, but only when isAddrUse, so compute it
788 // only in that case.
789 const Type *AccessTy = 0;
791 AccessTy = getAccessType(Uses[i].Inst);
793 // Split the expression into subexprs.
794 SeparateSubExprs(SubExprs, Uses[i].Base, SE);
795 // Add one to SubExpressionUseData.Count for each subexpr present, and
796 // if the subexpr is not a valid immediate within an addressing mode use,
797 // set SubExpressionUseData.notAllUsesAreFree. We definitely want to
798 // hoist these out of the loop (if they are common to all uses).
799 for (unsigned j = 0, e = SubExprs.size(); j != e; ++j) {
800 if (++SubExpressionUseData[SubExprs[j]].Count == 1)
801 UniqueSubExprs.push_back(SubExprs[j]);
802 if (!isAddrUse || !fitsInAddressMode(SubExprs[j], AccessTy, TLI, false))
803 SubExpressionUseData[SubExprs[j]].notAllUsesAreFree = true;
808 // Now that we know how many times each is used, build Result. Iterate over
809 // UniqueSubexprs so that we have a stable ordering.
810 for (unsigned i = 0, e = UniqueSubExprs.size(); i != e; ++i) {
811 std::map<const SCEV*, SubExprUseData>::iterator I =
812 SubExpressionUseData.find(UniqueSubExprs[i]);
813 assert(I != SubExpressionUseData.end() && "Entry not found?");
814 if (I->second.Count == NumUsesInsideLoop) { // Found CSE!
815 if (I->second.notAllUsesAreFree)
816 Result = SE->getAddExpr(Result, I->first);
818 FreeResult = SE->getAddExpr(FreeResult, I->first);
820 // Remove non-cse's from SubExpressionUseData.
821 SubExpressionUseData.erase(I);
824 if (FreeResult != Zero) {
825 // We have some subexpressions that can be subsumed into addressing
826 // modes in every use inside the loop. However, it's possible that
827 // there are so many of them that the combined FreeResult cannot
828 // be subsumed, or that the target cannot handle both a FreeResult
829 // and a Result in the same instruction (for example because it would
830 // require too many registers). Check this.
831 for (unsigned i=0; i<NumUses; ++i) {
832 if (!L->contains(Uses[i].Inst->getParent()))
834 // We know this is an addressing mode use; if there are any uses that
835 // are not, FreeResult would be Zero.
836 const Type *AccessTy = getAccessType(Uses[i].Inst);
837 if (!fitsInAddressMode(FreeResult, AccessTy, TLI, Result!=Zero)) {
838 // FIXME: could split up FreeResult into pieces here, some hoisted
839 // and some not. There is no obvious advantage to this.
840 Result = SE->getAddExpr(Result, FreeResult);
847 // If we found no CSE's, return now.
848 if (Result == Zero) return Result;
850 // If we still have a FreeResult, remove its subexpressions from
851 // SubExpressionUseData. This means they will remain in the use Bases.
852 if (FreeResult != Zero) {
853 SeparateSubExprs(SubExprs, FreeResult, SE);
854 for (unsigned j = 0, e = SubExprs.size(); j != e; ++j) {
855 std::map<const SCEV*, SubExprUseData>::iterator I =
856 SubExpressionUseData.find(SubExprs[j]);
857 SubExpressionUseData.erase(I);
862 // Otherwise, remove all of the CSE's we found from each of the base values.
863 for (unsigned i = 0; i != NumUses; ++i) {
864 // Uses outside the loop don't necessarily include the common base, but
865 // the final IV value coming into those uses does. Instead of trying to
866 // remove the pieces of the common base, which might not be there,
867 // subtract off the base to compensate for this.
868 if (!L->contains(Uses[i].Inst->getParent())) {
869 Uses[i].Base = SE->getMinusSCEV(Uses[i].Base, Result);
873 // Split the expression into subexprs.
874 SeparateSubExprs(SubExprs, Uses[i].Base, SE);
876 // Remove any common subexpressions.
877 for (unsigned j = 0, e = SubExprs.size(); j != e; ++j)
878 if (SubExpressionUseData.count(SubExprs[j])) {
879 SubExprs.erase(SubExprs.begin()+j);
883 // Finally, add the non-shared expressions together.
884 if (SubExprs.empty())
887 Uses[i].Base = SE->getAddExpr(SubExprs);
894 /// ValidScale - Check whether the given Scale is valid for all loads and
895 /// stores in UsersToProcess.
897 bool LoopStrengthReduce::ValidScale(bool HasBaseReg, int64_t Scale,
898 const std::vector<BasedUser>& UsersToProcess) {
902 for (unsigned i = 0, e = UsersToProcess.size(); i!=e; ++i) {
903 // If this is a load or other access, pass the type of the access in.
904 const Type *AccessTy = Type::VoidTy;
905 if (isAddressUse(UsersToProcess[i].Inst,
906 UsersToProcess[i].OperandValToReplace))
907 AccessTy = getAccessType(UsersToProcess[i].Inst);
908 else if (isa<PHINode>(UsersToProcess[i].Inst))
911 TargetLowering::AddrMode AM;
912 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(UsersToProcess[i].Imm))
913 AM.BaseOffs = SC->getValue()->getSExtValue();
914 AM.HasBaseReg = HasBaseReg || !UsersToProcess[i].Base->isZero();
917 // If load[imm+r*scale] is illegal, bail out.
918 if (!TLI->isLegalAddressingMode(AM, AccessTy))
924 /// ValidOffset - Check whether the given Offset is valid for all loads and
925 /// stores in UsersToProcess.
927 bool LoopStrengthReduce::ValidOffset(bool HasBaseReg,
930 const std::vector<BasedUser>& UsersToProcess) {
934 for (unsigned i=0, e = UsersToProcess.size(); i!=e; ++i) {
935 // If this is a load or other access, pass the type of the access in.
936 const Type *AccessTy = Type::VoidTy;
937 if (isAddressUse(UsersToProcess[i].Inst,
938 UsersToProcess[i].OperandValToReplace))
939 AccessTy = getAccessType(UsersToProcess[i].Inst);
940 else if (isa<PHINode>(UsersToProcess[i].Inst))
943 TargetLowering::AddrMode AM;
944 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(UsersToProcess[i].Imm))
945 AM.BaseOffs = SC->getValue()->getSExtValue();
946 AM.BaseOffs = (uint64_t)AM.BaseOffs + (uint64_t)Offset;
947 AM.HasBaseReg = HasBaseReg || !UsersToProcess[i].Base->isZero();
950 // If load[imm+r*scale] is illegal, bail out.
951 if (!TLI->isLegalAddressingMode(AM, AccessTy))
957 /// RequiresTypeConversion - Returns true if converting Ty1 to Ty2 is not
959 bool LoopStrengthReduce::RequiresTypeConversion(const Type *Ty1,
963 Ty1 = SE->getEffectiveSCEVType(Ty1);
964 Ty2 = SE->getEffectiveSCEVType(Ty2);
967 if (Ty1->canLosslesslyBitCastTo(Ty2))
969 if (TLI && TLI->isTruncateFree(Ty1, Ty2))
974 /// CheckForIVReuse - Returns the multiple if the stride is the multiple
975 /// of a previous stride and it is a legal value for the target addressing
976 /// mode scale component and optional base reg. This allows the users of
977 /// this stride to be rewritten as prev iv * factor. It returns 0 if no
978 /// reuse is possible. Factors can be negative on same targets, e.g. ARM.
980 /// If all uses are outside the loop, we don't require that all multiplies
981 /// be folded into the addressing mode, nor even that the factor be constant;
982 /// a multiply (executed once) outside the loop is better than another IV
983 /// within. Well, usually.
984 const SCEV* LoopStrengthReduce::CheckForIVReuse(bool HasBaseReg,
985 bool AllUsesAreAddresses,
986 bool AllUsesAreOutsideLoop,
987 const SCEV* const &Stride,
988 IVExpr &IV, const Type *Ty,
989 const std::vector<BasedUser>& UsersToProcess) {
990 if (StrideNoReuse.count(Stride))
991 return SE->getIntegerSCEV(0, Stride->getType());
993 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Stride)) {
994 int64_t SInt = SC->getValue()->getSExtValue();
995 for (unsigned NewStride = 0, e = IU->StrideOrder.size();
996 NewStride != e; ++NewStride) {
997 std::map<const SCEV*, IVsOfOneStride>::iterator SI =
998 IVsByStride.find(IU->StrideOrder[NewStride]);
999 if (SI == IVsByStride.end() || !isa<SCEVConstant>(SI->first) ||
1000 StrideNoReuse.count(SI->first))
1002 int64_t SSInt = cast<SCEVConstant>(SI->first)->getValue()->getSExtValue();
1003 if (SI->first != Stride &&
1004 (unsigned(abs64(SInt)) < SSInt || (SInt % SSInt) != 0))
1006 int64_t Scale = SInt / SSInt;
1007 // Check that this stride is valid for all the types used for loads and
1008 // stores; if it can be used for some and not others, we might as well use
1009 // the original stride everywhere, since we have to create the IV for it
1010 // anyway. If the scale is 1, then we don't need to worry about folding
1013 (AllUsesAreAddresses &&
1014 ValidScale(HasBaseReg, Scale, UsersToProcess))) {
1015 // Prefer to reuse an IV with a base of zero.
1016 for (std::vector<IVExpr>::iterator II = SI->second.IVs.begin(),
1017 IE = SI->second.IVs.end(); II != IE; ++II)
1018 // Only reuse previous IV if it would not require a type conversion
1019 // and if the base difference can be folded.
1020 if (II->Base->isZero() &&
1021 !RequiresTypeConversion(II->Base->getType(), Ty)) {
1023 return SE->getIntegerSCEV(Scale, Stride->getType());
1025 // Otherwise, settle for an IV with a foldable base.
1026 if (AllUsesAreAddresses)
1027 for (std::vector<IVExpr>::iterator II = SI->second.IVs.begin(),
1028 IE = SI->second.IVs.end(); II != IE; ++II)
1029 // Only reuse previous IV if it would not require a type conversion
1030 // and if the base difference can be folded.
1031 if (SE->getEffectiveSCEVType(II->Base->getType()) ==
1032 SE->getEffectiveSCEVType(Ty) &&
1033 isa<SCEVConstant>(II->Base)) {
1035 cast<SCEVConstant>(II->Base)->getValue()->getSExtValue();
1036 if (Base > INT32_MIN && Base <= INT32_MAX &&
1037 ValidOffset(HasBaseReg, -Base * Scale,
1038 Scale, UsersToProcess)) {
1040 return SE->getIntegerSCEV(Scale, Stride->getType());
1045 } else if (AllUsesAreOutsideLoop) {
1046 // Accept nonconstant strides here; it is really really right to substitute
1047 // an existing IV if we can.
1048 for (unsigned NewStride = 0, e = IU->StrideOrder.size();
1049 NewStride != e; ++NewStride) {
1050 std::map<const SCEV*, IVsOfOneStride>::iterator SI =
1051 IVsByStride.find(IU->StrideOrder[NewStride]);
1052 if (SI == IVsByStride.end() || !isa<SCEVConstant>(SI->first))
1054 int64_t SSInt = cast<SCEVConstant>(SI->first)->getValue()->getSExtValue();
1055 if (SI->first != Stride && SSInt != 1)
1057 for (std::vector<IVExpr>::iterator II = SI->second.IVs.begin(),
1058 IE = SI->second.IVs.end(); II != IE; ++II)
1059 // Accept nonzero base here.
1060 // Only reuse previous IV if it would not require a type conversion.
1061 if (!RequiresTypeConversion(II->Base->getType(), Ty)) {
1066 // Special case, old IV is -1*x and this one is x. Can treat this one as
1068 for (unsigned NewStride = 0, e = IU->StrideOrder.size();
1069 NewStride != e; ++NewStride) {
1070 std::map<const SCEV*, IVsOfOneStride>::iterator SI =
1071 IVsByStride.find(IU->StrideOrder[NewStride]);
1072 if (SI == IVsByStride.end())
1074 if (const SCEVMulExpr *ME = dyn_cast<SCEVMulExpr>(SI->first))
1075 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(ME->getOperand(0)))
1076 if (Stride == ME->getOperand(1) &&
1077 SC->getValue()->getSExtValue() == -1LL)
1078 for (std::vector<IVExpr>::iterator II = SI->second.IVs.begin(),
1079 IE = SI->second.IVs.end(); II != IE; ++II)
1080 // Accept nonzero base here.
1081 // Only reuse previous IV if it would not require type conversion.
1082 if (!RequiresTypeConversion(II->Base->getType(), Ty)) {
1084 return SE->getIntegerSCEV(-1LL, Stride->getType());
1088 return SE->getIntegerSCEV(0, Stride->getType());
1091 /// PartitionByIsUseOfPostIncrementedValue - Simple boolean predicate that
1092 /// returns true if Val's isUseOfPostIncrementedValue is true.
1093 static bool PartitionByIsUseOfPostIncrementedValue(const BasedUser &Val) {
1094 return Val.isUseOfPostIncrementedValue;
1097 /// isNonConstantNegative - Return true if the specified scev is negated, but
1099 static bool isNonConstantNegative(const SCEV* const &Expr) {
1100 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Expr);
1101 if (!Mul) return false;
1103 // If there is a constant factor, it will be first.
1104 const SCEVConstant *SC = dyn_cast<SCEVConstant>(Mul->getOperand(0));
1105 if (!SC) return false;
1107 // Return true if the value is negative, this matches things like (-42 * V).
1108 return SC->getValue()->getValue().isNegative();
1111 /// CollectIVUsers - Transform our list of users and offsets to a bit more
1112 /// complex table. In this new vector, each 'BasedUser' contains 'Base', the base
1113 /// of the strided accesses, as well as the old information from Uses. We
1114 /// progressively move information from the Base field to the Imm field, until
1115 /// we eventually have the full access expression to rewrite the use.
1116 const SCEV* LoopStrengthReduce::CollectIVUsers(const SCEV* const &Stride,
1117 IVUsersOfOneStride &Uses,
1119 bool &AllUsesAreAddresses,
1120 bool &AllUsesAreOutsideLoop,
1121 std::vector<BasedUser> &UsersToProcess) {
1122 // FIXME: Generalize to non-affine IV's.
1123 if (!Stride->isLoopInvariant(L))
1124 return SE->getIntegerSCEV(0, Stride->getType());
1126 UsersToProcess.reserve(Uses.Users.size());
1127 for (ilist<IVStrideUse>::iterator I = Uses.Users.begin(),
1128 E = Uses.Users.end(); I != E; ++I) {
1129 UsersToProcess.push_back(BasedUser(*I, SE));
1131 // Move any loop variant operands from the offset field to the immediate
1132 // field of the use, so that we don't try to use something before it is
1134 MoveLoopVariantsToImmediateField(UsersToProcess.back().Base,
1135 UsersToProcess.back().Imm, L, SE);
1136 assert(UsersToProcess.back().Base->isLoopInvariant(L) &&
1137 "Base value is not loop invariant!");
1140 // We now have a whole bunch of uses of like-strided induction variables, but
1141 // they might all have different bases. We want to emit one PHI node for this
1142 // stride which we fold as many common expressions (between the IVs) into as
1143 // possible. Start by identifying the common expressions in the base values
1144 // for the strides (e.g. if we have "A+C+B" and "A+B+D" as our bases, find
1145 // "A+B"), emit it to the preheader, then remove the expression from the
1146 // UsersToProcess base values.
1147 const SCEV* CommonExprs =
1148 RemoveCommonExpressionsFromUseBases(UsersToProcess, SE, L, TLI);
1150 // Next, figure out what we can represent in the immediate fields of
1151 // instructions. If we can represent anything there, move it to the imm
1152 // fields of the BasedUsers. We do this so that it increases the commonality
1153 // of the remaining uses.
1154 unsigned NumPHI = 0;
1155 bool HasAddress = false;
1156 for (unsigned i = 0, e = UsersToProcess.size(); i != e; ++i) {
1157 // If the user is not in the current loop, this means it is using the exit
1158 // value of the IV. Do not put anything in the base, make sure it's all in
1159 // the immediate field to allow as much factoring as possible.
1160 if (!L->contains(UsersToProcess[i].Inst->getParent())) {
1161 UsersToProcess[i].Imm = SE->getAddExpr(UsersToProcess[i].Imm,
1162 UsersToProcess[i].Base);
1163 UsersToProcess[i].Base =
1164 SE->getIntegerSCEV(0, UsersToProcess[i].Base->getType());
1166 // Not all uses are outside the loop.
1167 AllUsesAreOutsideLoop = false;
1169 // Addressing modes can be folded into loads and stores. Be careful that
1170 // the store is through the expression, not of the expression though.
1172 bool isAddress = isAddressUse(UsersToProcess[i].Inst,
1173 UsersToProcess[i].OperandValToReplace);
1174 if (isa<PHINode>(UsersToProcess[i].Inst)) {
1182 // If this use isn't an address, then not all uses are addresses.
1183 if (!isAddress && !isPHI)
1184 AllUsesAreAddresses = false;
1186 MoveImmediateValues(TLI, UsersToProcess[i].Inst, UsersToProcess[i].Base,
1187 UsersToProcess[i].Imm, isAddress, L, SE);
1191 // If one of the use is a PHI node and all other uses are addresses, still
1192 // allow iv reuse. Essentially we are trading one constant multiplication
1193 // for one fewer iv.
1195 AllUsesAreAddresses = false;
1197 // There are no in-loop address uses.
1198 if (AllUsesAreAddresses && (!HasAddress && !AllUsesAreOutsideLoop))
1199 AllUsesAreAddresses = false;
1204 /// ShouldUseFullStrengthReductionMode - Test whether full strength-reduction
1205 /// is valid and profitable for the given set of users of a stride. In
1206 /// full strength-reduction mode, all addresses at the current stride are
1207 /// strength-reduced all the way down to pointer arithmetic.
1209 bool LoopStrengthReduce::ShouldUseFullStrengthReductionMode(
1210 const std::vector<BasedUser> &UsersToProcess,
1212 bool AllUsesAreAddresses,
1213 const SCEV* Stride) {
1214 if (!EnableFullLSRMode)
1217 // The heuristics below aim to avoid increasing register pressure, but
1218 // fully strength-reducing all the addresses increases the number of
1219 // add instructions, so don't do this when optimizing for size.
1220 // TODO: If the loop is large, the savings due to simpler addresses
1221 // may oughtweight the costs of the extra increment instructions.
1222 if (L->getHeader()->getParent()->hasFnAttr(Attribute::OptimizeForSize))
1225 // TODO: For now, don't do full strength reduction if there could
1226 // potentially be greater-stride multiples of the current stride
1227 // which could reuse the current stride IV.
1228 if (IU->StrideOrder.back() != Stride)
1231 // Iterate through the uses to find conditions that automatically rule out
1233 for (unsigned i = 0, e = UsersToProcess.size(); i != e; ) {
1234 const SCEV *Base = UsersToProcess[i].Base;
1235 const SCEV *Imm = UsersToProcess[i].Imm;
1236 // If any users have a loop-variant component, they can't be fully
1237 // strength-reduced.
1238 if (Imm && !Imm->isLoopInvariant(L))
1240 // If there are to users with the same base and the difference between
1241 // the two Imm values can't be folded into the address, full
1242 // strength reduction would increase register pressure.
1244 const SCEV *CurImm = UsersToProcess[i].Imm;
1245 if ((CurImm || Imm) && CurImm != Imm) {
1246 if (!CurImm) CurImm = SE->getIntegerSCEV(0, Stride->getType());
1247 if (!Imm) Imm = SE->getIntegerSCEV(0, Stride->getType());
1248 const Instruction *Inst = UsersToProcess[i].Inst;
1249 const Type *AccessTy = getAccessType(Inst);
1250 const SCEV* Diff = SE->getMinusSCEV(UsersToProcess[i].Imm, Imm);
1251 if (!Diff->isZero() &&
1252 (!AllUsesAreAddresses ||
1253 !fitsInAddressMode(Diff, AccessTy, TLI, /*HasBaseReg=*/true)))
1256 } while (++i != e && Base == UsersToProcess[i].Base);
1259 // If there's exactly one user in this stride, fully strength-reducing it
1260 // won't increase register pressure. If it's starting from a non-zero base,
1261 // it'll be simpler this way.
1262 if (UsersToProcess.size() == 1 && !UsersToProcess[0].Base->isZero())
1265 // Otherwise, if there are any users in this stride that don't require
1266 // a register for their base, full strength-reduction will increase
1267 // register pressure.
1268 for (unsigned i = 0, e = UsersToProcess.size(); i != e; ++i)
1269 if (UsersToProcess[i].Base->isZero())
1272 // Otherwise, go for it.
1276 /// InsertAffinePhi Create and insert a PHI node for an induction variable
1277 /// with the specified start and step values in the specified loop.
1279 /// If NegateStride is true, the stride should be negated by using a
1280 /// subtract instead of an add.
1282 /// Return the created phi node.
1284 static PHINode *InsertAffinePhi(const SCEV* Start, const SCEV* Step,
1285 Instruction *IVIncInsertPt,
1287 SCEVExpander &Rewriter) {
1288 assert(Start->isLoopInvariant(L) && "New PHI start is not loop invariant!");
1289 assert(Step->isLoopInvariant(L) && "New PHI stride is not loop invariant!");
1291 BasicBlock *Header = L->getHeader();
1292 BasicBlock *Preheader = L->getLoopPreheader();
1293 BasicBlock *LatchBlock = L->getLoopLatch();
1294 const Type *Ty = Start->getType();
1295 Ty = Rewriter.SE.getEffectiveSCEVType(Ty);
1297 PHINode *PN = PHINode::Create(Ty, "lsr.iv", Header->begin());
1298 PN->addIncoming(Rewriter.expandCodeFor(Start, Ty, Preheader->getTerminator()),
1301 // If the stride is negative, insert a sub instead of an add for the
1303 bool isNegative = isNonConstantNegative(Step);
1304 const SCEV* IncAmount = Step;
1306 IncAmount = Rewriter.SE.getNegativeSCEV(Step);
1308 // Insert an add instruction right before the terminator corresponding
1309 // to the back-edge or just before the only use. The location is determined
1310 // by the caller and passed in as IVIncInsertPt.
1311 Value *StepV = Rewriter.expandCodeFor(IncAmount, Ty,
1312 Preheader->getTerminator());
1315 IncV = BinaryOperator::CreateSub(PN, StepV, "lsr.iv.next",
1318 IncV = BinaryOperator::CreateAdd(PN, StepV, "lsr.iv.next",
1321 if (!isa<ConstantInt>(StepV)) ++NumVariable;
1323 PN->addIncoming(IncV, LatchBlock);
1329 static void SortUsersToProcess(std::vector<BasedUser> &UsersToProcess) {
1330 // We want to emit code for users inside the loop first. To do this, we
1331 // rearrange BasedUser so that the entries at the end have
1332 // isUseOfPostIncrementedValue = false, because we pop off the end of the
1333 // vector (so we handle them first).
1334 std::partition(UsersToProcess.begin(), UsersToProcess.end(),
1335 PartitionByIsUseOfPostIncrementedValue);
1337 // Sort this by base, so that things with the same base are handled
1338 // together. By partitioning first and stable-sorting later, we are
1339 // guaranteed that within each base we will pop off users from within the
1340 // loop before users outside of the loop with a particular base.
1342 // We would like to use stable_sort here, but we can't. The problem is that
1343 // const SCEV*'s don't have a deterministic ordering w.r.t to each other, so
1344 // we don't have anything to do a '<' comparison on. Because we think the
1345 // number of uses is small, do a horrible bubble sort which just relies on
1347 for (unsigned i = 0, e = UsersToProcess.size(); i != e; ++i) {
1348 // Get a base value.
1349 const SCEV* Base = UsersToProcess[i].Base;
1351 // Compact everything with this base to be consecutive with this one.
1352 for (unsigned j = i+1; j != e; ++j) {
1353 if (UsersToProcess[j].Base == Base) {
1354 std::swap(UsersToProcess[i+1], UsersToProcess[j]);
1361 /// PrepareToStrengthReduceFully - Prepare to fully strength-reduce
1362 /// UsersToProcess, meaning lowering addresses all the way down to direct
1363 /// pointer arithmetic.
1366 LoopStrengthReduce::PrepareToStrengthReduceFully(
1367 std::vector<BasedUser> &UsersToProcess,
1369 const SCEV* CommonExprs,
1371 SCEVExpander &PreheaderRewriter) {
1372 DOUT << " Fully reducing all users\n";
1374 // Rewrite the UsersToProcess records, creating a separate PHI for each
1375 // unique Base value.
1376 Instruction *IVIncInsertPt = L->getLoopLatch()->getTerminator();
1377 for (unsigned i = 0, e = UsersToProcess.size(); i != e; ) {
1378 // TODO: The uses are grouped by base, but not sorted. We arbitrarily
1379 // pick the first Imm value here to start with, and adjust it for the
1381 const SCEV* Imm = UsersToProcess[i].Imm;
1382 const SCEV* Base = UsersToProcess[i].Base;
1383 const SCEV* Start = SE->getAddExpr(CommonExprs, Base, Imm);
1384 PHINode *Phi = InsertAffinePhi(Start, Stride, IVIncInsertPt, L,
1386 // Loop over all the users with the same base.
1388 UsersToProcess[i].Base = SE->getIntegerSCEV(0, Stride->getType());
1389 UsersToProcess[i].Imm = SE->getMinusSCEV(UsersToProcess[i].Imm, Imm);
1390 UsersToProcess[i].Phi = Phi;
1391 assert(UsersToProcess[i].Imm->isLoopInvariant(L) &&
1392 "ShouldUseFullStrengthReductionMode should reject this!");
1393 } while (++i != e && Base == UsersToProcess[i].Base);
1397 /// FindIVIncInsertPt - Return the location to insert the increment instruction.
1398 /// If the only use if a use of postinc value, (must be the loop termination
1399 /// condition), then insert it just before the use.
1400 static Instruction *FindIVIncInsertPt(std::vector<BasedUser> &UsersToProcess,
1402 if (UsersToProcess.size() == 1 &&
1403 UsersToProcess[0].isUseOfPostIncrementedValue &&
1404 L->contains(UsersToProcess[0].Inst->getParent()))
1405 return UsersToProcess[0].Inst;
1406 return L->getLoopLatch()->getTerminator();
1409 /// PrepareToStrengthReduceWithNewPhi - Insert a new induction variable for the
1410 /// given users to share.
1413 LoopStrengthReduce::PrepareToStrengthReduceWithNewPhi(
1414 std::vector<BasedUser> &UsersToProcess,
1416 const SCEV* CommonExprs,
1418 Instruction *IVIncInsertPt,
1420 SCEVExpander &PreheaderRewriter) {
1421 DOUT << " Inserting new PHI:\n";
1423 PHINode *Phi = InsertAffinePhi(SE->getUnknown(CommonBaseV),
1424 Stride, IVIncInsertPt, L,
1427 // Remember this in case a later stride is multiple of this.
1428 IVsByStride[Stride].addIV(Stride, CommonExprs, Phi);
1430 // All the users will share this new IV.
1431 for (unsigned i = 0, e = UsersToProcess.size(); i != e; ++i)
1432 UsersToProcess[i].Phi = Phi;
1435 DEBUG(WriteAsOperand(*DOUT, Phi, /*PrintType=*/false));
1439 /// PrepareToStrengthReduceFromSmallerStride - Prepare for the given users to
1440 /// reuse an induction variable with a stride that is a factor of the current
1441 /// induction variable.
1444 LoopStrengthReduce::PrepareToStrengthReduceFromSmallerStride(
1445 std::vector<BasedUser> &UsersToProcess,
1447 const IVExpr &ReuseIV,
1448 Instruction *PreInsertPt) {
1449 DOUT << " Rewriting in terms of existing IV of STRIDE " << *ReuseIV.Stride
1450 << " and BASE " << *ReuseIV.Base << "\n";
1452 // All the users will share the reused IV.
1453 for (unsigned i = 0, e = UsersToProcess.size(); i != e; ++i)
1454 UsersToProcess[i].Phi = ReuseIV.PHI;
1456 Constant *C = dyn_cast<Constant>(CommonBaseV);
1458 (!C->isNullValue() &&
1459 !fitsInAddressMode(SE->getUnknown(CommonBaseV), CommonBaseV->getType(),
1461 // We want the common base emitted into the preheader! This is just
1462 // using cast as a copy so BitCast (no-op cast) is appropriate
1463 CommonBaseV = new BitCastInst(CommonBaseV, CommonBaseV->getType(),
1464 "commonbase", PreInsertPt);
1467 static bool IsImmFoldedIntoAddrMode(GlobalValue *GV, int64_t Offset,
1468 const Type *AccessTy,
1469 std::vector<BasedUser> &UsersToProcess,
1470 const TargetLowering *TLI) {
1471 SmallVector<Instruction*, 16> AddrModeInsts;
1472 for (unsigned i = 0, e = UsersToProcess.size(); i != e; ++i) {
1473 if (UsersToProcess[i].isUseOfPostIncrementedValue)
1475 ExtAddrMode AddrMode =
1476 AddressingModeMatcher::Match(UsersToProcess[i].OperandValToReplace,
1477 AccessTy, UsersToProcess[i].Inst,
1478 AddrModeInsts, *TLI);
1479 if (GV && GV != AddrMode.BaseGV)
1481 if (Offset && !AddrMode.BaseOffs)
1482 // FIXME: How to accurate check it's immediate offset is folded.
1484 AddrModeInsts.clear();
1489 /// StrengthReduceStridedIVUsers - Strength reduce all of the users of a single
1490 /// stride of IV. All of the users may have different starting values, and this
1491 /// may not be the only stride.
1492 void LoopStrengthReduce::StrengthReduceStridedIVUsers(const SCEV* const &Stride,
1493 IVUsersOfOneStride &Uses,
1495 // If all the users are moved to another stride, then there is nothing to do.
1496 if (Uses.Users.empty())
1499 // Keep track if every use in UsersToProcess is an address. If they all are,
1500 // we may be able to rewrite the entire collection of them in terms of a
1501 // smaller-stride IV.
1502 bool AllUsesAreAddresses = true;
1504 // Keep track if every use of a single stride is outside the loop. If so,
1505 // we want to be more aggressive about reusing a smaller-stride IV; a
1506 // multiply outside the loop is better than another IV inside. Well, usually.
1507 bool AllUsesAreOutsideLoop = true;
1509 // Transform our list of users and offsets to a bit more complex table. In
1510 // this new vector, each 'BasedUser' contains 'Base' the base of the
1511 // strided accessas well as the old information from Uses. We progressively
1512 // move information from the Base field to the Imm field, until we eventually
1513 // have the full access expression to rewrite the use.
1514 std::vector<BasedUser> UsersToProcess;
1515 const SCEV* CommonExprs = CollectIVUsers(Stride, Uses, L, AllUsesAreAddresses,
1516 AllUsesAreOutsideLoop,
1519 // Sort the UsersToProcess array so that users with common bases are
1520 // next to each other.
1521 SortUsersToProcess(UsersToProcess);
1523 // If we managed to find some expressions in common, we'll need to carry
1524 // their value in a register and add it in for each use. This will take up
1525 // a register operand, which potentially restricts what stride values are
1527 bool HaveCommonExprs = !CommonExprs->isZero();
1528 const Type *ReplacedTy = CommonExprs->getType();
1530 // If all uses are addresses, consider sinking the immediate part of the
1531 // common expression back into uses if they can fit in the immediate fields.
1532 if (TLI && HaveCommonExprs && AllUsesAreAddresses) {
1533 const SCEV* NewCommon = CommonExprs;
1534 const SCEV* Imm = SE->getIntegerSCEV(0, ReplacedTy);
1535 MoveImmediateValues(TLI, Type::VoidTy, NewCommon, Imm, true, L, SE);
1536 if (!Imm->isZero()) {
1539 // If the immediate part of the common expression is a GV, check if it's
1540 // possible to fold it into the target addressing mode.
1541 GlobalValue *GV = 0;
1542 if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(Imm))
1543 GV = dyn_cast<GlobalValue>(SU->getValue());
1545 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Imm))
1546 Offset = SC->getValue()->getSExtValue();
1548 // Pass VoidTy as the AccessTy to be conservative, because
1549 // there could be multiple access types among all the uses.
1550 DoSink = IsImmFoldedIntoAddrMode(GV, Offset, Type::VoidTy,
1551 UsersToProcess, TLI);
1554 DOUT << " Sinking " << *Imm << " back down into uses\n";
1555 for (unsigned i = 0, e = UsersToProcess.size(); i != e; ++i)
1556 UsersToProcess[i].Imm = SE->getAddExpr(UsersToProcess[i].Imm, Imm);
1557 CommonExprs = NewCommon;
1558 HaveCommonExprs = !CommonExprs->isZero();
1564 // Now that we know what we need to do, insert the PHI node itself.
1566 DOUT << "LSR: Examining IVs of TYPE " << *ReplacedTy << " of STRIDE "
1568 << " Common base: " << *CommonExprs << "\n";
1570 SCEVExpander Rewriter(*SE);
1571 SCEVExpander PreheaderRewriter(*SE);
1573 BasicBlock *Preheader = L->getLoopPreheader();
1574 Instruction *PreInsertPt = Preheader->getTerminator();
1575 BasicBlock *LatchBlock = L->getLoopLatch();
1576 Instruction *IVIncInsertPt = LatchBlock->getTerminator();
1578 Value *CommonBaseV = Constant::getNullValue(ReplacedTy);
1580 const SCEV* RewriteFactor = SE->getIntegerSCEV(0, ReplacedTy);
1581 IVExpr ReuseIV(SE->getIntegerSCEV(0, Type::Int32Ty),
1582 SE->getIntegerSCEV(0, Type::Int32Ty),
1585 /// Choose a strength-reduction strategy and prepare for it by creating
1586 /// the necessary PHIs and adjusting the bookkeeping.
1587 if (ShouldUseFullStrengthReductionMode(UsersToProcess, L,
1588 AllUsesAreAddresses, Stride)) {
1589 PrepareToStrengthReduceFully(UsersToProcess, Stride, CommonExprs, L,
1592 // Emit the initial base value into the loop preheader.
1593 CommonBaseV = PreheaderRewriter.expandCodeFor(CommonExprs, ReplacedTy,
1596 // If all uses are addresses, check if it is possible to reuse an IV. The
1597 // new IV must have a stride that is a multiple of the old stride; the
1598 // multiple must be a number that can be encoded in the scale field of the
1599 // target addressing mode; and we must have a valid instruction after this
1600 // substitution, including the immediate field, if any.
1601 RewriteFactor = CheckForIVReuse(HaveCommonExprs, AllUsesAreAddresses,
1602 AllUsesAreOutsideLoop,
1603 Stride, ReuseIV, ReplacedTy,
1605 if (!RewriteFactor->isZero())
1606 PrepareToStrengthReduceFromSmallerStride(UsersToProcess, CommonBaseV,
1607 ReuseIV, PreInsertPt);
1609 IVIncInsertPt = FindIVIncInsertPt(UsersToProcess, L);
1610 PrepareToStrengthReduceWithNewPhi(UsersToProcess, Stride, CommonExprs,
1611 CommonBaseV, IVIncInsertPt,
1612 L, PreheaderRewriter);
1616 // Process all the users now, replacing their strided uses with
1617 // strength-reduced forms. This outer loop handles all bases, the inner
1618 // loop handles all users of a particular base.
1619 while (!UsersToProcess.empty()) {
1620 const SCEV* Base = UsersToProcess.back().Base;
1621 Instruction *Inst = UsersToProcess.back().Inst;
1623 // Emit the code for Base into the preheader.
1625 if (!Base->isZero()) {
1626 BaseV = PreheaderRewriter.expandCodeFor(Base, 0, PreInsertPt);
1628 DOUT << " INSERTING code for BASE = " << *Base << ":";
1629 if (BaseV->hasName())
1630 DOUT << " Result value name = %" << BaseV->getNameStr();
1633 // If BaseV is a non-zero constant, make sure that it gets inserted into
1634 // the preheader, instead of being forward substituted into the uses. We
1635 // do this by forcing a BitCast (noop cast) to be inserted into the
1636 // preheader in this case.
1637 if (!fitsInAddressMode(Base, getAccessType(Inst), TLI, false) &&
1638 !isa<Instruction>(BaseV)) {
1639 // We want this constant emitted into the preheader! This is just
1640 // using cast as a copy so BitCast (no-op cast) is appropriate
1641 BaseV = new BitCastInst(BaseV, BaseV->getType(), "preheaderinsert",
1646 // Emit the code to add the immediate offset to the Phi value, just before
1647 // the instructions that we identified as using this stride and base.
1649 // FIXME: Use emitted users to emit other users.
1650 BasedUser &User = UsersToProcess.back();
1652 DOUT << " Examining ";
1653 if (User.isUseOfPostIncrementedValue)
1658 DEBUG(WriteAsOperand(*DOUT, UsersToProcess.back().OperandValToReplace,
1659 /*PrintType=*/false));
1660 DOUT << " in Inst: " << *(User.Inst);
1662 // If this instruction wants to use the post-incremented value, move it
1663 // after the post-inc and use its value instead of the PHI.
1664 Value *RewriteOp = User.Phi;
1665 if (User.isUseOfPostIncrementedValue) {
1666 RewriteOp = User.Phi->getIncomingValueForBlock(LatchBlock);
1667 // If this user is in the loop, make sure it is the last thing in the
1668 // loop to ensure it is dominated by the increment. In case it's the
1669 // only use of the iv, the increment instruction is already before the
1671 if (L->contains(User.Inst->getParent()) && User.Inst != IVIncInsertPt)
1672 User.Inst->moveBefore(IVIncInsertPt);
1675 const SCEV* RewriteExpr = SE->getUnknown(RewriteOp);
1677 if (SE->getEffectiveSCEVType(RewriteOp->getType()) !=
1678 SE->getEffectiveSCEVType(ReplacedTy)) {
1679 assert(SE->getTypeSizeInBits(RewriteOp->getType()) >
1680 SE->getTypeSizeInBits(ReplacedTy) &&
1681 "Unexpected widening cast!");
1682 RewriteExpr = SE->getTruncateExpr(RewriteExpr, ReplacedTy);
1685 // If we had to insert new instructions for RewriteOp, we have to
1686 // consider that they may not have been able to end up immediately
1687 // next to RewriteOp, because non-PHI instructions may never precede
1688 // PHI instructions in a block. In this case, remember where the last
1689 // instruction was inserted so that if we're replacing a different
1690 // PHI node, we can use the later point to expand the final
1692 Instruction *NewBasePt = dyn_cast<Instruction>(RewriteOp);
1693 if (RewriteOp == User.Phi) NewBasePt = 0;
1695 // Clear the SCEVExpander's expression map so that we are guaranteed
1696 // to have the code emitted where we expect it.
1699 // If we are reusing the iv, then it must be multiplied by a constant
1700 // factor to take advantage of the addressing mode scale component.
1701 if (!RewriteFactor->isZero()) {
1702 // If we're reusing an IV with a nonzero base (currently this happens
1703 // only when all reuses are outside the loop) subtract that base here.
1704 // The base has been used to initialize the PHI node but we don't want
1706 if (!ReuseIV.Base->isZero()) {
1707 const SCEV* typedBase = ReuseIV.Base;
1708 if (SE->getEffectiveSCEVType(RewriteExpr->getType()) !=
1709 SE->getEffectiveSCEVType(ReuseIV.Base->getType())) {
1710 // It's possible the original IV is a larger type than the new IV,
1711 // in which case we have to truncate the Base. We checked in
1712 // RequiresTypeConversion that this is valid.
1713 assert(SE->getTypeSizeInBits(RewriteExpr->getType()) <
1714 SE->getTypeSizeInBits(ReuseIV.Base->getType()) &&
1715 "Unexpected lengthening conversion!");
1716 typedBase = SE->getTruncateExpr(ReuseIV.Base,
1717 RewriteExpr->getType());
1719 RewriteExpr = SE->getMinusSCEV(RewriteExpr, typedBase);
1722 // Multiply old variable, with base removed, by new scale factor.
1723 RewriteExpr = SE->getMulExpr(RewriteFactor,
1726 // The common base is emitted in the loop preheader. But since we
1727 // are reusing an IV, it has not been used to initialize the PHI node.
1728 // Add it to the expression used to rewrite the uses.
1729 // When this use is outside the loop, we earlier subtracted the
1730 // common base, and are adding it back here. Use the same expression
1731 // as before, rather than CommonBaseV, so DAGCombiner will zap it.
1732 if (!CommonExprs->isZero()) {
1733 if (L->contains(User.Inst->getParent()))
1734 RewriteExpr = SE->getAddExpr(RewriteExpr,
1735 SE->getUnknown(CommonBaseV));
1737 RewriteExpr = SE->getAddExpr(RewriteExpr, CommonExprs);
1741 // Now that we know what we need to do, insert code before User for the
1742 // immediate and any loop-variant expressions.
1744 // Add BaseV to the PHI value if needed.
1745 RewriteExpr = SE->getAddExpr(RewriteExpr, SE->getUnknown(BaseV));
1747 User.RewriteInstructionToUseNewBase(RewriteExpr, NewBasePt,
1748 Rewriter, L, this, *LI,
1751 // Mark old value we replaced as possibly dead, so that it is eliminated
1752 // if we just replaced the last use of that value.
1753 DeadInsts.push_back(User.OperandValToReplace);
1755 UsersToProcess.pop_back();
1758 // If there are any more users to process with the same base, process them
1759 // now. We sorted by base above, so we just have to check the last elt.
1760 } while (!UsersToProcess.empty() && UsersToProcess.back().Base == Base);
1761 // TODO: Next, find out which base index is the most common, pull it out.
1764 // IMPORTANT TODO: Figure out how to partition the IV's with this stride, but
1765 // different starting values, into different PHIs.
1768 /// FindIVUserForCond - If Cond has an operand that is an expression of an IV,
1769 /// set the IV user and stride information and return true, otherwise return
1771 bool LoopStrengthReduce::FindIVUserForCond(ICmpInst *Cond, IVStrideUse *&CondUse,
1772 const SCEV* const * &CondStride) {
1773 for (unsigned Stride = 0, e = IU->StrideOrder.size();
1774 Stride != e && !CondUse; ++Stride) {
1775 std::map<const SCEV*, IVUsersOfOneStride *>::iterator SI =
1776 IU->IVUsesByStride.find(IU->StrideOrder[Stride]);
1777 assert(SI != IU->IVUsesByStride.end() && "Stride doesn't exist!");
1779 for (ilist<IVStrideUse>::iterator UI = SI->second->Users.begin(),
1780 E = SI->second->Users.end(); UI != E; ++UI)
1781 if (UI->getUser() == Cond) {
1782 // NOTE: we could handle setcc instructions with multiple uses here, but
1783 // InstCombine does it as well for simple uses, it's not clear that it
1784 // occurs enough in real life to handle.
1786 CondStride = &SI->first;
1794 // Constant strides come first which in turns are sorted by their absolute
1795 // values. If absolute values are the same, then positive strides comes first.
1797 // 4, -1, X, 1, 2 ==> 1, -1, 2, 4, X
1798 struct StrideCompare {
1799 const ScalarEvolution *SE;
1800 explicit StrideCompare(const ScalarEvolution *se) : SE(se) {}
1802 bool operator()(const SCEV* const &LHS, const SCEV* const &RHS) {
1803 const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS);
1804 const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS);
1806 int64_t LV = LHSC->getValue()->getSExtValue();
1807 int64_t RV = RHSC->getValue()->getSExtValue();
1808 uint64_t ALV = (LV < 0) ? -LV : LV;
1809 uint64_t ARV = (RV < 0) ? -RV : RV;
1817 // If it's the same value but different type, sort by bit width so
1818 // that we emit larger induction variables before smaller
1819 // ones, letting the smaller be re-written in terms of larger ones.
1820 return SE->getTypeSizeInBits(RHS->getType()) <
1821 SE->getTypeSizeInBits(LHS->getType());
1823 return LHSC && !RHSC;
1828 /// ChangeCompareStride - If a loop termination compare instruction is the
1829 /// only use of its stride, and the compaison is against a constant value,
1830 /// try eliminate the stride by moving the compare instruction to another
1831 /// stride and change its constant operand accordingly. e.g.
1837 /// if (v2 < 10) goto loop
1842 /// if (v1 < 30) goto loop
1843 ICmpInst *LoopStrengthReduce::ChangeCompareStride(Loop *L, ICmpInst *Cond,
1844 IVStrideUse* &CondUse,
1845 const SCEV* const* &CondStride) {
1846 // If there's only one stride in the loop, there's nothing to do here.
1847 if (IU->StrideOrder.size() < 2)
1849 // If there are other users of the condition's stride, don't bother
1850 // trying to change the condition because the stride will still
1852 std::map<const SCEV*, IVUsersOfOneStride *>::iterator I =
1853 IU->IVUsesByStride.find(*CondStride);
1854 if (I == IU->IVUsesByStride.end() ||
1855 I->second->Users.size() != 1)
1857 // Only handle constant strides for now.
1858 const SCEVConstant *SC = dyn_cast<SCEVConstant>(*CondStride);
1859 if (!SC) return Cond;
1861 ICmpInst::Predicate Predicate = Cond->getPredicate();
1862 int64_t CmpSSInt = SC->getValue()->getSExtValue();
1863 unsigned BitWidth = SE->getTypeSizeInBits((*CondStride)->getType());
1864 uint64_t SignBit = 1ULL << (BitWidth-1);
1865 const Type *CmpTy = Cond->getOperand(0)->getType();
1866 const Type *NewCmpTy = NULL;
1867 unsigned TyBits = SE->getTypeSizeInBits(CmpTy);
1868 unsigned NewTyBits = 0;
1869 const SCEV* *NewStride = NULL;
1870 Value *NewCmpLHS = NULL;
1871 Value *NewCmpRHS = NULL;
1873 const SCEV* NewOffset = SE->getIntegerSCEV(0, CmpTy);
1875 if (ConstantInt *C = dyn_cast<ConstantInt>(Cond->getOperand(1))) {
1876 int64_t CmpVal = C->getValue().getSExtValue();
1878 // Check stride constant and the comparision constant signs to detect
1880 if ((CmpVal & SignBit) != (CmpSSInt & SignBit))
1883 // Look for a suitable stride / iv as replacement.
1884 for (unsigned i = 0, e = IU->StrideOrder.size(); i != e; ++i) {
1885 std::map<const SCEV*, IVUsersOfOneStride *>::iterator SI =
1886 IU->IVUsesByStride.find(IU->StrideOrder[i]);
1887 if (!isa<SCEVConstant>(SI->first))
1889 int64_t SSInt = cast<SCEVConstant>(SI->first)->getValue()->getSExtValue();
1890 if (SSInt == CmpSSInt ||
1891 abs64(SSInt) < abs64(CmpSSInt) ||
1892 (SSInt % CmpSSInt) != 0)
1895 Scale = SSInt / CmpSSInt;
1896 int64_t NewCmpVal = CmpVal * Scale;
1897 APInt Mul = APInt(BitWidth*2, CmpVal, true);
1898 Mul = Mul * APInt(BitWidth*2, Scale, true);
1899 // Check for overflow.
1900 if (!Mul.isSignedIntN(BitWidth))
1902 // Check for overflow in the stride's type too.
1903 if (!Mul.isSignedIntN(SE->getTypeSizeInBits(SI->first->getType())))
1906 // Watch out for overflow.
1907 if (ICmpInst::isSignedPredicate(Predicate) &&
1908 (CmpVal & SignBit) != (NewCmpVal & SignBit))
1911 if (NewCmpVal == CmpVal)
1913 // Pick the best iv to use trying to avoid a cast.
1915 for (ilist<IVStrideUse>::iterator UI = SI->second->Users.begin(),
1916 E = SI->second->Users.end(); UI != E; ++UI) {
1917 Value *Op = UI->getOperandValToReplace();
1919 // If the IVStrideUse implies a cast, check for an actual cast which
1920 // can be used to find the original IV expression.
1921 if (SE->getEffectiveSCEVType(Op->getType()) !=
1922 SE->getEffectiveSCEVType(SI->first->getType())) {
1923 CastInst *CI = dyn_cast<CastInst>(Op);
1924 // If it's not a simple cast, it's complicated.
1927 // If it's a cast from a type other than the stride type,
1928 // it's complicated.
1929 if (CI->getOperand(0)->getType() != SI->first->getType())
1931 // Ok, we found the IV expression in the stride's type.
1932 Op = CI->getOperand(0);
1936 if (NewCmpLHS->getType() == CmpTy)
1942 NewCmpTy = NewCmpLHS->getType();
1943 NewTyBits = SE->getTypeSizeInBits(NewCmpTy);
1944 const Type *NewCmpIntTy = IntegerType::get(NewTyBits);
1945 if (RequiresTypeConversion(NewCmpTy, CmpTy)) {
1946 // Check if it is possible to rewrite it using
1947 // an iv / stride of a smaller integer type.
1948 unsigned Bits = NewTyBits;
1949 if (ICmpInst::isSignedPredicate(Predicate))
1951 uint64_t Mask = (1ULL << Bits) - 1;
1952 if (((uint64_t)NewCmpVal & Mask) != (uint64_t)NewCmpVal)
1956 // Don't rewrite if use offset is non-constant and the new type is
1957 // of a different type.
1958 // FIXME: too conservative?
1959 if (NewTyBits != TyBits && !isa<SCEVConstant>(CondUse->getOffset()))
1962 bool AllUsesAreAddresses = true;
1963 bool AllUsesAreOutsideLoop = true;
1964 std::vector<BasedUser> UsersToProcess;
1965 const SCEV* CommonExprs = CollectIVUsers(SI->first, *SI->second, L,
1966 AllUsesAreAddresses,
1967 AllUsesAreOutsideLoop,
1969 // Avoid rewriting the compare instruction with an iv of new stride
1970 // if it's likely the new stride uses will be rewritten using the
1971 // stride of the compare instruction.
1972 if (AllUsesAreAddresses &&
1973 ValidScale(!CommonExprs->isZero(), Scale, UsersToProcess))
1976 // Avoid rewriting the compare instruction with an iv which has
1977 // implicit extension or truncation built into it.
1978 // TODO: This is over-conservative.
1979 if (SE->getTypeSizeInBits(CondUse->getOffset()->getType()) != TyBits)
1982 // If scale is negative, use swapped predicate unless it's testing
1984 if (Scale < 0 && !Cond->isEquality())
1985 Predicate = ICmpInst::getSwappedPredicate(Predicate);
1987 NewStride = &IU->StrideOrder[i];
1988 if (!isa<PointerType>(NewCmpTy))
1989 NewCmpRHS = ConstantInt::get(NewCmpTy, NewCmpVal);
1991 Constant *CI = ConstantInt::get(NewCmpIntTy, NewCmpVal);
1992 NewCmpRHS = ConstantExpr::getIntToPtr(CI, NewCmpTy);
1994 NewOffset = TyBits == NewTyBits
1995 ? SE->getMulExpr(CondUse->getOffset(),
1996 SE->getConstant(CmpTy, Scale))
1997 : SE->getConstant(NewCmpIntTy,
1998 cast<SCEVConstant>(CondUse->getOffset())->getValue()
1999 ->getSExtValue()*Scale);
2004 // Forgo this transformation if it the increment happens to be
2005 // unfortunately positioned after the condition, and the condition
2006 // has multiple uses which prevent it from being moved immediately
2007 // before the branch. See
2008 // test/Transforms/LoopStrengthReduce/change-compare-stride-trickiness-*.ll
2009 // for an example of this situation.
2010 if (!Cond->hasOneUse()) {
2011 for (BasicBlock::iterator I = Cond, E = Cond->getParent()->end();
2018 // Create a new compare instruction using new stride / iv.
2019 ICmpInst *OldCond = Cond;
2020 // Insert new compare instruction.
2021 Cond = new ICmpInst(Predicate, NewCmpLHS, NewCmpRHS,
2022 L->getHeader()->getName() + ".termcond",
2025 // Remove the old compare instruction. The old indvar is probably dead too.
2026 DeadInsts.push_back(CondUse->getOperandValToReplace());
2027 OldCond->replaceAllUsesWith(Cond);
2028 OldCond->eraseFromParent();
2030 IU->IVUsesByStride[*NewStride]->addUser(NewOffset, Cond, NewCmpLHS);
2031 CondUse = &IU->IVUsesByStride[*NewStride]->Users.back();
2032 CondStride = NewStride;
2040 /// OptimizeMax - Rewrite the loop's terminating condition if it uses
2041 /// a max computation.
2043 /// This is a narrow solution to a specific, but acute, problem. For loops
2049 /// } while (++i < n);
2051 /// the trip count isn't just 'n', because 'n' might not be positive. And
2052 /// unfortunately this can come up even for loops where the user didn't use
2053 /// a C do-while loop. For example, seemingly well-behaved top-test loops
2054 /// will commonly be lowered like this:
2060 /// } while (++i < n);
2063 /// and then it's possible for subsequent optimization to obscure the if
2064 /// test in such a way that indvars can't find it.
2066 /// When indvars can't find the if test in loops like this, it creates a
2067 /// max expression, which allows it to give the loop a canonical
2068 /// induction variable:
2071 /// max = n < 1 ? 1 : n;
2074 /// } while (++i != max);
2076 /// Canonical induction variables are necessary because the loop passes
2077 /// are designed around them. The most obvious example of this is the
2078 /// LoopInfo analysis, which doesn't remember trip count values. It
2079 /// expects to be able to rediscover the trip count each time it is
2080 /// needed, and it does this using a simple analyis that only succeeds if
2081 /// the loop has a canonical induction variable.
2083 /// However, when it comes time to generate code, the maximum operation
2084 /// can be quite costly, especially if it's inside of an outer loop.
2086 /// This function solves this problem by detecting this type of loop and
2087 /// rewriting their conditions from ICMP_NE back to ICMP_SLT, and deleting
2088 /// the instructions for the maximum computation.
2090 ICmpInst *LoopStrengthReduce::OptimizeMax(Loop *L, ICmpInst *Cond,
2091 IVStrideUse* &CondUse) {
2092 // Check that the loop matches the pattern we're looking for.
2093 if (Cond->getPredicate() != CmpInst::ICMP_EQ &&
2094 Cond->getPredicate() != CmpInst::ICMP_NE)
2097 SelectInst *Sel = dyn_cast<SelectInst>(Cond->getOperand(1));
2098 if (!Sel || !Sel->hasOneUse()) return Cond;
2100 const SCEV* BackedgeTakenCount = SE->getBackedgeTakenCount(L);
2101 if (isa<SCEVCouldNotCompute>(BackedgeTakenCount))
2103 const SCEV* One = SE->getIntegerSCEV(1, BackedgeTakenCount->getType());
2105 // Add one to the backedge-taken count to get the trip count.
2106 const SCEV* IterationCount = SE->getAddExpr(BackedgeTakenCount, One);
2108 // Check for a max calculation that matches the pattern.
2109 if (!isa<SCEVSMaxExpr>(IterationCount) && !isa<SCEVUMaxExpr>(IterationCount))
2111 const SCEVNAryExpr *Max = cast<SCEVNAryExpr>(IterationCount);
2112 if (Max != SE->getSCEV(Sel)) return Cond;
2114 // To handle a max with more than two operands, this optimization would
2115 // require additional checking and setup.
2116 if (Max->getNumOperands() != 2)
2119 const SCEV* MaxLHS = Max->getOperand(0);
2120 const SCEV* MaxRHS = Max->getOperand(1);
2121 if (!MaxLHS || MaxLHS != One) return Cond;
2123 // Check the relevant induction variable for conformance to
2125 const SCEV* IV = SE->getSCEV(Cond->getOperand(0));
2126 const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(IV);
2127 if (!AR || !AR->isAffine() ||
2128 AR->getStart() != One ||
2129 AR->getStepRecurrence(*SE) != One)
2132 assert(AR->getLoop() == L &&
2133 "Loop condition operand is an addrec in a different loop!");
2135 // Check the right operand of the select, and remember it, as it will
2136 // be used in the new comparison instruction.
2138 if (SE->getSCEV(Sel->getOperand(1)) == MaxRHS)
2139 NewRHS = Sel->getOperand(1);
2140 else if (SE->getSCEV(Sel->getOperand(2)) == MaxRHS)
2141 NewRHS = Sel->getOperand(2);
2142 if (!NewRHS) return Cond;
2144 // Determine the new comparison opcode. It may be signed or unsigned,
2145 // and the original comparison may be either equality or inequality.
2146 CmpInst::Predicate Pred =
2147 isa<SCEVSMaxExpr>(Max) ? CmpInst::ICMP_SLT : CmpInst::ICMP_ULT;
2148 if (Cond->getPredicate() == CmpInst::ICMP_EQ)
2149 Pred = CmpInst::getInversePredicate(Pred);
2151 // Ok, everything looks ok to change the condition into an SLT or SGE and
2152 // delete the max calculation.
2154 new ICmpInst(Pred, Cond->getOperand(0), NewRHS, "scmp", Cond);
2156 // Delete the max calculation instructions.
2157 Cond->replaceAllUsesWith(NewCond);
2158 CondUse->setUser(NewCond);
2159 Instruction *Cmp = cast<Instruction>(Sel->getOperand(0));
2160 Cond->eraseFromParent();
2161 Sel->eraseFromParent();
2162 if (Cmp->use_empty())
2163 Cmp->eraseFromParent();
2167 /// OptimizeShadowIV - If IV is used in a int-to-float cast
2168 /// inside the loop then try to eliminate the cast opeation.
2169 void LoopStrengthReduce::OptimizeShadowIV(Loop *L) {
2171 const SCEV* BackedgeTakenCount = SE->getBackedgeTakenCount(L);
2172 if (isa<SCEVCouldNotCompute>(BackedgeTakenCount))
2175 for (unsigned Stride = 0, e = IU->StrideOrder.size(); Stride != e;
2177 std::map<const SCEV*, IVUsersOfOneStride *>::iterator SI =
2178 IU->IVUsesByStride.find(IU->StrideOrder[Stride]);
2179 assert(SI != IU->IVUsesByStride.end() && "Stride doesn't exist!");
2180 if (!isa<SCEVConstant>(SI->first))
2183 for (ilist<IVStrideUse>::iterator UI = SI->second->Users.begin(),
2184 E = SI->second->Users.end(); UI != E; /* empty */) {
2185 ilist<IVStrideUse>::iterator CandidateUI = UI;
2187 Instruction *ShadowUse = CandidateUI->getUser();
2188 const Type *DestTy = NULL;
2190 /* If shadow use is a int->float cast then insert a second IV
2191 to eliminate this cast.
2193 for (unsigned i = 0; i < n; ++i)
2199 for (unsigned i = 0; i < n; ++i, ++d)
2202 if (UIToFPInst *UCast = dyn_cast<UIToFPInst>(CandidateUI->getUser()))
2203 DestTy = UCast->getDestTy();
2204 else if (SIToFPInst *SCast = dyn_cast<SIToFPInst>(CandidateUI->getUser()))
2205 DestTy = SCast->getDestTy();
2206 if (!DestTy) continue;
2209 // If target does not support DestTy natively then do not apply
2210 // this transformation.
2211 MVT DVT = TLI->getValueType(DestTy);
2212 if (!TLI->isTypeLegal(DVT)) continue;
2215 PHINode *PH = dyn_cast<PHINode>(ShadowUse->getOperand(0));
2217 if (PH->getNumIncomingValues() != 2) continue;
2219 const Type *SrcTy = PH->getType();
2220 int Mantissa = DestTy->getFPMantissaWidth();
2221 if (Mantissa == -1) continue;
2222 if ((int)SE->getTypeSizeInBits(SrcTy) > Mantissa)
2225 unsigned Entry, Latch;
2226 if (PH->getIncomingBlock(0) == L->getLoopPreheader()) {
2234 ConstantInt *Init = dyn_cast<ConstantInt>(PH->getIncomingValue(Entry));
2235 if (!Init) continue;
2236 Constant *NewInit = ConstantFP::get(DestTy, Init->getZExtValue());
2238 BinaryOperator *Incr =
2239 dyn_cast<BinaryOperator>(PH->getIncomingValue(Latch));
2240 if (!Incr) continue;
2241 if (Incr->getOpcode() != Instruction::Add
2242 && Incr->getOpcode() != Instruction::Sub)
2245 /* Initialize new IV, double d = 0.0 in above example. */
2246 ConstantInt *C = NULL;
2247 if (Incr->getOperand(0) == PH)
2248 C = dyn_cast<ConstantInt>(Incr->getOperand(1));
2249 else if (Incr->getOperand(1) == PH)
2250 C = dyn_cast<ConstantInt>(Incr->getOperand(0));
2256 /* Add new PHINode. */
2257 PHINode *NewPH = PHINode::Create(DestTy, "IV.S.", PH);
2259 /* create new increment. '++d' in above example. */
2260 Constant *CFP = ConstantFP::get(DestTy, C->getZExtValue());
2261 BinaryOperator *NewIncr =
2262 BinaryOperator::Create(Incr->getOpcode() == Instruction::Add ?
2263 Instruction::FAdd : Instruction::FSub,
2264 NewPH, CFP, "IV.S.next.", Incr);
2266 NewPH->addIncoming(NewInit, PH->getIncomingBlock(Entry));
2267 NewPH->addIncoming(NewIncr, PH->getIncomingBlock(Latch));
2269 /* Remove cast operation */
2270 ShadowUse->replaceAllUsesWith(NewPH);
2271 ShadowUse->eraseFromParent();
2278 /// OptimizeIndvars - Now that IVUsesByStride is set up with all of the indvar
2279 /// uses in the loop, look to see if we can eliminate some, in favor of using
2280 /// common indvars for the different uses.
2281 void LoopStrengthReduce::OptimizeIndvars(Loop *L) {
2282 // TODO: implement optzns here.
2284 OptimizeShadowIV(L);
2287 /// OptimizeLoopTermCond - Change loop terminating condition to use the
2288 /// postinc iv when possible.
2289 void LoopStrengthReduce::OptimizeLoopTermCond(Loop *L) {
2290 // Finally, get the terminating condition for the loop if possible. If we
2291 // can, we want to change it to use a post-incremented version of its
2292 // induction variable, to allow coalescing the live ranges for the IV into
2293 // one register value.
2294 BasicBlock *LatchBlock = L->getLoopLatch();
2295 BasicBlock *ExitingBlock = L->getExitingBlock();
2297 // Multiple exits, just look at the exit in the latch block if there is one.
2298 ExitingBlock = LatchBlock;
2299 BranchInst *TermBr = dyn_cast<BranchInst>(ExitingBlock->getTerminator());
2302 if (TermBr->isUnconditional() || !isa<ICmpInst>(TermBr->getCondition()))
2305 // Search IVUsesByStride to find Cond's IVUse if there is one.
2306 IVStrideUse *CondUse = 0;
2307 const SCEV* const *CondStride = 0;
2308 ICmpInst *Cond = cast<ICmpInst>(TermBr->getCondition());
2309 if (!FindIVUserForCond(Cond, CondUse, CondStride))
2310 return; // setcc doesn't use the IV.
2312 if (ExitingBlock != LatchBlock) {
2313 if (!Cond->hasOneUse())
2314 // See below, we don't want the condition to be cloned.
2317 // If exiting block is the latch block, we know it's safe and profitable to
2318 // transform the icmp to use post-inc iv. Otherwise do so only if it would
2319 // not reuse another iv and its iv would be reused by other uses. We are
2320 // optimizing for the case where the icmp is the only use of the iv.
2321 IVUsersOfOneStride &StrideUses = *IU->IVUsesByStride[*CondStride];
2322 for (ilist<IVStrideUse>::iterator I = StrideUses.Users.begin(),
2323 E = StrideUses.Users.end(); I != E; ++I) {
2324 if (I->getUser() == Cond)
2326 if (!I->isUseOfPostIncrementedValue())
2330 // FIXME: This is expensive, and worse still ChangeCompareStride does a
2331 // similar check. Can we perform all the icmp related transformations after
2332 // StrengthReduceStridedIVUsers?
2333 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(*CondStride)) {
2334 int64_t SInt = SC->getValue()->getSExtValue();
2335 for (unsigned NewStride = 0, ee = IU->StrideOrder.size(); NewStride != ee;
2337 std::map<const SCEV*, IVUsersOfOneStride *>::iterator SI =
2338 IU->IVUsesByStride.find(IU->StrideOrder[NewStride]);
2339 if (!isa<SCEVConstant>(SI->first) || SI->first == *CondStride)
2342 cast<SCEVConstant>(SI->first)->getValue()->getSExtValue();
2344 return; // This can definitely be reused.
2345 if (unsigned(abs64(SSInt)) < SInt || (SSInt % SInt) != 0)
2347 int64_t Scale = SSInt / SInt;
2348 bool AllUsesAreAddresses = true;
2349 bool AllUsesAreOutsideLoop = true;
2350 std::vector<BasedUser> UsersToProcess;
2351 const SCEV* CommonExprs = CollectIVUsers(SI->first, *SI->second, L,
2352 AllUsesAreAddresses,
2353 AllUsesAreOutsideLoop,
2355 // Avoid rewriting the compare instruction with an iv of new stride
2356 // if it's likely the new stride uses will be rewritten using the
2357 // stride of the compare instruction.
2358 if (AllUsesAreAddresses &&
2359 ValidScale(!CommonExprs->isZero(), Scale, UsersToProcess))
2364 StrideNoReuse.insert(*CondStride);
2367 // If the trip count is computed in terms of a max (due to ScalarEvolution
2368 // being unable to find a sufficient guard, for example), change the loop
2369 // comparison to use SLT or ULT instead of NE.
2370 Cond = OptimizeMax(L, Cond, CondUse);
2372 // If possible, change stride and operands of the compare instruction to
2373 // eliminate one stride.
2374 if (ExitingBlock == LatchBlock)
2375 Cond = ChangeCompareStride(L, Cond, CondUse, CondStride);
2377 // It's possible for the setcc instruction to be anywhere in the loop, and
2378 // possible for it to have multiple users. If it is not immediately before
2379 // the latch block branch, move it.
2380 if (&*++BasicBlock::iterator(Cond) != (Instruction*)TermBr) {
2381 if (Cond->hasOneUse()) { // Condition has a single use, just move it.
2382 Cond->moveBefore(TermBr);
2384 // Otherwise, clone the terminating condition and insert into the loopend.
2385 Cond = cast<ICmpInst>(Cond->clone());
2386 Cond->setName(L->getHeader()->getName() + ".termcond");
2387 LatchBlock->getInstList().insert(TermBr, Cond);
2389 // Clone the IVUse, as the old use still exists!
2390 IU->IVUsesByStride[*CondStride]->addUser(CondUse->getOffset(), Cond,
2391 CondUse->getOperandValToReplace());
2392 CondUse = &IU->IVUsesByStride[*CondStride]->Users.back();
2396 // If we get to here, we know that we can transform the setcc instruction to
2397 // use the post-incremented version of the IV, allowing us to coalesce the
2398 // live ranges for the IV correctly.
2399 CondUse->setOffset(SE->getMinusSCEV(CondUse->getOffset(), *CondStride));
2400 CondUse->setIsUseOfPostIncrementedValue(true);
2406 /// OptimizeLoopCountIV - If, after all sharing of IVs, the IV used for deciding
2407 /// when to exit the loop is used only for that purpose, try to rearrange things
2408 /// so it counts down to a test against zero.
2409 void LoopStrengthReduce::OptimizeLoopCountIV(Loop *L) {
2411 // If the number of times the loop is executed isn't computable, give up.
2412 const SCEV* BackedgeTakenCount = SE->getBackedgeTakenCount(L);
2413 if (isa<SCEVCouldNotCompute>(BackedgeTakenCount))
2416 // Get the terminating condition for the loop if possible (this isn't
2417 // necessarily in the latch, or a block that's a predecessor of the header).
2418 if (!L->getExitBlock())
2419 return; // More than one loop exit blocks.
2421 // Okay, there is one exit block. Try to find the condition that causes the
2422 // loop to be exited.
2423 BasicBlock *ExitingBlock = L->getExitingBlock();
2425 return; // More than one block exiting!
2427 // Okay, we've computed the exiting block. See what condition causes us to
2430 // FIXME: we should be able to handle switch instructions (with a single exit)
2431 BranchInst *TermBr = dyn_cast<BranchInst>(ExitingBlock->getTerminator());
2432 if (TermBr == 0) return;
2433 assert(TermBr->isConditional() && "If unconditional, it can't be in loop!");
2434 if (!isa<ICmpInst>(TermBr->getCondition()))
2436 ICmpInst *Cond = cast<ICmpInst>(TermBr->getCondition());
2438 // Handle only tests for equality for the moment, and only stride 1.
2439 if (Cond->getPredicate() != CmpInst::ICMP_EQ)
2441 const SCEV* IV = SE->getSCEV(Cond->getOperand(0));
2442 const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(IV);
2443 const SCEV* One = SE->getIntegerSCEV(1, BackedgeTakenCount->getType());
2444 if (!AR || !AR->isAffine() || AR->getStepRecurrence(*SE) != One)
2446 // If the RHS of the comparison is defined inside the loop, the rewrite
2448 if (Instruction *CR = dyn_cast<Instruction>(Cond->getOperand(1)))
2449 if (L->contains(CR->getParent()))
2452 // Make sure the IV is only used for counting. Value may be preinc or
2453 // postinc; 2 uses in either case.
2454 if (!Cond->getOperand(0)->hasNUses(2))
2456 PHINode *phi = dyn_cast<PHINode>(Cond->getOperand(0));
2458 if (phi && phi->getParent()==L->getHeader()) {
2459 // value tested is preinc. Find the increment.
2460 // A CmpInst is not a BinaryOperator; we depend on this.
2461 Instruction::use_iterator UI = phi->use_begin();
2462 incr = dyn_cast<BinaryOperator>(UI);
2464 incr = dyn_cast<BinaryOperator>(++UI);
2465 // 1 use for postinc value, the phi. Unnecessarily conservative?
2466 if (!incr || !incr->hasOneUse() || incr->getOpcode()!=Instruction::Add)
2469 // Value tested is postinc. Find the phi node.
2470 incr = dyn_cast<BinaryOperator>(Cond->getOperand(0));
2471 if (!incr || incr->getOpcode()!=Instruction::Add)
2474 Instruction::use_iterator UI = Cond->getOperand(0)->use_begin();
2475 phi = dyn_cast<PHINode>(UI);
2477 phi = dyn_cast<PHINode>(++UI);
2478 // 1 use for preinc value, the increment.
2479 if (!phi || phi->getParent()!=L->getHeader() || !phi->hasOneUse())
2483 // Replace the increment with a decrement.
2484 BinaryOperator *decr =
2485 BinaryOperator::Create(Instruction::Sub, incr->getOperand(0),
2486 incr->getOperand(1), "tmp", incr);
2487 incr->replaceAllUsesWith(decr);
2488 incr->eraseFromParent();
2490 // Substitute endval-startval for the original startval, and 0 for the
2491 // original endval. Since we're only testing for equality this is OK even
2492 // if the computation wraps around.
2493 BasicBlock *Preheader = L->getLoopPreheader();
2494 Instruction *PreInsertPt = Preheader->getTerminator();
2495 int inBlock = L->contains(phi->getIncomingBlock(0)) ? 1 : 0;
2496 Value *startVal = phi->getIncomingValue(inBlock);
2497 Value *endVal = Cond->getOperand(1);
2498 // FIXME check for case where both are constant
2499 Constant* Zero = ConstantInt::get(Cond->getOperand(1)->getType(), 0);
2500 BinaryOperator *NewStartVal =
2501 BinaryOperator::Create(Instruction::Sub, endVal, startVal,
2502 "tmp", PreInsertPt);
2503 phi->setIncomingValue(inBlock, NewStartVal);
2504 Cond->setOperand(1, Zero);
2509 bool LoopStrengthReduce::runOnLoop(Loop *L, LPPassManager &LPM) {
2511 IU = &getAnalysis<IVUsers>();
2512 LI = &getAnalysis<LoopInfo>();
2513 DT = &getAnalysis<DominatorTree>();
2514 SE = &getAnalysis<ScalarEvolution>();
2517 if (!IU->IVUsesByStride.empty()) {
2519 DOUT << "\nLSR on \"" << L->getHeader()->getParent()->getNameStart()
2524 // Sort the StrideOrder so we process larger strides first.
2525 std::stable_sort(IU->StrideOrder.begin(), IU->StrideOrder.end(),
2528 // Optimize induction variables. Some indvar uses can be transformed to use
2529 // strides that will be needed for other purposes. A common example of this
2530 // is the exit test for the loop, which can often be rewritten to use the
2531 // computation of some other indvar to decide when to terminate the loop.
2534 // Change loop terminating condition to use the postinc iv when possible
2535 // and optimize loop terminating compare. FIXME: Move this after
2536 // StrengthReduceStridedIVUsers?
2537 OptimizeLoopTermCond(L);
2539 // FIXME: We can shrink overlarge IV's here. e.g. if the code has
2540 // computation in i64 values and the target doesn't support i64, demote
2541 // the computation to 32-bit if safe.
2543 // FIXME: Attempt to reuse values across multiple IV's. In particular, we
2544 // could have something like "for(i) { foo(i*8); bar(i*16) }", which should
2545 // be codegened as "for (j = 0;; j+=8) { foo(j); bar(j+j); }" on X86/PPC.
2546 // Need to be careful that IV's are all the same type. Only works for
2547 // intptr_t indvars.
2549 // IVsByStride keeps IVs for one particular loop.
2550 assert(IVsByStride.empty() && "Stale entries in IVsByStride?");
2552 // Note: this processes each stride/type pair individually. All users
2553 // passed into StrengthReduceStridedIVUsers have the same type AND stride.
2554 // Also, note that we iterate over IVUsesByStride indirectly by using
2555 // StrideOrder. This extra layer of indirection makes the ordering of
2556 // strides deterministic - not dependent on map order.
2557 for (unsigned Stride = 0, e = IU->StrideOrder.size();
2558 Stride != e; ++Stride) {
2559 std::map<const SCEV*, IVUsersOfOneStride *>::iterator SI =
2560 IU->IVUsesByStride.find(IU->StrideOrder[Stride]);
2561 assert(SI != IU->IVUsesByStride.end() && "Stride doesn't exist!");
2562 // FIXME: Generalize to non-affine IV's.
2563 if (!SI->first->isLoopInvariant(L))
2565 StrengthReduceStridedIVUsers(SI->first, *SI->second, L);
2569 // After all sharing is done, see if we can adjust the loop to test against
2570 // zero instead of counting up to a maximum. This is usually faster.
2571 OptimizeLoopCountIV(L);
2573 // We're done analyzing this loop; release all the state we built up for it.
2574 IVsByStride.clear();
2575 StrideNoReuse.clear();
2577 // Clean up after ourselves
2578 if (!DeadInsts.empty())
2579 DeleteTriviallyDeadInstructions();
2581 // At this point, it is worth checking to see if any recurrence PHIs are also
2582 // dead, so that we can remove them as well.
2583 DeleteDeadPHIs(L->getHeader());