lib/Analysis/ScalarEvolution.cpp

   1 //===- ScalarEvolution.cpp - Scalar Evolution Analysis --------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  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.
  13 //
  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.
  19 //
  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.
  25 //
  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.
  30 //
  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.
  34 //
  35 // TODO: We should use these routines and value representations to implement
  36 // dependence analysis!
  37 //
  38 //===----------------------------------------------------------------------===//
  39 //
  40 // There are several good references for the techniques used in this analysis.
  41 //
  42 //  Chains of recurrences -- a method to expedite the evaluation
  43 //  of closed-form functions
  44 //  Olaf Bachmann, Paul S. Wang, Eugene V. Zima
  45 //
  46 //  On computational properties of chains of recurrences
  47 //  Eugene V. Zima
  48 //
  49 //  Symbolic Evaluation of Chains of Recurrences for Loop Optimization
  50 //  Robert A. van Engelen
  51 //
  52 //  Efficient Symbolic Analysis for Optimizing Compilers
  53 //  Robert A. van Engelen
  54 //
  55 //  Using the chains of recurrences algebra for data dependence testing and
  56 //  induction variable substitution
  57 //  MS Thesis, Johnie Birch
  58 //
  59 //===----------------------------------------------------------------------===//
  60
  61 #include "llvm/Analysis/ScalarEvolution.h"
  62 #include "llvm/ADT/APInt.h"
  63 #include "llvm/ADT/ArrayRef.h"
  64 #include "llvm/ADT/DenseMap.h"
  65 #include "llvm/ADT/DepthFirstIterator.h"
  66 #include "llvm/ADT/EquivalenceClasses.h"
  67 #include "llvm/ADT/FoldingSet.h"
  68 #include "llvm/ADT/None.h"
  69 #include "llvm/ADT/Optional.h"
  70 #include "llvm/ADT/STLExtras.h"
  71 #include "llvm/ADT/ScopeExit.h"
  72 #include "llvm/ADT/Sequence.h"
  73 #include "llvm/ADT/SetVector.h"
  74 #include "llvm/ADT/SmallPtrSet.h"
  75 #include "llvm/ADT/SmallSet.h"
  76 #include "llvm/ADT/SmallVector.h"
  77 #include "llvm/ADT/Statistic.h"
  78 #include "llvm/ADT/StringRef.h"
  79 #include "llvm/Analysis/AssumptionCache.h"
  80 #include "llvm/Analysis/ConstantFolding.h"
  81 #include "llvm/Analysis/InstructionSimplify.h"
  82 #include "llvm/Analysis/LoopInfo.h"
  83 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
  84 #include "llvm/Analysis/TargetLibraryInfo.h"
  85 #include "llvm/Analysis/ValueTracking.h"
  86 #include "llvm/IR/Argument.h"
  87 #include "llvm/IR/BasicBlock.h"
  88 #include "llvm/IR/CFG.h"
  89 #include "llvm/IR/CallSite.h"
  90 #include "llvm/IR/Constant.h"
  91 #include "llvm/IR/ConstantRange.h"
  92 #include "llvm/IR/Constants.h"
  93 #include "llvm/IR/DataLayout.h"
  94 #include "llvm/IR/DerivedTypes.h"
  95 #include "llvm/IR/Dominators.h"
  96 #include "llvm/IR/Function.h"
  97 #include "llvm/IR/GlobalAlias.h"
  98 #include "llvm/IR/GlobalValue.h"
  99 #include "llvm/IR/GlobalVariable.h"
 100 #include "llvm/IR/InstIterator.h"
 101 #include "llvm/IR/InstrTypes.h"
 102 #include "llvm/IR/Instruction.h"
 103 #include "llvm/IR/Instructions.h"
 104 #include "llvm/IR/IntrinsicInst.h"
 105 #include "llvm/IR/Intrinsics.h"
 106 #include "llvm/IR/LLVMContext.h"
 107 #include "llvm/IR/Metadata.h"
 108 #include "llvm/IR/Operator.h"
 109 #include "llvm/IR/PatternMatch.h"
 110 #include "llvm/IR/Type.h"
 111 #include "llvm/IR/Use.h"
 112 #include "llvm/IR/User.h"
 113 #include "llvm/IR/Value.h"
 114 #include "llvm/Pass.h"
 115 #include "llvm/Support/Casting.h"
 116 #include "llvm/Support/CommandLine.h"
 117 #include "llvm/Support/Compiler.h"
 118 #include "llvm/Support/Debug.h"
 119 #include "llvm/Support/ErrorHandling.h"
 120 #include "llvm/Support/KnownBits.h"
 121 #include "llvm/Support/SaveAndRestore.h"
 122 #include "llvm/Support/raw_ostream.h"
 123 #include <algorithm>
 124 #include <cassert>
 125 #include <climits>
 126 #include <cstddef>
 127 #include <cstdint>
 128 #include <cstdlib>
 129 #include <map>
 130 #include <memory>
 131 #include <tuple>
 132 #include <utility>
 133 #include <vector>
 134
 135 using namespace llvm;
 136
 137 #define DEBUG_TYPE "scalar-evolution"
 138
 139 STATISTIC(NumArrayLenItCounts,
 140           "Number of trip counts computed with array length");
 141 STATISTIC(NumTripCountsComputed,
 142           "Number of loops with predictable loop counts");
 143 STATISTIC(NumTripCountsNotComputed,
 144           "Number of loops without predictable loop counts");
 145 STATISTIC(NumBruteForceTripCountsComputed,
 146           "Number of loops with trip counts computed by force");
 147
 148 static cl::opt<unsigned>
 149 MaxBruteForceIterations("scalar-evolution-max-iterations", cl::ReallyHidden,
 150                         cl::desc("Maximum number of iterations SCEV will "
 151                                  "symbolically execute a constant "
 152                                  "derived loop"),
 153                         cl::init(100));
 154
 155 // FIXME: Enable this with EXPENSIVE_CHECKS when the test suite is clean.
 156 static cl::opt<bool> VerifySCEV(
 157     "verify-scev", cl::Hidden,
 158     cl::desc("Verify ScalarEvolution's backedge taken counts (slow)"));
 159 static cl::opt<bool>
 160     VerifySCEVMap("verify-scev-maps", cl::Hidden,
 161                   cl::desc("Verify no dangling value in ScalarEvolution's "
 162                            "ExprValueMap (slow)"));
 163
 164 static cl::opt<unsigned> MulOpsInlineThreshold(
 165     "scev-mulops-inline-threshold", cl::Hidden,
 166     cl::desc("Threshold for inlining multiplication operands into a SCEV"),
 167     cl::init(32));
 168
 169 static cl::opt<unsigned> AddOpsInlineThreshold(
 170     "scev-addops-inline-threshold", cl::Hidden,
 171     cl::desc("Threshold for inlining addition operands into a SCEV"),
 172     cl::init(500));
 173
 174 static cl::opt<unsigned> MaxSCEVCompareDepth(
 175     "scalar-evolution-max-scev-compare-depth", cl::Hidden,
 176     cl::desc("Maximum depth of recursive SCEV complexity comparisons"),
 177     cl::init(32));
 178
 179 static cl::opt<unsigned> MaxSCEVOperationsImplicationDepth(
 180     "scalar-evolution-max-scev-operations-implication-depth", cl::Hidden,
 181     cl::desc("Maximum depth of recursive SCEV operations implication analysis"),
 182     cl::init(2));
 183
 184 static cl::opt<unsigned> MaxValueCompareDepth(
 185     "scalar-evolution-max-value-compare-depth", cl::Hidden,
 186     cl::desc("Maximum depth of recursive value complexity comparisons"),
 187     cl::init(2));
 188
 189 static cl::opt<unsigned>
 190     MaxArithDepth("scalar-evolution-max-arith-depth", cl::Hidden,
 191                   cl::desc("Maximum depth of recursive arithmetics"),
 192                   cl::init(32));
 193
 194 static cl::opt<unsigned> MaxConstantEvolvingDepth(
 195     "scalar-evolution-max-constant-evolving-depth", cl::Hidden,
 196     cl::desc("Maximum depth of recursive constant evolving"), cl::init(32));
 197
 198 static cl::opt<unsigned>
 199     MaxExtDepth("scalar-evolution-max-ext-depth", cl::Hidden,
 200                 cl::desc("Maximum depth of recursive SExt/ZExt"),
 201                 cl::init(8));
 202
 203 static cl::opt<unsigned>
 204     MaxAddRecSize("scalar-evolution-max-add-rec-size", cl::Hidden,
 205                   cl::desc("Max coefficients in AddRec during evolving"),
 206                   cl::init(16));
 207
 208 //===----------------------------------------------------------------------===//
 209 //                           SCEV class definitions
 210 //===----------------------------------------------------------------------===//
 211
 212 //===----------------------------------------------------------------------===//
 213 // Implementation of the SCEV class.
 214 //
 215
 216 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 217 LLVM_DUMP_METHOD void SCEV::dump() const {
 218   print(dbgs());
 219   dbgs() << '\n';
 220 }
 221 #endif
 222
 223 void SCEV::print(raw_ostream &OS) const {
 224   switch (static_cast<SCEVTypes>(getSCEVType())) {
 225   case scConstant:
 226     cast<SCEVConstant>(this)->getValue()->printAsOperand(OS, false);
 227     return;
 228   case scTruncate: {
 229     const SCEVTruncateExpr *Trunc = cast<SCEVTruncateExpr>(this);
 230     const SCEV *Op = Trunc->getOperand();
 231     OS << "(trunc " << *Op->getType() << " " << *Op << " to "
 232        << *Trunc->getType() << ")";
 233     return;
 234   }
 235   case scZeroExtend: {
 236     const SCEVZeroExtendExpr *ZExt = cast<SCEVZeroExtendExpr>(this);
 237     const SCEV *Op = ZExt->getOperand();
 238     OS << "(zext " << *Op->getType() << " " << *Op << " to "
 239        << *ZExt->getType() << ")";
 240     return;
 241   }
 242   case scSignExtend: {
 243     const SCEVSignExtendExpr *SExt = cast<SCEVSignExtendExpr>(this);
 244     const SCEV *Op = SExt->getOperand();
 245     OS << "(sext " << *Op->getType() << " " << *Op << " to "
 246        << *SExt->getType() << ")";
 247     return;
 248   }
 249   case scAddRecExpr: {
 250     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(this);
 251     OS << "{" << *AR->getOperand(0);
 252     for (unsigned i = 1, e = AR->getNumOperands(); i != e; ++i)
 253       OS << ",+," << *AR->getOperand(i);
 254     OS << "}<";
 255     if (AR->hasNoUnsignedWrap())
 256       OS << "nuw><";
 257     if (AR->hasNoSignedWrap())
 258       OS << "nsw><";
 259     if (AR->hasNoSelfWrap() &&
 260         !AR->getNoWrapFlags((NoWrapFlags)(FlagNUW | FlagNSW)))
 261       OS << "nw><";
 262     AR->getLoop()->getHeader()->printAsOperand(OS, /*PrintType=*/false);
 263     OS << ">";
 264     return;
 265   }
 266   case scAddExpr:
 267   case scMulExpr:
 268   case scUMaxExpr:
 269   case scSMaxExpr: {
 270     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(this);
 271     const char *OpStr = nullptr;
 272     switch (NAry->getSCEVType()) {
 273     case scAddExpr: OpStr = " + "; break;
 274     case scMulExpr: OpStr = " * "; break;
 275     case scUMaxExpr: OpStr = " umax "; break;
 276     case scSMaxExpr: OpStr = " smax "; break;
 277     }
 278     OS << "(";
 279     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
 280          I != E; ++I) {
 281       OS << **I;
 282       if (std::next(I) != E)
 283         OS << OpStr;
 284     }
 285     OS << ")";
 286     switch (NAry->getSCEVType()) {
 287     case scAddExpr:
 288     case scMulExpr:
 289       if (NAry->hasNoUnsignedWrap())
 290         OS << "<nuw>";
 291       if (NAry->hasNoSignedWrap())
 292         OS << "<nsw>";
 293     }
 294     return;
 295   }
 296   case scUDivExpr: {
 297     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(this);
 298     OS << "(" << *UDiv->getLHS() << " /u " << *UDiv->getRHS() << ")";
 299     return;
 300   }
 301   case scUnknown: {
 302     const SCEVUnknown *U = cast<SCEVUnknown>(this);
 303     Type *AllocTy;
 304     if (U->isSizeOf(AllocTy)) {
 305       OS << "sizeof(" << *AllocTy << ")";
 306       return;
 307     }
 308     if (U->isAlignOf(AllocTy)) {
 309       OS << "alignof(" << *AllocTy << ")";
 310       return;
 311     }
 312
 313     Type *CTy;
 314     Constant *FieldNo;
 315     if (U->isOffsetOf(CTy, FieldNo)) {
 316       OS << "offsetof(" << *CTy << ", ";
 317       FieldNo->printAsOperand(OS, false);
 318       OS << ")";
 319       return;
 320     }
 321
 322     // Otherwise just print it normally.
 323     U->getValue()->printAsOperand(OS, false);
 324     return;
 325   }
 326   case scCouldNotCompute:
 327     OS << "***COULDNOTCOMPUTE***";
 328     return;
 329   }
 330   llvm_unreachable("Unknown SCEV kind!");
 331 }
 332
 333 Type *SCEV::getType() const {
 334   switch (static_cast<SCEVTypes>(getSCEVType())) {
 335   case scConstant:
 336     return cast<SCEVConstant>(this)->getType();
 337   case scTruncate:
 338   case scZeroExtend:
 339   case scSignExtend:
 340     return cast<SCEVCastExpr>(this)->getType();
 341   case scAddRecExpr:
 342   case scMulExpr:
 343   case scUMaxExpr:
 344   case scSMaxExpr:
 345     return cast<SCEVNAryExpr>(this)->getType();
 346   case scAddExpr:
 347     return cast<SCEVAddExpr>(this)->getType();
 348   case scUDivExpr:
 349     return cast<SCEVUDivExpr>(this)->getType();
 350   case scUnknown:
 351     return cast<SCEVUnknown>(this)->getType();
 352   case scCouldNotCompute:
 353     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
 354   }
 355   llvm_unreachable("Unknown SCEV kind!");
 356 }
 357
 358 bool SCEV::isZero() const {
 359   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
 360     return SC->getValue()->isZero();
 361   return false;
 362 }
 363
 364 bool SCEV::isOne() const {
 365   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
 366     return SC->getValue()->isOne();
 367   return false;
 368 }
 369
 370 bool SCEV::isAllOnesValue() const {
 371   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
 372     return SC->getValue()->isMinusOne();
 373   return false;
 374 }
 375
 376 bool SCEV::isNonConstantNegative() const {
 377   const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(this);
 378   if (!Mul) return false;
 379
 380   // If there is a constant factor, it will be first.
 381   const SCEVConstant *SC = dyn_cast<SCEVConstant>(Mul->getOperand(0));
 382   if (!SC) return false;
 383
 384   // Return true if the value is negative, this matches things like (-42 * V).
 385   return SC->getAPInt().isNegative();
 386 }
 387
 388 SCEVCouldNotCompute::SCEVCouldNotCompute() :
 389   SCEV(FoldingSetNodeIDRef(), scCouldNotCompute) {}
 390
 391 bool SCEVCouldNotCompute::classof(const SCEV *S) {
 392   return S->getSCEVType() == scCouldNotCompute;
 393 }
 394
 395 const SCEV *ScalarEvolution::getConstant(ConstantInt *V) {
 396   FoldingSetNodeID ID;
 397   ID.AddInteger(scConstant);
 398   ID.AddPointer(V);
 399   void *IP = nullptr;
 400   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
 401   SCEV *S = new (SCEVAllocator) SCEVConstant(ID.Intern(SCEVAllocator), V);
 402   UniqueSCEVs.InsertNode(S, IP);
 403   return S;
 404 }
 405
 406 const SCEV *ScalarEvolution::getConstant(const APInt &Val) {
 407   return getConstant(ConstantInt::get(getContext(), Val));
 408 }
 409
 410 const SCEV *
 411 ScalarEvolution::getConstant(Type *Ty, uint64_t V, bool isSigned) {
 412   IntegerType *ITy = cast<IntegerType>(getEffectiveSCEVType(Ty));
 413   return getConstant(ConstantInt::get(ITy, V, isSigned));
 414 }
 415
 416 SCEVCastExpr::SCEVCastExpr(const FoldingSetNodeIDRef ID,
 417                            unsigned SCEVTy, const SCEV *op, Type *ty)
 418   : SCEV(ID, SCEVTy), Op(op), Ty(ty) {}
 419
 420 SCEVTruncateExpr::SCEVTruncateExpr(const FoldingSetNodeIDRef ID,
 421                                    const SCEV *op, Type *ty)
 422   : SCEVCastExpr(ID, scTruncate, op, ty) {
 423   assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
 424          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
 425          "Cannot truncate non-integer value!");
 426 }
 427
 428 SCEVZeroExtendExpr::SCEVZeroExtendExpr(const FoldingSetNodeIDRef ID,
 429                                        const SCEV *op, Type *ty)
 430   : SCEVCastExpr(ID, scZeroExtend, op, ty) {
 431   assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
 432          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
 433          "Cannot zero extend non-integer value!");
 434 }
 435
 436 SCEVSignExtendExpr::SCEVSignExtendExpr(const FoldingSetNodeIDRef ID,
 437                                        const SCEV *op, Type *ty)
 438   : SCEVCastExpr(ID, scSignExtend, op, ty) {
 439   assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
 440          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
 441          "Cannot sign extend non-integer value!");
 442 }
 443
 444 void SCEVUnknown::deleted() {
 445   // Clear this SCEVUnknown from various maps.
 446   SE->forgetMemoizedResults(this);
 447
 448   // Remove this SCEVUnknown from the uniquing map.
 449   SE->UniqueSCEVs.RemoveNode(this);
 450
 451   // Release the value.
 452   setValPtr(nullptr);
 453 }
 454
 455 void SCEVUnknown::allUsesReplacedWith(Value *New) {
 456   // Remove this SCEVUnknown from the uniquing map.
 457   SE->UniqueSCEVs.RemoveNode(this);
 458
 459   // Update this SCEVUnknown to point to the new value. This is needed
 460   // because there may still be outstanding SCEVs which still point to
 461   // this SCEVUnknown.
 462   setValPtr(New);
 463 }
 464
 465 bool SCEVUnknown::isSizeOf(Type *&AllocTy) const {
 466   if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
 467     if (VCE->getOpcode() == Instruction::PtrToInt)
 468       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
 469         if (CE->getOpcode() == Instruction::GetElementPtr &&
 470             CE->getOperand(0)->isNullValue() &&
 471             CE->getNumOperands() == 2)
 472           if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(1)))
 473             if (CI->isOne()) {
 474               AllocTy = cast<PointerType>(CE->getOperand(0)->getType())
 475                                  ->getElementType();
 476               return true;
 477             }
 478
 479   return false;
 480 }
 481
 482 bool SCEVUnknown::isAlignOf(Type *&AllocTy) const {
 483   if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
 484     if (VCE->getOpcode() == Instruction::PtrToInt)
 485       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
 486         if (CE->getOpcode() == Instruction::GetElementPtr &&
 487             CE->getOperand(0)->isNullValue()) {
 488           Type *Ty =
 489             cast<PointerType>(CE->getOperand(0)->getType())->getElementType();
 490           if (StructType *STy = dyn_cast<StructType>(Ty))
 491             if (!STy->isPacked() &&
 492                 CE->getNumOperands() == 3 &&
 493                 CE->getOperand(1)->isNullValue()) {
 494               if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(2)))
 495                 if (CI->isOne() &&
 496                     STy->getNumElements() == 2 &&
 497                     STy->getElementType(0)->isIntegerTy(1)) {
 498                   AllocTy = STy->getElementType(1);
 499                   return true;
 500                 }
 501             }
 502         }
 503
 504   return false;
 505 }
 506
 507 bool SCEVUnknown::isOffsetOf(Type *&CTy, Constant *&FieldNo) const {
 508   if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
 509     if (VCE->getOpcode() == Instruction::PtrToInt)
 510       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
 511         if (CE->getOpcode() == Instruction::GetElementPtr &&
 512             CE->getNumOperands() == 3 &&
 513             CE->getOperand(0)->isNullValue() &&
 514             CE->getOperand(1)->isNullValue()) {
 515           Type *Ty =
 516             cast<PointerType>(CE->getOperand(0)->getType())->getElementType();
 517           // Ignore vector types here so that ScalarEvolutionExpander doesn't
 518           // emit getelementptrs that index into vectors.
 519           if (Ty->isStructTy() || Ty->isArrayTy()) {
 520             CTy = Ty;
 521             FieldNo = CE->getOperand(2);
 522             return true;
 523           }
 524         }
 525
 526   return false;
 527 }
 528
 529 //===----------------------------------------------------------------------===//
 530 //                               SCEV Utilities
 531 //===----------------------------------------------------------------------===//
 532
 533 /// Compare the two values \p LV and \p RV in terms of their "complexity" where
 534 /// "complexity" is a partial (and somewhat ad-hoc) relation used to order
 535 /// operands in SCEV expressions.  \p EqCache is a set of pairs of values that
 536 /// have been previously deemed to be "equally complex" by this routine.  It is
 537 /// intended to avoid exponential time complexity in cases like:
 538 ///
 539 ///   %a = f(%x, %y)
 540 ///   %b = f(%a, %a)
 541 ///   %c = f(%b, %b)
 542 ///
 543 ///   %d = f(%x, %y)
 544 ///   %e = f(%d, %d)
 545 ///   %f = f(%e, %e)
 546 ///
 547 ///   CompareValueComplexity(%f, %c)
 548 ///
 549 /// Since we do not continue running this routine on expression trees once we
 550 /// have seen unequal values, there is no need to track them in the cache.
 551 static int
 552 CompareValueComplexity(EquivalenceClasses<const Value *> &EqCacheValue,
 553                        const LoopInfo *const LI, Value *LV, Value *RV,
 554                        unsigned Depth) {
 555   if (Depth > MaxValueCompareDepth || EqCacheValue.isEquivalent(LV, RV))
 556     return 0;
 557
 558   // Order pointer values after integer values. This helps SCEVExpander form
 559   // GEPs.
 560   bool LIsPointer = LV->getType()->isPointerTy(),
 561        RIsPointer = RV->getType()->isPointerTy();
 562   if (LIsPointer != RIsPointer)
 563     return (int)LIsPointer - (int)RIsPointer;
 564
 565   // Compare getValueID values.
 566   unsigned LID = LV->getValueID(), RID = RV->getValueID();
 567   if (LID != RID)
 568     return (int)LID - (int)RID;
 569
 570   // Sort arguments by their position.
 571   if (const auto *LA = dyn_cast<Argument>(LV)) {
 572     const auto *RA = cast<Argument>(RV);
 573     unsigned LArgNo = LA->getArgNo(), RArgNo = RA->getArgNo();
 574     return (int)LArgNo - (int)RArgNo;
 575   }
 576
 577   if (const auto *LGV = dyn_cast<GlobalValue>(LV)) {
 578     const auto *RGV = cast<GlobalValue>(RV);
 579
 580     const auto IsGVNameSemantic = [&](const GlobalValue *GV) {
 581       auto LT = GV->getLinkage();
 582       return !(GlobalValue::isPrivateLinkage(LT) ||
 583                GlobalValue::isInternalLinkage(LT));
 584     };
 585
 586     // Use the names to distinguish the two values, but only if the
 587     // names are semantically important.
 588     if (IsGVNameSemantic(LGV) && IsGVNameSemantic(RGV))
 589       return LGV->getName().compare(RGV->getName());
 590   }
 591
 592   // For instructions, compare their loop depth, and their operand count.  This
 593   // is pretty loose.
 594   if (const auto *LInst = dyn_cast<Instruction>(LV)) {
 595     const auto *RInst = cast<Instruction>(RV);
 596
 597     // Compare loop depths.
 598     const BasicBlock *LParent = LInst->getParent(),
 599                      *RParent = RInst->getParent();
 600     if (LParent != RParent) {
 601       unsigned LDepth = LI->getLoopDepth(LParent),
 602                RDepth = LI->getLoopDepth(RParent);
 603       if (LDepth != RDepth)
 604         return (int)LDepth - (int)RDepth;
 605     }
 606
 607     // Compare the number of operands.
 608     unsigned LNumOps = LInst->getNumOperands(),
 609              RNumOps = RInst->getNumOperands();
 610     if (LNumOps != RNumOps)
 611       return (int)LNumOps - (int)RNumOps;
 612
 613     for (unsigned Idx : seq(0u, LNumOps)) {
 614       int Result =
 615           CompareValueComplexity(EqCacheValue, LI, LInst->getOperand(Idx),
 616                                  RInst->getOperand(Idx), Depth + 1);
 617       if (Result != 0)
 618         return Result;
 619     }
 620   }
 621
 622   EqCacheValue.unionSets(LV, RV);
 623   return 0;
 624 }
 625
 626 // Return negative, zero, or positive, if LHS is less than, equal to, or greater
 627 // than RHS, respectively. A three-way result allows recursive comparisons to be
 628 // more efficient.
 629 static int CompareSCEVComplexity(
 630     EquivalenceClasses<const SCEV *> &EqCacheSCEV,
 631     EquivalenceClasses<const Value *> &EqCacheValue,
 632     const LoopInfo *const LI, const SCEV *LHS, const SCEV *RHS,
 633     DominatorTree &DT, unsigned Depth = 0) {
 634   // Fast-path: SCEVs are uniqued so we can do a quick equality check.
 635   if (LHS == RHS)
 636     return 0;
 637
 638   // Primarily, sort the SCEVs by their getSCEVType().
 639   unsigned LType = LHS->getSCEVType(), RType = RHS->getSCEVType();
 640   if (LType != RType)
 641     return (int)LType - (int)RType;
 642
 643   if (Depth > MaxSCEVCompareDepth || EqCacheSCEV.isEquivalent(LHS, RHS))
 644     return 0;
 645   // Aside from the getSCEVType() ordering, the particular ordering
 646   // isn't very important except that it's beneficial to be consistent,
 647   // so that (a + b) and (b + a) don't end up as different expressions.
 648   switch (static_cast<SCEVTypes>(LType)) {
 649   case scUnknown: {
 650     const SCEVUnknown *LU = cast<SCEVUnknown>(LHS);
 651     const SCEVUnknown *RU = cast<SCEVUnknown>(RHS);
 652
 653     int X = CompareValueComplexity(EqCacheValue, LI, LU->getValue(),
 654                                    RU->getValue(), Depth + 1);
 655     if (X == 0)
 656       EqCacheSCEV.unionSets(LHS, RHS);
 657     return X;
 658   }
 659
 660   case scConstant: {
 661     const SCEVConstant *LC = cast<SCEVConstant>(LHS);
 662     const SCEVConstant *RC = cast<SCEVConstant>(RHS);
 663
 664     // Compare constant values.
 665     const APInt &LA = LC->getAPInt();
 666     const APInt &RA = RC->getAPInt();
 667     unsigned LBitWidth = LA.getBitWidth(), RBitWidth = RA.getBitWidth();
 668     if (LBitWidth != RBitWidth)
 669       return (int)LBitWidth - (int)RBitWidth;
 670     return LA.ult(RA) ? -1 : 1;
 671   }
 672
 673   case scAddRecExpr: {
 674     const SCEVAddRecExpr *LA = cast<SCEVAddRecExpr>(LHS);
 675     const SCEVAddRecExpr *RA = cast<SCEVAddRecExpr>(RHS);
 676
 677     // There is always a dominance between two recs that are used by one SCEV,
 678     // so we can safely sort recs by loop header dominance. We require such
 679     // order in getAddExpr.
 680     const Loop *LLoop = LA->getLoop(), *RLoop = RA->getLoop();
 681     if (LLoop != RLoop) {
 682       const BasicBlock *LHead = LLoop->getHeader(), *RHead = RLoop->getHeader();
 683       assert(LHead != RHead && "Two loops share the same header?");
 684       if (DT.dominates(LHead, RHead))
 685         return 1;
 686       else
 687         assert(DT.dominates(RHead, LHead) &&
 688                "No dominance between recurrences used by one SCEV?");
 689       return -1;
 690     }
 691
 692     // Addrec complexity grows with operand count.
 693     unsigned LNumOps = LA->getNumOperands(), RNumOps = RA->getNumOperands();
 694     if (LNumOps != RNumOps)
 695       return (int)LNumOps - (int)RNumOps;
 696
 697     // Compare NoWrap flags.
 698     if (LA->getNoWrapFlags() != RA->getNoWrapFlags())
 699       return (int)LA->getNoWrapFlags() - (int)RA->getNoWrapFlags();
 700
 701     // Lexicographically compare.
 702     for (unsigned i = 0; i != LNumOps; ++i) {
 703       int X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI,
 704                                     LA->getOperand(i), RA->getOperand(i), DT,
 705                                     Depth + 1);
 706       if (X != 0)
 707         return X;
 708     }
 709     EqCacheSCEV.unionSets(LHS, RHS);
 710     return 0;
 711   }
 712
 713   case scAddExpr:
 714   case scMulExpr:
 715   case scSMaxExpr:
 716   case scUMaxExpr: {
 717     const SCEVNAryExpr *LC = cast<SCEVNAryExpr>(LHS);
 718     const SCEVNAryExpr *RC = cast<SCEVNAryExpr>(RHS);
 719
 720     // Lexicographically compare n-ary expressions.
 721     unsigned LNumOps = LC->getNumOperands(), RNumOps = RC->getNumOperands();
 722     if (LNumOps != RNumOps)
 723       return (int)LNumOps - (int)RNumOps;
 724
 725     // Compare NoWrap flags.
 726     if (LC->getNoWrapFlags() != RC->getNoWrapFlags())
 727       return (int)LC->getNoWrapFlags() - (int)RC->getNoWrapFlags();
 728
 729     for (unsigned i = 0; i != LNumOps; ++i) {
 730       int X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI,
 731                                     LC->getOperand(i), RC->getOperand(i), DT,
 732                                     Depth + 1);
 733       if (X != 0)
 734         return X;
 735     }
 736     EqCacheSCEV.unionSets(LHS, RHS);
 737     return 0;
 738   }
 739
 740   case scUDivExpr: {
 741     const SCEVUDivExpr *LC = cast<SCEVUDivExpr>(LHS);
 742     const SCEVUDivExpr *RC = cast<SCEVUDivExpr>(RHS);
 743
 744     // Lexicographically compare udiv expressions.
 745     int X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, LC->getLHS(),
 746                                   RC->getLHS(), DT, Depth + 1);
 747     if (X != 0)
 748       return X;
 749     X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, LC->getRHS(),
 750                               RC->getRHS(), DT, Depth + 1);
 751     if (X == 0)
 752       EqCacheSCEV.unionSets(LHS, RHS);
 753     return X;
 754   }
 755
 756   case scTruncate:
 757   case scZeroExtend:
 758   case scSignExtend: {
 759     const SCEVCastExpr *LC = cast<SCEVCastExpr>(LHS);
 760     const SCEVCastExpr *RC = cast<SCEVCastExpr>(RHS);
 761
 762     // Compare cast expressions by operand.
 763     int X = CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI,
 764                                   LC->getOperand(), RC->getOperand(), DT,
 765                                   Depth + 1);
 766     if (X == 0)
 767       EqCacheSCEV.unionSets(LHS, RHS);
 768     return X;
 769   }
 770
 771   case scCouldNotCompute:
 772     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
 773   }
 774   llvm_unreachable("Unknown SCEV kind!");
 775 }
 776
 777 /// Given a list of SCEV objects, order them by their complexity, and group
 778 /// objects of the same complexity together by value.  When this routine is
 779 /// finished, we know that any duplicates in the vector are consecutive and that
 780 /// complexity is monotonically increasing.
 781 ///
 782 /// Note that we go take special precautions to ensure that we get deterministic
 783 /// results from this routine.  In other words, we don't want the results of
 784 /// this to depend on where the addresses of various SCEV objects happened to
 785 /// land in memory.
 786 static void GroupByComplexity(SmallVectorImpl<const SCEV *> &Ops,
 787                               LoopInfo *LI, DominatorTree &DT) {
 788   if (Ops.size() < 2) return;  // Noop
 789
 790   EquivalenceClasses<const SCEV *> EqCacheSCEV;
 791   EquivalenceClasses<const Value *> EqCacheValue;
 792   if (Ops.size() == 2) {
 793     // This is the common case, which also happens to be trivially simple.
 794     // Special case it.
 795     const SCEV *&LHS = Ops[0], *&RHS = Ops[1];
 796     if (CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI, RHS, LHS, DT) < 0)
 797       std::swap(LHS, RHS);
 798     return;
 799   }
 800
 801   // Do the rough sort by complexity.
 802   std::stable_sort(Ops.begin(), Ops.end(),
 803                    [&](const SCEV *LHS, const SCEV *RHS) {
 804                      return CompareSCEVComplexity(EqCacheSCEV, EqCacheValue, LI,
 805                                                   LHS, RHS, DT) < 0;
 806                    });
 807
 808   // Now that we are sorted by complexity, group elements of the same
 809   // complexity.  Note that this is, at worst, N^2, but the vector is likely to
 810   // be extremely short in practice.  Note that we take this approach because we
 811   // do not want to depend on the addresses of the objects we are grouping.
 812   for (unsigned i = 0, e = Ops.size(); i != e-2; ++i) {
 813     const SCEV *S = Ops[i];
 814     unsigned Complexity = S->getSCEVType();
 815
 816     // If there are any objects of the same complexity and same value as this
 817     // one, group them.
 818     for (unsigned j = i+1; j != e && Ops[j]->getSCEVType() == Complexity; ++j) {
 819       if (Ops[j] == S) { // Found a duplicate.
 820         // Move it to immediately after i'th element.
 821         std::swap(Ops[i+1], Ops[j]);
 822         ++i;   // no need to rescan it.
 823         if (i == e-2) return;  // Done!
 824       }
 825     }
 826   }
 827 }
 828
 829 // Returns the size of the SCEV S.
 830 static inline int sizeOfSCEV(const SCEV *S) {
 831   struct FindSCEVSize {
 832     int Size = 0;
 833
 834     FindSCEVSize() = default;
 835
 836     bool follow(const SCEV *S) {
 837       ++Size;
 838       // Keep looking at all operands of S.
 839       return true;
 840     }
 841
 842     bool isDone() const {
 843       return false;
 844     }
 845   };
 846
 847   FindSCEVSize F;
 848   SCEVTraversal<FindSCEVSize> ST(F);
 849   ST.visitAll(S);
 850   return F.Size;
 851 }
 852
 853 namespace {
 854
 855 struct SCEVDivision : public SCEVVisitor<SCEVDivision, void> {
 856 public:
 857   // Computes the Quotient and Remainder of the division of Numerator by
 858   // Denominator.
 859   static void divide(ScalarEvolution &SE, const SCEV *Numerator,
 860                      const SCEV *Denominator, const SCEV **Quotient,
 861                      const SCEV **Remainder) {
 862     assert(Numerator && Denominator && "Uninitialized SCEV");
 863
 864     SCEVDivision D(SE, Numerator, Denominator);
 865
 866     // Check for the trivial case here to avoid having to check for it in the
 867     // rest of the code.
 868     if (Numerator == Denominator) {
 869       *Quotient = D.One;
 870       *Remainder = D.Zero;
 871       return;
 872     }
 873
 874     if (Numerator->isZero()) {
 875       *Quotient = D.Zero;
 876       *Remainder = D.Zero;
 877       return;
 878     }
 879
 880     // A simple case when N/1. The quotient is N.
 881     if (Denominator->isOne()) {
 882       *Quotient = Numerator;
 883       *Remainder = D.Zero;
 884       return;
 885     }
 886
 887     // Split the Denominator when it is a product.
 888     if (const SCEVMulExpr *T = dyn_cast<SCEVMulExpr>(Denominator)) {
 889       const SCEV *Q, *R;
 890       *Quotient = Numerator;
 891       for (const SCEV *Op : T->operands()) {
 892         divide(SE, *Quotient, Op, &Q, &R);
 893         *Quotient = Q;
 894
 895         // Bail out when the Numerator is not divisible by one of the terms of
 896         // the Denominator.
 897         if (!R->isZero()) {
 898           *Quotient = D.Zero;
 899           *Remainder = Numerator;
 900           return;
 901         }
 902       }
 903       *Remainder = D.Zero;
 904       return;
 905     }
 906
 907     D.visit(Numerator);
 908     *Quotient = D.Quotient;
 909     *Remainder = D.Remainder;
 910   }
 911
 912   // Except in the trivial case described above, we do not know how to divide
 913   // Expr by Denominator for the following functions with empty implementation.
 914   void visitTruncateExpr(const SCEVTruncateExpr *Numerator) {}
 915   void visitZeroExtendExpr(const SCEVZeroExtendExpr *Numerator) {}
 916   void visitSignExtendExpr(const SCEVSignExtendExpr *Numerator) {}
 917   void visitUDivExpr(const SCEVUDivExpr *Numerator) {}
 918   void visitSMaxExpr(const SCEVSMaxExpr *Numerator) {}
 919   void visitUMaxExpr(const SCEVUMaxExpr *Numerator) {}
 920   void visitUnknown(const SCEVUnknown *Numerator) {}
 921   void visitCouldNotCompute(const SCEVCouldNotCompute *Numerator) {}
 922
 923   void visitConstant(const SCEVConstant *Numerator) {
 924     if (const SCEVConstant *D = dyn_cast<SCEVConstant>(Denominator)) {
 925       APInt NumeratorVal = Numerator->getAPInt();
 926       APInt DenominatorVal = D->getAPInt();
 927       uint32_t NumeratorBW = NumeratorVal.getBitWidth();
 928       uint32_t DenominatorBW = DenominatorVal.getBitWidth();
 929
 930       if (NumeratorBW > DenominatorBW)
 931         DenominatorVal = DenominatorVal.sext(NumeratorBW);
 932       else if (NumeratorBW < DenominatorBW)
 933         NumeratorVal = NumeratorVal.sext(DenominatorBW);
 934
 935       APInt QuotientVal(NumeratorVal.getBitWidth(), 0);
 936       APInt RemainderVal(NumeratorVal.getBitWidth(), 0);
 937       APInt::sdivrem(NumeratorVal, DenominatorVal, QuotientVal, RemainderVal);
 938       Quotient = SE.getConstant(QuotientVal);
 939       Remainder = SE.getConstant(RemainderVal);
 940       return;
 941     }
 942   }
 943
 944   void visitAddRecExpr(const SCEVAddRecExpr *Numerator) {
 945     const SCEV *StartQ, *StartR, *StepQ, *StepR;
 946     if (!Numerator->isAffine())
 947       return cannotDivide(Numerator);
 948     divide(SE, Numerator->getStart(), Denominator, &StartQ, &StartR);
 949     divide(SE, Numerator->getStepRecurrence(SE), Denominator, &StepQ, &StepR);
 950     // Bail out if the types do not match.
 951     Type *Ty = Denominator->getType();
 952     if (Ty != StartQ->getType() || Ty != StartR->getType() ||
 953         Ty != StepQ->getType() || Ty != StepR->getType())
 954       return cannotDivide(Numerator);
 955     Quotient = SE.getAddRecExpr(StartQ, StepQ, Numerator->getLoop(),
 956                                 Numerator->getNoWrapFlags());
 957     Remainder = SE.getAddRecExpr(StartR, StepR, Numerator->getLoop(),
 958                                  Numerator->getNoWrapFlags());
 959   }
 960
 961   void visitAddExpr(const SCEVAddExpr *Numerator) {
 962     SmallVector<const SCEV *, 2> Qs, Rs;
 963     Type *Ty = Denominator->getType();
 964
 965     for (const SCEV *Op : Numerator->operands()) {
 966       const SCEV *Q, *R;
 967       divide(SE, Op, Denominator, &Q, &R);
 968
 969       // Bail out if types do not match.
 970       if (Ty != Q->getType() || Ty != R->getType())
 971         return cannotDivide(Numerator);
 972
 973       Qs.push_back(Q);
 974       Rs.push_back(R);
 975     }
 976
 977     if (Qs.size() == 1) {
 978       Quotient = Qs[0];
 979       Remainder = Rs[0];
 980       return;
 981     }
 982
 983     Quotient = SE.getAddExpr(Qs);
 984     Remainder = SE.getAddExpr(Rs);
 985   }
 986
 987   void visitMulExpr(const SCEVMulExpr *Numerator) {
 988     SmallVector<const SCEV *, 2> Qs;
 989     Type *Ty = Denominator->getType();
 990
 991     bool FoundDenominatorTerm = false;
 992     for (const SCEV *Op : Numerator->operands()) {
 993       // Bail out if types do not match.
 994       if (Ty != Op->getType())
 995         return cannotDivide(Numerator);
 996
 997       if (FoundDenominatorTerm) {
 998         Qs.push_back(Op);
 999         continue;
1000       }
1001
1002       // Check whether Denominator divides one of the product operands.
1003       const SCEV *Q, *R;
1004       divide(SE, Op, Denominator, &Q, &R);
1005       if (!R->isZero()) {
1006         Qs.push_back(Op);
1007         continue;
1008       }
1009
1010       // Bail out if types do not match.
1011       if (Ty != Q->getType())
1012         return cannotDivide(Numerator);
1013
1014       FoundDenominatorTerm = true;
1015       Qs.push_back(Q);
1016     }
1017
1018     if (FoundDenominatorTerm) {
1019       Remainder = Zero;
1020       if (Qs.size() == 1)
1021         Quotient = Qs[0];
1022       else
1023         Quotient = SE.getMulExpr(Qs);
1024       return;
1025     }
1026
1027     if (!isa<SCEVUnknown>(Denominator))
1028       return cannotDivide(Numerator);
1029
1030     // The Remainder is obtained by replacing Denominator by 0 in Numerator.
1031     ValueToValueMap RewriteMap;
1032     RewriteMap[cast<SCEVUnknown>(Denominator)->getValue()] =
1033         cast<SCEVConstant>(Zero)->getValue();
1034     Remainder = SCEVParameterRewriter::rewrite(Numerator, SE, RewriteMap, true);
1035
1036     if (Remainder->isZero()) {
1037       // The Quotient is obtained by replacing Denominator by 1 in Numerator.
1038       RewriteMap[cast<SCEVUnknown>(Denominator)->getValue()] =
1039           cast<SCEVConstant>(One)->getValue();
1040       Quotient =
1041           SCEVParameterRewriter::rewrite(Numerator, SE, RewriteMap, true);
1042       return;
1043     }
1044
1045     // Quotient is (Numerator - Remainder) divided by Denominator.
1046     const SCEV *Q, *R;
1047     const SCEV *Diff = SE.getMinusSCEV(Numerator, Remainder);
1048     // This SCEV does not seem to simplify: fail the division here.
1049     if (sizeOfSCEV(Diff) > sizeOfSCEV(Numerator))
1050       return cannotDivide(Numerator);
1051     divide(SE, Diff, Denominator, &Q, &R);
1052     if (R != Zero)
1053       return cannotDivide(Numerator);
1054     Quotient = Q;
1055   }
1056
1057 private:
1058   SCEVDivision(ScalarEvolution &S, const SCEV *Numerator,
1059                const SCEV *Denominator)
1060       : SE(S), Denominator(Denominator) {
1061     Zero = SE.getZero(Denominator->getType());
1062     One = SE.getOne(Denominator->getType());
1063
1064     // We generally do not know how to divide Expr by Denominator. We
1065     // initialize the division to a "cannot divide" state to simplify the rest
1066     // of the code.
1067     cannotDivide(Numerator);
1068   }
1069
1070   // Convenience function for giving up on the division. We set the quotient to
1071   // be equal to zero and the remainder to be equal to the numerator.
1072   void cannotDivide(const SCEV *Numerator) {
1073     Quotient = Zero;
1074     Remainder = Numerator;
1075   }
1076
1077   ScalarEvolution &SE;
1078   const SCEV *Denominator, *Quotient, *Remainder, *Zero, *One;
1079 };
1080
1081 } // end anonymous namespace
1082
1083 //===----------------------------------------------------------------------===//
1084 //                      Simple SCEV method implementations
1085 //===----------------------------------------------------------------------===//
1086
1087 /// Compute BC(It, K).  The result has width W.  Assume, K > 0.
1088 static const SCEV *BinomialCoefficient(const SCEV *It, unsigned K,
1089                                        ScalarEvolution &SE,
1090                                        Type *ResultTy) {
1091   // Handle the simplest case efficiently.
1092   if (K == 1)
1093     return SE.getTruncateOrZeroExtend(It, ResultTy);
1094
1095   // We are using the following formula for BC(It, K):
1096   //
1097   //   BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / K!
1098   //
1099   // Suppose, W is the bitwidth of the return value.  We must be prepared for
1100   // overflow.  Hence, we must assure that the result of our computation is
1101   // equal to the accurate one modulo 2^W.  Unfortunately, division isn't
1102   // safe in modular arithmetic.
1103   //
1104   // However, this code doesn't use exactly that formula; the formula it uses
1105   // is something like the following, where T is the number of factors of 2 in
1106   // K! (i.e. trailing zeros in the binary representation of K!), and ^ is
1107   // exponentiation:
1108   //
1109   //   BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / 2^T / (K! / 2^T)
1110   //
1111   // This formula is trivially equivalent to the previous formula.  However,
1112   // this formula can be implemented much more efficiently.  The trick is that
1113   // K! / 2^T is odd, and exact division by an odd number *is* safe in modular
1114   // arithmetic.  To do exact division in modular arithmetic, all we have
1115   // to do is multiply by the inverse.  Therefore, this step can be done at
1116   // width W.
1117   //
1118   // The next issue is how to safely do the division by 2^T.  The way this
1119   // is done is by doing the multiplication step at a width of at least W + T
1120   // bits.  This way, the bottom W+T bits of the product are accurate. Then,
1121   // when we perform the division by 2^T (which is equivalent to a right shift
1122   // by T), the bottom W bits are accurate.  Extra bits are okay; they'll get
1123   // truncated out after the division by 2^T.
1124   //
1125   // In comparison to just directly using the first formula, this technique
1126   // is much more efficient; using the first formula requires W * K bits,
1127   // but this formula less than W + K bits. Also, the first formula requires
1128   // a division step, whereas this formula only requires multiplies and shifts.
1129   //
1130   // It doesn't matter whether the subtraction step is done in the calculation
1131   // width or the input iteration count's width; if the subtraction overflows,
1132   // the result must be zero anyway.  We prefer here to do it in the width of
1133   // the induction variable because it helps a lot for certain cases; CodeGen
1134   // isn't smart enough to ignore the overflow, which leads to much less
1135   // efficient code if the width of the subtraction is wider than the native
1136   // register width.
1137   //
1138   // (It's possible to not widen at all by pulling out factors of 2 before
1139   // the multiplication; for example, K=2 can be calculated as
1140   // It/2*(It+(It*INT_MIN/INT_MIN)+-1). However, it requires
1141   // extra arithmetic, so it's not an obvious win, and it gets
1142   // much more complicated for K > 3.)
1143
1144   // Protection from insane SCEVs; this bound is conservative,
1145   // but it probably doesn't matter.
1146   if (K > 1000)
1147     return SE.getCouldNotCompute();
1148
1149   unsigned W = SE.getTypeSizeInBits(ResultTy);
1150
1151   // Calculate K! / 2^T and T; we divide out the factors of two before
1152   // multiplying for calculating K! / 2^T to avoid overflow.
1153   // Other overflow doesn't matter because we only care about the bottom
1154   // W bits of the result.
1155   APInt OddFactorial(W, 1);
1156   unsigned T = 1;
1157   for (unsigned i = 3; i <= K; ++i) {
1158     APInt Mult(W, i);
1159     unsigned TwoFactors = Mult.countTrailingZeros();
1160     T += TwoFactors;
1161     Mult.lshrInPlace(TwoFactors);
1162     OddFactorial *= Mult;
1163   }
1164
1165   // We need at least W + T bits for the multiplication step
1166   unsigned CalculationBits = W + T;
1167
1168   // Calculate 2^T, at width T+W.
1169   APInt DivFactor = APInt::getOneBitSet(CalculationBits, T);
1170
1171   // Calculate the multiplicative inverse of K! / 2^T;
1172   // this multiplication factor will perform the exact division by
1173   // K! / 2^T.
1174   APInt Mod = APInt::getSignedMinValue(W+1);
1175   APInt MultiplyFactor = OddFactorial.zext(W+1);
1176   MultiplyFactor = MultiplyFactor.multiplicativeInverse(Mod);
1177   MultiplyFactor = MultiplyFactor.trunc(W);
1178
1179   // Calculate the product, at width T+W
1180   IntegerType *CalculationTy = IntegerType::get(SE.getContext(),
1181                                                       CalculationBits);
1182   const SCEV *Dividend = SE.getTruncateOrZeroExtend(It, CalculationTy);
1183   for (unsigned i = 1; i != K; ++i) {
1184     const SCEV *S = SE.getMinusSCEV(It, SE.getConstant(It->getType(), i));
1185     Dividend = SE.getMulExpr(Dividend,
1186                              SE.getTruncateOrZeroExtend(S, CalculationTy));
1187   }
1188
1189   // Divide by 2^T
1190   const SCEV *DivResult = SE.getUDivExpr(Dividend, SE.getConstant(DivFactor));
1191
1192   // Truncate the result, and divide by K! / 2^T.
1193
1194   return SE.getMulExpr(SE.getConstant(MultiplyFactor),
1195                        SE.getTruncateOrZeroExtend(DivResult, ResultTy));
1196 }
1197
1198 /// Return the value of this chain of recurrences at the specified iteration
1199 /// number.  We can evaluate this recurrence by multiplying each element in the
1200 /// chain by the binomial coefficient corresponding to it.  In other words, we
1201 /// can evaluate {A,+,B,+,C,+,D} as:
1202 ///
1203 ///   A*BC(It, 0) + B*BC(It, 1) + C*BC(It, 2) + D*BC(It, 3)
1204 ///
1205 /// where BC(It, k) stands for binomial coefficient.
1206 const SCEV *SCEVAddRecExpr::evaluateAtIteration(const SCEV *It,
1207                                                 ScalarEvolution &SE) const {
1208   const SCEV *Result = getStart();
1209   for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
1210     // The computation is correct in the face of overflow provided that the
1211     // multiplication is performed _after_ the evaluation of the binomial
1212     // coefficient.
1213     const SCEV *Coeff = BinomialCoefficient(It, i, SE, getType());
1214     if (isa<SCEVCouldNotCompute>(Coeff))
1215       return Coeff;
1216
1217     Result = SE.getAddExpr(Result, SE.getMulExpr(getOperand(i), Coeff));
1218   }
1219   return Result;
1220 }
1221
1222 //===----------------------------------------------------------------------===//
1223 //                    SCEV Expression folder implementations
1224 //===----------------------------------------------------------------------===//
1225
1226 const SCEV *ScalarEvolution::getTruncateExpr(const SCEV *Op,
1227                                              Type *Ty) {
1228   assert(getTypeSizeInBits(Op->getType()) > getTypeSizeInBits(Ty) &&
1229          "This is not a truncating conversion!");
1230   assert(isSCEVable(Ty) &&
1231          "This is not a conversion to a SCEVable type!");
1232   Ty = getEffectiveSCEVType(Ty);
1233
1234   FoldingSetNodeID ID;
1235   ID.AddInteger(scTruncate);
1236   ID.AddPointer(Op);
1237   ID.AddPointer(Ty);
1238   void *IP = nullptr;
1239   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1240
1241   // Fold if the operand is constant.
1242   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1243     return getConstant(
1244       cast<ConstantInt>(ConstantExpr::getTrunc(SC->getValue(), Ty)));
1245
1246   // trunc(trunc(x)) --> trunc(x)
1247   if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op))
1248     return getTruncateExpr(ST->getOperand(), Ty);
1249
1250   // trunc(sext(x)) --> sext(x) if widening or trunc(x) if narrowing
1251   if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op))
1252     return getTruncateOrSignExtend(SS->getOperand(), Ty);
1253
1254   // trunc(zext(x)) --> zext(x) if widening or trunc(x) if narrowing
1255   if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
1256     return getTruncateOrZeroExtend(SZ->getOperand(), Ty);
1257
1258   // trunc(x1+x2+...+xN) --> trunc(x1)+trunc(x2)+...+trunc(xN) if we can
1259   // eliminate all the truncates, or we replace other casts with truncates.
1260   if (const SCEVAddExpr *SA = dyn_cast<SCEVAddExpr>(Op)) {
1261     SmallVector<const SCEV *, 4> Operands;
1262     bool hasTrunc = false;
1263     for (unsigned i = 0, e = SA->getNumOperands(); i != e && !hasTrunc; ++i) {
1264       const SCEV *S = getTruncateExpr(SA->getOperand(i), Ty);
1265       if (!isa<SCEVCastExpr>(SA->getOperand(i)))
1266         hasTrunc = isa<SCEVTruncateExpr>(S);
1267       Operands.push_back(S);
1268     }
1269     if (!hasTrunc)
1270       return getAddExpr(Operands);
1271     UniqueSCEVs.FindNodeOrInsertPos(ID, IP);  // Mutates IP, returns NULL.
1272   }
1273
1274   // trunc(x1*x2*...*xN) --> trunc(x1)*trunc(x2)*...*trunc(xN) if we can
1275   // eliminate all the truncates, or we replace other casts with truncates.
1276   if (const SCEVMulExpr *SM = dyn_cast<SCEVMulExpr>(Op)) {
1277     SmallVector<const SCEV *, 4> Operands;
1278     bool hasTrunc = false;
1279     for (unsigned i = 0, e = SM->getNumOperands(); i != e && !hasTrunc; ++i) {
1280       const SCEV *S = getTruncateExpr(SM->getOperand(i), Ty);
1281       if (!isa<SCEVCastExpr>(SM->getOperand(i)))
1282         hasTrunc = isa<SCEVTruncateExpr>(S);
1283       Operands.push_back(S);
1284     }
1285     if (!hasTrunc)
1286       return getMulExpr(Operands);
1287     UniqueSCEVs.FindNodeOrInsertPos(ID, IP);  // Mutates IP, returns NULL.
1288   }
1289
1290   // If the input value is a chrec scev, truncate the chrec's operands.
1291   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(Op)) {
1292     SmallVector<const SCEV *, 4> Operands;
1293     for (const SCEV *Op : AddRec->operands())
1294       Operands.push_back(getTruncateExpr(Op, Ty));
1295     return getAddRecExpr(Operands, AddRec->getLoop(), SCEV::FlagAnyWrap);
1296   }
1297
1298   // The cast wasn't folded; create an explicit cast node. We can reuse
1299   // the existing insert position since if we get here, we won't have
1300   // made any changes which would invalidate it.
1301   SCEV *S = new (SCEVAllocator) SCEVTruncateExpr(ID.Intern(SCEVAllocator),
1302                                                  Op, Ty);
1303   UniqueSCEVs.InsertNode(S, IP);
1304   addToLoopUseLists(S);
1305   return S;
1306 }
1307
1308 // Get the limit of a recurrence such that incrementing by Step cannot cause
1309 // signed overflow as long as the value of the recurrence within the
1310 // loop does not exceed this limit before incrementing.
1311 static const SCEV *getSignedOverflowLimitForStep(const SCEV *Step,
1312                                                  ICmpInst::Predicate *Pred,
1313                                                  ScalarEvolution *SE) {
1314   unsigned BitWidth = SE->getTypeSizeInBits(Step->getType());
1315   if (SE->isKnownPositive(Step)) {
1316     *Pred = ICmpInst::ICMP_SLT;
1317     return SE->getConstant(APInt::getSignedMinValue(BitWidth) -
1318                            SE->getSignedRangeMax(Step));
1319   }
1320   if (SE->isKnownNegative(Step)) {
1321     *Pred = ICmpInst::ICMP_SGT;
1322     return SE->getConstant(APInt::getSignedMaxValue(BitWidth) -
1323                            SE->getSignedRangeMin(Step));
1324   }
1325   return nullptr;
1326 }
1327
1328 // Get the limit of a recurrence such that incrementing by Step cannot cause
1329 // unsigned overflow as long as the value of the recurrence within the loop does
1330 // not exceed this limit before incrementing.
1331 static const SCEV *getUnsignedOverflowLimitForStep(const SCEV *Step,
1332                                                    ICmpInst::Predicate *Pred,
1333                                                    ScalarEvolution *SE) {
1334   unsigned BitWidth = SE->getTypeSizeInBits(Step->getType());
1335   *Pred = ICmpInst::ICMP_ULT;
1336
1337   return SE->getConstant(APInt::getMinValue(BitWidth) -
1338                          SE->getUnsignedRangeMax(Step));
1339 }
1340
1341 namespace {
1342
1343 struct ExtendOpTraitsBase {
1344   typedef const SCEV *(ScalarEvolution::*GetExtendExprTy)(const SCEV *, Type *,
1345                                                           unsigned);
1346 };
1347
1348 // Used to make code generic over signed and unsigned overflow.
1349 template <typename ExtendOp> struct ExtendOpTraits {
1350   // Members present:
1351   //
1352   // static const SCEV::NoWrapFlags WrapType;
1353   //
1354   // static const ExtendOpTraitsBase::GetExtendExprTy GetExtendExpr;
1355   //
1356   // static const SCEV *getOverflowLimitForStep(const SCEV *Step,
1357   //                                           ICmpInst::Predicate *Pred,
1358   //                                           ScalarEvolution *SE);
1359 };
1360
1361 template <>
1362 struct ExtendOpTraits<SCEVSignExtendExpr> : public ExtendOpTraitsBase {
1363   static const SCEV::NoWrapFlags WrapType = SCEV::FlagNSW;
1364
1365   static const GetExtendExprTy GetExtendExpr;
1366
1367   static const SCEV *getOverflowLimitForStep(const SCEV *Step,
1368                                              ICmpInst::Predicate *Pred,
1369                                              ScalarEvolution *SE) {
1370     return getSignedOverflowLimitForStep(Step, Pred, SE);
1371   }
1372 };
1373
1374 const ExtendOpTraitsBase::GetExtendExprTy ExtendOpTraits<
1375     SCEVSignExtendExpr>::GetExtendExpr = &ScalarEvolution::getSignExtendExpr;
1376
1377 template <>
1378 struct ExtendOpTraits<SCEVZeroExtendExpr> : public ExtendOpTraitsBase {
1379   static const SCEV::NoWrapFlags WrapType = SCEV::FlagNUW;
1380
1381   static const GetExtendExprTy GetExtendExpr;
1382
1383   static const SCEV *getOverflowLimitForStep(const SCEV *Step,
1384                                              ICmpInst::Predicate *Pred,
1385                                              ScalarEvolution *SE) {
1386     return getUnsignedOverflowLimitForStep(Step, Pred, SE);
1387   }
1388 };
1389
1390 const ExtendOpTraitsBase::GetExtendExprTy ExtendOpTraits<
1391     SCEVZeroExtendExpr>::GetExtendExpr = &ScalarEvolution::getZeroExtendExpr;
1392
1393 } // end anonymous namespace
1394
1395 // The recurrence AR has been shown to have no signed/unsigned wrap or something
1396 // close to it. Typically, if we can prove NSW/NUW for AR, then we can just as
1397 // easily prove NSW/NUW for its preincrement or postincrement sibling. This
1398 // allows normalizing a sign/zero extended AddRec as such: {sext/zext(Step +
1399 // Start),+,Step} => {(Step + sext/zext(Start),+,Step} As a result, the
1400 // expression "Step + sext/zext(PreIncAR)" is congruent with
1401 // "sext/zext(PostIncAR)"
1402 template <typename ExtendOpTy>
1403 static const SCEV *getPreStartForExtend(const SCEVAddRecExpr *AR, Type *Ty,
1404                                         ScalarEvolution *SE, unsigned Depth) {
1405   auto WrapType = ExtendOpTraits<ExtendOpTy>::WrapType;
1406   auto GetExtendExpr = ExtendOpTraits<ExtendOpTy>::GetExtendExpr;
1407
1408   const Loop *L = AR->getLoop();
1409   const SCEV *Start = AR->getStart();
1410   const SCEV *Step = AR->getStepRecurrence(*SE);
1411
1412   // Check for a simple looking step prior to loop entry.
1413   const SCEVAddExpr *SA = dyn_cast<SCEVAddExpr>(Start);
1414   if (!SA)
1415     return nullptr;
1416
1417   // Create an AddExpr for "PreStart" after subtracting Step. Full SCEV
1418   // subtraction is expensive. For this purpose, perform a quick and dirty
1419   // difference, by checking for Step in the operand list.
1420   SmallVector<const SCEV *, 4> DiffOps;
1421   for (const SCEV *Op : SA->operands())
1422     if (Op != Step)
1423       DiffOps.push_back(Op);
1424
1425   if (DiffOps.size() == SA->getNumOperands())
1426     return nullptr;
1427
1428   // Try to prove `WrapType` (SCEV::FlagNSW or SCEV::FlagNUW) on `PreStart` +
1429   // `Step`:
1430
1431   // 1. NSW/NUW flags on the step increment.
1432   auto PreStartFlags =
1433     ScalarEvolution::maskFlags(SA->getNoWrapFlags(), SCEV::FlagNUW);
1434   const SCEV *PreStart = SE->getAddExpr(DiffOps, PreStartFlags);
1435   const SCEVAddRecExpr *PreAR = dyn_cast<SCEVAddRecExpr>(
1436       SE->getAddRecExpr(PreStart, Step, L, SCEV::FlagAnyWrap));
1437
1438   // "{S,+,X} is <nsw>/<nuw>" and "the backedge is taken at least once" implies
1439   // "S+X does not sign/unsign-overflow".
1440   //
1441
1442   const SCEV *BECount = SE->getBackedgeTakenCount(L);
1443   if (PreAR && PreAR->getNoWrapFlags(WrapType) &&
1444       !isa<SCEVCouldNotCompute>(BECount) && SE->isKnownPositive(BECount))
1445     return PreStart;
1446
1447   // 2. Direct overflow check on the step operation's expression.
1448   unsigned BitWidth = SE->getTypeSizeInBits(AR->getType());
1449   Type *WideTy = IntegerType::get(SE->getContext(), BitWidth * 2);
1450   const SCEV *OperandExtendedStart =
1451       SE->getAddExpr((SE->*GetExtendExpr)(PreStart, WideTy, Depth),
1452                      (SE->*GetExtendExpr)(Step, WideTy, Depth));
1453   if ((SE->*GetExtendExpr)(Start, WideTy, Depth) == OperandExtendedStart) {
1454     if (PreAR && AR->getNoWrapFlags(WrapType)) {
1455       // If we know `AR` == {`PreStart`+`Step`,+,`Step`} is `WrapType` (FlagNSW
1456       // or FlagNUW) and that `PreStart` + `Step` is `WrapType` too, then
1457       // `PreAR` == {`PreStart`,+,`Step`} is also `WrapType`.  Cache this fact.
1458       const_cast<SCEVAddRecExpr *>(PreAR)->setNoWrapFlags(WrapType);
1459     }
1460     return PreStart;
1461   }
1462
1463   // 3. Loop precondition.
1464   ICmpInst::Predicate Pred;
1465   const SCEV *OverflowLimit =
1466       ExtendOpTraits<ExtendOpTy>::getOverflowLimitForStep(Step, &Pred, SE);
1467
1468   if (OverflowLimit &&
1469       SE->isLoopEntryGuardedByCond(L, Pred, PreStart, OverflowLimit))
1470     return PreStart;
1471
1472   return nullptr;
1473 }
1474
1475 // Get the normalized zero or sign extended expression for this AddRec's Start.
1476 template <typename ExtendOpTy>
1477 static const SCEV *getExtendAddRecStart(const SCEVAddRecExpr *AR, Type *Ty,
1478                                         ScalarEvolution *SE,
1479                                         unsigned Depth) {
1480   auto GetExtendExpr = ExtendOpTraits<ExtendOpTy>::GetExtendExpr;
1481
1482   const SCEV *PreStart = getPreStartForExtend<ExtendOpTy>(AR, Ty, SE, Depth);
1483   if (!PreStart)
1484     return (SE->*GetExtendExpr)(AR->getStart(), Ty, Depth);
1485
1486   return SE->getAddExpr((SE->*GetExtendExpr)(AR->getStepRecurrence(*SE), Ty,
1487                                              Depth),
1488                         (SE->*GetExtendExpr)(PreStart, Ty, Depth));
1489 }
1490
1491 // Try to prove away overflow by looking at "nearby" add recurrences.  A
1492 // motivating example for this rule: if we know `{0,+,4}` is `ult` `-1` and it
1493 // does not itself wrap then we can conclude that `{1,+,4}` is `nuw`.
1494 //
1495 // Formally:
1496 //
1497 //     {S,+,X} == {S-T,+,X} + T
1498 //  => Ext({S,+,X}) == Ext({S-T,+,X} + T)
1499 //
1500 // If ({S-T,+,X} + T) does not overflow  ... (1)
1501 //
1502 //  RHS == Ext({S-T,+,X} + T) == Ext({S-T,+,X}) + Ext(T)
1503 //
1504 // If {S-T,+,X} does not overflow  ... (2)
1505 //
1506 //  RHS == Ext({S-T,+,X}) + Ext(T) == {Ext(S-T),+,Ext(X)} + Ext(T)
1507 //      == {Ext(S-T)+Ext(T),+,Ext(X)}
1508 //
1509 // If (S-T)+T does not overflow  ... (3)
1510 //
1511 //  RHS == {Ext(S-T)+Ext(T),+,Ext(X)} == {Ext(S-T+T),+,Ext(X)}
1512 //      == {Ext(S),+,Ext(X)} == LHS
1513 //
1514 // Thus, if (1), (2) and (3) are true for some T, then
1515 //   Ext({S,+,X}) == {Ext(S),+,Ext(X)}
1516 //
1517 // (3) is implied by (1) -- "(S-T)+T does not overflow" is simply "({S-T,+,X}+T)
1518 // does not overflow" restricted to the 0th iteration.  Therefore we only need
1519 // to check for (1) and (2).
1520 //
1521 // In the current context, S is `Start`, X is `Step`, Ext is `ExtendOpTy` and T
1522 // is `Delta` (defined below).
1523 template <typename ExtendOpTy>
1524 bool ScalarEvolution::proveNoWrapByVaryingStart(const SCEV *Start,
1525                                                 const SCEV *Step,
1526                                                 const Loop *L) {
1527   auto WrapType = ExtendOpTraits<ExtendOpTy>::WrapType;
1528
1529   // We restrict `Start` to a constant to prevent SCEV from spending too much
1530   // time here.  It is correct (but more expensive) to continue with a
1531   // non-constant `Start` and do a general SCEV subtraction to compute
1532   // `PreStart` below.
1533   const SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start);
1534   if (!StartC)
1535     return false;
1536
1537   APInt StartAI = StartC->getAPInt();
1538
1539   for (unsigned Delta : {-2, -1, 1, 2}) {
1540     const SCEV *PreStart = getConstant(StartAI - Delta);
1541
1542     FoldingSetNodeID ID;
1543     ID.AddInteger(scAddRecExpr);
1544     ID.AddPointer(PreStart);
1545     ID.AddPointer(Step);
1546     ID.AddPointer(L);
1547     void *IP = nullptr;
1548     const auto *PreAR =
1549       static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
1550
1551     // Give up if we don't already have the add recurrence we need because
1552     // actually constructing an add recurrence is relatively expensive.
1553     if (PreAR && PreAR->getNoWrapFlags(WrapType)) {  // proves (2)
1554       const SCEV *DeltaS = getConstant(StartC->getType(), Delta);
1555       ICmpInst::Predicate Pred = ICmpInst::BAD_ICMP_PREDICATE;
1556       const SCEV *Limit = ExtendOpTraits<ExtendOpTy>::getOverflowLimitForStep(
1557           DeltaS, &Pred, this);
1558       if (Limit && isKnownPredicate(Pred, PreAR, Limit))  // proves (1)
1559         return true;
1560     }
1561   }
1562
1563   return false;
1564 }
1565
1566 const SCEV *
1567 ScalarEvolution::getZeroExtendExpr(const SCEV *Op, Type *Ty, unsigned Depth) {
1568   assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
1569          "This is not an extending conversion!");
1570   assert(isSCEVable(Ty) &&
1571          "This is not a conversion to a SCEVable type!");
1572   Ty = getEffectiveSCEVType(Ty);
1573
1574   // Fold if the operand is constant.
1575   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1576     return getConstant(
1577       cast<ConstantInt>(ConstantExpr::getZExt(SC->getValue(), Ty)));
1578
1579   // zext(zext(x)) --> zext(x)
1580   if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
1581     return getZeroExtendExpr(SZ->getOperand(), Ty, Depth + 1);
1582
1583   // Before doing any expensive analysis, check to see if we've already
1584   // computed a SCEV for this Op and Ty.
1585   FoldingSetNodeID ID;
1586   ID.AddInteger(scZeroExtend);
1587   ID.AddPointer(Op);
1588   ID.AddPointer(Ty);
1589   void *IP = nullptr;
1590   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1591   if (Depth > MaxExtDepth) {
1592     SCEV *S = new (SCEVAllocator) SCEVZeroExtendExpr(ID.Intern(SCEVAllocator),
1593                                                      Op, Ty);
1594     UniqueSCEVs.InsertNode(S, IP);
1595     addToLoopUseLists(S);
1596     return S;
1597   }
1598
1599   // zext(trunc(x)) --> zext(x) or x or trunc(x)
1600   if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) {
1601     // It's possible the bits taken off by the truncate were all zero bits. If
1602     // so, we should be able to simplify this further.
1603     const SCEV *X = ST->getOperand();
1604     ConstantRange CR = getUnsignedRange(X);
1605     unsigned TruncBits = getTypeSizeInBits(ST->getType());
1606     unsigned NewBits = getTypeSizeInBits(Ty);
1607     if (CR.truncate(TruncBits).zeroExtend(NewBits).contains(
1608             CR.zextOrTrunc(NewBits)))
1609       return getTruncateOrZeroExtend(X, Ty);
1610   }
1611
1612   // If the input value is a chrec scev, and we can prove that the value
1613   // did not overflow the old, smaller, value, we can zero extend all of the
1614   // operands (often constants).  This allows analysis of something like
1615   // this:  for (unsigned char X = 0; X < 100; ++X) { int Y = X; }
1616   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op))
1617     if (AR->isAffine()) {
1618       const SCEV *Start = AR->getStart();
1619       const SCEV *Step = AR->getStepRecurrence(*this);
1620       unsigned BitWidth = getTypeSizeInBits(AR->getType());
1621       const Loop *L = AR->getLoop();
1622
1623       if (!AR->hasNoUnsignedWrap()) {
1624         auto NewFlags = proveNoWrapViaConstantRanges(AR);
1625         const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(NewFlags);
1626       }
1627
1628       // If we have special knowledge that this addrec won't overflow,
1629       // we don't need to do any further analysis.
1630       if (AR->hasNoUnsignedWrap())
1631         return getAddRecExpr(
1632             getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, Depth + 1),
1633             getZeroExtendExpr(Step, Ty, Depth + 1), L, AR->getNoWrapFlags());
1634
1635       // Check whether the backedge-taken count is SCEVCouldNotCompute.
1636       // Note that this serves two purposes: It filters out loops that are
1637       // simply not analyzable, and it covers the case where this code is
1638       // being called from within backedge-taken count analysis, such that
1639       // attempting to ask for the backedge-taken count would likely result
1640       // in infinite recursion. In the later case, the analysis code will
1641       // cope with a conservative value, and it will take care to purge
1642       // that value once it has finished.
1643       const SCEV *MaxBECount = getMaxBackedgeTakenCount(L);
1644       if (!isa<SCEVCouldNotCompute>(MaxBECount)) {
1645         // Manually compute the final value for AR, checking for
1646         // overflow.
1647
1648         // Check whether the backedge-taken count can be losslessly casted to
1649         // the addrec's type. The count is always unsigned.
1650         const SCEV *CastedMaxBECount =
1651           getTruncateOrZeroExtend(MaxBECount, Start->getType());
1652         const SCEV *RecastedMaxBECount =
1653           getTruncateOrZeroExtend(CastedMaxBECount, MaxBECount->getType());
1654         if (MaxBECount == RecastedMaxBECount) {
1655           Type *WideTy = IntegerType::get(getContext(), BitWidth * 2);
1656           // Check whether Start+Step*MaxBECount has no unsigned overflow.
1657           const SCEV *ZMul = getMulExpr(CastedMaxBECount, Step,
1658                                         SCEV::FlagAnyWrap, Depth + 1);
1659           const SCEV *ZAdd = getZeroExtendExpr(getAddExpr(Start, ZMul,
1660                                                           SCEV::FlagAnyWrap,
1661                                                           Depth + 1),
1662                                                WideTy, Depth + 1);
1663           const SCEV *WideStart = getZeroExtendExpr(Start, WideTy, Depth + 1);
1664           const SCEV *WideMaxBECount =
1665             getZeroExtendExpr(CastedMaxBECount, WideTy, Depth + 1);
1666           const SCEV *OperandExtendedAdd =
1667             getAddExpr(WideStart,
1668                        getMulExpr(WideMaxBECount,
1669                                   getZeroExtendExpr(Step, WideTy, Depth + 1),
1670                                   SCEV::FlagAnyWrap, Depth + 1),
1671                        SCEV::FlagAnyWrap, Depth + 1);
1672           if (ZAdd == OperandExtendedAdd) {
1673             // Cache knowledge of AR NUW, which is propagated to this AddRec.
1674             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNUW);
1675             // Return the expression with the addrec on the outside.
1676             return getAddRecExpr(
1677                 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this,
1678                                                          Depth + 1),
1679                 getZeroExtendExpr(Step, Ty, Depth + 1), L,
1680                 AR->getNoWrapFlags());
1681           }
1682           // Similar to above, only this time treat the step value as signed.
1683           // This covers loops that count down.
1684           OperandExtendedAdd =
1685             getAddExpr(WideStart,
1686                        getMulExpr(WideMaxBECount,
1687                                   getSignExtendExpr(Step, WideTy, Depth + 1),
1688                                   SCEV::FlagAnyWrap, Depth + 1),
1689                        SCEV::FlagAnyWrap, Depth + 1);
1690           if (ZAdd == OperandExtendedAdd) {
1691             // Cache knowledge of AR NW, which is propagated to this AddRec.
1692             // Negative step causes unsigned wrap, but it still can't self-wrap.
1693             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNW);
1694             // Return the expression with the addrec on the outside.
1695             return getAddRecExpr(
1696                 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this,
1697                                                          Depth + 1),
1698                 getSignExtendExpr(Step, Ty, Depth + 1), L,
1699                 AR->getNoWrapFlags());
1700           }
1701         }
1702       }
1703
1704       // Normally, in the cases we can prove no-overflow via a
1705       // backedge guarding condition, we can also compute a backedge
1706       // taken count for the loop.  The exceptions are assumptions and
1707       // guards present in the loop -- SCEV is not great at exploiting
1708       // these to compute max backedge taken counts, but can still use
1709       // these to prove lack of overflow.  Use this fact to avoid
1710       // doing extra work that may not pay off.
1711       if (!isa<SCEVCouldNotCompute>(MaxBECount) || HasGuards ||
1712           !AC.assumptions().empty()) {
1713         // If the backedge is guarded by a comparison with the pre-inc
1714         // value the addrec is safe. Also, if the entry is guarded by
1715         // a comparison with the start value and the backedge is
1716         // guarded by a comparison with the post-inc value, the addrec
1717         // is safe.
1718         if (isKnownPositive(Step)) {
1719           const SCEV *N = getConstant(APInt::getMinValue(BitWidth) -
1720                                       getUnsignedRangeMax(Step));
1721           if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT, AR, N) ||
1722               (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_ULT, Start, N) &&
1723                isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT,
1724                                            AR->getPostIncExpr(*this), N))) {
1725             // Cache knowledge of AR NUW, which is propagated to this
1726             // AddRec.
1727             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNUW);
1728             // Return the expression with the addrec on the outside.
1729             return getAddRecExpr(
1730                 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this,
1731                                                          Depth + 1),
1732                 getZeroExtendExpr(Step, Ty, Depth + 1), L,
1733                 AR->getNoWrapFlags());
1734           }
1735         } else if (isKnownNegative(Step)) {
1736           const SCEV *N = getConstant(APInt::getMaxValue(BitWidth) -
1737                                       getSignedRangeMin(Step));
1738           if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT, AR, N) ||
1739               (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_UGT, Start, N) &&
1740                isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT,
1741                                            AR->getPostIncExpr(*this), N))) {
1742             // Cache knowledge of AR NW, which is propagated to this
1743             // AddRec.  Negative step causes unsigned wrap, but it
1744             // still can't self-wrap.
1745             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNW);
1746             // Return the expression with the addrec on the outside.
1747             return getAddRecExpr(
1748                 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this,
1749                                                          Depth + 1),
1750                 getSignExtendExpr(Step, Ty, Depth + 1), L,
1751                 AR->getNoWrapFlags());
1752           }
1753         }
1754       }
1755
1756       if (proveNoWrapByVaryingStart<SCEVZeroExtendExpr>(Start, Step, L)) {
1757         const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNUW);
1758         return getAddRecExpr(
1759             getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this, Depth + 1),
1760             getZeroExtendExpr(Step, Ty, Depth + 1), L, AR->getNoWrapFlags());
1761       }
1762     }
1763
1764   if (auto *SA = dyn_cast<SCEVAddExpr>(Op)) {
1765     // zext((A + B + ...)<nuw>) --> (zext(A) + zext(B) + ...)<nuw>
1766     if (SA->hasNoUnsignedWrap()) {
1767       // If the addition does not unsign overflow then we can, by definition,
1768       // commute the zero extension with the addition operation.
1769       SmallVector<const SCEV *, 4> Ops;
1770       for (const auto *Op : SA->operands())
1771         Ops.push_back(getZeroExtendExpr(Op, Ty, Depth + 1));
1772       return getAddExpr(Ops, SCEV::FlagNUW, Depth + 1);
1773     }
1774   }
1775
1776   // The cast wasn't folded; create an explicit cast node.
1777   // Recompute the insert position, as it may have been invalidated.
1778   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1779   SCEV *S = new (SCEVAllocator) SCEVZeroExtendExpr(ID.Intern(SCEVAllocator),
1780                                                    Op, Ty);
1781   UniqueSCEVs.InsertNode(S, IP);
1782   addToLoopUseLists(S);
1783   return S;
1784 }
1785
1786 const SCEV *
1787 ScalarEvolution::getSignExtendExpr(const SCEV *Op, Type *Ty, unsigned Depth) {
1788   assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
1789          "This is not an extending conversion!");
1790   assert(isSCEVable(Ty) &&
1791          "This is not a conversion to a SCEVable type!");
1792   Ty = getEffectiveSCEVType(Ty);
1793
1794   // Fold if the operand is constant.
1795   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1796     return getConstant(
1797       cast<ConstantInt>(ConstantExpr::getSExt(SC->getValue(), Ty)));
1798
1799   // sext(sext(x)) --> sext(x)
1800   if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op))
1801     return getSignExtendExpr(SS->getOperand(), Ty, Depth + 1);
1802
1803   // sext(zext(x)) --> zext(x)
1804   if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
1805     return getZeroExtendExpr(SZ->getOperand(), Ty, Depth + 1);
1806
1807   // Before doing any expensive analysis, check to see if we've already
1808   // computed a SCEV for this Op and Ty.
1809   FoldingSetNodeID ID;
1810   ID.AddInteger(scSignExtend);
1811   ID.AddPointer(Op);
1812   ID.AddPointer(Ty);
1813   void *IP = nullptr;
1814   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1815   // Limit recursion depth.
1816   if (Depth > MaxExtDepth) {
1817     SCEV *S = new (SCEVAllocator) SCEVSignExtendExpr(ID.Intern(SCEVAllocator),
1818                                                      Op, Ty);
1819     UniqueSCEVs.InsertNode(S, IP);
1820     addToLoopUseLists(S);
1821     return S;
1822   }
1823
1824   // sext(trunc(x)) --> sext(x) or x or trunc(x)
1825   if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) {
1826     // It's possible the bits taken off by the truncate were all sign bits. If
1827     // so, we should be able to simplify this further.
1828     const SCEV *X = ST->getOperand();
1829     ConstantRange CR = getSignedRange(X);
1830     unsigned TruncBits = getTypeSizeInBits(ST->getType());
1831     unsigned NewBits = getTypeSizeInBits(Ty);
1832     if (CR.truncate(TruncBits).signExtend(NewBits).contains(
1833             CR.sextOrTrunc(NewBits)))
1834       return getTruncateOrSignExtend(X, Ty);
1835   }
1836
1837   // sext(C1 + (C2 * x)) --> C1 + sext(C2 * x) if C1 < C2
1838   if (auto *SA = dyn_cast<SCEVAddExpr>(Op)) {
1839     if (SA->getNumOperands() == 2) {
1840       auto *SC1 = dyn_cast<SCEVConstant>(SA->getOperand(0));
1841       auto *SMul = dyn_cast<SCEVMulExpr>(SA->getOperand(1));
1842       if (SMul && SC1) {
1843         if (auto *SC2 = dyn_cast<SCEVConstant>(SMul->getOperand(0))) {
1844           const APInt &C1 = SC1->getAPInt();
1845           const APInt &C2 = SC2->getAPInt();
1846           if (C1.isStrictlyPositive() && C2.isStrictlyPositive() &&
1847               C2.ugt(C1) && C2.isPowerOf2())
1848             return getAddExpr(getSignExtendExpr(SC1, Ty, Depth + 1),
1849                               getSignExtendExpr(SMul, Ty, Depth + 1),
1850                               SCEV::FlagAnyWrap, Depth + 1);
1851         }
1852       }
1853     }
1854
1855     // sext((A + B + ...)<nsw>) --> (sext(A) + sext(B) + ...)<nsw>
1856     if (SA->hasNoSignedWrap()) {
1857       // If the addition does not sign overflow then we can, by definition,
1858       // commute the sign extension with the addition operation.
1859       SmallVector<const SCEV *, 4> Ops;
1860       for (const auto *Op : SA->operands())
1861         Ops.push_back(getSignExtendExpr(Op, Ty, Depth + 1));
1862       return getAddExpr(Ops, SCEV::FlagNSW, Depth + 1);
1863     }
1864   }
1865   // If the input value is a chrec scev, and we can prove that the value
1866   // did not overflow the old, smaller, value, we can sign extend all of the
1867   // operands (often constants).  This allows analysis of something like
1868   // this:  for (signed char X = 0; X < 100; ++X) { int Y = X; }
1869   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op))
1870     if (AR->isAffine()) {
1871       const SCEV *Start = AR->getStart();
1872       const SCEV *Step = AR->getStepRecurrence(*this);
1873       unsigned BitWidth = getTypeSizeInBits(AR->getType());
1874       const Loop *L = AR->getLoop();
1875
1876       if (!AR->hasNoSignedWrap()) {
1877         auto NewFlags = proveNoWrapViaConstantRanges(AR);
1878         const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(NewFlags);
1879       }
1880
1881       // If we have special knowledge that this addrec won't overflow,
1882       // we don't need to do any further analysis.
1883       if (AR->hasNoSignedWrap())
1884         return getAddRecExpr(
1885             getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, Depth + 1),
1886             getSignExtendExpr(Step, Ty, Depth + 1), L, SCEV::FlagNSW);
1887
1888       // Check whether the backedge-taken count is SCEVCouldNotCompute.
1889       // Note that this serves two purposes: It filters out loops that are
1890       // simply not analyzable, and it covers the case where this code is
1891       // being called from within backedge-taken count analysis, such that
1892       // attempting to ask for the backedge-taken count would likely result
1893       // in infinite recursion. In the later case, the analysis code will
1894       // cope with a conservative value, and it will take care to purge
1895       // that value once it has finished.
1896       const SCEV *MaxBECount = getMaxBackedgeTakenCount(L);
1897       if (!isa<SCEVCouldNotCompute>(MaxBECount)) {
1898         // Manually compute the final value for AR, checking for
1899         // overflow.
1900
1901         // Check whether the backedge-taken count can be losslessly casted to
1902         // the addrec's type. The count is always unsigned.
1903         const SCEV *CastedMaxBECount =
1904           getTruncateOrZeroExtend(MaxBECount, Start->getType());
1905         const SCEV *RecastedMaxBECount =
1906           getTruncateOrZeroExtend(CastedMaxBECount, MaxBECount->getType());
1907         if (MaxBECount == RecastedMaxBECount) {
1908           Type *WideTy = IntegerType::get(getContext(), BitWidth * 2);
1909           // Check whether Start+Step*MaxBECount has no signed overflow.
1910           const SCEV *SMul = getMulExpr(CastedMaxBECount, Step,
1911                                         SCEV::FlagAnyWrap, Depth + 1);
1912           const SCEV *SAdd = getSignExtendExpr(getAddExpr(Start, SMul,
1913                                                           SCEV::FlagAnyWrap,
1914                                                           Depth + 1),
1915                                                WideTy, Depth + 1);
1916           const SCEV *WideStart = getSignExtendExpr(Start, WideTy, Depth + 1);
1917           const SCEV *WideMaxBECount =
1918             getZeroExtendExpr(CastedMaxBECount, WideTy, Depth + 1);
1919           const SCEV *OperandExtendedAdd =
1920             getAddExpr(WideStart,
1921                        getMulExpr(WideMaxBECount,
1922                                   getSignExtendExpr(Step, WideTy, Depth + 1),
1923                                   SCEV::FlagAnyWrap, Depth + 1),
1924                        SCEV::FlagAnyWrap, Depth + 1);
1925           if (SAdd == OperandExtendedAdd) {
1926             // Cache knowledge of AR NSW, which is propagated to this AddRec.
1927             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNSW);
1928             // Return the expression with the addrec on the outside.
1929             return getAddRecExpr(
1930                 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this,
1931                                                          Depth + 1),
1932                 getSignExtendExpr(Step, Ty, Depth + 1), L,
1933                 AR->getNoWrapFlags());
1934           }
1935           // Similar to above, only this time treat the step value as unsigned.
1936           // This covers loops that count up with an unsigned step.
1937           OperandExtendedAdd =
1938             getAddExpr(WideStart,
1939                        getMulExpr(WideMaxBECount,
1940                                   getZeroExtendExpr(Step, WideTy, Depth + 1),
1941                                   SCEV::FlagAnyWrap, Depth + 1),
1942                        SCEV::FlagAnyWrap, Depth + 1);
1943           if (SAdd == OperandExtendedAdd) {
1944             // If AR wraps around then
1945             //
1946             //    abs(Step) * MaxBECount > unsigned-max(AR->getType())
1947             // => SAdd != OperandExtendedAdd
1948             //
1949             // Thus (AR is not NW => SAdd != OperandExtendedAdd) <=>
1950             // (SAdd == OperandExtendedAdd => AR is NW)
1951
1952             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNW);
1953
1954             // Return the expression with the addrec on the outside.
1955             return getAddRecExpr(
1956                 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this,
1957                                                          Depth + 1),
1958                 getZeroExtendExpr(Step, Ty, Depth + 1), L,
1959                 AR->getNoWrapFlags());
1960           }
1961         }
1962       }
1963
1964       // Normally, in the cases we can prove no-overflow via a
1965       // backedge guarding condition, we can also compute a backedge
1966       // taken count for the loop.  The exceptions are assumptions and
1967       // guards present in the loop -- SCEV is not great at exploiting
1968       // these to compute max backedge taken counts, but can still use
1969       // these to prove lack of overflow.  Use this fact to avoid
1970       // doing extra work that may not pay off.
1971
1972       if (!isa<SCEVCouldNotCompute>(MaxBECount) || HasGuards ||
1973           !AC.assumptions().empty()) {
1974         // If the backedge is guarded by a comparison with the pre-inc
1975         // value the addrec is safe. Also, if the entry is guarded by
1976         // a comparison with the start value and the backedge is
1977         // guarded by a comparison with the post-inc value, the addrec
1978         // is safe.
1979         ICmpInst::Predicate Pred;
1980         const SCEV *OverflowLimit =
1981             getSignedOverflowLimitForStep(Step, &Pred, this);
1982         if (OverflowLimit &&
1983             (isLoopBackedgeGuardedByCond(L, Pred, AR, OverflowLimit) ||
1984              (isLoopEntryGuardedByCond(L, Pred, Start, OverflowLimit) &&
1985               isLoopBackedgeGuardedByCond(L, Pred, AR->getPostIncExpr(*this),
1986                                           OverflowLimit)))) {
1987           // Cache knowledge of AR NSW, then propagate NSW to the wide AddRec.
1988           const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNSW);
1989           return getAddRecExpr(
1990               getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, Depth + 1),
1991               getSignExtendExpr(Step, Ty, Depth + 1), L, AR->getNoWrapFlags());
1992         }
1993       }
1994
1995       // If Start and Step are constants, check if we can apply this
1996       // transformation:
1997       // sext{C1,+,C2} --> C1 + sext{0,+,C2} if C1 < C2
1998       auto *SC1 = dyn_cast<SCEVConstant>(Start);
1999       auto *SC2 = dyn_cast<SCEVConstant>(Step);
2000       if (SC1 && SC2) {
2001         const APInt &C1 = SC1->getAPInt();
2002         const APInt &C2 = SC2->getAPInt();
2003         if (C1.isStrictlyPositive() && C2.isStrictlyPositive() && C2.ugt(C1) &&
2004             C2.isPowerOf2()) {
2005           Start = getSignExtendExpr(Start, Ty, Depth + 1);
2006           const SCEV *NewAR = getAddRecExpr(getZero(AR->getType()), Step, L,
2007                                             AR->getNoWrapFlags());
2008           return getAddExpr(Start, getSignExtendExpr(NewAR, Ty, Depth + 1),
2009                             SCEV::FlagAnyWrap, Depth + 1);
2010         }
2011       }
2012
2013       if (proveNoWrapByVaryingStart<SCEVSignExtendExpr>(Start, Step, L)) {
2014         const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNSW);
2015         return getAddRecExpr(
2016             getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this, Depth + 1),
2017             getSignExtendExpr(Step, Ty, Depth + 1), L, AR->getNoWrapFlags());
2018       }
2019     }
2020
2021   // If the input value is provably positive and we could not simplify
2022   // away the sext build a zext instead.
2023   if (isKnownNonNegative(Op))
2024     return getZeroExtendExpr(Op, Ty, Depth + 1);
2025
2026   // The cast wasn't folded; create an explicit cast node.
2027   // Recompute the insert position, as it may have been invalidated.
2028   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
2029   SCEV *S = new (SCEVAllocator) SCEVSignExtendExpr(ID.Intern(SCEVAllocator),
2030                                                    Op, Ty);
2031   UniqueSCEVs.InsertNode(S, IP);
2032   addToLoopUseLists(S);
2033   return S;
2034 }
2035
2036 /// getAnyExtendExpr - Return a SCEV for the given operand extended with
2037 /// unspecified bits out to the given type.
2038 const SCEV *ScalarEvolution::getAnyExtendExpr(const SCEV *Op,
2039                                               Type *Ty) {
2040   assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
2041          "This is not an extending conversion!");
2042   assert(isSCEVable(Ty) &&
2043          "This is not a conversion to a SCEVable type!");
2044   Ty = getEffectiveSCEVType(Ty);
2045
2046   // Sign-extend negative constants.
2047   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
2048     if (SC->getAPInt().isNegative())
2049       return getSignExtendExpr(Op, Ty);
2050
2051   // Peel off a truncate cast.
2052   if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Op)) {
2053     const SCEV *NewOp = T->getOperand();
2054     if (getTypeSizeInBits(NewOp->getType()) < getTypeSizeInBits(Ty))
2055       return getAnyExtendExpr(NewOp, Ty);
2056     return getTruncateOrNoop(NewOp, Ty);
2057   }
2058
2059   // Next try a zext cast. If the cast is folded, use it.
2060   const SCEV *ZExt = getZeroExtendExpr(Op, Ty);
2061   if (!isa<SCEVZeroExtendExpr>(ZExt))
2062     return ZExt;
2063
2064   // Next try a sext cast. If the cast is folded, use it.
2065   const SCEV *SExt = getSignExtendExpr(Op, Ty);
2066   if (!isa<SCEVSignExtendExpr>(SExt))
2067     return SExt;
2068
2069   // Force the cast to be folded into the operands of an addrec.
2070   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op)) {
2071     SmallVector<const SCEV *, 4> Ops;
2072     for (const SCEV *Op : AR->operands())
2073       Ops.push_back(getAnyExtendExpr(Op, Ty));
2074     return getAddRecExpr(Ops, AR->getLoop(), SCEV::FlagNW);
2075   }
2076
2077   // If the expression is obviously signed, use the sext cast value.
2078   if (isa<SCEVSMaxExpr>(Op))
2079     return SExt;
2080
2081   // Absent any other information, use the zext cast value.
2082   return ZExt;
2083 }
2084
2085 /// Process the given Ops list, which is a list of operands to be added under
2086 /// the given scale, update the given map. This is a helper function for
2087 /// getAddRecExpr. As an example of what it does, given a sequence of operands
2088 /// that would form an add expression like this:
2089 ///
2090 ///    m + n + 13 + (A * (o + p + (B * (q + m + 29)))) + r + (-1 * r)
2091 ///
2092 /// where A and B are constants, update the map with these values:
2093 ///
2094 ///    (m, 1+A*B), (n, 1), (o, A), (p, A), (q, A*B), (r, 0)
2095 ///
2096 /// and add 13 + A*B*29 to AccumulatedConstant.
2097 /// This will allow getAddRecExpr to produce this:
2098 ///
2099 ///    13+A*B*29 + n + (m * (1+A*B)) + ((o + p) * A) + (q * A*B)
2100 ///
2101 /// This form often exposes folding opportunities that are hidden in
2102 /// the original operand list.
2103 ///
2104 /// Return true iff it appears that any interesting folding opportunities
2105 /// may be exposed. This helps getAddRecExpr short-circuit extra work in
2106 /// the common case where no interesting opportunities are present, and
2107 /// is also used as a check to avoid infinite recursion.
2108 static bool
2109 CollectAddOperandsWithScales(DenseMap<const SCEV *, APInt> &M,
2110                              SmallVectorImpl<const SCEV *> &NewOps,
2111                              APInt &AccumulatedConstant,
2112                              const SCEV *const *Ops, size_t NumOperands,
2113                              const APInt &Scale,
2114                              ScalarEvolution &SE) {
2115   bool Interesting = false;
2116
2117   // Iterate over the add operands. They are sorted, with constants first.
2118   unsigned i = 0;
2119   while (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) {
2120     ++i;
2121     // Pull a buried constant out to the outside.
2122     if (Scale != 1 || AccumulatedConstant != 0 || C->getValue()->isZero())
2123       Interesting = true;
2124     AccumulatedConstant += Scale * C->getAPInt();
2125   }
2126
2127   // Next comes everything else. We're especially interested in multiplies
2128   // here, but they're in the middle, so just visit the rest with one loop.
2129   for (; i != NumOperands; ++i) {
2130     const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[i]);
2131     if (Mul && isa<SCEVConstant>(Mul->getOperand(0))) {
2132       APInt NewScale =
2133           Scale * cast<SCEVConstant>(Mul->getOperand(0))->getAPInt();
2134       if (Mul->getNumOperands() == 2 && isa<SCEVAddExpr>(Mul->getOperand(1))) {
2135         // A multiplication of a constant with another add; recurse.
2136         const SCEVAddExpr *Add = cast<SCEVAddExpr>(Mul->getOperand(1));
2137         Interesting |=
2138           CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant,
2139                                        Add->op_begin(), Add->getNumOperands(),
2140                                        NewScale, SE);
2141       } else {
2142         // A multiplication of a constant with some other value. Update
2143         // the map.
2144         SmallVector<const SCEV *, 4> MulOps(Mul->op_begin()+1, Mul->op_end());
2145         const SCEV *Key = SE.getMulExpr(MulOps);
2146         auto Pair = M.insert({Key, NewScale});
2147         if (Pair.second) {
2148           NewOps.push_back(Pair.first->first);
2149         } else {
2150           Pair.first->second += NewScale;
2151           // The map already had an entry for this value, which may indicate
2152           // a folding opportunity.
2153           Interesting = true;
2154         }
2155       }
2156     } else {
2157       // An ordinary operand. Update the map.
2158       std::pair<DenseMap<const SCEV *, APInt>::iterator, bool> Pair =
2159           M.insert({Ops[i], Scale});
2160       if (Pair.second) {
2161         NewOps.push_back(Pair.first->first);
2162       } else {
2163         Pair.first->second += Scale;
2164         // The map already had an entry for this value, which may indicate
2165         // a folding opportunity.
2166         Interesting = true;
2167       }
2168     }
2169   }
2170
2171   return Interesting;
2172 }
2173
2174 // We're trying to construct a SCEV of type `Type' with `Ops' as operands and
2175 // `OldFlags' as can't-wrap behavior.  Infer a more aggressive set of
2176 // can't-overflow flags for the operation if possible.
2177 static SCEV::NoWrapFlags
2178 StrengthenNoWrapFlags(ScalarEvolution *SE, SCEVTypes Type,
2179                       const SmallVectorImpl<const SCEV *> &Ops,
2180                       SCEV::NoWrapFlags Flags) {
2181   using namespace std::placeholders;
2182
2183   using OBO = OverflowingBinaryOperator;
2184
2185   bool CanAnalyze =
2186       Type == scAddExpr || Type == scAddRecExpr || Type == scMulExpr;
2187   (void)CanAnalyze;
2188   assert(CanAnalyze && "don't call from other places!");
2189
2190   int SignOrUnsignMask = SCEV::FlagNUW | SCEV::FlagNSW;
2191   SCEV::NoWrapFlags SignOrUnsignWrap =
2192       ScalarEvolution::maskFlags(Flags, SignOrUnsignMask);
2193
2194   // If FlagNSW is true and all the operands are non-negative, infer FlagNUW.
2195   auto IsKnownNonNegative = [&](const SCEV *S) {
2196     return SE->isKnownNonNegative(S);
2197   };
2198
2199   if (SignOrUnsignWrap == SCEV::FlagNSW && all_of(Ops, IsKnownNonNegative))
2200     Flags =
2201         ScalarEvolution::setFlags(Flags, (SCEV::NoWrapFlags)SignOrUnsignMask);
2202
2203   SignOrUnsignWrap = ScalarEvolution::maskFlags(Flags, SignOrUnsignMask);
2204
2205   if (SignOrUnsignWrap != SignOrUnsignMask && Type == scAddExpr &&
2206       Ops.size() == 2 && isa<SCEVConstant>(Ops[0])) {
2207
2208     // (A + C) --> (A + C)<nsw> if the addition does not sign overflow
2209     // (A + C) --> (A + C)<nuw> if the addition does not unsign overflow
2210
2211     const APInt &C = cast<SCEVConstant>(Ops[0])->getAPInt();
2212     if (!(SignOrUnsignWrap & SCEV::FlagNSW)) {
2213       auto NSWRegion = ConstantRange::makeGuaranteedNoWrapRegion(
2214           Instruction::Add, C, OBO::NoSignedWrap);
2215       if (NSWRegion.contains(SE->getSignedRange(Ops[1])))
2216         Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNSW);
2217     }
2218     if (!(SignOrUnsignWrap & SCEV::FlagNUW)) {
2219       auto NUWRegion = ConstantRange::makeGuaranteedNoWrapRegion(
2220           Instruction::Add, C, OBO::NoUnsignedWrap);
2221       if (NUWRegion.contains(SE->getUnsignedRange(Ops[1])))
2222         Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW);
2223     }
2224   }
2225
2226   return Flags;
2227 }
2228
2229 bool ScalarEvolution::isAvailableAtLoopEntry(const SCEV *S, const Loop *L) {
2230   if (!isLoopInvariant(S, L))
2231     return false;
2232   // If a value depends on a SCEVUnknown which is defined after the loop, we
2233   // conservatively assume that we cannot calculate it at the loop's entry.
2234   struct FindDominatedSCEVUnknown {
2235     bool Found = false;
2236     const Loop *L;
2237     DominatorTree &DT;
2238     LoopInfo &LI;
2239
2240     FindDominatedSCEVUnknown(const Loop *L, DominatorTree &DT, LoopInfo &LI)
2241         : L(L), DT(DT), LI(LI) {}
2242
2243     bool checkSCEVUnknown(const SCEVUnknown *SU) {
2244       if (auto *I = dyn_cast<Instruction>(SU->getValue())) {
2245         if (DT.dominates(L->getHeader(), I->getParent()))
2246           Found = true;
2247         else
2248           assert(DT.dominates(I->getParent(), L->getHeader()) &&
2249                  "No dominance relationship between SCEV and loop?");
2250       }
2251       return false;
2252     }
2253
2254     bool follow(const SCEV *S) {
2255       switch (static_cast<SCEVTypes>(S->getSCEVType())) {
2256       case scConstant:
2257         return false;
2258       case scAddRecExpr:
2259       case scTruncate:
2260       case scZeroExtend:
2261       case scSignExtend:
2262       case scAddExpr:
2263       case scMulExpr:
2264       case scUMaxExpr:
2265       case scSMaxExpr:
2266       case scUDivExpr:
2267         return true;
2268       case scUnknown:
2269         return checkSCEVUnknown(cast<SCEVUnknown>(S));
2270       case scCouldNotCompute:
2271         llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
2272       }
2273       return false;
2274     }
2275
2276     bool isDone() { return Found; }
2277   };
2278
2279   FindDominatedSCEVUnknown FSU(L, DT, LI);
2280   SCEVTraversal<FindDominatedSCEVUnknown> ST(FSU);
2281   ST.visitAll(S);
2282   return !FSU.Found;
2283 }
2284
2285 /// Get a canonical add expression, or something simpler if possible.
2286 const SCEV *ScalarEvolution::getAddExpr(SmallVectorImpl<const SCEV *> &Ops,
2287                                         SCEV::NoWrapFlags Flags,
2288                                         unsigned Depth) {
2289   assert(!(Flags & ~(SCEV::FlagNUW | SCEV::FlagNSW)) &&
2290          "only nuw or nsw allowed");
2291   assert(!Ops.empty() && "Cannot get empty add!");
2292   if (Ops.size() == 1) return Ops[0];
2293 #ifndef NDEBUG
2294   Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
2295   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
2296     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
2297            "SCEVAddExpr operand types don't match!");
2298 #endif
2299
2300   // Sort by complexity, this groups all similar expression types together.
2301   GroupByComplexity(Ops, &LI, DT);
2302
2303   Flags = StrengthenNoWrapFlags(this, scAddExpr, Ops, Flags);
2304
2305   // If there are any constants, fold them together.
2306   unsigned Idx = 0;
2307   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
2308     ++Idx;
2309     assert(Idx < Ops.size());
2310     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
2311       // We found two constants, fold them together!
2312       Ops[0] = getConstant(LHSC->getAPInt() + RHSC->getAPInt());
2313       if (Ops.size() == 2) return Ops[0];
2314       Ops.erase(Ops.begin()+1);  // Erase the folded element
2315       LHSC = cast<SCEVConstant>(Ops[0]);
2316     }
2317
2318     // If we are left with a constant zero being added, strip it off.
2319     if (LHSC->getValue()->isZero()) {
2320       Ops.erase(Ops.begin());
2321       --Idx;
2322     }
2323
2324     if (Ops.size() == 1) return Ops[0];
2325   }
2326
2327   // Limit recursion calls depth.
2328   if (Depth > MaxArithDepth)
2329     return getOrCreateAddExpr(Ops, Flags);
2330
2331   // Okay, check to see if the same value occurs in the operand list more than
2332   // once.  If so, merge them together into an multiply expression.  Since we
2333   // sorted the list, these values are required to be adjacent.
2334   Type *Ty = Ops[0]->getType();
2335   bool FoundMatch = false;
2336   for (unsigned i = 0, e = Ops.size(); i != e-1; ++i)
2337     if (Ops[i] == Ops[i+1]) {      //  X + Y + Y  -->  X + Y*2
2338       // Scan ahead to count how many equal operands there are.
2339       unsigned Count = 2;
2340       while (i+Count != e && Ops[i+Count] == Ops[i])
2341         ++Count;
2342       // Merge the values into a multiply.
2343       const SCEV *Scale = getConstant(Ty, Count);
2344       const SCEV *Mul = getMulExpr(Scale, Ops[i], SCEV::FlagAnyWrap, Depth + 1);
2345       if (Ops.size() == Count)
2346         return Mul;
2347       Ops[i] = Mul;
2348       Ops.erase(Ops.begin()+i+1, Ops.begin()+i+Count);
2349       --i; e -= Count - 1;
2350       FoundMatch = true;
2351     }
2352   if (FoundMatch)
2353     return getAddExpr(Ops, Flags);
2354
2355   // Check for truncates. If all the operands are truncated from the same
2356   // type, see if factoring out the truncate would permit the result to be
2357   // folded. eg., n*trunc(x) + m*trunc(y) --> trunc(trunc(m)*x + trunc(n)*y)
2358   // if the contents of the resulting outer trunc fold to something simple.
2359   auto FindTruncSrcType = [&]() -> Type * {
2360     // We're ultimately looking to fold an addrec of truncs and muls of only
2361     // constants and truncs, so if we find any other types of SCEV
2362     // as operands of the addrec then we bail and return nullptr here.
2363     // Otherwise, we return the type of the operand of a trunc that we find.
2364     if (auto *T = dyn_cast<SCEVTruncateExpr>(Ops[Idx]))
2365       return T->getOperand()->getType();
2366     if (const auto *Mul = dyn_cast<SCEVMulExpr>(Ops[Idx])) {
2367       const auto *LastOp = Mul->getOperand(Mul->getNumOperands() - 1);
2368       if (const auto *T = dyn_cast<SCEVTruncateExpr>(LastOp))
2369         return T->getOperand()->getType();
2370     }
2371     return nullptr;
2372   };
2373   if (auto *SrcType = FindTruncSrcType()) {
2374     SmallVector<const SCEV *, 8> LargeOps;
2375     bool Ok = true;
2376     // Check all the operands to see if they can be represented in the
2377     // source type of the truncate.
2378     for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
2379       if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Ops[i])) {
2380         if (T->getOperand()->getType() != SrcType) {
2381           Ok = false;
2382           break;
2383         }
2384         LargeOps.push_back(T->getOperand());
2385       } else if (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) {
2386         LargeOps.push_back(getAnyExtendExpr(C, SrcType));
2387       } else if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(Ops[i])) {
2388         SmallVector<const SCEV *, 8> LargeMulOps;
2389         for (unsigned j = 0, f = M->getNumOperands(); j != f && Ok; ++j) {
2390           if (const SCEVTruncateExpr *T =
2391                 dyn_cast<SCEVTruncateExpr>(M->getOperand(j))) {
2392             if (T->getOperand()->getType() != SrcType) {
2393               Ok = false;
2394               break;
2395             }
2396             LargeMulOps.push_back(T->getOperand());
2397           } else if (const auto *C = dyn_cast<SCEVConstant>(M->getOperand(j))) {
2398             LargeMulOps.push_back(getAnyExtendExpr(C, SrcType));
2399           } else {
2400             Ok = false;
2401             break;
2402           }
2403         }
2404         if (Ok)
2405           LargeOps.push_back(getMulExpr(LargeMulOps, SCEV::FlagAnyWrap, Depth + 1));
2406       } else {
2407         Ok = false;
2408         break;
2409       }
2410     }
2411     if (Ok) {
2412       // Evaluate the expression in the larger type.
2413       const SCEV *Fold = getAddExpr(LargeOps, Flags, Depth + 1);
2414       // If it folds to something simple, use it. Otherwise, don't.
2415       if (isa<SCEVConstant>(Fold) || isa<SCEVUnknown>(Fold))
2416         return getTruncateExpr(Fold, Ty);
2417     }
2418   }
2419
2420   // Skip past any other cast SCEVs.
2421   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddExpr)
2422     ++Idx;
2423
2424   // If there are add operands they would be next.
2425   if (Idx < Ops.size()) {
2426     bool DeletedAdd = false;
2427     while (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[Idx])) {
2428       if (Ops.size() > AddOpsInlineThreshold ||
2429           Add->getNumOperands() > AddOpsInlineThreshold)
2430         break;
2431       // If we have an add, expand the add operands onto the end of the operands
2432       // list.
2433       Ops.erase(Ops.begin()+Idx);
2434       Ops.append(Add->op_begin(), Add->op_end());
2435       DeletedAdd = true;
2436     }
2437
2438     // If we deleted at least one add, we added operands to the end of the list,
2439     // and they are not necessarily sorted.  Recurse to resort and resimplify
2440     // any operands we just acquired.
2441     if (DeletedAdd)
2442       return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1);
2443   }
2444
2445   // Skip over the add expression until we get to a multiply.
2446   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr)
2447     ++Idx;
2448
2449   // Check to see if there are any folding opportunities present with
2450   // operands multiplied by constant values.
2451   if (Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx])) {
2452     uint64_t BitWidth = getTypeSizeInBits(Ty);
2453     DenseMap<const SCEV *, APInt> M;
2454     SmallVector<const SCEV *, 8> NewOps;
2455     APInt AccumulatedConstant(BitWidth, 0);
2456     if (CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant,
2457                                      Ops.data(), Ops.size(),
2458                                      APInt(BitWidth, 1), *this)) {
2459       struct APIntCompare {
2460         bool operator()(const APInt &LHS, const APInt &RHS) const {
2461           return LHS.ult(RHS);
2462         }
2463       };
2464
2465       // Some interesting folding opportunity is present, so its worthwhile to
2466       // re-generate the operands list. Group the operands by constant scale,
2467       // to avoid multiplying by the same constant scale multiple times.
2468       std::map<APInt, SmallVector<const SCEV *, 4>, APIntCompare> MulOpLists;
2469       for (const SCEV *NewOp : NewOps)
2470         MulOpLists[M.find(NewOp)->second].push_back(NewOp);
2471       // Re-generate the operands list.
2472       Ops.clear();
2473       if (AccumulatedConstant != 0)
2474         Ops.push_back(getConstant(AccumulatedConstant));
2475       for (auto &MulOp : MulOpLists)
2476         if (MulOp.first != 0)
2477           Ops.push_back(getMulExpr(
2478               getConstant(MulOp.first),
2479               getAddExpr(MulOp.second, SCEV::FlagAnyWrap, Depth + 1),
2480               SCEV::FlagAnyWrap, Depth + 1));
2481       if (Ops.empty())
2482         return getZero(Ty);
2483       if (Ops.size() == 1)
2484         return Ops[0];
2485       return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1);
2486     }
2487   }
2488
2489   // If we are adding something to a multiply expression, make sure the
2490   // something is not already an operand of the multiply.  If so, merge it into
2491   // the multiply.
2492   for (; Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx]); ++Idx) {
2493     const SCEVMulExpr *Mul = cast<SCEVMulExpr>(Ops[Idx]);
2494     for (unsigned MulOp = 0, e = Mul->getNumOperands(); MulOp != e; ++MulOp) {
2495       const SCEV *MulOpSCEV = Mul->getOperand(MulOp);
2496       if (isa<SCEVConstant>(MulOpSCEV))
2497         continue;
2498       for (unsigned AddOp = 0, e = Ops.size(); AddOp != e; ++AddOp)
2499         if (MulOpSCEV == Ops[AddOp]) {
2500           // Fold W + X + (X * Y * Z)  -->  W + (X * ((Y*Z)+1))
2501           const SCEV *InnerMul = Mul->getOperand(MulOp == 0);
2502           if (Mul->getNumOperands() != 2) {
2503             // If the multiply has more than two operands, we must get the
2504             // Y*Z term.
2505             SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(),
2506                                                 Mul->op_begin()+MulOp);
2507             MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end());
2508             InnerMul = getMulExpr(MulOps, SCEV::FlagAnyWrap, Depth + 1);
2509           }
2510           SmallVector<const SCEV *, 2> TwoOps = {getOne(Ty), InnerMul};
2511           const SCEV *AddOne = getAddExpr(TwoOps, SCEV::FlagAnyWrap, Depth + 1);
2512           const SCEV *OuterMul = getMulExpr(AddOne, MulOpSCEV,
2513                                             SCEV::FlagAnyWrap, Depth + 1);
2514           if (Ops.size() == 2) return OuterMul;
2515           if (AddOp < Idx) {
2516             Ops.erase(Ops.begin()+AddOp);
2517             Ops.erase(Ops.begin()+Idx-1);
2518           } else {
2519             Ops.erase(Ops.begin()+Idx);
2520             Ops.erase(Ops.begin()+AddOp-1);
2521           }
2522           Ops.push_back(OuterMul);
2523           return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1);
2524         }
2525
2526       // Check this multiply against other multiplies being added together.
2527       for (unsigned OtherMulIdx = Idx+1;
2528            OtherMulIdx < Ops.size() && isa<SCEVMulExpr>(Ops[OtherMulIdx]);
2529            ++OtherMulIdx) {
2530         const SCEVMulExpr *OtherMul = cast<SCEVMulExpr>(Ops[OtherMulIdx]);
2531         // If MulOp occurs in OtherMul, we can fold the two multiplies
2532         // together.
2533         for (unsigned OMulOp = 0, e = OtherMul->getNumOperands();
2534              OMulOp != e; ++OMulOp)
2535           if (OtherMul->getOperand(OMulOp) == MulOpSCEV) {
2536             // Fold X + (A*B*C) + (A*D*E) --> X + (A*(B*C+D*E))
2537             const SCEV *InnerMul1 = Mul->getOperand(MulOp == 0);
2538             if (Mul->getNumOperands() != 2) {
2539               SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(),
2540                                                   Mul->op_begin()+MulOp);
2541               MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end());
2542               InnerMul1 = getMulExpr(MulOps, SCEV::FlagAnyWrap, Depth + 1);
2543             }
2544             const SCEV *InnerMul2 = OtherMul->getOperand(OMulOp == 0);
2545             if (OtherMul->getNumOperands() != 2) {
2546               SmallVector<const SCEV *, 4> MulOps(OtherMul->op_begin(),
2547                                                   OtherMul->op_begin()+OMulOp);
2548               MulOps.append(OtherMul->op_begin()+OMulOp+1, OtherMul->op_end());
2549               InnerMul2 = getMulExpr(MulOps, SCEV::FlagAnyWrap, Depth + 1);
2550             }
2551             SmallVector<const SCEV *, 2> TwoOps = {InnerMul1, InnerMul2};
2552             const SCEV *InnerMulSum =
2553                 getAddExpr(TwoOps, SCEV::FlagAnyWrap, Depth + 1);
2554             const SCEV *OuterMul = getMulExpr(MulOpSCEV, InnerMulSum,
2555                                               SCEV::FlagAnyWrap, Depth + 1);
2556             if (Ops.size() == 2) return OuterMul;
2557             Ops.erase(Ops.begin()+Idx);
2558             Ops.erase(Ops.begin()+OtherMulIdx-1);
2559             Ops.push_back(OuterMul);
2560             return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1);
2561           }
2562       }
2563     }
2564   }
2565
2566   // If there are any add recurrences in the operands list, see if any other
2567   // added values are loop invariant.  If so, we can fold them into the
2568   // recurrence.
2569   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr)
2570     ++Idx;
2571
2572   // Scan over all recurrences, trying to fold loop invariants into them.
2573   for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) {
2574     // Scan all of the other operands to this add and add them to the vector if
2575     // they are loop invariant w.r.t. the recurrence.
2576     SmallVector<const SCEV *, 8> LIOps;
2577     const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]);
2578     const Loop *AddRecLoop = AddRec->getLoop();
2579     for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2580       if (isAvailableAtLoopEntry(Ops[i], AddRecLoop)) {
2581         LIOps.push_back(Ops[i]);
2582         Ops.erase(Ops.begin()+i);
2583         --i; --e;
2584       }
2585
2586     // If we found some loop invariants, fold them into the recurrence.
2587     if (!LIOps.empty()) {
2588       //  NLI + LI + {Start,+,Step}  -->  NLI + {LI+Start,+,Step}
2589       LIOps.push_back(AddRec->getStart());
2590
2591       SmallVector<const SCEV *, 4> AddRecOps(AddRec->op_begin(),
2592                                              AddRec->op_end());
2593       // This follows from the fact that the no-wrap flags on the outer add
2594       // expression are applicable on the 0th iteration, when the add recurrence
2595       // will be equal to its start value.
2596       AddRecOps[0] = getAddExpr(LIOps, Flags, Depth + 1);
2597
2598       // Build the new addrec. Propagate the NUW and NSW flags if both the
2599       // outer add and the inner addrec are guaranteed to have no overflow.
2600       // Always propagate NW.
2601       Flags = AddRec->getNoWrapFlags(setFlags(Flags, SCEV::FlagNW));
2602       const SCEV *NewRec = getAddRecExpr(AddRecOps, AddRecLoop, Flags);
2603
2604       // If all of the other operands were loop invariant, we are done.
2605       if (Ops.size() == 1) return NewRec;
2606
2607       // Otherwise, add the folded AddRec by the non-invariant parts.
2608       for (unsigned i = 0;; ++i)
2609         if (Ops[i] == AddRec) {
2610           Ops[i] = NewRec;
2611           break;
2612         }
2613       return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1);
2614     }
2615
2616     // Okay, if there weren't any loop invariants to be folded, check to see if
2617     // there are multiple AddRec's with the same loop induction variable being
2618     // added together.  If so, we can fold them.
2619     for (unsigned OtherIdx = Idx+1;
2620          OtherIdx < Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
2621          ++OtherIdx) {
2622       // We expect the AddRecExpr's to be sorted in reverse dominance order,
2623       // so that the 1st found AddRecExpr is dominated by all others.
2624       assert(DT.dominates(
2625            cast<SCEVAddRecExpr>(Ops[OtherIdx])->getLoop()->getHeader(),
2626            AddRec->getLoop()->getHeader()) &&
2627         "AddRecExprs are not sorted in reverse dominance order?");
2628       if (AddRecLoop == cast<SCEVAddRecExpr>(Ops[OtherIdx])->getLoop()) {
2629         // Other + {A,+,B}<L> + {C,+,D}<L>  -->  Other + {A+C,+,B+D}<L>
2630         SmallVector<const SCEV *, 4> AddRecOps(AddRec->op_begin(),
2631                                                AddRec->op_end());
2632         for (; OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
2633              ++OtherIdx) {
2634           const auto *OtherAddRec = cast<SCEVAddRecExpr>(Ops[OtherIdx]);
2635           if (OtherAddRec->getLoop() == AddRecLoop) {
2636             for (unsigned i = 0, e = OtherAddRec->getNumOperands();
2637                  i != e; ++i) {
2638               if (i >= AddRecOps.size()) {
2639                 AddRecOps.append(OtherAddRec->op_begin()+i,
2640                                  OtherAddRec->op_end());
2641                 break;
2642               }
2643               SmallVector<const SCEV *, 2> TwoOps = {
2644                   AddRecOps[i], OtherAddRec->getOperand(i)};
2645               AddRecOps[i] = getAddExpr(TwoOps, SCEV::FlagAnyWrap, Depth + 1);
2646             }
2647             Ops.erase(Ops.begin() + OtherIdx); --OtherIdx;
2648           }
2649         }
2650         // Step size has changed, so we cannot guarantee no self-wraparound.
2651         Ops[Idx] = getAddRecExpr(AddRecOps, AddRecLoop, SCEV::FlagAnyWrap);
2652         return getAddExpr(Ops, SCEV::FlagAnyWrap, Depth + 1);
2653       }
2654     }
2655
2656     // Otherwise couldn't fold anything into this recurrence.  Move onto the
2657     // next one.
2658   }
2659
2660   // Okay, it looks like we really DO need an add expr.  Check to see if we
2661   // already have one, otherwise create a new one.
2662   return getOrCreateAddExpr(Ops, Flags);
2663 }
2664
2665 const SCEV *
2666 ScalarEvolution::getOrCreateAddExpr(SmallVectorImpl<const SCEV *> &Ops,
2667                                     SCEV::NoWrapFlags Flags) {
2668   FoldingSetNodeID ID;
2669   ID.AddInteger(scAddExpr);
2670   for (const SCEV *Op : Ops)
2671     ID.AddPointer(Op);
2672   void *IP = nullptr;
2673   SCEVAddExpr *S =
2674       static_cast<SCEVAddExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
2675   if (!S) {
2676     const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
2677     std::uninitialized_copy(Ops.begin(), Ops.end(), O);
2678     S = new (SCEVAllocator)
2679         SCEVAddExpr(ID.Intern(SCEVAllocator), O, Ops.size());
2680     UniqueSCEVs.InsertNode(S, IP);
2681     addToLoopUseLists(S);
2682   }
2683   S->setNoWrapFlags(Flags);
2684   return S;
2685 }
2686
2687 const SCEV *
2688 ScalarEvolution::getOrCreateMulExpr(SmallVectorImpl<const SCEV *> &Ops,
2689                                     SCEV::NoWrapFlags Flags) {
2690   FoldingSetNodeID ID;
2691   ID.AddInteger(scMulExpr);
2692   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2693     ID.AddPointer(Ops[i]);
2694   void *IP = nullptr;
2695   SCEVMulExpr *S =
2696     static_cast<SCEVMulExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
2697   if (!S) {
2698     const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
2699     std::uninitialized_copy(Ops.begin(), Ops.end(), O);
2700     S = new (SCEVAllocator) SCEVMulExpr(ID.Intern(SCEVAllocator),
2701                                         O, Ops.size());
2702     UniqueSCEVs.InsertNode(S, IP);
2703     addToLoopUseLists(S);
2704   }
2705   S->setNoWrapFlags(Flags);
2706   return S;
2707 }
2708
2709 static uint64_t umul_ov(uint64_t i, uint64_t j, bool &Overflow) {
2710   uint64_t k = i*j;
2711   if (j > 1 && k / j != i) Overflow = true;
2712   return k;
2713 }
2714
2715 /// Compute the result of "n choose k", the binomial coefficient.  If an
2716 /// intermediate computation overflows, Overflow will be set and the return will
2717 /// be garbage. Overflow is not cleared on absence of overflow.
2718 static uint64_t Choose(uint64_t n, uint64_t k, bool &Overflow) {
2719   // We use the multiplicative formula:
2720   //     n(n-1)(n-2)...(n-(k-1)) / k(k-1)(k-2)...1 .
2721   // At each iteration, we take the n-th term of the numeral and divide by the
2722   // (k-n)th term of the denominator.  This division will always produce an
2723   // integral result, and helps reduce the chance of overflow in the
2724   // intermediate computations. However, we can still overflow even when the
2725   // final result would fit.
2726
2727   if (n == 0 || n == k) return 1;
2728   if (k > n) return 0;
2729
2730   if (k > n/2)
2731     k = n-k;
2732
2733   uint64_t r = 1;
2734   for (uint64_t i = 1; i <= k; ++i) {
2735     r = umul_ov(r, n-(i-1), Overflow);
2736     r /= i;
2737   }
2738   return r;
2739 }
2740
2741 /// Determine if any of the operands in this SCEV are a constant or if
2742 /// any of the add or multiply expressions in this SCEV contain a constant.
2743 static bool containsConstantInAddMulChain(const SCEV *StartExpr) {
2744   struct FindConstantInAddMulChain {
2745     bool FoundConstant = false;
2746
2747     bool follow(const SCEV *S) {
2748       FoundConstant |= isa<SCEVConstant>(S);
2749       return isa<SCEVAddExpr>(S) || isa<SCEVMulExpr>(S);
2750     }
2751
2752     bool isDone() const {
2753       return FoundConstant;
2754     }
2755   };
2756
2757   FindConstantInAddMulChain F;
2758   SCEVTraversal<FindConstantInAddMulChain> ST(F);
2759   ST.visitAll(StartExpr);
2760   return F.FoundConstant;
2761 }
2762
2763 /// Get a canonical multiply expression, or something simpler if possible.
2764 const SCEV *ScalarEvolution::getMulExpr(SmallVectorImpl<const SCEV *> &Ops,
2765                                         SCEV::NoWrapFlags Flags,
2766                                         unsigned Depth) {
2767   assert(Flags == maskFlags(Flags, SCEV::FlagNUW | SCEV::FlagNSW) &&
2768          "only nuw or nsw allowed");
2769   assert(!Ops.empty() && "Cannot get empty mul!");
2770   if (Ops.size() == 1) return Ops[0];
2771 #ifndef NDEBUG
2772   Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
2773   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
2774     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
2775            "SCEVMulExpr operand types don't match!");
2776 #endif
2777
2778   // Sort by complexity, this groups all similar expression types together.
2779   GroupByComplexity(Ops, &LI, DT);
2780
2781   Flags = StrengthenNoWrapFlags(this, scMulExpr, Ops, Flags);
2782
2783   // Limit recursion calls depth.
2784   if (Depth > MaxArithDepth)
2785     return getOrCreateMulExpr(Ops, Flags);
2786
2787   // If there are any constants, fold them together.
2788   unsigned Idx = 0;
2789   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
2790
2791     // C1*(C2+V) -> C1*C2 + C1*V
2792     if (Ops.size() == 2)
2793         if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1]))
2794           // If any of Add's ops are Adds or Muls with a constant,
2795           // apply this transformation as well.
2796           if (Add->getNumOperands() == 2)
2797             // TODO: There are some cases where this transformation is not
2798             // profitable, for example:
2799             // Add = (C0 + X) * Y + Z.
2800             // Maybe the scope of this transformation should be narrowed down.
2801             if (containsConstantInAddMulChain(Add))
2802               return getAddExpr(getMulExpr(LHSC, Add->getOperand(0),
2803                                            SCEV::FlagAnyWrap, Depth + 1),
2804                                 getMulExpr(LHSC, Add->getOperand(1),
2805                                            SCEV::FlagAnyWrap, Depth + 1),
2806                                 SCEV::FlagAnyWrap, Depth + 1);
2807
2808     ++Idx;
2809     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
2810       // We found two constants, fold them together!
2811       ConstantInt *Fold =
2812           ConstantInt::get(getContext(), LHSC->getAPInt() * RHSC->getAPInt());
2813       Ops[0] = getConstant(Fold);
2814       Ops.erase(Ops.begin()+1);  // Erase the folded element
2815       if (Ops.size() == 1) return Ops[0];
2816       LHSC = cast<SCEVConstant>(Ops[0]);
2817     }
2818
2819     // If we are left with a constant one being multiplied, strip it off.
2820     if (cast<SCEVConstant>(Ops[0])->getValue()->isOne()) {
2821       Ops.erase(Ops.begin());
2822       --Idx;
2823     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isZero()) {
2824       // If we have a multiply of zero, it will always be zero.
2825       return Ops[0];
2826     } else if (Ops[0]->isAllOnesValue()) {
2827       // If we have a mul by -1 of an add, try distributing the -1 among the
2828       // add operands.
2829       if (Ops.size() == 2) {
2830         if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1])) {
2831           SmallVector<const SCEV *, 4> NewOps;
2832           bool AnyFolded = false;
2833           for (const SCEV *AddOp : Add->operands()) {
2834             const SCEV *Mul = getMulExpr(Ops[0], AddOp, SCEV::FlagAnyWrap,
2835                                          Depth + 1);
2836             if (!isa<SCEVMulExpr>(Mul)) AnyFolded = true;
2837             NewOps.push_back(Mul);
2838           }
2839           if (AnyFolded)
2840             return getAddExpr(NewOps, SCEV::FlagAnyWrap, Depth + 1);
2841         } else if (const auto *AddRec = dyn_cast<SCEVAddRecExpr>(Ops[1])) {
2842           // Negation preserves a recurrence's no self-wrap property.
2843           SmallVector<const SCEV *, 4> Operands;
2844           for (const SCEV *AddRecOp : AddRec->operands())
2845             Operands.push_back(getMulExpr(Ops[0], AddRecOp, SCEV::FlagAnyWrap,
2846                                           Depth + 1));
2847
2848           return getAddRecExpr(Operands, AddRec->getLoop(),
2849                                AddRec->getNoWrapFlags(SCEV::FlagNW));
2850         }
2851       }
2852     }
2853
2854     if (Ops.size() == 1)
2855       return Ops[0];
2856   }
2857
2858   // Skip over the add expression until we get to a multiply.
2859   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr)
2860     ++Idx;
2861
2862   // If there are mul operands inline them all into this expression.
2863   if (Idx < Ops.size()) {
2864     bool DeletedMul = false;
2865     while (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[Idx])) {
2866       if (Ops.size() > MulOpsInlineThreshold)
2867         break;
2868       // If we have an mul, expand the mul operands onto the end of the
2869       // operands list.
2870       Ops.erase(Ops.begin()+Idx);
2871       Ops.append(Mul->op_begin(), Mul->op_end());
2872       DeletedMul = true;
2873     }
2874
2875     // If we deleted at least one mul, we added operands to the end of the
2876     // list, and they are not necessarily sorted.  Recurse to resort and
2877     // resimplify any operands we just acquired.
2878     if (DeletedMul)
2879       return getMulExpr(Ops, SCEV::FlagAnyWrap, Depth + 1);
2880   }
2881
2882   // If there are any add recurrences in the operands list, see if any other
2883   // added values are loop invariant.  If so, we can fold them into the
2884   // recurrence.
2885   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr)
2886     ++Idx;
2887
2888   // Scan over all recurrences, trying to fold loop invariants into them.
2889   for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) {
2890     // Scan all of the other operands to this mul and add them to the vector
2891     // if they are loop invariant w.r.t. the recurrence.
2892     SmallVector<const SCEV *, 8> LIOps;
2893     const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]);
2894     const Loop *AddRecLoop = AddRec->getLoop();
2895     for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2896       if (isAvailableAtLoopEntry(Ops[i], AddRecLoop)) {
2897         LIOps.push_back(Ops[i]);
2898         Ops.erase(Ops.begin()+i);
2899         --i; --e;
2900       }
2901
2902     // If we found some loop invariants, fold them into the recurrence.
2903     if (!LIOps.empty()) {
2904       //  NLI * LI * {Start,+,Step}  -->  NLI * {LI*Start,+,LI*Step}
2905       SmallVector<const SCEV *, 4> NewOps;
2906       NewOps.reserve(AddRec->getNumOperands());
2907       const SCEV *Scale = getMulExpr(LIOps, SCEV::FlagAnyWrap, Depth + 1);
2908       for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i)
2909         NewOps.push_back(getMulExpr(Scale, AddRec->getOperand(i),
2910                                     SCEV::FlagAnyWrap, Depth + 1));
2911
2912       // Build the new addrec. Propagate the NUW and NSW flags if both the
2913       // outer mul and the inner addrec are guaranteed to have no overflow.
2914       //
2915       // No self-wrap cannot be guaranteed after changing the step size, but
2916       // will be inferred if either NUW or NSW is true.
2917       Flags = AddRec->getNoWrapFlags(clearFlags(Flags, SCEV::FlagNW));
2918       const SCEV *NewRec = getAddRecExpr(NewOps, AddRecLoop, Flags);
2919
2920       // If all of the other operands were loop invariant, we are done.
2921       if (Ops.size() == 1) return NewRec;
2922
2923       // Otherwise, multiply the folded AddRec by the non-invariant parts.
2924       for (unsigned i = 0;; ++i)
2925         if (Ops[i] == AddRec) {
2926           Ops[i] = NewRec;
2927           break;
2928         }
2929       return getMulExpr(Ops, SCEV::FlagAnyWrap, Depth + 1);
2930     }
2931
2932     // Okay, if there weren't any loop invariants to be folded, check to see
2933     // if there are multiple AddRec's with the same loop induction variable
2934     // being multiplied together.  If so, we can fold them.
2935
2936     // {A1,+,A2,+,...,+,An}<L> * {B1,+,B2,+,...,+,Bn}<L>
2937     // = {x=1 in [ sum y=x..2x [ sum z=max(y-x, y-n)..min(x,n) [
2938     //       choose(x, 2x)*choose(2x-y, x-z)*A_{y-z}*B_z
2939     //   ]]],+,...up to x=2n}.
2940     // Note that the arguments to choose() are always integers with values
2941     // known at compile time, never SCEV objects.
2942     //
2943     // The implementation avoids pointless extra computations when the two
2944     // addrec's are of different length (mathematically, it's equivalent to
2945     // an infinite stream of zeros on the right).
2946     bool OpsModified = false;
2947     for (unsigned OtherIdx = Idx+1;
2948          OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
2949          ++OtherIdx) {
2950       const SCEVAddRecExpr *OtherAddRec =
2951         dyn_cast<SCEVAddRecExpr>(Ops[OtherIdx]);
2952       if (!OtherAddRec || OtherAddRec->getLoop() != AddRecLoop)
2953         continue;
2954
2955       // Limit max number of arguments to avoid creation of unreasonably big
2956       // SCEVAddRecs with very complex operands.
2957       if (AddRec->getNumOperands() + OtherAddRec->getNumOperands() - 1 >
2958           MaxAddRecSize)
2959         continue;
2960
2961       bool Overflow = false;
2962       Type *Ty = AddRec->getType();
2963       bool LargerThan64Bits = getTypeSizeInBits(Ty) > 64;
2964       SmallVector<const SCEV*, 7> AddRecOps;
2965       for (int x = 0, xe = AddRec->getNumOperands() +
2966              OtherAddRec->getNumOperands() - 1; x != xe && !Overflow; ++x) {
2967         const SCEV *Term = getZero(Ty);
2968         for (int y = x, ye = 2*x+1; y != ye && !Overflow; ++y) {
2969           uint64_t Coeff1 = Choose(x, 2*x - y, Overflow);
2970           for (int z = std::max(y-x, y-(int)AddRec->getNumOperands()+1),
2971                  ze = std::min(x+1, (int)OtherAddRec->getNumOperands());
2972                z < ze && !Overflow; ++z) {
2973             uint64_t Coeff2 = Choose(2*x - y, x-z, Overflow);
2974             uint64_t Coeff;
2975             if (LargerThan64Bits)
2976               Coeff = umul_ov(Coeff1, Coeff2, Overflow);
2977             else
2978               Coeff = Coeff1*Coeff2;
2979             const SCEV *CoeffTerm = getConstant(Ty, Coeff);
2980             const SCEV *Term1 = AddRec->getOperand(y-z);
2981             const SCEV *Term2 = OtherAddRec->getOperand(z);
2982             Term = getAddExpr(Term, getMulExpr(CoeffTerm, Term1, Term2,
2983                                                SCEV::FlagAnyWrap, Depth + 1),
2984                               SCEV::FlagAnyWrap, Depth + 1);
2985           }
2986         }
2987         AddRecOps.push_back(Term);
2988       }
2989       if (!Overflow) {
2990         const SCEV *NewAddRec = getAddRecExpr(AddRecOps, AddRec->getLoop(),
2991                                               SCEV::FlagAnyWrap);
2992         if (Ops.size() == 2) return NewAddRec;
2993         Ops[Idx] = NewAddRec;
2994         Ops.erase(Ops.begin() + OtherIdx); --OtherIdx;
2995         OpsModified = true;
2996         AddRec = dyn_cast<SCEVAddRecExpr>(NewAddRec);
2997         if (!AddRec)
2998           break;
2999       }
3000     }
3001     if (OpsModified)
3002       return getMulExpr(Ops, SCEV::FlagAnyWrap, Depth + 1);
3003
3004     // Otherwise couldn't fold anything into this recurrence.  Move onto the
3005     // next one.
3006   }
3007
3008   // Okay, it looks like we really DO need an mul expr.  Check to see if we
3009   // already have one, otherwise create a new one.
3010   return getOrCreateMulExpr(Ops, Flags);
3011 }
3012
3013 /// Represents an unsigned remainder expression based on unsigned division.
3014 const SCEV *ScalarEvolution::getURemExpr(const SCEV *LHS,
3015                                          const SCEV *RHS) {
3016   assert(getEffectiveSCEVType(LHS->getType()) ==
3017          getEffectiveSCEVType(RHS->getType()) &&
3018          "SCEVURemExpr operand types don't match!");
3019
3020   // Short-circuit easy cases
3021   if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
3022     // If constant is one, the result is trivial
3023     if (RHSC->getValue()->isOne())
3024       return getZero(LHS->getType()); // X urem 1 --> 0
3025
3026     // If constant is a power of two, fold into a zext(trunc(LHS)).
3027     if (RHSC->getAPInt().isPowerOf2()) {
3028       Type *FullTy = LHS->getType();
3029       Type *TruncTy =
3030           IntegerType::get(getContext(), RHSC->getAPInt().logBase2());
3031       return getZeroExtendExpr(getTruncateExpr(LHS, TruncTy), FullTy);
3032     }
3033   }
3034
3035   // Fallback to %a == %x urem %y == %x -<nuw> ((%x udiv %y) *<nuw> %y)
3036   const SCEV *UDiv = getUDivExpr(LHS, RHS);
3037   const SCEV *Mult = getMulExpr(UDiv, RHS, SCEV::FlagNUW);
3038   return getMinusSCEV(LHS, Mult, SCEV::FlagNUW);
3039 }
3040
3041 /// Get a canonical unsigned division expression, or something simpler if
3042 /// possible.
3043 const SCEV *ScalarEvolution::getUDivExpr(const SCEV *LHS,
3044                                          const SCEV *RHS) {
3045   assert(getEffectiveSCEVType(LHS->getType()) ==
3046          getEffectiveSCEVType(RHS->getType()) &&
3047          "SCEVUDivExpr operand types don't match!");
3048
3049   if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
3050     if (RHSC->getValue()->isOne())
3051       return LHS;                               // X udiv 1 --> x
3052     // If the denominator is zero, the result of the udiv is undefined. Don't
3053     // try to analyze it, because the resolution chosen here may differ from
3054     // the resolution chosen in other parts of the compiler.
3055     if (!RHSC->getValue()->isZero()) {
3056       // Determine if the division can be folded into the operands of
3057       // its operands.
3058       // TODO: Generalize this to non-constants by using known-bits information.
3059       Type *Ty = LHS->getType();
3060       unsigned LZ = RHSC->getAPInt().countLeadingZeros();
3061       unsigned MaxShiftAmt = getTypeSizeInBits(Ty) - LZ - 1;
3062       // For non-power-of-two values, effectively round the value up to the
3063       // nearest power of two.
3064       if (!RHSC->getAPInt().isPowerOf2())
3065         ++MaxShiftAmt;
3066       IntegerType *ExtTy =
3067         IntegerType::get(getContext(), getTypeSizeInBits(Ty) + MaxShiftAmt);
3068       if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(LHS))
3069         if (const SCEVConstant *Step =
3070             dyn_cast<SCEVConstant>(AR->getStepRecurrence(*this))) {
3071           // {X,+,N}/C --> {X/C,+,N/C} if safe and N/C can be folded.
3072           const APInt &StepInt = Step->getAPInt();
3073           const APInt &DivInt = RHSC->getAPInt();
3074           if (!StepInt.urem(DivInt) &&
3075               getZeroExtendExpr(AR, ExtTy) ==
3076               getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy),
3077                             getZeroExtendExpr(Step, ExtTy),
3078                             AR->getLoop(), SCEV::FlagAnyWrap)) {
3079             SmallVector<const SCEV *, 4> Operands;
3080             for (const SCEV *Op : AR->operands())
3081               Operands.push_back(getUDivExpr(Op, RHS));
3082             return getAddRecExpr(Operands, AR->getLoop(), SCEV::FlagNW);
3083           }
3084           /// Get a canonical UDivExpr for a recurrence.
3085           /// {X,+,N}/C => {Y,+,N}/C where Y=X-(X%N). Safe when C%N=0.
3086           // We can currently only fold X%N if X is constant.
3087           const SCEVConstant *StartC = dyn_cast<SCEVConstant>(AR->getStart());
3088           if (StartC && !DivInt.urem(StepInt) &&
3089               getZeroExtendExpr(AR, ExtTy) ==
3090               getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy),
3091                             getZeroExtendExpr(Step, ExtTy),
3092                             AR->getLoop(), SCEV::FlagAnyWrap)) {
3093             const APInt &StartInt = StartC->getAPInt();
3094             const APInt &StartRem = StartInt.urem(StepInt);
3095             if (StartRem != 0)
3096               LHS = getAddRecExpr(getConstant(StartInt - StartRem), Step,
3097                                   AR->getLoop(), SCEV::FlagNW);
3098           }
3099         }
3100       // (A*B)/C --> A*(B/C) if safe and B/C can be folded.
3101       if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(LHS)) {
3102         SmallVector<const SCEV *, 4> Operands;
3103         for (const SCEV *Op : M->operands())
3104           Operands.push_back(getZeroExtendExpr(Op, ExtTy));
3105         if (getZeroExtendExpr(M, ExtTy) == getMulExpr(Operands))
3106           // Find an operand that's safely divisible.
3107           for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i) {
3108             const SCEV *Op = M->getOperand(i);
3109             const SCEV *Div = getUDivExpr(Op, RHSC);
3110             if (!isa<SCEVUDivExpr>(Div) && getMulExpr(Div, RHSC) == Op) {
3111               Operands = SmallVector<const SCEV *, 4>(M->op_begin(),
3112                                                       M->op_end());
3113               Operands[i] = Div;
3114               return getMulExpr(Operands);
3115             }
3116           }
3117       }
3118       // (A+B)/C --> (A/C + B/C) if safe and A/C and B/C can be folded.
3119       if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(LHS)) {
3120         SmallVector<const SCEV *, 4> Operands;
3121         for (const SCEV *Op : A->operands())
3122           Operands.push_back(getZeroExtendExpr(Op, ExtTy));
3123         if (getZeroExtendExpr(A, ExtTy) == getAddExpr(Operands)) {
3124           Operands.clear();
3125           for (unsigned i = 0, e = A->getNumOperands(); i != e; ++i) {
3126             const SCEV *Op = getUDivExpr(A->getOperand(i), RHS);
3127             if (isa<SCEVUDivExpr>(Op) ||
3128                 getMulExpr(Op, RHS) != A->getOperand(i))
3129               break;
3130             Operands.push_back(Op);
3131           }
3132           if (Operands.size() == A->getNumOperands())
3133             return getAddExpr(Operands);
3134         }
3135       }
3136
3137       // Fold if both operands are constant.
3138       if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
3139         Constant *LHSCV = LHSC->getValue();
3140         Constant *RHSCV = RHSC->getValue();
3141         return getConstant(cast<ConstantInt>(ConstantExpr::getUDiv(LHSCV,
3142                                                                    RHSCV)));
3143       }
3144     }
3145   }
3146
3147   FoldingSetNodeID ID;
3148   ID.AddInteger(scUDivExpr);
3149   ID.AddPointer(LHS);
3150   ID.AddPointer(RHS);
3151   void *IP = nullptr;
3152   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
3153   SCEV *S = new (SCEVAllocator) SCEVUDivExpr(ID.Intern(SCEVAllocator),
3154                                              LHS, RHS);
3155   UniqueSCEVs.InsertNode(S, IP);
3156   addToLoopUseLists(S);
3157   return S;
3158 }
3159
3160 static const APInt gcd(const SCEVConstant *C1, const SCEVConstant *C2) {
3161   APInt A = C1->getAPInt().abs();
3162   APInt B = C2->getAPInt().abs();
3163   uint32_t ABW = A.getBitWidth();
3164   uint32_t BBW = B.getBitWidth();
3165
3166   if (ABW > BBW)
3167     B = B.zext(ABW);
3168   else if (ABW < BBW)
3169     A = A.zext(BBW);
3170
3171   return APIntOps::GreatestCommonDivisor(std::move(A), std::move(B));
3172 }
3173
3174 /// Get a canonical unsigned division expression, or something simpler if
3175 /// possible. There is no representation for an exact udiv in SCEV IR, but we
3176 /// can attempt to remove factors from the LHS and RHS.  We can't do this when
3177 /// it's not exact because the udiv may be clearing bits.
3178 const SCEV *ScalarEvolution::getUDivExactExpr(const SCEV *LHS,
3179                                               const SCEV *RHS) {
3180   // TODO: we could try to find factors in all sorts of things, but for now we
3181   // just deal with u/exact (multiply, constant). See SCEVDivision towards the
3182   // end of this file for inspiration.
3183
3184   const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(LHS);
3185   if (!Mul || !Mul->hasNoUnsignedWrap())
3186     return getUDivExpr(LHS, RHS);
3187
3188   if (const SCEVConstant *RHSCst = dyn_cast<SCEVConstant>(RHS)) {
3189     // If the mulexpr multiplies by a constant, then that constant must be the
3190     // first element of the mulexpr.
3191     if (const auto *LHSCst = dyn_cast<SCEVConstant>(Mul->getOperand(0))) {
3192       if (LHSCst == RHSCst) {
3193         SmallVector<const SCEV *, 2> Operands;
3194         Operands.append(Mul->op_begin() + 1, Mul->op_end());
3195         return getMulExpr(Operands);
3196       }
3197
3198       // We can't just assume that LHSCst divides RHSCst cleanly, it could be
3199       // that there's a factor provided by one of the other terms. We need to
3200       // check.
3201       APInt Factor = gcd(LHSCst, RHSCst);
3202       if (!Factor.isIntN(1)) {
3203         LHSCst =
3204             cast<SCEVConstant>(getConstant(LHSCst->getAPInt().udiv(Factor)));
3205         RHSCst =
3206             cast<SCEVConstant>(getConstant(RHSCst->getAPInt().udiv(Factor)));
3207         SmallVector<const SCEV *, 2> Operands;
3208         Operands.push_back(LHSCst);
3209         Operands.append(Mul->op_begin() + 1, Mul->op_end());
3210         LHS = getMulExpr(Operands);
3211         RHS = RHSCst;
3212         Mul = dyn_cast<SCEVMulExpr>(LHS);
3213         if (!Mul)
3214           return getUDivExactExpr(LHS, RHS);
3215       }
3216     }
3217   }
3218
3219   for (int i = 0, e = Mul->getNumOperands(); i != e; ++i) {
3220     if (Mul->getOperand(i) == RHS) {
3221       SmallVector<const SCEV *, 2> Operands;
3222       Operands.append(Mul->op_begin(), Mul->op_begin() + i);
3223       Operands.append(Mul->op_begin() + i + 1, Mul->op_end());
3224       return getMulExpr(Operands);
3225     }
3226   }
3227
3228   return getUDivExpr(LHS, RHS);
3229 }
3230
3231 /// Get an add recurrence expression for the specified loop.  Simplify the
3232 /// expression as much as possible.
3233 const SCEV *ScalarEvolution::getAddRecExpr(const SCEV *Start, const SCEV *Step,
3234                                            const Loop *L,
3235                                            SCEV::NoWrapFlags Flags) {
3236   SmallVector<const SCEV *, 4> Operands;
3237   Operands.push_back(Start);
3238   if (const SCEVAddRecExpr *StepChrec = dyn_cast<SCEVAddRecExpr>(Step))
3239     if (StepChrec->getLoop() == L) {
3240       Operands.append(StepChrec->op_begin(), StepChrec->op_end());
3241       return getAddRecExpr(Operands, L, maskFlags(Flags, SCEV::FlagNW));
3242     }
3243
3244   Operands.push_back(Step);
3245   return getAddRecExpr(Operands, L, Flags);
3246 }
3247
3248 /// Get an add recurrence expression for the specified loop.  Simplify the
3249 /// expression as much as possible.
3250 const SCEV *
3251 ScalarEvolution::getAddRecExpr(SmallVectorImpl<const SCEV *> &Operands,
3252                                const Loop *L, SCEV::NoWrapFlags Flags) {
3253   if (Operands.size() == 1) return Operands[0];
3254 #ifndef NDEBUG
3255   Type *ETy = getEffectiveSCEVType(Operands[0]->getType());
3256   for (unsigned i = 1, e = Operands.size(); i != e; ++i)
3257     assert(getEffectiveSCEVType(Operands[i]->getType()) == ETy &&
3258            "SCEVAddRecExpr operand types don't match!");
3259   for (unsigned i = 0, e = Operands.size(); i != e; ++i)
3260     assert(isLoopInvariant(Operands[i], L) &&
3261            "SCEVAddRecExpr operand is not loop-invariant!");
3262 #endif
3263
3264   if (Operands.back()->isZero()) {
3265     Operands.pop_back();
3266     return getAddRecExpr(Operands, L, SCEV::FlagAnyWrap); // {X,+,0}  -->  X
3267   }
3268
3269   // It's tempting to want to call getMaxBackedgeTakenCount count here and
3270   // use that information to infer NUW and NSW flags. However, computing a
3271   // BE count requires calling getAddRecExpr, so we may not yet have a
3272   // meaningful BE count at this point (and if we don't, we'd be stuck
3273   // with a SCEVCouldNotCompute as the cached BE count).
3274
3275   Flags = StrengthenNoWrapFlags(this, scAddRecExpr, Operands, Flags);
3276
3277   // Canonicalize nested AddRecs in by nesting them in order of loop depth.
3278   if (const SCEVAddRecExpr *NestedAR = dyn_cast<SCEVAddRecExpr>(Operands[0])) {
3279     const Loop *NestedLoop = NestedAR->getLoop();
3280     if (L->contains(NestedLoop)
3281             ? (L->getLoopDepth() < NestedLoop->getLoopDepth())
3282             : (!NestedLoop->contains(L) &&
3283                DT.dominates(L->getHeader(), NestedLoop->getHeader()))) {
3284       SmallVector<const SCEV *, 4> NestedOperands(NestedAR->op_begin(),
3285                                                   NestedAR->op_end());
3286       Operands[0] = NestedAR->getStart();
3287       // AddRecs require their operands be loop-invariant with respect to their
3288       // loops. Don't perform this transformation if it would break this
3289       // requirement.
3290       bool AllInvariant = all_of(
3291           Operands, [&](const SCEV *Op) { return isLoopInvariant(Op, L); });
3292
3293       if (AllInvariant) {
3294         // Create a recurrence for the outer loop with the same step size.
3295         //
3296         // The outer recurrence keeps its NW flag but only keeps NUW/NSW if the
3297         // inner recurrence has the same property.
3298         SCEV::NoWrapFlags OuterFlags =
3299           maskFlags(Flags, SCEV::FlagNW | NestedAR->getNoWrapFlags());
3300
3301         NestedOperands[0] = getAddRecExpr(Operands, L, OuterFlags);
3302         AllInvariant = all_of(NestedOperands, [&](const SCEV *Op) {
3303           return isLoopInvariant(Op, NestedLoop);
3304         });
3305
3306         if (AllInvariant) {
3307           // Ok, both add recurrences are valid after the transformation.
3308           //
3309           // The inner recurrence keeps its NW flag but only keeps NUW/NSW if
3310           // the outer recurrence has the same property.
3311           SCEV::NoWrapFlags InnerFlags =
3312             maskFlags(NestedAR->getNoWrapFlags(), SCEV::FlagNW | Flags);
3313           return getAddRecExpr(NestedOperands, NestedLoop, InnerFlags);
3314         }
3315       }
3316       // Reset Operands to its original state.
3317       Operands[0] = NestedAR;
3318     }
3319   }
3320
3321   // Okay, it looks like we really DO need an addrec expr.  Check to see if we
3322   // already have one, otherwise create a new one.
3323   FoldingSetNodeID ID;
3324   ID.AddInteger(scAddRecExpr);
3325   for (unsigned i = 0, e = Operands.size(); i != e; ++i)
3326     ID.AddPointer(Operands[i]);
3327   ID.AddPointer(L);
3328   void *IP = nullptr;
3329   SCEVAddRecExpr *S =
3330     static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
3331   if (!S) {
3332     const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Operands.size());
3333     std::uninitialized_copy(Operands.begin(), Operands.end(), O);
3334     S = new (SCEVAllocator) SCEVAddRecExpr(ID.Intern(SCEVAllocator),
3335                                            O, Operands.size(), L);
3336     UniqueSCEVs.InsertNode(S, IP);
3337     addToLoopUseLists(S);
3338   }
3339   S->setNoWrapFlags(Flags);
3340   return S;
3341 }
3342
3343 const SCEV *
3344 ScalarEvolution::getGEPExpr(GEPOperator *GEP,
3345                             const SmallVectorImpl<const SCEV *> &IndexExprs) {
3346   const SCEV *BaseExpr = getSCEV(GEP->getPointerOperand());
3347   // getSCEV(Base)->getType() has the same address space as Base->getType()
3348   // because SCEV::getType() preserves the address space.
3349   Type *IntPtrTy = getEffectiveSCEVType(BaseExpr->getType());
3350   // FIXME(PR23527): Don't blindly transfer the inbounds flag from the GEP
3351   // instruction to its SCEV, because the Instruction may be guarded by control
3352   // flow and the no-overflow bits may not be valid for the expression in any
3353   // context. This can be fixed similarly to how these flags are handled for
3354   // adds.
3355   SCEV::NoWrapFlags Wrap = GEP->isInBounds() ? SCEV::FlagNSW
3356                                              : SCEV::FlagAnyWrap;
3357
3358   const SCEV *TotalOffset = getZero(IntPtrTy);
3359   // The array size is unimportant. The first thing we do on CurTy is getting
3360   // its element type.
3361   Type *CurTy = ArrayType::get(GEP->getSourceElementType(), 0);
3362   for (const SCEV *IndexExpr : IndexExprs) {
3363     // Compute the (potentially symbolic) offset in bytes for this index.
3364     if (StructType *STy = dyn_cast<StructType>(CurTy)) {
3365       // For a struct, add the member offset.
3366       ConstantInt *Index = cast<SCEVConstant>(IndexExpr)->getValue();
3367       unsigned FieldNo = Index->getZExtValue();
3368       const SCEV *FieldOffset = getOffsetOfExpr(IntPtrTy, STy, FieldNo);
3369
3370       // Add the field offset to the running total offset.
3371       TotalOffset = getAddExpr(TotalOffset, FieldOffset);
3372
3373       // Update CurTy to the type of the field at Index.
3374       CurTy = STy->getTypeAtIndex(Index);
3375     } else {
3376       // Update CurTy to its element type.
3377       CurTy = cast<SequentialType>(CurTy)->getElementType();
3378       // For an array, add the element offset, explicitly scaled.
3379       const SCEV *ElementSize = getSizeOfExpr(IntPtrTy, CurTy);
3380       // Getelementptr indices are signed.
3381       IndexExpr = getTruncateOrSignExtend(IndexExpr, IntPtrTy);
3382
3383       // Multiply the index by the element size to compute the element offset.
3384       const SCEV *LocalOffset = getMulExpr(IndexExpr, ElementSize, Wrap);
3385
3386       // Add the element offset to the running total offset.
3387       TotalOffset = getAddExpr(TotalOffset, LocalOffset);
3388     }
3389   }
3390
3391   // Add the total offset from all the GEP indices to the base.
3392   return getAddExpr(BaseExpr, TotalOffset, Wrap);
3393 }
3394
3395 const SCEV *ScalarEvolution::getSMaxExpr(const SCEV *LHS,
3396                                          const SCEV *RHS) {
3397   SmallVector<const SCEV *, 2> Ops = {LHS, RHS};
3398   return getSMaxExpr(Ops);
3399 }
3400
3401 const SCEV *
3402 ScalarEvolution::getSMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
3403   assert(!Ops.empty() && "Cannot get empty smax!");
3404   if (Ops.size() == 1) return Ops[0];
3405 #ifndef NDEBUG
3406   Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
3407   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
3408     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
3409            "SCEVSMaxExpr operand types don't match!");
3410 #endif
3411
3412   // Sort by complexity, this groups all similar expression types together.
3413   GroupByComplexity(Ops, &LI, DT);
3414
3415   // If there are any constants, fold them together.
3416   unsigned Idx = 0;
3417   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
3418     ++Idx;
3419     assert(Idx < Ops.size());
3420     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
3421       // We found two constants, fold them together!
3422       ConstantInt *Fold = ConstantInt::get(
3423           getContext(), APIntOps::smax(LHSC->getAPInt(), RHSC->getAPInt()));
3424       Ops[0] = getConstant(Fold);
3425       Ops.erase(Ops.begin()+1);  // Erase the folded element
3426       if (Ops.size() == 1) return Ops[0];
3427       LHSC = cast<SCEVConstant>(Ops[0]);
3428     }
3429
3430     // If we are left with a constant minimum-int, strip it off.
3431     if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(true)) {
3432       Ops.erase(Ops.begin());
3433       --Idx;
3434     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(true)) {
3435       // If we have an smax with a constant maximum-int, it will always be
3436       // maximum-int.
3437       return Ops[0];
3438     }
3439
3440     if (Ops.size() == 1) return Ops[0];
3441   }
3442
3443   // Find the first SMax
3444   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scSMaxExpr)
3445     ++Idx;
3446
3447   // Check to see if one of the operands is an SMax. If so, expand its operands
3448   // onto our operand list, and recurse to simplify.
3449   if (Idx < Ops.size()) {
3450     bool DeletedSMax = false;
3451     while (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(Ops[Idx])) {
3452       Ops.erase(Ops.begin()+Idx);
3453       Ops.append(SMax->op_begin(), SMax->op_end());
3454       DeletedSMax = true;
3455     }
3456
3457     if (DeletedSMax)
3458       return getSMaxExpr(Ops);
3459   }
3460
3461   // Okay, check to see if the same value occurs in the operand list twice.  If
3462   // so, delete one.  Since we sorted the list, these values are required to
3463   // be adjacent.
3464   for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
3465     //  X smax Y smax Y  -->  X smax Y
3466     //  X smax Y         -->  X, if X is always greater than Y
3467     if (Ops[i] == Ops[i+1] ||
3468         isKnownPredicate(ICmpInst::ICMP_SGE, Ops[i], Ops[i+1])) {
3469       Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
3470       --i; --e;
3471     } else if (isKnownPredicate(ICmpInst::ICMP_SLE, Ops[i], Ops[i+1])) {
3472       Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
3473       --i; --e;
3474     }
3475
3476   if (Ops.size() == 1) return Ops[0];
3477
3478   assert(!Ops.empty() && "Reduced smax down to nothing!");
3479
3480   // Okay, it looks like we really DO need an smax expr.  Check to see if we
3481   // already have one, otherwise create a new one.
3482   FoldingSetNodeID ID;
3483   ID.AddInteger(scSMaxExpr);
3484   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
3485     ID.AddPointer(Ops[i]);
3486   void *IP = nullptr;
3487   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
3488   const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
3489   std::uninitialized_copy(Ops.begin(), Ops.end(), O);
3490   SCEV *S = new (SCEVAllocator) SCEVSMaxExpr(ID.Intern(SCEVAllocator),
3491                                              O, Ops.size());
3492   UniqueSCEVs.InsertNode(S, IP);
3493   addToLoopUseLists(S);
3494   return S;
3495 }
3496
3497 const SCEV *ScalarEvolution::getUMaxExpr(const SCEV *LHS,
3498                                          const SCEV *RHS) {
3499   SmallVector<const SCEV *, 2> Ops = {LHS, RHS};
3500   return getUMaxExpr(Ops);
3501 }
3502
3503 const SCEV *
3504 ScalarEvolution::getUMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
3505   assert(!Ops.empty() && "Cannot get empty umax!");
3506   if (Ops.size() == 1) return Ops[0];
3507 #ifndef NDEBUG
3508   Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
3509   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
3510     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
3511            "SCEVUMaxExpr operand types don't match!");
3512 #endif
3513
3514   // Sort by complexity, this groups all similar expression types together.
3515   GroupByComplexity(Ops, &LI, DT);
3516
3517   // If there are any constants, fold them together.
3518   unsigned Idx = 0;
3519   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
3520     ++Idx;
3521     assert(Idx < Ops.size());
3522     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
3523       // We found two constants, fold them together!
3524       ConstantInt *Fold = ConstantInt::get(
3525           getContext(), APIntOps::umax(LHSC->getAPInt(), RHSC->getAPInt()));
3526       Ops[0] = getConstant(Fold);
3527       Ops.erase(Ops.begin()+1);  // Erase the folded element
3528       if (Ops.size() == 1) return Ops[0];
3529       LHSC = cast<SCEVConstant>(Ops[0]);
3530     }
3531
3532     // If we are left with a constant minimum-int, strip it off.
3533     if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(false)) {
3534       Ops.erase(Ops.begin());
3535       --Idx;
3536     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(false)) {
3537       // If we have an umax with a constant maximum-int, it will always be
3538       // maximum-int.
3539       return Ops[0];
3540     }
3541
3542     if (Ops.size() == 1) return Ops[0];
3543   }
3544
3545   // Find the first UMax
3546   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scUMaxExpr)
3547     ++Idx;
3548
3549   // Check to see if one of the operands is a UMax. If so, expand its operands
3550   // onto our operand list, and recurse to simplify.
3551   if (Idx < Ops.size()) {
3552     bool DeletedUMax = false;
3553     while (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(Ops[Idx])) {
3554       Ops.erase(Ops.begin()+Idx);
3555       Ops.append(UMax->op_begin(), UMax->op_end());
3556       DeletedUMax = true;
3557     }
3558
3559     if (DeletedUMax)
3560       return getUMaxExpr(Ops);
3561   }
3562
3563   // Okay, check to see if the same value occurs in the operand list twice.  If
3564   // so, delete one.  Since we sorted the list, these values are required to
3565   // be adjacent.
3566   for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
3567     //  X umax Y umax Y  -->  X umax Y
3568     //  X umax Y         -->  X, if X is always greater than Y
3569     if (Ops[i] == Ops[i+1] ||
3570         isKnownPredicate(ICmpInst::ICMP_UGE, Ops[i], Ops[i+1])) {
3571       Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
3572       --i; --e;
3573     } else if (isKnownPredicate(ICmpInst::ICMP_ULE, Ops[i], Ops[i+1])) {
3574       Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
3575       --i; --e;
3576     }
3577
3578   if (Ops.size() == 1) return Ops[0];
3579
3580   assert(!Ops.empty() && "Reduced umax down to nothing!");
3581
3582   // Okay, it looks like we really DO need a umax expr.  Check to see if we
3583   // already have one, otherwise create a new one.
3584   FoldingSetNodeID ID;
3585   ID.AddInteger(scUMaxExpr);
3586   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
3587     ID.AddPointer(Ops[i]);
3588   void *IP = nullptr;
3589   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
3590   const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
3591   std::uninitialized_copy(Ops.begin(), Ops.end(), O);
3592   SCEV *S = new (SCEVAllocator) SCEVUMaxExpr(ID.Intern(SCEVAllocator),
3593                                              O, Ops.size());
3594   UniqueSCEVs.InsertNode(S, IP);
3595   addToLoopUseLists(S);
3596   return S;
3597 }
3598
3599 const SCEV *ScalarEvolution::getSMinExpr(const SCEV *LHS,
3600                                          const SCEV *RHS) {
3601   // ~smax(~x, ~y) == smin(x, y).
3602   return getNotSCEV(getSMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
3603 }
3604
3605 const SCEV *ScalarEvolution::getUMinExpr(const SCEV *LHS,
3606                                          const SCEV *RHS) {
3607   // ~umax(~x, ~y) == umin(x, y)
3608   return getNotSCEV(getUMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
3609 }
3610
3611 const SCEV *ScalarEvolution::getSizeOfExpr(Type *IntTy, Type *AllocTy) {
3612   // We can bypass creating a target-independent
3613   // constant expression and then folding it back into a ConstantInt.
3614   // This is just a compile-time optimization.
3615   return getConstant(IntTy, getDataLayout().getTypeAllocSize(AllocTy));
3616 }
3617
3618 const SCEV *ScalarEvolution::getOffsetOfExpr(Type *IntTy,
3619                                              StructType *STy,
3620                                              unsigned FieldNo) {
3621   // We can bypass creating a target-independent
3622   // constant expression and then folding it back into a ConstantInt.
3623   // This is just a compile-time optimization.
3624   return getConstant(
3625       IntTy, getDataLayout().getStructLayout(STy)->getElementOffset(FieldNo));
3626 }
3627
3628 const SCEV *ScalarEvolution::getUnknown(Value *V) {
3629   // Don't attempt to do anything other than create a SCEVUnknown object
3630   // here.  createSCEV only calls getUnknown after checking for all other
3631   // interesting possibilities, and any other code that calls getUnknown
3632   // is doing so in order to hide a value from SCEV canonicalization.
3633
3634   FoldingSetNodeID ID;
3635   ID.AddInteger(scUnknown);
3636   ID.AddPointer(V);
3637   void *IP = nullptr;
3638   if (SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) {
3639     assert(cast<SCEVUnknown>(S)->getValue() == V &&
3640            "Stale SCEVUnknown in uniquing map!");
3641     return S;
3642   }
3643   SCEV *S = new (SCEVAllocator) SCEVUnknown(ID.Intern(SCEVAllocator), V, this,
3644                                             FirstUnknown);
3645   FirstUnknown = cast<SCEVUnknown>(S);
3646   UniqueSCEVs.InsertNode(S, IP);
3647   return S;
3648 }
3649
3650 //===----------------------------------------------------------------------===//
3651 //            Basic SCEV Analysis and PHI Idiom Recognition Code
3652 //
3653
3654 /// Test if values of the given type are analyzable within the SCEV
3655 /// framework. This primarily includes integer types, and it can optionally
3656 /// include pointer types if the ScalarEvolution class has access to
3657 /// target-specific information.
3658 bool ScalarEvolution::isSCEVable(Type *Ty) const {
3659   // Integers and pointers are always SCEVable.
3660   return Ty->isIntegerTy() || Ty->isPointerTy();
3661 }
3662
3663 /// Return the size in bits of the specified type, for which isSCEVable must
3664 /// return true.
3665 uint64_t ScalarEvolution::getTypeSizeInBits(Type *Ty) const {
3666   assert(isSCEVable(Ty) && "Type is not SCEVable!");
3667   return getDataLayout().getTypeSizeInBits(Ty);
3668 }
3669
3670 /// Return a type with the same bitwidth as the given type and which represents
3671 /// how SCEV will treat the given type, for which isSCEVable must return
3672 /// true. For pointer types, this is the pointer-sized integer type.
3673 Type *ScalarEvolution::getEffectiveSCEVType(Type *Ty) const {
3674   assert(isSCEVable(Ty) && "Type is not SCEVable!");
3675
3676   if (Ty->isIntegerTy())
3677     return Ty;
3678
3679   // The only other support type is pointer.
3680   assert(Ty->isPointerTy() && "Unexpected non-pointer non-integer type!");
3681   return getDataLayout().getIntPtrType(Ty);
3682 }
3683
3684 Type *ScalarEvolution::getWiderType(Type *T1, Type *T2) const {
3685   return  getTypeSizeInBits(T1) >= getTypeSizeInBits(T2) ? T1 : T2;
3686 }
3687
3688 const SCEV *ScalarEvolution::getCouldNotCompute() {
3689   return CouldNotCompute.get();
3690 }
3691
3692 bool ScalarEvolution::checkValidity(const SCEV *S) const {
3693   bool ContainsNulls = SCEVExprContains(S, [](const SCEV *S) {
3694     auto *SU = dyn_cast<SCEVUnknown>(S);
3695     return SU && SU->getValue() == nullptr;
3696   });
3697
3698   return !ContainsNulls;
3699 }
3700
3701 bool ScalarEvolution::containsAddRecurrence(const SCEV *S) {
3702   HasRecMapType::iterator I = HasRecMap.find(S);
3703   if (I != HasRecMap.end())
3704     return I->second;
3705
3706   bool FoundAddRec = SCEVExprContains(S, isa<SCEVAddRecExpr, const SCEV *>);
3707   HasRecMap.insert({S, FoundAddRec});
3708   return FoundAddRec;
3709 }
3710
3711 /// Try to split a SCEVAddExpr into a pair of {SCEV, ConstantInt}.
3712 /// If \p S is a SCEVAddExpr and is composed of a sub SCEV S' and an
3713 /// offset I, then return {S', I}, else return {\p S, nullptr}.
3714 static std::pair<const SCEV *, ConstantInt *> splitAddExpr(const SCEV *S) {
3715   const auto *Add = dyn_cast<SCEVAddExpr>(S);
3716   if (!Add)
3717     return {S, nullptr};
3718
3719   if (Add->getNumOperands() != 2)
3720     return {S, nullptr};
3721
3722   auto *ConstOp = dyn_cast<SCEVConstant>(Add->getOperand(0));
3723   if (!ConstOp)
3724     return {S, nullptr};
3725
3726   return {Add->getOperand(1), ConstOp->getValue()};
3727 }
3728
3729 /// Return the ValueOffsetPair set for \p S. \p S can be represented
3730 /// by the value and offset from any ValueOffsetPair in the set.
3731 SetVector<ScalarEvolution::ValueOffsetPair> *
3732 ScalarEvolution::getSCEVValues(const SCEV *S) {
3733   ExprValueMapType::iterator SI = ExprValueMap.find_as(S);
3734   if (SI == ExprValueMap.end())
3735     return nullptr;
3736 #ifndef NDEBUG
3737   if (VerifySCEVMap) {
3738     // Check there is no dangling Value in the set returned.
3739     for (const auto &VE : SI->second)
3740       assert(ValueExprMap.count(VE.first));
3741   }
3742 #endif
3743   return &SI->second;
3744 }
3745
3746 /// Erase Value from ValueExprMap and ExprValueMap. ValueExprMap.erase(V)
3747 /// cannot be used separately. eraseValueFromMap should be used to remove
3748 /// V from ValueExprMap and ExprValueMap at the same time.
3749 void ScalarEvolution::eraseValueFromMap(Value *V) {
3750   ValueExprMapType::iterator I = ValueExprMap.find_as(V);
3751   if (I != ValueExprMap.end()) {
3752     const SCEV *S = I->second;
3753     // Remove {V, 0} from the set of ExprValueMap[S]
3754     if (SetVector<ValueOffsetPair> *SV = getSCEVValues(S))
3755       SV->remove({V, nullptr});
3756
3757     // Remove {V, Offset} from the set of ExprValueMap[Stripped]
3758     const SCEV *Stripped;
3759     ConstantInt *Offset;
3760     std::tie(Stripped, Offset) = splitAddExpr(S);
3761     if (Offset != nullptr) {
3762       if (SetVector<ValueOffsetPair> *SV = getSCEVValues(Stripped))
3763         SV->remove({V, Offset});
3764     }
3765     ValueExprMap.erase(V);
3766   }
3767 }
3768
3769 /// Return an existing SCEV if it exists, otherwise analyze the expression and
3770 /// create a new one.
3771 const SCEV *ScalarEvolution::getSCEV(Value *V) {
3772   assert(isSCEVable(V->getType()) && "Value is not SCEVable!");
3773
3774   const SCEV *S = getExistingSCEV(V);
3775   if (S == nullptr) {
3776     S = createSCEV(V);
3777     // During PHI resolution, it is possible to create two SCEVs for the same
3778     // V, so it is needed to double check whether V->S is inserted into
3779     // ValueExprMap before insert S->{V, 0} into ExprValueMap.
3780     std::pair<ValueExprMapType::iterator, bool> Pair =
3781         ValueExprMap.insert({SCEVCallbackVH(V, this), S});
3782     if (Pair.second) {
3783       ExprValueMap[S].insert({V, nullptr});
3784
3785       // If S == Stripped + Offset, add Stripped -> {V, Offset} into
3786       // ExprValueMap.
3787       const SCEV *Stripped = S;
3788       ConstantInt *Offset = nullptr;
3789       std::tie(Stripped, Offset) = splitAddExpr(S);
3790       // If stripped is SCEVUnknown, don't bother to save
3791       // Stripped -> {V, offset}. It doesn't simplify and sometimes even
3792       // increase the complexity of the expansion code.
3793       // If V is GetElementPtrInst, don't save Stripped -> {V, offset}
3794       // because it may generate add/sub instead of GEP in SCEV expansion.
3795       if (Offset != nullptr && !isa<SCEVUnknown>(Stripped) &&
3796           !isa<GetElementPtrInst>(V))
3797         ExprValueMap[Stripped].insert({V, Offset});
3798     }
3799   }
3800   return S;
3801 }
3802
3803 const SCEV *ScalarEvolution::getExistingSCEV(Value *V) {
3804   assert(isSCEVable(V->getType()) && "Value is not SCEVable!");
3805
3806   ValueExprMapType::iterator I = ValueExprMap.find_as(V);
3807   if (I != ValueExprMap.end()) {
3808     const SCEV *S = I->second;
3809     if (checkValidity(S))
3810       return S;
3811     eraseValueFromMap(V);
3812     forgetMemoizedResults(S);
3813   }
3814   return nullptr;
3815 }
3816
3817 /// Return a SCEV corresponding to -V = -1*V
3818 const SCEV *ScalarEvolution::getNegativeSCEV(const SCEV *V,
3819                                              SCEV::NoWrapFlags Flags) {
3820   if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
3821     return getConstant(
3822                cast<ConstantInt>(ConstantExpr::getNeg(VC->getValue())));
3823
3824   Type *Ty = V->getType();
3825   Ty = getEffectiveSCEVType(Ty);
3826   return getMulExpr(
3827       V, getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty))), Flags);
3828 }
3829
3830 /// Return a SCEV corresponding to ~V = -1-V
3831 const SCEV *ScalarEvolution::getNotSCEV(const SCEV *V) {
3832   if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
3833     return getConstant(
3834                 cast<ConstantInt>(ConstantExpr::getNot(VC->getValue())));
3835
3836   Type *Ty = V->getType();
3837   Ty = getEffectiveSCEVType(Ty);
3838   const SCEV *AllOnes =
3839                    getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty)));
3840   return getMinusSCEV(AllOnes, V);
3841 }
3842
3843 const SCEV *ScalarEvolution::getMinusSCEV(const SCEV *LHS, const SCEV *RHS,
3844                                           SCEV::NoWrapFlags Flags,
3845                                           unsigned Depth) {
3846   // Fast path: X - X --> 0.
3847   if (LHS == RHS)
3848     return getZero(LHS->getType());
3849
3850   // We represent LHS - RHS as LHS + (-1)*RHS. This transformation
3851   // makes it so that we cannot make much use of NUW.
3852   auto AddFlags = SCEV::FlagAnyWrap;
3853   const bool RHSIsNotMinSigned =
3854       !getSignedRangeMin(RHS).isMinSignedValue();
3855   if (maskFlags(Flags, SCEV::FlagNSW) == SCEV::FlagNSW) {
3856     // Let M be the minimum representable signed value. Then (-1)*RHS
3857     // signed-wraps if and only if RHS is M. That can happen even for
3858     // a NSW subtraction because e.g. (-1)*M signed-wraps even though
3859     // -1 - M does not. So to transfer NSW from LHS - RHS to LHS +
3860     // (-1)*RHS, we need to prove that RHS != M.
3861     //
3862     // If LHS is non-negative and we know that LHS - RHS does not
3863     // signed-wrap, then RHS cannot be M. So we can rule out signed-wrap
3864     // either by proving that RHS > M or that LHS >= 0.
3865     if (RHSIsNotMinSigned || isKnownNonNegative(LHS)) {
3866       AddFlags = SCEV::FlagNSW;
3867     }
3868   }
3869
3870   // FIXME: Find a correct way to transfer NSW to (-1)*M when LHS -
3871   // RHS is NSW and LHS >= 0.
3872   //
3873   // The difficulty here is that the NSW flag may have been proven
3874   // relative to a loop that is to be found in a recurrence in LHS and
3875   // not in RHS. Applying NSW to (-1)*M may then let the NSW have a
3876   // larger scope than intended.
3877   auto NegFlags = RHSIsNotMinSigned ? SCEV::FlagNSW : SCEV::FlagAnyWrap;
3878
3879   return getAddExpr(LHS, getNegativeSCEV(RHS, NegFlags), AddFlags, Depth);
3880 }
3881
3882 const SCEV *
3883 ScalarEvolution::getTruncateOrZeroExtend(const SCEV *V, Type *Ty) {
3884   Type *SrcTy = V->getType();
3885   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3886          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3887          "Cannot truncate or zero extend with non-integer arguments!");
3888   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3889     return V;  // No conversion
3890   if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
3891     return getTruncateExpr(V, Ty);
3892   return getZeroExtendExpr(V, Ty);
3893 }
3894
3895 const SCEV *
3896 ScalarEvolution::getTruncateOrSignExtend(const SCEV *V,
3897                                          Type *Ty) {
3898   Type *SrcTy = V->getType();
3899   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3900          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3901          "Cannot truncate or zero extend with non-integer arguments!");
3902   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3903     return V;  // No conversion
3904   if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
3905     return getTruncateExpr(V, Ty);
3906   return getSignExtendExpr(V, Ty);
3907 }
3908
3909 const SCEV *
3910 ScalarEvolution::getNoopOrZeroExtend(const SCEV *V, Type *Ty) {
3911   Type *SrcTy = V->getType();
3912   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3913          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3914          "Cannot noop or zero extend with non-integer arguments!");
3915   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
3916          "getNoopOrZeroExtend cannot truncate!");
3917   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3918     return V;  // No conversion
3919   return getZeroExtendExpr(V, Ty);
3920 }
3921
3922 const SCEV *
3923 ScalarEvolution::getNoopOrSignExtend(const SCEV *V, Type *Ty) {
3924   Type *SrcTy = V->getType();
3925   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3926          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3927          "Cannot noop or sign extend with non-integer arguments!");
3928   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
3929          "getNoopOrSignExtend cannot truncate!");
3930   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3931     return V;  // No conversion
3932   return getSignExtendExpr(V, Ty);
3933 }
3934
3935 const SCEV *
3936 ScalarEvolution::getNoopOrAnyExtend(const SCEV *V, Type *Ty) {
3937   Type *SrcTy = V->getType();
3938   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3939          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3940          "Cannot noop or any extend with non-integer arguments!");
3941   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
3942          "getNoopOrAnyExtend cannot truncate!");
3943   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3944     return V;  // No conversion
3945   return getAnyExtendExpr(V, Ty);
3946 }
3947
3948 const SCEV *
3949 ScalarEvolution::getTruncateOrNoop(const SCEV *V, Type *Ty) {
3950   Type *SrcTy = V->getType();
3951   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3952          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3953          "Cannot truncate or noop with non-integer arguments!");
3954   assert(getTypeSizeInBits(SrcTy) >= getTypeSizeInBits(Ty) &&
3955          "getTruncateOrNoop cannot extend!");
3956   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3957     return V;  // No conversion
3958   return getTruncateExpr(V, Ty);
3959 }
3960
3961 const SCEV *ScalarEvolution::getUMaxFromMismatchedTypes(const SCEV *LHS,
3962                                                         const SCEV *RHS) {
3963   const SCEV *PromotedLHS = LHS;
3964   const SCEV *PromotedRHS = RHS;
3965
3966   if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
3967     PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
3968   else
3969     PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
3970
3971   return getUMaxExpr(PromotedLHS, PromotedRHS);
3972 }
3973
3974 const SCEV *ScalarEvolution::getUMinFromMismatchedTypes(const SCEV *LHS,
3975                                                         const SCEV *RHS) {
3976   const SCEV *PromotedLHS = LHS;
3977   const SCEV *PromotedRHS = RHS;
3978
3979   if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
3980     PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
3981   else
3982     PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
3983
3984   return getUMinExpr(PromotedLHS, PromotedRHS);
3985 }
3986
3987 const SCEV *ScalarEvolution::getPointerBase(const SCEV *V) {
3988   // A pointer operand may evaluate to a nonpointer expression, such as null.
3989   if (!V->getType()->isPointerTy())
3990     return V;
3991
3992   if (const SCEVCastExpr *Cast = dyn_cast<SCEVCastExpr>(V)) {
3993     return getPointerBase(Cast->getOperand());
3994   } else if (const SCEVNAryExpr *NAry = dyn_cast<SCEVNAryExpr>(V)) {
3995     const SCEV *PtrOp = nullptr;
3996     for (const SCEV *NAryOp : NAry->operands()) {
3997       if (NAryOp->getType()->isPointerTy()) {
3998         // Cannot find the base of an expression with multiple pointer operands.
3999         if (PtrOp)
4000           return V;
4001         PtrOp = NAryOp;
4002       }
4003     }
4004     if (!PtrOp)
4005       return V;
4006     return getPointerBase(PtrOp);
4007   }
4008   return V;
4009 }
4010
4011 /// Push users of the given Instruction onto the given Worklist.
4012 static void
4013 PushDefUseChildren(Instruction *I,
4014                    SmallVectorImpl<Instruction *> &Worklist) {
4015   // Push the def-use children onto the Worklist stack.
4016   for (User *U : I->users())
4017     Worklist.push_back(cast<Instruction>(U));
4018 }
4019
4020 void ScalarEvolution::forgetSymbolicName(Instruction *PN, const SCEV *SymName) {
4021   SmallVector<Instruction *, 16> Worklist;
4022   PushDefUseChildren(PN, Worklist);
4023
4024   SmallPtrSet<Instruction *, 8> Visited;
4025   Visited.insert(PN);
4026   while (!Worklist.empty()) {
4027     Instruction *I = Worklist.pop_back_val();
4028     if (!Visited.insert(I).second)
4029       continue;
4030
4031     auto It = ValueExprMap.find_as(static_cast<Value *>(I));
4032     if (It != ValueExprMap.end()) {
4033       const SCEV *Old = It->second;
4034
4035       // Short-circuit the def-use traversal if the symbolic name
4036       // ceases to appear in expressions.
4037       if (Old != SymName && !hasOperand(Old, SymName))
4038         continue;
4039
4040       // SCEVUnknown for a PHI either means that it has an unrecognized
4041       // structure, it's a PHI that's in the progress of being computed
4042       // by createNodeForPHI, or it's a single-value PHI. In the first case,
4043       // additional loop trip count information isn't going to change anything.
4044       // In the second case, createNodeForPHI will perform the necessary
4045       // updates on its own when it gets to that point. In the third, we do
4046       // want to forget the SCEVUnknown.
4047       if (!isa<PHINode>(I) ||
4048           !isa<SCEVUnknown>(Old) ||
4049           (I != PN && Old == SymName)) {
4050         eraseValueFromMap(It->first);
4051         forgetMemoizedResults(Old);
4052       }
4053     }
4054
4055     PushDefUseChildren(I, Worklist);
4056   }
4057 }
4058
4059 namespace {
4060
4061 class SCEVInitRewriter : public SCEVRewriteVisitor<SCEVInitRewriter> {
4062 public:
4063   static const SCEV *rewrite(const SCEV *S, const Loop *L,
4064                              ScalarEvolution &SE) {
4065     SCEVInitRewriter Rewriter(L, SE);
4066     const SCEV *Result = Rewriter.visit(S);
4067     return Rewriter.isValid() ? Result : SE.getCouldNotCompute();
4068   }
4069
4070   const SCEV *visitUnknown(const SCEVUnknown *Expr) {
4071     if (!SE.isLoopInvariant(Expr, L))
4072       Valid = false;
4073     return Expr;
4074   }
4075
4076   const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) {
4077     // Only allow AddRecExprs for this loop.
4078     if (Expr->getLoop() == L)
4079       return Expr->getStart();
4080     Valid = false;
4081     return Expr;
4082   }
4083
4084   bool isValid() { return Valid; }
4085
4086 private:
4087   explicit SCEVInitRewriter(const Loop *L, ScalarEvolution &SE)
4088       : SCEVRewriteVisitor(SE), L(L) {}
4089
4090   const Loop *L;
4091   bool Valid = true;
4092 };
4093
4094 /// This class evaluates the compare condition by matching it against the
4095 /// condition of loop latch. If there is a match we assume a true value
4096 /// for the condition while building SCEV nodes.
4097 class SCEVBackedgeConditionFolder
4098     : public SCEVRewriteVisitor<SCEVBackedgeConditionFolder> {
4099 public:
4100   static const SCEV *rewrite(const SCEV *S, const Loop *L,
4101                              ScalarEvolution &SE) {
4102     bool IsPosBECond = false;
4103     Value *BECond = nullptr;
4104     if (BasicBlock *Latch = L->getLoopLatch()) {
4105       BranchInst *BI = dyn_cast<BranchInst>(Latch->getTerminator());
4106       if (BI && BI->isConditional()) {
4107         assert(BI->getSuccessor(0) != BI->getSuccessor(1) &&
4108                "Both outgoing branches should not target same header!");
4109         BECond = BI->getCondition();
4110         IsPosBECond = BI->getSuccessor(0) == L->getHeader();
4111       } else {
4112         return S;
4113       }
4114     }
4115     SCEVBackedgeConditionFolder Rewriter(L, BECond, IsPosBECond, SE);
4116     return Rewriter.visit(S);
4117   }
4118
4119   const SCEV *visitUnknown(const SCEVUnknown *Expr) {
4120     const SCEV *Result = Expr;
4121     bool InvariantF = SE.isLoopInvariant(Expr, L);
4122
4123     if (!InvariantF) {
4124       Instruction *I = cast<Instruction>(Expr->getValue());
4125       switch (I->getOpcode()) {
4126       case Instruction::Select: {
4127         SelectInst *SI = cast<SelectInst>(I);
4128         Optional<const SCEV *> Res =
4129             compareWithBackedgeCondition(SI->getCondition());
4130         if (Res.hasValue()) {
4131           bool IsOne = cast<SCEVConstant>(Res.getValue())->getValue()->isOne();
4132           Result = SE.getSCEV(IsOne ? SI->getTrueValue() : SI->getFalseValue());
4133         }
4134         break;
4135       }
4136       default: {
4137         Optional<const SCEV *> Res = compareWithBackedgeCondition(I);
4138         if (Res.hasValue())
4139           Result = Res.getValue();
4140         break;
4141       }
4142       }
4143     }
4144     return Result;
4145   }
4146
4147 private:
4148   explicit SCEVBackedgeConditionFolder(const Loop *L, Value *BECond,
4149                                        bool IsPosBECond, ScalarEvolution &SE)
4150       : SCEVRewriteVisitor(SE), L(L), BackedgeCond(BECond),
4151         IsPositiveBECond(IsPosBECond) {}
4152
4153   Optional<const SCEV *> compareWithBackedgeCondition(Value *IC);
4154
4155   const Loop *L;
4156   /// Loop back condition.
4157   Value *BackedgeCond = nullptr;
4158   /// Set to true if loop back is on positive branch condition.
4159   bool IsPositiveBECond;
4160 };
4161
4162 Optional<const SCEV *>
4163 SCEVBackedgeConditionFolder::compareWithBackedgeCondition(Value *IC) {
4164
4165   // If value matches the backedge condition for loop latch,
4166   // then return a constant evolution node based on loopback
4167   // branch taken.
4168   if (BackedgeCond == IC)
4169     return IsPositiveBECond ? SE.getOne(Type::getInt1Ty(SE.getContext()))
4170                             : SE.getZero(Type::getInt1Ty(SE.getContext()));
4171   return None;
4172 }
4173
4174 class SCEVShiftRewriter : public SCEVRewriteVisitor<SCEVShiftRewriter> {
4175 public:
4176   static const SCEV *rewrite(const SCEV *S, const Loop *L,
4177                              ScalarEvolution &SE) {
4178     SCEVShiftRewriter Rewriter(L, SE);
4179     const SCEV *Result = Rewriter.visit(S);
4180     return Rewriter.isValid() ? Result : SE.getCouldNotCompute();
4181   }
4182
4183   const SCEV *visitUnknown(const SCEVUnknown *Expr) {
4184     // Only allow AddRecExprs for this loop.
4185     if (!SE.isLoopInvariant(Expr, L))
4186       Valid = false;
4187     return Expr;
4188   }
4189
4190   const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) {
4191     if (Expr->getLoop() == L && Expr->isAffine())
4192       return SE.getMinusSCEV(Expr, Expr->getStepRecurrence(SE));
4193     Valid = false;
4194     return Expr;
4195   }
4196
4197   bool isValid() { return Valid; }
4198
4199 private:
4200   explicit SCEVShiftRewriter(const Loop *L, ScalarEvolution &SE)
4201       : SCEVRewriteVisitor(SE), L(L) {}
4202
4203   const Loop *L;
4204   bool Valid = true;
4205 };
4206
4207 } // end anonymous namespace
4208
4209 SCEV::NoWrapFlags
4210 ScalarEvolution::proveNoWrapViaConstantRanges(const SCEVAddRecExpr *AR) {
4211   if (!AR->isAffine())
4212     return SCEV::FlagAnyWrap;
4213
4214   using OBO = OverflowingBinaryOperator;
4215
4216   SCEV::NoWrapFlags Result = SCEV::FlagAnyWrap;
4217
4218   if (!AR->hasNoSignedWrap()) {
4219     ConstantRange AddRecRange = getSignedRange(AR);
4220     ConstantRange IncRange = getSignedRange(AR->getStepRecurrence(*this));
4221
4222     auto NSWRegion = ConstantRange::makeGuaranteedNoWrapRegion(
4223         Instruction::Add, IncRange, OBO::NoSignedWrap);
4224     if (NSWRegion.contains(AddRecRange))
4225       Result = ScalarEvolution::setFlags(Result, SCEV::FlagNSW);
4226   }
4227
4228   if (!AR->hasNoUnsignedWrap()) {
4229     ConstantRange AddRecRange = getUnsignedRange(AR);
4230     ConstantRange IncRange = getUnsignedRange(AR->getStepRecurrence(*this));
4231
4232     auto NUWRegion = ConstantRange::makeGuaranteedNoWrapRegion(
4233         Instruction::Add, IncRange, OBO::NoUnsignedWrap);
4234     if (NUWRegion.contains(AddRecRange))
4235       Result = ScalarEvolution::setFlags(Result, SCEV::FlagNUW);
4236   }
4237
4238   return Result;
4239 }
4240
4241 namespace {
4242
4243 /// Represents an abstract binary operation.  This may exist as a
4244 /// normal instruction or constant expression, or may have been
4245 /// derived from an expression tree.
4246 struct BinaryOp {
4247   unsigned Opcode;
4248   Value *LHS;
4249   Value *RHS;
4250   bool IsNSW = false;
4251   bool IsNUW = false;
4252
4253   /// Op is set if this BinaryOp corresponds to a concrete LLVM instruction or
4254   /// constant expression.
4255   Operator *Op = nullptr;
4256
4257   explicit BinaryOp(Operator *Op)
4258       : Opcode(Op->getOpcode()), LHS(Op->getOperand(0)), RHS(Op->getOperand(1)),
4259         Op(Op) {
4260     if (auto *OBO = dyn_cast<OverflowingBinaryOperator>(Op)) {
4261       IsNSW = OBO->hasNoSignedWrap();
4262       IsNUW = OBO->hasNoUnsignedWrap();
4263     }
4264   }
4265
4266   explicit BinaryOp(unsigned Opcode, Value *LHS, Value *RHS, bool IsNSW = false,
4267                     bool IsNUW = false)
4268       : Opcode(Opcode), LHS(LHS), RHS(RHS), IsNSW(IsNSW), IsNUW(IsNUW) {}
4269 };
4270
4271 } // end anonymous namespace
4272
4273 /// Try to map \p V into a BinaryOp, and return \c None on failure.
4274 static Optional<BinaryOp> MatchBinaryOp(Value *V, DominatorTree &DT) {
4275   auto *Op = dyn_cast<Operator>(V);
4276   if (!Op)
4277     return None;
4278
4279   // Implementation detail: all the cleverness here should happen without
4280   // creating new SCEV expressions -- our caller knowns tricks to avoid creating
4281   // SCEV expressions when possible, and we should not break that.
4282
4283   switch (Op->getOpcode()) {
4284   case Instruction::Add:
4285   case Instruction::Sub:
4286   case Instruction::Mul:
4287   case Instruction::UDiv:
4288   case Instruction::URem:
4289   case Instruction::And:
4290   case Instruction::Or:
4291   case Instruction::AShr:
4292   case Instruction::Shl:
4293     return BinaryOp(Op);
4294
4295   case Instruction::Xor:
4296     if (auto *RHSC = dyn_cast<ConstantInt>(Op->getOperand(1)))
4297       // If the RHS of the xor is a signmask, then this is just an add.
4298       // Instcombine turns add of signmask into xor as a strength reduction step.
4299       if (RHSC->getValue().isSignMask())
4300         return BinaryOp(Instruction::Add, Op->getOperand(0), Op->getOperand(1));
4301     return BinaryOp(Op);
4302
4303   case Instruction::LShr:
4304     // Turn logical shift right of a constant into a unsigned divide.
4305     if (ConstantInt *SA = dyn_cast<ConstantInt>(Op->getOperand(1))) {
4306       uint32_t BitWidth = cast<IntegerType>(Op->getType())->getBitWidth();
4307
4308       // If the shift count is not less than the bitwidth, the result of
4309       // the shift is undefined. Don't try to analyze it, because the
4310       // resolution chosen here may differ from the resolution chosen in
4311       // other parts of the compiler.
4312       if (SA->getValue().ult(BitWidth)) {
4313         Constant *X =
4314             ConstantInt::get(SA->getContext(),
4315                              APInt::getOneBitSet(BitWidth, SA->getZExtValue()));
4316         return BinaryOp(Instruction::UDiv, Op->getOperand(0), X);
4317       }
4318     }
4319     return BinaryOp(Op);
4320
4321   case Instruction::ExtractValue: {
4322     auto *EVI = cast<ExtractValueInst>(Op);
4323     if (EVI->getNumIndices() != 1 || EVI->getIndices()[0] != 0)
4324       break;
4325
4326     auto *CI = dyn_cast<CallInst>(EVI->getAggregateOperand());
4327     if (!CI)
4328       break;
4329
4330     if (auto *F = CI->getCalledFunction())
4331       switch (F->getIntrinsicID()) {
4332       case Intrinsic::sadd_with_overflow:
4333       case Intrinsic::uadd_with_overflow:
4334         if (!isOverflowIntrinsicNoWrap(cast<IntrinsicInst>(CI), DT))
4335           return BinaryOp(Instruction::Add, CI->getArgOperand(0),
4336                           CI->getArgOperand(1));
4337
4338         // Now that we know that all uses of the arithmetic-result component of
4339         // CI are guarded by the overflow check, we can go ahead and pretend
4340         // that the arithmetic is non-overflowing.
4341         if (F->getIntrinsicID() == Intrinsic::sadd_with_overflow)
4342           return BinaryOp(Instruction::Add, CI->getArgOperand(0),
4343                           CI->getArgOperand(1), /* IsNSW = */ true,
4344                           /* IsNUW = */ false);
4345         else
4346           return BinaryOp(Instruction::Add, CI->getArgOperand(0),
4347                           CI->getArgOperand(1), /* IsNSW = */ false,
4348                           /* IsNUW*/ true);
4349       case Intrinsic::ssub_with_overflow:
4350       case Intrinsic::usub_with_overflow:
4351         if (!isOverflowIntrinsicNoWrap(cast<IntrinsicInst>(CI), DT))
4352           return BinaryOp(Instruction::Sub, CI->getArgOperand(0),
4353                           CI->getArgOperand(1));
4354
4355         // The same reasoning as sadd/uadd above.
4356         if (F->getIntrinsicID() == Intrinsic::ssub_with_overflow)
4357           return BinaryOp(Instruction::Sub, CI->getArgOperand(0),
4358                           CI->getArgOperand(1), /* IsNSW = */ true,
4359                           /* IsNUW = */ false);
4360         else
4361           return BinaryOp(Instruction::Sub, CI->getArgOperand(0),
4362                           CI->getArgOperand(1), /* IsNSW = */ false,
4363                           /* IsNUW = */ true);
4364       case Intrinsic::smul_with_overflow:
4365       case Intrinsic::umul_with_overflow:
4366         return BinaryOp(Instruction::Mul, CI->getArgOperand(0),
4367                         CI->getArgOperand(1));
4368       default:
4369         break;
4370       }
4371     break;
4372   }
4373
4374   default:
4375     break;
4376   }
4377
4378   return None;
4379 }
4380
4381 /// Helper function to createAddRecFromPHIWithCasts. We have a phi
4382 /// node whose symbolic (unknown) SCEV is \p SymbolicPHI, which is updated via
4383 /// the loop backedge by a SCEVAddExpr, possibly also with a few casts on the
4384 /// way. This function checks if \p Op, an operand of this SCEVAddExpr,
4385 /// follows one of the following patterns:
4386 /// Op == (SExt ix (Trunc iy (%SymbolicPHI) to ix) to iy)
4387 /// Op == (ZExt ix (Trunc iy (%SymbolicPHI) to ix) to iy)
4388 /// If the SCEV expression of \p Op conforms with one of the expected patterns
4389 /// we return the type of the truncation operation, and indicate whether the
4390 /// truncated type should be treated as signed/unsigned by setting
4391 /// \p Signed to true/false, respectively.
4392 static Type *isSimpleCastedPHI(const SCEV *Op, const SCEVUnknown *SymbolicPHI,
4393                                bool &Signed, ScalarEvolution &SE) {
4394   // The case where Op == SymbolicPHI (that is, with no type conversions on
4395   // the way) is handled by the regular add recurrence creating logic and
4396   // would have already been triggered in createAddRecForPHI. Reaching it here
4397   // means that createAddRecFromPHI had failed for this PHI before (e.g.,
4398   // because one of the other operands of the SCEVAddExpr updating this PHI is
4399   // not invariant).
4400   //
4401   // Here we look for the case where Op = (ext(trunc(SymbolicPHI))), and in
4402   // this case predicates that allow us to prove that Op == SymbolicPHI will
4403   // be added.
4404   if (Op == SymbolicPHI)
4405     return nullptr;
4406
4407   unsigned SourceBits = SE.getTypeSizeInBits(SymbolicPHI->getType());
4408   unsigned NewBits = SE.getTypeSizeInBits(Op->getType());
4409   if (SourceBits != NewBits)
4410     return nullptr;
4411
4412   const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(Op);
4413   const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(Op);
4414   if (!SExt && !ZExt)
4415     return nullptr;
4416   const SCEVTruncateExpr *Trunc =
4417       SExt ? dyn_cast<SCEVTruncateExpr>(SExt->getOperand())
4418            : dyn_cast<SCEVTruncateExpr>(ZExt->getOperand());
4419   if (!Trunc)
4420     return nullptr;
4421   const SCEV *X = Trunc->getOperand();
4422   if (X != SymbolicPHI)
4423     return nullptr;
4424   Signed = SExt != nullptr;
4425   return Trunc->getType();
4426 }
4427
4428 static const Loop *isIntegerLoopHeaderPHI(const PHINode *PN, LoopInfo &LI) {
4429   if (!PN->getType()->isIntegerTy())
4430     return nullptr;
4431   const Loop *L = LI.getLoopFor(PN->getParent());
4432   if (!L || L->getHeader() != PN->getParent())
4433     return nullptr;
4434   return L;
4435 }
4436
4437 // Analyze \p SymbolicPHI, a SCEV expression of a phi node, and check if the
4438 // computation that updates the phi follows the following pattern:
4439 //   (SExt/ZExt ix (Trunc iy (%SymbolicPHI) to ix) to iy) + InvariantAccum
4440 // which correspond to a phi->trunc->sext/zext->add->phi update chain.
4441 // If so, try to see if it can be rewritten as an AddRecExpr under some
4442 // Predicates. If successful, return them as a pair. Also cache the results
4443 // of the analysis.
4444 //
4445 // Example usage scenario:
4446 //    Say the Rewriter is called for the following SCEV:
4447 //         8 * ((sext i32 (trunc i64 %X to i32) to i64) + %Step)
4448 //    where:
4449 //         %X = phi i64 (%Start, %BEValue)
4450 //    It will visitMul->visitAdd->visitSExt->visitTrunc->visitUnknown(%X),
4451 //    and call this function with %SymbolicPHI = %X.
4452 //
4453 //    The analysis will find that the value coming around the backedge has
4454 //    the following SCEV:
4455 //         BEValue = ((sext i32 (trunc i64 %X to i32) to i64) + %Step)
4456 //    Upon concluding that this matches the desired pattern, the function
4457 //    will return the pair {NewAddRec, SmallPredsVec} where:
4458 //         NewAddRec = {%Start,+,%Step}
4459 //         SmallPredsVec = {P1, P2, P3} as follows:
4460 //           P1(WrapPred): AR: {trunc(%Start),+,(trunc %Step)}<nsw> Flags: <nssw>
4461 //           P2(EqualPred): %Start == (sext i32 (trunc i64 %Start to i32) to i64)
4462 //           P3(EqualPred): %Step == (sext i32 (trunc i64 %Step to i32) to i64)
4463 //    The returned pair means that SymbolicPHI can be rewritten into NewAddRec
4464 //    under the predicates {P1,P2,P3}.
4465 //    This predicated rewrite will be cached in PredicatedSCEVRewrites:
4466 //         PredicatedSCEVRewrites[{%X,L}] = {NewAddRec, {P1,P2,P3)}
4467 //
4468 // TODO's:
4469 //
4470 // 1) Extend the Induction descriptor to also support inductions that involve
4471 //    casts: When needed (namely, when we are called in the context of the
4472 //    vectorizer induction analysis), a Set of cast instructions will be
4473 //    populated by this method, and provided back to isInductionPHI. This is
4474 //    needed to allow the vectorizer to properly record them to be ignored by
4475 //    the cost model and to avoid vectorizing them (otherwise these casts,
4476 //    which are redundant under the runtime overflow checks, will be
4477 //    vectorized, which can be costly).
4478 //
4479 // 2) Support additional induction/PHISCEV patterns: We also want to support
4480 //    inductions where the sext-trunc / zext-trunc operations (partly) occur
4481 //    after the induction update operation (the induction increment):
4482 //
4483 //      (Trunc iy (SExt/ZExt ix (%SymbolicPHI + InvariantAccum) to iy) to ix)
4484 //    which correspond to a phi->add->trunc->sext/zext->phi update chain.
4485 //
4486 //      (Trunc iy ((SExt/ZExt ix (%SymbolicPhi) to iy) + InvariantAccum) to ix)
4487 //    which correspond to a phi->trunc->add->sext/zext->phi update chain.
4488 //
4489 // 3) Outline common code with createAddRecFromPHI to avoid duplication.
4490 Optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>>
4491 ScalarEvolution::createAddRecFromPHIWithCastsImpl(const SCEVUnknown *SymbolicPHI) {
4492   SmallVector<const SCEVPredicate *, 3> Predicates;
4493
4494   // *** Part1: Analyze if we have a phi-with-cast pattern for which we can
4495   // return an AddRec expression under some predicate.
4496
4497   auto *PN = cast<PHINode>(SymbolicPHI->getValue());
4498   const Loop *L = isIntegerLoopHeaderPHI(PN, LI);
4499   assert(L && "Expecting an integer loop header phi");
4500
4501   // The loop may have multiple entrances or multiple exits; we can analyze
4502   // this phi as an addrec if it has a unique entry value and a unique
4503   // backedge value.
4504   Value *BEValueV = nullptr, *StartValueV = nullptr;
4505   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
4506     Value *V = PN->getIncomingValue(i);
4507     if (L->contains(PN->getIncomingBlock(i))) {
4508       if (!BEValueV) {
4509         BEValueV = V;
4510       } else if (BEValueV != V) {
4511         BEValueV = nullptr;
4512         break;
4513       }
4514     } else if (!StartValueV) {
4515       StartValueV = V;
4516     } else if (StartValueV != V) {
4517       StartValueV = nullptr;
4518       break;
4519     }
4520   }
4521   if (!BEValueV || !StartValueV)
4522     return None;
4523
4524   const SCEV *BEValue = getSCEV(BEValueV);
4525
4526   // If the value coming around the backedge is an add with the symbolic
4527   // value we just inserted, possibly with casts that we can ignore under
4528   // an appropriate runtime guard, then we found a simple induction variable!
4529   const auto *Add = dyn_cast<SCEVAddExpr>(BEValue);
4530   if (!Add)
4531     return None;
4532
4533   // If there is a single occurrence of the symbolic value, possibly
4534   // casted, replace it with a recurrence.
4535   unsigned FoundIndex = Add->getNumOperands();
4536   Type *TruncTy = nullptr;
4537   bool Signed;
4538   for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
4539     if ((TruncTy =
4540              isSimpleCastedPHI(Add->getOperand(i), SymbolicPHI, Signed, *this)))
4541       if (FoundIndex == e) {
4542         FoundIndex = i;
4543         break;
4544       }
4545
4546   if (FoundIndex == Add->getNumOperands())
4547     return None;
4548
4549   // Create an add with everything but the specified operand.
4550   SmallVector<const SCEV *, 8> Ops;
4551   for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
4552     if (i != FoundIndex)
4553       Ops.push_back(Add->getOperand(i));
4554   const SCEV *Accum = getAddExpr(Ops);
4555
4556   // The runtime checks will not be valid if the step amount is
4557   // varying inside the loop.
4558   if (!isLoopInvariant(Accum, L))
4559     return None;
4560
4561   // *** Part2: Create the predicates
4562
4563   // Analysis was successful: we have a phi-with-cast pattern for which we
4564   // can return an AddRec expression under the following predicates:
4565   //
4566   // P1: A Wrap predicate that guarantees that Trunc(Start) + i*Trunc(Accum)
4567   //     fits within the truncated type (does not overflow) for i = 0 to n-1.
4568   // P2: An Equal predicate that guarantees that
4569   //     Start = (Ext ix (Trunc iy (Start) to ix) to iy)
4570   // P3: An Equal predicate that guarantees that
4571   //     Accum = (Ext ix (Trunc iy (Accum) to ix) to iy)
4572   //
4573   // As we next prove, the above predicates guarantee that:
4574   //     Start + i*Accum = (Ext ix (Trunc iy ( Start + i*Accum ) to ix) to iy)
4575   //
4576   //
4577   // More formally, we want to prove that:
4578   //     Expr(i+1) = Start + (i+1) * Accum
4579   //               = (Ext ix (Trunc iy (Expr(i)) to ix) to iy) + Accum
4580   //
4581   // Given that:
4582   // 1) Expr(0) = Start
4583   // 2) Expr(1) = Start + Accum
4584   //            = (Ext ix (Trunc iy (Start) to ix) to iy) + Accum :: from P2
4585   // 3) Induction hypothesis (step i):
4586   //    Expr(i) = (Ext ix (Trunc iy (Expr(i-1)) to ix) to iy) + Accum
4587   //
4588   // Proof:
4589   //  Expr(i+1) =
4590   //   = Start + (i+1)*Accum
4591   //   = (Start + i*Accum) + Accum
4592   //   = Expr(i) + Accum
4593   //   = (Ext ix (Trunc iy (Expr(i-1)) to ix) to iy) + Accum + Accum
4594   //                                                             :: from step i
4595   //
4596   //   = (Ext ix (Trunc iy (Start + (i-1)*Accum) to ix) to iy) + Accum + Accum
4597   //
4598   //   = (Ext ix (Trunc iy (Start + (i-1)*Accum) to ix) to iy)
4599   //     + (Ext ix (Trunc iy (Accum) to ix) to iy)
4600   //     + Accum                                                     :: from P3
4601   //
4602   //   = (Ext ix (Trunc iy ((Start + (i-1)*Accum) + Accum) to ix) to iy)
4603   //     + Accum                            :: from P1: Ext(x)+Ext(y)=>Ext(x+y)
4604   //
4605   //   = (Ext ix (Trunc iy (Start + i*Accum) to ix) to iy) + Accum
4606   //   = (Ext ix (Trunc iy (Expr(i)) to ix) to iy) + Accum
4607   //
4608   // By induction, the same applies to all iterations 1<=i<n:
4609   //
4610
4611   // Create a truncated addrec for which we will add a no overflow check (P1).
4612   const SCEV *StartVal = getSCEV(StartValueV);
4613   const SCEV *PHISCEV =
4614       getAddRecExpr(getTruncateExpr(StartVal, TruncTy),
4615                     getTruncateExpr(Accum, TruncTy), L, SCEV::FlagAnyWrap);
4616
4617   // PHISCEV can be either a SCEVConstant or a SCEVAddRecExpr.
4618   // ex: If truncated Accum is 0 and StartVal is a constant, then PHISCEV
4619   // will be constant.
4620   //
4621   //  If PHISCEV is a constant, then P1 degenerates into P2 or P3, so we don't
4622   // add P1.
4623   if (const auto *AR = dyn_cast<SCEVAddRecExpr>(PHISCEV)) {
4624     SCEVWrapPredicate::IncrementWrapFlags AddedFlags =
4625         Signed ? SCEVWrapPredicate::IncrementNSSW
4626                : SCEVWrapPredicate::IncrementNUSW;
4627     const SCEVPredicate *AddRecPred = getWrapPredicate(AR, AddedFlags);
4628     Predicates.push_back(AddRecPred);
4629   }
4630
4631   // Create the Equal Predicates P2,P3:
4632
4633   // It is possible that the predicates P2 and/or P3 are computable at
4634   // compile time due to StartVal and/or Accum being constants.
4635   // If either one is, then we can check that now and escape if either P2
4636   // or P3 is false.
4637
4638   // Construct the extended SCEV: (Ext ix (Trunc iy (Expr) to ix) to iy)
4639   // for each of StartVal and Accum
4640   auto getExtendedExpr = [&](const SCEV *Expr,
4641                              bool CreateSignExtend) -> const SCEV * {
4642     assert(isLoopInvariant(Expr, L) && "Expr is expected to be invariant");
4643     const SCEV *TruncatedExpr = getTruncateExpr(Expr, TruncTy);
4644     const SCEV *ExtendedExpr =
4645         CreateSignExtend ? getSignExtendExpr(TruncatedExpr, Expr->getType())
4646                          : getZeroExtendExpr(TruncatedExpr, Expr->getType());
4647     return ExtendedExpr;
4648   };
4649
4650   // Given:
4651   //  ExtendedExpr = (Ext ix (Trunc iy (Expr) to ix) to iy
4652   //               = getExtendedExpr(Expr)
4653   // Determine whether the predicate P: Expr == ExtendedExpr
4654   // is known to be false at compile time
4655   auto PredIsKnownFalse = [&](const SCEV *Expr,
4656                               const SCEV *ExtendedExpr) -> bool {
4657     return Expr != ExtendedExpr &&
4658            isKnownPredicate(ICmpInst::ICMP_NE, Expr, ExtendedExpr);
4659   };
4660
4661   const SCEV *StartExtended = getExtendedExpr(StartVal, Signed);
4662   if (PredIsKnownFalse(StartVal, StartExtended)) {
4663     DEBUG(dbgs() << "P2 is compile-time false\n";);
4664     return None;
4665   }
4666
4667   // The Step is always Signed (because the overflow checks are either
4668   // NSSW or NUSW)
4669   const SCEV *AccumExtended = getExtendedExpr(Accum, /*CreateSignExtend=*/true);
4670   if (PredIsKnownFalse(Accum, AccumExtended)) {
4671     DEBUG(dbgs() << "P3 is compile-time false\n";);
4672     return None;
4673   }
4674
4675   auto AppendPredicate = [&](const SCEV *Expr,
4676                              const SCEV *ExtendedExpr) -> void {
4677     if (Expr != ExtendedExpr &&
4678         !isKnownPredicate(ICmpInst::ICMP_EQ, Expr, ExtendedExpr)) {
4679       const SCEVPredicate *Pred = getEqualPredicate(Expr, ExtendedExpr);
4680       DEBUG (dbgs() << "Added Predicate: " << *Pred);
4681       Predicates.push_back(Pred);
4682     }
4683   };
4684
4685   AppendPredicate(StartVal, StartExtended);
4686   AppendPredicate(Accum, AccumExtended);
4687
4688   // *** Part3: Predicates are ready. Now go ahead and create the new addrec in
4689   // which the casts had been folded away. The caller can rewrite SymbolicPHI
4690   // into NewAR if it will also add the runtime overflow checks specified in
4691   // Predicates.
4692   auto *NewAR = getAddRecExpr(StartVal, Accum, L, SCEV::FlagAnyWrap);
4693
4694   std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>> PredRewrite =
4695       std::make_pair(NewAR, Predicates);
4696   // Remember the result of the analysis for this SCEV at this locayyytion.
4697   PredicatedSCEVRewrites[{SymbolicPHI, L}] = PredRewrite;
4698   return PredRewrite;
4699 }
4700
4701 Optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>>
4702 ScalarEvolution::createAddRecFromPHIWithCasts(const SCEVUnknown *SymbolicPHI) {
4703   auto *PN = cast<PHINode>(SymbolicPHI->getValue());
4704   const Loop *L = isIntegerLoopHeaderPHI(PN, LI);
4705   if (!L)
4706     return None;
4707
4708   // Check to see if we already analyzed this PHI.
4709   auto I = PredicatedSCEVRewrites.find({SymbolicPHI, L});
4710   if (I != PredicatedSCEVRewrites.end()) {
4711     std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>> Rewrite =
4712         I->second;
4713     // Analysis was done before and failed to create an AddRec:
4714     if (Rewrite.first == SymbolicPHI)
4715       return None;
4716     // Analysis was done before and succeeded to create an AddRec under
4717     // a predicate:
4718     assert(isa<SCEVAddRecExpr>(Rewrite.first) && "Expected an AddRec");
4719     assert(!(Rewrite.second).empty() && "Expected to find Predicates");
4720     return Rewrite;
4721   }
4722
4723   Optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>>
4724     Rewrite = createAddRecFromPHIWithCastsImpl(SymbolicPHI);
4725
4726   // Record in the cache that the analysis failed
4727   if (!Rewrite) {
4728     SmallVector<const SCEVPredicate *, 3> Predicates;
4729     PredicatedSCEVRewrites[{SymbolicPHI, L}] = {SymbolicPHI, Predicates};
4730     return None;
4731   }
4732
4733   return Rewrite;
4734 }
4735
4736 // FIXME: This utility is currently required because the Rewriter currently
4737 // does not rewrite this expression:
4738 // {0, +, (sext ix (trunc iy to ix) to iy)}
4739 // into {0, +, %step},
4740 // even when the following Equal predicate exists:
4741 // "%step == (sext ix (trunc iy to ix) to iy)".
4742 bool PredicatedScalarEvolution::areAddRecsEqualWithPreds(
4743     const SCEVAddRecExpr *AR1, const SCEVAddRecExpr *AR2) const {
4744   if (AR1 == AR2)
4745     return true;
4746
4747   auto areExprsEqual = [&](const SCEV *Expr1, const SCEV *Expr2) -> bool {
4748     if (Expr1 != Expr2 && !Preds.implies(SE.getEqualPredicate(Expr1, Expr2)) &&
4749         !Preds.implies(SE.getEqualPredicate(Expr2, Expr1)))
4750       return false;
4751     return true;
4752   };
4753
4754   if (!areExprsEqual(AR1->getStart(), AR2->getStart()) ||
4755       !areExprsEqual(AR1->getStepRecurrence(SE), AR2->getStepRecurrence(SE)))
4756     return false;
4757   return true;
4758 }
4759
4760 /// A helper function for createAddRecFromPHI to handle simple cases.
4761 ///
4762 /// This function tries to find an AddRec expression for the simplest (yet most
4763 /// common) cases: PN = PHI(Start, OP(Self, LoopInvariant)).
4764 /// If it fails, createAddRecFromPHI will use a more general, but slow,
4765 /// technique for finding the AddRec expression.
4766 const SCEV *ScalarEvolution::createSimpleAffineAddRec(PHINode *PN,
4767                                                       Value *BEValueV,
4768                                                       Value *StartValueV) {
4769   const Loop *L = LI.getLoopFor(PN->getParent());
4770   assert(L && L->getHeader() == PN->getParent());
4771   assert(BEValueV && StartValueV);
4772
4773   auto BO = MatchBinaryOp(BEValueV, DT);
4774   if (!BO)
4775     return nullptr;
4776
4777   if (BO->Opcode != Instruction::Add)
4778     return nullptr;
4779
4780   const SCEV *Accum = nullptr;
4781   if (BO->LHS == PN && L->isLoopInvariant(BO->RHS))
4782     Accum = getSCEV(BO->RHS);
4783   else if (BO->RHS == PN && L->isLoopInvariant(BO->LHS))
4784     Accum = getSCEV(BO->LHS);
4785
4786   if (!Accum)
4787     return nullptr;
4788
4789   SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap;
4790   if (BO->IsNUW)
4791     Flags = setFlags(Flags, SCEV::FlagNUW);
4792   if (BO->IsNSW)
4793     Flags = setFlags(Flags, SCEV::FlagNSW);
4794
4795   const SCEV *StartVal = getSCEV(StartValueV);
4796   const SCEV *PHISCEV = getAddRecExpr(StartVal, Accum, L, Flags);
4797
4798   ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
4799
4800   // We can add Flags to the post-inc expression only if we
4801   // know that it is *undefined behavior* for BEValueV to
4802   // overflow.
4803   if (auto *BEInst = dyn_cast<Instruction>(BEValueV))
4804     if (isLoopInvariant(Accum, L) && isAddRecNeverPoison(BEInst, L))
4805       (void)getAddRecExpr(getAddExpr(StartVal, Accum), Accum, L, Flags);
4806
4807   return PHISCEV;
4808 }
4809
4810 const SCEV *ScalarEvolution::createAddRecFromPHI(PHINode *PN) {
4811   const Loop *L = LI.getLoopFor(PN->getParent());
4812   if (!L || L->getHeader() != PN->getParent())
4813     return nullptr;
4814
4815   // The loop may have multiple entrances or multiple exits; we can analyze
4816   // this phi as an addrec if it has a unique entry value and a unique
4817   // backedge value.
4818   Value *BEValueV = nullptr, *StartValueV = nullptr;
4819   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
4820     Value *V = PN->getIncomingValue(i);
4821     if (L->contains(PN->getIncomingBlock(i))) {
4822       if (!BEValueV) {
4823         BEValueV = V;
4824       } else if (BEValueV != V) {
4825         BEValueV = nullptr;
4826         break;
4827       }
4828     } else if (!StartValueV) {
4829       StartValueV = V;
4830     } else if (StartValueV != V) {
4831       StartValueV = nullptr;
4832       break;
4833     }
4834   }
4835   if (!BEValueV || !StartValueV)
4836     return nullptr;
4837
4838   assert(ValueExprMap.find_as(PN) == ValueExprMap.end() &&
4839          "PHI node already processed?");
4840
4841   // First, try to find AddRec expression without creating a fictituos symbolic
4842   // value for PN.
4843   if (auto *S = createSimpleAffineAddRec(PN, BEValueV, StartValueV))
4844     return S;
4845
4846   // Handle PHI node value symbolically.
4847   const SCEV *SymbolicName = getUnknown(PN);
4848   ValueExprMap.insert({SCEVCallbackVH(PN, this), SymbolicName});
4849
4850   // Using this symbolic name for the PHI, analyze the value coming around
4851   // the back-edge.
4852   const SCEV *BEValue = getSCEV(BEValueV);
4853
4854   // NOTE: If BEValue is loop invariant, we know that the PHI node just
4855   // has a special value for the first iteration of the loop.
4856
4857   // If the value coming around the backedge is an add with the symbolic
4858   // value we just inserted, then we found a simple induction variable!
4859   if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(BEValue)) {
4860     // If there is a single occurrence of the symbolic value, replace it
4861     // with a recurrence.
4862     unsigned FoundIndex = Add->getNumOperands();
4863     for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
4864       if (Add->getOperand(i) == SymbolicName)
4865         if (FoundIndex == e) {
4866           FoundIndex = i;
4867           break;
4868         }
4869
4870     if (FoundIndex != Add->getNumOperands()) {
4871       // Create an add with everything but the specified operand.
4872       SmallVector<const SCEV *, 8> Ops;
4873       for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
4874         if (i != FoundIndex)
4875           Ops.push_back(SCEVBackedgeConditionFolder::rewrite(Add->getOperand(i),
4876                                                              L, *this));
4877       const SCEV *Accum = getAddExpr(Ops);
4878
4879       // This is not a valid addrec if the step amount is varying each
4880       // loop iteration, but is not itself an addrec in this loop.
4881       if (isLoopInvariant(Accum, L) ||
4882           (isa<SCEVAddRecExpr>(Accum) &&
4883            cast<SCEVAddRecExpr>(Accum)->getLoop() == L)) {
4884         SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap;
4885
4886         if (auto BO = MatchBinaryOp(BEValueV, DT)) {
4887           if (BO->Opcode == Instruction::Add && BO->LHS == PN) {
4888             if (BO->IsNUW)
4889               Flags = setFlags(Flags, SCEV::FlagNUW);
4890             if (BO->IsNSW)
4891               Flags = setFlags(Flags, SCEV::FlagNSW);
4892           }
4893         } else if (GEPOperator *GEP = dyn_cast<GEPOperator>(BEValueV)) {
4894           // If the increment is an inbounds GEP, then we know the address
4895           // space cannot be wrapped around. We cannot make any guarantee
4896           // about signed or unsigned overflow because pointers are
4897           // unsigned but we may have a negative index from the base
4898           // pointer. We can guarantee that no unsigned wrap occurs if the
4899           // indices form a positive value.
4900           if (GEP->isInBounds() && GEP->getOperand(0) == PN) {
4901             Flags = setFlags(Flags, SCEV::FlagNW);
4902
4903             const SCEV *Ptr = getSCEV(GEP->getPointerOperand());
4904             if (isKnownPositive(getMinusSCEV(getSCEV(GEP), Ptr)))
4905               Flags = setFlags(Flags, SCEV::FlagNUW);
4906           }
4907
4908           // We cannot transfer nuw and nsw flags from subtraction
4909           // operations -- sub nuw X, Y is not the same as add nuw X, -Y
4910           // for instance.
4911         }
4912
4913         const SCEV *StartVal = getSCEV(StartValueV);
4914         const SCEV *PHISCEV = getAddRecExpr(StartVal, Accum, L, Flags);
4915
4916         // Okay, for the entire analysis of this edge we assumed the PHI
4917         // to be symbolic.  We now need to go back and purge all of the
4918         // entries for the scalars that use the symbolic expression.
4919         forgetSymbolicName(PN, SymbolicName);
4920         ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
4921
4922         // We can add Flags to the post-inc expression only if we
4923         // know that it is *undefined behavior* for BEValueV to
4924         // overflow.
4925         if (auto *BEInst = dyn_cast<Instruction>(BEValueV))
4926           if (isLoopInvariant(Accum, L) && isAddRecNeverPoison(BEInst, L))
4927             (void)getAddRecExpr(getAddExpr(StartVal, Accum), Accum, L, Flags);
4928
4929         return PHISCEV;
4930       }
4931     }
4932   } else {
4933     // Otherwise, this could be a loop like this:
4934     //     i = 0;  for (j = 1; ..; ++j) { ....  i = j; }
4935     // In this case, j = {1,+,1}  and BEValue is j.
4936     // Because the other in-value of i (0) fits the evolution of BEValue
4937     // i really is an addrec evolution.
4938     //
4939     // We can generalize this saying that i is the shifted value of BEValue
4940     // by one iteration:
4941     //   PHI(f(0), f({1,+,1})) --> f({0,+,1})
4942     const SCEV *Shifted = SCEVShiftRewriter::rewrite(BEValue, L, *this);
4943     const SCEV *Start = SCEVInitRewriter::rewrite(Shifted, L, *this);
4944     if (Shifted != getCouldNotCompute() &&
4945         Start != getCouldNotCompute()) {
4946       const SCEV *StartVal = getSCEV(StartValueV);
4947       if (Start == StartVal) {
4948         // Okay, for the entire analysis of this edge we assumed the PHI
4949         // to be symbolic.  We now need to go back and purge all of the
4950         // entries for the scalars that use the symbolic expression.
4951         forgetSymbolicName(PN, SymbolicName);
4952         ValueExprMap[SCEVCallbackVH(PN, this)] = Shifted;
4953         return Shifted;
4954       }
4955     }
4956   }
4957
4958   // Remove the temporary PHI node SCEV that has been inserted while intending
4959   // to create an AddRecExpr for this PHI node. We can not keep this temporary
4960   // as it will prevent later (possibly simpler) SCEV expressions to be added
4961   // to the ValueExprMap.
4962   eraseValueFromMap(PN);
4963
4964   return nullptr;
4965 }
4966
4967 // Checks if the SCEV S is available at BB.  S is considered available at BB
4968 // if S can be materialized at BB without introducing a fault.
4969 static bool IsAvailableOnEntry(const Loop *L, DominatorTree &DT, const SCEV *S,
4970                                BasicBlock *BB) {
4971   struct CheckAvailable {
4972     bool TraversalDone = false;
4973     bool Available = true;
4974
4975     const Loop *L = nullptr;  // The loop BB is in (can be nullptr)
4976     BasicBlock *BB = nullptr;
4977     DominatorTree &DT;
4978
4979     CheckAvailable(const Loop *L, BasicBlock *BB, DominatorTree &DT)
4980       : L(L), BB(BB), DT(DT) {}
4981
4982     bool setUnavailable() {
4983       TraversalDone = true;
4984       Available = false;
4985       return false;
4986     }
4987
4988     bool follow(const SCEV *S) {
4989       switch (S->getSCEVType()) {
4990       case scConstant: case scTruncate: case scZeroExtend: case scSignExtend:
4991       case scAddExpr: case scMulExpr: case scUMaxExpr: case scSMaxExpr:
4992         // These expressions are available if their operand(s) is/are.
4993         return true;
4994
4995       case scAddRecExpr: {
4996         // We allow add recurrences that are on the loop BB is in, or some
4997         // outer loop.  This guarantees availability because the value of the
4998         // add recurrence at BB is simply the "current" value of the induction
4999         // variable.  We can relax this in the future; for instance an add
5000         // recurrence on a sibling dominating loop is also available at BB.
5001         const auto *ARLoop = cast<SCEVAddRecExpr>(S)->getLoop();
5002         if (L && (ARLoop == L || ARLoop->contains(L)))
5003           return true;
5004
5005         return setUnavailable();
5006       }
5007
5008       case scUnknown: {
5009         // For SCEVUnknown, we check for simple dominance.
5010         const auto *SU = cast<SCEVUnknown>(S);
5011         Value *V = SU->getValue();
5012
5013         if (isa<Argument>(V))
5014           return false;
5015
5016         if (isa<Instruction>(V) && DT.dominates(cast<Instruction>(V), BB))
5017           return false;
5018
5019         return setUnavailable();
5020       }
5021
5022       case scUDivExpr:
5023       case scCouldNotCompute:
5024         // We do not try to smart about these at all.
5025         return setUnavailable();
5026       }
5027       llvm_unreachable("switch should be fully covered!");
5028     }
5029
5030     bool isDone() { return TraversalDone; }
5031   };
5032
5033   CheckAvailable CA(L, BB, DT);
5034   SCEVTraversal<CheckAvailable> ST(CA);
5035
5036   ST.visitAll(S);
5037   return CA.Available;
5038 }
5039
5040 // Try to match a control flow sequence that branches out at BI and merges back
5041 // at Merge into a "C ? LHS : RHS" select pattern.  Return true on a successful
5042 // match.
5043 static bool BrPHIToSelect(DominatorTree &DT, BranchInst *BI, PHINode *Merge,
5044                           Value *&C, Value *&LHS, Value *&RHS) {
5045   C = BI->getCondition();
5046
5047   BasicBlockEdge LeftEdge(BI->getParent(), BI->getSuccessor(0));
5048   BasicBlockEdge RightEdge(BI->getParent(), BI->getSuccessor(1));
5049
5050   if (!LeftEdge.isSingleEdge())
5051     return false;
5052
5053   assert(RightEdge.isSingleEdge() && "Follows from LeftEdge.isSingleEdge()");
5054
5055   Use &LeftUse = Merge->getOperandUse(0);
5056   Use &RightUse = Merge->getOperandUse(1);
5057
5058   if (DT.dominates(LeftEdge, LeftUse) && DT.dominates(RightEdge, RightUse)) {
5059     LHS = LeftUse;
5060     RHS = RightUse;
5061     return true;
5062   }
5063
5064   if (DT.dominates(LeftEdge, RightUse) && DT.dominates(RightEdge, LeftUse)) {
5065     LHS = RightUse;
5066     RHS = LeftUse;
5067     return true;
5068   }
5069
5070   return false;
5071 }
5072
5073 const SCEV *ScalarEvolution::createNodeFromSelectLikePHI(PHINode *PN) {
5074   auto IsReachable =
5075       [&](BasicBlock *BB) { return DT.isReachableFromEntry(BB); };
5076   if (PN->getNumIncomingValues() == 2 && all_of(PN->blocks(), IsReachable)) {
5077     const Loop *L = LI.getLoopFor(PN->getParent());
5078
5079     // We don't want to break LCSSA, even in a SCEV expression tree.
5080     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
5081       if (LI.getLoopFor(PN->getIncomingBlock(i)) != L)
5082         return nullptr;
5083
5084     // Try to match
5085     //
5086     //  br %cond, label %left, label %right
5087     // left:
5088     //  br label %merge
5089     // right:
5090     //  br label %merge
5091     // merge:
5092     //  V = phi [ %x, %left ], [ %y, %right ]
5093     //
5094     // as "select %cond, %x, %y"
5095
5096     BasicBlock *IDom = DT[PN->getParent()]->getIDom()->getBlock();
5097     assert(IDom && "At least the entry block should dominate PN");
5098
5099     auto *BI = dyn_cast<BranchInst>(IDom->getTerminator());
5100     Value *Cond = nullptr, *LHS = nullptr, *RHS = nullptr;
5101
5102     if (BI && BI->isConditional() &&
5103         BrPHIToSelect(DT, BI, PN, Cond, LHS, RHS) &&
5104         IsAvailableOnEntry(L, DT, getSCEV(LHS), PN->getParent()) &&
5105         IsAvailableOnEntry(L, DT, getSCEV(RHS), PN->getParent()))
5106       return createNodeForSelectOrPHI(PN, Cond, LHS, RHS);
5107   }
5108
5109   return nullptr;
5110 }
5111
5112 const SCEV *ScalarEvolution::createNodeForPHI(PHINode *PN) {
5113   if (const SCEV *S = createAddRecFromPHI(PN))
5114     return S;
5115
5116   if (const SCEV *S = createNodeFromSelectLikePHI(PN))
5117     return S;
5118
5119   // If the PHI has a single incoming value, follow that value, unless the
5120   // PHI's incoming blocks are in a different loop, in which case doing so
5121   // risks breaking LCSSA form. Instcombine would normally zap these, but
5122   // it doesn't have DominatorTree information, so it may miss cases.
5123   if (Value *V = SimplifyInstruction(PN, {getDataLayout(), &TLI, &DT, &AC}))
5124     if (LI.replacementPreservesLCSSAForm(PN, V))
5125       return getSCEV(V);
5126
5127   // If it's not a loop phi, we can't handle it yet.
5128   return getUnknown(PN);
5129 }
5130
5131 const SCEV *ScalarEvolution::createNodeForSelectOrPHI(Instruction *I,
5132                                                       Value *Cond,
5133                                                       Value *TrueVal,
5134                                                       Value *FalseVal) {
5135   // Handle "constant" branch or select. This can occur for instance when a
5136   // loop pass transforms an inner loop and moves on to process the outer loop.
5137   if (auto *CI = dyn_cast<ConstantInt>(Cond))
5138     return getSCEV(CI->isOne() ? TrueVal : FalseVal);
5139
5140   // Try to match some simple smax or umax patterns.
5141   auto *ICI = dyn_cast<ICmpInst>(Cond);
5142   if (!ICI)
5143     return getUnknown(I);
5144
5145   Value *LHS = ICI->getOperand(0);
5146   Value *RHS = ICI->getOperand(1);
5147
5148   switch (ICI->getPredicate()) {
5149   case ICmpInst::ICMP_SLT:
5150   case ICmpInst::ICMP_SLE:
5151     std::swap(LHS, RHS);
5152     LLVM_FALLTHROUGH;
5153   case ICmpInst::ICMP_SGT:
5154   case ICmpInst::ICMP_SGE:
5155     // a >s b ? a+x : b+x  ->  smax(a, b)+x
5156     // a >s b ? b+x : a+x  ->  smin(a, b)+x
5157     if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType())) {
5158       const SCEV *LS = getNoopOrSignExtend(getSCEV(LHS), I->getType());
5159       const SCEV *RS = getNoopOrSignExtend(getSCEV(RHS), I->getType());
5160       const SCEV *LA = getSCEV(TrueVal);
5161       const SCEV *RA = getSCEV(FalseVal);
5162       const SCEV *LDiff = getMinusSCEV(LA, LS);
5163       const SCEV *RDiff = getMinusSCEV(RA, RS);
5164       if (LDiff == RDiff)
5165         return getAddExpr(getSMaxExpr(LS, RS), LDiff);
5166       LDiff = getMinusSCEV(LA, RS);
5167       RDiff = getMinusSCEV(RA, LS);
5168       if (LDiff == RDiff)
5169         return getAddExpr(getSMinExpr(LS, RS), LDiff);
5170     }
5171     break;
5172   case ICmpInst::ICMP_ULT:
5173   case ICmpInst::ICMP_ULE:
5174     std::swap(LHS, RHS);
5175     LLVM_FALLTHROUGH;
5176   case ICmpInst::ICMP_UGT:
5177   case ICmpInst::ICMP_UGE:
5178     // a >u b ? a+x : b+x  ->  umax(a, b)+x
5179     // a >u b ? b+x : a+x  ->  umin(a, b)+x
5180     if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType())) {
5181       const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), I->getType());
5182       const SCEV *RS = getNoopOrZeroExtend(getSCEV(RHS), I->getType());
5183       const SCEV *LA = getSCEV(TrueVal);
5184       const SCEV *RA = getSCEV(FalseVal);
5185       const SCEV *LDiff = getMinusSCEV(LA, LS);
5186       const SCEV *RDiff = getMinusSCEV(RA, RS);
5187       if (LDiff == RDiff)
5188         return getAddExpr(getUMaxExpr(LS, RS), LDiff);
5189       LDiff = getMinusSCEV(LA, RS);
5190       RDiff = getMinusSCEV(RA, LS);
5191       if (LDiff == RDiff)
5192         return getAddExpr(getUMinExpr(LS, RS), LDiff);
5193     }
5194     break;
5195   case ICmpInst::ICMP_NE:
5196     // n != 0 ? n+x : 1+x  ->  umax(n, 1)+x
5197     if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType()) &&
5198         isa<ConstantInt>(RHS) && cast<ConstantInt>(RHS)->isZero()) {
5199       const SCEV *One = getOne(I->getType());
5200       const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), I->getType());
5201       const SCEV *LA = getSCEV(TrueVal);
5202       const SCEV *RA = getSCEV(FalseVal);
5203       const SCEV *LDiff = getMinusSCEV(LA, LS);
5204       const SCEV *RDiff = getMinusSCEV(RA, One);
5205       if (LDiff == RDiff)
5206         return getAddExpr(getUMaxExpr(One, LS), LDiff);
5207     }
5208     break;
5209   case ICmpInst::ICMP_EQ:
5210     // n == 0 ? 1+x : n+x  ->  umax(n, 1)+x
5211     if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType()) &&
5212         isa<ConstantInt>(RHS) && cast<ConstantInt>(RHS)->isZero()) {
5213       const SCEV *One = getOne(I->getType());
5214       const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), I->getType());
5215       const SCEV *LA = getSCEV(TrueVal);
5216       const SCEV *RA = getSCEV(FalseVal);
5217       const SCEV *LDiff = getMinusSCEV(LA, One);
5218       const SCEV *RDiff = getMinusSCEV(RA, LS);
5219       if (LDiff == RDiff)
5220         return getAddExpr(getUMaxExpr(One, LS), LDiff);
5221     }
5222     break;
5223   default:
5224     break;
5225   }
5226
5227   return getUnknown(I);
5228 }
5229
5230 /// Expand GEP instructions into add and multiply operations. This allows them
5231 /// to be analyzed by regular SCEV code.
5232 const SCEV *ScalarEvolution::createNodeForGEP(GEPOperator *GEP) {
5233   // Don't attempt to analyze GEPs over unsized objects.
5234   if (!GEP->getSourceElementType()->isSized())
5235     return getUnknown(GEP);
5236
5237   SmallVector<const SCEV *, 4> IndexExprs;
5238   for (auto Index = GEP->idx_begin(); Index != GEP->idx_end(); ++Index)
5239     IndexExprs.push_back(getSCEV(*Index));
5240   return getGEPExpr(GEP, IndexExprs);
5241 }
5242
5243 uint32_t ScalarEvolution::GetMinTrailingZerosImpl(const SCEV *S) {
5244   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
5245     return C->getAPInt().countTrailingZeros();
5246
5247   if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(S))
5248     return std::min(GetMinTrailingZeros(T->getOperand()),
5249                     (uint32_t)getTypeSizeInBits(T->getType()));
5250
5251   if (const SCEVZeroExtendExpr *E = dyn_cast<SCEVZeroExtendExpr>(S)) {
5252     uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
5253     return OpRes == getTypeSizeInBits(E->getOperand()->getType())
5254                ? getTypeSizeInBits(E->getType())
5255                : OpRes;
5256   }
5257
5258   if (const SCEVSignExtendExpr *E = dyn_cast<SCEVSignExtendExpr>(S)) {
5259     uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
5260     return OpRes == getTypeSizeInBits(E->getOperand()->getType())
5261                ? getTypeSizeInBits(E->getType())
5262                : OpRes;
5263   }
5264
5265   if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(S)) {
5266     // The result is the min of all operands results.
5267     uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
5268     for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
5269       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
5270     return MinOpRes;
5271   }
5272
5273   if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(S)) {
5274     // The result is the sum of all operands results.
5275     uint32_t SumOpRes = GetMinTrailingZeros(M->getOperand(0));
5276     uint32_t BitWidth = getTypeSizeInBits(M->getType());
5277     for (unsigned i = 1, e = M->getNumOperands();
5278          SumOpRes != BitWidth && i != e; ++i)
5279       SumOpRes =
5280           std::min(SumOpRes + GetMinTrailingZeros(M->getOperand(i)), BitWidth);
5281     return SumOpRes;
5282   }
5283
5284   if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(S)) {
5285     // The result is the min of all operands results.
5286     uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
5287     for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
5288       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
5289     return MinOpRes;
5290   }
5291
5292   if (const SCEVSMaxExpr *M = dyn_cast<SCEVSMaxExpr>(S)) {
5293     // The result is the min of all operands results.
5294     uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
5295     for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
5296       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
5297     return MinOpRes;
5298   }
5299
5300   if (const SCEVUMaxExpr *M = dyn_cast<SCEVUMaxExpr>(S)) {
5301     // The result is the min of all operands results.
5302     uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
5303     for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
5304       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
5305     return MinOpRes;
5306   }
5307
5308   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
5309     // For a SCEVUnknown, ask ValueTracking.
5310     KnownBits Known = computeKnownBits(U->getValue(), getDataLayout(), 0, &AC, nullptr, &DT);
5311     return Known.countMinTrailingZeros();
5312   }
5313
5314   // SCEVUDivExpr
5315   return 0;
5316 }
5317
5318 uint32_t ScalarEvolution::GetMinTrailingZeros(const SCEV *S) {
5319   auto I = MinTrailingZerosCache.find(S);
5320   if (I != MinTrailingZerosCache.end())
5321     return I->second;
5322
5323   uint32_t Result = GetMinTrailingZerosImpl(S);
5324   auto InsertPair = MinTrailingZerosCache.insert({S, Result});
5325   assert(InsertPair.second && "Should insert a new key");
5326   return InsertPair.first->second;
5327 }
5328
5329 /// Helper method to assign a range to V from metadata present in the IR.
5330 static Optional<ConstantRange> GetRangeFromMetadata(Value *V) {
5331   if (Instruction *I = dyn_cast<Instruction>(V))
5332     if (MDNode *MD = I->getMetadata(LLVMContext::MD_range))
5333       return getConstantRangeFromMetadata(*MD);
5334
5335   return None;
5336 }
5337
5338 /// Determine the range for a particular SCEV.  If SignHint is
5339 /// HINT_RANGE_UNSIGNED (resp. HINT_RANGE_SIGNED) then getRange prefers ranges
5340 /// with a "cleaner" unsigned (resp. signed) representation.
5341 const ConstantRange &
5342 ScalarEvolution::getRangeRef(const SCEV *S,
5343                              ScalarEvolution::RangeSignHint SignHint) {
5344   DenseMap<const SCEV *, ConstantRange> &Cache =
5345       SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED ? UnsignedRanges
5346                                                        : SignedRanges;
5347
5348   // See if we've computed this range already.
5349   DenseMap<const SCEV *, ConstantRange>::iterator I = Cache.find(S);
5350   if (I != Cache.end())
5351     return I->second;
5352
5353   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
5354     return setRange(C, SignHint, ConstantRange(C->getAPInt()));
5355
5356   unsigned BitWidth = getTypeSizeInBits(S->getType());
5357   ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true);
5358
5359   // If the value has known zeros, the maximum value will have those known zeros
5360   // as well.
5361   uint32_t TZ = GetMinTrailingZeros(S);
5362   if (TZ != 0) {
5363     if (SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED)
5364       ConservativeResult =
5365           ConstantRange(APInt::getMinValue(BitWidth),
5366                         APInt::getMaxValue(BitWidth).lshr(TZ).shl(TZ) + 1);
5367     else
5368       ConservativeResult = ConstantRange(
5369           APInt::getSignedMinValue(BitWidth),
5370           APInt::getSignedMaxValue(BitWidth).ashr(TZ).shl(TZ) + 1);
5371   }
5372
5373   if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
5374     ConstantRange X = getRangeRef(Add->getOperand(0), SignHint);
5375     for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i)
5376       X = X.add(getRangeRef(Add->getOperand(i), SignHint));
5377     return setRange(Add, SignHint, ConservativeResult.intersectWith(X));
5378   }
5379
5380   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
5381     ConstantRange X = getRangeRef(Mul->getOperand(0), SignHint);
5382     for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i)
5383       X = X.multiply(getRangeRef(Mul->getOperand(i), SignHint));
5384     return setRange(Mul, SignHint, ConservativeResult.intersectWith(X));
5385   }
5386
5387   if (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(S)) {
5388     ConstantRange X = getRangeRef(SMax->getOperand(0), SignHint);
5389     for (unsigned i = 1, e = SMax->getNumOperands(); i != e; ++i)
5390       X = X.smax(getRangeRef(SMax->getOperand(i), SignHint));
5391     return setRange(SMax, SignHint, ConservativeResult.intersectWith(X));
5392   }
5393
5394   if (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(S)) {
5395     ConstantRange X = getRangeRef(UMax->getOperand(0), SignHint);
5396     for (unsigned i = 1, e = UMax->getNumOperands(); i != e; ++i)
5397       X = X.umax(getRangeRef(UMax->getOperand(i), SignHint));
5398     return setRange(UMax, SignHint, ConservativeResult.intersectWith(X));
5399   }
5400
5401   if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) {
5402     ConstantRange X = getRangeRef(UDiv->getLHS(), SignHint);
5403     ConstantRange Y = getRangeRef(UDiv->getRHS(), SignHint);
5404     return setRange(UDiv, SignHint,
5405                     ConservativeResult.intersectWith(X.udiv(Y)));
5406   }
5407
5408   if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) {
5409     ConstantRange X = getRangeRef(ZExt->getOperand(), SignHint);
5410     return setRange(ZExt, SignHint,
5411                     ConservativeResult.intersectWith(X.zeroExtend(BitWidth)));
5412   }
5413
5414   if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) {
5415     ConstantRange X = getRangeRef(SExt->getOperand(), SignHint);
5416     return setRange(SExt, SignHint,
5417                     ConservativeResult.intersectWith(X.signExtend(BitWidth)));
5418   }
5419
5420   if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) {
5421     ConstantRange X = getRangeRef(Trunc->getOperand(), SignHint);
5422     return setRange(Trunc, SignHint,
5423                     ConservativeResult.intersectWith(X.truncate(BitWidth)));
5424   }
5425
5426   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) {
5427     // If there's no unsigned wrap, the value will never be less than its
5428     // initial value.
5429     if (AddRec->hasNoUnsignedWrap())
5430       if (const SCEVConstant *C = dyn_cast<SCEVConstant>(AddRec->getStart()))
5431         if (!C->getValue()->isZero())
5432           ConservativeResult = ConservativeResult.intersectWith(
5433               ConstantRange(C->getAPInt(), APInt(BitWidth, 0)));
5434
5435     // If there's no signed wrap, and all the operands have the same sign or
5436     // zero, the value won't ever change sign.
5437     if (AddRec->hasNoSignedWrap()) {
5438       bool AllNonNeg = true;
5439       bool AllNonPos = true;
5440       for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
5441         if (!isKnownNonNegative(AddRec->getOperand(i))) AllNonNeg = false;
5442         if (!isKnownNonPositive(AddRec->getOperand(i))) AllNonPos = false;
5443       }
5444       if (AllNonNeg)
5445         ConservativeResult = ConservativeResult.intersectWith(
5446           ConstantRange(APInt(BitWidth, 0),
5447                         APInt::getSignedMinValue(BitWidth)));
5448       else if (AllNonPos)
5449         ConservativeResult = ConservativeResult.intersectWith(
5450           ConstantRange(APInt::getSignedMinValue(BitWidth),
5451                         APInt(BitWidth, 1)));
5452     }
5453
5454     // TODO: non-affine addrec
5455     if (AddRec->isAffine()) {
5456       const SCEV *MaxBECount = getMaxBackedgeTakenCount(AddRec->getLoop());
5457       if (!isa<SCEVCouldNotCompute>(MaxBECount) &&
5458           getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) {
5459         auto RangeFromAffine = getRangeForAffineAR(
5460             AddRec->getStart(), AddRec->getStepRecurrence(*this), MaxBECount,
5461             BitWidth);
5462         if (!RangeFromAffine.isFullSet())
5463           ConservativeResult =
5464               ConservativeResult.intersectWith(RangeFromAffine);
5465
5466         auto RangeFromFactoring = getRangeViaFactoring(
5467             AddRec->getStart(), AddRec->getStepRecurrence(*this), MaxBECount,
5468             BitWidth);
5469         if (!RangeFromFactoring.isFullSet())
5470           ConservativeResult =
5471               ConservativeResult.intersectWith(RangeFromFactoring);
5472       }
5473     }
5474
5475     return setRange(AddRec, SignHint, std::move(ConservativeResult));
5476   }
5477
5478   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
5479     // Check if the IR explicitly contains !range metadata.
5480     Optional<ConstantRange> MDRange = GetRangeFromMetadata(U->getValue());
5481     if (MDRange.hasValue())
5482       ConservativeResult = ConservativeResult.intersectWith(MDRange.getValue());
5483
5484     // Split here to avoid paying the compile-time cost of calling both
5485     // computeKnownBits and ComputeNumSignBits.  This restriction can be lifted
5486     // if needed.
5487     const DataLayout &DL = getDataLayout();
5488     if (SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED) {
5489       // For a SCEVUnknown, ask ValueTracking.
5490       KnownBits Known = computeKnownBits(U->getValue(), DL, 0, &AC, nullptr, &DT);
5491       if (Known.One != ~Known.Zero + 1)
5492         ConservativeResult =
5493             ConservativeResult.intersectWith(ConstantRange(Known.One,
5494                                                            ~Known.Zero + 1));
5495     } else {
5496       assert(SignHint == ScalarEvolution::HINT_RANGE_SIGNED &&
5497              "generalize as needed!");
5498       unsigned NS = ComputeNumSignBits(U->getValue(), DL, 0, &AC, nullptr, &DT);
5499       if (NS > 1)
5500         ConservativeResult = ConservativeResult.intersectWith(
5501             ConstantRange(APInt::getSignedMinValue(BitWidth).ashr(NS - 1),
5502                           APInt::getSignedMaxValue(BitWidth).ashr(NS - 1) + 1));
5503     }
5504
5505     return setRange(U, SignHint, std::move(ConservativeResult));
5506   }
5507
5508   return setRange(S, SignHint, std::move(ConservativeResult));
5509 }
5510
5511 // Given a StartRange, Step and MaxBECount for an expression compute a range of
5512 // values that the expression can take. Initially, the expression has a value
5513 // from StartRange and then is changed by Step up to MaxBECount times. Signed
5514 // argument defines if we treat Step as signed or unsigned.
5515 static ConstantRange getRangeForAffineARHelper(APInt Step,
5516                                                const ConstantRange &StartRange,
5517                                                const APInt &MaxBECount,
5518                                                unsigned BitWidth, bool Signed) {
5519   // If either Step or MaxBECount is 0, then the expression won't change, and we
5520   // just need to return the initial range.
5521   if (Step == 0 || MaxBECount == 0)
5522     return StartRange;
5523
5524   // If we don't know anything about the initial value (i.e. StartRange is
5525   // FullRange), then we don't know anything about the final range either.
5526   // Return FullRange.
5527   if (StartRange.isFullSet())
5528     return ConstantRange(BitWidth, /* isFullSet = */ true);
5529
5530   // If Step is signed and negative, then we use its absolute value, but we also
5531   // note that we're moving in the opposite direction.
5532   bool Descending = Signed && Step.isNegative();
5533
5534   if (Signed)
5535     // This is correct even for INT_SMIN. Let's look at i8 to illustrate this:
5536     // abs(INT_SMIN) = abs(-128) = abs(0x80) = -0x80 = 0x80 = 128.
5537     // This equations hold true due to the well-defined wrap-around behavior of
5538     // APInt.
5539     Step = Step.abs();
5540
5541   // Check if Offset is more than full span of BitWidth. If it is, the
5542   // expression is guaranteed to overflow.
5543   if (APInt::getMaxValue(StartRange.getBitWidth()).udiv(Step).ult(MaxBECount))
5544     return ConstantRange(BitWidth, /* isFullSet = */ true);
5545
5546   // Offset is by how much the expression can change. Checks above guarantee no
5547   // overflow here.
5548   APInt Offset = Step * MaxBECount;
5549
5550   // Minimum value of the final range will match the minimal value of StartRange
5551   // if the expression is increasing and will be decreased by Offset otherwise.
5552   // Maximum value of the final range will match the maximal value of StartRange
5553   // if the expression is decreasing and will be increased by Offset otherwise.
5554   APInt StartLower = StartRange.getLower();
5555   APInt StartUpper = StartRange.getUpper() - 1;
5556   APInt MovedBoundary = Descending ? (StartLower - std::move(Offset))
5557                                    : (StartUpper + std::move(Offset));
5558
5559   // It's possible that the new minimum/maximum value will fall into the initial
5560   // range (due to wrap around). This means that the expression can take any
5561   // value in this bitwidth, and we have to return full range.
5562   if (StartRange.contains(MovedBoundary))
5563     return ConstantRange(BitWidth, /* isFullSet = */ true);
5564
5565   APInt NewLower =
5566       Descending ? std::move(MovedBoundary) : std::move(StartLower);
5567   APInt NewUpper =
5568       Descending ? std::move(StartUpper) : std::move(MovedBoundary);
5569   NewUpper += 1;
5570
5571   // If we end up with full range, return a proper full range.
5572   if (NewLower == NewUpper)
5573     return ConstantRange(BitWidth, /* isFullSet = */ true);
5574
5575   // No overflow detected, return [StartLower, StartUpper + Offset + 1) range.
5576   return ConstantRange(std::move(NewLower), std::move(NewUpper));
5577 }
5578
5579 ConstantRange ScalarEvolution::getRangeForAffineAR(const SCEV *Start,
5580                                                    const SCEV *Step,
5581                                                    const SCEV *MaxBECount,
5582                                                    unsigned BitWidth) {
5583   assert(!isa<SCEVCouldNotCompute>(MaxBECount) &&
5584          getTypeSizeInBits(MaxBECount->getType()) <= BitWidth &&
5585          "Precondition!");
5586
5587   MaxBECount = getNoopOrZeroExtend(MaxBECount, Start->getType());
5588   APInt MaxBECountValue = getUnsignedRangeMax(MaxBECount);
5589
5590   // First, consider step signed.
5591   ConstantRange StartSRange = getSignedRange(Start);
5592   ConstantRange StepSRange = getSignedRange(Step);
5593
5594   // If Step can be both positive and negative, we need to find ranges for the
5595   // maximum absolute step values in both directions and union them.
5596   ConstantRange SR =
5597       getRangeForAffineARHelper(StepSRange.getSignedMin(), StartSRange,
5598                                 MaxBECountValue, BitWidth, /* Signed = */ true);
5599   SR = SR.unionWith(getRangeForAffineARHelper(StepSRange.getSignedMax(),
5600                                               StartSRange, MaxBECountValue,
5601                                               BitWidth, /* Signed = */ true));
5602
5603   // Next, consider step unsigned.
5604   ConstantRange UR = getRangeForAffineARHelper(
5605       getUnsignedRangeMax(Step), getUnsignedRange(Start),
5606       MaxBECountValue, BitWidth, /* Signed = */ false);
5607
5608   // Finally, intersect signed and unsigned ranges.
5609   return SR.intersectWith(UR);
5610 }
5611
5612 ConstantRange ScalarEvolution::getRangeViaFactoring(const SCEV *Start,
5613                                                     const SCEV *Step,
5614                                                     const SCEV *MaxBECount,
5615                                                     unsigned BitWidth) {
5616   //    RangeOf({C?A:B,+,C?P:Q}) == RangeOf(C?{A,+,P}:{B,+,Q})
5617   // == RangeOf({A,+,P}) union RangeOf({B,+,Q})
5618
5619   struct SelectPattern {
5620     Value *Condition = nullptr;
5621     APInt TrueValue;
5622     APInt FalseValue;
5623
5624     explicit SelectPattern(ScalarEvolution &SE, unsigned BitWidth,
5625                            const SCEV *S) {
5626       Optional<unsigned> CastOp;
5627       APInt Offset(BitWidth, 0);
5628
5629       assert(SE.getTypeSizeInBits(S->getType()) == BitWidth &&
5630              "Should be!");
5631
5632       // Peel off a constant offset:
5633       if (auto *SA = dyn_cast<SCEVAddExpr>(S)) {
5634         // In the future we could consider being smarter here and handle
5635         // {Start+Step,+,Step} too.
5636         if (SA->getNumOperands() != 2 || !isa<SCEVConstant>(SA->getOperand(0)))
5637           return;
5638
5639         Offset = cast<SCEVConstant>(SA->getOperand(0))->getAPInt();
5640         S = SA->getOperand(1);
5641       }
5642
5643       // Peel off a cast operation
5644       if (auto *SCast = dyn_cast<SCEVCastExpr>(S)) {
5645         CastOp = SCast->getSCEVType();
5646         S = SCast->getOperand();
5647       }
5648
5649       using namespace llvm::PatternMatch;
5650
5651       auto *SU = dyn_cast<SCEVUnknown>(S);
5652       const APInt *TrueVal, *FalseVal;
5653       if (!SU ||
5654           !match(SU->getValue(), m_Select(m_Value(Condition), m_APInt(TrueVal),
5655                                           m_APInt(FalseVal)))) {
5656         Condition = nullptr;
5657         return;
5658       }
5659
5660       TrueValue = *TrueVal;
5661       FalseValue = *FalseVal;
5662
5663       // Re-apply the cast we peeled off earlier
5664       if (CastOp.hasValue())
5665         switch (*CastOp) {
5666         default:
5667           llvm_unreachable("Unknown SCEV cast type!");
5668
5669         case scTruncate:
5670           TrueValue = TrueValue.trunc(BitWidth);
5671           FalseValue = FalseValue.trunc(BitWidth);
5672           break;
5673         case scZeroExtend:
5674           TrueValue = TrueValue.zext(BitWidth);
5675           FalseValue = FalseValue.zext(BitWidth);
5676           break;
5677         case scSignExtend:
5678           TrueValue = TrueValue.sext(BitWidth);
5679           FalseValue = FalseValue.sext(BitWidth);
5680           break;
5681         }
5682
5683       // Re-apply the constant offset we peeled off earlier
5684       TrueValue += Offset;
5685       FalseValue += Offset;
5686     }
5687
5688     bool isRecognized() { return Condition != nullptr; }
5689   };
5690
5691   SelectPattern StartPattern(*this, BitWidth, Start);
5692   if (!StartPattern.isRecognized())
5693     return ConstantRange(BitWidth, /* isFullSet = */ true);
5694
5695   SelectPattern StepPattern(*this, BitWidth, Step);
5696   if (!StepPattern.isRecognized())
5697     return ConstantRange(BitWidth, /* isFullSet = */ true);
5698
5699   if (StartPattern.Condition != StepPattern.Condition) {
5700     // We don't handle this case today; but we could, by considering four
5701     // possibilities below instead of two. I'm not sure if there are cases where
5702     // that will help over what getRange already does, though.
5703     return ConstantRange(BitWidth, /* isFullSet = */ true);
5704   }
5705
5706   // NB! Calling ScalarEvolution::getConstant is fine, but we should not try to
5707   // construct arbitrary general SCEV expressions here.  This function is called
5708   // from deep in the call stack, and calling getSCEV (on a sext instruction,
5709   // say) can end up caching a suboptimal value.
5710
5711   // FIXME: without the explicit `this` receiver below, MSVC errors out with
5712   // C2352 and C2512 (otherwise it isn't needed).
5713
5714   const SCEV *TrueStart = this->getConstant(StartPattern.TrueValue);
5715   const SCEV *TrueStep = this->getConstant(StepPattern.TrueValue);
5716   const SCEV *FalseStart = this->getConstant(StartPattern.FalseValue);
5717   const SCEV *FalseStep = this->getConstant(StepPattern.FalseValue);
5718
5719   ConstantRange TrueRange =
5720       this->getRangeForAffineAR(TrueStart, TrueStep, MaxBECount, BitWidth);
5721   ConstantRange FalseRange =
5722       this->getRangeForAffineAR(FalseStart, FalseStep, MaxBECount, BitWidth);
5723
5724   return TrueRange.unionWith(FalseRange);
5725 }
5726
5727 SCEV::NoWrapFlags ScalarEvolution::getNoWrapFlagsFromUB(const Value *V) {
5728   if (isa<ConstantExpr>(V)) return SCEV::FlagAnyWrap;
5729   const BinaryOperator *BinOp = cast<BinaryOperator>(V);
5730
5731   // Return early if there are no flags to propagate to the SCEV.
5732   SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap;
5733   if (BinOp->hasNoUnsignedWrap())
5734     Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW);
5735   if (BinOp->hasNoSignedWrap())
5736     Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNSW);
5737   if (Flags == SCEV::FlagAnyWrap)
5738     return SCEV::FlagAnyWrap;
5739
5740   return isSCEVExprNeverPoison(BinOp) ? Flags : SCEV::FlagAnyWrap;
5741 }
5742
5743 bool ScalarEvolution::isSCEVExprNeverPoison(const Instruction *I) {
5744   // Here we check that I is in the header of the innermost loop containing I,
5745   // since we only deal with instructions in the loop header. The actual loop we
5746   // need to check later will come from an add recurrence, but getting that
5747   // requires computing the SCEV of the operands, which can be expensive. This
5748   // check we can do cheaply to rule out some cases early.
5749   Loop *InnermostContainingLoop = LI.getLoopFor(I->getParent());
5750   if (InnermostContainingLoop == nullptr ||
5751       InnermostContainingLoop->getHeader() != I->getParent())
5752     return false;
5753
5754   // Only proceed if we can prove that I does not yield poison.
5755   if (!programUndefinedIfFullPoison(I))
5756     return false;
5757
5758   // At this point we know that if I is executed, then it does not wrap
5759   // according to at least one of NSW or NUW. If I is not executed, then we do
5760   // not know if the calculation that I represents would wrap. Multiple
5761   // instructions can map to the same SCEV. If we apply NSW or NUW from I to
5762   // the SCEV, we must guarantee no wrapping for that SCEV also when it is
5763   // derived from other instructions that map to the same SCEV. We cannot make
5764   // that guarantee for cases where I is not executed. So we need to find the
5765   // loop that I is considered in relation to and prove that I is executed for
5766   // every iteration of that loop. That implies that the value that I
5767   // calculates does not wrap anywhere in the loop, so then we can apply the
5768   // flags to the SCEV.
5769   //
5770   // We check isLoopInvariant to disambiguate in case we are adding recurrences
5771   // from different loops, so that we know which loop to prove that I is
5772   // executed in.
5773   for (unsigned OpIndex = 0; OpIndex < I->getNumOperands(); ++OpIndex) {
5774     // I could be an extractvalue from a call to an overflow intrinsic.
5775     // TODO: We can do better here in some cases.
5776     if (!isSCEVable(I->getOperand(OpIndex)->getType()))
5777       return false;
5778     const SCEV *Op = getSCEV(I->getOperand(OpIndex));
5779     if (auto *AddRec = dyn_cast<SCEVAddRecExpr>(Op)) {
5780       bool AllOtherOpsLoopInvariant = true;
5781       for (unsigned OtherOpIndex = 0; OtherOpIndex < I->getNumOperands();
5782            ++OtherOpIndex) {
5783         if (OtherOpIndex != OpIndex) {
5784           const SCEV *OtherOp = getSCEV(I->getOperand(OtherOpIndex));
5785           if (!isLoopInvariant(OtherOp, AddRec->getLoop())) {
5786             AllOtherOpsLoopInvariant = false;
5787             break;
5788           }
5789         }
5790       }
5791       if (AllOtherOpsLoopInvariant &&
5792           isGuaranteedToExecuteForEveryIteration(I, AddRec->getLoop()))
5793         return true;
5794     }
5795   }
5796   return false;
5797 }
5798
5799 bool ScalarEvolution::isAddRecNeverPoison(const Instruction *I, const Loop *L) {
5800   // If we know that \c I can never be poison period, then that's enough.
5801   if (isSCEVExprNeverPoison(I))
5802     return true;
5803
5804   // For an add recurrence specifically, we assume that infinite loops without
5805   // side effects are undefined behavior, and then reason as follows:
5806   //
5807   // If the add recurrence is poison in any iteration, it is poison on all
5808   // future iterations (since incrementing poison yields poison). If the result
5809   // of the add recurrence is fed into the loop latch condition and the loop
5810   // does not contain any throws or exiting blocks other than the latch, we now
5811   // have the ability to "choose" whether the backedge is taken or not (by
5812   // choosing a sufficiently evil value for the poison feeding into the branch)
5813   // for every iteration including and after the one in which \p I first became
5814   // poison.  There are two possibilities (let's call the iteration in which \p
5815   // I first became poison as K):
5816   //
5817   //  1. In the set of iterations including and after K, the loop body executes
5818   //     no side effects.  In this case executing the backege an infinte number
5819   //     of times will yield undefined behavior.
5820   //
5821   //  2. In the set of iterations including and after K, the loop body executes
5822   //     at least one side effect.  In this case, that specific instance of side
5823   //     effect is control dependent on poison, which also yields undefined
5824   //     behavior.
5825
5826   auto *ExitingBB = L->getExitingBlock();
5827   auto *LatchBB = L->getLoopLatch();
5828   if (!ExitingBB || !LatchBB || ExitingBB != LatchBB)
5829     return false;
5830
5831   SmallPtrSet<const Instruction *, 16> Pushed;
5832   SmallVector<const Instruction *, 8> PoisonStack;
5833
5834   // We start by assuming \c I, the post-inc add recurrence, is poison.  Only
5835   // things that are known to be fully poison under that assumption go on the
5836   // PoisonStack.
5837   Pushed.insert(I);
5838   PoisonStack.push_back(I);
5839
5840   bool LatchControlDependentOnPoison = false;
5841   while (!PoisonStack.empty() && !LatchControlDependentOnPoison) {
5842     const Instruction *Poison = PoisonStack.pop_back_val();
5843
5844     for (auto *PoisonUser : Poison->users()) {
5845       if (propagatesFullPoison(cast<Instruction>(PoisonUser))) {
5846         if (Pushed.insert(cast<Instruction>(PoisonUser)).second)
5847           PoisonStack.push_back(cast<Instruction>(PoisonUser));
5848       } else if (auto *BI = dyn_cast<BranchInst>(PoisonUser)) {
5849         assert(BI->isConditional() && "Only possibility!");
5850         if (BI->getParent() == LatchBB) {
5851           LatchControlDependentOnPoison = true;
5852           break;
5853         }
5854       }
5855     }
5856   }
5857
5858   return LatchControlDependentOnPoison && loopHasNoAbnormalExits(L);
5859 }
5860
5861 ScalarEvolution::LoopProperties
5862 ScalarEvolution::getLoopProperties(const Loop *L) {
5863   using LoopProperties = ScalarEvolution::LoopProperties;
5864
5865   auto Itr = LoopPropertiesCache.find(L);
5866   if (Itr == LoopPropertiesCache.end()) {
5867     auto HasSideEffects = [](Instruction *I) {
5868       if (auto *SI = dyn_cast<StoreInst>(I))
5869         return !SI->isSimple();
5870
5871       return I->mayHaveSideEffects();
5872     };
5873
5874     LoopProperties LP = {/* HasNoAbnormalExits */ true,
5875                          /*HasNoSideEffects*/ true};
5876
5877     for (auto *BB : L->getBlocks())
5878       for (auto &I : *BB) {
5879         if (!isGuaranteedToTransferExecutionToSuccessor(&I))
5880           LP.HasNoAbnormalExits = false;
5881         if (HasSideEffects(&I))
5882           LP.HasNoSideEffects = false;
5883         if (!LP.HasNoAbnormalExits && !LP.HasNoSideEffects)
5884           break; // We're already as pessimistic as we can get.
5885       }
5886
5887     auto InsertPair = LoopPropertiesCache.insert({L, LP});
5888     assert(InsertPair.second && "We just checked!");
5889     Itr = InsertPair.first;
5890   }
5891
5892   return Itr->second;
5893 }
5894
5895 const SCEV *ScalarEvolution::createSCEV(Value *V) {
5896   if (!isSCEVable(V->getType()))
5897     return getUnknown(V);
5898
5899   if (Instruction *I = dyn_cast<Instruction>(V)) {
5900     // Don't attempt to analyze instructions in blocks that aren't
5901     // reachable. Such instructions don't matter, and they aren't required
5902     // to obey basic rules for definitions dominating uses which this
5903     // analysis depends on.
5904     if (!DT.isReachableFromEntry(I->getParent()))
5905       return getUnknown(V);
5906   } else if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
5907     return getConstant(CI);
5908   else if (isa<ConstantPointerNull>(V))
5909     return getZero(V->getType());
5910   else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
5911     return GA->isInterposable() ? getUnknown(V) : getSCEV(GA->getAliasee());
5912   else if (!isa<ConstantExpr>(V))
5913     return getUnknown(V);
5914
5915   Operator *U = cast<Operator>(V);
5916   if (auto BO = MatchBinaryOp(U, DT)) {
5917     switch (BO->Opcode) {
5918     case Instruction::Add: {
5919       // The simple thing to do would be to just call getSCEV on both operands
5920       // and call getAddExpr with the result. However if we're looking at a
5921       // bunch of things all added together, this can be quite inefficient,
5922       // because it leads to N-1 getAddExpr calls for N ultimate operands.
5923       // Instead, gather up all the operands and make a single getAddExpr call.
5924       // LLVM IR canonical form means we need only traverse the left operands.
5925       SmallVector<const SCEV *, 4> AddOps;
5926       do {
5927         if (BO->Op) {
5928           if (auto *OpSCEV = getExistingSCEV(BO->Op)) {
5929             AddOps.push_back(OpSCEV);
5930             break;
5931           }
5932
5933           // If a NUW or NSW flag can be applied to the SCEV for this
5934           // addition, then compute the SCEV for this addition by itself
5935           // with a separate call to getAddExpr. We need to do that
5936           // instead of pushing the operands of the addition onto AddOps,
5937           // since the flags are only known to apply to this particular
5938           // addition - they may not apply to other additions that can be
5939           // formed with operands from AddOps.
5940           const SCEV *RHS = getSCEV(BO->RHS);
5941           SCEV::NoWrapFlags Flags = getNoWrapFlagsFromUB(BO->Op);
5942           if (Flags != SCEV::FlagAnyWrap) {
5943             const SCEV *LHS = getSCEV(BO->LHS);
5944             if (BO->Opcode == Instruction::Sub)
5945               AddOps.push_back(getMinusSCEV(LHS, RHS, Flags));
5946             else
5947               AddOps.push_back(getAddExpr(LHS, RHS, Flags));
5948             break;
5949           }
5950         }
5951
5952         if (BO->Opcode == Instruction::Sub)
5953           AddOps.push_back(getNegativeSCEV(getSCEV(BO->RHS)));
5954         else
5955           AddOps.push_back(getSCEV(BO->RHS));
5956
5957         auto NewBO = MatchBinaryOp(BO->LHS, DT);
5958         if (!NewBO || (NewBO->Opcode != Instruction::Add &&
5959                        NewBO->Opcode != Instruction::Sub)) {
5960           AddOps.push_back(getSCEV(BO->LHS));
5961           break;
5962         }
5963         BO = NewBO;
5964       } while (true);
5965
5966       return getAddExpr(AddOps);
5967     }
5968
5969     case Instruction::Mul: {
5970       SmallVector<const SCEV *, 4> MulOps;
5971       do {
5972         if (BO->Op) {
5973           if (auto *OpSCEV = getExistingSCEV(BO->Op)) {
5974             MulOps.push_back(OpSCEV);
5975             break;
5976           }
5977
5978           SCEV::NoWrapFlags Flags = getNoWrapFlagsFromUB(BO->Op);
5979           if (Flags != SCEV::FlagAnyWrap) {
5980             MulOps.push_back(
5981                 getMulExpr(getSCEV(BO->LHS), getSCEV(BO->RHS), Flags));
5982             break;
5983           }
5984         }
5985
5986         MulOps.push_back(getSCEV(BO->RHS));
5987         auto NewBO = MatchBinaryOp(BO->LHS, DT);
5988         if (!NewBO || NewBO->Opcode != Instruction::Mul) {
5989           MulOps.push_back(getSCEV(BO->LHS));
5990           break;
5991         }
5992         BO = NewBO;
5993       } while (true);
5994
5995       return getMulExpr(MulOps);
5996     }
5997     case Instruction::UDiv:
5998       return getUDivExpr(getSCEV(BO->LHS), getSCEV(BO->RHS));
5999     case Instruction::URem:
6000       return getURemExpr(getSCEV(BO->LHS), getSCEV(BO->RHS));
6001     case Instruction::Sub: {
6002       SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap;
6003       if (BO->Op)
6004         Flags = getNoWrapFlagsFromUB(BO->Op);
6005       return getMinusSCEV(getSCEV(BO->LHS), getSCEV(BO->RHS), Flags);
6006     }
6007     case Instruction::And:
6008       // For an expression like x&255 that merely masks off the high bits,
6009       // use zext(trunc(x)) as the SCEV expression.
6010       if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->RHS)) {
6011         if (CI->isZero())
6012           return getSCEV(BO->RHS);
6013         if (CI->isMinusOne())
6014           return getSCEV(BO->LHS);
6015         const APInt &A = CI->getValue();
6016
6017         // Instcombine's ShrinkDemandedConstant may strip bits out of
6018         // constants, obscuring what would otherwise be a low-bits mask.
6019         // Use computeKnownBits to compute what ShrinkDemandedConstant
6020         // knew about to reconstruct a low-bits mask value.
6021         unsigned LZ = A.countLeadingZeros();
6022         unsigned TZ = A.countTrailingZeros();
6023         unsigned BitWidth = A.getBitWidth();
6024         KnownBits Known(BitWidth);
6025         computeKnownBits(BO->LHS, Known, getDataLayout(),
6026                          0, &AC, nullptr, &DT);
6027
6028         APInt EffectiveMask =
6029             APInt::getLowBitsSet(BitWidth, BitWidth - LZ - TZ).shl(TZ);
6030         if ((LZ != 0 || TZ != 0) && !((~A & ~Known.Zero) & EffectiveMask)) {
6031           const SCEV *MulCount = getConstant(APInt::getOneBitSet(BitWidth, TZ));
6032           const SCEV *LHS = getSCEV(BO->LHS);
6033           const SCEV *ShiftedLHS = nullptr;
6034           if (auto *LHSMul = dyn_cast<SCEVMulExpr>(LHS)) {
6035             if (auto *OpC = dyn_cast<SCEVConstant>(LHSMul->getOperand(0))) {
6036               // For an expression like (x * 8) & 8, simplify the multiply.
6037               unsigned MulZeros = OpC->getAPInt().countTrailingZeros();
6038               unsigned GCD = std::min(MulZeros, TZ);
6039               APInt DivAmt = APInt::getOneBitSet(BitWidth, TZ - GCD);
6040               SmallVector<const SCEV*, 4> MulOps;
6041               MulOps.push_back(getConstant(OpC->getAPInt().lshr(GCD)));
6042               MulOps.append(LHSMul->op_begin() + 1, LHSMul->op_end());
6043               auto *NewMul = getMulExpr(MulOps, LHSMul->getNoWrapFlags());
6044               ShiftedLHS = getUDivExpr(NewMul, getConstant(DivAmt));
6045             }
6046           }
6047           if (!ShiftedLHS)
6048             ShiftedLHS = getUDivExpr(LHS, MulCount);
6049           return getMulExpr(
6050               getZeroExtendExpr(
6051                   getTruncateExpr(ShiftedLHS,
6052                       IntegerType::get(getContext(), BitWidth - LZ - TZ)),
6053                   BO->LHS->getType()),
6054               MulCount);
6055         }
6056       }
6057       break;
6058
6059     case Instruction::Or:
6060       // If the RHS of the Or is a constant, we may have something like:
6061       // X*4+1 which got turned into X*4|1.  Handle this as an Add so loop
6062       // optimizations will transparently handle this case.
6063       //
6064       // In order for this transformation to be safe, the LHS must be of the
6065       // form X*(2^n) and the Or constant must be less than 2^n.
6066       if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->RHS)) {
6067         const SCEV *LHS = getSCEV(BO->LHS);
6068         const APInt &CIVal = CI->getValue();
6069         if (GetMinTrailingZeros(LHS) >=
6070             (CIVal.getBitWidth() - CIVal.countLeadingZeros())) {
6071           // Build a plain add SCEV.
6072           const SCEV *S = getAddExpr(LHS, getSCEV(CI));
6073           // If the LHS of the add was an addrec and it has no-wrap flags,
6074           // transfer the no-wrap flags, since an or won't introduce a wrap.
6075           if (const SCEVAddRecExpr *NewAR = dyn_cast<SCEVAddRecExpr>(S)) {
6076             const SCEVAddRecExpr *OldAR = cast<SCEVAddRecExpr>(LHS);
6077             const_cast<SCEVAddRecExpr *>(NewAR)->setNoWrapFlags(
6078                 OldAR->getNoWrapFlags());
6079           }
6080           return S;
6081         }
6082       }
6083       break;
6084
6085     case Instruction::Xor:
6086       if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->RHS)) {
6087         // If the RHS of xor is -1, then this is a not operation.
6088         if (CI->isMinusOne())
6089           return getNotSCEV(getSCEV(BO->LHS));
6090
6091         // Model xor(and(x, C), C) as and(~x, C), if C is a low-bits mask.
6092         // This is a variant of the check for xor with -1, and it handles
6093         // the case where instcombine has trimmed non-demanded bits out
6094         // of an xor with -1.
6095         if (auto *LBO = dyn_cast<BinaryOperator>(BO->LHS))
6096           if (ConstantInt *LCI = dyn_cast<ConstantInt>(LBO->getOperand(1)))
6097             if (LBO->getOpcode() == Instruction::And &&
6098                 LCI->getValue() == CI->getValue())
6099               if (const SCEVZeroExtendExpr *Z =
6100                       dyn_cast<SCEVZeroExtendExpr>(getSCEV(BO->LHS))) {
6101                 Type *UTy = BO->LHS->getType();
6102                 const SCEV *Z0 = Z->getOperand();
6103                 Type *Z0Ty = Z0->getType();
6104                 unsigned Z0TySize = getTypeSizeInBits(Z0Ty);
6105
6106                 // If C is a low-bits mask, the zero extend is serving to
6107                 // mask off the high bits. Complement the operand and
6108                 // re-apply the zext.
6109                 if (CI->getValue().isMask(Z0TySize))
6110                   return getZeroExtendExpr(getNotSCEV(Z0), UTy);
6111
6112                 // If C is a single bit, it may be in the sign-bit position
6113                 // before the zero-extend. In this case, represent the xor
6114                 // using an add, which is equivalent, and re-apply the zext.
6115                 APInt Trunc = CI->getValue().trunc(Z0TySize);
6116                 if (Trunc.zext(getTypeSizeInBits(UTy)) == CI->getValue() &&
6117                     Trunc.isSignMask())
6118                   return getZeroExtendExpr(getAddExpr(Z0, getConstant(Trunc)),
6119                                            UTy);
6120               }
6121       }
6122       break;
6123
6124   case Instruction::Shl:
6125     // Turn shift left of a constant amount into a multiply.
6126     if (ConstantInt *SA = dyn_cast<ConstantInt>(BO->RHS)) {
6127       uint32_t BitWidth = cast<IntegerType>(SA->getType())->getBitWidth();
6128
6129       // If the shift count is not less than the bitwidth, the result of
6130       // the shift is undefined. Don't try to analyze it, because the
6131       // resolution chosen here may differ from the resolution chosen in
6132       // other parts of the compiler.
6133       if (SA->getValue().uge(BitWidth))
6134         break;
6135
6136       // It is currently not resolved how to interpret NSW for left
6137       // shift by BitWidth - 1, so we avoid applying flags in that
6138       // case. Remove this check (or this comment) once the situation
6139       // is resolved. See
6140       // http://lists.llvm.org/pipermail/llvm-dev/2015-April/084195.html
6141       // and http://reviews.llvm.org/D8890 .
6142       auto Flags = SCEV::FlagAnyWrap;
6143       if (BO->Op && SA->getValue().ult(BitWidth - 1))
6144         Flags = getNoWrapFlagsFromUB(BO->Op);
6145
6146       Constant *X = ConstantInt::get(getContext(),
6147         APInt::getOneBitSet(BitWidth, SA->getZExtValue()));
6148       return getMulExpr(getSCEV(BO->LHS), getSCEV(X), Flags);
6149     }
6150     break;
6151
6152     case Instruction::AShr: {
6153       // AShr X, C, where C is a constant.
6154       ConstantInt *CI = dyn_cast<ConstantInt>(BO->RHS);
6155       if (!CI)
6156         break;
6157
6158       Type *OuterTy = BO->LHS->getType();
6159       uint64_t BitWidth = getTypeSizeInBits(OuterTy);
6160       // If the shift count is not less than the bitwidth, the result of
6161       // the shift is undefined. Don't try to analyze it, because the
6162       // resolution chosen here may differ from the resolution chosen in
6163       // other parts of the compiler.
6164       if (CI->getValue().uge(BitWidth))
6165         break;
6166
6167       if (CI->isZero())
6168         return getSCEV(BO->LHS); // shift by zero --> noop
6169
6170       uint64_t AShrAmt = CI->getZExtValue();
6171       Type *TruncTy = IntegerType::get(getContext(), BitWidth - AShrAmt);
6172
6173       Operator *L = dyn_cast<Operator>(BO->LHS);
6174       if (L && L->getOpcode() == Instruction::Shl) {
6175         // X = Shl A, n
6176         // Y = AShr X, m
6177         // Both n and m are constant.
6178
6179         const SCEV *ShlOp0SCEV = getSCEV(L->getOperand(0));
6180         if (L->getOperand(1) == BO->RHS)
6181           // For a two-shift sext-inreg, i.e. n = m,
6182           // use sext(trunc(x)) as the SCEV expression.
6183           return getSignExtendExpr(
6184               getTruncateExpr(ShlOp0SCEV, TruncTy), OuterTy);
6185
6186         ConstantInt *ShlAmtCI = dyn_cast<ConstantInt>(L->getOperand(1));
6187         if (ShlAmtCI && ShlAmtCI->getValue().ult(BitWidth)) {
6188           uint64_t ShlAmt = ShlAmtCI->getZExtValue();
6189           if (ShlAmt > AShrAmt) {
6190             // When n > m, use sext(mul(trunc(x), 2^(n-m)))) as the SCEV
6191             // expression. We already checked that ShlAmt < BitWidth, so
6192             // the multiplier, 1 << (ShlAmt - AShrAmt), fits into TruncTy as
6193             // ShlAmt - AShrAmt < Amt.
6194             APInt Mul = APInt::getOneBitSet(BitWidth - AShrAmt,
6195                                             ShlAmt - AShrAmt);
6196             return getSignExtendExpr(
6197                 getMulExpr(getTruncateExpr(ShlOp0SCEV, TruncTy),
6198                 getConstant(Mul)), OuterTy);
6199           }
6200         }
6201       }
6202       break;
6203     }
6204     }
6205   }
6206
6207   switch (U->getOpcode()) {
6208   case Instruction::Trunc:
6209     return getTruncateExpr(getSCEV(U->getOperand(0)), U->getType());
6210
6211   case Instruction::ZExt:
6212     return getZeroExtendExpr(getSCEV(U->getOperand(0)), U->getType());
6213
6214   case Instruction::SExt:
6215     if (auto BO = MatchBinaryOp(U->getOperand(0), DT)) {
6216       // The NSW flag of a subtract does not always survive the conversion to
6217       // A + (-1)*B.  By pushing sign extension onto its operands we are much
6218       // more likely to preserve NSW and allow later AddRec optimisations.
6219       //
6220       // NOTE: This is effectively duplicating this logic from getSignExtend:
6221       //   sext((A + B + ...)<nsw>) --> (sext(A) + sext(B) + ...)<nsw>
6222       // but by that point the NSW information has potentially been lost.
6223       if (BO->Opcode == Instruction::Sub && BO->IsNSW) {
6224         Type *Ty = U->getType();
6225         auto *V1 = getSignExtendExpr(getSCEV(BO->LHS), Ty);
6226         auto *V2 = getSignExtendExpr(getSCEV(BO->RHS), Ty);
6227         return getMinusSCEV(V1, V2, SCEV::FlagNSW);
6228       }
6229     }
6230     return getSignExtendExpr(getSCEV(U->getOperand(0)), U->getType());
6231
6232   case Instruction::BitCast:
6233     // BitCasts are no-op casts so we just eliminate the cast.
6234     if (isSCEVable(U->getType()) && isSCEVable(U->getOperand(0)->getType()))
6235       return getSCEV(U->getOperand(0));
6236     break;
6237
6238   // It's tempting to handle inttoptr and ptrtoint as no-ops, however this can
6239   // lead to pointer expressions which cannot safely be expanded to GEPs,
6240   // because ScalarEvolution doesn't respect the GEP aliasing rules when
6241   // simplifying integer expressions.
6242
6243   case Instruction::GetElementPtr:
6244     return createNodeForGEP(cast<GEPOperator>(U));
6245
6246   case Instruction::PHI:
6247     return createNodeForPHI(cast<PHINode>(U));
6248
6249   case Instruction::Select:
6250     // U can also be a select constant expr, which let fall through.  Since
6251     // createNodeForSelect only works for a condition that is an `ICmpInst`, and
6252     // constant expressions cannot have instructions as operands, we'd have
6253     // returned getUnknown for a select constant expressions anyway.
6254     if (isa<Instruction>(U))
6255       return createNodeForSelectOrPHI(cast<Instruction>(U), U->getOperand(0),
6256                                       U->getOperand(1), U->getOperand(2));
6257     break;
6258
6259   case Instruction::Call:
6260   case Instruction::Invoke:
6261     if (Value *RV = CallSite(U).getReturnedArgOperand())
6262       return getSCEV(RV);
6263     break;
6264   }
6265
6266   return getUnknown(V);
6267 }
6268
6269 //===----------------------------------------------------------------------===//
6270 //                   Iteration Count Computation Code
6271 //
6272
6273 static unsigned getConstantTripCount(const SCEVConstant *ExitCount) {
6274   if (!ExitCount)
6275     return 0;
6276
6277   ConstantInt *ExitConst = ExitCount->getValue();
6278
6279   // Guard against huge trip counts.
6280   if (ExitConst->getValue().getActiveBits() > 32)
6281     return 0;
6282
6283   // In case of integer overflow, this returns 0, which is correct.
6284   return ((unsigned)ExitConst->getZExtValue()) + 1;
6285 }
6286
6287 unsigned ScalarEvolution::getSmallConstantTripCount(const Loop *L) {
6288   if (BasicBlock *ExitingBB = L->getExitingBlock())
6289     return getSmallConstantTripCount(L, ExitingBB);
6290
6291   // No trip count information for multiple exits.
6292   return 0;
6293 }
6294
6295 unsigned ScalarEvolution::getSmallConstantTripCount(const Loop *L,
6296                                                     BasicBlock *ExitingBlock) {
6297   assert(ExitingBlock && "Must pass a non-null exiting block!");
6298   assert(L->isLoopExiting(ExitingBlock) &&
6299          "Exiting block must actually branch out of the loop!");
6300   const SCEVConstant *ExitCount =
6301       dyn_cast<SCEVConstant>(getExitCount(L, ExitingBlock));
6302   return getConstantTripCount(ExitCount);
6303 }
6304
6305 unsigned ScalarEvolution::getSmallConstantMaxTripCount(const Loop *L) {
6306   const auto *MaxExitCount =
6307       dyn_cast<SCEVConstant>(getMaxBackedgeTakenCount(L));
6308   return getConstantTripCount(MaxExitCount);
6309 }
6310
6311 unsigned ScalarEvolution::getSmallConstantTripMultiple(const Loop *L) {
6312   if (BasicBlock *ExitingBB = L->getExitingBlock())
6313     return getSmallConstantTripMultiple(L, ExitingBB);
6314
6315   // No trip multiple information for multiple exits.
6316   return 0;
6317 }
6318
6319 /// Returns the largest constant divisor of the trip count of this loop as a
6320 /// normal unsigned value, if possible. This means that the actual trip count is
6321 /// always a multiple of the returned value (don't forget the trip count could
6322 /// very well be zero as well!).
6323 ///
6324 /// Returns 1 if the trip count is unknown or not guaranteed to be the
6325 /// multiple of a constant (which is also the case if the trip count is simply
6326 /// constant, use getSmallConstantTripCount for that case), Will also return 1
6327 /// if the trip count is very large (>= 2^32).
6328 ///
6329 /// As explained in the comments for getSmallConstantTripCount, this assumes
6330 /// that control exits the loop via ExitingBlock.
6331 unsigned
6332 ScalarEvolution::getSmallConstantTripMultiple(const Loop *L,
6333                                               BasicBlock *ExitingBlock) {
6334   assert(ExitingBlock && "Must pass a non-null exiting block!");
6335   assert(L->isLoopExiting(ExitingBlock) &&
6336          "Exiting block must actually branch out of the loop!");
6337   const SCEV *ExitCount = getExitCount(L, ExitingBlock);
6338   if (ExitCount == getCouldNotCompute())
6339     return 1;
6340
6341   // Get the trip count from the BE count by adding 1.
6342   const SCEV *TCExpr = getAddExpr(ExitCount, getOne(ExitCount->getType()));
6343
6344   const SCEVConstant *TC = dyn_cast<SCEVConstant>(TCExpr);
6345   if (!TC)
6346     // Attempt to factor more general cases. Returns the greatest power of
6347     // two divisor. If overflow happens, the trip count expression is still
6348     // divisible by the greatest power of 2 divisor returned.
6349     return 1U << std::min((uint32_t)31, GetMinTrailingZeros(TCExpr));
6350
6351   ConstantInt *Result = TC->getValue();
6352
6353   // Guard against huge trip counts (this requires checking
6354   // for zero to handle the case where the trip count == -1 and the
6355   // addition wraps).
6356   if (!Result || Result->getValue().getActiveBits() > 32 ||
6357       Result->getValue().getActiveBits() == 0)
6358     return 1;
6359
6360   return (unsigned)Result->getZExtValue();
6361 }
6362
6363 /// Get the expression for the number of loop iterations for which this loop is
6364 /// guaranteed not to exit via ExitingBlock. Otherwise return
6365 /// SCEVCouldNotCompute.
6366 const SCEV *ScalarEvolution::getExitCount(const Loop *L,
6367                                           BasicBlock *ExitingBlock) {
6368   return getBackedgeTakenInfo(L).getExact(ExitingBlock, this);
6369 }
6370
6371 const SCEV *
6372 ScalarEvolution::getPredicatedBackedgeTakenCount(const Loop *L,
6373                                                  SCEVUnionPredicate &Preds) {
6374   return getPredicatedBackedgeTakenInfo(L).getExact(this, &Preds);
6375 }
6376
6377 const SCEV *ScalarEvolution::getBackedgeTakenCount(const Loop *L) {
6378   return getBackedgeTakenInfo(L).getExact(this);
6379 }
6380
6381 /// Similar to getBackedgeTakenCount, except return the least SCEV value that is
6382 /// known never to be less than the actual backedge taken count.
6383 const SCEV *ScalarEvolution::getMaxBackedgeTakenCount(const Loop *L) {
6384   return getBackedgeTakenInfo(L).getMax(this);
6385 }
6386
6387 bool ScalarEvolution::isBackedgeTakenCountMaxOrZero(const Loop *L) {
6388   return getBackedgeTakenInfo(L).isMaxOrZero(this);
6389 }
6390
6391 /// Push PHI nodes in the header of the given loop onto the given Worklist.
6392 static void
6393 PushLoopPHIs(const Loop *L, SmallVectorImpl<Instruction *> &Worklist) {
6394   BasicBlock *Header = L->getHeader();
6395
6396   // Push all Loop-header PHIs onto the Worklist stack.
6397   for (BasicBlock::iterator I = Header->begin();
6398        PHINode *PN = dyn_cast<PHINode>(I); ++I)
6399     Worklist.push_back(PN);
6400 }
6401
6402 const ScalarEvolution::BackedgeTakenInfo &
6403 ScalarEvolution::getPredicatedBackedgeTakenInfo(const Loop *L) {
6404   auto &BTI = getBackedgeTakenInfo(L);
6405   if (BTI.hasFullInfo())
6406     return BTI;
6407
6408   auto Pair = PredicatedBackedgeTakenCounts.insert({L, BackedgeTakenInfo()});
6409
6410   if (!Pair.second)
6411     return Pair.first->second;
6412
6413   BackedgeTakenInfo Result =
6414       computeBackedgeTakenCount(L, /*AllowPredicates=*/true);
6415
6416   return PredicatedBackedgeTakenCounts.find(L)->second = std::move(Result);
6417 }
6418
6419 const ScalarEvolution::BackedgeTakenInfo &
6420 ScalarEvolution::getBackedgeTakenInfo(const Loop *L) {
6421   // Initially insert an invalid entry for this loop. If the insertion
6422   // succeeds, proceed to actually compute a backedge-taken count and
6423   // update the value. The temporary CouldNotCompute value tells SCEV
6424   // code elsewhere that it shouldn't attempt to request a new
6425   // backedge-taken count, which could result in infinite recursion.
6426   std::pair<DenseMap<const Loop *, BackedgeTakenInfo>::iterator, bool> Pair =
6427       BackedgeTakenCounts.insert({L, BackedgeTakenInfo()});
6428   if (!Pair.second)
6429     return Pair.first->second;
6430
6431   // computeBackedgeTakenCount may allocate memory for its result. Inserting it
6432   // into the BackedgeTakenCounts map transfers ownership. Otherwise, the result
6433   // must be cleared in this scope.
6434   BackedgeTakenInfo Result = computeBackedgeTakenCount(L);
6435
6436   if (Result.getExact(this) != getCouldNotCompute()) {
6437     assert(isLoopInvariant(Result.getExact(this), L) &&
6438            isLoopInvariant(Result.getMax(this), L) &&
6439            "Computed backedge-taken count isn't loop invariant for loop!");
6440     ++NumTripCountsComputed;
6441   }
6442   else if (Result.getMax(this) == getCouldNotCompute() &&
6443            isa<PHINode>(L->getHeader()->begin())) {
6444     // Only count loops that have phi nodes as not being computable.
6445     ++NumTripCountsNotComputed;
6446   }
6447
6448   // Now that we know more about the trip count for this loop, forget any
6449   // existing SCEV values for PHI nodes in this loop since they are only
6450   // conservative estimates made without the benefit of trip count
6451   // information. This is similar to the code in forgetLoop, except that
6452   // it handles SCEVUnknown PHI nodes specially.
6453   if (Result.hasAnyInfo()) {
6454     SmallVector<Instruction *, 16> Worklist;
6455     PushLoopPHIs(L, Worklist);
6456
6457     SmallPtrSet<Instruction *, 8> Discovered;
6458     while (!Worklist.empty()) {
6459       Instruction *I = Worklist.pop_back_val();
6460
6461       ValueExprMapType::iterator It =
6462         ValueExprMap.find_as(static_cast<Value *>(I));
6463       if (It != ValueExprMap.end()) {
6464         const SCEV *Old = It->second;
6465
6466         // SCEVUnknown for a PHI either means that it has an unrecognized
6467         // structure, or it's a PHI that's in the progress of being computed
6468         // by createNodeForPHI.  In the former case, additional loop trip
6469         // count information isn't going to change anything. In the later
6470         // case, createNodeForPHI will perform the necessary updates on its
6471         // own when it gets to that point.
6472         if (!isa<PHINode>(I) || !isa<SCEVUnknown>(Old)) {
6473           eraseValueFromMap(It->first);
6474           forgetMemoizedResults(Old);
6475         }
6476         if (PHINode *PN = dyn_cast<PHINode>(I))
6477           ConstantEvolutionLoopExitValue.erase(PN);
6478       }
6479
6480       // Since we don't need to invalidate anything for correctness and we're
6481       // only invalidating to make SCEV's results more precise, we get to stop
6482       // early to avoid invalidating too much.  This is especially important in
6483       // cases like:
6484       //
6485       //   %v = f(pn0, pn1) // pn0 and pn1 used through some other phi node
6486       // loop0:
6487       //   %pn0 = phi
6488       //   ...
6489       // loop1:
6490       //   %pn1 = phi
6491       //   ...
6492       //
6493       // where both loop0 and loop1's backedge taken count uses the SCEV
6494       // expression for %v.  If we don't have the early stop below then in cases
6495       // like the above, getBackedgeTakenInfo(loop1) will clear out the trip
6496       // count for loop0 and getBackedgeTakenInfo(loop0) will clear out the trip
6497       // count for loop1, effectively nullifying SCEV's trip count cache.
6498       for (auto *U : I->users())
6499         if (auto *I = dyn_cast<Instruction>(U)) {
6500           auto *LoopForUser = LI.getLoopFor(I->getParent());
6501           if (LoopForUser && L->contains(LoopForUser) &&
6502               Discovered.insert(I).second)
6503             Worklist.push_back(I);
6504         }
6505     }
6506   }
6507
6508   // Re-lookup the insert position, since the call to
6509   // computeBackedgeTakenCount above could result in a
6510   // recusive call to getBackedgeTakenInfo (on a different
6511   // loop), which would invalidate the iterator computed
6512   // earlier.
6513   return BackedgeTakenCounts.find(L)->second = std::move(Result);
6514 }
6515
6516 void ScalarEvolution::forgetLoop(const Loop *L) {
6517   // Drop any stored trip count value.
6518   auto RemoveLoopFromBackedgeMap =
6519       [](DenseMap<const Loop *, BackedgeTakenInfo> &Map, const Loop *L) {
6520         auto BTCPos = Map.find(L);
6521         if (BTCPos != Map.end()) {
6522           BTCPos->second.clear();
6523           Map.erase(BTCPos);
6524         }
6525       };
6526
6527   SmallVector<const Loop *, 16> LoopWorklist(1, L);
6528   SmallVector<Instruction *, 32> Worklist;
6529   SmallPtrSet<Instruction *, 16> Visited;
6530
6531   // Iterate over all the loops and sub-loops to drop SCEV information.
6532   while (!LoopWorklist.empty()) {
6533     auto *CurrL = LoopWorklist.pop_back_val();
6534
6535     RemoveLoopFromBackedgeMap(BackedgeTakenCounts, CurrL);
6536     RemoveLoopFromBackedgeMap(PredicatedBackedgeTakenCounts, CurrL);
6537
6538     // Drop information about predicated SCEV rewrites for this loop.
6539     for (auto I = PredicatedSCEVRewrites.begin();
6540          I != PredicatedSCEVRewrites.end();) {
6541       std::pair<const SCEV *, const Loop *> Entry = I->first;
6542       if (Entry.second == CurrL)
6543         PredicatedSCEVRewrites.erase(I++);
6544       else
6545         ++I;
6546     }
6547
6548     auto LoopUsersItr = LoopUsers.find(CurrL);
6549     if (LoopUsersItr != LoopUsers.end()) {
6550       for (auto *S : LoopUsersItr->second)
6551         forgetMemoizedResults(S);
6552       LoopUsers.erase(LoopUsersItr);
6553     }
6554
6555     // Drop information about expressions based on loop-header PHIs.
6556     PushLoopPHIs(CurrL, Worklist);
6557
6558     while (!Worklist.empty()) {
6559       Instruction *I = Worklist.pop_back_val();
6560       if (!Visited.insert(I).second)
6561         continue;
6562
6563       ValueExprMapType::iterator It =
6564           ValueExprMap.find_as(static_cast<Value *>(I));
6565       if (It != ValueExprMap.end()) {
6566         eraseValueFromMap(It->first);
6567         forgetMemoizedResults(It->second);
6568         if (PHINode *PN = dyn_cast<PHINode>(I))
6569           ConstantEvolutionLoopExitValue.erase(PN);
6570       }
6571
6572       PushDefUseChildren(I, Worklist);
6573     }
6574
6575     LoopPropertiesCache.erase(CurrL);
6576     // Forget all contained loops too, to avoid dangling entries in the
6577     // ValuesAtScopes map.
6578     LoopWorklist.append(CurrL->begin(), CurrL->end());
6579   }
6580 }
6581
6582 void ScalarEvolution::forgetValue(Value *V) {
6583   Instruction *I = dyn_cast<Instruction>(V);
6584   if (!I) return;
6585
6586   // Drop information about expressions based on loop-header PHIs.
6587   SmallVector<Instruction *, 16> Worklist;
6588   Worklist.push_back(I);
6589
6590   SmallPtrSet<Instruction *, 8> Visited;
6591   while (!Worklist.empty()) {
6592     I = Worklist.pop_back_val();
6593     if (!Visited.insert(I).second)
6594       continue;
6595
6596     ValueExprMapType::iterator It =
6597       ValueExprMap.find_as(static_cast<Value *>(I));
6598     if (It != ValueExprMap.end()) {
6599       eraseValueFromMap(It->first);
6600       forgetMemoizedResults(It->second);
6601       if (PHINode *PN = dyn_cast<PHINode>(I))
6602         ConstantEvolutionLoopExitValue.erase(PN);
6603     }
6604
6605     PushDefUseChildren(I, Worklist);
6606   }
6607 }
6608
6609 /// Get the exact loop backedge taken count considering all loop exits. A
6610 /// computable result can only be returned for loops with a single exit.
6611 /// Returning the minimum taken count among all exits is incorrect because one
6612 /// of the loop's exit limit's may have been skipped. howFarToZero assumes that
6613 /// the limit of each loop test is never skipped. This is a valid assumption as
6614 /// long as the loop exits via that test. For precise results, it is the
6615 /// caller's responsibility to specify the relevant loop exit using
6616 /// getExact(ExitingBlock, SE).
6617 const SCEV *
6618 ScalarEvolution::BackedgeTakenInfo::getExact(ScalarEvolution *SE,
6619                                              SCEVUnionPredicate *Preds) const {
6620   // If any exits were not computable, the loop is not computable.
6621   if (!isComplete() || ExitNotTaken.empty())
6622     return SE->getCouldNotCompute();
6623
6624   const SCEV *BECount = nullptr;
6625   for (auto &ENT : ExitNotTaken) {
6626     assert(ENT.ExactNotTaken != SE->getCouldNotCompute() && "bad exit SCEV");
6627
6628     if (!BECount)
6629       BECount = ENT.ExactNotTaken;
6630     else if (BECount != ENT.ExactNotTaken)
6631       return SE->getCouldNotCompute();
6632     if (Preds && !ENT.hasAlwaysTruePredicate())
6633       Preds->add(ENT.Predicate.get());
6634
6635     assert((Preds || ENT.hasAlwaysTruePredicate()) &&
6636            "Predicate should be always true!");
6637   }
6638
6639   assert(BECount && "Invalid not taken count for loop exit");
6640   return BECount;
6641 }
6642
6643 /// Get the exact not taken count for this loop exit.
6644 const SCEV *
6645 ScalarEvolution::BackedgeTakenInfo::getExact(BasicBlock *ExitingBlock,
6646                                              ScalarEvolution *SE) const {
6647   for (auto &ENT : ExitNotTaken)
6648     if (ENT.ExitingBlock == ExitingBlock && ENT.hasAlwaysTruePredicate())
6649       return ENT.ExactNotTaken;
6650
6651   return SE->getCouldNotCompute();
6652 }
6653
6654 /// getMax - Get the max backedge taken count for the loop.
6655 const SCEV *
6656 ScalarEvolution::BackedgeTakenInfo::getMax(ScalarEvolution *SE) const {
6657   auto PredicateNotAlwaysTrue = [](const ExitNotTakenInfo &ENT) {
6658     return !ENT.hasAlwaysTruePredicate();
6659   };
6660
6661   if (any_of(ExitNotTaken, PredicateNotAlwaysTrue) || !getMax())
6662     return SE->getCouldNotCompute();
6663
6664   assert((isa<SCEVCouldNotCompute>(getMax()) || isa<SCEVConstant>(getMax())) &&
6665          "No point in having a non-constant max backedge taken count!");
6666   return getMax();
6667 }
6668
6669 bool ScalarEvolution::BackedgeTakenInfo::isMaxOrZero(ScalarEvolution *SE) const {
6670   auto PredicateNotAlwaysTrue = [](const ExitNotTakenInfo &ENT) {
6671     return !ENT.hasAlwaysTruePredicate();
6672   };
6673   return MaxOrZero && !any_of(ExitNotTaken, PredicateNotAlwaysTrue);
6674 }
6675
6676 bool ScalarEvolution::BackedgeTakenInfo::hasOperand(const SCEV *S,
6677                                                     ScalarEvolution *SE) const {
6678   if (getMax() && getMax() != SE->getCouldNotCompute() &&
6679       SE->hasOperand(getMax(), S))
6680     return true;
6681
6682   for (auto &ENT : ExitNotTaken)
6683     if (ENT.ExactNotTaken != SE->getCouldNotCompute() &&
6684         SE->hasOperand(ENT.ExactNotTaken, S))
6685       return true;
6686
6687   return false;
6688 }
6689
6690 ScalarEvolution::ExitLimit::ExitLimit(const SCEV *E)
6691     : ExactNotTaken(E), MaxNotTaken(E) {
6692   assert((isa<SCEVCouldNotCompute>(MaxNotTaken) ||
6693           isa<SCEVConstant>(MaxNotTaken)) &&
6694          "No point in having a non-constant max backedge taken count!");
6695 }
6696
6697 ScalarEvolution::ExitLimit::ExitLimit(
6698     const SCEV *E, const SCEV *M, bool MaxOrZero,
6699     ArrayRef<const SmallPtrSetImpl<const SCEVPredicate *> *> PredSetList)
6700     : ExactNotTaken(E), MaxNotTaken(M), MaxOrZero(MaxOrZero) {
6701   assert((isa<SCEVCouldNotCompute>(ExactNotTaken) ||
6702           !isa<SCEVCouldNotCompute>(MaxNotTaken)) &&
6703          "Exact is not allowed to be less precise than Max");
6704   assert((isa<SCEVCouldNotCompute>(MaxNotTaken) ||
6705           isa<SCEVConstant>(MaxNotTaken)) &&
6706          "No point in having a non-constant max backedge taken count!");
6707   for (auto *PredSet : PredSetList)
6708     for (auto *P : *PredSet)
6709       addPredicate(P);
6710 }
6711
6712 ScalarEvolution::ExitLimit::ExitLimit(
6713     const SCEV *E, const SCEV *M, bool MaxOrZero,
6714     const SmallPtrSetImpl<const SCEVPredicate *> &PredSet)
6715     : ExitLimit(E, M, MaxOrZero, {&PredSet}) {
6716   assert((isa<SCEVCouldNotCompute>(MaxNotTaken) ||
6717           isa<SCEVConstant>(MaxNotTaken)) &&
6718          "No point in having a non-constant max backedge taken count!");
6719 }
6720
6721 ScalarEvolution::ExitLimit::ExitLimit(const SCEV *E, const SCEV *M,
6722                                       bool MaxOrZero)
6723     : ExitLimit(E, M, MaxOrZero, None) {
6724   assert((isa<SCEVCouldNotCompute>(MaxNotTaken) ||
6725           isa<SCEVConstant>(MaxNotTaken)) &&
6726          "No point in having a non-constant max backedge taken count!");
6727 }
6728
6729 /// Allocate memory for BackedgeTakenInfo and copy the not-taken count of each
6730 /// computable exit into a persistent ExitNotTakenInfo array.
6731 ScalarEvolution::BackedgeTakenInfo::BackedgeTakenInfo(
6732     SmallVectorImpl<ScalarEvolution::BackedgeTakenInfo::EdgeExitInfo>
6733         &&ExitCounts,
6734     bool Complete, const SCEV *MaxCount, bool MaxOrZero)
6735     : MaxAndComplete(MaxCount, Complete), MaxOrZero(MaxOrZero) {
6736   using EdgeExitInfo = ScalarEvolution::BackedgeTakenInfo::EdgeExitInfo;
6737
6738   ExitNotTaken.reserve(ExitCounts.size());
6739   std::transform(
6740       ExitCounts.begin(), ExitCounts.end(), std::back_inserter(ExitNotTaken),
6741       [&](const EdgeExitInfo &EEI) {
6742         BasicBlock *ExitBB = EEI.first;
6743         const ExitLimit &EL = EEI.second;
6744         if (EL.Predicates.empty())
6745           return ExitNotTakenInfo(ExitBB, EL.ExactNotTaken, nullptr);
6746
6747         std::unique_ptr<SCEVUnionPredicate> Predicate(new SCEVUnionPredicate);
6748         for (auto *Pred : EL.Predicates)
6749           Predicate->add(Pred);
6750
6751         return ExitNotTakenInfo(ExitBB, EL.ExactNotTaken, std::move(Predicate));
6752       });
6753   assert((isa<SCEVCouldNotCompute>(MaxCount) || isa<SCEVConstant>(MaxCount)) &&
6754          "No point in having a non-constant max backedge taken count!");
6755 }
6756
6757 /// Invalidate this result and free the ExitNotTakenInfo array.
6758 void ScalarEvolution::BackedgeTakenInfo::clear() {
6759   ExitNotTaken.clear();
6760 }
6761
6762 /// Compute the number of times the backedge of the specified loop will execute.
6763 ScalarEvolution::BackedgeTakenInfo
6764 ScalarEvolution::computeBackedgeTakenCount(const Loop *L,
6765                                            bool AllowPredicates) {
6766   SmallVector<BasicBlock *, 8> ExitingBlocks;
6767   L->getExitingBlocks(ExitingBlocks);
6768
6769   using EdgeExitInfo = ScalarEvolution::BackedgeTakenInfo::EdgeExitInfo;
6770
6771   SmallVector<EdgeExitInfo, 4> ExitCounts;
6772   bool CouldComputeBECount = true;
6773   BasicBlock *Latch = L->getLoopLatch(); // may be NULL.
6774   const SCEV *MustExitMaxBECount = nullptr;
6775   const SCEV *MayExitMaxBECount = nullptr;
6776   bool MustExitMaxOrZero = false;
6777
6778   // Compute the ExitLimit for each loop exit. Use this to populate ExitCounts
6779   // and compute maxBECount.
6780   // Do a union of all the predicates here.
6781   for (unsigned i = 0, e = ExitingBlocks.size(); i != e; ++i) {
6782     BasicBlock *ExitBB = ExitingBlocks[i];
6783     ExitLimit EL = computeExitLimit(L, ExitBB, AllowPredicates);
6784
6785     assert((AllowPredicates || EL.Predicates.empty()) &&
6786            "Predicated exit limit when predicates are not allowed!");
6787
6788     // 1. For each exit that can be computed, add an entry to ExitCounts.
6789     // CouldComputeBECount is true only if all exits can be computed.
6790     if (EL.ExactNotTaken == getCouldNotCompute())
6791       // We couldn't compute an exact value for this exit, so
6792       // we won't be able to compute an exact value for the loop.
6793       CouldComputeBECount = false;
6794     else
6795       ExitCounts.emplace_back(ExitBB, EL);
6796
6797     // 2. Derive the loop's MaxBECount from each exit's max number of
6798     // non-exiting iterations. Partition the loop exits into two kinds:
6799     // LoopMustExits and LoopMayExits.
6800     //
6801     // If the exit dominates the loop latch, it is a LoopMustExit otherwise it
6802     // is a LoopMayExit.  If any computable LoopMustExit is found, then
6803     // MaxBECount is the minimum EL.MaxNotTaken of computable
6804     // LoopMustExits. Otherwise, MaxBECount is conservatively the maximum
6805     // EL.MaxNotTaken, where CouldNotCompute is considered greater than any
6806     // computable EL.MaxNotTaken.
6807     if (EL.MaxNotTaken != getCouldNotCompute() && Latch &&
6808         DT.dominates(ExitBB, Latch)) {
6809       if (!MustExitMaxBECount) {
6810         MustExitMaxBECount = EL.MaxNotTaken;
6811         MustExitMaxOrZero = EL.MaxOrZero;
6812       } else {
6813         MustExitMaxBECount =
6814             getUMinFromMismatchedTypes(MustExitMaxBECount, EL.MaxNotTaken);
6815       }
6816     } else if (MayExitMaxBECount != getCouldNotCompute()) {
6817       if (!MayExitMaxBECount || EL.MaxNotTaken == getCouldNotCompute())
6818         MayExitMaxBECount = EL.MaxNotTaken;
6819       else {
6820         MayExitMaxBECount =
6821             getUMaxFromMismatchedTypes(MayExitMaxBECount, EL.MaxNotTaken);
6822       }
6823     }
6824   }
6825   const SCEV *MaxBECount = MustExitMaxBECount ? MustExitMaxBECount :
6826     (MayExitMaxBECount ? MayExitMaxBECount : getCouldNotCompute());
6827   // The loop backedge will be taken the maximum or zero times if there's
6828   // a single exit that must be taken the maximum or zero times.
6829   bool MaxOrZero = (MustExitMaxOrZero && ExitingBlocks.size() == 1);
6830   return BackedgeTakenInfo(std::move(ExitCounts), CouldComputeBECount,
6831                            MaxBECount, MaxOrZero);
6832 }
6833
6834 ScalarEvolution::ExitLimit
6835 ScalarEvolution::computeExitLimit(const Loop *L, BasicBlock *ExitingBlock,
6836                                       bool AllowPredicates) {
6837   // Okay, we've chosen an exiting block.  See what condition causes us to exit
6838   // at this block and remember the exit block and whether all other targets
6839   // lead to the loop header.
6840   bool MustExecuteLoopHeader = true;
6841   BasicBlock *Exit = nullptr;
6842   for (auto *SBB : successors(ExitingBlock))
6843     if (!L->contains(SBB)) {
6844       if (Exit) // Multiple exit successors.
6845         return getCouldNotCompute();
6846       Exit = SBB;
6847     } else if (SBB != L->getHeader()) {
6848       MustExecuteLoopHeader = false;
6849     }
6850
6851   // At this point, we know we have a conditional branch that determines whether
6852   // the loop is exited.  However, we don't know if the branch is executed each
6853   // time through the loop.  If not, then the execution count of the branch will
6854   // not be equal to the trip count of the loop.
6855   //
6856   // Currently we check for this by checking to see if the Exit branch goes to
6857   // the loop header.  If so, we know it will always execute the same number of
6858   // times as the loop.  We also handle the case where the exit block *is* the
6859   // loop header.  This is common for un-rotated loops.
6860   //
6861   // If both of those tests fail, walk up the unique predecessor chain to the
6862   // header, stopping if there is an edge that doesn't exit the loop. If the
6863   // header is reached, the execution count of the branch will be equal to the
6864   // trip count of the loop.
6865   //
6866   //  More extensive analysis could be done to handle more cases here.
6867   //
6868   if (!MustExecuteLoopHeader && ExitingBlock != L->getHeader()) {
6869     // The simple checks failed, try climbing the unique predecessor chain
6870     // up to the header.
6871     bool Ok = false;
6872     for (BasicBlock *BB = ExitingBlock; BB; ) {
6873       BasicBlock *Pred = BB->getUniquePredecessor();
6874       if (!Pred)
6875         return getCouldNotCompute();
6876       TerminatorInst *PredTerm = Pred->getTerminator();
6877       for (const BasicBlock *PredSucc : PredTerm->successors()) {
6878         if (PredSucc == BB)
6879           continue;
6880         // If the predecessor has a successor that isn't BB and isn't
6881         // outside the loop, assume the worst.
6882         if (L->contains(PredSucc))
6883           return getCouldNotCompute();
6884       }
6885       if (Pred == L->getHeader()) {
6886         Ok = true;
6887         break;
6888       }
6889       BB = Pred;
6890     }
6891     if (!Ok)
6892       return getCouldNotCompute();
6893   }
6894
6895   bool IsOnlyExit = (L->getExitingBlock() != nullptr);
6896   TerminatorInst *Term = ExitingBlock->getTerminator();
6897   if (BranchInst *BI = dyn_cast<BranchInst>(Term)) {
6898     assert(BI->isConditional() && "If unconditional, it can't be in loop!");
6899     // Proceed to the next level to examine the exit condition expression.
6900     return computeExitLimitFromCond(
6901         L, BI->getCondition(), BI->getSuccessor(0), BI->getSuccessor(1),
6902         /*ControlsExit=*/IsOnlyExit, AllowPredicates);
6903   }
6904
6905   if (SwitchInst *SI = dyn_cast<SwitchInst>(Term))
6906     return computeExitLimitFromSingleExitSwitch(L, SI, Exit,
6907                                                 /*ControlsExit=*/IsOnlyExit);
6908
6909   return getCouldNotCompute();
6910 }
6911
6912 ScalarEvolution::ExitLimit ScalarEvolution::computeExitLimitFromCond(
6913     const Loop *L, Value *ExitCond, BasicBlock *TBB, BasicBlock *FBB,
6914     bool ControlsExit, bool AllowPredicates) {
6915   ScalarEvolution::ExitLimitCacheTy Cache(L, TBB, FBB, AllowPredicates);
6916   return computeExitLimitFromCondCached(Cache, L, ExitCond, TBB, FBB,
6917                                         ControlsExit, AllowPredicates);
6918 }
6919
6920 Optional<ScalarEvolution::ExitLimit>
6921 ScalarEvolution::ExitLimitCache::find(const Loop *L, Value *ExitCond,
6922                                       BasicBlock *TBB, BasicBlock *FBB,
6923                                       bool ControlsExit, bool AllowPredicates) {
6924   (void)this->L;
6925   (void)this->TBB;
6926   (void)this->FBB;
6927   (void)this->AllowPredicates;
6928
6929   assert(this->L == L && this->TBB == TBB && this->FBB == FBB &&
6930          this->AllowPredicates == AllowPredicates &&
6931          "Variance in assumed invariant key components!");
6932   auto Itr = TripCountMap.find({ExitCond, ControlsExit});
6933   if (Itr == TripCountMap.end())
6934     return None;
6935   return Itr->second;
6936 }
6937
6938 void ScalarEvolution::ExitLimitCache::insert(const Loop *L, Value *ExitCond,
6939                                              BasicBlock *TBB, BasicBlock *FBB,
6940                                              bool ControlsExit,
6941                                              bool AllowPredicates,
6942                                              const ExitLimit &EL) {
6943   assert(this->L == L && this->TBB == TBB && this->FBB == FBB &&
6944          this->AllowPredicates == AllowPredicates &&
6945          "Variance in assumed invariant key components!");
6946
6947   auto InsertResult = TripCountMap.insert({{ExitCond, ControlsExit}, EL});
6948   assert(InsertResult.second && "Expected successful insertion!");
6949   (void)InsertResult;
6950 }
6951
6952 ScalarEvolution::ExitLimit ScalarEvolution::computeExitLimitFromCondCached(
6953     ExitLimitCacheTy &Cache, const Loop *L, Value *ExitCond, BasicBlock *TBB,
6954     BasicBlock *FBB, bool ControlsExit, bool AllowPredicates) {
6955
6956   if (auto MaybeEL =
6957           Cache.find(L, ExitCond, TBB, FBB, ControlsExit, AllowPredicates))
6958     return *MaybeEL;
6959
6960   ExitLimit EL = computeExitLimitFromCondImpl(Cache, L, ExitCond, TBB, FBB,
6961                                               ControlsExit, AllowPredicates);
6962   Cache.insert(L, ExitCond, TBB, FBB, ControlsExit, AllowPredicates, EL);
6963   return EL;
6964 }
6965
6966 ScalarEvolution::ExitLimit ScalarEvolution::computeExitLimitFromCondImpl(
6967     ExitLimitCacheTy &Cache, const Loop *L, Value *ExitCond, BasicBlock *TBB,
6968     BasicBlock *FBB, bool ControlsExit, bool AllowPredicates) {
6969   // Check if the controlling expression for this loop is an And or Or.
6970   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(ExitCond)) {
6971     if (BO->getOpcode() == Instruction::And) {
6972       // Recurse on the operands of the and.
6973       bool EitherMayExit = L->contains(TBB);
6974       ExitLimit EL0 = computeExitLimitFromCondCached(
6975           Cache, L, BO->getOperand(0), TBB, FBB, ControlsExit && !EitherMayExit,
6976           AllowPredicates);
6977       ExitLimit EL1 = computeExitLimitFromCondCached(
6978           Cache, L, BO->getOperand(1), TBB, FBB, ControlsExit && !EitherMayExit,
6979           AllowPredicates);
6980       const SCEV *BECount = getCouldNotCompute();
6981       const SCEV *MaxBECount = getCouldNotCompute();
6982       if (EitherMayExit) {
6983         // Both conditions must be true for the loop to continue executing.
6984         // Choose the less conservative count.
6985         if (EL0.ExactNotTaken == getCouldNotCompute() ||
6986             EL1.ExactNotTaken == getCouldNotCompute())
6987           BECount = getCouldNotCompute();
6988         else
6989           BECount =
6990               getUMinFromMismatchedTypes(EL0.ExactNotTaken, EL1.ExactNotTaken);
6991         if (EL0.MaxNotTaken == getCouldNotCompute())
6992           MaxBECount = EL1.MaxNotTaken;
6993         else if (EL1.MaxNotTaken == getCouldNotCompute())
6994           MaxBECount = EL0.MaxNotTaken;
6995         else
6996           MaxBECount =
6997               getUMinFromMismatchedTypes(EL0.MaxNotTaken, EL1.MaxNotTaken);
6998       } else {
6999         // Both conditions must be true at the same time for the loop to exit.
7000         // For now, be conservative.
7001         assert(L->contains(FBB) && "Loop block has no successor in loop!");
7002         if (EL0.MaxNotTaken == EL1.MaxNotTaken)
7003           MaxBECount = EL0.MaxNotTaken;
7004         if (EL0.ExactNotTaken == EL1.ExactNotTaken)
7005           BECount = EL0.ExactNotTaken;
7006       }
7007
7008       // There are cases (e.g. PR26207) where computeExitLimitFromCond is able
7009       // to be more aggressive when computing BECount than when computing
7010       // MaxBECount.  In these cases it is possible for EL0.ExactNotTaken and
7011       // EL1.ExactNotTaken to match, but for EL0.MaxNotTaken and EL1.MaxNotTaken
7012       // to not.
7013       if (isa<SCEVCouldNotCompute>(MaxBECount) &&
7014           !isa<SCEVCouldNotCompute>(BECount))
7015         MaxBECount = getConstant(getUnsignedRangeMax(BECount));
7016
7017       return ExitLimit(BECount, MaxBECount, false,
7018                        {&EL0.Predicates, &EL1.Predicates});
7019     }
7020     if (BO->getOpcode() == Instruction::Or) {
7021       // Recurse on the operands of the or.
7022       bool EitherMayExit = L->contains(FBB);
7023       ExitLimit EL0 = computeExitLimitFromCondCached(
7024           Cache, L, BO->getOperand(0), TBB, FBB, ControlsExit && !EitherMayExit,
7025           AllowPredicates);
7026       ExitLimit EL1 = computeExitLimitFromCondCached(
7027           Cache, L, BO->getOperand(1), TBB, FBB, ControlsExit && !EitherMayExit,
7028           AllowPredicates);
7029       const SCEV *BECount = getCouldNotCompute();
7030       const SCEV *MaxBECount = getCouldNotCompute();
7031       if (EitherMayExit) {
7032         // Both conditions must be false for the loop to continue executing.
7033         // Choose the less conservative count.
7034         if (EL0.ExactNotTaken == getCouldNotCompute() ||
7035             EL1.ExactNotTaken == getCouldNotCompute())
7036           BECount = getCouldNotCompute();
7037         else
7038           BECount =
7039               getUMinFromMismatchedTypes(EL0.ExactNotTaken, EL1.ExactNotTaken);
7040         if (EL0.MaxNotTaken == getCouldNotCompute())
7041           MaxBECount = EL1.MaxNotTaken;
7042         else if (EL1.MaxNotTaken == getCouldNotCompute())
7043           MaxBECount = EL0.MaxNotTaken;
7044         else
7045           MaxBECount =
7046               getUMinFromMismatchedTypes(EL0.MaxNotTaken, EL1.MaxNotTaken);
7047       } else {
7048         // Both conditions must be false at the same time for the loop to exit.
7049         // For now, be conservative.
7050         assert(L->contains(TBB) && "Loop block has no successor in loop!");
7051         if (EL0.MaxNotTaken == EL1.MaxNotTaken)
7052           MaxBECount = EL0.MaxNotTaken;
7053         if (EL0.ExactNotTaken == EL1.ExactNotTaken)
7054           BECount = EL0.ExactNotTaken;
7055       }
7056
7057       return ExitLimit(BECount, MaxBECount, false,
7058                        {&EL0.Predicates, &EL1.Predicates});
7059     }
7060   }
7061
7062   // With an icmp, it may be feasible to compute an exact backedge-taken count.
7063   // Proceed to the next level to examine the icmp.
7064   if (ICmpInst *ExitCondICmp = dyn_cast<ICmpInst>(ExitCond)) {
7065     ExitLimit EL =
7066         computeExitLimitFromICmp(L, ExitCondICmp, TBB, FBB, ControlsExit);
7067     if (EL.hasFullInfo() || !AllowPredicates)
7068       return EL;
7069
7070     // Try again, but use SCEV predicates this time.
7071     return computeExitLimitFromICmp(L, ExitCondICmp, TBB, FBB, ControlsExit,
7072                                     /*AllowPredicates=*/true);
7073   }
7074
7075   // Check for a constant condition. These are normally stripped out by
7076   // SimplifyCFG, but ScalarEvolution may be used by a pass which wishes to
7077   // preserve the CFG and is temporarily leaving constant conditions
7078   // in place.
7079   if (ConstantInt *CI = dyn_cast<ConstantInt>(ExitCond)) {
7080     if (L->contains(FBB) == !CI->getZExtValue())
7081       // The backedge is always taken.
7082       return getCouldNotCompute();
7083     else
7084       // The backedge is never taken.
7085       return getZero(CI->getType());
7086   }
7087
7088   // If it's not an integer or pointer comparison then compute it the hard way.
7089   return computeExitCountExhaustively(L, ExitCond, !L->contains(TBB));
7090 }
7091
7092 ScalarEvolution::ExitLimit
7093 ScalarEvolution::computeExitLimitFromICmp(const Loop *L,
7094                                           ICmpInst *ExitCond,
7095                                           BasicBlock *TBB,
7096                                           BasicBlock *FBB,
7097                                           bool ControlsExit,
7098                                           bool AllowPredicates) {
7099   // If the condition was exit on true, convert the condition to exit on false
7100   ICmpInst::Predicate Pred;
7101   if (!L->contains(FBB))
7102     Pred = ExitCond->getPredicate();
7103   else
7104     Pred = ExitCond->getInversePredicate();
7105   const ICmpInst::Predicate OriginalPred = Pred;
7106
7107   // Handle common loops like: for (X = "string"; *X; ++X)
7108   if (LoadInst *LI = dyn_cast<LoadInst>(ExitCond->getOperand(0)))
7109     if (Constant *RHS = dyn_cast<Constant>(ExitCond->getOperand(1))) {
7110       ExitLimit ItCnt =
7111         computeLoadConstantCompareExitLimit(LI, RHS, L, Pred);
7112       if (ItCnt.hasAnyInfo())
7113         return ItCnt;
7114     }
7115
7116   const SCEV *LHS = getSCEV(ExitCond->getOperand(0));
7117   const SCEV *RHS = getSCEV(ExitCond->getOperand(1));
7118
7119   // Try to evaluate any dependencies out of the loop.
7120   LHS = getSCEVAtScope(LHS, L);
7121   RHS = getSCEVAtScope(RHS, L);
7122
7123   // At this point, we would like to compute how many iterations of the
7124   // loop the predicate will return true for these inputs.
7125   if (isLoopInvariant(LHS, L) && !isLoopInvariant(RHS, L)) {
7126     // If there is a loop-invariant, force it into the RHS.
7127     std::swap(LHS, RHS);
7128     Pred = ICmpInst::getSwappedPredicate(Pred);
7129   }
7130
7131   // Simplify the operands before analyzing them.
7132   (void)SimplifyICmpOperands(Pred, LHS, RHS);
7133
7134   // If we have a comparison of a chrec against a constant, try to use value
7135   // ranges to answer this query.
7136   if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS))
7137     if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS))
7138       if (AddRec->getLoop() == L) {
7139         // Form the constant range.
7140         ConstantRange CompRange =
7141             ConstantRange::makeExactICmpRegion(Pred, RHSC->getAPInt());
7142
7143         const SCEV *Ret = AddRec->getNumIterationsInRange(CompRange, *this);
7144         if (!isa<SCEVCouldNotCompute>(Ret)) return Ret;
7145       }
7146
7147   switch (Pred) {
7148   case ICmpInst::ICMP_NE: {                     // while (X != Y)
7149     // Convert to: while (X-Y != 0)
7150     ExitLimit EL = howFarToZero(getMinusSCEV(LHS, RHS), L, ControlsExit,
7151                                 AllowPredicates);
7152     if (EL.hasAnyInfo()) return EL;
7153     break;
7154   }
7155   case ICmpInst::ICMP_EQ: {                     // while (X == Y)
7156     // Convert to: while (X-Y == 0)
7157     ExitLimit EL = howFarToNonZero(getMinusSCEV(LHS, RHS), L);
7158     if (EL.hasAnyInfo()) return EL;
7159     break;
7160   }
7161   case ICmpInst::ICMP_SLT:
7162   case ICmpInst::ICMP_ULT: {                    // while (X < Y)
7163     bool IsSigned = Pred == ICmpInst::ICMP_SLT;
7164     ExitLimit EL = howManyLessThans(LHS, RHS, L, IsSigned, ControlsExit,
7165                                     AllowPredicates);
7166     if (EL.hasAnyInfo()) return EL;
7167     break;
7168   }
7169   case ICmpInst::ICMP_SGT:
7170   case ICmpInst::ICMP_UGT: {                    // while (X > Y)
7171     bool IsSigned = Pred == ICmpInst::ICMP_SGT;
7172     ExitLimit EL =
7173         howManyGreaterThans(LHS, RHS, L, IsSigned, ControlsExit,
7174                             AllowPredicates);
7175     if (EL.hasAnyInfo()) return EL;
7176     break;
7177   }
7178   default:
7179     break;
7180   }
7181
7182   auto *ExhaustiveCount =
7183       computeExitCountExhaustively(L, ExitCond, !L->contains(TBB));
7184
7185   if (!isa<SCEVCouldNotCompute>(ExhaustiveCount))
7186     return ExhaustiveCount;
7187
7188   return computeShiftCompareExitLimit(ExitCond->getOperand(0),
7189                                       ExitCond->getOperand(1), L, OriginalPred);
7190 }
7191
7192 ScalarEvolution::ExitLimit
7193 ScalarEvolution::computeExitLimitFromSingleExitSwitch(const Loop *L,
7194                                                       SwitchInst *Switch,
7195                                                       BasicBlock *ExitingBlock,
7196                                                       bool ControlsExit) {
7197   assert(!L->contains(ExitingBlock) && "Not an exiting block!");
7198
7199   // Give up if the exit is the default dest of a switch.
7200   if (Switch->getDefaultDest() == ExitingBlock)
7201     return getCouldNotCompute();
7202
7203   assert(L->contains(Switch->getDefaultDest()) &&
7204          "Default case must not exit the loop!");
7205   const SCEV *LHS = getSCEVAtScope(Switch->getCondition(), L);
7206   const SCEV *RHS = getConstant(Switch->findCaseDest(ExitingBlock));
7207
7208   // while (X != Y) --> while (X-Y != 0)
7209   ExitLimit EL = howFarToZero(getMinusSCEV(LHS, RHS), L, ControlsExit);
7210   if (EL.hasAnyInfo())
7211     return EL;
7212
7213   return getCouldNotCompute();
7214 }
7215
7216 static ConstantInt *
7217 EvaluateConstantChrecAtConstant(const SCEVAddRecExpr *AddRec, ConstantInt *C,
7218                                 ScalarEvolution &SE) {
7219   const SCEV *InVal = SE.getConstant(C);
7220   const SCEV *Val = AddRec->evaluateAtIteration(InVal, SE);
7221   assert(isa<SCEVConstant>(Val) &&
7222          "Evaluation of SCEV at constant didn't fold correctly?");
7223   return cast<SCEVConstant>(Val)->getValue();
7224 }
7225
7226 /// Given an exit condition of 'icmp op load X, cst', try to see if we can
7227 /// compute the backedge execution count.
7228 ScalarEvolution::ExitLimit
7229 ScalarEvolution::computeLoadConstantCompareExitLimit(
7230   LoadInst *LI,
7231   Constant *RHS,
7232   const Loop *L,
7233   ICmpInst::Predicate predicate) {
7234   if (LI->isVolatile()) return getCouldNotCompute();
7235
7236   // Check to see if the loaded pointer is a getelementptr of a global.
7237   // TODO: Use SCEV instead of manually grubbing with GEPs.
7238   GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0));
7239   if (!GEP) return getCouldNotCompute();
7240
7241   // Make sure that it is really a constant global we are gepping, with an
7242   // initializer, and make sure the first IDX is really 0.
7243   GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0));
7244   if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() ||
7245       GEP->getNumOperands() < 3 || !isa<Constant>(GEP->getOperand(1)) ||
7246       !cast<Constant>(GEP->getOperand(1))->isNullValue())
7247     return getCouldNotCompute();
7248
7249   // Okay, we allow one non-constant index into the GEP instruction.
7250   Value *VarIdx = nullptr;
7251   std::vector<Constant*> Indexes;
7252   unsigned VarIdxNum = 0;
7253   for (unsigned i = 2, e = GEP->getNumOperands(); i != e; ++i)
7254     if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
7255       Indexes.push_back(CI);
7256     } else if (!isa<ConstantInt>(GEP->getOperand(i))) {
7257       if (VarIdx) return getCouldNotCompute();  // Multiple non-constant idx's.
7258       VarIdx = GEP->getOperand(i);
7259       VarIdxNum = i-2;
7260       Indexes.push_back(nullptr);
7261     }
7262
7263   // Loop-invariant loads may be a byproduct of loop optimization. Skip them.
7264   if (!VarIdx)
7265     return getCouldNotCompute();
7266
7267   // Okay, we know we have a (load (gep GV, 0, X)) comparison with a constant.
7268   // Check to see if X is a loop variant variable value now.
7269   const SCEV *Idx = getSCEV(VarIdx);
7270   Idx = getSCEVAtScope(Idx, L);
7271
7272   // We can only recognize very limited forms of loop index expressions, in
7273   // particular, only affine AddRec's like {C1,+,C2}.
7274   const SCEVAddRecExpr *IdxExpr = dyn_cast<SCEVAddRecExpr>(Idx);
7275   if (!IdxExpr || !IdxExpr->isAffine() || isLoopInvariant(IdxExpr, L) ||
7276       !isa<SCEVConstant>(IdxExpr->getOperand(0)) ||
7277       !isa<SCEVConstant>(IdxExpr->getOperand(1)))
7278     return getCouldNotCompute();
7279
7280   unsigned MaxSteps = MaxBruteForceIterations;
7281   for (unsigned IterationNum = 0; IterationNum != MaxSteps; ++IterationNum) {
7282     ConstantInt *ItCst = ConstantInt::get(
7283                            cast<IntegerType>(IdxExpr->getType()), IterationNum);
7284     ConstantInt *Val = EvaluateConstantChrecAtConstant(IdxExpr, ItCst, *this);
7285
7286     // Form the GEP offset.
7287     Indexes[VarIdxNum] = Val;
7288
7289     Constant *Result = ConstantFoldLoadThroughGEPIndices(GV->getInitializer(),
7290                                                          Indexes);
7291     if (!Result) break;  // Cannot compute!
7292
7293     // Evaluate the condition for this iteration.
7294     Result = ConstantExpr::getICmp(predicate, Result, RHS);
7295     if (!isa<ConstantInt>(Result)) break;  // Couldn't decide for sure
7296     if (cast<ConstantInt>(Result)->getValue().isMinValue()) {
7297       ++NumArrayLenItCounts;
7298       return getConstant(ItCst);   // Found terminating iteration!
7299     }
7300   }
7301   return getCouldNotCompute();
7302 }
7303
7304 ScalarEvolution::ExitLimit ScalarEvolution::computeShiftCompareExitLimit(
7305     Value *LHS, Value *RHSV, const Loop *L, ICmpInst::Predicate Pred) {
7306   ConstantInt *RHS = dyn_cast<ConstantInt>(RHSV);
7307   if (!RHS)
7308     return getCouldNotCompute();
7309
7310   const BasicBlock *Latch = L->getLoopLatch();
7311   if (!Latch)
7312     return getCouldNotCompute();
7313
7314   const BasicBlock *Predecessor = L->getLoopPredecessor();
7315   if (!Predecessor)
7316     return getCouldNotCompute();
7317
7318   // Return true if V is of the form "LHS `shift_op` <positive constant>".
7319   // Return LHS in OutLHS and shift_opt in OutOpCode.
7320   auto MatchPositiveShift =
7321       [](Value *V, Value *&OutLHS, Instruction::BinaryOps &OutOpCode) {
7322
7323     using namespace PatternMatch;
7324
7325     ConstantInt *ShiftAmt;
7326     if (match(V, m_LShr(m_Value(OutLHS), m_ConstantInt(ShiftAmt))))
7327       OutOpCode = Instruction::LShr;
7328     else if (match(V, m_AShr(m_Value(OutLHS), m_ConstantInt(ShiftAmt))))
7329       OutOpCode = Instruction::AShr;
7330     else if (match(V, m_Shl(m_Value(OutLHS), m_ConstantInt(ShiftAmt))))
7331       OutOpCode = Instruction::Shl;
7332     else
7333       return false;
7334
7335     return ShiftAmt->getValue().isStrictlyPositive();
7336   };
7337
7338   // Recognize a "shift recurrence" either of the form %iv or of %iv.shifted in
7339   //
7340   // loop:
7341   //   %iv = phi i32 [ %iv.shifted, %loop ], [ %val, %preheader ]
7342   //   %iv.shifted = lshr i32 %iv, <positive constant>
7343   //
7344   // Return true on a successful match.  Return the corresponding PHI node (%iv
7345   // above) in PNOut and the opcode of the shift operation in OpCodeOut.
7346   auto MatchShiftRecurrence =
7347       [&](Value *V, PHINode *&PNOut, Instruction::BinaryOps &OpCodeOut) {
7348     Optional<Instruction::BinaryOps> PostShiftOpCode;
7349
7350     {
7351       Instruction::BinaryOps OpC;
7352       Value *V;
7353
7354       // If we encounter a shift instruction, "peel off" the shift operation,
7355       // and remember that we did so.  Later when we inspect %iv's backedge
7356       // value, we will make sure that the backedge value uses the same
7357       // operation.
7358       //
7359       // Note: the peeled shift operation does not have to be the same
7360       // instruction as the one feeding into the PHI's backedge value.  We only
7361       // really care about it being the same *kind* of shift instruction --
7362       // that's all that is required for our later inferences to hold.
7363       if (MatchPositiveShift(LHS, V, OpC)) {
7364         PostShiftOpCode = OpC;
7365         LHS = V;
7366       }
7367     }
7368
7369     PNOut = dyn_cast<PHINode>(LHS);
7370     if (!PNOut || PNOut->getParent() != L->getHeader())
7371       return false;
7372
7373     Value *BEValue = PNOut->getIncomingValueForBlock(Latch);
7374     Value *OpLHS;
7375
7376     return
7377         // The backedge value for the PHI node must be a shift by a positive
7378         // amount
7379         MatchPositiveShift(BEValue, OpLHS, OpCodeOut) &&
7380
7381         // of the PHI node itself
7382         OpLHS == PNOut &&
7383
7384         // and the kind of shift should be match the kind of shift we peeled
7385         // off, if any.
7386         (!PostShiftOpCode.hasValue() || *PostShiftOpCode == OpCodeOut);
7387   };
7388
7389   PHINode *PN;
7390   Instruction::BinaryOps OpCode;
7391   if (!MatchShiftRecurrence(LHS, PN, OpCode))
7392     return getCouldNotCompute();
7393
7394   const DataLayout &DL = getDataLayout();
7395
7396   // The key rationale for this optimization is that for some kinds of shift
7397   // recurrences, the value of the recurrence "stabilizes" to either 0 or -1
7398   // within a finite number of iterations.  If the condition guarding the
7399   // backedge (in the sense that the backedge is taken if the condition is true)
7400   // is false for the value the shift recurrence stabilizes to, then we know
7401   // that the backedge is taken only a finite number of times.
7402
7403   ConstantInt *StableValue = nullptr;
7404   switch (OpCode) {
7405   default:
7406     llvm_unreachable("Impossible case!");
7407
7408   case Instruction::AShr: {
7409     // {K,ashr,<positive-constant>} stabilizes to signum(K) in at most
7410     // bitwidth(K) iterations.
7411     Value *FirstValue = PN->getIncomingValueForBlock(Predecessor);
7412     KnownBits Known = computeKnownBits(FirstValue, DL, 0, nullptr,
7413                                        Predecessor->getTerminator(), &DT);
7414     auto *Ty = cast<IntegerType>(RHS->getType());
7415     if (Known.isNonNegative())
7416       StableValue = ConstantInt::get(Ty, 0);
7417     else if (Known.isNegative())
7418       StableValue = ConstantInt::get(Ty, -1, true);
7419     else
7420       return getCouldNotCompute();
7421
7422     break;
7423   }
7424   case Instruction::LShr:
7425   case Instruction::Shl:
7426     // Both {K,lshr,<positive-constant>} and {K,shl,<positive-constant>}
7427     // stabilize to 0 in at most bitwidth(K) iterations.
7428     StableValue = ConstantInt::get(cast<IntegerType>(RHS->getType()), 0);
7429     break;
7430   }
7431
7432   auto *Result =
7433       ConstantFoldCompareInstOperands(Pred, StableValue, RHS, DL, &TLI);
7434   assert(Result->getType()->isIntegerTy(1) &&
7435          "Otherwise cannot be an operand to a branch instruction");
7436
7437   if (Result->isZeroValue()) {
7438     unsigned BitWidth = getTypeSizeInBits(RHS->getType());
7439     const SCEV *UpperBound =
7440         getConstant(getEffectiveSCEVType(RHS->getType()), BitWidth);
7441     return ExitLimit(getCouldNotCompute(), UpperBound, false);
7442   }
7443
7444   return getCouldNotCompute();
7445 }
7446
7447 /// Return true if we can constant fold an instruction of the specified type,
7448 /// assuming that all operands were constants.
7449 static bool CanConstantFold(const Instruction *I) {
7450   if (isa<BinaryOperator>(I) || isa<CmpInst>(I) ||
7451       isa<SelectInst>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I) ||
7452       isa<LoadInst>(I))
7453     return true;
7454
7455   if (const CallInst *CI = dyn_cast<CallInst>(I))
7456     if (const Function *F = CI->getCalledFunction())
7457       return canConstantFoldCallTo(CI, F);
7458   return false;
7459 }
7460
7461 /// Determine whether this instruction can constant evolve within this loop
7462 /// assuming its operands can all constant evolve.
7463 static bool canConstantEvolve(Instruction *I, const Loop *L) {
7464   // An instruction outside of the loop can't be derived from a loop PHI.
7465   if (!L->contains(I)) return false;
7466
7467   if (isa<PHINode>(I)) {
7468     // We don't currently keep track of the control flow needed to evaluate
7469     // PHIs, so we cannot handle PHIs inside of loops.
7470     return L->getHeader() == I->getParent();
7471   }
7472
7473   // If we won't be able to constant fold this expression even if the operands
7474   // are constants, bail early.
7475   return CanConstantFold(I);
7476 }
7477
7478 /// getConstantEvolvingPHIOperands - Implement getConstantEvolvingPHI by
7479 /// recursing through each instruction operand until reaching a loop header phi.
7480 static PHINode *
7481 getConstantEvolvingPHIOperands(Instruction *UseInst, const Loop *L,
7482                                DenseMap<Instruction *, PHINode *> &PHIMap,
7483                                unsigned Depth) {
7484   if (Depth > MaxConstantEvolvingDepth)
7485     return nullptr;
7486
7487   // Otherwise, we can evaluate this instruction if all of its operands are
7488   // constant or derived from a PHI node themselves.
7489   PHINode *PHI = nullptr;
7490   for (Value *Op : UseInst->operands()) {
7491     if (isa<Constant>(Op)) continue;
7492
7493     Instruction *OpInst = dyn_cast<Instruction>(Op);
7494     if (!OpInst || !canConstantEvolve(OpInst, L)) return nullptr;
7495
7496     PHINode *P = dyn_cast<PHINode>(OpInst);
7497     if (!P)
7498       // If this operand is already visited, reuse the prior result.
7499       // We may have P != PHI if this is the deepest point at which the
7500       // inconsistent paths meet.
7501       P = PHIMap.lookup(OpInst);
7502     if (!P) {
7503       // Recurse and memoize the results, whether a phi is found or not.
7504       // This recursive call invalidates pointers into PHIMap.
7505       P = getConstantEvolvingPHIOperands(OpInst, L, PHIMap, Depth + 1);
7506       PHIMap[OpInst] = P;
7507     }
7508     if (!P)
7509       return nullptr;  // Not evolving from PHI
7510     if (PHI && PHI != P)
7511       return nullptr;  // Evolving from multiple different PHIs.
7512     PHI = P;
7513   }
7514   // This is a expression evolving from a constant PHI!
7515   return PHI;
7516 }
7517
7518 /// getConstantEvolvingPHI - Given an LLVM value and a loop, return a PHI node
7519 /// in the loop that V is derived from.  We allow arbitrary operations along the
7520 /// way, but the operands of an operation must either be constants or a value
7521 /// derived from a constant PHI.  If this expression does not fit with these
7522 /// constraints, return null.
7523 static PHINode *getConstantEvolvingPHI(Value *V, const Loop *L) {
7524   Instruction *I = dyn_cast<Instruction>(V);
7525   if (!I || !canConstantEvolve(I, L)) return nullptr;
7526
7527   if (PHINode *PN = dyn_cast<PHINode>(I))
7528     return PN;
7529
7530   // Record non-constant instructions contained by the loop.
7531   DenseMap<Instruction *, PHINode *> PHIMap;
7532   return getConstantEvolvingPHIOperands(I, L, PHIMap, 0);
7533 }
7534
7535 /// EvaluateExpression - Given an expression that passes the
7536 /// getConstantEvolvingPHI predicate, evaluate its value assuming the PHI node
7537 /// in the loop has the value PHIVal.  If we can't fold this expression for some
7538 /// reason, return null.
7539 static Constant *EvaluateExpression(Value *V, const Loop *L,
7540                                     DenseMap<Instruction *, Constant *> &Vals,
7541                                     const DataLayout &DL,
7542                                     const TargetLibraryInfo *TLI) {
7543   // Convenient constant check, but redundant for recursive calls.
7544   if (Constant *C = dyn_cast<Constant>(V)) return C;
7545   Instruction *I = dyn_cast<Instruction>(V);
7546   if (!I) return nullptr;
7547
7548   if (Constant *C = Vals.lookup(I)) return C;
7549
7550   // An instruction inside the loop depends on a value outside the loop that we
7551   // weren't given a mapping for, or a value such as a call inside the loop.
7552   if (!canConstantEvolve(I, L)) return nullptr;
7553
7554   // An unmapped PHI can be due to a branch or another loop inside this loop,
7555   // or due to this not being the initial iteration through a loop where we
7556   // couldn't compute the evolution of this particular PHI last time.
7557   if (isa<PHINode>(I)) return nullptr;
7558
7559   std::vector<Constant*> Operands(I->getNumOperands());
7560
7561   for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
7562     Instruction *Operand = dyn_cast<Instruction>(I->getOperand(i));
7563     if (!Operand) {
7564       Operands[i] = dyn_cast<Constant>(I->getOperand(i));
7565       if (!Operands[i]) return nullptr;
7566       continue;
7567     }
7568     Constant *C = EvaluateExpression(Operand, L, Vals, DL, TLI);
7569     Vals[Operand] = C;
7570     if (!C) return nullptr;
7571     Operands[i] = C;
7572   }
7573
7574   if (CmpInst *CI = dyn_cast<CmpInst>(I))
7575     return ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0],
7576                                            Operands[1], DL, TLI);
7577   if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
7578     if (!LI->isVolatile())
7579       return ConstantFoldLoadFromConstPtr(Operands[0], LI->getType(), DL);
7580   }
7581   return ConstantFoldInstOperands(I, Operands, DL, TLI);
7582 }
7583
7584
7585 // If every incoming value to PN except the one for BB is a specific Constant,
7586 // return that, else return nullptr.
7587 static Constant *getOtherIncomingValue(PHINode *PN, BasicBlock *BB) {
7588   Constant *IncomingVal = nullptr;
7589
7590   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
7591     if (PN->getIncomingBlock(i) == BB)
7592       continue;
7593
7594     auto *CurrentVal = dyn_cast<Constant>(PN->getIncomingValue(i));
7595     if (!CurrentVal)
7596       return nullptr;
7597
7598     if (IncomingVal != CurrentVal) {
7599       if (IncomingVal)
7600         return nullptr;
7601       IncomingVal = CurrentVal;
7602     }
7603   }
7604
7605   return IncomingVal;
7606 }
7607
7608 /// getConstantEvolutionLoopExitValue - If we know that the specified Phi is
7609 /// in the header of its containing loop, we know the loop executes a
7610 /// constant number of times, and the PHI node is just a recurrence
7611 /// involving constants, fold it.
7612 Constant *
7613 ScalarEvolution::getConstantEvolutionLoopExitValue(PHINode *PN,
7614                                                    const APInt &BEs,
7615                                                    const Loop *L) {
7616   auto I = ConstantEvolutionLoopExitValue.find(PN);
7617   if (I != ConstantEvolutionLoopExitValue.end())
7618     return I->second;
7619
7620   if (BEs.ugt(MaxBruteForceIterations))
7621     return ConstantEvolutionLoopExitValue[PN] = nullptr;  // Not going to evaluate it.
7622
7623   Constant *&RetVal = ConstantEvolutionLoopExitValue[PN];
7624
7625   DenseMap<Instruction *, Constant *> CurrentIterVals;
7626   BasicBlock *Header = L->getHeader();
7627   assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!");
7628
7629   BasicBlock *Latch = L->getLoopLatch();
7630   if (!Latch)
7631     return nullptr;
7632
7633   for (auto &I : *Header) {
7634     PHINode *PHI = dyn_cast<PHINode>(&I);
7635     if (!PHI) break;
7636     auto *StartCST = getOtherIncomingValue(PHI, Latch);
7637     if (!StartCST) continue;
7638     CurrentIterVals[PHI] = StartCST;
7639   }
7640   if (!CurrentIterVals.count(PN))
7641     return RetVal = nullptr;
7642
7643   Value *BEValue = PN->getIncomingValueForBlock(Latch);
7644
7645   // Execute the loop symbolically to determine the exit value.
7646   assert(BEs.getActiveBits() < CHAR_BIT * sizeof(unsigned) &&
7647          "BEs is <= MaxBruteForceIterations which is an 'unsigned'!");
7648
7649   unsigned NumIterations = BEs.getZExtValue(); // must be in range
7650   unsigned IterationNum = 0;
7651   const DataLayout &DL = getDataLayout();
7652   for (; ; ++IterationNum) {
7653     if (IterationNum == NumIterations)
7654       return RetVal = CurrentIterVals[PN];  // Got exit value!
7655
7656     // Compute the value of the PHIs for the next iteration.
7657     // EvaluateExpression adds non-phi values to the CurrentIterVals map.
7658     DenseMap<Instruction *, Constant *> NextIterVals;
7659     Constant *NextPHI =
7660         EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI);
7661     if (!NextPHI)
7662       return nullptr;        // Couldn't evaluate!
7663     NextIterVals[PN] = NextPHI;
7664
7665     bool StoppedEvolving = NextPHI == CurrentIterVals[PN];
7666
7667     // Also evaluate the other PHI nodes.  However, we don't get to stop if we
7668     // cease to be able to evaluate one of them or if they stop evolving,
7669     // because that doesn't necessarily prevent us from computing PN.
7670     SmallVector<std::pair<PHINode *, Constant *>, 8> PHIsToCompute;
7671     for (const auto &I : CurrentIterVals) {
7672       PHINode *PHI = dyn_cast<PHINode>(I.first);
7673       if (!PHI || PHI == PN || PHI->getParent() != Header) continue;
7674       PHIsToCompute.emplace_back(PHI, I.second);
7675     }
7676     // We use two distinct loops because EvaluateExpression may invalidate any
7677     // iterators into CurrentIterVals.
7678     for (const auto &I : PHIsToCompute) {
7679       PHINode *PHI = I.first;
7680       Constant *&NextPHI = NextIterVals[PHI];
7681       if (!NextPHI) {   // Not already computed.
7682         Value *BEValue = PHI->getIncomingValueForBlock(Latch);
7683         NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI);
7684       }
7685       if (NextPHI != I.second)
7686         StoppedEvolving = false;
7687     }
7688
7689     // If all entries in CurrentIterVals == NextIterVals then we can stop
7690     // iterating, the loop can't continue to change.
7691     if (StoppedEvolving)
7692       return RetVal = CurrentIterVals[PN];
7693
7694     CurrentIterVals.swap(NextIterVals);
7695   }
7696 }
7697
7698 const SCEV *ScalarEvolution::computeExitCountExhaustively(const Loop *L,
7699                                                           Value *Cond,
7700                                                           bool ExitWhen) {
7701   PHINode *PN = getConstantEvolvingPHI(Cond, L);
7702   if (!PN) return getCouldNotCompute();
7703
7704   // If the loop is canonicalized, the PHI will have exactly two entries.
7705   // That's the only form we support here.
7706   if (PN->getNumIncomingValues() != 2) return getCouldNotCompute();
7707
7708   DenseMap<Instruction *, Constant *> CurrentIterVals;
7709   BasicBlock *Header = L->getHeader();
7710   assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!");
7711
7712   BasicBlock *Latch = L->getLoopLatch();
7713   assert(Latch && "Should follow from NumIncomingValues == 2!");
7714
7715   for (auto &I : *Header) {
7716     PHINode *PHI = dyn_cast<PHINode>(&I);
7717     if (!PHI)
7718       break;
7719     auto *StartCST = getOtherIncomingValue(PHI, Latch);
7720     if (!StartCST) continue;
7721     CurrentIterVals[PHI] = StartCST;
7722   }
7723   if (!CurrentIterVals.count(PN))
7724     return getCouldNotCompute();
7725
7726   // Okay, we find a PHI node that defines the trip count of this loop.  Execute
7727   // the loop symbolically to determine when the condition gets a value of
7728   // "ExitWhen".
7729   unsigned MaxIterations = MaxBruteForceIterations;   // Limit analysis.
7730   const DataLayout &DL = getDataLayout();
7731   for (unsigned IterationNum = 0; IterationNum != MaxIterations;++IterationNum){
7732     auto *CondVal = dyn_cast_or_null<ConstantInt>(
7733         EvaluateExpression(Cond, L, CurrentIterVals, DL, &TLI));
7734
7735     // Couldn't symbolically evaluate.
7736     if (!CondVal) return getCouldNotCompute();
7737
7738     if (CondVal->getValue() == uint64_t(ExitWhen)) {
7739       ++NumBruteForceTripCountsComputed;
7740       return getConstant(Type::getInt32Ty(getContext()), IterationNum);
7741     }
7742
7743     // Update all the PHI nodes for the next iteration.
7744     DenseMap<Instruction *, Constant *> NextIterVals;
7745
7746     // Create a list of which PHIs we need to compute. We want to do this before
7747     // calling EvaluateExpression on them because that may invalidate iterators
7748     // into CurrentIterVals.
7749     SmallVector<PHINode *, 8> PHIsToCompute;
7750     for (const auto &I : CurrentIterVals) {
7751       PHINode *PHI = dyn_cast<PHINode>(I.first);
7752       if (!PHI || PHI->getParent() != Header) continue;
7753       PHIsToCompute.push_back(PHI);
7754     }
7755     for (PHINode *PHI : PHIsToCompute) {
7756       Constant *&NextPHI = NextIterVals[PHI];
7757       if (NextPHI) continue;    // Already computed!
7758
7759       Value *BEValue = PHI->getIncomingValueForBlock(Latch);
7760       NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI);
7761     }
7762     CurrentIterVals.swap(NextIterVals);
7763   }
7764
7765   // Too many iterations were needed to evaluate.
7766   return getCouldNotCompute();
7767 }
7768
7769 const SCEV *ScalarEvolution::getSCEVAtScope(const SCEV *V, const Loop *L) {
7770   SmallVector<std::pair<const Loop *, const SCEV *>, 2> &Values =
7771       ValuesAtScopes[V];
7772   // Check to see if we've folded this expression at this loop before.
7773   for (auto &LS : Values)
7774     if (LS.first == L)
7775       return LS.second ? LS.second : V;
7776
7777   Values.emplace_back(L, nullptr);
7778
7779   // Otherwise compute it.
7780   const SCEV *C = computeSCEVAtScope(V, L);
7781   for (auto &LS : reverse(ValuesAtScopes[V]))
7782     if (LS.first == L) {
7783       LS.second = C;
7784       break;
7785     }
7786   return C;
7787 }
7788
7789 /// This builds up a Constant using the ConstantExpr interface.  That way, we
7790 /// will return Constants for objects which aren't represented by a
7791 /// SCEVConstant, because SCEVConstant is restricted to ConstantInt.
7792 /// Returns NULL if the SCEV isn't representable as a Constant.
7793 static Constant *BuildConstantFromSCEV(const SCEV *V) {
7794   switch (static_cast<SCEVTypes>(V->getSCEVType())) {
7795     case scCouldNotCompute:
7796     case scAddRecExpr:
7797       break;
7798     case scConstant:
7799       return cast<SCEVConstant>(V)->getValue();
7800     case scUnknown:
7801       return dyn_cast<Constant>(cast<SCEVUnknown>(V)->getValue());
7802     case scSignExtend: {
7803       const SCEVSignExtendExpr *SS = cast<SCEVSignExtendExpr>(V);
7804       if (Constant *CastOp = BuildConstantFromSCEV(SS->getOperand()))
7805         return ConstantExpr::getSExt(CastOp, SS->getType());
7806       break;
7807     }
7808     case scZeroExtend: {
7809       const SCEVZeroExtendExpr *SZ = cast<SCEVZeroExtendExpr>(V);
7810       if (Constant *CastOp = BuildConstantFromSCEV(SZ->getOperand()))
7811         return ConstantExpr::getZExt(CastOp, SZ->getType());
7812       break;
7813     }
7814     case scTruncate: {
7815       const SCEVTruncateExpr *ST = cast<SCEVTruncateExpr>(V);
7816       if (Constant *CastOp = BuildConstantFromSCEV(ST->getOperand()))
7817         return ConstantExpr::getTrunc(CastOp, ST->getType());
7818       break;
7819     }
7820     case scAddExpr: {
7821       const SCEVAddExpr *SA = cast<SCEVAddExpr>(V);
7822       if (Constant *C = BuildConstantFromSCEV(SA->getOperand(0))) {
7823         if (PointerType *PTy = dyn_cast<PointerType>(C->getType())) {
7824           unsigned AS = PTy->getAddressSpace();
7825           Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS);
7826           C = ConstantExpr::getBitCast(C, DestPtrTy);
7827         }
7828         for (unsigned i = 1, e = SA->getNumOperands(); i != e; ++i) {
7829           Constant *C2 = BuildConstantFromSCEV(SA->getOperand(i));
7830           if (!C2) return nullptr;
7831
7832           // First pointer!
7833           if (!C->getType()->isPointerTy() && C2->getType()->isPointerTy()) {
7834             unsigned AS = C2->getType()->getPointerAddressSpace();
7835             std::swap(C, C2);
7836             Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS);
7837             // The offsets have been converted to bytes.  We can add bytes to an
7838             // i8* by GEP with the byte count in the first index.
7839             C = ConstantExpr::getBitCast(C, DestPtrTy);
7840           }
7841
7842           // Don't bother trying to sum two pointers. We probably can't
7843           // statically compute a load that results from it anyway.
7844           if (C2->getType()->isPointerTy())
7845             return nullptr;
7846
7847           if (PointerType *PTy = dyn_cast<PointerType>(C->getType())) {
7848             if (PTy->getElementType()->isStructTy())
7849               C2 = ConstantExpr::getIntegerCast(
7850                   C2, Type::getInt32Ty(C->getContext()), true);
7851             C = ConstantExpr::getGetElementPtr(PTy->getElementType(), C, C2);
7852           } else
7853             C = ConstantExpr::getAdd(C, C2);
7854         }
7855         return C;
7856       }
7857       break;
7858     }
7859     case scMulExpr: {
7860       const SCEVMulExpr *SM = cast<SCEVMulExpr>(V);
7861       if (Constant *C = BuildConstantFromSCEV(SM->getOperand(0))) {
7862         // Don't bother with pointers at all.
7863         if (C->getType()->isPointerTy()) return nullptr;
7864         for (unsigned i = 1, e = SM->getNumOperands(); i != e; ++i) {
7865           Constant *C2 = BuildConstantFromSCEV(SM->getOperand(i));
7866           if (!C2 || C2->getType()->isPointerTy()) return nullptr;
7867           C = ConstantExpr::getMul(C, C2);
7868         }
7869         return C;
7870       }
7871       break;
7872     }
7873     case scUDivExpr: {
7874       const SCEVUDivExpr *SU = cast<SCEVUDivExpr>(V);
7875       if (Constant *LHS = BuildConstantFromSCEV(SU->getLHS()))
7876         if (Constant *RHS = BuildConstantFromSCEV(SU->getRHS()))
7877           if (LHS->getType() == RHS->getType())
7878             return ConstantExpr::getUDiv(LHS, RHS);
7879       break;
7880     }
7881     case scSMaxExpr:
7882     case scUMaxExpr:
7883       break; // TODO: smax, umax.
7884   }
7885   return nullptr;
7886 }
7887
7888 const SCEV *ScalarEvolution::computeSCEVAtScope(const SCEV *V, const Loop *L) {
7889   if (isa<SCEVConstant>(V)) return V;
7890
7891   // If this instruction is evolved from a constant-evolving PHI, compute the
7892   // exit value from the loop without using SCEVs.
7893   if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V)) {
7894     if (Instruction *I = dyn_cast<Instruction>(SU->getValue())) {
7895       const Loop *LI = this->LI[I->getParent()];
7896       if (LI && LI->getParentLoop() == L)  // Looking for loop exit value.
7897         if (PHINode *PN = dyn_cast<PHINode>(I))
7898           if (PN->getParent() == LI->getHeader()) {
7899             // Okay, there is no closed form solution for the PHI node.  Check
7900             // to see if the loop that contains it has a known backedge-taken
7901             // count.  If so, we may be able to force computation of the exit
7902             // value.
7903             const SCEV *BackedgeTakenCount = getBackedgeTakenCount(LI);
7904             if (const SCEVConstant *BTCC =
7905                   dyn_cast<SCEVConstant>(BackedgeTakenCount)) {
7906
7907               // This trivial case can show up in some degenerate cases where
7908               // the incoming IR has not yet been fully simplified.
7909               if (BTCC->getValue()->isZero()) {
7910                 Value *InitValue = nullptr;
7911                 bool MultipleInitValues = false;
7912                 for (unsigned i = 0; i < PN->getNumIncomingValues(); i++) {
7913                   if (!LI->contains(PN->getIncomingBlock(i))) {
7914                     if (!InitValue)
7915                       InitValue = PN->getIncomingValue(i);
7916                     else if (InitValue != PN->getIncomingValue(i)) {
7917                       MultipleInitValues = true;
7918                       break;
7919                     }
7920                   }
7921                   if (!MultipleInitValues && InitValue)
7922                     return getSCEV(InitValue);
7923                 }
7924               }
7925               // Okay, we know how many times the containing loop executes.  If
7926               // this is a constant evolving PHI node, get the final value at
7927               // the specified iteration number.
7928               Constant *RV =
7929                   getConstantEvolutionLoopExitValue(PN, BTCC->getAPInt(), LI);
7930               if (RV) return getSCEV(RV);
7931             }
7932           }
7933
7934       // Okay, this is an expression that we cannot symbolically evaluate
7935       // into a SCEV.  Check to see if it's possible to symbolically evaluate
7936       // the arguments into constants, and if so, try to constant propagate the
7937       // result.  This is particularly useful for computing loop exit values.
7938       if (CanConstantFold(I)) {
7939         SmallVector<Constant *, 4> Operands;
7940         bool MadeImprovement = false;
7941         for (Value *Op : I->operands()) {
7942           if (Constant *C = dyn_cast<Constant>(Op)) {
7943             Operands.push_back(C);
7944             continue;
7945           }
7946
7947           // If any of the operands is non-constant and if they are
7948           // non-integer and non-pointer, don't even try to analyze them
7949           // with scev techniques.
7950           if (!isSCEVable(Op->getType()))
7951             return V;
7952
7953           const SCEV *OrigV = getSCEV(Op);
7954           const SCEV *OpV = getSCEVAtScope(OrigV, L);
7955           MadeImprovement |= OrigV != OpV;
7956
7957           Constant *C = BuildConstantFromSCEV(OpV);
7958           if (!C) return V;
7959           if (C->getType() != Op->getType())
7960             C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
7961                                                               Op->getType(),
7962                                                               false),
7963                                       C, Op->getType());
7964           Operands.push_back(C);
7965         }
7966
7967         // Check to see if getSCEVAtScope actually made an improvement.
7968         if (MadeImprovement) {
7969           Constant *C = nullptr;
7970           const DataLayout &DL = getDataLayout();
7971           if (const CmpInst *CI = dyn_cast<CmpInst>(I))
7972             C = ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0],
7973                                                 Operands[1], DL, &TLI);
7974           else if (const LoadInst *LI = dyn_cast<LoadInst>(I)) {
7975             if (!LI->isVolatile())
7976               C = ConstantFoldLoadFromConstPtr(Operands[0], LI->getType(), DL);
7977           } else
7978             C = ConstantFoldInstOperands(I, Operands, DL, &TLI);
7979           if (!C) return V;
7980           return getSCEV(C);
7981         }
7982       }
7983     }
7984
7985     // This is some other type of SCEVUnknown, just return it.
7986     return V;
7987   }
7988
7989   if (const SCEVCommutativeExpr *Comm = dyn_cast<SCEVCommutativeExpr>(V)) {
7990     // Avoid performing the look-up in the common case where the specified
7991     // expression has no loop-variant portions.
7992     for (unsigned i = 0, e = Comm->getNumOperands(); i != e; ++i) {
7993       const SCEV *OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
7994       if (OpAtScope != Comm->getOperand(i)) {
7995         // Okay, at least one of these operands is loop variant but might be
7996         // foldable.  Build a new instance of the folded commutative expression.
7997         SmallVector<const SCEV *, 8> NewOps(Comm->op_begin(),
7998                                             Comm->op_begin()+i);
7999         NewOps.push_back(OpAtScope);
8000
8001         for (++i; i != e; ++i) {
8002           OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
8003           NewOps.push_back(OpAtScope);
8004         }
8005         if (isa<SCEVAddExpr>(Comm))
8006           return getAddExpr(NewOps);
8007         if (isa<SCEVMulExpr>(Comm))
8008           return getMulExpr(NewOps);
8009         if (isa<SCEVSMaxExpr>(Comm))
8010           return getSMaxExpr(NewOps);
8011         if (isa<SCEVUMaxExpr>(Comm))
8012           return getUMaxExpr(NewOps);
8013         llvm_unreachable("Unknown commutative SCEV type!");
8014       }
8015     }
8016     // If we got here, all operands are loop invariant.
8017     return Comm;
8018   }
8019
8020   if (const SCEVUDivExpr *Div = dyn_cast<SCEVUDivExpr>(V)) {
8021     const SCEV *LHS = getSCEVAtScope(Div->getLHS(), L);
8022     const SCEV *RHS = getSCEVAtScope(Div->getRHS(), L);
8023     if (LHS == Div->getLHS() && RHS == Div->getRHS())
8024       return Div;   // must be loop invariant
8025     return getUDivExpr(LHS, RHS);
8026   }
8027
8028   // If this is a loop recurrence for a loop that does not contain L, then we
8029   // are dealing with the final value computed by the loop.
8030   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V)) {
8031     // First, attempt to evaluate each operand.
8032     // Avoid performing the look-up in the common case where the specified
8033     // expression has no loop-variant portions.
8034     for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
8035       const SCEV *OpAtScope = getSCEVAtScope(AddRec->getOperand(i), L);
8036       if (OpAtScope == AddRec->getOperand(i))
8037         continue;
8038
8039       // Okay, at least one of these operands is loop variant but might be
8040       // foldable.  Build a new instance of the folded commutative expression.
8041       SmallVector<const SCEV *, 8> NewOps(AddRec->op_begin(),
8042                                           AddRec->op_begin()+i);
8043       NewOps.push_back(OpAtScope);
8044       for (++i; i != e; ++i)
8045         NewOps.push_back(getSCEVAtScope(AddRec->getOperand(i), L));
8046
8047       const SCEV *FoldedRec =
8048         getAddRecExpr(NewOps, AddRec->getLoop(),
8049                       AddRec->getNoWrapFlags(SCEV::FlagNW));
8050       AddRec = dyn_cast<SCEVAddRecExpr>(FoldedRec);
8051       // The addrec may be folded to a nonrecurrence, for example, if the
8052       // induction variable is multiplied by zero after constant folding. Go
8053       // ahead and return the folded value.
8054       if (!AddRec)
8055         return FoldedRec;
8056       break;
8057     }
8058
8059     // If the scope is outside the addrec's loop, evaluate it by using the
8060     // loop exit value of the addrec.
8061     if (!AddRec->getLoop()->contains(L)) {
8062       // To evaluate this recurrence, we need to know how many times the AddRec
8063       // loop iterates.  Compute this now.
8064       const SCEV *BackedgeTakenCount = getBackedgeTakenCount(AddRec->getLoop());
8065       if (BackedgeTakenCount == getCouldNotCompute()) return AddRec;
8066
8067       // Then, evaluate the AddRec.
8068       return AddRec->evaluateAtIteration(BackedgeTakenCount, *this);
8069     }
8070
8071     return AddRec;
8072   }
8073
8074   if (const SCEVZeroExtendExpr *Cast = dyn_cast<SCEVZeroExtendExpr>(V)) {
8075     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
8076     if (Op == Cast->getOperand())
8077       return Cast;  // must be loop invariant
8078     return getZeroExtendExpr(Op, Cast->getType());
8079   }
8080
8081   if (const SCEVSignExtendExpr *Cast = dyn_cast<SCEVSignExtendExpr>(V)) {
8082     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
8083     if (Op == Cast->getOperand())
8084       return Cast;  // must be loop invariant
8085     return getSignExtendExpr(Op, Cast->getType());
8086   }
8087
8088   if (const SCEVTruncateExpr *Cast = dyn_cast<SCEVTruncateExpr>(V)) {
8089     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
8090     if (Op == Cast->getOperand())
8091       return Cast;  // must be loop invariant
8092     return getTruncateExpr(Op, Cast->getType());
8093   }
8094
8095   llvm_unreachable("Unknown SCEV type!");
8096 }
8097
8098 const SCEV *ScalarEvolution::getSCEVAtScope(Value *V, const Loop *L) {
8099   return getSCEVAtScope(getSCEV(V), L);
8100 }
8101
8102 /// Finds the minimum unsigned root of the following equation:
8103 ///
8104 ///     A * X = B (mod N)
8105 ///
8106 /// where N = 2^BW and BW is the common bit width of A and B. The signedness of
8107 /// A and B isn't important.
8108 ///
8109 /// If the equation does not have a solution, SCEVCouldNotCompute is returned.
8110 static const SCEV *SolveLinEquationWithOverflow(const APInt &A, const SCEV *B,
8111                                                ScalarEvolution &SE) {
8112   uint32_t BW = A.getBitWidth();
8113   assert(BW == SE.getTypeSizeInBits(B->getType()));
8114   assert(A != 0 && "A must be non-zero.");
8115
8116   // 1. D = gcd(A, N)
8117   //
8118   // The gcd of A and N may have only one prime factor: 2. The number of
8119   // trailing zeros in A is its multiplicity
8120   uint32_t Mult2 = A.countTrailingZeros();
8121   // D = 2^Mult2
8122
8123   // 2. Check if B is divisible by D.
8124   //
8125   // B is divisible by D if and only if the multiplicity of prime factor 2 for B
8126   // is not less than multiplicity of this prime factor for D.
8127   if (SE.GetMinTrailingZeros(B) < Mult2)
8128     return SE.getCouldNotCompute();
8129
8130   // 3. Compute I: the multiplicative inverse of (A / D) in arithmetic
8131   // modulo (N / D).
8132   //
8133   // If D == 1, (N / D) == N == 2^BW, so we need one extra bit to represent
8134   // (N / D) in general. The inverse itself always fits into BW bits, though,
8135   // so we immediately truncate it.
8136   APInt AD = A.lshr(Mult2).zext(BW + 1);  // AD = A / D
8137   APInt Mod(BW + 1, 0);
8138   Mod.setBit(BW - Mult2);  // Mod = N / D
8139   APInt I = AD.multiplicativeInverse(Mod).trunc(BW);
8140
8141   // 4. Compute the minimum unsigned root of the equation:
8142   // I * (B / D) mod (N / D)
8143   // To simplify the computation, we factor out the divide by D:
8144   // (I * B mod N) / D
8145   const SCEV *D = SE.getConstant(APInt::getOneBitSet(BW, Mult2));
8146   return SE.getUDivExactExpr(SE.getMulExpr(B, SE.getConstant(I)), D);
8147 }
8148
8149 /// Find the roots of the quadratic equation for the given quadratic chrec
8150 /// {L,+,M,+,N}.  This returns either the two roots (which might be the same) or
8151 /// two SCEVCouldNotCompute objects.
8152 static Optional<std::pair<const SCEVConstant *,const SCEVConstant *>>
8153 SolveQuadraticEquation(const SCEVAddRecExpr *AddRec, ScalarEvolution &SE) {
8154   assert(AddRec->getNumOperands() == 3 && "This is not a quadratic chrec!");
8155   const SCEVConstant *LC = dyn_cast<SCEVConstant>(AddRec->getOperand(0));
8156   const SCEVConstant *MC = dyn_cast<SCEVConstant>(AddRec->getOperand(1));
8157   const SCEVConstant *NC = dyn_cast<SCEVConstant>(AddRec->getOperand(2));
8158
8159   // We currently can only solve this if the coefficients are constants.
8160   if (!LC || !MC || !NC)
8161     return None;
8162
8163   uint32_t BitWidth = LC->getAPInt().getBitWidth();
8164   const APInt &L = LC->getAPInt();
8165   const APInt &M = MC->getAPInt();
8166   const APInt &N = NC->getAPInt();
8167   APInt Two(BitWidth, 2);
8168
8169   // Convert from chrec coefficients to polynomial coefficients AX^2+BX+C
8170
8171   // The A coefficient is N/2
8172   APInt A = N.sdiv(Two);
8173
8174   // The B coefficient is M-N/2
8175   APInt B = M;
8176   B -= A; // A is the same as N/2.
8177
8178   // The C coefficient is L.
8179   const APInt& C = L;
8180
8181   // Compute the B^2-4ac term.
8182   APInt SqrtTerm = B;
8183   SqrtTerm *= B;
8184   SqrtTerm -= 4 * (A * C);
8185
8186   if (SqrtTerm.isNegative()) {
8187     // The loop is provably infinite.
8188     return None;
8189   }
8190
8191   // Compute sqrt(B^2-4ac). This is guaranteed to be the nearest
8192   // integer value or else APInt::sqrt() will assert.
8193   APInt SqrtVal = SqrtTerm.sqrt();
8194
8195   // Compute the two solutions for the quadratic formula.
8196   // The divisions must be performed as signed divisions.
8197   APInt NegB = -std::move(B);
8198   APInt TwoA = std::move(A);
8199   TwoA <<= 1;
8200   if (TwoA.isNullValue())
8201     return None;
8202
8203   LLVMContext &Context = SE.getContext();
8204
8205   ConstantInt *Solution1 =
8206     ConstantInt::get(Context, (NegB + SqrtVal).sdiv(TwoA));
8207   ConstantInt *Solution2 =
8208     ConstantInt::get(Context, (NegB - SqrtVal).sdiv(TwoA));
8209
8210   return std::make_pair(cast<SCEVConstant>(SE.getConstant(Solution1)),
8211                         cast<SCEVConstant>(SE.getConstant(Solution2)));
8212 }
8213
8214 ScalarEvolution::ExitLimit
8215 ScalarEvolution::howFarToZero(const SCEV *V, const Loop *L, bool ControlsExit,
8216                               bool AllowPredicates) {
8217
8218   // This is only used for loops with a "x != y" exit test. The exit condition
8219   // is now expressed as a single expression, V = x-y. So the exit test is
8220   // effectively V != 0.  We know and take advantage of the fact that this
8221   // expression only being used in a comparison by zero context.
8222
8223   SmallPtrSet<const SCEVPredicate *, 4> Predicates;
8224   // If the value is a constant
8225   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
8226     // If the value is already zero, the branch will execute zero times.
8227     if (C->getValue()->isZero()) return C;
8228     return getCouldNotCompute();  // Otherwise it will loop infinitely.
8229   }
8230
8231   const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V);
8232   if (!AddRec && AllowPredicates)
8233     // Try to make this an AddRec using runtime tests, in the first X
8234     // iterations of this loop, where X is the SCEV expression found by the
8235     // algorithm below.
8236     AddRec = convertSCEVToAddRecWithPredicates(V, L, Predicates);
8237
8238   if (!AddRec || AddRec->getLoop() != L)
8239     return getCouldNotCompute();
8240
8241   // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of
8242   // the quadratic equation to solve it.
8243   if (AddRec->isQuadratic() && AddRec->getType()->isIntegerTy()) {
8244     if (auto Roots = SolveQuadraticEquation(AddRec, *this)) {
8245       const SCEVConstant *R1 = Roots->first;
8246       const SCEVConstant *R2 = Roots->second;
8247       // Pick the smallest positive root value.
8248       if (ConstantInt *CB = dyn_cast<ConstantInt>(ConstantExpr::getICmp(
8249               CmpInst::ICMP_ULT, R1->getValue(), R2->getValue()))) {
8250         if (!CB->getZExtValue())
8251           std::swap(R1, R2); // R1 is the minimum root now.
8252
8253         // We can only use this value if the chrec ends up with an exact zero
8254         // value at this index.  When solving for "X*X != 5", for example, we
8255         // should not accept a root of 2.
8256         const SCEV *Val = AddRec->evaluateAtIteration(R1, *this);
8257         if (Val->isZero())
8258           // We found a quadratic root!
8259           return ExitLimit(R1, R1, false, Predicates);
8260       }
8261     }
8262     return getCouldNotCompute();
8263   }
8264
8265   // Otherwise we can only handle this if it is affine.
8266   if (!AddRec->isAffine())
8267     return getCouldNotCompute();
8268
8269   // If this is an affine expression, the execution count of this branch is
8270   // the minimum unsigned root of the following equation:
8271   //
8272   //     Start + Step*N = 0 (mod 2^BW)
8273   //
8274   // equivalent to:
8275   //
8276   //             Step*N = -Start (mod 2^BW)
8277   //
8278   // where BW is the common bit width of Start and Step.
8279
8280   // Get the initial value for the loop.
8281   const SCEV *Start = getSCEVAtScope(AddRec->getStart(), L->getParentLoop());
8282   const SCEV *Step = getSCEVAtScope(AddRec->getOperand(1), L->getParentLoop());
8283
8284   // For now we handle only constant steps.
8285   //
8286   // TODO: Handle a nonconstant Step given AddRec<NUW>. If the
8287   // AddRec is NUW, then (in an unsigned sense) it cannot be counting up to wrap
8288   // to 0, it must be counting down to equal 0. Consequently, N = Start / -Step.
8289   // We have not yet seen any such cases.
8290   const SCEVConstant *StepC = dyn_cast<SCEVConstant>(Step);
8291   if (!StepC || StepC->getValue()->isZero())
8292     return getCouldNotCompute();
8293
8294   // For positive steps (counting up until unsigned overflow):
8295   //   N = -Start/Step (as unsigned)
8296   // For negative steps (counting down to zero):
8297   //   N = Start/-Step
8298   // First compute the unsigned distance from zero in the direction of Step.
8299   bool CountDown = StepC->getAPInt().isNegative();
8300   const SCEV *Distance = CountDown ? Start : getNegativeSCEV(Start);
8301
8302   // Handle unitary steps, which cannot wraparound.
8303   // 1*N = -Start; -1*N = Start (mod 2^BW), so:
8304   //   N = Distance (as unsigned)
8305   if (StepC->getValue()->isOne() || StepC->getValue()->isMinusOne()) {
8306     APInt MaxBECount = getUnsignedRangeMax(Distance);
8307
8308     // When a loop like "for (int i = 0; i != n; ++i) { /* body */ }" is rotated,
8309     // we end up with a loop whose backedge-taken count is n - 1.  Detect this
8310     // case, and see if we can improve the bound.
8311     //
8312     // Explicitly handling this here is necessary because getUnsignedRange
8313     // isn't context-sensitive; it doesn't know that we only care about the
8314     // range inside the loop.
8315     const SCEV *Zero = getZero(Distance->getType());
8316     const SCEV *One = getOne(Distance->getType());
8317     const SCEV *DistancePlusOne = getAddExpr(Distance, One);
8318     if (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_NE, DistancePlusOne, Zero)) {
8319       // If Distance + 1 doesn't overflow, we can compute the maximum distance
8320       // as "unsigned_max(Distance + 1) - 1".
8321       ConstantRange CR = getUnsignedRange(DistancePlusOne);
8322       MaxBECount = APIntOps::umin(MaxBECount, CR.getUnsignedMax() - 1);
8323     }
8324     return ExitLimit(Distance, getConstant(MaxBECount), false, Predicates);
8325   }
8326
8327   // If the condition controls loop exit (the loop exits only if the expression
8328   // is true) and the addition is no-wrap we can use unsigned divide to
8329   // compute the backedge count.  In this case, the step may not divide the
8330   // distance, but we don't care because if the condition is "missed" the loop
8331   // will have undefined behavior due to wrapping.
8332   if (ControlsExit && AddRec->hasNoSelfWrap() &&
8333       loopHasNoAbnormalExits(AddRec->getLoop())) {
8334     const SCEV *Exact =
8335         getUDivExpr(Distance, CountDown ? getNegativeSCEV(Step) : Step);
8336     const SCEV *Max =
8337         Exact == getCouldNotCompute()
8338             ? Exact
8339             : getConstant(getUnsignedRangeMax(Exact));
8340     return ExitLimit(Exact, Max, false, Predicates);
8341   }
8342
8343   // Solve the general equation.
8344   const SCEV *E = SolveLinEquationWithOverflow(StepC->getAPInt(),
8345                                                getNegativeSCEV(Start), *this);
8346   const SCEV *M = E == getCouldNotCompute()
8347                       ? E
8348                       : getConstant(getUnsignedRangeMax(E));
8349   return ExitLimit(E, M, false, Predicates);
8350 }
8351
8352 ScalarEvolution::ExitLimit
8353 ScalarEvolution::howFarToNonZero(const SCEV *V, const Loop *L) {
8354   // Loops that look like: while (X == 0) are very strange indeed.  We don't
8355   // handle them yet except for the trivial case.  This could be expanded in the
8356   // future as needed.
8357
8358   // If the value is a constant, check to see if it is known to be non-zero
8359   // already.  If so, the backedge will execute zero times.
8360   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
8361     if (!C->getValue()->isZero())
8362       return getZero(C->getType());
8363     return getCouldNotCompute();  // Otherwise it will loop infinitely.
8364   }
8365
8366   // We could implement others, but I really doubt anyone writes loops like
8367   // this, and if they did, they would already be constant folded.
8368   return getCouldNotCompute();
8369 }
8370
8371 std::pair<BasicBlock *, BasicBlock *>
8372 ScalarEvolution::getPredecessorWithUniqueSuccessorForBB(BasicBlock *BB) {
8373   // If the block has a unique predecessor, then there is no path from the
8374   // predecessor to the block that does not go through the direct edge
8375   // from the predecessor to the block.
8376   if (BasicBlock *Pred = BB->getSinglePredecessor())
8377     return {Pred, BB};
8378
8379   // A loop's header is defined to be a block that dominates the loop.
8380   // If the header has a unique predecessor outside the loop, it must be
8381   // a block that has exactly one successor that can reach the loop.
8382   if (Loop *L = LI.getLoopFor(BB))
8383     return {L->getLoopPredecessor(), L->getHeader()};
8384
8385   return {nullptr, nullptr};
8386 }
8387
8388 /// SCEV structural equivalence is usually sufficient for testing whether two
8389 /// expressions are equal, however for the purposes of looking for a condition
8390 /// guarding a loop, it can be useful to be a little more general, since a
8391 /// front-end may have replicated the controlling expression.
8392 static bool HasSameValue(const SCEV *A, const SCEV *B) {
8393   // Quick check to see if they are the same SCEV.
8394   if (A == B) return true;
8395
8396   auto ComputesEqualValues = [](const Instruction *A, const Instruction *B) {
8397     // Not all instructions that are "identical" compute the same value.  For
8398     // instance, two distinct alloca instructions allocating the same type are
8399     // identical and do not read memory; but compute distinct values.
8400     return A->isIdenticalTo(B) && (isa<BinaryOperator>(A) || isa<GetElementPtrInst>(A));
8401   };
8402
8403   // Otherwise, if they're both SCEVUnknown, it's possible that they hold
8404   // two different instructions with the same value. Check for this case.
8405   if (const SCEVUnknown *AU = dyn_cast<SCEVUnknown>(A))
8406     if (const SCEVUnknown *BU = dyn_cast<SCEVUnknown>(B))
8407       if (const Instruction *AI = dyn_cast<Instruction>(AU->getValue()))
8408         if (const Instruction *BI = dyn_cast<Instruction>(BU->getValue()))
8409           if (ComputesEqualValues(AI, BI))
8410             return true;
8411
8412   // Otherwise assume they may have a different value.
8413   return false;
8414 }
8415
8416 bool ScalarEvolution::SimplifyICmpOperands(ICmpInst::Predicate &Pred,
8417                                            const SCEV *&LHS, const SCEV *&RHS,
8418                                            unsigned Depth) {
8419   bool Changed = false;
8420
8421   // If we hit the max recursion limit bail out.
8422   if (Depth >= 3)
8423     return false;
8424
8425   // Canonicalize a constant to the right side.
8426   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
8427     // Check for both operands constant.
8428     if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
8429       if (ConstantExpr::getICmp(Pred,
8430                                 LHSC->getValue(),
8431                                 RHSC->getValue())->isNullValue())
8432         goto trivially_false;
8433       else
8434         goto trivially_true;
8435     }
8436     // Otherwise swap the operands to put the constant on the right.
8437     std::swap(LHS, RHS);
8438     Pred = ICmpInst::getSwappedPredicate(Pred);
8439     Changed = true;
8440   }
8441
8442   // If we're comparing an addrec with a value which is loop-invariant in the
8443   // addrec's loop, put the addrec on the left. Also make a dominance check,
8444   // as both operands could be addrecs loop-invariant in each other's loop.
8445   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS)) {
8446     const Loop *L = AR->getLoop();
8447     if (isLoopInvariant(LHS, L) && properlyDominates(LHS, L->getHeader())) {
8448       std::swap(LHS, RHS);
8449       Pred = ICmpInst::getSwappedPredicate(Pred);
8450       Changed = true;
8451     }
8452   }
8453
8454   // If there's a constant operand, canonicalize comparisons with boundary
8455   // cases, and canonicalize *-or-equal comparisons to regular comparisons.
8456   if (const SCEVConstant *RC = dyn_cast<SCEVConstant>(RHS)) {
8457     const APInt &RA = RC->getAPInt();
8458
8459     bool SimplifiedByConstantRange = false;
8460
8461     if (!ICmpInst::isEquality(Pred)) {
8462       ConstantRange ExactCR = ConstantRange::makeExactICmpRegion(Pred, RA);
8463       if (ExactCR.isFullSet())
8464         goto trivially_true;
8465       else if (ExactCR.isEmptySet())
8466         goto trivially_false;
8467
8468       APInt NewRHS;
8469       CmpInst::Predicate NewPred;
8470       if (ExactCR.getEquivalentICmp(NewPred, NewRHS) &&
8471           ICmpInst::isEquality(NewPred)) {
8472         // We were able to convert an inequality to an equality.
8473         Pred = NewPred;
8474         RHS = getConstant(NewRHS);
8475         Changed = SimplifiedByConstantRange = true;
8476       }
8477     }
8478
8479     if (!SimplifiedByConstantRange) {
8480       switch (Pred) {
8481       default:
8482         break;
8483       case ICmpInst::ICMP_EQ:
8484       case ICmpInst::ICMP_NE:
8485         // Fold ((-1) * %a) + %b == 0 (equivalent to %b-%a == 0) into %a == %b.
8486         if (!RA)
8487           if (const SCEVAddExpr *AE = dyn_cast<SCEVAddExpr>(LHS))
8488             if (const SCEVMulExpr *ME =
8489                     dyn_cast<SCEVMulExpr>(AE->getOperand(0)))
8490               if (AE->getNumOperands() == 2 && ME->getNumOperands() == 2 &&
8491                   ME->getOperand(0)->isAllOnesValue()) {
8492                 RHS = AE->getOperand(1);
8493                 LHS = ME->getOperand(1);
8494                 Changed = true;
8495               }
8496         break;
8497
8498
8499         // The "Should have been caught earlier!" messages refer to the fact
8500         // that the ExactCR.isFullSet() or ExactCR.isEmptySet() check above
8501         // should have fired on the corresponding cases, and canonicalized the
8502         // check to trivially_true or trivially_false.
8503
8504       case ICmpInst::ICMP_UGE:
8505         assert(!RA.isMinValue() && "Should have been caught earlier!");
8506         Pred = ICmpInst::ICMP_UGT;
8507         RHS = getConstant(RA - 1);
8508         Changed = true;
8509         break;
8510       case ICmpInst::ICMP_ULE:
8511         assert(!RA.isMaxValue() && "Should have been caught earlier!");
8512         Pred = ICmpInst::ICMP_ULT;
8513         RHS = getConstant(RA + 1);
8514         Changed = true;
8515         break;
8516       case ICmpInst::ICMP_SGE:
8517         assert(!RA.isMinSignedValue() && "Should have been caught earlier!");
8518         Pred = ICmpInst::ICMP_SGT;
8519         RHS = getConstant(RA - 1);
8520         Changed = true;
8521         break;
8522       case ICmpInst::ICMP_SLE:
8523         assert(!RA.isMaxSignedValue() && "Should have been caught earlier!");
8524         Pred = ICmpInst::ICMP_SLT;
8525         RHS = getConstant(RA + 1);
8526         Changed = true;
8527         break;
8528       }
8529     }
8530   }
8531
8532   // Check for obvious equality.
8533   if (HasSameValue(LHS, RHS)) {
8534     if (ICmpInst::isTrueWhenEqual(Pred))
8535       goto trivially_true;
8536     if (ICmpInst::isFalseWhenEqual(Pred))
8537       goto trivially_false;
8538   }
8539
8540   // If possible, canonicalize GE/LE comparisons to GT/LT comparisons, by
8541   // adding or subtracting 1 from one of the operands.
8542   switch (Pred) {
8543   case ICmpInst::ICMP_SLE:
8544     if (!getSignedRangeMax(RHS).isMaxSignedValue()) {
8545       RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
8546                        SCEV::FlagNSW);
8547       Pred = ICmpInst::ICMP_SLT;
8548       Changed = true;
8549     } else if (!getSignedRangeMin(LHS).isMinSignedValue()) {
8550       LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
8551                        SCEV::FlagNSW);
8552       Pred = ICmpInst::ICMP_SLT;
8553       Changed = true;
8554     }
8555     break;
8556   case ICmpInst::ICMP_SGE:
8557     if (!getSignedRangeMin(RHS).isMinSignedValue()) {
8558       RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
8559                        SCEV::FlagNSW);
8560       Pred = ICmpInst::ICMP_SGT;
8561       Changed = true;
8562     } else if (!getSignedRangeMax(LHS).isMaxSignedValue()) {
8563       LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
8564                        SCEV::FlagNSW);
8565       Pred = ICmpInst::ICMP_SGT;
8566       Changed = true;
8567     }
8568     break;
8569   case ICmpInst::ICMP_ULE:
8570     if (!getUnsignedRangeMax(RHS).isMaxValue()) {
8571       RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
8572                        SCEV::FlagNUW);
8573       Pred = ICmpInst::ICMP_ULT;
8574       Changed = true;
8575     } else if (!getUnsignedRangeMin(LHS).isMinValue()) {
8576       LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS);
8577       Pred = ICmpInst::ICMP_ULT;
8578       Changed = true;
8579     }
8580     break;
8581   case ICmpInst::ICMP_UGE:
8582     if (!getUnsignedRangeMin(RHS).isMinValue()) {
8583       RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS);
8584       Pred = ICmpInst::ICMP_UGT;
8585       Changed = true;
8586     } else if (!getUnsignedRangeMax(LHS).isMaxValue()) {
8587       LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
8588                        SCEV::FlagNUW);
8589       Pred = ICmpInst::ICMP_UGT;
8590       Changed = true;
8591     }
8592     break;
8593   default:
8594     break;
8595   }
8596
8597   // TODO: More simplifications are possible here.
8598
8599   // Recursively simplify until we either hit a recursion limit or nothing
8600   // changes.
8601   if (Changed)
8602     return SimplifyICmpOperands(Pred, LHS, RHS, Depth+1);
8603
8604   return Changed;
8605
8606 trivially_true:
8607   // Return 0 == 0.
8608   LHS = RHS = getConstant(ConstantInt::getFalse(getContext()));
8609   Pred = ICmpInst::ICMP_EQ;
8610   return true;
8611
8612 trivially_false:
8613   // Return 0 != 0.
8614   LHS = RHS = getConstant(ConstantInt::getFalse(getContext()));
8615   Pred = ICmpInst::ICMP_NE;
8616   return true;
8617 }
8618
8619 bool ScalarEvolution::isKnownNegative(const SCEV *S) {
8620   return getSignedRangeMax(S).isNegative();
8621 }
8622
8623 bool ScalarEvolution::isKnownPositive(const SCEV *S) {
8624   return getSignedRangeMin(S).isStrictlyPositive();
8625 }
8626
8627 bool ScalarEvolution::isKnownNonNegative(const SCEV *S) {
8628   return !getSignedRangeMin(S).isNegative();
8629 }
8630
8631 bool ScalarEvolution::isKnownNonPositive(const SCEV *S) {
8632   return !getSignedRangeMax(S).isStrictlyPositive();
8633 }
8634
8635 bool ScalarEvolution::isKnownNonZero(const SCEV *S) {
8636   return isKnownNegative(S) || isKnownPositive(S);
8637 }
8638
8639 bool ScalarEvolution::isKnownPredicate(ICmpInst::Predicate Pred,
8640                                        const SCEV *LHS, const SCEV *RHS) {
8641   // Canonicalize the inputs first.
8642   (void)SimplifyICmpOperands(Pred, LHS, RHS);
8643
8644   // If LHS or RHS is an addrec, check to see if the condition is true in
8645   // every iteration of the loop.
8646   // If LHS and RHS are both addrec, both conditions must be true in
8647   // every iteration of the loop.
8648   const SCEVAddRecExpr *LAR = dyn_cast<SCEVAddRecExpr>(LHS);
8649   const SCEVAddRecExpr *RAR = dyn_cast<SCEVAddRecExpr>(RHS);
8650   bool LeftGuarded = false;
8651   bool RightGuarded = false;
8652   if (LAR) {
8653     const Loop *L = LAR->getLoop();
8654     if (isLoopEntryGuardedByCond(L, Pred, LAR->getStart(), RHS) &&
8655         isLoopBackedgeGuardedByCond(L, Pred, LAR->getPostIncExpr(*this), RHS)) {
8656       if (!RAR) return true;
8657       LeftGuarded = true;
8658     }
8659   }
8660   if (RAR) {
8661     const Loop *L = RAR->getLoop();
8662     if (isLoopEntryGuardedByCond(L, Pred, LHS, RAR->getStart()) &&
8663         isLoopBackedgeGuardedByCond(L, Pred, LHS, RAR->getPostIncExpr(*this))) {
8664       if (!LAR) return true;
8665       RightGuarded = true;
8666     }
8667   }
8668   if (LeftGuarded && RightGuarded)
8669     return true;
8670
8671   if (isKnownPredicateViaSplitting(Pred, LHS, RHS))
8672     return true;
8673
8674   // Otherwise see what can be done with known constant ranges.
8675   return isKnownPredicateViaConstantRanges(Pred, LHS, RHS);
8676 }
8677
8678 bool ScalarEvolution::isMonotonicPredicate(const SCEVAddRecExpr *LHS,
8679                                            ICmpInst::Predicate Pred,
8680                                            bool &Increasing) {
8681   bool Result = isMonotonicPredicateImpl(LHS, Pred, Increasing);
8682
8683 #ifndef NDEBUG
8684   // Verify an invariant: inverting the predicate should turn a monotonically
8685   // increasing change to a monotonically decreasing one, and vice versa.
8686   bool IncreasingSwapped;
8687   bool ResultSwapped = isMonotonicPredicateImpl(
8688       LHS, ICmpInst::getSwappedPredicate(Pred), IncreasingSwapped);
8689
8690   assert(Result == ResultSwapped && "should be able to analyze both!");
8691   if (ResultSwapped)
8692     assert(Increasing == !IncreasingSwapped &&
8693            "monotonicity should flip as we flip the predicate");
8694 #endif
8695
8696   return Result;
8697 }
8698
8699 bool ScalarEvolution::isMonotonicPredicateImpl(const SCEVAddRecExpr *LHS,
8700                                                ICmpInst::Predicate Pred,
8701                                                bool &Increasing) {
8702
8703   // A zero step value for LHS means the induction variable is essentially a
8704   // loop invariant value. We don't really depend on the predicate actually
8705   // flipping from false to true (for increasing predicates, and the other way
8706   // around for decreasing predicates), all we care about is that *if* the
8707   // predicate changes then it only changes from false to true.
8708   //
8709   // A zero step value in itself is not very useful, but there may be places
8710   // where SCEV can prove X >= 0 but not prove X > 0, so it is helpful to be
8711   // as general as possible.
8712
8713   switch (Pred) {
8714   default:
8715     return false; // Conservative answer
8716
8717   case ICmpInst::ICMP_UGT:
8718   case ICmpInst::ICMP_UGE:
8719   case ICmpInst::ICMP_ULT:
8720   case ICmpInst::ICMP_ULE:
8721     if (!LHS->hasNoUnsignedWrap())
8722       return false;
8723
8724     Increasing = Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE;
8725     return true;
8726
8727   case ICmpInst::ICMP_SGT:
8728   case ICmpInst::ICMP_SGE:
8729   case ICmpInst::ICMP_SLT:
8730   case ICmpInst::ICMP_SLE: {
8731     if (!LHS->hasNoSignedWrap())
8732       return false;
8733
8734     const SCEV *Step = LHS->getStepRecurrence(*this);
8735
8736     if (isKnownNonNegative(Step)) {
8737       Increasing = Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE;
8738       return true;
8739     }
8740
8741     if (isKnownNonPositive(Step)) {
8742       Increasing = Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE;
8743       return true;
8744     }
8745
8746     return false;
8747   }
8748
8749   }
8750
8751   llvm_unreachable("switch has default clause!");
8752 }
8753
8754 bool ScalarEvolution::isLoopInvariantPredicate(
8755     ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS, const Loop *L,
8756     ICmpInst::Predicate &InvariantPred, const SCEV *&InvariantLHS,
8757     const SCEV *&InvariantRHS) {
8758
8759   // If there is a loop-invariant, force it into the RHS, otherwise bail out.
8760   if (!isLoopInvariant(RHS, L)) {
8761     if (!isLoopInvariant(LHS, L))
8762       return false;
8763
8764     std::swap(LHS, RHS);
8765     Pred = ICmpInst::getSwappedPredicate(Pred);
8766   }
8767
8768   const SCEVAddRecExpr *ArLHS = dyn_cast<SCEVAddRecExpr>(LHS);
8769   if (!ArLHS || ArLHS->getLoop() != L)
8770     return false;
8771
8772   bool Increasing;
8773   if (!isMonotonicPredicate(ArLHS, Pred, Increasing))
8774     return false;
8775
8776   // If the predicate "ArLHS `Pred` RHS" monotonically increases from false to
8777   // true as the loop iterates, and the backedge is control dependent on
8778   // "ArLHS `Pred` RHS" == true then we can reason as follows:
8779   //
8780   //   * if the predicate was false in the first iteration then the predicate
8781   //     is never evaluated again, since the loop exits without taking the
8782   //     backedge.
8783   //   * if the predicate was true in the first iteration then it will
8784   //     continue to be true for all future iterations since it is
8785   //     monotonically increasing.
8786   //
8787   // For both the above possibilities, we can replace the loop varying
8788   // predicate with its value on the first iteration of the loop (which is
8789   // loop invariant).
8790   //
8791   // A similar reasoning applies for a monotonically decreasing predicate, by
8792   // replacing true with false and false with true in the above two bullets.
8793
8794   auto P = Increasing ? Pred : ICmpInst::getInversePredicate(Pred);
8795
8796   if (!isLoopBackedgeGuardedByCond(L, P, LHS, RHS))
8797     return false;
8798
8799   InvariantPred = Pred;
8800   InvariantLHS = ArLHS->getStart();
8801   InvariantRHS = RHS;
8802   return true;
8803 }
8804
8805 bool ScalarEvolution::isKnownPredicateViaConstantRanges(
8806     ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS) {
8807   if (HasSameValue(LHS, RHS))
8808     return ICmpInst::isTrueWhenEqual(Pred);
8809
8810   // This code is split out from isKnownPredicate because it is called from
8811   // within isLoopEntryGuardedByCond.
8812
8813   auto CheckRanges =
8814       [&](const ConstantRange &RangeLHS, const ConstantRange &RangeRHS) {
8815     return ConstantRange::makeSatisfyingICmpRegion(Pred, RangeRHS)
8816         .contains(RangeLHS);
8817   };
8818
8819   // The check at the top of the function catches the case where the values are
8820   // known to be equal.
8821   if (Pred == CmpInst::ICMP_EQ)
8822     return false;
8823
8824   if (Pred == CmpInst::ICMP_NE)
8825     return CheckRanges(getSignedRange(LHS), getSignedRange(RHS)) ||
8826            CheckRanges(getUnsignedRange(LHS), getUnsignedRange(RHS)) ||
8827            isKnownNonZero(getMinusSCEV(LHS, RHS));
8828
8829   if (CmpInst::isSigned(Pred))
8830     return CheckRanges(getSignedRange(LHS), getSignedRange(RHS));
8831
8832   return CheckRanges(getUnsignedRange(LHS), getUnsignedRange(RHS));
8833 }
8834
8835 bool ScalarEvolution::isKnownPredicateViaNoOverflow(ICmpInst::Predicate Pred,
8836                                                     const SCEV *LHS,
8837                                                     const SCEV *RHS) {
8838   // Match Result to (X + Y)<ExpectedFlags> where Y is a constant integer.
8839   // Return Y via OutY.
8840   auto MatchBinaryAddToConst =
8841       [this](const SCEV *Result, const SCEV *X, APInt &OutY,
8842              SCEV::NoWrapFlags ExpectedFlags) {
8843     const SCEV *NonConstOp, *ConstOp;
8844     SCEV::NoWrapFlags FlagsPresent;
8845
8846     if (!splitBinaryAdd(Result, ConstOp, NonConstOp, FlagsPresent) ||
8847         !isa<SCEVConstant>(ConstOp) || NonConstOp != X)
8848       return false;
8849
8850     OutY = cast<SCEVConstant>(ConstOp)->getAPInt();
8851     return (FlagsPresent & ExpectedFlags) == ExpectedFlags;
8852   };
8853
8854   APInt C;
8855
8856   switch (Pred) {
8857   default:
8858     break;
8859
8860   case ICmpInst::ICMP_SGE:
8861     std::swap(LHS, RHS);
8862     LLVM_FALLTHROUGH;
8863   case ICmpInst::ICMP_SLE:
8864     // X s<= (X + C)<nsw> if C >= 0
8865     if (MatchBinaryAddToConst(RHS, LHS, C, SCEV::FlagNSW) && C.isNonNegative())
8866       return true;
8867
8868     // (X + C)<nsw> s<= X if C <= 0
8869     if (MatchBinaryAddToConst(LHS, RHS, C, SCEV::FlagNSW) &&
8870         !C.isStrictlyPositive())
8871       return true;
8872     break;
8873
8874   case ICmpInst::ICMP_SGT:
8875     std::swap(LHS, RHS);
8876     LLVM_FALLTHROUGH;
8877   case ICmpInst::ICMP_SLT:
8878     // X s< (X + C)<nsw> if C > 0
8879     if (MatchBinaryAddToConst(RHS, LHS, C, SCEV::FlagNSW) &&
8880         C.isStrictlyPositive())
8881       return true;
8882
8883     // (X + C)<nsw> s< X if C < 0
8884     if (MatchBinaryAddToConst(LHS, RHS, C, SCEV::FlagNSW) && C.isNegative())
8885       return true;
8886     break;
8887   }
8888
8889   return false;
8890 }
8891
8892 bool ScalarEvolution::isKnownPredicateViaSplitting(ICmpInst::Predicate Pred,
8893                                                    const SCEV *LHS,
8894                                                    const SCEV *RHS) {
8895   if (Pred != ICmpInst::ICMP_ULT || ProvingSplitPredicate)
8896     return false;
8897
8898   // Allowing arbitrary number of activations of isKnownPredicateViaSplitting on
8899   // the stack can result in exponential time complexity.
8900   SaveAndRestore<bool> Restore(ProvingSplitPredicate, true);
8901
8902   // If L >= 0 then I `ult` L <=> I >= 0 && I `slt` L
8903   //
8904   // To prove L >= 0 we use isKnownNonNegative whereas to prove I >= 0 we use
8905   // isKnownPredicate.  isKnownPredicate is more powerful, but also more
8906   // expensive; and using isKnownNonNegative(RHS) is sufficient for most of the
8907   // interesting cases seen in practice.  We can consider "upgrading" L >= 0 to
8908   // use isKnownPredicate later if needed.
8909   return isKnownNonNegative(RHS) &&
8910          isKnownPredicate(CmpInst::ICMP_SGE, LHS, getZero(LHS->getType())) &&
8911          isKnownPredicate(CmpInst::ICMP_SLT, LHS, RHS);
8912 }
8913
8914 bool ScalarEvolution::isImpliedViaGuard(BasicBlock *BB,
8915                                         ICmpInst::Predicate Pred,
8916                                         const SCEV *LHS, const SCEV *RHS) {
8917   // No need to even try if we know the module has no guards.
8918   if (!HasGuards)
8919     return false;
8920
8921   return any_of(*BB, [&](Instruction &I) {
8922     using namespace llvm::PatternMatch;
8923
8924     Value *Condition;
8925     return match(&I, m_Intrinsic<Intrinsic::experimental_guard>(
8926                          m_Value(Condition))) &&
8927            isImpliedCond(Pred, LHS, RHS, Condition, false);
8928   });
8929 }
8930
8931 /// isLoopBackedgeGuardedByCond - Test whether the backedge of the loop is
8932 /// protected by a conditional between LHS and RHS.  This is used to
8933 /// to eliminate casts.
8934 bool
8935 ScalarEvolution::isLoopBackedgeGuardedByCond(const Loop *L,
8936                                              ICmpInst::Predicate Pred,
8937                                              const SCEV *LHS, const SCEV *RHS) {
8938   // Interpret a null as meaning no loop, where there is obviously no guard
8939   // (interprocedural conditions notwithstanding).
8940   if (!L) return true;
8941
8942   if (isKnownPredicateViaConstantRanges(Pred, LHS, RHS))
8943     return true;
8944
8945   BasicBlock *Latch = L->getLoopLatch();
8946   if (!Latch)
8947     return false;
8948
8949   BranchInst *LoopContinuePredicate =
8950     dyn_cast<BranchInst>(Latch->getTerminator());
8951   if (LoopContinuePredicate && LoopContinuePredicate->isConditional() &&
8952       isImpliedCond(Pred, LHS, RHS,
8953                     LoopContinuePredicate->getCondition(),
8954                     LoopContinuePredicate->getSuccessor(0) != L->getHeader()))
8955     return true;
8956
8957   // We don't want more than one activation of the following loops on the stack
8958   // -- that can lead to O(n!) time complexity.
8959   if (WalkingBEDominatingConds)
8960     return false;
8961
8962   SaveAndRestore<bool> ClearOnExit(WalkingBEDominatingConds, true);
8963
8964   // See if we can exploit a trip count to prove the predicate.
8965   const auto &BETakenInfo = getBackedgeTakenInfo(L);
8966   const SCEV *LatchBECount = BETakenInfo.getExact(Latch, this);
8967   if (LatchBECount != getCouldNotCompute()) {
8968     // We know that Latch branches back to the loop header exactly
8969     // LatchBECount times.  This means the backdege condition at Latch is
8970     // equivalent to  "{0,+,1} u< LatchBECount".
8971     Type *Ty = LatchBECount->getType();
8972     auto NoWrapFlags = SCEV::NoWrapFlags(SCEV::FlagNUW | SCEV::FlagNW);
8973     const SCEV *LoopCounter =
8974       getAddRecExpr(getZero(Ty), getOne(Ty), L, NoWrapFlags);
8975     if (isImpliedCond(Pred, LHS, RHS, ICmpInst::ICMP_ULT, LoopCounter,
8976                       LatchBECount))
8977       return true;
8978   }
8979
8980   // Check conditions due to any @llvm.assume intrinsics.
8981   for (auto &AssumeVH : AC.assumptions()) {
8982     if (!AssumeVH)
8983       continue;
8984     auto *CI = cast<CallInst>(AssumeVH);
8985     if (!DT.dominates(CI, Latch->getTerminator()))
8986       continue;
8987
8988     if (isImpliedCond(Pred, LHS, RHS, CI->getArgOperand(0), false))
8989       return true;
8990   }
8991
8992   // If the loop is not reachable from the entry block, we risk running into an
8993   // infinite loop as we walk up into the dom tree.  These loops do not matter
8994   // anyway, so we just return a conservative answer when we see them.
8995   if (!DT.isReachableFromEntry(L->getHeader()))
8996     return false;
8997
8998   if (isImpliedViaGuard(Latch, Pred, LHS, RHS))
8999     return true;
9000
9001   for (DomTreeNode *DTN = DT[Latch], *HeaderDTN = DT[L->getHeader()];
9002        DTN != HeaderDTN; DTN = DTN->getIDom()) {
9003     assert(DTN && "should reach the loop header before reaching the root!");
9004
9005     BasicBlock *BB = DTN->getBlock();
9006     if (isImpliedViaGuard(BB, Pred, LHS, RHS))
9007       return true;
9008
9009     BasicBlock *PBB = BB->getSinglePredecessor();
9010     if (!PBB)
9011       continue;
9012
9013     BranchInst *ContinuePredicate = dyn_cast<BranchInst>(PBB->getTerminator());
9014     if (!ContinuePredicate || !ContinuePredicate->isConditional())
9015       continue;
9016
9017     Value *Condition = ContinuePredicate->getCondition();
9018
9019     // If we have an edge `E` within the loop body that dominates the only
9020     // latch, the condition guarding `E` also guards the backedge.  This
9021     // reasoning works only for loops with a single latch.
9022
9023     BasicBlockEdge DominatingEdge(PBB, BB);
9024     if (DominatingEdge.isSingleEdge()) {
9025       // We're constructively (and conservatively) enumerating edges within the
9026       // loop body that dominate the latch.  The dominator tree better agree
9027       // with us on this:
9028       assert(DT.dominates(DominatingEdge, Latch) && "should be!");
9029
9030       if (isImpliedCond(Pred, LHS, RHS, Condition,
9031                         BB != ContinuePredicate->getSuccessor(0)))
9032         return true;
9033     }
9034   }
9035
9036   return false;
9037 }
9038
9039 bool
9040 ScalarEvolution::isLoopEntryGuardedByCond(const Loop *L,
9041                                           ICmpInst::Predicate Pred,
9042                                           const SCEV *LHS, const SCEV *RHS) {
9043   // Interpret a null as meaning no loop, where there is obviously no guard
9044   // (interprocedural conditions notwithstanding).
9045   if (!L) return false;
9046
9047   if (isKnownPredicateViaConstantRanges(Pred, LHS, RHS))
9048     return true;
9049
9050   // Starting at the loop predecessor, climb up the predecessor chain, as long
9051   // as there are predecessors that can be found that have unique successors
9052   // leading to the original header.
9053   for (std::pair<BasicBlock *, BasicBlock *>
9054          Pair(L->getLoopPredecessor(), L->getHeader());
9055        Pair.first;
9056        Pair = getPredecessorWithUniqueSuccessorForBB(Pair.first)) {
9057
9058     if (isImpliedViaGuard(Pair.first, Pred, LHS, RHS))
9059       return true;
9060
9061     BranchInst *LoopEntryPredicate =
9062       dyn_cast<BranchInst>(Pair.first->getTerminator());
9063     if (!LoopEntryPredicate ||
9064         LoopEntryPredicate->isUnconditional())
9065       continue;
9066
9067     if (isImpliedCond(Pred, LHS, RHS,
9068                       LoopEntryPredicate->getCondition(),
9069                       LoopEntryPredicate->getSuccessor(0) != Pair.second))
9070       return true;
9071   }
9072
9073   // Check conditions due to any @llvm.assume intrinsics.
9074   for (auto &AssumeVH : AC.assumptions()) {
9075     if (!AssumeVH)
9076       continue;
9077     auto *CI = cast<CallInst>(AssumeVH);
9078     if (!DT.dominates(CI, L->getHeader()))
9079       continue;
9080
9081     if (isImpliedCond(Pred, LHS, RHS, CI->getArgOperand(0), false))
9082       return true;
9083   }
9084
9085   return false;
9086 }
9087
9088 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred,
9089                                     const SCEV *LHS, const SCEV *RHS,
9090                                     Value *FoundCondValue,
9091                                     bool Inverse) {
9092   if (!PendingLoopPredicates.insert(FoundCondValue).second)
9093     return false;
9094
9095   auto ClearOnExit =
9096       make_scope_exit([&]() { PendingLoopPredicates.erase(FoundCondValue); });
9097
9098   // Recursively handle And and Or conditions.
9099   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(FoundCondValue)) {
9100     if (BO->getOpcode() == Instruction::And) {
9101       if (!Inverse)
9102         return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
9103                isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
9104     } else if (BO->getOpcode() == Instruction::Or) {
9105       if (Inverse)
9106         return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
9107                isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
9108     }
9109   }
9110
9111   ICmpInst *ICI = dyn_cast<ICmpInst>(FoundCondValue);
9112   if (!ICI) return false;
9113
9114   // Now that we found a conditional branch that dominates the loop or controls
9115   // the loop latch. Check to see if it is the comparison we are looking for.
9116   ICmpInst::Predicate FoundPred;
9117   if (Inverse)
9118     FoundPred = ICI->getInversePredicate();
9119   else
9120     FoundPred = ICI->getPredicate();
9121
9122   const SCEV *FoundLHS = getSCEV(ICI->getOperand(0));
9123   const SCEV *FoundRHS = getSCEV(ICI->getOperand(1));
9124
9125   return isImpliedCond(Pred, LHS, RHS, FoundPred, FoundLHS, FoundRHS);
9126 }
9127
9128 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred, const SCEV *LHS,
9129                                     const SCEV *RHS,
9130                                     ICmpInst::Predicate FoundPred,
9131                                     const SCEV *FoundLHS,
9132                                     const SCEV *FoundRHS) {
9133   // Balance the types.
9134   if (getTypeSizeInBits(LHS->getType()) <
9135       getTypeSizeInBits(FoundLHS->getType())) {
9136     if (CmpInst::isSigned(Pred)) {
9137       LHS = getSignExtendExpr(LHS, FoundLHS->getType());
9138       RHS = getSignExtendExpr(RHS, FoundLHS->getType());
9139     } else {
9140       LHS = getZeroExtendExpr(LHS, FoundLHS->getType());
9141       RHS = getZeroExtendExpr(RHS, FoundLHS->getType());
9142     }
9143   } else if (getTypeSizeInBits(LHS->getType()) >
9144       getTypeSizeInBits(FoundLHS->getType())) {
9145     if (CmpInst::isSigned(FoundPred)) {
9146       FoundLHS = getSignExtendExpr(FoundLHS, LHS->getType());
9147       FoundRHS = getSignExtendExpr(FoundRHS, LHS->getType());
9148     } else {
9149       FoundLHS = getZeroExtendExpr(FoundLHS, LHS->getType());
9150       FoundRHS = getZeroExtendExpr(FoundRHS, LHS->getType());
9151     }
9152   }
9153
9154   // Canonicalize the query to match the way instcombine will have
9155   // canonicalized the comparison.
9156   if (SimplifyICmpOperands(Pred, LHS, RHS))
9157     if (LHS == RHS)
9158       return CmpInst::isTrueWhenEqual(Pred);
9159   if (SimplifyICmpOperands(FoundPred, FoundLHS, FoundRHS))
9160     if (FoundLHS == FoundRHS)
9161       return CmpInst::isFalseWhenEqual(FoundPred);
9162
9163   // Check to see if we can make the LHS or RHS match.
9164   if (LHS == FoundRHS || RHS == FoundLHS) {
9165     if (isa<SCEVConstant>(RHS)) {
9166       std::swap(FoundLHS, FoundRHS);
9167       FoundPred = ICmpInst::getSwappedPredicate(FoundPred);
9168     } else {
9169       std::swap(LHS, RHS);
9170       Pred = ICmpInst::getSwappedPredicate(Pred);
9171     }
9172   }
9173
9174   // Check whether the found predicate is the same as the desired predicate.
9175   if (FoundPred == Pred)
9176     return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS);
9177
9178   // Check whether swapping the found predicate makes it the same as the
9179   // desired predicate.
9180   if (ICmpInst::getSwappedPredicate(FoundPred) == Pred) {
9181     if (isa<SCEVConstant>(RHS))
9182       return isImpliedCondOperands(Pred, LHS, RHS, FoundRHS, FoundLHS);
9183     else
9184       return isImpliedCondOperands(ICmpInst::getSwappedPredicate(Pred),
9185                                    RHS, LHS, FoundLHS, FoundRHS);
9186   }
9187
9188   // Unsigned comparison is the same as signed comparison when both the operands
9189   // are non-negative.
9190   if (CmpInst::isUnsigned(FoundPred) &&
9191       CmpInst::getSignedPredicate(FoundPred) == Pred &&
9192       isKnownNonNegative(FoundLHS) && isKnownNonNegative(FoundRHS))
9193     return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS);
9194
9195   // Check if we can make progress by sharpening ranges.
9196   if (FoundPred == ICmpInst::ICMP_NE &&
9197       (isa<SCEVConstant>(FoundLHS) || isa<SCEVConstant>(FoundRHS))) {
9198
9199     const SCEVConstant *C = nullptr;
9200     const SCEV *V = nullptr;
9201
9202     if (isa<SCEVConstant>(FoundLHS)) {
9203       C = cast<SCEVConstant>(FoundLHS);
9204       V = FoundRHS;
9205     } else {
9206       C = cast<SCEVConstant>(FoundRHS);
9207       V = FoundLHS;
9208     }
9209
9210     // The guarding predicate tells us that C != V. If the known range
9211     // of V is [C, t), we can sharpen the range to [C + 1, t).  The
9212     // range we consider has to correspond to same signedness as the
9213     // predicate we're interested in folding.
9214
9215     APInt Min = ICmpInst::isSigned(Pred) ?
9216         getSignedRangeMin(V) : getUnsignedRangeMin(V);
9217
9218     if (Min == C->getAPInt()) {
9219       // Given (V >= Min && V != Min) we conclude V >= (Min + 1).
9220       // This is true even if (Min + 1) wraps around -- in case of
9221       // wraparound, (Min + 1) < Min, so (V >= Min => V >= (Min + 1)).
9222
9223       APInt SharperMin = Min + 1;
9224
9225       switch (Pred) {
9226         case ICmpInst::ICMP_SGE:
9227         case ICmpInst::ICMP_UGE:
9228           // We know V `Pred` SharperMin.  If this implies LHS `Pred`
9229           // RHS, we're done.
9230           if (isImpliedCondOperands(Pred, LHS, RHS, V,
9231                                     getConstant(SharperMin)))
9232             return true;
9233           LLVM_FALLTHROUGH;
9234
9235         case ICmpInst::ICMP_SGT:
9236         case ICmpInst::ICMP_UGT:
9237           // We know from the range information that (V `Pred` Min ||
9238           // V == Min).  We know from the guarding condition that !(V
9239           // == Min).  This gives us
9240           //
9241           //       V `Pred` Min || V == Min && !(V == Min)
9242           //   =>  V `Pred` Min
9243           //
9244           // If V `Pred` Min implies LHS `Pred` RHS, we're done.
9245
9246           if (isImpliedCondOperands(Pred, LHS, RHS, V, getConstant(Min)))
9247             return true;
9248           LLVM_FALLTHROUGH;
9249
9250         default:
9251           // No change
9252           break;
9253       }
9254     }
9255   }
9256
9257   // Check whether the actual condition is beyond sufficient.
9258   if (FoundPred == ICmpInst::ICMP_EQ)
9259     if (ICmpInst::isTrueWhenEqual(Pred))
9260       if (isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS))
9261         return true;
9262   if (Pred == ICmpInst::ICMP_NE)
9263     if (!ICmpInst::isTrueWhenEqual(FoundPred))
9264       if (isImpliedCondOperands(FoundPred, LHS, RHS, FoundLHS, FoundRHS))
9265         return true;
9266
9267   // Otherwise assume the worst.
9268   return false;
9269 }
9270
9271 bool ScalarEvolution::splitBinaryAdd(const SCEV *Expr,
9272                                      const SCEV *&L, const SCEV *&R,
9273                                      SCEV::NoWrapFlags &Flags) {
9274   const auto *AE = dyn_cast<SCEVAddExpr>(Expr);
9275   if (!AE || AE->getNumOperands() != 2)
9276     return false;
9277
9278   L = AE->getOperand(0);
9279   R = AE->getOperand(1);
9280   Flags = AE->getNoWrapFlags();
9281   return true;
9282 }
9283
9284 Optional<APInt> ScalarEvolution::computeConstantDifference(const SCEV *More,
9285                                                            const SCEV *Less) {
9286   // We avoid subtracting expressions here because this function is usually
9287   // fairly deep in the call stack (i.e. is called many times).
9288
9289   if (isa<SCEVAddRecExpr>(Less) && isa<SCEVAddRecExpr>(More)) {
9290     const auto *LAR = cast<SCEVAddRecExpr>(Less);
9291     const auto *MAR = cast<SCEVAddRecExpr>(More);
9292
9293     if (LAR->getLoop() != MAR->getLoop())
9294       return None;
9295
9296     // We look at affine expressions only; not for correctness but to keep
9297     // getStepRecurrence cheap.
9298     if (!LAR->isAffine() || !MAR->isAffine())
9299       return None;
9300
9301     if (LAR->getStepRecurrence(*this) != MAR->getStepRecurrence(*this))
9302       return None;
9303
9304     Less = LAR->getStart();
9305     More = MAR->getStart();
9306
9307     // fall through
9308   }
9309
9310   if (isa<SCEVConstant>(Less) && isa<SCEVConstant>(More)) {
9311     const auto &M = cast<SCEVConstant>(More)->getAPInt();
9312     const auto &L = cast<SCEVConstant>(Less)->getAPInt();
9313     return M - L;
9314   }
9315
9316   const SCEV *L, *R;
9317   SCEV::NoWrapFlags Flags;
9318   if (splitBinaryAdd(Less, L, R, Flags))
9319     if (const auto *LC = dyn_cast<SCEVConstant>(L))
9320       if (R == More)
9321         return -(LC->getAPInt());
9322
9323   if (splitBinaryAdd(More, L, R, Flags))
9324     if (const auto *LC = dyn_cast<SCEVConstant>(L))
9325       if (R == Less)
9326         return LC->getAPInt();
9327
9328   return None;
9329 }
9330
9331 bool ScalarEvolution::isImpliedCondOperandsViaNoOverflow(
9332     ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS,
9333     const SCEV *FoundLHS, const SCEV *FoundRHS) {
9334   if (Pred != CmpInst::ICMP_SLT && Pred != CmpInst::ICMP_ULT)
9335     return false;
9336
9337   const auto *AddRecLHS = dyn_cast<SCEVAddRecExpr>(LHS);
9338   if (!AddRecLHS)
9339     return false;
9340
9341   const auto *AddRecFoundLHS = dyn_cast<SCEVAddRecExpr>(FoundLHS);
9342   if (!AddRecFoundLHS)
9343     return false;
9344
9345   // We'd like to let SCEV reason about control dependencies, so we constrain
9346   // both the inequalities to be about add recurrences on the same loop.  This
9347   // way we can use isLoopEntryGuardedByCond later.
9348
9349   const Loop *L = AddRecFoundLHS->getLoop();
9350   if (L != AddRecLHS->getLoop())
9351     return false;
9352
9353   //  FoundLHS u< FoundRHS u< -C =>  (FoundLHS + C) u< (FoundRHS + C) ... (1)
9354   //
9355   //  FoundLHS s< FoundRHS s< INT_MIN - C => (FoundLHS + C) s< (FoundRHS + C)
9356   //                                                                  ... (2)
9357   //
9358   // Informal proof for (2), assuming (1) [*]:
9359   //
9360   // We'll also assume (A s< B) <=> ((A + INT_MIN) u< (B + INT_MIN)) ... (3)[**]
9361   //
9362   // Then
9363   //
9364   //       FoundLHS s< FoundRHS s< INT_MIN - C
9365   // <=>  (FoundLHS + INT_MIN) u< (FoundRHS + INT_MIN) u< -C   [ using (3) ]
9366   // <=>  (FoundLHS + INT_MIN + C) u< (FoundRHS + INT_MIN + C) [ using (1) ]
9367   // <=>  (FoundLHS + INT_MIN + C + INT_MIN) s<
9368   //                        (FoundRHS + INT_MIN + C + INT_MIN) [ using (3) ]
9369   // <=>  FoundLHS + C s< FoundRHS + C
9370   //
9371   // [*]: (1) can be proved by ruling out overflow.
9372   //
9373   // [**]: This can be proved by analyzing all the four possibilities:
9374   //    (A s< 0, B s< 0), (A s< 0, B s>= 0), (A s>= 0, B s< 0) and
9375   //    (A s>= 0, B s>= 0).
9376   //
9377   // Note:
9378   // Despite (2), "FoundRHS s< INT_MIN - C" does not mean that "FoundRHS + C"
9379   // will not sign underflow.  For instance, say FoundLHS = (i8 -128), FoundRHS
9380   // = (i8 -127) and C = (i8 -100).  Then INT_MIN - C = (i8 -28), and FoundRHS
9381   // s< (INT_MIN - C).  Lack of sign overflow / underflow in "FoundRHS + C" is
9382   // neither necessary nor sufficient to prove "(FoundLHS + C) s< (FoundRHS +
9383   // C)".
9384
9385   Optional<APInt> LDiff = computeConstantDifference(LHS, FoundLHS);
9386   Optional<APInt> RDiff = computeConstantDifference(RHS, FoundRHS);
9387   if (!LDiff || !RDiff || *LDiff != *RDiff)
9388     return false;
9389
9390   if (LDiff->isMinValue())
9391     return true;
9392
9393   APInt FoundRHSLimit;
9394
9395   if (Pred == CmpInst::ICMP_ULT) {
9396     FoundRHSLimit = -(*RDiff);
9397   } else {
9398     assert(Pred == CmpInst::ICMP_SLT && "Checked above!");
9399     FoundRHSLimit = APInt::getSignedMinValue(getTypeSizeInBits(RHS->getType())) - *RDiff;
9400   }
9401
9402   // Try to prove (1) or (2), as needed.
9403   return isLoopEntryGuardedByCond(L, Pred, FoundRHS,
9404                                   getConstant(FoundRHSLimit));
9405 }
9406
9407 bool ScalarEvolution::isImpliedCondOperands(ICmpInst::Predicate Pred,
9408                                             const SCEV *LHS, const SCEV *RHS,
9409                                             const SCEV *FoundLHS,
9410                                             const SCEV *FoundRHS) {
9411   if (isImpliedCondOperandsViaRanges(Pred, LHS, RHS, FoundLHS, FoundRHS))
9412     return true;
9413
9414   if (isImpliedCondOperandsViaNoOverflow(Pred, LHS, RHS, FoundLHS, FoundRHS))
9415     return true;
9416
9417   return isImpliedCondOperandsHelper(Pred, LHS, RHS,
9418                                      FoundLHS, FoundRHS) ||
9419          // ~x < ~y --> x > y
9420          isImpliedCondOperandsHelper(Pred, LHS, RHS,
9421                                      getNotSCEV(FoundRHS),
9422                                      getNotSCEV(FoundLHS));
9423 }
9424
9425 /// If Expr computes ~A, return A else return nullptr
9426 static const SCEV *MatchNotExpr(const SCEV *Expr) {
9427   const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Expr);
9428   if (!Add || Add->getNumOperands() != 2 ||
9429       !Add->getOperand(0)->isAllOnesValue())
9430     return nullptr;
9431
9432   const SCEVMulExpr *AddRHS = dyn_cast<SCEVMulExpr>(Add->getOperand(1));
9433   if (!AddRHS || AddRHS->getNumOperands() != 2 ||
9434       !AddRHS->getOperand(0)->isAllOnesValue())
9435     return nullptr;
9436
9437   return AddRHS->getOperand(1);
9438 }
9439
9440 /// Is MaybeMaxExpr an SMax or UMax of Candidate and some other values?
9441 template<typename MaxExprType>
9442 static bool IsMaxConsistingOf(const SCEV *MaybeMaxExpr,
9443                               const SCEV *Candidate) {
9444   const MaxExprType *MaxExpr = dyn_cast<MaxExprType>(MaybeMaxExpr);
9445   if (!MaxExpr) return false;
9446
9447   return find(MaxExpr->operands(), Candidate) != MaxExpr->op_end();
9448 }
9449
9450 /// Is MaybeMinExpr an SMin or UMin of Candidate and some other values?
9451 template<typename MaxExprType>
9452 static bool IsMinConsistingOf(ScalarEvolution &SE,
9453                               const SCEV *MaybeMinExpr,
9454                               const SCEV *Candidate) {
9455   const SCEV *MaybeMaxExpr = MatchNotExpr(MaybeMinExpr);
9456   if (!MaybeMaxExpr)
9457     return false;
9458
9459   return IsMaxConsistingOf<MaxExprType>(MaybeMaxExpr, SE.getNotSCEV(Candidate));
9460 }
9461
9462 static bool IsKnownPredicateViaAddRecStart(ScalarEvolution &SE,
9463                                            ICmpInst::Predicate Pred,
9464                                            const SCEV *LHS, const SCEV *RHS) {
9465   // If both sides are affine addrecs for the same loop, with equal
9466   // steps, and we know the recurrences don't wrap, then we only
9467   // need to check the predicate on the starting values.
9468
9469   if (!ICmpInst::isRelational(Pred))
9470     return false;
9471
9472   const SCEVAddRecExpr *LAR = dyn_cast<SCEVAddRecExpr>(LHS);
9473   if (!LAR)
9474     return false;
9475   const SCEVAddRecExpr *RAR = dyn_cast<SCEVAddRecExpr>(RHS);
9476   if (!RAR)
9477     return false;
9478   if (LAR->getLoop() != RAR->getLoop())
9479     return false;
9480   if (!LAR->isAffine() || !RAR->isAffine())
9481     return false;
9482
9483   if (LAR->getStepRecurrence(SE) != RAR->getStepRecurrence(SE))
9484     return false;
9485
9486   SCEV::NoWrapFlags NW = ICmpInst::isSigned(Pred) ?
9487                          SCEV::FlagNSW : SCEV::FlagNUW;
9488   if (!LAR->getNoWrapFlags(NW) || !RAR->getNoWrapFlags(NW))
9489     return false;
9490
9491   return SE.isKnownPredicate(Pred, LAR->getStart(), RAR->getStart());
9492 }
9493
9494 /// Is LHS `Pred` RHS true on the virtue of LHS or RHS being a Min or Max
9495 /// expression?
9496 static bool IsKnownPredicateViaMinOrMax(ScalarEvolution &SE,
9497                                         ICmpInst::Predicate Pred,
9498                                         const SCEV *LHS, const SCEV *RHS) {
9499   switch (Pred) {
9500   default:
9501     return false;
9502
9503   case ICmpInst::ICMP_SGE:
9504     std::swap(LHS, RHS);
9505     LLVM_FALLTHROUGH;
9506   case ICmpInst::ICMP_SLE:
9507     return
9508       // min(A, ...) <= A
9509       IsMinConsistingOf<SCEVSMaxExpr>(SE, LHS, RHS) ||
9510       // A <= max(A, ...)
9511       IsMaxConsistingOf<SCEVSMaxExpr>(RHS, LHS);
9512
9513   case ICmpInst::ICMP_UGE:
9514     std::swap(LHS, RHS);
9515     LLVM_FALLTHROUGH;
9516   case ICmpInst::ICMP_ULE:
9517     return
9518       // min(A, ...) <= A
9519       IsMinConsistingOf<SCEVUMaxExpr>(SE, LHS, RHS) ||
9520       // A <= max(A, ...)
9521       IsMaxConsistingOf<SCEVUMaxExpr>(RHS, LHS);
9522   }
9523
9524   llvm_unreachable("covered switch fell through?!");
9525 }
9526
9527 bool ScalarEvolution::isImpliedViaOperations(ICmpInst::Predicate Pred,
9528                                              const SCEV *LHS, const SCEV *RHS,
9529                                              const SCEV *FoundLHS,
9530                                              const SCEV *FoundRHS,
9531                                              unsigned Depth) {
9532   assert(getTypeSizeInBits(LHS->getType()) ==
9533              getTypeSizeInBits(RHS->getType()) &&
9534          "LHS and RHS have different sizes?");
9535   assert(getTypeSizeInBits(FoundLHS->getType()) ==
9536              getTypeSizeInBits(FoundRHS->getType()) &&
9537          "FoundLHS and FoundRHS have different sizes?");
9538   // We want to avoid hurting the compile time with analysis of too big trees.
9539   if (Depth > MaxSCEVOperationsImplicationDepth)
9540     return false;
9541   // We only want to work with ICMP_SGT comparison so far.
9542   // TODO: Extend to ICMP_UGT?
9543   if (Pred == ICmpInst::ICMP_SLT) {
9544     Pred = ICmpInst::ICMP_SGT;
9545     std::swap(LHS, RHS);
9546     std::swap(FoundLHS, FoundRHS);
9547   }
9548   if (Pred != ICmpInst::ICMP_SGT)
9549     return false;
9550
9551   auto GetOpFromSExt = [&](const SCEV *S) {
9552     if (auto *Ext = dyn_cast<SCEVSignExtendExpr>(S))
9553       return Ext->getOperand();
9554     // TODO: If S is a SCEVConstant then you can cheaply "strip" the sext off
9555     // the constant in some cases.
9556     return S;
9557   };
9558
9559   // Acquire values from extensions.
9560   auto *OrigFoundLHS = FoundLHS;
9561   LHS = GetOpFromSExt(LHS);
9562   FoundLHS = GetOpFromSExt(FoundLHS);
9563
9564   // Is the SGT predicate can be proved trivially or using the found context.
9565   auto IsSGTViaContext = [&](const SCEV *S1, const SCEV *S2) {
9566     return isKnownViaSimpleReasoning(ICmpInst::ICMP_SGT, S1, S2) ||
9567            isImpliedViaOperations(ICmpInst::ICMP_SGT, S1, S2, OrigFoundLHS,
9568                                   FoundRHS, Depth + 1);
9569   };
9570
9571   if (auto *LHSAddExpr = dyn_cast<SCEVAddExpr>(LHS)) {
9572     // We want to avoid creation of any new non-constant SCEV. Since we are
9573     // going to compare the operands to RHS, we should be certain that we don't
9574     // need any size extensions for this. So let's decline all cases when the
9575     // sizes of types of LHS and RHS do not match.
9576     // TODO: Maybe try to get RHS from sext to catch more cases?
9577     if (getTypeSizeInBits(LHS->getType()) != getTypeSizeInBits(RHS->getType()))
9578       return false;
9579
9580     // Should not overflow.
9581     if (!LHSAddExpr->hasNoSignedWrap())
9582       return false;
9583
9584     auto *LL = LHSAddExpr->getOperand(0);
9585     auto *LR = LHSAddExpr->getOperand(1);
9586     auto *MinusOne = getNegativeSCEV(getOne(RHS->getType()));
9587
9588     // Checks that S1 >= 0 && S2 > RHS, trivially or using the found context.
9589     auto IsSumGreaterThanRHS = [&](const SCEV *S1, const SCEV *S2) {
9590       return IsSGTViaContext(S1, MinusOne) && IsSGTViaContext(S2, RHS);
9591     };
9592     // Try to prove the following rule:
9593     // (LHS = LL + LR) && (LL >= 0) && (LR > RHS) => (LHS > RHS).
9594     // (LHS = LL + LR) && (LR >= 0) && (LL > RHS) => (LHS > RHS).
9595     if (IsSumGreaterThanRHS(LL, LR) || IsSumGreaterThanRHS(LR, LL))
9596       return true;
9597   } else if (auto *LHSUnknownExpr = dyn_cast<SCEVUnknown>(LHS)) {
9598     Value *LL, *LR;
9599     // FIXME: Once we have SDiv implemented, we can get rid of this matching.
9600
9601     using namespace llvm::PatternMatch;
9602
9603     if (match(LHSUnknownExpr->getValue(), m_SDiv(m_Value(LL), m_Value(LR)))) {
9604       // Rules for division.
9605       // We are going to perform some comparisons with Denominator and its
9606       // derivative expressions. In general case, creating a SCEV for it may
9607       // lead to a complex analysis of the entire graph, and in particular it
9608       // can request trip count recalculation for the same loop. This would
9609       // cache as SCEVCouldNotCompute to avoid the infinite recursion. To avoid
9610       // this, we only want to create SCEVs that are constants in this section.
9611       // So we bail if Denominator is not a constant.
9612       if (!isa<ConstantInt>(LR))
9613         return false;
9614
9615       auto *Denominator = cast<SCEVConstant>(getSCEV(LR));
9616
9617       // We want to make sure that LHS = FoundLHS / Denominator. If it is so,
9618       // then a SCEV for the numerator already exists and matches with FoundLHS.
9619       auto *Numerator = getExistingSCEV(LL);
9620       if (!Numerator || Numerator->getType() != FoundLHS->getType())
9621         return false;
9622
9623       // Make sure that the numerator matches with FoundLHS and the denominator
9624       // is positive.
9625       if (!HasSameValue(Numerator, FoundLHS) || !isKnownPositive(Denominator))
9626         return false;
9627
9628       auto *DTy = Denominator->getType();
9629       auto *FRHSTy = FoundRHS->getType();
9630       if (DTy->isPointerTy() != FRHSTy->isPointerTy())
9631         // One of types is a pointer and another one is not. We cannot extend
9632         // them properly to a wider type, so let us just reject this case.
9633         // TODO: Usage of getEffectiveSCEVType for DTy, FRHSTy etc should help
9634         // to avoid this check.
9635         return false;
9636
9637       // Given that:
9638       // FoundLHS > FoundRHS, LHS = FoundLHS / Denominator, Denominator > 0.
9639       auto *WTy = getWiderType(DTy, FRHSTy);
9640       auto *DenominatorExt = getNoopOrSignExtend(Denominator, WTy);
9641       auto *FoundRHSExt = getNoopOrSignExtend(FoundRHS, WTy);
9642
9643       // Try to prove the following rule:
9644       // (FoundRHS > Denominator - 2) && (RHS <= 0) => (LHS > RHS).
9645       // For example, given that FoundLHS > 2. It means that FoundLHS is at
9646       // least 3. If we divide it by Denominator < 4, we will have at least 1.
9647       auto *DenomMinusTwo = getMinusSCEV(DenominatorExt, getConstant(WTy, 2));
9648       if (isKnownNonPositive(RHS) &&
9649           IsSGTViaContext(FoundRHSExt, DenomMinusTwo))
9650         return true;
9651
9652       // Try to prove the following rule:
9653       // (FoundRHS > -1 - Denominator) && (RHS < 0) => (LHS > RHS).
9654       // For example, given that FoundLHS > -3. Then FoundLHS is at least -2.
9655       // If we divide it by Denominator > 2, then:
9656       // 1. If FoundLHS is negative, then the result is 0.
9657       // 2. If FoundLHS is non-negative, then the result is non-negative.
9658       // Anyways, the result is non-negative.
9659       auto *MinusOne = getNegativeSCEV(getOne(WTy));
9660       auto *NegDenomMinusOne = getMinusSCEV(MinusOne, DenominatorExt);
9661       if (isKnownNegative(RHS) &&
9662           IsSGTViaContext(FoundRHSExt, NegDenomMinusOne))
9663         return true;
9664     }
9665   }
9666
9667   return false;
9668 }
9669
9670 bool
9671 ScalarEvolution::isKnownViaSimpleReasoning(ICmpInst::Predicate Pred,
9672                                            const SCEV *LHS, const SCEV *RHS) {
9673   return isKnownPredicateViaConstantRanges(Pred, LHS, RHS) ||
9674          IsKnownPredicateViaMinOrMax(*this, Pred, LHS, RHS) ||
9675          IsKnownPredicateViaAddRecStart(*this, Pred, LHS, RHS) ||
9676          isKnownPredicateViaNoOverflow(Pred, LHS, RHS);
9677 }
9678
9679 bool
9680 ScalarEvolution::isImpliedCondOperandsHelper(ICmpInst::Predicate Pred,
9681                                              const SCEV *LHS, const SCEV *RHS,
9682                                              const SCEV *FoundLHS,
9683                                              const SCEV *FoundRHS) {
9684   switch (Pred) {
9685   default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
9686   case ICmpInst::ICMP_EQ:
9687   case ICmpInst::ICMP_NE:
9688     if (HasSameValue(LHS, FoundLHS) && HasSameValue(RHS, FoundRHS))
9689       return true;
9690     break;
9691   case ICmpInst::ICMP_SLT:
9692   case ICmpInst::ICMP_SLE:
9693     if (isKnownViaSimpleReasoning(ICmpInst::ICMP_SLE, LHS, FoundLHS) &&
9694         isKnownViaSimpleReasoning(ICmpInst::ICMP_SGE, RHS, FoundRHS))
9695       return true;
9696     break;
9697   case ICmpInst::ICMP_SGT:
9698   case ICmpInst::ICMP_SGE:
9699     if (isKnownViaSimpleReasoning(ICmpInst::ICMP_SGE, LHS, FoundLHS) &&
9700         isKnownViaSimpleReasoning(ICmpInst::ICMP_SLE, RHS, FoundRHS))
9701       return true;
9702     break;
9703   case ICmpInst::ICMP_ULT:
9704   case ICmpInst::ICMP_ULE:
9705     if (isKnownViaSimpleReasoning(ICmpInst::ICMP_ULE, LHS, FoundLHS) &&
9706         isKnownViaSimpleReasoning(ICmpInst::ICMP_UGE, RHS, FoundRHS))
9707       return true;
9708     break;
9709   case ICmpInst::ICMP_UGT:
9710   case ICmpInst::ICMP_UGE:
9711     if (isKnownViaSimpleReasoning(ICmpInst::ICMP_UGE, LHS, FoundLHS) &&
9712         isKnownViaSimpleReasoning(ICmpInst::ICMP_ULE, RHS, FoundRHS))
9713       return true;
9714     break;
9715   }
9716
9717   // Maybe it can be proved via operations?
9718   if (isImpliedViaOperations(Pred, LHS, RHS, FoundLHS, FoundRHS))
9719     return true;
9720
9721   return false;
9722 }
9723
9724 bool ScalarEvolution::isImpliedCondOperandsViaRanges(ICmpInst::Predicate Pred,
9725                                                      const SCEV *LHS,
9726                                                      const SCEV *RHS,
9727                                                      const SCEV *FoundLHS,
9728                                                      const SCEV *FoundRHS) {
9729   if (!isa<SCEVConstant>(RHS) || !isa<SCEVConstant>(FoundRHS))
9730     // The restriction on `FoundRHS` be lifted easily -- it exists only to
9731     // reduce the compile time impact of this optimization.
9732     return false;
9733
9734   Optional<APInt> Addend = computeConstantDifference(LHS, FoundLHS);
9735   if (!Addend)
9736     return false;
9737
9738   const APInt &ConstFoundRHS = cast<SCEVConstant>(FoundRHS)->getAPInt();
9739
9740   // `FoundLHSRange` is the range we know `FoundLHS` to be in by virtue of the
9741   // antecedent "`FoundLHS` `Pred` `FoundRHS`".
9742   ConstantRange FoundLHSRange =
9743       ConstantRange::makeAllowedICmpRegion(Pred, ConstFoundRHS);
9744
9745   // Since `LHS` is `FoundLHS` + `Addend`, we can compute a range for `LHS`:
9746   ConstantRange LHSRange = FoundLHSRange.add(ConstantRange(*Addend));
9747
9748   // We can also compute the range of values for `LHS` that satisfy the
9749   // consequent, "`LHS` `Pred` `RHS`":
9750   const APInt &ConstRHS = cast<SCEVConstant>(RHS)->getAPInt();
9751   ConstantRange SatisfyingLHSRange =
9752       ConstantRange::makeSatisfyingICmpRegion(Pred, ConstRHS);
9753
9754   // The antecedent implies the consequent if every value of `LHS` that
9755   // satisfies the antecedent also satisfies the consequent.
9756   return SatisfyingLHSRange.contains(LHSRange);
9757 }
9758
9759 bool ScalarEvolution::doesIVOverflowOnLT(const SCEV *RHS, const SCEV *Stride,
9760                                          bool IsSigned, bool NoWrap) {
9761   assert(isKnownPositive(Stride) && "Positive stride expected!");
9762
9763   if (NoWrap) return false;
9764
9765   unsigned BitWidth = getTypeSizeInBits(RHS->getType());
9766   const SCEV *One = getOne(Stride->getType());
9767
9768   if (IsSigned) {
9769     APInt MaxRHS = getSignedRangeMax(RHS);
9770     APInt MaxValue = APInt::getSignedMaxValue(BitWidth);
9771     APInt MaxStrideMinusOne = getSignedRangeMax(getMinusSCEV(Stride, One));
9772
9773     // SMaxRHS + SMaxStrideMinusOne > SMaxValue => overflow!
9774     return (std::move(MaxValue) - MaxStrideMinusOne).slt(MaxRHS);
9775   }
9776
9777   APInt MaxRHS = getUnsignedRangeMax(RHS);
9778   APInt MaxValue = APInt::getMaxValue(BitWidth);
9779   APInt MaxStrideMinusOne = getUnsignedRangeMax(getMinusSCEV(Stride, One));
9780
9781   // UMaxRHS + UMaxStrideMinusOne > UMaxValue => overflow!
9782   return (std::move(MaxValue) - MaxStrideMinusOne).ult(MaxRHS);
9783 }
9784
9785 bool ScalarEvolution::doesIVOverflowOnGT(const SCEV *RHS, const SCEV *Stride,
9786                                          bool IsSigned, bool NoWrap) {
9787   if (NoWrap) return false;
9788
9789   unsigned BitWidth = getTypeSizeInBits(RHS->getType());
9790   const SCEV *One = getOne(Stride->getType());
9791
9792   if (IsSigned) {
9793     APInt MinRHS = getSignedRangeMin(RHS);
9794     APInt MinValue = APInt::getSignedMinValue(BitWidth);
9795     APInt MaxStrideMinusOne = getSignedRangeMax(getMinusSCEV(Stride, One));
9796
9797     // SMinRHS - SMaxStrideMinusOne < SMinValue => overflow!
9798     return (std::move(MinValue) + MaxStrideMinusOne).sgt(MinRHS);
9799   }
9800
9801   APInt MinRHS = getUnsignedRangeMin(RHS);
9802   APInt MinValue = APInt::getMinValue(BitWidth);
9803   APInt MaxStrideMinusOne = getUnsignedRangeMax(getMinusSCEV(Stride, One));
9804
9805   // UMinRHS - UMaxStrideMinusOne < UMinValue => overflow!
9806   return (std::move(MinValue) + MaxStrideMinusOne).ugt(MinRHS);
9807 }
9808
9809 const SCEV *ScalarEvolution::computeBECount(const SCEV *Delta, const SCEV *Step,
9810                                             bool Equality) {
9811   const SCEV *One = getOne(Step->getType());
9812   Delta = Equality ? getAddExpr(Delta, Step)
9813                    : getAddExpr(Delta, getMinusSCEV(Step, One));
9814   return getUDivExpr(Delta, Step);
9815 }
9816
9817 const SCEV *ScalarEvolution::computeMaxBECountForLT(const SCEV *Start,
9818                                                     const SCEV *Stride,
9819                                                     const SCEV *End,
9820                                                     unsigned BitWidth,
9821                                                     bool IsSigned) {
9822
9823   assert(!isKnownNonPositive(Stride) &&
9824          "Stride is expected strictly positive!");
9825   // Calculate the maximum backedge count based on the range of values
9826   // permitted by Start, End, and Stride.
9827   const SCEV *MaxBECount;
9828   APInt MinStart =
9829       IsSigned ? getSignedRangeMin(Start) : getUnsignedRangeMin(Start);
9830
9831   APInt StrideForMaxBECount =
9832       IsSigned ? getSignedRangeMin(Stride) : getUnsignedRangeMin(Stride);
9833
9834   // We already know that the stride is positive, so we paper over conservatism
9835   // in our range computation by forcing StrideForMaxBECount to be at least one.
9836   // In theory this is unnecessary, but we expect MaxBECount to be a
9837   // SCEVConstant, and (udiv <constant> 0) is not constant folded by SCEV (there
9838   // is nothing to constant fold it to).
9839   APInt One(BitWidth, 1, IsSigned);
9840   StrideForMaxBECount = APIntOps::smax(One, StrideForMaxBECount);
9841
9842   APInt MaxValue = IsSigned ? APInt::getSignedMaxValue(BitWidth)
9843                             : APInt::getMaxValue(BitWidth);
9844   APInt Limit = MaxValue - (StrideForMaxBECount - 1);
9845
9846   // Although End can be a MAX expression we estimate MaxEnd considering only
9847   // the case End = RHS of the loop termination condition. This is safe because
9848   // in the other case (End - Start) is zero, leading to a zero maximum backedge
9849   // taken count.
9850   APInt MaxEnd = IsSigned ? APIntOps::smin(getSignedRangeMax(End), Limit)
9851                           : APIntOps::umin(getUnsignedRangeMax(End), Limit);
9852
9853   MaxBECount = computeBECount(getConstant(MaxEnd - MinStart) /* Delta */,
9854                               getConstant(StrideForMaxBECount) /* Step */,
9855                               false /* Equality */);
9856
9857   return MaxBECount;
9858 }
9859
9860 ScalarEvolution::ExitLimit
9861 ScalarEvolution::howManyLessThans(const SCEV *LHS, const SCEV *RHS,
9862                                   const Loop *L, bool IsSigned,
9863                                   bool ControlsExit, bool AllowPredicates) {
9864   SmallPtrSet<const SCEVPredicate *, 4> Predicates;
9865
9866   const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS);
9867   bool PredicatedIV = false;
9868
9869   if (!IV && AllowPredicates) {
9870     // Try to make this an AddRec using runtime tests, in the first X
9871     // iterations of this loop, where X is the SCEV expression found by the
9872     // algorithm below.
9873     IV = convertSCEVToAddRecWithPredicates(LHS, L, Predicates);
9874     PredicatedIV = true;
9875   }
9876
9877   // Avoid weird loops
9878   if (!IV || IV->getLoop() != L || !IV->isAffine())
9879     return getCouldNotCompute();
9880
9881   bool NoWrap = ControlsExit &&
9882                 IV->getNoWrapFlags(IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW);
9883
9884   const SCEV *Stride = IV->getStepRecurrence(*this);
9885
9886   bool PositiveStride = isKnownPositive(Stride);
9887
9888   // Avoid negative or zero stride values.
9889   if (!PositiveStride) {
9890     // We can compute the correct backedge taken count for loops with unknown
9891     // strides if we can prove that the loop is not an infinite loop with side
9892     // effects. Here's the loop structure we are trying to handle -
9893     //
9894     // i = start
9895     // do {
9896     //   A[i] = i;
9897     //   i += s;
9898     // } while (i < end);
9899     //
9900     // The backedge taken count for such loops is evaluated as -
9901     // (max(end, start + stride) - start - 1) /u stride
9902     //
9903     // The additional preconditions that we need to check to prove correctness
9904     // of the above formula is as follows -
9905     //
9906     // a) IV is either nuw or nsw depending upon signedness (indicated by the
9907     //    NoWrap flag).
9908     // b) loop is single exit with no side effects.
9909     //
9910     //
9911     // Precondition a) implies that if the stride is negative, this is a single
9912     // trip loop. The backedge taken count formula reduces to zero in this case.
9913     //
9914     // Precondition b) implies that the unknown stride cannot be zero otherwise
9915     // we have UB.
9916     //
9917     // The positive stride case is the same as isKnownPositive(Stride) returning
9918     // true (original behavior of the function).
9919     //
9920     // We want to make sure that the stride is truly unknown as there are edge
9921     // cases where ScalarEvolution propagates no wrap flags to the
9922     // post-increment/decrement IV even though the increment/decrement operation
9923     // itself is wrapping. The computed backedge taken count may be wrong in
9924     // such cases. This is prevented by checking that the stride is not known to
9925     // be either positive or non-positive. For example, no wrap flags are
9926     // propagated to the post-increment IV of this loop with a trip count of 2 -
9927     //
9928     // unsigned char i;
9929     // for(i=127; i<128; i+=129)
9930     //   A[i] = i;
9931     //
9932     if (PredicatedIV || !NoWrap || isKnownNonPositive(Stride) ||
9933         !loopHasNoSideEffects(L))
9934       return getCouldNotCompute();
9935   } else if (!Stride->isOne() &&
9936              doesIVOverflowOnLT(RHS, Stride, IsSigned, NoWrap))
9937     // Avoid proven overflow cases: this will ensure that the backedge taken
9938     // count will not generate any unsigned overflow. Relaxed no-overflow
9939     // conditions exploit NoWrapFlags, allowing to optimize in presence of
9940     // undefined behaviors like the case of C language.
9941     return getCouldNotCompute();
9942
9943   ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SLT
9944                                       : ICmpInst::ICMP_ULT;
9945   const SCEV *Start = IV->getStart();
9946   const SCEV *End = RHS;
9947   // When the RHS is not invariant, we do not know the end bound of the loop and
9948   // cannot calculate the ExactBECount needed by ExitLimit. However, we can
9949   // calculate the MaxBECount, given the start, stride and max value for the end
9950   // bound of the loop (RHS), and the fact that IV does not overflow (which is
9951   // checked above).
9952   if (!isLoopInvariant(RHS, L)) {
9953     const SCEV *MaxBECount = computeMaxBECountForLT(
9954         Start, Stride, RHS, getTypeSizeInBits(LHS->getType()), IsSigned);
9955     return ExitLimit(getCouldNotCompute() /* ExactNotTaken */, MaxBECount,
9956                      false /*MaxOrZero*/, Predicates);
9957   }
9958   // If the backedge is taken at least once, then it will be taken
9959   // (End-Start)/Stride times (rounded up to a multiple of Stride), where Start
9960   // is the LHS value of the less-than comparison the first time it is evaluated
9961   // and End is the RHS.
9962   const SCEV *BECountIfBackedgeTaken =
9963     computeBECount(getMinusSCEV(End, Start), Stride, false);
9964   // If the loop entry is guarded by the result of the backedge test of the
9965   // first loop iteration, then we know the backedge will be taken at least
9966   // once and so the backedge taken count is as above. If not then we use the
9967   // expression (max(End,Start)-Start)/Stride to describe the backedge count,
9968   // as if the backedge is taken at least once max(End,Start) is End and so the
9969   // result is as above, and if not max(End,Start) is Start so we get a backedge
9970   // count of zero.
9971   const SCEV *BECount;
9972   if (isLoopEntryGuardedByCond(L, Cond, getMinusSCEV(Start, Stride), RHS))
9973     BECount = BECountIfBackedgeTaken;
9974   else {
9975     End = IsSigned ? getSMaxExpr(RHS, Start) : getUMaxExpr(RHS, Start);
9976     BECount = computeBECount(getMinusSCEV(End, Start), Stride, false);
9977   }
9978
9979   const SCEV *MaxBECount;
9980   bool MaxOrZero = false;
9981   if (isa<SCEVConstant>(BECount))
9982     MaxBECount = BECount;
9983   else if (isa<SCEVConstant>(BECountIfBackedgeTaken)) {
9984     // If we know exactly how many times the backedge will be taken if it's
9985     // taken at least once, then the backedge count will either be that or
9986     // zero.
9987     MaxBECount = BECountIfBackedgeTaken;
9988     MaxOrZero = true;
9989   } else {
9990     MaxBECount = computeMaxBECountForLT(
9991         Start, Stride, RHS, getTypeSizeInBits(LHS->getType()), IsSigned);
9992   }
9993
9994   if (isa<SCEVCouldNotCompute>(MaxBECount) &&
9995       !isa<SCEVCouldNotCompute>(BECount))
9996     MaxBECount = getConstant(getUnsignedRangeMax(BECount));
9997
9998   return ExitLimit(BECount, MaxBECount, MaxOrZero, Predicates);
9999 }
10000
10001 ScalarEvolution::ExitLimit
10002 ScalarEvolution::howManyGreaterThans(const SCEV *LHS, const SCEV *RHS,
10003                                      const Loop *L, bool IsSigned,
10004                                      bool ControlsExit, bool AllowPredicates) {
10005   SmallPtrSet<const SCEVPredicate *, 4> Predicates;
10006   // We handle only IV > Invariant
10007   if (!isLoopInvariant(RHS, L))
10008     return getCouldNotCompute();
10009
10010   const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS);
10011   if (!IV && AllowPredicates)
10012     // Try to make this an AddRec using runtime tests, in the first X
10013     // iterations of this loop, where X is the SCEV expression found by the
10014     // algorithm below.
10015     IV = convertSCEVToAddRecWithPredicates(LHS, L, Predicates);
10016
10017   // Avoid weird loops
10018   if (!IV || IV->getLoop() != L || !IV->isAffine())
10019     return getCouldNotCompute();
10020
10021   bool NoWrap = ControlsExit &&
10022                 IV->getNoWrapFlags(IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW);
10023
10024   const SCEV *Stride = getNegativeSCEV(IV->getStepRecurrence(*this));
10025
10026   // Avoid negative or zero stride values
10027   if (!isKnownPositive(Stride))
10028     return getCouldNotCompute();
10029
10030   // Avoid proven overflow cases: this will ensure that the backedge taken count
10031   // will not generate any unsigned overflow. Relaxed no-overflow conditions
10032   // exploit NoWrapFlags, allowing to optimize in presence of undefined
10033   // behaviors like the case of C language.
10034   if (!Stride->isOne() && doesIVOverflowOnGT(RHS, Stride, IsSigned, NoWrap))
10035     return getCouldNotCompute();
10036
10037   ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SGT
10038                                       : ICmpInst::ICMP_UGT;
10039
10040   const SCEV *Start = IV->getStart();
10041   const SCEV *End = RHS;
10042   if (!isLoopEntryGuardedByCond(L, Cond, getAddExpr(Start, Stride), RHS))
10043     End = IsSigned ? getSMinExpr(RHS, Start) : getUMinExpr(RHS, Start);
10044
10045   const SCEV *BECount = computeBECount(getMinusSCEV(Start, End), Stride, false);
10046
10047   APInt MaxStart = IsSigned ? getSignedRangeMax(Start)
10048                             : getUnsignedRangeMax(Start);
10049
10050   APInt MinStride = IsSigned ? getSignedRangeMin(Stride)
10051                              : getUnsignedRangeMin(Stride);
10052
10053   unsigned BitWidth = getTypeSizeInBits(LHS->getType());
10054   APInt Limit = IsSigned ? APInt::getSignedMinValue(BitWidth) + (MinStride - 1)
10055                          : APInt::getMinValue(BitWidth) + (MinStride - 1);
10056
10057   // Although End can be a MIN expression we estimate MinEnd considering only
10058   // the case End = RHS. This is safe because in the other case (Start - End)
10059   // is zero, leading to a zero maximum backedge taken count.
10060   APInt MinEnd =
10061     IsSigned ? APIntOps::smax(getSignedRangeMin(RHS), Limit)
10062              : APIntOps::umax(getUnsignedRangeMin(RHS), Limit);
10063
10064
10065   const SCEV *MaxBECount = getCouldNotCompute();
10066   if (isa<SCEVConstant>(BECount))
10067     MaxBECount = BECount;
10068   else
10069     MaxBECount = computeBECount(getConstant(MaxStart - MinEnd),
10070                                 getConstant(MinStride), false);
10071
10072   if (isa<SCEVCouldNotCompute>(MaxBECount))
10073     MaxBECount = BECount;
10074
10075   return ExitLimit(BECount, MaxBECount, false, Predicates);
10076 }
10077
10078 const SCEV *SCEVAddRecExpr::getNumIterationsInRange(const ConstantRange &Range,
10079                                                     ScalarEvolution &SE) const {
10080   if (Range.isFullSet())  // Infinite loop.
10081     return SE.getCouldNotCompute();
10082
10083   // If the start is a non-zero constant, shift the range to simplify things.
10084   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(getStart()))
10085     if (!SC->getValue()->isZero()) {
10086       SmallVector<const SCEV *, 4> Operands(op_begin(), op_end());
10087       Operands[0] = SE.getZero(SC->getType());
10088       const SCEV *Shifted = SE.getAddRecExpr(Operands, getLoop(),
10089                                              getNoWrapFlags(FlagNW));
10090       if (const auto *ShiftedAddRec = dyn_cast<SCEVAddRecExpr>(Shifted))
10091         return ShiftedAddRec->getNumIterationsInRange(
10092             Range.subtract(SC->getAPInt()), SE);
10093       // This is strange and shouldn't happen.
10094       return SE.getCouldNotCompute();
10095     }
10096
10097   // The only time we can solve this is when we have all constant indices.
10098   // Otherwise, we cannot determine the overflow conditions.
10099   if (any_of(operands(), [](const SCEV *Op) { return !isa<SCEVConstant>(Op); }))
10100     return SE.getCouldNotCompute();
10101
10102   // Okay at this point we know that all elements of the chrec are constants and
10103   // that the start element is zero.
10104
10105   // First check to see if the range contains zero.  If not, the first
10106   // iteration exits.
10107   unsigned BitWidth = SE.getTypeSizeInBits(getType());
10108   if (!Range.contains(APInt(BitWidth, 0)))
10109     return SE.getZero(getType());
10110
10111   if (isAffine()) {
10112     // If this is an affine expression then we have this situation:
10113     //   Solve {0,+,A} in Range  ===  Ax in Range
10114
10115     // We know that zero is in the range.  If A is positive then we know that
10116     // the upper value of the range must be the first possible exit value.
10117     // If A is negative then the lower of the range is the last possible loop
10118     // value.  Also note that we already checked for a full range.
10119     APInt A = cast<SCEVConstant>(getOperand(1))->getAPInt();
10120     APInt End = A.sge(1) ? (Range.getUpper() - 1) : Range.getLower();
10121
10122     // The exit value should be (End+A)/A.
10123     APInt ExitVal = (End + A).udiv(A);
10124     ConstantInt *ExitValue = ConstantInt::get(SE.getContext(), ExitVal);
10125
10126     // Evaluate at the exit value.  If we really did fall out of the valid
10127     // range, then we computed our trip count, otherwise wrap around or other
10128     // things must have happened.
10129     ConstantInt *Val = EvaluateConstantChrecAtConstant(this, ExitValue, SE);
10130     if (Range.contains(Val->getValue()))
10131       return SE.getCouldNotCompute();  // Something strange happened
10132
10133     // Ensure that the previous value is in the range.  This is a sanity check.
10134     assert(Range.contains(
10135            EvaluateConstantChrecAtConstant(this,
10136            ConstantInt::get(SE.getContext(), ExitVal - 1), SE)->getValue()) &&
10137            "Linear scev computation is off in a bad way!");
10138     return SE.getConstant(ExitValue);
10139   } else if (isQuadratic()) {
10140     // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of the
10141     // quadratic equation to solve it.  To do this, we must frame our problem in
10142     // terms of figuring out when zero is crossed, instead of when
10143     // Range.getUpper() is crossed.
10144     SmallVector<const SCEV *, 4> NewOps(op_begin(), op_end());
10145     NewOps[0] = SE.getNegativeSCEV(SE.getConstant(Range.getUpper()));
10146     const SCEV *NewAddRec = SE.getAddRecExpr(NewOps, getLoop(), FlagAnyWrap);
10147
10148     // Next, solve the constructed addrec
10149     if (auto Roots =
10150             SolveQuadraticEquation(cast<SCEVAddRecExpr>(NewAddRec), SE)) {
10151       const SCEVConstant *R1 = Roots->first;
10152       const SCEVConstant *R2 = Roots->second;
10153       // Pick the smallest positive root value.
10154       if (ConstantInt *CB = dyn_cast<ConstantInt>(ConstantExpr::getICmp(
10155               ICmpInst::ICMP_ULT, R1->getValue(), R2->getValue()))) {
10156         if (!CB->getZExtValue())
10157           std::swap(R1, R2); // R1 is the minimum root now.
10158
10159         // Make sure the root is not off by one.  The returned iteration should
10160         // not be in the range, but the previous one should be.  When solving
10161         // for "X*X < 5", for example, we should not return a root of 2.
10162         ConstantInt *R1Val =
10163             EvaluateConstantChrecAtConstant(this, R1->getValue(), SE);
10164         if (Range.contains(R1Val->getValue())) {
10165           // The next iteration must be out of the range...
10166           ConstantInt *NextVal =
10167               ConstantInt::get(SE.getContext(), R1->getAPInt() + 1);
10168
10169           R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
10170           if (!Range.contains(R1Val->getValue()))
10171             return SE.getConstant(NextVal);
10172           return SE.getCouldNotCompute(); // Something strange happened
10173         }
10174
10175         // If R1 was not in the range, then it is a good return value.  Make
10176         // sure that R1-1 WAS in the range though, just in case.
10177         ConstantInt *NextVal =
10178             ConstantInt::get(SE.getContext(), R1->getAPInt() - 1);
10179         R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
10180         if (Range.contains(R1Val->getValue()))
10181           return R1;
10182         return SE.getCouldNotCompute(); // Something strange happened
10183       }
10184     }
10185   }
10186
10187   return SE.getCouldNotCompute();
10188 }
10189
10190 // Return true when S contains at least an undef value.
10191 static inline bool containsUndefs(const SCEV *S) {
10192   return SCEVExprContains(S, [](const SCEV *S) {
10193     if (const auto *SU = dyn_cast<SCEVUnknown>(S))
10194       return isa<UndefValue>(SU->getValue());
10195     else if (const auto *SC = dyn_cast<SCEVConstant>(S))
10196       return isa<UndefValue>(SC->getValue());
10197     return false;
10198   });
10199 }
10200
10201 namespace {
10202
10203 // Collect all steps of SCEV expressions.
10204 struct SCEVCollectStrides {
10205   ScalarEvolution &SE;
10206   SmallVectorImpl<const SCEV *> &Strides;
10207
10208   SCEVCollectStrides(ScalarEvolution &SE, SmallVectorImpl<const SCEV *> &S)
10209       : SE(SE), Strides(S) {}
10210
10211   bool follow(const SCEV *S) {
10212     if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S))
10213       Strides.push_back(AR->getStepRecurrence(SE));
10214     return true;
10215   }
10216
10217   bool isDone() const { return false; }
10218 };
10219
10220 // Collect all SCEVUnknown and SCEVMulExpr expressions.
10221 struct SCEVCollectTerms {
10222   SmallVectorImpl<const SCEV *> &Terms;
10223
10224   SCEVCollectTerms(SmallVectorImpl<const SCEV *> &T) : Terms(T) {}
10225
10226   bool follow(const SCEV *S) {
10227     if (isa<SCEVUnknown>(S) || isa<SCEVMulExpr>(S) ||
10228         isa<SCEVSignExtendExpr>(S)) {
10229       if (!containsUndefs(S))
10230         Terms.push_back(S);
10231
10232       // Stop recursion: once we collected a term, do not walk its operands.
10233       return false;
10234     }
10235
10236     // Keep looking.
10237     return true;
10238   }
10239
10240   bool isDone() const { return false; }
10241 };
10242
10243 // Check if a SCEV contains an AddRecExpr.
10244 struct SCEVHasAddRec {
10245   bool &ContainsAddRec;
10246
10247   SCEVHasAddRec(bool &ContainsAddRec) : ContainsAddRec(ContainsAddRec) {
10248     ContainsAddRec = false;
10249   }
10250
10251   bool follow(const SCEV *S) {
10252     if (isa<SCEVAddRecExpr>(S)) {
10253       ContainsAddRec = true;
10254
10255       // Stop recursion: once we collected a term, do not walk its operands.
10256       return false;
10257     }
10258
10259     // Keep looking.
10260     return true;
10261   }
10262
10263   bool isDone() const { return false; }
10264 };
10265
10266 // Find factors that are multiplied with an expression that (possibly as a
10267 // subexpression) contains an AddRecExpr. In the expression:
10268 //
10269 //  8 * (100 +  %p * %q * (%a + {0, +, 1}_loop))
10270 //
10271 // "%p * %q" are factors multiplied by the expression "(%a + {0, +, 1}_loop)"
10272 // that contains the AddRec {0, +, 1}_loop. %p * %q are likely to be array size
10273 // parameters as they form a product with an induction variable.
10274 //
10275 // This collector expects all array size parameters to be in the same MulExpr.
10276 // It might be necessary to later add support for collecting parameters that are
10277 // spread over different nested MulExpr.
10278 struct SCEVCollectAddRecMultiplies {
10279   SmallVectorImpl<const SCEV *> &Terms;
10280   ScalarEvolution &SE;
10281
10282   SCEVCollectAddRecMultiplies(SmallVectorImpl<const SCEV *> &T, ScalarEvolution &SE)
10283       : Terms(T), SE(SE) {}
10284
10285   bool follow(const SCEV *S) {
10286     if (auto *Mul = dyn_cast<SCEVMulExpr>(S)) {
10287       bool HasAddRec = false;
10288       SmallVector<const SCEV *, 0> Operands;
10289       for (auto Op : Mul->operands()) {
10290         const SCEVUnknown *Unknown = dyn_cast<SCEVUnknown>(Op);
10291         if (Unknown && !isa<CallInst>(Unknown->getValue())) {
10292           Operands.push_back(Op);
10293         } else if (Unknown) {
10294           HasAddRec = true;
10295         } else {
10296           bool ContainsAddRec;
10297           SCEVHasAddRec ContiansAddRec(ContainsAddRec);
10298           visitAll(Op, ContiansAddRec);
10299           HasAddRec |= ContainsAddRec;
10300         }
10301       }
10302       if (Operands.size() == 0)
10303         return true;
10304
10305       if (!HasAddRec)
10306         return false;
10307
10308       Terms.push_back(SE.getMulExpr(Operands));
10309       // Stop recursion: once we collected a term, do not walk its operands.
10310       return false;
10311     }
10312
10313     // Keep looking.
10314     return true;
10315   }
10316
10317   bool isDone() const { return false; }
10318 };
10319
10320 } // end anonymous namespace
10321
10322 /// Find parametric terms in this SCEVAddRecExpr. We first for parameters in
10323 /// two places:
10324 ///   1) The strides of AddRec expressions.
10325 ///   2) Unknowns that are multiplied with AddRec expressions.
10326 void ScalarEvolution::collectParametricTerms(const SCEV *Expr,
10327     SmallVectorImpl<const SCEV *> &Terms) {
10328   SmallVector<const SCEV *, 4> Strides;
10329   SCEVCollectStrides StrideCollector(*this, Strides);
10330   visitAll(Expr, StrideCollector);
10331
10332   DEBUG({
10333       dbgs() << "Strides:\n";
10334       for (const SCEV *S : Strides)
10335         dbgs() << *S << "\n";
10336     });
10337
10338   for (const SCEV *S : Strides) {
10339     SCEVCollectTerms TermCollector(Terms);
10340     visitAll(S, TermCollector);
10341   }
10342
10343   DEBUG({
10344       dbgs() << "Terms:\n";
10345       for (const SCEV *T : Terms)
10346         dbgs() << *T << "\n";
10347     });
10348
10349   SCEVCollectAddRecMultiplies MulCollector(Terms, *this);
10350   visitAll(Expr, MulCollector);
10351 }
10352
10353 static bool findArrayDimensionsRec(ScalarEvolution &SE,
10354                                    SmallVectorImpl<const SCEV *> &Terms,
10355                                    SmallVectorImpl<const SCEV *> &Sizes) {
10356   int Last = Terms.size() - 1;
10357   const SCEV *Step = Terms[Last];
10358
10359   // End of recursion.
10360   if (Last == 0) {
10361     if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(Step)) {
10362       SmallVector<const SCEV *, 2> Qs;
10363       for (const SCEV *Op : M->operands())
10364         if (!isa<SCEVConstant>(Op))
10365           Qs.push_back(Op);
10366
10367       Step = SE.getMulExpr(Qs);
10368     }
10369
10370     Sizes.push_back(Step);
10371     return true;
10372   }
10373
10374   for (const SCEV *&Term : Terms) {
10375     // Normalize the terms before the next call to findArrayDimensionsRec.
10376     const SCEV *Q, *R;
10377     SCEVDivision::divide(SE, Term, Step, &Q, &R);
10378
10379     // Bail out when GCD does not evenly divide one of the terms.
10380     if (!R->isZero())
10381       return false;
10382
10383     Term = Q;
10384   }
10385
10386   // Remove all SCEVConstants.
10387   Terms.erase(
10388       remove_if(Terms, [](const SCEV *E) { return isa<SCEVConstant>(E); }),
10389       Terms.end());
10390
10391   if (Terms.size() > 0)
10392     if (!findArrayDimensionsRec(SE, Terms, Sizes))
10393       return false;
10394
10395   Sizes.push_back(Step);
10396   return true;
10397 }
10398
10399 // Returns true when one of the SCEVs of Terms contains a SCEVUnknown parameter.
10400 static inline bool containsParameters(SmallVectorImpl<const SCEV *> &Terms) {
10401   for (const SCEV *T : Terms)
10402     if (SCEVExprContains(T, isa<SCEVUnknown, const SCEV *>))
10403       return true;
10404   return false;
10405 }
10406
10407 // Return the number of product terms in S.
10408 static inline int numberOfTerms(const SCEV *S) {
10409   if (const SCEVMulExpr *Expr = dyn_cast<SCEVMulExpr>(S))
10410     return Expr->getNumOperands();
10411   return 1;
10412 }
10413
10414 static const SCEV *removeConstantFactors(ScalarEvolution &SE, const SCEV *T) {
10415   if (isa<SCEVConstant>(T))
10416     return nullptr;
10417
10418   if (isa<SCEVUnknown>(T))
10419     return T;
10420
10421   if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(T)) {
10422     SmallVector<const SCEV *, 2> Factors;
10423     for (const SCEV *Op : M->operands())
10424       if (!isa<SCEVConstant>(Op))
10425         Factors.push_back(Op);
10426
10427     return SE.getMulExpr(Factors);
10428   }
10429
10430   return T;
10431 }
10432
10433 /// Return the size of an element read or written by Inst.
10434 const SCEV *ScalarEvolution::getElementSize(Instruction *Inst) {
10435   Type *Ty;
10436   if (StoreInst *Store = dyn_cast<StoreInst>(Inst))
10437     Ty = Store->getValueOperand()->getType();
10438   else if (LoadInst *Load = dyn_cast<LoadInst>(Inst))
10439     Ty = Load->getType();
10440   else
10441     return nullptr;
10442
10443   Type *ETy = getEffectiveSCEVType(PointerType::getUnqual(Ty));
10444   return getSizeOfExpr(ETy, Ty);
10445 }
10446
10447 void ScalarEvolution::findArrayDimensions(SmallVectorImpl<const SCEV *> &Terms,
10448                                           SmallVectorImpl<const SCEV *> &Sizes,
10449                                           const SCEV *ElementSize) {
10450   if (Terms.size() < 1 || !ElementSize)
10451     return;
10452
10453   // Early return when Terms do not contain parameters: we do not delinearize
10454   // non parametric SCEVs.
10455   if (!containsParameters(Terms))
10456     return;
10457
10458   DEBUG({
10459       dbgs() << "Terms:\n";
10460       for (const SCEV *T : Terms)
10461         dbgs() << *T << "\n";
10462     });
10463
10464   // Remove duplicates.
10465   array_pod_sort(Terms.begin(), Terms.end());
10466   Terms.erase(std::unique(Terms.begin(), Terms.end()), Terms.end());
10467
10468   // Put larger terms first.
10469   std::sort(Terms.begin(), Terms.end(), [](const SCEV *LHS, const SCEV *RHS) {
10470     return numberOfTerms(LHS) > numberOfTerms(RHS);
10471   });
10472
10473   // Try to divide all terms by the element size. If term is not divisible by
10474   // element size, proceed with the original term.
10475   for (const SCEV *&Term : Terms) {
10476     const SCEV *Q, *R;
10477     SCEVDivision::divide(*this, Term, ElementSize, &Q, &R);
10478     if (!Q->isZero())
10479       Term = Q;
10480   }
10481
10482   SmallVector<const SCEV *, 4> NewTerms;
10483
10484   // Remove constant factors.
10485   for (const SCEV *T : Terms)
10486     if (const SCEV *NewT = removeConstantFactors(*this, T))
10487       NewTerms.push_back(NewT);
10488
10489   DEBUG({
10490       dbgs() << "Terms after sorting:\n";
10491       for (const SCEV *T : NewTerms)
10492         dbgs() << *T << "\n";
10493     });
10494
10495   if (NewTerms.empty() || !findArrayDimensionsRec(*this, NewTerms, Sizes)) {
10496     Sizes.clear();
10497     return;
10498   }
10499
10500   // The last element to be pushed into Sizes is the size of an element.
10501   Sizes.push_back(ElementSize);
10502
10503   DEBUG({
10504       dbgs() << "Sizes:\n";
10505       for (const SCEV *S : Sizes)
10506         dbgs() << *S << "\n";
10507     });
10508 }
10509
10510 void ScalarEvolution::computeAccessFunctions(
10511     const SCEV *Expr, SmallVectorImpl<const SCEV *> &Subscripts,
10512     SmallVectorImpl<const SCEV *> &Sizes) {
10513   // Early exit in case this SCEV is not an affine multivariate function.
10514   if (Sizes.empty())
10515     return;
10516
10517   if (auto *AR = dyn_cast<SCEVAddRecExpr>(Expr))
10518     if (!AR->isAffine())
10519       return;
10520
10521   const SCEV *Res = Expr;
10522   int Last = Sizes.size() - 1;
10523   for (int i = Last; i >= 0; i--) {
10524     const SCEV *Q, *R;
10525     SCEVDivision::divide(*this, Res, Sizes[i], &Q, &R);
10526
10527     DEBUG({
10528         dbgs() << "Res: " << *Res << "\n";
10529         dbgs() << "Sizes[i]: " << *Sizes[i] << "\n";
10530         dbgs() << "Res divided by Sizes[i]:\n";
10531         dbgs() << "Quotient: " << *Q << "\n";
10532         dbgs() << "Remainder: " << *R << "\n";
10533       });
10534
10535     Res = Q;
10536
10537     // Do not record the last subscript corresponding to the size of elements in
10538     // the array.
10539     if (i == Last) {
10540
10541       // Bail out if the remainder is too complex.
10542       if (isa<SCEVAddRecExpr>(R)) {
10543         Subscripts.clear();
10544         Sizes.clear();
10545         return;
10546       }
10547
10548       continue;
10549     }
10550
10551     // Record the access function for the current subscript.
10552     Subscripts.push_back(R);
10553   }
10554
10555   // Also push in last position the remainder of the last division: it will be
10556   // the access function of the innermost dimension.
10557   Subscripts.push_back(Res);
10558
10559   std::reverse(Subscripts.begin(), Subscripts.end());
10560
10561   DEBUG({
10562       dbgs() << "Subscripts:\n";
10563       for (const SCEV *S : Subscripts)
10564         dbgs() << *S << "\n";
10565     });
10566 }
10567
10568 /// Splits the SCEV into two vectors of SCEVs representing the subscripts and
10569 /// sizes of an array access. Returns the remainder of the delinearization that
10570 /// is the offset start of the array.  The SCEV->delinearize algorithm computes
10571 /// the multiples of SCEV coefficients: that is a pattern matching of sub
10572 /// expressions in the stride and base of a SCEV corresponding to the
10573 /// computation of a GCD (greatest common divisor) of base and stride.  When
10574 /// SCEV->delinearize fails, it returns the SCEV unchanged.
10575 ///
10576 /// For example: when analyzing the memory access A[i][j][k] in this loop nest
10577 ///
10578 ///  void foo(long n, long m, long o, double A[n][m][o]) {
10579 ///
10580 ///    for (long i = 0; i < n; i++)
10581 ///      for (long j = 0; j < m; j++)
10582 ///        for (long k = 0; k < o; k++)
10583 ///          A[i][j][k] = 1.0;
10584 ///  }
10585 ///
10586 /// the delinearization input is the following AddRec SCEV:
10587 ///
10588 ///  AddRec: {{{%A,+,(8 * %m * %o)}<%for.i>,+,(8 * %o)}<%for.j>,+,8}<%for.k>
10589 ///
10590 /// From this SCEV, we are able to say that the base offset of the access is %A
10591 /// because it appears as an offset that does not divide any of the strides in
10592 /// the loops:
10593 ///
10594 ///  CHECK: Base offset: %A
10595 ///
10596 /// and then SCEV->delinearize determines the size of some of the dimensions of
10597 /// the array as these are the multiples by which the strides are happening:
10598 ///
10599 ///  CHECK: ArrayDecl[UnknownSize][%m][%o] with elements of sizeof(double) bytes.
10600 ///
10601 /// Note that the outermost dimension remains of UnknownSize because there are
10602 /// no strides that would help identifying the size of the last dimension: when
10603 /// the array has been statically allocated, one could compute the size of that
10604 /// dimension by dividing the overall size of the array by the size of the known
10605 /// dimensions: %m * %o * 8.
10606 ///
10607 /// Finally delinearize provides the access functions for the array reference
10608 /// that does correspond to A[i][j][k] of the above C testcase:
10609 ///
10610 ///  CHECK: ArrayRef[{0,+,1}<%for.i>][{0,+,1}<%for.j>][{0,+,1}<%for.k>]
10611 ///
10612 /// The testcases are checking the output of a function pass:
10613 /// DelinearizationPass that walks through all loads and stores of a function
10614 /// asking for the SCEV of the memory access with respect to all enclosing
10615 /// loops, calling SCEV->delinearize on that and printing the results.
10616 void ScalarEvolution::delinearize(const SCEV *Expr,
10617                                  SmallVectorImpl<const SCEV *> &Subscripts,
10618                                  SmallVectorImpl<const SCEV *> &Sizes,
10619                                  const SCEV *ElementSize) {
10620   // First step: collect parametric terms.
10621   SmallVector<const SCEV *, 4> Terms;
10622   collectParametricTerms(Expr, Terms);
10623
10624   if (Terms.empty())
10625     return;
10626
10627   // Second step: find subscript sizes.
10628   findArrayDimensions(Terms, Sizes, ElementSize);
10629
10630   if (Sizes.empty())
10631     return;
10632
10633   // Third step: compute the access functions for each subscript.
10634   computeAccessFunctions(Expr, Subscripts, Sizes);
10635
10636   if (Subscripts.empty())
10637     return;
10638
10639   DEBUG({
10640       dbgs() << "succeeded to delinearize " << *Expr << "\n";
10641       dbgs() << "ArrayDecl[UnknownSize]";
10642       for (const SCEV *S : Sizes)
10643         dbgs() << "[" << *S << "]";
10644
10645       dbgs() << "\nArrayRef";
10646       for (const SCEV *S : Subscripts)
10647         dbgs() << "[" << *S << "]";
10648       dbgs() << "\n";
10649     });
10650 }
10651
10652 //===----------------------------------------------------------------------===//
10653 //                   SCEVCallbackVH Class Implementation
10654 //===----------------------------------------------------------------------===//
10655
10656 void ScalarEvolution::SCEVCallbackVH::deleted() {
10657   assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
10658   if (PHINode *PN = dyn_cast<PHINode>(getValPtr()))
10659     SE->ConstantEvolutionLoopExitValue.erase(PN);
10660   SE->eraseValueFromMap(getValPtr());
10661   // this now dangles!
10662 }
10663
10664 void ScalarEvolution::SCEVCallbackVH::allUsesReplacedWith(Value *V) {
10665   assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
10666
10667   // Forget all the expressions associated with users of the old value,
10668   // so that future queries will recompute the expressions using the new
10669   // value.
10670   Value *Old = getValPtr();
10671   SmallVector<User *, 16> Worklist(Old->user_begin(), Old->user_end());
10672   SmallPtrSet<User *, 8> Visited;
10673   while (!Worklist.empty()) {
10674     User *U = Worklist.pop_back_val();
10675     // Deleting the Old value will cause this to dangle. Postpone
10676     // that until everything else is done.
10677     if (U == Old)
10678       continue;
10679     if (!Visited.insert(U).second)
10680       continue;
10681     if (PHINode *PN = dyn_cast<PHINode>(U))
10682       SE->ConstantEvolutionLoopExitValue.erase(PN);
10683     SE->eraseValueFromMap(U);
10684     Worklist.insert(Worklist.end(), U->user_begin(), U->user_end());
10685   }
10686   // Delete the Old value.
10687   if (PHINode *PN = dyn_cast<PHINode>(Old))
10688     SE->ConstantEvolutionLoopExitValue.erase(PN);
10689   SE->eraseValueFromMap(Old);
10690   // this now dangles!
10691 }
10692
10693 ScalarEvolution::SCEVCallbackVH::SCEVCallbackVH(Value *V, ScalarEvolution *se)
10694   : CallbackVH(V), SE(se) {}
10695
10696 //===----------------------------------------------------------------------===//
10697 //                   ScalarEvolution Class Implementation
10698 //===----------------------------------------------------------------------===//
10699
10700 ScalarEvolution::ScalarEvolution(Function &F, TargetLibraryInfo &TLI,
10701                                  AssumptionCache &AC, DominatorTree &DT,
10702                                  LoopInfo &LI)
10703     : F(F), TLI(TLI), AC(AC), DT(DT), LI(LI),
10704       CouldNotCompute(new SCEVCouldNotCompute()), ValuesAtScopes(64),
10705       LoopDispositions(64), BlockDispositions(64) {
10706   // To use guards for proving predicates, we need to scan every instruction in
10707   // relevant basic blocks, and not just terminators.  Doing this is a waste of
10708   // time if the IR does not actually contain any calls to
10709   // @llvm.experimental.guard, so do a quick check and remember this beforehand.
10710   //
10711   // This pessimizes the case where a pass that preserves ScalarEvolution wants
10712   // to _add_ guards to the module when there weren't any before, and wants
10713   // ScalarEvolution to optimize based on those guards.  For now we prefer to be
10714   // efficient in lieu of being smart in that rather obscure case.
10715
10716   auto *GuardDecl = F.getParent()->getFunction(
10717       Intrinsic::getName(Intrinsic::experimental_guard));
10718   HasGuards = GuardDecl && !GuardDecl->use_empty();
10719 }
10720
10721 ScalarEvolution::ScalarEvolution(ScalarEvolution &&Arg)
10722     : F(Arg.F), HasGuards(Arg.HasGuards), TLI(Arg.TLI), AC(Arg.AC), DT(Arg.DT),
10723       LI(Arg.LI), CouldNotCompute(std::move(Arg.CouldNotCompute)),
10724       ValueExprMap(std::move(Arg.ValueExprMap)),
10725       PendingLoopPredicates(std::move(Arg.PendingLoopPredicates)),
10726       MinTrailingZerosCache(std::move(Arg.MinTrailingZerosCache)),
10727       BackedgeTakenCounts(std::move(Arg.BackedgeTakenCounts)),
10728       PredicatedBackedgeTakenCounts(
10729           std::move(Arg.PredicatedBackedgeTakenCounts)),
10730       ConstantEvolutionLoopExitValue(
10731           std::move(Arg.ConstantEvolutionLoopExitValue)),
10732       ValuesAtScopes(std::move(Arg.ValuesAtScopes)),
10733       LoopDispositions(std::move(Arg.LoopDispositions)),
10734       LoopPropertiesCache(std::move(Arg.LoopPropertiesCache)),
10735       BlockDispositions(std::move(Arg.BlockDispositions)),
10736       UnsignedRanges(std::move(Arg.UnsignedRanges)),
10737       SignedRanges(std::move(Arg.SignedRanges)),
10738       UniqueSCEVs(std::move(Arg.UniqueSCEVs)),
10739       UniquePreds(std::move(Arg.UniquePreds)),
10740       SCEVAllocator(std::move(Arg.SCEVAllocator)),
10741       LoopUsers(std::move(Arg.LoopUsers)),
10742       PredicatedSCEVRewrites(std::move(Arg.PredicatedSCEVRewrites)),
10743       FirstUnknown(Arg.FirstUnknown) {
10744   Arg.FirstUnknown = nullptr;
10745 }
10746
10747 ScalarEvolution::~ScalarEvolution() {
10748   // Iterate through all the SCEVUnknown instances and call their
10749   // destructors, so that they release their references to their values.
10750   for (SCEVUnknown *U = FirstUnknown; U;) {
10751     SCEVUnknown *Tmp = U;
10752     U = U->Next;
10753     Tmp->~SCEVUnknown();
10754   }
10755   FirstUnknown = nullptr;
10756
10757   ExprValueMap.clear();
10758   ValueExprMap.clear();
10759   HasRecMap.clear();
10760
10761   // Free any extra memory created for ExitNotTakenInfo in the unlikely event
10762   // that a loop had multiple computable exits.
10763   for (auto &BTCI : BackedgeTakenCounts)
10764     BTCI.second.clear();
10765   for (auto &BTCI : PredicatedBackedgeTakenCounts)
10766     BTCI.second.clear();
10767
10768   assert(PendingLoopPredicates.empty() && "isImpliedCond garbage");
10769   assert(!WalkingBEDominatingConds && "isLoopBackedgeGuardedByCond garbage!");
10770   assert(!ProvingSplitPredicate && "ProvingSplitPredicate garbage!");
10771 }
10772
10773 bool ScalarEvolution::hasLoopInvariantBackedgeTakenCount(const Loop *L) {
10774   return !isa<SCEVCouldNotCompute>(getBackedgeTakenCount(L));
10775 }
10776
10777 static void PrintLoopInfo(raw_ostream &OS, ScalarEvolution *SE,
10778                           const Loop *L) {
10779   // Print all inner loops first
10780   for (Loop *I : *L)
10781     PrintLoopInfo(OS, SE, I);
10782
10783   OS << "Loop ";
10784   L->getHeader()->printAsOperand(OS, /*PrintType=*/false);
10785   OS << ": ";
10786
10787   SmallVector<BasicBlock *, 8> ExitBlocks;
10788   L->getExitBlocks(ExitBlocks);
10789   if (ExitBlocks.size() != 1)
10790     OS << "<multiple exits> ";
10791
10792   if (SE->hasLoopInvariantBackedgeTakenCount(L)) {
10793     OS << "backedge-taken count is " << *SE->getBackedgeTakenCount(L);
10794   } else {
10795     OS << "Unpredictable backedge-taken count. ";
10796   }
10797
10798   OS << "\n"
10799         "Loop ";
10800   L->getHeader()->printAsOperand(OS, /*PrintType=*/false);
10801   OS << ": ";
10802
10803   if (!isa<SCEVCouldNotCompute>(SE->getMaxBackedgeTakenCount(L))) {
10804     OS << "max backedge-taken count is " << *SE->getMaxBackedgeTakenCount(L);
10805     if (SE->isBackedgeTakenCountMaxOrZero(L))
10806       OS << ", actual taken count either this or zero.";
10807   } else {
10808     OS << "Unpredictable max backedge-taken count. ";
10809   }
10810
10811   OS << "\n"
10812         "Loop ";
10813   L->getHeader()->printAsOperand(OS, /*PrintType=*/false);
10814   OS << ": ";
10815
10816   SCEVUnionPredicate Pred;
10817   auto PBT = SE->getPredicatedBackedgeTakenCount(L, Pred);
10818   if (!isa<SCEVCouldNotCompute>(PBT)) {
10819     OS << "Predicated backedge-taken count is " << *PBT << "\n";
10820     OS << " Predicates:\n";
10821     Pred.print(OS, 4);
10822   } else {
10823     OS << "Unpredictable predicated backedge-taken count. ";
10824   }
10825   OS << "\n";
10826
10827   if (SE->hasLoopInvariantBackedgeTakenCount(L)) {
10828     OS << "Loop ";
10829     L->getHeader()->printAsOperand(OS, /*PrintType=*/false);
10830     OS << ": ";
10831     OS << "Trip multiple is " << SE->getSmallConstantTripMultiple(L) << "\n";
10832   }
10833 }
10834
10835 static StringRef loopDispositionToStr(ScalarEvolution::LoopDisposition LD) {
10836   switch (LD) {
10837   case ScalarEvolution::LoopVariant:
10838     return "Variant";
10839   case ScalarEvolution::LoopInvariant:
10840     return "Invariant";
10841   case ScalarEvolution::LoopComputable:
10842     return "Computable";
10843   }
10844   llvm_unreachable("Unknown ScalarEvolution::LoopDisposition kind!");
10845 }
10846
10847 void ScalarEvolution::print(raw_ostream &OS) const {
10848   // ScalarEvolution's implementation of the print method is to print
10849   // out SCEV values of all instructions that are interesting. Doing
10850   // this potentially causes it to create new SCEV objects though,
10851   // which technically conflicts with the const qualifier. This isn't
10852   // observable from outside the class though, so casting away the
10853   // const isn't dangerous.
10854   ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
10855
10856   OS << "Classifying expressions for: ";
10857   F.printAsOperand(OS, /*PrintType=*/false);
10858   OS << "\n";
10859   for (Instruction &I : instructions(F))
10860     if (isSCEVable(I.getType()) && !isa<CmpInst>(I)) {
10861       OS << I << '\n';
10862       OS << "  -->  ";
10863       const SCEV *SV = SE.getSCEV(&I);
10864       SV->print(OS);
10865       if (!isa<SCEVCouldNotCompute>(SV)) {
10866         OS << " U: ";
10867         SE.getUnsignedRange(SV).print(OS);
10868         OS << " S: ";
10869         SE.getSignedRange(SV).print(OS);
10870       }
10871
10872       const Loop *L = LI.getLoopFor(I.getParent());
10873
10874       const SCEV *AtUse = SE.getSCEVAtScope(SV, L);
10875       if (AtUse != SV) {
10876         OS << "  -->  ";
10877         AtUse->print(OS);
10878         if (!isa<SCEVCouldNotCompute>(AtUse)) {
10879           OS << " U: ";
10880           SE.getUnsignedRange(AtUse).print(OS);
10881           OS << " S: ";
10882           SE.getSignedRange(AtUse).print(OS);
10883         }
10884       }
10885
10886       if (L) {
10887         OS << "\t\t" "Exits: ";
10888         const SCEV *ExitValue = SE.getSCEVAtScope(SV, L->getParentLoop());
10889         if (!SE.isLoopInvariant(ExitValue, L)) {
10890           OS << "<<Unknown>>";
10891         } else {
10892           OS << *ExitValue;
10893         }
10894
10895         bool First = true;
10896         for (auto *Iter = L; Iter; Iter = Iter->getParentLoop()) {
10897           if (First) {
10898             OS << "\t\t" "LoopDispositions: { ";
10899             First = false;
10900           } else {
10901             OS << ", ";
10902           }
10903
10904           Iter->getHeader()->printAsOperand(OS, /*PrintType=*/false);
10905           OS << ": " << loopDispositionToStr(SE.getLoopDisposition(SV, Iter));
10906         }
10907
10908         for (auto *InnerL : depth_first(L)) {
10909           if (InnerL == L)
10910             continue;
10911           if (First) {
10912             OS << "\t\t" "LoopDispositions: { ";
10913             First = false;
10914           } else {
10915             OS << ", ";
10916           }
10917
10918           InnerL->getHeader()->printAsOperand(OS, /*PrintType=*/false);
10919           OS << ": " << loopDispositionToStr(SE.getLoopDisposition(SV, InnerL));
10920         }
10921
10922         OS << " }";
10923       }
10924
10925       OS << "\n";
10926     }
10927
10928   OS << "Determining loop execution counts for: ";
10929   F.printAsOperand(OS, /*PrintType=*/false);
10930   OS << "\n";
10931   for (Loop *I : LI)
10932     PrintLoopInfo(OS, &SE, I);
10933 }
10934
10935 ScalarEvolution::LoopDisposition
10936 ScalarEvolution::getLoopDisposition(const SCEV *S, const Loop *L) {
10937   auto &Values = LoopDispositions[S];
10938   for (auto &V : Values) {
10939     if (V.getPointer() == L)
10940       return V.getInt();
10941   }
10942   Values.emplace_back(L, LoopVariant);
10943   LoopDisposition D = computeLoopDisposition(S, L);
10944   auto &Values2 = LoopDispositions[S];
10945   for (auto &V : make_range(Values2.rbegin(), Values2.rend())) {
10946     if (V.getPointer() == L) {
10947       V.setInt(D);
10948       break;
10949     }
10950   }
10951   return D;
10952 }
10953
10954 ScalarEvolution::LoopDisposition
10955 ScalarEvolution::computeLoopDisposition(const SCEV *S, const Loop *L) {
10956   switch (static_cast<SCEVTypes>(S->getSCEVType())) {
10957   case scConstant:
10958     return LoopInvariant;
10959   case scTruncate:
10960   case scZeroExtend:
10961   case scSignExtend:
10962     return getLoopDisposition(cast<SCEVCastExpr>(S)->getOperand(), L);
10963   case scAddRecExpr: {
10964     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S);
10965
10966     // If L is the addrec's loop, it's computable.
10967     if (AR->getLoop() == L)
10968       return LoopComputable;
10969
10970     // Add recurrences are never invariant in the function-body (null loop).
10971     if (!L)
10972       return LoopVariant;
10973
10974     // Everything that is not defined at loop entry is variant.
10975     if (DT.dominates(L->getHeader(), AR->getLoop()->getHeader()))
10976       return LoopVariant;
10977     assert(!L->contains(AR->getLoop()) && "Containing loop's header does not"
10978            " dominate the contained loop's header?");
10979
10980     // This recurrence is invariant w.r.t. L if AR's loop contains L.
10981     if (AR->getLoop()->contains(L))
10982       return LoopInvariant;
10983
10984     // This recurrence is variant w.r.t. L if any of its operands
10985     // are variant.
10986     for (auto *Op : AR->operands())
10987       if (!isLoopInvariant(Op, L))
10988         return LoopVariant;
10989
10990     // Otherwise it's loop-invariant.
10991     return LoopInvariant;
10992   }
10993   case scAddExpr:
10994   case scMulExpr:
10995   case scUMaxExpr:
10996   case scSMaxExpr: {
10997     bool HasVarying = false;
10998     for (auto *Op : cast<SCEVNAryExpr>(S)->operands()) {
10999       LoopDisposition D = getLoopDisposition(Op, L);
11000       if (D == LoopVariant)
11001         return LoopVariant;
11002       if (D == LoopComputable)
11003         HasVarying = true;
11004     }
11005     return HasVarying ? LoopComputable : LoopInvariant;
11006   }
11007   case scUDivExpr: {
11008     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
11009     LoopDisposition LD = getLoopDisposition(UDiv->getLHS(), L);
11010     if (LD == LoopVariant)
11011       return LoopVariant;
11012     LoopDisposition RD = getLoopDisposition(UDiv->getRHS(), L);
11013     if (RD == LoopVariant)
11014       return LoopVariant;
11015     return (LD == LoopInvariant && RD == LoopInvariant) ?
11016            LoopInvariant : LoopComputable;
11017   }
11018   case scUnknown:
11019     // All non-instruction values are loop invariant.  All instructions are loop
11020     // invariant if they are not contained in the specified loop.
11021     // Instructions are never considered invariant in the function body
11022     // (null loop) because they are defined within the "loop".
11023     if (auto *I = dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue()))
11024       return (L && !L->contains(I)) ? LoopInvariant : LoopVariant;
11025     return LoopInvariant;
11026   case scCouldNotCompute:
11027     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
11028   }
11029   llvm_unreachable("Unknown SCEV kind!");
11030 }
11031
11032 bool ScalarEvolution::isLoopInvariant(const SCEV *S, const Loop *L) {
11033   return getLoopDisposition(S, L) == LoopInvariant;
11034 }
11035
11036 bool ScalarEvolution::hasComputableLoopEvolution(const SCEV *S, const Loop *L) {
11037   return getLoopDisposition(S, L) == LoopComputable;
11038 }
11039
11040 ScalarEvolution::BlockDisposition
11041 ScalarEvolution::getBlockDisposition(const SCEV *S, const BasicBlock *BB) {
11042   auto &Values = BlockDispositions[S];
11043   for (auto &V : Values) {
11044     if (V.getPointer() == BB)
11045       return V.getInt();
11046   }
11047   Values.emplace_back(BB, DoesNotDominateBlock);
11048   BlockDisposition D = computeBlockDisposition(S, BB);
11049   auto &Values2 = BlockDispositions[S];
11050   for (auto &V : make_range(Values2.rbegin(), Values2.rend())) {
11051     if (V.getPointer() == BB) {
11052       V.setInt(D);
11053       break;
11054     }
11055   }
11056   return D;
11057 }
11058
11059 ScalarEvolution::BlockDisposition
11060 ScalarEvolution::computeBlockDisposition(const SCEV *S, const BasicBlock *BB) {
11061   switch (static_cast<SCEVTypes>(S->getSCEVType())) {
11062   case scConstant:
11063     return ProperlyDominatesBlock;
11064   case scTruncate:
11065   case scZeroExtend:
11066   case scSignExtend:
11067     return getBlockDisposition(cast<SCEVCastExpr>(S)->getOperand(), BB);
11068   case scAddRecExpr: {
11069     // This uses a "dominates" query instead of "properly dominates" query
11070     // to test for proper dominance too, because the instruction which
11071     // produces the addrec's value is a PHI, and a PHI effectively properly
11072     // dominates its entire containing block.
11073     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S);
11074     if (!DT.dominates(AR->getLoop()->getHeader(), BB))
11075       return DoesNotDominateBlock;
11076
11077     // Fall through into SCEVNAryExpr handling.
11078     LLVM_FALLTHROUGH;
11079   }
11080   case scAddExpr:
11081   case scMulExpr:
11082   case scUMaxExpr:
11083   case scSMaxExpr: {
11084     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S);
11085     bool Proper = true;
11086     for (const SCEV *NAryOp : NAry->operands()) {
11087       BlockDisposition D = getBlockDisposition(NAryOp, BB);
11088       if (D == DoesNotDominateBlock)
11089         return DoesNotDominateBlock;
11090       if (D == DominatesBlock)
11091         Proper = false;
11092     }
11093     return Proper ? ProperlyDominatesBlock : DominatesBlock;
11094   }
11095   case scUDivExpr: {
11096     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
11097     const SCEV *LHS = UDiv->getLHS(), *RHS = UDiv->getRHS();
11098     BlockDisposition LD = getBlockDisposition(LHS, BB);
11099     if (LD == DoesNotDominateBlock)
11100       return DoesNotDominateBlock;
11101     BlockDisposition RD = getBlockDisposition(RHS, BB);
11102     if (RD == DoesNotDominateBlock)
11103       return DoesNotDominateBlock;
11104     return (LD == ProperlyDominatesBlock && RD == ProperlyDominatesBlock) ?
11105       ProperlyDominatesBlock : DominatesBlock;
11106   }
11107   case scUnknown:
11108     if (Instruction *I =
11109           dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue())) {
11110       if (I->getParent() == BB)
11111         return DominatesBlock;
11112       if (DT.properlyDominates(I->getParent(), BB))
11113         return ProperlyDominatesBlock;
11114       return DoesNotDominateBlock;
11115     }
11116     return ProperlyDominatesBlock;
11117   case scCouldNotCompute:
11118     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
11119   }
11120   llvm_unreachable("Unknown SCEV kind!");
11121 }
11122
11123 bool ScalarEvolution::dominates(const SCEV *S, const BasicBlock *BB) {
11124   return getBlockDisposition(S, BB) >= DominatesBlock;
11125 }
11126
11127 bool ScalarEvolution::properlyDominates(const SCEV *S, const BasicBlock *BB) {
11128   return getBlockDisposition(S, BB) == ProperlyDominatesBlock;
11129 }
11130
11131 bool ScalarEvolution::hasOperand(const SCEV *S, const SCEV *Op) const {
11132   return SCEVExprContains(S, [&](const SCEV *Expr) { return Expr == Op; });
11133 }
11134
11135 bool ScalarEvolution::ExitLimit::hasOperand(const SCEV *S) const {
11136   auto IsS = [&](const SCEV *X) { return S == X; };
11137   auto ContainsS = [&](const SCEV *X) {
11138     return !isa<SCEVCouldNotCompute>(X) && SCEVExprContains(X, IsS);
11139   };
11140   return ContainsS(ExactNotTaken) || ContainsS(MaxNotTaken);
11141 }
11142
11143 void
11144 ScalarEvolution::forgetMemoizedResults(const SCEV *S) {
11145   ValuesAtScopes.erase(S);
11146   LoopDispositions.erase(S);
11147   BlockDispositions.erase(S);
11148   UnsignedRanges.erase(S);
11149   SignedRanges.erase(S);
11150   ExprValueMap.erase(S);
11151   HasRecMap.erase(S);
11152   MinTrailingZerosCache.erase(S);
11153
11154   for (auto I = PredicatedSCEVRewrites.begin();
11155        I != PredicatedSCEVRewrites.end();) {
11156     std::pair<const SCEV *, const Loop *> Entry = I->first;
11157     if (Entry.first == S)
11158       PredicatedSCEVRewrites.erase(I++);
11159     else
11160       ++I;
11161   }
11162
11163   auto RemoveSCEVFromBackedgeMap =
11164       [S, this](DenseMap<const Loop *, BackedgeTakenInfo> &Map) {
11165         for (auto I = Map.begin(), E = Map.end(); I != E;) {
11166           BackedgeTakenInfo &BEInfo = I->second;
11167           if (BEInfo.hasOperand(S, this)) {
11168             BEInfo.clear();
11169             Map.erase(I++);
11170           } else
11171             ++I;
11172         }
11173       };
11174
11175   RemoveSCEVFromBackedgeMap(BackedgeTakenCounts);
11176   RemoveSCEVFromBackedgeMap(PredicatedBackedgeTakenCounts);
11177 }
11178
11179 void ScalarEvolution::addToLoopUseLists(const SCEV *S) {
11180   struct FindUsedLoops {
11181     SmallPtrSet<const Loop *, 8> LoopsUsed;
11182     bool follow(const SCEV *S) {
11183       if (auto *AR = dyn_cast<SCEVAddRecExpr>(S))
11184         LoopsUsed.insert(AR->getLoop());
11185       return true;
11186     }
11187
11188     bool isDone() const { return false; }
11189   };
11190
11191   FindUsedLoops F;
11192   SCEVTraversal<FindUsedLoops>(F).visitAll(S);
11193
11194   for (auto *L : F.LoopsUsed)
11195     LoopUsers[L].push_back(S);
11196 }
11197
11198 void ScalarEvolution::verify() const {
11199   ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
11200   ScalarEvolution SE2(F, TLI, AC, DT, LI);
11201
11202   SmallVector<Loop *, 8> LoopStack(LI.begin(), LI.end());
11203
11204   // Map's SCEV expressions from one ScalarEvolution "universe" to another.
11205   struct SCEVMapper : public SCEVRewriteVisitor<SCEVMapper> {
11206     SCEVMapper(ScalarEvolution &SE) : SCEVRewriteVisitor<SCEVMapper>(SE) {}
11207
11208     const SCEV *visitConstant(const SCEVConstant *Constant) {
11209       return SE.getConstant(Constant->getAPInt());
11210     }
11211
11212     const SCEV *visitUnknown(const SCEVUnknown *Expr) {
11213       return SE.getUnknown(Expr->getValue());
11214     }
11215
11216     const SCEV *visitCouldNotCompute(const SCEVCouldNotCompute *Expr) {
11217       return SE.getCouldNotCompute();
11218     }
11219   };
11220
11221   SCEVMapper SCM(SE2);
11222
11223   while (!LoopStack.empty()) {
11224     auto *L = LoopStack.pop_back_val();
11225     LoopStack.insert(LoopStack.end(), L->begin(), L->end());
11226
11227     auto *CurBECount = SCM.visit(
11228         const_cast<ScalarEvolution *>(this)->getBackedgeTakenCount(L));
11229     auto *NewBECount = SE2.getBackedgeTakenCount(L);
11230
11231     if (CurBECount == SE2.getCouldNotCompute() ||
11232         NewBECount == SE2.getCouldNotCompute()) {
11233       // NB! This situation is legal, but is very suspicious -- whatever pass
11234       // change the loop to make a trip count go from could not compute to
11235       // computable or vice-versa *should have* invalidated SCEV.  However, we
11236       // choose not to assert here (for now) since we don't want false
11237       // positives.
11238       continue;
11239     }
11240
11241     if (containsUndefs(CurBECount) || containsUndefs(NewBECount)) {
11242       // SCEV treats "undef" as an unknown but consistent value (i.e. it does
11243       // not propagate undef aggressively).  This means we can (and do) fail
11244       // verification in cases where a transform makes the trip count of a loop
11245       // go from "undef" to "undef+1" (say).  The transform is fine, since in
11246       // both cases the loop iterates "undef" times, but SCEV thinks we
11247       // increased the trip count of the loop by 1 incorrectly.
11248       continue;
11249     }
11250
11251     if (SE.getTypeSizeInBits(CurBECount->getType()) >
11252         SE.getTypeSizeInBits(NewBECount->getType()))
11253       NewBECount = SE2.getZeroExtendExpr(NewBECount, CurBECount->getType());
11254     else if (SE.getTypeSizeInBits(CurBECount->getType()) <
11255              SE.getTypeSizeInBits(NewBECount->getType()))
11256       CurBECount = SE2.getZeroExtendExpr(CurBECount, NewBECount->getType());
11257
11258     auto *ConstantDelta =
11259         dyn_cast<SCEVConstant>(SE2.getMinusSCEV(CurBECount, NewBECount));
11260
11261     if (ConstantDelta && ConstantDelta->getAPInt() != 0) {
11262       dbgs() << "Trip Count Changed!\n";
11263       dbgs() << "Old: " << *CurBECount << "\n";
11264       dbgs() << "New: " << *NewBECount << "\n";
11265       dbgs() << "Delta: " << *ConstantDelta << "\n";
11266       std::abort();
11267     }
11268   }
11269 }
11270
11271 bool ScalarEvolution::invalidate(
11272     Function &F, const PreservedAnalyses &PA,
11273     FunctionAnalysisManager::Invalidator &Inv) {
11274   // Invalidate the ScalarEvolution object whenever it isn't preserved or one
11275   // of its dependencies is invalidated.
11276   auto PAC = PA.getChecker<ScalarEvolutionAnalysis>();
11277   return !(PAC.preserved() || PAC.preservedSet<AllAnalysesOn<Function>>()) ||
11278          Inv.invalidate<AssumptionAnalysis>(F, PA) ||
11279          Inv.invalidate<DominatorTreeAnalysis>(F, PA) ||
11280          Inv.invalidate<LoopAnalysis>(F, PA);
11281 }
11282
11283 AnalysisKey ScalarEvolutionAnalysis::Key;
11284
11285 ScalarEvolution ScalarEvolutionAnalysis::run(Function &F,
11286                                              FunctionAnalysisManager &AM) {
11287   return ScalarEvolution(F, AM.getResult<TargetLibraryAnalysis>(F),
11288                          AM.getResult<AssumptionAnalysis>(F),
11289                          AM.getResult<DominatorTreeAnalysis>(F),
11290                          AM.getResult<LoopAnalysis>(F));
11291 }
11292
11293 PreservedAnalyses
11294 ScalarEvolutionPrinterPass::run(Function &F, FunctionAnalysisManager &AM) {
11295   AM.getResult<ScalarEvolutionAnalysis>(F).print(OS);
11296   return PreservedAnalyses::all();
11297 }
11298
11299 INITIALIZE_PASS_BEGIN(ScalarEvolutionWrapperPass, "scalar-evolution",
11300                       "Scalar Evolution Analysis", false, true)
11301 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
11302 INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass)
11303 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
11304 INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)
11305 INITIALIZE_PASS_END(ScalarEvolutionWrapperPass, "scalar-evolution",
11306                     "Scalar Evolution Analysis", false, true)
11307
11308 char ScalarEvolutionWrapperPass::ID = 0;
11309
11310 ScalarEvolutionWrapperPass::ScalarEvolutionWrapperPass() : FunctionPass(ID) {
11311   initializeScalarEvolutionWrapperPassPass(*PassRegistry::getPassRegistry());
11312 }
11313
11314 bool ScalarEvolutionWrapperPass::runOnFunction(Function &F) {
11315   SE.reset(new ScalarEvolution(
11316       F, getAnalysis<TargetLibraryInfoWrapperPass>().getTLI(),
11317       getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F),
11318       getAnalysis<DominatorTreeWrapperPass>().getDomTree(),
11319       getAnalysis<LoopInfoWrapperPass>().getLoopInfo()));
11320   return false;
11321 }
11322
11323 void ScalarEvolutionWrapperPass::releaseMemory() { SE.reset(); }
11324
11325 void ScalarEvolutionWrapperPass::print(raw_ostream &OS, const Module *) const {
11326   SE->print(OS);
11327 }
11328
11329 void ScalarEvolutionWrapperPass::verifyAnalysis() const {
11330   if (!VerifySCEV)
11331     return;
11332
11333   SE->verify();
11334 }
11335
11336 void ScalarEvolutionWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
11337   AU.setPreservesAll();
11338   AU.addRequiredTransitive<AssumptionCacheTracker>();
11339   AU.addRequiredTransitive<LoopInfoWrapperPass>();
11340   AU.addRequiredTransitive<DominatorTreeWrapperPass>();
11341   AU.addRequiredTransitive<TargetLibraryInfoWrapperPass>();
11342 }
11343
11344 const SCEVPredicate *ScalarEvolution::getEqualPredicate(const SCEV *LHS,
11345                                                         const SCEV *RHS) {
11346   FoldingSetNodeID ID;
11347   assert(LHS->getType() == RHS->getType() &&
11348          "Type mismatch between LHS and RHS");
11349   // Unique this node based on the arguments
11350   ID.AddInteger(SCEVPredicate::P_Equal);
11351   ID.AddPointer(LHS);
11352   ID.AddPointer(RHS);
11353   void *IP = nullptr;
11354   if (const auto *S = UniquePreds.FindNodeOrInsertPos(ID, IP))
11355     return S;
11356   SCEVEqualPredicate *Eq = new (SCEVAllocator)
11357       SCEVEqualPredicate(ID.Intern(SCEVAllocator), LHS, RHS);
11358   UniquePreds.InsertNode(Eq, IP);
11359   return Eq;
11360 }
11361
11362 const SCEVPredicate *ScalarEvolution::getWrapPredicate(
11363     const SCEVAddRecExpr *AR,
11364     SCEVWrapPredicate::IncrementWrapFlags AddedFlags) {
11365   FoldingSetNodeID ID;
11366   // Unique this node based on the arguments
11367   ID.AddInteger(SCEVPredicate::P_Wrap);
11368   ID.AddPointer(AR);
11369   ID.AddInteger(AddedFlags);
11370   void *IP = nullptr;
11371   if (const auto *S = UniquePreds.FindNodeOrInsertPos(ID, IP))
11372     return S;
11373   auto *OF = new (SCEVAllocator)
11374       SCEVWrapPredicate(ID.Intern(SCEVAllocator), AR, AddedFlags);
11375   UniquePreds.InsertNode(OF, IP);
11376   return OF;
11377 }
11378
11379 namespace {
11380
11381 class SCEVPredicateRewriter : public SCEVRewriteVisitor<SCEVPredicateRewriter> {
11382 public:
11383
11384   /// Rewrites \p S in the context of a loop L and the SCEV predication
11385   /// infrastructure.
11386   ///
11387   /// If \p Pred is non-null, the SCEV expression is rewritten to respect the
11388   /// equivalences present in \p Pred.
11389   ///
11390   /// If \p NewPreds is non-null, rewrite is free to add further predicates to
11391   /// \p NewPreds such that the result will be an AddRecExpr.
11392   static const SCEV *rewrite(const SCEV *S, const Loop *L, ScalarEvolution &SE,
11393                              SmallPtrSetImpl<const SCEVPredicate *> *NewPreds,
11394                              SCEVUnionPredicate *Pred) {
11395     SCEVPredicateRewriter Rewriter(L, SE, NewPreds, Pred);
11396     return Rewriter.visit(S);
11397   }
11398
11399   const SCEV *visitUnknown(const SCEVUnknown *Expr) {
11400     if (Pred) {
11401       auto ExprPreds = Pred->getPredicatesForExpr(Expr);
11402       for (auto *Pred : ExprPreds)
11403         if (const auto *IPred = dyn_cast<SCEVEqualPredicate>(Pred))
11404           if (IPred->getLHS() == Expr)
11405             return IPred->getRHS();
11406     }
11407     return convertToAddRecWithPreds(Expr);
11408   }
11409
11410   const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *Expr) {
11411     const SCEV *Operand = visit(Expr->getOperand());
11412     const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Operand);
11413     if (AR && AR->getLoop() == L && AR->isAffine()) {
11414       // This couldn't be folded because the operand didn't have the nuw
11415       // flag. Add the nusw flag as an assumption that we could make.
11416       const SCEV *Step = AR->getStepRecurrence(SE);
11417       Type *Ty = Expr->getType();
11418       if (addOverflowAssumption(AR, SCEVWrapPredicate::IncrementNUSW))
11419         return SE.getAddRecExpr(SE.getZeroExtendExpr(AR->getStart(), Ty),
11420                                 SE.getSignExtendExpr(Step, Ty), L,
11421                                 AR->getNoWrapFlags());
11422     }
11423     return SE.getZeroExtendExpr(Operand, Expr->getType());
11424   }
11425
11426   const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *Expr) {
11427     const SCEV *Operand = visit(Expr->getOperand());
11428     const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Operand);
11429     if (AR && AR->getLoop() == L && AR->isAffine()) {
11430       // This couldn't be folded because the operand didn't have the nsw
11431       // flag. Add the nssw flag as an assumption that we could make.
11432       const SCEV *Step = AR->getStepRecurrence(SE);
11433       Type *Ty = Expr->getType();
11434       if (addOverflowAssumption(AR, SCEVWrapPredicate::IncrementNSSW))
11435         return SE.getAddRecExpr(SE.getSignExtendExpr(AR->getStart(), Ty),
11436                                 SE.getSignExtendExpr(Step, Ty), L,
11437                                 AR->getNoWrapFlags());
11438     }
11439     return SE.getSignExtendExpr(Operand, Expr->getType());
11440   }
11441
11442 private:
11443   explicit SCEVPredicateRewriter(const Loop *L, ScalarEvolution &SE,
11444                         SmallPtrSetImpl<const SCEVPredicate *> *NewPreds,
11445                         SCEVUnionPredicate *Pred)
11446       : SCEVRewriteVisitor(SE), NewPreds(NewPreds), Pred(Pred), L(L) {}
11447
11448   bool addOverflowAssumption(const SCEVPredicate *P) {
11449     if (!NewPreds) {
11450       // Check if we've already made this assumption.
11451       return Pred && Pred->implies(P);
11452     }
11453     NewPreds->insert(P);
11454     return true;
11455   }
11456
11457   bool addOverflowAssumption(const SCEVAddRecExpr *AR,
11458                              SCEVWrapPredicate::IncrementWrapFlags AddedFlags) {
11459     auto *A = SE.getWrapPredicate(AR, AddedFlags);
11460     return addOverflowAssumption(A);
11461   }
11462
11463   // If \p Expr represents a PHINode, we try to see if it can be represented
11464   // as an AddRec, possibly under a predicate (PHISCEVPred). If it is possible
11465   // to add this predicate as a runtime overflow check, we return the AddRec.
11466   // If \p Expr does not meet these conditions (is not a PHI node, or we
11467   // couldn't create an AddRec for it, or couldn't add the predicate), we just
11468   // return \p Expr.
11469   const SCEV *convertToAddRecWithPreds(const SCEVUnknown *Expr) {
11470     if (!isa<PHINode>(Expr->getValue()))
11471       return Expr;
11472     Optional<std::pair<const SCEV *, SmallVector<const SCEVPredicate *, 3>>>
11473     PredicatedRewrite = SE.createAddRecFromPHIWithCasts(Expr);
11474     if (!PredicatedRewrite)
11475       return Expr;
11476     for (auto *P : PredicatedRewrite->second){
11477       if (!addOverflowAssumption(P))
11478         return Expr;
11479     }
11480     return PredicatedRewrite->first;
11481   }
11482
11483   SmallPtrSetImpl<const SCEVPredicate *> *NewPreds;
11484   SCEVUnionPredicate *Pred;
11485   const Loop *L;
11486 };
11487
11488 } // end anonymous namespace
11489
11490 const SCEV *ScalarEvolution::rewriteUsingPredicate(const SCEV *S, const Loop *L,
11491                                                    SCEVUnionPredicate &Preds) {
11492   return SCEVPredicateRewriter::rewrite(S, L, *this, nullptr, &Preds);
11493 }
11494
11495 const SCEVAddRecExpr *ScalarEvolution::convertSCEVToAddRecWithPredicates(
11496     const SCEV *S, const Loop *L,
11497     SmallPtrSetImpl<const SCEVPredicate *> &Preds) {
11498   SmallPtrSet<const SCEVPredicate *, 4> TransformPreds;
11499   S = SCEVPredicateRewriter::rewrite(S, L, *this, &TransformPreds, nullptr);
11500   auto *AddRec = dyn_cast<SCEVAddRecExpr>(S);
11501
11502   if (!AddRec)
11503     return nullptr;
11504
11505   // Since the transformation was successful, we can now transfer the SCEV
11506   // predicates.
11507   for (auto *P : TransformPreds)
11508     Preds.insert(P);
11509
11510   return AddRec;
11511 }
11512
11513 /// SCEV predicates
11514 SCEVPredicate::SCEVPredicate(const FoldingSetNodeIDRef ID,
11515                              SCEVPredicateKind Kind)
11516     : FastID(ID), Kind(Kind) {}
11517
11518 SCEVEqualPredicate::SCEVEqualPredicate(const FoldingSetNodeIDRef ID,
11519                                        const SCEV *LHS, const SCEV *RHS)
11520     : SCEVPredicate(ID, P_Equal), LHS(LHS), RHS(RHS) {
11521   assert(LHS->getType() == RHS->getType() && "LHS and RHS types don't match");
11522   assert(LHS != RHS && "LHS and RHS are the same SCEV");
11523 }
11524
11525 bool SCEVEqualPredicate::implies(const SCEVPredicate *N) const {
11526   const auto *Op = dyn_cast<SCEVEqualPredicate>(N);
11527
11528   if (!Op)
11529     return false;
11530
11531   return Op->LHS == LHS && Op->RHS == RHS;
11532 }
11533
11534 bool SCEVEqualPredicate::isAlwaysTrue() const { return false; }
11535
11536 const SCEV *SCEVEqualPredicate::getExpr() const { return LHS; }
11537
11538 void SCEVEqualPredicate::print(raw_ostream &OS, unsigned Depth) const {
11539   OS.indent(Depth) << "Equal predicate: " << *LHS << " == " << *RHS << "\n";
11540 }
11541
11542 SCEVWrapPredicate::SCEVWrapPredicate(const FoldingSetNodeIDRef ID,
11543                                      const SCEVAddRecExpr *AR,
11544                                      IncrementWrapFlags Flags)
11545     : SCEVPredicate(ID, P_Wrap), AR(AR), Flags(Flags) {}
11546
11547 const SCEV *SCEVWrapPredicate::getExpr() const { return AR; }
11548
11549 bool SCEVWrapPredicate::implies(const SCEVPredicate *N) const {
11550   const auto *Op = dyn_cast<SCEVWrapPredicate>(N);
11551
11552   return Op && Op->AR == AR && setFlags(Flags, Op->Flags) == Flags;
11553 }
11554
11555 bool SCEVWrapPredicate::isAlwaysTrue() const {
11556   SCEV::NoWrapFlags ScevFlags = AR->getNoWrapFlags();
11557   IncrementWrapFlags IFlags = Flags;
11558
11559   if (ScalarEvolution::setFlags(ScevFlags, SCEV::FlagNSW) == ScevFlags)
11560     IFlags = clearFlags(IFlags, IncrementNSSW);
11561
11562   return IFlags == IncrementAnyWrap;
11563 }
11564
11565 void SCEVWrapPredicate::print(raw_ostream &OS, unsigned Depth) const {
11566   OS.indent(Depth) << *getExpr() << " Added Flags: ";
11567   if (SCEVWrapPredicate::IncrementNUSW & getFlags())
11568     OS << "<nusw>";
11569   if (SCEVWrapPredicate::IncrementNSSW & getFlags())
11570     OS << "<nssw>";
11571   OS << "\n";
11572 }
11573
11574 SCEVWrapPredicate::IncrementWrapFlags
11575 SCEVWrapPredicate::getImpliedFlags(const SCEVAddRecExpr *AR,
11576                                    ScalarEvolution &SE) {
11577   IncrementWrapFlags ImpliedFlags = IncrementAnyWrap;
11578   SCEV::NoWrapFlags StaticFlags = AR->getNoWrapFlags();
11579
11580   // We can safely transfer the NSW flag as NSSW.
11581   if (ScalarEvolution::setFlags(StaticFlags, SCEV::FlagNSW) == StaticFlags)
11582     ImpliedFlags = IncrementNSSW;
11583
11584   if (ScalarEvolution::setFlags(StaticFlags, SCEV::FlagNUW) == StaticFlags) {
11585     // If the increment is positive, the SCEV NUW flag will also imply the
11586     // WrapPredicate NUSW flag.
11587     if (const auto *Step = dyn_cast<SCEVConstant>(AR->getStepRecurrence(SE)))
11588       if (Step->getValue()->getValue().isNonNegative())
11589         ImpliedFlags = setFlags(ImpliedFlags, IncrementNUSW);
11590   }
11591
11592   return ImpliedFlags;
11593 }
11594
11595 /// Union predicates don't get cached so create a dummy set ID for it.
11596 SCEVUnionPredicate::SCEVUnionPredicate()
11597     : SCEVPredicate(FoldingSetNodeIDRef(nullptr, 0), P_Union) {}
11598
11599 bool SCEVUnionPredicate::isAlwaysTrue() const {
11600   return all_of(Preds,
11601                 [](const SCEVPredicate *I) { return I->isAlwaysTrue(); });
11602 }
11603
11604 ArrayRef<const SCEVPredicate *>
11605 SCEVUnionPredicate::getPredicatesForExpr(const SCEV *Expr) {
11606   auto I = SCEVToPreds.find(Expr);
11607   if (I == SCEVToPreds.end())
11608     return ArrayRef<const SCEVPredicate *>();
11609   return I->second;
11610 }
11611
11612 bool SCEVUnionPredicate::implies(const SCEVPredicate *N) const {
11613   if (const auto *Set = dyn_cast<SCEVUnionPredicate>(N))
11614     return all_of(Set->Preds,
11615                   [this](const SCEVPredicate *I) { return this->implies(I); });
11616
11617   auto ScevPredsIt = SCEVToPreds.find(N->getExpr());
11618   if (ScevPredsIt == SCEVToPreds.end())
11619     return false;
11620   auto &SCEVPreds = ScevPredsIt->second;
11621
11622   return any_of(SCEVPreds,
11623                 [N](const SCEVPredicate *I) { return I->implies(N); });
11624 }
11625
11626 const SCEV *SCEVUnionPredicate::getExpr() const { return nullptr; }
11627
11628 void SCEVUnionPredicate::print(raw_ostream &OS, unsigned Depth) const {
11629   for (auto Pred : Preds)
11630     Pred->print(OS, Depth);
11631 }
11632
11633 void SCEVUnionPredicate::add(const SCEVPredicate *N) {
11634   if (const auto *Set = dyn_cast<SCEVUnionPredicate>(N)) {
11635     for (auto Pred : Set->Preds)
11636       add(Pred);
11637     return;
11638   }
11639
11640   if (implies(N))
11641     return;
11642
11643   const SCEV *Key = N->getExpr();
11644   assert(Key && "Only SCEVUnionPredicate doesn't have an "
11645                 " associated expression!");
11646
11647   SCEVToPreds[Key].push_back(N);
11648   Preds.push_back(N);
11649 }
11650
11651 PredicatedScalarEvolution::PredicatedScalarEvolution(ScalarEvolution &SE,
11652                                                      Loop &L)
11653     : SE(SE), L(L) {}
11654
11655 const SCEV *PredicatedScalarEvolution::getSCEV(Value *V) {
11656   const SCEV *Expr = SE.getSCEV(V);
11657   RewriteEntry &Entry = RewriteMap[Expr];
11658
11659   // If we already have an entry and the version matches, return it.
11660   if (Entry.second && Generation == Entry.first)
11661     return Entry.second;
11662
11663   // We found an entry but it's stale. Rewrite the stale entry
11664   // according to the current predicate.
11665   if (Entry.second)
11666     Expr = Entry.second;
11667
11668   const SCEV *NewSCEV = SE.rewriteUsingPredicate(Expr, &L, Preds);
11669   Entry = {Generation, NewSCEV};
11670
11671   return NewSCEV;
11672 }
11673
11674 const SCEV *PredicatedScalarEvolution::getBackedgeTakenCount() {
11675   if (!BackedgeCount) {
11676     SCEVUnionPredicate BackedgePred;
11677     BackedgeCount = SE.getPredicatedBackedgeTakenCount(&L, BackedgePred);
11678     addPredicate(BackedgePred);
11679   }
11680   return BackedgeCount;
11681 }
11682
11683 void PredicatedScalarEvolution::addPredicate(const SCEVPredicate &Pred) {
11684   if (Preds.implies(&Pred))
11685     return;
11686   Preds.add(&Pred);
11687   updateGeneration();
11688 }
11689
11690 const SCEVUnionPredicate &PredicatedScalarEvolution::getUnionPredicate() const {
11691   return Preds;
11692 }
11693
11694 void PredicatedScalarEvolution::updateGeneration() {
11695   // If the generation number wrapped recompute everything.
11696   if (++Generation == 0) {
11697     for (auto &II : RewriteMap) {
11698       const SCEV *Rewritten = II.second.second;
11699       II.second = {Generation, SE.rewriteUsingPredicate(Rewritten, &L, Preds)};
11700     }
11701   }
11702 }
11703
11704 void PredicatedScalarEvolution::setNoOverflow(
11705     Value *V, SCEVWrapPredicate::IncrementWrapFlags Flags) {
11706   const SCEV *Expr = getSCEV(V);
11707   const auto *AR = cast<SCEVAddRecExpr>(Expr);
11708
11709   auto ImpliedFlags = SCEVWrapPredicate::getImpliedFlags(AR, SE);
11710
11711   // Clear the statically implied flags.
11712   Flags = SCEVWrapPredicate::clearFlags(Flags, ImpliedFlags);
11713   addPredicate(*SE.getWrapPredicate(AR, Flags));
11714
11715   auto II = FlagsMap.insert({V, Flags});
11716   if (!II.second)
11717     II.first->second = SCEVWrapPredicate::setFlags(Flags, II.first->second);
11718 }
11719
11720 bool PredicatedScalarEvolution::hasNoOverflow(
11721     Value *V, SCEVWrapPredicate::IncrementWrapFlags Flags) {
11722   const SCEV *Expr = getSCEV(V);
11723   const auto *AR = cast<SCEVAddRecExpr>(Expr);
11724
11725   Flags = SCEVWrapPredicate::clearFlags(
11726       Flags, SCEVWrapPredicate::getImpliedFlags(AR, SE));
11727
11728   auto II = FlagsMap.find(V);
11729
11730   if (II != FlagsMap.end())
11731     Flags = SCEVWrapPredicate::clearFlags(Flags, II->second);
11732
11733   return Flags == SCEVWrapPredicate::IncrementAnyWrap;
11734 }
11735
11736 const SCEVAddRecExpr *PredicatedScalarEvolution::getAsAddRec(Value *V) {
11737   const SCEV *Expr = this->getSCEV(V);
11738   SmallPtrSet<const SCEVPredicate *, 4> NewPreds;
11739   auto *New = SE.convertSCEVToAddRecWithPredicates(Expr, &L, NewPreds);
11740
11741   if (!New)
11742     return nullptr;
11743
11744   for (auto *P : NewPreds)
11745     Preds.add(P);
11746
11747   updateGeneration();
11748   RewriteMap[SE.getSCEV(V)] = {Generation, New};
11749   return New;
11750 }
11751
11752 PredicatedScalarEvolution::PredicatedScalarEvolution(
11753     const PredicatedScalarEvolution &Init)
11754     : RewriteMap(Init.RewriteMap), SE(Init.SE), L(Init.L), Preds(Init.Preds),
11755       Generation(Init.Generation), BackedgeCount(Init.BackedgeCount) {
11756   for (const auto &I : Init.FlagsMap)
11757     FlagsMap.insert(I);
11758 }
11759
11760 void PredicatedScalarEvolution::print(raw_ostream &OS, unsigned Depth) const {
11761   // For each block.
11762   for (auto *BB : L.getBlocks())
11763     for (auto &I : *BB) {
11764       if (!SE.isSCEVable(I.getType()))
11765         continue;
11766
11767       auto *Expr = SE.getSCEV(&I);
11768       auto II = RewriteMap.find(Expr);
11769
11770       if (II == RewriteMap.end())
11771         continue;
11772
11773       // Don't print things that are not interesting.
11774       if (II->second.second == Expr)
11775         continue;
11776
11777       OS.indent(Depth) << "[PSE]" << I << ":\n";
11778       OS.indent(Depth + 2) << *Expr << "\n";
11779       OS.indent(Depth + 2) << "--> " << *II->second.second << "\n";
11780     }
11781 }