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/Optional.h"
  63 #include "llvm/ADT/STLExtras.h"
  64 #include "llvm/ADT/SmallPtrSet.h"
  65 #include "llvm/ADT/Statistic.h"
  66 #include "llvm/Analysis/AssumptionCache.h"
  67 #include "llvm/Analysis/ConstantFolding.h"
  68 #include "llvm/Analysis/InstructionSimplify.h"
  69 #include "llvm/Analysis/LoopInfo.h"
  70 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
  71 #include "llvm/Analysis/TargetLibraryInfo.h"
  72 #include "llvm/Analysis/ValueTracking.h"
  73 #include "llvm/IR/ConstantRange.h"
  74 #include "llvm/IR/Constants.h"
  75 #include "llvm/IR/DataLayout.h"
  76 #include "llvm/IR/DerivedTypes.h"
  77 #include "llvm/IR/Dominators.h"
  78 #include "llvm/IR/GetElementPtrTypeIterator.h"
  79 #include "llvm/IR/GlobalAlias.h"
  80 #include "llvm/IR/GlobalVariable.h"
  81 #include "llvm/IR/InstIterator.h"
  82 #include "llvm/IR/Instructions.h"
  83 #include "llvm/IR/LLVMContext.h"
  84 #include "llvm/IR/Metadata.h"
  85 #include "llvm/IR/Operator.h"
  86 #include "llvm/Support/CommandLine.h"
  87 #include "llvm/Support/Debug.h"
  88 #include "llvm/Support/ErrorHandling.h"
  89 #include "llvm/Support/MathExtras.h"
  90 #include "llvm/Support/raw_ostream.h"
  91 #include <algorithm>
  92 using namespace llvm;
  93
  94 #define DEBUG_TYPE "scalar-evolution"
  95
  96 STATISTIC(NumArrayLenItCounts,
  97           "Number of trip counts computed with array length");
  98 STATISTIC(NumTripCountsComputed,
  99           "Number of loops with predictable loop counts");
 100 STATISTIC(NumTripCountsNotComputed,
 101           "Number of loops without predictable loop counts");
 102 STATISTIC(NumBruteForceTripCountsComputed,
 103           "Number of loops with trip counts computed by force");
 104
 105 static cl::opt<unsigned>
 106 MaxBruteForceIterations("scalar-evolution-max-iterations", cl::ReallyHidden,
 107                         cl::desc("Maximum number of iterations SCEV will "
 108                                  "symbolically execute a constant "
 109                                  "derived loop"),
 110                         cl::init(100));
 111
 112 // FIXME: Enable this with XDEBUG when the test suite is clean.
 113 static cl::opt<bool>
 114 VerifySCEV("verify-scev",
 115            cl::desc("Verify ScalarEvolution's backedge taken counts (slow)"));
 116
 117 INITIALIZE_PASS_BEGIN(ScalarEvolution, "scalar-evolution",
 118                 "Scalar Evolution Analysis", false, true)
 119 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
 120 INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass)
 121 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
 122 INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)
 123 INITIALIZE_PASS_END(ScalarEvolution, "scalar-evolution",
 124                 "Scalar Evolution Analysis", false, true)
 125 char ScalarEvolution::ID = 0;
 126
 127 //===----------------------------------------------------------------------===//
 128 //                           SCEV class definitions
 129 //===----------------------------------------------------------------------===//
 130
 131 //===----------------------------------------------------------------------===//
 132 // Implementation of the SCEV class.
 133 //
 134
 135 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 136 void SCEV::dump() const {
 137   print(dbgs());
 138   dbgs() << '\n';
 139 }
 140 #endif
 141
 142 void SCEV::print(raw_ostream &OS) const {
 143   switch (static_cast<SCEVTypes>(getSCEVType())) {
 144   case scConstant:
 145     cast<SCEVConstant>(this)->getValue()->printAsOperand(OS, false);
 146     return;
 147   case scTruncate: {
 148     const SCEVTruncateExpr *Trunc = cast<SCEVTruncateExpr>(this);
 149     const SCEV *Op = Trunc->getOperand();
 150     OS << "(trunc " << *Op->getType() << " " << *Op << " to "
 151        << *Trunc->getType() << ")";
 152     return;
 153   }
 154   case scZeroExtend: {
 155     const SCEVZeroExtendExpr *ZExt = cast<SCEVZeroExtendExpr>(this);
 156     const SCEV *Op = ZExt->getOperand();
 157     OS << "(zext " << *Op->getType() << " " << *Op << " to "
 158        << *ZExt->getType() << ")";
 159     return;
 160   }
 161   case scSignExtend: {
 162     const SCEVSignExtendExpr *SExt = cast<SCEVSignExtendExpr>(this);
 163     const SCEV *Op = SExt->getOperand();
 164     OS << "(sext " << *Op->getType() << " " << *Op << " to "
 165        << *SExt->getType() << ")";
 166     return;
 167   }
 168   case scAddRecExpr: {
 169     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(this);
 170     OS << "{" << *AR->getOperand(0);
 171     for (unsigned i = 1, e = AR->getNumOperands(); i != e; ++i)
 172       OS << ",+," << *AR->getOperand(i);
 173     OS << "}<";
 174     if (AR->getNoWrapFlags(FlagNUW))
 175       OS << "nuw><";
 176     if (AR->getNoWrapFlags(FlagNSW))
 177       OS << "nsw><";
 178     if (AR->getNoWrapFlags(FlagNW) &&
 179         !AR->getNoWrapFlags((NoWrapFlags)(FlagNUW | FlagNSW)))
 180       OS << "nw><";
 181     AR->getLoop()->getHeader()->printAsOperand(OS, /*PrintType=*/false);
 182     OS << ">";
 183     return;
 184   }
 185   case scAddExpr:
 186   case scMulExpr:
 187   case scUMaxExpr:
 188   case scSMaxExpr: {
 189     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(this);
 190     const char *OpStr = nullptr;
 191     switch (NAry->getSCEVType()) {
 192     case scAddExpr: OpStr = " + "; break;
 193     case scMulExpr: OpStr = " * "; break;
 194     case scUMaxExpr: OpStr = " umax "; break;
 195     case scSMaxExpr: OpStr = " smax "; break;
 196     }
 197     OS << "(";
 198     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
 199          I != E; ++I) {
 200       OS << **I;
 201       if (std::next(I) != E)
 202         OS << OpStr;
 203     }
 204     OS << ")";
 205     switch (NAry->getSCEVType()) {
 206     case scAddExpr:
 207     case scMulExpr:
 208       if (NAry->getNoWrapFlags(FlagNUW))
 209         OS << "<nuw>";
 210       if (NAry->getNoWrapFlags(FlagNSW))
 211         OS << "<nsw>";
 212     }
 213     return;
 214   }
 215   case scUDivExpr: {
 216     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(this);
 217     OS << "(" << *UDiv->getLHS() << " /u " << *UDiv->getRHS() << ")";
 218     return;
 219   }
 220   case scUnknown: {
 221     const SCEVUnknown *U = cast<SCEVUnknown>(this);
 222     Type *AllocTy;
 223     if (U->isSizeOf(AllocTy)) {
 224       OS << "sizeof(" << *AllocTy << ")";
 225       return;
 226     }
 227     if (U->isAlignOf(AllocTy)) {
 228       OS << "alignof(" << *AllocTy << ")";
 229       return;
 230     }
 231
 232     Type *CTy;
 233     Constant *FieldNo;
 234     if (U->isOffsetOf(CTy, FieldNo)) {
 235       OS << "offsetof(" << *CTy << ", ";
 236       FieldNo->printAsOperand(OS, false);
 237       OS << ")";
 238       return;
 239     }
 240
 241     // Otherwise just print it normally.
 242     U->getValue()->printAsOperand(OS, false);
 243     return;
 244   }
 245   case scCouldNotCompute:
 246     OS << "***COULDNOTCOMPUTE***";
 247     return;
 248   }
 249   llvm_unreachable("Unknown SCEV kind!");
 250 }
 251
 252 Type *SCEV::getType() const {
 253   switch (static_cast<SCEVTypes>(getSCEVType())) {
 254   case scConstant:
 255     return cast<SCEVConstant>(this)->getType();
 256   case scTruncate:
 257   case scZeroExtend:
 258   case scSignExtend:
 259     return cast<SCEVCastExpr>(this)->getType();
 260   case scAddRecExpr:
 261   case scMulExpr:
 262   case scUMaxExpr:
 263   case scSMaxExpr:
 264     return cast<SCEVNAryExpr>(this)->getType();
 265   case scAddExpr:
 266     return cast<SCEVAddExpr>(this)->getType();
 267   case scUDivExpr:
 268     return cast<SCEVUDivExpr>(this)->getType();
 269   case scUnknown:
 270     return cast<SCEVUnknown>(this)->getType();
 271   case scCouldNotCompute:
 272     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
 273   }
 274   llvm_unreachable("Unknown SCEV kind!");
 275 }
 276
 277 bool SCEV::isZero() const {
 278   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
 279     return SC->getValue()->isZero();
 280   return false;
 281 }
 282
 283 bool SCEV::isOne() const {
 284   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
 285     return SC->getValue()->isOne();
 286   return false;
 287 }
 288
 289 bool SCEV::isAllOnesValue() const {
 290   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
 291     return SC->getValue()->isAllOnesValue();
 292   return false;
 293 }
 294
 295 /// isNonConstantNegative - Return true if the specified scev is negated, but
 296 /// not a constant.
 297 bool SCEV::isNonConstantNegative() const {
 298   const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(this);
 299   if (!Mul) return false;
 300
 301   // If there is a constant factor, it will be first.
 302   const SCEVConstant *SC = dyn_cast<SCEVConstant>(Mul->getOperand(0));
 303   if (!SC) return false;
 304
 305   // Return true if the value is negative, this matches things like (-42 * V).
 306   return SC->getValue()->getValue().isNegative();
 307 }
 308
 309 SCEVCouldNotCompute::SCEVCouldNotCompute() :
 310   SCEV(FoldingSetNodeIDRef(), scCouldNotCompute) {}
 311
 312 bool SCEVCouldNotCompute::classof(const SCEV *S) {
 313   return S->getSCEVType() == scCouldNotCompute;
 314 }
 315
 316 const SCEV *ScalarEvolution::getConstant(ConstantInt *V) {
 317   FoldingSetNodeID ID;
 318   ID.AddInteger(scConstant);
 319   ID.AddPointer(V);
 320   void *IP = nullptr;
 321   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
 322   SCEV *S = new (SCEVAllocator) SCEVConstant(ID.Intern(SCEVAllocator), V);
 323   UniqueSCEVs.InsertNode(S, IP);
 324   return S;
 325 }
 326
 327 const SCEV *ScalarEvolution::getConstant(const APInt &Val) {
 328   return getConstant(ConstantInt::get(getContext(), Val));
 329 }
 330
 331 const SCEV *
 332 ScalarEvolution::getConstant(Type *Ty, uint64_t V, bool isSigned) {
 333   IntegerType *ITy = cast<IntegerType>(getEffectiveSCEVType(Ty));
 334   return getConstant(ConstantInt::get(ITy, V, isSigned));
 335 }
 336
 337 SCEVCastExpr::SCEVCastExpr(const FoldingSetNodeIDRef ID,
 338                            unsigned SCEVTy, const SCEV *op, Type *ty)
 339   : SCEV(ID, SCEVTy), Op(op), Ty(ty) {}
 340
 341 SCEVTruncateExpr::SCEVTruncateExpr(const FoldingSetNodeIDRef ID,
 342                                    const SCEV *op, Type *ty)
 343   : SCEVCastExpr(ID, scTruncate, op, ty) {
 344   assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
 345          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
 346          "Cannot truncate non-integer value!");
 347 }
 348
 349 SCEVZeroExtendExpr::SCEVZeroExtendExpr(const FoldingSetNodeIDRef ID,
 350                                        const SCEV *op, Type *ty)
 351   : SCEVCastExpr(ID, scZeroExtend, op, ty) {
 352   assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
 353          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
 354          "Cannot zero extend non-integer value!");
 355 }
 356
 357 SCEVSignExtendExpr::SCEVSignExtendExpr(const FoldingSetNodeIDRef ID,
 358                                        const SCEV *op, Type *ty)
 359   : SCEVCastExpr(ID, scSignExtend, op, ty) {
 360   assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
 361          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
 362          "Cannot sign extend non-integer value!");
 363 }
 364
 365 void SCEVUnknown::deleted() {
 366   // Clear this SCEVUnknown from various maps.
 367   SE->forgetMemoizedResults(this);
 368
 369   // Remove this SCEVUnknown from the uniquing map.
 370   SE->UniqueSCEVs.RemoveNode(this);
 371
 372   // Release the value.
 373   setValPtr(nullptr);
 374 }
 375
 376 void SCEVUnknown::allUsesReplacedWith(Value *New) {
 377   // Clear this SCEVUnknown from various maps.
 378   SE->forgetMemoizedResults(this);
 379
 380   // Remove this SCEVUnknown from the uniquing map.
 381   SE->UniqueSCEVs.RemoveNode(this);
 382
 383   // Update this SCEVUnknown to point to the new value. This is needed
 384   // because there may still be outstanding SCEVs which still point to
 385   // this SCEVUnknown.
 386   setValPtr(New);
 387 }
 388
 389 bool SCEVUnknown::isSizeOf(Type *&AllocTy) const {
 390   if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
 391     if (VCE->getOpcode() == Instruction::PtrToInt)
 392       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
 393         if (CE->getOpcode() == Instruction::GetElementPtr &&
 394             CE->getOperand(0)->isNullValue() &&
 395             CE->getNumOperands() == 2)
 396           if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(1)))
 397             if (CI->isOne()) {
 398               AllocTy = cast<PointerType>(CE->getOperand(0)->getType())
 399                                  ->getElementType();
 400               return true;
 401             }
 402
 403   return false;
 404 }
 405
 406 bool SCEVUnknown::isAlignOf(Type *&AllocTy) const {
 407   if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
 408     if (VCE->getOpcode() == Instruction::PtrToInt)
 409       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
 410         if (CE->getOpcode() == Instruction::GetElementPtr &&
 411             CE->getOperand(0)->isNullValue()) {
 412           Type *Ty =
 413             cast<PointerType>(CE->getOperand(0)->getType())->getElementType();
 414           if (StructType *STy = dyn_cast<StructType>(Ty))
 415             if (!STy->isPacked() &&
 416                 CE->getNumOperands() == 3 &&
 417                 CE->getOperand(1)->isNullValue()) {
 418               if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(2)))
 419                 if (CI->isOne() &&
 420                     STy->getNumElements() == 2 &&
 421                     STy->getElementType(0)->isIntegerTy(1)) {
 422                   AllocTy = STy->getElementType(1);
 423                   return true;
 424                 }
 425             }
 426         }
 427
 428   return false;
 429 }
 430
 431 bool SCEVUnknown::isOffsetOf(Type *&CTy, Constant *&FieldNo) const {
 432   if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
 433     if (VCE->getOpcode() == Instruction::PtrToInt)
 434       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
 435         if (CE->getOpcode() == Instruction::GetElementPtr &&
 436             CE->getNumOperands() == 3 &&
 437             CE->getOperand(0)->isNullValue() &&
 438             CE->getOperand(1)->isNullValue()) {
 439           Type *Ty =
 440             cast<PointerType>(CE->getOperand(0)->getType())->getElementType();
 441           // Ignore vector types here so that ScalarEvolutionExpander doesn't
 442           // emit getelementptrs that index into vectors.
 443           if (Ty->isStructTy() || Ty->isArrayTy()) {
 444             CTy = Ty;
 445             FieldNo = CE->getOperand(2);
 446             return true;
 447           }
 448         }
 449
 450   return false;
 451 }
 452
 453 //===----------------------------------------------------------------------===//
 454 //                               SCEV Utilities
 455 //===----------------------------------------------------------------------===//
 456
 457 namespace {
 458   /// SCEVComplexityCompare - Return true if the complexity of the LHS is less
 459   /// than the complexity of the RHS.  This comparator is used to canonicalize
 460   /// expressions.
 461   class SCEVComplexityCompare {
 462     const LoopInfo *const LI;
 463   public:
 464     explicit SCEVComplexityCompare(const LoopInfo *li) : LI(li) {}
 465
 466     // Return true or false if LHS is less than, or at least RHS, respectively.
 467     bool operator()(const SCEV *LHS, const SCEV *RHS) const {
 468       return compare(LHS, RHS) < 0;
 469     }
 470
 471     // Return negative, zero, or positive, if LHS is less than, equal to, or
 472     // greater than RHS, respectively. A three-way result allows recursive
 473     // comparisons to be more efficient.
 474     int compare(const SCEV *LHS, const SCEV *RHS) const {
 475       // Fast-path: SCEVs are uniqued so we can do a quick equality check.
 476       if (LHS == RHS)
 477         return 0;
 478
 479       // Primarily, sort the SCEVs by their getSCEVType().
 480       unsigned LType = LHS->getSCEVType(), RType = RHS->getSCEVType();
 481       if (LType != RType)
 482         return (int)LType - (int)RType;
 483
 484       // Aside from the getSCEVType() ordering, the particular ordering
 485       // isn't very important except that it's beneficial to be consistent,
 486       // so that (a + b) and (b + a) don't end up as different expressions.
 487       switch (static_cast<SCEVTypes>(LType)) {
 488       case scUnknown: {
 489         const SCEVUnknown *LU = cast<SCEVUnknown>(LHS);
 490         const SCEVUnknown *RU = cast<SCEVUnknown>(RHS);
 491
 492         // Sort SCEVUnknown values with some loose heuristics. TODO: This is
 493         // not as complete as it could be.
 494         const Value *LV = LU->getValue(), *RV = RU->getValue();
 495
 496         // Order pointer values after integer values. This helps SCEVExpander
 497         // form GEPs.
 498         bool LIsPointer = LV->getType()->isPointerTy(),
 499              RIsPointer = RV->getType()->isPointerTy();
 500         if (LIsPointer != RIsPointer)
 501           return (int)LIsPointer - (int)RIsPointer;
 502
 503         // Compare getValueID values.
 504         unsigned LID = LV->getValueID(),
 505                  RID = RV->getValueID();
 506         if (LID != RID)
 507           return (int)LID - (int)RID;
 508
 509         // Sort arguments by their position.
 510         if (const Argument *LA = dyn_cast<Argument>(LV)) {
 511           const Argument *RA = cast<Argument>(RV);
 512           unsigned LArgNo = LA->getArgNo(), RArgNo = RA->getArgNo();
 513           return (int)LArgNo - (int)RArgNo;
 514         }
 515
 516         // For instructions, compare their loop depth, and their operand
 517         // count.  This is pretty loose.
 518         if (const Instruction *LInst = dyn_cast<Instruction>(LV)) {
 519           const Instruction *RInst = cast<Instruction>(RV);
 520
 521           // Compare loop depths.
 522           const BasicBlock *LParent = LInst->getParent(),
 523                            *RParent = RInst->getParent();
 524           if (LParent != RParent) {
 525             unsigned LDepth = LI->getLoopDepth(LParent),
 526                      RDepth = LI->getLoopDepth(RParent);
 527             if (LDepth != RDepth)
 528               return (int)LDepth - (int)RDepth;
 529           }
 530
 531           // Compare the number of operands.
 532           unsigned LNumOps = LInst->getNumOperands(),
 533                    RNumOps = RInst->getNumOperands();
 534           return (int)LNumOps - (int)RNumOps;
 535         }
 536
 537         return 0;
 538       }
 539
 540       case scConstant: {
 541         const SCEVConstant *LC = cast<SCEVConstant>(LHS);
 542         const SCEVConstant *RC = cast<SCEVConstant>(RHS);
 543
 544         // Compare constant values.
 545         const APInt &LA = LC->getValue()->getValue();
 546         const APInt &RA = RC->getValue()->getValue();
 547         unsigned LBitWidth = LA.getBitWidth(), RBitWidth = RA.getBitWidth();
 548         if (LBitWidth != RBitWidth)
 549           return (int)LBitWidth - (int)RBitWidth;
 550         return LA.ult(RA) ? -1 : 1;
 551       }
 552
 553       case scAddRecExpr: {
 554         const SCEVAddRecExpr *LA = cast<SCEVAddRecExpr>(LHS);
 555         const SCEVAddRecExpr *RA = cast<SCEVAddRecExpr>(RHS);
 556
 557         // Compare addrec loop depths.
 558         const Loop *LLoop = LA->getLoop(), *RLoop = RA->getLoop();
 559         if (LLoop != RLoop) {
 560           unsigned LDepth = LLoop->getLoopDepth(),
 561                    RDepth = RLoop->getLoopDepth();
 562           if (LDepth != RDepth)
 563             return (int)LDepth - (int)RDepth;
 564         }
 565
 566         // Addrec complexity grows with operand count.
 567         unsigned LNumOps = LA->getNumOperands(), RNumOps = RA->getNumOperands();
 568         if (LNumOps != RNumOps)
 569           return (int)LNumOps - (int)RNumOps;
 570
 571         // Lexicographically compare.
 572         for (unsigned i = 0; i != LNumOps; ++i) {
 573           long X = compare(LA->getOperand(i), RA->getOperand(i));
 574           if (X != 0)
 575             return X;
 576         }
 577
 578         return 0;
 579       }
 580
 581       case scAddExpr:
 582       case scMulExpr:
 583       case scSMaxExpr:
 584       case scUMaxExpr: {
 585         const SCEVNAryExpr *LC = cast<SCEVNAryExpr>(LHS);
 586         const SCEVNAryExpr *RC = cast<SCEVNAryExpr>(RHS);
 587
 588         // Lexicographically compare n-ary expressions.
 589         unsigned LNumOps = LC->getNumOperands(), RNumOps = RC->getNumOperands();
 590         if (LNumOps != RNumOps)
 591           return (int)LNumOps - (int)RNumOps;
 592
 593         for (unsigned i = 0; i != LNumOps; ++i) {
 594           if (i >= RNumOps)
 595             return 1;
 596           long X = compare(LC->getOperand(i), RC->getOperand(i));
 597           if (X != 0)
 598             return X;
 599         }
 600         return (int)LNumOps - (int)RNumOps;
 601       }
 602
 603       case scUDivExpr: {
 604         const SCEVUDivExpr *LC = cast<SCEVUDivExpr>(LHS);
 605         const SCEVUDivExpr *RC = cast<SCEVUDivExpr>(RHS);
 606
 607         // Lexicographically compare udiv expressions.
 608         long X = compare(LC->getLHS(), RC->getLHS());
 609         if (X != 0)
 610           return X;
 611         return compare(LC->getRHS(), RC->getRHS());
 612       }
 613
 614       case scTruncate:
 615       case scZeroExtend:
 616       case scSignExtend: {
 617         const SCEVCastExpr *LC = cast<SCEVCastExpr>(LHS);
 618         const SCEVCastExpr *RC = cast<SCEVCastExpr>(RHS);
 619
 620         // Compare cast expressions by operand.
 621         return compare(LC->getOperand(), RC->getOperand());
 622       }
 623
 624       case scCouldNotCompute:
 625         llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
 626       }
 627       llvm_unreachable("Unknown SCEV kind!");
 628     }
 629   };
 630 }
 631
 632 /// GroupByComplexity - Given a list of SCEV objects, order them by their
 633 /// complexity, and group objects of the same complexity together by value.
 634 /// When this routine is finished, we know that any duplicates in the vector are
 635 /// consecutive and that complexity is monotonically increasing.
 636 ///
 637 /// Note that we go take special precautions to ensure that we get deterministic
 638 /// results from this routine.  In other words, we don't want the results of
 639 /// this to depend on where the addresses of various SCEV objects happened to
 640 /// land in memory.
 641 ///
 642 static void GroupByComplexity(SmallVectorImpl<const SCEV *> &Ops,
 643                               LoopInfo *LI) {
 644   if (Ops.size() < 2) return;  // Noop
 645   if (Ops.size() == 2) {
 646     // This is the common case, which also happens to be trivially simple.
 647     // Special case it.
 648     const SCEV *&LHS = Ops[0], *&RHS = Ops[1];
 649     if (SCEVComplexityCompare(LI)(RHS, LHS))
 650       std::swap(LHS, RHS);
 651     return;
 652   }
 653
 654   // Do the rough sort by complexity.
 655   std::stable_sort(Ops.begin(), Ops.end(), SCEVComplexityCompare(LI));
 656
 657   // Now that we are sorted by complexity, group elements of the same
 658   // complexity.  Note that this is, at worst, N^2, but the vector is likely to
 659   // be extremely short in practice.  Note that we take this approach because we
 660   // do not want to depend on the addresses of the objects we are grouping.
 661   for (unsigned i = 0, e = Ops.size(); i != e-2; ++i) {
 662     const SCEV *S = Ops[i];
 663     unsigned Complexity = S->getSCEVType();
 664
 665     // If there are any objects of the same complexity and same value as this
 666     // one, group them.
 667     for (unsigned j = i+1; j != e && Ops[j]->getSCEVType() == Complexity; ++j) {
 668       if (Ops[j] == S) { // Found a duplicate.
 669         // Move it to immediately after i'th element.
 670         std::swap(Ops[i+1], Ops[j]);
 671         ++i;   // no need to rescan it.
 672         if (i == e-2) return;  // Done!
 673       }
 674     }
 675   }
 676 }
 677
 678 namespace {
 679 struct FindSCEVSize {
 680   int Size;
 681   FindSCEVSize() : Size(0) {}
 682
 683   bool follow(const SCEV *S) {
 684     ++Size;
 685     // Keep looking at all operands of S.
 686     return true;
 687   }
 688   bool isDone() const {
 689     return false;
 690   }
 691 };
 692 }
 693
 694 // Returns the size of the SCEV S.
 695 static inline int sizeOfSCEV(const SCEV *S) {
 696   FindSCEVSize F;
 697   SCEVTraversal<FindSCEVSize> ST(F);
 698   ST.visitAll(S);
 699   return F.Size;
 700 }
 701
 702 namespace {
 703
 704 struct SCEVDivision : public SCEVVisitor<SCEVDivision, void> {
 705 public:
 706   // Computes the Quotient and Remainder of the division of Numerator by
 707   // Denominator.
 708   static void divide(ScalarEvolution &SE, const SCEV *Numerator,
 709                      const SCEV *Denominator, const SCEV **Quotient,
 710                      const SCEV **Remainder) {
 711     assert(Numerator && Denominator && "Uninitialized SCEV");
 712
 713     SCEVDivision D(SE, Numerator, Denominator);
 714
 715     // Check for the trivial case here to avoid having to check for it in the
 716     // rest of the code.
 717     if (Numerator == Denominator) {
 718       *Quotient = D.One;
 719       *Remainder = D.Zero;
 720       return;
 721     }
 722
 723     if (Numerator->isZero()) {
 724       *Quotient = D.Zero;
 725       *Remainder = D.Zero;
 726       return;
 727     }
 728
 729     // Split the Denominator when it is a product.
 730     if (const SCEVMulExpr *T = dyn_cast<const SCEVMulExpr>(Denominator)) {
 731       const SCEV *Q, *R;
 732       *Quotient = Numerator;
 733       for (const SCEV *Op : T->operands()) {
 734         divide(SE, *Quotient, Op, &Q, &R);
 735         *Quotient = Q;
 736
 737         // Bail out when the Numerator is not divisible by one of the terms of
 738         // the Denominator.
 739         if (!R->isZero()) {
 740           *Quotient = D.Zero;
 741           *Remainder = Numerator;
 742           return;
 743         }
 744       }
 745       *Remainder = D.Zero;
 746       return;
 747     }
 748
 749     D.visit(Numerator);
 750     *Quotient = D.Quotient;
 751     *Remainder = D.Remainder;
 752   }
 753
 754   // Except in the trivial case described above, we do not know how to divide
 755   // Expr by Denominator for the following functions with empty implementation.
 756   void visitTruncateExpr(const SCEVTruncateExpr *Numerator) {}
 757   void visitZeroExtendExpr(const SCEVZeroExtendExpr *Numerator) {}
 758   void visitSignExtendExpr(const SCEVSignExtendExpr *Numerator) {}
 759   void visitUDivExpr(const SCEVUDivExpr *Numerator) {}
 760   void visitSMaxExpr(const SCEVSMaxExpr *Numerator) {}
 761   void visitUMaxExpr(const SCEVUMaxExpr *Numerator) {}
 762   void visitUnknown(const SCEVUnknown *Numerator) {}
 763   void visitCouldNotCompute(const SCEVCouldNotCompute *Numerator) {}
 764
 765   void visitConstant(const SCEVConstant *Numerator) {
 766     if (const SCEVConstant *D = dyn_cast<SCEVConstant>(Denominator)) {
 767       APInt NumeratorVal = Numerator->getValue()->getValue();
 768       APInt DenominatorVal = D->getValue()->getValue();
 769       uint32_t NumeratorBW = NumeratorVal.getBitWidth();
 770       uint32_t DenominatorBW = DenominatorVal.getBitWidth();
 771
 772       if (NumeratorBW > DenominatorBW)
 773         DenominatorVal = DenominatorVal.sext(NumeratorBW);
 774       else if (NumeratorBW < DenominatorBW)
 775         NumeratorVal = NumeratorVal.sext(DenominatorBW);
 776
 777       APInt QuotientVal(NumeratorVal.getBitWidth(), 0);
 778       APInt RemainderVal(NumeratorVal.getBitWidth(), 0);
 779       APInt::sdivrem(NumeratorVal, DenominatorVal, QuotientVal, RemainderVal);
 780       Quotient = SE.getConstant(QuotientVal);
 781       Remainder = SE.getConstant(RemainderVal);
 782       return;
 783     }
 784   }
 785
 786   void visitAddRecExpr(const SCEVAddRecExpr *Numerator) {
 787     const SCEV *StartQ, *StartR, *StepQ, *StepR;
 788     assert(Numerator->isAffine() && "Numerator should be affine");
 789     divide(SE, Numerator->getStart(), Denominator, &StartQ, &StartR);
 790     divide(SE, Numerator->getStepRecurrence(SE), Denominator, &StepQ, &StepR);
 791     Quotient = SE.getAddRecExpr(StartQ, StepQ, Numerator->getLoop(),
 792                                 Numerator->getNoWrapFlags());
 793     Remainder = SE.getAddRecExpr(StartR, StepR, Numerator->getLoop(),
 794                                  Numerator->getNoWrapFlags());
 795   }
 796
 797   void visitAddExpr(const SCEVAddExpr *Numerator) {
 798     SmallVector<const SCEV *, 2> Qs, Rs;
 799     Type *Ty = Denominator->getType();
 800
 801     for (const SCEV *Op : Numerator->operands()) {
 802       const SCEV *Q, *R;
 803       divide(SE, Op, Denominator, &Q, &R);
 804
 805       // Bail out if types do not match.
 806       if (Ty != Q->getType() || Ty != R->getType()) {
 807         Quotient = Zero;
 808         Remainder = Numerator;
 809         return;
 810       }
 811
 812       Qs.push_back(Q);
 813       Rs.push_back(R);
 814     }
 815
 816     if (Qs.size() == 1) {
 817       Quotient = Qs[0];
 818       Remainder = Rs[0];
 819       return;
 820     }
 821
 822     Quotient = SE.getAddExpr(Qs);
 823     Remainder = SE.getAddExpr(Rs);
 824   }
 825
 826   void visitMulExpr(const SCEVMulExpr *Numerator) {
 827     SmallVector<const SCEV *, 2> Qs;
 828     Type *Ty = Denominator->getType();
 829
 830     bool FoundDenominatorTerm = false;
 831     for (const SCEV *Op : Numerator->operands()) {
 832       // Bail out if types do not match.
 833       if (Ty != Op->getType()) {
 834         Quotient = Zero;
 835         Remainder = Numerator;
 836         return;
 837       }
 838
 839       if (FoundDenominatorTerm) {
 840         Qs.push_back(Op);
 841         continue;
 842       }
 843
 844       // Check whether Denominator divides one of the product operands.
 845       const SCEV *Q, *R;
 846       divide(SE, Op, Denominator, &Q, &R);
 847       if (!R->isZero()) {
 848         Qs.push_back(Op);
 849         continue;
 850       }
 851
 852       // Bail out if types do not match.
 853       if (Ty != Q->getType()) {
 854         Quotient = Zero;
 855         Remainder = Numerator;
 856         return;
 857       }
 858
 859       FoundDenominatorTerm = true;
 860       Qs.push_back(Q);
 861     }
 862
 863     if (FoundDenominatorTerm) {
 864       Remainder = Zero;
 865       if (Qs.size() == 1)
 866         Quotient = Qs[0];
 867       else
 868         Quotient = SE.getMulExpr(Qs);
 869       return;
 870     }
 871
 872     if (!isa<SCEVUnknown>(Denominator)) {
 873       Quotient = Zero;
 874       Remainder = Numerator;
 875       return;
 876     }
 877
 878     // The Remainder is obtained by replacing Denominator by 0 in Numerator.
 879     ValueToValueMap RewriteMap;
 880     RewriteMap[cast<SCEVUnknown>(Denominator)->getValue()] =
 881         cast<SCEVConstant>(Zero)->getValue();
 882     Remainder = SCEVParameterRewriter::rewrite(Numerator, SE, RewriteMap, true);
 883
 884     if (Remainder->isZero()) {
 885       // The Quotient is obtained by replacing Denominator by 1 in Numerator.
 886       RewriteMap[cast<SCEVUnknown>(Denominator)->getValue()] =
 887           cast<SCEVConstant>(One)->getValue();
 888       Quotient =
 889           SCEVParameterRewriter::rewrite(Numerator, SE, RewriteMap, true);
 890       return;
 891     }
 892
 893     // Quotient is (Numerator - Remainder) divided by Denominator.
 894     const SCEV *Q, *R;
 895     const SCEV *Diff = SE.getMinusSCEV(Numerator, Remainder);
 896     if (sizeOfSCEV(Diff) > sizeOfSCEV(Numerator)) {
 897       // This SCEV does not seem to simplify: fail the division here.
 898       Quotient = Zero;
 899       Remainder = Numerator;
 900       return;
 901     }
 902     divide(SE, Diff, Denominator, &Q, &R);
 903     assert(R == Zero &&
 904            "(Numerator - Remainder) should evenly divide Denominator");
 905     Quotient = Q;
 906   }
 907
 908 private:
 909   SCEVDivision(ScalarEvolution &S, const SCEV *Numerator,
 910                const SCEV *Denominator)
 911       : SE(S), Denominator(Denominator) {
 912     Zero = SE.getConstant(Denominator->getType(), 0);
 913     One = SE.getConstant(Denominator->getType(), 1);
 914
 915     // By default, we don't know how to divide Expr by Denominator.
 916     // Providing the default here simplifies the rest of the code.
 917     Quotient = Zero;
 918     Remainder = Numerator;
 919   }
 920
 921   ScalarEvolution &SE;
 922   const SCEV *Denominator, *Quotient, *Remainder, *Zero, *One;
 923 };
 924
 925 }
 926
 927 //===----------------------------------------------------------------------===//
 928 //                      Simple SCEV method implementations
 929 //===----------------------------------------------------------------------===//
 930
 931 /// BinomialCoefficient - Compute BC(It, K).  The result has width W.
 932 /// Assume, K > 0.
 933 static const SCEV *BinomialCoefficient(const SCEV *It, unsigned K,
 934                                        ScalarEvolution &SE,
 935                                        Type *ResultTy) {
 936   // Handle the simplest case efficiently.
 937   if (K == 1)
 938     return SE.getTruncateOrZeroExtend(It, ResultTy);
 939
 940   // We are using the following formula for BC(It, K):
 941   //
 942   //   BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / K!
 943   //
 944   // Suppose, W is the bitwidth of the return value.  We must be prepared for
 945   // overflow.  Hence, we must assure that the result of our computation is
 946   // equal to the accurate one modulo 2^W.  Unfortunately, division isn't
 947   // safe in modular arithmetic.
 948   //
 949   // However, this code doesn't use exactly that formula; the formula it uses
 950   // is something like the following, where T is the number of factors of 2 in
 951   // K! (i.e. trailing zeros in the binary representation of K!), and ^ is
 952   // exponentiation:
 953   //
 954   //   BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / 2^T / (K! / 2^T)
 955   //
 956   // This formula is trivially equivalent to the previous formula.  However,
 957   // this formula can be implemented much more efficiently.  The trick is that
 958   // K! / 2^T is odd, and exact division by an odd number *is* safe in modular
 959   // arithmetic.  To do exact division in modular arithmetic, all we have
 960   // to do is multiply by the inverse.  Therefore, this step can be done at
 961   // width W.
 962   //
 963   // The next issue is how to safely do the division by 2^T.  The way this
 964   // is done is by doing the multiplication step at a width of at least W + T
 965   // bits.  This way, the bottom W+T bits of the product are accurate. Then,
 966   // when we perform the division by 2^T (which is equivalent to a right shift
 967   // by T), the bottom W bits are accurate.  Extra bits are okay; they'll get
 968   // truncated out after the division by 2^T.
 969   //
 970   // In comparison to just directly using the first formula, this technique
 971   // is much more efficient; using the first formula requires W * K bits,
 972   // but this formula less than W + K bits. Also, the first formula requires
 973   // a division step, whereas this formula only requires multiplies and shifts.
 974   //
 975   // It doesn't matter whether the subtraction step is done in the calculation
 976   // width or the input iteration count's width; if the subtraction overflows,
 977   // the result must be zero anyway.  We prefer here to do it in the width of
 978   // the induction variable because it helps a lot for certain cases; CodeGen
 979   // isn't smart enough to ignore the overflow, which leads to much less
 980   // efficient code if the width of the subtraction is wider than the native
 981   // register width.
 982   //
 983   // (It's possible to not widen at all by pulling out factors of 2 before
 984   // the multiplication; for example, K=2 can be calculated as
 985   // It/2*(It+(It*INT_MIN/INT_MIN)+-1). However, it requires
 986   // extra arithmetic, so it's not an obvious win, and it gets
 987   // much more complicated for K > 3.)
 988
 989   // Protection from insane SCEVs; this bound is conservative,
 990   // but it probably doesn't matter.
 991   if (K > 1000)
 992     return SE.getCouldNotCompute();
 993
 994   unsigned W = SE.getTypeSizeInBits(ResultTy);
 995
 996   // Calculate K! / 2^T and T; we divide out the factors of two before
 997   // multiplying for calculating K! / 2^T to avoid overflow.
 998   // Other overflow doesn't matter because we only care about the bottom
 999   // W bits of the result.
1000   APInt OddFactorial(W, 1);
1001   unsigned T = 1;
1002   for (unsigned i = 3; i <= K; ++i) {
1003     APInt Mult(W, i);
1004     unsigned TwoFactors = Mult.countTrailingZeros();
1005     T += TwoFactors;
1006     Mult = Mult.lshr(TwoFactors);
1007     OddFactorial *= Mult;
1008   }
1009
1010   // We need at least W + T bits for the multiplication step
1011   unsigned CalculationBits = W + T;
1012
1013   // Calculate 2^T, at width T+W.
1014   APInt DivFactor = APInt::getOneBitSet(CalculationBits, T);
1015
1016   // Calculate the multiplicative inverse of K! / 2^T;
1017   // this multiplication factor will perform the exact division by
1018   // K! / 2^T.
1019   APInt Mod = APInt::getSignedMinValue(W+1);
1020   APInt MultiplyFactor = OddFactorial.zext(W+1);
1021   MultiplyFactor = MultiplyFactor.multiplicativeInverse(Mod);
1022   MultiplyFactor = MultiplyFactor.trunc(W);
1023
1024   // Calculate the product, at width T+W
1025   IntegerType *CalculationTy = IntegerType::get(SE.getContext(),
1026                                                       CalculationBits);
1027   const SCEV *Dividend = SE.getTruncateOrZeroExtend(It, CalculationTy);
1028   for (unsigned i = 1; i != K; ++i) {
1029     const SCEV *S = SE.getMinusSCEV(It, SE.getConstant(It->getType(), i));
1030     Dividend = SE.getMulExpr(Dividend,
1031                              SE.getTruncateOrZeroExtend(S, CalculationTy));
1032   }
1033
1034   // Divide by 2^T
1035   const SCEV *DivResult = SE.getUDivExpr(Dividend, SE.getConstant(DivFactor));
1036
1037   // Truncate the result, and divide by K! / 2^T.
1038
1039   return SE.getMulExpr(SE.getConstant(MultiplyFactor),
1040                        SE.getTruncateOrZeroExtend(DivResult, ResultTy));
1041 }
1042
1043 /// evaluateAtIteration - Return the value of this chain of recurrences at
1044 /// the specified iteration number.  We can evaluate this recurrence by
1045 /// multiplying each element in the chain by the binomial coefficient
1046 /// corresponding to it.  In other words, we can evaluate {A,+,B,+,C,+,D} as:
1047 ///
1048 ///   A*BC(It, 0) + B*BC(It, 1) + C*BC(It, 2) + D*BC(It, 3)
1049 ///
1050 /// where BC(It, k) stands for binomial coefficient.
1051 ///
1052 const SCEV *SCEVAddRecExpr::evaluateAtIteration(const SCEV *It,
1053                                                 ScalarEvolution &SE) const {
1054   const SCEV *Result = getStart();
1055   for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
1056     // The computation is correct in the face of overflow provided that the
1057     // multiplication is performed _after_ the evaluation of the binomial
1058     // coefficient.
1059     const SCEV *Coeff = BinomialCoefficient(It, i, SE, getType());
1060     if (isa<SCEVCouldNotCompute>(Coeff))
1061       return Coeff;
1062
1063     Result = SE.getAddExpr(Result, SE.getMulExpr(getOperand(i), Coeff));
1064   }
1065   return Result;
1066 }
1067
1068 //===----------------------------------------------------------------------===//
1069 //                    SCEV Expression folder implementations
1070 //===----------------------------------------------------------------------===//
1071
1072 const SCEV *ScalarEvolution::getTruncateExpr(const SCEV *Op,
1073                                              Type *Ty) {
1074   assert(getTypeSizeInBits(Op->getType()) > getTypeSizeInBits(Ty) &&
1075          "This is not a truncating conversion!");
1076   assert(isSCEVable(Ty) &&
1077          "This is not a conversion to a SCEVable type!");
1078   Ty = getEffectiveSCEVType(Ty);
1079
1080   FoldingSetNodeID ID;
1081   ID.AddInteger(scTruncate);
1082   ID.AddPointer(Op);
1083   ID.AddPointer(Ty);
1084   void *IP = nullptr;
1085   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1086
1087   // Fold if the operand is constant.
1088   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1089     return getConstant(
1090       cast<ConstantInt>(ConstantExpr::getTrunc(SC->getValue(), Ty)));
1091
1092   // trunc(trunc(x)) --> trunc(x)
1093   if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op))
1094     return getTruncateExpr(ST->getOperand(), Ty);
1095
1096   // trunc(sext(x)) --> sext(x) if widening or trunc(x) if narrowing
1097   if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op))
1098     return getTruncateOrSignExtend(SS->getOperand(), Ty);
1099
1100   // trunc(zext(x)) --> zext(x) if widening or trunc(x) if narrowing
1101   if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
1102     return getTruncateOrZeroExtend(SZ->getOperand(), Ty);
1103
1104   // trunc(x1+x2+...+xN) --> trunc(x1)+trunc(x2)+...+trunc(xN) if we can
1105   // eliminate all the truncates.
1106   if (const SCEVAddExpr *SA = dyn_cast<SCEVAddExpr>(Op)) {
1107     SmallVector<const SCEV *, 4> Operands;
1108     bool hasTrunc = false;
1109     for (unsigned i = 0, e = SA->getNumOperands(); i != e && !hasTrunc; ++i) {
1110       const SCEV *S = getTruncateExpr(SA->getOperand(i), Ty);
1111       hasTrunc = isa<SCEVTruncateExpr>(S);
1112       Operands.push_back(S);
1113     }
1114     if (!hasTrunc)
1115       return getAddExpr(Operands);
1116     UniqueSCEVs.FindNodeOrInsertPos(ID, IP);  // Mutates IP, returns NULL.
1117   }
1118
1119   // trunc(x1*x2*...*xN) --> trunc(x1)*trunc(x2)*...*trunc(xN) if we can
1120   // eliminate all the truncates.
1121   if (const SCEVMulExpr *SM = dyn_cast<SCEVMulExpr>(Op)) {
1122     SmallVector<const SCEV *, 4> Operands;
1123     bool hasTrunc = false;
1124     for (unsigned i = 0, e = SM->getNumOperands(); i != e && !hasTrunc; ++i) {
1125       const SCEV *S = getTruncateExpr(SM->getOperand(i), Ty);
1126       hasTrunc = isa<SCEVTruncateExpr>(S);
1127       Operands.push_back(S);
1128     }
1129     if (!hasTrunc)
1130       return getMulExpr(Operands);
1131     UniqueSCEVs.FindNodeOrInsertPos(ID, IP);  // Mutates IP, returns NULL.
1132   }
1133
1134   // If the input value is a chrec scev, truncate the chrec's operands.
1135   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(Op)) {
1136     SmallVector<const SCEV *, 4> Operands;
1137     for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i)
1138       Operands.push_back(getTruncateExpr(AddRec->getOperand(i), Ty));
1139     return getAddRecExpr(Operands, AddRec->getLoop(), SCEV::FlagAnyWrap);
1140   }
1141
1142   // The cast wasn't folded; create an explicit cast node. We can reuse
1143   // the existing insert position since if we get here, we won't have
1144   // made any changes which would invalidate it.
1145   SCEV *S = new (SCEVAllocator) SCEVTruncateExpr(ID.Intern(SCEVAllocator),
1146                                                  Op, Ty);
1147   UniqueSCEVs.InsertNode(S, IP);
1148   return S;
1149 }
1150
1151 // Get the limit of a recurrence such that incrementing by Step cannot cause
1152 // signed overflow as long as the value of the recurrence within the
1153 // loop does not exceed this limit before incrementing.
1154 static const SCEV *getSignedOverflowLimitForStep(const SCEV *Step,
1155                                                  ICmpInst::Predicate *Pred,
1156                                                  ScalarEvolution *SE) {
1157   unsigned BitWidth = SE->getTypeSizeInBits(Step->getType());
1158   if (SE->isKnownPositive(Step)) {
1159     *Pred = ICmpInst::ICMP_SLT;
1160     return SE->getConstant(APInt::getSignedMinValue(BitWidth) -
1161                            SE->getSignedRange(Step).getSignedMax());
1162   }
1163   if (SE->isKnownNegative(Step)) {
1164     *Pred = ICmpInst::ICMP_SGT;
1165     return SE->getConstant(APInt::getSignedMaxValue(BitWidth) -
1166                            SE->getSignedRange(Step).getSignedMin());
1167   }
1168   return nullptr;
1169 }
1170
1171 // Get the limit of a recurrence such that incrementing by Step cannot cause
1172 // unsigned overflow as long as the value of the recurrence within the loop does
1173 // not exceed this limit before incrementing.
1174 static const SCEV *getUnsignedOverflowLimitForStep(const SCEV *Step,
1175                                                    ICmpInst::Predicate *Pred,
1176                                                    ScalarEvolution *SE) {
1177   unsigned BitWidth = SE->getTypeSizeInBits(Step->getType());
1178   *Pred = ICmpInst::ICMP_ULT;
1179
1180   return SE->getConstant(APInt::getMinValue(BitWidth) -
1181                          SE->getUnsignedRange(Step).getUnsignedMax());
1182 }
1183
1184 namespace {
1185
1186 struct ExtendOpTraitsBase {
1187   typedef const SCEV *(ScalarEvolution::*GetExtendExprTy)(const SCEV *, Type *);
1188 };
1189
1190 // Used to make code generic over signed and unsigned overflow.
1191 template <typename ExtendOp> struct ExtendOpTraits {
1192   // Members present:
1193   //
1194   // static const SCEV::NoWrapFlags WrapType;
1195   //
1196   // static const ExtendOpTraitsBase::GetExtendExprTy GetExtendExpr;
1197   //
1198   // static const SCEV *getOverflowLimitForStep(const SCEV *Step,
1199   //                                           ICmpInst::Predicate *Pred,
1200   //                                           ScalarEvolution *SE);
1201 };
1202
1203 template <>
1204 struct ExtendOpTraits<SCEVSignExtendExpr> : public ExtendOpTraitsBase {
1205   static const SCEV::NoWrapFlags WrapType = SCEV::FlagNSW;
1206
1207   static const GetExtendExprTy GetExtendExpr;
1208
1209   static const SCEV *getOverflowLimitForStep(const SCEV *Step,
1210                                              ICmpInst::Predicate *Pred,
1211                                              ScalarEvolution *SE) {
1212     return getSignedOverflowLimitForStep(Step, Pred, SE);
1213   }
1214 };
1215
1216 const ExtendOpTraitsBase::GetExtendExprTy ExtendOpTraits<
1217     SCEVSignExtendExpr>::GetExtendExpr = &ScalarEvolution::getSignExtendExpr;
1218
1219 template <>
1220 struct ExtendOpTraits<SCEVZeroExtendExpr> : public ExtendOpTraitsBase {
1221   static const SCEV::NoWrapFlags WrapType = SCEV::FlagNUW;
1222
1223   static const GetExtendExprTy GetExtendExpr;
1224
1225   static const SCEV *getOverflowLimitForStep(const SCEV *Step,
1226                                              ICmpInst::Predicate *Pred,
1227                                              ScalarEvolution *SE) {
1228     return getUnsignedOverflowLimitForStep(Step, Pred, SE);
1229   }
1230 };
1231
1232 const ExtendOpTraitsBase::GetExtendExprTy ExtendOpTraits<
1233     SCEVZeroExtendExpr>::GetExtendExpr = &ScalarEvolution::getZeroExtendExpr;
1234 }
1235
1236 // The recurrence AR has been shown to have no signed/unsigned wrap or something
1237 // close to it. Typically, if we can prove NSW/NUW for AR, then we can just as
1238 // easily prove NSW/NUW for its preincrement or postincrement sibling. This
1239 // allows normalizing a sign/zero extended AddRec as such: {sext/zext(Step +
1240 // Start),+,Step} => {(Step + sext/zext(Start),+,Step} As a result, the
1241 // expression "Step + sext/zext(PreIncAR)" is congruent with
1242 // "sext/zext(PostIncAR)"
1243 template <typename ExtendOpTy>
1244 static const SCEV *getPreStartForExtend(const SCEVAddRecExpr *AR, Type *Ty,
1245                                         ScalarEvolution *SE) {
1246   auto WrapType = ExtendOpTraits<ExtendOpTy>::WrapType;
1247   auto GetExtendExpr = ExtendOpTraits<ExtendOpTy>::GetExtendExpr;
1248
1249   const Loop *L = AR->getLoop();
1250   const SCEV *Start = AR->getStart();
1251   const SCEV *Step = AR->getStepRecurrence(*SE);
1252
1253   // Check for a simple looking step prior to loop entry.
1254   const SCEVAddExpr *SA = dyn_cast<SCEVAddExpr>(Start);
1255   if (!SA)
1256     return nullptr;
1257
1258   // Create an AddExpr for "PreStart" after subtracting Step. Full SCEV
1259   // subtraction is expensive. For this purpose, perform a quick and dirty
1260   // difference, by checking for Step in the operand list.
1261   SmallVector<const SCEV *, 4> DiffOps;
1262   for (const SCEV *Op : SA->operands())
1263     if (Op != Step)
1264       DiffOps.push_back(Op);
1265
1266   if (DiffOps.size() == SA->getNumOperands())
1267     return nullptr;
1268
1269   // Try to prove `WrapType` (SCEV::FlagNSW or SCEV::FlagNUW) on `PreStart` +
1270   // `Step`:
1271
1272   // 1. NSW/NUW flags on the step increment.
1273   const SCEV *PreStart = SE->getAddExpr(DiffOps, SA->getNoWrapFlags());
1274   const SCEVAddRecExpr *PreAR = dyn_cast<SCEVAddRecExpr>(
1275       SE->getAddRecExpr(PreStart, Step, L, SCEV::FlagAnyWrap));
1276
1277   // "{S,+,X} is <nsw>/<nuw>" and "the backedge is taken at least once" implies
1278   // "S+X does not sign/unsign-overflow".
1279   //
1280
1281   const SCEV *BECount = SE->getBackedgeTakenCount(L);
1282   if (PreAR && PreAR->getNoWrapFlags(WrapType) &&
1283       !isa<SCEVCouldNotCompute>(BECount) && SE->isKnownPositive(BECount))
1284     return PreStart;
1285
1286   // 2. Direct overflow check on the step operation's expression.
1287   unsigned BitWidth = SE->getTypeSizeInBits(AR->getType());
1288   Type *WideTy = IntegerType::get(SE->getContext(), BitWidth * 2);
1289   const SCEV *OperandExtendedStart =
1290       SE->getAddExpr((SE->*GetExtendExpr)(PreStart, WideTy),
1291                      (SE->*GetExtendExpr)(Step, WideTy));
1292   if ((SE->*GetExtendExpr)(Start, WideTy) == OperandExtendedStart) {
1293     if (PreAR && AR->getNoWrapFlags(WrapType)) {
1294       // If we know `AR` == {`PreStart`+`Step`,+,`Step`} is `WrapType` (FlagNSW
1295       // or FlagNUW) and that `PreStart` + `Step` is `WrapType` too, then
1296       // `PreAR` == {`PreStart`,+,`Step`} is also `WrapType`.  Cache this fact.
1297       const_cast<SCEVAddRecExpr *>(PreAR)->setNoWrapFlags(WrapType);
1298     }
1299     return PreStart;
1300   }
1301
1302   // 3. Loop precondition.
1303   ICmpInst::Predicate Pred;
1304   const SCEV *OverflowLimit =
1305       ExtendOpTraits<ExtendOpTy>::getOverflowLimitForStep(Step, &Pred, SE);
1306
1307   if (OverflowLimit &&
1308       SE->isLoopEntryGuardedByCond(L, Pred, PreStart, OverflowLimit)) {
1309     return PreStart;
1310   }
1311   return nullptr;
1312 }
1313
1314 // Get the normalized zero or sign extended expression for this AddRec's Start.
1315 template <typename ExtendOpTy>
1316 static const SCEV *getExtendAddRecStart(const SCEVAddRecExpr *AR, Type *Ty,
1317                                         ScalarEvolution *SE) {
1318   auto GetExtendExpr = ExtendOpTraits<ExtendOpTy>::GetExtendExpr;
1319
1320   const SCEV *PreStart = getPreStartForExtend<ExtendOpTy>(AR, Ty, SE);
1321   if (!PreStart)
1322     return (SE->*GetExtendExpr)(AR->getStart(), Ty);
1323
1324   return SE->getAddExpr((SE->*GetExtendExpr)(AR->getStepRecurrence(*SE), Ty),
1325                         (SE->*GetExtendExpr)(PreStart, Ty));
1326 }
1327
1328 // Try to prove away overflow by looking at "nearby" add recurrences.  A
1329 // motivating example for this rule: if we know `{0,+,4}` is `ult` `-1` and it
1330 // does not itself wrap then we can conclude that `{1,+,4}` is `nuw`.
1331 //
1332 // Formally:
1333 //
1334 //     {S,+,X} == {S-T,+,X} + T
1335 //  => Ext({S,+,X}) == Ext({S-T,+,X} + T)
1336 //
1337 // If ({S-T,+,X} + T) does not overflow  ... (1)
1338 //
1339 //  RHS == Ext({S-T,+,X} + T) == Ext({S-T,+,X}) + Ext(T)
1340 //
1341 // If {S-T,+,X} does not overflow  ... (2)
1342 //
1343 //  RHS == Ext({S-T,+,X}) + Ext(T) == {Ext(S-T),+,Ext(X)} + Ext(T)
1344 //      == {Ext(S-T)+Ext(T),+,Ext(X)}
1345 //
1346 // If (S-T)+T does not overflow  ... (3)
1347 //
1348 //  RHS == {Ext(S-T)+Ext(T),+,Ext(X)} == {Ext(S-T+T),+,Ext(X)}
1349 //      == {Ext(S),+,Ext(X)} == LHS
1350 //
1351 // Thus, if (1), (2) and (3) are true for some T, then
1352 //   Ext({S,+,X}) == {Ext(S),+,Ext(X)}
1353 //
1354 // (3) is implied by (1) -- "(S-T)+T does not overflow" is simply "({S-T,+,X}+T)
1355 // does not overflow" restricted to the 0th iteration.  Therefore we only need
1356 // to check for (1) and (2).
1357 //
1358 // In the current context, S is `Start`, X is `Step`, Ext is `ExtendOpTy` and T
1359 // is `Delta` (defined below).
1360 //
1361 template <typename ExtendOpTy>
1362 bool ScalarEvolution::proveNoWrapByVaryingStart(const SCEV *Start,
1363                                                 const SCEV *Step,
1364                                                 const Loop *L) {
1365   auto WrapType = ExtendOpTraits<ExtendOpTy>::WrapType;
1366
1367   // We restrict `Start` to a constant to prevent SCEV from spending too much
1368   // time here.  It is correct (but more expensive) to continue with a
1369   // non-constant `Start` and do a general SCEV subtraction to compute
1370   // `PreStart` below.
1371   //
1372   const SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start);
1373   if (!StartC)
1374     return false;
1375
1376   APInt StartAI = StartC->getValue()->getValue();
1377
1378   for (unsigned Delta : {-2, -1, 1, 2}) {
1379     const SCEV *PreStart = getConstant(StartAI - Delta);
1380
1381     // Give up if we don't already have the add recurrence we need because
1382     // actually constructing an add recurrence is relatively expensive.
1383     const SCEVAddRecExpr *PreAR = [&]() {
1384       FoldingSetNodeID ID;
1385       ID.AddInteger(scAddRecExpr);
1386       ID.AddPointer(PreStart);
1387       ID.AddPointer(Step);
1388       ID.AddPointer(L);
1389       void *IP = nullptr;
1390       return static_cast<SCEVAddRecExpr *>(
1391           this->UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
1392     }();
1393
1394     if (PreAR && PreAR->getNoWrapFlags(WrapType)) {  // proves (2)
1395       const SCEV *DeltaS = getConstant(StartC->getType(), Delta);
1396       ICmpInst::Predicate Pred = ICmpInst::BAD_ICMP_PREDICATE;
1397       const SCEV *Limit = ExtendOpTraits<ExtendOpTy>::getOverflowLimitForStep(
1398           DeltaS, &Pred, this);
1399       if (Limit && isKnownPredicate(Pred, PreAR, Limit))  // proves (1)
1400         return true;
1401     }
1402   }
1403
1404   return false;
1405 }
1406
1407 const SCEV *ScalarEvolution::getZeroExtendExpr(const SCEV *Op,
1408                                                Type *Ty) {
1409   assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
1410          "This is not an extending conversion!");
1411   assert(isSCEVable(Ty) &&
1412          "This is not a conversion to a SCEVable type!");
1413   Ty = getEffectiveSCEVType(Ty);
1414
1415   // Fold if the operand is constant.
1416   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1417     return getConstant(
1418       cast<ConstantInt>(ConstantExpr::getZExt(SC->getValue(), Ty)));
1419
1420   // zext(zext(x)) --> zext(x)
1421   if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
1422     return getZeroExtendExpr(SZ->getOperand(), Ty);
1423
1424   // Before doing any expensive analysis, check to see if we've already
1425   // computed a SCEV for this Op and Ty.
1426   FoldingSetNodeID ID;
1427   ID.AddInteger(scZeroExtend);
1428   ID.AddPointer(Op);
1429   ID.AddPointer(Ty);
1430   void *IP = nullptr;
1431   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1432
1433   // zext(trunc(x)) --> zext(x) or x or trunc(x)
1434   if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) {
1435     // It's possible the bits taken off by the truncate were all zero bits. If
1436     // so, we should be able to simplify this further.
1437     const SCEV *X = ST->getOperand();
1438     ConstantRange CR = getUnsignedRange(X);
1439     unsigned TruncBits = getTypeSizeInBits(ST->getType());
1440     unsigned NewBits = getTypeSizeInBits(Ty);
1441     if (CR.truncate(TruncBits).zeroExtend(NewBits).contains(
1442             CR.zextOrTrunc(NewBits)))
1443       return getTruncateOrZeroExtend(X, Ty);
1444   }
1445
1446   // If the input value is a chrec scev, and we can prove that the value
1447   // did not overflow the old, smaller, value, we can zero extend all of the
1448   // operands (often constants).  This allows analysis of something like
1449   // this:  for (unsigned char X = 0; X < 100; ++X) { int Y = X; }
1450   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op))
1451     if (AR->isAffine()) {
1452       const SCEV *Start = AR->getStart();
1453       const SCEV *Step = AR->getStepRecurrence(*this);
1454       unsigned BitWidth = getTypeSizeInBits(AR->getType());
1455       const Loop *L = AR->getLoop();
1456
1457       // If we have special knowledge that this addrec won't overflow,
1458       // we don't need to do any further analysis.
1459       if (AR->getNoWrapFlags(SCEV::FlagNUW))
1460         return getAddRecExpr(
1461             getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1462             getZeroExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1463
1464       // Check whether the backedge-taken count is SCEVCouldNotCompute.
1465       // Note that this serves two purposes: It filters out loops that are
1466       // simply not analyzable, and it covers the case where this code is
1467       // being called from within backedge-taken count analysis, such that
1468       // attempting to ask for the backedge-taken count would likely result
1469       // in infinite recursion. In the later case, the analysis code will
1470       // cope with a conservative value, and it will take care to purge
1471       // that value once it has finished.
1472       const SCEV *MaxBECount = getMaxBackedgeTakenCount(L);
1473       if (!isa<SCEVCouldNotCompute>(MaxBECount)) {
1474         // Manually compute the final value for AR, checking for
1475         // overflow.
1476
1477         // Check whether the backedge-taken count can be losslessly casted to
1478         // the addrec's type. The count is always unsigned.
1479         const SCEV *CastedMaxBECount =
1480           getTruncateOrZeroExtend(MaxBECount, Start->getType());
1481         const SCEV *RecastedMaxBECount =
1482           getTruncateOrZeroExtend(CastedMaxBECount, MaxBECount->getType());
1483         if (MaxBECount == RecastedMaxBECount) {
1484           Type *WideTy = IntegerType::get(getContext(), BitWidth * 2);
1485           // Check whether Start+Step*MaxBECount has no unsigned overflow.
1486           const SCEV *ZMul = getMulExpr(CastedMaxBECount, Step);
1487           const SCEV *ZAdd = getZeroExtendExpr(getAddExpr(Start, ZMul), WideTy);
1488           const SCEV *WideStart = getZeroExtendExpr(Start, WideTy);
1489           const SCEV *WideMaxBECount =
1490             getZeroExtendExpr(CastedMaxBECount, WideTy);
1491           const SCEV *OperandExtendedAdd =
1492             getAddExpr(WideStart,
1493                        getMulExpr(WideMaxBECount,
1494                                   getZeroExtendExpr(Step, WideTy)));
1495           if (ZAdd == OperandExtendedAdd) {
1496             // Cache knowledge of AR NUW, which is propagated to this AddRec.
1497             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNUW);
1498             // Return the expression with the addrec on the outside.
1499             return getAddRecExpr(
1500                 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1501                 getZeroExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1502           }
1503           // Similar to above, only this time treat the step value as signed.
1504           // This covers loops that count down.
1505           OperandExtendedAdd =
1506             getAddExpr(WideStart,
1507                        getMulExpr(WideMaxBECount,
1508                                   getSignExtendExpr(Step, WideTy)));
1509           if (ZAdd == OperandExtendedAdd) {
1510             // Cache knowledge of AR NW, which is propagated to this AddRec.
1511             // Negative step causes unsigned wrap, but it still can't self-wrap.
1512             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNW);
1513             // Return the expression with the addrec on the outside.
1514             return getAddRecExpr(
1515                 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1516                 getSignExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1517           }
1518         }
1519
1520         // If the backedge is guarded by a comparison with the pre-inc value
1521         // the addrec is safe. Also, if the entry is guarded by a comparison
1522         // with the start value and the backedge is guarded by a comparison
1523         // with the post-inc value, the addrec is safe.
1524         if (isKnownPositive(Step)) {
1525           const SCEV *N = getConstant(APInt::getMinValue(BitWidth) -
1526                                       getUnsignedRange(Step).getUnsignedMax());
1527           if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT, AR, N) ||
1528               (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_ULT, Start, N) &&
1529                isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT,
1530                                            AR->getPostIncExpr(*this), N))) {
1531             // Cache knowledge of AR NUW, which is propagated to this AddRec.
1532             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNUW);
1533             // Return the expression with the addrec on the outside.
1534             return getAddRecExpr(
1535                 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1536                 getZeroExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1537           }
1538         } else if (isKnownNegative(Step)) {
1539           const SCEV *N = getConstant(APInt::getMaxValue(BitWidth) -
1540                                       getSignedRange(Step).getSignedMin());
1541           if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT, AR, N) ||
1542               (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_UGT, Start, N) &&
1543                isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT,
1544                                            AR->getPostIncExpr(*this), N))) {
1545             // Cache knowledge of AR NW, which is propagated to this AddRec.
1546             // Negative step causes unsigned wrap, but it still can't self-wrap.
1547             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNW);
1548             // Return the expression with the addrec on the outside.
1549             return getAddRecExpr(
1550                 getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1551                 getSignExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1552           }
1553         }
1554       }
1555
1556       if (proveNoWrapByVaryingStart<SCEVZeroExtendExpr>(Start, Step, L)) {
1557         const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNUW);
1558         return getAddRecExpr(
1559             getExtendAddRecStart<SCEVZeroExtendExpr>(AR, Ty, this),
1560             getZeroExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1561       }
1562     }
1563
1564   // The cast wasn't folded; create an explicit cast node.
1565   // Recompute the insert position, as it may have been invalidated.
1566   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1567   SCEV *S = new (SCEVAllocator) SCEVZeroExtendExpr(ID.Intern(SCEVAllocator),
1568                                                    Op, Ty);
1569   UniqueSCEVs.InsertNode(S, IP);
1570   return S;
1571 }
1572
1573 const SCEV *ScalarEvolution::getSignExtendExpr(const SCEV *Op,
1574                                                Type *Ty) {
1575   assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
1576          "This is not an extending conversion!");
1577   assert(isSCEVable(Ty) &&
1578          "This is not a conversion to a SCEVable type!");
1579   Ty = getEffectiveSCEVType(Ty);
1580
1581   // Fold if the operand is constant.
1582   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1583     return getConstant(
1584       cast<ConstantInt>(ConstantExpr::getSExt(SC->getValue(), Ty)));
1585
1586   // sext(sext(x)) --> sext(x)
1587   if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op))
1588     return getSignExtendExpr(SS->getOperand(), Ty);
1589
1590   // sext(zext(x)) --> zext(x)
1591   if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
1592     return getZeroExtendExpr(SZ->getOperand(), Ty);
1593
1594   // Before doing any expensive analysis, check to see if we've already
1595   // computed a SCEV for this Op and Ty.
1596   FoldingSetNodeID ID;
1597   ID.AddInteger(scSignExtend);
1598   ID.AddPointer(Op);
1599   ID.AddPointer(Ty);
1600   void *IP = nullptr;
1601   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1602
1603   // If the input value is provably positive, build a zext instead.
1604   if (isKnownNonNegative(Op))
1605     return getZeroExtendExpr(Op, Ty);
1606
1607   // sext(trunc(x)) --> sext(x) or x or trunc(x)
1608   if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op)) {
1609     // It's possible the bits taken off by the truncate were all sign bits. If
1610     // so, we should be able to simplify this further.
1611     const SCEV *X = ST->getOperand();
1612     ConstantRange CR = getSignedRange(X);
1613     unsigned TruncBits = getTypeSizeInBits(ST->getType());
1614     unsigned NewBits = getTypeSizeInBits(Ty);
1615     if (CR.truncate(TruncBits).signExtend(NewBits).contains(
1616             CR.sextOrTrunc(NewBits)))
1617       return getTruncateOrSignExtend(X, Ty);
1618   }
1619
1620   // sext(C1 + (C2 * x)) --> C1 + sext(C2 * x) if C1 < C2
1621   if (auto SA = dyn_cast<SCEVAddExpr>(Op)) {
1622     if (SA->getNumOperands() == 2) {
1623       auto SC1 = dyn_cast<SCEVConstant>(SA->getOperand(0));
1624       auto SMul = dyn_cast<SCEVMulExpr>(SA->getOperand(1));
1625       if (SMul && SC1) {
1626         if (auto SC2 = dyn_cast<SCEVConstant>(SMul->getOperand(0))) {
1627           const APInt &C1 = SC1->getValue()->getValue();
1628           const APInt &C2 = SC2->getValue()->getValue();
1629           if (C1.isStrictlyPositive() && C2.isStrictlyPositive() &&
1630               C2.ugt(C1) && C2.isPowerOf2())
1631             return getAddExpr(getSignExtendExpr(SC1, Ty),
1632                               getSignExtendExpr(SMul, Ty));
1633         }
1634       }
1635     }
1636   }
1637   // If the input value is a chrec scev, and we can prove that the value
1638   // did not overflow the old, smaller, value, we can sign extend all of the
1639   // operands (often constants).  This allows analysis of something like
1640   // this:  for (signed char X = 0; X < 100; ++X) { int Y = X; }
1641   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op))
1642     if (AR->isAffine()) {
1643       const SCEV *Start = AR->getStart();
1644       const SCEV *Step = AR->getStepRecurrence(*this);
1645       unsigned BitWidth = getTypeSizeInBits(AR->getType());
1646       const Loop *L = AR->getLoop();
1647
1648       // If we have special knowledge that this addrec won't overflow,
1649       // we don't need to do any further analysis.
1650       if (AR->getNoWrapFlags(SCEV::FlagNSW))
1651         return getAddRecExpr(
1652             getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this),
1653             getSignExtendExpr(Step, Ty), L, SCEV::FlagNSW);
1654
1655       // Check whether the backedge-taken count is SCEVCouldNotCompute.
1656       // Note that this serves two purposes: It filters out loops that are
1657       // simply not analyzable, and it covers the case where this code is
1658       // being called from within backedge-taken count analysis, such that
1659       // attempting to ask for the backedge-taken count would likely result
1660       // in infinite recursion. In the later case, the analysis code will
1661       // cope with a conservative value, and it will take care to purge
1662       // that value once it has finished.
1663       const SCEV *MaxBECount = getMaxBackedgeTakenCount(L);
1664       if (!isa<SCEVCouldNotCompute>(MaxBECount)) {
1665         // Manually compute the final value for AR, checking for
1666         // overflow.
1667
1668         // Check whether the backedge-taken count can be losslessly casted to
1669         // the addrec's type. The count is always unsigned.
1670         const SCEV *CastedMaxBECount =
1671           getTruncateOrZeroExtend(MaxBECount, Start->getType());
1672         const SCEV *RecastedMaxBECount =
1673           getTruncateOrZeroExtend(CastedMaxBECount, MaxBECount->getType());
1674         if (MaxBECount == RecastedMaxBECount) {
1675           Type *WideTy = IntegerType::get(getContext(), BitWidth * 2);
1676           // Check whether Start+Step*MaxBECount has no signed overflow.
1677           const SCEV *SMul = getMulExpr(CastedMaxBECount, Step);
1678           const SCEV *SAdd = getSignExtendExpr(getAddExpr(Start, SMul), WideTy);
1679           const SCEV *WideStart = getSignExtendExpr(Start, WideTy);
1680           const SCEV *WideMaxBECount =
1681             getZeroExtendExpr(CastedMaxBECount, WideTy);
1682           const SCEV *OperandExtendedAdd =
1683             getAddExpr(WideStart,
1684                        getMulExpr(WideMaxBECount,
1685                                   getSignExtendExpr(Step, WideTy)));
1686           if (SAdd == OperandExtendedAdd) {
1687             // Cache knowledge of AR NSW, which is propagated to this AddRec.
1688             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNSW);
1689             // Return the expression with the addrec on the outside.
1690             return getAddRecExpr(
1691                 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this),
1692                 getSignExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1693           }
1694           // Similar to above, only this time treat the step value as unsigned.
1695           // This covers loops that count up with an unsigned step.
1696           OperandExtendedAdd =
1697             getAddExpr(WideStart,
1698                        getMulExpr(WideMaxBECount,
1699                                   getZeroExtendExpr(Step, WideTy)));
1700           if (SAdd == OperandExtendedAdd) {
1701             // If AR wraps around then
1702             //
1703             //    abs(Step) * MaxBECount > unsigned-max(AR->getType())
1704             // => SAdd != OperandExtendedAdd
1705             //
1706             // Thus (AR is not NW => SAdd != OperandExtendedAdd) <=>
1707             // (SAdd == OperandExtendedAdd => AR is NW)
1708
1709             const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNW);
1710
1711             // Return the expression with the addrec on the outside.
1712             return getAddRecExpr(
1713                 getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this),
1714                 getZeroExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1715           }
1716         }
1717
1718         // If the backedge is guarded by a comparison with the pre-inc value
1719         // the addrec is safe. Also, if the entry is guarded by a comparison
1720         // with the start value and the backedge is guarded by a comparison
1721         // with the post-inc value, the addrec is safe.
1722         ICmpInst::Predicate Pred;
1723         const SCEV *OverflowLimit =
1724             getSignedOverflowLimitForStep(Step, &Pred, this);
1725         if (OverflowLimit &&
1726             (isLoopBackedgeGuardedByCond(L, Pred, AR, OverflowLimit) ||
1727              (isLoopEntryGuardedByCond(L, Pred, Start, OverflowLimit) &&
1728               isLoopBackedgeGuardedByCond(L, Pred, AR->getPostIncExpr(*this),
1729                                           OverflowLimit)))) {
1730           // Cache knowledge of AR NSW, then propagate NSW to the wide AddRec.
1731           const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNSW);
1732           return getAddRecExpr(
1733               getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this),
1734               getSignExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1735         }
1736       }
1737       // If Start and Step are constants, check if we can apply this
1738       // transformation:
1739       // sext{C1,+,C2} --> C1 + sext{0,+,C2} if C1 < C2
1740       auto SC1 = dyn_cast<SCEVConstant>(Start);
1741       auto SC2 = dyn_cast<SCEVConstant>(Step);
1742       if (SC1 && SC2) {
1743         const APInt &C1 = SC1->getValue()->getValue();
1744         const APInt &C2 = SC2->getValue()->getValue();
1745         if (C1.isStrictlyPositive() && C2.isStrictlyPositive() && C2.ugt(C1) &&
1746             C2.isPowerOf2()) {
1747           Start = getSignExtendExpr(Start, Ty);
1748           const SCEV *NewAR = getAddRecExpr(getConstant(AR->getType(), 0), Step,
1749                                             L, AR->getNoWrapFlags());
1750           return getAddExpr(Start, getSignExtendExpr(NewAR, Ty));
1751         }
1752       }
1753
1754       if (proveNoWrapByVaryingStart<SCEVSignExtendExpr>(Start, Step, L)) {
1755         const_cast<SCEVAddRecExpr *>(AR)->setNoWrapFlags(SCEV::FlagNSW);
1756         return getAddRecExpr(
1757             getExtendAddRecStart<SCEVSignExtendExpr>(AR, Ty, this),
1758             getSignExtendExpr(Step, Ty), L, AR->getNoWrapFlags());
1759       }
1760     }
1761
1762   // The cast wasn't folded; create an explicit cast node.
1763   // Recompute the insert position, as it may have been invalidated.
1764   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1765   SCEV *S = new (SCEVAllocator) SCEVSignExtendExpr(ID.Intern(SCEVAllocator),
1766                                                    Op, Ty);
1767   UniqueSCEVs.InsertNode(S, IP);
1768   return S;
1769 }
1770
1771 /// getAnyExtendExpr - Return a SCEV for the given operand extended with
1772 /// unspecified bits out to the given type.
1773 ///
1774 const SCEV *ScalarEvolution::getAnyExtendExpr(const SCEV *Op,
1775                                               Type *Ty) {
1776   assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
1777          "This is not an extending conversion!");
1778   assert(isSCEVable(Ty) &&
1779          "This is not a conversion to a SCEVable type!");
1780   Ty = getEffectiveSCEVType(Ty);
1781
1782   // Sign-extend negative constants.
1783   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1784     if (SC->getValue()->getValue().isNegative())
1785       return getSignExtendExpr(Op, Ty);
1786
1787   // Peel off a truncate cast.
1788   if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Op)) {
1789     const SCEV *NewOp = T->getOperand();
1790     if (getTypeSizeInBits(NewOp->getType()) < getTypeSizeInBits(Ty))
1791       return getAnyExtendExpr(NewOp, Ty);
1792     return getTruncateOrNoop(NewOp, Ty);
1793   }
1794
1795   // Next try a zext cast. If the cast is folded, use it.
1796   const SCEV *ZExt = getZeroExtendExpr(Op, Ty);
1797   if (!isa<SCEVZeroExtendExpr>(ZExt))
1798     return ZExt;
1799
1800   // Next try a sext cast. If the cast is folded, use it.
1801   const SCEV *SExt = getSignExtendExpr(Op, Ty);
1802   if (!isa<SCEVSignExtendExpr>(SExt))
1803     return SExt;
1804
1805   // Force the cast to be folded into the operands of an addrec.
1806   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op)) {
1807     SmallVector<const SCEV *, 4> Ops;
1808     for (const SCEV *Op : AR->operands())
1809       Ops.push_back(getAnyExtendExpr(Op, Ty));
1810     return getAddRecExpr(Ops, AR->getLoop(), SCEV::FlagNW);
1811   }
1812
1813   // If the expression is obviously signed, use the sext cast value.
1814   if (isa<SCEVSMaxExpr>(Op))
1815     return SExt;
1816
1817   // Absent any other information, use the zext cast value.
1818   return ZExt;
1819 }
1820
1821 /// CollectAddOperandsWithScales - Process the given Ops list, which is
1822 /// a list of operands to be added under the given scale, update the given
1823 /// map. This is a helper function for getAddRecExpr. As an example of
1824 /// what it does, given a sequence of operands that would form an add
1825 /// expression like this:
1826 ///
1827 ///    m + n + 13 + (A * (o + p + (B * (q + m + 29)))) + r + (-1 * r)
1828 ///
1829 /// where A and B are constants, update the map with these values:
1830 ///
1831 ///    (m, 1+A*B), (n, 1), (o, A), (p, A), (q, A*B), (r, 0)
1832 ///
1833 /// and add 13 + A*B*29 to AccumulatedConstant.
1834 /// This will allow getAddRecExpr to produce this:
1835 ///
1836 ///    13+A*B*29 + n + (m * (1+A*B)) + ((o + p) * A) + (q * A*B)
1837 ///
1838 /// This form often exposes folding opportunities that are hidden in
1839 /// the original operand list.
1840 ///
1841 /// Return true iff it appears that any interesting folding opportunities
1842 /// may be exposed. This helps getAddRecExpr short-circuit extra work in
1843 /// the common case where no interesting opportunities are present, and
1844 /// is also used as a check to avoid infinite recursion.
1845 ///
1846 static bool
1847 CollectAddOperandsWithScales(DenseMap<const SCEV *, APInt> &M,
1848                              SmallVectorImpl<const SCEV *> &NewOps,
1849                              APInt &AccumulatedConstant,
1850                              const SCEV *const *Ops, size_t NumOperands,
1851                              const APInt &Scale,
1852                              ScalarEvolution &SE) {
1853   bool Interesting = false;
1854
1855   // Iterate over the add operands. They are sorted, with constants first.
1856   unsigned i = 0;
1857   while (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) {
1858     ++i;
1859     // Pull a buried constant out to the outside.
1860     if (Scale != 1 || AccumulatedConstant != 0 || C->getValue()->isZero())
1861       Interesting = true;
1862     AccumulatedConstant += Scale * C->getValue()->getValue();
1863   }
1864
1865   // Next comes everything else. We're especially interested in multiplies
1866   // here, but they're in the middle, so just visit the rest with one loop.
1867   for (; i != NumOperands; ++i) {
1868     const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[i]);
1869     if (Mul && isa<SCEVConstant>(Mul->getOperand(0))) {
1870       APInt NewScale =
1871         Scale * cast<SCEVConstant>(Mul->getOperand(0))->getValue()->getValue();
1872       if (Mul->getNumOperands() == 2 && isa<SCEVAddExpr>(Mul->getOperand(1))) {
1873         // A multiplication of a constant with another add; recurse.
1874         const SCEVAddExpr *Add = cast<SCEVAddExpr>(Mul->getOperand(1));
1875         Interesting |=
1876           CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant,
1877                                        Add->op_begin(), Add->getNumOperands(),
1878                                        NewScale, SE);
1879       } else {
1880         // A multiplication of a constant with some other value. Update
1881         // the map.
1882         SmallVector<const SCEV *, 4> MulOps(Mul->op_begin()+1, Mul->op_end());
1883         const SCEV *Key = SE.getMulExpr(MulOps);
1884         std::pair<DenseMap<const SCEV *, APInt>::iterator, bool> Pair =
1885           M.insert(std::make_pair(Key, NewScale));
1886         if (Pair.second) {
1887           NewOps.push_back(Pair.first->first);
1888         } else {
1889           Pair.first->second += NewScale;
1890           // The map already had an entry for this value, which may indicate
1891           // a folding opportunity.
1892           Interesting = true;
1893         }
1894       }
1895     } else {
1896       // An ordinary operand. Update the map.
1897       std::pair<DenseMap<const SCEV *, APInt>::iterator, bool> Pair =
1898         M.insert(std::make_pair(Ops[i], Scale));
1899       if (Pair.second) {
1900         NewOps.push_back(Pair.first->first);
1901       } else {
1902         Pair.first->second += Scale;
1903         // The map already had an entry for this value, which may indicate
1904         // a folding opportunity.
1905         Interesting = true;
1906       }
1907     }
1908   }
1909
1910   return Interesting;
1911 }
1912
1913 namespace {
1914   struct APIntCompare {
1915     bool operator()(const APInt &LHS, const APInt &RHS) const {
1916       return LHS.ult(RHS);
1917     }
1918   };
1919 }
1920
1921 // We're trying to construct a SCEV of type `Type' with `Ops' as operands and
1922 // `OldFlags' as can't-wrap behavior.  Infer a more aggressive set of
1923 // can't-overflow flags for the operation if possible.
1924 static SCEV::NoWrapFlags
1925 StrengthenNoWrapFlags(ScalarEvolution *SE, SCEVTypes Type,
1926                       const SmallVectorImpl<const SCEV *> &Ops,
1927                       SCEV::NoWrapFlags OldFlags) {
1928   using namespace std::placeholders;
1929
1930   bool CanAnalyze =
1931       Type == scAddExpr || Type == scAddRecExpr || Type == scMulExpr;
1932   (void)CanAnalyze;
1933   assert(CanAnalyze && "don't call from other places!");
1934
1935   int SignOrUnsignMask = SCEV::FlagNUW | SCEV::FlagNSW;
1936   SCEV::NoWrapFlags SignOrUnsignWrap =
1937       ScalarEvolution::maskFlags(OldFlags, SignOrUnsignMask);
1938
1939   // If FlagNSW is true and all the operands are non-negative, infer FlagNUW.
1940   auto IsKnownNonNegative =
1941     std::bind(std::mem_fn(&ScalarEvolution::isKnownNonNegative), SE, _1);
1942
1943   if (SignOrUnsignWrap == SCEV::FlagNSW &&
1944       std::all_of(Ops.begin(), Ops.end(), IsKnownNonNegative))
1945     return ScalarEvolution::setFlags(OldFlags,
1946                                      (SCEV::NoWrapFlags)SignOrUnsignMask);
1947
1948   return OldFlags;
1949 }
1950
1951 /// getAddExpr - Get a canonical add expression, or something simpler if
1952 /// possible.
1953 const SCEV *ScalarEvolution::getAddExpr(SmallVectorImpl<const SCEV *> &Ops,
1954                                         SCEV::NoWrapFlags Flags) {
1955   assert(!(Flags & ~(SCEV::FlagNUW | SCEV::FlagNSW)) &&
1956          "only nuw or nsw allowed");
1957   assert(!Ops.empty() && "Cannot get empty add!");
1958   if (Ops.size() == 1) return Ops[0];
1959 #ifndef NDEBUG
1960   Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
1961   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
1962     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
1963            "SCEVAddExpr operand types don't match!");
1964 #endif
1965
1966   Flags = StrengthenNoWrapFlags(this, scAddExpr, Ops, Flags);
1967
1968   // Sort by complexity, this groups all similar expression types together.
1969   GroupByComplexity(Ops, LI);
1970
1971   // If there are any constants, fold them together.
1972   unsigned Idx = 0;
1973   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
1974     ++Idx;
1975     assert(Idx < Ops.size());
1976     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
1977       // We found two constants, fold them together!
1978       Ops[0] = getConstant(LHSC->getValue()->getValue() +
1979                            RHSC->getValue()->getValue());
1980       if (Ops.size() == 2) return Ops[0];
1981       Ops.erase(Ops.begin()+1);  // Erase the folded element
1982       LHSC = cast<SCEVConstant>(Ops[0]);
1983     }
1984
1985     // If we are left with a constant zero being added, strip it off.
1986     if (LHSC->getValue()->isZero()) {
1987       Ops.erase(Ops.begin());
1988       --Idx;
1989     }
1990
1991     if (Ops.size() == 1) return Ops[0];
1992   }
1993
1994   // Okay, check to see if the same value occurs in the operand list more than
1995   // once.  If so, merge them together into an multiply expression.  Since we
1996   // sorted the list, these values are required to be adjacent.
1997   Type *Ty = Ops[0]->getType();
1998   bool FoundMatch = false;
1999   for (unsigned i = 0, e = Ops.size(); i != e-1; ++i)
2000     if (Ops[i] == Ops[i+1]) {      //  X + Y + Y  -->  X + Y*2
2001       // Scan ahead to count how many equal operands there are.
2002       unsigned Count = 2;
2003       while (i+Count != e && Ops[i+Count] == Ops[i])
2004         ++Count;
2005       // Merge the values into a multiply.
2006       const SCEV *Scale = getConstant(Ty, Count);
2007       const SCEV *Mul = getMulExpr(Scale, Ops[i]);
2008       if (Ops.size() == Count)
2009         return Mul;
2010       Ops[i] = Mul;
2011       Ops.erase(Ops.begin()+i+1, Ops.begin()+i+Count);
2012       --i; e -= Count - 1;
2013       FoundMatch = true;
2014     }
2015   if (FoundMatch)
2016     return getAddExpr(Ops, Flags);
2017
2018   // Check for truncates. If all the operands are truncated from the same
2019   // type, see if factoring out the truncate would permit the result to be
2020   // folded. eg., trunc(x) + m*trunc(n) --> trunc(x + trunc(m)*n)
2021   // if the contents of the resulting outer trunc fold to something simple.
2022   for (; Idx < Ops.size() && isa<SCEVTruncateExpr>(Ops[Idx]); ++Idx) {
2023     const SCEVTruncateExpr *Trunc = cast<SCEVTruncateExpr>(Ops[Idx]);
2024     Type *DstType = Trunc->getType();
2025     Type *SrcType = Trunc->getOperand()->getType();
2026     SmallVector<const SCEV *, 8> LargeOps;
2027     bool Ok = true;
2028     // Check all the operands to see if they can be represented in the
2029     // source type of the truncate.
2030     for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
2031       if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Ops[i])) {
2032         if (T->getOperand()->getType() != SrcType) {
2033           Ok = false;
2034           break;
2035         }
2036         LargeOps.push_back(T->getOperand());
2037       } else if (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) {
2038         LargeOps.push_back(getAnyExtendExpr(C, SrcType));
2039       } else if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(Ops[i])) {
2040         SmallVector<const SCEV *, 8> LargeMulOps;
2041         for (unsigned j = 0, f = M->getNumOperands(); j != f && Ok; ++j) {
2042           if (const SCEVTruncateExpr *T =
2043                 dyn_cast<SCEVTruncateExpr>(M->getOperand(j))) {
2044             if (T->getOperand()->getType() != SrcType) {
2045               Ok = false;
2046               break;
2047             }
2048             LargeMulOps.push_back(T->getOperand());
2049           } else if (const SCEVConstant *C =
2050                        dyn_cast<SCEVConstant>(M->getOperand(j))) {
2051             LargeMulOps.push_back(getAnyExtendExpr(C, SrcType));
2052           } else {
2053             Ok = false;
2054             break;
2055           }
2056         }
2057         if (Ok)
2058           LargeOps.push_back(getMulExpr(LargeMulOps));
2059       } else {
2060         Ok = false;
2061         break;
2062       }
2063     }
2064     if (Ok) {
2065       // Evaluate the expression in the larger type.
2066       const SCEV *Fold = getAddExpr(LargeOps, Flags);
2067       // If it folds to something simple, use it. Otherwise, don't.
2068       if (isa<SCEVConstant>(Fold) || isa<SCEVUnknown>(Fold))
2069         return getTruncateExpr(Fold, DstType);
2070     }
2071   }
2072
2073   // Skip past any other cast SCEVs.
2074   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddExpr)
2075     ++Idx;
2076
2077   // If there are add operands they would be next.
2078   if (Idx < Ops.size()) {
2079     bool DeletedAdd = false;
2080     while (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[Idx])) {
2081       // If we have an add, expand the add operands onto the end of the operands
2082       // list.
2083       Ops.erase(Ops.begin()+Idx);
2084       Ops.append(Add->op_begin(), Add->op_end());
2085       DeletedAdd = true;
2086     }
2087
2088     // If we deleted at least one add, we added operands to the end of the list,
2089     // and they are not necessarily sorted.  Recurse to resort and resimplify
2090     // any operands we just acquired.
2091     if (DeletedAdd)
2092       return getAddExpr(Ops);
2093   }
2094
2095   // Skip over the add expression until we get to a multiply.
2096   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr)
2097     ++Idx;
2098
2099   // Check to see if there are any folding opportunities present with
2100   // operands multiplied by constant values.
2101   if (Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx])) {
2102     uint64_t BitWidth = getTypeSizeInBits(Ty);
2103     DenseMap<const SCEV *, APInt> M;
2104     SmallVector<const SCEV *, 8> NewOps;
2105     APInt AccumulatedConstant(BitWidth, 0);
2106     if (CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant,
2107                                      Ops.data(), Ops.size(),
2108                                      APInt(BitWidth, 1), *this)) {
2109       // Some interesting folding opportunity is present, so its worthwhile to
2110       // re-generate the operands list. Group the operands by constant scale,
2111       // to avoid multiplying by the same constant scale multiple times.
2112       std::map<APInt, SmallVector<const SCEV *, 4>, APIntCompare> MulOpLists;
2113       for (SmallVectorImpl<const SCEV *>::const_iterator I = NewOps.begin(),
2114            E = NewOps.end(); I != E; ++I)
2115         MulOpLists[M.find(*I)->second].push_back(*I);
2116       // Re-generate the operands list.
2117       Ops.clear();
2118       if (AccumulatedConstant != 0)
2119         Ops.push_back(getConstant(AccumulatedConstant));
2120       for (std::map<APInt, SmallVector<const SCEV *, 4>, APIntCompare>::iterator
2121            I = MulOpLists.begin(), E = MulOpLists.end(); I != E; ++I)
2122         if (I->first != 0)
2123           Ops.push_back(getMulExpr(getConstant(I->first),
2124                                    getAddExpr(I->second)));
2125       if (Ops.empty())
2126         return getConstant(Ty, 0);
2127       if (Ops.size() == 1)
2128         return Ops[0];
2129       return getAddExpr(Ops);
2130     }
2131   }
2132
2133   // If we are adding something to a multiply expression, make sure the
2134   // something is not already an operand of the multiply.  If so, merge it into
2135   // the multiply.
2136   for (; Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx]); ++Idx) {
2137     const SCEVMulExpr *Mul = cast<SCEVMulExpr>(Ops[Idx]);
2138     for (unsigned MulOp = 0, e = Mul->getNumOperands(); MulOp != e; ++MulOp) {
2139       const SCEV *MulOpSCEV = Mul->getOperand(MulOp);
2140       if (isa<SCEVConstant>(MulOpSCEV))
2141         continue;
2142       for (unsigned AddOp = 0, e = Ops.size(); AddOp != e; ++AddOp)
2143         if (MulOpSCEV == Ops[AddOp]) {
2144           // Fold W + X + (X * Y * Z)  -->  W + (X * ((Y*Z)+1))
2145           const SCEV *InnerMul = Mul->getOperand(MulOp == 0);
2146           if (Mul->getNumOperands() != 2) {
2147             // If the multiply has more than two operands, we must get the
2148             // Y*Z term.
2149             SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(),
2150                                                 Mul->op_begin()+MulOp);
2151             MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end());
2152             InnerMul = getMulExpr(MulOps);
2153           }
2154           const SCEV *One = getConstant(Ty, 1);
2155           const SCEV *AddOne = getAddExpr(One, InnerMul);
2156           const SCEV *OuterMul = getMulExpr(AddOne, MulOpSCEV);
2157           if (Ops.size() == 2) return OuterMul;
2158           if (AddOp < Idx) {
2159             Ops.erase(Ops.begin()+AddOp);
2160             Ops.erase(Ops.begin()+Idx-1);
2161           } else {
2162             Ops.erase(Ops.begin()+Idx);
2163             Ops.erase(Ops.begin()+AddOp-1);
2164           }
2165           Ops.push_back(OuterMul);
2166           return getAddExpr(Ops);
2167         }
2168
2169       // Check this multiply against other multiplies being added together.
2170       for (unsigned OtherMulIdx = Idx+1;
2171            OtherMulIdx < Ops.size() && isa<SCEVMulExpr>(Ops[OtherMulIdx]);
2172            ++OtherMulIdx) {
2173         const SCEVMulExpr *OtherMul = cast<SCEVMulExpr>(Ops[OtherMulIdx]);
2174         // If MulOp occurs in OtherMul, we can fold the two multiplies
2175         // together.
2176         for (unsigned OMulOp = 0, e = OtherMul->getNumOperands();
2177              OMulOp != e; ++OMulOp)
2178           if (OtherMul->getOperand(OMulOp) == MulOpSCEV) {
2179             // Fold X + (A*B*C) + (A*D*E) --> X + (A*(B*C+D*E))
2180             const SCEV *InnerMul1 = Mul->getOperand(MulOp == 0);
2181             if (Mul->getNumOperands() != 2) {
2182               SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(),
2183                                                   Mul->op_begin()+MulOp);
2184               MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end());
2185               InnerMul1 = getMulExpr(MulOps);
2186             }
2187             const SCEV *InnerMul2 = OtherMul->getOperand(OMulOp == 0);
2188             if (OtherMul->getNumOperands() != 2) {
2189               SmallVector<const SCEV *, 4> MulOps(OtherMul->op_begin(),
2190                                                   OtherMul->op_begin()+OMulOp);
2191               MulOps.append(OtherMul->op_begin()+OMulOp+1, OtherMul->op_end());
2192               InnerMul2 = getMulExpr(MulOps);
2193             }
2194             const SCEV *InnerMulSum = getAddExpr(InnerMul1,InnerMul2);
2195             const SCEV *OuterMul = getMulExpr(MulOpSCEV, InnerMulSum);
2196             if (Ops.size() == 2) return OuterMul;
2197             Ops.erase(Ops.begin()+Idx);
2198             Ops.erase(Ops.begin()+OtherMulIdx-1);
2199             Ops.push_back(OuterMul);
2200             return getAddExpr(Ops);
2201           }
2202       }
2203     }
2204   }
2205
2206   // If there are any add recurrences in the operands list, see if any other
2207   // added values are loop invariant.  If so, we can fold them into the
2208   // recurrence.
2209   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr)
2210     ++Idx;
2211
2212   // Scan over all recurrences, trying to fold loop invariants into them.
2213   for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) {
2214     // Scan all of the other operands to this add and add them to the vector if
2215     // they are loop invariant w.r.t. the recurrence.
2216     SmallVector<const SCEV *, 8> LIOps;
2217     const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]);
2218     const Loop *AddRecLoop = AddRec->getLoop();
2219     for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2220       if (isLoopInvariant(Ops[i], AddRecLoop)) {
2221         LIOps.push_back(Ops[i]);
2222         Ops.erase(Ops.begin()+i);
2223         --i; --e;
2224       }
2225
2226     // If we found some loop invariants, fold them into the recurrence.
2227     if (!LIOps.empty()) {
2228       //  NLI + LI + {Start,+,Step}  -->  NLI + {LI+Start,+,Step}
2229       LIOps.push_back(AddRec->getStart());
2230
2231       SmallVector<const SCEV *, 4> AddRecOps(AddRec->op_begin(),
2232                                              AddRec->op_end());
2233       AddRecOps[0] = getAddExpr(LIOps);
2234
2235       // Build the new addrec. Propagate the NUW and NSW flags if both the
2236       // outer add and the inner addrec are guaranteed to have no overflow.
2237       // Always propagate NW.
2238       Flags = AddRec->getNoWrapFlags(setFlags(Flags, SCEV::FlagNW));
2239       const SCEV *NewRec = getAddRecExpr(AddRecOps, AddRecLoop, Flags);
2240
2241       // If all of the other operands were loop invariant, we are done.
2242       if (Ops.size() == 1) return NewRec;
2243
2244       // Otherwise, add the folded AddRec by the non-invariant parts.
2245       for (unsigned i = 0;; ++i)
2246         if (Ops[i] == AddRec) {
2247           Ops[i] = NewRec;
2248           break;
2249         }
2250       return getAddExpr(Ops);
2251     }
2252
2253     // Okay, if there weren't any loop invariants to be folded, check to see if
2254     // there are multiple AddRec's with the same loop induction variable being
2255     // added together.  If so, we can fold them.
2256     for (unsigned OtherIdx = Idx+1;
2257          OtherIdx < Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
2258          ++OtherIdx)
2259       if (AddRecLoop == cast<SCEVAddRecExpr>(Ops[OtherIdx])->getLoop()) {
2260         // Other + {A,+,B}<L> + {C,+,D}<L>  -->  Other + {A+C,+,B+D}<L>
2261         SmallVector<const SCEV *, 4> AddRecOps(AddRec->op_begin(),
2262                                                AddRec->op_end());
2263         for (; OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
2264              ++OtherIdx)
2265           if (const SCEVAddRecExpr *OtherAddRec =
2266                 dyn_cast<SCEVAddRecExpr>(Ops[OtherIdx]))
2267             if (OtherAddRec->getLoop() == AddRecLoop) {
2268               for (unsigned i = 0, e = OtherAddRec->getNumOperands();
2269                    i != e; ++i) {
2270                 if (i >= AddRecOps.size()) {
2271                   AddRecOps.append(OtherAddRec->op_begin()+i,
2272                                    OtherAddRec->op_end());
2273                   break;
2274                 }
2275                 AddRecOps[i] = getAddExpr(AddRecOps[i],
2276                                           OtherAddRec->getOperand(i));
2277               }
2278               Ops.erase(Ops.begin() + OtherIdx); --OtherIdx;
2279             }
2280         // Step size has changed, so we cannot guarantee no self-wraparound.
2281         Ops[Idx] = getAddRecExpr(AddRecOps, AddRecLoop, SCEV::FlagAnyWrap);
2282         return getAddExpr(Ops);
2283       }
2284
2285     // Otherwise couldn't fold anything into this recurrence.  Move onto the
2286     // next one.
2287   }
2288
2289   // Okay, it looks like we really DO need an add expr.  Check to see if we
2290   // already have one, otherwise create a new one.
2291   FoldingSetNodeID ID;
2292   ID.AddInteger(scAddExpr);
2293   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2294     ID.AddPointer(Ops[i]);
2295   void *IP = nullptr;
2296   SCEVAddExpr *S =
2297     static_cast<SCEVAddExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
2298   if (!S) {
2299     const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
2300     std::uninitialized_copy(Ops.begin(), Ops.end(), O);
2301     S = new (SCEVAllocator) SCEVAddExpr(ID.Intern(SCEVAllocator),
2302                                         O, Ops.size());
2303     UniqueSCEVs.InsertNode(S, IP);
2304   }
2305   S->setNoWrapFlags(Flags);
2306   return S;
2307 }
2308
2309 static uint64_t umul_ov(uint64_t i, uint64_t j, bool &Overflow) {
2310   uint64_t k = i*j;
2311   if (j > 1 && k / j != i) Overflow = true;
2312   return k;
2313 }
2314
2315 /// Compute the result of "n choose k", the binomial coefficient.  If an
2316 /// intermediate computation overflows, Overflow will be set and the return will
2317 /// be garbage. Overflow is not cleared on absence of overflow.
2318 static uint64_t Choose(uint64_t n, uint64_t k, bool &Overflow) {
2319   // We use the multiplicative formula:
2320   //     n(n-1)(n-2)...(n-(k-1)) / k(k-1)(k-2)...1 .
2321   // At each iteration, we take the n-th term of the numeral and divide by the
2322   // (k-n)th term of the denominator.  This division will always produce an
2323   // integral result, and helps reduce the chance of overflow in the
2324   // intermediate computations. However, we can still overflow even when the
2325   // final result would fit.
2326
2327   if (n == 0 || n == k) return 1;
2328   if (k > n) return 0;
2329
2330   if (k > n/2)
2331     k = n-k;
2332
2333   uint64_t r = 1;
2334   for (uint64_t i = 1; i <= k; ++i) {
2335     r = umul_ov(r, n-(i-1), Overflow);
2336     r /= i;
2337   }
2338   return r;
2339 }
2340
2341 /// Determine if any of the operands in this SCEV are a constant or if
2342 /// any of the add or multiply expressions in this SCEV contain a constant.
2343 static bool containsConstantSomewhere(const SCEV *StartExpr) {
2344   SmallVector<const SCEV *, 4> Ops;
2345   Ops.push_back(StartExpr);
2346   while (!Ops.empty()) {
2347     const SCEV *CurrentExpr = Ops.pop_back_val();
2348     if (isa<SCEVConstant>(*CurrentExpr))
2349       return true;
2350
2351     if (isa<SCEVAddExpr>(*CurrentExpr) || isa<SCEVMulExpr>(*CurrentExpr)) {
2352       const auto *CurrentNAry = cast<SCEVNAryExpr>(CurrentExpr);
2353       Ops.append(CurrentNAry->op_begin(), CurrentNAry->op_end());
2354     }
2355   }
2356   return false;
2357 }
2358
2359 /// getMulExpr - Get a canonical multiply expression, or something simpler if
2360 /// possible.
2361 const SCEV *ScalarEvolution::getMulExpr(SmallVectorImpl<const SCEV *> &Ops,
2362                                         SCEV::NoWrapFlags Flags) {
2363   assert(Flags == maskFlags(Flags, SCEV::FlagNUW | SCEV::FlagNSW) &&
2364          "only nuw or nsw allowed");
2365   assert(!Ops.empty() && "Cannot get empty mul!");
2366   if (Ops.size() == 1) return Ops[0];
2367 #ifndef NDEBUG
2368   Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
2369   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
2370     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
2371            "SCEVMulExpr operand types don't match!");
2372 #endif
2373
2374   Flags = StrengthenNoWrapFlags(this, scMulExpr, Ops, Flags);
2375
2376   // Sort by complexity, this groups all similar expression types together.
2377   GroupByComplexity(Ops, LI);
2378
2379   // If there are any constants, fold them together.
2380   unsigned Idx = 0;
2381   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
2382
2383     // C1*(C2+V) -> C1*C2 + C1*V
2384     if (Ops.size() == 2)
2385         if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1]))
2386           // If any of Add's ops are Adds or Muls with a constant,
2387           // apply this transformation as well.
2388           if (Add->getNumOperands() == 2)
2389             if (containsConstantSomewhere(Add))
2390               return getAddExpr(getMulExpr(LHSC, Add->getOperand(0)),
2391                                 getMulExpr(LHSC, Add->getOperand(1)));
2392
2393     ++Idx;
2394     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
2395       // We found two constants, fold them together!
2396       ConstantInt *Fold = ConstantInt::get(getContext(),
2397                                            LHSC->getValue()->getValue() *
2398                                            RHSC->getValue()->getValue());
2399       Ops[0] = getConstant(Fold);
2400       Ops.erase(Ops.begin()+1);  // Erase the folded element
2401       if (Ops.size() == 1) return Ops[0];
2402       LHSC = cast<SCEVConstant>(Ops[0]);
2403     }
2404
2405     // If we are left with a constant one being multiplied, strip it off.
2406     if (cast<SCEVConstant>(Ops[0])->getValue()->equalsInt(1)) {
2407       Ops.erase(Ops.begin());
2408       --Idx;
2409     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isZero()) {
2410       // If we have a multiply of zero, it will always be zero.
2411       return Ops[0];
2412     } else if (Ops[0]->isAllOnesValue()) {
2413       // If we have a mul by -1 of an add, try distributing the -1 among the
2414       // add operands.
2415       if (Ops.size() == 2) {
2416         if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1])) {
2417           SmallVector<const SCEV *, 4> NewOps;
2418           bool AnyFolded = false;
2419           for (SCEVAddRecExpr::op_iterator I = Add->op_begin(),
2420                  E = Add->op_end(); I != E; ++I) {
2421             const SCEV *Mul = getMulExpr(Ops[0], *I);
2422             if (!isa<SCEVMulExpr>(Mul)) AnyFolded = true;
2423             NewOps.push_back(Mul);
2424           }
2425           if (AnyFolded)
2426             return getAddExpr(NewOps);
2427         }
2428         else if (const SCEVAddRecExpr *
2429                  AddRec = dyn_cast<SCEVAddRecExpr>(Ops[1])) {
2430           // Negation preserves a recurrence's no self-wrap property.
2431           SmallVector<const SCEV *, 4> Operands;
2432           for (SCEVAddRecExpr::op_iterator I = AddRec->op_begin(),
2433                  E = AddRec->op_end(); I != E; ++I) {
2434             Operands.push_back(getMulExpr(Ops[0], *I));
2435           }
2436           return getAddRecExpr(Operands, AddRec->getLoop(),
2437                                AddRec->getNoWrapFlags(SCEV::FlagNW));
2438         }
2439       }
2440     }
2441
2442     if (Ops.size() == 1)
2443       return Ops[0];
2444   }
2445
2446   // Skip over the add expression until we get to a multiply.
2447   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr)
2448     ++Idx;
2449
2450   // If there are mul operands inline them all into this expression.
2451   if (Idx < Ops.size()) {
2452     bool DeletedMul = false;
2453     while (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[Idx])) {
2454       // If we have an mul, expand the mul operands onto the end of the operands
2455       // list.
2456       Ops.erase(Ops.begin()+Idx);
2457       Ops.append(Mul->op_begin(), Mul->op_end());
2458       DeletedMul = true;
2459     }
2460
2461     // If we deleted at least one mul, we added operands to the end of the list,
2462     // and they are not necessarily sorted.  Recurse to resort and resimplify
2463     // any operands we just acquired.
2464     if (DeletedMul)
2465       return getMulExpr(Ops);
2466   }
2467
2468   // If there are any add recurrences in the operands list, see if any other
2469   // added values are loop invariant.  If so, we can fold them into the
2470   // recurrence.
2471   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr)
2472     ++Idx;
2473
2474   // Scan over all recurrences, trying to fold loop invariants into them.
2475   for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) {
2476     // Scan all of the other operands to this mul and add them to the vector if
2477     // they are loop invariant w.r.t. the recurrence.
2478     SmallVector<const SCEV *, 8> LIOps;
2479     const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]);
2480     const Loop *AddRecLoop = AddRec->getLoop();
2481     for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2482       if (isLoopInvariant(Ops[i], AddRecLoop)) {
2483         LIOps.push_back(Ops[i]);
2484         Ops.erase(Ops.begin()+i);
2485         --i; --e;
2486       }
2487
2488     // If we found some loop invariants, fold them into the recurrence.
2489     if (!LIOps.empty()) {
2490       //  NLI * LI * {Start,+,Step}  -->  NLI * {LI*Start,+,LI*Step}
2491       SmallVector<const SCEV *, 4> NewOps;
2492       NewOps.reserve(AddRec->getNumOperands());
2493       const SCEV *Scale = getMulExpr(LIOps);
2494       for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i)
2495         NewOps.push_back(getMulExpr(Scale, AddRec->getOperand(i)));
2496
2497       // Build the new addrec. Propagate the NUW and NSW flags if both the
2498       // outer mul and the inner addrec are guaranteed to have no overflow.
2499       //
2500       // No self-wrap cannot be guaranteed after changing the step size, but
2501       // will be inferred if either NUW or NSW is true.
2502       Flags = AddRec->getNoWrapFlags(clearFlags(Flags, SCEV::FlagNW));
2503       const SCEV *NewRec = getAddRecExpr(NewOps, AddRecLoop, Flags);
2504
2505       // If all of the other operands were loop invariant, we are done.
2506       if (Ops.size() == 1) return NewRec;
2507
2508       // Otherwise, multiply the folded AddRec by the non-invariant parts.
2509       for (unsigned i = 0;; ++i)
2510         if (Ops[i] == AddRec) {
2511           Ops[i] = NewRec;
2512           break;
2513         }
2514       return getMulExpr(Ops);
2515     }
2516
2517     // Okay, if there weren't any loop invariants to be folded, check to see if
2518     // there are multiple AddRec's with the same loop induction variable being
2519     // multiplied together.  If so, we can fold them.
2520
2521     // {A1,+,A2,+,...,+,An}<L> * {B1,+,B2,+,...,+,Bn}<L>
2522     // = {x=1 in [ sum y=x..2x [ sum z=max(y-x, y-n)..min(x,n) [
2523     //       choose(x, 2x)*choose(2x-y, x-z)*A_{y-z}*B_z
2524     //   ]]],+,...up to x=2n}.
2525     // Note that the arguments to choose() are always integers with values
2526     // known at compile time, never SCEV objects.
2527     //
2528     // The implementation avoids pointless extra computations when the two
2529     // addrec's are of different length (mathematically, it's equivalent to
2530     // an infinite stream of zeros on the right).
2531     bool OpsModified = false;
2532     for (unsigned OtherIdx = Idx+1;
2533          OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
2534          ++OtherIdx) {
2535       const SCEVAddRecExpr *OtherAddRec =
2536         dyn_cast<SCEVAddRecExpr>(Ops[OtherIdx]);
2537       if (!OtherAddRec || OtherAddRec->getLoop() != AddRecLoop)
2538         continue;
2539
2540       bool Overflow = false;
2541       Type *Ty = AddRec->getType();
2542       bool LargerThan64Bits = getTypeSizeInBits(Ty) > 64;
2543       SmallVector<const SCEV*, 7> AddRecOps;
2544       for (int x = 0, xe = AddRec->getNumOperands() +
2545              OtherAddRec->getNumOperands() - 1; x != xe && !Overflow; ++x) {
2546         const SCEV *Term = getConstant(Ty, 0);
2547         for (int y = x, ye = 2*x+1; y != ye && !Overflow; ++y) {
2548           uint64_t Coeff1 = Choose(x, 2*x - y, Overflow);
2549           for (int z = std::max(y-x, y-(int)AddRec->getNumOperands()+1),
2550                  ze = std::min(x+1, (int)OtherAddRec->getNumOperands());
2551                z < ze && !Overflow; ++z) {
2552             uint64_t Coeff2 = Choose(2*x - y, x-z, Overflow);
2553             uint64_t Coeff;
2554             if (LargerThan64Bits)
2555               Coeff = umul_ov(Coeff1, Coeff2, Overflow);
2556             else
2557               Coeff = Coeff1*Coeff2;
2558             const SCEV *CoeffTerm = getConstant(Ty, Coeff);
2559             const SCEV *Term1 = AddRec->getOperand(y-z);
2560             const SCEV *Term2 = OtherAddRec->getOperand(z);
2561             Term = getAddExpr(Term, getMulExpr(CoeffTerm, Term1,Term2));
2562           }
2563         }
2564         AddRecOps.push_back(Term);
2565       }
2566       if (!Overflow) {
2567         const SCEV *NewAddRec = getAddRecExpr(AddRecOps, AddRec->getLoop(),
2568                                               SCEV::FlagAnyWrap);
2569         if (Ops.size() == 2) return NewAddRec;
2570         Ops[Idx] = NewAddRec;
2571         Ops.erase(Ops.begin() + OtherIdx); --OtherIdx;
2572         OpsModified = true;
2573         AddRec = dyn_cast<SCEVAddRecExpr>(NewAddRec);
2574         if (!AddRec)
2575           break;
2576       }
2577     }
2578     if (OpsModified)
2579       return getMulExpr(Ops);
2580
2581     // Otherwise couldn't fold anything into this recurrence.  Move onto the
2582     // next one.
2583   }
2584
2585   // Okay, it looks like we really DO need an mul expr.  Check to see if we
2586   // already have one, otherwise create a new one.
2587   FoldingSetNodeID ID;
2588   ID.AddInteger(scMulExpr);
2589   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2590     ID.AddPointer(Ops[i]);
2591   void *IP = nullptr;
2592   SCEVMulExpr *S =
2593     static_cast<SCEVMulExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
2594   if (!S) {
2595     const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
2596     std::uninitialized_copy(Ops.begin(), Ops.end(), O);
2597     S = new (SCEVAllocator) SCEVMulExpr(ID.Intern(SCEVAllocator),
2598                                         O, Ops.size());
2599     UniqueSCEVs.InsertNode(S, IP);
2600   }
2601   S->setNoWrapFlags(Flags);
2602   return S;
2603 }
2604
2605 /// getUDivExpr - Get a canonical unsigned division expression, or something
2606 /// simpler if possible.
2607 const SCEV *ScalarEvolution::getUDivExpr(const SCEV *LHS,
2608                                          const SCEV *RHS) {
2609   assert(getEffectiveSCEVType(LHS->getType()) ==
2610          getEffectiveSCEVType(RHS->getType()) &&
2611          "SCEVUDivExpr operand types don't match!");
2612
2613   if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
2614     if (RHSC->getValue()->equalsInt(1))
2615       return LHS;                               // X udiv 1 --> x
2616     // If the denominator is zero, the result of the udiv is undefined. Don't
2617     // try to analyze it, because the resolution chosen here may differ from
2618     // the resolution chosen in other parts of the compiler.
2619     if (!RHSC->getValue()->isZero()) {
2620       // Determine if the division can be folded into the operands of
2621       // its operands.
2622       // TODO: Generalize this to non-constants by using known-bits information.
2623       Type *Ty = LHS->getType();
2624       unsigned LZ = RHSC->getValue()->getValue().countLeadingZeros();
2625       unsigned MaxShiftAmt = getTypeSizeInBits(Ty) - LZ - 1;
2626       // For non-power-of-two values, effectively round the value up to the
2627       // nearest power of two.
2628       if (!RHSC->getValue()->getValue().isPowerOf2())
2629         ++MaxShiftAmt;
2630       IntegerType *ExtTy =
2631         IntegerType::get(getContext(), getTypeSizeInBits(Ty) + MaxShiftAmt);
2632       if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(LHS))
2633         if (const SCEVConstant *Step =
2634             dyn_cast<SCEVConstant>(AR->getStepRecurrence(*this))) {
2635           // {X,+,N}/C --> {X/C,+,N/C} if safe and N/C can be folded.
2636           const APInt &StepInt = Step->getValue()->getValue();
2637           const APInt &DivInt = RHSC->getValue()->getValue();
2638           if (!StepInt.urem(DivInt) &&
2639               getZeroExtendExpr(AR, ExtTy) ==
2640               getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy),
2641                             getZeroExtendExpr(Step, ExtTy),
2642                             AR->getLoop(), SCEV::FlagAnyWrap)) {
2643             SmallVector<const SCEV *, 4> Operands;
2644             for (unsigned i = 0, e = AR->getNumOperands(); i != e; ++i)
2645               Operands.push_back(getUDivExpr(AR->getOperand(i), RHS));
2646             return getAddRecExpr(Operands, AR->getLoop(),
2647                                  SCEV::FlagNW);
2648           }
2649           /// Get a canonical UDivExpr for a recurrence.
2650           /// {X,+,N}/C => {Y,+,N}/C where Y=X-(X%N). Safe when C%N=0.
2651           // We can currently only fold X%N if X is constant.
2652           const SCEVConstant *StartC = dyn_cast<SCEVConstant>(AR->getStart());
2653           if (StartC && !DivInt.urem(StepInt) &&
2654               getZeroExtendExpr(AR, ExtTy) ==
2655               getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy),
2656                             getZeroExtendExpr(Step, ExtTy),
2657                             AR->getLoop(), SCEV::FlagAnyWrap)) {
2658             const APInt &StartInt = StartC->getValue()->getValue();
2659             const APInt &StartRem = StartInt.urem(StepInt);
2660             if (StartRem != 0)
2661               LHS = getAddRecExpr(getConstant(StartInt - StartRem), Step,
2662                                   AR->getLoop(), SCEV::FlagNW);
2663           }
2664         }
2665       // (A*B)/C --> A*(B/C) if safe and B/C can be folded.
2666       if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(LHS)) {
2667         SmallVector<const SCEV *, 4> Operands;
2668         for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i)
2669           Operands.push_back(getZeroExtendExpr(M->getOperand(i), ExtTy));
2670         if (getZeroExtendExpr(M, ExtTy) == getMulExpr(Operands))
2671           // Find an operand that's safely divisible.
2672           for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i) {
2673             const SCEV *Op = M->getOperand(i);
2674             const SCEV *Div = getUDivExpr(Op, RHSC);
2675             if (!isa<SCEVUDivExpr>(Div) && getMulExpr(Div, RHSC) == Op) {
2676               Operands = SmallVector<const SCEV *, 4>(M->op_begin(),
2677                                                       M->op_end());
2678               Operands[i] = Div;
2679               return getMulExpr(Operands);
2680             }
2681           }
2682       }
2683       // (A+B)/C --> (A/C + B/C) if safe and A/C and B/C can be folded.
2684       if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(LHS)) {
2685         SmallVector<const SCEV *, 4> Operands;
2686         for (unsigned i = 0, e = A->getNumOperands(); i != e; ++i)
2687           Operands.push_back(getZeroExtendExpr(A->getOperand(i), ExtTy));
2688         if (getZeroExtendExpr(A, ExtTy) == getAddExpr(Operands)) {
2689           Operands.clear();
2690           for (unsigned i = 0, e = A->getNumOperands(); i != e; ++i) {
2691             const SCEV *Op = getUDivExpr(A->getOperand(i), RHS);
2692             if (isa<SCEVUDivExpr>(Op) ||
2693                 getMulExpr(Op, RHS) != A->getOperand(i))
2694               break;
2695             Operands.push_back(Op);
2696           }
2697           if (Operands.size() == A->getNumOperands())
2698             return getAddExpr(Operands);
2699         }
2700       }
2701
2702       // Fold if both operands are constant.
2703       if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
2704         Constant *LHSCV = LHSC->getValue();
2705         Constant *RHSCV = RHSC->getValue();
2706         return getConstant(cast<ConstantInt>(ConstantExpr::getUDiv(LHSCV,
2707                                                                    RHSCV)));
2708       }
2709     }
2710   }
2711
2712   FoldingSetNodeID ID;
2713   ID.AddInteger(scUDivExpr);
2714   ID.AddPointer(LHS);
2715   ID.AddPointer(RHS);
2716   void *IP = nullptr;
2717   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
2718   SCEV *S = new (SCEVAllocator) SCEVUDivExpr(ID.Intern(SCEVAllocator),
2719                                              LHS, RHS);
2720   UniqueSCEVs.InsertNode(S, IP);
2721   return S;
2722 }
2723
2724 static const APInt gcd(const SCEVConstant *C1, const SCEVConstant *C2) {
2725   APInt A = C1->getValue()->getValue().abs();
2726   APInt B = C2->getValue()->getValue().abs();
2727   uint32_t ABW = A.getBitWidth();
2728   uint32_t BBW = B.getBitWidth();
2729
2730   if (ABW > BBW)
2731     B = B.zext(ABW);
2732   else if (ABW < BBW)
2733     A = A.zext(BBW);
2734
2735   return APIntOps::GreatestCommonDivisor(A, B);
2736 }
2737
2738 /// getUDivExactExpr - Get a canonical unsigned division expression, or
2739 /// something simpler if possible. There is no representation for an exact udiv
2740 /// in SCEV IR, but we can attempt to remove factors from the LHS and RHS.
2741 /// We can't do this when it's not exact because the udiv may be clearing bits.
2742 const SCEV *ScalarEvolution::getUDivExactExpr(const SCEV *LHS,
2743                                               const SCEV *RHS) {
2744   // TODO: we could try to find factors in all sorts of things, but for now we
2745   // just deal with u/exact (multiply, constant). See SCEVDivision towards the
2746   // end of this file for inspiration.
2747
2748   const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(LHS);
2749   if (!Mul)
2750     return getUDivExpr(LHS, RHS);
2751
2752   if (const SCEVConstant *RHSCst = dyn_cast<SCEVConstant>(RHS)) {
2753     // If the mulexpr multiplies by a constant, then that constant must be the
2754     // first element of the mulexpr.
2755     if (const SCEVConstant *LHSCst =
2756             dyn_cast<SCEVConstant>(Mul->getOperand(0))) {
2757       if (LHSCst == RHSCst) {
2758         SmallVector<const SCEV *, 2> Operands;
2759         Operands.append(Mul->op_begin() + 1, Mul->op_end());
2760         return getMulExpr(Operands);
2761       }
2762
2763       // We can't just assume that LHSCst divides RHSCst cleanly, it could be
2764       // that there's a factor provided by one of the other terms. We need to
2765       // check.
2766       APInt Factor = gcd(LHSCst, RHSCst);
2767       if (!Factor.isIntN(1)) {
2768         LHSCst = cast<SCEVConstant>(
2769             getConstant(LHSCst->getValue()->getValue().udiv(Factor)));
2770         RHSCst = cast<SCEVConstant>(
2771             getConstant(RHSCst->getValue()->getValue().udiv(Factor)));
2772         SmallVector<const SCEV *, 2> Operands;
2773         Operands.push_back(LHSCst);
2774         Operands.append(Mul->op_begin() + 1, Mul->op_end());
2775         LHS = getMulExpr(Operands);
2776         RHS = RHSCst;
2777         Mul = dyn_cast<SCEVMulExpr>(LHS);
2778         if (!Mul)
2779           return getUDivExactExpr(LHS, RHS);
2780       }
2781     }
2782   }
2783
2784   for (int i = 0, e = Mul->getNumOperands(); i != e; ++i) {
2785     if (Mul->getOperand(i) == RHS) {
2786       SmallVector<const SCEV *, 2> Operands;
2787       Operands.append(Mul->op_begin(), Mul->op_begin() + i);
2788       Operands.append(Mul->op_begin() + i + 1, Mul->op_end());
2789       return getMulExpr(Operands);
2790     }
2791   }
2792
2793   return getUDivExpr(LHS, RHS);
2794 }
2795
2796 /// getAddRecExpr - Get an add recurrence expression for the specified loop.
2797 /// Simplify the expression as much as possible.
2798 const SCEV *ScalarEvolution::getAddRecExpr(const SCEV *Start, const SCEV *Step,
2799                                            const Loop *L,
2800                                            SCEV::NoWrapFlags Flags) {
2801   SmallVector<const SCEV *, 4> Operands;
2802   Operands.push_back(Start);
2803   if (const SCEVAddRecExpr *StepChrec = dyn_cast<SCEVAddRecExpr>(Step))
2804     if (StepChrec->getLoop() == L) {
2805       Operands.append(StepChrec->op_begin(), StepChrec->op_end());
2806       return getAddRecExpr(Operands, L, maskFlags(Flags, SCEV::FlagNW));
2807     }
2808
2809   Operands.push_back(Step);
2810   return getAddRecExpr(Operands, L, Flags);
2811 }
2812
2813 /// getAddRecExpr - Get an add recurrence expression for the specified loop.
2814 /// Simplify the expression as much as possible.
2815 const SCEV *
2816 ScalarEvolution::getAddRecExpr(SmallVectorImpl<const SCEV *> &Operands,
2817                                const Loop *L, SCEV::NoWrapFlags Flags) {
2818   if (Operands.size() == 1) return Operands[0];
2819 #ifndef NDEBUG
2820   Type *ETy = getEffectiveSCEVType(Operands[0]->getType());
2821   for (unsigned i = 1, e = Operands.size(); i != e; ++i)
2822     assert(getEffectiveSCEVType(Operands[i]->getType()) == ETy &&
2823            "SCEVAddRecExpr operand types don't match!");
2824   for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2825     assert(isLoopInvariant(Operands[i], L) &&
2826            "SCEVAddRecExpr operand is not loop-invariant!");
2827 #endif
2828
2829   if (Operands.back()->isZero()) {
2830     Operands.pop_back();
2831     return getAddRecExpr(Operands, L, SCEV::FlagAnyWrap); // {X,+,0}  -->  X
2832   }
2833
2834   // It's tempting to want to call getMaxBackedgeTakenCount count here and
2835   // use that information to infer NUW and NSW flags. However, computing a
2836   // BE count requires calling getAddRecExpr, so we may not yet have a
2837   // meaningful BE count at this point (and if we don't, we'd be stuck
2838   // with a SCEVCouldNotCompute as the cached BE count).
2839
2840   Flags = StrengthenNoWrapFlags(this, scAddRecExpr, Operands, Flags);
2841
2842   // Canonicalize nested AddRecs in by nesting them in order of loop depth.
2843   if (const SCEVAddRecExpr *NestedAR = dyn_cast<SCEVAddRecExpr>(Operands[0])) {
2844     const Loop *NestedLoop = NestedAR->getLoop();
2845     if (L->contains(NestedLoop) ?
2846         (L->getLoopDepth() < NestedLoop->getLoopDepth()) :
2847         (!NestedLoop->contains(L) &&
2848          DT->dominates(L->getHeader(), NestedLoop->getHeader()))) {
2849       SmallVector<const SCEV *, 4> NestedOperands(NestedAR->op_begin(),
2850                                                   NestedAR->op_end());
2851       Operands[0] = NestedAR->getStart();
2852       // AddRecs require their operands be loop-invariant with respect to their
2853       // loops. Don't perform this transformation if it would break this
2854       // requirement.
2855       bool AllInvariant = true;
2856       for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2857         if (!isLoopInvariant(Operands[i], L)) {
2858           AllInvariant = false;
2859           break;
2860         }
2861       if (AllInvariant) {
2862         // Create a recurrence for the outer loop with the same step size.
2863         //
2864         // The outer recurrence keeps its NW flag but only keeps NUW/NSW if the
2865         // inner recurrence has the same property.
2866         SCEV::NoWrapFlags OuterFlags =
2867           maskFlags(Flags, SCEV::FlagNW | NestedAR->getNoWrapFlags());
2868
2869         NestedOperands[0] = getAddRecExpr(Operands, L, OuterFlags);
2870         AllInvariant = true;
2871         for (unsigned i = 0, e = NestedOperands.size(); i != e; ++i)
2872           if (!isLoopInvariant(NestedOperands[i], NestedLoop)) {
2873             AllInvariant = false;
2874             break;
2875           }
2876         if (AllInvariant) {
2877           // Ok, both add recurrences are valid after the transformation.
2878           //
2879           // The inner recurrence keeps its NW flag but only keeps NUW/NSW if
2880           // the outer recurrence has the same property.
2881           SCEV::NoWrapFlags InnerFlags =
2882             maskFlags(NestedAR->getNoWrapFlags(), SCEV::FlagNW | Flags);
2883           return getAddRecExpr(NestedOperands, NestedLoop, InnerFlags);
2884         }
2885       }
2886       // Reset Operands to its original state.
2887       Operands[0] = NestedAR;
2888     }
2889   }
2890
2891   // Okay, it looks like we really DO need an addrec expr.  Check to see if we
2892   // already have one, otherwise create a new one.
2893   FoldingSetNodeID ID;
2894   ID.AddInteger(scAddRecExpr);
2895   for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2896     ID.AddPointer(Operands[i]);
2897   ID.AddPointer(L);
2898   void *IP = nullptr;
2899   SCEVAddRecExpr *S =
2900     static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
2901   if (!S) {
2902     const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Operands.size());
2903     std::uninitialized_copy(Operands.begin(), Operands.end(), O);
2904     S = new (SCEVAllocator) SCEVAddRecExpr(ID.Intern(SCEVAllocator),
2905                                            O, Operands.size(), L);
2906     UniqueSCEVs.InsertNode(S, IP);
2907   }
2908   S->setNoWrapFlags(Flags);
2909   return S;
2910 }
2911
2912 const SCEV *ScalarEvolution::getSMaxExpr(const SCEV *LHS,
2913                                          const SCEV *RHS) {
2914   SmallVector<const SCEV *, 2> Ops;
2915   Ops.push_back(LHS);
2916   Ops.push_back(RHS);
2917   return getSMaxExpr(Ops);
2918 }
2919
2920 const SCEV *
2921 ScalarEvolution::getSMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
2922   assert(!Ops.empty() && "Cannot get empty smax!");
2923   if (Ops.size() == 1) return Ops[0];
2924 #ifndef NDEBUG
2925   Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
2926   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
2927     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
2928            "SCEVSMaxExpr operand types don't match!");
2929 #endif
2930
2931   // Sort by complexity, this groups all similar expression types together.
2932   GroupByComplexity(Ops, LI);
2933
2934   // If there are any constants, fold them together.
2935   unsigned Idx = 0;
2936   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
2937     ++Idx;
2938     assert(Idx < Ops.size());
2939     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
2940       // We found two constants, fold them together!
2941       ConstantInt *Fold = ConstantInt::get(getContext(),
2942                               APIntOps::smax(LHSC->getValue()->getValue(),
2943                                              RHSC->getValue()->getValue()));
2944       Ops[0] = getConstant(Fold);
2945       Ops.erase(Ops.begin()+1);  // Erase the folded element
2946       if (Ops.size() == 1) return Ops[0];
2947       LHSC = cast<SCEVConstant>(Ops[0]);
2948     }
2949
2950     // If we are left with a constant minimum-int, strip it off.
2951     if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(true)) {
2952       Ops.erase(Ops.begin());
2953       --Idx;
2954     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(true)) {
2955       // If we have an smax with a constant maximum-int, it will always be
2956       // maximum-int.
2957       return Ops[0];
2958     }
2959
2960     if (Ops.size() == 1) return Ops[0];
2961   }
2962
2963   // Find the first SMax
2964   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scSMaxExpr)
2965     ++Idx;
2966
2967   // Check to see if one of the operands is an SMax. If so, expand its operands
2968   // onto our operand list, and recurse to simplify.
2969   if (Idx < Ops.size()) {
2970     bool DeletedSMax = false;
2971     while (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(Ops[Idx])) {
2972       Ops.erase(Ops.begin()+Idx);
2973       Ops.append(SMax->op_begin(), SMax->op_end());
2974       DeletedSMax = true;
2975     }
2976
2977     if (DeletedSMax)
2978       return getSMaxExpr(Ops);
2979   }
2980
2981   // Okay, check to see if the same value occurs in the operand list twice.  If
2982   // so, delete one.  Since we sorted the list, these values are required to
2983   // be adjacent.
2984   for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
2985     //  X smax Y smax Y  -->  X smax Y
2986     //  X smax Y         -->  X, if X is always greater than Y
2987     if (Ops[i] == Ops[i+1] ||
2988         isKnownPredicate(ICmpInst::ICMP_SGE, Ops[i], Ops[i+1])) {
2989       Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
2990       --i; --e;
2991     } else if (isKnownPredicate(ICmpInst::ICMP_SLE, Ops[i], Ops[i+1])) {
2992       Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
2993       --i; --e;
2994     }
2995
2996   if (Ops.size() == 1) return Ops[0];
2997
2998   assert(!Ops.empty() && "Reduced smax down to nothing!");
2999
3000   // Okay, it looks like we really DO need an smax expr.  Check to see if we
3001   // already have one, otherwise create a new one.
3002   FoldingSetNodeID ID;
3003   ID.AddInteger(scSMaxExpr);
3004   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
3005     ID.AddPointer(Ops[i]);
3006   void *IP = nullptr;
3007   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
3008   const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
3009   std::uninitialized_copy(Ops.begin(), Ops.end(), O);
3010   SCEV *S = new (SCEVAllocator) SCEVSMaxExpr(ID.Intern(SCEVAllocator),
3011                                              O, Ops.size());
3012   UniqueSCEVs.InsertNode(S, IP);
3013   return S;
3014 }
3015
3016 const SCEV *ScalarEvolution::getUMaxExpr(const SCEV *LHS,
3017                                          const SCEV *RHS) {
3018   SmallVector<const SCEV *, 2> Ops;
3019   Ops.push_back(LHS);
3020   Ops.push_back(RHS);
3021   return getUMaxExpr(Ops);
3022 }
3023
3024 const SCEV *
3025 ScalarEvolution::getUMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
3026   assert(!Ops.empty() && "Cannot get empty umax!");
3027   if (Ops.size() == 1) return Ops[0];
3028 #ifndef NDEBUG
3029   Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
3030   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
3031     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
3032            "SCEVUMaxExpr operand types don't match!");
3033 #endif
3034
3035   // Sort by complexity, this groups all similar expression types together.
3036   GroupByComplexity(Ops, LI);
3037
3038   // If there are any constants, fold them together.
3039   unsigned Idx = 0;
3040   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
3041     ++Idx;
3042     assert(Idx < Ops.size());
3043     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
3044       // We found two constants, fold them together!
3045       ConstantInt *Fold = ConstantInt::get(getContext(),
3046                               APIntOps::umax(LHSC->getValue()->getValue(),
3047                                              RHSC->getValue()->getValue()));
3048       Ops[0] = getConstant(Fold);
3049       Ops.erase(Ops.begin()+1);  // Erase the folded element
3050       if (Ops.size() == 1) return Ops[0];
3051       LHSC = cast<SCEVConstant>(Ops[0]);
3052     }
3053
3054     // If we are left with a constant minimum-int, strip it off.
3055     if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(false)) {
3056       Ops.erase(Ops.begin());
3057       --Idx;
3058     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(false)) {
3059       // If we have an umax with a constant maximum-int, it will always be
3060       // maximum-int.
3061       return Ops[0];
3062     }
3063
3064     if (Ops.size() == 1) return Ops[0];
3065   }
3066
3067   // Find the first UMax
3068   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scUMaxExpr)
3069     ++Idx;
3070
3071   // Check to see if one of the operands is a UMax. If so, expand its operands
3072   // onto our operand list, and recurse to simplify.
3073   if (Idx < Ops.size()) {
3074     bool DeletedUMax = false;
3075     while (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(Ops[Idx])) {
3076       Ops.erase(Ops.begin()+Idx);
3077       Ops.append(UMax->op_begin(), UMax->op_end());
3078       DeletedUMax = true;
3079     }
3080
3081     if (DeletedUMax)
3082       return getUMaxExpr(Ops);
3083   }
3084
3085   // Okay, check to see if the same value occurs in the operand list twice.  If
3086   // so, delete one.  Since we sorted the list, these values are required to
3087   // be adjacent.
3088   for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
3089     //  X umax Y umax Y  -->  X umax Y
3090     //  X umax Y         -->  X, if X is always greater than Y
3091     if (Ops[i] == Ops[i+1] ||
3092         isKnownPredicate(ICmpInst::ICMP_UGE, Ops[i], Ops[i+1])) {
3093       Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
3094       --i; --e;
3095     } else if (isKnownPredicate(ICmpInst::ICMP_ULE, Ops[i], Ops[i+1])) {
3096       Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
3097       --i; --e;
3098     }
3099
3100   if (Ops.size() == 1) return Ops[0];
3101
3102   assert(!Ops.empty() && "Reduced umax down to nothing!");
3103
3104   // Okay, it looks like we really DO need a umax expr.  Check to see if we
3105   // already have one, otherwise create a new one.
3106   FoldingSetNodeID ID;
3107   ID.AddInteger(scUMaxExpr);
3108   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
3109     ID.AddPointer(Ops[i]);
3110   void *IP = nullptr;
3111   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
3112   const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
3113   std::uninitialized_copy(Ops.begin(), Ops.end(), O);
3114   SCEV *S = new (SCEVAllocator) SCEVUMaxExpr(ID.Intern(SCEVAllocator),
3115                                              O, Ops.size());
3116   UniqueSCEVs.InsertNode(S, IP);
3117   return S;
3118 }
3119
3120 const SCEV *ScalarEvolution::getSMinExpr(const SCEV *LHS,
3121                                          const SCEV *RHS) {
3122   // ~smax(~x, ~y) == smin(x, y).
3123   return getNotSCEV(getSMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
3124 }
3125
3126 const SCEV *ScalarEvolution::getUMinExpr(const SCEV *LHS,
3127                                          const SCEV *RHS) {
3128   // ~umax(~x, ~y) == umin(x, y)
3129   return getNotSCEV(getUMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
3130 }
3131
3132 const SCEV *ScalarEvolution::getSizeOfExpr(Type *IntTy, Type *AllocTy) {
3133   // We can bypass creating a target-independent
3134   // constant expression and then folding it back into a ConstantInt.
3135   // This is just a compile-time optimization.
3136   return getConstant(IntTy,
3137                      F->getParent()->getDataLayout().getTypeAllocSize(AllocTy));
3138 }
3139
3140 const SCEV *ScalarEvolution::getOffsetOfExpr(Type *IntTy,
3141                                              StructType *STy,
3142                                              unsigned FieldNo) {
3143   // We can bypass creating a target-independent
3144   // constant expression and then folding it back into a ConstantInt.
3145   // This is just a compile-time optimization.
3146   return getConstant(
3147       IntTy,
3148       F->getParent()->getDataLayout().getStructLayout(STy)->getElementOffset(
3149           FieldNo));
3150 }
3151
3152 const SCEV *ScalarEvolution::getUnknown(Value *V) {
3153   // Don't attempt to do anything other than create a SCEVUnknown object
3154   // here.  createSCEV only calls getUnknown after checking for all other
3155   // interesting possibilities, and any other code that calls getUnknown
3156   // is doing so in order to hide a value from SCEV canonicalization.
3157
3158   FoldingSetNodeID ID;
3159   ID.AddInteger(scUnknown);
3160   ID.AddPointer(V);
3161   void *IP = nullptr;
3162   if (SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) {
3163     assert(cast<SCEVUnknown>(S)->getValue() == V &&
3164            "Stale SCEVUnknown in uniquing map!");
3165     return S;
3166   }
3167   SCEV *S = new (SCEVAllocator) SCEVUnknown(ID.Intern(SCEVAllocator), V, this,
3168                                             FirstUnknown);
3169   FirstUnknown = cast<SCEVUnknown>(S);
3170   UniqueSCEVs.InsertNode(S, IP);
3171   return S;
3172 }
3173
3174 //===----------------------------------------------------------------------===//
3175 //            Basic SCEV Analysis and PHI Idiom Recognition Code
3176 //
3177
3178 /// isSCEVable - Test if values of the given type are analyzable within
3179 /// the SCEV framework. This primarily includes integer types, and it
3180 /// can optionally include pointer types if the ScalarEvolution class
3181 /// has access to target-specific information.
3182 bool ScalarEvolution::isSCEVable(Type *Ty) const {
3183   // Integers and pointers are always SCEVable.
3184   return Ty->isIntegerTy() || Ty->isPointerTy();
3185 }
3186
3187 /// getTypeSizeInBits - Return the size in bits of the specified type,
3188 /// for which isSCEVable must return true.
3189 uint64_t ScalarEvolution::getTypeSizeInBits(Type *Ty) const {
3190   assert(isSCEVable(Ty) && "Type is not SCEVable!");
3191   return F->getParent()->getDataLayout().getTypeSizeInBits(Ty);
3192 }
3193
3194 /// getEffectiveSCEVType - Return a type with the same bitwidth as
3195 /// the given type and which represents how SCEV will treat the given
3196 /// type, for which isSCEVable must return true. For pointer types,
3197 /// this is the pointer-sized integer type.
3198 Type *ScalarEvolution::getEffectiveSCEVType(Type *Ty) const {
3199   assert(isSCEVable(Ty) && "Type is not SCEVable!");
3200
3201   if (Ty->isIntegerTy()) {
3202     return Ty;
3203   }
3204
3205   // The only other support type is pointer.
3206   assert(Ty->isPointerTy() && "Unexpected non-pointer non-integer type!");
3207   return F->getParent()->getDataLayout().getIntPtrType(Ty);
3208 }
3209
3210 const SCEV *ScalarEvolution::getCouldNotCompute() {
3211   return &CouldNotCompute;
3212 }
3213
3214 namespace {
3215   // Helper class working with SCEVTraversal to figure out if a SCEV contains
3216   // a SCEVUnknown with null value-pointer. FindInvalidSCEVUnknown::FindOne
3217   // is set iff if find such SCEVUnknown.
3218   //
3219   struct FindInvalidSCEVUnknown {
3220     bool FindOne;
3221     FindInvalidSCEVUnknown() { FindOne = false; }
3222     bool follow(const SCEV *S) {
3223       switch (static_cast<SCEVTypes>(S->getSCEVType())) {
3224       case scConstant:
3225         return false;
3226       case scUnknown:
3227         if (!cast<SCEVUnknown>(S)->getValue())
3228           FindOne = true;
3229         return false;
3230       default:
3231         return true;
3232       }
3233     }
3234     bool isDone() const { return FindOne; }
3235   };
3236 }
3237
3238 bool ScalarEvolution::checkValidity(const SCEV *S) const {
3239   FindInvalidSCEVUnknown F;
3240   SCEVTraversal<FindInvalidSCEVUnknown> ST(F);
3241   ST.visitAll(S);
3242
3243   return !F.FindOne;
3244 }
3245
3246 /// getSCEV - Return an existing SCEV if it exists, otherwise analyze the
3247 /// expression and create a new one.
3248 const SCEV *ScalarEvolution::getSCEV(Value *V) {
3249   assert(isSCEVable(V->getType()) && "Value is not SCEVable!");
3250
3251   ValueExprMapType::iterator I = ValueExprMap.find_as(V);
3252   if (I != ValueExprMap.end()) {
3253     const SCEV *S = I->second;
3254     if (checkValidity(S))
3255       return S;
3256     else
3257       ValueExprMap.erase(I);
3258   }
3259   const SCEV *S = createSCEV(V);
3260
3261   // The process of creating a SCEV for V may have caused other SCEVs
3262   // to have been created, so it's necessary to insert the new entry
3263   // from scratch, rather than trying to remember the insert position
3264   // above.
3265   ValueExprMap.insert(std::make_pair(SCEVCallbackVH(V, this), S));
3266   return S;
3267 }
3268
3269 /// getNegativeSCEV - Return a SCEV corresponding to -V = -1*V
3270 ///
3271 const SCEV *ScalarEvolution::getNegativeSCEV(const SCEV *V) {
3272   if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
3273     return getConstant(
3274                cast<ConstantInt>(ConstantExpr::getNeg(VC->getValue())));
3275
3276   Type *Ty = V->getType();
3277   Ty = getEffectiveSCEVType(Ty);
3278   return getMulExpr(V,
3279                   getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty))));
3280 }
3281
3282 /// getNotSCEV - Return a SCEV corresponding to ~V = -1-V
3283 const SCEV *ScalarEvolution::getNotSCEV(const SCEV *V) {
3284   if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
3285     return getConstant(
3286                 cast<ConstantInt>(ConstantExpr::getNot(VC->getValue())));
3287
3288   Type *Ty = V->getType();
3289   Ty = getEffectiveSCEVType(Ty);
3290   const SCEV *AllOnes =
3291                    getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty)));
3292   return getMinusSCEV(AllOnes, V);
3293 }
3294
3295 /// getMinusSCEV - Return LHS-RHS.  Minus is represented in SCEV as A+B*-1.
3296 const SCEV *ScalarEvolution::getMinusSCEV(const SCEV *LHS, const SCEV *RHS,
3297                                           SCEV::NoWrapFlags Flags) {
3298   assert(!maskFlags(Flags, SCEV::FlagNUW) && "subtraction does not have NUW");
3299
3300   // Fast path: X - X --> 0.
3301   if (LHS == RHS)
3302     return getConstant(LHS->getType(), 0);
3303
3304   // X - Y --> X + -Y.
3305   // X -(nsw || nuw) Y --> X + -Y.
3306   return getAddExpr(LHS, getNegativeSCEV(RHS));
3307 }
3308
3309 /// getTruncateOrZeroExtend - Return a SCEV corresponding to a conversion of the
3310 /// input value to the specified type.  If the type must be extended, it is zero
3311 /// extended.
3312 const SCEV *
3313 ScalarEvolution::getTruncateOrZeroExtend(const SCEV *V, Type *Ty) {
3314   Type *SrcTy = V->getType();
3315   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3316          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3317          "Cannot truncate or zero extend with non-integer arguments!");
3318   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3319     return V;  // No conversion
3320   if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
3321     return getTruncateExpr(V, Ty);
3322   return getZeroExtendExpr(V, Ty);
3323 }
3324
3325 /// getTruncateOrSignExtend - Return a SCEV corresponding to a conversion of the
3326 /// input value to the specified type.  If the type must be extended, it is sign
3327 /// extended.
3328 const SCEV *
3329 ScalarEvolution::getTruncateOrSignExtend(const SCEV *V,
3330                                          Type *Ty) {
3331   Type *SrcTy = V->getType();
3332   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3333          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3334          "Cannot truncate or zero extend with non-integer arguments!");
3335   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3336     return V;  // No conversion
3337   if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
3338     return getTruncateExpr(V, Ty);
3339   return getSignExtendExpr(V, Ty);
3340 }
3341
3342 /// getNoopOrZeroExtend - Return a SCEV corresponding to a conversion of the
3343 /// input value to the specified type.  If the type must be extended, it is zero
3344 /// extended.  The conversion must not be narrowing.
3345 const SCEV *
3346 ScalarEvolution::getNoopOrZeroExtend(const SCEV *V, Type *Ty) {
3347   Type *SrcTy = V->getType();
3348   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3349          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3350          "Cannot noop or zero extend with non-integer arguments!");
3351   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
3352          "getNoopOrZeroExtend cannot truncate!");
3353   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3354     return V;  // No conversion
3355   return getZeroExtendExpr(V, Ty);
3356 }
3357
3358 /// getNoopOrSignExtend - Return a SCEV corresponding to a conversion of the
3359 /// input value to the specified type.  If the type must be extended, it is sign
3360 /// extended.  The conversion must not be narrowing.
3361 const SCEV *
3362 ScalarEvolution::getNoopOrSignExtend(const SCEV *V, Type *Ty) {
3363   Type *SrcTy = V->getType();
3364   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3365          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3366          "Cannot noop or sign extend with non-integer arguments!");
3367   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
3368          "getNoopOrSignExtend cannot truncate!");
3369   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3370     return V;  // No conversion
3371   return getSignExtendExpr(V, Ty);
3372 }
3373
3374 /// getNoopOrAnyExtend - Return a SCEV corresponding to a conversion of
3375 /// the input value to the specified type. If the type must be extended,
3376 /// it is extended with unspecified bits. The conversion must not be
3377 /// narrowing.
3378 const SCEV *
3379 ScalarEvolution::getNoopOrAnyExtend(const SCEV *V, Type *Ty) {
3380   Type *SrcTy = V->getType();
3381   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3382          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3383          "Cannot noop or any extend with non-integer arguments!");
3384   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
3385          "getNoopOrAnyExtend cannot truncate!");
3386   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3387     return V;  // No conversion
3388   return getAnyExtendExpr(V, Ty);
3389 }
3390
3391 /// getTruncateOrNoop - Return a SCEV corresponding to a conversion of the
3392 /// input value to the specified type.  The conversion must not be widening.
3393 const SCEV *
3394 ScalarEvolution::getTruncateOrNoop(const SCEV *V, Type *Ty) {
3395   Type *SrcTy = V->getType();
3396   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3397          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3398          "Cannot truncate or noop with non-integer arguments!");
3399   assert(getTypeSizeInBits(SrcTy) >= getTypeSizeInBits(Ty) &&
3400          "getTruncateOrNoop cannot extend!");
3401   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3402     return V;  // No conversion
3403   return getTruncateExpr(V, Ty);
3404 }
3405
3406 /// getUMaxFromMismatchedTypes - Promote the operands to the wider of
3407 /// the types using zero-extension, and then perform a umax operation
3408 /// with them.
3409 const SCEV *ScalarEvolution::getUMaxFromMismatchedTypes(const SCEV *LHS,
3410                                                         const SCEV *RHS) {
3411   const SCEV *PromotedLHS = LHS;
3412   const SCEV *PromotedRHS = RHS;
3413
3414   if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
3415     PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
3416   else
3417     PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
3418
3419   return getUMaxExpr(PromotedLHS, PromotedRHS);
3420 }
3421
3422 /// getUMinFromMismatchedTypes - Promote the operands to the wider of
3423 /// the types using zero-extension, and then perform a umin operation
3424 /// with them.
3425 const SCEV *ScalarEvolution::getUMinFromMismatchedTypes(const SCEV *LHS,
3426                                                         const SCEV *RHS) {
3427   const SCEV *PromotedLHS = LHS;
3428   const SCEV *PromotedRHS = RHS;
3429
3430   if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
3431     PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
3432   else
3433     PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
3434
3435   return getUMinExpr(PromotedLHS, PromotedRHS);
3436 }
3437
3438 /// getPointerBase - Transitively follow the chain of pointer-type operands
3439 /// until reaching a SCEV that does not have a single pointer operand. This
3440 /// returns a SCEVUnknown pointer for well-formed pointer-type expressions,
3441 /// but corner cases do exist.
3442 const SCEV *ScalarEvolution::getPointerBase(const SCEV *V) {
3443   // A pointer operand may evaluate to a nonpointer expression, such as null.
3444   if (!V->getType()->isPointerTy())
3445     return V;
3446
3447   if (const SCEVCastExpr *Cast = dyn_cast<SCEVCastExpr>(V)) {
3448     return getPointerBase(Cast->getOperand());
3449   }
3450   else if (const SCEVNAryExpr *NAry = dyn_cast<SCEVNAryExpr>(V)) {
3451     const SCEV *PtrOp = nullptr;
3452     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
3453          I != E; ++I) {
3454       if ((*I)->getType()->isPointerTy()) {
3455         // Cannot find the base of an expression with multiple pointer operands.
3456         if (PtrOp)
3457           return V;
3458         PtrOp = *I;
3459       }
3460     }
3461     if (!PtrOp)
3462       return V;
3463     return getPointerBase(PtrOp);
3464   }
3465   return V;
3466 }
3467
3468 /// PushDefUseChildren - Push users of the given Instruction
3469 /// onto the given Worklist.
3470 static void
3471 PushDefUseChildren(Instruction *I,
3472                    SmallVectorImpl<Instruction *> &Worklist) {
3473   // Push the def-use children onto the Worklist stack.
3474   for (User *U : I->users())
3475     Worklist.push_back(cast<Instruction>(U));
3476 }
3477
3478 /// ForgetSymbolicValue - This looks up computed SCEV values for all
3479 /// instructions that depend on the given instruction and removes them from
3480 /// the ValueExprMapType map if they reference SymName. This is used during PHI
3481 /// resolution.
3482 void
3483 ScalarEvolution::ForgetSymbolicName(Instruction *PN, const SCEV *SymName) {
3484   SmallVector<Instruction *, 16> Worklist;
3485   PushDefUseChildren(PN, Worklist);
3486
3487   SmallPtrSet<Instruction *, 8> Visited;
3488   Visited.insert(PN);
3489   while (!Worklist.empty()) {
3490     Instruction *I = Worklist.pop_back_val();
3491     if (!Visited.insert(I).second)
3492       continue;
3493
3494     ValueExprMapType::iterator It =
3495       ValueExprMap.find_as(static_cast<Value *>(I));
3496     if (It != ValueExprMap.end()) {
3497       const SCEV *Old = It->second;
3498
3499       // Short-circuit the def-use traversal if the symbolic name
3500       // ceases to appear in expressions.
3501       if (Old != SymName && !hasOperand(Old, SymName))
3502         continue;
3503
3504       // SCEVUnknown for a PHI either means that it has an unrecognized
3505       // structure, it's a PHI that's in the progress of being computed
3506       // by createNodeForPHI, or it's a single-value PHI. In the first case,
3507       // additional loop trip count information isn't going to change anything.
3508       // In the second case, createNodeForPHI will perform the necessary
3509       // updates on its own when it gets to that point. In the third, we do
3510       // want to forget the SCEVUnknown.
3511       if (!isa<PHINode>(I) ||
3512           !isa<SCEVUnknown>(Old) ||
3513           (I != PN && Old == SymName)) {
3514         forgetMemoizedResults(Old);
3515         ValueExprMap.erase(It);
3516       }
3517     }
3518
3519     PushDefUseChildren(I, Worklist);
3520   }
3521 }
3522
3523 /// createNodeForPHI - PHI nodes have two cases.  Either the PHI node exists in
3524 /// a loop header, making it a potential recurrence, or it doesn't.
3525 ///
3526 const SCEV *ScalarEvolution::createNodeForPHI(PHINode *PN) {
3527   if (const Loop *L = LI->getLoopFor(PN->getParent()))
3528     if (L->getHeader() == PN->getParent()) {
3529       // The loop may have multiple entrances or multiple exits; we can analyze
3530       // this phi as an addrec if it has a unique entry value and a unique
3531       // backedge value.
3532       Value *BEValueV = nullptr, *StartValueV = nullptr;
3533       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
3534         Value *V = PN->getIncomingValue(i);
3535         if (L->contains(PN->getIncomingBlock(i))) {
3536           if (!BEValueV) {
3537             BEValueV = V;
3538           } else if (BEValueV != V) {
3539             BEValueV = nullptr;
3540             break;
3541           }
3542         } else if (!StartValueV) {
3543           StartValueV = V;
3544         } else if (StartValueV != V) {
3545           StartValueV = nullptr;
3546           break;
3547         }
3548       }
3549       if (BEValueV && StartValueV) {
3550         // While we are analyzing this PHI node, handle its value symbolically.
3551         const SCEV *SymbolicName = getUnknown(PN);
3552         assert(ValueExprMap.find_as(PN) == ValueExprMap.end() &&
3553                "PHI node already processed?");
3554         ValueExprMap.insert(std::make_pair(SCEVCallbackVH(PN, this), SymbolicName));
3555
3556         // Using this symbolic name for the PHI, analyze the value coming around
3557         // the back-edge.
3558         const SCEV *BEValue = getSCEV(BEValueV);
3559
3560         // NOTE: If BEValue is loop invariant, we know that the PHI node just
3561         // has a special value for the first iteration of the loop.
3562
3563         // If the value coming around the backedge is an add with the symbolic
3564         // value we just inserted, then we found a simple induction variable!
3565         if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(BEValue)) {
3566           // If there is a single occurrence of the symbolic value, replace it
3567           // with a recurrence.
3568           unsigned FoundIndex = Add->getNumOperands();
3569           for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
3570             if (Add->getOperand(i) == SymbolicName)
3571               if (FoundIndex == e) {
3572                 FoundIndex = i;
3573                 break;
3574               }
3575
3576           if (FoundIndex != Add->getNumOperands()) {
3577             // Create an add with everything but the specified operand.
3578             SmallVector<const SCEV *, 8> Ops;
3579             for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
3580               if (i != FoundIndex)
3581                 Ops.push_back(Add->getOperand(i));
3582             const SCEV *Accum = getAddExpr(Ops);
3583
3584             // This is not a valid addrec if the step amount is varying each
3585             // loop iteration, but is not itself an addrec in this loop.
3586             if (isLoopInvariant(Accum, L) ||
3587                 (isa<SCEVAddRecExpr>(Accum) &&
3588                  cast<SCEVAddRecExpr>(Accum)->getLoop() == L)) {
3589               SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap;
3590
3591               // If the increment doesn't overflow, then neither the addrec nor
3592               // the post-increment will overflow.
3593               if (const AddOperator *OBO = dyn_cast<AddOperator>(BEValueV)) {
3594                 if (OBO->getOperand(0) == PN) {
3595                   if (OBO->hasNoUnsignedWrap())
3596                     Flags = setFlags(Flags, SCEV::FlagNUW);
3597                   if (OBO->hasNoSignedWrap())
3598                     Flags = setFlags(Flags, SCEV::FlagNSW);
3599                 }
3600               } else if (GEPOperator *GEP = dyn_cast<GEPOperator>(BEValueV)) {
3601                 // If the increment is an inbounds GEP, then we know the address
3602                 // space cannot be wrapped around. We cannot make any guarantee
3603                 // about signed or unsigned overflow because pointers are
3604                 // unsigned but we may have a negative index from the base
3605                 // pointer. We can guarantee that no unsigned wrap occurs if the
3606                 // indices form a positive value.
3607                 if (GEP->isInBounds() && GEP->getOperand(0) == PN) {
3608                   Flags = setFlags(Flags, SCEV::FlagNW);
3609
3610                   const SCEV *Ptr = getSCEV(GEP->getPointerOperand());
3611                   if (isKnownPositive(getMinusSCEV(getSCEV(GEP), Ptr)))
3612                     Flags = setFlags(Flags, SCEV::FlagNUW);
3613                 }
3614
3615                 // We cannot transfer nuw and nsw flags from subtraction
3616                 // operations -- sub nuw X, Y is not the same as add nuw X, -Y
3617                 // for instance.
3618               }
3619
3620               const SCEV *StartVal = getSCEV(StartValueV);
3621               const SCEV *PHISCEV = getAddRecExpr(StartVal, Accum, L, Flags);
3622
3623               // Since the no-wrap flags are on the increment, they apply to the
3624               // post-incremented value as well.
3625               if (isLoopInvariant(Accum, L))
3626                 (void)getAddRecExpr(getAddExpr(StartVal, Accum),
3627                                     Accum, L, Flags);
3628
3629               // Okay, for the entire analysis of this edge we assumed the PHI
3630               // to be symbolic.  We now need to go back and purge all of the
3631               // entries for the scalars that use the symbolic expression.
3632               ForgetSymbolicName(PN, SymbolicName);
3633               ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
3634               return PHISCEV;
3635             }
3636           }
3637         } else if (const SCEVAddRecExpr *AddRec =
3638                      dyn_cast<SCEVAddRecExpr>(BEValue)) {
3639           // Otherwise, this could be a loop like this:
3640           //     i = 0;  for (j = 1; ..; ++j) { ....  i = j; }
3641           // In this case, j = {1,+,1}  and BEValue is j.
3642           // Because the other in-value of i (0) fits the evolution of BEValue
3643           // i really is an addrec evolution.
3644           if (AddRec->getLoop() == L && AddRec->isAffine()) {
3645             const SCEV *StartVal = getSCEV(StartValueV);
3646
3647             // If StartVal = j.start - j.stride, we can use StartVal as the
3648             // initial step of the addrec evolution.
3649             if (StartVal == getMinusSCEV(AddRec->getOperand(0),
3650                                          AddRec->getOperand(1))) {
3651               // FIXME: For constant StartVal, we should be able to infer
3652               // no-wrap flags.
3653               const SCEV *PHISCEV =
3654                 getAddRecExpr(StartVal, AddRec->getOperand(1), L,
3655                               SCEV::FlagAnyWrap);
3656
3657               // Okay, for the entire analysis of this edge we assumed the PHI
3658               // to be symbolic.  We now need to go back and purge all of the
3659               // entries for the scalars that use the symbolic expression.
3660               ForgetSymbolicName(PN, SymbolicName);
3661               ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
3662               return PHISCEV;
3663             }
3664           }
3665         }
3666       }
3667     }
3668
3669   // If the PHI has a single incoming value, follow that value, unless the
3670   // PHI's incoming blocks are in a different loop, in which case doing so
3671   // risks breaking LCSSA form. Instcombine would normally zap these, but
3672   // it doesn't have DominatorTree information, so it may miss cases.
3673   if (Value *V =
3674           SimplifyInstruction(PN, F->getParent()->getDataLayout(), TLI, DT, AC))
3675     if (LI->replacementPreservesLCSSAForm(PN, V))
3676       return getSCEV(V);
3677
3678   // If it's not a loop phi, we can't handle it yet.
3679   return getUnknown(PN);
3680 }
3681
3682 /// createNodeForGEP - Expand GEP instructions into add and multiply
3683 /// operations. This allows them to be analyzed by regular SCEV code.
3684 ///
3685 const SCEV *ScalarEvolution::createNodeForGEP(GEPOperator *GEP) {
3686   Type *IntPtrTy = getEffectiveSCEVType(GEP->getType());
3687   Value *Base = GEP->getOperand(0);
3688   // Don't attempt to analyze GEPs over unsized objects.
3689   if (!Base->getType()->getPointerElementType()->isSized())
3690     return getUnknown(GEP);
3691
3692   // Don't blindly transfer the inbounds flag from the GEP instruction to the
3693   // Add expression, because the Instruction may be guarded by control flow
3694   // and the no-overflow bits may not be valid for the expression in any
3695   // context.
3696   SCEV::NoWrapFlags Wrap = GEP->isInBounds() ? SCEV::FlagNSW : SCEV::FlagAnyWrap;
3697
3698   const SCEV *TotalOffset = getConstant(IntPtrTy, 0);
3699   gep_type_iterator GTI = gep_type_begin(GEP);
3700   for (GetElementPtrInst::op_iterator I = std::next(GEP->op_begin()),
3701                                       E = GEP->op_end();
3702        I != E; ++I) {
3703     Value *Index = *I;
3704     // Compute the (potentially symbolic) offset in bytes for this index.
3705     if (StructType *STy = dyn_cast<StructType>(*GTI++)) {
3706       // For a struct, add the member offset.
3707       unsigned FieldNo = cast<ConstantInt>(Index)->getZExtValue();
3708       const SCEV *FieldOffset = getOffsetOfExpr(IntPtrTy, STy, FieldNo);
3709
3710       // Add the field offset to the running total offset.
3711       TotalOffset = getAddExpr(TotalOffset, FieldOffset);
3712     } else {
3713       // For an array, add the element offset, explicitly scaled.
3714       const SCEV *ElementSize = getSizeOfExpr(IntPtrTy, *GTI);
3715       const SCEV *IndexS = getSCEV(Index);
3716       // Getelementptr indices are signed.
3717       IndexS = getTruncateOrSignExtend(IndexS, IntPtrTy);
3718
3719       // Multiply the index by the element size to compute the element offset.
3720       const SCEV *LocalOffset = getMulExpr(IndexS, ElementSize, Wrap);
3721
3722       // Add the element offset to the running total offset.
3723       TotalOffset = getAddExpr(TotalOffset, LocalOffset);
3724     }
3725   }
3726
3727   // Get the SCEV for the GEP base.
3728   const SCEV *BaseS = getSCEV(Base);
3729
3730   // Add the total offset from all the GEP indices to the base.
3731   return getAddExpr(BaseS, TotalOffset, Wrap);
3732 }
3733
3734 /// GetMinTrailingZeros - Determine the minimum number of zero bits that S is
3735 /// guaranteed to end in (at every loop iteration).  It is, at the same time,
3736 /// the minimum number of times S is divisible by 2.  For example, given {4,+,8}
3737 /// it returns 2.  If S is guaranteed to be 0, it returns the bitwidth of S.
3738 uint32_t
3739 ScalarEvolution::GetMinTrailingZeros(const SCEV *S) {
3740   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
3741     return C->getValue()->getValue().countTrailingZeros();
3742
3743   if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(S))
3744     return std::min(GetMinTrailingZeros(T->getOperand()),
3745                     (uint32_t)getTypeSizeInBits(T->getType()));
3746
3747   if (const SCEVZeroExtendExpr *E = dyn_cast<SCEVZeroExtendExpr>(S)) {
3748     uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
3749     return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
3750              getTypeSizeInBits(E->getType()) : OpRes;
3751   }
3752
3753   if (const SCEVSignExtendExpr *E = dyn_cast<SCEVSignExtendExpr>(S)) {
3754     uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
3755     return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
3756              getTypeSizeInBits(E->getType()) : OpRes;
3757   }
3758
3759   if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(S)) {
3760     // The result is the min of all operands results.
3761     uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
3762     for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
3763       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
3764     return MinOpRes;
3765   }
3766
3767   if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(S)) {
3768     // The result is the sum of all operands results.
3769     uint32_t SumOpRes = GetMinTrailingZeros(M->getOperand(0));
3770     uint32_t BitWidth = getTypeSizeInBits(M->getType());
3771     for (unsigned i = 1, e = M->getNumOperands();
3772          SumOpRes != BitWidth && i != e; ++i)
3773       SumOpRes = std::min(SumOpRes + GetMinTrailingZeros(M->getOperand(i)),
3774                           BitWidth);
3775     return SumOpRes;
3776   }
3777
3778   if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(S)) {
3779     // The result is the min of all operands results.
3780     uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
3781     for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
3782       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
3783     return MinOpRes;
3784   }
3785
3786   if (const SCEVSMaxExpr *M = dyn_cast<SCEVSMaxExpr>(S)) {
3787     // The result is the min of all operands results.
3788     uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
3789     for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
3790       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
3791     return MinOpRes;
3792   }
3793
3794   if (const SCEVUMaxExpr *M = dyn_cast<SCEVUMaxExpr>(S)) {
3795     // The result is the min of all operands results.
3796     uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
3797     for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
3798       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
3799     return MinOpRes;
3800   }
3801
3802   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
3803     // For a SCEVUnknown, ask ValueTracking.
3804     unsigned BitWidth = getTypeSizeInBits(U->getType());
3805     APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
3806     computeKnownBits(U->getValue(), Zeros, Ones,
3807                      F->getParent()->getDataLayout(), 0, AC, nullptr, DT);
3808     return Zeros.countTrailingOnes();
3809   }
3810
3811   // SCEVUDivExpr
3812   return 0;
3813 }
3814
3815 /// GetRangeFromMetadata - Helper method to assign a range to V from
3816 /// metadata present in the IR.
3817 static Optional<ConstantRange> GetRangeFromMetadata(Value *V) {
3818   if (Instruction *I = dyn_cast<Instruction>(V)) {
3819     if (MDNode *MD = I->getMetadata(LLVMContext::MD_range)) {
3820       ConstantRange TotalRange(
3821           cast<IntegerType>(I->getType())->getBitWidth(), false);
3822
3823       unsigned NumRanges = MD->getNumOperands() / 2;
3824       assert(NumRanges >= 1);
3825
3826       for (unsigned i = 0; i < NumRanges; ++i) {
3827         ConstantInt *Lower =
3828             mdconst::extract<ConstantInt>(MD->getOperand(2 * i + 0));
3829         ConstantInt *Upper =
3830             mdconst::extract<ConstantInt>(MD->getOperand(2 * i + 1));
3831         ConstantRange Range(Lower->getValue(), Upper->getValue());
3832         TotalRange = TotalRange.unionWith(Range);
3833       }
3834
3835       return TotalRange;
3836     }
3837   }
3838
3839   return None;
3840 }
3841
3842 /// getRange - Determine the range for a particular SCEV.  If SignHint is
3843 /// HINT_RANGE_UNSIGNED (resp. HINT_RANGE_SIGNED) then getRange prefers ranges
3844 /// with a "cleaner" unsigned (resp. signed) representation.
3845 ///
3846 ConstantRange
3847 ScalarEvolution::getRange(const SCEV *S,
3848                           ScalarEvolution::RangeSignHint SignHint) {
3849   DenseMap<const SCEV *, ConstantRange> &Cache =
3850       SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED ? UnsignedRanges
3851                                                        : SignedRanges;
3852
3853   // See if we've computed this range already.
3854   DenseMap<const SCEV *, ConstantRange>::iterator I = Cache.find(S);
3855   if (I != Cache.end())
3856     return I->second;
3857
3858   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
3859     return setRange(C, SignHint, ConstantRange(C->getValue()->getValue()));
3860
3861   unsigned BitWidth = getTypeSizeInBits(S->getType());
3862   ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true);
3863
3864   // If the value has known zeros, the maximum value will have those known zeros
3865   // as well.
3866   uint32_t TZ = GetMinTrailingZeros(S);
3867   if (TZ != 0) {
3868     if (SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED)
3869       ConservativeResult =
3870           ConstantRange(APInt::getMinValue(BitWidth),
3871                         APInt::getMaxValue(BitWidth).lshr(TZ).shl(TZ) + 1);
3872     else
3873       ConservativeResult = ConstantRange(
3874           APInt::getSignedMinValue(BitWidth),
3875           APInt::getSignedMaxValue(BitWidth).ashr(TZ).shl(TZ) + 1);
3876   }
3877
3878   if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
3879     ConstantRange X = getRange(Add->getOperand(0), SignHint);
3880     for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i)
3881       X = X.add(getRange(Add->getOperand(i), SignHint));
3882     return setRange(Add, SignHint, ConservativeResult.intersectWith(X));
3883   }
3884
3885   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
3886     ConstantRange X = getRange(Mul->getOperand(0), SignHint);
3887     for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i)
3888       X = X.multiply(getRange(Mul->getOperand(i), SignHint));
3889     return setRange(Mul, SignHint, ConservativeResult.intersectWith(X));
3890   }
3891
3892   if (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(S)) {
3893     ConstantRange X = getRange(SMax->getOperand(0), SignHint);
3894     for (unsigned i = 1, e = SMax->getNumOperands(); i != e; ++i)
3895       X = X.smax(getRange(SMax->getOperand(i), SignHint));
3896     return setRange(SMax, SignHint, ConservativeResult.intersectWith(X));
3897   }
3898
3899   if (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(S)) {
3900     ConstantRange X = getRange(UMax->getOperand(0), SignHint);
3901     for (unsigned i = 1, e = UMax->getNumOperands(); i != e; ++i)
3902       X = X.umax(getRange(UMax->getOperand(i), SignHint));
3903     return setRange(UMax, SignHint, ConservativeResult.intersectWith(X));
3904   }
3905
3906   if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) {
3907     ConstantRange X = getRange(UDiv->getLHS(), SignHint);
3908     ConstantRange Y = getRange(UDiv->getRHS(), SignHint);
3909     return setRange(UDiv, SignHint,
3910                     ConservativeResult.intersectWith(X.udiv(Y)));
3911   }
3912
3913   if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) {
3914     ConstantRange X = getRange(ZExt->getOperand(), SignHint);
3915     return setRange(ZExt, SignHint,
3916                     ConservativeResult.intersectWith(X.zeroExtend(BitWidth)));
3917   }
3918
3919   if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) {
3920     ConstantRange X = getRange(SExt->getOperand(), SignHint);
3921     return setRange(SExt, SignHint,
3922                     ConservativeResult.intersectWith(X.signExtend(BitWidth)));
3923   }
3924
3925   if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) {
3926     ConstantRange X = getRange(Trunc->getOperand(), SignHint);
3927     return setRange(Trunc, SignHint,
3928                     ConservativeResult.intersectWith(X.truncate(BitWidth)));
3929   }
3930
3931   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) {
3932     // If there's no unsigned wrap, the value will never be less than its
3933     // initial value.
3934     if (AddRec->getNoWrapFlags(SCEV::FlagNUW))
3935       if (const SCEVConstant *C = dyn_cast<SCEVConstant>(AddRec->getStart()))
3936         if (!C->getValue()->isZero())
3937           ConservativeResult =
3938             ConservativeResult.intersectWith(
3939               ConstantRange(C->getValue()->getValue(), APInt(BitWidth, 0)));
3940
3941     // If there's no signed wrap, and all the operands have the same sign or
3942     // zero, the value won't ever change sign.
3943     if (AddRec->getNoWrapFlags(SCEV::FlagNSW)) {
3944       bool AllNonNeg = true;
3945       bool AllNonPos = true;
3946       for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
3947         if (!isKnownNonNegative(AddRec->getOperand(i))) AllNonNeg = false;
3948         if (!isKnownNonPositive(AddRec->getOperand(i))) AllNonPos = false;
3949       }
3950       if (AllNonNeg)
3951         ConservativeResult = ConservativeResult.intersectWith(
3952           ConstantRange(APInt(BitWidth, 0),
3953                         APInt::getSignedMinValue(BitWidth)));
3954       else if (AllNonPos)
3955         ConservativeResult = ConservativeResult.intersectWith(
3956           ConstantRange(APInt::getSignedMinValue(BitWidth),
3957                         APInt(BitWidth, 1)));
3958     }
3959
3960     // TODO: non-affine addrec
3961     if (AddRec->isAffine()) {
3962       Type *Ty = AddRec->getType();
3963       const SCEV *MaxBECount = getMaxBackedgeTakenCount(AddRec->getLoop());
3964       if (!isa<SCEVCouldNotCompute>(MaxBECount) &&
3965           getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) {
3966
3967         // Check for overflow.  This must be done with ConstantRange arithmetic
3968         // because we could be called from within the ScalarEvolution overflow
3969         // checking code.
3970
3971         MaxBECount = getNoopOrZeroExtend(MaxBECount, Ty);
3972         ConstantRange MaxBECountRange = getUnsignedRange(MaxBECount);
3973         ConstantRange ZExtMaxBECountRange =
3974             MaxBECountRange.zextOrTrunc(BitWidth * 2 + 1);
3975
3976         const SCEV *Start = AddRec->getStart();
3977         const SCEV *Step = AddRec->getStepRecurrence(*this);
3978         ConstantRange StepSRange = getSignedRange(Step);
3979         ConstantRange SExtStepSRange = StepSRange.sextOrTrunc(BitWidth * 2 + 1);
3980
3981         ConstantRange StartURange = getUnsignedRange(Start);
3982         ConstantRange EndURange =
3983             StartURange.add(MaxBECountRange.multiply(StepSRange));
3984
3985         // Check for unsigned overflow.
3986         ConstantRange ZExtStartURange =
3987             StartURange.zextOrTrunc(BitWidth * 2 + 1);
3988         ConstantRange ZExtEndURange = EndURange.zextOrTrunc(BitWidth * 2 + 1);
3989         if (ZExtStartURange.add(ZExtMaxBECountRange.multiply(SExtStepSRange)) ==
3990             ZExtEndURange) {
3991           APInt Min = APIntOps::umin(StartURange.getUnsignedMin(),
3992                                      EndURange.getUnsignedMin());
3993           APInt Max = APIntOps::umax(StartURange.getUnsignedMax(),
3994                                      EndURange.getUnsignedMax());
3995           bool IsFullRange = Min.isMinValue() && Max.isMaxValue();
3996           if (!IsFullRange)
3997             ConservativeResult =
3998                 ConservativeResult.intersectWith(ConstantRange(Min, Max + 1));
3999         }
4000
4001         ConstantRange StartSRange = getSignedRange(Start);
4002         ConstantRange EndSRange =
4003             StartSRange.add(MaxBECountRange.multiply(StepSRange));
4004
4005         // Check for signed overflow. This must be done with ConstantRange
4006         // arithmetic because we could be called from within the ScalarEvolution
4007         // overflow checking code.
4008         ConstantRange SExtStartSRange =
4009             StartSRange.sextOrTrunc(BitWidth * 2 + 1);
4010         ConstantRange SExtEndSRange = EndSRange.sextOrTrunc(BitWidth * 2 + 1);
4011         if (SExtStartSRange.add(ZExtMaxBECountRange.multiply(SExtStepSRange)) ==
4012             SExtEndSRange) {
4013           APInt Min = APIntOps::smin(StartSRange.getSignedMin(),
4014                                      EndSRange.getSignedMin());
4015           APInt Max = APIntOps::smax(StartSRange.getSignedMax(),
4016                                      EndSRange.getSignedMax());
4017           bool IsFullRange = Min.isMinSignedValue() && Max.isMaxSignedValue();
4018           if (!IsFullRange)
4019             ConservativeResult =
4020                 ConservativeResult.intersectWith(ConstantRange(Min, Max + 1));
4021         }
4022       }
4023     }
4024
4025     return setRange(AddRec, SignHint, ConservativeResult);
4026   }
4027
4028   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
4029     // Check if the IR explicitly contains !range metadata.
4030     Optional<ConstantRange> MDRange = GetRangeFromMetadata(U->getValue());
4031     if (MDRange.hasValue())
4032       ConservativeResult = ConservativeResult.intersectWith(MDRange.getValue());
4033
4034     // Split here to avoid paying the compile-time cost of calling both
4035     // computeKnownBits and ComputeNumSignBits.  This restriction can be lifted
4036     // if needed.
4037     const DataLayout &DL = F->getParent()->getDataLayout();
4038     if (SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED) {
4039       // For a SCEVUnknown, ask ValueTracking.
4040       APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
4041       computeKnownBits(U->getValue(), Zeros, Ones, DL, 0, AC, nullptr, DT);
4042       if (Ones != ~Zeros + 1)
4043         ConservativeResult =
4044             ConservativeResult.intersectWith(ConstantRange(Ones, ~Zeros + 1));
4045     } else {
4046       assert(SignHint == ScalarEvolution::HINT_RANGE_SIGNED &&
4047              "generalize as needed!");
4048       unsigned NS = ComputeNumSignBits(U->getValue(), DL, 0, AC, nullptr, DT);
4049       if (NS > 1)
4050         ConservativeResult = ConservativeResult.intersectWith(
4051             ConstantRange(APInt::getSignedMinValue(BitWidth).ashr(NS - 1),
4052                           APInt::getSignedMaxValue(BitWidth).ashr(NS - 1) + 1));
4053     }
4054
4055     return setRange(U, SignHint, ConservativeResult);
4056   }
4057
4058   return setRange(S, SignHint, ConservativeResult);
4059 }
4060
4061 /// createSCEV - We know that there is no SCEV for the specified value.
4062 /// Analyze the expression.
4063 ///
4064 const SCEV *ScalarEvolution::createSCEV(Value *V) {
4065   if (!isSCEVable(V->getType()))
4066     return getUnknown(V);
4067
4068   unsigned Opcode = Instruction::UserOp1;
4069   if (Instruction *I = dyn_cast<Instruction>(V)) {
4070     Opcode = I->getOpcode();
4071
4072     // Don't attempt to analyze instructions in blocks that aren't
4073     // reachable. Such instructions don't matter, and they aren't required
4074     // to obey basic rules for definitions dominating uses which this
4075     // analysis depends on.
4076     if (!DT->isReachableFromEntry(I->getParent()))
4077       return getUnknown(V);
4078   } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
4079     Opcode = CE->getOpcode();
4080   else if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
4081     return getConstant(CI);
4082   else if (isa<ConstantPointerNull>(V))
4083     return getConstant(V->getType(), 0);
4084   else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
4085     return GA->mayBeOverridden() ? getUnknown(V) : getSCEV(GA->getAliasee());
4086   else
4087     return getUnknown(V);
4088
4089   Operator *U = cast<Operator>(V);
4090   switch (Opcode) {
4091   case Instruction::Add: {
4092     // The simple thing to do would be to just call getSCEV on both operands
4093     // and call getAddExpr with the result. However if we're looking at a
4094     // bunch of things all added together, this can be quite inefficient,
4095     // because it leads to N-1 getAddExpr calls for N ultimate operands.
4096     // Instead, gather up all the operands and make a single getAddExpr call.
4097     // LLVM IR canonical form means we need only traverse the left operands.
4098     //
4099     // Don't apply this instruction's NSW or NUW flags to the new
4100     // expression. The instruction may be guarded by control flow that the
4101     // no-wrap behavior depends on. Non-control-equivalent instructions can be
4102     // mapped to the same SCEV expression, and it would be incorrect to transfer
4103     // NSW/NUW semantics to those operations.
4104     SmallVector<const SCEV *, 4> AddOps;
4105     AddOps.push_back(getSCEV(U->getOperand(1)));
4106     for (Value *Op = U->getOperand(0); ; Op = U->getOperand(0)) {
4107       unsigned Opcode = Op->getValueID() - Value::InstructionVal;
4108       if (Opcode != Instruction::Add && Opcode != Instruction::Sub)
4109         break;
4110       U = cast<Operator>(Op);
4111       const SCEV *Op1 = getSCEV(U->getOperand(1));
4112       if (Opcode == Instruction::Sub)
4113         AddOps.push_back(getNegativeSCEV(Op1));
4114       else
4115         AddOps.push_back(Op1);
4116     }
4117     AddOps.push_back(getSCEV(U->getOperand(0)));
4118     return getAddExpr(AddOps);
4119   }
4120   case Instruction::Mul: {
4121     // Don't transfer NSW/NUW for the same reason as AddExpr.
4122     SmallVector<const SCEV *, 4> MulOps;
4123     MulOps.push_back(getSCEV(U->getOperand(1)));
4124     for (Value *Op = U->getOperand(0);
4125          Op->getValueID() == Instruction::Mul + Value::InstructionVal;
4126          Op = U->getOperand(0)) {
4127       U = cast<Operator>(Op);
4128       MulOps.push_back(getSCEV(U->getOperand(1)));
4129     }
4130     MulOps.push_back(getSCEV(U->getOperand(0)));
4131     return getMulExpr(MulOps);
4132   }
4133   case Instruction::UDiv:
4134     return getUDivExpr(getSCEV(U->getOperand(0)),
4135                        getSCEV(U->getOperand(1)));
4136   case Instruction::Sub:
4137     return getMinusSCEV(getSCEV(U->getOperand(0)),
4138                         getSCEV(U->getOperand(1)));
4139   case Instruction::And:
4140     // For an expression like x&255 that merely masks off the high bits,
4141     // use zext(trunc(x)) as the SCEV expression.
4142     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
4143       if (CI->isNullValue())
4144         return getSCEV(U->getOperand(1));
4145       if (CI->isAllOnesValue())
4146         return getSCEV(U->getOperand(0));
4147       const APInt &A = CI->getValue();
4148
4149       // Instcombine's ShrinkDemandedConstant may strip bits out of
4150       // constants, obscuring what would otherwise be a low-bits mask.
4151       // Use computeKnownBits to compute what ShrinkDemandedConstant
4152       // knew about to reconstruct a low-bits mask value.
4153       unsigned LZ = A.countLeadingZeros();
4154       unsigned TZ = A.countTrailingZeros();
4155       unsigned BitWidth = A.getBitWidth();
4156       APInt KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
4157       computeKnownBits(U->getOperand(0), KnownZero, KnownOne,
4158                        F->getParent()->getDataLayout(), 0, AC, nullptr, DT);
4159
4160       APInt EffectiveMask =
4161           APInt::getLowBitsSet(BitWidth, BitWidth - LZ - TZ).shl(TZ);
4162       if ((LZ != 0 || TZ != 0) && !((~A & ~KnownZero) & EffectiveMask)) {
4163         const SCEV *MulCount = getConstant(
4164             ConstantInt::get(getContext(), APInt::getOneBitSet(BitWidth, TZ)));
4165         return getMulExpr(
4166             getZeroExtendExpr(
4167                 getTruncateExpr(
4168                     getUDivExactExpr(getSCEV(U->getOperand(0)), MulCount),
4169                     IntegerType::get(getContext(), BitWidth - LZ - TZ)),
4170                 U->getType()),
4171             MulCount);
4172       }
4173     }
4174     break;
4175
4176   case Instruction::Or:
4177     // If the RHS of the Or is a constant, we may have something like:
4178     // X*4+1 which got turned into X*4|1.  Handle this as an Add so loop
4179     // optimizations will transparently handle this case.
4180     //
4181     // In order for this transformation to be safe, the LHS must be of the
4182     // form X*(2^n) and the Or constant must be less than 2^n.
4183     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
4184       const SCEV *LHS = getSCEV(U->getOperand(0));
4185       const APInt &CIVal = CI->getValue();
4186       if (GetMinTrailingZeros(LHS) >=
4187           (CIVal.getBitWidth() - CIVal.countLeadingZeros())) {
4188         // Build a plain add SCEV.
4189         const SCEV *S = getAddExpr(LHS, getSCEV(CI));
4190         // If the LHS of the add was an addrec and it has no-wrap flags,
4191         // transfer the no-wrap flags, since an or won't introduce a wrap.
4192         if (const SCEVAddRecExpr *NewAR = dyn_cast<SCEVAddRecExpr>(S)) {
4193           const SCEVAddRecExpr *OldAR = cast<SCEVAddRecExpr>(LHS);
4194           const_cast<SCEVAddRecExpr *>(NewAR)->setNoWrapFlags(
4195             OldAR->getNoWrapFlags());
4196         }
4197         return S;
4198       }
4199     }
4200     break;
4201   case Instruction::Xor:
4202     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
4203       // If the RHS of the xor is a signbit, then this is just an add.
4204       // Instcombine turns add of signbit into xor as a strength reduction step.
4205       if (CI->getValue().isSignBit())
4206         return getAddExpr(getSCEV(U->getOperand(0)),
4207                           getSCEV(U->getOperand(1)));
4208
4209       // If the RHS of xor is -1, then this is a not operation.
4210       if (CI->isAllOnesValue())
4211         return getNotSCEV(getSCEV(U->getOperand(0)));
4212
4213       // Model xor(and(x, C), C) as and(~x, C), if C is a low-bits mask.
4214       // This is a variant of the check for xor with -1, and it handles
4215       // the case where instcombine has trimmed non-demanded bits out
4216       // of an xor with -1.
4217       if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U->getOperand(0)))
4218         if (ConstantInt *LCI = dyn_cast<ConstantInt>(BO->getOperand(1)))
4219           if (BO->getOpcode() == Instruction::And &&
4220               LCI->getValue() == CI->getValue())
4221             if (const SCEVZeroExtendExpr *Z =
4222                   dyn_cast<SCEVZeroExtendExpr>(getSCEV(U->getOperand(0)))) {
4223               Type *UTy = U->getType();
4224               const SCEV *Z0 = Z->getOperand();
4225               Type *Z0Ty = Z0->getType();
4226               unsigned Z0TySize = getTypeSizeInBits(Z0Ty);
4227
4228               // If C is a low-bits mask, the zero extend is serving to
4229               // mask off the high bits. Complement the operand and
4230               // re-apply the zext.
4231               if (APIntOps::isMask(Z0TySize, CI->getValue()))
4232                 return getZeroExtendExpr(getNotSCEV(Z0), UTy);
4233
4234               // If C is a single bit, it may be in the sign-bit position
4235               // before the zero-extend. In this case, represent the xor
4236               // using an add, which is equivalent, and re-apply the zext.
4237               APInt Trunc = CI->getValue().trunc(Z0TySize);
4238               if (Trunc.zext(getTypeSizeInBits(UTy)) == CI->getValue() &&
4239                   Trunc.isSignBit())
4240                 return getZeroExtendExpr(getAddExpr(Z0, getConstant(Trunc)),
4241                                          UTy);
4242             }
4243     }
4244     break;
4245
4246   case Instruction::Shl:
4247     // Turn shift left of a constant amount into a multiply.
4248     if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
4249       uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
4250
4251       // If the shift count is not less than the bitwidth, the result of
4252       // the shift is undefined. Don't try to analyze it, because the
4253       // resolution chosen here may differ from the resolution chosen in
4254       // other parts of the compiler.
4255       if (SA->getValue().uge(BitWidth))
4256         break;
4257
4258       Constant *X = ConstantInt::get(getContext(),
4259         APInt::getOneBitSet(BitWidth, SA->getZExtValue()));
4260       return getMulExpr(getSCEV(U->getOperand(0)), getSCEV(X));
4261     }
4262     break;
4263
4264   case Instruction::LShr:
4265     // Turn logical shift right of a constant into a unsigned divide.
4266     if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
4267       uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
4268
4269       // If the shift count is not less than the bitwidth, the result of
4270       // the shift is undefined. Don't try to analyze it, because the
4271       // resolution chosen here may differ from the resolution chosen in
4272       // other parts of the compiler.
4273       if (SA->getValue().uge(BitWidth))
4274         break;
4275
4276       Constant *X = ConstantInt::get(getContext(),
4277         APInt::getOneBitSet(BitWidth, SA->getZExtValue()));
4278       return getUDivExpr(getSCEV(U->getOperand(0)), getSCEV(X));
4279     }
4280     break;
4281
4282   case Instruction::AShr:
4283     // For a two-shift sext-inreg, use sext(trunc(x)) as the SCEV expression.
4284     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1)))
4285       if (Operator *L = dyn_cast<Operator>(U->getOperand(0)))
4286         if (L->getOpcode() == Instruction::Shl &&
4287             L->getOperand(1) == U->getOperand(1)) {
4288           uint64_t BitWidth = getTypeSizeInBits(U->getType());
4289
4290           // If the shift count is not less than the bitwidth, the result of
4291           // the shift is undefined. Don't try to analyze it, because the
4292           // resolution chosen here may differ from the resolution chosen in
4293           // other parts of the compiler.
4294           if (CI->getValue().uge(BitWidth))
4295             break;
4296
4297           uint64_t Amt = BitWidth - CI->getZExtValue();
4298           if (Amt == BitWidth)
4299             return getSCEV(L->getOperand(0));       // shift by zero --> noop
4300           return
4301             getSignExtendExpr(getTruncateExpr(getSCEV(L->getOperand(0)),
4302                                               IntegerType::get(getContext(),
4303                                                                Amt)),
4304                               U->getType());
4305         }
4306     break;
4307
4308   case Instruction::Trunc:
4309     return getTruncateExpr(getSCEV(U->getOperand(0)), U->getType());
4310
4311   case Instruction::ZExt:
4312     return getZeroExtendExpr(getSCEV(U->getOperand(0)), U->getType());
4313
4314   case Instruction::SExt:
4315     return getSignExtendExpr(getSCEV(U->getOperand(0)), U->getType());
4316
4317   case Instruction::BitCast:
4318     // BitCasts are no-op casts so we just eliminate the cast.
4319     if (isSCEVable(U->getType()) && isSCEVable(U->getOperand(0)->getType()))
4320       return getSCEV(U->getOperand(0));
4321     break;
4322
4323   // It's tempting to handle inttoptr and ptrtoint as no-ops, however this can
4324   // lead to pointer expressions which cannot safely be expanded to GEPs,
4325   // because ScalarEvolution doesn't respect the GEP aliasing rules when
4326   // simplifying integer expressions.
4327
4328   case Instruction::GetElementPtr:
4329     return createNodeForGEP(cast<GEPOperator>(U));
4330
4331   case Instruction::PHI:
4332     return createNodeForPHI(cast<PHINode>(U));
4333
4334   case Instruction::Select:
4335     // This could be a smax or umax that was lowered earlier.
4336     // Try to recover it.
4337     if (ICmpInst *ICI = dyn_cast<ICmpInst>(U->getOperand(0))) {
4338       Value *LHS = ICI->getOperand(0);
4339       Value *RHS = ICI->getOperand(1);
4340       switch (ICI->getPredicate()) {
4341       case ICmpInst::ICMP_SLT:
4342       case ICmpInst::ICMP_SLE:
4343         std::swap(LHS, RHS);
4344         // fall through
4345       case ICmpInst::ICMP_SGT:
4346       case ICmpInst::ICMP_SGE:
4347         // a >s b ? a+x : b+x  ->  smax(a, b)+x
4348         // a >s b ? b+x : a+x  ->  smin(a, b)+x
4349         if (getTypeSizeInBits(LHS->getType()) <=
4350             getTypeSizeInBits(U->getType())) {
4351           const SCEV *LS = getNoopOrSignExtend(getSCEV(LHS), U->getType());
4352           const SCEV *RS = getNoopOrSignExtend(getSCEV(RHS), U->getType());
4353           const SCEV *LA = getSCEV(U->getOperand(1));
4354           const SCEV *RA = getSCEV(U->getOperand(2));
4355           const SCEV *LDiff = getMinusSCEV(LA, LS);
4356           const SCEV *RDiff = getMinusSCEV(RA, RS);
4357           if (LDiff == RDiff)
4358             return getAddExpr(getSMaxExpr(LS, RS), LDiff);
4359           LDiff = getMinusSCEV(LA, RS);
4360           RDiff = getMinusSCEV(RA, LS);
4361           if (LDiff == RDiff)
4362             return getAddExpr(getSMinExpr(LS, RS), LDiff);
4363         }
4364         break;
4365       case ICmpInst::ICMP_ULT:
4366       case ICmpInst::ICMP_ULE:
4367         std::swap(LHS, RHS);
4368         // fall through
4369       case ICmpInst::ICMP_UGT:
4370       case ICmpInst::ICMP_UGE:
4371         // a >u b ? a+x : b+x  ->  umax(a, b)+x
4372         // a >u b ? b+x : a+x  ->  umin(a, b)+x
4373         if (getTypeSizeInBits(LHS->getType()) <=
4374             getTypeSizeInBits(U->getType())) {
4375           const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), U->getType());
4376           const SCEV *RS = getNoopOrZeroExtend(getSCEV(RHS), U->getType());
4377           const SCEV *LA = getSCEV(U->getOperand(1));
4378           const SCEV *RA = getSCEV(U->getOperand(2));
4379           const SCEV *LDiff = getMinusSCEV(LA, LS);
4380           const SCEV *RDiff = getMinusSCEV(RA, RS);
4381           if (LDiff == RDiff)
4382             return getAddExpr(getUMaxExpr(LS, RS), LDiff);
4383           LDiff = getMinusSCEV(LA, RS);
4384           RDiff = getMinusSCEV(RA, LS);
4385           if (LDiff == RDiff)
4386             return getAddExpr(getUMinExpr(LS, RS), LDiff);
4387         }
4388         break;
4389       case ICmpInst::ICMP_NE:
4390         // n != 0 ? n+x : 1+x  ->  umax(n, 1)+x
4391         if (getTypeSizeInBits(LHS->getType()) <=
4392                 getTypeSizeInBits(U->getType()) &&
4393             isa<ConstantInt>(RHS) && cast<ConstantInt>(RHS)->isZero()) {
4394           const SCEV *One = getConstant(U->getType(), 1);
4395           const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), U->getType());
4396           const SCEV *LA = getSCEV(U->getOperand(1));
4397           const SCEV *RA = getSCEV(U->getOperand(2));
4398           const SCEV *LDiff = getMinusSCEV(LA, LS);
4399           const SCEV *RDiff = getMinusSCEV(RA, One);
4400           if (LDiff == RDiff)
4401             return getAddExpr(getUMaxExpr(One, LS), LDiff);
4402         }
4403         break;
4404       case ICmpInst::ICMP_EQ:
4405         // n == 0 ? 1+x : n+x  ->  umax(n, 1)+x
4406         if (getTypeSizeInBits(LHS->getType()) <=
4407                 getTypeSizeInBits(U->getType()) &&
4408             isa<ConstantInt>(RHS) && cast<ConstantInt>(RHS)->isZero()) {
4409           const SCEV *One = getConstant(U->getType(), 1);
4410           const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), U->getType());
4411           const SCEV *LA = getSCEV(U->getOperand(1));
4412           const SCEV *RA = getSCEV(U->getOperand(2));
4413           const SCEV *LDiff = getMinusSCEV(LA, One);
4414           const SCEV *RDiff = getMinusSCEV(RA, LS);
4415           if (LDiff == RDiff)
4416             return getAddExpr(getUMaxExpr(One, LS), LDiff);
4417         }
4418         break;
4419       default:
4420         break;
4421       }
4422     }
4423
4424   default: // We cannot analyze this expression.
4425     break;
4426   }
4427
4428   return getUnknown(V);
4429 }
4430
4431
4432
4433 //===----------------------------------------------------------------------===//
4434 //                   Iteration Count Computation Code
4435 //
4436
4437 unsigned ScalarEvolution::getSmallConstantTripCount(Loop *L) {
4438   if (BasicBlock *ExitingBB = L->getExitingBlock())
4439     return getSmallConstantTripCount(L, ExitingBB);
4440
4441   // No trip count information for multiple exits.
4442   return 0;
4443 }
4444
4445 /// getSmallConstantTripCount - Returns the maximum trip count of this loop as a
4446 /// normal unsigned value. Returns 0 if the trip count is unknown or not
4447 /// constant. Will also return 0 if the maximum trip count is very large (>=
4448 /// 2^32).
4449 ///
4450 /// This "trip count" assumes that control exits via ExitingBlock. More
4451 /// precisely, it is the number of times that control may reach ExitingBlock
4452 /// before taking the branch. For loops with multiple exits, it may not be the
4453 /// number times that the loop header executes because the loop may exit
4454 /// prematurely via another branch.
4455 unsigned ScalarEvolution::getSmallConstantTripCount(Loop *L,
4456                                                     BasicBlock *ExitingBlock) {
4457   assert(ExitingBlock && "Must pass a non-null exiting block!");
4458   assert(L->isLoopExiting(ExitingBlock) &&
4459          "Exiting block must actually branch out of the loop!");
4460   const SCEVConstant *ExitCount =
4461       dyn_cast<SCEVConstant>(getExitCount(L, ExitingBlock));
4462   if (!ExitCount)
4463     return 0;
4464
4465   ConstantInt *ExitConst = ExitCount->getValue();
4466
4467   // Guard against huge trip counts.
4468   if (ExitConst->getValue().getActiveBits() > 32)
4469     return 0;
4470
4471   // In case of integer overflow, this returns 0, which is correct.
4472   return ((unsigned)ExitConst->getZExtValue()) + 1;
4473 }
4474
4475 unsigned ScalarEvolution::getSmallConstantTripMultiple(Loop *L) {
4476   if (BasicBlock *ExitingBB = L->getExitingBlock())
4477     return getSmallConstantTripMultiple(L, ExitingBB);
4478
4479   // No trip multiple information for multiple exits.
4480   return 0;
4481 }
4482
4483 /// getSmallConstantTripMultiple - Returns the largest constant divisor of the
4484 /// trip count of this loop as a normal unsigned value, if possible. This
4485 /// means that the actual trip count is always a multiple of the returned
4486 /// value (don't forget the trip count could very well be zero as well!).
4487 ///
4488 /// Returns 1 if the trip count is unknown or not guaranteed to be the
4489 /// multiple of a constant (which is also the case if the trip count is simply
4490 /// constant, use getSmallConstantTripCount for that case), Will also return 1
4491 /// if the trip count is very large (>= 2^32).
4492 ///
4493 /// As explained in the comments for getSmallConstantTripCount, this assumes
4494 /// that control exits the loop via ExitingBlock.
4495 unsigned
4496 ScalarEvolution::getSmallConstantTripMultiple(Loop *L,
4497                                               BasicBlock *ExitingBlock) {
4498   assert(ExitingBlock && "Must pass a non-null exiting block!");
4499   assert(L->isLoopExiting(ExitingBlock) &&
4500          "Exiting block must actually branch out of the loop!");
4501   const SCEV *ExitCount = getExitCount(L, ExitingBlock);
4502   if (ExitCount == getCouldNotCompute())
4503     return 1;
4504
4505   // Get the trip count from the BE count by adding 1.
4506   const SCEV *TCMul = getAddExpr(ExitCount,
4507                                  getConstant(ExitCount->getType(), 1));
4508   // FIXME: SCEV distributes multiplication as V1*C1 + V2*C1. We could attempt
4509   // to factor simple cases.
4510   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(TCMul))
4511     TCMul = Mul->getOperand(0);
4512
4513   const SCEVConstant *MulC = dyn_cast<SCEVConstant>(TCMul);
4514   if (!MulC)
4515     return 1;
4516
4517   ConstantInt *Result = MulC->getValue();
4518
4519   // Guard against huge trip counts (this requires checking
4520   // for zero to handle the case where the trip count == -1 and the
4521   // addition wraps).
4522   if (!Result || Result->getValue().getActiveBits() > 32 ||
4523       Result->getValue().getActiveBits() == 0)
4524     return 1;
4525
4526   return (unsigned)Result->getZExtValue();
4527 }
4528
4529 // getExitCount - Get the expression for the number of loop iterations for which
4530 // this loop is guaranteed not to exit via ExitingBlock. Otherwise return
4531 // SCEVCouldNotCompute.
4532 const SCEV *ScalarEvolution::getExitCount(Loop *L, BasicBlock *ExitingBlock) {
4533   return getBackedgeTakenInfo(L).getExact(ExitingBlock, this);
4534 }
4535
4536 /// getBackedgeTakenCount - If the specified loop has a predictable
4537 /// backedge-taken count, return it, otherwise return a SCEVCouldNotCompute
4538 /// object. The backedge-taken count is the number of times the loop header
4539 /// will be branched to from within the loop. This is one less than the
4540 /// trip count of the loop, since it doesn't count the first iteration,
4541 /// when the header is branched to from outside the loop.
4542 ///
4543 /// Note that it is not valid to call this method on a loop without a
4544 /// loop-invariant backedge-taken count (see
4545 /// hasLoopInvariantBackedgeTakenCount).
4546 ///
4547 const SCEV *ScalarEvolution::getBackedgeTakenCount(const Loop *L) {
4548   return getBackedgeTakenInfo(L).getExact(this);
4549 }
4550
4551 /// getMaxBackedgeTakenCount - Similar to getBackedgeTakenCount, except
4552 /// return the least SCEV value that is known never to be less than the
4553 /// actual backedge taken count.
4554 const SCEV *ScalarEvolution::getMaxBackedgeTakenCount(const Loop *L) {
4555   return getBackedgeTakenInfo(L).getMax(this);
4556 }
4557
4558 /// PushLoopPHIs - Push PHI nodes in the header of the given loop
4559 /// onto the given Worklist.
4560 static void
4561 PushLoopPHIs(const Loop *L, SmallVectorImpl<Instruction *> &Worklist) {
4562   BasicBlock *Header = L->getHeader();
4563
4564   // Push all Loop-header PHIs onto the Worklist stack.
4565   for (BasicBlock::iterator I = Header->begin();
4566        PHINode *PN = dyn_cast<PHINode>(I); ++I)
4567     Worklist.push_back(PN);
4568 }
4569
4570 const ScalarEvolution::BackedgeTakenInfo &
4571 ScalarEvolution::getBackedgeTakenInfo(const Loop *L) {
4572   // Initially insert an invalid entry for this loop. If the insertion
4573   // succeeds, proceed to actually compute a backedge-taken count and
4574   // update the value. The temporary CouldNotCompute value tells SCEV
4575   // code elsewhere that it shouldn't attempt to request a new
4576   // backedge-taken count, which could result in infinite recursion.
4577   std::pair<DenseMap<const Loop *, BackedgeTakenInfo>::iterator, bool> Pair =
4578     BackedgeTakenCounts.insert(std::make_pair(L, BackedgeTakenInfo()));
4579   if (!Pair.second)
4580     return Pair.first->second;
4581
4582   // ComputeBackedgeTakenCount may allocate memory for its result. Inserting it
4583   // into the BackedgeTakenCounts map transfers ownership. Otherwise, the result
4584   // must be cleared in this scope.
4585   BackedgeTakenInfo Result = ComputeBackedgeTakenCount(L);
4586
4587   if (Result.getExact(this) != getCouldNotCompute()) {
4588     assert(isLoopInvariant(Result.getExact(this), L) &&
4589            isLoopInvariant(Result.getMax(this), L) &&
4590            "Computed backedge-taken count isn't loop invariant for loop!");
4591     ++NumTripCountsComputed;
4592   }
4593   else if (Result.getMax(this) == getCouldNotCompute() &&
4594            isa<PHINode>(L->getHeader()->begin())) {
4595     // Only count loops that have phi nodes as not being computable.
4596     ++NumTripCountsNotComputed;
4597   }
4598
4599   // Now that we know more about the trip count for this loop, forget any
4600   // existing SCEV values for PHI nodes in this loop since they are only
4601   // conservative estimates made without the benefit of trip count
4602   // information. This is similar to the code in forgetLoop, except that
4603   // it handles SCEVUnknown PHI nodes specially.
4604   if (Result.hasAnyInfo()) {
4605     SmallVector<Instruction *, 16> Worklist;
4606     PushLoopPHIs(L, Worklist);
4607
4608     SmallPtrSet<Instruction *, 8> Visited;
4609     while (!Worklist.empty()) {
4610       Instruction *I = Worklist.pop_back_val();
4611       if (!Visited.insert(I).second)
4612         continue;
4613
4614       ValueExprMapType::iterator It =
4615         ValueExprMap.find_as(static_cast<Value *>(I));
4616       if (It != ValueExprMap.end()) {
4617         const SCEV *Old = It->second;
4618
4619         // SCEVUnknown for a PHI either means that it has an unrecognized
4620         // structure, or it's a PHI that's in the progress of being computed
4621         // by createNodeForPHI.  In the former case, additional loop trip
4622         // count information isn't going to change anything. In the later
4623         // case, createNodeForPHI will perform the necessary updates on its
4624         // own when it gets to that point.
4625         if (!isa<PHINode>(I) || !isa<SCEVUnknown>(Old)) {
4626           forgetMemoizedResults(Old);
4627           ValueExprMap.erase(It);
4628         }
4629         if (PHINode *PN = dyn_cast<PHINode>(I))
4630           ConstantEvolutionLoopExitValue.erase(PN);
4631       }
4632
4633       PushDefUseChildren(I, Worklist);
4634     }
4635   }
4636
4637   // Re-lookup the insert position, since the call to
4638   // ComputeBackedgeTakenCount above could result in a
4639   // recusive call to getBackedgeTakenInfo (on a different
4640   // loop), which would invalidate the iterator computed
4641   // earlier.
4642   return BackedgeTakenCounts.find(L)->second = Result;
4643 }
4644
4645 /// forgetLoop - This method should be called by the client when it has
4646 /// changed a loop in a way that may effect ScalarEvolution's ability to
4647 /// compute a trip count, or if the loop is deleted.
4648 void ScalarEvolution::forgetLoop(const Loop *L) {
4649   // Drop any stored trip count value.
4650   DenseMap<const Loop*, BackedgeTakenInfo>::iterator BTCPos =
4651     BackedgeTakenCounts.find(L);
4652   if (BTCPos != BackedgeTakenCounts.end()) {
4653     BTCPos->second.clear();
4654     BackedgeTakenCounts.erase(BTCPos);
4655   }
4656
4657   // Drop information about expressions based on loop-header PHIs.
4658   SmallVector<Instruction *, 16> Worklist;
4659   PushLoopPHIs(L, Worklist);
4660
4661   SmallPtrSet<Instruction *, 8> Visited;
4662   while (!Worklist.empty()) {
4663     Instruction *I = Worklist.pop_back_val();
4664     if (!Visited.insert(I).second)
4665       continue;
4666
4667     ValueExprMapType::iterator It =
4668       ValueExprMap.find_as(static_cast<Value *>(I));
4669     if (It != ValueExprMap.end()) {
4670       forgetMemoizedResults(It->second);
4671       ValueExprMap.erase(It);
4672       if (PHINode *PN = dyn_cast<PHINode>(I))
4673         ConstantEvolutionLoopExitValue.erase(PN);
4674     }
4675
4676     PushDefUseChildren(I, Worklist);
4677   }
4678
4679   // Forget all contained loops too, to avoid dangling entries in the
4680   // ValuesAtScopes map.
4681   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
4682     forgetLoop(*I);
4683 }
4684
4685 /// forgetValue - This method should be called by the client when it has
4686 /// changed a value in a way that may effect its value, or which may
4687 /// disconnect it from a def-use chain linking it to a loop.
4688 void ScalarEvolution::forgetValue(Value *V) {
4689   Instruction *I = dyn_cast<Instruction>(V);
4690   if (!I) return;
4691
4692   // Drop information about expressions based on loop-header PHIs.
4693   SmallVector<Instruction *, 16> Worklist;
4694   Worklist.push_back(I);
4695
4696   SmallPtrSet<Instruction *, 8> Visited;
4697   while (!Worklist.empty()) {
4698     I = Worklist.pop_back_val();
4699     if (!Visited.insert(I).second)
4700       continue;
4701
4702     ValueExprMapType::iterator It =
4703       ValueExprMap.find_as(static_cast<Value *>(I));
4704     if (It != ValueExprMap.end()) {
4705       forgetMemoizedResults(It->second);
4706       ValueExprMap.erase(It);
4707       if (PHINode *PN = dyn_cast<PHINode>(I))
4708         ConstantEvolutionLoopExitValue.erase(PN);
4709     }
4710
4711     PushDefUseChildren(I, Worklist);
4712   }
4713 }
4714
4715 /// getExact - Get the exact loop backedge taken count considering all loop
4716 /// exits. A computable result can only be return for loops with a single exit.
4717 /// Returning the minimum taken count among all exits is incorrect because one
4718 /// of the loop's exit limit's may have been skipped. HowFarToZero assumes that
4719 /// the limit of each loop test is never skipped. This is a valid assumption as
4720 /// long as the loop exits via that test. For precise results, it is the
4721 /// caller's responsibility to specify the relevant loop exit using
4722 /// getExact(ExitingBlock, SE).
4723 const SCEV *
4724 ScalarEvolution::BackedgeTakenInfo::getExact(ScalarEvolution *SE) const {
4725   // If any exits were not computable, the loop is not computable.
4726   if (!ExitNotTaken.isCompleteList()) return SE->getCouldNotCompute();
4727
4728   // We need exactly one computable exit.
4729   if (!ExitNotTaken.ExitingBlock) return SE->getCouldNotCompute();
4730   assert(ExitNotTaken.ExactNotTaken && "uninitialized not-taken info");
4731
4732   const SCEV *BECount = nullptr;
4733   for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
4734        ENT != nullptr; ENT = ENT->getNextExit()) {
4735
4736     assert(ENT->ExactNotTaken != SE->getCouldNotCompute() && "bad exit SCEV");
4737
4738     if (!BECount)
4739       BECount = ENT->ExactNotTaken;
4740     else if (BECount != ENT->ExactNotTaken)
4741       return SE->getCouldNotCompute();
4742   }
4743   assert(BECount && "Invalid not taken count for loop exit");
4744   return BECount;
4745 }
4746
4747 /// getExact - Get the exact not taken count for this loop exit.
4748 const SCEV *
4749 ScalarEvolution::BackedgeTakenInfo::getExact(BasicBlock *ExitingBlock,
4750                                              ScalarEvolution *SE) const {
4751   for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
4752        ENT != nullptr; ENT = ENT->getNextExit()) {
4753
4754     if (ENT->ExitingBlock == ExitingBlock)
4755       return ENT->ExactNotTaken;
4756   }
4757   return SE->getCouldNotCompute();
4758 }
4759
4760 /// getMax - Get the max backedge taken count for the loop.
4761 const SCEV *
4762 ScalarEvolution::BackedgeTakenInfo::getMax(ScalarEvolution *SE) const {
4763   return Max ? Max : SE->getCouldNotCompute();
4764 }
4765
4766 bool ScalarEvolution::BackedgeTakenInfo::hasOperand(const SCEV *S,
4767                                                     ScalarEvolution *SE) const {
4768   if (Max && Max != SE->getCouldNotCompute() && SE->hasOperand(Max, S))
4769     return true;
4770
4771   if (!ExitNotTaken.ExitingBlock)
4772     return false;
4773
4774   for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
4775        ENT != nullptr; ENT = ENT->getNextExit()) {
4776
4777     if (ENT->ExactNotTaken != SE->getCouldNotCompute()
4778         && SE->hasOperand(ENT->ExactNotTaken, S)) {
4779       return true;
4780     }
4781   }
4782   return false;
4783 }
4784
4785 /// Allocate memory for BackedgeTakenInfo and copy the not-taken count of each
4786 /// computable exit into a persistent ExitNotTakenInfo array.
4787 ScalarEvolution::BackedgeTakenInfo::BackedgeTakenInfo(
4788   SmallVectorImpl< std::pair<BasicBlock *, const SCEV *> > &ExitCounts,
4789   bool Complete, const SCEV *MaxCount) : Max(MaxCount) {
4790
4791   if (!Complete)
4792     ExitNotTaken.setIncomplete();
4793
4794   unsigned NumExits = ExitCounts.size();
4795   if (NumExits == 0) return;
4796
4797   ExitNotTaken.ExitingBlock = ExitCounts[0].first;
4798   ExitNotTaken.ExactNotTaken = ExitCounts[0].second;
4799   if (NumExits == 1) return;
4800
4801   // Handle the rare case of multiple computable exits.
4802   ExitNotTakenInfo *ENT = new ExitNotTakenInfo[NumExits-1];
4803
4804   ExitNotTakenInfo *PrevENT = &ExitNotTaken;
4805   for (unsigned i = 1; i < NumExits; ++i, PrevENT = ENT, ++ENT) {
4806     PrevENT->setNextExit(ENT);
4807     ENT->ExitingBlock = ExitCounts[i].first;
4808     ENT->ExactNotTaken = ExitCounts[i].second;
4809   }
4810 }
4811
4812 /// clear - Invalidate this result and free the ExitNotTakenInfo array.
4813 void ScalarEvolution::BackedgeTakenInfo::clear() {
4814   ExitNotTaken.ExitingBlock = nullptr;
4815   ExitNotTaken.ExactNotTaken = nullptr;
4816   delete[] ExitNotTaken.getNextExit();
4817 }
4818
4819 /// ComputeBackedgeTakenCount - Compute the number of times the backedge
4820 /// of the specified loop will execute.
4821 ScalarEvolution::BackedgeTakenInfo
4822 ScalarEvolution::ComputeBackedgeTakenCount(const Loop *L) {
4823   SmallVector<BasicBlock *, 8> ExitingBlocks;
4824   L->getExitingBlocks(ExitingBlocks);
4825
4826   SmallVector<std::pair<BasicBlock *, const SCEV *>, 4> ExitCounts;
4827   bool CouldComputeBECount = true;
4828   BasicBlock *Latch = L->getLoopLatch(); // may be NULL.
4829   const SCEV *MustExitMaxBECount = nullptr;
4830   const SCEV *MayExitMaxBECount = nullptr;
4831
4832   // Compute the ExitLimit for each loop exit. Use this to populate ExitCounts
4833   // and compute maxBECount.
4834   for (unsigned i = 0, e = ExitingBlocks.size(); i != e; ++i) {
4835     BasicBlock *ExitBB = ExitingBlocks[i];
4836     ExitLimit EL = ComputeExitLimit(L, ExitBB);
4837
4838     // 1. For each exit that can be computed, add an entry to ExitCounts.
4839     // CouldComputeBECount is true only if all exits can be computed.
4840     if (EL.Exact == getCouldNotCompute())
4841       // We couldn't compute an exact value for this exit, so
4842       // we won't be able to compute an exact value for the loop.
4843       CouldComputeBECount = false;
4844     else
4845       ExitCounts.push_back(std::make_pair(ExitBB, EL.Exact));
4846
4847     // 2. Derive the loop's MaxBECount from each exit's max number of
4848     // non-exiting iterations. Partition the loop exits into two kinds:
4849     // LoopMustExits and LoopMayExits.
4850     //
4851     // If the exit dominates the loop latch, it is a LoopMustExit otherwise it
4852     // is a LoopMayExit.  If any computable LoopMustExit is found, then
4853     // MaxBECount is the minimum EL.Max of computable LoopMustExits. Otherwise,
4854     // MaxBECount is conservatively the maximum EL.Max, where CouldNotCompute is
4855     // considered greater than any computable EL.Max.
4856     if (EL.Max != getCouldNotCompute() && Latch &&
4857         DT->dominates(ExitBB, Latch)) {
4858       if (!MustExitMaxBECount)
4859         MustExitMaxBECount = EL.Max;
4860       else {
4861         MustExitMaxBECount =
4862           getUMinFromMismatchedTypes(MustExitMaxBECount, EL.Max);
4863       }
4864     } else if (MayExitMaxBECount != getCouldNotCompute()) {
4865       if (!MayExitMaxBECount || EL.Max == getCouldNotCompute())
4866         MayExitMaxBECount = EL.Max;
4867       else {
4868         MayExitMaxBECount =
4869           getUMaxFromMismatchedTypes(MayExitMaxBECount, EL.Max);
4870       }
4871     }
4872   }
4873   const SCEV *MaxBECount = MustExitMaxBECount ? MustExitMaxBECount :
4874     (MayExitMaxBECount ? MayExitMaxBECount : getCouldNotCompute());
4875   return BackedgeTakenInfo(ExitCounts, CouldComputeBECount, MaxBECount);
4876 }
4877
4878 /// ComputeExitLimit - Compute the number of times the backedge of the specified
4879 /// loop will execute if it exits via the specified block.
4880 ScalarEvolution::ExitLimit
4881 ScalarEvolution::ComputeExitLimit(const Loop *L, BasicBlock *ExitingBlock) {
4882
4883   // Okay, we've chosen an exiting block.  See what condition causes us to
4884   // exit at this block and remember the exit block and whether all other targets
4885   // lead to the loop header.
4886   bool MustExecuteLoopHeader = true;
4887   BasicBlock *Exit = nullptr;
4888   for (succ_iterator SI = succ_begin(ExitingBlock), SE = succ_end(ExitingBlock);
4889        SI != SE; ++SI)
4890     if (!L->contains(*SI)) {
4891       if (Exit) // Multiple exit successors.
4892         return getCouldNotCompute();
4893       Exit = *SI;
4894     } else if (*SI != L->getHeader()) {
4895       MustExecuteLoopHeader = false;
4896     }
4897
4898   // At this point, we know we have a conditional branch that determines whether
4899   // the loop is exited.  However, we don't know if the branch is executed each
4900   // time through the loop.  If not, then the execution count of the branch will
4901   // not be equal to the trip count of the loop.
4902   //
4903   // Currently we check for this by checking to see if the Exit branch goes to
4904   // the loop header.  If so, we know it will always execute the same number of
4905   // times as the loop.  We also handle the case where the exit block *is* the
4906   // loop header.  This is common for un-rotated loops.
4907   //
4908   // If both of those tests fail, walk up the unique predecessor chain to the
4909   // header, stopping if there is an edge that doesn't exit the loop. If the
4910   // header is reached, the execution count of the branch will be equal to the
4911   // trip count of the loop.
4912   //
4913   //  More extensive analysis could be done to handle more cases here.
4914   //
4915   if (!MustExecuteLoopHeader && ExitingBlock != L->getHeader()) {
4916     // The simple checks failed, try climbing the unique predecessor chain
4917     // up to the header.
4918     bool Ok = false;
4919     for (BasicBlock *BB = ExitingBlock; BB; ) {
4920       BasicBlock *Pred = BB->getUniquePredecessor();
4921       if (!Pred)
4922         return getCouldNotCompute();
4923       TerminatorInst *PredTerm = Pred->getTerminator();
4924       for (unsigned i = 0, e = PredTerm->getNumSuccessors(); i != e; ++i) {
4925         BasicBlock *PredSucc = PredTerm->getSuccessor(i);
4926         if (PredSucc == BB)
4927           continue;
4928         // If the predecessor has a successor that isn't BB and isn't
4929         // outside the loop, assume the worst.
4930         if (L->contains(PredSucc))
4931           return getCouldNotCompute();
4932       }
4933       if (Pred == L->getHeader()) {
4934         Ok = true;
4935         break;
4936       }
4937       BB = Pred;
4938     }
4939     if (!Ok)
4940       return getCouldNotCompute();
4941   }
4942
4943   bool IsOnlyExit = (L->getExitingBlock() != nullptr);
4944   TerminatorInst *Term = ExitingBlock->getTerminator();
4945   if (BranchInst *BI = dyn_cast<BranchInst>(Term)) {
4946     assert(BI->isConditional() && "If unconditional, it can't be in loop!");
4947     // Proceed to the next level to examine the exit condition expression.
4948     return ComputeExitLimitFromCond(L, BI->getCondition(), BI->getSuccessor(0),
4949                                     BI->getSuccessor(1),
4950                                     /*ControlsExit=*/IsOnlyExit);
4951   }
4952
4953   if (SwitchInst *SI = dyn_cast<SwitchInst>(Term))
4954     return ComputeExitLimitFromSingleExitSwitch(L, SI, Exit,
4955                                                 /*ControlsExit=*/IsOnlyExit);
4956
4957   return getCouldNotCompute();
4958 }
4959
4960 /// ComputeExitLimitFromCond - Compute the number of times the
4961 /// backedge of the specified loop will execute if its exit condition
4962 /// were a conditional branch of ExitCond, TBB, and FBB.
4963 ///
4964 /// @param ControlsExit is true if ExitCond directly controls the exit
4965 /// branch. In this case, we can assume that the loop exits only if the
4966 /// condition is true and can infer that failing to meet the condition prior to
4967 /// integer wraparound results in undefined behavior.
4968 ScalarEvolution::ExitLimit
4969 ScalarEvolution::ComputeExitLimitFromCond(const Loop *L,
4970                                           Value *ExitCond,
4971                                           BasicBlock *TBB,
4972                                           BasicBlock *FBB,
4973                                           bool ControlsExit) {
4974   // Check if the controlling expression for this loop is an And or Or.
4975   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(ExitCond)) {
4976     if (BO->getOpcode() == Instruction::And) {
4977       // Recurse on the operands of the and.
4978       bool EitherMayExit = L->contains(TBB);
4979       ExitLimit EL0 = ComputeExitLimitFromCond(L, BO->getOperand(0), TBB, FBB,
4980                                                ControlsExit && !EitherMayExit);
4981       ExitLimit EL1 = ComputeExitLimitFromCond(L, BO->getOperand(1), TBB, FBB,
4982                                                ControlsExit && !EitherMayExit);
4983       const SCEV *BECount = getCouldNotCompute();
4984       const SCEV *MaxBECount = getCouldNotCompute();
4985       if (EitherMayExit) {
4986         // Both conditions must be true for the loop to continue executing.
4987         // Choose the less conservative count.
4988         if (EL0.Exact == getCouldNotCompute() ||
4989             EL1.Exact == getCouldNotCompute())
4990           BECount = getCouldNotCompute();
4991         else
4992           BECount = getUMinFromMismatchedTypes(EL0.Exact, EL1.Exact);
4993         if (EL0.Max == getCouldNotCompute())
4994           MaxBECount = EL1.Max;
4995         else if (EL1.Max == getCouldNotCompute())
4996           MaxBECount = EL0.Max;
4997         else
4998           MaxBECount = getUMinFromMismatchedTypes(EL0.Max, EL1.Max);
4999       } else {
5000         // Both conditions must be true at the same time for the loop to exit.
5001         // For now, be conservative.
5002         assert(L->contains(FBB) && "Loop block has no successor in loop!");
5003         if (EL0.Max == EL1.Max)
5004           MaxBECount = EL0.Max;
5005         if (EL0.Exact == EL1.Exact)
5006           BECount = EL0.Exact;
5007       }
5008
5009       return ExitLimit(BECount, MaxBECount);
5010     }
5011     if (BO->getOpcode() == Instruction::Or) {
5012       // Recurse on the operands of the or.
5013       bool EitherMayExit = L->contains(FBB);
5014       ExitLimit EL0 = ComputeExitLimitFromCond(L, BO->getOperand(0), TBB, FBB,
5015                                                ControlsExit && !EitherMayExit);
5016       ExitLimit EL1 = ComputeExitLimitFromCond(L, BO->getOperand(1), TBB, FBB,
5017                                                ControlsExit && !EitherMayExit);
5018       const SCEV *BECount = getCouldNotCompute();
5019       const SCEV *MaxBECount = getCouldNotCompute();
5020       if (EitherMayExit) {
5021         // Both conditions must be false for the loop to continue executing.
5022         // Choose the less conservative count.
5023         if (EL0.Exact == getCouldNotCompute() ||
5024             EL1.Exact == getCouldNotCompute())
5025           BECount = getCouldNotCompute();
5026         else
5027           BECount = getUMinFromMismatchedTypes(EL0.Exact, EL1.Exact);
5028         if (EL0.Max == getCouldNotCompute())
5029           MaxBECount = EL1.Max;
5030         else if (EL1.Max == getCouldNotCompute())
5031           MaxBECount = EL0.Max;
5032         else
5033           MaxBECount = getUMinFromMismatchedTypes(EL0.Max, EL1.Max);
5034       } else {
5035         // Both conditions must be false at the same time for the loop to exit.
5036         // For now, be conservative.
5037         assert(L->contains(TBB) && "Loop block has no successor in loop!");
5038         if (EL0.Max == EL1.Max)
5039           MaxBECount = EL0.Max;
5040         if (EL0.Exact == EL1.Exact)
5041           BECount = EL0.Exact;
5042       }
5043
5044       return ExitLimit(BECount, MaxBECount);
5045     }
5046   }
5047
5048   // With an icmp, it may be feasible to compute an exact backedge-taken count.
5049   // Proceed to the next level to examine the icmp.
5050   if (ICmpInst *ExitCondICmp = dyn_cast<ICmpInst>(ExitCond))
5051     return ComputeExitLimitFromICmp(L, ExitCondICmp, TBB, FBB, ControlsExit);
5052
5053   // Check for a constant condition. These are normally stripped out by
5054   // SimplifyCFG, but ScalarEvolution may be used by a pass which wishes to
5055   // preserve the CFG and is temporarily leaving constant conditions
5056   // in place.
5057   if (ConstantInt *CI = dyn_cast<ConstantInt>(ExitCond)) {
5058     if (L->contains(FBB) == !CI->getZExtValue())
5059       // The backedge is always taken.
5060       return getCouldNotCompute();
5061     else
5062       // The backedge is never taken.
5063       return getConstant(CI->getType(), 0);
5064   }
5065
5066   // If it's not an integer or pointer comparison then compute it the hard way.
5067   return ComputeExitCountExhaustively(L, ExitCond, !L->contains(TBB));
5068 }
5069
5070 /// ComputeExitLimitFromICmp - Compute the number of times the
5071 /// backedge of the specified loop will execute if its exit condition
5072 /// were a conditional branch of the ICmpInst ExitCond, TBB, and FBB.
5073 ScalarEvolution::ExitLimit
5074 ScalarEvolution::ComputeExitLimitFromICmp(const Loop *L,
5075                                           ICmpInst *ExitCond,
5076                                           BasicBlock *TBB,
5077                                           BasicBlock *FBB,
5078                                           bool ControlsExit) {
5079
5080   // If the condition was exit on true, convert the condition to exit on false
5081   ICmpInst::Predicate Cond;
5082   if (!L->contains(FBB))
5083     Cond = ExitCond->getPredicate();
5084   else
5085     Cond = ExitCond->getInversePredicate();
5086
5087   // Handle common loops like: for (X = "string"; *X; ++X)
5088   if (LoadInst *LI = dyn_cast<LoadInst>(ExitCond->getOperand(0)))
5089     if (Constant *RHS = dyn_cast<Constant>(ExitCond->getOperand(1))) {
5090       ExitLimit ItCnt =
5091         ComputeLoadConstantCompareExitLimit(LI, RHS, L, Cond);
5092       if (ItCnt.hasAnyInfo())
5093         return ItCnt;
5094     }
5095
5096   const SCEV *LHS = getSCEV(ExitCond->getOperand(0));
5097   const SCEV *RHS = getSCEV(ExitCond->getOperand(1));
5098
5099   // Try to evaluate any dependencies out of the loop.
5100   LHS = getSCEVAtScope(LHS, L);
5101   RHS = getSCEVAtScope(RHS, L);
5102
5103   // At this point, we would like to compute how many iterations of the
5104   // loop the predicate will return true for these inputs.
5105   if (isLoopInvariant(LHS, L) && !isLoopInvariant(RHS, L)) {
5106     // If there is a loop-invariant, force it into the RHS.
5107     std::swap(LHS, RHS);
5108     Cond = ICmpInst::getSwappedPredicate(Cond);
5109   }
5110
5111   // Simplify the operands before analyzing them.
5112   (void)SimplifyICmpOperands(Cond, LHS, RHS);
5113
5114   // If we have a comparison of a chrec against a constant, try to use value
5115   // ranges to answer this query.
5116   if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS))
5117     if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS))
5118       if (AddRec->getLoop() == L) {
5119         // Form the constant range.
5120         ConstantRange CompRange(
5121             ICmpInst::makeConstantRange(Cond, RHSC->getValue()->getValue()));
5122
5123         const SCEV *Ret = AddRec->getNumIterationsInRange(CompRange, *this);
5124         if (!isa<SCEVCouldNotCompute>(Ret)) return Ret;
5125       }
5126
5127   switch (Cond) {
5128   case ICmpInst::ICMP_NE: {                     // while (X != Y)
5129     // Convert to: while (X-Y != 0)
5130     ExitLimit EL = HowFarToZero(getMinusSCEV(LHS, RHS), L, ControlsExit);
5131     if (EL.hasAnyInfo()) return EL;
5132     break;
5133   }
5134   case ICmpInst::ICMP_EQ: {                     // while (X == Y)
5135     // Convert to: while (X-Y == 0)
5136     ExitLimit EL = HowFarToNonZero(getMinusSCEV(LHS, RHS), L);
5137     if (EL.hasAnyInfo()) return EL;
5138     break;
5139   }
5140   case ICmpInst::ICMP_SLT:
5141   case ICmpInst::ICMP_ULT: {                    // while (X < Y)
5142     bool IsSigned = Cond == ICmpInst::ICMP_SLT;
5143     ExitLimit EL = HowManyLessThans(LHS, RHS, L, IsSigned, ControlsExit);
5144     if (EL.hasAnyInfo()) return EL;
5145     break;
5146   }
5147   case ICmpInst::ICMP_SGT:
5148   case ICmpInst::ICMP_UGT: {                    // while (X > Y)
5149     bool IsSigned = Cond == ICmpInst::ICMP_SGT;
5150     ExitLimit EL = HowManyGreaterThans(LHS, RHS, L, IsSigned, ControlsExit);
5151     if (EL.hasAnyInfo()) return EL;
5152     break;
5153   }
5154   default:
5155 #if 0
5156     dbgs() << "ComputeBackedgeTakenCount ";
5157     if (ExitCond->getOperand(0)->getType()->isUnsigned())
5158       dbgs() << "[unsigned] ";
5159     dbgs() << *LHS << "   "
5160          << Instruction::getOpcodeName(Instruction::ICmp)
5161          << "   " << *RHS << "\n";
5162 #endif
5163     break;
5164   }
5165   return ComputeExitCountExhaustively(L, ExitCond, !L->contains(TBB));
5166 }
5167
5168 ScalarEvolution::ExitLimit
5169 ScalarEvolution::ComputeExitLimitFromSingleExitSwitch(const Loop *L,
5170                                                       SwitchInst *Switch,
5171                                                       BasicBlock *ExitingBlock,
5172                                                       bool ControlsExit) {
5173   assert(!L->contains(ExitingBlock) && "Not an exiting block!");
5174
5175   // Give up if the exit is the default dest of a switch.
5176   if (Switch->getDefaultDest() == ExitingBlock)
5177     return getCouldNotCompute();
5178
5179   assert(L->contains(Switch->getDefaultDest()) &&
5180          "Default case must not exit the loop!");
5181   const SCEV *LHS = getSCEVAtScope(Switch->getCondition(), L);
5182   const SCEV *RHS = getConstant(Switch->findCaseDest(ExitingBlock));
5183
5184   // while (X != Y) --> while (X-Y != 0)
5185   ExitLimit EL = HowFarToZero(getMinusSCEV(LHS, RHS), L, ControlsExit);
5186   if (EL.hasAnyInfo())
5187     return EL;
5188
5189   return getCouldNotCompute();
5190 }
5191
5192 static ConstantInt *
5193 EvaluateConstantChrecAtConstant(const SCEVAddRecExpr *AddRec, ConstantInt *C,
5194                                 ScalarEvolution &SE) {
5195   const SCEV *InVal = SE.getConstant(C);
5196   const SCEV *Val = AddRec->evaluateAtIteration(InVal, SE);
5197   assert(isa<SCEVConstant>(Val) &&
5198          "Evaluation of SCEV at constant didn't fold correctly?");
5199   return cast<SCEVConstant>(Val)->getValue();
5200 }
5201
5202 /// ComputeLoadConstantCompareExitLimit - Given an exit condition of
5203 /// 'icmp op load X, cst', try to see if we can compute the backedge
5204 /// execution count.
5205 ScalarEvolution::ExitLimit
5206 ScalarEvolution::ComputeLoadConstantCompareExitLimit(
5207   LoadInst *LI,
5208   Constant *RHS,
5209   const Loop *L,
5210   ICmpInst::Predicate predicate) {
5211
5212   if (LI->isVolatile()) return getCouldNotCompute();
5213
5214   // Check to see if the loaded pointer is a getelementptr of a global.
5215   // TODO: Use SCEV instead of manually grubbing with GEPs.
5216   GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0));
5217   if (!GEP) return getCouldNotCompute();
5218
5219   // Make sure that it is really a constant global we are gepping, with an
5220   // initializer, and make sure the first IDX is really 0.
5221   GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0));
5222   if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() ||
5223       GEP->getNumOperands() < 3 || !isa<Constant>(GEP->getOperand(1)) ||
5224       !cast<Constant>(GEP->getOperand(1))->isNullValue())
5225     return getCouldNotCompute();
5226
5227   // Okay, we allow one non-constant index into the GEP instruction.
5228   Value *VarIdx = nullptr;
5229   std::vector<Constant*> Indexes;
5230   unsigned VarIdxNum = 0;
5231   for (unsigned i = 2, e = GEP->getNumOperands(); i != e; ++i)
5232     if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
5233       Indexes.push_back(CI);
5234     } else if (!isa<ConstantInt>(GEP->getOperand(i))) {
5235       if (VarIdx) return getCouldNotCompute();  // Multiple non-constant idx's.
5236       VarIdx = GEP->getOperand(i);
5237       VarIdxNum = i-2;
5238       Indexes.push_back(nullptr);
5239     }
5240
5241   // Loop-invariant loads may be a byproduct of loop optimization. Skip them.
5242   if (!VarIdx)
5243     return getCouldNotCompute();
5244
5245   // Okay, we know we have a (load (gep GV, 0, X)) comparison with a constant.
5246   // Check to see if X is a loop variant variable value now.
5247   const SCEV *Idx = getSCEV(VarIdx);
5248   Idx = getSCEVAtScope(Idx, L);
5249
5250   // We can only recognize very limited forms of loop index expressions, in
5251   // particular, only affine AddRec's like {C1,+,C2}.
5252   const SCEVAddRecExpr *IdxExpr = dyn_cast<SCEVAddRecExpr>(Idx);
5253   if (!IdxExpr || !IdxExpr->isAffine() || isLoopInvariant(IdxExpr, L) ||
5254       !isa<SCEVConstant>(IdxExpr->getOperand(0)) ||
5255       !isa<SCEVConstant>(IdxExpr->getOperand(1)))
5256     return getCouldNotCompute();
5257
5258   unsigned MaxSteps = MaxBruteForceIterations;
5259   for (unsigned IterationNum = 0; IterationNum != MaxSteps; ++IterationNum) {
5260     ConstantInt *ItCst = ConstantInt::get(
5261                            cast<IntegerType>(IdxExpr->getType()), IterationNum);
5262     ConstantInt *Val = EvaluateConstantChrecAtConstant(IdxExpr, ItCst, *this);
5263
5264     // Form the GEP offset.
5265     Indexes[VarIdxNum] = Val;
5266
5267     Constant *Result = ConstantFoldLoadThroughGEPIndices(GV->getInitializer(),
5268                                                          Indexes);
5269     if (!Result) break;  // Cannot compute!
5270
5271     // Evaluate the condition for this iteration.
5272     Result = ConstantExpr::getICmp(predicate, Result, RHS);
5273     if (!isa<ConstantInt>(Result)) break;  // Couldn't decide for sure
5274     if (cast<ConstantInt>(Result)->getValue().isMinValue()) {
5275 #if 0
5276       dbgs() << "\n***\n*** Computed loop count " << *ItCst
5277              << "\n*** From global " << *GV << "*** BB: " << *L->getHeader()
5278              << "***\n";
5279 #endif
5280       ++NumArrayLenItCounts;
5281       return getConstant(ItCst);   // Found terminating iteration!
5282     }
5283   }
5284   return getCouldNotCompute();
5285 }
5286
5287
5288 /// CanConstantFold - Return true if we can constant fold an instruction of the
5289 /// specified type, assuming that all operands were constants.
5290 static bool CanConstantFold(const Instruction *I) {
5291   if (isa<BinaryOperator>(I) || isa<CmpInst>(I) ||
5292       isa<SelectInst>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I) ||
5293       isa<LoadInst>(I))
5294     return true;
5295
5296   if (const CallInst *CI = dyn_cast<CallInst>(I))
5297     if (const Function *F = CI->getCalledFunction())
5298       return canConstantFoldCallTo(F);
5299   return false;
5300 }
5301
5302 /// Determine whether this instruction can constant evolve within this loop
5303 /// assuming its operands can all constant evolve.
5304 static bool canConstantEvolve(Instruction *I, const Loop *L) {
5305   // An instruction outside of the loop can't be derived from a loop PHI.
5306   if (!L->contains(I)) return false;
5307
5308   if (isa<PHINode>(I)) {
5309     if (L->getHeader() == I->getParent())
5310       return true;
5311     else
5312       // We don't currently keep track of the control flow needed to evaluate
5313       // PHIs, so we cannot handle PHIs inside of loops.
5314       return false;
5315   }
5316
5317   // If we won't be able to constant fold this expression even if the operands
5318   // are constants, bail early.
5319   return CanConstantFold(I);
5320 }
5321
5322 /// getConstantEvolvingPHIOperands - Implement getConstantEvolvingPHI by
5323 /// recursing through each instruction operand until reaching a loop header phi.
5324 static PHINode *
5325 getConstantEvolvingPHIOperands(Instruction *UseInst, const Loop *L,
5326                                DenseMap<Instruction *, PHINode *> &PHIMap) {
5327
5328   // Otherwise, we can evaluate this instruction if all of its operands are
5329   // constant or derived from a PHI node themselves.
5330   PHINode *PHI = nullptr;
5331   for (Instruction::op_iterator OpI = UseInst->op_begin(),
5332          OpE = UseInst->op_end(); OpI != OpE; ++OpI) {
5333
5334     if (isa<Constant>(*OpI)) continue;
5335
5336     Instruction *OpInst = dyn_cast<Instruction>(*OpI);
5337     if (!OpInst || !canConstantEvolve(OpInst, L)) return nullptr;
5338
5339     PHINode *P = dyn_cast<PHINode>(OpInst);
5340     if (!P)
5341       // If this operand is already visited, reuse the prior result.
5342       // We may have P != PHI if this is the deepest point at which the
5343       // inconsistent paths meet.
5344       P = PHIMap.lookup(OpInst);
5345     if (!P) {
5346       // Recurse and memoize the results, whether a phi is found or not.
5347       // This recursive call invalidates pointers into PHIMap.
5348       P = getConstantEvolvingPHIOperands(OpInst, L, PHIMap);
5349       PHIMap[OpInst] = P;
5350     }
5351     if (!P)
5352       return nullptr;  // Not evolving from PHI
5353     if (PHI && PHI != P)
5354       return nullptr;  // Evolving from multiple different PHIs.
5355     PHI = P;
5356   }
5357   // This is a expression evolving from a constant PHI!
5358   return PHI;
5359 }
5360
5361 /// getConstantEvolvingPHI - Given an LLVM value and a loop, return a PHI node
5362 /// in the loop that V is derived from.  We allow arbitrary operations along the
5363 /// way, but the operands of an operation must either be constants or a value
5364 /// derived from a constant PHI.  If this expression does not fit with these
5365 /// constraints, return null.
5366 static PHINode *getConstantEvolvingPHI(Value *V, const Loop *L) {
5367   Instruction *I = dyn_cast<Instruction>(V);
5368   if (!I || !canConstantEvolve(I, L)) return nullptr;
5369
5370   if (PHINode *PN = dyn_cast<PHINode>(I)) {
5371     return PN;
5372   }
5373
5374   // Record non-constant instructions contained by the loop.
5375   DenseMap<Instruction *, PHINode *> PHIMap;
5376   return getConstantEvolvingPHIOperands(I, L, PHIMap);
5377 }
5378
5379 /// EvaluateExpression - Given an expression that passes the
5380 /// getConstantEvolvingPHI predicate, evaluate its value assuming the PHI node
5381 /// in the loop has the value PHIVal.  If we can't fold this expression for some
5382 /// reason, return null.
5383 static Constant *EvaluateExpression(Value *V, const Loop *L,
5384                                     DenseMap<Instruction *, Constant *> &Vals,
5385                                     const DataLayout &DL,
5386                                     const TargetLibraryInfo *TLI) {
5387   // Convenient constant check, but redundant for recursive calls.
5388   if (Constant *C = dyn_cast<Constant>(V)) return C;
5389   Instruction *I = dyn_cast<Instruction>(V);
5390   if (!I) return nullptr;
5391
5392   if (Constant *C = Vals.lookup(I)) return C;
5393
5394   // An instruction inside the loop depends on a value outside the loop that we
5395   // weren't given a mapping for, or a value such as a call inside the loop.
5396   if (!canConstantEvolve(I, L)) return nullptr;
5397
5398   // An unmapped PHI can be due to a branch or another loop inside this loop,
5399   // or due to this not being the initial iteration through a loop where we
5400   // couldn't compute the evolution of this particular PHI last time.
5401   if (isa<PHINode>(I)) return nullptr;
5402
5403   std::vector<Constant*> Operands(I->getNumOperands());
5404
5405   for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
5406     Instruction *Operand = dyn_cast<Instruction>(I->getOperand(i));
5407     if (!Operand) {
5408       Operands[i] = dyn_cast<Constant>(I->getOperand(i));
5409       if (!Operands[i]) return nullptr;
5410       continue;
5411     }
5412     Constant *C = EvaluateExpression(Operand, L, Vals, DL, TLI);
5413     Vals[Operand] = C;
5414     if (!C) return nullptr;
5415     Operands[i] = C;
5416   }
5417
5418   if (CmpInst *CI = dyn_cast<CmpInst>(I))
5419     return ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0],
5420                                            Operands[1], DL, TLI);
5421   if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
5422     if (!LI->isVolatile())
5423       return ConstantFoldLoadFromConstPtr(Operands[0], DL);
5424   }
5425   return ConstantFoldInstOperands(I->getOpcode(), I->getType(), Operands, DL,
5426                                   TLI);
5427 }
5428
5429 /// getConstantEvolutionLoopExitValue - If we know that the specified Phi is
5430 /// in the header of its containing loop, we know the loop executes a
5431 /// constant number of times, and the PHI node is just a recurrence
5432 /// involving constants, fold it.
5433 Constant *
5434 ScalarEvolution::getConstantEvolutionLoopExitValue(PHINode *PN,
5435                                                    const APInt &BEs,
5436                                                    const Loop *L) {
5437   DenseMap<PHINode*, Constant*>::const_iterator I =
5438     ConstantEvolutionLoopExitValue.find(PN);
5439   if (I != ConstantEvolutionLoopExitValue.end())
5440     return I->second;
5441
5442   if (BEs.ugt(MaxBruteForceIterations))
5443     return ConstantEvolutionLoopExitValue[PN] = nullptr;  // Not going to evaluate it.
5444
5445   Constant *&RetVal = ConstantEvolutionLoopExitValue[PN];
5446
5447   DenseMap<Instruction *, Constant *> CurrentIterVals;
5448   BasicBlock *Header = L->getHeader();
5449   assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!");
5450
5451   // Since the loop is canonicalized, the PHI node must have two entries.  One
5452   // entry must be a constant (coming in from outside of the loop), and the
5453   // second must be derived from the same PHI.
5454   bool SecondIsBackedge = L->contains(PN->getIncomingBlock(1));
5455   PHINode *PHI = nullptr;
5456   for (BasicBlock::iterator I = Header->begin();
5457        (PHI = dyn_cast<PHINode>(I)); ++I) {
5458     Constant *StartCST =
5459       dyn_cast<Constant>(PHI->getIncomingValue(!SecondIsBackedge));
5460     if (!StartCST) continue;
5461     CurrentIterVals[PHI] = StartCST;
5462   }
5463   if (!CurrentIterVals.count(PN))
5464     return RetVal = nullptr;
5465
5466   Value *BEValue = PN->getIncomingValue(SecondIsBackedge);
5467
5468   // Execute the loop symbolically to determine the exit value.
5469   if (BEs.getActiveBits() >= 32)
5470     return RetVal = nullptr; // More than 2^32-1 iterations?? Not doing it!
5471
5472   unsigned NumIterations = BEs.getZExtValue(); // must be in range
5473   unsigned IterationNum = 0;
5474   const DataLayout &DL = F->getParent()->getDataLayout();
5475   for (; ; ++IterationNum) {
5476     if (IterationNum == NumIterations)
5477       return RetVal = CurrentIterVals[PN];  // Got exit value!
5478
5479     // Compute the value of the PHIs for the next iteration.
5480     // EvaluateExpression adds non-phi values to the CurrentIterVals map.
5481     DenseMap<Instruction *, Constant *> NextIterVals;
5482     Constant *NextPHI =
5483         EvaluateExpression(BEValue, L, CurrentIterVals, DL, TLI);
5484     if (!NextPHI)
5485       return nullptr;        // Couldn't evaluate!
5486     NextIterVals[PN] = NextPHI;
5487
5488     bool StoppedEvolving = NextPHI == CurrentIterVals[PN];
5489
5490     // Also evaluate the other PHI nodes.  However, we don't get to stop if we
5491     // cease to be able to evaluate one of them or if they stop evolving,
5492     // because that doesn't necessarily prevent us from computing PN.
5493     SmallVector<std::pair<PHINode *, Constant *>, 8> PHIsToCompute;
5494     for (DenseMap<Instruction *, Constant *>::const_iterator
5495            I = CurrentIterVals.begin(), E = CurrentIterVals.end(); I != E; ++I){
5496       PHINode *PHI = dyn_cast<PHINode>(I->first);
5497       if (!PHI || PHI == PN || PHI->getParent() != Header) continue;
5498       PHIsToCompute.push_back(std::make_pair(PHI, I->second));
5499     }
5500     // We use two distinct loops because EvaluateExpression may invalidate any
5501     // iterators into CurrentIterVals.
5502     for (SmallVectorImpl<std::pair<PHINode *, Constant*> >::const_iterator
5503              I = PHIsToCompute.begin(), E = PHIsToCompute.end(); I != E; ++I) {
5504       PHINode *PHI = I->first;
5505       Constant *&NextPHI = NextIterVals[PHI];
5506       if (!NextPHI) {   // Not already computed.
5507         Value *BEValue = PHI->getIncomingValue(SecondIsBackedge);
5508         NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, DL, TLI);
5509       }
5510       if (NextPHI != I->second)
5511         StoppedEvolving = false;
5512     }
5513
5514     // If all entries in CurrentIterVals == NextIterVals then we can stop
5515     // iterating, the loop can't continue to change.
5516     if (StoppedEvolving)
5517       return RetVal = CurrentIterVals[PN];
5518
5519     CurrentIterVals.swap(NextIterVals);
5520   }
5521 }
5522
5523 /// ComputeExitCountExhaustively - If the loop is known to execute a
5524 /// constant number of times (the condition evolves only from constants),
5525 /// try to evaluate a few iterations of the loop until we get the exit
5526 /// condition gets a value of ExitWhen (true or false).  If we cannot
5527 /// evaluate the trip count of the loop, return getCouldNotCompute().
5528 const SCEV *ScalarEvolution::ComputeExitCountExhaustively(const Loop *L,
5529                                                           Value *Cond,
5530                                                           bool ExitWhen) {
5531   PHINode *PN = getConstantEvolvingPHI(Cond, L);
5532   if (!PN) return getCouldNotCompute();
5533
5534   // If the loop is canonicalized, the PHI will have exactly two entries.
5535   // That's the only form we support here.
5536   if (PN->getNumIncomingValues() != 2) return getCouldNotCompute();
5537
5538   DenseMap<Instruction *, Constant *> CurrentIterVals;
5539   BasicBlock *Header = L->getHeader();
5540   assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!");
5541
5542   // One entry must be a constant (coming in from outside of the loop), and the
5543   // second must be derived from the same PHI.
5544   bool SecondIsBackedge = L->contains(PN->getIncomingBlock(1));
5545   PHINode *PHI = nullptr;
5546   for (BasicBlock::iterator I = Header->begin();
5547        (PHI = dyn_cast<PHINode>(I)); ++I) {
5548     Constant *StartCST =
5549       dyn_cast<Constant>(PHI->getIncomingValue(!SecondIsBackedge));
5550     if (!StartCST) continue;
5551     CurrentIterVals[PHI] = StartCST;
5552   }
5553   if (!CurrentIterVals.count(PN))
5554     return getCouldNotCompute();
5555
5556   // Okay, we find a PHI node that defines the trip count of this loop.  Execute
5557   // the loop symbolically to determine when the condition gets a value of
5558   // "ExitWhen".
5559   unsigned MaxIterations = MaxBruteForceIterations;   // Limit analysis.
5560   const DataLayout &DL = F->getParent()->getDataLayout();
5561   for (unsigned IterationNum = 0; IterationNum != MaxIterations;++IterationNum){
5562     ConstantInt *CondVal = dyn_cast_or_null<ConstantInt>(
5563         EvaluateExpression(Cond, L, CurrentIterVals, DL, TLI));
5564
5565     // Couldn't symbolically evaluate.
5566     if (!CondVal) return getCouldNotCompute();
5567
5568     if (CondVal->getValue() == uint64_t(ExitWhen)) {
5569       ++NumBruteForceTripCountsComputed;
5570       return getConstant(Type::getInt32Ty(getContext()), IterationNum);
5571     }
5572
5573     // Update all the PHI nodes for the next iteration.
5574     DenseMap<Instruction *, Constant *> NextIterVals;
5575
5576     // Create a list of which PHIs we need to compute. We want to do this before
5577     // calling EvaluateExpression on them because that may invalidate iterators
5578     // into CurrentIterVals.
5579     SmallVector<PHINode *, 8> PHIsToCompute;
5580     for (DenseMap<Instruction *, Constant *>::const_iterator
5581            I = CurrentIterVals.begin(), E = CurrentIterVals.end(); I != E; ++I){
5582       PHINode *PHI = dyn_cast<PHINode>(I->first);
5583       if (!PHI || PHI->getParent() != Header) continue;
5584       PHIsToCompute.push_back(PHI);
5585     }
5586     for (SmallVectorImpl<PHINode *>::const_iterator I = PHIsToCompute.begin(),
5587              E = PHIsToCompute.end(); I != E; ++I) {
5588       PHINode *PHI = *I;
5589       Constant *&NextPHI = NextIterVals[PHI];
5590       if (NextPHI) continue;    // Already computed!
5591
5592       Value *BEValue = PHI->getIncomingValue(SecondIsBackedge);
5593       NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, DL, TLI);
5594     }
5595     CurrentIterVals.swap(NextIterVals);
5596   }
5597
5598   // Too many iterations were needed to evaluate.
5599   return getCouldNotCompute();
5600 }
5601
5602 /// getSCEVAtScope - Return a SCEV expression for the specified value
5603 /// at the specified scope in the program.  The L value specifies a loop
5604 /// nest to evaluate the expression at, where null is the top-level or a
5605 /// specified loop is immediately inside of the loop.
5606 ///
5607 /// This method can be used to compute the exit value for a variable defined
5608 /// in a loop by querying what the value will hold in the parent loop.
5609 ///
5610 /// In the case that a relevant loop exit value cannot be computed, the
5611 /// original value V is returned.
5612 const SCEV *ScalarEvolution::getSCEVAtScope(const SCEV *V, const Loop *L) {
5613   // Check to see if we've folded this expression at this loop before.
5614   SmallVector<std::pair<const Loop *, const SCEV *>, 2> &Values = ValuesAtScopes[V];
5615   for (unsigned u = 0; u < Values.size(); u++) {
5616     if (Values[u].first == L)
5617       return Values[u].second ? Values[u].second : V;
5618   }
5619   Values.push_back(std::make_pair(L, static_cast<const SCEV *>(nullptr)));
5620   // Otherwise compute it.
5621   const SCEV *C = computeSCEVAtScope(V, L);
5622   SmallVector<std::pair<const Loop *, const SCEV *>, 2> &Values2 = ValuesAtScopes[V];
5623   for (unsigned u = Values2.size(); u > 0; u--) {
5624     if (Values2[u - 1].first == L) {
5625       Values2[u - 1].second = C;
5626       break;
5627     }
5628   }
5629   return C;
5630 }
5631
5632 /// This builds up a Constant using the ConstantExpr interface.  That way, we
5633 /// will return Constants for objects which aren't represented by a
5634 /// SCEVConstant, because SCEVConstant is restricted to ConstantInt.
5635 /// Returns NULL if the SCEV isn't representable as a Constant.
5636 static Constant *BuildConstantFromSCEV(const SCEV *V) {
5637   switch (static_cast<SCEVTypes>(V->getSCEVType())) {
5638     case scCouldNotCompute:
5639     case scAddRecExpr:
5640       break;
5641     case scConstant:
5642       return cast<SCEVConstant>(V)->getValue();
5643     case scUnknown:
5644       return dyn_cast<Constant>(cast<SCEVUnknown>(V)->getValue());
5645     case scSignExtend: {
5646       const SCEVSignExtendExpr *SS = cast<SCEVSignExtendExpr>(V);
5647       if (Constant *CastOp = BuildConstantFromSCEV(SS->getOperand()))
5648         return ConstantExpr::getSExt(CastOp, SS->getType());
5649       break;
5650     }
5651     case scZeroExtend: {
5652       const SCEVZeroExtendExpr *SZ = cast<SCEVZeroExtendExpr>(V);
5653       if (Constant *CastOp = BuildConstantFromSCEV(SZ->getOperand()))
5654         return ConstantExpr::getZExt(CastOp, SZ->getType());
5655       break;
5656     }
5657     case scTruncate: {
5658       const SCEVTruncateExpr *ST = cast<SCEVTruncateExpr>(V);
5659       if (Constant *CastOp = BuildConstantFromSCEV(ST->getOperand()))
5660         return ConstantExpr::getTrunc(CastOp, ST->getType());
5661       break;
5662     }
5663     case scAddExpr: {
5664       const SCEVAddExpr *SA = cast<SCEVAddExpr>(V);
5665       if (Constant *C = BuildConstantFromSCEV(SA->getOperand(0))) {
5666         if (PointerType *PTy = dyn_cast<PointerType>(C->getType())) {
5667           unsigned AS = PTy->getAddressSpace();
5668           Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS);
5669           C = ConstantExpr::getBitCast(C, DestPtrTy);
5670         }
5671         for (unsigned i = 1, e = SA->getNumOperands(); i != e; ++i) {
5672           Constant *C2 = BuildConstantFromSCEV(SA->getOperand(i));
5673           if (!C2) return nullptr;
5674
5675           // First pointer!
5676           if (!C->getType()->isPointerTy() && C2->getType()->isPointerTy()) {
5677             unsigned AS = C2->getType()->getPointerAddressSpace();
5678             std::swap(C, C2);
5679             Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS);
5680             // The offsets have been converted to bytes.  We can add bytes to an
5681             // i8* by GEP with the byte count in the first index.
5682             C = ConstantExpr::getBitCast(C, DestPtrTy);
5683           }
5684
5685           // Don't bother trying to sum two pointers. We probably can't
5686           // statically compute a load that results from it anyway.
5687           if (C2->getType()->isPointerTy())
5688             return nullptr;
5689
5690           if (PointerType *PTy = dyn_cast<PointerType>(C->getType())) {
5691             if (PTy->getElementType()->isStructTy())
5692               C2 = ConstantExpr::getIntegerCast(
5693                   C2, Type::getInt32Ty(C->getContext()), true);
5694             C = ConstantExpr::getGetElementPtr(C, C2);
5695           } else
5696             C = ConstantExpr::getAdd(C, C2);
5697         }
5698         return C;
5699       }
5700       break;
5701     }
5702     case scMulExpr: {
5703       const SCEVMulExpr *SM = cast<SCEVMulExpr>(V);
5704       if (Constant *C = BuildConstantFromSCEV(SM->getOperand(0))) {
5705         // Don't bother with pointers at all.
5706         if (C->getType()->isPointerTy()) return nullptr;
5707         for (unsigned i = 1, e = SM->getNumOperands(); i != e; ++i) {
5708           Constant *C2 = BuildConstantFromSCEV(SM->getOperand(i));
5709           if (!C2 || C2->getType()->isPointerTy()) return nullptr;
5710           C = ConstantExpr::getMul(C, C2);
5711         }
5712         return C;
5713       }
5714       break;
5715     }
5716     case scUDivExpr: {
5717       const SCEVUDivExpr *SU = cast<SCEVUDivExpr>(V);
5718       if (Constant *LHS = BuildConstantFromSCEV(SU->getLHS()))
5719         if (Constant *RHS = BuildConstantFromSCEV(SU->getRHS()))
5720           if (LHS->getType() == RHS->getType())
5721             return ConstantExpr::getUDiv(LHS, RHS);
5722       break;
5723     }
5724     case scSMaxExpr:
5725     case scUMaxExpr:
5726       break; // TODO: smax, umax.
5727   }
5728   return nullptr;
5729 }
5730
5731 const SCEV *ScalarEvolution::computeSCEVAtScope(const SCEV *V, const Loop *L) {
5732   if (isa<SCEVConstant>(V)) return V;
5733
5734   // If this instruction is evolved from a constant-evolving PHI, compute the
5735   // exit value from the loop without using SCEVs.
5736   if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V)) {
5737     if (Instruction *I = dyn_cast<Instruction>(SU->getValue())) {
5738       const Loop *LI = (*this->LI)[I->getParent()];
5739       if (LI && LI->getParentLoop() == L)  // Looking for loop exit value.
5740         if (PHINode *PN = dyn_cast<PHINode>(I))
5741           if (PN->getParent() == LI->getHeader()) {
5742             // Okay, there is no closed form solution for the PHI node.  Check
5743             // to see if the loop that contains it has a known backedge-taken
5744             // count.  If so, we may be able to force computation of the exit
5745             // value.
5746             const SCEV *BackedgeTakenCount = getBackedgeTakenCount(LI);
5747             if (const SCEVConstant *BTCC =
5748                   dyn_cast<SCEVConstant>(BackedgeTakenCount)) {
5749               // Okay, we know how many times the containing loop executes.  If
5750               // this is a constant evolving PHI node, get the final value at
5751               // the specified iteration number.
5752               Constant *RV = getConstantEvolutionLoopExitValue(PN,
5753                                                    BTCC->getValue()->getValue(),
5754                                                                LI);
5755               if (RV) return getSCEV(RV);
5756             }
5757           }
5758
5759       // Okay, this is an expression that we cannot symbolically evaluate
5760       // into a SCEV.  Check to see if it's possible to symbolically evaluate
5761       // the arguments into constants, and if so, try to constant propagate the
5762       // result.  This is particularly useful for computing loop exit values.
5763       if (CanConstantFold(I)) {
5764         SmallVector<Constant *, 4> Operands;
5765         bool MadeImprovement = false;
5766         for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
5767           Value *Op = I->getOperand(i);
5768           if (Constant *C = dyn_cast<Constant>(Op)) {
5769             Operands.push_back(C);
5770             continue;
5771           }
5772
5773           // If any of the operands is non-constant and if they are
5774           // non-integer and non-pointer, don't even try to analyze them
5775           // with scev techniques.
5776           if (!isSCEVable(Op->getType()))
5777             return V;
5778
5779           const SCEV *OrigV = getSCEV(Op);
5780           const SCEV *OpV = getSCEVAtScope(OrigV, L);
5781           MadeImprovement |= OrigV != OpV;
5782
5783           Constant *C = BuildConstantFromSCEV(OpV);
5784           if (!C) return V;
5785           if (C->getType() != Op->getType())
5786             C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
5787                                                               Op->getType(),
5788                                                               false),
5789                                       C, Op->getType());
5790           Operands.push_back(C);
5791         }
5792
5793         // Check to see if getSCEVAtScope actually made an improvement.
5794         if (MadeImprovement) {
5795           Constant *C = nullptr;
5796           const DataLayout &DL = F->getParent()->getDataLayout();
5797           if (const CmpInst *CI = dyn_cast<CmpInst>(I))
5798             C = ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0],
5799                                                 Operands[1], DL, TLI);
5800           else if (const LoadInst *LI = dyn_cast<LoadInst>(I)) {
5801             if (!LI->isVolatile())
5802               C = ConstantFoldLoadFromConstPtr(Operands[0], DL);
5803           } else
5804             C = ConstantFoldInstOperands(I->getOpcode(), I->getType(), Operands,
5805                                          DL, TLI);
5806           if (!C) return V;
5807           return getSCEV(C);
5808         }
5809       }
5810     }
5811
5812     // This is some other type of SCEVUnknown, just return it.
5813     return V;
5814   }
5815
5816   if (const SCEVCommutativeExpr *Comm = dyn_cast<SCEVCommutativeExpr>(V)) {
5817     // Avoid performing the look-up in the common case where the specified
5818     // expression has no loop-variant portions.
5819     for (unsigned i = 0, e = Comm->getNumOperands(); i != e; ++i) {
5820       const SCEV *OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
5821       if (OpAtScope != Comm->getOperand(i)) {
5822         // Okay, at least one of these operands is loop variant but might be
5823         // foldable.  Build a new instance of the folded commutative expression.
5824         SmallVector<const SCEV *, 8> NewOps(Comm->op_begin(),
5825                                             Comm->op_begin()+i);
5826         NewOps.push_back(OpAtScope);
5827
5828         for (++i; i != e; ++i) {
5829           OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
5830           NewOps.push_back(OpAtScope);
5831         }
5832         if (isa<SCEVAddExpr>(Comm))
5833           return getAddExpr(NewOps);
5834         if (isa<SCEVMulExpr>(Comm))
5835           return getMulExpr(NewOps);
5836         if (isa<SCEVSMaxExpr>(Comm))
5837           return getSMaxExpr(NewOps);
5838         if (isa<SCEVUMaxExpr>(Comm))
5839           return getUMaxExpr(NewOps);
5840         llvm_unreachable("Unknown commutative SCEV type!");
5841       }
5842     }
5843     // If we got here, all operands are loop invariant.
5844     return Comm;
5845   }
5846
5847   if (const SCEVUDivExpr *Div = dyn_cast<SCEVUDivExpr>(V)) {
5848     const SCEV *LHS = getSCEVAtScope(Div->getLHS(), L);
5849     const SCEV *RHS = getSCEVAtScope(Div->getRHS(), L);
5850     if (LHS == Div->getLHS() && RHS == Div->getRHS())
5851       return Div;   // must be loop invariant
5852     return getUDivExpr(LHS, RHS);
5853   }
5854
5855   // If this is a loop recurrence for a loop that does not contain L, then we
5856   // are dealing with the final value computed by the loop.
5857   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V)) {
5858     // First, attempt to evaluate each operand.
5859     // Avoid performing the look-up in the common case where the specified
5860     // expression has no loop-variant portions.
5861     for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
5862       const SCEV *OpAtScope = getSCEVAtScope(AddRec->getOperand(i), L);
5863       if (OpAtScope == AddRec->getOperand(i))
5864         continue;
5865
5866       // Okay, at least one of these operands is loop variant but might be
5867       // foldable.  Build a new instance of the folded commutative expression.
5868       SmallVector<const SCEV *, 8> NewOps(AddRec->op_begin(),
5869                                           AddRec->op_begin()+i);
5870       NewOps.push_back(OpAtScope);
5871       for (++i; i != e; ++i)
5872         NewOps.push_back(getSCEVAtScope(AddRec->getOperand(i), L));
5873
5874       const SCEV *FoldedRec =
5875         getAddRecExpr(NewOps, AddRec->getLoop(),
5876                       AddRec->getNoWrapFlags(SCEV::FlagNW));
5877       AddRec = dyn_cast<SCEVAddRecExpr>(FoldedRec);
5878       // The addrec may be folded to a nonrecurrence, for example, if the
5879       // induction variable is multiplied by zero after constant folding. Go
5880       // ahead and return the folded value.
5881       if (!AddRec)
5882         return FoldedRec;
5883       break;
5884     }
5885
5886     // If the scope is outside the addrec's loop, evaluate it by using the
5887     // loop exit value of the addrec.
5888     if (!AddRec->getLoop()->contains(L)) {
5889       // To evaluate this recurrence, we need to know how many times the AddRec
5890       // loop iterates.  Compute this now.
5891       const SCEV *BackedgeTakenCount = getBackedgeTakenCount(AddRec->getLoop());
5892       if (BackedgeTakenCount == getCouldNotCompute()) return AddRec;
5893
5894       // Then, evaluate the AddRec.
5895       return AddRec->evaluateAtIteration(BackedgeTakenCount, *this);
5896     }
5897
5898     return AddRec;
5899   }
5900
5901   if (const SCEVZeroExtendExpr *Cast = dyn_cast<SCEVZeroExtendExpr>(V)) {
5902     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
5903     if (Op == Cast->getOperand())
5904       return Cast;  // must be loop invariant
5905     return getZeroExtendExpr(Op, Cast->getType());
5906   }
5907
5908   if (const SCEVSignExtendExpr *Cast = dyn_cast<SCEVSignExtendExpr>(V)) {
5909     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
5910     if (Op == Cast->getOperand())
5911       return Cast;  // must be loop invariant
5912     return getSignExtendExpr(Op, Cast->getType());
5913   }
5914
5915   if (const SCEVTruncateExpr *Cast = dyn_cast<SCEVTruncateExpr>(V)) {
5916     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
5917     if (Op == Cast->getOperand())
5918       return Cast;  // must be loop invariant
5919     return getTruncateExpr(Op, Cast->getType());
5920   }
5921
5922   llvm_unreachable("Unknown SCEV type!");
5923 }
5924
5925 /// getSCEVAtScope - This is a convenience function which does
5926 /// getSCEVAtScope(getSCEV(V), L).
5927 const SCEV *ScalarEvolution::getSCEVAtScope(Value *V, const Loop *L) {
5928   return getSCEVAtScope(getSCEV(V), L);
5929 }
5930
5931 /// SolveLinEquationWithOverflow - Finds the minimum unsigned root of the
5932 /// following equation:
5933 ///
5934 ///     A * X = B (mod N)
5935 ///
5936 /// where N = 2^BW and BW is the common bit width of A and B. The signedness of
5937 /// A and B isn't important.
5938 ///
5939 /// If the equation does not have a solution, SCEVCouldNotCompute is returned.
5940 static const SCEV *SolveLinEquationWithOverflow(const APInt &A, const APInt &B,
5941                                                ScalarEvolution &SE) {
5942   uint32_t BW = A.getBitWidth();
5943   assert(BW == B.getBitWidth() && "Bit widths must be the same.");
5944   assert(A != 0 && "A must be non-zero.");
5945
5946   // 1. D = gcd(A, N)
5947   //
5948   // The gcd of A and N may have only one prime factor: 2. The number of
5949   // trailing zeros in A is its multiplicity
5950   uint32_t Mult2 = A.countTrailingZeros();
5951   // D = 2^Mult2
5952
5953   // 2. Check if B is divisible by D.
5954   //
5955   // B is divisible by D if and only if the multiplicity of prime factor 2 for B
5956   // is not less than multiplicity of this prime factor for D.
5957   if (B.countTrailingZeros() < Mult2)
5958     return SE.getCouldNotCompute();
5959
5960   // 3. Compute I: the multiplicative inverse of (A / D) in arithmetic
5961   // modulo (N / D).
5962   //
5963   // (N / D) may need BW+1 bits in its representation.  Hence, we'll use this
5964   // bit width during computations.
5965   APInt AD = A.lshr(Mult2).zext(BW + 1);  // AD = A / D
5966   APInt Mod(BW + 1, 0);
5967   Mod.setBit(BW - Mult2);  // Mod = N / D
5968   APInt I = AD.multiplicativeInverse(Mod);
5969
5970   // 4. Compute the minimum unsigned root of the equation:
5971   // I * (B / D) mod (N / D)
5972   APInt Result = (I * B.lshr(Mult2).zext(BW + 1)).urem(Mod);
5973
5974   // The result is guaranteed to be less than 2^BW so we may truncate it to BW
5975   // bits.
5976   return SE.getConstant(Result.trunc(BW));
5977 }
5978
5979 /// SolveQuadraticEquation - Find the roots of the quadratic equation for the
5980 /// given quadratic chrec {L,+,M,+,N}.  This returns either the two roots (which
5981 /// might be the same) or two SCEVCouldNotCompute objects.
5982 ///
5983 static std::pair<const SCEV *,const SCEV *>
5984 SolveQuadraticEquation(const SCEVAddRecExpr *AddRec, ScalarEvolution &SE) {
5985   assert(AddRec->getNumOperands() == 3 && "This is not a quadratic chrec!");
5986   const SCEVConstant *LC = dyn_cast<SCEVConstant>(AddRec->getOperand(0));
5987   const SCEVConstant *MC = dyn_cast<SCEVConstant>(AddRec->getOperand(1));
5988   const SCEVConstant *NC = dyn_cast<SCEVConstant>(AddRec->getOperand(2));
5989
5990   // We currently can only solve this if the coefficients are constants.
5991   if (!LC || !MC || !NC) {
5992     const SCEV *CNC = SE.getCouldNotCompute();
5993     return std::make_pair(CNC, CNC);
5994   }
5995
5996   uint32_t BitWidth = LC->getValue()->getValue().getBitWidth();
5997   const APInt &L = LC->getValue()->getValue();
5998   const APInt &M = MC->getValue()->getValue();
5999   const APInt &N = NC->getValue()->getValue();
6000   APInt Two(BitWidth, 2);
6001   APInt Four(BitWidth, 4);
6002
6003   {
6004     using namespace APIntOps;
6005     const APInt& C = L;
6006     // Convert from chrec coefficients to polynomial coefficients AX^2+BX+C
6007     // The B coefficient is M-N/2
6008     APInt B(M);
6009     B -= sdiv(N,Two);
6010
6011     // The A coefficient is N/2
6012     APInt A(N.sdiv(Two));
6013
6014     // Compute the B^2-4ac term.
6015     APInt SqrtTerm(B);
6016     SqrtTerm *= B;
6017     SqrtTerm -= Four * (A * C);
6018
6019     if (SqrtTerm.isNegative()) {
6020       // The loop is provably infinite.
6021       const SCEV *CNC = SE.getCouldNotCompute();
6022       return std::make_pair(CNC, CNC);
6023     }
6024
6025     // Compute sqrt(B^2-4ac). This is guaranteed to be the nearest
6026     // integer value or else APInt::sqrt() will assert.
6027     APInt SqrtVal(SqrtTerm.sqrt());
6028
6029     // Compute the two solutions for the quadratic formula.
6030     // The divisions must be performed as signed divisions.
6031     APInt NegB(-B);
6032     APInt TwoA(A << 1);
6033     if (TwoA.isMinValue()) {
6034       const SCEV *CNC = SE.getCouldNotCompute();
6035       return std::make_pair(CNC, CNC);
6036     }
6037
6038     LLVMContext &Context = SE.getContext();
6039
6040     ConstantInt *Solution1 =
6041       ConstantInt::get(Context, (NegB + SqrtVal).sdiv(TwoA));
6042     ConstantInt *Solution2 =
6043       ConstantInt::get(Context, (NegB - SqrtVal).sdiv(TwoA));
6044
6045     return std::make_pair(SE.getConstant(Solution1),
6046                           SE.getConstant(Solution2));
6047   } // end APIntOps namespace
6048 }
6049
6050 /// HowFarToZero - Return the number of times a backedge comparing the specified
6051 /// value to zero will execute.  If not computable, return CouldNotCompute.
6052 ///
6053 /// This is only used for loops with a "x != y" exit test. The exit condition is
6054 /// now expressed as a single expression, V = x-y. So the exit test is
6055 /// effectively V != 0.  We know and take advantage of the fact that this
6056 /// expression only being used in a comparison by zero context.
6057 ScalarEvolution::ExitLimit
6058 ScalarEvolution::HowFarToZero(const SCEV *V, const Loop *L, bool ControlsExit) {
6059   // If the value is a constant
6060   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
6061     // If the value is already zero, the branch will execute zero times.
6062     if (C->getValue()->isZero()) return C;
6063     return getCouldNotCompute();  // Otherwise it will loop infinitely.
6064   }
6065
6066   const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V);
6067   if (!AddRec || AddRec->getLoop() != L)
6068     return getCouldNotCompute();
6069
6070   // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of
6071   // the quadratic equation to solve it.
6072   if (AddRec->isQuadratic() && AddRec->getType()->isIntegerTy()) {
6073     std::pair<const SCEV *,const SCEV *> Roots =
6074       SolveQuadraticEquation(AddRec, *this);
6075     const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
6076     const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
6077     if (R1 && R2) {
6078 #if 0
6079       dbgs() << "HFTZ: " << *V << " - sol#1: " << *R1
6080              << "  sol#2: " << *R2 << "\n";
6081 #endif
6082       // Pick the smallest positive root value.
6083       if (ConstantInt *CB =
6084           dyn_cast<ConstantInt>(ConstantExpr::getICmp(CmpInst::ICMP_ULT,
6085                                                       R1->getValue(),
6086                                                       R2->getValue()))) {
6087         if (!CB->getZExtValue())
6088           std::swap(R1, R2);   // R1 is the minimum root now.
6089
6090         // We can only use this value if the chrec ends up with an exact zero
6091         // value at this index.  When solving for "X*X != 5", for example, we
6092         // should not accept a root of 2.
6093         const SCEV *Val = AddRec->evaluateAtIteration(R1, *this);
6094         if (Val->isZero())
6095           return R1;  // We found a quadratic root!
6096       }
6097     }
6098     return getCouldNotCompute();
6099   }
6100
6101   // Otherwise we can only handle this if it is affine.
6102   if (!AddRec->isAffine())
6103     return getCouldNotCompute();
6104
6105   // If this is an affine expression, the execution count of this branch is
6106   // the minimum unsigned root of the following equation:
6107   //
6108   //     Start + Step*N = 0 (mod 2^BW)
6109   //
6110   // equivalent to:
6111   //
6112   //             Step*N = -Start (mod 2^BW)
6113   //
6114   // where BW is the common bit width of Start and Step.
6115
6116   // Get the initial value for the loop.
6117   const SCEV *Start = getSCEVAtScope(AddRec->getStart(), L->getParentLoop());
6118   const SCEV *Step = getSCEVAtScope(AddRec->getOperand(1), L->getParentLoop());
6119
6120   // For now we handle only constant steps.
6121   //
6122   // TODO: Handle a nonconstant Step given AddRec<NUW>. If the
6123   // AddRec is NUW, then (in an unsigned sense) it cannot be counting up to wrap
6124   // to 0, it must be counting down to equal 0. Consequently, N = Start / -Step.
6125   // We have not yet seen any such cases.
6126   const SCEVConstant *StepC = dyn_cast<SCEVConstant>(Step);
6127   if (!StepC || StepC->getValue()->equalsInt(0))
6128     return getCouldNotCompute();
6129
6130   // For positive steps (counting up until unsigned overflow):
6131   //   N = -Start/Step (as unsigned)
6132   // For negative steps (counting down to zero):
6133   //   N = Start/-Step
6134   // First compute the unsigned distance from zero in the direction of Step.
6135   bool CountDown = StepC->getValue()->getValue().isNegative();
6136   const SCEV *Distance = CountDown ? Start : getNegativeSCEV(Start);
6137
6138   // Handle unitary steps, which cannot wraparound.
6139   // 1*N = -Start; -1*N = Start (mod 2^BW), so:
6140   //   N = Distance (as unsigned)
6141   if (StepC->getValue()->equalsInt(1) || StepC->getValue()->isAllOnesValue()) {
6142     ConstantRange CR = getUnsignedRange(Start);
6143     const SCEV *MaxBECount;
6144     if (!CountDown && CR.getUnsignedMin().isMinValue())
6145       // When counting up, the worst starting value is 1, not 0.
6146       MaxBECount = CR.getUnsignedMax().isMinValue()
6147         ? getConstant(APInt::getMinValue(CR.getBitWidth()))
6148         : getConstant(APInt::getMaxValue(CR.getBitWidth()));
6149     else
6150       MaxBECount = getConstant(CountDown ? CR.getUnsignedMax()
6151                                          : -CR.getUnsignedMin());
6152     return ExitLimit(Distance, MaxBECount);
6153   }
6154
6155   // As a special case, handle the instance where Step is a positive power of
6156   // two. In this case, determining whether Step divides Distance evenly can be
6157   // done by counting and comparing the number of trailing zeros of Step and
6158   // Distance.
6159   if (!CountDown) {
6160     const APInt &StepV = StepC->getValue()->getValue();
6161     // StepV.isPowerOf2() returns true if StepV is an positive power of two.  It
6162     // also returns true if StepV is maximally negative (eg, INT_MIN), but that
6163     // case is not handled as this code is guarded by !CountDown.
6164     if (StepV.isPowerOf2() &&
6165         GetMinTrailingZeros(Distance) >= StepV.countTrailingZeros())
6166       return getUDivExactExpr(Distance, Step);
6167   }
6168
6169   // If the condition controls loop exit (the loop exits only if the expression
6170   // is true) and the addition is no-wrap we can use unsigned divide to
6171   // compute the backedge count.  In this case, the step may not divide the
6172   // distance, but we don't care because if the condition is "missed" the loop
6173   // will have undefined behavior due to wrapping.
6174   if (ControlsExit && AddRec->getNoWrapFlags(SCEV::FlagNW)) {
6175     const SCEV *Exact =
6176         getUDivExpr(Distance, CountDown ? getNegativeSCEV(Step) : Step);
6177     return ExitLimit(Exact, Exact);
6178   }
6179
6180   // Then, try to solve the above equation provided that Start is constant.
6181   if (const SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start))
6182     return SolveLinEquationWithOverflow(StepC->getValue()->getValue(),
6183                                         -StartC->getValue()->getValue(),
6184                                         *this);
6185   return getCouldNotCompute();
6186 }
6187
6188 /// HowFarToNonZero - Return the number of times a backedge checking the
6189 /// specified value for nonzero will execute.  If not computable, return
6190 /// CouldNotCompute
6191 ScalarEvolution::ExitLimit
6192 ScalarEvolution::HowFarToNonZero(const SCEV *V, const Loop *L) {
6193   // Loops that look like: while (X == 0) are very strange indeed.  We don't
6194   // handle them yet except for the trivial case.  This could be expanded in the
6195   // future as needed.
6196
6197   // If the value is a constant, check to see if it is known to be non-zero
6198   // already.  If so, the backedge will execute zero times.
6199   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
6200     if (!C->getValue()->isNullValue())
6201       return getConstant(C->getType(), 0);
6202     return getCouldNotCompute();  // Otherwise it will loop infinitely.
6203   }
6204
6205   // We could implement others, but I really doubt anyone writes loops like
6206   // this, and if they did, they would already be constant folded.
6207   return getCouldNotCompute();
6208 }
6209
6210 /// getPredecessorWithUniqueSuccessorForBB - Return a predecessor of BB
6211 /// (which may not be an immediate predecessor) which has exactly one
6212 /// successor from which BB is reachable, or null if no such block is
6213 /// found.
6214 ///
6215 std::pair<BasicBlock *, BasicBlock *>
6216 ScalarEvolution::getPredecessorWithUniqueSuccessorForBB(BasicBlock *BB) {
6217   // If the block has a unique predecessor, then there is no path from the
6218   // predecessor to the block that does not go through the direct edge
6219   // from the predecessor to the block.
6220   if (BasicBlock *Pred = BB->getSinglePredecessor())
6221     return std::make_pair(Pred, BB);
6222
6223   // A loop's header is defined to be a block that dominates the loop.
6224   // If the header has a unique predecessor outside the loop, it must be
6225   // a block that has exactly one successor that can reach the loop.
6226   if (Loop *L = LI->getLoopFor(BB))
6227     return std::make_pair(L->getLoopPredecessor(), L->getHeader());
6228
6229   return std::pair<BasicBlock *, BasicBlock *>();
6230 }
6231
6232 /// HasSameValue - SCEV structural equivalence is usually sufficient for
6233 /// testing whether two expressions are equal, however for the purposes of
6234 /// looking for a condition guarding a loop, it can be useful to be a little
6235 /// more general, since a front-end may have replicated the controlling
6236 /// expression.
6237 ///
6238 static bool HasSameValue(const SCEV *A, const SCEV *B) {
6239   // Quick check to see if they are the same SCEV.
6240   if (A == B) return true;
6241
6242   // Otherwise, if they're both SCEVUnknown, it's possible that they hold
6243   // two different instructions with the same value. Check for this case.
6244   if (const SCEVUnknown *AU = dyn_cast<SCEVUnknown>(A))
6245     if (const SCEVUnknown *BU = dyn_cast<SCEVUnknown>(B))
6246       if (const Instruction *AI = dyn_cast<Instruction>(AU->getValue()))
6247         if (const Instruction *BI = dyn_cast<Instruction>(BU->getValue()))
6248           if (AI->isIdenticalTo(BI) && !AI->mayReadFromMemory())
6249             return true;
6250
6251   // Otherwise assume they may have a different value.
6252   return false;
6253 }
6254
6255 /// SimplifyICmpOperands - Simplify LHS and RHS in a comparison with
6256 /// predicate Pred. Return true iff any changes were made.
6257 ///
6258 bool ScalarEvolution::SimplifyICmpOperands(ICmpInst::Predicate &Pred,
6259                                            const SCEV *&LHS, const SCEV *&RHS,
6260                                            unsigned Depth) {
6261   bool Changed = false;
6262
6263   // If we hit the max recursion limit bail out.
6264   if (Depth >= 3)
6265     return false;
6266
6267   // Canonicalize a constant to the right side.
6268   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
6269     // Check for both operands constant.
6270     if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
6271       if (ConstantExpr::getICmp(Pred,
6272                                 LHSC->getValue(),
6273                                 RHSC->getValue())->isNullValue())
6274         goto trivially_false;
6275       else
6276         goto trivially_true;
6277     }
6278     // Otherwise swap the operands to put the constant on the right.
6279     std::swap(LHS, RHS);
6280     Pred = ICmpInst::getSwappedPredicate(Pred);
6281     Changed = true;
6282   }
6283
6284   // If we're comparing an addrec with a value which is loop-invariant in the
6285   // addrec's loop, put the addrec on the left. Also make a dominance check,
6286   // as both operands could be addrecs loop-invariant in each other's loop.
6287   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS)) {
6288     const Loop *L = AR->getLoop();
6289     if (isLoopInvariant(LHS, L) && properlyDominates(LHS, L->getHeader())) {
6290       std::swap(LHS, RHS);
6291       Pred = ICmpInst::getSwappedPredicate(Pred);
6292       Changed = true;
6293     }
6294   }
6295
6296   // If there's a constant operand, canonicalize comparisons with boundary
6297   // cases, and canonicalize *-or-equal comparisons to regular comparisons.
6298   if (const SCEVConstant *RC = dyn_cast<SCEVConstant>(RHS)) {
6299     const APInt &RA = RC->getValue()->getValue();
6300     switch (Pred) {
6301     default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
6302     case ICmpInst::ICMP_EQ:
6303     case ICmpInst::ICMP_NE:
6304       // Fold ((-1) * %a) + %b == 0 (equivalent to %b-%a == 0) into %a == %b.
6305       if (!RA)
6306         if (const SCEVAddExpr *AE = dyn_cast<SCEVAddExpr>(LHS))
6307           if (const SCEVMulExpr *ME = dyn_cast<SCEVMulExpr>(AE->getOperand(0)))
6308             if (AE->getNumOperands() == 2 && ME->getNumOperands() == 2 &&
6309                 ME->getOperand(0)->isAllOnesValue()) {
6310               RHS = AE->getOperand(1);
6311               LHS = ME->getOperand(1);
6312               Changed = true;
6313             }
6314       break;
6315     case ICmpInst::ICMP_UGE:
6316       if ((RA - 1).isMinValue()) {
6317         Pred = ICmpInst::ICMP_NE;
6318         RHS = getConstant(RA - 1);
6319         Changed = true;
6320         break;
6321       }
6322       if (RA.isMaxValue()) {
6323         Pred = ICmpInst::ICMP_EQ;
6324         Changed = true;
6325         break;
6326       }
6327       if (RA.isMinValue()) goto trivially_true;
6328
6329       Pred = ICmpInst::ICMP_UGT;
6330       RHS = getConstant(RA - 1);
6331       Changed = true;
6332       break;
6333     case ICmpInst::ICMP_ULE:
6334       if ((RA + 1).isMaxValue()) {
6335         Pred = ICmpInst::ICMP_NE;
6336         RHS = getConstant(RA + 1);
6337         Changed = true;
6338         break;
6339       }
6340       if (RA.isMinValue()) {
6341         Pred = ICmpInst::ICMP_EQ;
6342         Changed = true;
6343         break;
6344       }
6345       if (RA.isMaxValue()) goto trivially_true;
6346
6347       Pred = ICmpInst::ICMP_ULT;
6348       RHS = getConstant(RA + 1);
6349       Changed = true;
6350       break;
6351     case ICmpInst::ICMP_SGE:
6352       if ((RA - 1).isMinSignedValue()) {
6353         Pred = ICmpInst::ICMP_NE;
6354         RHS = getConstant(RA - 1);
6355         Changed = true;
6356         break;
6357       }
6358       if (RA.isMaxSignedValue()) {
6359         Pred = ICmpInst::ICMP_EQ;
6360         Changed = true;
6361         break;
6362       }
6363       if (RA.isMinSignedValue()) goto trivially_true;
6364
6365       Pred = ICmpInst::ICMP_SGT;
6366       RHS = getConstant(RA - 1);
6367       Changed = true;
6368       break;
6369     case ICmpInst::ICMP_SLE:
6370       if ((RA + 1).isMaxSignedValue()) {
6371         Pred = ICmpInst::ICMP_NE;
6372         RHS = getConstant(RA + 1);
6373         Changed = true;
6374         break;
6375       }
6376       if (RA.isMinSignedValue()) {
6377         Pred = ICmpInst::ICMP_EQ;
6378         Changed = true;
6379         break;
6380       }
6381       if (RA.isMaxSignedValue()) goto trivially_true;
6382
6383       Pred = ICmpInst::ICMP_SLT;
6384       RHS = getConstant(RA + 1);
6385       Changed = true;
6386       break;
6387     case ICmpInst::ICMP_UGT:
6388       if (RA.isMinValue()) {
6389         Pred = ICmpInst::ICMP_NE;
6390         Changed = true;
6391         break;
6392       }
6393       if ((RA + 1).isMaxValue()) {
6394         Pred = ICmpInst::ICMP_EQ;
6395         RHS = getConstant(RA + 1);
6396         Changed = true;
6397         break;
6398       }
6399       if (RA.isMaxValue()) goto trivially_false;
6400       break;
6401     case ICmpInst::ICMP_ULT:
6402       if (RA.isMaxValue()) {
6403         Pred = ICmpInst::ICMP_NE;
6404         Changed = true;
6405         break;
6406       }
6407       if ((RA - 1).isMinValue()) {
6408         Pred = ICmpInst::ICMP_EQ;
6409         RHS = getConstant(RA - 1);
6410         Changed = true;
6411         break;
6412       }
6413       if (RA.isMinValue()) goto trivially_false;
6414       break;
6415     case ICmpInst::ICMP_SGT:
6416       if (RA.isMinSignedValue()) {
6417         Pred = ICmpInst::ICMP_NE;
6418         Changed = true;
6419         break;
6420       }
6421       if ((RA + 1).isMaxSignedValue()) {
6422         Pred = ICmpInst::ICMP_EQ;
6423         RHS = getConstant(RA + 1);
6424         Changed = true;
6425         break;
6426       }
6427       if (RA.isMaxSignedValue()) goto trivially_false;
6428       break;
6429     case ICmpInst::ICMP_SLT:
6430       if (RA.isMaxSignedValue()) {
6431         Pred = ICmpInst::ICMP_NE;
6432         Changed = true;
6433         break;
6434       }
6435       if ((RA - 1).isMinSignedValue()) {
6436        Pred = ICmpInst::ICMP_EQ;
6437        RHS = getConstant(RA - 1);
6438         Changed = true;
6439        break;
6440       }
6441       if (RA.isMinSignedValue()) goto trivially_false;
6442       break;
6443     }
6444   }
6445
6446   // Check for obvious equality.
6447   if (HasSameValue(LHS, RHS)) {
6448     if (ICmpInst::isTrueWhenEqual(Pred))
6449       goto trivially_true;
6450     if (ICmpInst::isFalseWhenEqual(Pred))
6451       goto trivially_false;
6452   }
6453
6454   // If possible, canonicalize GE/LE comparisons to GT/LT comparisons, by
6455   // adding or subtracting 1 from one of the operands.
6456   switch (Pred) {
6457   case ICmpInst::ICMP_SLE:
6458     if (!getSignedRange(RHS).getSignedMax().isMaxSignedValue()) {
6459       RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
6460                        SCEV::FlagNSW);
6461       Pred = ICmpInst::ICMP_SLT;
6462       Changed = true;
6463     } else if (!getSignedRange(LHS).getSignedMin().isMinSignedValue()) {
6464       LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
6465                        SCEV::FlagNSW);
6466       Pred = ICmpInst::ICMP_SLT;
6467       Changed = true;
6468     }
6469     break;
6470   case ICmpInst::ICMP_SGE:
6471     if (!getSignedRange(RHS).getSignedMin().isMinSignedValue()) {
6472       RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
6473                        SCEV::FlagNSW);
6474       Pred = ICmpInst::ICMP_SGT;
6475       Changed = true;
6476     } else if (!getSignedRange(LHS).getSignedMax().isMaxSignedValue()) {
6477       LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
6478                        SCEV::FlagNSW);
6479       Pred = ICmpInst::ICMP_SGT;
6480       Changed = true;
6481     }
6482     break;
6483   case ICmpInst::ICMP_ULE:
6484     if (!getUnsignedRange(RHS).getUnsignedMax().isMaxValue()) {
6485       RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
6486                        SCEV::FlagNUW);
6487       Pred = ICmpInst::ICMP_ULT;
6488       Changed = true;
6489     } else if (!getUnsignedRange(LHS).getUnsignedMin().isMinValue()) {
6490       LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
6491                        SCEV::FlagNUW);
6492       Pred = ICmpInst::ICMP_ULT;
6493       Changed = true;
6494     }
6495     break;
6496   case ICmpInst::ICMP_UGE:
6497     if (!getUnsignedRange(RHS).getUnsignedMin().isMinValue()) {
6498       RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
6499                        SCEV::FlagNUW);
6500       Pred = ICmpInst::ICMP_UGT;
6501       Changed = true;
6502     } else if (!getUnsignedRange(LHS).getUnsignedMax().isMaxValue()) {
6503       LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
6504                        SCEV::FlagNUW);
6505       Pred = ICmpInst::ICMP_UGT;
6506       Changed = true;
6507     }
6508     break;
6509   default:
6510     break;
6511   }
6512
6513   // TODO: More simplifications are possible here.
6514
6515   // Recursively simplify until we either hit a recursion limit or nothing
6516   // changes.
6517   if (Changed)
6518     return SimplifyICmpOperands(Pred, LHS, RHS, Depth+1);
6519
6520   return Changed;
6521
6522 trivially_true:
6523   // Return 0 == 0.
6524   LHS = RHS = getConstant(ConstantInt::getFalse(getContext()));
6525   Pred = ICmpInst::ICMP_EQ;
6526   return true;
6527
6528 trivially_false:
6529   // Return 0 != 0.
6530   LHS = RHS = getConstant(ConstantInt::getFalse(getContext()));
6531   Pred = ICmpInst::ICMP_NE;
6532   return true;
6533 }
6534
6535 bool ScalarEvolution::isKnownNegative(const SCEV *S) {
6536   return getSignedRange(S).getSignedMax().isNegative();
6537 }
6538
6539 bool ScalarEvolution::isKnownPositive(const SCEV *S) {
6540   return getSignedRange(S).getSignedMin().isStrictlyPositive();
6541 }
6542
6543 bool ScalarEvolution::isKnownNonNegative(const SCEV *S) {
6544   return !getSignedRange(S).getSignedMin().isNegative();
6545 }
6546
6547 bool ScalarEvolution::isKnownNonPositive(const SCEV *S) {
6548   return !getSignedRange(S).getSignedMax().isStrictlyPositive();
6549 }
6550
6551 bool ScalarEvolution::isKnownNonZero(const SCEV *S) {
6552   return isKnownNegative(S) || isKnownPositive(S);
6553 }
6554
6555 bool ScalarEvolution::isKnownPredicate(ICmpInst::Predicate Pred,
6556                                        const SCEV *LHS, const SCEV *RHS) {
6557   // Canonicalize the inputs first.
6558   (void)SimplifyICmpOperands(Pred, LHS, RHS);
6559
6560   // If LHS or RHS is an addrec, check to see if the condition is true in
6561   // every iteration of the loop.
6562   // If LHS and RHS are both addrec, both conditions must be true in
6563   // every iteration of the loop.
6564   const SCEVAddRecExpr *LAR = dyn_cast<SCEVAddRecExpr>(LHS);
6565   const SCEVAddRecExpr *RAR = dyn_cast<SCEVAddRecExpr>(RHS);
6566   bool LeftGuarded = false;
6567   bool RightGuarded = false;
6568   if (LAR) {
6569     const Loop *L = LAR->getLoop();
6570     if (isLoopEntryGuardedByCond(L, Pred, LAR->getStart(), RHS) &&
6571         isLoopBackedgeGuardedByCond(L, Pred, LAR->getPostIncExpr(*this), RHS)) {
6572       if (!RAR) return true;
6573       LeftGuarded = true;
6574     }
6575   }
6576   if (RAR) {
6577     const Loop *L = RAR->getLoop();
6578     if (isLoopEntryGuardedByCond(L, Pred, LHS, RAR->getStart()) &&
6579         isLoopBackedgeGuardedByCond(L, Pred, LHS, RAR->getPostIncExpr(*this))) {
6580       if (!LAR) return true;
6581       RightGuarded = true;
6582     }
6583   }
6584   if (LeftGuarded && RightGuarded)
6585     return true;
6586
6587   // Otherwise see what can be done with known constant ranges.
6588   return isKnownPredicateWithRanges(Pred, LHS, RHS);
6589 }
6590
6591 bool
6592 ScalarEvolution::isKnownPredicateWithRanges(ICmpInst::Predicate Pred,
6593                                             const SCEV *LHS, const SCEV *RHS) {
6594   if (HasSameValue(LHS, RHS))
6595     return ICmpInst::isTrueWhenEqual(Pred);
6596
6597   // This code is split out from isKnownPredicate because it is called from
6598   // within isLoopEntryGuardedByCond.
6599   switch (Pred) {
6600   default:
6601     llvm_unreachable("Unexpected ICmpInst::Predicate value!");
6602   case ICmpInst::ICMP_SGT:
6603     std::swap(LHS, RHS);
6604   case ICmpInst::ICMP_SLT: {
6605     ConstantRange LHSRange = getSignedRange(LHS);
6606     ConstantRange RHSRange = getSignedRange(RHS);
6607     if (LHSRange.getSignedMax().slt(RHSRange.getSignedMin()))
6608       return true;
6609     if (LHSRange.getSignedMin().sge(RHSRange.getSignedMax()))
6610       return false;
6611     break;
6612   }
6613   case ICmpInst::ICMP_SGE:
6614     std::swap(LHS, RHS);
6615   case ICmpInst::ICMP_SLE: {
6616     ConstantRange LHSRange = getSignedRange(LHS);
6617     ConstantRange RHSRange = getSignedRange(RHS);
6618     if (LHSRange.getSignedMax().sle(RHSRange.getSignedMin()))
6619       return true;
6620     if (LHSRange.getSignedMin().sgt(RHSRange.getSignedMax()))
6621       return false;
6622     break;
6623   }
6624   case ICmpInst::ICMP_UGT:
6625     std::swap(LHS, RHS);
6626   case ICmpInst::ICMP_ULT: {
6627     ConstantRange LHSRange = getUnsignedRange(LHS);
6628     ConstantRange RHSRange = getUnsignedRange(RHS);
6629     if (LHSRange.getUnsignedMax().ult(RHSRange.getUnsignedMin()))
6630       return true;
6631     if (LHSRange.getUnsignedMin().uge(RHSRange.getUnsignedMax()))
6632       return false;
6633     break;
6634   }
6635   case ICmpInst::ICMP_UGE:
6636     std::swap(LHS, RHS);
6637   case ICmpInst::ICMP_ULE: {
6638     ConstantRange LHSRange = getUnsignedRange(LHS);
6639     ConstantRange RHSRange = getUnsignedRange(RHS);
6640     if (LHSRange.getUnsignedMax().ule(RHSRange.getUnsignedMin()))
6641       return true;
6642     if (LHSRange.getUnsignedMin().ugt(RHSRange.getUnsignedMax()))
6643       return false;
6644     break;
6645   }
6646   case ICmpInst::ICMP_NE: {
6647     if (getUnsignedRange(LHS).intersectWith(getUnsignedRange(RHS)).isEmptySet())
6648       return true;
6649     if (getSignedRange(LHS).intersectWith(getSignedRange(RHS)).isEmptySet())
6650       return true;
6651
6652     const SCEV *Diff = getMinusSCEV(LHS, RHS);
6653     if (isKnownNonZero(Diff))
6654       return true;
6655     break;
6656   }
6657   case ICmpInst::ICMP_EQ:
6658     // The check at the top of the function catches the case where
6659     // the values are known to be equal.
6660     break;
6661   }
6662   return false;
6663 }
6664
6665 /// isLoopBackedgeGuardedByCond - Test whether the backedge of the loop is
6666 /// protected by a conditional between LHS and RHS.  This is used to
6667 /// to eliminate casts.
6668 bool
6669 ScalarEvolution::isLoopBackedgeGuardedByCond(const Loop *L,
6670                                              ICmpInst::Predicate Pred,
6671                                              const SCEV *LHS, const SCEV *RHS) {
6672   // Interpret a null as meaning no loop, where there is obviously no guard
6673   // (interprocedural conditions notwithstanding).
6674   if (!L) return true;
6675
6676   if (isKnownPredicateWithRanges(Pred, LHS, RHS)) return true;
6677
6678   BasicBlock *Latch = L->getLoopLatch();
6679   if (!Latch)
6680     return false;
6681
6682   BranchInst *LoopContinuePredicate =
6683     dyn_cast<BranchInst>(Latch->getTerminator());
6684   if (LoopContinuePredicate && LoopContinuePredicate->isConditional() &&
6685       isImpliedCond(Pred, LHS, RHS,
6686                     LoopContinuePredicate->getCondition(),
6687                     LoopContinuePredicate->getSuccessor(0) != L->getHeader()))
6688     return true;
6689
6690   // Check conditions due to any @llvm.assume intrinsics.
6691   for (auto &AssumeVH : AC->assumptions()) {
6692     if (!AssumeVH)
6693       continue;
6694     auto *CI = cast<CallInst>(AssumeVH);
6695     if (!DT->dominates(CI, Latch->getTerminator()))
6696       continue;
6697
6698     if (isImpliedCond(Pred, LHS, RHS, CI->getArgOperand(0), false))
6699       return true;
6700   }
6701
6702   return false;
6703 }
6704
6705 /// isLoopEntryGuardedByCond - Test whether entry to the loop is protected
6706 /// by a conditional between LHS and RHS.  This is used to help avoid max
6707 /// expressions in loop trip counts, and to eliminate casts.
6708 bool
6709 ScalarEvolution::isLoopEntryGuardedByCond(const Loop *L,
6710                                           ICmpInst::Predicate Pred,
6711                                           const SCEV *LHS, const SCEV *RHS) {
6712   // Interpret a null as meaning no loop, where there is obviously no guard
6713   // (interprocedural conditions notwithstanding).
6714   if (!L) return false;
6715
6716   if (isKnownPredicateWithRanges(Pred, LHS, RHS)) return true;
6717
6718   // Starting at the loop predecessor, climb up the predecessor chain, as long
6719   // as there are predecessors that can be found that have unique successors
6720   // leading to the original header.
6721   for (std::pair<BasicBlock *, BasicBlock *>
6722          Pair(L->getLoopPredecessor(), L->getHeader());
6723        Pair.first;
6724        Pair = getPredecessorWithUniqueSuccessorForBB(Pair.first)) {
6725
6726     BranchInst *LoopEntryPredicate =
6727       dyn_cast<BranchInst>(Pair.first->getTerminator());
6728     if (!LoopEntryPredicate ||
6729         LoopEntryPredicate->isUnconditional())
6730       continue;
6731
6732     if (isImpliedCond(Pred, LHS, RHS,
6733                       LoopEntryPredicate->getCondition(),
6734                       LoopEntryPredicate->getSuccessor(0) != Pair.second))
6735       return true;
6736   }
6737
6738   // Check conditions due to any @llvm.assume intrinsics.
6739   for (auto &AssumeVH : AC->assumptions()) {
6740     if (!AssumeVH)
6741       continue;
6742     auto *CI = cast<CallInst>(AssumeVH);
6743     if (!DT->dominates(CI, L->getHeader()))
6744       continue;
6745
6746     if (isImpliedCond(Pred, LHS, RHS, CI->getArgOperand(0), false))
6747       return true;
6748   }
6749
6750   return false;
6751 }
6752
6753 /// RAII wrapper to prevent recursive application of isImpliedCond.
6754 /// ScalarEvolution's PendingLoopPredicates set must be empty unless we are
6755 /// currently evaluating isImpliedCond.
6756 struct MarkPendingLoopPredicate {
6757   Value *Cond;
6758   DenseSet<Value*> &LoopPreds;
6759   bool Pending;
6760
6761   MarkPendingLoopPredicate(Value *C, DenseSet<Value*> &LP)
6762     : Cond(C), LoopPreds(LP) {
6763     Pending = !LoopPreds.insert(Cond).second;
6764   }
6765   ~MarkPendingLoopPredicate() {
6766     if (!Pending)
6767       LoopPreds.erase(Cond);
6768   }
6769 };
6770
6771 /// isImpliedCond - Test whether the condition described by Pred, LHS,
6772 /// and RHS is true whenever the given Cond value evaluates to true.
6773 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred,
6774                                     const SCEV *LHS, const SCEV *RHS,
6775                                     Value *FoundCondValue,
6776                                     bool Inverse) {
6777   MarkPendingLoopPredicate Mark(FoundCondValue, PendingLoopPredicates);
6778   if (Mark.Pending)
6779     return false;
6780
6781   // Recursively handle And and Or conditions.
6782   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(FoundCondValue)) {
6783     if (BO->getOpcode() == Instruction::And) {
6784       if (!Inverse)
6785         return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
6786                isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
6787     } else if (BO->getOpcode() == Instruction::Or) {
6788       if (Inverse)
6789         return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
6790                isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
6791     }
6792   }
6793
6794   ICmpInst *ICI = dyn_cast<ICmpInst>(FoundCondValue);
6795   if (!ICI) return false;
6796
6797   // Bail if the ICmp's operands' types are wider than the needed type
6798   // before attempting to call getSCEV on them. This avoids infinite
6799   // recursion, since the analysis of widening casts can require loop
6800   // exit condition information for overflow checking, which would
6801   // lead back here.
6802   if (getTypeSizeInBits(LHS->getType()) <
6803       getTypeSizeInBits(ICI->getOperand(0)->getType()))
6804     return false;
6805
6806   // Now that we found a conditional branch that dominates the loop or controls
6807   // the loop latch. Check to see if it is the comparison we are looking for.
6808   ICmpInst::Predicate FoundPred;
6809   if (Inverse)
6810     FoundPred = ICI->getInversePredicate();
6811   else
6812     FoundPred = ICI->getPredicate();
6813
6814   const SCEV *FoundLHS = getSCEV(ICI->getOperand(0));
6815   const SCEV *FoundRHS = getSCEV(ICI->getOperand(1));
6816
6817   // Balance the types. The case where FoundLHS' type is wider than
6818   // LHS' type is checked for above.
6819   if (getTypeSizeInBits(LHS->getType()) >
6820       getTypeSizeInBits(FoundLHS->getType())) {
6821     if (CmpInst::isSigned(FoundPred)) {
6822       FoundLHS = getSignExtendExpr(FoundLHS, LHS->getType());
6823       FoundRHS = getSignExtendExpr(FoundRHS, LHS->getType());
6824     } else {
6825       FoundLHS = getZeroExtendExpr(FoundLHS, LHS->getType());
6826       FoundRHS = getZeroExtendExpr(FoundRHS, LHS->getType());
6827     }
6828   }
6829
6830   // Canonicalize the query to match the way instcombine will have
6831   // canonicalized the comparison.
6832   if (SimplifyICmpOperands(Pred, LHS, RHS))
6833     if (LHS == RHS)
6834       return CmpInst::isTrueWhenEqual(Pred);
6835   if (SimplifyICmpOperands(FoundPred, FoundLHS, FoundRHS))
6836     if (FoundLHS == FoundRHS)
6837       return CmpInst::isFalseWhenEqual(FoundPred);
6838
6839   // Check to see if we can make the LHS or RHS match.
6840   if (LHS == FoundRHS || RHS == FoundLHS) {
6841     if (isa<SCEVConstant>(RHS)) {
6842       std::swap(FoundLHS, FoundRHS);
6843       FoundPred = ICmpInst::getSwappedPredicate(FoundPred);
6844     } else {
6845       std::swap(LHS, RHS);
6846       Pred = ICmpInst::getSwappedPredicate(Pred);
6847     }
6848   }
6849
6850   // Check whether the found predicate is the same as the desired predicate.
6851   if (FoundPred == Pred)
6852     return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS);
6853
6854   // Check whether swapping the found predicate makes it the same as the
6855   // desired predicate.
6856   if (ICmpInst::getSwappedPredicate(FoundPred) == Pred) {
6857     if (isa<SCEVConstant>(RHS))
6858       return isImpliedCondOperands(Pred, LHS, RHS, FoundRHS, FoundLHS);
6859     else
6860       return isImpliedCondOperands(ICmpInst::getSwappedPredicate(Pred),
6861                                    RHS, LHS, FoundLHS, FoundRHS);
6862   }
6863
6864   // Check if we can make progress by sharpening ranges.
6865   if (FoundPred == ICmpInst::ICMP_NE &&
6866       (isa<SCEVConstant>(FoundLHS) || isa<SCEVConstant>(FoundRHS))) {
6867
6868     const SCEVConstant *C = nullptr;
6869     const SCEV *V = nullptr;
6870
6871     if (isa<SCEVConstant>(FoundLHS)) {
6872       C = cast<SCEVConstant>(FoundLHS);
6873       V = FoundRHS;
6874     } else {
6875       C = cast<SCEVConstant>(FoundRHS);
6876       V = FoundLHS;
6877     }
6878
6879     // The guarding predicate tells us that C != V. If the known range
6880     // of V is [C, t), we can sharpen the range to [C + 1, t).  The
6881     // range we consider has to correspond to same signedness as the
6882     // predicate we're interested in folding.
6883
6884     APInt Min = ICmpInst::isSigned(Pred) ?
6885         getSignedRange(V).getSignedMin() : getUnsignedRange(V).getUnsignedMin();
6886
6887     if (Min == C->getValue()->getValue()) {
6888       // Given (V >= Min && V != Min) we conclude V >= (Min + 1).
6889       // This is true even if (Min + 1) wraps around -- in case of
6890       // wraparound, (Min + 1) < Min, so (V >= Min => V >= (Min + 1)).
6891
6892       APInt SharperMin = Min + 1;
6893
6894       switch (Pred) {
6895         case ICmpInst::ICMP_SGE:
6896         case ICmpInst::ICMP_UGE:
6897           // We know V `Pred` SharperMin.  If this implies LHS `Pred`
6898           // RHS, we're done.
6899           if (isImpliedCondOperands(Pred, LHS, RHS, V,
6900                                     getConstant(SharperMin)))
6901             return true;
6902
6903         case ICmpInst::ICMP_SGT:
6904         case ICmpInst::ICMP_UGT:
6905           // We know from the range information that (V `Pred` Min ||
6906           // V == Min).  We know from the guarding condition that !(V
6907           // == Min).  This gives us
6908           //
6909           //       V `Pred` Min || V == Min && !(V == Min)
6910           //   =>  V `Pred` Min
6911           //
6912           // If V `Pred` Min implies LHS `Pred` RHS, we're done.
6913
6914           if (isImpliedCondOperands(Pred, LHS, RHS, V, getConstant(Min)))
6915             return true;
6916
6917         default:
6918           // No change
6919           break;
6920       }
6921     }
6922   }
6923
6924   // Check whether the actual condition is beyond sufficient.
6925   if (FoundPred == ICmpInst::ICMP_EQ)
6926     if (ICmpInst::isTrueWhenEqual(Pred))
6927       if (isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS))
6928         return true;
6929   if (Pred == ICmpInst::ICMP_NE)
6930     if (!ICmpInst::isTrueWhenEqual(FoundPred))
6931       if (isImpliedCondOperands(FoundPred, LHS, RHS, FoundLHS, FoundRHS))
6932         return true;
6933
6934   // Otherwise assume the worst.
6935   return false;
6936 }
6937
6938 /// isImpliedCondOperands - Test whether the condition described by Pred,
6939 /// LHS, and RHS is true whenever the condition described by Pred, FoundLHS,
6940 /// and FoundRHS is true.
6941 bool ScalarEvolution::isImpliedCondOperands(ICmpInst::Predicate Pred,
6942                                             const SCEV *LHS, const SCEV *RHS,
6943                                             const SCEV *FoundLHS,
6944                                             const SCEV *FoundRHS) {
6945   if (isImpliedCondOperandsViaRanges(Pred, LHS, RHS, FoundLHS, FoundRHS))
6946     return true;
6947
6948   return isImpliedCondOperandsHelper(Pred, LHS, RHS,
6949                                      FoundLHS, FoundRHS) ||
6950          // ~x < ~y --> x > y
6951          isImpliedCondOperandsHelper(Pred, LHS, RHS,
6952                                      getNotSCEV(FoundRHS),
6953                                      getNotSCEV(FoundLHS));
6954 }
6955
6956
6957 /// If Expr computes ~A, return A else return nullptr
6958 static const SCEV *MatchNotExpr(const SCEV *Expr) {
6959   const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Expr);
6960   if (!Add || Add->getNumOperands() != 2) return nullptr;
6961
6962   const SCEVConstant *AddLHS = dyn_cast<SCEVConstant>(Add->getOperand(0));
6963   if (!(AddLHS && AddLHS->getValue()->getValue().isAllOnesValue()))
6964     return nullptr;
6965
6966   const SCEVMulExpr *AddRHS = dyn_cast<SCEVMulExpr>(Add->getOperand(1));
6967   if (!AddRHS || AddRHS->getNumOperands() != 2) return nullptr;
6968
6969   const SCEVConstant *MulLHS = dyn_cast<SCEVConstant>(AddRHS->getOperand(0));
6970   if (!(MulLHS && MulLHS->getValue()->getValue().isAllOnesValue()))
6971     return nullptr;
6972
6973   return AddRHS->getOperand(1);
6974 }
6975
6976
6977 /// Is MaybeMaxExpr an SMax or UMax of Candidate and some other values?
6978 template<typename MaxExprType>
6979 static bool IsMaxConsistingOf(const SCEV *MaybeMaxExpr,
6980                               const SCEV *Candidate) {
6981   const MaxExprType *MaxExpr = dyn_cast<MaxExprType>(MaybeMaxExpr);
6982   if (!MaxExpr) return false;
6983
6984   auto It = std::find(MaxExpr->op_begin(), MaxExpr->op_end(), Candidate);
6985   return It != MaxExpr->op_end();
6986 }
6987
6988
6989 /// Is MaybeMinExpr an SMin or UMin of Candidate and some other values?
6990 template<typename MaxExprType>
6991 static bool IsMinConsistingOf(ScalarEvolution &SE,
6992                               const SCEV *MaybeMinExpr,
6993                               const SCEV *Candidate) {
6994   const SCEV *MaybeMaxExpr = MatchNotExpr(MaybeMinExpr);
6995   if (!MaybeMaxExpr)
6996     return false;
6997
6998   return IsMaxConsistingOf<MaxExprType>(MaybeMaxExpr, SE.getNotSCEV(Candidate));
6999 }
7000
7001
7002 /// Is LHS `Pred` RHS true on the virtue of LHS or RHS being a Min or Max
7003 /// expression?
7004 static bool IsKnownPredicateViaMinOrMax(ScalarEvolution &SE,
7005                                         ICmpInst::Predicate Pred,
7006                                         const SCEV *LHS, const SCEV *RHS) {
7007   switch (Pred) {
7008   default:
7009     return false;
7010
7011   case ICmpInst::ICMP_SGE:
7012     std::swap(LHS, RHS);
7013     // fall through
7014   case ICmpInst::ICMP_SLE:
7015     return
7016       // min(A, ...) <= A
7017       IsMinConsistingOf<SCEVSMaxExpr>(SE, LHS, RHS) ||
7018       // A <= max(A, ...)
7019       IsMaxConsistingOf<SCEVSMaxExpr>(RHS, LHS);
7020
7021   case ICmpInst::ICMP_UGE:
7022     std::swap(LHS, RHS);
7023     // fall through
7024   case ICmpInst::ICMP_ULE:
7025     return
7026       // min(A, ...) <= A
7027       IsMinConsistingOf<SCEVUMaxExpr>(SE, LHS, RHS) ||
7028       // A <= max(A, ...)
7029       IsMaxConsistingOf<SCEVUMaxExpr>(RHS, LHS);
7030   }
7031
7032   llvm_unreachable("covered switch fell through?!");
7033 }
7034
7035 /// isImpliedCondOperandsHelper - Test whether the condition described by
7036 /// Pred, LHS, and RHS is true whenever the condition described by Pred,
7037 /// FoundLHS, and FoundRHS is true.
7038 bool
7039 ScalarEvolution::isImpliedCondOperandsHelper(ICmpInst::Predicate Pred,
7040                                              const SCEV *LHS, const SCEV *RHS,
7041                                              const SCEV *FoundLHS,
7042                                              const SCEV *FoundRHS) {
7043   auto IsKnownPredicateFull =
7044       [this](ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS) {
7045     return isKnownPredicateWithRanges(Pred, LHS, RHS) ||
7046         IsKnownPredicateViaMinOrMax(*this, Pred, LHS, RHS);
7047   };
7048
7049   switch (Pred) {
7050   default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
7051   case ICmpInst::ICMP_EQ:
7052   case ICmpInst::ICMP_NE:
7053     if (HasSameValue(LHS, FoundLHS) && HasSameValue(RHS, FoundRHS))
7054       return true;
7055     break;
7056   case ICmpInst::ICMP_SLT:
7057   case ICmpInst::ICMP_SLE:
7058     if (IsKnownPredicateFull(ICmpInst::ICMP_SLE, LHS, FoundLHS) &&
7059         IsKnownPredicateFull(ICmpInst::ICMP_SGE, RHS, FoundRHS))
7060       return true;
7061     break;
7062   case ICmpInst::ICMP_SGT:
7063   case ICmpInst::ICMP_SGE:
7064     if (IsKnownPredicateFull(ICmpInst::ICMP_SGE, LHS, FoundLHS) &&
7065         IsKnownPredicateFull(ICmpInst::ICMP_SLE, RHS, FoundRHS))
7066       return true;
7067     break;
7068   case ICmpInst::ICMP_ULT:
7069   case ICmpInst::ICMP_ULE:
7070     if (IsKnownPredicateFull(ICmpInst::ICMP_ULE, LHS, FoundLHS) &&
7071         IsKnownPredicateFull(ICmpInst::ICMP_UGE, RHS, FoundRHS))
7072       return true;
7073     break;
7074   case ICmpInst::ICMP_UGT:
7075   case ICmpInst::ICMP_UGE:
7076     if (IsKnownPredicateFull(ICmpInst::ICMP_UGE, LHS, FoundLHS) &&
7077         IsKnownPredicateFull(ICmpInst::ICMP_ULE, RHS, FoundRHS))
7078       return true;
7079     break;
7080   }
7081
7082   return false;
7083 }
7084
7085 /// isImpliedCondOperandsViaRanges - helper function for isImpliedCondOperands.
7086 /// Tries to get cases like "X `sgt` 0 => X - 1 `sgt` -1".
7087 bool ScalarEvolution::isImpliedCondOperandsViaRanges(ICmpInst::Predicate Pred,
7088                                                      const SCEV *LHS,
7089                                                      const SCEV *RHS,
7090                                                      const SCEV *FoundLHS,
7091                                                      const SCEV *FoundRHS) {
7092   if (!isa<SCEVConstant>(RHS) || !isa<SCEVConstant>(FoundRHS))
7093     // The restriction on `FoundRHS` be lifted easily -- it exists only to
7094     // reduce the compile time impact of this optimization.
7095     return false;
7096
7097   const SCEVAddExpr *AddLHS = dyn_cast<SCEVAddExpr>(LHS);
7098   if (!AddLHS || AddLHS->getOperand(1) != FoundLHS ||
7099       !isa<SCEVConstant>(AddLHS->getOperand(0)))
7100     return false;
7101
7102   APInt ConstFoundRHS = cast<SCEVConstant>(FoundRHS)->getValue()->getValue();
7103
7104   // `FoundLHSRange` is the range we know `FoundLHS` to be in by virtue of the
7105   // antecedent "`FoundLHS` `Pred` `FoundRHS`".
7106   ConstantRange FoundLHSRange =
7107       ConstantRange::makeAllowedICmpRegion(Pred, ConstFoundRHS);
7108
7109   // Since `LHS` is `FoundLHS` + `AddLHS->getOperand(0)`, we can compute a range
7110   // for `LHS`:
7111   APInt Addend =
7112       cast<SCEVConstant>(AddLHS->getOperand(0))->getValue()->getValue();
7113   ConstantRange LHSRange = FoundLHSRange.add(ConstantRange(Addend));
7114
7115   // We can also compute the range of values for `LHS` that satisfy the
7116   // consequent, "`LHS` `Pred` `RHS`":
7117   APInt ConstRHS = cast<SCEVConstant>(RHS)->getValue()->getValue();
7118   ConstantRange SatisfyingLHSRange =
7119       ConstantRange::makeSatisfyingICmpRegion(Pred, ConstRHS);
7120
7121   // The antecedent implies the consequent if every value of `LHS` that
7122   // satisfies the antecedent also satisfies the consequent.
7123   return SatisfyingLHSRange.contains(LHSRange);
7124 }
7125
7126 // Verify if an linear IV with positive stride can overflow when in a
7127 // less-than comparison, knowing the invariant term of the comparison, the
7128 // stride and the knowledge of NSW/NUW flags on the recurrence.
7129 bool ScalarEvolution::doesIVOverflowOnLT(const SCEV *RHS, const SCEV *Stride,
7130                                          bool IsSigned, bool NoWrap) {
7131   if (NoWrap) return false;
7132
7133   unsigned BitWidth = getTypeSizeInBits(RHS->getType());
7134   const SCEV *One = getConstant(Stride->getType(), 1);
7135
7136   if (IsSigned) {
7137     APInt MaxRHS = getSignedRange(RHS).getSignedMax();
7138     APInt MaxValue = APInt::getSignedMaxValue(BitWidth);
7139     APInt MaxStrideMinusOne = getSignedRange(getMinusSCEV(Stride, One))
7140                                 .getSignedMax();
7141
7142     // SMaxRHS + SMaxStrideMinusOne > SMaxValue => overflow!
7143     return (MaxValue - MaxStrideMinusOne).slt(MaxRHS);
7144   }
7145
7146   APInt MaxRHS = getUnsignedRange(RHS).getUnsignedMax();
7147   APInt MaxValue = APInt::getMaxValue(BitWidth);
7148   APInt MaxStrideMinusOne = getUnsignedRange(getMinusSCEV(Stride, One))
7149                               .getUnsignedMax();
7150
7151   // UMaxRHS + UMaxStrideMinusOne > UMaxValue => overflow!
7152   return (MaxValue - MaxStrideMinusOne).ult(MaxRHS);
7153 }
7154
7155 // Verify if an linear IV with negative stride can overflow when in a
7156 // greater-than comparison, knowing the invariant term of the comparison,
7157 // the stride and the knowledge of NSW/NUW flags on the recurrence.
7158 bool ScalarEvolution::doesIVOverflowOnGT(const SCEV *RHS, const SCEV *Stride,
7159                                          bool IsSigned, bool NoWrap) {
7160   if (NoWrap) return false;
7161
7162   unsigned BitWidth = getTypeSizeInBits(RHS->getType());
7163   const SCEV *One = getConstant(Stride->getType(), 1);
7164
7165   if (IsSigned) {
7166     APInt MinRHS = getSignedRange(RHS).getSignedMin();
7167     APInt MinValue = APInt::getSignedMinValue(BitWidth);
7168     APInt MaxStrideMinusOne = getSignedRange(getMinusSCEV(Stride, One))
7169                                .getSignedMax();
7170
7171     // SMinRHS - SMaxStrideMinusOne < SMinValue => overflow!
7172     return (MinValue + MaxStrideMinusOne).sgt(MinRHS);
7173   }
7174
7175   APInt MinRHS = getUnsignedRange(RHS).getUnsignedMin();
7176   APInt MinValue = APInt::getMinValue(BitWidth);
7177   APInt MaxStrideMinusOne = getUnsignedRange(getMinusSCEV(Stride, One))
7178                             .getUnsignedMax();
7179
7180   // UMinRHS - UMaxStrideMinusOne < UMinValue => overflow!
7181   return (MinValue + MaxStrideMinusOne).ugt(MinRHS);
7182 }
7183
7184 // Compute the backedge taken count knowing the interval difference, the
7185 // stride and presence of the equality in the comparison.
7186 const SCEV *ScalarEvolution::computeBECount(const SCEV *Delta, const SCEV *Step,
7187                                             bool Equality) {
7188   const SCEV *One = getConstant(Step->getType(), 1);
7189   Delta = Equality ? getAddExpr(Delta, Step)
7190                    : getAddExpr(Delta, getMinusSCEV(Step, One));
7191   return getUDivExpr(Delta, Step);
7192 }
7193
7194 /// HowManyLessThans - Return the number of times a backedge containing the
7195 /// specified less-than comparison will execute.  If not computable, return
7196 /// CouldNotCompute.
7197 ///
7198 /// @param ControlsExit is true when the LHS < RHS condition directly controls
7199 /// the branch (loops exits only if condition is true). In this case, we can use
7200 /// NoWrapFlags to skip overflow checks.
7201 ScalarEvolution::ExitLimit
7202 ScalarEvolution::HowManyLessThans(const SCEV *LHS, const SCEV *RHS,
7203                                   const Loop *L, bool IsSigned,
7204                                   bool ControlsExit) {
7205   // We handle only IV < Invariant
7206   if (!isLoopInvariant(RHS, L))
7207     return getCouldNotCompute();
7208
7209   const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS);
7210
7211   // Avoid weird loops
7212   if (!IV || IV->getLoop() != L || !IV->isAffine())
7213     return getCouldNotCompute();
7214
7215   bool NoWrap = ControlsExit &&
7216                 IV->getNoWrapFlags(IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW);
7217
7218   const SCEV *Stride = IV->getStepRecurrence(*this);
7219
7220   // Avoid negative or zero stride values
7221   if (!isKnownPositive(Stride))
7222     return getCouldNotCompute();
7223
7224   // Avoid proven overflow cases: this will ensure that the backedge taken count
7225   // will not generate any unsigned overflow. Relaxed no-overflow conditions
7226   // exploit NoWrapFlags, allowing to optimize in presence of undefined
7227   // behaviors like the case of C language.
7228   if (!Stride->isOne() && doesIVOverflowOnLT(RHS, Stride, IsSigned, NoWrap))
7229     return getCouldNotCompute();
7230
7231   ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SLT
7232                                       : ICmpInst::ICMP_ULT;
7233   const SCEV *Start = IV->getStart();
7234   const SCEV *End = RHS;
7235   if (!isLoopEntryGuardedByCond(L, Cond, getMinusSCEV(Start, Stride), RHS)) {
7236     const SCEV *Diff = getMinusSCEV(RHS, Start);
7237     // If we have NoWrap set, then we can assume that the increment won't
7238     // overflow, in which case if RHS - Start is a constant, we don't need to
7239     // do a max operation since we can just figure it out statically
7240     if (NoWrap && isa<SCEVConstant>(Diff)) {
7241       APInt D = dyn_cast<const SCEVConstant>(Diff)->getValue()->getValue();
7242       if (D.isNegative())
7243         End = Start;
7244     } else
7245       End = IsSigned ? getSMaxExpr(RHS, Start)
7246                      : getUMaxExpr(RHS, Start);
7247   }
7248
7249   const SCEV *BECount = computeBECount(getMinusSCEV(End, Start), Stride, false);
7250
7251   APInt MinStart = IsSigned ? getSignedRange(Start).getSignedMin()
7252                             : getUnsignedRange(Start).getUnsignedMin();
7253
7254   APInt MinStride = IsSigned ? getSignedRange(Stride).getSignedMin()
7255                              : getUnsignedRange(Stride).getUnsignedMin();
7256
7257   unsigned BitWidth = getTypeSizeInBits(LHS->getType());
7258   APInt Limit = IsSigned ? APInt::getSignedMaxValue(BitWidth) - (MinStride - 1)
7259                          : APInt::getMaxValue(BitWidth) - (MinStride - 1);
7260
7261   // Although End can be a MAX expression we estimate MaxEnd considering only
7262   // the case End = RHS. This is safe because in the other case (End - Start)
7263   // is zero, leading to a zero maximum backedge taken count.
7264   APInt MaxEnd =
7265     IsSigned ? APIntOps::smin(getSignedRange(RHS).getSignedMax(), Limit)
7266              : APIntOps::umin(getUnsignedRange(RHS).getUnsignedMax(), Limit);
7267
7268   const SCEV *MaxBECount;
7269   if (isa<SCEVConstant>(BECount))
7270     MaxBECount = BECount;
7271   else
7272     MaxBECount = computeBECount(getConstant(MaxEnd - MinStart),
7273                                 getConstant(MinStride), false);
7274
7275   if (isa<SCEVCouldNotCompute>(MaxBECount))
7276     MaxBECount = BECount;
7277
7278   return ExitLimit(BECount, MaxBECount);
7279 }
7280
7281 ScalarEvolution::ExitLimit
7282 ScalarEvolution::HowManyGreaterThans(const SCEV *LHS, const SCEV *RHS,
7283                                      const Loop *L, bool IsSigned,
7284                                      bool ControlsExit) {
7285   // We handle only IV > Invariant
7286   if (!isLoopInvariant(RHS, L))
7287     return getCouldNotCompute();
7288
7289   const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS);
7290
7291   // Avoid weird loops
7292   if (!IV || IV->getLoop() != L || !IV->isAffine())
7293     return getCouldNotCompute();
7294
7295   bool NoWrap = ControlsExit &&
7296                 IV->getNoWrapFlags(IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW);
7297
7298   const SCEV *Stride = getNegativeSCEV(IV->getStepRecurrence(*this));
7299
7300   // Avoid negative or zero stride values
7301   if (!isKnownPositive(Stride))
7302     return getCouldNotCompute();
7303
7304   // Avoid proven overflow cases: this will ensure that the backedge taken count
7305   // will not generate any unsigned overflow. Relaxed no-overflow conditions
7306   // exploit NoWrapFlags, allowing to optimize in presence of undefined
7307   // behaviors like the case of C language.
7308   if (!Stride->isOne() && doesIVOverflowOnGT(RHS, Stride, IsSigned, NoWrap))
7309     return getCouldNotCompute();
7310
7311   ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SGT
7312                                       : ICmpInst::ICMP_UGT;
7313
7314   const SCEV *Start = IV->getStart();
7315   const SCEV *End = RHS;
7316   if (!isLoopEntryGuardedByCond(L, Cond, getAddExpr(Start, Stride), RHS)) {
7317     const SCEV *Diff = getMinusSCEV(RHS, Start);
7318     // If we have NoWrap set, then we can assume that the increment won't
7319     // overflow, in which case if RHS - Start is a constant, we don't need to
7320     // do a max operation since we can just figure it out statically
7321     if (NoWrap && isa<SCEVConstant>(Diff)) {
7322       APInt D = dyn_cast<const SCEVConstant>(Diff)->getValue()->getValue();
7323       if (!D.isNegative())
7324         End = Start;
7325     } else
7326       End = IsSigned ? getSMinExpr(RHS, Start)
7327                      : getUMinExpr(RHS, Start);
7328   }
7329
7330   const SCEV *BECount = computeBECount(getMinusSCEV(Start, End), Stride, false);
7331
7332   APInt MaxStart = IsSigned ? getSignedRange(Start).getSignedMax()
7333                             : getUnsignedRange(Start).getUnsignedMax();
7334
7335   APInt MinStride = IsSigned ? getSignedRange(Stride).getSignedMin()
7336                              : getUnsignedRange(Stride).getUnsignedMin();
7337
7338   unsigned BitWidth = getTypeSizeInBits(LHS->getType());
7339   APInt Limit = IsSigned ? APInt::getSignedMinValue(BitWidth) + (MinStride - 1)
7340                          : APInt::getMinValue(BitWidth) + (MinStride - 1);
7341
7342   // Although End can be a MIN expression we estimate MinEnd considering only
7343   // the case End = RHS. This is safe because in the other case (Start - End)
7344   // is zero, leading to a zero maximum backedge taken count.
7345   APInt MinEnd =
7346     IsSigned ? APIntOps::smax(getSignedRange(RHS).getSignedMin(), Limit)
7347              : APIntOps::umax(getUnsignedRange(RHS).getUnsignedMin(), Limit);
7348
7349
7350   const SCEV *MaxBECount = getCouldNotCompute();
7351   if (isa<SCEVConstant>(BECount))
7352     MaxBECount = BECount;
7353   else
7354     MaxBECount = computeBECount(getConstant(MaxStart - MinEnd),
7355                                 getConstant(MinStride), false);
7356
7357   if (isa<SCEVCouldNotCompute>(MaxBECount))
7358     MaxBECount = BECount;
7359
7360   return ExitLimit(BECount, MaxBECount);
7361 }
7362
7363 /// getNumIterationsInRange - Return the number of iterations of this loop that
7364 /// produce values in the specified constant range.  Another way of looking at
7365 /// this is that it returns the first iteration number where the value is not in
7366 /// the condition, thus computing the exit count. If the iteration count can't
7367 /// be computed, an instance of SCEVCouldNotCompute is returned.
7368 const SCEV *SCEVAddRecExpr::getNumIterationsInRange(ConstantRange Range,
7369                                                     ScalarEvolution &SE) const {
7370   if (Range.isFullSet())  // Infinite loop.
7371     return SE.getCouldNotCompute();
7372
7373   // If the start is a non-zero constant, shift the range to simplify things.
7374   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(getStart()))
7375     if (!SC->getValue()->isZero()) {
7376       SmallVector<const SCEV *, 4> Operands(op_begin(), op_end());
7377       Operands[0] = SE.getConstant(SC->getType(), 0);
7378       const SCEV *Shifted = SE.getAddRecExpr(Operands, getLoop(),
7379                                              getNoWrapFlags(FlagNW));
7380       if (const SCEVAddRecExpr *ShiftedAddRec =
7381             dyn_cast<SCEVAddRecExpr>(Shifted))
7382         return ShiftedAddRec->getNumIterationsInRange(
7383                            Range.subtract(SC->getValue()->getValue()), SE);
7384       // This is strange and shouldn't happen.
7385       return SE.getCouldNotCompute();
7386     }
7387
7388   // The only time we can solve this is when we have all constant indices.
7389   // Otherwise, we cannot determine the overflow conditions.
7390   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
7391     if (!isa<SCEVConstant>(getOperand(i)))
7392       return SE.getCouldNotCompute();
7393
7394
7395   // Okay at this point we know that all elements of the chrec are constants and
7396   // that the start element is zero.
7397
7398   // First check to see if the range contains zero.  If not, the first
7399   // iteration exits.
7400   unsigned BitWidth = SE.getTypeSizeInBits(getType());
7401   if (!Range.contains(APInt(BitWidth, 0)))
7402     return SE.getConstant(getType(), 0);
7403
7404   if (isAffine()) {
7405     // If this is an affine expression then we have this situation:
7406     //   Solve {0,+,A} in Range  ===  Ax in Range
7407
7408     // We know that zero is in the range.  If A is positive then we know that
7409     // the upper value of the range must be the first possible exit value.
7410     // If A is negative then the lower of the range is the last possible loop
7411     // value.  Also note that we already checked for a full range.
7412     APInt One(BitWidth,1);
7413     APInt A     = cast<SCEVConstant>(getOperand(1))->getValue()->getValue();
7414     APInt End = A.sge(One) ? (Range.getUpper() - One) : Range.getLower();
7415
7416     // The exit value should be (End+A)/A.
7417     APInt ExitVal = (End + A).udiv(A);
7418     ConstantInt *ExitValue = ConstantInt::get(SE.getContext(), ExitVal);
7419
7420     // Evaluate at the exit value.  If we really did fall out of the valid
7421     // range, then we computed our trip count, otherwise wrap around or other
7422     // things must have happened.
7423     ConstantInt *Val = EvaluateConstantChrecAtConstant(this, ExitValue, SE);
7424     if (Range.contains(Val->getValue()))
7425       return SE.getCouldNotCompute();  // Something strange happened
7426
7427     // Ensure that the previous value is in the range.  This is a sanity check.
7428     assert(Range.contains(
7429            EvaluateConstantChrecAtConstant(this,
7430            ConstantInt::get(SE.getContext(), ExitVal - One), SE)->getValue()) &&
7431            "Linear scev computation is off in a bad way!");
7432     return SE.getConstant(ExitValue);
7433   } else if (isQuadratic()) {
7434     // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of the
7435     // quadratic equation to solve it.  To do this, we must frame our problem in
7436     // terms of figuring out when zero is crossed, instead of when
7437     // Range.getUpper() is crossed.
7438     SmallVector<const SCEV *, 4> NewOps(op_begin(), op_end());
7439     NewOps[0] = SE.getNegativeSCEV(SE.getConstant(Range.getUpper()));
7440     const SCEV *NewAddRec = SE.getAddRecExpr(NewOps, getLoop(),
7441                                              // getNoWrapFlags(FlagNW)
7442                                              FlagAnyWrap);
7443
7444     // Next, solve the constructed addrec
7445     std::pair<const SCEV *,const SCEV *> Roots =
7446       SolveQuadraticEquation(cast<SCEVAddRecExpr>(NewAddRec), SE);
7447     const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
7448     const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
7449     if (R1) {
7450       // Pick the smallest positive root value.
7451       if (ConstantInt *CB =
7452           dyn_cast<ConstantInt>(ConstantExpr::getICmp(ICmpInst::ICMP_ULT,
7453                          R1->getValue(), R2->getValue()))) {
7454         if (!CB->getZExtValue())
7455           std::swap(R1, R2);   // R1 is the minimum root now.
7456
7457         // Make sure the root is not off by one.  The returned iteration should
7458         // not be in the range, but the previous one should be.  When solving
7459         // for "X*X < 5", for example, we should not return a root of 2.
7460         ConstantInt *R1Val = EvaluateConstantChrecAtConstant(this,
7461                                                              R1->getValue(),
7462                                                              SE);
7463         if (Range.contains(R1Val->getValue())) {
7464           // The next iteration must be out of the range...
7465           ConstantInt *NextVal =
7466                 ConstantInt::get(SE.getContext(), R1->getValue()->getValue()+1);
7467
7468           R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
7469           if (!Range.contains(R1Val->getValue()))
7470             return SE.getConstant(NextVal);
7471           return SE.getCouldNotCompute();  // Something strange happened
7472         }
7473
7474         // If R1 was not in the range, then it is a good return value.  Make
7475         // sure that R1-1 WAS in the range though, just in case.
7476         ConstantInt *NextVal =
7477                ConstantInt::get(SE.getContext(), R1->getValue()->getValue()-1);
7478         R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
7479         if (Range.contains(R1Val->getValue()))
7480           return R1;
7481         return SE.getCouldNotCompute();  // Something strange happened
7482       }
7483     }
7484   }
7485
7486   return SE.getCouldNotCompute();
7487 }
7488
7489 namespace {
7490 struct FindUndefs {
7491   bool Found;
7492   FindUndefs() : Found(false) {}
7493
7494   bool follow(const SCEV *S) {
7495     if (const SCEVUnknown *C = dyn_cast<SCEVUnknown>(S)) {
7496       if (isa<UndefValue>(C->getValue()))
7497         Found = true;
7498     } else if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S)) {
7499       if (isa<UndefValue>(C->getValue()))
7500         Found = true;
7501     }
7502
7503     // Keep looking if we haven't found it yet.
7504     return !Found;
7505   }
7506   bool isDone() const {
7507     // Stop recursion if we have found an undef.
7508     return Found;
7509   }
7510 };
7511 }
7512
7513 // Return true when S contains at least an undef value.
7514 static inline bool
7515 containsUndefs(const SCEV *S) {
7516   FindUndefs F;
7517   SCEVTraversal<FindUndefs> ST(F);
7518   ST.visitAll(S);
7519
7520   return F.Found;
7521 }
7522
7523 namespace {
7524 // Collect all steps of SCEV expressions.
7525 struct SCEVCollectStrides {
7526   ScalarEvolution &SE;
7527   SmallVectorImpl<const SCEV *> &Strides;
7528
7529   SCEVCollectStrides(ScalarEvolution &SE, SmallVectorImpl<const SCEV *> &S)
7530       : SE(SE), Strides(S) {}
7531
7532   bool follow(const SCEV *S) {
7533     if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S))
7534       Strides.push_back(AR->getStepRecurrence(SE));
7535     return true;
7536   }
7537   bool isDone() const { return false; }
7538 };
7539
7540 // Collect all SCEVUnknown and SCEVMulExpr expressions.
7541 struct SCEVCollectTerms {
7542   SmallVectorImpl<const SCEV *> &Terms;
7543
7544   SCEVCollectTerms(SmallVectorImpl<const SCEV *> &T)
7545       : Terms(T) {}
7546
7547   bool follow(const SCEV *S) {
7548     if (isa<SCEVUnknown>(S) || isa<SCEVMulExpr>(S)) {
7549       if (!containsUndefs(S))
7550         Terms.push_back(S);
7551
7552       // Stop recursion: once we collected a term, do not walk its operands.
7553       return false;
7554     }
7555
7556     // Keep looking.
7557     return true;
7558   }
7559   bool isDone() const { return false; }
7560 };
7561 }
7562
7563 /// Find parametric terms in this SCEVAddRecExpr.
7564 void SCEVAddRecExpr::collectParametricTerms(
7565     ScalarEvolution &SE, SmallVectorImpl<const SCEV *> &Terms) const {
7566   SmallVector<const SCEV *, 4> Strides;
7567   SCEVCollectStrides StrideCollector(SE, Strides);
7568   visitAll(this, StrideCollector);
7569
7570   DEBUG({
7571       dbgs() << "Strides:\n";
7572       for (const SCEV *S : Strides)
7573         dbgs() << *S << "\n";
7574     });
7575
7576   for (const SCEV *S : Strides) {
7577     SCEVCollectTerms TermCollector(Terms);
7578     visitAll(S, TermCollector);
7579   }
7580
7581   DEBUG({
7582       dbgs() << "Terms:\n";
7583       for (const SCEV *T : Terms)
7584         dbgs() << *T << "\n";
7585     });
7586 }
7587
7588 static bool findArrayDimensionsRec(ScalarEvolution &SE,
7589                                    SmallVectorImpl<const SCEV *> &Terms,
7590                                    SmallVectorImpl<const SCEV *> &Sizes) {
7591   int Last = Terms.size() - 1;
7592   const SCEV *Step = Terms[Last];
7593
7594   // End of recursion.
7595   if (Last == 0) {
7596     if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(Step)) {
7597       SmallVector<const SCEV *, 2> Qs;
7598       for (const SCEV *Op : M->operands())
7599         if (!isa<SCEVConstant>(Op))
7600           Qs.push_back(Op);
7601
7602       Step = SE.getMulExpr(Qs);
7603     }
7604
7605     Sizes.push_back(Step);
7606     return true;
7607   }
7608
7609   for (const SCEV *&Term : Terms) {
7610     // Normalize the terms before the next call to findArrayDimensionsRec.
7611     const SCEV *Q, *R;
7612     SCEVDivision::divide(SE, Term, Step, &Q, &R);
7613
7614     // Bail out when GCD does not evenly divide one of the terms.
7615     if (!R->isZero())
7616       return false;
7617
7618     Term = Q;
7619   }
7620
7621   // Remove all SCEVConstants.
7622   Terms.erase(std::remove_if(Terms.begin(), Terms.end(), [](const SCEV *E) {
7623                 return isa<SCEVConstant>(E);
7624               }),
7625               Terms.end());
7626
7627   if (Terms.size() > 0)
7628     if (!findArrayDimensionsRec(SE, Terms, Sizes))
7629       return false;
7630
7631   Sizes.push_back(Step);
7632   return true;
7633 }
7634
7635 namespace {
7636 struct FindParameter {
7637   bool FoundParameter;
7638   FindParameter() : FoundParameter(false) {}
7639
7640   bool follow(const SCEV *S) {
7641     if (isa<SCEVUnknown>(S)) {
7642       FoundParameter = true;
7643       // Stop recursion: we found a parameter.
7644       return false;
7645     }
7646     // Keep looking.
7647     return true;
7648   }
7649   bool isDone() const {
7650     // Stop recursion if we have found a parameter.
7651     return FoundParameter;
7652   }
7653 };
7654 }
7655
7656 // Returns true when S contains at least a SCEVUnknown parameter.
7657 static inline bool
7658 containsParameters(const SCEV *S) {
7659   FindParameter F;
7660   SCEVTraversal<FindParameter> ST(F);
7661   ST.visitAll(S);
7662
7663   return F.FoundParameter;
7664 }
7665
7666 // Returns true when one of the SCEVs of Terms contains a SCEVUnknown parameter.
7667 static inline bool
7668 containsParameters(SmallVectorImpl<const SCEV *> &Terms) {
7669   for (const SCEV *T : Terms)
7670     if (containsParameters(T))
7671       return true;
7672   return false;
7673 }
7674
7675 // Return the number of product terms in S.
7676 static inline int numberOfTerms(const SCEV *S) {
7677   if (const SCEVMulExpr *Expr = dyn_cast<SCEVMulExpr>(S))
7678     return Expr->getNumOperands();
7679   return 1;
7680 }
7681
7682 static const SCEV *removeConstantFactors(ScalarEvolution &SE, const SCEV *T) {
7683   if (isa<SCEVConstant>(T))
7684     return nullptr;
7685
7686   if (isa<SCEVUnknown>(T))
7687     return T;
7688
7689   if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(T)) {
7690     SmallVector<const SCEV *, 2> Factors;
7691     for (const SCEV *Op : M->operands())
7692       if (!isa<SCEVConstant>(Op))
7693         Factors.push_back(Op);
7694
7695     return SE.getMulExpr(Factors);
7696   }
7697
7698   return T;
7699 }
7700
7701 /// Return the size of an element read or written by Inst.
7702 const SCEV *ScalarEvolution::getElementSize(Instruction *Inst) {
7703   Type *Ty;
7704   if (StoreInst *Store = dyn_cast<StoreInst>(Inst))
7705     Ty = Store->getValueOperand()->getType();
7706   else if (LoadInst *Load = dyn_cast<LoadInst>(Inst))
7707     Ty = Load->getType();
7708   else
7709     return nullptr;
7710
7711   Type *ETy = getEffectiveSCEVType(PointerType::getUnqual(Ty));
7712   return getSizeOfExpr(ETy, Ty);
7713 }
7714
7715 /// Second step of delinearization: compute the array dimensions Sizes from the
7716 /// set of Terms extracted from the memory access function of this SCEVAddRec.
7717 void ScalarEvolution::findArrayDimensions(SmallVectorImpl<const SCEV *> &Terms,
7718                                           SmallVectorImpl<const SCEV *> &Sizes,
7719                                           const SCEV *ElementSize) const {
7720
7721   if (Terms.size() < 1 || !ElementSize)
7722     return;
7723
7724   // Early return when Terms do not contain parameters: we do not delinearize
7725   // non parametric SCEVs.
7726   if (!containsParameters(Terms))
7727     return;
7728
7729   DEBUG({
7730       dbgs() << "Terms:\n";
7731       for (const SCEV *T : Terms)
7732         dbgs() << *T << "\n";
7733     });
7734
7735   // Remove duplicates.
7736   std::sort(Terms.begin(), Terms.end());
7737   Terms.erase(std::unique(Terms.begin(), Terms.end()), Terms.end());
7738
7739   // Put larger terms first.
7740   std::sort(Terms.begin(), Terms.end(), [](const SCEV *LHS, const SCEV *RHS) {
7741     return numberOfTerms(LHS) > numberOfTerms(RHS);
7742   });
7743
7744   ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
7745
7746   // Divide all terms by the element size.
7747   for (const SCEV *&Term : Terms) {
7748     const SCEV *Q, *R;
7749     SCEVDivision::divide(SE, Term, ElementSize, &Q, &R);
7750     Term = Q;
7751   }
7752
7753   SmallVector<const SCEV *, 4> NewTerms;
7754
7755   // Remove constant factors.
7756   for (const SCEV *T : Terms)
7757     if (const SCEV *NewT = removeConstantFactors(SE, T))
7758       NewTerms.push_back(NewT);
7759
7760   DEBUG({
7761       dbgs() << "Terms after sorting:\n";
7762       for (const SCEV *T : NewTerms)
7763         dbgs() << *T << "\n";
7764     });
7765
7766   if (NewTerms.empty() ||
7767       !findArrayDimensionsRec(SE, NewTerms, Sizes)) {
7768     Sizes.clear();
7769     return;
7770   }
7771
7772   // The last element to be pushed into Sizes is the size of an element.
7773   Sizes.push_back(ElementSize);
7774
7775   DEBUG({
7776       dbgs() << "Sizes:\n";
7777       for (const SCEV *S : Sizes)
7778         dbgs() << *S << "\n";
7779     });
7780 }
7781
7782 /// Third step of delinearization: compute the access functions for the
7783 /// Subscripts based on the dimensions in Sizes.
7784 void SCEVAddRecExpr::computeAccessFunctions(
7785     ScalarEvolution &SE, SmallVectorImpl<const SCEV *> &Subscripts,
7786     SmallVectorImpl<const SCEV *> &Sizes) const {
7787
7788   // Early exit in case this SCEV is not an affine multivariate function.
7789   if (Sizes.empty() || !this->isAffine())
7790     return;
7791
7792   const SCEV *Res = this;
7793   int Last = Sizes.size() - 1;
7794   for (int i = Last; i >= 0; i--) {
7795     const SCEV *Q, *R;
7796     SCEVDivision::divide(SE, Res, Sizes[i], &Q, &R);
7797
7798     DEBUG({
7799         dbgs() << "Res: " << *Res << "\n";
7800         dbgs() << "Sizes[i]: " << *Sizes[i] << "\n";
7801         dbgs() << "Res divided by Sizes[i]:\n";
7802         dbgs() << "Quotient: " << *Q << "\n";
7803         dbgs() << "Remainder: " << *R << "\n";
7804       });
7805
7806     Res = Q;
7807
7808     // Do not record the last subscript corresponding to the size of elements in
7809     // the array.
7810     if (i == Last) {
7811
7812       // Bail out if the remainder is too complex.
7813       if (isa<SCEVAddRecExpr>(R)) {
7814         Subscripts.clear();
7815         Sizes.clear();
7816         return;
7817       }
7818
7819       continue;
7820     }
7821
7822     // Record the access function for the current subscript.
7823     Subscripts.push_back(R);
7824   }
7825
7826   // Also push in last position the remainder of the last division: it will be
7827   // the access function of the innermost dimension.
7828   Subscripts.push_back(Res);
7829
7830   std::reverse(Subscripts.begin(), Subscripts.end());
7831
7832   DEBUG({
7833       dbgs() << "Subscripts:\n";
7834       for (const SCEV *S : Subscripts)
7835         dbgs() << *S << "\n";
7836     });
7837 }
7838
7839 /// Splits the SCEV into two vectors of SCEVs representing the subscripts and
7840 /// sizes of an array access. Returns the remainder of the delinearization that
7841 /// is the offset start of the array.  The SCEV->delinearize algorithm computes
7842 /// the multiples of SCEV coefficients: that is a pattern matching of sub
7843 /// expressions in the stride and base of a SCEV corresponding to the
7844 /// computation of a GCD (greatest common divisor) of base and stride.  When
7845 /// SCEV->delinearize fails, it returns the SCEV unchanged.
7846 ///
7847 /// For example: when analyzing the memory access A[i][j][k] in this loop nest
7848 ///
7849 ///  void foo(long n, long m, long o, double A[n][m][o]) {
7850 ///
7851 ///    for (long i = 0; i < n; i++)
7852 ///      for (long j = 0; j < m; j++)
7853 ///        for (long k = 0; k < o; k++)
7854 ///          A[i][j][k] = 1.0;
7855 ///  }
7856 ///
7857 /// the delinearization input is the following AddRec SCEV:
7858 ///
7859 ///  AddRec: {{{%A,+,(8 * %m * %o)}<%for.i>,+,(8 * %o)}<%for.j>,+,8}<%for.k>
7860 ///
7861 /// From this SCEV, we are able to say that the base offset of the access is %A
7862 /// because it appears as an offset that does not divide any of the strides in
7863 /// the loops:
7864 ///
7865 ///  CHECK: Base offset: %A
7866 ///
7867 /// and then SCEV->delinearize determines the size of some of the dimensions of
7868 /// the array as these are the multiples by which the strides are happening:
7869 ///
7870 ///  CHECK: ArrayDecl[UnknownSize][%m][%o] with elements of sizeof(double) bytes.
7871 ///
7872 /// Note that the outermost dimension remains of UnknownSize because there are
7873 /// no strides that would help identifying the size of the last dimension: when
7874 /// the array has been statically allocated, one could compute the size of that
7875 /// dimension by dividing the overall size of the array by the size of the known
7876 /// dimensions: %m * %o * 8.
7877 ///
7878 /// Finally delinearize provides the access functions for the array reference
7879 /// that does correspond to A[i][j][k] of the above C testcase:
7880 ///
7881 ///  CHECK: ArrayRef[{0,+,1}<%for.i>][{0,+,1}<%for.j>][{0,+,1}<%for.k>]
7882 ///
7883 /// The testcases are checking the output of a function pass:
7884 /// DelinearizationPass that walks through all loads and stores of a function
7885 /// asking for the SCEV of the memory access with respect to all enclosing
7886 /// loops, calling SCEV->delinearize on that and printing the results.
7887
7888 void SCEVAddRecExpr::delinearize(ScalarEvolution &SE,
7889                                  SmallVectorImpl<const SCEV *> &Subscripts,
7890                                  SmallVectorImpl<const SCEV *> &Sizes,
7891                                  const SCEV *ElementSize) const {
7892   // First step: collect parametric terms.
7893   SmallVector<const SCEV *, 4> Terms;
7894   collectParametricTerms(SE, Terms);
7895
7896   if (Terms.empty())
7897     return;
7898
7899   // Second step: find subscript sizes.
7900   SE.findArrayDimensions(Terms, Sizes, ElementSize);
7901
7902   if (Sizes.empty())
7903     return;
7904
7905   // Third step: compute the access functions for each subscript.
7906   computeAccessFunctions(SE, Subscripts, Sizes);
7907
7908   if (Subscripts.empty())
7909     return;
7910
7911   DEBUG({
7912       dbgs() << "succeeded to delinearize " << *this << "\n";
7913       dbgs() << "ArrayDecl[UnknownSize]";
7914       for (const SCEV *S : Sizes)
7915         dbgs() << "[" << *S << "]";
7916
7917       dbgs() << "\nArrayRef";
7918       for (const SCEV *S : Subscripts)
7919         dbgs() << "[" << *S << "]";
7920       dbgs() << "\n";
7921     });
7922 }
7923
7924 //===----------------------------------------------------------------------===//
7925 //                   SCEVCallbackVH Class Implementation
7926 //===----------------------------------------------------------------------===//
7927
7928 void ScalarEvolution::SCEVCallbackVH::deleted() {
7929   assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
7930   if (PHINode *PN = dyn_cast<PHINode>(getValPtr()))
7931     SE->ConstantEvolutionLoopExitValue.erase(PN);
7932   SE->ValueExprMap.erase(getValPtr());
7933   // this now dangles!
7934 }
7935
7936 void ScalarEvolution::SCEVCallbackVH::allUsesReplacedWith(Value *V) {
7937   assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
7938
7939   // Forget all the expressions associated with users of the old value,
7940   // so that future queries will recompute the expressions using the new
7941   // value.
7942   Value *Old = getValPtr();
7943   SmallVector<User *, 16> Worklist(Old->user_begin(), Old->user_end());
7944   SmallPtrSet<User *, 8> Visited;
7945   while (!Worklist.empty()) {
7946     User *U = Worklist.pop_back_val();
7947     // Deleting the Old value will cause this to dangle. Postpone
7948     // that until everything else is done.
7949     if (U == Old)
7950       continue;
7951     if (!Visited.insert(U).second)
7952       continue;
7953     if (PHINode *PN = dyn_cast<PHINode>(U))
7954       SE->ConstantEvolutionLoopExitValue.erase(PN);
7955     SE->ValueExprMap.erase(U);
7956     Worklist.insert(Worklist.end(), U->user_begin(), U->user_end());
7957   }
7958   // Delete the Old value.
7959   if (PHINode *PN = dyn_cast<PHINode>(Old))
7960     SE->ConstantEvolutionLoopExitValue.erase(PN);
7961   SE->ValueExprMap.erase(Old);
7962   // this now dangles!
7963 }
7964
7965 ScalarEvolution::SCEVCallbackVH::SCEVCallbackVH(Value *V, ScalarEvolution *se)
7966   : CallbackVH(V), SE(se) {}
7967
7968 //===----------------------------------------------------------------------===//
7969 //                   ScalarEvolution Class Implementation
7970 //===----------------------------------------------------------------------===//
7971
7972 ScalarEvolution::ScalarEvolution()
7973   : FunctionPass(ID), ValuesAtScopes(64), LoopDispositions(64),
7974     BlockDispositions(64), FirstUnknown(nullptr) {
7975   initializeScalarEvolutionPass(*PassRegistry::getPassRegistry());
7976 }
7977
7978 bool ScalarEvolution::runOnFunction(Function &F) {
7979   this->F = &F;
7980   AC = &getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F);
7981   LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
7982   TLI = &getAnalysis<TargetLibraryInfoWrapperPass>().getTLI();
7983   DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
7984   return false;
7985 }
7986
7987 void ScalarEvolution::releaseMemory() {
7988   // Iterate through all the SCEVUnknown instances and call their
7989   // destructors, so that they release their references to their values.
7990   for (SCEVUnknown *U = FirstUnknown; U; U = U->Next)
7991     U->~SCEVUnknown();
7992   FirstUnknown = nullptr;
7993
7994   ValueExprMap.clear();
7995
7996   // Free any extra memory created for ExitNotTakenInfo in the unlikely event
7997   // that a loop had multiple computable exits.
7998   for (DenseMap<const Loop*, BackedgeTakenInfo>::iterator I =
7999          BackedgeTakenCounts.begin(), E = BackedgeTakenCounts.end();
8000        I != E; ++I) {
8001     I->second.clear();
8002   }
8003
8004   assert(PendingLoopPredicates.empty() && "isImpliedCond garbage");
8005
8006   BackedgeTakenCounts.clear();
8007   ConstantEvolutionLoopExitValue.clear();
8008   ValuesAtScopes.clear();
8009   LoopDispositions.clear();
8010   BlockDispositions.clear();
8011   UnsignedRanges.clear();
8012   SignedRanges.clear();
8013   UniqueSCEVs.clear();
8014   SCEVAllocator.Reset();
8015 }
8016
8017 void ScalarEvolution::getAnalysisUsage(AnalysisUsage &AU) const {
8018   AU.setPreservesAll();
8019   AU.addRequired<AssumptionCacheTracker>();
8020   AU.addRequiredTransitive<LoopInfoWrapperPass>();
8021   AU.addRequiredTransitive<DominatorTreeWrapperPass>();
8022   AU.addRequired<TargetLibraryInfoWrapperPass>();
8023 }
8024
8025 bool ScalarEvolution::hasLoopInvariantBackedgeTakenCount(const Loop *L) {
8026   return !isa<SCEVCouldNotCompute>(getBackedgeTakenCount(L));
8027 }
8028
8029 static void PrintLoopInfo(raw_ostream &OS, ScalarEvolution *SE,
8030                           const Loop *L) {
8031   // Print all inner loops first
8032   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
8033     PrintLoopInfo(OS, SE, *I);
8034
8035   OS << "Loop ";
8036   L->getHeader()->printAsOperand(OS, /*PrintType=*/false);
8037   OS << ": ";
8038
8039   SmallVector<BasicBlock *, 8> ExitBlocks;
8040   L->getExitBlocks(ExitBlocks);
8041   if (ExitBlocks.size() != 1)
8042     OS << "<multiple exits> ";
8043
8044   if (SE->hasLoopInvariantBackedgeTakenCount(L)) {
8045     OS << "backedge-taken count is " << *SE->getBackedgeTakenCount(L);
8046   } else {
8047     OS << "Unpredictable backedge-taken count. ";
8048   }
8049
8050   OS << "\n"
8051         "Loop ";
8052   L->getHeader()->printAsOperand(OS, /*PrintType=*/false);
8053   OS << ": ";
8054
8055   if (!isa<SCEVCouldNotCompute>(SE->getMaxBackedgeTakenCount(L))) {
8056     OS << "max backedge-taken count is " << *SE->getMaxBackedgeTakenCount(L);
8057   } else {
8058     OS << "Unpredictable max backedge-taken count. ";
8059   }
8060
8061   OS << "\n";
8062 }
8063
8064 void ScalarEvolution::print(raw_ostream &OS, const Module *) const {
8065   // ScalarEvolution's implementation of the print method is to print
8066   // out SCEV values of all instructions that are interesting. Doing
8067   // this potentially causes it to create new SCEV objects though,
8068   // which technically conflicts with the const qualifier. This isn't
8069   // observable from outside the class though, so casting away the
8070   // const isn't dangerous.
8071   ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
8072
8073   OS << "Classifying expressions for: ";
8074   F->printAsOperand(OS, /*PrintType=*/false);
8075   OS << "\n";
8076   for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
8077     if (isSCEVable(I->getType()) && !isa<CmpInst>(*I)) {
8078       OS << *I << '\n';
8079       OS << "  -->  ";
8080       const SCEV *SV = SE.getSCEV(&*I);
8081       SV->print(OS);
8082       if (!isa<SCEVCouldNotCompute>(SV)) {
8083         OS << " U: ";
8084         SE.getUnsignedRange(SV).print(OS);
8085         OS << " S: ";
8086         SE.getSignedRange(SV).print(OS);
8087       }
8088
8089       const Loop *L = LI->getLoopFor((*I).getParent());
8090
8091       const SCEV *AtUse = SE.getSCEVAtScope(SV, L);
8092       if (AtUse != SV) {
8093         OS << "  -->  ";
8094         AtUse->print(OS);
8095         if (!isa<SCEVCouldNotCompute>(AtUse)) {
8096           OS << " U: ";
8097           SE.getUnsignedRange(AtUse).print(OS);
8098           OS << " S: ";
8099           SE.getSignedRange(AtUse).print(OS);
8100         }
8101       }
8102
8103       if (L) {
8104         OS << "\t\t" "Exits: ";
8105         const SCEV *ExitValue = SE.getSCEVAtScope(SV, L->getParentLoop());
8106         if (!SE.isLoopInvariant(ExitValue, L)) {
8107           OS << "<<Unknown>>";
8108         } else {
8109           OS << *ExitValue;
8110         }
8111       }
8112
8113       OS << "\n";
8114     }
8115
8116   OS << "Determining loop execution counts for: ";
8117   F->printAsOperand(OS, /*PrintType=*/false);
8118   OS << "\n";
8119   for (LoopInfo::iterator I = LI->begin(), E = LI->end(); I != E; ++I)
8120     PrintLoopInfo(OS, &SE, *I);
8121 }
8122
8123 ScalarEvolution::LoopDisposition
8124 ScalarEvolution::getLoopDisposition(const SCEV *S, const Loop *L) {
8125   auto &Values = LoopDispositions[S];
8126   for (auto &V : Values) {
8127     if (V.getPointer() == L)
8128       return V.getInt();
8129   }
8130   Values.emplace_back(L, LoopVariant);
8131   LoopDisposition D = computeLoopDisposition(S, L);
8132   auto &Values2 = LoopDispositions[S];
8133   for (auto &V : make_range(Values2.rbegin(), Values2.rend())) {
8134     if (V.getPointer() == L) {
8135       V.setInt(D);
8136       break;
8137     }
8138   }
8139   return D;
8140 }
8141
8142 ScalarEvolution::LoopDisposition
8143 ScalarEvolution::computeLoopDisposition(const SCEV *S, const Loop *L) {
8144   switch (static_cast<SCEVTypes>(S->getSCEVType())) {
8145   case scConstant:
8146     return LoopInvariant;
8147   case scTruncate:
8148   case scZeroExtend:
8149   case scSignExtend:
8150     return getLoopDisposition(cast<SCEVCastExpr>(S)->getOperand(), L);
8151   case scAddRecExpr: {
8152     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S);
8153
8154     // If L is the addrec's loop, it's computable.
8155     if (AR->getLoop() == L)
8156       return LoopComputable;
8157
8158     // Add recurrences are never invariant in the function-body (null loop).
8159     if (!L)
8160       return LoopVariant;
8161
8162     // This recurrence is variant w.r.t. L if L contains AR's loop.
8163     if (L->contains(AR->getLoop()))
8164       return LoopVariant;
8165
8166     // This recurrence is invariant w.r.t. L if AR's loop contains L.
8167     if (AR->getLoop()->contains(L))
8168       return LoopInvariant;
8169
8170     // This recurrence is variant w.r.t. L if any of its operands
8171     // are variant.
8172     for (SCEVAddRecExpr::op_iterator I = AR->op_begin(), E = AR->op_end();
8173          I != E; ++I)
8174       if (!isLoopInvariant(*I, L))
8175         return LoopVariant;
8176
8177     // Otherwise it's loop-invariant.
8178     return LoopInvariant;
8179   }
8180   case scAddExpr:
8181   case scMulExpr:
8182   case scUMaxExpr:
8183   case scSMaxExpr: {
8184     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S);
8185     bool HasVarying = false;
8186     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
8187          I != E; ++I) {
8188       LoopDisposition D = getLoopDisposition(*I, L);
8189       if (D == LoopVariant)
8190         return LoopVariant;
8191       if (D == LoopComputable)
8192         HasVarying = true;
8193     }
8194     return HasVarying ? LoopComputable : LoopInvariant;
8195   }
8196   case scUDivExpr: {
8197     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
8198     LoopDisposition LD = getLoopDisposition(UDiv->getLHS(), L);
8199     if (LD == LoopVariant)
8200       return LoopVariant;
8201     LoopDisposition RD = getLoopDisposition(UDiv->getRHS(), L);
8202     if (RD == LoopVariant)
8203       return LoopVariant;
8204     return (LD == LoopInvariant && RD == LoopInvariant) ?
8205            LoopInvariant : LoopComputable;
8206   }
8207   case scUnknown:
8208     // All non-instruction values are loop invariant.  All instructions are loop
8209     // invariant if they are not contained in the specified loop.
8210     // Instructions are never considered invariant in the function body
8211     // (null loop) because they are defined within the "loop".
8212     if (Instruction *I = dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue()))
8213       return (L && !L->contains(I)) ? LoopInvariant : LoopVariant;
8214     return LoopInvariant;
8215   case scCouldNotCompute:
8216     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
8217   }
8218   llvm_unreachable("Unknown SCEV kind!");
8219 }
8220
8221 bool ScalarEvolution::isLoopInvariant(const SCEV *S, const Loop *L) {
8222   return getLoopDisposition(S, L) == LoopInvariant;
8223 }
8224
8225 bool ScalarEvolution::hasComputableLoopEvolution(const SCEV *S, const Loop *L) {
8226   return getLoopDisposition(S, L) == LoopComputable;
8227 }
8228
8229 ScalarEvolution::BlockDisposition
8230 ScalarEvolution::getBlockDisposition(const SCEV *S, const BasicBlock *BB) {
8231   auto &Values = BlockDispositions[S];
8232   for (auto &V : Values) {
8233     if (V.getPointer() == BB)
8234       return V.getInt();
8235   }
8236   Values.emplace_back(BB, DoesNotDominateBlock);
8237   BlockDisposition D = computeBlockDisposition(S, BB);
8238   auto &Values2 = BlockDispositions[S];
8239   for (auto &V : make_range(Values2.rbegin(), Values2.rend())) {
8240     if (V.getPointer() == BB) {
8241       V.setInt(D);
8242       break;
8243     }
8244   }
8245   return D;
8246 }
8247
8248 ScalarEvolution::BlockDisposition
8249 ScalarEvolution::computeBlockDisposition(const SCEV *S, const BasicBlock *BB) {
8250   switch (static_cast<SCEVTypes>(S->getSCEVType())) {
8251   case scConstant:
8252     return ProperlyDominatesBlock;
8253   case scTruncate:
8254   case scZeroExtend:
8255   case scSignExtend:
8256     return getBlockDisposition(cast<SCEVCastExpr>(S)->getOperand(), BB);
8257   case scAddRecExpr: {
8258     // This uses a "dominates" query instead of "properly dominates" query
8259     // to test for proper dominance too, because the instruction which
8260     // produces the addrec's value is a PHI, and a PHI effectively properly
8261     // dominates its entire containing block.
8262     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S);
8263     if (!DT->dominates(AR->getLoop()->getHeader(), BB))
8264       return DoesNotDominateBlock;
8265   }
8266   // FALL THROUGH into SCEVNAryExpr handling.
8267   case scAddExpr:
8268   case scMulExpr:
8269   case scUMaxExpr:
8270   case scSMaxExpr: {
8271     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S);
8272     bool Proper = true;
8273     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
8274          I != E; ++I) {
8275       BlockDisposition D = getBlockDisposition(*I, BB);
8276       if (D == DoesNotDominateBlock)
8277         return DoesNotDominateBlock;
8278       if (D == DominatesBlock)
8279         Proper = false;
8280     }
8281     return Proper ? ProperlyDominatesBlock : DominatesBlock;
8282   }
8283   case scUDivExpr: {
8284     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
8285     const SCEV *LHS = UDiv->getLHS(), *RHS = UDiv->getRHS();
8286     BlockDisposition LD = getBlockDisposition(LHS, BB);
8287     if (LD == DoesNotDominateBlock)
8288       return DoesNotDominateBlock;
8289     BlockDisposition RD = getBlockDisposition(RHS, BB);
8290     if (RD == DoesNotDominateBlock)
8291       return DoesNotDominateBlock;
8292     return (LD == ProperlyDominatesBlock && RD == ProperlyDominatesBlock) ?
8293       ProperlyDominatesBlock : DominatesBlock;
8294   }
8295   case scUnknown:
8296     if (Instruction *I =
8297           dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue())) {
8298       if (I->getParent() == BB)
8299         return DominatesBlock;
8300       if (DT->properlyDominates(I->getParent(), BB))
8301         return ProperlyDominatesBlock;
8302       return DoesNotDominateBlock;
8303     }
8304     return ProperlyDominatesBlock;
8305   case scCouldNotCompute:
8306     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
8307   }
8308   llvm_unreachable("Unknown SCEV kind!");
8309 }
8310
8311 bool ScalarEvolution::dominates(const SCEV *S, const BasicBlock *BB) {
8312   return getBlockDisposition(S, BB) >= DominatesBlock;
8313 }
8314
8315 bool ScalarEvolution::properlyDominates(const SCEV *S, const BasicBlock *BB) {
8316   return getBlockDisposition(S, BB) == ProperlyDominatesBlock;
8317 }
8318
8319 namespace {
8320 // Search for a SCEV expression node within an expression tree.
8321 // Implements SCEVTraversal::Visitor.
8322 struct SCEVSearch {
8323   const SCEV *Node;
8324   bool IsFound;
8325
8326   SCEVSearch(const SCEV *N): Node(N), IsFound(false) {}
8327
8328   bool follow(const SCEV *S) {
8329     IsFound |= (S == Node);
8330     return !IsFound;
8331   }
8332   bool isDone() const { return IsFound; }
8333 };
8334 }
8335
8336 bool ScalarEvolution::hasOperand(const SCEV *S, const SCEV *Op) const {
8337   SCEVSearch Search(Op);
8338   visitAll(S, Search);
8339   return Search.IsFound;
8340 }
8341
8342 void ScalarEvolution::forgetMemoizedResults(const SCEV *S) {
8343   ValuesAtScopes.erase(S);
8344   LoopDispositions.erase(S);
8345   BlockDispositions.erase(S);
8346   UnsignedRanges.erase(S);
8347   SignedRanges.erase(S);
8348
8349   for (DenseMap<const Loop*, BackedgeTakenInfo>::iterator I =
8350          BackedgeTakenCounts.begin(), E = BackedgeTakenCounts.end(); I != E; ) {
8351     BackedgeTakenInfo &BEInfo = I->second;
8352     if (BEInfo.hasOperand(S, this)) {
8353       BEInfo.clear();
8354       BackedgeTakenCounts.erase(I++);
8355     }
8356     else
8357       ++I;
8358   }
8359 }
8360
8361 typedef DenseMap<const Loop *, std::string> VerifyMap;
8362
8363 /// replaceSubString - Replaces all occurrences of From in Str with To.
8364 static void replaceSubString(std::string &Str, StringRef From, StringRef To) {
8365   size_t Pos = 0;
8366   while ((Pos = Str.find(From, Pos)) != std::string::npos) {
8367     Str.replace(Pos, From.size(), To.data(), To.size());
8368     Pos += To.size();
8369   }
8370 }
8371
8372 /// getLoopBackedgeTakenCounts - Helper method for verifyAnalysis.
8373 static void
8374 getLoopBackedgeTakenCounts(Loop *L, VerifyMap &Map, ScalarEvolution &SE) {
8375   for (Loop::reverse_iterator I = L->rbegin(), E = L->rend(); I != E; ++I) {
8376     getLoopBackedgeTakenCounts(*I, Map, SE); // recurse.
8377
8378     std::string &S = Map[L];
8379     if (S.empty()) {
8380       raw_string_ostream OS(S);
8381       SE.getBackedgeTakenCount(L)->print(OS);
8382
8383       // false and 0 are semantically equivalent. This can happen in dead loops.
8384       replaceSubString(OS.str(), "false", "0");
8385       // Remove wrap flags, their use in SCEV is highly fragile.
8386       // FIXME: Remove this when SCEV gets smarter about them.
8387       replaceSubString(OS.str(), "<nw>", "");
8388       replaceSubString(OS.str(), "<nsw>", "");
8389       replaceSubString(OS.str(), "<nuw>", "");
8390     }
8391   }
8392 }
8393
8394 void ScalarEvolution::verifyAnalysis() const {
8395   if (!VerifySCEV)
8396     return;
8397
8398   ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
8399
8400   // Gather stringified backedge taken counts for all loops using SCEV's caches.
8401   // FIXME: It would be much better to store actual values instead of strings,
8402   //        but SCEV pointers will change if we drop the caches.
8403   VerifyMap BackedgeDumpsOld, BackedgeDumpsNew;
8404   for (LoopInfo::reverse_iterator I = LI->rbegin(), E = LI->rend(); I != E; ++I)
8405     getLoopBackedgeTakenCounts(*I, BackedgeDumpsOld, SE);
8406
8407   // Gather stringified backedge taken counts for all loops without using
8408   // SCEV's caches.
8409   SE.releaseMemory();
8410   for (LoopInfo::reverse_iterator I = LI->rbegin(), E = LI->rend(); I != E; ++I)
8411     getLoopBackedgeTakenCounts(*I, BackedgeDumpsNew, SE);
8412
8413   // Now compare whether they're the same with and without caches. This allows
8414   // verifying that no pass changed the cache.
8415   assert(BackedgeDumpsOld.size() == BackedgeDumpsNew.size() &&
8416          "New loops suddenly appeared!");
8417
8418   for (VerifyMap::iterator OldI = BackedgeDumpsOld.begin(),
8419                            OldE = BackedgeDumpsOld.end(),
8420                            NewI = BackedgeDumpsNew.begin();
8421        OldI != OldE; ++OldI, ++NewI) {
8422     assert(OldI->first == NewI->first && "Loop order changed!");
8423
8424     // Compare the stringified SCEVs. We don't care if undef backedgetaken count
8425     // changes.
8426     // FIXME: We currently ignore SCEV changes from/to CouldNotCompute. This
8427     // means that a pass is buggy or SCEV has to learn a new pattern but is
8428     // usually not harmful.
8429     if (OldI->second != NewI->second &&
8430         OldI->second.find("undef") == std::string::npos &&
8431         NewI->second.find("undef") == std::string::npos &&
8432         OldI->second != "***COULDNOTCOMPUTE***" &&
8433         NewI->second != "***COULDNOTCOMPUTE***") {
8434       dbgs() << "SCEVValidator: SCEV for loop '"
8435              << OldI->first->getHeader()->getName()
8436              << "' changed from '" << OldI->second
8437              << "' to '" << NewI->second << "'!\n";
8438       std::abort();
8439     }
8440   }
8441
8442   // TODO: Verify more things.
8443 }