1 //===- ScalarEvolution.cpp - Scalar Evolution Analysis --------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains the implementation of the scalar evolution analysis
11 // engine, which is used primarily to analyze expressions involving induction
12 // variables in loops.
14 // There are several aspects to this library. First is the representation of
15 // scalar expressions, which are represented as subclasses of the SCEV class.
16 // These classes are used to represent certain types of subexpressions that we
17 // can handle. We only create one SCEV of a particular shape, so
18 // pointer-comparisons for equality are legal.
20 // One important aspect of the SCEV objects is that they are never cyclic, even
21 // if there is a cycle in the dataflow for an expression (ie, a PHI node). If
22 // the PHI node is one of the idioms that we can represent (e.g., a polynomial
23 // recurrence) then we represent it directly as a recurrence node, otherwise we
24 // represent it as a SCEVUnknown node.
26 // In addition to being able to represent expressions of various types, we also
27 // have folders that are used to build the *canonical* representation for a
28 // particular expression. These folders are capable of using a variety of
29 // rewrite rules to simplify the expressions.
31 // Once the folders are defined, we can implement the more interesting
32 // higher-level code, such as the code that recognizes PHI nodes of various
33 // types, computes the execution count of a loop, etc.
35 // TODO: We should use these routines and value representations to implement
36 // dependence analysis!
38 //===----------------------------------------------------------------------===//
40 // There are several good references for the techniques used in this analysis.
42 // Chains of recurrences -- a method to expedite the evaluation
43 // of closed-form functions
44 // Olaf Bachmann, Paul S. Wang, Eugene V. Zima
46 // On computational properties of chains of recurrences
49 // Symbolic Evaluation of Chains of Recurrences for Loop Optimization
50 // Robert A. van Engelen
52 // Efficient Symbolic Analysis for Optimizing Compilers
53 // Robert A. van Engelen
55 // Using the chains of recurrences algebra for data dependence testing and
56 // induction variable substitution
57 // MS Thesis, Johnie Birch
59 //===----------------------------------------------------------------------===//
61 #include "llvm/Analysis/ScalarEvolution.h"
62 #include "llvm/ADT/Optional.h"
63 #include "llvm/ADT/STLExtras.h"
64 #include "llvm/ADT/SmallPtrSet.h"
65 #include "llvm/ADT/Statistic.h"
66 #include "llvm/Analysis/AssumptionCache.h"
67 #include "llvm/Analysis/ConstantFolding.h"
68 #include "llvm/Analysis/InstructionSimplify.h"
69 #include "llvm/Analysis/LoopInfo.h"
70 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
71 #include "llvm/Analysis/TargetLibraryInfo.h"
72 #include "llvm/Analysis/ValueTracking.h"
73 #include "llvm/IR/ConstantRange.h"
74 #include "llvm/IR/Constants.h"
75 #include "llvm/IR/DataLayout.h"
76 #include "llvm/IR/DerivedTypes.h"
77 #include "llvm/IR/Dominators.h"
78 #include "llvm/IR/GetElementPtrTypeIterator.h"
79 #include "llvm/IR/GlobalAlias.h"
80 #include "llvm/IR/GlobalVariable.h"
81 #include "llvm/IR/InstIterator.h"
82 #include "llvm/IR/Instructions.h"
83 #include "llvm/IR/LLVMContext.h"
84 #include "llvm/IR/Metadata.h"
85 #include "llvm/IR/Operator.h"
86 #include "llvm/IR/PatternMatch.h"
87 #include "llvm/Support/CommandLine.h"
88 #include "llvm/Support/Debug.h"
89 #include "llvm/Support/ErrorHandling.h"
90 #include "llvm/Support/MathExtras.h"
91 #include "llvm/Support/raw_ostream.h"
92 #include "llvm/Support/SaveAndRestore.h"
96 #define DEBUG_TYPE "scalar-evolution"
98 STATISTIC(NumArrayLenItCounts,
99 "Number of trip counts computed with array length");
100 STATISTIC(NumTripCountsComputed,
101 "Number of loops with predictable loop counts");
102 STATISTIC(NumTripCountsNotComputed,
103 "Number of loops without predictable loop counts");
104 STATISTIC(NumBruteForceTripCountsComputed,
105 "Number of loops with trip counts computed by force");
107 static cl::opt<unsigned>
108 MaxBruteForceIterations("scalar-evolution-max-iterations", cl::ReallyHidden,
109 cl::desc("Maximum number of iterations SCEV will "
110 "symbolically execute a constant "
114 // FIXME: Enable this with XDEBUG when the test suite is clean.
116 VerifySCEV("verify-scev",
117 cl::desc("Verify ScalarEvolution's backedge taken counts (slow)"));
119 //===----------------------------------------------------------------------===//
120 // SCEV class definitions
121 //===----------------------------------------------------------------------===//
123 //===----------------------------------------------------------------------===//
124 // Implementation of the SCEV class.
128 void SCEV::dump() const {
133 void SCEV::print(raw_ostream &OS) const {
134 switch (static_cast<SCEVTypes>(getSCEVType())) {
136 cast<SCEVConstant>(this)->getValue()->printAsOperand(OS, false);
139 const SCEVTruncateExpr *Trunc = cast<SCEVTruncateExpr>(this);
140 const SCEV *Op = Trunc->getOperand();
141 OS << "(trunc " << *Op->getType() << " " << *Op << " to "
142 << *Trunc->getType() << ")";
146 const SCEVZeroExtendExpr *ZExt = cast<SCEVZeroExtendExpr>(this);
147 const SCEV *Op = ZExt->getOperand();
148 OS << "(zext " << *Op->getType() << " " << *Op << " to "
149 << *ZExt->getType() << ")";
153 const SCEVSignExtendExpr *SExt = cast<SCEVSignExtendExpr>(this);
154 const SCEV *Op = SExt->getOperand();
155 OS << "(sext " << *Op->getType() << " " << *Op << " to "
156 << *SExt->getType() << ")";
160 const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(this);
161 OS << "{" << *AR->getOperand(0);
162 for (unsigned i = 1, e = AR->getNumOperands(); i != e; ++i)
163 OS << ",+," << *AR->getOperand(i);
165 if (AR->getNoWrapFlags(FlagNUW))
167 if (AR->getNoWrapFlags(FlagNSW))
169 if (AR->getNoWrapFlags(FlagNW) &&
170 !AR->getNoWrapFlags((NoWrapFlags)(FlagNUW | FlagNSW)))
172 AR->getLoop()->getHeader()->printAsOperand(OS, /*PrintType=*/false);
180 const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(this);
181 const char *OpStr = nullptr;
182 switch (NAry->getSCEVType()) {
183 case scAddExpr: OpStr = " + "; break;
184 case scMulExpr: OpStr = " * "; break;
185 case scUMaxExpr: OpStr = " umax "; break;
186 case scSMaxExpr: OpStr = " smax "; break;
189 for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
192 if (std::next(I) != E)
196 switch (NAry->getSCEVType()) {
199 if (NAry->getNoWrapFlags(FlagNUW))
201 if (NAry->getNoWrapFlags(FlagNSW))
207 const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(this);
208 OS << "(" << *UDiv->getLHS() << " /u " << *UDiv->getRHS() << ")";
212 const SCEVUnknown *U = cast<SCEVUnknown>(this);
214 if (U->isSizeOf(AllocTy)) {
215 OS << "sizeof(" << *AllocTy << ")";
218 if (U->isAlignOf(AllocTy)) {
219 OS << "alignof(" << *AllocTy << ")";
225 if (U->isOffsetOf(CTy, FieldNo)) {
226 OS << "offsetof(" << *CTy << ", ";
227 FieldNo->printAsOperand(OS, false);
232 // Otherwise just print it normally.
233 U->getValue()->printAsOperand(OS, false);
236 case scCouldNotCompute:
237 OS << "***COULDNOTCOMPUTE***";
240 llvm_unreachable("Unknown SCEV kind!");
243 Type *SCEV::getType() const {
244 switch (static_cast<SCEVTypes>(getSCEVType())) {
246 return cast<SCEVConstant>(this)->getType();
250 return cast<SCEVCastExpr>(this)->getType();
255 return cast<SCEVNAryExpr>(this)->getType();
257 return cast<SCEVAddExpr>(this)->getType();
259 return cast<SCEVUDivExpr>(this)->getType();
261 return cast<SCEVUnknown>(this)->getType();
262 case scCouldNotCompute:
263 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
265 llvm_unreachable("Unknown SCEV kind!");
268 bool SCEV::isZero() const {
269 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
270 return SC->getValue()->isZero();
274 bool SCEV::isOne() const {
275 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
276 return SC->getValue()->isOne();
280 bool SCEV::isAllOnesValue() const {
281 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
282 return SC->getValue()->isAllOnesValue();
286 /// isNonConstantNegative - Return true if the specified scev is negated, but
288 bool SCEV::isNonConstantNegative() const {
289 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(this);
290 if (!Mul) return false;
292 // If there is a constant factor, it will be first.
293 const SCEVConstant *SC = dyn_cast<SCEVConstant>(Mul->getOperand(0));
294 if (!SC) return false;
296 // Return true if the value is negative, this matches things like (-42 * V).
297 return SC->getValue()->getValue().isNegative();
300 SCEVCouldNotCompute::SCEVCouldNotCompute() :
301 SCEV(FoldingSetNodeIDRef(), scCouldNotCompute) {}
303 bool SCEVCouldNotCompute::classof(const SCEV *S) {
304 return S->getSCEVType() == scCouldNotCompute;
307 const SCEV *ScalarEvolution::getConstant(ConstantInt *V) {
309 ID.AddInteger(scConstant);
312 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
313 SCEV *S = new (SCEVAllocator) SCEVConstant(ID.Intern(SCEVAllocator), V);
314 UniqueSCEVs.InsertNode(S, IP);
318 const SCEV *ScalarEvolution::getConstant(const APInt &Val) {
319 return getConstant(ConstantInt::get(getContext(), Val));
323 ScalarEvolution::getConstant(Type *Ty, uint64_t V, bool isSigned) {
324 IntegerType *ITy = cast<IntegerType>(getEffectiveSCEVType(Ty));
325 return getConstant(ConstantInt::get(ITy, V, isSigned));
328 SCEVCastExpr::SCEVCastExpr(const FoldingSetNodeIDRef ID,
329 unsigned SCEVTy, const SCEV *op, Type *ty)
330 : SCEV(ID, SCEVTy), Op(op), Ty(ty) {}
332 SCEVTruncateExpr::SCEVTruncateExpr(const FoldingSetNodeIDRef ID,
333 const SCEV *op, Type *ty)
334 : SCEVCastExpr(ID, scTruncate, op, ty) {
335 assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
336 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
337 "Cannot truncate non-integer value!");
340 SCEVZeroExtendExpr::SCEVZeroExtendExpr(const FoldingSetNodeIDRef ID,
341 const SCEV *op, Type *ty)
342 : SCEVCastExpr(ID, scZeroExtend, op, ty) {
343 assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
344 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
345 "Cannot zero extend non-integer value!");
348 SCEVSignExtendExpr::SCEVSignExtendExpr(const FoldingSetNodeIDRef ID,
349 const SCEV *op, Type *ty)
350 : SCEVCastExpr(ID, scSignExtend, op, ty) {
351 assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
352 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
353 "Cannot sign extend non-integer value!");
356 void SCEVUnknown::deleted() {
357 // Clear this SCEVUnknown from various maps.
358 SE->forgetMemoizedResults(this);
360 // Remove this SCEVUnknown from the uniquing map.
361 SE->UniqueSCEVs.RemoveNode(this);
363 // Release the value.
367 void SCEVUnknown::allUsesReplacedWith(Value *New) {
368 // Clear this SCEVUnknown from various maps.
369 SE->forgetMemoizedResults(this);
371 // Remove this SCEVUnknown from the uniquing map.
372 SE->UniqueSCEVs.RemoveNode(this);
374 // Update this SCEVUnknown to point to the new value. This is needed
375 // because there may still be outstanding SCEVs which still point to
380 bool SCEVUnknown::isSizeOf(Type *&AllocTy) const {
381 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
382 if (VCE->getOpcode() == Instruction::PtrToInt)
383 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
384 if (CE->getOpcode() == Instruction::GetElementPtr &&
385 CE->getOperand(0)->isNullValue() &&
386 CE->getNumOperands() == 2)
387 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(1)))
389 AllocTy = cast<PointerType>(CE->getOperand(0)->getType())
397 bool SCEVUnknown::isAlignOf(Type *&AllocTy) const {
398 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
399 if (VCE->getOpcode() == Instruction::PtrToInt)
400 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
401 if (CE->getOpcode() == Instruction::GetElementPtr &&
402 CE->getOperand(0)->isNullValue()) {
404 cast<PointerType>(CE->getOperand(0)->getType())->getElementType();
405 if (StructType *STy = dyn_cast<StructType>(Ty))
406 if (!STy->isPacked() &&
407 CE->getNumOperands() == 3 &&
408 CE->getOperand(1)->isNullValue()) {
409 if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(2)))
411 STy->getNumElements() == 2 &&
412 STy->getElementType(0)->isIntegerTy(1)) {
413 AllocTy = STy->getElementType(1);
422 bool SCEVUnknown::isOffsetOf(Type *&CTy, Constant *&FieldNo) const {
423 if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
424 if (VCE->getOpcode() == Instruction::PtrToInt)
425 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
426 if (CE->getOpcode() == Instruction::GetElementPtr &&
427 CE->getNumOperands() == 3 &&
428 CE->getOperand(0)->isNullValue() &&
429 CE->getOperand(1)->isNullValue()) {
431 cast<PointerType>(CE->getOperand(0)->getType())->getElementType();
432 // Ignore vector types here so that ScalarEvolutionExpander doesn't
433 // emit getelementptrs that index into vectors.
434 if (Ty->isStructTy() || Ty->isArrayTy()) {
436 FieldNo = CE->getOperand(2);
444 //===----------------------------------------------------------------------===//
446 //===----------------------------------------------------------------------===//
449 /// SCEVComplexityCompare - Return true if the complexity of the LHS is less
450 /// than the complexity of the RHS. This comparator is used to canonicalize
452 class SCEVComplexityCompare {
453 const LoopInfo *const LI;
455 explicit SCEVComplexityCompare(const LoopInfo *li) : LI(li) {}
457 // Return true or false if LHS is less than, or at least RHS, respectively.
458 bool operator()(const SCEV *LHS, const SCEV *RHS) const {
459 return compare(LHS, RHS) < 0;
462 // Return negative, zero, or positive, if LHS is less than, equal to, or
463 // greater than RHS, respectively. A three-way result allows recursive
464 // comparisons to be more efficient.
465 int compare(const SCEV *LHS, const SCEV *RHS) const {
466 // Fast-path: SCEVs are uniqued so we can do a quick equality check.
470 // Primarily, sort the SCEVs by their getSCEVType().
471 unsigned LType = LHS->getSCEVType(), RType = RHS->getSCEVType();
473 return (int)LType - (int)RType;
475 // Aside from the getSCEVType() ordering, the particular ordering
476 // isn't very important except that it's beneficial to be consistent,
477 // so that (a + b) and (b + a) don't end up as different expressions.
478 switch (static_cast<SCEVTypes>(LType)) {
480 const SCEVUnknown *LU = cast<SCEVUnknown>(LHS);
481 const SCEVUnknown *RU = cast<SCEVUnknown>(RHS);
483 // Sort SCEVUnknown values with some loose heuristics. TODO: This is
484 // not as complete as it could be.
485 const Value *LV = LU->getValue(), *RV = RU->getValue();
487 // Order pointer values after integer values. This helps SCEVExpander
489 bool LIsPointer = LV->getType()->isPointerTy(),
490 RIsPointer = RV->getType()->isPointerTy();
491 if (LIsPointer != RIsPointer)
492 return (int)LIsPointer - (int)RIsPointer;
494 // Compare getValueID values.
495 unsigned LID = LV->getValueID(),
496 RID = RV->getValueID();
498 return (int)LID - (int)RID;
500 // Sort arguments by their position.
501 if (const Argument *LA = dyn_cast<Argument>(LV)) {
502 const Argument *RA = cast<Argument>(RV);
503 unsigned LArgNo = LA->getArgNo(), RArgNo = RA->getArgNo();
504 return (int)LArgNo - (int)RArgNo;
507 // For instructions, compare their loop depth, and their operand
508 // count. This is pretty loose.
509 if (const Instruction *LInst = dyn_cast<Instruction>(LV)) {
510 const Instruction *RInst = cast<Instruction>(RV);
512 // Compare loop depths.
513 const BasicBlock *LParent = LInst->getParent(),
514 *RParent = RInst->getParent();
515 if (LParent != RParent) {
516 unsigned LDepth = LI->getLoopDepth(LParent),
517 RDepth = LI->getLoopDepth(RParent);
518 if (LDepth != RDepth)
519 return (int)LDepth - (int)RDepth;
522 // Compare the number of operands.
523 unsigned LNumOps = LInst->getNumOperands(),
524 RNumOps = RInst->getNumOperands();
525 return (int)LNumOps - (int)RNumOps;
532 const SCEVConstant *LC = cast<SCEVConstant>(LHS);
533 const SCEVConstant *RC = cast<SCEVConstant>(RHS);
535 // Compare constant values.
536 const APInt &LA = LC->getValue()->getValue();
537 const APInt &RA = RC->getValue()->getValue();
538 unsigned LBitWidth = LA.getBitWidth(), RBitWidth = RA.getBitWidth();
539 if (LBitWidth != RBitWidth)
540 return (int)LBitWidth - (int)RBitWidth;
541 return LA.ult(RA) ? -1 : 1;
545 const SCEVAddRecExpr *LA = cast<SCEVAddRecExpr>(LHS);
546 const SCEVAddRecExpr *RA = cast<SCEVAddRecExpr>(RHS);
548 // Compare addrec loop depths.
549 const Loop *LLoop = LA->getLoop(), *RLoop = RA->getLoop();
550 if (LLoop != RLoop) {
551 unsigned LDepth = LLoop->getLoopDepth(),
552 RDepth = RLoop->getLoopDepth();
553 if (LDepth != RDepth)
554 return (int)LDepth - (int)RDepth;
557 // Addrec complexity grows with operand count.
558 unsigned LNumOps = LA->getNumOperands(), RNumOps = RA->getNumOperands();
559 if (LNumOps != RNumOps)
560 return (int)LNumOps - (int)RNumOps;
562 // Lexicographically compare.
563 for (unsigned i = 0; i != LNumOps; ++i) {
564 long X = compare(LA->getOperand(i), RA->getOperand(i));
576 const SCEVNAryExpr *LC = cast<SCEVNAryExpr>(LHS);
577 const SCEVNAryExpr *RC = cast<SCEVNAryExpr>(RHS);
579 // Lexicographically compare n-ary expressions.
580 unsigned LNumOps = LC->getNumOperands(), RNumOps = RC->getNumOperands();
581 if (LNumOps != RNumOps)
582 return (int)LNumOps - (int)RNumOps;
584 for (unsigned i = 0; i != LNumOps; ++i) {
587 long X = compare(LC->getOperand(i), RC->getOperand(i));
591 return (int)LNumOps - (int)RNumOps;
595 const SCEVUDivExpr *LC = cast<SCEVUDivExpr>(LHS);
596 const SCEVUDivExpr *RC = cast<SCEVUDivExpr>(RHS);
598 // Lexicographically compare udiv expressions.
599 long X = compare(LC->getLHS(), RC->getLHS());
602 return compare(LC->getRHS(), RC->getRHS());
608 const SCEVCastExpr *LC = cast<SCEVCastExpr>(LHS);
609 const SCEVCastExpr *RC = cast<SCEVCastExpr>(RHS);
611 // Compare cast expressions by operand.
612 return compare(LC->getOperand(), RC->getOperand());
615 case scCouldNotCompute:
616 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
618 llvm_unreachable("Unknown SCEV kind!");
621 } // end anonymous namespace
623 /// GroupByComplexity - Given a list of SCEV objects, order them by their
624 /// complexity, and group objects of the same complexity together by value.
625 /// When this routine is finished, we know that any duplicates in the vector are
626 /// consecutive and that complexity is monotonically increasing.
628 /// Note that we go take special precautions to ensure that we get deterministic
629 /// results from this routine. In other words, we don't want the results of
630 /// this to depend on where the addresses of various SCEV objects happened to
633 static void GroupByComplexity(SmallVectorImpl<const SCEV *> &Ops,
635 if (Ops.size() < 2) return; // Noop
636 if (Ops.size() == 2) {
637 // This is the common case, which also happens to be trivially simple.
639 const SCEV *&LHS = Ops[0], *&RHS = Ops[1];
640 if (SCEVComplexityCompare(LI)(RHS, LHS))
645 // Do the rough sort by complexity.
646 std::stable_sort(Ops.begin(), Ops.end(), SCEVComplexityCompare(LI));
648 // Now that we are sorted by complexity, group elements of the same
649 // complexity. Note that this is, at worst, N^2, but the vector is likely to
650 // be extremely short in practice. Note that we take this approach because we
651 // do not want to depend on the addresses of the objects we are grouping.
652 for (unsigned i = 0, e = Ops.size(); i != e-2; ++i) {
653 const SCEV *S = Ops[i];
654 unsigned Complexity = S->getSCEVType();
656 // If there are any objects of the same complexity and same value as this
658 for (unsigned j = i+1; j != e && Ops[j]->getSCEVType() == Complexity; ++j) {
659 if (Ops[j] == S) { // Found a duplicate.
660 // Move it to immediately after i'th element.
661 std::swap(Ops[i+1], Ops[j]);
662 ++i; // no need to rescan it.
663 if (i == e-2) return; // Done!
669 // Returns the size of the SCEV S.
670 static inline int sizeOfSCEV(const SCEV *S) {
671 struct FindSCEVSize {
673 FindSCEVSize() : Size(0) {}
675 bool follow(const SCEV *S) {
677 // Keep looking at all operands of S.
680 bool isDone() const {
686 SCEVTraversal<FindSCEVSize> ST(F);
693 struct SCEVDivision : public SCEVVisitor<SCEVDivision, void> {
695 // Computes the Quotient and Remainder of the division of Numerator by
697 static void divide(ScalarEvolution &SE, const SCEV *Numerator,
698 const SCEV *Denominator, const SCEV **Quotient,
699 const SCEV **Remainder) {
700 assert(Numerator && Denominator && "Uninitialized SCEV");
702 SCEVDivision D(SE, Numerator, Denominator);
704 // Check for the trivial case here to avoid having to check for it in the
706 if (Numerator == Denominator) {
712 if (Numerator->isZero()) {
718 // A simple case when N/1. The quotient is N.
719 if (Denominator->isOne()) {
720 *Quotient = Numerator;
725 // Split the Denominator when it is a product.
726 if (const SCEVMulExpr *T = dyn_cast<const SCEVMulExpr>(Denominator)) {
728 *Quotient = Numerator;
729 for (const SCEV *Op : T->operands()) {
730 divide(SE, *Quotient, Op, &Q, &R);
733 // Bail out when the Numerator is not divisible by one of the terms of
737 *Remainder = Numerator;
746 *Quotient = D.Quotient;
747 *Remainder = D.Remainder;
750 // Except in the trivial case described above, we do not know how to divide
751 // Expr by Denominator for the following functions with empty implementation.
752 void visitTruncateExpr(const SCEVTruncateExpr *Numerator) {}
753 void visitZeroExtendExpr(const SCEVZeroExtendExpr *Numerator) {}
754 void visitSignExtendExpr(const SCEVSignExtendExpr *Numerator) {}
755 void visitUDivExpr(const SCEVUDivExpr *Numerator) {}
756 void visitSMaxExpr(const SCEVSMaxExpr *Numerator) {}
757 void visitUMaxExpr(const SCEVUMaxExpr *Numerator) {}
758 void visitUnknown(const SCEVUnknown *Numerator) {}
759 void visitCouldNotCompute(const SCEVCouldNotCompute *Numerator) {}
761 void visitConstant(const SCEVConstant *Numerator) {
762 if (const SCEVConstant *D = dyn_cast<SCEVConstant>(Denominator)) {
763 APInt NumeratorVal = Numerator->getValue()->getValue();
764 APInt DenominatorVal = D->getValue()->getValue();
765 uint32_t NumeratorBW = NumeratorVal.getBitWidth();
766 uint32_t DenominatorBW = DenominatorVal.getBitWidth();
768 if (NumeratorBW > DenominatorBW)
769 DenominatorVal = DenominatorVal.sext(NumeratorBW);
770 else if (NumeratorBW < DenominatorBW)
771 NumeratorVal = NumeratorVal.sext(DenominatorBW);
773 APInt QuotientVal(NumeratorVal.getBitWidth(), 0);
774 APInt RemainderVal(NumeratorVal.getBitWidth(), 0);
775 APInt::sdivrem(NumeratorVal, DenominatorVal, QuotientVal, RemainderVal);
776 Quotient = SE.getConstant(QuotientVal);
777 Remainder = SE.getConstant(RemainderVal);
782 void visitAddRecExpr(const SCEVAddRecExpr *Numerator) {
783 const SCEV *StartQ, *StartR, *StepQ, *StepR;
784 if (!Numerator->isAffine())
785 return cannotDivide(Numerator);
786 divide(SE, Numerator->getStart(), Denominator, &StartQ, &StartR);
787 divide(SE, Numerator->getStepRecurrence(SE), Denominator, &StepQ, &StepR);
788 // Bail out if the types do not match.
789 Type *Ty = Denominator->getType();
790 if (Ty != StartQ->getType() || Ty != StartR->getType() ||
791 Ty != StepQ->getType() || Ty != StepR->getType())
792 return cannotDivide(Numerator);
793 Quotient = SE.getAddRecExpr(StartQ, StepQ, Numerator->getLoop(),
794 Numerator->getNoWrapFlags());
795 Remainder = SE.getAddRecExpr(StartR, StepR, Numerator->getLoop(),
796 Numerator->getNoWrapFlags());
799 void visitAddExpr(const SCEVAddExpr *Numerator) {
800 SmallVector<const SCEV *, 2> Qs, Rs;
801 Type *Ty = Denominator->getType();
803 for (const SCEV *Op : Numerator->operands()) {
805 divide(SE, Op, Denominator, &Q, &R);
807 // Bail out if types do not match.
808 if (Ty != Q->getType() || Ty != R->getType())
809 return cannotDivide(Numerator);
815 if (Qs.size() == 1) {
821 Quotient = SE.getAddExpr(Qs);
822 Remainder = SE.getAddExpr(Rs);
825 void visitMulExpr(const SCEVMulExpr *Numerator) {
826 SmallVector<const SCEV *, 2> Qs;
827 Type *Ty = Denominator->getType();
829 bool FoundDenominatorTerm = false;
830 for (const SCEV *Op : Numerator->operands()) {
831 // Bail out if types do not match.
832 if (Ty != Op->getType())
833 return cannotDivide(Numerator);
835 if (FoundDenominatorTerm) {
840 // Check whether Denominator divides one of the product operands.
842 divide(SE, Op, Denominator, &Q, &R);
848 // Bail out if types do not match.
849 if (Ty != Q->getType())
850 return cannotDivide(Numerator);
852 FoundDenominatorTerm = true;
856 if (FoundDenominatorTerm) {
861 Quotient = SE.getMulExpr(Qs);
865 if (!isa<SCEVUnknown>(Denominator))
866 return cannotDivide(Numerator);
868 // The Remainder is obtained by replacing Denominator by 0 in Numerator.
869 ValueToValueMap RewriteMap;
870 RewriteMap[cast<SCEVUnknown>(Denominator)->getValue()] =
871 cast<SCEVConstant>(Zero)->getValue();
872 Remainder = SCEVParameterRewriter::rewrite(Numerator, SE, RewriteMap, true);
874 if (Remainder->isZero()) {
875 // The Quotient is obtained by replacing Denominator by 1 in Numerator.
876 RewriteMap[cast<SCEVUnknown>(Denominator)->getValue()] =
877 cast<SCEVConstant>(One)->getValue();
879 SCEVParameterRewriter::rewrite(Numerator, SE, RewriteMap, true);
883 // Quotient is (Numerator - Remainder) divided by Denominator.
885 const SCEV *Diff = SE.getMinusSCEV(Numerator, Remainder);
886 // This SCEV does not seem to simplify: fail the division here.
887 if (sizeOfSCEV(Diff) > sizeOfSCEV(Numerator))
888 return cannotDivide(Numerator);
889 divide(SE, Diff, Denominator, &Q, &R);
891 return cannotDivide(Numerator);
896 SCEVDivision(ScalarEvolution &S, const SCEV *Numerator,
897 const SCEV *Denominator)
898 : SE(S), Denominator(Denominator) {
899 Zero = SE.getZero(Denominator->getType());
900 One = SE.getOne(Denominator->getType());
902 // We generally do not know how to divide Expr by Denominator. We
903 // initialize the division to a "cannot divide" state to simplify the rest
905 cannotDivide(Numerator);
908 // Convenience function for giving up on the division. We set the quotient to
909 // be equal to zero and the remainder to be equal to the numerator.
910 void cannotDivide(const SCEV *Numerator) {
912 Remainder = Numerator;
916 const SCEV *Denominator, *Quotient, *Remainder, *Zero, *One;
921 //===----------------------------------------------------------------------===//
922 // Simple SCEV method implementations
923 //===----------------------------------------------------------------------===//
925 /// BinomialCoefficient - Compute BC(It, K). The result has width W.
927 static const SCEV *BinomialCoefficient(const SCEV *It, unsigned K,
930 // Handle the simplest case efficiently.
932 return SE.getTruncateOrZeroExtend(It, ResultTy);
934 // We are using the following formula for BC(It, K):
936 // BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / K!
938 // Suppose, W is the bitwidth of the return value. We must be prepared for
939 // overflow. Hence, we must assure that the result of our computation is
940 // equal to the accurate one modulo 2^W. Unfortunately, division isn't
941 // safe in modular arithmetic.
943 // However, this code doesn't use exactly that formula; the formula it uses
944 // is something like the following, where T is the number of factors of 2 in
945 // K! (i.e. trailing zeros in the binary representation of K!), and ^ is
948 // BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / 2^T / (K! / 2^T)
950 // This formula is trivially equivalent to the previous formula. However,
951 // this formula can be implemented much more efficiently. The trick is that
952 // K! / 2^T is odd, and exact division by an odd number *is* safe in modular
953 // arithmetic. To do exact division in modular arithmetic, all we have
954 // to do is multiply by the inverse. Therefore, this step can be done at
957 // The next issue is how to safely do the division by 2^T. The way this
958 // is done is by doing the multiplication step at a width of at least W + T
959 // bits. This way, the bottom W+T bits of the product are accurate. Then,
960 // when we perform the division by 2^T (which is equivalent to a right shift
961 // by T), the bottom W bits are accurate. Extra bits are okay; they'll get
962 // truncated out after the division by 2^T.
964 // In comparison to just directly using the first formula, this technique
965 // is much more efficient; using the first formula requires W * K bits,
966 // but this formula less than W + K bits. Also, the first formula requires
967 // a division step, whereas this formula only requires multiplies and shifts.
969 // It doesn't matter whether the subtraction step is done in the calculation
970 // width or the input iteration count's width; if the subtraction overflows,
971 // the result must be zero anyway. We prefer here to do it in the width of
972 // the induction variable because it helps a lot for certain cases; CodeGen
973 // isn't smart enough to ignore the overflow, which leads to much less
974 // efficient code if the width of the subtraction is wider than the native
977 // (It's possible to not widen at all by pulling out factors of 2 before
978 // the multiplication; for example, K=2 can be calculated as
979 // It/2*(It+(It*INT_MIN/INT_MIN)+-1). However, it requires
980 // extra arithmetic, so it's not an obvious win, and it gets
981 // much more complicated for K > 3.)
983 // Protection from insane SCEVs; this bound is conservative,
984 // but it probably doesn't matter.
986 return SE.getCouldNotCompute();
988 unsigned W = SE.getTypeSizeInBits(ResultTy);
990 // Calculate K! / 2^T and T; we divide out the factors of two before
991 // multiplying for calculating K! / 2^T to avoid overflow.
992 // Other overflow doesn't matter because we only care about the bottom
993 // W bits of the result.
994 APInt OddFactorial(W, 1);
996 for (unsigned i = 3; i <= K; ++i) {
998 unsigned TwoFactors = Mult.countTrailingZeros();
1000 Mult = Mult.lshr(TwoFactors);
1001 OddFactorial *= Mult;
1004 // We need at least W + T bits for the multiplication step
1005 unsigned CalculationBits = W + T;
1007 // Calculate 2^T, at width T+W.
1008 APInt DivFactor = APInt::getOneBitSet(CalculationBits, T);
1010 // Calculate the multiplicative inverse of K! / 2^T;
1011 // this multiplication factor will perform the exact division by
1013 APInt Mod = APInt::getSignedMinValue(W+1);
1014 APInt MultiplyFactor = OddFactorial.zext(W+1);
1015 MultiplyFactor = MultiplyFactor.multiplicativeInverse(Mod);
1016 MultiplyFactor = MultiplyFactor.trunc(W);
1018 // Calculate the product, at width T+W
1019 IntegerType *CalculationTy = IntegerType::get(SE.getContext(),
1021 const SCEV *Dividend = SE.getTruncateOrZeroExtend(It, CalculationTy);
1022 for (unsigned i = 1; i != K; ++i) {
1023 const SCEV *S = SE.getMinusSCEV(It, SE.getConstant(It->getType(), i));
1024 Dividend = SE.getMulExpr(Dividend,
1025 SE.getTruncateOrZeroExtend(S, CalculationTy));
1029 const SCEV *DivResult = SE.getUDivExpr(Dividend, SE.getConstant(DivFactor));
1031 // Truncate the result, and divide by K! / 2^T.
1033 return SE.getMulExpr(SE.getConstant(MultiplyFactor),
1034 SE.getTruncateOrZeroExtend(DivResult, ResultTy));
1037 /// evaluateAtIteration - Return the value of this chain of recurrences at
1038 /// the specified iteration number. We can evaluate this recurrence by
1039 /// multiplying each element in the chain by the binomial coefficient
1040 /// corresponding to it. In other words, we can evaluate {A,+,B,+,C,+,D} as:
1042 /// A*BC(It, 0) + B*BC(It, 1) + C*BC(It, 2) + D*BC(It, 3)
1044 /// where BC(It, k) stands for binomial coefficient.
1046 const SCEV *SCEVAddRecExpr::evaluateAtIteration(const SCEV *It,
1047 ScalarEvolution &SE) const {
1048 const SCEV *Result = getStart();
1049 for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
1050 // The computation is correct in the face of overflow provided that the
1051 // multiplication is performed _after_ the evaluation of the binomial
1053 const SCEV *Coeff = BinomialCoefficient(It, i, SE, getType());
1054 if (isa<SCEVCouldNotCompute>(Coeff))
1057 Result = SE.getAddExpr(Result, SE.getMulExpr(getOperand(i), Coeff));
1062 //===----------------------------------------------------------------------===//
1063 // SCEV Expression folder implementations
1064 //===----------------------------------------------------------------------===//
1066 const SCEV *ScalarEvolution::getTruncateExpr(const SCEV *Op,
1068 assert(getTypeSizeInBits(Op->getType()) > getTypeSizeInBits(Ty) &&
1069 "This is not a truncating conversion!");
1070 assert(isSCEVable(Ty) &&
1071 "This is not a conversion to a SCEVable type!");
1072 Ty = getEffectiveSCEVType(Ty);
1074 FoldingSetNodeID ID;
1075 ID.AddInteger(scTruncate);
1079 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1081 // Fold if the operand is constant.
1082 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1084 cast<ConstantInt>(ConstantExpr::getTrunc(SC->getValue(), Ty)));
1086 // trunc(trunc(x)) --> trunc(x)
1087 if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op))
1088 return getTruncateExpr(ST->getOperand(), Ty);
1090 // trunc(sext(x)) --> sext(x) if widening or trunc(x) if narrowing
1091 if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op))
1092 return getTruncateOrSignExtend(SS->getOperand(), Ty);
1094 // trunc(zext(x)) --> zext(x) if widening or trunc(x) if narrowing
1095 if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
1096 return getTruncateOrZeroExtend(SZ->getOperand(), Ty);
1098 // trunc(x1+x2+...+xN) --> trunc(x1)+trunc(x2)+...+trunc(xN) if we can
1099 // eliminate all the truncates, or we replace other casts with truncates.
1100 if (const SCEVAddExpr *SA = dyn_cast<SCEVAddExpr>(Op)) {
1101 SmallVector<const SCEV *, 4> Operands;
1102 bool hasTrunc = false;
1103 for (unsigned i = 0, e = SA->getNumOperands(); i != e && !hasTrunc; ++i) {
1104 const SCEV *S = getTruncateExpr(SA->getOperand(i), Ty);
1105 if (!isa<SCEVCastExpr>(SA->getOperand(i)))
1106 hasTrunc = isa<SCEVTruncateExpr>(S);
1107 Operands.push_back(S);
1110 return getAddExpr(Operands);
1111 UniqueSCEVs.FindNodeOrInsertPos(ID, IP); // Mutates IP, returns NULL.
1114 // trunc(x1*x2*...*xN) --> trunc(x1)*trunc(x2)*...*trunc(xN) if we can
1115 // eliminate all the truncates, or we replace other casts with truncates.
1116 if (const SCEVMulExpr *SM = dyn_cast<SCEVMulExpr>(Op)) {
1117 SmallVector<const SCEV *, 4> Operands;
1118 bool hasTrunc = false;
1119 for (unsigned i = 0, e = SM->getNumOperands(); i != e && !hasTrunc; ++i) {
1120 const SCEV *S = getTruncateExpr(SM->getOperand(i), Ty);
1121 if (!isa<SCEVCastExpr>(SM->getOperand(i)))
1122 hasTrunc = isa<SCEVTruncateExpr>(S);
1123 Operands.push_back(S);
1126 return getMulExpr(Operands);
1127 UniqueSCEVs.FindNodeOrInsertPos(ID, IP); // Mutates IP, returns NULL.
1130 // If the input value is a chrec scev, truncate the chrec's operands.
1131 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(Op)) {
1132 SmallVector<const SCEV *, 4> Operands;
1133 for (const SCEV *Op : AddRec->operands())
1134 Operands.push_back(getTruncateExpr(Op, Ty));
1135 return getAddRecExpr(Operands, AddRec->getLoop(), SCEV::FlagAnyWrap);
1138 // The cast wasn't folded; create an explicit cast node. We can reuse
1139 // the existing insert position since if we get here, we won't have
1140 // made any changes which would invalidate it.
1141 SCEV *S = new (SCEVAllocator) SCEVTruncateExpr(ID.Intern(SCEVAllocator),
1143 UniqueSCEVs.InsertNode(S, IP);
1147 // Get the limit of a recurrence such that incrementing by Step cannot cause
1148 // signed overflow as long as the value of the recurrence within the
1149 // loop does not exceed this limit before incrementing.
1150 static const SCEV *getSignedOverflowLimitForStep(const SCEV *Step,
1151 ICmpInst::Predicate *Pred,
1152 ScalarEvolution *SE) {
1153 unsigned BitWidth = SE->getTypeSizeInBits(Step->getType());
1154 if (SE->isKnownPositive(Step)) {
1155 *Pred = ICmpInst::ICMP_SLT;
1156 return SE->getConstant(APInt::getSignedMinValue(BitWidth) -
1157 SE->getSignedRange(Step).getSignedMax());
1159 if (SE->isKnownNegative(Step)) {
1160 *Pred = ICmpInst::ICMP_SGT;
1161 return SE->getConstant(APInt::getSignedMaxValue(BitWidth) -
1162 SE->getSignedRange(Step).getSignedMin());
1167 // Get the limit of a recurrence such that incrementing by Step cannot cause
1168 // unsigned overflow as long as the value of the recurrence within the loop does
1169 // not exceed this limit before incrementing.
1170 static const SCEV *getUnsignedOverflowLimitForStep(const SCEV *Step,
1171 ICmpInst::Predicate *Pred,
1172 ScalarEvolution *SE) {
1173 unsigned BitWidth = SE->getTypeSizeInBits(Step->getType());
1174 *Pred = ICmpInst::ICMP_ULT;
1176 return SE->getConstant(APInt::getMinValue(BitWidth) -
1177 SE->getUnsignedRange(Step).getUnsignedMax());
1182 struct ExtendOpTraitsBase {
1183 typedef const SCEV *(ScalarEvolution::*GetExtendExprTy)(const SCEV *, Type *);
1186 // Used to make code generic over signed and unsigned overflow.
1187 template <typename ExtendOp> struct ExtendOpTraits {
1190 // static const SCEV::NoWrapFlags WrapType;
1192 // static const ExtendOpTraitsBase::GetExtendExprTy GetExtendExpr;
1194 // static const SCEV *getOverflowLimitForStep(const SCEV *Step,
1195 // ICmpInst::Predicate *Pred,
1196 // ScalarEvolution *SE);
1200 struct ExtendOpTraits<SCEVSignExtendExpr> : public ExtendOpTraitsBase {
1201 static const SCEV::NoWrapFlags WrapType = SCEV::FlagNSW;
1203 static const GetExtendExprTy GetExtendExpr;
1205 static const SCEV *getOverflowLimitForStep(const SCEV *Step,
1206 ICmpInst::Predicate *Pred,
1207 ScalarEvolution *SE) {
1208 return getSignedOverflowLimitForStep(Step, Pred, SE);
1212 const ExtendOpTraitsBase::GetExtendExprTy ExtendOpTraits<
1213 SCEVSignExtendExpr>::GetExtendExpr = &ScalarEvolution::getSignExtendExpr;
1216 struct ExtendOpTraits<SCEVZeroExtendExpr> : public ExtendOpTraitsBase {
1217 static const SCEV::NoWrapFlags WrapType = SCEV::FlagNUW;
1219 static const GetExtendExprTy GetExtendExpr;
1221 static const SCEV *getOverflowLimitForStep(const SCEV *Step,
1222 ICmpInst::Predicate *Pred,
1223 ScalarEvolution *SE) {
1224 return getUnsignedOverflowLimitForStep(Step, Pred, SE);
1228 const ExtendOpTraitsBase::GetExtendExprTy ExtendOpTraits<
1229 SCEVZeroExtendExpr>::GetExtendExpr = &ScalarEvolution::getZeroExtendExpr;
1232 // The recurrence AR has been shown to have no signed/unsigned wrap or something
1233 // close to it. Typically, if we can prove NSW/NUW for AR, then we can just as
1234 // easily prove NSW/NUW for its preincrement or postincrement sibling. This
1235 // allows normalizing a sign/zero extended AddRec as such: {sext/zext(Step +
1236 // Start),+,Step} => {(Step + sext/zext(Start),+,Step} As a result, the
1237 // expression "Step + sext/zext(PreIncAR)" is congruent with
1238 // "sext/zext(PostIncAR)"
1239 template <typename ExtendOpTy>
1240 static const SCEV *getPreStartForExtend(const SCEVAddRecExpr *AR, Type *Ty,
1241 ScalarEvolution *SE) {
1242 auto WrapType = ExtendOpTraits<ExtendOpTy>::WrapType;
1243 auto GetExtendExpr = ExtendOpTraits<ExtendOpTy>::GetExtendExpr;
1245 const Loop *L = AR->getLoop();
1246 const SCEV *Start = AR->getStart();
1247 const SCEV *Step = AR->getStepRecurrence(*SE);
1249 // Check for a simple looking step prior to loop entry.
1250 const SCEVAddExpr *SA = dyn_cast<SCEVAddExpr>(Start);
1254 // Create an AddExpr for "PreStart" after subtracting Step. Full SCEV
1255 // subtraction is expensive. For this purpose, perform a quick and dirty
1256 // difference, by checking for Step in the operand list.
1257 SmallVector<const SCEV *, 4> DiffOps;
1258 for (const SCEV *Op : SA->operands())
1260 DiffOps.push_back(Op);
1262 if (DiffOps.size() == SA->getNumOperands())
1265 // Try to prove `WrapType` (SCEV::FlagNSW or SCEV::FlagNUW) on `PreStart` +
1268 // 1. NSW/NUW flags on the step increment.
1269 auto PreStartFlags =
1270 ScalarEvolution::maskFlags(SA->getNoWrapFlags(), SCEV::FlagNUW);
1271 const SCEV *PreStart = SE->getAddExpr(DiffOps, PreStartFlags);
1272 const SCEVAddRecExpr *PreAR = dyn_cast<SCEVAddRecExpr>(
1273 SE->getAddRecExpr(PreStart, Step, L, SCEV::FlagAnyWrap));
1275 // "{S,+,X} is <nsw>/<nuw>" and "the backedge is taken at least once" implies
1276 // "S+X does not sign/unsign-overflow".
1279 const SCEV *BECount = SE->getBackedgeTakenCount(L);
1280 if (PreAR && PreAR->getNoWrapFlags(WrapType) &&
1281 !isa<SCEVCouldNotCompute>(BECount) && SE->isKnownPositive(BECount))
1284 // 2. Direct overflow check on the step operation's expression.
1285 unsigned BitWidth = SE->getTypeSizeInBits(AR->getType());
1286 Type *WideTy = IntegerType::get(SE->getContext(), BitWidth * 2);
1287 const SCEV *OperandExtendedStart =
1288 SE->getAddExpr((SE->*GetExtendExpr)(PreStart, WideTy),
1289 (SE->*GetExtendExpr)(Step, WideTy));
1290 if ((SE->*GetExtendExpr)(Start, WideTy) == OperandExtendedStart) {
1291 if (PreAR && AR->getNoWrapFlags(WrapType)) {
1292 // If we know `AR` == {`PreStart`+`Step`,+,`Step`} is `WrapType` (FlagNSW
1293 // or FlagNUW) and that `PreStart` + `Step` is `WrapType` too, then
1294 // `PreAR` == {`PreStart`,+,`Step`} is also `WrapType`. Cache this fact.
1295 const_cast<SCEVAddRecExpr *>(PreAR)->setNoWrapFlags(WrapType);
1300 // 3. Loop precondition.
1301 ICmpInst::Predicate Pred;
1302 const SCEV *OverflowLimit =
1303 ExtendOpTraits<ExtendOpTy>::getOverflowLimitForStep(Step, &Pred, SE);
1305 if (OverflowLimit &&
1306 SE->isLoopEntryGuardedByCond(L, Pred, PreStart, OverflowLimit))
1312 // Get the normalized zero or sign extended expression for this AddRec's Start.
1313 template <typename ExtendOpTy>
1314 static const SCEV *getExtendAddRecStart(const SCEVAddRecExpr *AR, Type *Ty,
1315 ScalarEvolution *SE) {
1316 auto GetExtendExpr = ExtendOpTraits<ExtendOpTy>::GetExtendExpr;
1318 const SCEV *PreStart = getPreStartForExtend<ExtendOpTy>(AR, Ty, SE);
1320 return (SE->*GetExtendExpr)(AR->getStart(), Ty);
1322 return SE->getAddExpr((SE->*GetExtendExpr)(AR->getStepRecurrence(*SE), Ty),
1323 (SE->*GetExtendExpr)(PreStart, Ty));
1326 // Try to prove away overflow by looking at "nearby" add recurrences. A
1327 // motivating example for this rule: if we know `{0,+,4}` is `ult` `-1` and it
1328 // does not itself wrap then we can conclude that `{1,+,4}` is `nuw`.
1332 // {S,+,X} == {S-T,+,X} + T
1333 // => Ext({S,+,X}) == Ext({S-T,+,X} + T)
1335 // If ({S-T,+,X} + T) does not overflow ... (1)
1337 // RHS == Ext({S-T,+,X} + T) == Ext({S-T,+,X}) + Ext(T)
1339 // If {S-T,+,X} does not overflow ... (2)
1341 // RHS == Ext({S-T,+,X}) + Ext(T) == {Ext(S-T),+,Ext(X)} + Ext(T)
1342 // == {Ext(S-T)+Ext(T),+,Ext(X)}
1344 // If (S-T)+T does not overflow ... (3)
1346 // RHS == {Ext(S-T)+Ext(T),+,Ext(X)} == {Ext(S-T+T),+,Ext(X)}
1347 // == {Ext(S),+,Ext(X)} == LHS
1349 // Thus, if (1), (2) and (3) are true for some T, then
1350 // Ext({S,+,X}) == {Ext(S),+,Ext(X)}
1352 // (3) is implied by (1) -- "(S-T)+T does not overflow" is simply "({S-T,+,X}+T)
1353 // does not overflow" restricted to the 0th iteration. Therefore we only need
1354 // to check for (1) and (2).
1356 // In the current context, S is `Start`, X is `Step`, Ext is `ExtendOpTy` and T
1357 // is `Delta` (defined below).
1359 template <typename ExtendOpTy>
1360 bool ScalarEvolution::proveNoWrapByVaryingStart(const SCEV *Start,
1363 auto WrapType = ExtendOpTraits<ExtendOpTy>::WrapType;
1365 // We restrict `Start` to a constant to prevent SCEV from spending too much
1366 // time here. It is correct (but more expensive) to continue with a
1367 // non-constant `Start` and do a general SCEV subtraction to compute
1368 // `PreStart` below.
1370 const SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start);
1374 APInt StartAI = StartC->getValue()->getValue();
1376 for (unsigned Delta : {-2, -1, 1, 2}) {
1377 const SCEV *PreStart = getConstant(StartAI - Delta);
1379 FoldingSetNodeID ID;
1380 ID.AddInteger(scAddRecExpr);
1381 ID.AddPointer(PreStart);
1382 ID.AddPointer(Step);
1386 static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
1388 // Give up if we don't already have the add recurrence we need because
1389 // actually constructing an add recurrence is relatively expensive.
1390 if (PreAR && PreAR->getNoWrapFlags(WrapType)) { // proves (2)
1391 const SCEV *DeltaS = getConstant(StartC->getType(), Delta);
1392 ICmpInst::Predicate Pred = ICmpInst::BAD_ICMP_PREDICATE;
1393 const SCEV *Limit = ExtendOpTraits<ExtendOpTy>::getOverflowLimitForStep(
1394 DeltaS, &Pred, this);
1395 if (Limit && isKnownPredicate(Pred, PreAR, Limit)) // proves (1)
1403 const SCEV *ScalarEvolution::getZeroExtendExpr(const SCEV *Op,
1405 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
1406 "This is not an extending conversion!");
1407 assert(isSCEVable(Ty) &&
1408 "This is not a conversion to a SCEVable type!");
1409 Ty = getEffectiveSCEVType(Ty);
1411 // Fold if the operand is constant.
1412 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1414 cast<ConstantInt>(ConstantExpr::getZExt(SC->getValue(), Ty)));
1416 // zext(zext(x)) --> zext(x)
1417 if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
1418 return getZeroExtendExpr(SZ->getOperand(), Ty);
1420 // Before doing any expensive analysis, check to see if we've already
1421 // computed a SCEV for this Op and Ty.
1422 FoldingSetNodeID ID;
1423 ID.AddInteger(scZeroExtend);
1427 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1429 // zext(trunc(x)) --> zext(x) or x or trunc(x)
1430 if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) {
1431 // It's possible the bits taken off by the truncate were all zero bits. If
1432 // so, we should be able to simplify this further.
1433 const SCEV *X = ST->getOperand();
1434 ConstantRange CR = getUnsignedRange(X);
1435 unsigned TruncBits = getTypeSizeInBits(ST->getType());
1436 unsigned NewBits = getTypeSizeInBits(Ty);
1437 if (CR.truncate(TruncBits).zeroExtend(NewBits).contains(
1438 CR.zextOrTrunc(NewBits)))
1439 return getTruncateOrZeroExtend(X, Ty);
1442 // If the input value is a chrec scev, and we can prove that the value
1443 // did not overflow the old, smaller, value, we can zero extend all of the
1444 // operands (often constants). This allows analysis of something like
1445 // this: for (unsigned char X = 0; X < 100; ++X) { int Y = X; }
1446 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op))
1447 if (AR->isAffine()) {
1448 const SCEV *Start = AR->getStart();
1449 const SCEV *Step = AR->getStepRecurrence(*this);
1450 unsigned BitWidth = getTypeSizeInBits(AR->getType());
1451 const Loop *L = AR->getLoop();
1453 // If we have special knowledge that this addrec won't overflow,
1454 // we don't need to do any further analysis.
1455 if (AR->getNoWrapFlags(SCEV::FlagNUW))
1456 return getAddRecExpr(
1457 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1458 getZeroExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1460 // Check whether the backedge-taken count is SCEVCouldNotCompute.
1461 // Note that this serves two purposes: It filters out loops that are
1462 // simply not analyzable, and it covers the case where this code is
1463 // being called from within backedge-taken count analysis, such that
1464 // attempting to ask for the backedge-taken count would likely result
1465 // in infinite recursion. In the later case, the analysis code will
1466 // cope with a conservative value, and it will take care to purge
1467 // that value once it has finished.
1468 const SCEV *MaxBECount = getMaxBackedgeTakenCount(L);
1469 if (!isa<SCEVCouldNotCompute>(MaxBECount)) {
1470 // Manually compute the final value for AR, checking for
1473 // Check whether the backedge-taken count can be losslessly casted to
1474 // the addrec's type. The count is always unsigned.
1475 const SCEV *CastedMaxBECount =
1476 getTruncateOrZeroExtend(MaxBECount, Start->getType());
1477 const SCEV *RecastedMaxBECount =
1478 getTruncateOrZeroExtend(CastedMaxBECount, MaxBECount->getType());
1479 if (MaxBECount == RecastedMaxBECount) {
1480 Type *WideTy = IntegerType::get(getContext(), BitWidth * 2);
1481 // Check whether Start+Step*MaxBECount has no unsigned overflow.
1482 const SCEV *ZMul = getMulExpr(CastedMaxBECount, Step);
1483 const SCEV *ZAdd = getZeroExtendExpr(getAddExpr(Start, ZMul), WideTy);
1484 const SCEV *WideStart = getZeroExtendExpr(Start, WideTy);
1485 const SCEV *WideMaxBECount =
1486 getZeroExtendExpr(CastedMaxBECount, WideTy);
1487 const SCEV *OperandExtendedAdd =
1488 getAddExpr(WideStart,
1489 getMulExpr(WideMaxBECount,
1490 getZeroExtendExpr(Step, WideTy)));
1491 if (ZAdd == OperandExtendedAdd) {
1492 // Cache knowledge of AR NUW, which is propagated to this AddRec.
1493 const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNUW);
1494 // Return the expression with the addrec on the outside.
1495 return getAddRecExpr(
1496 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1497 getZeroExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1499 // Similar to above, only this time treat the step value as signed.
1500 // This covers loops that count down.
1501 OperandExtendedAdd =
1502 getAddExpr(WideStart,
1503 getMulExpr(WideMaxBECount,
1504 getSignExtendExpr(Step, WideTy)));
1505 if (ZAdd == OperandExtendedAdd) {
1506 // Cache knowledge of AR NW, which is propagated to this AddRec.
1507 // Negative step causes unsigned wrap, but it still can't self-wrap.
1508 const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNW);
1509 // Return the expression with the addrec on the outside.
1510 return getAddRecExpr(
1511 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1512 getSignExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1516 // If the backedge is guarded by a comparison with the pre-inc value
1517 // the addrec is safe. Also, if the entry is guarded by a comparison
1518 // with the start value and the backedge is guarded by a comparison
1519 // with the post-inc value, the addrec is safe.
1520 if (isKnownPositive(Step)) {
1521 const SCEV *N = getConstant(APInt::getMinValue(BitWidth) -
1522 getUnsignedRange(Step).getUnsignedMax());
1523 if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT, AR, N) ||
1524 (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_ULT, Start, N) &&
1525 isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT,
1526 AR->getPostIncExpr(*this), N))) {
1527 // Cache knowledge of AR NUW, which is propagated to this AddRec.
1528 const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNUW);
1529 // Return the expression with the addrec on the outside.
1530 return getAddRecExpr(
1531 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1532 getZeroExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1534 } else if (isKnownNegative(Step)) {
1535 const SCEV *N = getConstant(APInt::getMaxValue(BitWidth) -
1536 getSignedRange(Step).getSignedMin());
1537 if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT, AR, N) ||
1538 (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_UGT, Start, N) &&
1539 isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT,
1540 AR->getPostIncExpr(*this), N))) {
1541 // Cache knowledge of AR NW, which is propagated to this AddRec.
1542 // Negative step causes unsigned wrap, but it still can't self-wrap.
1543 const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNW);
1544 // Return the expression with the addrec on the outside.
1545 return getAddRecExpr(
1546 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1547 getSignExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1552 if (proveNoWrapByVaryingStart<SCEVZeroExtendExpr>(Start, Step, L)) {
1553 const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNUW);
1554 return getAddRecExpr(
1555 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1556 getZeroExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1560 if (auto *SA = dyn_cast<SCEVAddExpr>(Op)) {
1561 // zext((A + B + ...)<nuw>) --> (zext(A) + zext(B) + ...)<nuw>
1562 if (SA->getNoWrapFlags(SCEV::FlagNUW)) {
1563 // If the addition does not unsign overflow then we can, by definition,
1564 // commute the zero extension with the addition operation.
1565 SmallVector<const SCEV *, 4> Ops;
1566 for (const auto *Op : SA->operands())
1567 Ops.push_back(getZeroExtendExpr(Op, Ty));
1568 return getAddExpr(Ops, SCEV::FlagNUW);
1572 // The cast wasn't folded; create an explicit cast node.
1573 // Recompute the insert position, as it may have been invalidated.
1574 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1575 SCEV *S = new (SCEVAllocator) SCEVZeroExtendExpr(ID.Intern(SCEVAllocator),
1577 UniqueSCEVs.InsertNode(S, IP);
1581 const SCEV *ScalarEvolution::getSignExtendExpr(const SCEV *Op,
1583 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
1584 "This is not an extending conversion!");
1585 assert(isSCEVable(Ty) &&
1586 "This is not a conversion to a SCEVable type!");
1587 Ty = getEffectiveSCEVType(Ty);
1589 // Fold if the operand is constant.
1590 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1592 cast<ConstantInt>(ConstantExpr::getSExt(SC->getValue(), Ty)));
1594 // sext(sext(x)) --> sext(x)
1595 if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op))
1596 return getSignExtendExpr(SS->getOperand(), Ty);
1598 // sext(zext(x)) --> zext(x)
1599 if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
1600 return getZeroExtendExpr(SZ->getOperand(), Ty);
1602 // Before doing any expensive analysis, check to see if we've already
1603 // computed a SCEV for this Op and Ty.
1604 FoldingSetNodeID ID;
1605 ID.AddInteger(scSignExtend);
1609 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1611 // If the input value is provably positive, build a zext instead.
1612 if (isKnownNonNegative(Op))
1613 return getZeroExtendExpr(Op, Ty);
1615 // sext(trunc(x)) --> sext(x) or x or trunc(x)
1616 if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) {
1617 // It's possible the bits taken off by the truncate were all sign bits. If
1618 // so, we should be able to simplify this further.
1619 const SCEV *X = ST->getOperand();
1620 ConstantRange CR = getSignedRange(X);
1621 unsigned TruncBits = getTypeSizeInBits(ST->getType());
1622 unsigned NewBits = getTypeSizeInBits(Ty);
1623 if (CR.truncate(TruncBits).signExtend(NewBits).contains(
1624 CR.sextOrTrunc(NewBits)))
1625 return getTruncateOrSignExtend(X, Ty);
1628 // sext(C1 + (C2 * x)) --> C1 + sext(C2 * x) if C1 < C2
1629 if (auto *SA = dyn_cast<SCEVAddExpr>(Op)) {
1630 if (SA->getNumOperands() == 2) {
1631 auto *SC1 = dyn_cast<SCEVConstant>(SA->getOperand(0));
1632 auto *SMul = dyn_cast<SCEVMulExpr>(SA->getOperand(1));
1634 if (auto *SC2 = dyn_cast<SCEVConstant>(SMul->getOperand(0))) {
1635 const APInt &C1 = SC1->getValue()->getValue();
1636 const APInt &C2 = SC2->getValue()->getValue();
1637 if (C1.isStrictlyPositive() && C2.isStrictlyPositive() &&
1638 C2.ugt(C1) && C2.isPowerOf2())
1639 return getAddExpr(getSignExtendExpr(SC1, Ty),
1640 getSignExtendExpr(SMul, Ty));
1645 // sext((A + B + ...)<nsw>) --> (sext(A) + sext(B) + ...)<nsw>
1646 if (SA->getNoWrapFlags(SCEV::FlagNSW)) {
1647 // If the addition does not sign overflow then we can, by definition,
1648 // commute the sign extension with the addition operation.
1649 SmallVector<const SCEV *, 4> Ops;
1650 for (const auto *Op : SA->operands())
1651 Ops.push_back(getSignExtendExpr(Op, Ty));
1652 return getAddExpr(Ops, SCEV::FlagNSW);
1655 // If the input value is a chrec scev, and we can prove that the value
1656 // did not overflow the old, smaller, value, we can sign extend all of the
1657 // operands (often constants). This allows analysis of something like
1658 // this: for (signed char X = 0; X < 100; ++X) { int Y = X; }
1659 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op))
1660 if (AR->isAffine()) {
1661 const SCEV *Start = AR->getStart();
1662 const SCEV *Step = AR->getStepRecurrence(*this);
1663 unsigned BitWidth = getTypeSizeInBits(AR->getType());
1664 const Loop *L = AR->getLoop();
1666 // If we have special knowledge that this addrec won't overflow,
1667 // we don't need to do any further analysis.
1668 if (AR->getNoWrapFlags(SCEV::FlagNSW))
1669 return getAddRecExpr(
1670 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this),
1671 getSignExtendExpr(Step, Ty), L, SCEV::FlagNSW);
1673 // Check whether the backedge-taken count is SCEVCouldNotCompute.
1674 // Note that this serves two purposes: It filters out loops that are
1675 // simply not analyzable, and it covers the case where this code is
1676 // being called from within backedge-taken count analysis, such that
1677 // attempting to ask for the backedge-taken count would likely result
1678 // in infinite recursion. In the later case, the analysis code will
1679 // cope with a conservative value, and it will take care to purge
1680 // that value once it has finished.
1681 const SCEV *MaxBECount = getMaxBackedgeTakenCount(L);
1682 if (!isa<SCEVCouldNotCompute>(MaxBECount)) {
1683 // Manually compute the final value for AR, checking for
1686 // Check whether the backedge-taken count can be losslessly casted to
1687 // the addrec's type. The count is always unsigned.
1688 const SCEV *CastedMaxBECount =
1689 getTruncateOrZeroExtend(MaxBECount, Start->getType());
1690 const SCEV *RecastedMaxBECount =
1691 getTruncateOrZeroExtend(CastedMaxBECount, MaxBECount->getType());
1692 if (MaxBECount == RecastedMaxBECount) {
1693 Type *WideTy = IntegerType::get(getContext(), BitWidth * 2);
1694 // Check whether Start+Step*MaxBECount has no signed overflow.
1695 const SCEV *SMul = getMulExpr(CastedMaxBECount, Step);
1696 const SCEV *SAdd = getSignExtendExpr(getAddExpr(Start, SMul), WideTy);
1697 const SCEV *WideStart = getSignExtendExpr(Start, WideTy);
1698 const SCEV *WideMaxBECount =
1699 getZeroExtendExpr(CastedMaxBECount, WideTy);
1700 const SCEV *OperandExtendedAdd =
1701 getAddExpr(WideStart,
1702 getMulExpr(WideMaxBECount,
1703 getSignExtendExpr(Step, WideTy)));
1704 if (SAdd == OperandExtendedAdd) {
1705 // Cache knowledge of AR NSW, which is propagated to this AddRec.
1706 const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNSW);
1707 // Return the expression with the addrec on the outside.
1708 return getAddRecExpr(
1709 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this),
1710 getSignExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1712 // Similar to above, only this time treat the step value as unsigned.
1713 // This covers loops that count up with an unsigned step.
1714 OperandExtendedAdd =
1715 getAddExpr(WideStart,
1716 getMulExpr(WideMaxBECount,
1717 getZeroExtendExpr(Step, WideTy)));
1718 if (SAdd == OperandExtendedAdd) {
1719 // If AR wraps around then
1721 // abs(Step) * MaxBECount > unsigned-max(AR->getType())
1722 // => SAdd != OperandExtendedAdd
1724 // Thus (AR is not NW => SAdd != OperandExtendedAdd) <=>
1725 // (SAdd == OperandExtendedAdd => AR is NW)
1727 const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNW);
1729 // Return the expression with the addrec on the outside.
1730 return getAddRecExpr(
1731 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this),
1732 getZeroExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1736 // If the backedge is guarded by a comparison with the pre-inc value
1737 // the addrec is safe. Also, if the entry is guarded by a comparison
1738 // with the start value and the backedge is guarded by a comparison
1739 // with the post-inc value, the addrec is safe.
1740 ICmpInst::Predicate Pred;
1741 const SCEV *OverflowLimit =
1742 getSignedOverflowLimitForStep(Step, &Pred, this);
1743 if (OverflowLimit &&
1744 (isLoopBackedgeGuardedByCond(L, Pred, AR, OverflowLimit) ||
1745 (isLoopEntryGuardedByCond(L, Pred, Start, OverflowLimit) &&
1746 isLoopBackedgeGuardedByCond(L, Pred, AR->getPostIncExpr(*this),
1748 // Cache knowledge of AR NSW, then propagate NSW to the wide AddRec.
1749 const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNSW);
1750 return getAddRecExpr(
1751 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this),
1752 getSignExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1755 // If Start and Step are constants, check if we can apply this
1757 // sext{C1,+,C2} --> C1 + sext{0,+,C2} if C1 < C2
1758 auto *SC1 = dyn_cast<SCEVConstant>(Start);
1759 auto *SC2 = dyn_cast<SCEVConstant>(Step);
1761 const APInt &C1 = SC1->getValue()->getValue();
1762 const APInt &C2 = SC2->getValue()->getValue();
1763 if (C1.isStrictlyPositive() && C2.isStrictlyPositive() && C2.ugt(C1) &&
1765 Start = getSignExtendExpr(Start, Ty);
1766 const SCEV *NewAR = getAddRecExpr(getZero(AR->getType()), Step, L,
1767 AR->getNoWrapFlags());
1768 return getAddExpr(Start, getSignExtendExpr(NewAR, Ty));
1772 if (proveNoWrapByVaryingStart<SCEVSignExtendExpr>(Start, Step, L)) {
1773 const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNSW);
1774 return getAddRecExpr(
1775 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this),
1776 getSignExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1780 // The cast wasn't folded; create an explicit cast node.
1781 // Recompute the insert position, as it may have been invalidated.
1782 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1783 SCEV *S = new (SCEVAllocator) SCEVSignExtendExpr(ID.Intern(SCEVAllocator),
1785 UniqueSCEVs.InsertNode(S, IP);
1789 /// getAnyExtendExpr - Return a SCEV for the given operand extended with
1790 /// unspecified bits out to the given type.
1792 const SCEV *ScalarEvolution::getAnyExtendExpr(const SCEV *Op,
1794 assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
1795 "This is not an extending conversion!");
1796 assert(isSCEVable(Ty) &&
1797 "This is not a conversion to a SCEVable type!");
1798 Ty = getEffectiveSCEVType(Ty);
1800 // Sign-extend negative constants.
1801 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1802 if (SC->getValue()->getValue().isNegative())
1803 return getSignExtendExpr(Op, Ty);
1805 // Peel off a truncate cast.
1806 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Op)) {
1807 const SCEV *NewOp = T->getOperand();
1808 if (getTypeSizeInBits(NewOp->getType()) < getTypeSizeInBits(Ty))
1809 return getAnyExtendExpr(NewOp, Ty);
1810 return getTruncateOrNoop(NewOp, Ty);
1813 // Next try a zext cast. If the cast is folded, use it.
1814 const SCEV *ZExt = getZeroExtendExpr(Op, Ty);
1815 if (!isa<SCEVZeroExtendExpr>(ZExt))
1818 // Next try a sext cast. If the cast is folded, use it.
1819 const SCEV *SExt = getSignExtendExpr(Op, Ty);
1820 if (!isa<SCEVSignExtendExpr>(SExt))
1823 // Force the cast to be folded into the operands of an addrec.
1824 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op)) {
1825 SmallVector<const SCEV *, 4> Ops;
1826 for (const SCEV *Op : AR->operands())
1827 Ops.push_back(getAnyExtendExpr(Op, Ty));
1828 return getAddRecExpr(Ops, AR->getLoop(), SCEV::FlagNW);
1831 // If the expression is obviously signed, use the sext cast value.
1832 if (isa<SCEVSMaxExpr>(Op))
1835 // Absent any other information, use the zext cast value.
1839 /// CollectAddOperandsWithScales - Process the given Ops list, which is
1840 /// a list of operands to be added under the given scale, update the given
1841 /// map. This is a helper function for getAddRecExpr. As an example of
1842 /// what it does, given a sequence of operands that would form an add
1843 /// expression like this:
1845 /// m + n + 13 + (A * (o + p + (B * (q + m + 29)))) + r + (-1 * r)
1847 /// where A and B are constants, update the map with these values:
1849 /// (m, 1+A*B), (n, 1), (o, A), (p, A), (q, A*B), (r, 0)
1851 /// and add 13 + A*B*29 to AccumulatedConstant.
1852 /// This will allow getAddRecExpr to produce this:
1854 /// 13+A*B*29 + n + (m * (1+A*B)) + ((o + p) * A) + (q * A*B)
1856 /// This form often exposes folding opportunities that are hidden in
1857 /// the original operand list.
1859 /// Return true iff it appears that any interesting folding opportunities
1860 /// may be exposed. This helps getAddRecExpr short-circuit extra work in
1861 /// the common case where no interesting opportunities are present, and
1862 /// is also used as a check to avoid infinite recursion.
1865 CollectAddOperandsWithScales(DenseMap<const SCEV *, APInt> &M,
1866 SmallVectorImpl<const SCEV *> &NewOps,
1867 APInt &AccumulatedConstant,
1868 const SCEV *const *Ops, size_t NumOperands,
1870 ScalarEvolution &SE) {
1871 bool Interesting = false;
1873 // Iterate over the add operands. They are sorted, with constants first.
1875 while (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) {
1877 // Pull a buried constant out to the outside.
1878 if (Scale != 1 || AccumulatedConstant != 0 || C->getValue()->isZero())
1880 AccumulatedConstant += Scale * C->getValue()->getValue();
1883 // Next comes everything else. We're especially interested in multiplies
1884 // here, but they're in the middle, so just visit the rest with one loop.
1885 for (; i != NumOperands; ++i) {
1886 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[i]);
1887 if (Mul && isa<SCEVConstant>(Mul->getOperand(0))) {
1889 Scale * cast<SCEVConstant>(Mul->getOperand(0))->getValue()->getValue();
1890 if (Mul->getNumOperands() == 2 && isa<SCEVAddExpr>(Mul->getOperand(1))) {
1891 // A multiplication of a constant with another add; recurse.
1892 const SCEVAddExpr *Add = cast<SCEVAddExpr>(Mul->getOperand(1));
1894 CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant,
1895 Add->op_begin(), Add->getNumOperands(),
1898 // A multiplication of a constant with some other value. Update
1900 SmallVector<const SCEV *, 4> MulOps(Mul->op_begin()+1, Mul->op_end());
1901 const SCEV *Key = SE.getMulExpr(MulOps);
1902 auto Pair = M.insert(std::make_pair(Key, NewScale));
1904 NewOps.push_back(Pair.first->first);
1906 Pair.first->second += NewScale;
1907 // The map already had an entry for this value, which may indicate
1908 // a folding opportunity.
1913 // An ordinary operand. Update the map.
1914 std::pair<DenseMap<const SCEV *, APInt>::iterator, bool> Pair =
1915 M.insert(std::make_pair(Ops[i], Scale));
1917 NewOps.push_back(Pair.first->first);
1919 Pair.first->second += Scale;
1920 // The map already had an entry for this value, which may indicate
1921 // a folding opportunity.
1930 // We're trying to construct a SCEV of type `Type' with `Ops' as operands and
1931 // `OldFlags' as can't-wrap behavior. Infer a more aggressive set of
1932 // can't-overflow flags for the operation if possible.
1933 static SCEV::NoWrapFlags
1934 StrengthenNoWrapFlags(ScalarEvolution *SE, SCEVTypes Type,
1935 const SmallVectorImpl<const SCEV *> &Ops,
1936 SCEV::NoWrapFlags Flags) {
1937 using namespace std::placeholders;
1938 typedef OverflowingBinaryOperator OBO;
1941 Type == scAddExpr || Type == scAddRecExpr || Type == scMulExpr;
1943 assert(CanAnalyze && "don't call from other places!");
1945 int SignOrUnsignMask = SCEV::FlagNUW | SCEV::FlagNSW;
1946 SCEV::NoWrapFlags SignOrUnsignWrap =
1947 ScalarEvolution::maskFlags(Flags, SignOrUnsignMask);
1949 // If FlagNSW is true and all the operands are non-negative, infer FlagNUW.
1950 auto IsKnownNonNegative = [&](const SCEV *S) {
1951 return SE->isKnownNonNegative(S);
1954 if (SignOrUnsignWrap == SCEV::FlagNSW && all_of(Ops, IsKnownNonNegative))
1956 ScalarEvolution::setFlags(Flags, (SCEV::NoWrapFlags)SignOrUnsignMask);
1958 SignOrUnsignWrap = ScalarEvolution::maskFlags(Flags, SignOrUnsignMask);
1960 if (SignOrUnsignWrap != SignOrUnsignMask && Type == scAddExpr &&
1961 Ops.size() == 2 && isa<SCEVConstant>(Ops[0])) {
1963 // (A + C) --> (A + C)<nsw> if the addition does not sign overflow
1964 // (A + C) --> (A + C)<nuw> if the addition does not unsign overflow
1966 const APInt &C = cast<SCEVConstant>(Ops[0])->getValue()->getValue();
1967 if (!(SignOrUnsignWrap & SCEV::FlagNSW)) {
1969 ConstantRange::makeNoWrapRegion(Instruction::Add, C, OBO::NoSignedWrap);
1970 if (NSWRegion.contains(SE->getSignedRange(Ops[1])))
1971 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNSW);
1973 if (!(SignOrUnsignWrap & SCEV::FlagNUW)) {
1975 ConstantRange::makeNoWrapRegion(Instruction::Add, C,
1976 OBO::NoUnsignedWrap);
1977 if (NUWRegion.contains(SE->getUnsignedRange(Ops[1])))
1978 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW);
1985 /// getAddExpr - Get a canonical add expression, or something simpler if
1987 const SCEV *ScalarEvolution::getAddExpr(SmallVectorImpl<const SCEV *> &Ops,
1988 SCEV::NoWrapFlags Flags) {
1989 assert(!(Flags & ~(SCEV::FlagNUW | SCEV::FlagNSW)) &&
1990 "only nuw or nsw allowed");
1991 assert(!Ops.empty() && "Cannot get empty add!");
1992 if (Ops.size() == 1) return Ops[0];
1994 Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
1995 for (unsigned i = 1, e = Ops.size(); i != e; ++i)
1996 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
1997 "SCEVAddExpr operand types don't match!");
2000 // Sort by complexity, this groups all similar expression types together.
2001 GroupByComplexity(Ops, &LI);
2003 Flags = StrengthenNoWrapFlags(this, scAddExpr, Ops, Flags);
2005 // If there are any constants, fold them together.
2007 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
2009 assert(Idx < Ops.size());
2010 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
2011 // We found two constants, fold them together!
2012 Ops[0] = getConstant(LHSC->getValue()->getValue() +
2013 RHSC->getValue()->getValue());
2014 if (Ops.size() == 2) return Ops[0];
2015 Ops.erase(Ops.begin()+1); // Erase the folded element
2016 LHSC = cast<SCEVConstant>(Ops[0]);
2019 // If we are left with a constant zero being added, strip it off.
2020 if (LHSC->getValue()->isZero()) {
2021 Ops.erase(Ops.begin());
2025 if (Ops.size() == 1) return Ops[0];
2028 // Okay, check to see if the same value occurs in the operand list more than
2029 // once. If so, merge them together into an multiply expression. Since we
2030 // sorted the list, these values are required to be adjacent.
2031 Type *Ty = Ops[0]->getType();
2032 bool FoundMatch = false;
2033 for (unsigned i = 0, e = Ops.size(); i != e-1; ++i)
2034 if (Ops[i] == Ops[i+1]) { // X + Y + Y --> X + Y*2
2035 // Scan ahead to count how many equal operands there are.
2037 while (i+Count != e && Ops[i+Count] == Ops[i])
2039 // Merge the values into a multiply.
2040 const SCEV *Scale = getConstant(Ty, Count);
2041 const SCEV *Mul = getMulExpr(Scale, Ops[i]);
2042 if (Ops.size() == Count)
2045 Ops.erase(Ops.begin()+i+1, Ops.begin()+i+Count);
2046 --i; e -= Count - 1;
2050 return getAddExpr(Ops, Flags);
2052 // Check for truncates. If all the operands are truncated from the same
2053 // type, see if factoring out the truncate would permit the result to be
2054 // folded. eg., trunc(x) + m*trunc(n) --> trunc(x + trunc(m)*n)
2055 // if the contents of the resulting outer trunc fold to something simple.
2056 for (; Idx < Ops.size() && isa<SCEVTruncateExpr>(Ops[Idx]); ++Idx) {
2057 const SCEVTruncateExpr *Trunc = cast<SCEVTruncateExpr>(Ops[Idx]);
2058 Type *DstType = Trunc->getType();
2059 Type *SrcType = Trunc->getOperand()->getType();
2060 SmallVector<const SCEV *, 8> LargeOps;
2062 // Check all the operands to see if they can be represented in the
2063 // source type of the truncate.
2064 for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
2065 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Ops[i])) {
2066 if (T->getOperand()->getType() != SrcType) {
2070 LargeOps.push_back(T->getOperand());
2071 } else if (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) {
2072 LargeOps.push_back(getAnyExtendExpr(C, SrcType));
2073 } else if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(Ops[i])) {
2074 SmallVector<const SCEV *, 8> LargeMulOps;
2075 for (unsigned j = 0, f = M->getNumOperands(); j != f && Ok; ++j) {
2076 if (const SCEVTruncateExpr *T =
2077 dyn_cast<SCEVTruncateExpr>(M->getOperand(j))) {
2078 if (T->getOperand()->getType() != SrcType) {
2082 LargeMulOps.push_back(T->getOperand());
2083 } else if (const auto *C = dyn_cast<SCEVConstant>(M->getOperand(j))) {
2084 LargeMulOps.push_back(getAnyExtendExpr(C, SrcType));
2091 LargeOps.push_back(getMulExpr(LargeMulOps));
2098 // Evaluate the expression in the larger type.
2099 const SCEV *Fold = getAddExpr(LargeOps, Flags);
2100 // If it folds to something simple, use it. Otherwise, don't.
2101 if (isa<SCEVConstant>(Fold) || isa<SCEVUnknown>(Fold))
2102 return getTruncateExpr(Fold, DstType);
2106 // Skip past any other cast SCEVs.
2107 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddExpr)
2110 // If there are add operands they would be next.
2111 if (Idx < Ops.size()) {
2112 bool DeletedAdd = false;
2113 while (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[Idx])) {
2114 // If we have an add, expand the add operands onto the end of the operands
2116 Ops.erase(Ops.begin()+Idx);
2117 Ops.append(Add->op_begin(), Add->op_end());
2121 // If we deleted at least one add, we added operands to the end of the list,
2122 // and they are not necessarily sorted. Recurse to resort and resimplify
2123 // any operands we just acquired.
2125 return getAddExpr(Ops);
2128 // Skip over the add expression until we get to a multiply.
2129 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr)
2132 // Check to see if there are any folding opportunities present with
2133 // operands multiplied by constant values.
2134 if (Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx])) {
2135 uint64_t BitWidth = getTypeSizeInBits(Ty);
2136 DenseMap<const SCEV *, APInt> M;
2137 SmallVector<const SCEV *, 8> NewOps;
2138 APInt AccumulatedConstant(BitWidth, 0);
2139 if (CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant,
2140 Ops.data(), Ops.size(),
2141 APInt(BitWidth, 1), *this)) {
2142 struct APIntCompare {
2143 bool operator()(const APInt &LHS, const APInt &RHS) const {
2144 return LHS.ult(RHS);
2148 // Some interesting folding opportunity is present, so its worthwhile to
2149 // re-generate the operands list. Group the operands by constant scale,
2150 // to avoid multiplying by the same constant scale multiple times.
2151 std::map<APInt, SmallVector<const SCEV *, 4>, APIntCompare> MulOpLists;
2152 for (const SCEV *NewOp : NewOps)
2153 MulOpLists[M.find(NewOp)->second].push_back(NewOp);
2154 // Re-generate the operands list.
2156 if (AccumulatedConstant != 0)
2157 Ops.push_back(getConstant(AccumulatedConstant));
2158 for (auto &MulOp : MulOpLists)
2159 if (MulOp.first != 0)
2160 Ops.push_back(getMulExpr(getConstant(MulOp.first),
2161 getAddExpr(MulOp.second)));
2164 if (Ops.size() == 1)
2166 return getAddExpr(Ops);
2170 // If we are adding something to a multiply expression, make sure the
2171 // something is not already an operand of the multiply. If so, merge it into
2173 for (; Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx]); ++Idx) {
2174 const SCEVMulExpr *Mul = cast<SCEVMulExpr>(Ops[Idx]);
2175 for (unsigned MulOp = 0, e = Mul->getNumOperands(); MulOp != e; ++MulOp) {
2176 const SCEV *MulOpSCEV = Mul->getOperand(MulOp);
2177 if (isa<SCEVConstant>(MulOpSCEV))
2179 for (unsigned AddOp = 0, e = Ops.size(); AddOp != e; ++AddOp)
2180 if (MulOpSCEV == Ops[AddOp]) {
2181 // Fold W + X + (X * Y * Z) --> W + (X * ((Y*Z)+1))
2182 const SCEV *InnerMul = Mul->getOperand(MulOp == 0);
2183 if (Mul->getNumOperands() != 2) {
2184 // If the multiply has more than two operands, we must get the
2186 SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(),
2187 Mul->op_begin()+MulOp);
2188 MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end());
2189 InnerMul = getMulExpr(MulOps);
2191 const SCEV *One = getOne(Ty);
2192 const SCEV *AddOne = getAddExpr(One, InnerMul);
2193 const SCEV *OuterMul = getMulExpr(AddOne, MulOpSCEV);
2194 if (Ops.size() == 2) return OuterMul;
2196 Ops.erase(Ops.begin()+AddOp);
2197 Ops.erase(Ops.begin()+Idx-1);
2199 Ops.erase(Ops.begin()+Idx);
2200 Ops.erase(Ops.begin()+AddOp-1);
2202 Ops.push_back(OuterMul);
2203 return getAddExpr(Ops);
2206 // Check this multiply against other multiplies being added together.
2207 for (unsigned OtherMulIdx = Idx+1;
2208 OtherMulIdx < Ops.size() && isa<SCEVMulExpr>(Ops[OtherMulIdx]);
2210 const SCEVMulExpr *OtherMul = cast<SCEVMulExpr>(Ops[OtherMulIdx]);
2211 // If MulOp occurs in OtherMul, we can fold the two multiplies
2213 for (unsigned OMulOp = 0, e = OtherMul->getNumOperands();
2214 OMulOp != e; ++OMulOp)
2215 if (OtherMul->getOperand(OMulOp) == MulOpSCEV) {
2216 // Fold X + (A*B*C) + (A*D*E) --> X + (A*(B*C+D*E))
2217 const SCEV *InnerMul1 = Mul->getOperand(MulOp == 0);
2218 if (Mul->getNumOperands() != 2) {
2219 SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(),
2220 Mul->op_begin()+MulOp);
2221 MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end());
2222 InnerMul1 = getMulExpr(MulOps);
2224 const SCEV *InnerMul2 = OtherMul->getOperand(OMulOp == 0);
2225 if (OtherMul->getNumOperands() != 2) {
2226 SmallVector<const SCEV *, 4> MulOps(OtherMul->op_begin(),
2227 OtherMul->op_begin()+OMulOp);
2228 MulOps.append(OtherMul->op_begin()+OMulOp+1, OtherMul->op_end());
2229 InnerMul2 = getMulExpr(MulOps);
2231 const SCEV *InnerMulSum = getAddExpr(InnerMul1,InnerMul2);
2232 const SCEV *OuterMul = getMulExpr(MulOpSCEV, InnerMulSum);
2233 if (Ops.size() == 2) return OuterMul;
2234 Ops.erase(Ops.begin()+Idx);
2235 Ops.erase(Ops.begin()+OtherMulIdx-1);
2236 Ops.push_back(OuterMul);
2237 return getAddExpr(Ops);
2243 // If there are any add recurrences in the operands list, see if any other
2244 // added values are loop invariant. If so, we can fold them into the
2246 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr)
2249 // Scan over all recurrences, trying to fold loop invariants into them.
2250 for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) {
2251 // Scan all of the other operands to this add and add them to the vector if
2252 // they are loop invariant w.r.t. the recurrence.
2253 SmallVector<const SCEV *, 8> LIOps;
2254 const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]);
2255 const Loop *AddRecLoop = AddRec->getLoop();
2256 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2257 if (isLoopInvariant(Ops[i], AddRecLoop)) {
2258 LIOps.push_back(Ops[i]);
2259 Ops.erase(Ops.begin()+i);
2263 // If we found some loop invariants, fold them into the recurrence.
2264 if (!LIOps.empty()) {
2265 // NLI + LI + {Start,+,Step} --> NLI + {LI+Start,+,Step}
2266 LIOps.push_back(AddRec->getStart());
2268 SmallVector<const SCEV *, 4> AddRecOps(AddRec->op_begin(),
2270 AddRecOps[0] = getAddExpr(LIOps);
2272 // Build the new addrec. Propagate the NUW and NSW flags if both the
2273 // outer add and the inner addrec are guaranteed to have no overflow.
2274 // Always propagate NW.
2275 Flags = AddRec->getNoWrapFlags(setFlags(Flags, SCEV::FlagNW));
2276 const SCEV *NewRec = getAddRecExpr(AddRecOps, AddRecLoop, Flags);
2278 // If all of the other operands were loop invariant, we are done.
2279 if (Ops.size() == 1) return NewRec;
2281 // Otherwise, add the folded AddRec by the non-invariant parts.
2282 for (unsigned i = 0;; ++i)
2283 if (Ops[i] == AddRec) {
2287 return getAddExpr(Ops);
2290 // Okay, if there weren't any loop invariants to be folded, check to see if
2291 // there are multiple AddRec's with the same loop induction variable being
2292 // added together. If so, we can fold them.
2293 for (unsigned OtherIdx = Idx+1;
2294 OtherIdx < Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
2296 if (AddRecLoop == cast<SCEVAddRecExpr>(Ops[OtherIdx])->getLoop()) {
2297 // Other + {A,+,B}<L> + {C,+,D}<L> --> Other + {A+C,+,B+D}<L>
2298 SmallVector<const SCEV *, 4> AddRecOps(AddRec->op_begin(),
2300 for (; OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
2302 if (const auto *OtherAddRec = dyn_cast<SCEVAddRecExpr>(Ops[OtherIdx]))
2303 if (OtherAddRec->getLoop() == AddRecLoop) {
2304 for (unsigned i = 0, e = OtherAddRec->getNumOperands();
2306 if (i >= AddRecOps.size()) {
2307 AddRecOps.append(OtherAddRec->op_begin()+i,
2308 OtherAddRec->op_end());
2311 AddRecOps[i] = getAddExpr(AddRecOps[i],
2312 OtherAddRec->getOperand(i));
2314 Ops.erase(Ops.begin() + OtherIdx); --OtherIdx;
2316 // Step size has changed, so we cannot guarantee no self-wraparound.
2317 Ops[Idx] = getAddRecExpr(AddRecOps, AddRecLoop, SCEV::FlagAnyWrap);
2318 return getAddExpr(Ops);
2321 // Otherwise couldn't fold anything into this recurrence. Move onto the
2325 // Okay, it looks like we really DO need an add expr. Check to see if we
2326 // already have one, otherwise create a new one.
2327 FoldingSetNodeID ID;
2328 ID.AddInteger(scAddExpr);
2329 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2330 ID.AddPointer(Ops[i]);
2333 static_cast<SCEVAddExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
2335 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
2336 std::uninitialized_copy(Ops.begin(), Ops.end(), O);
2337 S = new (SCEVAllocator) SCEVAddExpr(ID.Intern(SCEVAllocator),
2339 UniqueSCEVs.InsertNode(S, IP);
2341 S->setNoWrapFlags(Flags);
2345 static uint64_t umul_ov(uint64_t i, uint64_t j, bool &Overflow) {
2347 if (j > 1 && k / j != i) Overflow = true;
2351 /// Compute the result of "n choose k", the binomial coefficient. If an
2352 /// intermediate computation overflows, Overflow will be set and the return will
2353 /// be garbage. Overflow is not cleared on absence of overflow.
2354 static uint64_t Choose(uint64_t n, uint64_t k, bool &Overflow) {
2355 // We use the multiplicative formula:
2356 // n(n-1)(n-2)...(n-(k-1)) / k(k-1)(k-2)...1 .
2357 // At each iteration, we take the n-th term of the numeral and divide by the
2358 // (k-n)th term of the denominator. This division will always produce an
2359 // integral result, and helps reduce the chance of overflow in the
2360 // intermediate computations. However, we can still overflow even when the
2361 // final result would fit.
2363 if (n == 0 || n == k) return 1;
2364 if (k > n) return 0;
2370 for (uint64_t i = 1; i <= k; ++i) {
2371 r = umul_ov(r, n-(i-1), Overflow);
2377 /// Determine if any of the operands in this SCEV are a constant or if
2378 /// any of the add or multiply expressions in this SCEV contain a constant.
2379 static bool containsConstantSomewhere(const SCEV *StartExpr) {
2380 SmallVector<const SCEV *, 4> Ops;
2381 Ops.push_back(StartExpr);
2382 while (!Ops.empty()) {
2383 const SCEV *CurrentExpr = Ops.pop_back_val();
2384 if (isa<SCEVConstant>(*CurrentExpr))
2387 if (isa<SCEVAddExpr>(*CurrentExpr) || isa<SCEVMulExpr>(*CurrentExpr)) {
2388 const auto *CurrentNAry = cast<SCEVNAryExpr>(CurrentExpr);
2389 Ops.append(CurrentNAry->op_begin(), CurrentNAry->op_end());
2395 /// getMulExpr - Get a canonical multiply expression, or something simpler if
2397 const SCEV *ScalarEvolution::getMulExpr(SmallVectorImpl<const SCEV *> &Ops,
2398 SCEV::NoWrapFlags Flags) {
2399 assert(Flags == maskFlags(Flags, SCEV::FlagNUW | SCEV::FlagNSW) &&
2400 "only nuw or nsw allowed");
2401 assert(!Ops.empty() && "Cannot get empty mul!");
2402 if (Ops.size() == 1) return Ops[0];
2404 Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
2405 for (unsigned i = 1, e = Ops.size(); i != e; ++i)
2406 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
2407 "SCEVMulExpr operand types don't match!");
2410 // Sort by complexity, this groups all similar expression types together.
2411 GroupByComplexity(Ops, &LI);
2413 Flags = StrengthenNoWrapFlags(this, scMulExpr, Ops, Flags);
2415 // If there are any constants, fold them together.
2417 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
2419 // C1*(C2+V) -> C1*C2 + C1*V
2420 if (Ops.size() == 2)
2421 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1]))
2422 // If any of Add's ops are Adds or Muls with a constant,
2423 // apply this transformation as well.
2424 if (Add->getNumOperands() == 2)
2425 if (containsConstantSomewhere(Add))
2426 return getAddExpr(getMulExpr(LHSC, Add->getOperand(0)),
2427 getMulExpr(LHSC, Add->getOperand(1)));
2430 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
2431 // We found two constants, fold them together!
2432 ConstantInt *Fold = ConstantInt::get(getContext(),
2433 LHSC->getValue()->getValue() *
2434 RHSC->getValue()->getValue());
2435 Ops[0] = getConstant(Fold);
2436 Ops.erase(Ops.begin()+1); // Erase the folded element
2437 if (Ops.size() == 1) return Ops[0];
2438 LHSC = cast<SCEVConstant>(Ops[0]);
2441 // If we are left with a constant one being multiplied, strip it off.
2442 if (cast<SCEVConstant>(Ops[0])->getValue()->equalsInt(1)) {
2443 Ops.erase(Ops.begin());
2445 } else if (cast<SCEVConstant>(Ops[0])->getValue()->isZero()) {
2446 // If we have a multiply of zero, it will always be zero.
2448 } else if (Ops[0]->isAllOnesValue()) {
2449 // If we have a mul by -1 of an add, try distributing the -1 among the
2451 if (Ops.size() == 2) {
2452 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1])) {
2453 SmallVector<const SCEV *, 4> NewOps;
2454 bool AnyFolded = false;
2455 for (const SCEV *AddOp : Add->operands()) {
2456 const SCEV *Mul = getMulExpr(Ops[0], AddOp);
2457 if (!isa<SCEVMulExpr>(Mul)) AnyFolded = true;
2458 NewOps.push_back(Mul);
2461 return getAddExpr(NewOps);
2462 } else if (const auto *AddRec = dyn_cast<SCEVAddRecExpr>(Ops[1])) {
2463 // Negation preserves a recurrence's no self-wrap property.
2464 SmallVector<const SCEV *, 4> Operands;
2465 for (const SCEV *AddRecOp : AddRec->operands())
2466 Operands.push_back(getMulExpr(Ops[0], AddRecOp));
2468 return getAddRecExpr(Operands, AddRec->getLoop(),
2469 AddRec->getNoWrapFlags(SCEV::FlagNW));
2474 if (Ops.size() == 1)
2478 // Skip over the add expression until we get to a multiply.
2479 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr)
2482 // If there are mul operands inline them all into this expression.
2483 if (Idx < Ops.size()) {
2484 bool DeletedMul = false;
2485 while (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[Idx])) {
2486 // If we have an mul, expand the mul operands onto the end of the operands
2488 Ops.erase(Ops.begin()+Idx);
2489 Ops.append(Mul->op_begin(), Mul->op_end());
2493 // If we deleted at least one mul, we added operands to the end of the list,
2494 // and they are not necessarily sorted. Recurse to resort and resimplify
2495 // any operands we just acquired.
2497 return getMulExpr(Ops);
2500 // If there are any add recurrences in the operands list, see if any other
2501 // added values are loop invariant. If so, we can fold them into the
2503 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr)
2506 // Scan over all recurrences, trying to fold loop invariants into them.
2507 for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) {
2508 // Scan all of the other operands to this mul and add them to the vector if
2509 // they are loop invariant w.r.t. the recurrence.
2510 SmallVector<const SCEV *, 8> LIOps;
2511 const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]);
2512 const Loop *AddRecLoop = AddRec->getLoop();
2513 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2514 if (isLoopInvariant(Ops[i], AddRecLoop)) {
2515 LIOps.push_back(Ops[i]);
2516 Ops.erase(Ops.begin()+i);
2520 // If we found some loop invariants, fold them into the recurrence.
2521 if (!LIOps.empty()) {
2522 // NLI * LI * {Start,+,Step} --> NLI * {LI*Start,+,LI*Step}
2523 SmallVector<const SCEV *, 4> NewOps;
2524 NewOps.reserve(AddRec->getNumOperands());
2525 const SCEV *Scale = getMulExpr(LIOps);
2526 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i)
2527 NewOps.push_back(getMulExpr(Scale, AddRec->getOperand(i)));
2529 // Build the new addrec. Propagate the NUW and NSW flags if both the
2530 // outer mul and the inner addrec are guaranteed to have no overflow.
2532 // No self-wrap cannot be guaranteed after changing the step size, but
2533 // will be inferred if either NUW or NSW is true.
2534 Flags = AddRec->getNoWrapFlags(clearFlags(Flags, SCEV::FlagNW));
2535 const SCEV *NewRec = getAddRecExpr(NewOps, AddRecLoop, Flags);
2537 // If all of the other operands were loop invariant, we are done.
2538 if (Ops.size() == 1) return NewRec;
2540 // Otherwise, multiply the folded AddRec by the non-invariant parts.
2541 for (unsigned i = 0;; ++i)
2542 if (Ops[i] == AddRec) {
2546 return getMulExpr(Ops);
2549 // Okay, if there weren't any loop invariants to be folded, check to see if
2550 // there are multiple AddRec's with the same loop induction variable being
2551 // multiplied together. If so, we can fold them.
2553 // {A1,+,A2,+,...,+,An}<L> * {B1,+,B2,+,...,+,Bn}<L>
2554 // = {x=1 in [ sum y=x..2x [ sum z=max(y-x, y-n)..min(x,n) [
2555 // choose(x, 2x)*choose(2x-y, x-z)*A_{y-z}*B_z
2556 // ]]],+,...up to x=2n}.
2557 // Note that the arguments to choose() are always integers with values
2558 // known at compile time, never SCEV objects.
2560 // The implementation avoids pointless extra computations when the two
2561 // addrec's are of different length (mathematically, it's equivalent to
2562 // an infinite stream of zeros on the right).
2563 bool OpsModified = false;
2564 for (unsigned OtherIdx = Idx+1;
2565 OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
2567 const SCEVAddRecExpr *OtherAddRec =
2568 dyn_cast<SCEVAddRecExpr>(Ops[OtherIdx]);
2569 if (!OtherAddRec || OtherAddRec->getLoop() != AddRecLoop)
2572 bool Overflow = false;
2573 Type *Ty = AddRec->getType();
2574 bool LargerThan64Bits = getTypeSizeInBits(Ty) > 64;
2575 SmallVector<const SCEV*, 7> AddRecOps;
2576 for (int x = 0, xe = AddRec->getNumOperands() +
2577 OtherAddRec->getNumOperands() - 1; x != xe && !Overflow; ++x) {
2578 const SCEV *Term = getZero(Ty);
2579 for (int y = x, ye = 2*x+1; y != ye && !Overflow; ++y) {
2580 uint64_t Coeff1 = Choose(x, 2*x - y, Overflow);
2581 for (int z = std::max(y-x, y-(int)AddRec->getNumOperands()+1),
2582 ze = std::min(x+1, (int)OtherAddRec->getNumOperands());
2583 z < ze && !Overflow; ++z) {
2584 uint64_t Coeff2 = Choose(2*x - y, x-z, Overflow);
2586 if (LargerThan64Bits)
2587 Coeff = umul_ov(Coeff1, Coeff2, Overflow);
2589 Coeff = Coeff1*Coeff2;
2590 const SCEV *CoeffTerm = getConstant(Ty, Coeff);
2591 const SCEV *Term1 = AddRec->getOperand(y-z);
2592 const SCEV *Term2 = OtherAddRec->getOperand(z);
2593 Term = getAddExpr(Term, getMulExpr(CoeffTerm, Term1,Term2));
2596 AddRecOps.push_back(Term);
2599 const SCEV *NewAddRec = getAddRecExpr(AddRecOps, AddRec->getLoop(),
2601 if (Ops.size() == 2) return NewAddRec;
2602 Ops[Idx] = NewAddRec;
2603 Ops.erase(Ops.begin() + OtherIdx); --OtherIdx;
2605 AddRec = dyn_cast<SCEVAddRecExpr>(NewAddRec);
2611 return getMulExpr(Ops);
2613 // Otherwise couldn't fold anything into this recurrence. Move onto the
2617 // Okay, it looks like we really DO need an mul expr. Check to see if we
2618 // already have one, otherwise create a new one.
2619 FoldingSetNodeID ID;
2620 ID.AddInteger(scMulExpr);
2621 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2622 ID.AddPointer(Ops[i]);
2625 static_cast<SCEVMulExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
2627 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
2628 std::uninitialized_copy(Ops.begin(), Ops.end(), O);
2629 S = new (SCEVAllocator) SCEVMulExpr(ID.Intern(SCEVAllocator),
2631 UniqueSCEVs.InsertNode(S, IP);
2633 S->setNoWrapFlags(Flags);
2637 /// getUDivExpr - Get a canonical unsigned division expression, or something
2638 /// simpler if possible.
2639 const SCEV *ScalarEvolution::getUDivExpr(const SCEV *LHS,
2641 assert(getEffectiveSCEVType(LHS->getType()) ==
2642 getEffectiveSCEVType(RHS->getType()) &&
2643 "SCEVUDivExpr operand types don't match!");
2645 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
2646 if (RHSC->getValue()->equalsInt(1))
2647 return LHS; // X udiv 1 --> x
2648 // If the denominator is zero, the result of the udiv is undefined. Don't
2649 // try to analyze it, because the resolution chosen here may differ from
2650 // the resolution chosen in other parts of the compiler.
2651 if (!RHSC->getValue()->isZero()) {
2652 // Determine if the division can be folded into the operands of
2654 // TODO: Generalize this to non-constants by using known-bits information.
2655 Type *Ty = LHS->getType();
2656 unsigned LZ = RHSC->getValue()->getValue().countLeadingZeros();
2657 unsigned MaxShiftAmt = getTypeSizeInBits(Ty) - LZ - 1;
2658 // For non-power-of-two values, effectively round the value up to the
2659 // nearest power of two.
2660 if (!RHSC->getValue()->getValue().isPowerOf2())
2662 IntegerType *ExtTy =
2663 IntegerType::get(getContext(), getTypeSizeInBits(Ty) + MaxShiftAmt);
2664 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(LHS))
2665 if (const SCEVConstant *Step =
2666 dyn_cast<SCEVConstant>(AR->getStepRecurrence(*this))) {
2667 // {X,+,N}/C --> {X/C,+,N/C} if safe and N/C can be folded.
2668 const APInt &StepInt = Step->getValue()->getValue();
2669 const APInt &DivInt = RHSC->getValue()->getValue();
2670 if (!StepInt.urem(DivInt) &&
2671 getZeroExtendExpr(AR, ExtTy) ==
2672 getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy),
2673 getZeroExtendExpr(Step, ExtTy),
2674 AR->getLoop(), SCEV::FlagAnyWrap)) {
2675 SmallVector<const SCEV *, 4> Operands;
2676 for (const SCEV *Op : AR->operands())
2677 Operands.push_back(getUDivExpr(Op, RHS));
2678 return getAddRecExpr(Operands, AR->getLoop(), SCEV::FlagNW);
2680 /// Get a canonical UDivExpr for a recurrence.
2681 /// {X,+,N}/C => {Y,+,N}/C where Y=X-(X%N). Safe when C%N=0.
2682 // We can currently only fold X%N if X is constant.
2683 const SCEVConstant *StartC = dyn_cast<SCEVConstant>(AR->getStart());
2684 if (StartC && !DivInt.urem(StepInt) &&
2685 getZeroExtendExpr(AR, ExtTy) ==
2686 getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy),
2687 getZeroExtendExpr(Step, ExtTy),
2688 AR->getLoop(), SCEV::FlagAnyWrap)) {
2689 const APInt &StartInt = StartC->getValue()->getValue();
2690 const APInt &StartRem = StartInt.urem(StepInt);
2692 LHS = getAddRecExpr(getConstant(StartInt - StartRem), Step,
2693 AR->getLoop(), SCEV::FlagNW);
2696 // (A*B)/C --> A*(B/C) if safe and B/C can be folded.
2697 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(LHS)) {
2698 SmallVector<const SCEV *, 4> Operands;
2699 for (const SCEV *Op : M->operands())
2700 Operands.push_back(getZeroExtendExpr(Op, ExtTy));
2701 if (getZeroExtendExpr(M, ExtTy) == getMulExpr(Operands))
2702 // Find an operand that's safely divisible.
2703 for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i) {
2704 const SCEV *Op = M->getOperand(i);
2705 const SCEV *Div = getUDivExpr(Op, RHSC);
2706 if (!isa<SCEVUDivExpr>(Div) && getMulExpr(Div, RHSC) == Op) {
2707 Operands = SmallVector<const SCEV *, 4>(M->op_begin(),
2710 return getMulExpr(Operands);
2714 // (A+B)/C --> (A/C + B/C) if safe and A/C and B/C can be folded.
2715 if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(LHS)) {
2716 SmallVector<const SCEV *, 4> Operands;
2717 for (const SCEV *Op : A->operands())
2718 Operands.push_back(getZeroExtendExpr(Op, ExtTy));
2719 if (getZeroExtendExpr(A, ExtTy) == getAddExpr(Operands)) {
2721 for (unsigned i = 0, e = A->getNumOperands(); i != e; ++i) {
2722 const SCEV *Op = getUDivExpr(A->getOperand(i), RHS);
2723 if (isa<SCEVUDivExpr>(Op) ||
2724 getMulExpr(Op, RHS) != A->getOperand(i))
2726 Operands.push_back(Op);
2728 if (Operands.size() == A->getNumOperands())
2729 return getAddExpr(Operands);
2733 // Fold if both operands are constant.
2734 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
2735 Constant *LHSCV = LHSC->getValue();
2736 Constant *RHSCV = RHSC->getValue();
2737 return getConstant(cast<ConstantInt>(ConstantExpr::getUDiv(LHSCV,
2743 FoldingSetNodeID ID;
2744 ID.AddInteger(scUDivExpr);
2748 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
2749 SCEV *S = new (SCEVAllocator) SCEVUDivExpr(ID.Intern(SCEVAllocator),
2751 UniqueSCEVs.InsertNode(S, IP);
2755 static const APInt gcd(const SCEVConstant *C1, const SCEVConstant *C2) {
2756 APInt A = C1->getValue()->getValue().abs();
2757 APInt B = C2->getValue()->getValue().abs();
2758 uint32_t ABW = A.getBitWidth();
2759 uint32_t BBW = B.getBitWidth();
2766 return APIntOps::GreatestCommonDivisor(A, B);
2769 /// getUDivExactExpr - Get a canonical unsigned division expression, or
2770 /// something simpler if possible. There is no representation for an exact udiv
2771 /// in SCEV IR, but we can attempt to remove factors from the LHS and RHS.
2772 /// We can't do this when it's not exact because the udiv may be clearing bits.
2773 const SCEV *ScalarEvolution::getUDivExactExpr(const SCEV *LHS,
2775 // TODO: we could try to find factors in all sorts of things, but for now we
2776 // just deal with u/exact (multiply, constant). See SCEVDivision towards the
2777 // end of this file for inspiration.
2779 const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(LHS);
2781 return getUDivExpr(LHS, RHS);
2783 if (const SCEVConstant *RHSCst = dyn_cast<SCEVConstant>(RHS)) {
2784 // If the mulexpr multiplies by a constant, then that constant must be the
2785 // first element of the mulexpr.
2786 if (const auto *LHSCst = dyn_cast<SCEVConstant>(Mul->getOperand(0))) {
2787 if (LHSCst == RHSCst) {
2788 SmallVector<const SCEV *, 2> Operands;
2789 Operands.append(Mul->op_begin() + 1, Mul->op_end());
2790 return getMulExpr(Operands);
2793 // We can't just assume that LHSCst divides RHSCst cleanly, it could be
2794 // that there's a factor provided by one of the other terms. We need to
2796 APInt Factor = gcd(LHSCst, RHSCst);
2797 if (!Factor.isIntN(1)) {
2798 LHSCst = cast<SCEVConstant>(
2799 getConstant(LHSCst->getValue()->getValue().udiv(Factor)));
2800 RHSCst = cast<SCEVConstant>(
2801 getConstant(RHSCst->getValue()->getValue().udiv(Factor)));
2802 SmallVector<const SCEV *, 2> Operands;
2803 Operands.push_back(LHSCst);
2804 Operands.append(Mul->op_begin() + 1, Mul->op_end());
2805 LHS = getMulExpr(Operands);
2807 Mul = dyn_cast<SCEVMulExpr>(LHS);
2809 return getUDivExactExpr(LHS, RHS);
2814 for (int i = 0, e = Mul->getNumOperands(); i != e; ++i) {
2815 if (Mul->getOperand(i) == RHS) {
2816 SmallVector<const SCEV *, 2> Operands;
2817 Operands.append(Mul->op_begin(), Mul->op_begin() + i);
2818 Operands.append(Mul->op_begin() + i + 1, Mul->op_end());
2819 return getMulExpr(Operands);
2823 return getUDivExpr(LHS, RHS);
2826 /// getAddRecExpr - Get an add recurrence expression for the specified loop.
2827 /// Simplify the expression as much as possible.
2828 const SCEV *ScalarEvolution::getAddRecExpr(const SCEV *Start, const SCEV *Step,
2830 SCEV::NoWrapFlags Flags) {
2831 SmallVector<const SCEV *, 4> Operands;
2832 Operands.push_back(Start);
2833 if (const SCEVAddRecExpr *StepChrec = dyn_cast<SCEVAddRecExpr>(Step))
2834 if (StepChrec->getLoop() == L) {
2835 Operands.append(StepChrec->op_begin(), StepChrec->op_end());
2836 return getAddRecExpr(Operands, L, maskFlags(Flags, SCEV::FlagNW));
2839 Operands.push_back(Step);
2840 return getAddRecExpr(Operands, L, Flags);
2843 /// getAddRecExpr - Get an add recurrence expression for the specified loop.
2844 /// Simplify the expression as much as possible.
2846 ScalarEvolution::getAddRecExpr(SmallVectorImpl<const SCEV *> &Operands,
2847 const Loop *L, SCEV::NoWrapFlags Flags) {
2848 if (Operands.size() == 1) return Operands[0];
2850 Type *ETy = getEffectiveSCEVType(Operands[0]->getType());
2851 for (unsigned i = 1, e = Operands.size(); i != e; ++i)
2852 assert(getEffectiveSCEVType(Operands[i]->getType()) == ETy &&
2853 "SCEVAddRecExpr operand types don't match!");
2854 for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2855 assert(isLoopInvariant(Operands[i], L) &&
2856 "SCEVAddRecExpr operand is not loop-invariant!");
2859 if (Operands.back()->isZero()) {
2860 Operands.pop_back();
2861 return getAddRecExpr(Operands, L, SCEV::FlagAnyWrap); // {X,+,0} --> X
2864 // It's tempting to want to call getMaxBackedgeTakenCount count here and
2865 // use that information to infer NUW and NSW flags. However, computing a
2866 // BE count requires calling getAddRecExpr, so we may not yet have a
2867 // meaningful BE count at this point (and if we don't, we'd be stuck
2868 // with a SCEVCouldNotCompute as the cached BE count).
2870 Flags = StrengthenNoWrapFlags(this, scAddRecExpr, Operands, Flags);
2872 // Canonicalize nested AddRecs in by nesting them in order of loop depth.
2873 if (const SCEVAddRecExpr *NestedAR = dyn_cast<SCEVAddRecExpr>(Operands[0])) {
2874 const Loop *NestedLoop = NestedAR->getLoop();
2875 if (L->contains(NestedLoop)
2876 ? (L->getLoopDepth() < NestedLoop->getLoopDepth())
2877 : (!NestedLoop->contains(L) &&
2878 DT.dominates(L->getHeader(), NestedLoop->getHeader()))) {
2879 SmallVector<const SCEV *, 4> NestedOperands(NestedAR->op_begin(),
2880 NestedAR->op_end());
2881 Operands[0] = NestedAR->getStart();
2882 // AddRecs require their operands be loop-invariant with respect to their
2883 // loops. Don't perform this transformation if it would break this
2885 bool AllInvariant = all_of(
2886 Operands, [&](const SCEV *Op) { return isLoopInvariant(Op, L); });
2889 // Create a recurrence for the outer loop with the same step size.
2891 // The outer recurrence keeps its NW flag but only keeps NUW/NSW if the
2892 // inner recurrence has the same property.
2893 SCEV::NoWrapFlags OuterFlags =
2894 maskFlags(Flags, SCEV::FlagNW | NestedAR->getNoWrapFlags());
2896 NestedOperands[0] = getAddRecExpr(Operands, L, OuterFlags);
2897 AllInvariant = all_of(NestedOperands, [&](const SCEV *Op) {
2898 return isLoopInvariant(Op, NestedLoop);
2902 // Ok, both add recurrences are valid after the transformation.
2904 // The inner recurrence keeps its NW flag but only keeps NUW/NSW if
2905 // the outer recurrence has the same property.
2906 SCEV::NoWrapFlags InnerFlags =
2907 maskFlags(NestedAR->getNoWrapFlags(), SCEV::FlagNW | Flags);
2908 return getAddRecExpr(NestedOperands, NestedLoop, InnerFlags);
2911 // Reset Operands to its original state.
2912 Operands[0] = NestedAR;
2916 // Okay, it looks like we really DO need an addrec expr. Check to see if we
2917 // already have one, otherwise create a new one.
2918 FoldingSetNodeID ID;
2919 ID.AddInteger(scAddRecExpr);
2920 for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2921 ID.AddPointer(Operands[i]);
2925 static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
2927 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Operands.size());
2928 std::uninitialized_copy(Operands.begin(), Operands.end(), O);
2929 S = new (SCEVAllocator) SCEVAddRecExpr(ID.Intern(SCEVAllocator),
2930 O, Operands.size(), L);
2931 UniqueSCEVs.InsertNode(S, IP);
2933 S->setNoWrapFlags(Flags);
2938 ScalarEvolution::getGEPExpr(Type *PointeeType, const SCEV *BaseExpr,
2939 const SmallVectorImpl<const SCEV *> &IndexExprs,
2941 // getSCEV(Base)->getType() has the same address space as Base->getType()
2942 // because SCEV::getType() preserves the address space.
2943 Type *IntPtrTy = getEffectiveSCEVType(BaseExpr->getType());
2944 // FIXME(PR23527): Don't blindly transfer the inbounds flag from the GEP
2945 // instruction to its SCEV, because the Instruction may be guarded by control
2946 // flow and the no-overflow bits may not be valid for the expression in any
2947 // context. This can be fixed similarly to how these flags are handled for
2949 SCEV::NoWrapFlags Wrap = InBounds ? SCEV::FlagNSW : SCEV::FlagAnyWrap;
2951 const SCEV *TotalOffset = getZero(IntPtrTy);
2952 // The address space is unimportant. The first thing we do on CurTy is getting
2953 // its element type.
2954 Type *CurTy = PointerType::getUnqual(PointeeType);
2955 for (const SCEV *IndexExpr : IndexExprs) {
2956 // Compute the (potentially symbolic) offset in bytes for this index.
2957 if (StructType *STy = dyn_cast<StructType>(CurTy)) {
2958 // For a struct, add the member offset.
2959 ConstantInt *Index = cast<SCEVConstant>(IndexExpr)->getValue();
2960 unsigned FieldNo = Index->getZExtValue();
2961 const SCEV *FieldOffset = getOffsetOfExpr(IntPtrTy, STy, FieldNo);
2963 // Add the field offset to the running total offset.
2964 TotalOffset = getAddExpr(TotalOffset, FieldOffset);
2966 // Update CurTy to the type of the field at Index.
2967 CurTy = STy->getTypeAtIndex(Index);
2969 // Update CurTy to its element type.
2970 CurTy = cast<SequentialType>(CurTy)->getElementType();
2971 // For an array, add the element offset, explicitly scaled.
2972 const SCEV *ElementSize = getSizeOfExpr(IntPtrTy, CurTy);
2973 // Getelementptr indices are signed.
2974 IndexExpr = getTruncateOrSignExtend(IndexExpr, IntPtrTy);
2976 // Multiply the index by the element size to compute the element offset.
2977 const SCEV *LocalOffset = getMulExpr(IndexExpr, ElementSize, Wrap);
2979 // Add the element offset to the running total offset.
2980 TotalOffset = getAddExpr(TotalOffset, LocalOffset);
2984 // Add the total offset from all the GEP indices to the base.
2985 return getAddExpr(BaseExpr, TotalOffset, Wrap);
2988 const SCEV *ScalarEvolution::getSMaxExpr(const SCEV *LHS,
2990 SmallVector<const SCEV *, 2> Ops;
2993 return getSMaxExpr(Ops);
2997 ScalarEvolution::getSMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
2998 assert(!Ops.empty() && "Cannot get empty smax!");
2999 if (Ops.size() == 1) return Ops[0];
3001 Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
3002 for (unsigned i = 1, e = Ops.size(); i != e; ++i)
3003 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
3004 "SCEVSMaxExpr operand types don't match!");
3007 // Sort by complexity, this groups all similar expression types together.
3008 GroupByComplexity(Ops, &LI);
3010 // If there are any constants, fold them together.
3012 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
3014 assert(Idx < Ops.size());
3015 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
3016 // We found two constants, fold them together!
3017 ConstantInt *Fold = ConstantInt::get(getContext(),
3018 APIntOps::smax(LHSC->getValue()->getValue(),
3019 RHSC->getValue()->getValue()));
3020 Ops[0] = getConstant(Fold);
3021 Ops.erase(Ops.begin()+1); // Erase the folded element
3022 if (Ops.size() == 1) return Ops[0];
3023 LHSC = cast<SCEVConstant>(Ops[0]);
3026 // If we are left with a constant minimum-int, strip it off.
3027 if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(true)) {
3028 Ops.erase(Ops.begin());
3030 } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(true)) {
3031 // If we have an smax with a constant maximum-int, it will always be
3036 if (Ops.size() == 1) return Ops[0];
3039 // Find the first SMax
3040 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scSMaxExpr)
3043 // Check to see if one of the operands is an SMax. If so, expand its operands
3044 // onto our operand list, and recurse to simplify.
3045 if (Idx < Ops.size()) {
3046 bool DeletedSMax = false;
3047 while (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(Ops[Idx])) {
3048 Ops.erase(Ops.begin()+Idx);
3049 Ops.append(SMax->op_begin(), SMax->op_end());
3054 return getSMaxExpr(Ops);
3057 // Okay, check to see if the same value occurs in the operand list twice. If
3058 // so, delete one. Since we sorted the list, these values are required to
3060 for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
3061 // X smax Y smax Y --> X smax Y
3062 // X smax Y --> X, if X is always greater than Y
3063 if (Ops[i] == Ops[i+1] ||
3064 isKnownPredicate(ICmpInst::ICMP_SGE, Ops[i], Ops[i+1])) {
3065 Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
3067 } else if (isKnownPredicate(ICmpInst::ICMP_SLE, Ops[i], Ops[i+1])) {
3068 Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
3072 if (Ops.size() == 1) return Ops[0];
3074 assert(!Ops.empty() && "Reduced smax down to nothing!");
3076 // Okay, it looks like we really DO need an smax expr. Check to see if we
3077 // already have one, otherwise create a new one.
3078 FoldingSetNodeID ID;
3079 ID.AddInteger(scSMaxExpr);
3080 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
3081 ID.AddPointer(Ops[i]);
3083 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
3084 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
3085 std::uninitialized_copy(Ops.begin(), Ops.end(), O);
3086 SCEV *S = new (SCEVAllocator) SCEVSMaxExpr(ID.Intern(SCEVAllocator),
3088 UniqueSCEVs.InsertNode(S, IP);
3092 const SCEV *ScalarEvolution::getUMaxExpr(const SCEV *LHS,
3094 SmallVector<const SCEV *, 2> Ops;
3097 return getUMaxExpr(Ops);
3101 ScalarEvolution::getUMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
3102 assert(!Ops.empty() && "Cannot get empty umax!");
3103 if (Ops.size() == 1) return Ops[0];
3105 Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
3106 for (unsigned i = 1, e = Ops.size(); i != e; ++i)
3107 assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
3108 "SCEVUMaxExpr operand types don't match!");
3111 // Sort by complexity, this groups all similar expression types together.
3112 GroupByComplexity(Ops, &LI);
3114 // If there are any constants, fold them together.
3116 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
3118 assert(Idx < Ops.size());
3119 while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
3120 // We found two constants, fold them together!
3121 ConstantInt *Fold = ConstantInt::get(getContext(),
3122 APIntOps::umax(LHSC->getValue()->getValue(),
3123 RHSC->getValue()->getValue()));
3124 Ops[0] = getConstant(Fold);
3125 Ops.erase(Ops.begin()+1); // Erase the folded element
3126 if (Ops.size() == 1) return Ops[0];
3127 LHSC = cast<SCEVConstant>(Ops[0]);
3130 // If we are left with a constant minimum-int, strip it off.
3131 if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(false)) {
3132 Ops.erase(Ops.begin());
3134 } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(false)) {
3135 // If we have an umax with a constant maximum-int, it will always be
3140 if (Ops.size() == 1) return Ops[0];
3143 // Find the first UMax
3144 while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scUMaxExpr)
3147 // Check to see if one of the operands is a UMax. If so, expand its operands
3148 // onto our operand list, and recurse to simplify.
3149 if (Idx < Ops.size()) {
3150 bool DeletedUMax = false;
3151 while (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(Ops[Idx])) {
3152 Ops.erase(Ops.begin()+Idx);
3153 Ops.append(UMax->op_begin(), UMax->op_end());
3158 return getUMaxExpr(Ops);
3161 // Okay, check to see if the same value occurs in the operand list twice. If
3162 // so, delete one. Since we sorted the list, these values are required to
3164 for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
3165 // X umax Y umax Y --> X umax Y
3166 // X umax Y --> X, if X is always greater than Y
3167 if (Ops[i] == Ops[i+1] ||
3168 isKnownPredicate(ICmpInst::ICMP_UGE, Ops[i], Ops[i+1])) {
3169 Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
3171 } else if (isKnownPredicate(ICmpInst::ICMP_ULE, Ops[i], Ops[i+1])) {
3172 Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
3176 if (Ops.size() == 1) return Ops[0];
3178 assert(!Ops.empty() && "Reduced umax down to nothing!");
3180 // Okay, it looks like we really DO need a umax expr. Check to see if we
3181 // already have one, otherwise create a new one.
3182 FoldingSetNodeID ID;
3183 ID.AddInteger(scUMaxExpr);
3184 for (unsigned i = 0, e = Ops.size(); i != e; ++i)
3185 ID.AddPointer(Ops[i]);
3187 if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
3188 const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
3189 std::uninitialized_copy(Ops.begin(), Ops.end(), O);
3190 SCEV *S = new (SCEVAllocator) SCEVUMaxExpr(ID.Intern(SCEVAllocator),
3192 UniqueSCEVs.InsertNode(S, IP);
3196 const SCEV *ScalarEvolution::getSMinExpr(const SCEV *LHS,
3198 // ~smax(~x, ~y) == smin(x, y).
3199 return getNotSCEV(getSMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
3202 const SCEV *ScalarEvolution::getUMinExpr(const SCEV *LHS,
3204 // ~umax(~x, ~y) == umin(x, y)
3205 return getNotSCEV(getUMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
3208 const SCEV *ScalarEvolution::getSizeOfExpr(Type *IntTy, Type *AllocTy) {
3209 // We can bypass creating a target-independent
3210 // constant expression and then folding it back into a ConstantInt.
3211 // This is just a compile-time optimization.
3212 return getConstant(IntTy, getDataLayout().getTypeAllocSize(AllocTy));
3215 const SCEV *ScalarEvolution::getOffsetOfExpr(Type *IntTy,
3218 // We can bypass creating a target-independent
3219 // constant expression and then folding it back into a ConstantInt.
3220 // This is just a compile-time optimization.
3222 IntTy, getDataLayout().getStructLayout(STy)->getElementOffset(FieldNo));
3225 const SCEV *ScalarEvolution::getUnknown(Value *V) {
3226 // Don't attempt to do anything other than create a SCEVUnknown object
3227 // here. createSCEV only calls getUnknown after checking for all other
3228 // interesting possibilities, and any other code that calls getUnknown
3229 // is doing so in order to hide a value from SCEV canonicalization.
3231 FoldingSetNodeID ID;
3232 ID.AddInteger(scUnknown);
3235 if (SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) {
3236 assert(cast<SCEVUnknown>(S)->getValue() == V &&
3237 "Stale SCEVUnknown in uniquing map!");
3240 SCEV *S = new (SCEVAllocator) SCEVUnknown(ID.Intern(SCEVAllocator), V, this,
3242 FirstUnknown = cast<SCEVUnknown>(S);
3243 UniqueSCEVs.InsertNode(S, IP);
3247 //===----------------------------------------------------------------------===//
3248 // Basic SCEV Analysis and PHI Idiom Recognition Code
3251 /// isSCEVable - Test if values of the given type are analyzable within
3252 /// the SCEV framework. This primarily includes integer types, and it
3253 /// can optionally include pointer types if the ScalarEvolution class
3254 /// has access to target-specific information.
3255 bool ScalarEvolution::isSCEVable(Type *Ty) const {
3256 // Integers and pointers are always SCEVable.
3257 return Ty->isIntegerTy() || Ty->isPointerTy();
3260 /// getTypeSizeInBits - Return the size in bits of the specified type,
3261 /// for which isSCEVable must return true.
3262 uint64_t ScalarEvolution::getTypeSizeInBits(Type *Ty) const {
3263 assert(isSCEVable(Ty) && "Type is not SCEVable!");
3264 return getDataLayout().getTypeSizeInBits(Ty);
3267 /// getEffectiveSCEVType - Return a type with the same bitwidth as
3268 /// the given type and which represents how SCEV will treat the given
3269 /// type, for which isSCEVable must return true. For pointer types,
3270 /// this is the pointer-sized integer type.
3271 Type *ScalarEvolution::getEffectiveSCEVType(Type *Ty) const {
3272 assert(isSCEVable(Ty) && "Type is not SCEVable!");
3274 if (Ty->isIntegerTy())
3277 // The only other support type is pointer.
3278 assert(Ty->isPointerTy() && "Unexpected non-pointer non-integer type!");
3279 return getDataLayout().getIntPtrType(Ty);
3282 const SCEV *ScalarEvolution::getCouldNotCompute() {
3283 return CouldNotCompute.get();
3287 bool ScalarEvolution::checkValidity(const SCEV *S) const {
3288 // Helper class working with SCEVTraversal to figure out if a SCEV contains
3289 // a SCEVUnknown with null value-pointer. FindInvalidSCEVUnknown::FindOne
3290 // is set iff if find such SCEVUnknown.
3292 struct FindInvalidSCEVUnknown {
3294 FindInvalidSCEVUnknown() { FindOne = false; }
3295 bool follow(const SCEV *S) {
3296 switch (static_cast<SCEVTypes>(S->getSCEVType())) {
3300 if (!cast<SCEVUnknown>(S)->getValue())
3307 bool isDone() const { return FindOne; }
3310 FindInvalidSCEVUnknown F;
3311 SCEVTraversal<FindInvalidSCEVUnknown> ST(F);
3317 /// getSCEV - Return an existing SCEV if it exists, otherwise analyze the
3318 /// expression and create a new one.
3319 const SCEV *ScalarEvolution::getSCEV(Value *V) {
3320 assert(isSCEVable(V->getType()) && "Value is not SCEVable!");
3322 const SCEV *S = getExistingSCEV(V);
3325 ValueExprMap.insert(std::make_pair(SCEVCallbackVH(V, this), S));
3330 const SCEV *ScalarEvolution::getExistingSCEV(Value *V) {
3331 assert(isSCEVable(V->getType()) && "Value is not SCEVable!");
3333 ValueExprMapType::iterator I = ValueExprMap.find_as(V);
3334 if (I != ValueExprMap.end()) {
3335 const SCEV *S = I->second;
3336 if (checkValidity(S))
3338 ValueExprMap.erase(I);
3343 /// getNegativeSCEV - Return a SCEV corresponding to -V = -1*V
3345 const SCEV *ScalarEvolution::getNegativeSCEV(const SCEV *V,
3346 SCEV::NoWrapFlags Flags) {
3347 if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
3349 cast<ConstantInt>(ConstantExpr::getNeg(VC->getValue())));
3351 Type *Ty = V->getType();
3352 Ty = getEffectiveSCEVType(Ty);
3354 V, getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty))), Flags);
3357 /// getNotSCEV - Return a SCEV corresponding to ~V = -1-V
3358 const SCEV *ScalarEvolution::getNotSCEV(const SCEV *V) {
3359 if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
3361 cast<ConstantInt>(ConstantExpr::getNot(VC->getValue())));
3363 Type *Ty = V->getType();
3364 Ty = getEffectiveSCEVType(Ty);
3365 const SCEV *AllOnes =
3366 getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty)));
3367 return getMinusSCEV(AllOnes, V);
3370 /// getMinusSCEV - Return LHS-RHS. Minus is represented in SCEV as A+B*-1.
3371 const SCEV *ScalarEvolution::getMinusSCEV(const SCEV *LHS, const SCEV *RHS,
3372 SCEV::NoWrapFlags Flags) {
3373 // Fast path: X - X --> 0.
3375 return getZero(LHS->getType());
3377 // We represent LHS - RHS as LHS + (-1)*RHS. This transformation
3378 // makes it so that we cannot make much use of NUW.
3379 auto AddFlags = SCEV::FlagAnyWrap;
3380 const bool RHSIsNotMinSigned =
3381 !getSignedRange(RHS).getSignedMin().isMinSignedValue();
3382 if (maskFlags(Flags, SCEV::FlagNSW) == SCEV::FlagNSW) {
3383 // Let M be the minimum representable signed value. Then (-1)*RHS
3384 // signed-wraps if and only if RHS is M. That can happen even for
3385 // a NSW subtraction because e.g. (-1)*M signed-wraps even though
3386 // -1 - M does not. So to transfer NSW from LHS - RHS to LHS +
3387 // (-1)*RHS, we need to prove that RHS != M.
3389 // If LHS is non-negative and we know that LHS - RHS does not
3390 // signed-wrap, then RHS cannot be M. So we can rule out signed-wrap
3391 // either by proving that RHS > M or that LHS >= 0.
3392 if (RHSIsNotMinSigned || isKnownNonNegative(LHS)) {
3393 AddFlags = SCEV::FlagNSW;
3397 // FIXME: Find a correct way to transfer NSW to (-1)*M when LHS -
3398 // RHS is NSW and LHS >= 0.
3400 // The difficulty here is that the NSW flag may have been proven
3401 // relative to a loop that is to be found in a recurrence in LHS and
3402 // not in RHS. Applying NSW to (-1)*M may then let the NSW have a
3403 // larger scope than intended.
3404 auto NegFlags = RHSIsNotMinSigned ? SCEV::FlagNSW : SCEV::FlagAnyWrap;
3406 return getAddExpr(LHS, getNegativeSCEV(RHS, NegFlags), AddFlags);
3409 /// getTruncateOrZeroExtend - Return a SCEV corresponding to a conversion of the
3410 /// input value to the specified type. If the type must be extended, it is zero
3413 ScalarEvolution::getTruncateOrZeroExtend(const SCEV *V, Type *Ty) {
3414 Type *SrcTy = V->getType();
3415 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3416 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3417 "Cannot truncate or zero extend with non-integer arguments!");
3418 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3419 return V; // No conversion
3420 if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
3421 return getTruncateExpr(V, Ty);
3422 return getZeroExtendExpr(V, Ty);
3425 /// getTruncateOrSignExtend - Return a SCEV corresponding to a conversion of the
3426 /// input value to the specified type. If the type must be extended, it is sign
3429 ScalarEvolution::getTruncateOrSignExtend(const SCEV *V,
3431 Type *SrcTy = V->getType();
3432 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3433 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3434 "Cannot truncate or zero extend with non-integer arguments!");
3435 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3436 return V; // No conversion
3437 if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
3438 return getTruncateExpr(V, Ty);
3439 return getSignExtendExpr(V, Ty);
3442 /// getNoopOrZeroExtend - Return a SCEV corresponding to a conversion of the
3443 /// input value to the specified type. If the type must be extended, it is zero
3444 /// extended. The conversion must not be narrowing.
3446 ScalarEvolution::getNoopOrZeroExtend(const SCEV *V, Type *Ty) {
3447 Type *SrcTy = V->getType();
3448 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3449 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3450 "Cannot noop or zero extend with non-integer arguments!");
3451 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
3452 "getNoopOrZeroExtend cannot truncate!");
3453 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3454 return V; // No conversion
3455 return getZeroExtendExpr(V, Ty);
3458 /// getNoopOrSignExtend - Return a SCEV corresponding to a conversion of the
3459 /// input value to the specified type. If the type must be extended, it is sign
3460 /// extended. The conversion must not be narrowing.
3462 ScalarEvolution::getNoopOrSignExtend(const SCEV *V, Type *Ty) {
3463 Type *SrcTy = V->getType();
3464 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3465 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3466 "Cannot noop or sign extend with non-integer arguments!");
3467 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
3468 "getNoopOrSignExtend cannot truncate!");
3469 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3470 return V; // No conversion
3471 return getSignExtendExpr(V, Ty);
3474 /// getNoopOrAnyExtend - Return a SCEV corresponding to a conversion of
3475 /// the input value to the specified type. If the type must be extended,
3476 /// it is extended with unspecified bits. The conversion must not be
3479 ScalarEvolution::getNoopOrAnyExtend(const SCEV *V, Type *Ty) {
3480 Type *SrcTy = V->getType();
3481 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3482 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3483 "Cannot noop or any extend with non-integer arguments!");
3484 assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
3485 "getNoopOrAnyExtend cannot truncate!");
3486 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3487 return V; // No conversion
3488 return getAnyExtendExpr(V, Ty);
3491 /// getTruncateOrNoop - Return a SCEV corresponding to a conversion of the
3492 /// input value to the specified type. The conversion must not be widening.
3494 ScalarEvolution::getTruncateOrNoop(const SCEV *V, Type *Ty) {
3495 Type *SrcTy = V->getType();
3496 assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3497 (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3498 "Cannot truncate or noop with non-integer arguments!");
3499 assert(getTypeSizeInBits(SrcTy) >= getTypeSizeInBits(Ty) &&
3500 "getTruncateOrNoop cannot extend!");
3501 if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3502 return V; // No conversion
3503 return getTruncateExpr(V, Ty);
3506 /// getUMaxFromMismatchedTypes - Promote the operands to the wider of
3507 /// the types using zero-extension, and then perform a umax operation
3509 const SCEV *ScalarEvolution::getUMaxFromMismatchedTypes(const SCEV *LHS,
3511 const SCEV *PromotedLHS = LHS;
3512 const SCEV *PromotedRHS = RHS;
3514 if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
3515 PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
3517 PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
3519 return getUMaxExpr(PromotedLHS, PromotedRHS);
3522 /// getUMinFromMismatchedTypes - Promote the operands to the wider of
3523 /// the types using zero-extension, and then perform a umin operation
3525 const SCEV *ScalarEvolution::getUMinFromMismatchedTypes(const SCEV *LHS,
3527 const SCEV *PromotedLHS = LHS;
3528 const SCEV *PromotedRHS = RHS;
3530 if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
3531 PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
3533 PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
3535 return getUMinExpr(PromotedLHS, PromotedRHS);
3538 /// getPointerBase - Transitively follow the chain of pointer-type operands
3539 /// until reaching a SCEV that does not have a single pointer operand. This
3540 /// returns a SCEVUnknown pointer for well-formed pointer-type expressions,
3541 /// but corner cases do exist.
3542 const SCEV *ScalarEvolution::getPointerBase(const SCEV *V) {
3543 // A pointer operand may evaluate to a nonpointer expression, such as null.
3544 if (!V->getType()->isPointerTy())
3547 if (const SCEVCastExpr *Cast = dyn_cast<SCEVCastExpr>(V)) {
3548 return getPointerBase(Cast->getOperand());
3549 } else if (const SCEVNAryExpr *NAry = dyn_cast<SCEVNAryExpr>(V)) {
3550 const SCEV *PtrOp = nullptr;
3551 for (const SCEV *NAryOp : NAry->operands()) {
3552 if (NAryOp->getType()->isPointerTy()) {
3553 // Cannot find the base of an expression with multiple pointer operands.
3561 return getPointerBase(PtrOp);
3566 /// PushDefUseChildren - Push users of the given Instruction
3567 /// onto the given Worklist.
3569 PushDefUseChildren(Instruction *I,
3570 SmallVectorImpl<Instruction *> &Worklist) {
3571 // Push the def-use children onto the Worklist stack.
3572 for (User *U : I->users())
3573 Worklist.push_back(cast<Instruction>(U));
3576 /// ForgetSymbolicValue - This looks up computed SCEV values for all
3577 /// instructions that depend on the given instruction and removes them from
3578 /// the ValueExprMapType map if they reference SymName. This is used during PHI
3581 ScalarEvolution::ForgetSymbolicName(Instruction *PN, const SCEV *SymName) {
3582 SmallVector<Instruction *, 16> Worklist;
3583 PushDefUseChildren(PN, Worklist);
3585 SmallPtrSet<Instruction *, 8> Visited;
3587 while (!Worklist.empty()) {
3588 Instruction *I = Worklist.pop_back_val();
3589 if (!Visited.insert(I).second)
3592 auto It = ValueExprMap.find_as(static_cast<Value *>(I));
3593 if (It != ValueExprMap.end()) {
3594 const SCEV *Old = It->second;
3596 // Short-circuit the def-use traversal if the symbolic name
3597 // ceases to appear in expressions.
3598 if (Old != SymName && !hasOperand(Old, SymName))
3601 // SCEVUnknown for a PHI either means that it has an unrecognized
3602 // structure, it's a PHI that's in the progress of being computed
3603 // by createNodeForPHI, or it's a single-value PHI. In the first case,
3604 // additional loop trip count information isn't going to change anything.
3605 // In the second case, createNodeForPHI will perform the necessary
3606 // updates on its own when it gets to that point. In the third, we do
3607 // want to forget the SCEVUnknown.
3608 if (!isa<PHINode>(I) ||
3609 !isa<SCEVUnknown>(Old) ||
3610 (I != PN && Old == SymName)) {
3611 forgetMemoizedResults(Old);
3612 ValueExprMap.erase(It);
3616 PushDefUseChildren(I, Worklist);
3621 class SCEVInitRewriter : public SCEVRewriteVisitor<SCEVInitRewriter> {
3623 static const SCEV *rewrite(const SCEV *Scev, const Loop *L,
3624 ScalarEvolution &SE) {
3625 SCEVInitRewriter Rewriter(L, SE);
3626 const SCEV *Result = Rewriter.visit(Scev);
3627 return Rewriter.isValid() ? Result : SE.getCouldNotCompute();
3630 SCEVInitRewriter(const Loop *L, ScalarEvolution &SE)
3631 : SCEVRewriteVisitor(SE), L(L), Valid(true) {}
3633 const SCEV *visitUnknown(const SCEVUnknown *Expr) {
3634 if (!(SE.getLoopDisposition(Expr, L) == ScalarEvolution::LoopInvariant))
3639 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) {
3640 // Only allow AddRecExprs for this loop.
3641 if (Expr->getLoop() == L)
3642 return Expr->getStart();
3647 bool isValid() { return Valid; }
3654 class SCEVShiftRewriter : public SCEVRewriteVisitor<SCEVShiftRewriter> {
3656 static const SCEV *rewrite(const SCEV *Scev, const Loop *L,
3657 ScalarEvolution &SE) {
3658 SCEVShiftRewriter Rewriter(L, SE);
3659 const SCEV *Result = Rewriter.visit(Scev);
3660 return Rewriter.isValid() ? Result : SE.getCouldNotCompute();
3663 SCEVShiftRewriter(const Loop *L, ScalarEvolution &SE)
3664 : SCEVRewriteVisitor(SE), L(L), Valid(true) {}
3666 const SCEV *visitUnknown(const SCEVUnknown *Expr) {
3667 // Only allow AddRecExprs for this loop.
3668 if (!(SE.getLoopDisposition(Expr, L) == ScalarEvolution::LoopInvariant))
3673 const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) {
3674 if (Expr->getLoop() == L && Expr->isAffine())
3675 return SE.getMinusSCEV(Expr, Expr->getStepRecurrence(SE));
3679 bool isValid() { return Valid; }
3685 } // end anonymous namespace
3687 const SCEV *ScalarEvolution::createAddRecFromPHI(PHINode *PN) {
3688 const Loop *L = LI.getLoopFor(PN->getParent());
3689 if (!L || L->getHeader() != PN->getParent())
3692 // The loop may have multiple entrances or multiple exits; we can analyze
3693 // this phi as an addrec if it has a unique entry value and a unique
3695 Value *BEValueV = nullptr, *StartValueV = nullptr;
3696 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
3697 Value *V = PN->getIncomingValue(i);
3698 if (L->contains(PN->getIncomingBlock(i))) {
3701 } else if (BEValueV != V) {
3705 } else if (!StartValueV) {
3707 } else if (StartValueV != V) {
3708 StartValueV = nullptr;
3712 if (BEValueV && StartValueV) {
3713 // While we are analyzing this PHI node, handle its value symbolically.
3714 const SCEV *SymbolicName = getUnknown(PN);
3715 assert(ValueExprMap.find_as(PN) == ValueExprMap.end() &&
3716 "PHI node already processed?");
3717 ValueExprMap.insert(std::make_pair(SCEVCallbackVH(PN, this), SymbolicName));
3719 // Using this symbolic name for the PHI, analyze the value coming around
3721 const SCEV *BEValue = getSCEV(BEValueV);
3723 // NOTE: If BEValue is loop invariant, we know that the PHI node just
3724 // has a special value for the first iteration of the loop.
3726 // If the value coming around the backedge is an add with the symbolic
3727 // value we just inserted, then we found a simple induction variable!
3728 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(BEValue)) {
3729 // If there is a single occurrence of the symbolic value, replace it
3730 // with a recurrence.
3731 unsigned FoundIndex = Add->getNumOperands();
3732 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
3733 if (Add->getOperand(i) == SymbolicName)
3734 if (FoundIndex == e) {
3739 if (FoundIndex != Add->getNumOperands()) {
3740 // Create an add with everything but the specified operand.
3741 SmallVector<const SCEV *, 8> Ops;
3742 for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
3743 if (i != FoundIndex)
3744 Ops.push_back(Add->getOperand(i));
3745 const SCEV *Accum = getAddExpr(Ops);
3747 // This is not a valid addrec if the step amount is varying each
3748 // loop iteration, but is not itself an addrec in this loop.
3749 if (isLoopInvariant(Accum, L) ||
3750 (isa<SCEVAddRecExpr>(Accum) &&
3751 cast<SCEVAddRecExpr>(Accum)->getLoop() == L)) {
3752 SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap;
3754 // If the increment doesn't overflow, then neither the addrec nor
3755 // the post-increment will overflow.
3756 if (const AddOperator *OBO = dyn_cast<AddOperator>(BEValueV)) {
3757 if (OBO->getOperand(0) == PN) {
3758 if (OBO->hasNoUnsignedWrap())
3759 Flags = setFlags(Flags, SCEV::FlagNUW);
3760 if (OBO->hasNoSignedWrap())
3761 Flags = setFlags(Flags, SCEV::FlagNSW);
3763 } else if (GEPOperator *GEP = dyn_cast<GEPOperator>(BEValueV)) {
3764 // If the increment is an inbounds GEP, then we know the address
3765 // space cannot be wrapped around. We cannot make any guarantee
3766 // about signed or unsigned overflow because pointers are
3767 // unsigned but we may have a negative index from the base
3768 // pointer. We can guarantee that no unsigned wrap occurs if the
3769 // indices form a positive value.
3770 if (GEP->isInBounds() && GEP->getOperand(0) == PN) {
3771 Flags = setFlags(Flags, SCEV::FlagNW);
3773 const SCEV *Ptr = getSCEV(GEP->getPointerOperand());
3774 if (isKnownPositive(getMinusSCEV(getSCEV(GEP), Ptr)))
3775 Flags = setFlags(Flags, SCEV::FlagNUW);
3778 // We cannot transfer nuw and nsw flags from subtraction
3779 // operations -- sub nuw X, Y is not the same as add nuw X, -Y
3783 const SCEV *StartVal = getSCEV(StartValueV);
3784 const SCEV *PHISCEV = getAddRecExpr(StartVal, Accum, L, Flags);
3786 // Since the no-wrap flags are on the increment, they apply to the
3787 // post-incremented value as well.
3788 if (isLoopInvariant(Accum, L))
3789 (void)getAddRecExpr(getAddExpr(StartVal, Accum), Accum, L, Flags);
3791 // Okay, for the entire analysis of this edge we assumed the PHI
3792 // to be symbolic. We now need to go back and purge all of the
3793 // entries for the scalars that use the symbolic expression.
3794 ForgetSymbolicName(PN, SymbolicName);
3795 ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
3800 // Otherwise, this could be a loop like this:
3801 // i = 0; for (j = 1; ..; ++j) { .... i = j; }
3802 // In this case, j = {1,+,1} and BEValue is j.
3803 // Because the other in-value of i (0) fits the evolution of BEValue
3804 // i really is an addrec evolution.
3806 // We can generalize this saying that i is the shifted value of BEValue
3807 // by one iteration:
3808 // PHI(f(0), f({1,+,1})) --> f({0,+,1})
3809 const SCEV *Shifted = SCEVShiftRewriter::rewrite(BEValue, L, *this);
3810 const SCEV *Start = SCEVInitRewriter::rewrite(Shifted, L, *this);
3811 if (Shifted != getCouldNotCompute() &&
3812 Start != getCouldNotCompute()) {
3813 const SCEV *StartVal = getSCEV(StartValueV);
3814 if (Start == StartVal) {
3815 // Okay, for the entire analysis of this edge we assumed the PHI
3816 // to be symbolic. We now need to go back and purge all of the
3817 // entries for the scalars that use the symbolic expression.
3818 ForgetSymbolicName(PN, SymbolicName);
3819 ValueExprMap[SCEVCallbackVH(PN, this)] = Shifted;
3829 // Checks if the SCEV S is available at BB. S is considered available at BB
3830 // if S can be materialized at BB without introducing a fault.
3831 static bool IsAvailableOnEntry(const Loop *L, DominatorTree &DT, const SCEV *S,
3833 struct CheckAvailable {
3834 bool TraversalDone = false;
3835 bool Available = true;
3837 const Loop *L = nullptr; // The loop BB is in (can be nullptr)
3838 BasicBlock *BB = nullptr;
3841 CheckAvailable(const Loop *L, BasicBlock *BB, DominatorTree &DT)
3842 : L(L), BB(BB), DT(DT) {}
3844 bool setUnavailable() {
3845 TraversalDone = true;
3850 bool follow(const SCEV *S) {
3851 switch (S->getSCEVType()) {
3852 case scConstant: case scTruncate: case scZeroExtend: case scSignExtend:
3853 case scAddExpr: case scMulExpr: case scUMaxExpr: case scSMaxExpr:
3854 // These expressions are available if their operand(s) is/are.
3857 case scAddRecExpr: {
3858 // We allow add recurrences that are on the loop BB is in, or some
3859 // outer loop. This guarantees availability because the value of the
3860 // add recurrence at BB is simply the "current" value of the induction
3861 // variable. We can relax this in the future; for instance an add
3862 // recurrence on a sibling dominating loop is also available at BB.
3863 const auto *ARLoop = cast<SCEVAddRecExpr>(S)->getLoop();
3864 if (L && (ARLoop == L || ARLoop->contains(L)))
3867 return setUnavailable();
3871 // For SCEVUnknown, we check for simple dominance.
3872 const auto *SU = cast<SCEVUnknown>(S);
3873 Value *V = SU->getValue();
3875 if (isa<Argument>(V))
3878 if (isa<Instruction>(V) && DT.dominates(cast<Instruction>(V), BB))
3881 return setUnavailable();
3885 case scCouldNotCompute:
3886 // We do not try to smart about these at all.
3887 return setUnavailable();
3889 llvm_unreachable("switch should be fully covered!");
3892 bool isDone() { return TraversalDone; }
3895 CheckAvailable CA(L, BB, DT);
3896 SCEVTraversal<CheckAvailable> ST(CA);
3899 return CA.Available;
3902 // Try to match a control flow sequence that branches out at BI and merges back
3903 // at Merge into a "C ? LHS : RHS" select pattern. Return true on a successful
3905 static bool BrPHIToSelect(DominatorTree &DT, BranchInst *BI, PHINode *Merge,
3906 Value *&C, Value *&LHS, Value *&RHS) {
3907 C = BI->getCondition();
3909 BasicBlockEdge LeftEdge(BI->getParent(), BI->getSuccessor(0));
3910 BasicBlockEdge RightEdge(BI->getParent(), BI->getSuccessor(1));
3912 if (!LeftEdge.isSingleEdge())
3915 assert(RightEdge.isSingleEdge() && "Follows from LeftEdge.isSingleEdge()");
3917 Use &LeftUse = Merge->getOperandUse(0);
3918 Use &RightUse = Merge->getOperandUse(1);
3920 if (DT.dominates(LeftEdge, LeftUse) && DT.dominates(RightEdge, RightUse)) {
3926 if (DT.dominates(LeftEdge, RightUse) && DT.dominates(RightEdge, LeftUse)) {
3935 const SCEV *ScalarEvolution::createNodeFromSelectLikePHI(PHINode *PN) {
3936 if (PN->getNumIncomingValues() == 2) {
3937 const Loop *L = LI.getLoopFor(PN->getParent());
3939 // We don't want to break LCSSA, even in a SCEV expression tree.
3940 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
3941 if (LI.getLoopFor(PN->getIncomingBlock(i)) != L)
3946 // br %cond, label %left, label %right
3952 // V = phi [ %x, %left ], [ %y, %right ]
3954 // as "select %cond, %x, %y"
3956 BasicBlock *IDom = DT[PN->getParent()]->getIDom()->getBlock();
3957 assert(IDom && "At least the entry block should dominate PN");
3959 auto *BI = dyn_cast<BranchInst>(IDom->getTerminator());
3960 Value *Cond = nullptr, *LHS = nullptr, *RHS = nullptr;
3962 if (BI && BI->isConditional() &&
3963 BrPHIToSelect(DT, BI, PN, Cond, LHS, RHS) &&
3964 IsAvailableOnEntry(L, DT, getSCEV(LHS), PN->getParent()) &&
3965 IsAvailableOnEntry(L, DT, getSCEV(RHS), PN->getParent()))
3966 return createNodeForSelectOrPHI(PN, Cond, LHS, RHS);
3972 const SCEV *ScalarEvolution::createNodeForPHI(PHINode *PN) {
3973 if (const SCEV *S = createAddRecFromPHI(PN))
3976 if (const SCEV *S = createNodeFromSelectLikePHI(PN))
3979 // If the PHI has a single incoming value, follow that value, unless the
3980 // PHI's incoming blocks are in a different loop, in which case doing so
3981 // risks breaking LCSSA form. Instcombine would normally zap these, but
3982 // it doesn't have DominatorTree information, so it may miss cases.
3983 if (Value *V = SimplifyInstruction(PN, getDataLayout(), &TLI, &DT, &AC))
3984 if (LI.replacementPreservesLCSSAForm(PN, V))
3987 // If it's not a loop phi, we can't handle it yet.
3988 return getUnknown(PN);
3991 const SCEV *ScalarEvolution::createNodeForSelectOrPHI(Instruction *I,
3995 // Handle "constant" branch or select. This can occur for instance when a
3996 // loop pass transforms an inner loop and moves on to process the outer loop.
3997 if (auto *CI = dyn_cast<ConstantInt>(Cond))
3998 return getSCEV(CI->isOne() ? TrueVal : FalseVal);
4000 // Try to match some simple smax or umax patterns.
4001 auto *ICI = dyn_cast<ICmpInst>(Cond);
4003 return getUnknown(I);
4005 Value *LHS = ICI->getOperand(0);
4006 Value *RHS = ICI->getOperand(1);
4008 switch (ICI->getPredicate()) {
4009 case ICmpInst::ICMP_SLT:
4010 case ICmpInst::ICMP_SLE:
4011 std::swap(LHS, RHS);
4013 case ICmpInst::ICMP_SGT:
4014 case ICmpInst::ICMP_SGE:
4015 // a >s b ? a+x : b+x -> smax(a, b)+x
4016 // a >s b ? b+x : a+x -> smin(a, b)+x
4017 if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType())) {
4018 const SCEV *LS = getNoopOrSignExtend(getSCEV(LHS), I->getType());
4019 const SCEV *RS = getNoopOrSignExtend(getSCEV(RHS), I->getType());
4020 const SCEV *LA = getSCEV(TrueVal);
4021 const SCEV *RA = getSCEV(FalseVal);
4022 const SCEV *LDiff = getMinusSCEV(LA, LS);
4023 const SCEV *RDiff = getMinusSCEV(RA, RS);
4025 return getAddExpr(getSMaxExpr(LS, RS), LDiff);
4026 LDiff = getMinusSCEV(LA, RS);
4027 RDiff = getMinusSCEV(RA, LS);
4029 return getAddExpr(getSMinExpr(LS, RS), LDiff);
4032 case ICmpInst::ICMP_ULT:
4033 case ICmpInst::ICMP_ULE:
4034 std::swap(LHS, RHS);
4036 case ICmpInst::ICMP_UGT:
4037 case ICmpInst::ICMP_UGE:
4038 // a >u b ? a+x : b+x -> umax(a, b)+x
4039 // a >u b ? b+x : a+x -> umin(a, b)+x
4040 if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType())) {
4041 const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), I->getType());
4042 const SCEV *RS = getNoopOrZeroExtend(getSCEV(RHS), I->getType());
4043 const SCEV *LA = getSCEV(TrueVal);
4044 const SCEV *RA = getSCEV(FalseVal);
4045 const SCEV *LDiff = getMinusSCEV(LA, LS);
4046 const SCEV *RDiff = getMinusSCEV(RA, RS);
4048 return getAddExpr(getUMaxExpr(LS, RS), LDiff);
4049 LDiff = getMinusSCEV(LA, RS);
4050 RDiff = getMinusSCEV(RA, LS);
4052 return getAddExpr(getUMinExpr(LS, RS), LDiff);
4055 case ICmpInst::ICMP_NE:
4056 // n != 0 ? n+x : 1+x -> umax(n, 1)+x
4057 if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType()) &&
4058 isa<ConstantInt>(RHS) && cast<ConstantInt>(RHS)->isZero()) {
4059 const SCEV *One = getOne(I->getType());
4060 const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), I->getType());
4061 const SCEV *LA = getSCEV(TrueVal);
4062 const SCEV *RA = getSCEV(FalseVal);
4063 const SCEV *LDiff = getMinusSCEV(LA, LS);
4064 const SCEV *RDiff = getMinusSCEV(RA, One);
4066 return getAddExpr(getUMaxExpr(One, LS), LDiff);
4069 case ICmpInst::ICMP_EQ:
4070 // n == 0 ? 1+x : n+x -> umax(n, 1)+x
4071 if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType()) &&
4072 isa<ConstantInt>(RHS) && cast<ConstantInt>(RHS)->isZero()) {
4073 const SCEV *One = getOne(I->getType());
4074 const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), I->getType());
4075 const SCEV *LA = getSCEV(TrueVal);
4076 const SCEV *RA = getSCEV(FalseVal);
4077 const SCEV *LDiff = getMinusSCEV(LA, One);
4078 const SCEV *RDiff = getMinusSCEV(RA, LS);
4080 return getAddExpr(getUMaxExpr(One, LS), LDiff);
4087 return getUnknown(I);
4090 /// createNodeForGEP - Expand GEP instructions into add and multiply
4091 /// operations. This allows them to be analyzed by regular SCEV code.
4093 const SCEV *ScalarEvolution::createNodeForGEP(GEPOperator *GEP) {
4094 Value *Base = GEP->getOperand(0);
4095 // Don't attempt to analyze GEPs over unsized objects.
4096 if (!Base->getType()->getPointerElementType()->isSized())
4097 return getUnknown(GEP);
4099 SmallVector<const SCEV *, 4> IndexExprs;
4100 for (auto Index = GEP->idx_begin(); Index != GEP->idx_end(); ++Index)
4101 IndexExprs.push_back(getSCEV(*Index));
4102 return getGEPExpr(GEP->getSourceElementType(), getSCEV(Base), IndexExprs,
4106 /// GetMinTrailingZeros - Determine the minimum number of zero bits that S is
4107 /// guaranteed to end in (at every loop iteration). It is, at the same time,
4108 /// the minimum number of times S is divisible by 2. For example, given {4,+,8}
4109 /// it returns 2. If S is guaranteed to be 0, it returns the bitwidth of S.
4111 ScalarEvolution::GetMinTrailingZeros(const SCEV *S) {
4112 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
4113 return C->getValue()->getValue().countTrailingZeros();
4115 if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(S))
4116 return std::min(GetMinTrailingZeros(T->getOperand()),
4117 (uint32_t)getTypeSizeInBits(T->getType()));
4119 if (const SCEVZeroExtendExpr *E = dyn_cast<SCEVZeroExtendExpr>(S)) {
4120 uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
4121 return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
4122 getTypeSizeInBits(E->getType()) : OpRes;
4125 if (const SCEVSignExtendExpr *E = dyn_cast<SCEVSignExtendExpr>(S)) {
4126 uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
4127 return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
4128 getTypeSizeInBits(E->getType()) : OpRes;
4131 if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(S)) {
4132 // The result is the min of all operands results.
4133 uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
4134 for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
4135 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
4139 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(S)) {
4140 // The result is the sum of all operands results.
4141 uint32_t SumOpRes = GetMinTrailingZeros(M->getOperand(0));
4142 uint32_t BitWidth = getTypeSizeInBits(M->getType());
4143 for (unsigned i = 1, e = M->getNumOperands();
4144 SumOpRes != BitWidth && i != e; ++i)
4145 SumOpRes = std::min(SumOpRes + GetMinTrailingZeros(M->getOperand(i)),
4150 if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(S)) {
4151 // The result is the min of all operands results.
4152 uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
4153 for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
4154 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
4158 if (const SCEVSMaxExpr *M = dyn_cast<SCEVSMaxExpr>(S)) {
4159 // The result is the min of all operands results.
4160 uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
4161 for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
4162 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
4166 if (const SCEVUMaxExpr *M = dyn_cast<SCEVUMaxExpr>(S)) {
4167 // The result is the min of all operands results.
4168 uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
4169 for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
4170 MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
4174 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
4175 // For a SCEVUnknown, ask ValueTracking.
4176 unsigned BitWidth = getTypeSizeInBits(U->getType());
4177 APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
4178 computeKnownBits(U->getValue(), Zeros, Ones, getDataLayout(), 0, &AC,
4180 return Zeros.countTrailingOnes();
4187 /// GetRangeFromMetadata - Helper method to assign a range to V from
4188 /// metadata present in the IR.
4189 static Optional<ConstantRange> GetRangeFromMetadata(Value *V) {
4190 if (Instruction *I = dyn_cast<Instruction>(V))
4191 if (MDNode *MD = I->getMetadata(LLVMContext::MD_range))
4192 return getConstantRangeFromMetadata(*MD);
4197 /// getRange - Determine the range for a particular SCEV. If SignHint is
4198 /// HINT_RANGE_UNSIGNED (resp. HINT_RANGE_SIGNED) then getRange prefers ranges
4199 /// with a "cleaner" unsigned (resp. signed) representation.
4202 ScalarEvolution::getRange(const SCEV *S,
4203 ScalarEvolution::RangeSignHint SignHint) {
4204 DenseMap<const SCEV *, ConstantRange> &Cache =
4205 SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED ? UnsignedRanges
4208 // See if we've computed this range already.
4209 DenseMap<const SCEV *, ConstantRange>::iterator I = Cache.find(S);
4210 if (I != Cache.end())
4213 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
4214 return setRange(C, SignHint, ConstantRange(C->getValue()->getValue()));
4216 unsigned BitWidth = getTypeSizeInBits(S->getType());
4217 ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true);
4219 // If the value has known zeros, the maximum value will have those known zeros
4221 uint32_t TZ = GetMinTrailingZeros(S);
4223 if (SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED)
4224 ConservativeResult =
4225 ConstantRange(APInt::getMinValue(BitWidth),
4226 APInt::getMaxValue(BitWidth).lshr(TZ).shl(TZ) + 1);
4228 ConservativeResult = ConstantRange(
4229 APInt::getSignedMinValue(BitWidth),
4230 APInt::getSignedMaxValue(BitWidth).ashr(TZ).shl(TZ) + 1);
4233 if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
4234 ConstantRange X = getRange(Add->getOperand(0), SignHint);
4235 for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i)
4236 X = X.add(getRange(Add->getOperand(i), SignHint));
4237 return setRange(Add, SignHint, ConservativeResult.intersectWith(X));
4240 if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
4241 ConstantRange X = getRange(Mul->getOperand(0), SignHint);
4242 for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i)
4243 X = X.multiply(getRange(Mul->getOperand(i), SignHint));
4244 return setRange(Mul, SignHint, ConservativeResult.intersectWith(X));
4247 if (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(S)) {
4248 ConstantRange X = getRange(SMax->getOperand(0), SignHint);
4249 for (unsigned i = 1, e = SMax->getNumOperands(); i != e; ++i)
4250 X = X.smax(getRange(SMax->getOperand(i), SignHint));
4251 return setRange(SMax, SignHint, ConservativeResult.intersectWith(X));
4254 if (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(S)) {
4255 ConstantRange X = getRange(UMax->getOperand(0), SignHint);
4256 for (unsigned i = 1, e = UMax->getNumOperands(); i != e; ++i)
4257 X = X.umax(getRange(UMax->getOperand(i), SignHint));
4258 return setRange(UMax, SignHint, ConservativeResult.intersectWith(X));
4261 if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) {
4262 ConstantRange X = getRange(UDiv->getLHS(), SignHint);
4263 ConstantRange Y = getRange(UDiv->getRHS(), SignHint);
4264 return setRange(UDiv, SignHint,
4265 ConservativeResult.intersectWith(X.udiv(Y)));
4268 if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) {
4269 ConstantRange X = getRange(ZExt->getOperand(), SignHint);
4270 return setRange(ZExt, SignHint,
4271 ConservativeResult.intersectWith(X.zeroExtend(BitWidth)));
4274 if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) {
4275 ConstantRange X = getRange(SExt->getOperand(), SignHint);
4276 return setRange(SExt, SignHint,
4277 ConservativeResult.intersectWith(X.signExtend(BitWidth)));
4280 if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) {
4281 ConstantRange X = getRange(Trunc->getOperand(), SignHint);
4282 return setRange(Trunc, SignHint,
4283 ConservativeResult.intersectWith(X.truncate(BitWidth)));
4286 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) {
4287 // If there's no unsigned wrap, the value will never be less than its
4289 if (AddRec->getNoWrapFlags(SCEV::FlagNUW))
4290 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(AddRec->getStart()))
4291 if (!C->getValue()->isZero())
4292 ConservativeResult =
4293 ConservativeResult.intersectWith(
4294 ConstantRange(C->getValue()->getValue(), APInt(BitWidth, 0)));
4296 // If there's no signed wrap, and all the operands have the same sign or
4297 // zero, the value won't ever change sign.
4298 if (AddRec->getNoWrapFlags(SCEV::FlagNSW)) {
4299 bool AllNonNeg = true;
4300 bool AllNonPos = true;
4301 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
4302 if (!isKnownNonNegative(AddRec->getOperand(i))) AllNonNeg = false;
4303 if (!isKnownNonPositive(AddRec->getOperand(i))) AllNonPos = false;
4306 ConservativeResult = ConservativeResult.intersectWith(
4307 ConstantRange(APInt(BitWidth, 0),
4308 APInt::getSignedMinValue(BitWidth)));
4310 ConservativeResult = ConservativeResult.intersectWith(
4311 ConstantRange(APInt::getSignedMinValue(BitWidth),
4312 APInt(BitWidth, 1)));
4315 // TODO: non-affine addrec
4316 if (AddRec->isAffine()) {
4317 Type *Ty = AddRec->getType();
4318 const SCEV *MaxBECount = getMaxBackedgeTakenCount(AddRec->getLoop());
4319 if (!isa<SCEVCouldNotCompute>(MaxBECount) &&
4320 getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) {
4322 // Check for overflow. This must be done with ConstantRange arithmetic
4323 // because we could be called from within the ScalarEvolution overflow
4326 MaxBECount = getNoopOrZeroExtend(MaxBECount, Ty);
4327 ConstantRange MaxBECountRange = getUnsignedRange(MaxBECount);
4328 ConstantRange ZExtMaxBECountRange =
4329 MaxBECountRange.zextOrTrunc(BitWidth * 2 + 1);
4331 const SCEV *Start = AddRec->getStart();
4332 const SCEV *Step = AddRec->getStepRecurrence(*this);
4333 ConstantRange StepSRange = getSignedRange(Step);
4334 ConstantRange SExtStepSRange = StepSRange.sextOrTrunc(BitWidth * 2 + 1);
4336 ConstantRange StartURange = getUnsignedRange(Start);
4337 ConstantRange EndURange =
4338 StartURange.add(MaxBECountRange.multiply(StepSRange));
4340 // Check for unsigned overflow.
4341 ConstantRange ZExtStartURange =
4342 StartURange.zextOrTrunc(BitWidth * 2 + 1);
4343 ConstantRange ZExtEndURange = EndURange.zextOrTrunc(BitWidth * 2 + 1);
4344 if (ZExtStartURange.add(ZExtMaxBECountRange.multiply(SExtStepSRange)) ==
4346 APInt Min = APIntOps::umin(StartURange.getUnsignedMin(),
4347 EndURange.getUnsignedMin());
4348 APInt Max = APIntOps::umax(StartURange.getUnsignedMax(),
4349 EndURange.getUnsignedMax());
4350 bool IsFullRange = Min.isMinValue() && Max.isMaxValue();
4352 ConservativeResult =
4353 ConservativeResult.intersectWith(ConstantRange(Min, Max + 1));
4356 ConstantRange StartSRange = getSignedRange(Start);
4357 ConstantRange EndSRange =
4358 StartSRange.add(MaxBECountRange.multiply(StepSRange));
4360 // Check for signed overflow. This must be done with ConstantRange
4361 // arithmetic because we could be called from within the ScalarEvolution
4362 // overflow checking code.
4363 ConstantRange SExtStartSRange =
4364 StartSRange.sextOrTrunc(BitWidth * 2 + 1);
4365 ConstantRange SExtEndSRange = EndSRange.sextOrTrunc(BitWidth * 2 + 1);
4366 if (SExtStartSRange.add(ZExtMaxBECountRange.multiply(SExtStepSRange)) ==
4368 APInt Min = APIntOps::smin(StartSRange.getSignedMin(),
4369 EndSRange.getSignedMin());
4370 APInt Max = APIntOps::smax(StartSRange.getSignedMax(),
4371 EndSRange.getSignedMax());
4372 bool IsFullRange = Min.isMinSignedValue() && Max.isMaxSignedValue();
4374 ConservativeResult =
4375 ConservativeResult.intersectWith(ConstantRange(Min, Max + 1));
4380 return setRange(AddRec, SignHint, ConservativeResult);
4383 if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
4384 // Check if the IR explicitly contains !range metadata.
4385 Optional<ConstantRange> MDRange = GetRangeFromMetadata(U->getValue());
4386 if (MDRange.hasValue())
4387 ConservativeResult = ConservativeResult.intersectWith(MDRange.getValue());
4389 // Split here to avoid paying the compile-time cost of calling both
4390 // computeKnownBits and ComputeNumSignBits. This restriction can be lifted
4392 const DataLayout &DL = getDataLayout();
4393 if (SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED) {
4394 // For a SCEVUnknown, ask ValueTracking.
4395 APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
4396 computeKnownBits(U->getValue(), Zeros, Ones, DL, 0, &AC, nullptr, &DT);
4397 if (Ones != ~Zeros + 1)
4398 ConservativeResult =
4399 ConservativeResult.intersectWith(ConstantRange(Ones, ~Zeros + 1));
4401 assert(SignHint == ScalarEvolution::HINT_RANGE_SIGNED &&
4402 "generalize as needed!");
4403 unsigned NS = ComputeNumSignBits(U->getValue(), DL, 0, &AC, nullptr, &DT);
4405 ConservativeResult = ConservativeResult.intersectWith(
4406 ConstantRange(APInt::getSignedMinValue(BitWidth).ashr(NS - 1),
4407 APInt::getSignedMaxValue(BitWidth).ashr(NS - 1) + 1));
4410 return setRange(U, SignHint, ConservativeResult);
4413 return setRange(S, SignHint, ConservativeResult);
4416 SCEV::NoWrapFlags ScalarEvolution::getNoWrapFlagsFromUB(const Value *V) {
4417 if (isa<ConstantExpr>(V)) return SCEV::FlagAnyWrap;
4418 const BinaryOperator *BinOp = cast<BinaryOperator>(V);
4420 // Return early if there are no flags to propagate to the SCEV.
4421 SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap;
4422 if (BinOp->hasNoUnsignedWrap())
4423 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW);
4424 if (BinOp->hasNoSignedWrap())
4425 Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNSW);
4426 if (Flags == SCEV::FlagAnyWrap) {
4427 return SCEV::FlagAnyWrap;
4430 // Here we check that BinOp is in the header of the innermost loop
4431 // containing BinOp, since we only deal with instructions in the loop
4432 // header. The actual loop we need to check later will come from an add
4433 // recurrence, but getting that requires computing the SCEV of the operands,
4434 // which can be expensive. This check we can do cheaply to rule out some
4436 Loop *innermostContainingLoop = LI.getLoopFor(BinOp->getParent());
4437 if (innermostContainingLoop == nullptr ||
4438 innermostContainingLoop->getHeader() != BinOp->getParent())
4439 return SCEV::FlagAnyWrap;
4441 // Only proceed if we can prove that BinOp does not yield poison.
4442 if (!isKnownNotFullPoison(BinOp)) return SCEV::FlagAnyWrap;
4444 // At this point we know that if V is executed, then it does not wrap
4445 // according to at least one of NSW or NUW. If V is not executed, then we do
4446 // not know if the calculation that V represents would wrap. Multiple
4447 // instructions can map to the same SCEV. If we apply NSW or NUW from V to
4448 // the SCEV, we must guarantee no wrapping for that SCEV also when it is
4449 // derived from other instructions that map to the same SCEV. We cannot make
4450 // that guarantee for cases where V is not executed. So we need to find the
4451 // loop that V is considered in relation to and prove that V is executed for
4452 // every iteration of that loop. That implies that the value that V
4453 // calculates does not wrap anywhere in the loop, so then we can apply the
4454 // flags to the SCEV.
4456 // We check isLoopInvariant to disambiguate in case we are adding two
4457 // recurrences from different loops, so that we know which loop to prove
4458 // that V is executed in.
4459 for (int OpIndex = 0; OpIndex < 2; ++OpIndex) {
4460 const SCEV *Op = getSCEV(BinOp->getOperand(OpIndex));
4461 if (auto *AddRec = dyn_cast<SCEVAddRecExpr>(Op)) {
4462 const int OtherOpIndex = 1 - OpIndex;
4463 const SCEV *OtherOp = getSCEV(BinOp->getOperand(OtherOpIndex));
4464 if (isLoopInvariant(OtherOp, AddRec->getLoop()) &&
4465 isGuaranteedToExecuteForEveryIteration(BinOp, AddRec->getLoop()))
4469 return SCEV::FlagAnyWrap;
4472 /// createSCEV - We know that there is no SCEV for the specified value. Analyze
4475 const SCEV *ScalarEvolution::createSCEV(Value *V) {
4476 if (!isSCEVable(V->getType()))
4477 return getUnknown(V);
4479 unsigned Opcode = Instruction::UserOp1;
4480 if (Instruction *I = dyn_cast<Instruction>(V)) {
4481 Opcode = I->getOpcode();
4483 // Don't attempt to analyze instructions in blocks that aren't
4484 // reachable. Such instructions don't matter, and they aren't required
4485 // to obey basic rules for definitions dominating uses which this
4486 // analysis depends on.
4487 if (!DT.isReachableFromEntry(I->getParent()))
4488 return getUnknown(V);
4489 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
4490 Opcode = CE->getOpcode();
4491 else if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
4492 return getConstant(CI);
4493 else if (isa<ConstantPointerNull>(V))
4494 return getZero(V->getType());
4495 else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
4496 return GA->mayBeOverridden() ? getUnknown(V) : getSCEV(GA->getAliasee());
4498 return getUnknown(V);
4500 Operator *U = cast<Operator>(V);
4502 case Instruction::Add: {
4503 // The simple thing to do would be to just call getSCEV on both operands
4504 // and call getAddExpr with the result. However if we're looking at a
4505 // bunch of things all added together, this can be quite inefficient,
4506 // because it leads to N-1 getAddExpr calls for N ultimate operands.
4507 // Instead, gather up all the operands and make a single getAddExpr call.
4508 // LLVM IR canonical form means we need only traverse the left operands.
4509 SmallVector<const SCEV *, 4> AddOps;
4510 for (Value *Op = U;; Op = U->getOperand(0)) {
4511 U = dyn_cast<Operator>(Op);
4512 unsigned Opcode = U ? U->getOpcode() : 0;
4513 if (!U || (Opcode != Instruction::Add && Opcode != Instruction::Sub)) {
4514 assert(Op != V && "V should be an add");
4515 AddOps.push_back(getSCEV(Op));
4519 if (auto *OpSCEV = getExistingSCEV(U)) {
4520 AddOps.push_back(OpSCEV);
4524 // If a NUW or NSW flag can be applied to the SCEV for this
4525 // addition, then compute the SCEV for this addition by itself
4526 // with a separate call to getAddExpr. We need to do that
4527 // instead of pushing the operands of the addition onto AddOps,
4528 // since the flags are only known to apply to this particular
4529 // addition - they may not apply to other additions that can be
4530 // formed with operands from AddOps.
4531 const SCEV *RHS = getSCEV(U->getOperand(1));
4532 SCEV::NoWrapFlags Flags = getNoWrapFlagsFromUB(U);
4533 if (Flags != SCEV::FlagAnyWrap) {
4534 const SCEV *LHS = getSCEV(U->getOperand(0));
4535 if (Opcode == Instruction::Sub)
4536 AddOps.push_back(getMinusSCEV(LHS, RHS, Flags));
4538 AddOps.push_back(getAddExpr(LHS, RHS, Flags));
4542 if (Opcode == Instruction::Sub)
4543 AddOps.push_back(getNegativeSCEV(RHS));
4545 AddOps.push_back(RHS);
4547 return getAddExpr(AddOps);
4550 case Instruction::Mul: {
4551 SmallVector<const SCEV *, 4> MulOps;
4552 for (Value *Op = U;; Op = U->getOperand(0)) {
4553 U = dyn_cast<Operator>(Op);
4554 if (!U || U->getOpcode() != Instruction::Mul) {
4555 assert(Op != V && "V should be a mul");
4556 MulOps.push_back(getSCEV(Op));
4560 if (auto *OpSCEV = getExistingSCEV(U)) {
4561 MulOps.push_back(OpSCEV);
4565 SCEV::NoWrapFlags Flags = getNoWrapFlagsFromUB(U);
4566 if (Flags != SCEV::FlagAnyWrap) {
4567 MulOps.push_back(getMulExpr(getSCEV(U->getOperand(0)),
4568 getSCEV(U->getOperand(1)), Flags));
4572 MulOps.push_back(getSCEV(U->getOperand(1)));
4574 return getMulExpr(MulOps);
4576 case Instruction::UDiv:
4577 return getUDivExpr(getSCEV(U->getOperand(0)),
4578 getSCEV(U->getOperand(1)));
4579 case Instruction::Sub:
4580 return getMinusSCEV(getSCEV(U->getOperand(0)), getSCEV(U->getOperand(1)),
4581 getNoWrapFlagsFromUB(U));
4582 case Instruction::And:
4583 // For an expression like x&255 that merely masks off the high bits,
4584 // use zext(trunc(x)) as the SCEV expression.
4585 if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
4586 if (CI->isNullValue())
4587 return getSCEV(U->getOperand(1));
4588 if (CI->isAllOnesValue())
4589 return getSCEV(U->getOperand(0));
4590 const APInt &A = CI->getValue();
4592 // Instcombine's ShrinkDemandedConstant may strip bits out of
4593 // constants, obscuring what would otherwise be a low-bits mask.
4594 // Use computeKnownBits to compute what ShrinkDemandedConstant
4595 // knew about to reconstruct a low-bits mask value.
4596 unsigned LZ = A.countLeadingZeros();
4597 unsigned TZ = A.countTrailingZeros();
4598 unsigned BitWidth = A.getBitWidth();
4599 APInt KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
4600 computeKnownBits(U->getOperand(0), KnownZero, KnownOne, getDataLayout(),
4601 0, &AC, nullptr, &DT);
4603 APInt EffectiveMask =
4604 APInt::getLowBitsSet(BitWidth, BitWidth - LZ - TZ).shl(TZ);
4605 if ((LZ != 0 || TZ != 0) && !((~A & ~KnownZero) & EffectiveMask)) {
4606 const SCEV *MulCount = getConstant(
4607 ConstantInt::get(getContext(), APInt::getOneBitSet(BitWidth, TZ)));
4611 getUDivExactExpr(getSCEV(U->getOperand(0)), MulCount),
4612 IntegerType::get(getContext(), BitWidth - LZ - TZ)),
4619 case Instruction::Or:
4620 // If the RHS of the Or is a constant, we may have something like:
4621 // X*4+1 which got turned into X*4|1. Handle this as an Add so loop
4622 // optimizations will transparently handle this case.
4624 // In order for this transformation to be safe, the LHS must be of the
4625 // form X*(2^n) and the Or constant must be less than 2^n.
4626 if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
4627 const SCEV *LHS = getSCEV(U->getOperand(0));
4628 const APInt &CIVal = CI->getValue();
4629 if (GetMinTrailingZeros(LHS) >=
4630 (CIVal.getBitWidth() - CIVal.countLeadingZeros())) {
4631 // Build a plain add SCEV.
4632 const SCEV *S = getAddExpr(LHS, getSCEV(CI));
4633 // If the LHS of the add was an addrec and it has no-wrap flags,
4634 // transfer the no-wrap flags, since an or won't introduce a wrap.
4635 if (const SCEVAddRecExpr *NewAR = dyn_cast<SCEVAddRecExpr>(S)) {
4636 const SCEVAddRecExpr *OldAR = cast<SCEVAddRecExpr>(LHS);
4637 const_cast<SCEVAddRecExpr *>(NewAR)->setNoWrapFlags(
4638 OldAR->getNoWrapFlags());
4644 case Instruction::Xor:
4645 if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
4646 // If the RHS of the xor is a signbit, then this is just an add.
4647 // Instcombine turns add of signbit into xor as a strength reduction step.
4648 if (CI->getValue().isSignBit())
4649 return getAddExpr(getSCEV(U->getOperand(0)),
4650 getSCEV(U->getOperand(1)));
4652 // If the RHS of xor is -1, then this is a not operation.
4653 if (CI->isAllOnesValue())
4654 return getNotSCEV(getSCEV(U->getOperand(0)));
4656 // Model xor(and(x, C), C) as and(~x, C), if C is a low-bits mask.
4657 // This is a variant of the check for xor with -1, and it handles
4658 // the case where instcombine has trimmed non-demanded bits out
4659 // of an xor with -1.
4660 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U->getOperand(0)))
4661 if (ConstantInt *LCI = dyn_cast<ConstantInt>(BO->getOperand(1)))
4662 if (BO->getOpcode() == Instruction::And &&
4663 LCI->getValue() == CI->getValue())
4664 if (const SCEVZeroExtendExpr *Z =
4665 dyn_cast<SCEVZeroExtendExpr>(getSCEV(U->getOperand(0)))) {
4666 Type *UTy = U->getType();
4667 const SCEV *Z0 = Z->getOperand();
4668 Type *Z0Ty = Z0->getType();
4669 unsigned Z0TySize = getTypeSizeInBits(Z0Ty);
4671 // If C is a low-bits mask, the zero extend is serving to
4672 // mask off the high bits. Complement the operand and
4673 // re-apply the zext.
4674 if (APIntOps::isMask(Z0TySize, CI->getValue()))
4675 return getZeroExtendExpr(getNotSCEV(Z0), UTy);
4677 // If C is a single bit, it may be in the sign-bit position
4678 // before the zero-extend. In this case, represent the xor
4679 // using an add, which is equivalent, and re-apply the zext.
4680 APInt Trunc = CI->getValue().trunc(Z0TySize);
4681 if (Trunc.zext(getTypeSizeInBits(UTy)) == CI->getValue() &&
4683 return getZeroExtendExpr(getAddExpr(Z0, getConstant(Trunc)),
4689 case Instruction::Shl:
4690 // Turn shift left of a constant amount into a multiply.
4691 if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
4692 uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
4694 // If the shift count is not less than the bitwidth, the result of
4695 // the shift is undefined. Don't try to analyze it, because the
4696 // resolution chosen here may differ from the resolution chosen in
4697 // other parts of the compiler.
4698 if (SA->getValue().uge(BitWidth))
4701 // It is currently not resolved how to interpret NSW for left
4702 // shift by BitWidth - 1, so we avoid applying flags in that
4703 // case. Remove this check (or this comment) once the situation
4705 // http://lists.llvm.org/pipermail/llvm-dev/2015-April/084195.html
4706 // and http://reviews.llvm.org/D8890 .
4707 auto Flags = SCEV::FlagAnyWrap;
4708 if (SA->getValue().ult(BitWidth - 1)) Flags = getNoWrapFlagsFromUB(U);
4710 Constant *X = ConstantInt::get(getContext(),
4711 APInt::getOneBitSet(BitWidth, SA->getZExtValue()));
4712 return getMulExpr(getSCEV(U->getOperand(0)), getSCEV(X), Flags);
4716 case Instruction::LShr:
4717 // Turn logical shift right of a constant into a unsigned divide.
4718 if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
4719 uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
4721 // If the shift count is not less than the bitwidth, the result of
4722 // the shift is undefined. Don't try to analyze it, because the
4723 // resolution chosen here may differ from the resolution chosen in
4724 // other parts of the compiler.
4725 if (SA->getValue().uge(BitWidth))
4728 Constant *X = ConstantInt::get(getContext(),
4729 APInt::getOneBitSet(BitWidth, SA->getZExtValue()));
4730 return getUDivExpr(getSCEV(U->getOperand(0)), getSCEV(X));
4734 case Instruction::AShr:
4735 // For a two-shift sext-inreg, use sext(trunc(x)) as the SCEV expression.
4736 if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1)))
4737 if (Operator *L = dyn_cast<Operator>(U->getOperand(0)))
4738 if (L->getOpcode() == Instruction::Shl &&
4739 L->getOperand(1) == U->getOperand(1)) {
4740 uint64_t BitWidth = getTypeSizeInBits(U->getType());
4742 // If the shift count is not less than the bitwidth, the result of
4743 // the shift is undefined. Don't try to analyze it, because the
4744 // resolution chosen here may differ from the resolution chosen in
4745 // other parts of the compiler.
4746 if (CI->getValue().uge(BitWidth))
4749 uint64_t Amt = BitWidth - CI->getZExtValue();
4750 if (Amt == BitWidth)
4751 return getSCEV(L->getOperand(0)); // shift by zero --> noop
4753 getSignExtendExpr(getTruncateExpr(getSCEV(L->getOperand(0)),
4754 IntegerType::get(getContext(),
4760 case Instruction::Trunc:
4761 return getTruncateExpr(getSCEV(U->getOperand(0)), U->getType());
4763 case Instruction::ZExt:
4764 return getZeroExtendExpr(getSCEV(U->getOperand(0)), U->getType());
4766 case Instruction::SExt:
4767 return getSignExtendExpr(getSCEV(U->getOperand(0)), U->getType());
4769 case Instruction::BitCast:
4770 // BitCasts are no-op casts so we just eliminate the cast.
4771 if (isSCEVable(U->getType()) && isSCEVable(U->getOperand(0)->getType()))
4772 return getSCEV(U->getOperand(0));
4775 // It's tempting to handle inttoptr and ptrtoint as no-ops, however this can
4776 // lead to pointer expressions which cannot safely be expanded to GEPs,
4777 // because ScalarEvolution doesn't respect the GEP aliasing rules when
4778 // simplifying integer expressions.
4780 case Instruction::GetElementPtr:
4781 return createNodeForGEP(cast<GEPOperator>(U));
4783 case Instruction::PHI:
4784 return createNodeForPHI(cast<PHINode>(U));
4786 case Instruction::Select:
4787 // U can also be a select constant expr, which let fall through. Since
4788 // createNodeForSelect only works for a condition that is an `ICmpInst`, and
4789 // constant expressions cannot have instructions as operands, we'd have
4790 // returned getUnknown for a select constant expressions anyway.
4791 if (isa<Instruction>(U))
4792 return createNodeForSelectOrPHI(cast<Instruction>(U), U->getOperand(0),
4793 U->getOperand(1), U->getOperand(2));
4795 default: // We cannot analyze this expression.
4799 return getUnknown(V);
4804 //===----------------------------------------------------------------------===//
4805 // Iteration Count Computation Code
4808 unsigned ScalarEvolution::getSmallConstantTripCount(Loop *L) {
4809 if (BasicBlock *ExitingBB = L->getExitingBlock())
4810 return getSmallConstantTripCount(L, ExitingBB);
4812 // No trip count information for multiple exits.
4816 /// getSmallConstantTripCount - Returns the maximum trip count of this loop as a
4817 /// normal unsigned value. Returns 0 if the trip count is unknown or not
4818 /// constant. Will also return 0 if the maximum trip count is very large (>=
4821 /// This "trip count" assumes that control exits via ExitingBlock. More
4822 /// precisely, it is the number of times that control may reach ExitingBlock
4823 /// before taking the branch. For loops with multiple exits, it may not be the
4824 /// number times that the loop header executes because the loop may exit
4825 /// prematurely via another branch.
4826 unsigned ScalarEvolution::getSmallConstantTripCount(Loop *L,
4827 BasicBlock *ExitingBlock) {
4828 assert(ExitingBlock && "Must pass a non-null exiting block!");
4829 assert(L->isLoopExiting(ExitingBlock) &&
4830 "Exiting block must actually branch out of the loop!");
4831 const SCEVConstant *ExitCount =
4832 dyn_cast<SCEVConstant>(getExitCount(L, ExitingBlock));
4836 ConstantInt *ExitConst = ExitCount->getValue();
4838 // Guard against huge trip counts.
4839 if (ExitConst->getValue().getActiveBits() > 32)
4842 // In case of integer overflow, this returns 0, which is correct.
4843 return ((unsigned)ExitConst->getZExtValue()) + 1;
4846 unsigned ScalarEvolution::getSmallConstantTripMultiple(Loop *L) {
4847 if (BasicBlock *ExitingBB = L->getExitingBlock())
4848 return getSmallConstantTripMultiple(L, ExitingBB);
4850 // No trip multiple information for multiple exits.
4854 /// getSmallConstantTripMultiple - Returns the largest constant divisor of the
4855 /// trip count of this loop as a normal unsigned value, if possible. This
4856 /// means that the actual trip count is always a multiple of the returned
4857 /// value (don't forget the trip count could very well be zero as well!).
4859 /// Returns 1 if the trip count is unknown or not guaranteed to be the
4860 /// multiple of a constant (which is also the case if the trip count is simply
4861 /// constant, use getSmallConstantTripCount for that case), Will also return 1
4862 /// if the trip count is very large (>= 2^32).
4864 /// As explained in the comments for getSmallConstantTripCount, this assumes
4865 /// that control exits the loop via ExitingBlock.
4867 ScalarEvolution::getSmallConstantTripMultiple(Loop *L,
4868 BasicBlock *ExitingBlock) {
4869 assert(ExitingBlock && "Must pass a non-null exiting block!");
4870 assert(L->isLoopExiting(ExitingBlock) &&
4871 "Exiting block must actually branch out of the loop!");
4872 const SCEV *ExitCount = getExitCount(L, ExitingBlock);
4873 if (ExitCount == getCouldNotCompute())
4876 // Get the trip count from the BE count by adding 1.
4877 const SCEV *TCMul = getAddExpr(ExitCount, getOne(ExitCount->getType()));
4878 // FIXME: SCEV distributes multiplication as V1*C1 + V2*C1. We could attempt
4879 // to factor simple cases.
4880 if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(TCMul))
4881 TCMul = Mul->getOperand(0);
4883 const SCEVConstant *MulC = dyn_cast<SCEVConstant>(TCMul);
4887 ConstantInt *Result = MulC->getValue();
4889 // Guard against huge trip counts (this requires checking
4890 // for zero to handle the case where the trip count == -1 and the
4892 if (!Result || Result->getValue().getActiveBits() > 32 ||
4893 Result->getValue().getActiveBits() == 0)
4896 return (unsigned)Result->getZExtValue();
4899 // getExitCount - Get the expression for the number of loop iterations for which
4900 // this loop is guaranteed not to exit via ExitingBlock. Otherwise return
4901 // SCEVCouldNotCompute.
4902 const SCEV *ScalarEvolution::getExitCount(Loop *L, BasicBlock *ExitingBlock) {
4903 return getBackedgeTakenInfo(L).getExact(ExitingBlock, this);
4906 /// getBackedgeTakenCount - If the specified loop has a predictable
4907 /// backedge-taken count, return it, otherwise return a SCEVCouldNotCompute
4908 /// object. The backedge-taken count is the number of times the loop header
4909 /// will be branched to from within the loop. This is one less than the
4910 /// trip count of the loop, since it doesn't count the first iteration,
4911 /// when the header is branched to from outside the loop.
4913 /// Note that it is not valid to call this method on a loop without a
4914 /// loop-invariant backedge-taken count (see
4915 /// hasLoopInvariantBackedgeTakenCount).
4917 const SCEV *ScalarEvolution::getBackedgeTakenCount(const Loop *L) {
4918 return getBackedgeTakenInfo(L).getExact(this);
4921 /// getMaxBackedgeTakenCount - Similar to getBackedgeTakenCount, except
4922 /// return the least SCEV value that is known never to be less than the
4923 /// actual backedge taken count.
4924 const SCEV *ScalarEvolution::getMaxBackedgeTakenCount(const Loop *L) {
4925 return getBackedgeTakenInfo(L).getMax(this);
4928 /// PushLoopPHIs - Push PHI nodes in the header of the given loop
4929 /// onto the given Worklist.
4931 PushLoopPHIs(const Loop *L, SmallVectorImpl<Instruction *> &Worklist) {
4932 BasicBlock *Header = L->getHeader();
4934 // Push all Loop-header PHIs onto the Worklist stack.
4935 for (BasicBlock::iterator I = Header->begin();
4936 PHINode *PN = dyn_cast<PHINode>(I); ++I)
4937 Worklist.push_back(PN);
4940 const ScalarEvolution::BackedgeTakenInfo &
4941 ScalarEvolution::getBackedgeTakenInfo(const Loop *L) {
4942 // Initially insert an invalid entry for this loop. If the insertion
4943 // succeeds, proceed to actually compute a backedge-taken count and
4944 // update the value. The temporary CouldNotCompute value tells SCEV
4945 // code elsewhere that it shouldn't attempt to request a new
4946 // backedge-taken count, which could result in infinite recursion.
4947 std::pair<DenseMap<const Loop *, BackedgeTakenInfo>::iterator, bool> Pair =
4948 BackedgeTakenCounts.insert(std::make_pair(L, BackedgeTakenInfo()));
4950 return Pair.first->second;
4952 // computeBackedgeTakenCount may allocate memory for its result. Inserting it
4953 // into the BackedgeTakenCounts map transfers ownership. Otherwise, the result
4954 // must be cleared in this scope.
4955 BackedgeTakenInfo Result = computeBackedgeTakenCount(L);
4957 if (Result.getExact(this) != getCouldNotCompute()) {
4958 assert(isLoopInvariant(Result.getExact(this), L) &&
4959 isLoopInvariant(Result.getMax(this), L) &&
4960 "Computed backedge-taken count isn't loop invariant for loop!");
4961 ++NumTripCountsComputed;
4963 else if (Result.getMax(this) == getCouldNotCompute() &&
4964 isa<PHINode>(L->getHeader()->begin())) {
4965 // Only count loops that have phi nodes as not being computable.
4966 ++NumTripCountsNotComputed;
4969 // Now that we know more about the trip count for this loop, forget any
4970 // existing SCEV values for PHI nodes in this loop since they are only
4971 // conservative estimates made without the benefit of trip count
4972 // information. This is similar to the code in forgetLoop, except that
4973 // it handles SCEVUnknown PHI nodes specially.
4974 if (Result.hasAnyInfo()) {
4975 SmallVector<Instruction *, 16> Worklist;
4976 PushLoopPHIs(L, Worklist);
4978 SmallPtrSet<Instruction *, 8> Visited;
4979 while (!Worklist.empty()) {
4980 Instruction *I = Worklist.pop_back_val();
4981 if (!Visited.insert(I).second)
4984 ValueExprMapType::iterator It =
4985 ValueExprMap.find_as(static_cast<Value *>(I));
4986 if (It != ValueExprMap.end()) {
4987 const SCEV *Old = It->second;
4989 // SCEVUnknown for a PHI either means that it has an unrecognized
4990 // structure, or it's a PHI that's in the progress of being computed
4991 // by createNodeForPHI. In the former case, additional loop trip
4992 // count information isn't going to change anything. In the later
4993 // case, createNodeForPHI will perform the necessary updates on its
4994 // own when it gets to that point.
4995 if (!isa<PHINode>(I) || !isa<SCEVUnknown>(Old)) {
4996 forgetMemoizedResults(Old);
4997 ValueExprMap.erase(It);
4999 if (PHINode *PN = dyn_cast<PHINode>(I))
5000 ConstantEvolutionLoopExitValue.erase(PN);
5003 PushDefUseChildren(I, Worklist);
5007 // Re-lookup the insert position, since the call to
5008 // computeBackedgeTakenCount above could result in a
5009 // recusive call to getBackedgeTakenInfo (on a different
5010 // loop), which would invalidate the iterator computed
5012 return BackedgeTakenCounts.find(L)->second = Result;
5015 /// forgetLoop - This method should be called by the client when it has
5016 /// changed a loop in a way that may effect ScalarEvolution's ability to
5017 /// compute a trip count, or if the loop is deleted.
5018 void ScalarEvolution::forgetLoop(const Loop *L) {
5019 // Drop any stored trip count value.
5020 DenseMap<const Loop*, BackedgeTakenInfo>::iterator BTCPos =
5021 BackedgeTakenCounts.find(L);
5022 if (BTCPos != BackedgeTakenCounts.end()) {
5023 BTCPos->second.clear();
5024 BackedgeTakenCounts.erase(BTCPos);
5027 // Drop information about expressions based on loop-header PHIs.
5028 SmallVector<Instruction *, 16> Worklist;
5029 PushLoopPHIs(L, Worklist);
5031 SmallPtrSet<Instruction *, 8> Visited;
5032 while (!Worklist.empty()) {
5033 Instruction *I = Worklist.pop_back_val();
5034 if (!Visited.insert(I).second)
5037 ValueExprMapType::iterator It =
5038 ValueExprMap.find_as(static_cast<Value *>(I));
5039 if (It != ValueExprMap.end()) {
5040 forgetMemoizedResults(It->second);
5041 ValueExprMap.erase(It);
5042 if (PHINode *PN = dyn_cast<PHINode>(I))
5043 ConstantEvolutionLoopExitValue.erase(PN);
5046 PushDefUseChildren(I, Worklist);
5049 // Forget all contained loops too, to avoid dangling entries in the
5050 // ValuesAtScopes map.
5051 for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
5055 /// forgetValue - This method should be called by the client when it has
5056 /// changed a value in a way that may effect its value, or which may
5057 /// disconnect it from a def-use chain linking it to a loop.
5058 void ScalarEvolution::forgetValue(Value *V) {
5059 Instruction *I = dyn_cast<Instruction>(V);
5062 // Drop information about expressions based on loop-header PHIs.
5063 SmallVector<Instruction *, 16> Worklist;
5064 Worklist.push_back(I);
5066 SmallPtrSet<Instruction *, 8> Visited;
5067 while (!Worklist.empty()) {
5068 I = Worklist.pop_back_val();
5069 if (!Visited.insert(I).second)
5072 ValueExprMapType::iterator It =
5073 ValueExprMap.find_as(static_cast<Value *>(I));
5074 if (It != ValueExprMap.end()) {
5075 forgetMemoizedResults(It->second);
5076 ValueExprMap.erase(It);
5077 if (PHINode *PN = dyn_cast<PHINode>(I))
5078 ConstantEvolutionLoopExitValue.erase(PN);
5081 PushDefUseChildren(I, Worklist);
5085 /// getExact - Get the exact loop backedge taken count considering all loop
5086 /// exits. A computable result can only be returned for loops with a single
5087 /// exit. Returning the minimum taken count among all exits is incorrect
5088 /// because one of the loop's exit limit's may have been skipped. HowFarToZero
5089 /// assumes that the limit of each loop test is never skipped. This is a valid
5090 /// assumption as long as the loop exits via that test. For precise results, it
5091 /// is the caller's responsibility to specify the relevant loop exit using
5092 /// getExact(ExitingBlock, SE).
5094 ScalarEvolution::BackedgeTakenInfo::getExact(ScalarEvolution *SE) const {
5095 // If any exits were not computable, the loop is not computable.
5096 if (!ExitNotTaken.isCompleteList()) return SE->getCouldNotCompute();
5098 // We need exactly one computable exit.
5099 if (!ExitNotTaken.ExitingBlock) return SE->getCouldNotCompute();
5100 assert(ExitNotTaken.ExactNotTaken && "uninitialized not-taken info");
5102 const SCEV *BECount = nullptr;
5103 for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
5104 ENT != nullptr; ENT = ENT->getNextExit()) {
5106 assert(ENT->ExactNotTaken != SE->getCouldNotCompute() && "bad exit SCEV");
5109 BECount = ENT->ExactNotTaken;
5110 else if (BECount != ENT->ExactNotTaken)
5111 return SE->getCouldNotCompute();
5113 assert(BECount && "Invalid not taken count for loop exit");
5117 /// getExact - Get the exact not taken count for this loop exit.
5119 ScalarEvolution::BackedgeTakenInfo::getExact(BasicBlock *ExitingBlock,
5120 ScalarEvolution *SE) const {
5121 for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
5122 ENT != nullptr; ENT = ENT->getNextExit()) {
5124 if (ENT->ExitingBlock == ExitingBlock)
5125 return ENT->ExactNotTaken;
5127 return SE->getCouldNotCompute();
5130 /// getMax - Get the max backedge taken count for the loop.
5132 ScalarEvolution::BackedgeTakenInfo::getMax(ScalarEvolution *SE) const {
5133 return Max ? Max : SE->getCouldNotCompute();
5136 bool ScalarEvolution::BackedgeTakenInfo::hasOperand(const SCEV *S,
5137 ScalarEvolution *SE) const {
5138 if (Max && Max != SE->getCouldNotCompute() && SE->hasOperand(Max, S))
5141 if (!ExitNotTaken.ExitingBlock)
5144 for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
5145 ENT != nullptr; ENT = ENT->getNextExit()) {
5147 if (ENT->ExactNotTaken != SE->getCouldNotCompute()
5148 && SE->hasOperand(ENT->ExactNotTaken, S)) {
5155 /// Allocate memory for BackedgeTakenInfo and copy the not-taken count of each
5156 /// computable exit into a persistent ExitNotTakenInfo array.
5157 ScalarEvolution::BackedgeTakenInfo::BackedgeTakenInfo(
5158 SmallVectorImpl< std::pair<BasicBlock *, const SCEV *> > &ExitCounts,
5159 bool Complete, const SCEV *MaxCount) : Max(MaxCount) {
5162 ExitNotTaken.setIncomplete();
5164 unsigned NumExits = ExitCounts.size();
5165 if (NumExits == 0) return;
5167 ExitNotTaken.ExitingBlock = ExitCounts[0].first;
5168 ExitNotTaken.ExactNotTaken = ExitCounts[0].second;
5169 if (NumExits == 1) return;
5171 // Handle the rare case of multiple computable exits.
5172 ExitNotTakenInfo *ENT = new ExitNotTakenInfo[NumExits-1];
5174 ExitNotTakenInfo *PrevENT = &ExitNotTaken;
5175 for (unsigned i = 1; i < NumExits; ++i, PrevENT = ENT, ++ENT) {
5176 PrevENT->setNextExit(ENT);
5177 ENT->ExitingBlock = ExitCounts[i].first;
5178 ENT->ExactNotTaken = ExitCounts[i].second;
5182 /// clear - Invalidate this result and free the ExitNotTakenInfo array.
5183 void ScalarEvolution::BackedgeTakenInfo::clear() {
5184 ExitNotTaken.ExitingBlock = nullptr;
5185 ExitNotTaken.ExactNotTaken = nullptr;
5186 delete[] ExitNotTaken.getNextExit();
5189 /// computeBackedgeTakenCount - Compute the number of times the backedge
5190 /// of the specified loop will execute.
5191 ScalarEvolution::BackedgeTakenInfo
5192 ScalarEvolution::computeBackedgeTakenCount(const Loop *L) {
5193 SmallVector<BasicBlock *, 8> ExitingBlocks;
5194 L->getExitingBlocks(ExitingBlocks);
5196 SmallVector<std::pair<BasicBlock *, const SCEV *>, 4> ExitCounts;
5197 bool CouldComputeBECount = true;
5198 BasicBlock *Latch = L->getLoopLatch(); // may be NULL.
5199 const SCEV *MustExitMaxBECount = nullptr;
5200 const SCEV *MayExitMaxBECount = nullptr;
5202 // Compute the ExitLimit for each loop exit. Use this to populate ExitCounts
5203 // and compute maxBECount.
5204 for (unsigned i = 0, e = ExitingBlocks.size(); i != e; ++i) {
5205 BasicBlock *ExitBB = ExitingBlocks[i];
5206 ExitLimit EL = computeExitLimit(L, ExitBB);
5208 // 1. For each exit that can be computed, add an entry to ExitCounts.
5209 // CouldComputeBECount is true only if all exits can be computed.
5210 if (EL.Exact == getCouldNotCompute())
5211 // We couldn't compute an exact value for this exit, so
5212 // we won't be able to compute an exact value for the loop.
5213 CouldComputeBECount = false;
5215 ExitCounts.push_back(std::make_pair(ExitBB, EL.Exact));
5217 // 2. Derive the loop's MaxBECount from each exit's max number of
5218 // non-exiting iterations. Partition the loop exits into two kinds:
5219 // LoopMustExits and LoopMayExits.
5221 // If the exit dominates the loop latch, it is a LoopMustExit otherwise it
5222 // is a LoopMayExit. If any computable LoopMustExit is found, then
5223 // MaxBECount is the minimum EL.Max of computable LoopMustExits. Otherwise,
5224 // MaxBECount is conservatively the maximum EL.Max, where CouldNotCompute is
5225 // considered greater than any computable EL.Max.
5226 if (EL.Max != getCouldNotCompute() && Latch &&
5227 DT.dominates(ExitBB, Latch)) {
5228 if (!MustExitMaxBECount)
5229 MustExitMaxBECount = EL.Max;
5231 MustExitMaxBECount =
5232 getUMinFromMismatchedTypes(MustExitMaxBECount, EL.Max);
5234 } else if (MayExitMaxBECount != getCouldNotCompute()) {
5235 if (!MayExitMaxBECount || EL.Max == getCouldNotCompute())
5236 MayExitMaxBECount = EL.Max;
5239 getUMaxFromMismatchedTypes(MayExitMaxBECount, EL.Max);
5243 const SCEV *MaxBECount = MustExitMaxBECount ? MustExitMaxBECount :
5244 (MayExitMaxBECount ? MayExitMaxBECount : getCouldNotCompute());
5245 return BackedgeTakenInfo(ExitCounts, CouldComputeBECount, MaxBECount);
5248 ScalarEvolution::ExitLimit
5249 ScalarEvolution::computeExitLimit(const Loop *L, BasicBlock *ExitingBlock) {
5251 // Okay, we've chosen an exiting block. See what condition causes us to exit
5252 // at this block and remember the exit block and whether all other targets
5253 // lead to the loop header.
5254 bool MustExecuteLoopHeader = true;
5255 BasicBlock *Exit = nullptr;
5256 for (succ_iterator SI = succ_begin(ExitingBlock), SE = succ_end(ExitingBlock);
5258 if (!L->contains(*SI)) {
5259 if (Exit) // Multiple exit successors.
5260 return getCouldNotCompute();
5262 } else if (*SI != L->getHeader()) {
5263 MustExecuteLoopHeader = false;
5266 // At this point, we know we have a conditional branch that determines whether
5267 // the loop is exited. However, we don't know if the branch is executed each
5268 // time through the loop. If not, then the execution count of the branch will
5269 // not be equal to the trip count of the loop.
5271 // Currently we check for this by checking to see if the Exit branch goes to
5272 // the loop header. If so, we know it will always execute the same number of
5273 // times as the loop. We also handle the case where the exit block *is* the
5274 // loop header. This is common for un-rotated loops.
5276 // If both of those tests fail, walk up the unique predecessor chain to the
5277 // header, stopping if there is an edge that doesn't exit the loop. If the
5278 // header is reached, the execution count of the branch will be equal to the
5279 // trip count of the loop.
5281 // More extensive analysis could be done to handle more cases here.
5283 if (!MustExecuteLoopHeader && ExitingBlock != L->getHeader()) {
5284 // The simple checks failed, try climbing the unique predecessor chain
5285 // up to the header.
5287 for (BasicBlock *BB = ExitingBlock; BB; ) {
5288 BasicBlock *Pred = BB->getUniquePredecessor();
5290 return getCouldNotCompute();
5291 TerminatorInst *PredTerm = Pred->getTerminator();
5292 for (const BasicBlock *PredSucc : PredTerm->successors()) {
5295 // If the predecessor has a successor that isn't BB and isn't
5296 // outside the loop, assume the worst.
5297 if (L->contains(PredSucc))
5298 return getCouldNotCompute();
5300 if (Pred == L->getHeader()) {
5307 return getCouldNotCompute();
5310 bool IsOnlyExit = (L->getExitingBlock() != nullptr);
5311 TerminatorInst *Term = ExitingBlock->getTerminator();
5312 if (BranchInst *BI = dyn_cast<BranchInst>(Term)) {
5313 assert(BI->isConditional() && "If unconditional, it can't be in loop!");
5314 // Proceed to the next level to examine the exit condition expression.
5315 return computeExitLimitFromCond(L, BI->getCondition(), BI->getSuccessor(0),
5316 BI->getSuccessor(1),
5317 /*ControlsExit=*/IsOnlyExit);
5320 if (SwitchInst *SI = dyn_cast<SwitchInst>(Term))
5321 return computeExitLimitFromSingleExitSwitch(L, SI, Exit,
5322 /*ControlsExit=*/IsOnlyExit);
5324 return getCouldNotCompute();
5327 /// computeExitLimitFromCond - Compute the number of times the
5328 /// backedge of the specified loop will execute if its exit condition
5329 /// were a conditional branch of ExitCond, TBB, and FBB.
5331 /// @param ControlsExit is true if ExitCond directly controls the exit
5332 /// branch. In this case, we can assume that the loop exits only if the
5333 /// condition is true and can infer that failing to meet the condition prior to
5334 /// integer wraparound results in undefined behavior.
5335 ScalarEvolution::ExitLimit
5336 ScalarEvolution::computeExitLimitFromCond(const Loop *L,
5340 bool ControlsExit) {
5341 // Check if the controlling expression for this loop is an And or Or.
5342 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(ExitCond)) {
5343 if (BO->getOpcode() == Instruction::And) {
5344 // Recurse on the operands of the and.
5345 bool EitherMayExit = L->contains(TBB);
5346 ExitLimit EL0 = computeExitLimitFromCond(L, BO->getOperand(0), TBB, FBB,
5347 ControlsExit && !EitherMayExit);
5348 ExitLimit EL1 = computeExitLimitFromCond(L, BO->getOperand(1), TBB, FBB,
5349 ControlsExit && !EitherMayExit);
5350 const SCEV *BECount = getCouldNotCompute();
5351 const SCEV *MaxBECount = getCouldNotCompute();
5352 if (EitherMayExit) {
5353 // Both conditions must be true for the loop to continue executing.
5354 // Choose the less conservative count.
5355 if (EL0.Exact == getCouldNotCompute() ||
5356 EL1.Exact == getCouldNotCompute())
5357 BECount = getCouldNotCompute();
5359 BECount = getUMinFromMismatchedTypes(EL0.Exact, EL1.Exact);
5360 if (EL0.Max == getCouldNotCompute())
5361 MaxBECount = EL1.Max;
5362 else if (EL1.Max == getCouldNotCompute())
5363 MaxBECount = EL0.Max;
5365 MaxBECount = getUMinFromMismatchedTypes(EL0.Max, EL1.Max);
5367 // Both conditions must be true at the same time for the loop to exit.
5368 // For now, be conservative.
5369 assert(L->contains(FBB) && "Loop block has no successor in loop!");
5370 if (EL0.Max == EL1.Max)
5371 MaxBECount = EL0.Max;
5372 if (EL0.Exact == EL1.Exact)
5373 BECount = EL0.Exact;
5376 return ExitLimit(BECount, MaxBECount);
5378 if (BO->getOpcode() == Instruction::Or) {
5379 // Recurse on the operands of the or.
5380 bool EitherMayExit = L->contains(FBB);
5381 ExitLimit EL0 = computeExitLimitFromCond(L, BO->getOperand(0), TBB, FBB,
5382 ControlsExit && !EitherMayExit);
5383 ExitLimit EL1 = computeExitLimitFromCond(L, BO->getOperand(1), TBB, FBB,
5384 ControlsExit && !EitherMayExit);
5385 const SCEV *BECount = getCouldNotCompute();
5386 const SCEV *MaxBECount = getCouldNotCompute();
5387 if (EitherMayExit) {
5388 // Both conditions must be false for the loop to continue executing.
5389 // Choose the less conservative count.
5390 if (EL0.Exact == getCouldNotCompute() ||
5391 EL1.Exact == getCouldNotCompute())
5392 BECount = getCouldNotCompute();
5394 BECount = getUMinFromMismatchedTypes(EL0.Exact, EL1.Exact);
5395 if (EL0.Max == getCouldNotCompute())
5396 MaxBECount = EL1.Max;
5397 else if (EL1.Max == getCouldNotCompute())
5398 MaxBECount = EL0.Max;
5400 MaxBECount = getUMinFromMismatchedTypes(EL0.Max, EL1.Max);
5402 // Both conditions must be false at the same time for the loop to exit.
5403 // For now, be conservative.
5404 assert(L->contains(TBB) && "Loop block has no successor in loop!");
5405 if (EL0.Max == EL1.Max)
5406 MaxBECount = EL0.Max;
5407 if (EL0.Exact == EL1.Exact)
5408 BECount = EL0.Exact;
5411 return ExitLimit(BECount, MaxBECount);
5415 // With an icmp, it may be feasible to compute an exact backedge-taken count.
5416 // Proceed to the next level to examine the icmp.
5417 if (ICmpInst *ExitCondICmp = dyn_cast<ICmpInst>(ExitCond))
5418 return computeExitLimitFromICmp(L, ExitCondICmp, TBB, FBB, ControlsExit);
5420 // Check for a constant condition. These are normally stripped out by
5421 // SimplifyCFG, but ScalarEvolution may be used by a pass which wishes to
5422 // preserve the CFG and is temporarily leaving constant conditions
5424 if (ConstantInt *CI = dyn_cast<ConstantInt>(ExitCond)) {
5425 if (L->contains(FBB) == !CI->getZExtValue())
5426 // The backedge is always taken.
5427 return getCouldNotCompute();
5429 // The backedge is never taken.
5430 return getZero(CI->getType());
5433 // If it's not an integer or pointer comparison then compute it the hard way.
5434 return computeExitCountExhaustively(L, ExitCond, !L->contains(TBB));
5437 ScalarEvolution::ExitLimit
5438 ScalarEvolution::computeExitLimitFromICmp(const Loop *L,
5442 bool ControlsExit) {
5444 // If the condition was exit on true, convert the condition to exit on false
5445 ICmpInst::Predicate Cond;
5446 if (!L->contains(FBB))
5447 Cond = ExitCond->getPredicate();
5449 Cond = ExitCond->getInversePredicate();
5451 // Handle common loops like: for (X = "string"; *X; ++X)
5452 if (LoadInst *LI = dyn_cast<LoadInst>(ExitCond->getOperand(0)))
5453 if (Constant *RHS = dyn_cast<Constant>(ExitCond->getOperand(1))) {
5455 computeLoadConstantCompareExitLimit(LI, RHS, L, Cond);
5456 if (ItCnt.hasAnyInfo())
5460 ExitLimit ShiftEL = computeShiftCompareExitLimit(
5461 ExitCond->getOperand(0), ExitCond->getOperand(1), L, Cond);
5462 if (ShiftEL.hasAnyInfo())
5465 const SCEV *LHS = getSCEV(ExitCond->getOperand(0));
5466 const SCEV *RHS = getSCEV(ExitCond->getOperand(1));
5468 // Try to evaluate any dependencies out of the loop.
5469 LHS = getSCEVAtScope(LHS, L);
5470 RHS = getSCEVAtScope(RHS, L);
5472 // At this point, we would like to compute how many iterations of the
5473 // loop the predicate will return true for these inputs.
5474 if (isLoopInvariant(LHS, L) && !isLoopInvariant(RHS, L)) {
5475 // If there is a loop-invariant, force it into the RHS.
5476 std::swap(LHS, RHS);
5477 Cond = ICmpInst::getSwappedPredicate(Cond);
5480 // Simplify the operands before analyzing them.
5481 (void)SimplifyICmpOperands(Cond, LHS, RHS);
5483 // If we have a comparison of a chrec against a constant, try to use value
5484 // ranges to answer this query.
5485 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS))
5486 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS))
5487 if (AddRec->getLoop() == L) {
5488 // Form the constant range.
5489 ConstantRange CompRange(
5490 ICmpInst::makeConstantRange(Cond, RHSC->getValue()->getValue()));
5492 const SCEV *Ret = AddRec->getNumIterationsInRange(CompRange, *this);
5493 if (!isa<SCEVCouldNotCompute>(Ret)) return Ret;
5497 case ICmpInst::ICMP_NE: { // while (X != Y)
5498 // Convert to: while (X-Y != 0)
5499 ExitLimit EL = HowFarToZero(getMinusSCEV(LHS, RHS), L, ControlsExit);
5500 if (EL.hasAnyInfo()) return EL;
5503 case ICmpInst::ICMP_EQ: { // while (X == Y)
5504 // Convert to: while (X-Y == 0)
5505 ExitLimit EL = HowFarToNonZero(getMinusSCEV(LHS, RHS), L);
5506 if (EL.hasAnyInfo()) return EL;
5509 case ICmpInst::ICMP_SLT:
5510 case ICmpInst::ICMP_ULT: { // while (X < Y)
5511 bool IsSigned = Cond == ICmpInst::ICMP_SLT;
5512 ExitLimit EL = HowManyLessThans(LHS, RHS, L, IsSigned, ControlsExit);
5513 if (EL.hasAnyInfo()) return EL;
5516 case ICmpInst::ICMP_SGT:
5517 case ICmpInst::ICMP_UGT: { // while (X > Y)
5518 bool IsSigned = Cond == ICmpInst::ICMP_SGT;
5519 ExitLimit EL = HowManyGreaterThans(LHS, RHS, L, IsSigned, ControlsExit);
5520 if (EL.hasAnyInfo()) return EL;
5526 return computeExitCountExhaustively(L, ExitCond, !L->contains(TBB));
5529 ScalarEvolution::ExitLimit
5530 ScalarEvolution::computeExitLimitFromSingleExitSwitch(const Loop *L,
5532 BasicBlock *ExitingBlock,
5533 bool ControlsExit) {
5534 assert(!L->contains(ExitingBlock) && "Not an exiting block!");
5536 // Give up if the exit is the default dest of a switch.
5537 if (Switch->getDefaultDest() == ExitingBlock)
5538 return getCouldNotCompute();
5540 assert(L->contains(Switch->getDefaultDest()) &&
5541 "Default case must not exit the loop!");
5542 const SCEV *LHS = getSCEVAtScope(Switch->getCondition(), L);
5543 const SCEV *RHS = getConstant(Switch->findCaseDest(ExitingBlock));
5545 // while (X != Y) --> while (X-Y != 0)
5546 ExitLimit EL = HowFarToZero(getMinusSCEV(LHS, RHS), L, ControlsExit);
5547 if (EL.hasAnyInfo())
5550 return getCouldNotCompute();
5553 static ConstantInt *
5554 EvaluateConstantChrecAtConstant(const SCEVAddRecExpr *AddRec, ConstantInt *C,
5555 ScalarEvolution &SE) {
5556 const SCEV *InVal = SE.getConstant(C);
5557 const SCEV *Val = AddRec->evaluateAtIteration(InVal, SE);
5558 assert(isa<SCEVConstant>(Val) &&
5559 "Evaluation of SCEV at constant didn't fold correctly?");
5560 return cast<SCEVConstant>(Val)->getValue();
5563 /// computeLoadConstantCompareExitLimit - Given an exit condition of
5564 /// 'icmp op load X, cst', try to see if we can compute the backedge
5565 /// execution count.
5566 ScalarEvolution::ExitLimit
5567 ScalarEvolution::computeLoadConstantCompareExitLimit(
5571 ICmpInst::Predicate predicate) {
5573 if (LI->isVolatile()) return getCouldNotCompute();
5575 // Check to see if the loaded pointer is a getelementptr of a global.
5576 // TODO: Use SCEV instead of manually grubbing with GEPs.
5577 GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0));
5578 if (!GEP) return getCouldNotCompute();
5580 // Make sure that it is really a constant global we are gepping, with an
5581 // initializer, and make sure the first IDX is really 0.
5582 GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0));
5583 if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() ||
5584 GEP->getNumOperands() < 3 || !isa<Constant>(GEP->getOperand(1)) ||
5585 !cast<Constant>(GEP->getOperand(1))->isNullValue())
5586 return getCouldNotCompute();
5588 // Okay, we allow one non-constant index into the GEP instruction.
5589 Value *VarIdx = nullptr;
5590 std::vector<Constant*> Indexes;
5591 unsigned VarIdxNum = 0;
5592 for (unsigned i = 2, e = GEP->getNumOperands(); i != e; ++i)
5593 if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
5594 Indexes.push_back(CI);
5595 } else if (!isa<ConstantInt>(GEP->getOperand(i))) {
5596 if (VarIdx) return getCouldNotCompute(); // Multiple non-constant idx's.
5597 VarIdx = GEP->getOperand(i);
5599 Indexes.push_back(nullptr);
5602 // Loop-invariant loads may be a byproduct of loop optimization. Skip them.
5604 return getCouldNotCompute();
5606 // Okay, we know we have a (load (gep GV, 0, X)) comparison with a constant.
5607 // Check to see if X is a loop variant variable value now.
5608 const SCEV *Idx = getSCEV(VarIdx);
5609 Idx = getSCEVAtScope(Idx, L);
5611 // We can only recognize very limited forms of loop index expressions, in
5612 // particular, only affine AddRec's like {C1,+,C2}.
5613 const SCEVAddRecExpr *IdxExpr = dyn_cast<SCEVAddRecExpr>(Idx);
5614 if (!IdxExpr || !IdxExpr->isAffine() || isLoopInvariant(IdxExpr, L) ||
5615 !isa<SCEVConstant>(IdxExpr->getOperand(0)) ||
5616 !isa<SCEVConstant>(IdxExpr->getOperand(1)))
5617 return getCouldNotCompute();
5619 unsigned MaxSteps = MaxBruteForceIterations;
5620 for (unsigned IterationNum = 0; IterationNum != MaxSteps; ++IterationNum) {
5621 ConstantInt *ItCst = ConstantInt::get(
5622 cast<IntegerType>(IdxExpr->getType()), IterationNum);
5623 ConstantInt *Val = EvaluateConstantChrecAtConstant(IdxExpr, ItCst, *this);
5625 // Form the GEP offset.
5626 Indexes[VarIdxNum] = Val;
5628 Constant *Result = ConstantFoldLoadThroughGEPIndices(GV->getInitializer(),
5630 if (!Result) break; // Cannot compute!
5632 // Evaluate the condition for this iteration.
5633 Result = ConstantExpr::getICmp(predicate, Result, RHS);
5634 if (!isa<ConstantInt>(Result)) break; // Couldn't decide for sure
5635 if (cast<ConstantInt>(Result)->getValue().isMinValue()) {
5636 ++NumArrayLenItCounts;
5637 return getConstant(ItCst); // Found terminating iteration!
5640 return getCouldNotCompute();
5643 ScalarEvolution::ExitLimit ScalarEvolution::computeShiftCompareExitLimit(
5644 Value *LHS, Value *RHSV, const Loop *L, ICmpInst::Predicate Pred) {
5645 ConstantInt *RHS = dyn_cast<ConstantInt>(RHSV);
5647 return getCouldNotCompute();
5649 const BasicBlock *Latch = L->getLoopLatch();
5651 return getCouldNotCompute();
5653 const BasicBlock *Predecessor = L->getLoopPredecessor();
5655 return getCouldNotCompute();
5657 // Return true if V is of the form "LHS `shift_op` <positive constant>".
5658 // Return LHS in OutLHS and shift_opt in OutOpCode.
5659 auto MatchPositiveShift =
5660 [](Value *V, Value *&OutLHS, Instruction::BinaryOps &OutOpCode) {
5662 using namespace PatternMatch;
5664 ConstantInt *ShiftAmt;
5665 if (match(V, m_LShr(m_Value(OutLHS), m_ConstantInt(ShiftAmt))))
5666 OutOpCode = Instruction::LShr;
5667 else if (match(V, m_AShr(m_Value(OutLHS), m_ConstantInt(ShiftAmt))))
5668 OutOpCode = Instruction::AShr;
5669 else if (match(V, m_Shl(m_Value(OutLHS), m_ConstantInt(ShiftAmt))))
5670 OutOpCode = Instruction::Shl;
5674 return ShiftAmt->getValue().isStrictlyPositive();
5677 // Recognize a "shift recurrence" either of the form %iv or of %iv.shifted in
5680 // %iv = phi i32 [ %iv.shifted, %loop ], [ %val, %preheader ]
5681 // %iv.shifted = lshr i32 %iv, <positive constant>
5683 // Return true on a succesful match. Return the corresponding PHI node (%iv
5684 // above) in PNOut and the opcode of the shift operation in OpCodeOut.
5685 auto MatchShiftRecurrence =
5686 [&](Value *V, PHINode *&PNOut, Instruction::BinaryOps &OpCodeOut) {
5687 Optional<Instruction::BinaryOps> PostShiftOpCode;
5690 Instruction::BinaryOps OpC;
5693 // If we encounter a shift instruction, "peel off" the shift operation,
5694 // and remember that we did so. Later when we inspect %iv's backedge
5695 // value, we will make sure that the backedge value uses the same
5698 // Note: the peeled shift operation does not have to be the same
5699 // instruction as the one feeding into the PHI's backedge value. We only
5700 // really care about it being the same *kind* of shift instruction --
5701 // that's all that is required for our later inferences to hold.
5702 if (MatchPositiveShift(LHS, V, OpC)) {
5703 PostShiftOpCode = OpC;
5708 PNOut = dyn_cast<PHINode>(LHS);
5709 if (!PNOut || PNOut->getParent() != L->getHeader())
5712 Value *BEValue = PNOut->getIncomingValueForBlock(Latch);
5716 // The backedge value for the PHI node must be a shift by a positive
5718 MatchPositiveShift(BEValue, OpLHS, OpCodeOut) &&
5720 // of the PHI node itself
5723 // and the kind of shift should be match the kind of shift we peeled
5725 (!PostShiftOpCode.hasValue() || *PostShiftOpCode == OpCodeOut);
5729 Instruction::BinaryOps OpCode;
5730 if (!MatchShiftRecurrence(LHS, PN, OpCode))
5731 return getCouldNotCompute();
5733 const DataLayout &DL = getDataLayout();
5735 // The key rationale for this optimization is that for some kinds of shift
5736 // recurrences, the value of the recurrence "stabilizes" to either 0 or -1
5737 // within a finite number of iterations. If the condition guarding the
5738 // backedge (in the sense that the backedge is taken if the condition is true)
5739 // is false for the value the shift recurrence stabilizes to, then we know
5740 // that the backedge is taken only a finite number of times.
5742 ConstantInt *StableValue = nullptr;
5745 llvm_unreachable("Impossible case!");
5747 case Instruction::AShr: {
5748 // {K,ashr,<positive-constant>} stabilizes to signum(K) in at most
5749 // bitwidth(K) iterations.
5750 Value *FirstValue = PN->getIncomingValueForBlock(Predecessor);
5751 bool KnownZero, KnownOne;
5752 ComputeSignBit(FirstValue, KnownZero, KnownOne, DL, 0, nullptr,
5753 Predecessor->getTerminator(), &DT);
5754 auto *Ty = cast<IntegerType>(RHS->getType());
5756 StableValue = ConstantInt::get(Ty, 0);
5758 StableValue = ConstantInt::get(Ty, -1, true);
5760 return getCouldNotCompute();
5764 case Instruction::LShr:
5765 case Instruction::Shl:
5766 // Both {K,lshr,<positive-constant>} and {K,shl,<positive-constant>}
5767 // stabilize to 0 in at most bitwidth(K) iterations.
5768 StableValue = ConstantInt::get(cast<IntegerType>(RHS->getType()), 0);
5773 ConstantFoldCompareInstOperands(Pred, StableValue, RHS, DL, &TLI);
5774 assert(Result->getType()->isIntegerTy(1) &&
5775 "Otherwise cannot be an operand to a branch instruction");
5777 if (Result->isZeroValue()) {
5778 unsigned BitWidth = getTypeSizeInBits(RHS->getType());
5779 const SCEV *UpperBound =
5780 getConstant(getEffectiveSCEVType(RHS->getType()), BitWidth);
5781 return ExitLimit(getCouldNotCompute(), UpperBound);
5784 return getCouldNotCompute();
5787 /// CanConstantFold - Return true if we can constant fold an instruction of the
5788 /// specified type, assuming that all operands were constants.
5789 static bool CanConstantFold(const Instruction *I) {
5790 if (isa<BinaryOperator>(I) || isa<CmpInst>(I) ||
5791 isa<SelectInst>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I) ||
5795 if (const CallInst *CI = dyn_cast<CallInst>(I))
5796 if (const Function *F = CI->getCalledFunction())
5797 return canConstantFoldCallTo(F);
5801 /// Determine whether this instruction can constant evolve within this loop
5802 /// assuming its operands can all constant evolve.
5803 static bool canConstantEvolve(Instruction *I, const Loop *L) {
5804 // An instruction outside of the loop can't be derived from a loop PHI.
5805 if (!L->contains(I)) return false;
5807 if (isa<PHINode>(I)) {
5808 // We don't currently keep track of the control flow needed to evaluate
5809 // PHIs, so we cannot handle PHIs inside of loops.
5810 return L->getHeader() == I->getParent();
5813 // If we won't be able to constant fold this expression even if the operands
5814 // are constants, bail early.
5815 return CanConstantFold(I);
5818 /// getConstantEvolvingPHIOperands - Implement getConstantEvolvingPHI by
5819 /// recursing through each instruction operand until reaching a loop header phi.
5821 getConstantEvolvingPHIOperands(Instruction *UseInst, const Loop *L,
5822 DenseMap<Instruction *, PHINode *> &PHIMap) {
5824 // Otherwise, we can evaluate this instruction if all of its operands are
5825 // constant or derived from a PHI node themselves.
5826 PHINode *PHI = nullptr;
5827 for (Value *Op : UseInst->operands()) {
5828 if (isa<Constant>(Op)) continue;
5830 Instruction *OpInst = dyn_cast<Instruction>(Op);
5831 if (!OpInst || !canConstantEvolve(OpInst, L)) return nullptr;
5833 PHINode *P = dyn_cast<PHINode>(OpInst);
5835 // If this operand is already visited, reuse the prior result.
5836 // We may have P != PHI if this is the deepest point at which the
5837 // inconsistent paths meet.
5838 P = PHIMap.lookup(OpInst);
5840 // Recurse and memoize the results, whether a phi is found or not.
5841 // This recursive call invalidates pointers into PHIMap.
5842 P = getConstantEvolvingPHIOperands(OpInst, L, PHIMap);
5846 return nullptr; // Not evolving from PHI
5847 if (PHI && PHI != P)
5848 return nullptr; // Evolving from multiple different PHIs.
5851 // This is a expression evolving from a constant PHI!
5855 /// getConstantEvolvingPHI - Given an LLVM value and a loop, return a PHI node
5856 /// in the loop that V is derived from. We allow arbitrary operations along the
5857 /// way, but the operands of an operation must either be constants or a value
5858 /// derived from a constant PHI. If this expression does not fit with these
5859 /// constraints, return null.
5860 static PHINode *getConstantEvolvingPHI(Value *V, const Loop *L) {
5861 Instruction *I = dyn_cast<Instruction>(V);
5862 if (!I || !canConstantEvolve(I, L)) return nullptr;
5864 if (PHINode *PN = dyn_cast<PHINode>(I))
5867 // Record non-constant instructions contained by the loop.
5868 DenseMap<Instruction *, PHINode *> PHIMap;
5869 return getConstantEvolvingPHIOperands(I, L, PHIMap);
5872 /// EvaluateExpression - Given an expression that passes the
5873 /// getConstantEvolvingPHI predicate, evaluate its value assuming the PHI node
5874 /// in the loop has the value PHIVal. If we can't fold this expression for some
5875 /// reason, return null.
5876 static Constant *EvaluateExpression(Value *V, const Loop *L,
5877 DenseMap<Instruction *, Constant *> &Vals,
5878 const DataLayout &DL,
5879 const TargetLibraryInfo *TLI) {
5880 // Convenient constant check, but redundant for recursive calls.
5881 if (Constant *C = dyn_cast<Constant>(V)) return C;
5882 Instruction *I = dyn_cast<Instruction>(V);
5883 if (!I) return nullptr;
5885 if (Constant *C = Vals.lookup(I)) return C;
5887 // An instruction inside the loop depends on a value outside the loop that we
5888 // weren't given a mapping for, or a value such as a call inside the loop.
5889 if (!canConstantEvolve(I, L)) return nullptr;
5891 // An unmapped PHI can be due to a branch or another loop inside this loop,
5892 // or due to this not being the initial iteration through a loop where we
5893 // couldn't compute the evolution of this particular PHI last time.
5894 if (isa<PHINode>(I)) return nullptr;
5896 std::vector<Constant*> Operands(I->getNumOperands());
5898 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
5899 Instruction *Operand = dyn_cast<Instruction>(I->getOperand(i));
5901 Operands[i] = dyn_cast<Constant>(I->getOperand(i));
5902 if (!Operands[i]) return nullptr;
5905 Constant *C = EvaluateExpression(Operand, L, Vals, DL, TLI);
5907 if (!C) return nullptr;
5911 if (CmpInst *CI = dyn_cast<CmpInst>(I))
5912 return ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0],
5913 Operands[1], DL, TLI);
5914 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
5915 if (!LI->isVolatile())
5916 return ConstantFoldLoadFromConstPtr(Operands[0], DL);
5918 return ConstantFoldInstOperands(I->getOpcode(), I->getType(), Operands, DL,
5923 // If every incoming value to PN except the one for BB is a specific Constant,
5924 // return that, else return nullptr.
5925 static Constant *getOtherIncomingValue(PHINode *PN, BasicBlock *BB) {
5926 Constant *IncomingVal = nullptr;
5928 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
5929 if (PN->getIncomingBlock(i) == BB)
5932 auto *CurrentVal = dyn_cast<Constant>(PN->getIncomingValue(i));
5936 if (IncomingVal != CurrentVal) {
5939 IncomingVal = CurrentVal;
5946 /// getConstantEvolutionLoopExitValue - If we know that the specified Phi is
5947 /// in the header of its containing loop, we know the loop executes a
5948 /// constant number of times, and the PHI node is just a recurrence
5949 /// involving constants, fold it.
5951 ScalarEvolution::getConstantEvolutionLoopExitValue(PHINode *PN,
5954 auto I = ConstantEvolutionLoopExitValue.find(PN);
5955 if (I != ConstantEvolutionLoopExitValue.end())
5958 if (BEs.ugt(MaxBruteForceIterations))
5959 return ConstantEvolutionLoopExitValue[PN] = nullptr; // Not going to evaluate it.
5961 Constant *&RetVal = ConstantEvolutionLoopExitValue[PN];
5963 DenseMap<Instruction *, Constant *> CurrentIterVals;
5964 BasicBlock *Header = L->getHeader();
5965 assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!");
5967 BasicBlock *Latch = L->getLoopLatch();
5971 for (auto &I : *Header) {
5972 PHINode *PHI = dyn_cast<PHINode>(&I);
5974 auto *StartCST = getOtherIncomingValue(PHI, Latch);
5975 if (!StartCST) continue;
5976 CurrentIterVals[PHI] = StartCST;
5978 if (!CurrentIterVals.count(PN))
5979 return RetVal = nullptr;
5981 Value *BEValue = PN->getIncomingValueForBlock(Latch);
5983 // Execute the loop symbolically to determine the exit value.
5984 if (BEs.getActiveBits() >= 32)
5985 return RetVal = nullptr; // More than 2^32-1 iterations?? Not doing it!
5987 unsigned NumIterations = BEs.getZExtValue(); // must be in range
5988 unsigned IterationNum = 0;
5989 const DataLayout &DL = getDataLayout();
5990 for (; ; ++IterationNum) {
5991 if (IterationNum == NumIterations)
5992 return RetVal = CurrentIterVals[PN]; // Got exit value!
5994 // Compute the value of the PHIs for the next iteration.
5995 // EvaluateExpression adds non-phi values to the CurrentIterVals map.
5996 DenseMap<Instruction *, Constant *> NextIterVals;
5998 EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI);
6000 return nullptr; // Couldn't evaluate!
6001 NextIterVals[PN] = NextPHI;
6003 bool StoppedEvolving = NextPHI == CurrentIterVals[PN];
6005 // Also evaluate the other PHI nodes. However, we don't get to stop if we
6006 // cease to be able to evaluate one of them or if they stop evolving,
6007 // because that doesn't necessarily prevent us from computing PN.
6008 SmallVector<std::pair<PHINode *, Constant *>, 8> PHIsToCompute;
6009 for (const auto &I : CurrentIterVals) {
6010 PHINode *PHI = dyn_cast<PHINode>(I.first);
6011 if (!PHI || PHI == PN || PHI->getParent() != Header) continue;
6012 PHIsToCompute.emplace_back(PHI, I.second);
6014 // We use two distinct loops because EvaluateExpression may invalidate any
6015 // iterators into CurrentIterVals.
6016 for (const auto &I : PHIsToCompute) {
6017 PHINode *PHI = I.first;
6018 Constant *&NextPHI = NextIterVals[PHI];
6019 if (!NextPHI) { // Not already computed.
6020 Value *BEValue = PHI->getIncomingValueForBlock(Latch);
6021 NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI);
6023 if (NextPHI != I.second)
6024 StoppedEvolving = false;
6027 // If all entries in CurrentIterVals == NextIterVals then we can stop
6028 // iterating, the loop can't continue to change.
6029 if (StoppedEvolving)
6030 return RetVal = CurrentIterVals[PN];
6032 CurrentIterVals.swap(NextIterVals);
6036 const SCEV *ScalarEvolution::computeExitCountExhaustively(const Loop *L,
6039 PHINode *PN = getConstantEvolvingPHI(Cond, L);
6040 if (!PN) return getCouldNotCompute();
6042 // If the loop is canonicalized, the PHI will have exactly two entries.
6043 // That's the only form we support here.
6044 if (PN->getNumIncomingValues() != 2) return getCouldNotCompute();
6046 DenseMap<Instruction *, Constant *> CurrentIterVals;
6047 BasicBlock *Header = L->getHeader();
6048 assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!");
6050 BasicBlock *Latch = L->getLoopLatch();
6051 assert(Latch && "Should follow from NumIncomingValues == 2!");
6053 for (auto &I : *Header) {
6054 PHINode *PHI = dyn_cast<PHINode>(&I);
6057 auto *StartCST = getOtherIncomingValue(PHI, Latch);
6058 if (!StartCST) continue;
6059 CurrentIterVals[PHI] = StartCST;
6061 if (!CurrentIterVals.count(PN))
6062 return getCouldNotCompute();
6064 // Okay, we find a PHI node that defines the trip count of this loop. Execute
6065 // the loop symbolically to determine when the condition gets a value of
6067 unsigned MaxIterations = MaxBruteForceIterations; // Limit analysis.
6068 const DataLayout &DL = getDataLayout();
6069 for (unsigned IterationNum = 0; IterationNum != MaxIterations;++IterationNum){
6070 auto *CondVal = dyn_cast_or_null<ConstantInt>(
6071 EvaluateExpression(Cond, L, CurrentIterVals, DL, &TLI));
6073 // Couldn't symbolically evaluate.
6074 if (!CondVal) return getCouldNotCompute();
6076 if (CondVal->getValue() == uint64_t(ExitWhen)) {
6077 ++NumBruteForceTripCountsComputed;
6078 return getConstant(Type::getInt32Ty(getContext()), IterationNum);
6081 // Update all the PHI nodes for the next iteration.
6082 DenseMap<Instruction *, Constant *> NextIterVals;
6084 // Create a list of which PHIs we need to compute. We want to do this before
6085 // calling EvaluateExpression on them because that may invalidate iterators
6086 // into CurrentIterVals.
6087 SmallVector<PHINode *, 8> PHIsToCompute;
6088 for (const auto &I : CurrentIterVals) {
6089 PHINode *PHI = dyn_cast<PHINode>(I.first);
6090 if (!PHI || PHI->getParent() != Header) continue;
6091 PHIsToCompute.push_back(PHI);
6093 for (PHINode *PHI : PHIsToCompute) {
6094 Constant *&NextPHI = NextIterVals[PHI];
6095 if (NextPHI) continue; // Already computed!
6097 Value *BEValue = PHI->getIncomingValueForBlock(Latch);
6098 NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI);
6100 CurrentIterVals.swap(NextIterVals);
6103 // Too many iterations were needed to evaluate.
6104 return getCouldNotCompute();
6107 /// getSCEVAtScope - Return a SCEV expression for the specified value
6108 /// at the specified scope in the program. The L value specifies a loop
6109 /// nest to evaluate the expression at, where null is the top-level or a
6110 /// specified loop is immediately inside of the loop.
6112 /// This method can be used to compute the exit value for a variable defined
6113 /// in a loop by querying what the value will hold in the parent loop.
6115 /// In the case that a relevant loop exit value cannot be computed, the
6116 /// original value V is returned.
6117 const SCEV *ScalarEvolution::getSCEVAtScope(const SCEV *V, const Loop *L) {
6118 SmallVector<std::pair<const Loop *, const SCEV *>, 2> &Values =
6120 // Check to see if we've folded this expression at this loop before.
6121 for (auto &LS : Values)
6123 return LS.second ? LS.second : V;
6125 Values.emplace_back(L, nullptr);
6127 // Otherwise compute it.
6128 const SCEV *C = computeSCEVAtScope(V, L);
6129 for (auto &LS : reverse(ValuesAtScopes[V]))
6130 if (LS.first == L) {
6137 /// This builds up a Constant using the ConstantExpr interface. That way, we
6138 /// will return Constants for objects which aren't represented by a
6139 /// SCEVConstant, because SCEVConstant is restricted to ConstantInt.
6140 /// Returns NULL if the SCEV isn't representable as a Constant.
6141 static Constant *BuildConstantFromSCEV(const SCEV *V) {
6142 switch (static_cast<SCEVTypes>(V->getSCEVType())) {
6143 case scCouldNotCompute:
6147 return cast<SCEVConstant>(V)->getValue();
6149 return dyn_cast<Constant>(cast<SCEVUnknown>(V)->getValue());
6150 case scSignExtend: {
6151 const SCEVSignExtendExpr *SS = cast<SCEVSignExtendExpr>(V);
6152 if (Constant *CastOp = BuildConstantFromSCEV(SS->getOperand()))
6153 return ConstantExpr::getSExt(CastOp, SS->getType());
6156 case scZeroExtend: {
6157 const SCEVZeroExtendExpr *SZ = cast<SCEVZeroExtendExpr>(V);
6158 if (Constant *CastOp = BuildConstantFromSCEV(SZ->getOperand()))
6159 return ConstantExpr::getZExt(CastOp, SZ->getType());
6163 const SCEVTruncateExpr *ST = cast<SCEVTruncateExpr>(V);
6164 if (Constant *CastOp = BuildConstantFromSCEV(ST->getOperand()))
6165 return ConstantExpr::getTrunc(CastOp, ST->getType());
6169 const SCEVAddExpr *SA = cast<SCEVAddExpr>(V);
6170 if (Constant *C = BuildConstantFromSCEV(SA->getOperand(0))) {
6171 if (PointerType *PTy = dyn_cast<PointerType>(C->getType())) {
6172 unsigned AS = PTy->getAddressSpace();
6173 Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS);
6174 C = ConstantExpr::getBitCast(C, DestPtrTy);
6176 for (unsigned i = 1, e = SA->getNumOperands(); i != e; ++i) {
6177 Constant *C2 = BuildConstantFromSCEV(SA->getOperand(i));
6178 if (!C2) return nullptr;
6181 if (!C->getType()->isPointerTy() && C2->getType()->isPointerTy()) {
6182 unsigned AS = C2->getType()->getPointerAddressSpace();
6184 Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS);
6185 // The offsets have been converted to bytes. We can add bytes to an
6186 // i8* by GEP with the byte count in the first index.
6187 C = ConstantExpr::getBitCast(C, DestPtrTy);
6190 // Don't bother trying to sum two pointers. We probably can't
6191 // statically compute a load that results from it anyway.
6192 if (C2->getType()->isPointerTy())
6195 if (PointerType *PTy = dyn_cast<PointerType>(C->getType())) {
6196 if (PTy->getElementType()->isStructTy())
6197 C2 = ConstantExpr::getIntegerCast(
6198 C2, Type::getInt32Ty(C->getContext()), true);
6199 C = ConstantExpr::getGetElementPtr(PTy->getElementType(), C, C2);
6201 C = ConstantExpr::getAdd(C, C2);
6208 const SCEVMulExpr *SM = cast<SCEVMulExpr>(V);
6209 if (Constant *C = BuildConstantFromSCEV(SM->getOperand(0))) {
6210 // Don't bother with pointers at all.
6211 if (C->getType()->isPointerTy()) return nullptr;
6212 for (unsigned i = 1, e = SM->getNumOperands(); i != e; ++i) {
6213 Constant *C2 = BuildConstantFromSCEV(SM->getOperand(i));
6214 if (!C2 || C2->getType()->isPointerTy()) return nullptr;
6215 C = ConstantExpr::getMul(C, C2);
6222 const SCEVUDivExpr *SU = cast<SCEVUDivExpr>(V);
6223 if (Constant *LHS = BuildConstantFromSCEV(SU->getLHS()))
6224 if (Constant *RHS = BuildConstantFromSCEV(SU->getRHS()))
6225 if (LHS->getType() == RHS->getType())
6226 return ConstantExpr::getUDiv(LHS, RHS);
6231 break; // TODO: smax, umax.
6236 const SCEV *ScalarEvolution::computeSCEVAtScope(const SCEV *V, const Loop *L) {
6237 if (isa<SCEVConstant>(V)) return V;
6239 // If this instruction is evolved from a constant-evolving PHI, compute the
6240 // exit value from the loop without using SCEVs.
6241 if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V)) {
6242 if (Instruction *I = dyn_cast<Instruction>(SU->getValue())) {
6243 const Loop *LI = this->LI[I->getParent()];
6244 if (LI && LI->getParentLoop() == L) // Looking for loop exit value.
6245 if (PHINode *PN = dyn_cast<PHINode>(I))
6246 if (PN->getParent() == LI->getHeader()) {
6247 // Okay, there is no closed form solution for the PHI node. Check
6248 // to see if the loop that contains it has a known backedge-taken
6249 // count. If so, we may be able to force computation of the exit
6251 const SCEV *BackedgeTakenCount = getBackedgeTakenCount(LI);
6252 if (const SCEVConstant *BTCC =
6253 dyn_cast<SCEVConstant>(BackedgeTakenCount)) {
6254 // Okay, we know how many times the containing loop executes. If
6255 // this is a constant evolving PHI node, get the final value at
6256 // the specified iteration number.
6257 Constant *RV = getConstantEvolutionLoopExitValue(PN,
6258 BTCC->getValue()->getValue(),
6260 if (RV) return getSCEV(RV);
6264 // Okay, this is an expression that we cannot symbolically evaluate
6265 // into a SCEV. Check to see if it's possible to symbolically evaluate
6266 // the arguments into constants, and if so, try to constant propagate the
6267 // result. This is particularly useful for computing loop exit values.
6268 if (CanConstantFold(I)) {
6269 SmallVector<Constant *, 4> Operands;
6270 bool MadeImprovement = false;
6271 for (Value *Op : I->operands()) {
6272 if (Constant *C = dyn_cast<Constant>(Op)) {
6273 Operands.push_back(C);
6277 // If any of the operands is non-constant and if they are
6278 // non-integer and non-pointer, don't even try to analyze them
6279 // with scev techniques.
6280 if (!isSCEVable(Op->getType()))
6283 const SCEV *OrigV = getSCEV(Op);
6284 const SCEV *OpV = getSCEVAtScope(OrigV, L);
6285 MadeImprovement |= OrigV != OpV;
6287 Constant *C = BuildConstantFromSCEV(OpV);
6289 if (C->getType() != Op->getType())
6290 C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
6294 Operands.push_back(C);
6297 // Check to see if getSCEVAtScope actually made an improvement.
6298 if (MadeImprovement) {
6299 Constant *C = nullptr;
6300 const DataLayout &DL = getDataLayout();
6301 if (const CmpInst *CI = dyn_cast<CmpInst>(I))
6302 C = ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0],
6303 Operands[1], DL, &TLI);
6304 else if (const LoadInst *LI = dyn_cast<LoadInst>(I)) {
6305 if (!LI->isVolatile())
6306 C = ConstantFoldLoadFromConstPtr(Operands[0], DL);
6308 C = ConstantFoldInstOperands(I->getOpcode(), I->getType(), Operands,
6316 // This is some other type of SCEVUnknown, just return it.
6320 if (const SCEVCommutativeExpr *Comm = dyn_cast<SCEVCommutativeExpr>(V)) {
6321 // Avoid performing the look-up in the common case where the specified
6322 // expression has no loop-variant portions.
6323 for (unsigned i = 0, e = Comm->getNumOperands(); i != e; ++i) {
6324 const SCEV *OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
6325 if (OpAtScope != Comm->getOperand(i)) {
6326 // Okay, at least one of these operands is loop variant but might be
6327 // foldable. Build a new instance of the folded commutative expression.
6328 SmallVector<const SCEV *, 8> NewOps(Comm->op_begin(),
6329 Comm->op_begin()+i);
6330 NewOps.push_back(OpAtScope);
6332 for (++i; i != e; ++i) {
6333 OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
6334 NewOps.push_back(OpAtScope);
6336 if (isa<SCEVAddExpr>(Comm))
6337 return getAddExpr(NewOps);
6338 if (isa<SCEVMulExpr>(Comm))
6339 return getMulExpr(NewOps);
6340 if (isa<SCEVSMaxExpr>(Comm))
6341 return getSMaxExpr(NewOps);
6342 if (isa<SCEVUMaxExpr>(Comm))
6343 return getUMaxExpr(NewOps);
6344 llvm_unreachable("Unknown commutative SCEV type!");
6347 // If we got here, all operands are loop invariant.
6351 if (const SCEVUDivExpr *Div = dyn_cast<SCEVUDivExpr>(V)) {
6352 const SCEV *LHS = getSCEVAtScope(Div->getLHS(), L);
6353 const SCEV *RHS = getSCEVAtScope(Div->getRHS(), L);
6354 if (LHS == Div->getLHS() && RHS == Div->getRHS())
6355 return Div; // must be loop invariant
6356 return getUDivExpr(LHS, RHS);
6359 // If this is a loop recurrence for a loop that does not contain L, then we
6360 // are dealing with the final value computed by the loop.
6361 if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V)) {
6362 // First, attempt to evaluate each operand.
6363 // Avoid performing the look-up in the common case where the specified
6364 // expression has no loop-variant portions.
6365 for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
6366 const SCEV *OpAtScope = getSCEVAtScope(AddRec->getOperand(i), L);
6367 if (OpAtScope == AddRec->getOperand(i))
6370 // Okay, at least one of these operands is loop variant but might be
6371 // foldable. Build a new instance of the folded commutative expression.
6372 SmallVector<const SCEV *, 8> NewOps(AddRec->op_begin(),
6373 AddRec->op_begin()+i);
6374 NewOps.push_back(OpAtScope);
6375 for (++i; i != e; ++i)
6376 NewOps.push_back(getSCEVAtScope(AddRec->getOperand(i), L));
6378 const SCEV *FoldedRec =
6379 getAddRecExpr(NewOps, AddRec->getLoop(),
6380 AddRec->getNoWrapFlags(SCEV::FlagNW));
6381 AddRec = dyn_cast<SCEVAddRecExpr>(FoldedRec);
6382 // The addrec may be folded to a nonrecurrence, for example, if the
6383 // induction variable is multiplied by zero after constant folding. Go
6384 // ahead and return the folded value.
6390 // If the scope is outside the addrec's loop, evaluate it by using the
6391 // loop exit value of the addrec.
6392 if (!AddRec->getLoop()->contains(L)) {
6393 // To evaluate this recurrence, we need to know how many times the AddRec
6394 // loop iterates. Compute this now.
6395 const SCEV *BackedgeTakenCount = getBackedgeTakenCount(AddRec->getLoop());
6396 if (BackedgeTakenCount == getCouldNotCompute()) return AddRec;
6398 // Then, evaluate the AddRec.
6399 return AddRec->evaluateAtIteration(BackedgeTakenCount, *this);
6405 if (const SCEVZeroExtendExpr *Cast = dyn_cast<SCEVZeroExtendExpr>(V)) {
6406 const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
6407 if (Op == Cast->getOperand())
6408 return Cast; // must be loop invariant
6409 return getZeroExtendExpr(Op, Cast->getType());
6412 if (const SCEVSignExtendExpr *Cast = dyn_cast<SCEVSignExtendExpr>(V)) {
6413 const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
6414 if (Op == Cast->getOperand())
6415 return Cast; // must be loop invariant
6416 return getSignExtendExpr(Op, Cast->getType());
6419 if (const SCEVTruncateExpr *Cast = dyn_cast<SCEVTruncateExpr>(V)) {
6420 const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
6421 if (Op == Cast->getOperand())
6422 return Cast; // must be loop invariant
6423 return getTruncateExpr(Op, Cast->getType());
6426 llvm_unreachable("Unknown SCEV type!");
6429 /// getSCEVAtScope - This is a convenience function which does
6430 /// getSCEVAtScope(getSCEV(V), L).
6431 const SCEV *ScalarEvolution::getSCEVAtScope(Value *V, const Loop *L) {
6432 return getSCEVAtScope(getSCEV(V), L);
6435 /// SolveLinEquationWithOverflow - Finds the minimum unsigned root of the
6436 /// following equation:
6438 /// A * X = B (mod N)
6440 /// where N = 2^BW and BW is the common bit width of A and B. The signedness of
6441 /// A and B isn't important.
6443 /// If the equation does not have a solution, SCEVCouldNotCompute is returned.
6444 static const SCEV *SolveLinEquationWithOverflow(const APInt &A, const APInt &B,
6445 ScalarEvolution &SE) {
6446 uint32_t BW = A.getBitWidth();
6447 assert(BW == B.getBitWidth() && "Bit widths must be the same.");
6448 assert(A != 0 && "A must be non-zero.");
6452 // The gcd of A and N may have only one prime factor: 2. The number of
6453 // trailing zeros in A is its multiplicity
6454 uint32_t Mult2 = A.countTrailingZeros();
6457 // 2. Check if B is divisible by D.
6459 // B is divisible by D if and only if the multiplicity of prime factor 2 for B
6460 // is not less than multiplicity of this prime factor for D.
6461 if (B.countTrailingZeros() < Mult2)
6462 return SE.getCouldNotCompute();
6464 // 3. Compute I: the multiplicative inverse of (A / D) in arithmetic
6467 // (N / D) may need BW+1 bits in its representation. Hence, we'll use this
6468 // bit width during computations.
6469 APInt AD = A.lshr(Mult2).zext(BW + 1); // AD = A / D
6470 APInt Mod(BW + 1, 0);
6471 Mod.setBit(BW - Mult2); // Mod = N / D
6472 APInt I = AD.multiplicativeInverse(Mod);
6474 // 4. Compute the minimum unsigned root of the equation:
6475 // I * (B / D) mod (N / D)
6476 APInt Result = (I * B.lshr(Mult2).zext(BW + 1)).urem(Mod);
6478 // The result is guaranteed to be less than 2^BW so we may truncate it to BW
6480 return SE.getConstant(Result.trunc(BW));
6483 /// SolveQuadraticEquation - Find the roots of the quadratic equation for the
6484 /// given quadratic chrec {L,+,M,+,N}. This returns either the two roots (which
6485 /// might be the same) or two SCEVCouldNotCompute objects.
6487 static std::pair<const SCEV *,const SCEV *>
6488 SolveQuadraticEquation(const SCEVAddRecExpr *AddRec, ScalarEvolution &SE) {
6489 assert(AddRec->getNumOperands() == 3 && "This is not a quadratic chrec!");
6490 const SCEVConstant *LC = dyn_cast<SCEVConstant>(AddRec->getOperand(0));
6491 const SCEVConstant *MC = dyn_cast<SCEVConstant>(AddRec->getOperand(1));
6492 const SCEVConstant *NC = dyn_cast<SCEVConstant>(AddRec->getOperand(2));
6494 // We currently can only solve this if the coefficients are constants.
6495 if (!LC || !MC || !NC) {
6496 const SCEV *CNC = SE.getCouldNotCompute();
6497 return std::make_pair(CNC, CNC);
6500 uint32_t BitWidth = LC->getValue()->getValue().getBitWidth();
6501 const APInt &L = LC->getValue()->getValue();
6502 const APInt &M = MC->getValue()->getValue();
6503 const APInt &N = NC->getValue()->getValue();
6504 APInt Two(BitWidth, 2);
6505 APInt Four(BitWidth, 4);
6508 using namespace APIntOps;
6510 // Convert from chrec coefficients to polynomial coefficients AX^2+BX+C
6511 // The B coefficient is M-N/2
6515 // The A coefficient is N/2
6516 APInt A(N.sdiv(Two));
6518 // Compute the B^2-4ac term.
6521 SqrtTerm -= Four * (A * C);
6523 if (SqrtTerm.isNegative()) {
6524 // The loop is provably infinite.
6525 const SCEV *CNC = SE.getCouldNotCompute();
6526 return std::make_pair(CNC, CNC);
6529 // Compute sqrt(B^2-4ac). This is guaranteed to be the nearest
6530 // integer value or else APInt::sqrt() will assert.
6531 APInt SqrtVal(SqrtTerm.sqrt());
6533 // Compute the two solutions for the quadratic formula.
6534 // The divisions must be performed as signed divisions.
6537 if (TwoA.isMinValue()) {
6538 const SCEV *CNC = SE.getCouldNotCompute();
6539 return std::make_pair(CNC, CNC);
6542 LLVMContext &Context = SE.getContext();
6544 ConstantInt *Solution1 =
6545 ConstantInt::get(Context, (NegB + SqrtVal).sdiv(TwoA));
6546 ConstantInt *Solution2 =
6547 ConstantInt::get(Context, (NegB - SqrtVal).sdiv(TwoA));
6549 return std::make_pair(SE.getConstant(Solution1),
6550 SE.getConstant(Solution2));
6551 } // end APIntOps namespace
6554 /// HowFarToZero - Return the number of times a backedge comparing the specified
6555 /// value to zero will execute. If not computable, return CouldNotCompute.
6557 /// This is only used for loops with a "x != y" exit test. The exit condition is
6558 /// now expressed as a single expression, V = x-y. So the exit test is
6559 /// effectively V != 0. We know and take advantage of the fact that this
6560 /// expression only being used in a comparison by zero context.
6561 ScalarEvolution::ExitLimit
6562 ScalarEvolution::HowFarToZero(const SCEV *V, const Loop *L, bool ControlsExit) {
6563 // If the value is a constant
6564 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
6565 // If the value is already zero, the branch will execute zero times.
6566 if (C->getValue()->isZero()) return C;
6567 return getCouldNotCompute(); // Otherwise it will loop infinitely.
6570 const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V);
6571 if (!AddRec || AddRec->getLoop() != L)
6572 return getCouldNotCompute();
6574 // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of
6575 // the quadratic equation to solve it.
6576 if (AddRec->isQuadratic() && AddRec->getType()->isIntegerTy()) {
6577 std::pair<const SCEV *,const SCEV *> Roots =
6578 SolveQuadraticEquation(AddRec, *this);
6579 const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
6580 const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
6582 // Pick the smallest positive root value.
6583 if (ConstantInt *CB =
6584 dyn_cast<ConstantInt>(ConstantExpr::getICmp(CmpInst::ICMP_ULT,
6587 if (!CB->getZExtValue())
6588 std::swap(R1, R2); // R1 is the minimum root now.
6590 // We can only use this value if the chrec ends up with an exact zero
6591 // value at this index. When solving for "X*X != 5", for example, we
6592 // should not accept a root of 2.
6593 const SCEV *Val = AddRec->evaluateAtIteration(R1, *this);
6595 return R1; // We found a quadratic root!
6598 return getCouldNotCompute();
6601 // Otherwise we can only handle this if it is affine.
6602 if (!AddRec->isAffine())
6603 return getCouldNotCompute();
6605 // If this is an affine expression, the execution count of this branch is
6606 // the minimum unsigned root of the following equation:
6608 // Start + Step*N = 0 (mod 2^BW)
6612 // Step*N = -Start (mod 2^BW)
6614 // where BW is the common bit width of Start and Step.
6616 // Get the initial value for the loop.
6617 const SCEV *Start = getSCEVAtScope(AddRec->getStart(), L->getParentLoop());
6618 const SCEV *Step = getSCEVAtScope(AddRec->getOperand(1), L->getParentLoop());
6620 // For now we handle only constant steps.
6622 // TODO: Handle a nonconstant Step given AddRec<NUW>. If the
6623 // AddRec is NUW, then (in an unsigned sense) it cannot be counting up to wrap
6624 // to 0, it must be counting down to equal 0. Consequently, N = Start / -Step.
6625 // We have not yet seen any such cases.
6626 const SCEVConstant *StepC = dyn_cast<SCEVConstant>(Step);
6627 if (!StepC || StepC->getValue()->equalsInt(0))
6628 return getCouldNotCompute();
6630 // For positive steps (counting up until unsigned overflow):
6631 // N = -Start/Step (as unsigned)
6632 // For negative steps (counting down to zero):
6634 // First compute the unsigned distance from zero in the direction of Step.
6635 bool CountDown = StepC->getValue()->getValue().isNegative();
6636 const SCEV *Distance = CountDown ? Start : getNegativeSCEV(Start);
6638 // Handle unitary steps, which cannot wraparound.
6639 // 1*N = -Start; -1*N = Start (mod 2^BW), so:
6640 // N = Distance (as unsigned)
6641 if (StepC->getValue()->equalsInt(1) || StepC->getValue()->isAllOnesValue()) {
6642 ConstantRange CR = getUnsignedRange(Start);
6643 const SCEV *MaxBECount;
6644 if (!CountDown && CR.getUnsignedMin().isMinValue())
6645 // When counting up, the worst starting value is 1, not 0.
6646 MaxBECount = CR.getUnsignedMax().isMinValue()
6647 ? getConstant(APInt::getMinValue(CR.getBitWidth()))
6648 : getConstant(APInt::getMaxValue(CR.getBitWidth()));
6650 MaxBECount = getConstant(CountDown ? CR.getUnsignedMax()
6651 : -CR.getUnsignedMin());
6652 return ExitLimit(Distance, MaxBECount);
6655 // As a special case, handle the instance where Step is a positive power of
6656 // two. In this case, determining whether Step divides Distance evenly can be
6657 // done by counting and comparing the number of trailing zeros of Step and
6660 const APInt &StepV = StepC->getValue()->getValue();
6661 // StepV.isPowerOf2() returns true if StepV is an positive power of two. It
6662 // also returns true if StepV is maximally negative (eg, INT_MIN), but that
6663 // case is not handled as this code is guarded by !CountDown.
6664 if (StepV.isPowerOf2() &&
6665 GetMinTrailingZeros(Distance) >= StepV.countTrailingZeros()) {
6666 // Here we've constrained the equation to be of the form
6668 // 2^(N + k) * Distance' = (StepV == 2^N) * X (mod 2^W) ... (0)
6670 // where we're operating on a W bit wide integer domain and k is
6671 // non-negative. The smallest unsigned solution for X is the trip count.
6673 // (0) is equivalent to:
6675 // 2^(N + k) * Distance' - 2^N * X = L * 2^W
6676 // <=> 2^N(2^k * Distance' - X) = L * 2^(W - N) * 2^N
6677 // <=> 2^k * Distance' - X = L * 2^(W - N)
6678 // <=> 2^k * Distance' = L * 2^(W - N) + X ... (1)
6680 // The smallest X satisfying (1) is unsigned remainder of dividing the LHS
6683 // <=> X = 2^k * Distance' URem 2^(W - N) ... (2)
6685 // E.g. say we're solving
6687 // 2 * Val = 2 * X (in i8) ... (3)
6689 // then from (2), we get X = Val URem i8 128 (k = 0 in this case).
6691 // Note: It is tempting to solve (3) by setting X = Val, but Val is not
6692 // necessarily the smallest unsigned value of X that satisfies (3).
6693 // E.g. if Val is i8 -127 then the smallest value of X that satisfies (3)
6694 // is i8 1, not i8 -127
6696 const auto *ModuloResult = getUDivExactExpr(Distance, Step);
6698 // Since SCEV does not have a URem node, we construct one using a truncate
6699 // and a zero extend.
6701 unsigned NarrowWidth = StepV.getBitWidth() - StepV.countTrailingZeros();
6702 auto *NarrowTy = IntegerType::get(getContext(), NarrowWidth);
6703 auto *WideTy = Distance->getType();
6705 return getZeroExtendExpr(getTruncateExpr(ModuloResult, NarrowTy), WideTy);
6709 // If the condition controls loop exit (the loop exits only if the expression
6710 // is true) and the addition is no-wrap we can use unsigned divide to
6711 // compute the backedge count. In this case, the step may not divide the
6712 // distance, but we don't care because if the condition is "missed" the loop
6713 // will have undefined behavior due to wrapping.
6714 if (ControlsExit && AddRec->getNoWrapFlags(SCEV::FlagNW)) {
6716 getUDivExpr(Distance, CountDown ? getNegativeSCEV(Step) : Step);
6717 return ExitLimit(Exact, Exact);
6720 // Then, try to solve the above equation provided that Start is constant.
6721 if (const SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start))
6722 return SolveLinEquationWithOverflow(StepC->getValue()->getValue(),
6723 -StartC->getValue()->getValue(),
6725 return getCouldNotCompute();
6728 /// HowFarToNonZero - Return the number of times a backedge checking the
6729 /// specified value for nonzero will execute. If not computable, return
6731 ScalarEvolution::ExitLimit
6732 ScalarEvolution::HowFarToNonZero(const SCEV *V, const Loop *L) {
6733 // Loops that look like: while (X == 0) are very strange indeed. We don't
6734 // handle them yet except for the trivial case. This could be expanded in the
6735 // future as needed.
6737 // If the value is a constant, check to see if it is known to be non-zero
6738 // already. If so, the backedge will execute zero times.
6739 if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
6740 if (!C->getValue()->isNullValue())
6741 return getZero(C->getType());
6742 return getCouldNotCompute(); // Otherwise it will loop infinitely.
6745 // We could implement others, but I really doubt anyone writes loops like
6746 // this, and if they did, they would already be constant folded.
6747 return getCouldNotCompute();
6750 /// getPredecessorWithUniqueSuccessorForBB - Return a predecessor of BB
6751 /// (which may not be an immediate predecessor) which has exactly one
6752 /// successor from which BB is reachable, or null if no such block is
6755 std::pair<BasicBlock *, BasicBlock *>
6756 ScalarEvolution::getPredecessorWithUniqueSuccessorForBB(BasicBlock *BB) {
6757 // If the block has a unique predecessor, then there is no path from the
6758 // predecessor to the block that does not go through the direct edge
6759 // from the predecessor to the block.
6760 if (BasicBlock *Pred = BB->getSinglePredecessor())
6761 return std::make_pair(Pred, BB);
6763 // A loop's header is defined to be a block that dominates the loop.
6764 // If the header has a unique predecessor outside the loop, it must be
6765 // a block that has exactly one successor that can reach the loop.
6766 if (Loop *L = LI.getLoopFor(BB))
6767 return std::make_pair(L->getLoopPredecessor(), L->getHeader());
6769 return std::pair<BasicBlock *, BasicBlock *>();
6772 /// HasSameValue - SCEV structural equivalence is usually sufficient for
6773 /// testing whether two expressions are equal, however for the purposes of
6774 /// looking for a condition guarding a loop, it can be useful to be a little
6775 /// more general, since a front-end may have replicated the controlling
6778 static bool HasSameValue(const SCEV *A, const SCEV *B) {
6779 // Quick check to see if they are the same SCEV.
6780 if (A == B) return true;
6782 auto ComputesEqualValues = [](const Instruction *A, const Instruction *B) {
6783 // Not all instructions that are "identical" compute the same value. For
6784 // instance, two distinct alloca instructions allocating the same type are
6785 // identical and do not read memory; but compute distinct values.
6786 return A->isIdenticalTo(B) && (isa<BinaryOperator>(A) || isa<GetElementPtrInst>(A));
6789 // Otherwise, if they're both SCEVUnknown, it's possible that they hold
6790 // two different instructions with the same value. Check for this case.
6791 if (const SCEVUnknown *AU = dyn_cast<SCEVUnknown>(A))
6792 if (const SCEVUnknown *BU = dyn_cast<SCEVUnknown>(B))
6793 if (const Instruction *AI = dyn_cast<Instruction>(AU->getValue()))
6794 if (const Instruction *BI = dyn_cast<Instruction>(BU->getValue()))
6795 if (ComputesEqualValues(AI, BI))
6798 // Otherwise assume they may have a different value.
6802 /// SimplifyICmpOperands - Simplify LHS and RHS in a comparison with
6803 /// predicate Pred. Return true iff any changes were made.
6805 bool ScalarEvolution::SimplifyICmpOperands(ICmpInst::Predicate &Pred,
6806 const SCEV *&LHS, const SCEV *&RHS,
6808 bool Changed = false;
6810 // If we hit the max recursion limit bail out.
6814 // Canonicalize a constant to the right side.
6815 if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
6816 // Check for both operands constant.
6817 if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
6818 if (ConstantExpr::getICmp(Pred,
6820 RHSC->getValue())->isNullValue())
6821 goto trivially_false;
6823 goto trivially_true;
6825 // Otherwise swap the operands to put the constant on the right.
6826 std::swap(LHS, RHS);
6827 Pred = ICmpInst::getSwappedPredicate(Pred);
6831 // If we're comparing an addrec with a value which is loop-invariant in the
6832 // addrec's loop, put the addrec on the left. Also make a dominance check,
6833 // as both operands could be addrecs loop-invariant in each other's loop.
6834 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS)) {
6835 const Loop *L = AR->getLoop();
6836 if (isLoopInvariant(LHS, L) && properlyDominates(LHS, L->getHeader())) {
6837 std::swap(LHS, RHS);
6838 Pred = ICmpInst::getSwappedPredicate(Pred);
6843 // If there's a constant operand, canonicalize comparisons with boundary
6844 // cases, and canonicalize *-or-equal comparisons to regular comparisons.
6845 if (const SCEVConstant *RC = dyn_cast<SCEVConstant>(RHS)) {
6846 const APInt &RA = RC->getValue()->getValue();
6848 default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
6849 case ICmpInst::ICMP_EQ:
6850 case ICmpInst::ICMP_NE:
6851 // Fold ((-1) * %a) + %b == 0 (equivalent to %b-%a == 0) into %a == %b.
6853 if (const SCEVAddExpr *AE = dyn_cast<SCEVAddExpr>(LHS))
6854 if (const SCEVMulExpr *ME = dyn_cast<SCEVMulExpr>(AE->getOperand(0)))
6855 if (AE->getNumOperands() == 2 && ME->getNumOperands() == 2 &&
6856 ME->getOperand(0)->isAllOnesValue()) {
6857 RHS = AE->getOperand(1);
6858 LHS = ME->getOperand(1);
6862 case ICmpInst::ICMP_UGE:
6863 if ((RA - 1).isMinValue()) {
6864 Pred = ICmpInst::ICMP_NE;
6865 RHS = getConstant(RA - 1);
6869 if (RA.isMaxValue()) {
6870 Pred = ICmpInst::ICMP_EQ;
6874 if (RA.isMinValue()) goto trivially_true;
6876 Pred = ICmpInst::ICMP_UGT;
6877 RHS = getConstant(RA - 1);
6880 case ICmpInst::ICMP_ULE:
6881 if ((RA + 1).isMaxValue()) {
6882 Pred = ICmpInst::ICMP_NE;
6883 RHS = getConstant(RA + 1);
6887 if (RA.isMinValue()) {
6888 Pred = ICmpInst::ICMP_EQ;
6892 if (RA.isMaxValue()) goto trivially_true;
6894 Pred = ICmpInst::ICMP_ULT;
6895 RHS = getConstant(RA + 1);
6898 case ICmpInst::ICMP_SGE:
6899 if ((RA - 1).isMinSignedValue()) {
6900 Pred = ICmpInst::ICMP_NE;
6901 RHS = getConstant(RA - 1);
6905 if (RA.isMaxSignedValue()) {
6906 Pred = ICmpInst::ICMP_EQ;
6910 if (RA.isMinSignedValue()) goto trivially_true;
6912 Pred = ICmpInst::ICMP_SGT;
6913 RHS = getConstant(RA - 1);
6916 case ICmpInst::ICMP_SLE:
6917 if ((RA + 1).isMaxSignedValue()) {
6918 Pred = ICmpInst::ICMP_NE;
6919 RHS = getConstant(RA + 1);
6923 if (RA.isMinSignedValue()) {
6924 Pred = ICmpInst::ICMP_EQ;
6928 if (RA.isMaxSignedValue()) goto trivially_true;
6930 Pred = ICmpInst::ICMP_SLT;
6931 RHS = getConstant(RA + 1);
6934 case ICmpInst::ICMP_UGT:
6935 if (RA.isMinValue()) {
6936 Pred = ICmpInst::ICMP_NE;
6940 if ((RA + 1).isMaxValue()) {
6941 Pred = ICmpInst::ICMP_EQ;
6942 RHS = getConstant(RA + 1);
6946 if (RA.isMaxValue()) goto trivially_false;
6948 case ICmpInst::ICMP_ULT:
6949 if (RA.isMaxValue()) {
6950 Pred = ICmpInst::ICMP_NE;
6954 if ((RA - 1).isMinValue()) {
6955 Pred = ICmpInst::ICMP_EQ;
6956 RHS = getConstant(RA - 1);
6960 if (RA.isMinValue()) goto trivially_false;
6962 case ICmpInst::ICMP_SGT:
6963 if (RA.isMinSignedValue()) {
6964 Pred = ICmpInst::ICMP_NE;
6968 if ((RA + 1).isMaxSignedValue()) {
6969 Pred = ICmpInst::ICMP_EQ;
6970 RHS = getConstant(RA + 1);
6974 if (RA.isMaxSignedValue()) goto trivially_false;
6976 case ICmpInst::ICMP_SLT:
6977 if (RA.isMaxSignedValue()) {
6978 Pred = ICmpInst::ICMP_NE;
6982 if ((RA - 1).isMinSignedValue()) {
6983 Pred = ICmpInst::ICMP_EQ;
6984 RHS = getConstant(RA - 1);
6988 if (RA.isMinSignedValue()) goto trivially_false;
6993 // Check for obvious equality.
6994 if (HasSameValue(LHS, RHS)) {
6995 if (ICmpInst::isTrueWhenEqual(Pred))
6996 goto trivially_true;
6997 if (ICmpInst::isFalseWhenEqual(Pred))
6998 goto trivially_false;
7001 // If possible, canonicalize GE/LE comparisons to GT/LT comparisons, by
7002 // adding or subtracting 1 from one of the operands.
7004 case ICmpInst::ICMP_SLE:
7005 if (!getSignedRange(RHS).getSignedMax().isMaxSignedValue()) {
7006 RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
7008 Pred = ICmpInst::ICMP_SLT;
7010 } else if (!getSignedRange(LHS).getSignedMin().isMinSignedValue()) {
7011 LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
7013 Pred = ICmpInst::ICMP_SLT;
7017 case ICmpInst::ICMP_SGE:
7018 if (!getSignedRange(RHS).getSignedMin().isMinSignedValue()) {
7019 RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
7021 Pred = ICmpInst::ICMP_SGT;
7023 } else if (!getSignedRange(LHS).getSignedMax().isMaxSignedValue()) {
7024 LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
7026 Pred = ICmpInst::ICMP_SGT;
7030 case ICmpInst::ICMP_ULE:
7031 if (!getUnsignedRange(RHS).getUnsignedMax().isMaxValue()) {
7032 RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
7034 Pred = ICmpInst::ICMP_ULT;
7036 } else if (!getUnsignedRange(LHS).getUnsignedMin().isMinValue()) {
7037 LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS);
7038 Pred = ICmpInst::ICMP_ULT;
7042 case ICmpInst::ICMP_UGE:
7043 if (!getUnsignedRange(RHS).getUnsignedMin().isMinValue()) {
7044 RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS);
7045 Pred = ICmpInst::ICMP_UGT;
7047 } else if (!getUnsignedRange(LHS).getUnsignedMax().isMaxValue()) {
7048 LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
7050 Pred = ICmpInst::ICMP_UGT;
7058 // TODO: More simplifications are possible here.
7060 // Recursively simplify until we either hit a recursion limit or nothing
7063 return SimplifyICmpOperands(Pred, LHS, RHS, Depth+1);
7069 LHS = RHS = getConstant(ConstantInt::getFalse(getContext()));
7070 Pred = ICmpInst::ICMP_EQ;
7075 LHS = RHS = getConstant(ConstantInt::getFalse(getContext()));
7076 Pred = ICmpInst::ICMP_NE;
7080 bool ScalarEvolution::isKnownNegative(const SCEV *S) {
7081 return getSignedRange(S).getSignedMax().isNegative();
7084 bool ScalarEvolution::isKnownPositive(const SCEV *S) {
7085 return getSignedRange(S).getSignedMin().isStrictlyPositive();
7088 bool ScalarEvolution::isKnownNonNegative(const SCEV *S) {
7089 return !getSignedRange(S).getSignedMin().isNegative();
7092 bool ScalarEvolution::isKnownNonPositive(const SCEV *S) {
7093 return !getSignedRange(S).getSignedMax().isStrictlyPositive();
7096 bool ScalarEvolution::isKnownNonZero(const SCEV *S) {
7097 return isKnownNegative(S) || isKnownPositive(S);
7100 bool ScalarEvolution::isKnownPredicate(ICmpInst::Predicate Pred,
7101 const SCEV *LHS, const SCEV *RHS) {
7102 // Canonicalize the inputs first.
7103 (void)SimplifyICmpOperands(Pred, LHS, RHS);
7105 // If LHS or RHS is an addrec, check to see if the condition is true in
7106 // every iteration of the loop.
7107 // If LHS and RHS are both addrec, both conditions must be true in
7108 // every iteration of the loop.
7109 const SCEVAddRecExpr *LAR = dyn_cast<SCEVAddRecExpr>(LHS);
7110 const SCEVAddRecExpr *RAR = dyn_cast<SCEVAddRecExpr>(RHS);
7111 bool LeftGuarded = false;
7112 bool RightGuarded = false;
7114 const Loop *L = LAR->getLoop();
7115 if (isLoopEntryGuardedByCond(L, Pred, LAR->getStart(), RHS) &&
7116 isLoopBackedgeGuardedByCond(L, Pred, LAR->getPostIncExpr(*this), RHS)) {
7117 if (!RAR) return true;
7122 const Loop *L = RAR->getLoop();
7123 if (isLoopEntryGuardedByCond(L, Pred, LHS, RAR->getStart()) &&
7124 isLoopBackedgeGuardedByCond(L, Pred, LHS, RAR->getPostIncExpr(*this))) {
7125 if (!LAR) return true;
7126 RightGuarded = true;
7129 if (LeftGuarded && RightGuarded)
7132 if (isKnownPredicateViaSplitting(Pred, LHS, RHS))
7135 // Otherwise see what can be done with known constant ranges.
7136 return isKnownPredicateWithRanges(Pred, LHS, RHS);
7139 bool ScalarEvolution::isMonotonicPredicate(const SCEVAddRecExpr *LHS,
7140 ICmpInst::Predicate Pred,
7142 bool Result = isMonotonicPredicateImpl(LHS, Pred, Increasing);
7145 // Verify an invariant: inverting the predicate should turn a monotonically
7146 // increasing change to a monotonically decreasing one, and vice versa.
7147 bool IncreasingSwapped;
7148 bool ResultSwapped = isMonotonicPredicateImpl(
7149 LHS, ICmpInst::getSwappedPredicate(Pred), IncreasingSwapped);
7151 assert(Result == ResultSwapped && "should be able to analyze both!");
7153 assert(Increasing == !IncreasingSwapped &&
7154 "monotonicity should flip as we flip the predicate");
7160 bool ScalarEvolution::isMonotonicPredicateImpl(const SCEVAddRecExpr *LHS,
7161 ICmpInst::Predicate Pred,
7164 // A zero step value for LHS means the induction variable is essentially a
7165 // loop invariant value. We don't really depend on the predicate actually
7166 // flipping from false to true (for increasing predicates, and the other way
7167 // around for decreasing predicates), all we care about is that *if* the
7168 // predicate changes then it only changes from false to true.
7170 // A zero step value in itself is not very useful, but there may be places
7171 // where SCEV can prove X >= 0 but not prove X > 0, so it is helpful to be
7172 // as general as possible.
7176 return false; // Conservative answer
7178 case ICmpInst::ICMP_UGT:
7179 case ICmpInst::ICMP_UGE:
7180 case ICmpInst::ICMP_ULT:
7181 case ICmpInst::ICMP_ULE:
7182 if (!LHS->getNoWrapFlags(SCEV::FlagNUW))
7185 Increasing = Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE;
7188 case ICmpInst::ICMP_SGT:
7189 case ICmpInst::ICMP_SGE:
7190 case ICmpInst::ICMP_SLT:
7191 case ICmpInst::ICMP_SLE: {
7192 if (!LHS->getNoWrapFlags(SCEV::FlagNSW))
7195 const SCEV *Step = LHS->getStepRecurrence(*this);
7197 if (isKnownNonNegative(Step)) {
7198 Increasing = Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE;
7202 if (isKnownNonPositive(Step)) {
7203 Increasing = Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE;
7212 llvm_unreachable("switch has default clause!");
7215 bool ScalarEvolution::isLoopInvariantPredicate(
7216 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS, const Loop *L,
7217 ICmpInst::Predicate &InvariantPred, const SCEV *&InvariantLHS,
7218 const SCEV *&InvariantRHS) {
7220 // If there is a loop-invariant, force it into the RHS, otherwise bail out.
7221 if (!isLoopInvariant(RHS, L)) {
7222 if (!isLoopInvariant(LHS, L))
7225 std::swap(LHS, RHS);
7226 Pred = ICmpInst::getSwappedPredicate(Pred);
7229 const SCEVAddRecExpr *ArLHS = dyn_cast<SCEVAddRecExpr>(LHS);
7230 if (!ArLHS || ArLHS->getLoop() != L)
7234 if (!isMonotonicPredicate(ArLHS, Pred, Increasing))
7237 // If the predicate "ArLHS `Pred` RHS" monotonically increases from false to
7238 // true as the loop iterates, and the backedge is control dependent on
7239 // "ArLHS `Pred` RHS" == true then we can reason as follows:
7241 // * if the predicate was false in the first iteration then the predicate
7242 // is never evaluated again, since the loop exits without taking the
7244 // * if the predicate was true in the first iteration then it will
7245 // continue to be true for all future iterations since it is
7246 // monotonically increasing.
7248 // For both the above possibilities, we can replace the loop varying
7249 // predicate with its value on the first iteration of the loop (which is
7252 // A similar reasoning applies for a monotonically decreasing predicate, by
7253 // replacing true with false and false with true in the above two bullets.
7255 auto P = Increasing ? Pred : ICmpInst::getInversePredicate(Pred);
7257 if (!isLoopBackedgeGuardedByCond(L, P, LHS, RHS))
7260 InvariantPred = Pred;
7261 InvariantLHS = ArLHS->getStart();
7267 ScalarEvolution::isKnownPredicateWithRanges(ICmpInst::Predicate Pred,
7268 const SCEV *LHS, const SCEV *RHS) {
7269 if (HasSameValue(LHS, RHS))
7270 return ICmpInst::isTrueWhenEqual(Pred);
7272 // This code is split out from isKnownPredicate because it is called from
7273 // within isLoopEntryGuardedByCond.
7276 llvm_unreachable("Unexpected ICmpInst::Predicate value!");
7277 case ICmpInst::ICMP_SGT:
7278 std::swap(LHS, RHS);
7279 case ICmpInst::ICMP_SLT: {
7280 ConstantRange LHSRange = getSignedRange(LHS);
7281 ConstantRange RHSRange = getSignedRange(RHS);
7282 if (LHSRange.getSignedMax().slt(RHSRange.getSignedMin()))
7284 if (LHSRange.getSignedMin().sge(RHSRange.getSignedMax()))
7288 case ICmpInst::ICMP_SGE:
7289 std::swap(LHS, RHS);
7290 case ICmpInst::ICMP_SLE: {
7291 ConstantRange LHSRange = getSignedRange(LHS);
7292 ConstantRange RHSRange = getSignedRange(RHS);
7293 if (LHSRange.getSignedMax().sle(RHSRange.getSignedMin()))
7295 if (LHSRange.getSignedMin().sgt(RHSRange.getSignedMax()))
7299 case ICmpInst::ICMP_UGT:
7300 std::swap(LHS, RHS);
7301 case ICmpInst::ICMP_ULT: {
7302 ConstantRange LHSRange = getUnsignedRange(LHS);
7303 ConstantRange RHSRange = getUnsignedRange(RHS);
7304 if (LHSRange.getUnsignedMax().ult(RHSRange.getUnsignedMin()))
7306 if (LHSRange.getUnsignedMin().uge(RHSRange.getUnsignedMax()))
7310 case ICmpInst::ICMP_UGE:
7311 std::swap(LHS, RHS);
7312 case ICmpInst::ICMP_ULE: {
7313 ConstantRange LHSRange = getUnsignedRange(LHS);
7314 ConstantRange RHSRange = getUnsignedRange(RHS);
7315 if (LHSRange.getUnsignedMax().ule(RHSRange.getUnsignedMin()))
7317 if (LHSRange.getUnsignedMin().ugt(RHSRange.getUnsignedMax()))
7321 case ICmpInst::ICMP_NE: {
7322 if (getUnsignedRange(LHS).intersectWith(getUnsignedRange(RHS)).isEmptySet())
7324 if (getSignedRange(LHS).intersectWith(getSignedRange(RHS)).isEmptySet())
7327 const SCEV *Diff = getMinusSCEV(LHS, RHS);
7328 if (isKnownNonZero(Diff))
7332 case ICmpInst::ICMP_EQ:
7333 // The check at the top of the function catches the case where
7334 // the values are known to be equal.
7340 bool ScalarEvolution::isKnownPredicateViaNoOverflow(ICmpInst::Predicate Pred,
7344 // Match Result to (X + Y)<ExpectedFlags> where Y is a constant integer.
7345 // Return Y via OutY.
7346 auto MatchBinaryAddToConst =
7347 [this](const SCEV *Result, const SCEV *X, APInt &OutY,
7348 SCEV::NoWrapFlags ExpectedFlags) {
7349 const SCEV *NonConstOp, *ConstOp;
7350 SCEV::NoWrapFlags FlagsPresent;
7352 if (!splitBinaryAdd(Result, ConstOp, NonConstOp, FlagsPresent) ||
7353 !isa<SCEVConstant>(ConstOp) || NonConstOp != X)
7356 OutY = cast<SCEVConstant>(ConstOp)->getValue()->getValue();
7357 return (FlagsPresent & ExpectedFlags) == ExpectedFlags;
7366 case ICmpInst::ICMP_SGE:
7367 std::swap(LHS, RHS);
7368 case ICmpInst::ICMP_SLE:
7369 // X s<= (X + C)<nsw> if C >= 0
7370 if (MatchBinaryAddToConst(RHS, LHS, C, SCEV::FlagNSW) && C.isNonNegative())
7373 // (X + C)<nsw> s<= X if C <= 0
7374 if (MatchBinaryAddToConst(LHS, RHS, C, SCEV::FlagNSW) &&
7375 !C.isStrictlyPositive())
7379 case ICmpInst::ICMP_SGT:
7380 std::swap(LHS, RHS);
7381 case ICmpInst::ICMP_SLT:
7382 // X s< (X + C)<nsw> if C > 0
7383 if (MatchBinaryAddToConst(RHS, LHS, C, SCEV::FlagNSW) &&
7384 C.isStrictlyPositive())
7387 // (X + C)<nsw> s< X if C < 0
7388 if (MatchBinaryAddToConst(LHS, RHS, C, SCEV::FlagNSW) && C.isNegative())
7396 bool ScalarEvolution::isKnownPredicateViaSplitting(ICmpInst::Predicate Pred,
7399 if (Pred != ICmpInst::ICMP_ULT || ProvingSplitPredicate)
7402 // Allowing arbitrary number of activations of isKnownPredicateViaSplitting on
7403 // the stack can result in exponential time complexity.
7404 SaveAndRestore<bool> Restore(ProvingSplitPredicate, true);
7406 // If L >= 0 then I `ult` L <=> I >= 0 && I `slt` L
7408 // To prove L >= 0 we use isKnownNonNegative whereas to prove I >= 0 we use
7409 // isKnownPredicate. isKnownPredicate is more powerful, but also more
7410 // expensive; and using isKnownNonNegative(RHS) is sufficient for most of the
7411 // interesting cases seen in practice. We can consider "upgrading" L >= 0 to
7412 // use isKnownPredicate later if needed.
7413 return isKnownNonNegative(RHS) &&
7414 isKnownPredicate(CmpInst::ICMP_SGE, LHS, getZero(LHS->getType())) &&
7415 isKnownPredicate(CmpInst::ICMP_SLT, LHS, RHS);
7418 /// isLoopBackedgeGuardedByCond - Test whether the backedge of the loop is
7419 /// protected by a conditional between LHS and RHS. This is used to
7420 /// to eliminate casts.
7422 ScalarEvolution::isLoopBackedgeGuardedByCond(const Loop *L,
7423 ICmpInst::Predicate Pred,
7424 const SCEV *LHS, const SCEV *RHS) {
7425 // Interpret a null as meaning no loop, where there is obviously no guard
7426 // (interprocedural conditions notwithstanding).
7427 if (!L) return true;
7429 if (isKnownPredicateWithRanges(Pred, LHS, RHS)) return true;
7431 BasicBlock *Latch = L->getLoopLatch();
7435 BranchInst *LoopContinuePredicate =
7436 dyn_cast<BranchInst>(Latch->getTerminator());
7437 if (LoopContinuePredicate && LoopContinuePredicate->isConditional() &&
7438 isImpliedCond(Pred, LHS, RHS,
7439 LoopContinuePredicate->getCondition(),
7440 LoopContinuePredicate->getSuccessor(0) != L->getHeader()))
7443 // We don't want more than one activation of the following loops on the stack
7444 // -- that can lead to O(n!) time complexity.
7445 if (WalkingBEDominatingConds)
7448 SaveAndRestore<bool> ClearOnExit(WalkingBEDominatingConds, true);
7450 // See if we can exploit a trip count to prove the predicate.
7451 const auto &BETakenInfo = getBackedgeTakenInfo(L);
7452 const SCEV *LatchBECount = BETakenInfo.getExact(Latch, this);
7453 if (LatchBECount != getCouldNotCompute()) {
7454 // We know that Latch branches back to the loop header exactly
7455 // LatchBECount times. This means the backdege condition at Latch is
7456 // equivalent to "{0,+,1} u< LatchBECount".
7457 Type *Ty = LatchBECount->getType();
7458 auto NoWrapFlags = SCEV::NoWrapFlags(SCEV::FlagNUW | SCEV::FlagNW);
7459 const SCEV *LoopCounter =
7460 getAddRecExpr(getZero(Ty), getOne(Ty), L, NoWrapFlags);
7461 if (isImpliedCond(Pred, LHS, RHS, ICmpInst::ICMP_ULT, LoopCounter,
7466 // Check conditions due to any @llvm.assume intrinsics.
7467 for (auto &AssumeVH : AC.assumptions()) {
7470 auto *CI = cast<CallInst>(AssumeVH);
7471 if (!DT.dominates(CI, Latch->getTerminator()))
7474 if (isImpliedCond(Pred, LHS, RHS, CI->getArgOperand(0), false))
7478 // If the loop is not reachable from the entry block, we risk running into an
7479 // infinite loop as we walk up into the dom tree. These loops do not matter
7480 // anyway, so we just return a conservative answer when we see them.
7481 if (!DT.isReachableFromEntry(L->getHeader()))
7484 for (DomTreeNode *DTN = DT[Latch], *HeaderDTN = DT[L->getHeader()];
7485 DTN != HeaderDTN; DTN = DTN->getIDom()) {
7487 assert(DTN && "should reach the loop header before reaching the root!");
7489 BasicBlock *BB = DTN->getBlock();
7490 BasicBlock *PBB = BB->getSinglePredecessor();
7494 BranchInst *ContinuePredicate = dyn_cast<BranchInst>(PBB->getTerminator());
7495 if (!ContinuePredicate || !ContinuePredicate->isConditional())
7498 Value *Condition = ContinuePredicate->getCondition();
7500 // If we have an edge `E` within the loop body that dominates the only
7501 // latch, the condition guarding `E` also guards the backedge. This
7502 // reasoning works only for loops with a single latch.
7504 BasicBlockEdge DominatingEdge(PBB, BB);
7505 if (DominatingEdge.isSingleEdge()) {
7506 // We're constructively (and conservatively) enumerating edges within the
7507 // loop body that dominate the latch. The dominator tree better agree
7509 assert(DT.dominates(DominatingEdge, Latch) && "should be!");
7511 if (isImpliedCond(Pred, LHS, RHS, Condition,
7512 BB != ContinuePredicate->getSuccessor(0)))
7520 /// isLoopEntryGuardedByCond - Test whether entry to the loop is protected
7521 /// by a conditional between LHS and RHS. This is used to help avoid max
7522 /// expressions in loop trip counts, and to eliminate casts.
7524 ScalarEvolution::isLoopEntryGuardedByCond(const Loop *L,
7525 ICmpInst::Predicate Pred,
7526 const SCEV *LHS, const SCEV *RHS) {
7527 // Interpret a null as meaning no loop, where there is obviously no guard
7528 // (interprocedural conditions notwithstanding).
7529 if (!L) return false;
7531 if (isKnownPredicateWithRanges(Pred, LHS, RHS)) return true;
7533 // Starting at the loop predecessor, climb up the predecessor chain, as long
7534 // as there are predecessors that can be found that have unique successors
7535 // leading to the original header.
7536 for (std::pair<BasicBlock *, BasicBlock *>
7537 Pair(L->getLoopPredecessor(), L->getHeader());
7539 Pair = getPredecessorWithUniqueSuccessorForBB(Pair.first)) {
7541 BranchInst *LoopEntryPredicate =
7542 dyn_cast<BranchInst>(Pair.first->getTerminator());
7543 if (!LoopEntryPredicate ||
7544 LoopEntryPredicate->isUnconditional())
7547 if (isImpliedCond(Pred, LHS, RHS,
7548 LoopEntryPredicate->getCondition(),
7549 LoopEntryPredicate->getSuccessor(0) != Pair.second))
7553 // Check conditions due to any @llvm.assume intrinsics.
7554 for (auto &AssumeVH : AC.assumptions()) {
7557 auto *CI = cast<CallInst>(AssumeVH);
7558 if (!DT.dominates(CI, L->getHeader()))
7561 if (isImpliedCond(Pred, LHS, RHS, CI->getArgOperand(0), false))
7569 /// RAII wrapper to prevent recursive application of isImpliedCond.
7570 /// ScalarEvolution's PendingLoopPredicates set must be empty unless we are
7571 /// currently evaluating isImpliedCond.
7572 struct MarkPendingLoopPredicate {
7574 DenseSet<Value*> &LoopPreds;
7577 MarkPendingLoopPredicate(Value *C, DenseSet<Value*> &LP)
7578 : Cond(C), LoopPreds(LP) {
7579 Pending = !LoopPreds.insert(Cond).second;
7581 ~MarkPendingLoopPredicate() {
7583 LoopPreds.erase(Cond);
7586 } // end anonymous namespace
7588 /// isImpliedCond - Test whether the condition described by Pred, LHS,
7589 /// and RHS is true whenever the given Cond value evaluates to true.
7590 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred,
7591 const SCEV *LHS, const SCEV *RHS,
7592 Value *FoundCondValue,
7594 MarkPendingLoopPredicate Mark(FoundCondValue, PendingLoopPredicates);
7598 // Recursively handle And and Or conditions.
7599 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(FoundCondValue)) {
7600 if (BO->getOpcode() == Instruction::And) {
7602 return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
7603 isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
7604 } else if (BO->getOpcode() == Instruction::Or) {
7606 return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
7607 isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
7611 ICmpInst *ICI = dyn_cast<ICmpInst>(FoundCondValue);
7612 if (!ICI) return false;
7614 // Now that we found a conditional branch that dominates the loop or controls
7615 // the loop latch. Check to see if it is the comparison we are looking for.
7616 ICmpInst::Predicate FoundPred;
7618 FoundPred = ICI->getInversePredicate();
7620 FoundPred = ICI->getPredicate();
7622 const SCEV *FoundLHS = getSCEV(ICI->getOperand(0));
7623 const SCEV *FoundRHS = getSCEV(ICI->getOperand(1));
7625 return isImpliedCond(Pred, LHS, RHS, FoundPred, FoundLHS, FoundRHS);
7628 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred, const SCEV *LHS,
7630 ICmpInst::Predicate FoundPred,
7631 const SCEV *FoundLHS,
7632 const SCEV *FoundRHS) {
7633 // Balance the types.
7634 if (getTypeSizeInBits(LHS->getType()) <
7635 getTypeSizeInBits(FoundLHS->getType())) {
7636 if (CmpInst::isSigned(Pred)) {
7637 LHS = getSignExtendExpr(LHS, FoundLHS->getType());
7638 RHS = getSignExtendExpr(RHS, FoundLHS->getType());
7640 LHS = getZeroExtendExpr(LHS, FoundLHS->getType());
7641 RHS = getZeroExtendExpr(RHS, FoundLHS->getType());
7643 } else if (getTypeSizeInBits(LHS->getType()) >
7644 getTypeSizeInBits(FoundLHS->getType())) {
7645 if (CmpInst::isSigned(FoundPred)) {
7646 FoundLHS = getSignExtendExpr(FoundLHS, LHS->getType());
7647 FoundRHS = getSignExtendExpr(FoundRHS, LHS->getType());
7649 FoundLHS = getZeroExtendExpr(FoundLHS, LHS->getType());
7650 FoundRHS = getZeroExtendExpr(FoundRHS, LHS->getType());
7654 // Canonicalize the query to match the way instcombine will have
7655 // canonicalized the comparison.
7656 if (SimplifyICmpOperands(Pred, LHS, RHS))
7658 return CmpInst::isTrueWhenEqual(Pred);
7659 if (SimplifyICmpOperands(FoundPred, FoundLHS, FoundRHS))
7660 if (FoundLHS == FoundRHS)
7661 return CmpInst::isFalseWhenEqual(FoundPred);
7663 // Check to see if we can make the LHS or RHS match.
7664 if (LHS == FoundRHS || RHS == FoundLHS) {
7665 if (isa<SCEVConstant>(RHS)) {
7666 std::swap(FoundLHS, FoundRHS);
7667 FoundPred = ICmpInst::getSwappedPredicate(FoundPred);
7669 std::swap(LHS, RHS);
7670 Pred = ICmpInst::getSwappedPredicate(Pred);
7674 // Check whether the found predicate is the same as the desired predicate.
7675 if (FoundPred == Pred)
7676 return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS);
7678 // Check whether swapping the found predicate makes it the same as the
7679 // desired predicate.
7680 if (ICmpInst::getSwappedPredicate(FoundPred) == Pred) {
7681 if (isa<SCEVConstant>(RHS))
7682 return isImpliedCondOperands(Pred, LHS, RHS, FoundRHS, FoundLHS);
7684 return isImpliedCondOperands(ICmpInst::getSwappedPredicate(Pred),
7685 RHS, LHS, FoundLHS, FoundRHS);
7688 // Unsigned comparison is the same as signed comparison when both the operands
7689 // are non-negative.
7690 if (CmpInst::isUnsigned(FoundPred) &&
7691 CmpInst::getSignedPredicate(FoundPred) == Pred &&
7692 isKnownNonNegative(FoundLHS) && isKnownNonNegative(FoundRHS))
7693 return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS);
7695 // Check if we can make progress by sharpening ranges.
7696 if (FoundPred == ICmpInst::ICMP_NE &&
7697 (isa<SCEVConstant>(FoundLHS) || isa<SCEVConstant>(FoundRHS))) {
7699 const SCEVConstant *C = nullptr;
7700 const SCEV *V = nullptr;
7702 if (isa<SCEVConstant>(FoundLHS)) {
7703 C = cast<SCEVConstant>(FoundLHS);
7706 C = cast<SCEVConstant>(FoundRHS);
7710 // The guarding predicate tells us that C != V. If the known range
7711 // of V is [C, t), we can sharpen the range to [C + 1, t). The
7712 // range we consider has to correspond to same signedness as the
7713 // predicate we're interested in folding.
7715 APInt Min = ICmpInst::isSigned(Pred) ?
7716 getSignedRange(V).getSignedMin() : getUnsignedRange(V).getUnsignedMin();
7718 if (Min == C->getValue()->getValue()) {
7719 // Given (V >= Min && V != Min) we conclude V >= (Min + 1).
7720 // This is true even if (Min + 1) wraps around -- in case of
7721 // wraparound, (Min + 1) < Min, so (V >= Min => V >= (Min + 1)).
7723 APInt SharperMin = Min + 1;
7726 case ICmpInst::ICMP_SGE:
7727 case ICmpInst::ICMP_UGE:
7728 // We know V `Pred` SharperMin. If this implies LHS `Pred`
7730 if (isImpliedCondOperands(Pred, LHS, RHS, V,
7731 getConstant(SharperMin)))
7734 case ICmpInst::ICMP_SGT:
7735 case ICmpInst::ICMP_UGT:
7736 // We know from the range information that (V `Pred` Min ||
7737 // V == Min). We know from the guarding condition that !(V
7738 // == Min). This gives us
7740 // V `Pred` Min || V == Min && !(V == Min)
7743 // If V `Pred` Min implies LHS `Pred` RHS, we're done.
7745 if (isImpliedCondOperands(Pred, LHS, RHS, V, getConstant(Min)))
7755 // Check whether the actual condition is beyond sufficient.
7756 if (FoundPred == ICmpInst::ICMP_EQ)
7757 if (ICmpInst::isTrueWhenEqual(Pred))
7758 if (isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS))
7760 if (Pred == ICmpInst::ICMP_NE)
7761 if (!ICmpInst::isTrueWhenEqual(FoundPred))
7762 if (isImpliedCondOperands(FoundPred, LHS, RHS, FoundLHS, FoundRHS))
7765 // Otherwise assume the worst.
7769 bool ScalarEvolution::splitBinaryAdd(const SCEV *Expr,
7770 const SCEV *&L, const SCEV *&R,
7771 SCEV::NoWrapFlags &Flags) {
7772 const auto *AE = dyn_cast<SCEVAddExpr>(Expr);
7773 if (!AE || AE->getNumOperands() != 2)
7776 L = AE->getOperand(0);
7777 R = AE->getOperand(1);
7778 Flags = AE->getNoWrapFlags();
7782 bool ScalarEvolution::computeConstantDifference(const SCEV *Less,
7785 // We avoid subtracting expressions here because this function is usually
7786 // fairly deep in the call stack (i.e. is called many times).
7788 if (isa<SCEVAddRecExpr>(Less) && isa<SCEVAddRecExpr>(More)) {
7789 const auto *LAR = cast<SCEVAddRecExpr>(Less);
7790 const auto *MAR = cast<SCEVAddRecExpr>(More);
7792 if (LAR->getLoop() != MAR->getLoop())
7795 // We look at affine expressions only; not for correctness but to keep
7796 // getStepRecurrence cheap.
7797 if (!LAR->isAffine() || !MAR->isAffine())
7800 if (LAR->getStepRecurrence(*this) != MAR->getStepRecurrence(*this))
7803 Less = LAR->getStart();
7804 More = MAR->getStart();
7809 if (isa<SCEVConstant>(Less) && isa<SCEVConstant>(More)) {
7810 const auto &M = cast<SCEVConstant>(More)->getValue()->getValue();
7811 const auto &L = cast<SCEVConstant>(Less)->getValue()->getValue();
7817 SCEV::NoWrapFlags Flags;
7818 if (splitBinaryAdd(Less, L, R, Flags))
7819 if (const auto *LC = dyn_cast<SCEVConstant>(L))
7821 C = -(LC->getValue()->getValue());
7825 if (splitBinaryAdd(More, L, R, Flags))
7826 if (const auto *LC = dyn_cast<SCEVConstant>(L))
7828 C = LC->getValue()->getValue();
7835 bool ScalarEvolution::isImpliedCondOperandsViaNoOverflow(
7836 ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS,
7837 const SCEV *FoundLHS, const SCEV *FoundRHS) {
7838 if (Pred != CmpInst::ICMP_SLT && Pred != CmpInst::ICMP_ULT)
7841 const auto *AddRecLHS = dyn_cast<SCEVAddRecExpr>(LHS);
7845 const auto *AddRecFoundLHS = dyn_cast<SCEVAddRecExpr>(FoundLHS);
7846 if (!AddRecFoundLHS)
7849 // We'd like to let SCEV reason about control dependencies, so we constrain
7850 // both the inequalities to be about add recurrences on the same loop. This
7851 // way we can use isLoopEntryGuardedByCond later.
7853 const Loop *L = AddRecFoundLHS->getLoop();
7854 if (L != AddRecLHS->getLoop())
7857 // FoundLHS u< FoundRHS u< -C => (FoundLHS + C) u< (FoundRHS + C) ... (1)
7859 // FoundLHS s< FoundRHS s< INT_MIN - C => (FoundLHS + C) s< (FoundRHS + C)
7862 // Informal proof for (2), assuming (1) [*]:
7864 // We'll also assume (A s< B) <=> ((A + INT_MIN) u< (B + INT_MIN)) ... (3)[**]
7868 // FoundLHS s< FoundRHS s< INT_MIN - C
7869 // <=> (FoundLHS + INT_MIN) u< (FoundRHS + INT_MIN) u< -C [ using (3) ]
7870 // <=> (FoundLHS + INT_MIN + C) u< (FoundRHS + INT_MIN + C) [ using (1) ]
7871 // <=> (FoundLHS + INT_MIN + C + INT_MIN) s<
7872 // (FoundRHS + INT_MIN + C + INT_MIN) [ using (3) ]
7873 // <=> FoundLHS + C s< FoundRHS + C
7875 // [*]: (1) can be proved by ruling out overflow.
7877 // [**]: This can be proved by analyzing all the four possibilities:
7878 // (A s< 0, B s< 0), (A s< 0, B s>= 0), (A s>= 0, B s< 0) and
7879 // (A s>= 0, B s>= 0).
7882 // Despite (2), "FoundRHS s< INT_MIN - C" does not mean that "FoundRHS + C"
7883 // will not sign underflow. For instance, say FoundLHS = (i8 -128), FoundRHS
7884 // = (i8 -127) and C = (i8 -100). Then INT_MIN - C = (i8 -28), and FoundRHS
7885 // s< (INT_MIN - C). Lack of sign overflow / underflow in "FoundRHS + C" is
7886 // neither necessary nor sufficient to prove "(FoundLHS + C) s< (FoundRHS +
7890 if (!computeConstantDifference(FoundLHS, LHS, LDiff) ||
7891 !computeConstantDifference(FoundRHS, RHS, RDiff) ||
7898 APInt FoundRHSLimit;
7900 if (Pred == CmpInst::ICMP_ULT) {
7901 FoundRHSLimit = -RDiff;
7903 assert(Pred == CmpInst::ICMP_SLT && "Checked above!");
7904 FoundRHSLimit = APInt::getSignedMinValue(getTypeSizeInBits(RHS->getType())) - RDiff;
7907 // Try to prove (1) or (2), as needed.
7908 return isLoopEntryGuardedByCond(L, Pred, FoundRHS,
7909 getConstant(FoundRHSLimit));
7912 /// isImpliedCondOperands - Test whether the condition described by Pred,
7913 /// LHS, and RHS is true whenever the condition described by Pred, FoundLHS,
7914 /// and FoundRHS is true.
7915 bool ScalarEvolution::isImpliedCondOperands(ICmpInst::Predicate Pred,
7916 const SCEV *LHS, const SCEV *RHS,
7917 const SCEV *FoundLHS,
7918 const SCEV *FoundRHS) {
7919 if (isImpliedCondOperandsViaRanges(Pred, LHS, RHS, FoundLHS, FoundRHS))
7922 if (isImpliedCondOperandsViaNoOverflow(Pred, LHS, RHS, FoundLHS, FoundRHS))
7925 return isImpliedCondOperandsHelper(Pred, LHS, RHS,
7926 FoundLHS, FoundRHS) ||
7927 // ~x < ~y --> x > y
7928 isImpliedCondOperandsHelper(Pred, LHS, RHS,
7929 getNotSCEV(FoundRHS),
7930 getNotSCEV(FoundLHS));
7934 /// If Expr computes ~A, return A else return nullptr
7935 static const SCEV *MatchNotExpr(const SCEV *Expr) {
7936 const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Expr);
7937 if (!Add || Add->getNumOperands() != 2 ||
7938 !Add->getOperand(0)->isAllOnesValue())
7941 const SCEVMulExpr *AddRHS = dyn_cast<SCEVMulExpr>(Add->getOperand(1));
7942 if (!AddRHS || AddRHS->getNumOperands() != 2 ||
7943 !AddRHS->getOperand(0)->isAllOnesValue())
7946 return AddRHS->getOperand(1);
7950 /// Is MaybeMaxExpr an SMax or UMax of Candidate and some other values?
7951 template<typename MaxExprType>
7952 static bool IsMaxConsistingOf(const SCEV *MaybeMaxExpr,
7953 const SCEV *Candidate) {
7954 const MaxExprType *MaxExpr = dyn_cast<MaxExprType>(MaybeMaxExpr);
7955 if (!MaxExpr) return false;
7957 return find(MaxExpr->operands(), Candidate) != MaxExpr->op_end();
7961 /// Is MaybeMinExpr an SMin or UMin of Candidate and some other values?
7962 template<typename MaxExprType>
7963 static bool IsMinConsistingOf(ScalarEvolution &SE,
7964 const SCEV *MaybeMinExpr,
7965 const SCEV *Candidate) {
7966 const SCEV *MaybeMaxExpr = MatchNotExpr(MaybeMinExpr);
7970 return IsMaxConsistingOf<MaxExprType>(MaybeMaxExpr, SE.getNotSCEV(Candidate));
7973 static bool IsKnownPredicateViaAddRecStart(ScalarEvolution &SE,
7974 ICmpInst::Predicate Pred,
7975 const SCEV *LHS, const SCEV *RHS) {
7977 // If both sides are affine addrecs for the same loop, with equal
7978 // steps, and we know the recurrences don't wrap, then we only
7979 // need to check the predicate on the starting values.
7981 if (!ICmpInst::isRelational(Pred))
7984 const SCEVAddRecExpr *LAR = dyn_cast<SCEVAddRecExpr>(LHS);
7987 const SCEVAddRecExpr *RAR = dyn_cast<SCEVAddRecExpr>(RHS);
7990 if (LAR->getLoop() != RAR->getLoop())
7992 if (!LAR->isAffine() || !RAR->isAffine())
7995 if (LAR->getStepRecurrence(SE) != RAR->getStepRecurrence(SE))
7998 SCEV::NoWrapFlags NW = ICmpInst::isSigned(Pred) ?
7999 SCEV::FlagNSW : SCEV::FlagNUW;
8000 if (!LAR->getNoWrapFlags(NW) || !RAR->getNoWrapFlags(NW))
8003 return SE.isKnownPredicate(Pred, LAR->getStart(), RAR->getStart());
8006 /// Is LHS `Pred` RHS true on the virtue of LHS or RHS being a Min or Max
8008 static bool IsKnownPredicateViaMinOrMax(ScalarEvolution &SE,
8009 ICmpInst::Predicate Pred,
8010 const SCEV *LHS, const SCEV *RHS) {
8015 case ICmpInst::ICMP_SGE:
8016 std::swap(LHS, RHS);
8018 case ICmpInst::ICMP_SLE:
8021 IsMinConsistingOf<SCEVSMaxExpr>(SE, LHS, RHS) ||
8023 IsMaxConsistingOf<SCEVSMaxExpr>(RHS, LHS);
8025 case ICmpInst::ICMP_UGE:
8026 std::swap(LHS, RHS);
8028 case ICmpInst::ICMP_ULE:
8031 IsMinConsistingOf<SCEVUMaxExpr>(SE, LHS, RHS) ||
8033 IsMaxConsistingOf<SCEVUMaxExpr>(RHS, LHS);
8036 llvm_unreachable("covered switch fell through?!");
8039 /// isImpliedCondOperandsHelper - Test whether the condition described by
8040 /// Pred, LHS, and RHS is true whenever the condition described by Pred,
8041 /// FoundLHS, and FoundRHS is true.
8043 ScalarEvolution::isImpliedCondOperandsHelper(ICmpInst::Predicate Pred,
8044 const SCEV *LHS, const SCEV *RHS,
8045 const SCEV *FoundLHS,
8046 const SCEV *FoundRHS) {
8047 auto IsKnownPredicateFull =
8048 [this](ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS) {
8049 return isKnownPredicateWithRanges(Pred, LHS, RHS) ||
8050 IsKnownPredicateViaMinOrMax(*this, Pred, LHS, RHS) ||
8051 IsKnownPredicateViaAddRecStart(*this, Pred, LHS, RHS) ||
8052 isKnownPredicateViaNoOverflow(Pred, LHS, RHS);
8056 default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
8057 case ICmpInst::ICMP_EQ:
8058 case ICmpInst::ICMP_NE:
8059 if (HasSameValue(LHS, FoundLHS) && HasSameValue(RHS, FoundRHS))
8062 case ICmpInst::ICMP_SLT:
8063 case ICmpInst::ICMP_SLE:
8064 if (IsKnownPredicateFull(ICmpInst::ICMP_SLE, LHS, FoundLHS) &&
8065 IsKnownPredicateFull(ICmpInst::ICMP_SGE, RHS, FoundRHS))
8068 case ICmpInst::ICMP_SGT:
8069 case ICmpInst::ICMP_SGE:
8070 if (IsKnownPredicateFull(ICmpInst::ICMP_SGE, LHS, FoundLHS) &&
8071 IsKnownPredicateFull(ICmpInst::ICMP_SLE, RHS, FoundRHS))
8074 case ICmpInst::ICMP_ULT:
8075 case ICmpInst::ICMP_ULE:
8076 if (IsKnownPredicateFull(ICmpInst::ICMP_ULE, LHS, FoundLHS) &&
8077 IsKnownPredicateFull(ICmpInst::ICMP_UGE, RHS, FoundRHS))
8080 case ICmpInst::ICMP_UGT:
8081 case ICmpInst::ICMP_UGE:
8082 if (IsKnownPredicateFull(ICmpInst::ICMP_UGE, LHS, FoundLHS) &&
8083 IsKnownPredicateFull(ICmpInst::ICMP_ULE, RHS, FoundRHS))
8091 /// isImpliedCondOperandsViaRanges - helper function for isImpliedCondOperands.
8092 /// Tries to get cases like "X `sgt` 0 => X - 1 `sgt` -1".
8093 bool ScalarEvolution::isImpliedCondOperandsViaRanges(ICmpInst::Predicate Pred,
8096 const SCEV *FoundLHS,
8097 const SCEV *FoundRHS) {
8098 if (!isa<SCEVConstant>(RHS) || !isa<SCEVConstant>(FoundRHS))
8099 // The restriction on `FoundRHS` be lifted easily -- it exists only to
8100 // reduce the compile time impact of this optimization.
8103 const SCEVAddExpr *AddLHS = dyn_cast<SCEVAddExpr>(LHS);
8104 if (!AddLHS || AddLHS->getOperand(1) != FoundLHS ||
8105 !isa<SCEVConstant>(AddLHS->getOperand(0)))
8108 APInt ConstFoundRHS = cast<SCEVConstant>(FoundRHS)->getValue()->getValue();
8110 // `FoundLHSRange` is the range we know `FoundLHS` to be in by virtue of the
8111 // antecedent "`FoundLHS` `Pred` `FoundRHS`".
8112 ConstantRange FoundLHSRange =
8113 ConstantRange::makeAllowedICmpRegion(Pred, ConstFoundRHS);
8115 // Since `LHS` is `FoundLHS` + `AddLHS->getOperand(0)`, we can compute a range
8118 cast<SCEVConstant>(AddLHS->getOperand(0))->getValue()->getValue();
8119 ConstantRange LHSRange = FoundLHSRange.add(ConstantRange(Addend));
8121 // We can also compute the range of values for `LHS` that satisfy the
8122 // consequent, "`LHS` `Pred` `RHS`":
8123 APInt ConstRHS = cast<SCEVConstant>(RHS)->getValue()->getValue();
8124 ConstantRange SatisfyingLHSRange =
8125 ConstantRange::makeSatisfyingICmpRegion(Pred, ConstRHS);
8127 // The antecedent implies the consequent if every value of `LHS` that
8128 // satisfies the antecedent also satisfies the consequent.
8129 return SatisfyingLHSRange.contains(LHSRange);
8132 // Verify if an linear IV with positive stride can overflow when in a
8133 // less-than comparison, knowing the invariant term of the comparison, the
8134 // stride and the knowledge of NSW/NUW flags on the recurrence.
8135 bool ScalarEvolution::doesIVOverflowOnLT(const SCEV *RHS, const SCEV *Stride,
8136 bool IsSigned, bool NoWrap) {
8137 if (NoWrap) return false;
8139 unsigned BitWidth = getTypeSizeInBits(RHS->getType());
8140 const SCEV *One = getOne(Stride->getType());
8143 APInt MaxRHS = getSignedRange(RHS).getSignedMax();
8144 APInt MaxValue = APInt::getSignedMaxValue(BitWidth);
8145 APInt MaxStrideMinusOne = getSignedRange(getMinusSCEV(Stride, One))
8148 // SMaxRHS + SMaxStrideMinusOne > SMaxValue => overflow!
8149 return (MaxValue - MaxStrideMinusOne).slt(MaxRHS);
8152 APInt MaxRHS = getUnsignedRange(RHS).getUnsignedMax();
8153 APInt MaxValue = APInt::getMaxValue(BitWidth);
8154 APInt MaxStrideMinusOne = getUnsignedRange(getMinusSCEV(Stride, One))
8157 // UMaxRHS + UMaxStrideMinusOne > UMaxValue => overflow!
8158 return (MaxValue - MaxStrideMinusOne).ult(MaxRHS);
8161 // Verify if an linear IV with negative stride can overflow when in a
8162 // greater-than comparison, knowing the invariant term of the comparison,
8163 // the stride and the knowledge of NSW/NUW flags on the recurrence.
8164 bool ScalarEvolution::doesIVOverflowOnGT(const SCEV *RHS, const SCEV *Stride,
8165 bool IsSigned, bool NoWrap) {
8166 if (NoWrap) return false;
8168 unsigned BitWidth = getTypeSizeInBits(RHS->getType());
8169 const SCEV *One = getOne(Stride->getType());
8172 APInt MinRHS = getSignedRange(RHS).getSignedMin();
8173 APInt MinValue = APInt::getSignedMinValue(BitWidth);
8174 APInt MaxStrideMinusOne = getSignedRange(getMinusSCEV(Stride, One))
8177 // SMinRHS - SMaxStrideMinusOne < SMinValue => overflow!
8178 return (MinValue + MaxStrideMinusOne).sgt(MinRHS);
8181 APInt MinRHS = getUnsignedRange(RHS).getUnsignedMin();
8182 APInt MinValue = APInt::getMinValue(BitWidth);
8183 APInt MaxStrideMinusOne = getUnsignedRange(getMinusSCEV(Stride, One))
8186 // UMinRHS - UMaxStrideMinusOne < UMinValue => overflow!
8187 return (MinValue + MaxStrideMinusOne).ugt(MinRHS);
8190 // Compute the backedge taken count knowing the interval difference, the
8191 // stride and presence of the equality in the comparison.
8192 const SCEV *ScalarEvolution::computeBECount(const SCEV *Delta, const SCEV *Step,
8194 const SCEV *One = getOne(Step->getType());
8195 Delta = Equality ? getAddExpr(Delta, Step)
8196 : getAddExpr(Delta, getMinusSCEV(Step, One));
8197 return getUDivExpr(Delta, Step);
8200 /// HowManyLessThans - Return the number of times a backedge containing the
8201 /// specified less-than comparison will execute. If not computable, return
8202 /// CouldNotCompute.
8204 /// @param ControlsExit is true when the LHS < RHS condition directly controls
8205 /// the branch (loops exits only if condition is true). In this case, we can use
8206 /// NoWrapFlags to skip overflow checks.
8207 ScalarEvolution::ExitLimit
8208 ScalarEvolution::HowManyLessThans(const SCEV *LHS, const SCEV *RHS,
8209 const Loop *L, bool IsSigned,
8210 bool ControlsExit) {
8211 // We handle only IV < Invariant
8212 if (!isLoopInvariant(RHS, L))
8213 return getCouldNotCompute();
8215 const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS);
8217 // Avoid weird loops
8218 if (!IV || IV->getLoop() != L || !IV->isAffine())
8219 return getCouldNotCompute();
8221 bool NoWrap = ControlsExit &&
8222 IV->getNoWrapFlags(IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW);
8224 const SCEV *Stride = IV->getStepRecurrence(*this);
8226 // Avoid negative or zero stride values
8227 if (!isKnownPositive(Stride))
8228 return getCouldNotCompute();
8230 // Avoid proven overflow cases: this will ensure that the backedge taken count
8231 // will not generate any unsigned overflow. Relaxed no-overflow conditions
8232 // exploit NoWrapFlags, allowing to optimize in presence of undefined
8233 // behaviors like the case of C language.
8234 if (!Stride->isOne() && doesIVOverflowOnLT(RHS, Stride, IsSigned, NoWrap))
8235 return getCouldNotCompute();
8237 ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SLT
8238 : ICmpInst::ICMP_ULT;
8239 const SCEV *Start = IV->getStart();
8240 const SCEV *End = RHS;
8241 if (!isLoopEntryGuardedByCond(L, Cond, getMinusSCEV(Start, Stride), RHS)) {
8242 const SCEV *Diff = getMinusSCEV(RHS, Start);
8243 // If we have NoWrap set, then we can assume that the increment won't
8244 // overflow, in which case if RHS - Start is a constant, we don't need to
8245 // do a max operation since we can just figure it out statically
8246 if (NoWrap && isa<SCEVConstant>(Diff)) {
8247 APInt D = dyn_cast<const SCEVConstant>(Diff)->getValue()->getValue();
8251 End = IsSigned ? getSMaxExpr(RHS, Start)
8252 : getUMaxExpr(RHS, Start);
8255 const SCEV *BECount = computeBECount(getMinusSCEV(End, Start), Stride, false);
8257 APInt MinStart = IsSigned ? getSignedRange(Start).getSignedMin()
8258 : getUnsignedRange(Start).getUnsignedMin();
8260 APInt MinStride = IsSigned ? getSignedRange(Stride).getSignedMin()
8261 : getUnsignedRange(Stride).getUnsignedMin();
8263 unsigned BitWidth = getTypeSizeInBits(LHS->getType());
8264 APInt Limit = IsSigned ? APInt::getSignedMaxValue(BitWidth) - (MinStride - 1)
8265 : APInt::getMaxValue(BitWidth) - (MinStride - 1);
8267 // Although End can be a MAX expression we estimate MaxEnd considering only
8268 // the case End = RHS. This is safe because in the other case (End - Start)
8269 // is zero, leading to a zero maximum backedge taken count.
8271 IsSigned ? APIntOps::smin(getSignedRange(RHS).getSignedMax(), Limit)
8272 : APIntOps::umin(getUnsignedRange(RHS).getUnsignedMax(), Limit);
8274 const SCEV *MaxBECount;
8275 if (isa<SCEVConstant>(BECount))
8276 MaxBECount = BECount;
8278 MaxBECount = computeBECount(getConstant(MaxEnd - MinStart),
8279 getConstant(MinStride), false);
8281 if (isa<SCEVCouldNotCompute>(MaxBECount))
8282 MaxBECount = BECount;
8284 return ExitLimit(BECount, MaxBECount);
8287 ScalarEvolution::ExitLimit
8288 ScalarEvolution::HowManyGreaterThans(const SCEV *LHS, const SCEV *RHS,
8289 const Loop *L, bool IsSigned,
8290 bool ControlsExit) {
8291 // We handle only IV > Invariant
8292 if (!isLoopInvariant(RHS, L))
8293 return getCouldNotCompute();
8295 const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS);
8297 // Avoid weird loops
8298 if (!IV || IV->getLoop() != L || !IV->isAffine())
8299 return getCouldNotCompute();
8301 bool NoWrap = ControlsExit &&
8302 IV->getNoWrapFlags(IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW);
8304 const SCEV *Stride = getNegativeSCEV(IV->getStepRecurrence(*this));
8306 // Avoid negative or zero stride values
8307 if (!isKnownPositive(Stride))
8308 return getCouldNotCompute();
8310 // Avoid proven overflow cases: this will ensure that the backedge taken count
8311 // will not generate any unsigned overflow. Relaxed no-overflow conditions
8312 // exploit NoWrapFlags, allowing to optimize in presence of undefined
8313 // behaviors like the case of C language.
8314 if (!Stride->isOne() && doesIVOverflowOnGT(RHS, Stride, IsSigned, NoWrap))
8315 return getCouldNotCompute();
8317 ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SGT
8318 : ICmpInst::ICMP_UGT;
8320 const SCEV *Start = IV->getStart();
8321 const SCEV *End = RHS;
8322 if (!isLoopEntryGuardedByCond(L, Cond, getAddExpr(Start, Stride), RHS)) {
8323 const SCEV *Diff = getMinusSCEV(RHS, Start);
8324 // If we have NoWrap set, then we can assume that the increment won't
8325 // overflow, in which case if RHS - Start is a constant, we don't need to
8326 // do a max operation since we can just figure it out statically
8327 if (NoWrap && isa<SCEVConstant>(Diff)) {
8328 APInt D = dyn_cast<const SCEVConstant>(Diff)->getValue()->getValue();
8329 if (!D.isNegative())
8332 End = IsSigned ? getSMinExpr(RHS, Start)
8333 : getUMinExpr(RHS, Start);
8336 const SCEV *BECount = computeBECount(getMinusSCEV(Start, End), Stride, false);
8338 APInt MaxStart = IsSigned ? getSignedRange(Start).getSignedMax()
8339 : getUnsignedRange(Start).getUnsignedMax();
8341 APInt MinStride = IsSigned ? getSignedRange(Stride).getSignedMin()
8342 : getUnsignedRange(Stride).getUnsignedMin();
8344 unsigned BitWidth = getTypeSizeInBits(LHS->getType());
8345 APInt Limit = IsSigned ? APInt::getSignedMinValue(BitWidth) + (MinStride - 1)
8346 : APInt::getMinValue(BitWidth) + (MinStride - 1);
8348 // Although End can be a MIN expression we estimate MinEnd considering only
8349 // the case End = RHS. This is safe because in the other case (Start - End)
8350 // is zero, leading to a zero maximum backedge taken count.
8352 IsSigned ? APIntOps::smax(getSignedRange(RHS).getSignedMin(), Limit)
8353 : APIntOps::umax(getUnsignedRange(RHS).getUnsignedMin(), Limit);
8356 const SCEV *MaxBECount = getCouldNotCompute();
8357 if (isa<SCEVConstant>(BECount))
8358 MaxBECount = BECount;
8360 MaxBECount = computeBECount(getConstant(MaxStart - MinEnd),
8361 getConstant(MinStride), false);
8363 if (isa<SCEVCouldNotCompute>(MaxBECount))
8364 MaxBECount = BECount;
8366 return ExitLimit(BECount, MaxBECount);
8369 /// getNumIterationsInRange - Return the number of iterations of this loop that
8370 /// produce values in the specified constant range. Another way of looking at
8371 /// this is that it returns the first iteration number where the value is not in
8372 /// the condition, thus computing the exit count. If the iteration count can't
8373 /// be computed, an instance of SCEVCouldNotCompute is returned.
8374 const SCEV *SCEVAddRecExpr::getNumIterationsInRange(ConstantRange Range,
8375 ScalarEvolution &SE) const {
8376 if (Range.isFullSet()) // Infinite loop.
8377 return SE.getCouldNotCompute();
8379 // If the start is a non-zero constant, shift the range to simplify things.
8380 if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(getStart()))
8381 if (!SC->getValue()->isZero()) {
8382 SmallVector<const SCEV *, 4> Operands(op_begin(), op_end());
8383 Operands[0] = SE.getZero(SC->getType());
8384 const SCEV *Shifted = SE.getAddRecExpr(Operands, getLoop(),
8385 getNoWrapFlags(FlagNW));
8386 if (const auto *ShiftedAddRec = dyn_cast<SCEVAddRecExpr>(Shifted))
8387 return ShiftedAddRec->getNumIterationsInRange(
8388 Range.subtract(SC->getValue()->getValue()), SE);
8389 // This is strange and shouldn't happen.
8390 return SE.getCouldNotCompute();
8393 // The only time we can solve this is when we have all constant indices.
8394 // Otherwise, we cannot determine the overflow conditions.
8395 if (any_of(operands(), [](const SCEV *Op) { return !isa<SCEVConstant>(Op); }))
8396 return SE.getCouldNotCompute();
8398 // Okay at this point we know that all elements of the chrec are constants and
8399 // that the start element is zero.
8401 // First check to see if the range contains zero. If not, the first
8403 unsigned BitWidth = SE.getTypeSizeInBits(getType());
8404 if (!Range.contains(APInt(BitWidth, 0)))
8405 return SE.getZero(getType());
8408 // If this is an affine expression then we have this situation:
8409 // Solve {0,+,A} in Range === Ax in Range
8411 // We know that zero is in the range. If A is positive then we know that
8412 // the upper value of the range must be the first possible exit value.
8413 // If A is negative then the lower of the range is the last possible loop
8414 // value. Also note that we already checked for a full range.
8415 APInt One(BitWidth,1);
8416 APInt A = cast<SCEVConstant>(getOperand(1))->getValue()->getValue();
8417 APInt End = A.sge(One) ? (Range.getUpper() - One) : Range.getLower();
8419 // The exit value should be (End+A)/A.
8420 APInt ExitVal = (End + A).udiv(A);
8421 ConstantInt *ExitValue = ConstantInt::get(SE.getContext(), ExitVal);
8423 // Evaluate at the exit value. If we really did fall out of the valid
8424 // range, then we computed our trip count, otherwise wrap around or other
8425 // things must have happened.
8426 ConstantInt *Val = EvaluateConstantChrecAtConstant(this, ExitValue, SE);
8427 if (Range.contains(Val->getValue()))
8428 return SE.getCouldNotCompute(); // Something strange happened
8430 // Ensure that the previous value is in the range. This is a sanity check.
8431 assert(Range.contains(
8432 EvaluateConstantChrecAtConstant(this,
8433 ConstantInt::get(SE.getContext(), ExitVal - One), SE)->getValue()) &&
8434 "Linear scev computation is off in a bad way!");
8435 return SE.getConstant(ExitValue);
8436 } else if (isQuadratic()) {
8437 // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of the
8438 // quadratic equation to solve it. To do this, we must frame our problem in
8439 // terms of figuring out when zero is crossed, instead of when
8440 // Range.getUpper() is crossed.
8441 SmallVector<const SCEV *, 4> NewOps(op_begin(), op_end());
8442 NewOps[0] = SE.getNegativeSCEV(SE.getConstant(Range.getUpper()));
8443 const SCEV *NewAddRec = SE.getAddRecExpr(NewOps, getLoop(),
8444 // getNoWrapFlags(FlagNW)
8447 // Next, solve the constructed addrec
8448 auto Roots = SolveQuadraticEquation(cast<SCEVAddRecExpr>(NewAddRec), SE);
8449 const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
8450 const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
8452 // Pick the smallest positive root value.
8453 if (ConstantInt *CB = dyn_cast<ConstantInt>(ConstantExpr::getICmp(
8454 ICmpInst::ICMP_ULT, R1->getValue(), R2->getValue()))) {
8455 if (!CB->getZExtValue())
8456 std::swap(R1, R2); // R1 is the minimum root now.
8458 // Make sure the root is not off by one. The returned iteration should
8459 // not be in the range, but the previous one should be. When solving
8460 // for "X*X < 5", for example, we should not return a root of 2.
8461 ConstantInt *R1Val = EvaluateConstantChrecAtConstant(this,
8464 if (Range.contains(R1Val->getValue())) {
8465 // The next iteration must be out of the range...
8466 ConstantInt *NextVal =
8467 ConstantInt::get(SE.getContext(), R1->getValue()->getValue()+1);
8469 R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
8470 if (!Range.contains(R1Val->getValue()))
8471 return SE.getConstant(NextVal);
8472 return SE.getCouldNotCompute(); // Something strange happened
8475 // If R1 was not in the range, then it is a good return value. Make
8476 // sure that R1-1 WAS in the range though, just in case.
8477 ConstantInt *NextVal =
8478 ConstantInt::get(SE.getContext(), R1->getValue()->getValue()-1);
8479 R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
8480 if (Range.contains(R1Val->getValue()))
8482 return SE.getCouldNotCompute(); // Something strange happened
8487 return SE.getCouldNotCompute();
8493 FindUndefs() : Found(false) {}
8495 bool follow(const SCEV *S) {
8496 if (const SCEVUnknown *C = dyn_cast<SCEVUnknown>(S)) {
8497 if (isa<UndefValue>(C->getValue()))
8499 } else if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S)) {
8500 if (isa<UndefValue>(C->getValue()))
8504 // Keep looking if we haven't found it yet.
8507 bool isDone() const {
8508 // Stop recursion if we have found an undef.
8514 // Return true when S contains at least an undef value.
8516 containsUndefs(const SCEV *S) {
8518 SCEVTraversal<FindUndefs> ST(F);
8525 // Collect all steps of SCEV expressions.
8526 struct SCEVCollectStrides {
8527 ScalarEvolution &SE;
8528 SmallVectorImpl<const SCEV *> &Strides;
8530 SCEVCollectStrides(ScalarEvolution &SE, SmallVectorImpl<const SCEV *> &S)
8531 : SE(SE), Strides(S) {}
8533 bool follow(const SCEV *S) {
8534 if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S))
8535 Strides.push_back(AR->getStepRecurrence(SE));
8538 bool isDone() const { return false; }
8541 // Collect all SCEVUnknown and SCEVMulExpr expressions.
8542 struct SCEVCollectTerms {
8543 SmallVectorImpl<const SCEV *> &Terms;
8545 SCEVCollectTerms(SmallVectorImpl<const SCEV *> &T)
8548 bool follow(const SCEV *S) {
8549 if (isa<SCEVUnknown>(S) || isa<SCEVMulExpr>(S)) {
8550 if (!containsUndefs(S))
8553 // Stop recursion: once we collected a term, do not walk its operands.
8560 bool isDone() const { return false; }
8563 // Check if a SCEV contains an AddRecExpr.
8564 struct SCEVHasAddRec {
8565 bool &ContainsAddRec;
8567 SCEVHasAddRec(bool &ContainsAddRec) : ContainsAddRec(ContainsAddRec) {
8568 ContainsAddRec = false;
8571 bool follow(const SCEV *S) {
8572 if (isa<SCEVAddRecExpr>(S)) {
8573 ContainsAddRec = true;
8575 // Stop recursion: once we collected a term, do not walk its operands.
8582 bool isDone() const { return false; }
8585 // Find factors that are multiplied with an expression that (possibly as a
8586 // subexpression) contains an AddRecExpr. In the expression:
8588 // 8 * (100 + %p * %q * (%a + {0, +, 1}_loop))
8590 // "%p * %q" are factors multiplied by the expression "(%a + {0, +, 1}_loop)"
8591 // that contains the AddRec {0, +, 1}_loop. %p * %q are likely to be array size
8592 // parameters as they form a product with an induction variable.
8594 // This collector expects all array size parameters to be in the same MulExpr.
8595 // It might be necessary to later add support for collecting parameters that are
8596 // spread over different nested MulExpr.
8597 struct SCEVCollectAddRecMultiplies {
8598 SmallVectorImpl<const SCEV *> &Terms;
8599 ScalarEvolution &SE;
8601 SCEVCollectAddRecMultiplies(SmallVectorImpl<const SCEV *> &T, ScalarEvolution &SE)
8602 : Terms(T), SE(SE) {}
8604 bool follow(const SCEV *S) {
8605 if (auto *Mul = dyn_cast<SCEVMulExpr>(S)) {
8606 bool HasAddRec = false;
8607 SmallVector<const SCEV *, 0> Operands;
8608 for (auto Op : Mul->operands()) {
8609 if (isa<SCEVUnknown>(Op)) {
8610 Operands.push_back(Op);
8612 bool ContainsAddRec;
8613 SCEVHasAddRec ContiansAddRec(ContainsAddRec);
8614 visitAll(Op, ContiansAddRec);
8615 HasAddRec |= ContainsAddRec;
8618 if (Operands.size() == 0)
8624 Terms.push_back(SE.getMulExpr(Operands));
8625 // Stop recursion: once we collected a term, do not walk its operands.
8632 bool isDone() const { return false; }
8636 /// Find parametric terms in this SCEVAddRecExpr. We first for parameters in
8638 /// 1) The strides of AddRec expressions.
8639 /// 2) Unknowns that are multiplied with AddRec expressions.
8640 void ScalarEvolution::collectParametricTerms(const SCEV *Expr,
8641 SmallVectorImpl<const SCEV *> &Terms) {
8642 SmallVector<const SCEV *, 4> Strides;
8643 SCEVCollectStrides StrideCollector(*this, Strides);
8644 visitAll(Expr, StrideCollector);
8647 dbgs() << "Strides:\n";
8648 for (const SCEV *S : Strides)
8649 dbgs() << *S << "\n";
8652 for (const SCEV *S : Strides) {
8653 SCEVCollectTerms TermCollector(Terms);
8654 visitAll(S, TermCollector);
8658 dbgs() << "Terms:\n";
8659 for (const SCEV *T : Terms)
8660 dbgs() << *T << "\n";
8663 SCEVCollectAddRecMultiplies MulCollector(Terms, *this);
8664 visitAll(Expr, MulCollector);
8667 static bool findArrayDimensionsRec(ScalarEvolution &SE,
8668 SmallVectorImpl<const SCEV *> &Terms,
8669 SmallVectorImpl<const SCEV *> &Sizes) {
8670 int Last = Terms.size() - 1;
8671 const SCEV *Step = Terms[Last];
8673 // End of recursion.
8675 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(Step)) {
8676 SmallVector<const SCEV *, 2> Qs;
8677 for (const SCEV *Op : M->operands())
8678 if (!isa<SCEVConstant>(Op))
8681 Step = SE.getMulExpr(Qs);
8684 Sizes.push_back(Step);
8688 for (const SCEV *&Term : Terms) {
8689 // Normalize the terms before the next call to findArrayDimensionsRec.
8691 SCEVDivision::divide(SE, Term, Step, &Q, &R);
8693 // Bail out when GCD does not evenly divide one of the terms.
8700 // Remove all SCEVConstants.
8701 Terms.erase(std::remove_if(Terms.begin(), Terms.end(), [](const SCEV *E) {
8702 return isa<SCEVConstant>(E);
8706 if (Terms.size() > 0)
8707 if (!findArrayDimensionsRec(SE, Terms, Sizes))
8710 Sizes.push_back(Step);
8714 // Returns true when S contains at least a SCEVUnknown parameter.
8716 containsParameters(const SCEV *S) {
8717 struct FindParameter {
8718 bool FoundParameter;
8719 FindParameter() : FoundParameter(false) {}
8721 bool follow(const SCEV *S) {
8722 if (isa<SCEVUnknown>(S)) {
8723 FoundParameter = true;
8724 // Stop recursion: we found a parameter.
8730 bool isDone() const {
8731 // Stop recursion if we have found a parameter.
8732 return FoundParameter;
8737 SCEVTraversal<FindParameter> ST(F);
8740 return F.FoundParameter;
8743 // Returns true when one of the SCEVs of Terms contains a SCEVUnknown parameter.
8745 containsParameters(SmallVectorImpl<const SCEV *> &Terms) {
8746 for (const SCEV *T : Terms)
8747 if (containsParameters(T))
8752 // Return the number of product terms in S.
8753 static inline int numberOfTerms(const SCEV *S) {
8754 if (const SCEVMulExpr *Expr = dyn_cast<SCEVMulExpr>(S))
8755 return Expr->getNumOperands();
8759 static const SCEV *removeConstantFactors(ScalarEvolution &SE, const SCEV *T) {
8760 if (isa<SCEVConstant>(T))
8763 if (isa<SCEVUnknown>(T))
8766 if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(T)) {
8767 SmallVector<const SCEV *, 2> Factors;
8768 for (const SCEV *Op : M->operands())
8769 if (!isa<SCEVConstant>(Op))
8770 Factors.push_back(Op);
8772 return SE.getMulExpr(Factors);
8778 /// Return the size of an element read or written by Inst.
8779 const SCEV *ScalarEvolution::getElementSize(Instruction *Inst) {
8781 if (StoreInst *Store = dyn_cast<StoreInst>(Inst))
8782 Ty = Store->getValueOperand()->getType();
8783 else if (LoadInst *Load = dyn_cast<LoadInst>(Inst))
8784 Ty = Load->getType();
8788 Type *ETy = getEffectiveSCEVType(PointerType::getUnqual(Ty));
8789 return getSizeOfExpr(ETy, Ty);
8792 /// Second step of delinearization: compute the array dimensions Sizes from the
8793 /// set of Terms extracted from the memory access function of this SCEVAddRec.
8794 void ScalarEvolution::findArrayDimensions(SmallVectorImpl<const SCEV *> &Terms,
8795 SmallVectorImpl<const SCEV *> &Sizes,
8796 const SCEV *ElementSize) const {
8798 if (Terms.size() < 1 || !ElementSize)
8801 // Early return when Terms do not contain parameters: we do not delinearize
8802 // non parametric SCEVs.
8803 if (!containsParameters(Terms))
8807 dbgs() << "Terms:\n";
8808 for (const SCEV *T : Terms)
8809 dbgs() << *T << "\n";
8812 // Remove duplicates.
8813 std::sort(Terms.begin(), Terms.end());
8814 Terms.erase(std::unique(Terms.begin(), Terms.end()), Terms.end());
8816 // Put larger terms first.
8817 std::sort(Terms.begin(), Terms.end(), [](const SCEV *LHS, const SCEV *RHS) {
8818 return numberOfTerms(LHS) > numberOfTerms(RHS);
8821 ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
8823 // Try to divide all terms by the element size. If term is not divisible by
8824 // element size, proceed with the original term.
8825 for (const SCEV *&Term : Terms) {
8827 SCEVDivision::divide(SE, Term, ElementSize, &Q, &R);
8832 SmallVector<const SCEV *, 4> NewTerms;
8834 // Remove constant factors.
8835 for (const SCEV *T : Terms)
8836 if (const SCEV *NewT = removeConstantFactors(SE, T))
8837 NewTerms.push_back(NewT);
8840 dbgs() << "Terms after sorting:\n";
8841 for (const SCEV *T : NewTerms)
8842 dbgs() << *T << "\n";
8845 if (NewTerms.empty() ||
8846 !findArrayDimensionsRec(SE, NewTerms, Sizes)) {
8851 // The last element to be pushed into Sizes is the size of an element.
8852 Sizes.push_back(ElementSize);
8855 dbgs() << "Sizes:\n";
8856 for (const SCEV *S : Sizes)
8857 dbgs() << *S << "\n";
8861 /// Third step of delinearization: compute the access functions for the
8862 /// Subscripts based on the dimensions in Sizes.
8863 void ScalarEvolution::computeAccessFunctions(
8864 const SCEV *Expr, SmallVectorImpl<const SCEV *> &Subscripts,
8865 SmallVectorImpl<const SCEV *> &Sizes) {
8867 // Early exit in case this SCEV is not an affine multivariate function.
8871 if (auto *AR = dyn_cast<SCEVAddRecExpr>(Expr))
8872 if (!AR->isAffine())
8875 const SCEV *Res = Expr;
8876 int Last = Sizes.size() - 1;
8877 for (int i = Last; i >= 0; i--) {
8879 SCEVDivision::divide(*this, Res, Sizes[i], &Q, &R);
8882 dbgs() << "Res: " << *Res << "\n";
8883 dbgs() << "Sizes[i]: " << *Sizes[i] << "\n";
8884 dbgs() << "Res divided by Sizes[i]:\n";
8885 dbgs() << "Quotient: " << *Q << "\n";
8886 dbgs() << "Remainder: " << *R << "\n";
8891 // Do not record the last subscript corresponding to the size of elements in
8895 // Bail out if the remainder is too complex.
8896 if (isa<SCEVAddRecExpr>(R)) {
8905 // Record the access function for the current subscript.
8906 Subscripts.push_back(R);
8909 // Also push in last position the remainder of the last division: it will be
8910 // the access function of the innermost dimension.
8911 Subscripts.push_back(Res);
8913 std::reverse(Subscripts.begin(), Subscripts.end());
8916 dbgs() << "Subscripts:\n";
8917 for (const SCEV *S : Subscripts)
8918 dbgs() << *S << "\n";
8922 /// Splits the SCEV into two vectors of SCEVs representing the subscripts and
8923 /// sizes of an array access. Returns the remainder of the delinearization that
8924 /// is the offset start of the array. The SCEV->delinearize algorithm computes
8925 /// the multiples of SCEV coefficients: that is a pattern matching of sub
8926 /// expressions in the stride and base of a SCEV corresponding to the
8927 /// computation of a GCD (greatest common divisor) of base and stride. When
8928 /// SCEV->delinearize fails, it returns the SCEV unchanged.
8930 /// For example: when analyzing the memory access A[i][j][k] in this loop nest
8932 /// void foo(long n, long m, long o, double A[n][m][o]) {
8934 /// for (long i = 0; i < n; i++)
8935 /// for (long j = 0; j < m; j++)
8936 /// for (long k = 0; k < o; k++)
8937 /// A[i][j][k] = 1.0;
8940 /// the delinearization input is the following AddRec SCEV:
8942 /// AddRec: {{{%A,+,(8 * %m * %o)}<%for.i>,+,(8 * %o)}<%for.j>,+,8}<%for.k>
8944 /// From this SCEV, we are able to say that the base offset of the access is %A
8945 /// because it appears as an offset that does not divide any of the strides in
8948 /// CHECK: Base offset: %A
8950 /// and then SCEV->delinearize determines the size of some of the dimensions of
8951 /// the array as these are the multiples by which the strides are happening:
8953 /// CHECK: ArrayDecl[UnknownSize][%m][%o] with elements of sizeof(double) bytes.
8955 /// Note that the outermost dimension remains of UnknownSize because there are
8956 /// no strides that would help identifying the size of the last dimension: when
8957 /// the array has been statically allocated, one could compute the size of that
8958 /// dimension by dividing the overall size of the array by the size of the known
8959 /// dimensions: %m * %o * 8.
8961 /// Finally delinearize provides the access functions for the array reference
8962 /// that does correspond to A[i][j][k] of the above C testcase:
8964 /// CHECK: ArrayRef[{0,+,1}<%for.i>][{0,+,1}<%for.j>][{0,+,1}<%for.k>]
8966 /// The testcases are checking the output of a function pass:
8967 /// DelinearizationPass that walks through all loads and stores of a function
8968 /// asking for the SCEV of the memory access with respect to all enclosing
8969 /// loops, calling SCEV->delinearize on that and printing the results.
8971 void ScalarEvolution::delinearize(const SCEV *Expr,
8972 SmallVectorImpl<const SCEV *> &Subscripts,
8973 SmallVectorImpl<const SCEV *> &Sizes,
8974 const SCEV *ElementSize) {
8975 // First step: collect parametric terms.
8976 SmallVector<const SCEV *, 4> Terms;
8977 collectParametricTerms(Expr, Terms);
8982 // Second step: find subscript sizes.
8983 findArrayDimensions(Terms, Sizes, ElementSize);
8988 // Third step: compute the access functions for each subscript.
8989 computeAccessFunctions(Expr, Subscripts, Sizes);
8991 if (Subscripts.empty())
8995 dbgs() << "succeeded to delinearize " << *Expr << "\n";
8996 dbgs() << "ArrayDecl[UnknownSize]";
8997 for (const SCEV *S : Sizes)
8998 dbgs() << "[" << *S << "]";
9000 dbgs() << "\nArrayRef";
9001 for (const SCEV *S : Subscripts)
9002 dbgs() << "[" << *S << "]";
9007 //===----------------------------------------------------------------------===//
9008 // SCEVCallbackVH Class Implementation
9009 //===----------------------------------------------------------------------===//
9011 void ScalarEvolution::SCEVCallbackVH::deleted() {
9012 assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
9013 if (PHINode *PN = dyn_cast<PHINode>(getValPtr()))
9014 SE->ConstantEvolutionLoopExitValue.erase(PN);
9015 SE->ValueExprMap.erase(getValPtr());
9016 // this now dangles!
9019 void ScalarEvolution::SCEVCallbackVH::allUsesReplacedWith(Value *V) {
9020 assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
9022 // Forget all the expressions associated with users of the old value,
9023 // so that future queries will recompute the expressions using the new
9025 Value *Old = getValPtr();
9026 SmallVector<User *, 16> Worklist(Old->user_begin(), Old->user_end());
9027 SmallPtrSet<User *, 8> Visited;
9028 while (!Worklist.empty()) {
9029 User *U = Worklist.pop_back_val();
9030 // Deleting the Old value will cause this to dangle. Postpone
9031 // that until everything else is done.
9034 if (!Visited.insert(U).second)
9036 if (PHINode *PN = dyn_cast<PHINode>(U))
9037 SE->ConstantEvolutionLoopExitValue.erase(PN);
9038 SE->ValueExprMap.erase(U);
9039 Worklist.insert(Worklist.end(), U->user_begin(), U->user_end());
9041 // Delete the Old value.
9042 if (PHINode *PN = dyn_cast<PHINode>(Old))
9043 SE->ConstantEvolutionLoopExitValue.erase(PN);
9044 SE->ValueExprMap.erase(Old);
9045 // this now dangles!
9048 ScalarEvolution::SCEVCallbackVH::SCEVCallbackVH(Value *V, ScalarEvolution *se)
9049 : CallbackVH(V), SE(se) {}
9051 //===----------------------------------------------------------------------===//
9052 // ScalarEvolution Class Implementation
9053 //===----------------------------------------------------------------------===//
9055 ScalarEvolution::ScalarEvolution(Function &F, TargetLibraryInfo &TLI,
9056 AssumptionCache &AC, DominatorTree &DT,
9058 : F(F), TLI(TLI), AC(AC), DT(DT), LI(LI),
9059 CouldNotCompute(new SCEVCouldNotCompute()),
9060 WalkingBEDominatingConds(false), ProvingSplitPredicate(false),
9061 ValuesAtScopes(64), LoopDispositions(64), BlockDispositions(64),
9062 FirstUnknown(nullptr) {}
9064 ScalarEvolution::ScalarEvolution(ScalarEvolution &&Arg)
9065 : F(Arg.F), TLI(Arg.TLI), AC(Arg.AC), DT(Arg.DT), LI(Arg.LI),
9066 CouldNotCompute(std::move(Arg.CouldNotCompute)),
9067 ValueExprMap(std::move(Arg.ValueExprMap)),
9068 WalkingBEDominatingConds(false), ProvingSplitPredicate(false),
9069 BackedgeTakenCounts(std::move(Arg.BackedgeTakenCounts)),
9070 ConstantEvolutionLoopExitValue(
9071 std::move(Arg.ConstantEvolutionLoopExitValue)),
9072 ValuesAtScopes(std::move(Arg.ValuesAtScopes)),
9073 LoopDispositions(std::move(Arg.LoopDispositions)),
9074 BlockDispositions(std::move(Arg.BlockDispositions)),
9075 UnsignedRanges(std::move(Arg.UnsignedRanges)),
9076 SignedRanges(std::move(Arg.SignedRanges)),
9077 UniqueSCEVs(std::move(Arg.UniqueSCEVs)),
9078 UniquePreds(std::move(Arg.UniquePreds)),
9079 SCEVAllocator(std::move(Arg.SCEVAllocator)),
9080 FirstUnknown(Arg.FirstUnknown) {
9081 Arg.FirstUnknown = nullptr;
9084 ScalarEvolution::~ScalarEvolution() {
9085 // Iterate through all the SCEVUnknown instances and call their
9086 // destructors, so that they release their references to their values.
9087 for (SCEVUnknown *U = FirstUnknown; U;) {
9088 SCEVUnknown *Tmp = U;
9090 Tmp->~SCEVUnknown();
9092 FirstUnknown = nullptr;
9094 ValueExprMap.clear();
9096 // Free any extra memory created for ExitNotTakenInfo in the unlikely event
9097 // that a loop had multiple computable exits.
9098 for (auto &BTCI : BackedgeTakenCounts)
9099 BTCI.second.clear();
9101 assert(PendingLoopPredicates.empty() && "isImpliedCond garbage");
9102 assert(!WalkingBEDominatingConds && "isLoopBackedgeGuardedByCond garbage!");
9103 assert(!ProvingSplitPredicate && "ProvingSplitPredicate garbage!");
9106 bool ScalarEvolution::hasLoopInvariantBackedgeTakenCount(const Loop *L) {
9107 return !isa<SCEVCouldNotCompute>(getBackedgeTakenCount(L));
9110 static void PrintLoopInfo(raw_ostream &OS, ScalarEvolution *SE,
9112 // Print all inner loops first
9113 for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
9114 PrintLoopInfo(OS, SE, *I);
9117 L->getHeader()->printAsOperand(OS, /*PrintType=*/false);
9120 SmallVector<BasicBlock *, 8> ExitBlocks;
9121 L->getExitBlocks(ExitBlocks);
9122 if (ExitBlocks.size() != 1)
9123 OS << "<multiple exits> ";
9125 if (SE->hasLoopInvariantBackedgeTakenCount(L)) {
9126 OS << "backedge-taken count is " << *SE->getBackedgeTakenCount(L);
9128 OS << "Unpredictable backedge-taken count. ";
9133 L->getHeader()->printAsOperand(OS, /*PrintType=*/false);
9136 if (!isa<SCEVCouldNotCompute>(SE->getMaxBackedgeTakenCount(L))) {
9137 OS << "max backedge-taken count is " << *SE->getMaxBackedgeTakenCount(L);
9139 OS << "Unpredictable max backedge-taken count. ";
9145 void ScalarEvolution::print(raw_ostream &OS) const {
9146 // ScalarEvolution's implementation of the print method is to print
9147 // out SCEV values of all instructions that are interesting. Doing
9148 // this potentially causes it to create new SCEV objects though,
9149 // which technically conflicts with the const qualifier. This isn't
9150 // observable from outside the class though, so casting away the
9151 // const isn't dangerous.
9152 ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
9154 OS << "Classifying expressions for: ";
9155 F.printAsOperand(OS, /*PrintType=*/false);
9157 for (Instruction &I : instructions(F))
9158 if (isSCEVable(I.getType()) && !isa<CmpInst>(I)) {
9161 const SCEV *SV = SE.getSCEV(&I);
9163 if (!isa<SCEVCouldNotCompute>(SV)) {
9165 SE.getUnsignedRange(SV).print(OS);
9167 SE.getSignedRange(SV).print(OS);
9170 const Loop *L = LI.getLoopFor(I.getParent());
9172 const SCEV *AtUse = SE.getSCEVAtScope(SV, L);
9176 if (!isa<SCEVCouldNotCompute>(AtUse)) {
9178 SE.getUnsignedRange(AtUse).print(OS);
9180 SE.getSignedRange(AtUse).print(OS);
9185 OS << "\t\t" "Exits: ";
9186 const SCEV *ExitValue = SE.getSCEVAtScope(SV, L->getParentLoop());
9187 if (!SE.isLoopInvariant(ExitValue, L)) {
9188 OS << "<<Unknown>>";
9197 OS << "Determining loop execution counts for: ";
9198 F.printAsOperand(OS, /*PrintType=*/false);
9200 for (LoopInfo::iterator I = LI.begin(), E = LI.end(); I != E; ++I)
9201 PrintLoopInfo(OS, &SE, *I);
9204 ScalarEvolution::LoopDisposition
9205 ScalarEvolution::getLoopDisposition(const SCEV *S, const Loop *L) {
9206 auto &Values = LoopDispositions[S];
9207 for (auto &V : Values) {
9208 if (V.getPointer() == L)
9211 Values.emplace_back(L, LoopVariant);
9212 LoopDisposition D = computeLoopDisposition(S, L);
9213 auto &Values2 = LoopDispositions[S];
9214 for (auto &V : make_range(Values2.rbegin(), Values2.rend())) {
9215 if (V.getPointer() == L) {
9223 ScalarEvolution::LoopDisposition
9224 ScalarEvolution::computeLoopDisposition(const SCEV *S, const Loop *L) {
9225 switch (static_cast<SCEVTypes>(S->getSCEVType())) {
9227 return LoopInvariant;
9231 return getLoopDisposition(cast<SCEVCastExpr>(S)->getOperand(), L);
9232 case scAddRecExpr: {
9233 const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S);
9235 // If L is the addrec's loop, it's computable.
9236 if (AR->getLoop() == L)
9237 return LoopComputable;
9239 // Add recurrences are never invariant in the function-body (null loop).
9243 // This recurrence is variant w.r.t. L if L contains AR's loop.
9244 if (L->contains(AR->getLoop()))
9247 // This recurrence is invariant w.r.t. L if AR's loop contains L.
9248 if (AR->getLoop()->contains(L))
9249 return LoopInvariant;
9251 // This recurrence is variant w.r.t. L if any of its operands
9253 for (auto *Op : AR->operands())
9254 if (!isLoopInvariant(Op, L))
9257 // Otherwise it's loop-invariant.
9258 return LoopInvariant;
9264 bool HasVarying = false;
9265 for (auto *Op : cast<SCEVNAryExpr>(S)->operands()) {
9266 LoopDisposition D = getLoopDisposition(Op, L);
9267 if (D == LoopVariant)
9269 if (D == LoopComputable)
9272 return HasVarying ? LoopComputable : LoopInvariant;
9275 const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
9276 LoopDisposition LD = getLoopDisposition(UDiv->getLHS(), L);
9277 if (LD == LoopVariant)
9279 LoopDisposition RD = getLoopDisposition(UDiv->getRHS(), L);
9280 if (RD == LoopVariant)
9282 return (LD == LoopInvariant && RD == LoopInvariant) ?
9283 LoopInvariant : LoopComputable;
9286 // All non-instruction values are loop invariant. All instructions are loop
9287 // invariant if they are not contained in the specified loop.
9288 // Instructions are never considered invariant in the function body
9289 // (null loop) because they are defined within the "loop".
9290 if (auto *I = dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue()))
9291 return (L && !L->contains(I)) ? LoopInvariant : LoopVariant;
9292 return LoopInvariant;
9293 case scCouldNotCompute:
9294 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
9296 llvm_unreachable("Unknown SCEV kind!");
9299 bool ScalarEvolution::isLoopInvariant(const SCEV *S, const Loop *L) {
9300 return getLoopDisposition(S, L) == LoopInvariant;
9303 bool ScalarEvolution::hasComputableLoopEvolution(const SCEV *S, const Loop *L) {
9304 return getLoopDisposition(S, L) == LoopComputable;
9307 ScalarEvolution::BlockDisposition
9308 ScalarEvolution::getBlockDisposition(const SCEV *S, const BasicBlock *BB) {
9309 auto &Values = BlockDispositions[S];
9310 for (auto &V : Values) {
9311 if (V.getPointer() == BB)
9314 Values.emplace_back(BB, DoesNotDominateBlock);
9315 BlockDisposition D = computeBlockDisposition(S, BB);
9316 auto &Values2 = BlockDispositions[S];
9317 for (auto &V : make_range(Values2.rbegin(), Values2.rend())) {
9318 if (V.getPointer() == BB) {
9326 ScalarEvolution::BlockDisposition
9327 ScalarEvolution::computeBlockDisposition(const SCEV *S, const BasicBlock *BB) {
9328 switch (static_cast<SCEVTypes>(S->getSCEVType())) {
9330 return ProperlyDominatesBlock;
9334 return getBlockDisposition(cast<SCEVCastExpr>(S)->getOperand(), BB);
9335 case scAddRecExpr: {
9336 // This uses a "dominates" query instead of "properly dominates" query
9337 // to test for proper dominance too, because the instruction which
9338 // produces the addrec's value is a PHI, and a PHI effectively properly
9339 // dominates its entire containing block.
9340 const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S);
9341 if (!DT.dominates(AR->getLoop()->getHeader(), BB))
9342 return DoesNotDominateBlock;
9344 // FALL THROUGH into SCEVNAryExpr handling.
9349 const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S);
9351 for (const SCEV *NAryOp : NAry->operands()) {
9352 BlockDisposition D = getBlockDisposition(NAryOp, BB);
9353 if (D == DoesNotDominateBlock)
9354 return DoesNotDominateBlock;
9355 if (D == DominatesBlock)
9358 return Proper ? ProperlyDominatesBlock : DominatesBlock;
9361 const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
9362 const SCEV *LHS = UDiv->getLHS(), *RHS = UDiv->getRHS();
9363 BlockDisposition LD = getBlockDisposition(LHS, BB);
9364 if (LD == DoesNotDominateBlock)
9365 return DoesNotDominateBlock;
9366 BlockDisposition RD = getBlockDisposition(RHS, BB);
9367 if (RD == DoesNotDominateBlock)
9368 return DoesNotDominateBlock;
9369 return (LD == ProperlyDominatesBlock && RD == ProperlyDominatesBlock) ?
9370 ProperlyDominatesBlock : DominatesBlock;
9373 if (Instruction *I =
9374 dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue())) {
9375 if (I->getParent() == BB)
9376 return DominatesBlock;
9377 if (DT.properlyDominates(I->getParent(), BB))
9378 return ProperlyDominatesBlock;
9379 return DoesNotDominateBlock;
9381 return ProperlyDominatesBlock;
9382 case scCouldNotCompute:
9383 llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
9385 llvm_unreachable("Unknown SCEV kind!");
9388 bool ScalarEvolution::dominates(const SCEV *S, const BasicBlock *BB) {
9389 return getBlockDisposition(S, BB) >= DominatesBlock;
9392 bool ScalarEvolution::properlyDominates(const SCEV *S, const BasicBlock *BB) {
9393 return getBlockDisposition(S, BB) == ProperlyDominatesBlock;
9396 bool ScalarEvolution::hasOperand(const SCEV *S, const SCEV *Op) const {
9397 // Search for a SCEV expression node within an expression tree.
9398 // Implements SCEVTraversal::Visitor.
9403 SCEVSearch(const SCEV *N): Node(N), IsFound(false) {}
9405 bool follow(const SCEV *S) {
9406 IsFound |= (S == Node);
9409 bool isDone() const { return IsFound; }
9412 SCEVSearch Search(Op);
9413 visitAll(S, Search);
9414 return Search.IsFound;
9417 void ScalarEvolution::forgetMemoizedResults(const SCEV *S) {
9418 ValuesAtScopes.erase(S);
9419 LoopDispositions.erase(S);
9420 BlockDispositions.erase(S);
9421 UnsignedRanges.erase(S);
9422 SignedRanges.erase(S);
9424 for (DenseMap<const Loop*, BackedgeTakenInfo>::iterator I =
9425 BackedgeTakenCounts.begin(), E = BackedgeTakenCounts.end(); I != E; ) {
9426 BackedgeTakenInfo &BEInfo = I->second;
9427 if (BEInfo.hasOperand(S, this)) {
9429 BackedgeTakenCounts.erase(I++);
9436 typedef DenseMap<const Loop *, std::string> VerifyMap;
9438 /// replaceSubString - Replaces all occurrences of From in Str with To.
9439 static void replaceSubString(std::string &Str, StringRef From, StringRef To) {
9441 while ((Pos = Str.find(From, Pos)) != std::string::npos) {
9442 Str.replace(Pos, From.size(), To.data(), To.size());
9447 /// getLoopBackedgeTakenCounts - Helper method for verifyAnalysis.
9449 getLoopBackedgeTakenCounts(Loop *L, VerifyMap &Map, ScalarEvolution &SE) {
9450 for (Loop::reverse_iterator I = L->rbegin(), E = L->rend(); I != E; ++I) {
9451 getLoopBackedgeTakenCounts(*I, Map, SE); // recurse.
9453 std::string &S = Map[L];
9455 raw_string_ostream OS(S);
9456 SE.getBackedgeTakenCount(L)->print(OS);
9458 // false and 0 are semantically equivalent. This can happen in dead loops.
9459 replaceSubString(OS.str(), "false", "0");
9460 // Remove wrap flags, their use in SCEV is highly fragile.
9461 // FIXME: Remove this when SCEV gets smarter about them.
9462 replaceSubString(OS.str(), "<nw>", "");
9463 replaceSubString(OS.str(), "<nsw>", "");
9464 replaceSubString(OS.str(), "<nuw>", "");
9469 void ScalarEvolution::verify() const {
9470 ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
9472 // Gather stringified backedge taken counts for all loops using SCEV's caches.
9473 // FIXME: It would be much better to store actual values instead of strings,
9474 // but SCEV pointers will change if we drop the caches.
9475 VerifyMap BackedgeDumpsOld, BackedgeDumpsNew;
9476 for (LoopInfo::reverse_iterator I = LI.rbegin(), E = LI.rend(); I != E; ++I)
9477 getLoopBackedgeTakenCounts(*I, BackedgeDumpsOld, SE);
9479 // Gather stringified backedge taken counts for all loops using a fresh
9480 // ScalarEvolution object.
9481 ScalarEvolution SE2(F, TLI, AC, DT, LI);
9482 for (LoopInfo::reverse_iterator I = LI.rbegin(), E = LI.rend(); I != E; ++I)
9483 getLoopBackedgeTakenCounts(*I, BackedgeDumpsNew, SE2);
9485 // Now compare whether they're the same with and without caches. This allows
9486 // verifying that no pass changed the cache.
9487 assert(BackedgeDumpsOld.size() == BackedgeDumpsNew.size() &&
9488 "New loops suddenly appeared!");
9490 for (VerifyMap::iterator OldI = BackedgeDumpsOld.begin(),
9491 OldE = BackedgeDumpsOld.end(),
9492 NewI = BackedgeDumpsNew.begin();
9493 OldI != OldE; ++OldI, ++NewI) {
9494 assert(OldI->first == NewI->first && "Loop order changed!");
9496 // Compare the stringified SCEVs. We don't care if undef backedgetaken count
9498 // FIXME: We currently ignore SCEV changes from/to CouldNotCompute. This
9499 // means that a pass is buggy or SCEV has to learn a new pattern but is
9500 // usually not harmful.
9501 if (OldI->second != NewI->second &&
9502 OldI->second.find("undef") == std::string::npos &&
9503 NewI->second.find("undef") == std::string::npos &&
9504 OldI->second != "***COULDNOTCOMPUTE***" &&
9505 NewI->second != "***COULDNOTCOMPUTE***") {
9506 dbgs() << "SCEVValidator: SCEV for loop '"
9507 << OldI->first->getHeader()->getName()
9508 << "' changed from '" << OldI->second
9509 << "' to '" << NewI->second << "'!\n";
9514 // TODO: Verify more things.
9517 char ScalarEvolutionAnalysis::PassID;
9519 ScalarEvolution ScalarEvolutionAnalysis::run(Function &F,
9520 AnalysisManager<Function> *AM) {
9521 return ScalarEvolution(F, AM->getResult<TargetLibraryAnalysis>(F),
9522 AM->getResult<AssumptionAnalysis>(F),
9523 AM->getResult<DominatorTreeAnalysis>(F),
9524 AM->getResult<LoopAnalysis>(F));
9528 ScalarEvolutionPrinterPass::run(Function &F, AnalysisManager<Function> *AM) {
9529 AM->getResult<ScalarEvolutionAnalysis>(F).print(OS);
9530 return PreservedAnalyses::all();
9533 INITIALIZE_PASS_BEGIN(ScalarEvolutionWrapperPass, "scalar-evolution",
9534 "Scalar Evolution Analysis", false, true)
9535 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
9536 INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass)
9537 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
9538 INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)
9539 INITIALIZE_PASS_END(ScalarEvolutionWrapperPass, "scalar-evolution",
9540 "Scalar Evolution Analysis", false, true)
9541 char ScalarEvolutionWrapperPass::ID = 0;
9543 ScalarEvolutionWrapperPass::ScalarEvolutionWrapperPass() : FunctionPass(ID) {
9544 initializeScalarEvolutionWrapperPassPass(*PassRegistry::getPassRegistry());
9547 bool ScalarEvolutionWrapperPass::runOnFunction(Function &F) {
9548 SE.reset(new ScalarEvolution(
9549 F, getAnalysis<TargetLibraryInfoWrapperPass>().getTLI(),
9550 getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F),
9551 getAnalysis<DominatorTreeWrapperPass>().getDomTree(),
9552 getAnalysis<LoopInfoWrapperPass>().getLoopInfo()));
9556 void ScalarEvolutionWrapperPass::releaseMemory() { SE.reset(); }
9558 void ScalarEvolutionWrapperPass::print(raw_ostream &OS, const Module *) const {
9562 void ScalarEvolutionWrapperPass::verifyAnalysis() const {
9569 void ScalarEvolutionWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
9570 AU.setPreservesAll();
9571 AU.addRequiredTransitive<AssumptionCacheTracker>();
9572 AU.addRequiredTransitive<LoopInfoWrapperPass>();
9573 AU.addRequiredTransitive<DominatorTreeWrapperPass>();
9574 AU.addRequiredTransitive<TargetLibraryInfoWrapperPass>();
9577 const SCEVPredicate *
9578 ScalarEvolution::getEqualPredicate(const SCEVUnknown *LHS,
9579 const SCEVConstant *RHS) {
9580 FoldingSetNodeID ID;
9581 // Unique this node based on the arguments
9582 ID.AddInteger(SCEVPredicate::P_Equal);
9586 if (const auto *S = UniquePreds.FindNodeOrInsertPos(ID, IP))
9588 SCEVEqualPredicate *Eq = new (SCEVAllocator)
9589 SCEVEqualPredicate(ID.Intern(SCEVAllocator), LHS, RHS);
9590 UniquePreds.InsertNode(Eq, IP);
9595 class SCEVPredicateRewriter : public SCEVRewriteVisitor<SCEVPredicateRewriter> {
9597 static const SCEV *rewrite(const SCEV *Scev, ScalarEvolution &SE,
9598 SCEVUnionPredicate &A) {
9599 SCEVPredicateRewriter Rewriter(SE, A);
9600 return Rewriter.visit(Scev);
9603 SCEVPredicateRewriter(ScalarEvolution &SE, SCEVUnionPredicate &P)
9604 : SCEVRewriteVisitor(SE), P(P) {}
9606 const SCEV *visitUnknown(const SCEVUnknown *Expr) {
9607 auto ExprPreds = P.getPredicatesForExpr(Expr);
9608 for (auto *Pred : ExprPreds)
9609 if (const auto *IPred = dyn_cast<const SCEVEqualPredicate>(Pred))
9610 if (IPred->getLHS() == Expr)
9611 return IPred->getRHS();
9617 SCEVUnionPredicate &P;
9619 } // end anonymous namespace
9621 const SCEV *ScalarEvolution::rewriteUsingPredicate(const SCEV *Scev,
9622 SCEVUnionPredicate &Preds) {
9623 return SCEVPredicateRewriter::rewrite(Scev, *this, Preds);
9627 SCEVPredicate::SCEVPredicate(const FoldingSetNodeIDRef ID,
9628 SCEVPredicateKind Kind)
9629 : FastID(ID), Kind(Kind) {}
9631 SCEVPredicate::~SCEVPredicate() {}
9633 SCEVEqualPredicate::SCEVEqualPredicate(const FoldingSetNodeIDRef ID,
9634 const SCEVUnknown *LHS,
9635 const SCEVConstant *RHS)
9636 : SCEVPredicate(ID, P_Equal), LHS(LHS), RHS(RHS) {}
9638 bool SCEVEqualPredicate::implies(const SCEVPredicate *N) const {
9639 const auto *Op = dyn_cast<const SCEVEqualPredicate>(N);
9644 return Op->LHS == LHS && Op->RHS == RHS;
9647 bool SCEVEqualPredicate::isAlwaysTrue() const { return false; }
9649 const SCEV *SCEVEqualPredicate::getExpr() const { return LHS; }
9651 void SCEVEqualPredicate::print(raw_ostream &OS, unsigned Depth) const {
9652 OS.indent(Depth) << "Equal predicate: " << *LHS << " == " << *RHS << "\n";
9655 /// Union predicates don't get cached so create a dummy set ID for it.
9656 SCEVUnionPredicate::SCEVUnionPredicate()
9657 : SCEVPredicate(FoldingSetNodeIDRef(nullptr, 0), P_Union) {}
9659 bool SCEVUnionPredicate::isAlwaysTrue() const {
9660 return all_of(Preds,
9661 [](const SCEVPredicate *I) { return I->isAlwaysTrue(); });
9664 ArrayRef<const SCEVPredicate *>
9665 SCEVUnionPredicate::getPredicatesForExpr(const SCEV *Expr) {
9666 auto I = SCEVToPreds.find(Expr);
9667 if (I == SCEVToPreds.end())
9668 return ArrayRef<const SCEVPredicate *>();
9672 bool SCEVUnionPredicate::implies(const SCEVPredicate *N) const {
9673 if (const auto *Set = dyn_cast<const SCEVUnionPredicate>(N))
9674 return all_of(Set->Preds,
9675 [this](const SCEVPredicate *I) { return this->implies(I); });
9677 auto ScevPredsIt = SCEVToPreds.find(N->getExpr());
9678 if (ScevPredsIt == SCEVToPreds.end())
9680 auto &SCEVPreds = ScevPredsIt->second;
9682 return any_of(SCEVPreds,
9683 [N](const SCEVPredicate *I) { return I->implies(N); });
9686 const SCEV *SCEVUnionPredicate::getExpr() const { return nullptr; }
9688 void SCEVUnionPredicate::print(raw_ostream &OS, unsigned Depth) const {
9689 for (auto Pred : Preds)
9690 Pred->print(OS, Depth);
9693 void SCEVUnionPredicate::add(const SCEVPredicate *N) {
9694 if (const auto *Set = dyn_cast<const SCEVUnionPredicate>(N)) {
9695 for (auto Pred : Set->Preds)
9703 const SCEV *Key = N->getExpr();
9704 assert(Key && "Only SCEVUnionPredicate doesn't have an "
9705 " associated expression!");
9707 SCEVToPreds[Key].push_back(N);
9711 PredicatedScalarEvolution::PredicatedScalarEvolution(ScalarEvolution &SE)
9712 : SE(SE), Generation(0) {}
9714 const SCEV *PredicatedScalarEvolution::getSCEV(Value *V) {
9715 const SCEV *Expr = SE.getSCEV(V);
9716 RewriteEntry &Entry = RewriteMap[Expr];
9718 // If we already have an entry and the version matches, return it.
9719 if (Entry.second && Generation == Entry.first)
9720 return Entry.second;
9722 // We found an entry but it's stale. Rewrite the stale entry
9723 // acording to the current predicate.
9725 Expr = Entry.second;
9727 const SCEV *NewSCEV = SE.rewriteUsingPredicate(Expr, Preds);
9728 Entry = {Generation, NewSCEV};
9733 void PredicatedScalarEvolution::addPredicate(const SCEVPredicate &Pred) {
9734 if (Preds.implies(&Pred))
9740 const SCEVUnionPredicate &PredicatedScalarEvolution::getUnionPredicate() const {
9744 void PredicatedScalarEvolution::updateGeneration() {
9745 // If the generation number wrapped recompute everything.
9746 if (++Generation == 0) {
9747 for (auto &II : RewriteMap) {
9748 const SCEV *Rewritten = II.second.second;
9749 II.second = {Generation, SE.rewriteUsingPredicate(Rewritten, Preds)};