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->hasNoUnsignedWrap())
3595                   Flags = setFlags(Flags, SCEV::FlagNUW);
3596                 if (OBO->hasNoSignedWrap())
3597                   Flags = setFlags(Flags, SCEV::FlagNSW);
3598               } else if (GEPOperator *GEP = dyn_cast<GEPOperator>(BEValueV)) {
3599                 // If the increment is an inbounds GEP, then we know the address
3600                 // space cannot be wrapped around. We cannot make any guarantee
3601                 // about signed or unsigned overflow because pointers are
3602                 // unsigned but we may have a negative index from the base
3603                 // pointer. We can guarantee that no unsigned wrap occurs if the
3604                 // indices form a positive value.
3605                 if (GEP->isInBounds()) {
3606                   Flags = setFlags(Flags, SCEV::FlagNW);
3607
3608                   const SCEV *Ptr = getSCEV(GEP->getPointerOperand());
3609                   if (isKnownPositive(getMinusSCEV(getSCEV(GEP), Ptr)))
3610                     Flags = setFlags(Flags, SCEV::FlagNUW);
3611                 }
3612
3613                 // We cannot transfer nuw and nsw flags from subtraction
3614                 // operations -- sub nuw X, Y is not the same as add nuw X, -Y
3615                 // for instance.
3616               }
3617
3618               const SCEV *StartVal = getSCEV(StartValueV);
3619               const SCEV *PHISCEV = getAddRecExpr(StartVal, Accum, L, Flags);
3620
3621               // Since the no-wrap flags are on the increment, they apply to the
3622               // post-incremented value as well.
3623               if (isLoopInvariant(Accum, L))
3624                 (void)getAddRecExpr(getAddExpr(StartVal, Accum),
3625                                     Accum, L, Flags);
3626
3627               // Okay, for the entire analysis of this edge we assumed the PHI
3628               // to be symbolic.  We now need to go back and purge all of the
3629               // entries for the scalars that use the symbolic expression.
3630               ForgetSymbolicName(PN, SymbolicName);
3631               ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
3632               return PHISCEV;
3633             }
3634           }
3635         } else if (const SCEVAddRecExpr *AddRec =
3636                      dyn_cast<SCEVAddRecExpr>(BEValue)) {
3637           // Otherwise, this could be a loop like this:
3638           //     i = 0;  for (j = 1; ..; ++j) { ....  i = j; }
3639           // In this case, j = {1,+,1}  and BEValue is j.
3640           // Because the other in-value of i (0) fits the evolution of BEValue
3641           // i really is an addrec evolution.
3642           if (AddRec->getLoop() == L && AddRec->isAffine()) {
3643             const SCEV *StartVal = getSCEV(StartValueV);
3644
3645             // If StartVal = j.start - j.stride, we can use StartVal as the
3646             // initial step of the addrec evolution.
3647             if (StartVal == getMinusSCEV(AddRec->getOperand(0),
3648                                          AddRec->getOperand(1))) {
3649               // FIXME: For constant StartVal, we should be able to infer
3650               // no-wrap flags.
3651               const SCEV *PHISCEV =
3652                 getAddRecExpr(StartVal, AddRec->getOperand(1), L,
3653                               SCEV::FlagAnyWrap);
3654
3655               // Okay, for the entire analysis of this edge we assumed the PHI
3656               // to be symbolic.  We now need to go back and purge all of the
3657               // entries for the scalars that use the symbolic expression.
3658               ForgetSymbolicName(PN, SymbolicName);
3659               ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
3660               return PHISCEV;
3661             }
3662           }
3663         }
3664       }
3665     }
3666
3667   // If the PHI has a single incoming value, follow that value, unless the
3668   // PHI's incoming blocks are in a different loop, in which case doing so
3669   // risks breaking LCSSA form. Instcombine would normally zap these, but
3670   // it doesn't have DominatorTree information, so it may miss cases.
3671   if (Value *V =
3672           SimplifyInstruction(PN, F->getParent()->getDataLayout(), TLI, DT, AC))
3673     if (LI->replacementPreservesLCSSAForm(PN, V))
3674       return getSCEV(V);
3675
3676   // If it's not a loop phi, we can't handle it yet.
3677   return getUnknown(PN);
3678 }
3679
3680 /// createNodeForGEP - Expand GEP instructions into add and multiply
3681 /// operations. This allows them to be analyzed by regular SCEV code.
3682 ///
3683 const SCEV *ScalarEvolution::createNodeForGEP(GEPOperator *GEP) {
3684   Type *IntPtrTy = getEffectiveSCEVType(GEP->getType());
3685   Value *Base = GEP->getOperand(0);
3686   // Don't attempt to analyze GEPs over unsized objects.
3687   if (!Base->getType()->getPointerElementType()->isSized())
3688     return getUnknown(GEP);
3689
3690   // Don't blindly transfer the inbounds flag from the GEP instruction to the
3691   // Add expression, because the Instruction may be guarded by control flow
3692   // and the no-overflow bits may not be valid for the expression in any
3693   // context.
3694   SCEV::NoWrapFlags Wrap = GEP->isInBounds() ? SCEV::FlagNSW : SCEV::FlagAnyWrap;
3695
3696   const SCEV *TotalOffset = getConstant(IntPtrTy, 0);
3697   gep_type_iterator GTI = gep_type_begin(GEP);
3698   for (GetElementPtrInst::op_iterator I = std::next(GEP->op_begin()),
3699                                       E = GEP->op_end();
3700        I != E; ++I) {
3701     Value *Index = *I;
3702     // Compute the (potentially symbolic) offset in bytes for this index.
3703     if (StructType *STy = dyn_cast<StructType>(*GTI++)) {
3704       // For a struct, add the member offset.
3705       unsigned FieldNo = cast<ConstantInt>(Index)->getZExtValue();
3706       const SCEV *FieldOffset = getOffsetOfExpr(IntPtrTy, STy, FieldNo);
3707
3708       // Add the field offset to the running total offset.
3709       TotalOffset = getAddExpr(TotalOffset, FieldOffset);
3710     } else {
3711       // For an array, add the element offset, explicitly scaled.
3712       const SCEV *ElementSize = getSizeOfExpr(IntPtrTy, *GTI);
3713       const SCEV *IndexS = getSCEV(Index);
3714       // Getelementptr indices are signed.
3715       IndexS = getTruncateOrSignExtend(IndexS, IntPtrTy);
3716
3717       // Multiply the index by the element size to compute the element offset.
3718       const SCEV *LocalOffset = getMulExpr(IndexS, ElementSize, Wrap);
3719
3720       // Add the element offset to the running total offset.
3721       TotalOffset = getAddExpr(TotalOffset, LocalOffset);
3722     }
3723   }
3724
3725   // Get the SCEV for the GEP base.
3726   const SCEV *BaseS = getSCEV(Base);
3727
3728   // Add the total offset from all the GEP indices to the base.
3729   return getAddExpr(BaseS, TotalOffset, Wrap);
3730 }
3731
3732 /// GetMinTrailingZeros - Determine the minimum number of zero bits that S is
3733 /// guaranteed to end in (at every loop iteration).  It is, at the same time,
3734 /// the minimum number of times S is divisible by 2.  For example, given {4,+,8}
3735 /// it returns 2.  If S is guaranteed to be 0, it returns the bitwidth of S.
3736 uint32_t
3737 ScalarEvolution::GetMinTrailingZeros(const SCEV *S) {
3738   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
3739     return C->getValue()->getValue().countTrailingZeros();
3740
3741   if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(S))
3742     return std::min(GetMinTrailingZeros(T->getOperand()),
3743                     (uint32_t)getTypeSizeInBits(T->getType()));
3744
3745   if (const SCEVZeroExtendExpr *E = dyn_cast<SCEVZeroExtendExpr>(S)) {
3746     uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
3747     return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
3748              getTypeSizeInBits(E->getType()) : OpRes;
3749   }
3750
3751   if (const SCEVSignExtendExpr *E = dyn_cast<SCEVSignExtendExpr>(S)) {
3752     uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
3753     return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
3754              getTypeSizeInBits(E->getType()) : OpRes;
3755   }
3756
3757   if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(S)) {
3758     // The result is the min of all operands results.
3759     uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
3760     for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
3761       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
3762     return MinOpRes;
3763   }
3764
3765   if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(S)) {
3766     // The result is the sum of all operands results.
3767     uint32_t SumOpRes = GetMinTrailingZeros(M->getOperand(0));
3768     uint32_t BitWidth = getTypeSizeInBits(M->getType());
3769     for (unsigned i = 1, e = M->getNumOperands();
3770          SumOpRes != BitWidth && i != e; ++i)
3771       SumOpRes = std::min(SumOpRes + GetMinTrailingZeros(M->getOperand(i)),
3772                           BitWidth);
3773     return SumOpRes;
3774   }
3775
3776   if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(S)) {
3777     // The result is the min of all operands results.
3778     uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
3779     for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
3780       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
3781     return MinOpRes;
3782   }
3783
3784   if (const SCEVSMaxExpr *M = dyn_cast<SCEVSMaxExpr>(S)) {
3785     // The result is the min of all operands results.
3786     uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
3787     for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
3788       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
3789     return MinOpRes;
3790   }
3791
3792   if (const SCEVUMaxExpr *M = dyn_cast<SCEVUMaxExpr>(S)) {
3793     // The result is the min of all operands results.
3794     uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
3795     for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
3796       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
3797     return MinOpRes;
3798   }
3799
3800   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
3801     // For a SCEVUnknown, ask ValueTracking.
3802     unsigned BitWidth = getTypeSizeInBits(U->getType());
3803     APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
3804     computeKnownBits(U->getValue(), Zeros, Ones,
3805                      F->getParent()->getDataLayout(), 0, AC, nullptr, DT);
3806     return Zeros.countTrailingOnes();
3807   }
3808
3809   // SCEVUDivExpr
3810   return 0;
3811 }
3812
3813 /// GetRangeFromMetadata - Helper method to assign a range to V from
3814 /// metadata present in the IR.
3815 static Optional<ConstantRange> GetRangeFromMetadata(Value *V) {
3816   if (Instruction *I = dyn_cast<Instruction>(V)) {
3817     if (MDNode *MD = I->getMetadata(LLVMContext::MD_range)) {
3818       ConstantRange TotalRange(
3819           cast<IntegerType>(I->getType())->getBitWidth(), false);
3820
3821       unsigned NumRanges = MD->getNumOperands() / 2;
3822       assert(NumRanges >= 1);
3823
3824       for (unsigned i = 0; i < NumRanges; ++i) {
3825         ConstantInt *Lower =
3826             mdconst::extract<ConstantInt>(MD->getOperand(2 * i + 0));
3827         ConstantInt *Upper =
3828             mdconst::extract<ConstantInt>(MD->getOperand(2 * i + 1));
3829         ConstantRange Range(Lower->getValue(), Upper->getValue());
3830         TotalRange = TotalRange.unionWith(Range);
3831       }
3832
3833       return TotalRange;
3834     }
3835   }
3836
3837   return None;
3838 }
3839
3840 /// getRange - Determine the range for a particular SCEV.  If SignHint is
3841 /// HINT_RANGE_UNSIGNED (resp. HINT_RANGE_SIGNED) then getRange prefers ranges
3842 /// with a "cleaner" unsigned (resp. signed) representation.
3843 ///
3844 ConstantRange
3845 ScalarEvolution::getRange(const SCEV *S,
3846                           ScalarEvolution::RangeSignHint SignHint) {
3847   DenseMap<const SCEV *, ConstantRange> &Cache =
3848       SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED ? UnsignedRanges
3849                                                        : SignedRanges;
3850
3851   // See if we've computed this range already.
3852   DenseMap<const SCEV *, ConstantRange>::iterator I = Cache.find(S);
3853   if (I != Cache.end())
3854     return I->second;
3855
3856   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
3857     return setRange(C, SignHint, ConstantRange(C->getValue()->getValue()));
3858
3859   unsigned BitWidth = getTypeSizeInBits(S->getType());
3860   ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true);
3861
3862   // If the value has known zeros, the maximum value will have those known zeros
3863   // as well.
3864   uint32_t TZ = GetMinTrailingZeros(S);
3865   if (TZ != 0) {
3866     if (SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED)
3867       ConservativeResult =
3868           ConstantRange(APInt::getMinValue(BitWidth),
3869                         APInt::getMaxValue(BitWidth).lshr(TZ).shl(TZ) + 1);
3870     else
3871       ConservativeResult = ConstantRange(
3872           APInt::getSignedMinValue(BitWidth),
3873           APInt::getSignedMaxValue(BitWidth).ashr(TZ).shl(TZ) + 1);
3874   }
3875
3876   if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
3877     ConstantRange X = getRange(Add->getOperand(0), SignHint);
3878     for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i)
3879       X = X.add(getRange(Add->getOperand(i), SignHint));
3880     return setRange(Add, SignHint, ConservativeResult.intersectWith(X));
3881   }
3882
3883   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
3884     ConstantRange X = getRange(Mul->getOperand(0), SignHint);
3885     for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i)
3886       X = X.multiply(getRange(Mul->getOperand(i), SignHint));
3887     return setRange(Mul, SignHint, ConservativeResult.intersectWith(X));
3888   }
3889
3890   if (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(S)) {
3891     ConstantRange X = getRange(SMax->getOperand(0), SignHint);
3892     for (unsigned i = 1, e = SMax->getNumOperands(); i != e; ++i)
3893       X = X.smax(getRange(SMax->getOperand(i), SignHint));
3894     return setRange(SMax, SignHint, ConservativeResult.intersectWith(X));
3895   }
3896
3897   if (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(S)) {
3898     ConstantRange X = getRange(UMax->getOperand(0), SignHint);
3899     for (unsigned i = 1, e = UMax->getNumOperands(); i != e; ++i)
3900       X = X.umax(getRange(UMax->getOperand(i), SignHint));
3901     return setRange(UMax, SignHint, ConservativeResult.intersectWith(X));
3902   }
3903
3904   if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) {
3905     ConstantRange X = getRange(UDiv->getLHS(), SignHint);
3906     ConstantRange Y = getRange(UDiv->getRHS(), SignHint);
3907     return setRange(UDiv, SignHint,
3908                     ConservativeResult.intersectWith(X.udiv(Y)));
3909   }
3910
3911   if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) {
3912     ConstantRange X = getRange(ZExt->getOperand(), SignHint);
3913     return setRange(ZExt, SignHint,
3914                     ConservativeResult.intersectWith(X.zeroExtend(BitWidth)));
3915   }
3916
3917   if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) {
3918     ConstantRange X = getRange(SExt->getOperand(), SignHint);
3919     return setRange(SExt, SignHint,
3920                     ConservativeResult.intersectWith(X.signExtend(BitWidth)));
3921   }
3922
3923   if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) {
3924     ConstantRange X = getRange(Trunc->getOperand(), SignHint);
3925     return setRange(Trunc, SignHint,
3926                     ConservativeResult.intersectWith(X.truncate(BitWidth)));
3927   }
3928
3929   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) {
3930     // If there's no unsigned wrap, the value will never be less than its
3931     // initial value.
3932     if (AddRec->getNoWrapFlags(SCEV::FlagNUW))
3933       if (const SCEVConstant *C = dyn_cast<SCEVConstant>(AddRec->getStart()))
3934         if (!C->getValue()->isZero())
3935           ConservativeResult =
3936             ConservativeResult.intersectWith(
3937               ConstantRange(C->getValue()->getValue(), APInt(BitWidth, 0)));
3938
3939     // If there's no signed wrap, and all the operands have the same sign or
3940     // zero, the value won't ever change sign.
3941     if (AddRec->getNoWrapFlags(SCEV::FlagNSW)) {
3942       bool AllNonNeg = true;
3943       bool AllNonPos = true;
3944       for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
3945         if (!isKnownNonNegative(AddRec->getOperand(i))) AllNonNeg = false;
3946         if (!isKnownNonPositive(AddRec->getOperand(i))) AllNonPos = false;
3947       }
3948       if (AllNonNeg)
3949         ConservativeResult = ConservativeResult.intersectWith(
3950           ConstantRange(APInt(BitWidth, 0),
3951                         APInt::getSignedMinValue(BitWidth)));
3952       else if (AllNonPos)
3953         ConservativeResult = ConservativeResult.intersectWith(
3954           ConstantRange(APInt::getSignedMinValue(BitWidth),
3955                         APInt(BitWidth, 1)));
3956     }
3957
3958     // TODO: non-affine addrec
3959     if (AddRec->isAffine()) {
3960       Type *Ty = AddRec->getType();
3961       const SCEV *MaxBECount = getMaxBackedgeTakenCount(AddRec->getLoop());
3962       if (!isa<SCEVCouldNotCompute>(MaxBECount) &&
3963           getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) {
3964
3965         // Check for overflow.  This must be done with ConstantRange arithmetic
3966         // because we could be called from within the ScalarEvolution overflow
3967         // checking code.
3968
3969         MaxBECount = getNoopOrZeroExtend(MaxBECount, Ty);
3970         ConstantRange MaxBECountRange = getUnsignedRange(MaxBECount);
3971         ConstantRange ZExtMaxBECountRange =
3972             MaxBECountRange.zextOrTrunc(BitWidth * 2 + 1);
3973
3974         const SCEV *Start = AddRec->getStart();
3975         const SCEV *Step = AddRec->getStepRecurrence(*this);
3976         ConstantRange StepSRange = getSignedRange(Step);
3977         ConstantRange SExtStepSRange = StepSRange.sextOrTrunc(BitWidth * 2 + 1);
3978
3979         ConstantRange StartURange = getUnsignedRange(Start);
3980         ConstantRange EndURange =
3981             StartURange.add(MaxBECountRange.multiply(StepSRange));
3982
3983         // Check for unsigned overflow.
3984         ConstantRange ZExtStartURange =
3985             StartURange.zextOrTrunc(BitWidth * 2 + 1);
3986         ConstantRange ZExtEndURange = EndURange.zextOrTrunc(BitWidth * 2 + 1);
3987         if (ZExtStartURange.add(ZExtMaxBECountRange.multiply(SExtStepSRange)) ==
3988             ZExtEndURange) {
3989           APInt Min = APIntOps::umin(StartURange.getUnsignedMin(),
3990                                      EndURange.getUnsignedMin());
3991           APInt Max = APIntOps::umax(StartURange.getUnsignedMax(),
3992                                      EndURange.getUnsignedMax());
3993           bool IsFullRange = Min.isMinValue() && Max.isMaxValue();
3994           if (!IsFullRange)
3995             ConservativeResult =
3996                 ConservativeResult.intersectWith(ConstantRange(Min, Max + 1));
3997         }
3998
3999         ConstantRange StartSRange = getSignedRange(Start);
4000         ConstantRange EndSRange =
4001             StartSRange.add(MaxBECountRange.multiply(StepSRange));
4002
4003         // Check for signed overflow. This must be done with ConstantRange
4004         // arithmetic because we could be called from within the ScalarEvolution
4005         // overflow checking code.
4006         ConstantRange SExtStartSRange =
4007             StartSRange.sextOrTrunc(BitWidth * 2 + 1);
4008         ConstantRange SExtEndSRange = EndSRange.sextOrTrunc(BitWidth * 2 + 1);
4009         if (SExtStartSRange.add(ZExtMaxBECountRange.multiply(SExtStepSRange)) ==
4010             SExtEndSRange) {
4011           APInt Min = APIntOps::smin(StartSRange.getSignedMin(),
4012                                      EndSRange.getSignedMin());
4013           APInt Max = APIntOps::smax(StartSRange.getSignedMax(),
4014                                      EndSRange.getSignedMax());
4015           bool IsFullRange = Min.isMinSignedValue() && Max.isMaxSignedValue();
4016           if (!IsFullRange)
4017             ConservativeResult =
4018                 ConservativeResult.intersectWith(ConstantRange(Min, Max + 1));
4019         }
4020       }
4021     }
4022
4023     return setRange(AddRec, SignHint, ConservativeResult);
4024   }
4025
4026   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
4027     // Check if the IR explicitly contains !range metadata.
4028     Optional<ConstantRange> MDRange = GetRangeFromMetadata(U->getValue());
4029     if (MDRange.hasValue())
4030       ConservativeResult = ConservativeResult.intersectWith(MDRange.getValue());
4031
4032     // Split here to avoid paying the compile-time cost of calling both
4033     // computeKnownBits and ComputeNumSignBits.  This restriction can be lifted
4034     // if needed.
4035     const DataLayout &DL = F->getParent()->getDataLayout();
4036     if (SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED) {
4037       // For a SCEVUnknown, ask ValueTracking.
4038       APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
4039       computeKnownBits(U->getValue(), Zeros, Ones, DL, 0, AC, nullptr, DT);
4040       if (Ones != ~Zeros + 1)
4041         ConservativeResult =
4042             ConservativeResult.intersectWith(ConstantRange(Ones, ~Zeros + 1));
4043     } else {
4044       assert(SignHint == ScalarEvolution::HINT_RANGE_SIGNED &&
4045              "generalize as needed!");
4046       unsigned NS = ComputeNumSignBits(U->getValue(), DL, 0, AC, nullptr, DT);
4047       if (NS > 1)
4048         ConservativeResult = ConservativeResult.intersectWith(
4049             ConstantRange(APInt::getSignedMinValue(BitWidth).ashr(NS - 1),
4050                           APInt::getSignedMaxValue(BitWidth).ashr(NS - 1) + 1));
4051     }
4052
4053     return setRange(U, SignHint, ConservativeResult);
4054   }
4055
4056   return setRange(S, SignHint, ConservativeResult);
4057 }
4058
4059 /// createSCEV - We know that there is no SCEV for the specified value.
4060 /// Analyze the expression.
4061 ///
4062 const SCEV *ScalarEvolution::createSCEV(Value *V) {
4063   if (!isSCEVable(V->getType()))
4064     return getUnknown(V);
4065
4066   unsigned Opcode = Instruction::UserOp1;
4067   if (Instruction *I = dyn_cast<Instruction>(V)) {
4068     Opcode = I->getOpcode();
4069
4070     // Don't attempt to analyze instructions in blocks that aren't
4071     // reachable. Such instructions don't matter, and they aren't required
4072     // to obey basic rules for definitions dominating uses which this
4073     // analysis depends on.
4074     if (!DT->isReachableFromEntry(I->getParent()))
4075       return getUnknown(V);
4076   } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
4077     Opcode = CE->getOpcode();
4078   else if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
4079     return getConstant(CI);
4080   else if (isa<ConstantPointerNull>(V))
4081     return getConstant(V->getType(), 0);
4082   else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
4083     return GA->mayBeOverridden() ? getUnknown(V) : getSCEV(GA->getAliasee());
4084   else
4085     return getUnknown(V);
4086
4087   Operator *U = cast<Operator>(V);
4088   switch (Opcode) {
4089   case Instruction::Add: {
4090     // The simple thing to do would be to just call getSCEV on both operands
4091     // and call getAddExpr with the result. However if we're looking at a
4092     // bunch of things all added together, this can be quite inefficient,
4093     // because it leads to N-1 getAddExpr calls for N ultimate operands.
4094     // Instead, gather up all the operands and make a single getAddExpr call.
4095     // LLVM IR canonical form means we need only traverse the left operands.
4096     //
4097     // Don't apply this instruction's NSW or NUW flags to the new
4098     // expression. The instruction may be guarded by control flow that the
4099     // no-wrap behavior depends on. Non-control-equivalent instructions can be
4100     // mapped to the same SCEV expression, and it would be incorrect to transfer
4101     // NSW/NUW semantics to those operations.
4102     SmallVector<const SCEV *, 4> AddOps;
4103     AddOps.push_back(getSCEV(U->getOperand(1)));
4104     for (Value *Op = U->getOperand(0); ; Op = U->getOperand(0)) {
4105       unsigned Opcode = Op->getValueID() - Value::InstructionVal;
4106       if (Opcode != Instruction::Add && Opcode != Instruction::Sub)
4107         break;
4108       U = cast<Operator>(Op);
4109       const SCEV *Op1 = getSCEV(U->getOperand(1));
4110       if (Opcode == Instruction::Sub)
4111         AddOps.push_back(getNegativeSCEV(Op1));
4112       else
4113         AddOps.push_back(Op1);
4114     }
4115     AddOps.push_back(getSCEV(U->getOperand(0)));
4116     return getAddExpr(AddOps);
4117   }
4118   case Instruction::Mul: {
4119     // Don't transfer NSW/NUW for the same reason as AddExpr.
4120     SmallVector<const SCEV *, 4> MulOps;
4121     MulOps.push_back(getSCEV(U->getOperand(1)));
4122     for (Value *Op = U->getOperand(0);
4123          Op->getValueID() == Instruction::Mul + Value::InstructionVal;
4124          Op = U->getOperand(0)) {
4125       U = cast<Operator>(Op);
4126       MulOps.push_back(getSCEV(U->getOperand(1)));
4127     }
4128     MulOps.push_back(getSCEV(U->getOperand(0)));
4129     return getMulExpr(MulOps);
4130   }
4131   case Instruction::UDiv:
4132     return getUDivExpr(getSCEV(U->getOperand(0)),
4133                        getSCEV(U->getOperand(1)));
4134   case Instruction::Sub:
4135     return getMinusSCEV(getSCEV(U->getOperand(0)),
4136                         getSCEV(U->getOperand(1)));
4137   case Instruction::And:
4138     // For an expression like x&255 that merely masks off the high bits,
4139     // use zext(trunc(x)) as the SCEV expression.
4140     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
4141       if (CI->isNullValue())
4142         return getSCEV(U->getOperand(1));
4143       if (CI->isAllOnesValue())
4144         return getSCEV(U->getOperand(0));
4145       const APInt &A = CI->getValue();
4146
4147       // Instcombine's ShrinkDemandedConstant may strip bits out of
4148       // constants, obscuring what would otherwise be a low-bits mask.
4149       // Use computeKnownBits to compute what ShrinkDemandedConstant
4150       // knew about to reconstruct a low-bits mask value.
4151       unsigned LZ = A.countLeadingZeros();
4152       unsigned TZ = A.countTrailingZeros();
4153       unsigned BitWidth = A.getBitWidth();
4154       APInt KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
4155       computeKnownBits(U->getOperand(0), KnownZero, KnownOne,
4156                        F->getParent()->getDataLayout(), 0, AC, nullptr, DT);
4157
4158       APInt EffectiveMask =
4159           APInt::getLowBitsSet(BitWidth, BitWidth - LZ - TZ).shl(TZ);
4160       if ((LZ != 0 || TZ != 0) && !((~A & ~KnownZero) & EffectiveMask)) {
4161         const SCEV *MulCount = getConstant(
4162             ConstantInt::get(getContext(), APInt::getOneBitSet(BitWidth, TZ)));
4163         return getMulExpr(
4164             getZeroExtendExpr(
4165                 getTruncateExpr(
4166                     getUDivExactExpr(getSCEV(U->getOperand(0)), MulCount),
4167                     IntegerType::get(getContext(), BitWidth - LZ - TZ)),
4168                 U->getType()),
4169             MulCount);
4170       }
4171     }
4172     break;
4173
4174   case Instruction::Or:
4175     // If the RHS of the Or is a constant, we may have something like:
4176     // X*4+1 which got turned into X*4|1.  Handle this as an Add so loop
4177     // optimizations will transparently handle this case.
4178     //
4179     // In order for this transformation to be safe, the LHS must be of the
4180     // form X*(2^n) and the Or constant must be less than 2^n.
4181     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
4182       const SCEV *LHS = getSCEV(U->getOperand(0));
4183       const APInt &CIVal = CI->getValue();
4184       if (GetMinTrailingZeros(LHS) >=
4185           (CIVal.getBitWidth() - CIVal.countLeadingZeros())) {
4186         // Build a plain add SCEV.
4187         const SCEV *S = getAddExpr(LHS, getSCEV(CI));
4188         // If the LHS of the add was an addrec and it has no-wrap flags,
4189         // transfer the no-wrap flags, since an or won't introduce a wrap.
4190         if (const SCEVAddRecExpr *NewAR = dyn_cast<SCEVAddRecExpr>(S)) {
4191           const SCEVAddRecExpr *OldAR = cast<SCEVAddRecExpr>(LHS);
4192           const_cast<SCEVAddRecExpr *>(NewAR)->setNoWrapFlags(
4193             OldAR->getNoWrapFlags());
4194         }
4195         return S;
4196       }
4197     }
4198     break;
4199   case Instruction::Xor:
4200     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
4201       // If the RHS of the xor is a signbit, then this is just an add.
4202       // Instcombine turns add of signbit into xor as a strength reduction step.
4203       if (CI->getValue().isSignBit())
4204         return getAddExpr(getSCEV(U->getOperand(0)),
4205                           getSCEV(U->getOperand(1)));
4206
4207       // If the RHS of xor is -1, then this is a not operation.
4208       if (CI->isAllOnesValue())
4209         return getNotSCEV(getSCEV(U->getOperand(0)));
4210
4211       // Model xor(and(x, C), C) as and(~x, C), if C is a low-bits mask.
4212       // This is a variant of the check for xor with -1, and it handles
4213       // the case where instcombine has trimmed non-demanded bits out
4214       // of an xor with -1.
4215       if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U->getOperand(0)))
4216         if (ConstantInt *LCI = dyn_cast<ConstantInt>(BO->getOperand(1)))
4217           if (BO->getOpcode() == Instruction::And &&
4218               LCI->getValue() == CI->getValue())
4219             if (const SCEVZeroExtendExpr *Z =
4220                   dyn_cast<SCEVZeroExtendExpr>(getSCEV(U->getOperand(0)))) {
4221               Type *UTy = U->getType();
4222               const SCEV *Z0 = Z->getOperand();
4223               Type *Z0Ty = Z0->getType();
4224               unsigned Z0TySize = getTypeSizeInBits(Z0Ty);
4225
4226               // If C is a low-bits mask, the zero extend is serving to
4227               // mask off the high bits. Complement the operand and
4228               // re-apply the zext.
4229               if (APIntOps::isMask(Z0TySize, CI->getValue()))
4230                 return getZeroExtendExpr(getNotSCEV(Z0), UTy);
4231
4232               // If C is a single bit, it may be in the sign-bit position
4233               // before the zero-extend. In this case, represent the xor
4234               // using an add, which is equivalent, and re-apply the zext.
4235               APInt Trunc = CI->getValue().trunc(Z0TySize);
4236               if (Trunc.zext(getTypeSizeInBits(UTy)) == CI->getValue() &&
4237                   Trunc.isSignBit())
4238                 return getZeroExtendExpr(getAddExpr(Z0, getConstant(Trunc)),
4239                                          UTy);
4240             }
4241     }
4242     break;
4243
4244   case Instruction::Shl:
4245     // Turn shift left of a constant amount into a multiply.
4246     if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
4247       uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
4248
4249       // If the shift count is not less than the bitwidth, the result of
4250       // the shift is undefined. Don't try to analyze it, because the
4251       // resolution chosen here may differ from the resolution chosen in
4252       // other parts of the compiler.
4253       if (SA->getValue().uge(BitWidth))
4254         break;
4255
4256       Constant *X = ConstantInt::get(getContext(),
4257         APInt::getOneBitSet(BitWidth, SA->getZExtValue()));
4258       return getMulExpr(getSCEV(U->getOperand(0)), getSCEV(X));
4259     }
4260     break;
4261
4262   case Instruction::LShr:
4263     // Turn logical shift right of a constant into a unsigned divide.
4264     if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
4265       uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
4266
4267       // If the shift count is not less than the bitwidth, the result of
4268       // the shift is undefined. Don't try to analyze it, because the
4269       // resolution chosen here may differ from the resolution chosen in
4270       // other parts of the compiler.
4271       if (SA->getValue().uge(BitWidth))
4272         break;
4273
4274       Constant *X = ConstantInt::get(getContext(),
4275         APInt::getOneBitSet(BitWidth, SA->getZExtValue()));
4276       return getUDivExpr(getSCEV(U->getOperand(0)), getSCEV(X));
4277     }
4278     break;
4279
4280   case Instruction::AShr:
4281     // For a two-shift sext-inreg, use sext(trunc(x)) as the SCEV expression.
4282     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1)))
4283       if (Operator *L = dyn_cast<Operator>(U->getOperand(0)))
4284         if (L->getOpcode() == Instruction::Shl &&
4285             L->getOperand(1) == U->getOperand(1)) {
4286           uint64_t BitWidth = getTypeSizeInBits(U->getType());
4287
4288           // If the shift count is not less than the bitwidth, the result of
4289           // the shift is undefined. Don't try to analyze it, because the
4290           // resolution chosen here may differ from the resolution chosen in
4291           // other parts of the compiler.
4292           if (CI->getValue().uge(BitWidth))
4293             break;
4294
4295           uint64_t Amt = BitWidth - CI->getZExtValue();
4296           if (Amt == BitWidth)
4297             return getSCEV(L->getOperand(0));       // shift by zero --> noop
4298           return
4299             getSignExtendExpr(getTruncateExpr(getSCEV(L->getOperand(0)),
4300                                               IntegerType::get(getContext(),
4301                                                                Amt)),
4302                               U->getType());
4303         }
4304     break;
4305
4306   case Instruction::Trunc:
4307     return getTruncateExpr(getSCEV(U->getOperand(0)), U->getType());
4308
4309   case Instruction::ZExt:
4310     return getZeroExtendExpr(getSCEV(U->getOperand(0)), U->getType());
4311
4312   case Instruction::SExt:
4313     return getSignExtendExpr(getSCEV(U->getOperand(0)), U->getType());
4314
4315   case Instruction::BitCast:
4316     // BitCasts are no-op casts so we just eliminate the cast.
4317     if (isSCEVable(U->getType()) && isSCEVable(U->getOperand(0)->getType()))
4318       return getSCEV(U->getOperand(0));
4319     break;
4320
4321   // It's tempting to handle inttoptr and ptrtoint as no-ops, however this can
4322   // lead to pointer expressions which cannot safely be expanded to GEPs,
4323   // because ScalarEvolution doesn't respect the GEP aliasing rules when
4324   // simplifying integer expressions.
4325
4326   case Instruction::GetElementPtr:
4327     return createNodeForGEP(cast<GEPOperator>(U));
4328
4329   case Instruction::PHI:
4330     return createNodeForPHI(cast<PHINode>(U));
4331
4332   case Instruction::Select:
4333     // This could be a smax or umax that was lowered earlier.
4334     // Try to recover it.
4335     if (ICmpInst *ICI = dyn_cast<ICmpInst>(U->getOperand(0))) {
4336       Value *LHS = ICI->getOperand(0);
4337       Value *RHS = ICI->getOperand(1);
4338       switch (ICI->getPredicate()) {
4339       case ICmpInst::ICMP_SLT:
4340       case ICmpInst::ICMP_SLE:
4341         std::swap(LHS, RHS);
4342         // fall through
4343       case ICmpInst::ICMP_SGT:
4344       case ICmpInst::ICMP_SGE:
4345         // a >s b ? a+x : b+x  ->  smax(a, b)+x
4346         // a >s b ? b+x : a+x  ->  smin(a, b)+x
4347         if (getTypeSizeInBits(LHS->getType()) <=
4348             getTypeSizeInBits(U->getType())) {
4349           const SCEV *LS = getNoopOrSignExtend(getSCEV(LHS), U->getType());
4350           const SCEV *RS = getNoopOrSignExtend(getSCEV(RHS), U->getType());
4351           const SCEV *LA = getSCEV(U->getOperand(1));
4352           const SCEV *RA = getSCEV(U->getOperand(2));
4353           const SCEV *LDiff = getMinusSCEV(LA, LS);
4354           const SCEV *RDiff = getMinusSCEV(RA, RS);
4355           if (LDiff == RDiff)
4356             return getAddExpr(getSMaxExpr(LS, RS), LDiff);
4357           LDiff = getMinusSCEV(LA, RS);
4358           RDiff = getMinusSCEV(RA, LS);
4359           if (LDiff == RDiff)
4360             return getAddExpr(getSMinExpr(LS, RS), LDiff);
4361         }
4362         break;
4363       case ICmpInst::ICMP_ULT:
4364       case ICmpInst::ICMP_ULE:
4365         std::swap(LHS, RHS);
4366         // fall through
4367       case ICmpInst::ICMP_UGT:
4368       case ICmpInst::ICMP_UGE:
4369         // a >u b ? a+x : b+x  ->  umax(a, b)+x
4370         // a >u b ? b+x : a+x  ->  umin(a, b)+x
4371         if (getTypeSizeInBits(LHS->getType()) <=
4372             getTypeSizeInBits(U->getType())) {
4373           const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), U->getType());
4374           const SCEV *RS = getNoopOrZeroExtend(getSCEV(RHS), U->getType());
4375           const SCEV *LA = getSCEV(U->getOperand(1));
4376           const SCEV *RA = getSCEV(U->getOperand(2));
4377           const SCEV *LDiff = getMinusSCEV(LA, LS);
4378           const SCEV *RDiff = getMinusSCEV(RA, RS);
4379           if (LDiff == RDiff)
4380             return getAddExpr(getUMaxExpr(LS, RS), LDiff);
4381           LDiff = getMinusSCEV(LA, RS);
4382           RDiff = getMinusSCEV(RA, LS);
4383           if (LDiff == RDiff)
4384             return getAddExpr(getUMinExpr(LS, RS), LDiff);
4385         }
4386         break;
4387       case ICmpInst::ICMP_NE:
4388         // n != 0 ? n+x : 1+x  ->  umax(n, 1)+x
4389         if (getTypeSizeInBits(LHS->getType()) <=
4390                 getTypeSizeInBits(U->getType()) &&
4391             isa<ConstantInt>(RHS) && cast<ConstantInt>(RHS)->isZero()) {
4392           const SCEV *One = getConstant(U->getType(), 1);
4393           const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), U->getType());
4394           const SCEV *LA = getSCEV(U->getOperand(1));
4395           const SCEV *RA = getSCEV(U->getOperand(2));
4396           const SCEV *LDiff = getMinusSCEV(LA, LS);
4397           const SCEV *RDiff = getMinusSCEV(RA, One);
4398           if (LDiff == RDiff)
4399             return getAddExpr(getUMaxExpr(One, LS), LDiff);
4400         }
4401         break;
4402       case ICmpInst::ICMP_EQ:
4403         // n == 0 ? 1+x : n+x  ->  umax(n, 1)+x
4404         if (getTypeSizeInBits(LHS->getType()) <=
4405                 getTypeSizeInBits(U->getType()) &&
4406             isa<ConstantInt>(RHS) && cast<ConstantInt>(RHS)->isZero()) {
4407           const SCEV *One = getConstant(U->getType(), 1);
4408           const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), U->getType());
4409           const SCEV *LA = getSCEV(U->getOperand(1));
4410           const SCEV *RA = getSCEV(U->getOperand(2));
4411           const SCEV *LDiff = getMinusSCEV(LA, One);
4412           const SCEV *RDiff = getMinusSCEV(RA, LS);
4413           if (LDiff == RDiff)
4414             return getAddExpr(getUMaxExpr(One, LS), LDiff);
4415         }
4416         break;
4417       default:
4418         break;
4419       }
4420     }
4421
4422   default: // We cannot analyze this expression.
4423     break;
4424   }
4425
4426   return getUnknown(V);
4427 }
4428
4429
4430
4431 //===----------------------------------------------------------------------===//
4432 //                   Iteration Count Computation Code
4433 //
4434
4435 unsigned ScalarEvolution::getSmallConstantTripCount(Loop *L) {
4436   if (BasicBlock *ExitingBB = L->getExitingBlock())
4437     return getSmallConstantTripCount(L, ExitingBB);
4438
4439   // No trip count information for multiple exits.
4440   return 0;
4441 }
4442
4443 /// getSmallConstantTripCount - Returns the maximum trip count of this loop as a
4444 /// normal unsigned value. Returns 0 if the trip count is unknown or not
4445 /// constant. Will also return 0 if the maximum trip count is very large (>=
4446 /// 2^32).
4447 ///
4448 /// This "trip count" assumes that control exits via ExitingBlock. More
4449 /// precisely, it is the number of times that control may reach ExitingBlock
4450 /// before taking the branch. For loops with multiple exits, it may not be the
4451 /// number times that the loop header executes because the loop may exit
4452 /// prematurely via another branch.
4453 unsigned ScalarEvolution::getSmallConstantTripCount(Loop *L,
4454                                                     BasicBlock *ExitingBlock) {
4455   assert(ExitingBlock && "Must pass a non-null exiting block!");
4456   assert(L->isLoopExiting(ExitingBlock) &&
4457          "Exiting block must actually branch out of the loop!");
4458   const SCEVConstant *ExitCount =
4459       dyn_cast<SCEVConstant>(getExitCount(L, ExitingBlock));
4460   if (!ExitCount)
4461     return 0;
4462
4463   ConstantInt *ExitConst = ExitCount->getValue();
4464
4465   // Guard against huge trip counts.
4466   if (ExitConst->getValue().getActiveBits() > 32)
4467     return 0;
4468
4469   // In case of integer overflow, this returns 0, which is correct.
4470   return ((unsigned)ExitConst->getZExtValue()) + 1;
4471 }
4472
4473 unsigned ScalarEvolution::getSmallConstantTripMultiple(Loop *L) {
4474   if (BasicBlock *ExitingBB = L->getExitingBlock())
4475     return getSmallConstantTripMultiple(L, ExitingBB);
4476
4477   // No trip multiple information for multiple exits.
4478   return 0;
4479 }
4480
4481 /// getSmallConstantTripMultiple - Returns the largest constant divisor of the
4482 /// trip count of this loop as a normal unsigned value, if possible. This
4483 /// means that the actual trip count is always a multiple of the returned
4484 /// value (don't forget the trip count could very well be zero as well!).
4485 ///
4486 /// Returns 1 if the trip count is unknown or not guaranteed to be the
4487 /// multiple of a constant (which is also the case if the trip count is simply
4488 /// constant, use getSmallConstantTripCount for that case), Will also return 1
4489 /// if the trip count is very large (>= 2^32).
4490 ///
4491 /// As explained in the comments for getSmallConstantTripCount, this assumes
4492 /// that control exits the loop via ExitingBlock.
4493 unsigned
4494 ScalarEvolution::getSmallConstantTripMultiple(Loop *L,
4495                                               BasicBlock *ExitingBlock) {
4496   assert(ExitingBlock && "Must pass a non-null exiting block!");
4497   assert(L->isLoopExiting(ExitingBlock) &&
4498          "Exiting block must actually branch out of the loop!");
4499   const SCEV *ExitCount = getExitCount(L, ExitingBlock);
4500   if (ExitCount == getCouldNotCompute())
4501     return 1;
4502
4503   // Get the trip count from the BE count by adding 1.
4504   const SCEV *TCMul = getAddExpr(ExitCount,
4505                                  getConstant(ExitCount->getType(), 1));
4506   // FIXME: SCEV distributes multiplication as V1*C1 + V2*C1. We could attempt
4507   // to factor simple cases.
4508   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(TCMul))
4509     TCMul = Mul->getOperand(0);
4510
4511   const SCEVConstant *MulC = dyn_cast<SCEVConstant>(TCMul);
4512   if (!MulC)
4513     return 1;
4514
4515   ConstantInt *Result = MulC->getValue();
4516
4517   // Guard against huge trip counts (this requires checking
4518   // for zero to handle the case where the trip count == -1 and the
4519   // addition wraps).
4520   if (!Result || Result->getValue().getActiveBits() > 32 ||
4521       Result->getValue().getActiveBits() == 0)
4522     return 1;
4523
4524   return (unsigned)Result->getZExtValue();
4525 }
4526
4527 // getExitCount - Get the expression for the number of loop iterations for which
4528 // this loop is guaranteed not to exit via ExitingBlock. Otherwise return
4529 // SCEVCouldNotCompute.
4530 const SCEV *ScalarEvolution::getExitCount(Loop *L, BasicBlock *ExitingBlock) {
4531   return getBackedgeTakenInfo(L).getExact(ExitingBlock, this);
4532 }
4533
4534 /// getBackedgeTakenCount - If the specified loop has a predictable
4535 /// backedge-taken count, return it, otherwise return a SCEVCouldNotCompute
4536 /// object. The backedge-taken count is the number of times the loop header
4537 /// will be branched to from within the loop. This is one less than the
4538 /// trip count of the loop, since it doesn't count the first iteration,
4539 /// when the header is branched to from outside the loop.
4540 ///
4541 /// Note that it is not valid to call this method on a loop without a
4542 /// loop-invariant backedge-taken count (see
4543 /// hasLoopInvariantBackedgeTakenCount).
4544 ///
4545 const SCEV *ScalarEvolution::getBackedgeTakenCount(const Loop *L) {
4546   return getBackedgeTakenInfo(L).getExact(this);
4547 }
4548
4549 /// getMaxBackedgeTakenCount - Similar to getBackedgeTakenCount, except
4550 /// return the least SCEV value that is known never to be less than the
4551 /// actual backedge taken count.
4552 const SCEV *ScalarEvolution::getMaxBackedgeTakenCount(const Loop *L) {
4553   return getBackedgeTakenInfo(L).getMax(this);
4554 }
4555
4556 /// PushLoopPHIs - Push PHI nodes in the header of the given loop
4557 /// onto the given Worklist.
4558 static void
4559 PushLoopPHIs(const Loop *L, SmallVectorImpl<Instruction *> &Worklist) {
4560   BasicBlock *Header = L->getHeader();
4561
4562   // Push all Loop-header PHIs onto the Worklist stack.
4563   for (BasicBlock::iterator I = Header->begin();
4564        PHINode *PN = dyn_cast<PHINode>(I); ++I)
4565     Worklist.push_back(PN);
4566 }
4567
4568 const ScalarEvolution::BackedgeTakenInfo &
4569 ScalarEvolution::getBackedgeTakenInfo(const Loop *L) {
4570   // Initially insert an invalid entry for this loop. If the insertion
4571   // succeeds, proceed to actually compute a backedge-taken count and
4572   // update the value. The temporary CouldNotCompute value tells SCEV
4573   // code elsewhere that it shouldn't attempt to request a new
4574   // backedge-taken count, which could result in infinite recursion.
4575   std::pair<DenseMap<const Loop *, BackedgeTakenInfo>::iterator, bool> Pair =
4576     BackedgeTakenCounts.insert(std::make_pair(L, BackedgeTakenInfo()));
4577   if (!Pair.second)
4578     return Pair.first->second;
4579
4580   // ComputeBackedgeTakenCount may allocate memory for its result. Inserting it
4581   // into the BackedgeTakenCounts map transfers ownership. Otherwise, the result
4582   // must be cleared in this scope.
4583   BackedgeTakenInfo Result = ComputeBackedgeTakenCount(L);
4584
4585   if (Result.getExact(this) != getCouldNotCompute()) {
4586     assert(isLoopInvariant(Result.getExact(this), L) &&
4587            isLoopInvariant(Result.getMax(this), L) &&
4588            "Computed backedge-taken count isn't loop invariant for loop!");
4589     ++NumTripCountsComputed;
4590   }
4591   else if (Result.getMax(this) == getCouldNotCompute() &&
4592            isa<PHINode>(L->getHeader()->begin())) {
4593     // Only count loops that have phi nodes as not being computable.
4594     ++NumTripCountsNotComputed;
4595   }
4596
4597   // Now that we know more about the trip count for this loop, forget any
4598   // existing SCEV values for PHI nodes in this loop since they are only
4599   // conservative estimates made without the benefit of trip count
4600   // information. This is similar to the code in forgetLoop, except that
4601   // it handles SCEVUnknown PHI nodes specially.
4602   if (Result.hasAnyInfo()) {
4603     SmallVector<Instruction *, 16> Worklist;
4604     PushLoopPHIs(L, Worklist);
4605
4606     SmallPtrSet<Instruction *, 8> Visited;
4607     while (!Worklist.empty()) {
4608       Instruction *I = Worklist.pop_back_val();
4609       if (!Visited.insert(I).second)
4610         continue;
4611
4612       ValueExprMapType::iterator It =
4613         ValueExprMap.find_as(static_cast<Value *>(I));
4614       if (It != ValueExprMap.end()) {
4615         const SCEV *Old = It->second;
4616
4617         // SCEVUnknown for a PHI either means that it has an unrecognized
4618         // structure, or it's a PHI that's in the progress of being computed
4619         // by createNodeForPHI.  In the former case, additional loop trip
4620         // count information isn't going to change anything. In the later
4621         // case, createNodeForPHI will perform the necessary updates on its
4622         // own when it gets to that point.
4623         if (!isa<PHINode>(I) || !isa<SCEVUnknown>(Old)) {
4624           forgetMemoizedResults(Old);
4625           ValueExprMap.erase(It);
4626         }
4627         if (PHINode *PN = dyn_cast<PHINode>(I))
4628           ConstantEvolutionLoopExitValue.erase(PN);
4629       }
4630
4631       PushDefUseChildren(I, Worklist);
4632     }
4633   }
4634
4635   // Re-lookup the insert position, since the call to
4636   // ComputeBackedgeTakenCount above could result in a
4637   // recusive call to getBackedgeTakenInfo (on a different
4638   // loop), which would invalidate the iterator computed
4639   // earlier.
4640   return BackedgeTakenCounts.find(L)->second = Result;
4641 }
4642
4643 /// forgetLoop - This method should be called by the client when it has
4644 /// changed a loop in a way that may effect ScalarEvolution's ability to
4645 /// compute a trip count, or if the loop is deleted.
4646 void ScalarEvolution::forgetLoop(const Loop *L) {
4647   // Drop any stored trip count value.
4648   DenseMap<const Loop*, BackedgeTakenInfo>::iterator BTCPos =
4649     BackedgeTakenCounts.find(L);
4650   if (BTCPos != BackedgeTakenCounts.end()) {
4651     BTCPos->second.clear();
4652     BackedgeTakenCounts.erase(BTCPos);
4653   }
4654
4655   // Drop information about expressions based on loop-header PHIs.
4656   SmallVector<Instruction *, 16> Worklist;
4657   PushLoopPHIs(L, Worklist);
4658
4659   SmallPtrSet<Instruction *, 8> Visited;
4660   while (!Worklist.empty()) {
4661     Instruction *I = Worklist.pop_back_val();
4662     if (!Visited.insert(I).second)
4663       continue;
4664
4665     ValueExprMapType::iterator It =
4666       ValueExprMap.find_as(static_cast<Value *>(I));
4667     if (It != ValueExprMap.end()) {
4668       forgetMemoizedResults(It->second);
4669       ValueExprMap.erase(It);
4670       if (PHINode *PN = dyn_cast<PHINode>(I))
4671         ConstantEvolutionLoopExitValue.erase(PN);
4672     }
4673
4674     PushDefUseChildren(I, Worklist);
4675   }
4676
4677   // Forget all contained loops too, to avoid dangling entries in the
4678   // ValuesAtScopes map.
4679   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
4680     forgetLoop(*I);
4681 }
4682
4683 /// forgetValue - This method should be called by the client when it has
4684 /// changed a value in a way that may effect its value, or which may
4685 /// disconnect it from a def-use chain linking it to a loop.
4686 void ScalarEvolution::forgetValue(Value *V) {
4687   Instruction *I = dyn_cast<Instruction>(V);
4688   if (!I) return;
4689
4690   // Drop information about expressions based on loop-header PHIs.
4691   SmallVector<Instruction *, 16> Worklist;
4692   Worklist.push_back(I);
4693
4694   SmallPtrSet<Instruction *, 8> Visited;
4695   while (!Worklist.empty()) {
4696     I = Worklist.pop_back_val();
4697     if (!Visited.insert(I).second)
4698       continue;
4699
4700     ValueExprMapType::iterator It =
4701       ValueExprMap.find_as(static_cast<Value *>(I));
4702     if (It != ValueExprMap.end()) {
4703       forgetMemoizedResults(It->second);
4704       ValueExprMap.erase(It);
4705       if (PHINode *PN = dyn_cast<PHINode>(I))
4706         ConstantEvolutionLoopExitValue.erase(PN);
4707     }
4708
4709     PushDefUseChildren(I, Worklist);
4710   }
4711 }
4712
4713 /// getExact - Get the exact loop backedge taken count considering all loop
4714 /// exits. A computable result can only be return for loops with a single exit.
4715 /// Returning the minimum taken count among all exits is incorrect because one
4716 /// of the loop's exit limit's may have been skipped. HowFarToZero assumes that
4717 /// the limit of each loop test is never skipped. This is a valid assumption as
4718 /// long as the loop exits via that test. For precise results, it is the
4719 /// caller's responsibility to specify the relevant loop exit using
4720 /// getExact(ExitingBlock, SE).
4721 const SCEV *
4722 ScalarEvolution::BackedgeTakenInfo::getExact(ScalarEvolution *SE) const {
4723   // If any exits were not computable, the loop is not computable.
4724   if (!ExitNotTaken.isCompleteList()) return SE->getCouldNotCompute();
4725
4726   // We need exactly one computable exit.
4727   if (!ExitNotTaken.ExitingBlock) return SE->getCouldNotCompute();
4728   assert(ExitNotTaken.ExactNotTaken && "uninitialized not-taken info");
4729
4730   const SCEV *BECount = nullptr;
4731   for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
4732        ENT != nullptr; ENT = ENT->getNextExit()) {
4733
4734     assert(ENT->ExactNotTaken != SE->getCouldNotCompute() && "bad exit SCEV");
4735
4736     if (!BECount)
4737       BECount = ENT->ExactNotTaken;
4738     else if (BECount != ENT->ExactNotTaken)
4739       return SE->getCouldNotCompute();
4740   }
4741   assert(BECount && "Invalid not taken count for loop exit");
4742   return BECount;
4743 }
4744
4745 /// getExact - Get the exact not taken count for this loop exit.
4746 const SCEV *
4747 ScalarEvolution::BackedgeTakenInfo::getExact(BasicBlock *ExitingBlock,
4748                                              ScalarEvolution *SE) const {
4749   for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
4750        ENT != nullptr; ENT = ENT->getNextExit()) {
4751
4752     if (ENT->ExitingBlock == ExitingBlock)
4753       return ENT->ExactNotTaken;
4754   }
4755   return SE->getCouldNotCompute();
4756 }
4757
4758 /// getMax - Get the max backedge taken count for the loop.
4759 const SCEV *
4760 ScalarEvolution::BackedgeTakenInfo::getMax(ScalarEvolution *SE) const {
4761   return Max ? Max : SE->getCouldNotCompute();
4762 }
4763
4764 bool ScalarEvolution::BackedgeTakenInfo::hasOperand(const SCEV *S,
4765                                                     ScalarEvolution *SE) const {
4766   if (Max && Max != SE->getCouldNotCompute() && SE->hasOperand(Max, S))
4767     return true;
4768
4769   if (!ExitNotTaken.ExitingBlock)
4770     return false;
4771
4772   for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
4773        ENT != nullptr; ENT = ENT->getNextExit()) {
4774
4775     if (ENT->ExactNotTaken != SE->getCouldNotCompute()
4776         && SE->hasOperand(ENT->ExactNotTaken, S)) {
4777       return true;
4778     }
4779   }
4780   return false;
4781 }
4782
4783 /// Allocate memory for BackedgeTakenInfo and copy the not-taken count of each
4784 /// computable exit into a persistent ExitNotTakenInfo array.
4785 ScalarEvolution::BackedgeTakenInfo::BackedgeTakenInfo(
4786   SmallVectorImpl< std::pair<BasicBlock *, const SCEV *> > &ExitCounts,
4787   bool Complete, const SCEV *MaxCount) : Max(MaxCount) {
4788
4789   if (!Complete)
4790     ExitNotTaken.setIncomplete();
4791
4792   unsigned NumExits = ExitCounts.size();
4793   if (NumExits == 0) return;
4794
4795   ExitNotTaken.ExitingBlock = ExitCounts[0].first;
4796   ExitNotTaken.ExactNotTaken = ExitCounts[0].second;
4797   if (NumExits == 1) return;
4798
4799   // Handle the rare case of multiple computable exits.
4800   ExitNotTakenInfo *ENT = new ExitNotTakenInfo[NumExits-1];
4801
4802   ExitNotTakenInfo *PrevENT = &ExitNotTaken;
4803   for (unsigned i = 1; i < NumExits; ++i, PrevENT = ENT, ++ENT) {
4804     PrevENT->setNextExit(ENT);
4805     ENT->ExitingBlock = ExitCounts[i].first;
4806     ENT->ExactNotTaken = ExitCounts[i].second;
4807   }
4808 }
4809
4810 /// clear - Invalidate this result and free the ExitNotTakenInfo array.
4811 void ScalarEvolution::BackedgeTakenInfo::clear() {
4812   ExitNotTaken.ExitingBlock = nullptr;
4813   ExitNotTaken.ExactNotTaken = nullptr;
4814   delete[] ExitNotTaken.getNextExit();
4815 }
4816
4817 /// ComputeBackedgeTakenCount - Compute the number of times the backedge
4818 /// of the specified loop will execute.
4819 ScalarEvolution::BackedgeTakenInfo
4820 ScalarEvolution::ComputeBackedgeTakenCount(const Loop *L) {
4821   SmallVector<BasicBlock *, 8> ExitingBlocks;
4822   L->getExitingBlocks(ExitingBlocks);
4823
4824   SmallVector<std::pair<BasicBlock *, const SCEV *>, 4> ExitCounts;
4825   bool CouldComputeBECount = true;
4826   BasicBlock *Latch = L->getLoopLatch(); // may be NULL.
4827   const SCEV *MustExitMaxBECount = nullptr;
4828   const SCEV *MayExitMaxBECount = nullptr;
4829
4830   // Compute the ExitLimit for each loop exit. Use this to populate ExitCounts
4831   // and compute maxBECount.
4832   for (unsigned i = 0, e = ExitingBlocks.size(); i != e; ++i) {
4833     BasicBlock *ExitBB = ExitingBlocks[i];
4834     ExitLimit EL = ComputeExitLimit(L, ExitBB);
4835
4836     // 1. For each exit that can be computed, add an entry to ExitCounts.
4837     // CouldComputeBECount is true only if all exits can be computed.
4838     if (EL.Exact == getCouldNotCompute())
4839       // We couldn't compute an exact value for this exit, so
4840       // we won't be able to compute an exact value for the loop.
4841       CouldComputeBECount = false;
4842     else
4843       ExitCounts.push_back(std::make_pair(ExitBB, EL.Exact));
4844
4845     // 2. Derive the loop's MaxBECount from each exit's max number of
4846     // non-exiting iterations. Partition the loop exits into two kinds:
4847     // LoopMustExits and LoopMayExits.
4848     //
4849     // If the exit dominates the loop latch, it is a LoopMustExit otherwise it
4850     // is a LoopMayExit.  If any computable LoopMustExit is found, then
4851     // MaxBECount is the minimum EL.Max of computable LoopMustExits. Otherwise,
4852     // MaxBECount is conservatively the maximum EL.Max, where CouldNotCompute is
4853     // considered greater than any computable EL.Max.
4854     if (EL.Max != getCouldNotCompute() && Latch &&
4855         DT->dominates(ExitBB, Latch)) {
4856       if (!MustExitMaxBECount)
4857         MustExitMaxBECount = EL.Max;
4858       else {
4859         MustExitMaxBECount =
4860           getUMinFromMismatchedTypes(MustExitMaxBECount, EL.Max);
4861       }
4862     } else if (MayExitMaxBECount != getCouldNotCompute()) {
4863       if (!MayExitMaxBECount || EL.Max == getCouldNotCompute())
4864         MayExitMaxBECount = EL.Max;
4865       else {
4866         MayExitMaxBECount =
4867           getUMaxFromMismatchedTypes(MayExitMaxBECount, EL.Max);
4868       }
4869     }
4870   }
4871   const SCEV *MaxBECount = MustExitMaxBECount ? MustExitMaxBECount :
4872     (MayExitMaxBECount ? MayExitMaxBECount : getCouldNotCompute());
4873   return BackedgeTakenInfo(ExitCounts, CouldComputeBECount, MaxBECount);
4874 }
4875
4876 /// ComputeExitLimit - Compute the number of times the backedge of the specified
4877 /// loop will execute if it exits via the specified block.
4878 ScalarEvolution::ExitLimit
4879 ScalarEvolution::ComputeExitLimit(const Loop *L, BasicBlock *ExitingBlock) {
4880
4881   // Okay, we've chosen an exiting block.  See what condition causes us to
4882   // exit at this block and remember the exit block and whether all other targets
4883   // lead to the loop header.
4884   bool MustExecuteLoopHeader = true;
4885   BasicBlock *Exit = nullptr;
4886   for (succ_iterator SI = succ_begin(ExitingBlock), SE = succ_end(ExitingBlock);
4887        SI != SE; ++SI)
4888     if (!L->contains(*SI)) {
4889       if (Exit) // Multiple exit successors.
4890         return getCouldNotCompute();
4891       Exit = *SI;
4892     } else if (*SI != L->getHeader()) {
4893       MustExecuteLoopHeader = false;
4894     }
4895
4896   // At this point, we know we have a conditional branch that determines whether
4897   // the loop is exited.  However, we don't know if the branch is executed each
4898   // time through the loop.  If not, then the execution count of the branch will
4899   // not be equal to the trip count of the loop.
4900   //
4901   // Currently we check for this by checking to see if the Exit branch goes to
4902   // the loop header.  If so, we know it will always execute the same number of
4903   // times as the loop.  We also handle the case where the exit block *is* the
4904   // loop header.  This is common for un-rotated loops.
4905   //
4906   // If both of those tests fail, walk up the unique predecessor chain to the
4907   // header, stopping if there is an edge that doesn't exit the loop. If the
4908   // header is reached, the execution count of the branch will be equal to the
4909   // trip count of the loop.
4910   //
4911   //  More extensive analysis could be done to handle more cases here.
4912   //
4913   if (!MustExecuteLoopHeader && ExitingBlock != L->getHeader()) {
4914     // The simple checks failed, try climbing the unique predecessor chain
4915     // up to the header.
4916     bool Ok = false;
4917     for (BasicBlock *BB = ExitingBlock; BB; ) {
4918       BasicBlock *Pred = BB->getUniquePredecessor();
4919       if (!Pred)
4920         return getCouldNotCompute();
4921       TerminatorInst *PredTerm = Pred->getTerminator();
4922       for (unsigned i = 0, e = PredTerm->getNumSuccessors(); i != e; ++i) {
4923         BasicBlock *PredSucc = PredTerm->getSuccessor(i);
4924         if (PredSucc == BB)
4925           continue;
4926         // If the predecessor has a successor that isn't BB and isn't
4927         // outside the loop, assume the worst.
4928         if (L->contains(PredSucc))
4929           return getCouldNotCompute();
4930       }
4931       if (Pred == L->getHeader()) {
4932         Ok = true;
4933         break;
4934       }
4935       BB = Pred;
4936     }
4937     if (!Ok)
4938       return getCouldNotCompute();
4939   }
4940
4941   bool IsOnlyExit = (L->getExitingBlock() != nullptr);
4942   TerminatorInst *Term = ExitingBlock->getTerminator();
4943   if (BranchInst *BI = dyn_cast<BranchInst>(Term)) {
4944     assert(BI->isConditional() && "If unconditional, it can't be in loop!");
4945     // Proceed to the next level to examine the exit condition expression.
4946     return ComputeExitLimitFromCond(L, BI->getCondition(), BI->getSuccessor(0),
4947                                     BI->getSuccessor(1),
4948                                     /*ControlsExit=*/IsOnlyExit);
4949   }
4950
4951   if (SwitchInst *SI = dyn_cast<SwitchInst>(Term))
4952     return ComputeExitLimitFromSingleExitSwitch(L, SI, Exit,
4953                                                 /*ControlsExit=*/IsOnlyExit);
4954
4955   return getCouldNotCompute();
4956 }
4957
4958 /// ComputeExitLimitFromCond - Compute the number of times the
4959 /// backedge of the specified loop will execute if its exit condition
4960 /// were a conditional branch of ExitCond, TBB, and FBB.
4961 ///
4962 /// @param ControlsExit is true if ExitCond directly controls the exit
4963 /// branch. In this case, we can assume that the loop exits only if the
4964 /// condition is true and can infer that failing to meet the condition prior to
4965 /// integer wraparound results in undefined behavior.
4966 ScalarEvolution::ExitLimit
4967 ScalarEvolution::ComputeExitLimitFromCond(const Loop *L,
4968                                           Value *ExitCond,
4969                                           BasicBlock *TBB,
4970                                           BasicBlock *FBB,
4971                                           bool ControlsExit) {
4972   // Check if the controlling expression for this loop is an And or Or.
4973   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(ExitCond)) {
4974     if (BO->getOpcode() == Instruction::And) {
4975       // Recurse on the operands of the and.
4976       bool EitherMayExit = L->contains(TBB);
4977       ExitLimit EL0 = ComputeExitLimitFromCond(L, BO->getOperand(0), TBB, FBB,
4978                                                ControlsExit && !EitherMayExit);
4979       ExitLimit EL1 = ComputeExitLimitFromCond(L, BO->getOperand(1), TBB, FBB,
4980                                                ControlsExit && !EitherMayExit);
4981       const SCEV *BECount = getCouldNotCompute();
4982       const SCEV *MaxBECount = getCouldNotCompute();
4983       if (EitherMayExit) {
4984         // Both conditions must be true for the loop to continue executing.
4985         // Choose the less conservative count.
4986         if (EL0.Exact == getCouldNotCompute() ||
4987             EL1.Exact == getCouldNotCompute())
4988           BECount = getCouldNotCompute();
4989         else
4990           BECount = getUMinFromMismatchedTypes(EL0.Exact, EL1.Exact);
4991         if (EL0.Max == getCouldNotCompute())
4992           MaxBECount = EL1.Max;
4993         else if (EL1.Max == getCouldNotCompute())
4994           MaxBECount = EL0.Max;
4995         else
4996           MaxBECount = getUMinFromMismatchedTypes(EL0.Max, EL1.Max);
4997       } else {
4998         // Both conditions must be true at the same time for the loop to exit.
4999         // For now, be conservative.
5000         assert(L->contains(FBB) && "Loop block has no successor in loop!");
5001         if (EL0.Max == EL1.Max)
5002           MaxBECount = EL0.Max;
5003         if (EL0.Exact == EL1.Exact)
5004           BECount = EL0.Exact;
5005       }
5006
5007       return ExitLimit(BECount, MaxBECount);
5008     }
5009     if (BO->getOpcode() == Instruction::Or) {
5010       // Recurse on the operands of the or.
5011       bool EitherMayExit = L->contains(FBB);
5012       ExitLimit EL0 = ComputeExitLimitFromCond(L, BO->getOperand(0), TBB, FBB,
5013                                                ControlsExit && !EitherMayExit);
5014       ExitLimit EL1 = ComputeExitLimitFromCond(L, BO->getOperand(1), TBB, FBB,
5015                                                ControlsExit && !EitherMayExit);
5016       const SCEV *BECount = getCouldNotCompute();
5017       const SCEV *MaxBECount = getCouldNotCompute();
5018       if (EitherMayExit) {
5019         // Both conditions must be false for the loop to continue executing.
5020         // Choose the less conservative count.
5021         if (EL0.Exact == getCouldNotCompute() ||
5022             EL1.Exact == getCouldNotCompute())
5023           BECount = getCouldNotCompute();
5024         else
5025           BECount = getUMinFromMismatchedTypes(EL0.Exact, EL1.Exact);
5026         if (EL0.Max == getCouldNotCompute())
5027           MaxBECount = EL1.Max;
5028         else if (EL1.Max == getCouldNotCompute())
5029           MaxBECount = EL0.Max;
5030         else
5031           MaxBECount = getUMinFromMismatchedTypes(EL0.Max, EL1.Max);
5032       } else {
5033         // Both conditions must be false at the same time for the loop to exit.
5034         // For now, be conservative.
5035         assert(L->contains(TBB) && "Loop block has no successor in loop!");
5036         if (EL0.Max == EL1.Max)
5037           MaxBECount = EL0.Max;
5038         if (EL0.Exact == EL1.Exact)
5039           BECount = EL0.Exact;
5040       }
5041
5042       return ExitLimit(BECount, MaxBECount);
5043     }
5044   }
5045
5046   // With an icmp, it may be feasible to compute an exact backedge-taken count.
5047   // Proceed to the next level to examine the icmp.
5048   if (ICmpInst *ExitCondICmp = dyn_cast<ICmpInst>(ExitCond))
5049     return ComputeExitLimitFromICmp(L, ExitCondICmp, TBB, FBB, ControlsExit);
5050
5051   // Check for a constant condition. These are normally stripped out by
5052   // SimplifyCFG, but ScalarEvolution may be used by a pass which wishes to
5053   // preserve the CFG and is temporarily leaving constant conditions
5054   // in place.
5055   if (ConstantInt *CI = dyn_cast<ConstantInt>(ExitCond)) {
5056     if (L->contains(FBB) == !CI->getZExtValue())
5057       // The backedge is always taken.
5058       return getCouldNotCompute();
5059     else
5060       // The backedge is never taken.
5061       return getConstant(CI->getType(), 0);
5062   }
5063
5064   // If it's not an integer or pointer comparison then compute it the hard way.
5065   return ComputeExitCountExhaustively(L, ExitCond, !L->contains(TBB));
5066 }
5067
5068 /// ComputeExitLimitFromICmp - Compute the number of times the
5069 /// backedge of the specified loop will execute if its exit condition
5070 /// were a conditional branch of the ICmpInst ExitCond, TBB, and FBB.
5071 ScalarEvolution::ExitLimit
5072 ScalarEvolution::ComputeExitLimitFromICmp(const Loop *L,
5073                                           ICmpInst *ExitCond,
5074                                           BasicBlock *TBB,
5075                                           BasicBlock *FBB,
5076                                           bool ControlsExit) {
5077
5078   // If the condition was exit on true, convert the condition to exit on false
5079   ICmpInst::Predicate Cond;
5080   if (!L->contains(FBB))
5081     Cond = ExitCond->getPredicate();
5082   else
5083     Cond = ExitCond->getInversePredicate();
5084
5085   // Handle common loops like: for (X = "string"; *X; ++X)
5086   if (LoadInst *LI = dyn_cast<LoadInst>(ExitCond->getOperand(0)))
5087     if (Constant *RHS = dyn_cast<Constant>(ExitCond->getOperand(1))) {
5088       ExitLimit ItCnt =
5089         ComputeLoadConstantCompareExitLimit(LI, RHS, L, Cond);
5090       if (ItCnt.hasAnyInfo())
5091         return ItCnt;
5092     }
5093
5094   const SCEV *LHS = getSCEV(ExitCond->getOperand(0));
5095   const SCEV *RHS = getSCEV(ExitCond->getOperand(1));
5096
5097   // Try to evaluate any dependencies out of the loop.
5098   LHS = getSCEVAtScope(LHS, L);
5099   RHS = getSCEVAtScope(RHS, L);
5100
5101   // At this point, we would like to compute how many iterations of the
5102   // loop the predicate will return true for these inputs.
5103   if (isLoopInvariant(LHS, L) && !isLoopInvariant(RHS, L)) {
5104     // If there is a loop-invariant, force it into the RHS.
5105     std::swap(LHS, RHS);
5106     Cond = ICmpInst::getSwappedPredicate(Cond);
5107   }
5108
5109   // Simplify the operands before analyzing them.
5110   (void)SimplifyICmpOperands(Cond, LHS, RHS);
5111
5112   // If we have a comparison of a chrec against a constant, try to use value
5113   // ranges to answer this query.
5114   if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS))
5115     if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS))
5116       if (AddRec->getLoop() == L) {
5117         // Form the constant range.
5118         ConstantRange CompRange(
5119             ICmpInst::makeConstantRange(Cond, RHSC->getValue()->getValue()));
5120
5121         const SCEV *Ret = AddRec->getNumIterationsInRange(CompRange, *this);
5122         if (!isa<SCEVCouldNotCompute>(Ret)) return Ret;
5123       }
5124
5125   switch (Cond) {
5126   case ICmpInst::ICMP_NE: {                     // while (X != Y)
5127     // Convert to: while (X-Y != 0)
5128     ExitLimit EL = HowFarToZero(getMinusSCEV(LHS, RHS), L, ControlsExit);
5129     if (EL.hasAnyInfo()) return EL;
5130     break;
5131   }
5132   case ICmpInst::ICMP_EQ: {                     // while (X == Y)
5133     // Convert to: while (X-Y == 0)
5134     ExitLimit EL = HowFarToNonZero(getMinusSCEV(LHS, RHS), L);
5135     if (EL.hasAnyInfo()) return EL;
5136     break;
5137   }
5138   case ICmpInst::ICMP_SLT:
5139   case ICmpInst::ICMP_ULT: {                    // while (X < Y)
5140     bool IsSigned = Cond == ICmpInst::ICMP_SLT;
5141     ExitLimit EL = HowManyLessThans(LHS, RHS, L, IsSigned, ControlsExit);
5142     if (EL.hasAnyInfo()) return EL;
5143     break;
5144   }
5145   case ICmpInst::ICMP_SGT:
5146   case ICmpInst::ICMP_UGT: {                    // while (X > Y)
5147     bool IsSigned = Cond == ICmpInst::ICMP_SGT;
5148     ExitLimit EL = HowManyGreaterThans(LHS, RHS, L, IsSigned, ControlsExit);
5149     if (EL.hasAnyInfo()) return EL;
5150     break;
5151   }
5152   default:
5153 #if 0
5154     dbgs() << "ComputeBackedgeTakenCount ";
5155     if (ExitCond->getOperand(0)->getType()->isUnsigned())
5156       dbgs() << "[unsigned] ";
5157     dbgs() << *LHS << "   "
5158          << Instruction::getOpcodeName(Instruction::ICmp)
5159          << "   " << *RHS << "\n";
5160 #endif
5161     break;
5162   }
5163   return ComputeExitCountExhaustively(L, ExitCond, !L->contains(TBB));
5164 }
5165
5166 ScalarEvolution::ExitLimit
5167 ScalarEvolution::ComputeExitLimitFromSingleExitSwitch(const Loop *L,
5168                                                       SwitchInst *Switch,
5169                                                       BasicBlock *ExitingBlock,
5170                                                       bool ControlsExit) {
5171   assert(!L->contains(ExitingBlock) && "Not an exiting block!");
5172
5173   // Give up if the exit is the default dest of a switch.
5174   if (Switch->getDefaultDest() == ExitingBlock)
5175     return getCouldNotCompute();
5176
5177   assert(L->contains(Switch->getDefaultDest()) &&
5178          "Default case must not exit the loop!");
5179   const SCEV *LHS = getSCEVAtScope(Switch->getCondition(), L);
5180   const SCEV *RHS = getConstant(Switch->findCaseDest(ExitingBlock));
5181
5182   // while (X != Y) --> while (X-Y != 0)
5183   ExitLimit EL = HowFarToZero(getMinusSCEV(LHS, RHS), L, ControlsExit);
5184   if (EL.hasAnyInfo())
5185     return EL;
5186
5187   return getCouldNotCompute();
5188 }
5189
5190 static ConstantInt *
5191 EvaluateConstantChrecAtConstant(const SCEVAddRecExpr *AddRec, ConstantInt *C,
5192                                 ScalarEvolution &SE) {
5193   const SCEV *InVal = SE.getConstant(C);
5194   const SCEV *Val = AddRec->evaluateAtIteration(InVal, SE);
5195   assert(isa<SCEVConstant>(Val) &&
5196          "Evaluation of SCEV at constant didn't fold correctly?");
5197   return cast<SCEVConstant>(Val)->getValue();
5198 }
5199
5200 /// ComputeLoadConstantCompareExitLimit - Given an exit condition of
5201 /// 'icmp op load X, cst', try to see if we can compute the backedge
5202 /// execution count.
5203 ScalarEvolution::ExitLimit
5204 ScalarEvolution::ComputeLoadConstantCompareExitLimit(
5205   LoadInst *LI,
5206   Constant *RHS,
5207   const Loop *L,
5208   ICmpInst::Predicate predicate) {
5209
5210   if (LI->isVolatile()) return getCouldNotCompute();
5211
5212   // Check to see if the loaded pointer is a getelementptr of a global.
5213   // TODO: Use SCEV instead of manually grubbing with GEPs.
5214   GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0));
5215   if (!GEP) return getCouldNotCompute();
5216
5217   // Make sure that it is really a constant global we are gepping, with an
5218   // initializer, and make sure the first IDX is really 0.
5219   GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0));
5220   if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() ||
5221       GEP->getNumOperands() < 3 || !isa<Constant>(GEP->getOperand(1)) ||
5222       !cast<Constant>(GEP->getOperand(1))->isNullValue())
5223     return getCouldNotCompute();
5224
5225   // Okay, we allow one non-constant index into the GEP instruction.
5226   Value *VarIdx = nullptr;
5227   std::vector<Constant*> Indexes;
5228   unsigned VarIdxNum = 0;
5229   for (unsigned i = 2, e = GEP->getNumOperands(); i != e; ++i)
5230     if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
5231       Indexes.push_back(CI);
5232     } else if (!isa<ConstantInt>(GEP->getOperand(i))) {
5233       if (VarIdx) return getCouldNotCompute();  // Multiple non-constant idx's.
5234       VarIdx = GEP->getOperand(i);
5235       VarIdxNum = i-2;
5236       Indexes.push_back(nullptr);
5237     }
5238
5239   // Loop-invariant loads may be a byproduct of loop optimization. Skip them.
5240   if (!VarIdx)
5241     return getCouldNotCompute();
5242
5243   // Okay, we know we have a (load (gep GV, 0, X)) comparison with a constant.
5244   // Check to see if X is a loop variant variable value now.
5245   const SCEV *Idx = getSCEV(VarIdx);
5246   Idx = getSCEVAtScope(Idx, L);
5247
5248   // We can only recognize very limited forms of loop index expressions, in
5249   // particular, only affine AddRec's like {C1,+,C2}.
5250   const SCEVAddRecExpr *IdxExpr = dyn_cast<SCEVAddRecExpr>(Idx);
5251   if (!IdxExpr || !IdxExpr->isAffine() || isLoopInvariant(IdxExpr, L) ||
5252       !isa<SCEVConstant>(IdxExpr->getOperand(0)) ||
5253       !isa<SCEVConstant>(IdxExpr->getOperand(1)))
5254     return getCouldNotCompute();
5255
5256   unsigned MaxSteps = MaxBruteForceIterations;
5257   for (unsigned IterationNum = 0; IterationNum != MaxSteps; ++IterationNum) {
5258     ConstantInt *ItCst = ConstantInt::get(
5259                            cast<IntegerType>(IdxExpr->getType()), IterationNum);
5260     ConstantInt *Val = EvaluateConstantChrecAtConstant(IdxExpr, ItCst, *this);
5261
5262     // Form the GEP offset.
5263     Indexes[VarIdxNum] = Val;
5264
5265     Constant *Result = ConstantFoldLoadThroughGEPIndices(GV->getInitializer(),
5266                                                          Indexes);
5267     if (!Result) break;  // Cannot compute!
5268
5269     // Evaluate the condition for this iteration.
5270     Result = ConstantExpr::getICmp(predicate, Result, RHS);
5271     if (!isa<ConstantInt>(Result)) break;  // Couldn't decide for sure
5272     if (cast<ConstantInt>(Result)->getValue().isMinValue()) {
5273 #if 0
5274       dbgs() << "\n***\n*** Computed loop count " << *ItCst
5275              << "\n*** From global " << *GV << "*** BB: " << *L->getHeader()
5276              << "***\n";
5277 #endif
5278       ++NumArrayLenItCounts;
5279       return getConstant(ItCst);   // Found terminating iteration!
5280     }
5281   }
5282   return getCouldNotCompute();
5283 }
5284
5285
5286 /// CanConstantFold - Return true if we can constant fold an instruction of the
5287 /// specified type, assuming that all operands were constants.
5288 static bool CanConstantFold(const Instruction *I) {
5289   if (isa<BinaryOperator>(I) || isa<CmpInst>(I) ||
5290       isa<SelectInst>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I) ||
5291       isa<LoadInst>(I))
5292     return true;
5293
5294   if (const CallInst *CI = dyn_cast<CallInst>(I))
5295     if (const Function *F = CI->getCalledFunction())
5296       return canConstantFoldCallTo(F);
5297   return false;
5298 }
5299
5300 /// Determine whether this instruction can constant evolve within this loop
5301 /// assuming its operands can all constant evolve.
5302 static bool canConstantEvolve(Instruction *I, const Loop *L) {
5303   // An instruction outside of the loop can't be derived from a loop PHI.
5304   if (!L->contains(I)) return false;
5305
5306   if (isa<PHINode>(I)) {
5307     if (L->getHeader() == I->getParent())
5308       return true;
5309     else
5310       // We don't currently keep track of the control flow needed to evaluate
5311       // PHIs, so we cannot handle PHIs inside of loops.
5312       return false;
5313   }
5314
5315   // If we won't be able to constant fold this expression even if the operands
5316   // are constants, bail early.
5317   return CanConstantFold(I);
5318 }
5319
5320 /// getConstantEvolvingPHIOperands - Implement getConstantEvolvingPHI by
5321 /// recursing through each instruction operand until reaching a loop header phi.
5322 static PHINode *
5323 getConstantEvolvingPHIOperands(Instruction *UseInst, const Loop *L,
5324                                DenseMap<Instruction *, PHINode *> &PHIMap) {
5325
5326   // Otherwise, we can evaluate this instruction if all of its operands are
5327   // constant or derived from a PHI node themselves.
5328   PHINode *PHI = nullptr;
5329   for (Instruction::op_iterator OpI = UseInst->op_begin(),
5330          OpE = UseInst->op_end(); OpI != OpE; ++OpI) {
5331
5332     if (isa<Constant>(*OpI)) continue;
5333
5334     Instruction *OpInst = dyn_cast<Instruction>(*OpI);
5335     if (!OpInst || !canConstantEvolve(OpInst, L)) return nullptr;
5336
5337     PHINode *P = dyn_cast<PHINode>(OpInst);
5338     if (!P)
5339       // If this operand is already visited, reuse the prior result.
5340       // We may have P != PHI if this is the deepest point at which the
5341       // inconsistent paths meet.
5342       P = PHIMap.lookup(OpInst);
5343     if (!P) {
5344       // Recurse and memoize the results, whether a phi is found or not.
5345       // This recursive call invalidates pointers into PHIMap.
5346       P = getConstantEvolvingPHIOperands(OpInst, L, PHIMap);
5347       PHIMap[OpInst] = P;
5348     }
5349     if (!P)
5350       return nullptr;  // Not evolving from PHI
5351     if (PHI && PHI != P)
5352       return nullptr;  // Evolving from multiple different PHIs.
5353     PHI = P;
5354   }
5355   // This is a expression evolving from a constant PHI!
5356   return PHI;
5357 }
5358
5359 /// getConstantEvolvingPHI - Given an LLVM value and a loop, return a PHI node
5360 /// in the loop that V is derived from.  We allow arbitrary operations along the
5361 /// way, but the operands of an operation must either be constants or a value
5362 /// derived from a constant PHI.  If this expression does not fit with these
5363 /// constraints, return null.
5364 static PHINode *getConstantEvolvingPHI(Value *V, const Loop *L) {
5365   Instruction *I = dyn_cast<Instruction>(V);
5366   if (!I || !canConstantEvolve(I, L)) return nullptr;
5367
5368   if (PHINode *PN = dyn_cast<PHINode>(I)) {
5369     return PN;
5370   }
5371
5372   // Record non-constant instructions contained by the loop.
5373   DenseMap<Instruction *, PHINode *> PHIMap;
5374   return getConstantEvolvingPHIOperands(I, L, PHIMap);
5375 }
5376
5377 /// EvaluateExpression - Given an expression that passes the
5378 /// getConstantEvolvingPHI predicate, evaluate its value assuming the PHI node
5379 /// in the loop has the value PHIVal.  If we can't fold this expression for some
5380 /// reason, return null.
5381 static Constant *EvaluateExpression(Value *V, const Loop *L,
5382                                     DenseMap<Instruction *, Constant *> &Vals,
5383                                     const DataLayout &DL,
5384                                     const TargetLibraryInfo *TLI) {
5385   // Convenient constant check, but redundant for recursive calls.
5386   if (Constant *C = dyn_cast<Constant>(V)) return C;
5387   Instruction *I = dyn_cast<Instruction>(V);
5388   if (!I) return nullptr;
5389
5390   if (Constant *C = Vals.lookup(I)) return C;
5391
5392   // An instruction inside the loop depends on a value outside the loop that we
5393   // weren't given a mapping for, or a value such as a call inside the loop.
5394   if (!canConstantEvolve(I, L)) return nullptr;
5395
5396   // An unmapped PHI can be due to a branch or another loop inside this loop,
5397   // or due to this not being the initial iteration through a loop where we
5398   // couldn't compute the evolution of this particular PHI last time.
5399   if (isa<PHINode>(I)) return nullptr;
5400
5401   std::vector<Constant*> Operands(I->getNumOperands());
5402
5403   for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
5404     Instruction *Operand = dyn_cast<Instruction>(I->getOperand(i));
5405     if (!Operand) {
5406       Operands[i] = dyn_cast<Constant>(I->getOperand(i));
5407       if (!Operands[i]) return nullptr;
5408       continue;
5409     }
5410     Constant *C = EvaluateExpression(Operand, L, Vals, DL, TLI);
5411     Vals[Operand] = C;
5412     if (!C) return nullptr;
5413     Operands[i] = C;
5414   }
5415
5416   if (CmpInst *CI = dyn_cast<CmpInst>(I))
5417     return ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0],
5418                                            Operands[1], DL, TLI);
5419   if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
5420     if (!LI->isVolatile())
5421       return ConstantFoldLoadFromConstPtr(Operands[0], DL);
5422   }
5423   return ConstantFoldInstOperands(I->getOpcode(), I->getType(), Operands, DL,
5424                                   TLI);
5425 }
5426
5427 /// getConstantEvolutionLoopExitValue - If we know that the specified Phi is
5428 /// in the header of its containing loop, we know the loop executes a
5429 /// constant number of times, and the PHI node is just a recurrence
5430 /// involving constants, fold it.
5431 Constant *
5432 ScalarEvolution::getConstantEvolutionLoopExitValue(PHINode *PN,
5433                                                    const APInt &BEs,
5434                                                    const Loop *L) {
5435   DenseMap<PHINode*, Constant*>::const_iterator I =
5436     ConstantEvolutionLoopExitValue.find(PN);
5437   if (I != ConstantEvolutionLoopExitValue.end())
5438     return I->second;
5439
5440   if (BEs.ugt(MaxBruteForceIterations))
5441     return ConstantEvolutionLoopExitValue[PN] = nullptr;  // Not going to evaluate it.
5442
5443   Constant *&RetVal = ConstantEvolutionLoopExitValue[PN];
5444
5445   DenseMap<Instruction *, Constant *> CurrentIterVals;
5446   BasicBlock *Header = L->getHeader();
5447   assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!");
5448
5449   // Since the loop is canonicalized, the PHI node must have two entries.  One
5450   // entry must be a constant (coming in from outside of the loop), and the
5451   // second must be derived from the same PHI.
5452   bool SecondIsBackedge = L->contains(PN->getIncomingBlock(1));
5453   PHINode *PHI = nullptr;
5454   for (BasicBlock::iterator I = Header->begin();
5455        (PHI = dyn_cast<PHINode>(I)); ++I) {
5456     Constant *StartCST =
5457       dyn_cast<Constant>(PHI->getIncomingValue(!SecondIsBackedge));
5458     if (!StartCST) continue;
5459     CurrentIterVals[PHI] = StartCST;
5460   }
5461   if (!CurrentIterVals.count(PN))
5462     return RetVal = nullptr;
5463
5464   Value *BEValue = PN->getIncomingValue(SecondIsBackedge);
5465
5466   // Execute the loop symbolically to determine the exit value.
5467   if (BEs.getActiveBits() >= 32)
5468     return RetVal = nullptr; // More than 2^32-1 iterations?? Not doing it!
5469
5470   unsigned NumIterations = BEs.getZExtValue(); // must be in range
5471   unsigned IterationNum = 0;
5472   const DataLayout &DL = F->getParent()->getDataLayout();
5473   for (; ; ++IterationNum) {
5474     if (IterationNum == NumIterations)
5475       return RetVal = CurrentIterVals[PN];  // Got exit value!
5476
5477     // Compute the value of the PHIs for the next iteration.
5478     // EvaluateExpression adds non-phi values to the CurrentIterVals map.
5479     DenseMap<Instruction *, Constant *> NextIterVals;
5480     Constant *NextPHI =
5481         EvaluateExpression(BEValue, L, CurrentIterVals, DL, TLI);
5482     if (!NextPHI)
5483       return nullptr;        // Couldn't evaluate!
5484     NextIterVals[PN] = NextPHI;
5485
5486     bool StoppedEvolving = NextPHI == CurrentIterVals[PN];
5487
5488     // Also evaluate the other PHI nodes.  However, we don't get to stop if we
5489     // cease to be able to evaluate one of them or if they stop evolving,
5490     // because that doesn't necessarily prevent us from computing PN.
5491     SmallVector<std::pair<PHINode *, Constant *>, 8> PHIsToCompute;
5492     for (DenseMap<Instruction *, Constant *>::const_iterator
5493            I = CurrentIterVals.begin(), E = CurrentIterVals.end(); I != E; ++I){
5494       PHINode *PHI = dyn_cast<PHINode>(I->first);
5495       if (!PHI || PHI == PN || PHI->getParent() != Header) continue;
5496       PHIsToCompute.push_back(std::make_pair(PHI, I->second));
5497     }
5498     // We use two distinct loops because EvaluateExpression may invalidate any
5499     // iterators into CurrentIterVals.
5500     for (SmallVectorImpl<std::pair<PHINode *, Constant*> >::const_iterator
5501              I = PHIsToCompute.begin(), E = PHIsToCompute.end(); I != E; ++I) {
5502       PHINode *PHI = I->first;
5503       Constant *&NextPHI = NextIterVals[PHI];
5504       if (!NextPHI) {   // Not already computed.
5505         Value *BEValue = PHI->getIncomingValue(SecondIsBackedge);
5506         NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, DL, TLI);
5507       }
5508       if (NextPHI != I->second)
5509         StoppedEvolving = false;
5510     }
5511
5512     // If all entries in CurrentIterVals == NextIterVals then we can stop
5513     // iterating, the loop can't continue to change.
5514     if (StoppedEvolving)
5515       return RetVal = CurrentIterVals[PN];
5516
5517     CurrentIterVals.swap(NextIterVals);
5518   }
5519 }
5520
5521 /// ComputeExitCountExhaustively - If the loop is known to execute a
5522 /// constant number of times (the condition evolves only from constants),
5523 /// try to evaluate a few iterations of the loop until we get the exit
5524 /// condition gets a value of ExitWhen (true or false).  If we cannot
5525 /// evaluate the trip count of the loop, return getCouldNotCompute().
5526 const SCEV *ScalarEvolution::ComputeExitCountExhaustively(const Loop *L,
5527                                                           Value *Cond,
5528                                                           bool ExitWhen) {
5529   PHINode *PN = getConstantEvolvingPHI(Cond, L);
5530   if (!PN) return getCouldNotCompute();
5531
5532   // If the loop is canonicalized, the PHI will have exactly two entries.
5533   // That's the only form we support here.
5534   if (PN->getNumIncomingValues() != 2) return getCouldNotCompute();
5535
5536   DenseMap<Instruction *, Constant *> CurrentIterVals;
5537   BasicBlock *Header = L->getHeader();
5538   assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!");
5539
5540   // One entry must be a constant (coming in from outside of the loop), and the
5541   // second must be derived from the same PHI.
5542   bool SecondIsBackedge = L->contains(PN->getIncomingBlock(1));
5543   PHINode *PHI = nullptr;
5544   for (BasicBlock::iterator I = Header->begin();
5545        (PHI = dyn_cast<PHINode>(I)); ++I) {
5546     Constant *StartCST =
5547       dyn_cast<Constant>(PHI->getIncomingValue(!SecondIsBackedge));
5548     if (!StartCST) continue;
5549     CurrentIterVals[PHI] = StartCST;
5550   }
5551   if (!CurrentIterVals.count(PN))
5552     return getCouldNotCompute();
5553
5554   // Okay, we find a PHI node that defines the trip count of this loop.  Execute
5555   // the loop symbolically to determine when the condition gets a value of
5556   // "ExitWhen".
5557   unsigned MaxIterations = MaxBruteForceIterations;   // Limit analysis.
5558   const DataLayout &DL = F->getParent()->getDataLayout();
5559   for (unsigned IterationNum = 0; IterationNum != MaxIterations;++IterationNum){
5560     ConstantInt *CondVal = dyn_cast_or_null<ConstantInt>(
5561         EvaluateExpression(Cond, L, CurrentIterVals, DL, TLI));
5562
5563     // Couldn't symbolically evaluate.
5564     if (!CondVal) return getCouldNotCompute();
5565
5566     if (CondVal->getValue() == uint64_t(ExitWhen)) {
5567       ++NumBruteForceTripCountsComputed;
5568       return getConstant(Type::getInt32Ty(getContext()), IterationNum);
5569     }
5570
5571     // Update all the PHI nodes for the next iteration.
5572     DenseMap<Instruction *, Constant *> NextIterVals;
5573
5574     // Create a list of which PHIs we need to compute. We want to do this before
5575     // calling EvaluateExpression on them because that may invalidate iterators
5576     // into CurrentIterVals.
5577     SmallVector<PHINode *, 8> PHIsToCompute;
5578     for (DenseMap<Instruction *, Constant *>::const_iterator
5579            I = CurrentIterVals.begin(), E = CurrentIterVals.end(); I != E; ++I){
5580       PHINode *PHI = dyn_cast<PHINode>(I->first);
5581       if (!PHI || PHI->getParent() != Header) continue;
5582       PHIsToCompute.push_back(PHI);
5583     }
5584     for (SmallVectorImpl<PHINode *>::const_iterator I = PHIsToCompute.begin(),
5585              E = PHIsToCompute.end(); I != E; ++I) {
5586       PHINode *PHI = *I;
5587       Constant *&NextPHI = NextIterVals[PHI];
5588       if (NextPHI) continue;    // Already computed!
5589
5590       Value *BEValue = PHI->getIncomingValue(SecondIsBackedge);
5591       NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, DL, TLI);
5592     }
5593     CurrentIterVals.swap(NextIterVals);
5594   }
5595
5596   // Too many iterations were needed to evaluate.
5597   return getCouldNotCompute();
5598 }
5599
5600 /// getSCEVAtScope - Return a SCEV expression for the specified value
5601 /// at the specified scope in the program.  The L value specifies a loop
5602 /// nest to evaluate the expression at, where null is the top-level or a
5603 /// specified loop is immediately inside of the loop.
5604 ///
5605 /// This method can be used to compute the exit value for a variable defined
5606 /// in a loop by querying what the value will hold in the parent loop.
5607 ///
5608 /// In the case that a relevant loop exit value cannot be computed, the
5609 /// original value V is returned.
5610 const SCEV *ScalarEvolution::getSCEVAtScope(const SCEV *V, const Loop *L) {
5611   // Check to see if we've folded this expression at this loop before.
5612   SmallVector<std::pair<const Loop *, const SCEV *>, 2> &Values = ValuesAtScopes[V];
5613   for (unsigned u = 0; u < Values.size(); u++) {
5614     if (Values[u].first == L)
5615       return Values[u].second ? Values[u].second : V;
5616   }
5617   Values.push_back(std::make_pair(L, static_cast<const SCEV *>(nullptr)));
5618   // Otherwise compute it.
5619   const SCEV *C = computeSCEVAtScope(V, L);
5620   SmallVector<std::pair<const Loop *, const SCEV *>, 2> &Values2 = ValuesAtScopes[V];
5621   for (unsigned u = Values2.size(); u > 0; u--) {
5622     if (Values2[u - 1].first == L) {
5623       Values2[u - 1].second = C;
5624       break;
5625     }
5626   }
5627   return C;
5628 }
5629
5630 /// This builds up a Constant using the ConstantExpr interface.  That way, we
5631 /// will return Constants for objects which aren't represented by a
5632 /// SCEVConstant, because SCEVConstant is restricted to ConstantInt.
5633 /// Returns NULL if the SCEV isn't representable as a Constant.
5634 static Constant *BuildConstantFromSCEV(const SCEV *V) {
5635   switch (static_cast<SCEVTypes>(V->getSCEVType())) {
5636     case scCouldNotCompute:
5637     case scAddRecExpr:
5638       break;
5639     case scConstant:
5640       return cast<SCEVConstant>(V)->getValue();
5641     case scUnknown:
5642       return dyn_cast<Constant>(cast<SCEVUnknown>(V)->getValue());
5643     case scSignExtend: {
5644       const SCEVSignExtendExpr *SS = cast<SCEVSignExtendExpr>(V);
5645       if (Constant *CastOp = BuildConstantFromSCEV(SS->getOperand()))
5646         return ConstantExpr::getSExt(CastOp, SS->getType());
5647       break;
5648     }
5649     case scZeroExtend: {
5650       const SCEVZeroExtendExpr *SZ = cast<SCEVZeroExtendExpr>(V);
5651       if (Constant *CastOp = BuildConstantFromSCEV(SZ->getOperand()))
5652         return ConstantExpr::getZExt(CastOp, SZ->getType());
5653       break;
5654     }
5655     case scTruncate: {
5656       const SCEVTruncateExpr *ST = cast<SCEVTruncateExpr>(V);
5657       if (Constant *CastOp = BuildConstantFromSCEV(ST->getOperand()))
5658         return ConstantExpr::getTrunc(CastOp, ST->getType());
5659       break;
5660     }
5661     case scAddExpr: {
5662       const SCEVAddExpr *SA = cast<SCEVAddExpr>(V);
5663       if (Constant *C = BuildConstantFromSCEV(SA->getOperand(0))) {
5664         if (PointerType *PTy = dyn_cast<PointerType>(C->getType())) {
5665           unsigned AS = PTy->getAddressSpace();
5666           Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS);
5667           C = ConstantExpr::getBitCast(C, DestPtrTy);
5668         }
5669         for (unsigned i = 1, e = SA->getNumOperands(); i != e; ++i) {
5670           Constant *C2 = BuildConstantFromSCEV(SA->getOperand(i));
5671           if (!C2) return nullptr;
5672
5673           // First pointer!
5674           if (!C->getType()->isPointerTy() && C2->getType()->isPointerTy()) {
5675             unsigned AS = C2->getType()->getPointerAddressSpace();
5676             std::swap(C, C2);
5677             Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS);
5678             // The offsets have been converted to bytes.  We can add bytes to an
5679             // i8* by GEP with the byte count in the first index.
5680             C = ConstantExpr::getBitCast(C, DestPtrTy);
5681           }
5682
5683           // Don't bother trying to sum two pointers. We probably can't
5684           // statically compute a load that results from it anyway.
5685           if (C2->getType()->isPointerTy())
5686             return nullptr;
5687
5688           if (PointerType *PTy = dyn_cast<PointerType>(C->getType())) {
5689             if (PTy->getElementType()->isStructTy())
5690               C2 = ConstantExpr::getIntegerCast(
5691                   C2, Type::getInt32Ty(C->getContext()), true);
5692             C = ConstantExpr::getGetElementPtr(C, C2);
5693           } else
5694             C = ConstantExpr::getAdd(C, C2);
5695         }
5696         return C;
5697       }
5698       break;
5699     }
5700     case scMulExpr: {
5701       const SCEVMulExpr *SM = cast<SCEVMulExpr>(V);
5702       if (Constant *C = BuildConstantFromSCEV(SM->getOperand(0))) {
5703         // Don't bother with pointers at all.
5704         if (C->getType()->isPointerTy()) return nullptr;
5705         for (unsigned i = 1, e = SM->getNumOperands(); i != e; ++i) {
5706           Constant *C2 = BuildConstantFromSCEV(SM->getOperand(i));
5707           if (!C2 || C2->getType()->isPointerTy()) return nullptr;
5708           C = ConstantExpr::getMul(C, C2);
5709         }
5710         return C;
5711       }
5712       break;
5713     }
5714     case scUDivExpr: {
5715       const SCEVUDivExpr *SU = cast<SCEVUDivExpr>(V);
5716       if (Constant *LHS = BuildConstantFromSCEV(SU->getLHS()))
5717         if (Constant *RHS = BuildConstantFromSCEV(SU->getRHS()))
5718           if (LHS->getType() == RHS->getType())
5719             return ConstantExpr::getUDiv(LHS, RHS);
5720       break;
5721     }
5722     case scSMaxExpr:
5723     case scUMaxExpr:
5724       break; // TODO: smax, umax.
5725   }
5726   return nullptr;
5727 }
5728
5729 const SCEV *ScalarEvolution::computeSCEVAtScope(const SCEV *V, const Loop *L) {
5730   if (isa<SCEVConstant>(V)) return V;
5731
5732   // If this instruction is evolved from a constant-evolving PHI, compute the
5733   // exit value from the loop without using SCEVs.
5734   if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V)) {
5735     if (Instruction *I = dyn_cast<Instruction>(SU->getValue())) {
5736       const Loop *LI = (*this->LI)[I->getParent()];
5737       if (LI && LI->getParentLoop() == L)  // Looking for loop exit value.
5738         if (PHINode *PN = dyn_cast<PHINode>(I))
5739           if (PN->getParent() == LI->getHeader()) {
5740             // Okay, there is no closed form solution for the PHI node.  Check
5741             // to see if the loop that contains it has a known backedge-taken
5742             // count.  If so, we may be able to force computation of the exit
5743             // value.
5744             const SCEV *BackedgeTakenCount = getBackedgeTakenCount(LI);
5745             if (const SCEVConstant *BTCC =
5746                   dyn_cast<SCEVConstant>(BackedgeTakenCount)) {
5747               // Okay, we know how many times the containing loop executes.  If
5748               // this is a constant evolving PHI node, get the final value at
5749               // the specified iteration number.
5750               Constant *RV = getConstantEvolutionLoopExitValue(PN,
5751                                                    BTCC->getValue()->getValue(),
5752                                                                LI);
5753               if (RV) return getSCEV(RV);
5754             }
5755           }
5756
5757       // Okay, this is an expression that we cannot symbolically evaluate
5758       // into a SCEV.  Check to see if it's possible to symbolically evaluate
5759       // the arguments into constants, and if so, try to constant propagate the
5760       // result.  This is particularly useful for computing loop exit values.
5761       if (CanConstantFold(I)) {
5762         SmallVector<Constant *, 4> Operands;
5763         bool MadeImprovement = false;
5764         for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
5765           Value *Op = I->getOperand(i);
5766           if (Constant *C = dyn_cast<Constant>(Op)) {
5767             Operands.push_back(C);
5768             continue;
5769           }
5770
5771           // If any of the operands is non-constant and if they are
5772           // non-integer and non-pointer, don't even try to analyze them
5773           // with scev techniques.
5774           if (!isSCEVable(Op->getType()))
5775             return V;
5776
5777           const SCEV *OrigV = getSCEV(Op);
5778           const SCEV *OpV = getSCEVAtScope(OrigV, L);
5779           MadeImprovement |= OrigV != OpV;
5780
5781           Constant *C = BuildConstantFromSCEV(OpV);
5782           if (!C) return V;
5783           if (C->getType() != Op->getType())
5784             C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
5785                                                               Op->getType(),
5786                                                               false),
5787                                       C, Op->getType());
5788           Operands.push_back(C);
5789         }
5790
5791         // Check to see if getSCEVAtScope actually made an improvement.
5792         if (MadeImprovement) {
5793           Constant *C = nullptr;
5794           const DataLayout &DL = F->getParent()->getDataLayout();
5795           if (const CmpInst *CI = dyn_cast<CmpInst>(I))
5796             C = ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0],
5797                                                 Operands[1], DL, TLI);
5798           else if (const LoadInst *LI = dyn_cast<LoadInst>(I)) {
5799             if (!LI->isVolatile())
5800               C = ConstantFoldLoadFromConstPtr(Operands[0], DL);
5801           } else
5802             C = ConstantFoldInstOperands(I->getOpcode(), I->getType(), Operands,
5803                                          DL, TLI);
5804           if (!C) return V;
5805           return getSCEV(C);
5806         }
5807       }
5808     }
5809
5810     // This is some other type of SCEVUnknown, just return it.
5811     return V;
5812   }
5813
5814   if (const SCEVCommutativeExpr *Comm = dyn_cast<SCEVCommutativeExpr>(V)) {
5815     // Avoid performing the look-up in the common case where the specified
5816     // expression has no loop-variant portions.
5817     for (unsigned i = 0, e = Comm->getNumOperands(); i != e; ++i) {
5818       const SCEV *OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
5819       if (OpAtScope != Comm->getOperand(i)) {
5820         // Okay, at least one of these operands is loop variant but might be
5821         // foldable.  Build a new instance of the folded commutative expression.
5822         SmallVector<const SCEV *, 8> NewOps(Comm->op_begin(),
5823                                             Comm->op_begin()+i);
5824         NewOps.push_back(OpAtScope);
5825
5826         for (++i; i != e; ++i) {
5827           OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
5828           NewOps.push_back(OpAtScope);
5829         }
5830         if (isa<SCEVAddExpr>(Comm))
5831           return getAddExpr(NewOps);
5832         if (isa<SCEVMulExpr>(Comm))
5833           return getMulExpr(NewOps);
5834         if (isa<SCEVSMaxExpr>(Comm))
5835           return getSMaxExpr(NewOps);
5836         if (isa<SCEVUMaxExpr>(Comm))
5837           return getUMaxExpr(NewOps);
5838         llvm_unreachable("Unknown commutative SCEV type!");
5839       }
5840     }
5841     // If we got here, all operands are loop invariant.
5842     return Comm;
5843   }
5844
5845   if (const SCEVUDivExpr *Div = dyn_cast<SCEVUDivExpr>(V)) {
5846     const SCEV *LHS = getSCEVAtScope(Div->getLHS(), L);
5847     const SCEV *RHS = getSCEVAtScope(Div->getRHS(), L);
5848     if (LHS == Div->getLHS() && RHS == Div->getRHS())
5849       return Div;   // must be loop invariant
5850     return getUDivExpr(LHS, RHS);
5851   }
5852
5853   // If this is a loop recurrence for a loop that does not contain L, then we
5854   // are dealing with the final value computed by the loop.
5855   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V)) {
5856     // First, attempt to evaluate each operand.
5857     // Avoid performing the look-up in the common case where the specified
5858     // expression has no loop-variant portions.
5859     for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
5860       const SCEV *OpAtScope = getSCEVAtScope(AddRec->getOperand(i), L);
5861       if (OpAtScope == AddRec->getOperand(i))
5862         continue;
5863
5864       // Okay, at least one of these operands is loop variant but might be
5865       // foldable.  Build a new instance of the folded commutative expression.
5866       SmallVector<const SCEV *, 8> NewOps(AddRec->op_begin(),
5867                                           AddRec->op_begin()+i);
5868       NewOps.push_back(OpAtScope);
5869       for (++i; i != e; ++i)
5870         NewOps.push_back(getSCEVAtScope(AddRec->getOperand(i), L));
5871
5872       const SCEV *FoldedRec =
5873         getAddRecExpr(NewOps, AddRec->getLoop(),
5874                       AddRec->getNoWrapFlags(SCEV::FlagNW));
5875       AddRec = dyn_cast<SCEVAddRecExpr>(FoldedRec);
5876       // The addrec may be folded to a nonrecurrence, for example, if the
5877       // induction variable is multiplied by zero after constant folding. Go
5878       // ahead and return the folded value.
5879       if (!AddRec)
5880         return FoldedRec;
5881       break;
5882     }
5883
5884     // If the scope is outside the addrec's loop, evaluate it by using the
5885     // loop exit value of the addrec.
5886     if (!AddRec->getLoop()->contains(L)) {
5887       // To evaluate this recurrence, we need to know how many times the AddRec
5888       // loop iterates.  Compute this now.
5889       const SCEV *BackedgeTakenCount = getBackedgeTakenCount(AddRec->getLoop());
5890       if (BackedgeTakenCount == getCouldNotCompute()) return AddRec;
5891
5892       // Then, evaluate the AddRec.
5893       return AddRec->evaluateAtIteration(BackedgeTakenCount, *this);
5894     }
5895
5896     return AddRec;
5897   }
5898
5899   if (const SCEVZeroExtendExpr *Cast = dyn_cast<SCEVZeroExtendExpr>(V)) {
5900     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
5901     if (Op == Cast->getOperand())
5902       return Cast;  // must be loop invariant
5903     return getZeroExtendExpr(Op, Cast->getType());
5904   }
5905
5906   if (const SCEVSignExtendExpr *Cast = dyn_cast<SCEVSignExtendExpr>(V)) {
5907     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
5908     if (Op == Cast->getOperand())
5909       return Cast;  // must be loop invariant
5910     return getSignExtendExpr(Op, Cast->getType());
5911   }
5912
5913   if (const SCEVTruncateExpr *Cast = dyn_cast<SCEVTruncateExpr>(V)) {
5914     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
5915     if (Op == Cast->getOperand())
5916       return Cast;  // must be loop invariant
5917     return getTruncateExpr(Op, Cast->getType());
5918   }
5919
5920   llvm_unreachable("Unknown SCEV type!");
5921 }
5922
5923 /// getSCEVAtScope - This is a convenience function which does
5924 /// getSCEVAtScope(getSCEV(V), L).
5925 const SCEV *ScalarEvolution::getSCEVAtScope(Value *V, const Loop *L) {
5926   return getSCEVAtScope(getSCEV(V), L);
5927 }
5928
5929 /// SolveLinEquationWithOverflow - Finds the minimum unsigned root of the
5930 /// following equation:
5931 ///
5932 ///     A * X = B (mod N)
5933 ///
5934 /// where N = 2^BW and BW is the common bit width of A and B. The signedness of
5935 /// A and B isn't important.
5936 ///
5937 /// If the equation does not have a solution, SCEVCouldNotCompute is returned.
5938 static const SCEV *SolveLinEquationWithOverflow(const APInt &A, const APInt &B,
5939                                                ScalarEvolution &SE) {
5940   uint32_t BW = A.getBitWidth();
5941   assert(BW == B.getBitWidth() && "Bit widths must be the same.");
5942   assert(A != 0 && "A must be non-zero.");
5943
5944   // 1. D = gcd(A, N)
5945   //
5946   // The gcd of A and N may have only one prime factor: 2. The number of
5947   // trailing zeros in A is its multiplicity
5948   uint32_t Mult2 = A.countTrailingZeros();
5949   // D = 2^Mult2
5950
5951   // 2. Check if B is divisible by D.
5952   //
5953   // B is divisible by D if and only if the multiplicity of prime factor 2 for B
5954   // is not less than multiplicity of this prime factor for D.
5955   if (B.countTrailingZeros() < Mult2)
5956     return SE.getCouldNotCompute();
5957
5958   // 3. Compute I: the multiplicative inverse of (A / D) in arithmetic
5959   // modulo (N / D).
5960   //
5961   // (N / D) may need BW+1 bits in its representation.  Hence, we'll use this
5962   // bit width during computations.
5963   APInt AD = A.lshr(Mult2).zext(BW + 1);  // AD = A / D
5964   APInt Mod(BW + 1, 0);
5965   Mod.setBit(BW - Mult2);  // Mod = N / D
5966   APInt I = AD.multiplicativeInverse(Mod);
5967
5968   // 4. Compute the minimum unsigned root of the equation:
5969   // I * (B / D) mod (N / D)
5970   APInt Result = (I * B.lshr(Mult2).zext(BW + 1)).urem(Mod);
5971
5972   // The result is guaranteed to be less than 2^BW so we may truncate it to BW
5973   // bits.
5974   return SE.getConstant(Result.trunc(BW));
5975 }
5976
5977 /// SolveQuadraticEquation - Find the roots of the quadratic equation for the
5978 /// given quadratic chrec {L,+,M,+,N}.  This returns either the two roots (which
5979 /// might be the same) or two SCEVCouldNotCompute objects.
5980 ///
5981 static std::pair<const SCEV *,const SCEV *>
5982 SolveQuadraticEquation(const SCEVAddRecExpr *AddRec, ScalarEvolution &SE) {
5983   assert(AddRec->getNumOperands() == 3 && "This is not a quadratic chrec!");
5984   const SCEVConstant *LC = dyn_cast<SCEVConstant>(AddRec->getOperand(0));
5985   const SCEVConstant *MC = dyn_cast<SCEVConstant>(AddRec->getOperand(1));
5986   const SCEVConstant *NC = dyn_cast<SCEVConstant>(AddRec->getOperand(2));
5987
5988   // We currently can only solve this if the coefficients are constants.
5989   if (!LC || !MC || !NC) {
5990     const SCEV *CNC = SE.getCouldNotCompute();
5991     return std::make_pair(CNC, CNC);
5992   }
5993
5994   uint32_t BitWidth = LC->getValue()->getValue().getBitWidth();
5995   const APInt &L = LC->getValue()->getValue();
5996   const APInt &M = MC->getValue()->getValue();
5997   const APInt &N = NC->getValue()->getValue();
5998   APInt Two(BitWidth, 2);
5999   APInt Four(BitWidth, 4);
6000
6001   {
6002     using namespace APIntOps;
6003     const APInt& C = L;
6004     // Convert from chrec coefficients to polynomial coefficients AX^2+BX+C
6005     // The B coefficient is M-N/2
6006     APInt B(M);
6007     B -= sdiv(N,Two);
6008
6009     // The A coefficient is N/2
6010     APInt A(N.sdiv(Two));
6011
6012     // Compute the B^2-4ac term.
6013     APInt SqrtTerm(B);
6014     SqrtTerm *= B;
6015     SqrtTerm -= Four * (A * C);
6016
6017     if (SqrtTerm.isNegative()) {
6018       // The loop is provably infinite.
6019       const SCEV *CNC = SE.getCouldNotCompute();
6020       return std::make_pair(CNC, CNC);
6021     }
6022
6023     // Compute sqrt(B^2-4ac). This is guaranteed to be the nearest
6024     // integer value or else APInt::sqrt() will assert.
6025     APInt SqrtVal(SqrtTerm.sqrt());
6026
6027     // Compute the two solutions for the quadratic formula.
6028     // The divisions must be performed as signed divisions.
6029     APInt NegB(-B);
6030     APInt TwoA(A << 1);
6031     if (TwoA.isMinValue()) {
6032       const SCEV *CNC = SE.getCouldNotCompute();
6033       return std::make_pair(CNC, CNC);
6034     }
6035
6036     LLVMContext &Context = SE.getContext();
6037
6038     ConstantInt *Solution1 =
6039       ConstantInt::get(Context, (NegB + SqrtVal).sdiv(TwoA));
6040     ConstantInt *Solution2 =
6041       ConstantInt::get(Context, (NegB - SqrtVal).sdiv(TwoA));
6042
6043     return std::make_pair(SE.getConstant(Solution1),
6044                           SE.getConstant(Solution2));
6045   } // end APIntOps namespace
6046 }
6047
6048 /// HowFarToZero - Return the number of times a backedge comparing the specified
6049 /// value to zero will execute.  If not computable, return CouldNotCompute.
6050 ///
6051 /// This is only used for loops with a "x != y" exit test. The exit condition is
6052 /// now expressed as a single expression, V = x-y. So the exit test is
6053 /// effectively V != 0.  We know and take advantage of the fact that this
6054 /// expression only being used in a comparison by zero context.
6055 ScalarEvolution::ExitLimit
6056 ScalarEvolution::HowFarToZero(const SCEV *V, const Loop *L, bool ControlsExit) {
6057   // If the value is a constant
6058   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
6059     // If the value is already zero, the branch will execute zero times.
6060     if (C->getValue()->isZero()) return C;
6061     return getCouldNotCompute();  // Otherwise it will loop infinitely.
6062   }
6063
6064   const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V);
6065   if (!AddRec || AddRec->getLoop() != L)
6066     return getCouldNotCompute();
6067
6068   // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of
6069   // the quadratic equation to solve it.
6070   if (AddRec->isQuadratic() && AddRec->getType()->isIntegerTy()) {
6071     std::pair<const SCEV *,const SCEV *> Roots =
6072       SolveQuadraticEquation(AddRec, *this);
6073     const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
6074     const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
6075     if (R1 && R2) {
6076 #if 0
6077       dbgs() << "HFTZ: " << *V << " - sol#1: " << *R1
6078              << "  sol#2: " << *R2 << "\n";
6079 #endif
6080       // Pick the smallest positive root value.
6081       if (ConstantInt *CB =
6082           dyn_cast<ConstantInt>(ConstantExpr::getICmp(CmpInst::ICMP_ULT,
6083                                                       R1->getValue(),
6084                                                       R2->getValue()))) {
6085         if (!CB->getZExtValue())
6086           std::swap(R1, R2);   // R1 is the minimum root now.
6087
6088         // We can only use this value if the chrec ends up with an exact zero
6089         // value at this index.  When solving for "X*X != 5", for example, we
6090         // should not accept a root of 2.
6091         const SCEV *Val = AddRec->evaluateAtIteration(R1, *this);
6092         if (Val->isZero())
6093           return R1;  // We found a quadratic root!
6094       }
6095     }
6096     return getCouldNotCompute();
6097   }
6098
6099   // Otherwise we can only handle this if it is affine.
6100   if (!AddRec->isAffine())
6101     return getCouldNotCompute();
6102
6103   // If this is an affine expression, the execution count of this branch is
6104   // the minimum unsigned root of the following equation:
6105   //
6106   //     Start + Step*N = 0 (mod 2^BW)
6107   //
6108   // equivalent to:
6109   //
6110   //             Step*N = -Start (mod 2^BW)
6111   //
6112   // where BW is the common bit width of Start and Step.
6113
6114   // Get the initial value for the loop.
6115   const SCEV *Start = getSCEVAtScope(AddRec->getStart(), L->getParentLoop());
6116   const SCEV *Step = getSCEVAtScope(AddRec->getOperand(1), L->getParentLoop());
6117
6118   // For now we handle only constant steps.
6119   //
6120   // TODO: Handle a nonconstant Step given AddRec<NUW>. If the
6121   // AddRec is NUW, then (in an unsigned sense) it cannot be counting up to wrap
6122   // to 0, it must be counting down to equal 0. Consequently, N = Start / -Step.
6123   // We have not yet seen any such cases.
6124   const SCEVConstant *StepC = dyn_cast<SCEVConstant>(Step);
6125   if (!StepC || StepC->getValue()->equalsInt(0))
6126     return getCouldNotCompute();
6127
6128   // For positive steps (counting up until unsigned overflow):
6129   //   N = -Start/Step (as unsigned)
6130   // For negative steps (counting down to zero):
6131   //   N = Start/-Step
6132   // First compute the unsigned distance from zero in the direction of Step.
6133   bool CountDown = StepC->getValue()->getValue().isNegative();
6134   const SCEV *Distance = CountDown ? Start : getNegativeSCEV(Start);
6135
6136   // Handle unitary steps, which cannot wraparound.
6137   // 1*N = -Start; -1*N = Start (mod 2^BW), so:
6138   //   N = Distance (as unsigned)
6139   if (StepC->getValue()->equalsInt(1) || StepC->getValue()->isAllOnesValue()) {
6140     ConstantRange CR = getUnsignedRange(Start);
6141     const SCEV *MaxBECount;
6142     if (!CountDown && CR.getUnsignedMin().isMinValue())
6143       // When counting up, the worst starting value is 1, not 0.
6144       MaxBECount = CR.getUnsignedMax().isMinValue()
6145         ? getConstant(APInt::getMinValue(CR.getBitWidth()))
6146         : getConstant(APInt::getMaxValue(CR.getBitWidth()));
6147     else
6148       MaxBECount = getConstant(CountDown ? CR.getUnsignedMax()
6149                                          : -CR.getUnsignedMin());
6150     return ExitLimit(Distance, MaxBECount);
6151   }
6152
6153   // As a special case, handle the instance where Step is a positive power of
6154   // two. In this case, determining whether Step divides Distance evenly can be
6155   // done by counting and comparing the number of trailing zeros of Step and
6156   // Distance.
6157   if (!CountDown) {
6158     const APInt &StepV = StepC->getValue()->getValue();
6159     // StepV.isPowerOf2() returns true if StepV is an positive power of two.  It
6160     // also returns true if StepV is maximally negative (eg, INT_MIN), but that
6161     // case is not handled as this code is guarded by !CountDown.
6162     if (StepV.isPowerOf2() &&
6163         GetMinTrailingZeros(Distance) >= StepV.countTrailingZeros())
6164       return getUDivExactExpr(Distance, Step);
6165   }
6166
6167   // If the condition controls loop exit (the loop exits only if the expression
6168   // is true) and the addition is no-wrap we can use unsigned divide to
6169   // compute the backedge count.  In this case, the step may not divide the
6170   // distance, but we don't care because if the condition is "missed" the loop
6171   // will have undefined behavior due to wrapping.
6172   if (ControlsExit && AddRec->getNoWrapFlags(SCEV::FlagNW)) {
6173     const SCEV *Exact =
6174         getUDivExpr(Distance, CountDown ? getNegativeSCEV(Step) : Step);
6175     return ExitLimit(Exact, Exact);
6176   }
6177
6178   // Then, try to solve the above equation provided that Start is constant.
6179   if (const SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start))
6180     return SolveLinEquationWithOverflow(StepC->getValue()->getValue(),
6181                                         -StartC->getValue()->getValue(),
6182                                         *this);
6183   return getCouldNotCompute();
6184 }
6185
6186 /// HowFarToNonZero - Return the number of times a backedge checking the
6187 /// specified value for nonzero will execute.  If not computable, return
6188 /// CouldNotCompute
6189 ScalarEvolution::ExitLimit
6190 ScalarEvolution::HowFarToNonZero(const SCEV *V, const Loop *L) {
6191   // Loops that look like: while (X == 0) are very strange indeed.  We don't
6192   // handle them yet except for the trivial case.  This could be expanded in the
6193   // future as needed.
6194
6195   // If the value is a constant, check to see if it is known to be non-zero
6196   // already.  If so, the backedge will execute zero times.
6197   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
6198     if (!C->getValue()->isNullValue())
6199       return getConstant(C->getType(), 0);
6200     return getCouldNotCompute();  // Otherwise it will loop infinitely.
6201   }
6202
6203   // We could implement others, but I really doubt anyone writes loops like
6204   // this, and if they did, they would already be constant folded.
6205   return getCouldNotCompute();
6206 }
6207
6208 /// getPredecessorWithUniqueSuccessorForBB - Return a predecessor of BB
6209 /// (which may not be an immediate predecessor) which has exactly one
6210 /// successor from which BB is reachable, or null if no such block is
6211 /// found.
6212 ///
6213 std::pair<BasicBlock *, BasicBlock *>
6214 ScalarEvolution::getPredecessorWithUniqueSuccessorForBB(BasicBlock *BB) {
6215   // If the block has a unique predecessor, then there is no path from the
6216   // predecessor to the block that does not go through the direct edge
6217   // from the predecessor to the block.
6218   if (BasicBlock *Pred = BB->getSinglePredecessor())
6219     return std::make_pair(Pred, BB);
6220
6221   // A loop's header is defined to be a block that dominates the loop.
6222   // If the header has a unique predecessor outside the loop, it must be
6223   // a block that has exactly one successor that can reach the loop.
6224   if (Loop *L = LI->getLoopFor(BB))
6225     return std::make_pair(L->getLoopPredecessor(), L->getHeader());
6226
6227   return std::pair<BasicBlock *, BasicBlock *>();
6228 }
6229
6230 /// HasSameValue - SCEV structural equivalence is usually sufficient for
6231 /// testing whether two expressions are equal, however for the purposes of
6232 /// looking for a condition guarding a loop, it can be useful to be a little
6233 /// more general, since a front-end may have replicated the controlling
6234 /// expression.
6235 ///
6236 static bool HasSameValue(const SCEV *A, const SCEV *B) {
6237   // Quick check to see if they are the same SCEV.
6238   if (A == B) return true;
6239
6240   // Otherwise, if they're both SCEVUnknown, it's possible that they hold
6241   // two different instructions with the same value. Check for this case.
6242   if (const SCEVUnknown *AU = dyn_cast<SCEVUnknown>(A))
6243     if (const SCEVUnknown *BU = dyn_cast<SCEVUnknown>(B))
6244       if (const Instruction *AI = dyn_cast<Instruction>(AU->getValue()))
6245         if (const Instruction *BI = dyn_cast<Instruction>(BU->getValue()))
6246           if (AI->isIdenticalTo(BI) && !AI->mayReadFromMemory())
6247             return true;
6248
6249   // Otherwise assume they may have a different value.
6250   return false;
6251 }
6252
6253 /// SimplifyICmpOperands - Simplify LHS and RHS in a comparison with
6254 /// predicate Pred. Return true iff any changes were made.
6255 ///
6256 bool ScalarEvolution::SimplifyICmpOperands(ICmpInst::Predicate &Pred,
6257                                            const SCEV *&LHS, const SCEV *&RHS,
6258                                            unsigned Depth) {
6259   bool Changed = false;
6260
6261   // If we hit the max recursion limit bail out.
6262   if (Depth >= 3)
6263     return false;
6264
6265   // Canonicalize a constant to the right side.
6266   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
6267     // Check for both operands constant.
6268     if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
6269       if (ConstantExpr::getICmp(Pred,
6270                                 LHSC->getValue(),
6271                                 RHSC->getValue())->isNullValue())
6272         goto trivially_false;
6273       else
6274         goto trivially_true;
6275     }
6276     // Otherwise swap the operands to put the constant on the right.
6277     std::swap(LHS, RHS);
6278     Pred = ICmpInst::getSwappedPredicate(Pred);
6279     Changed = true;
6280   }
6281
6282   // If we're comparing an addrec with a value which is loop-invariant in the
6283   // addrec's loop, put the addrec on the left. Also make a dominance check,
6284   // as both operands could be addrecs loop-invariant in each other's loop.
6285   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS)) {
6286     const Loop *L = AR->getLoop();
6287     if (isLoopInvariant(LHS, L) && properlyDominates(LHS, L->getHeader())) {
6288       std::swap(LHS, RHS);
6289       Pred = ICmpInst::getSwappedPredicate(Pred);
6290       Changed = true;
6291     }
6292   }
6293
6294   // If there's a constant operand, canonicalize comparisons with boundary
6295   // cases, and canonicalize *-or-equal comparisons to regular comparisons.
6296   if (const SCEVConstant *RC = dyn_cast<SCEVConstant>(RHS)) {
6297     const APInt &RA = RC->getValue()->getValue();
6298     switch (Pred) {
6299     default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
6300     case ICmpInst::ICMP_EQ:
6301     case ICmpInst::ICMP_NE:
6302       // Fold ((-1) * %a) + %b == 0 (equivalent to %b-%a == 0) into %a == %b.
6303       if (!RA)
6304         if (const SCEVAddExpr *AE = dyn_cast<SCEVAddExpr>(LHS))
6305           if (const SCEVMulExpr *ME = dyn_cast<SCEVMulExpr>(AE->getOperand(0)))
6306             if (AE->getNumOperands() == 2 && ME->getNumOperands() == 2 &&
6307                 ME->getOperand(0)->isAllOnesValue()) {
6308               RHS = AE->getOperand(1);
6309               LHS = ME->getOperand(1);
6310               Changed = true;
6311             }
6312       break;
6313     case ICmpInst::ICMP_UGE:
6314       if ((RA - 1).isMinValue()) {
6315         Pred = ICmpInst::ICMP_NE;
6316         RHS = getConstant(RA - 1);
6317         Changed = true;
6318         break;
6319       }
6320       if (RA.isMaxValue()) {
6321         Pred = ICmpInst::ICMP_EQ;
6322         Changed = true;
6323         break;
6324       }
6325       if (RA.isMinValue()) goto trivially_true;
6326
6327       Pred = ICmpInst::ICMP_UGT;
6328       RHS = getConstant(RA - 1);
6329       Changed = true;
6330       break;
6331     case ICmpInst::ICMP_ULE:
6332       if ((RA + 1).isMaxValue()) {
6333         Pred = ICmpInst::ICMP_NE;
6334         RHS = getConstant(RA + 1);
6335         Changed = true;
6336         break;
6337       }
6338       if (RA.isMinValue()) {
6339         Pred = ICmpInst::ICMP_EQ;
6340         Changed = true;
6341         break;
6342       }
6343       if (RA.isMaxValue()) goto trivially_true;
6344
6345       Pred = ICmpInst::ICMP_ULT;
6346       RHS = getConstant(RA + 1);
6347       Changed = true;
6348       break;
6349     case ICmpInst::ICMP_SGE:
6350       if ((RA - 1).isMinSignedValue()) {
6351         Pred = ICmpInst::ICMP_NE;
6352         RHS = getConstant(RA - 1);
6353         Changed = true;
6354         break;
6355       }
6356       if (RA.isMaxSignedValue()) {
6357         Pred = ICmpInst::ICMP_EQ;
6358         Changed = true;
6359         break;
6360       }
6361       if (RA.isMinSignedValue()) goto trivially_true;
6362
6363       Pred = ICmpInst::ICMP_SGT;
6364       RHS = getConstant(RA - 1);
6365       Changed = true;
6366       break;
6367     case ICmpInst::ICMP_SLE:
6368       if ((RA + 1).isMaxSignedValue()) {
6369         Pred = ICmpInst::ICMP_NE;
6370         RHS = getConstant(RA + 1);
6371         Changed = true;
6372         break;
6373       }
6374       if (RA.isMinSignedValue()) {
6375         Pred = ICmpInst::ICMP_EQ;
6376         Changed = true;
6377         break;
6378       }
6379       if (RA.isMaxSignedValue()) goto trivially_true;
6380
6381       Pred = ICmpInst::ICMP_SLT;
6382       RHS = getConstant(RA + 1);
6383       Changed = true;
6384       break;
6385     case ICmpInst::ICMP_UGT:
6386       if (RA.isMinValue()) {
6387         Pred = ICmpInst::ICMP_NE;
6388         Changed = true;
6389         break;
6390       }
6391       if ((RA + 1).isMaxValue()) {
6392         Pred = ICmpInst::ICMP_EQ;
6393         RHS = getConstant(RA + 1);
6394         Changed = true;
6395         break;
6396       }
6397       if (RA.isMaxValue()) goto trivially_false;
6398       break;
6399     case ICmpInst::ICMP_ULT:
6400       if (RA.isMaxValue()) {
6401         Pred = ICmpInst::ICMP_NE;
6402         Changed = true;
6403         break;
6404       }
6405       if ((RA - 1).isMinValue()) {
6406         Pred = ICmpInst::ICMP_EQ;
6407         RHS = getConstant(RA - 1);
6408         Changed = true;
6409         break;
6410       }
6411       if (RA.isMinValue()) goto trivially_false;
6412       break;
6413     case ICmpInst::ICMP_SGT:
6414       if (RA.isMinSignedValue()) {
6415         Pred = ICmpInst::ICMP_NE;
6416         Changed = true;
6417         break;
6418       }
6419       if ((RA + 1).isMaxSignedValue()) {
6420         Pred = ICmpInst::ICMP_EQ;
6421         RHS = getConstant(RA + 1);
6422         Changed = true;
6423         break;
6424       }
6425       if (RA.isMaxSignedValue()) goto trivially_false;
6426       break;
6427     case ICmpInst::ICMP_SLT:
6428       if (RA.isMaxSignedValue()) {
6429         Pred = ICmpInst::ICMP_NE;
6430         Changed = true;
6431         break;
6432       }
6433       if ((RA - 1).isMinSignedValue()) {
6434        Pred = ICmpInst::ICMP_EQ;
6435        RHS = getConstant(RA - 1);
6436         Changed = true;
6437        break;
6438       }
6439       if (RA.isMinSignedValue()) goto trivially_false;
6440       break;
6441     }
6442   }
6443
6444   // Check for obvious equality.
6445   if (HasSameValue(LHS, RHS)) {
6446     if (ICmpInst::isTrueWhenEqual(Pred))
6447       goto trivially_true;
6448     if (ICmpInst::isFalseWhenEqual(Pred))
6449       goto trivially_false;
6450   }
6451
6452   // If possible, canonicalize GE/LE comparisons to GT/LT comparisons, by
6453   // adding or subtracting 1 from one of the operands.
6454   switch (Pred) {
6455   case ICmpInst::ICMP_SLE:
6456     if (!getSignedRange(RHS).getSignedMax().isMaxSignedValue()) {
6457       RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
6458                        SCEV::FlagNSW);
6459       Pred = ICmpInst::ICMP_SLT;
6460       Changed = true;
6461     } else if (!getSignedRange(LHS).getSignedMin().isMinSignedValue()) {
6462       LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
6463                        SCEV::FlagNSW);
6464       Pred = ICmpInst::ICMP_SLT;
6465       Changed = true;
6466     }
6467     break;
6468   case ICmpInst::ICMP_SGE:
6469     if (!getSignedRange(RHS).getSignedMin().isMinSignedValue()) {
6470       RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
6471                        SCEV::FlagNSW);
6472       Pred = ICmpInst::ICMP_SGT;
6473       Changed = true;
6474     } else if (!getSignedRange(LHS).getSignedMax().isMaxSignedValue()) {
6475       LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
6476                        SCEV::FlagNSW);
6477       Pred = ICmpInst::ICMP_SGT;
6478       Changed = true;
6479     }
6480     break;
6481   case ICmpInst::ICMP_ULE:
6482     if (!getUnsignedRange(RHS).getUnsignedMax().isMaxValue()) {
6483       RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
6484                        SCEV::FlagNUW);
6485       Pred = ICmpInst::ICMP_ULT;
6486       Changed = true;
6487     } else if (!getUnsignedRange(LHS).getUnsignedMin().isMinValue()) {
6488       LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
6489                        SCEV::FlagNUW);
6490       Pred = ICmpInst::ICMP_ULT;
6491       Changed = true;
6492     }
6493     break;
6494   case ICmpInst::ICMP_UGE:
6495     if (!getUnsignedRange(RHS).getUnsignedMin().isMinValue()) {
6496       RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
6497                        SCEV::FlagNUW);
6498       Pred = ICmpInst::ICMP_UGT;
6499       Changed = true;
6500     } else if (!getUnsignedRange(LHS).getUnsignedMax().isMaxValue()) {
6501       LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
6502                        SCEV::FlagNUW);
6503       Pred = ICmpInst::ICMP_UGT;
6504       Changed = true;
6505     }
6506     break;
6507   default:
6508     break;
6509   }
6510
6511   // TODO: More simplifications are possible here.
6512
6513   // Recursively simplify until we either hit a recursion limit or nothing
6514   // changes.
6515   if (Changed)
6516     return SimplifyICmpOperands(Pred, LHS, RHS, Depth+1);
6517
6518   return Changed;
6519
6520 trivially_true:
6521   // Return 0 == 0.
6522   LHS = RHS = getConstant(ConstantInt::getFalse(getContext()));
6523   Pred = ICmpInst::ICMP_EQ;
6524   return true;
6525
6526 trivially_false:
6527   // Return 0 != 0.
6528   LHS = RHS = getConstant(ConstantInt::getFalse(getContext()));
6529   Pred = ICmpInst::ICMP_NE;
6530   return true;
6531 }
6532
6533 bool ScalarEvolution::isKnownNegative(const SCEV *S) {
6534   return getSignedRange(S).getSignedMax().isNegative();
6535 }
6536
6537 bool ScalarEvolution::isKnownPositive(const SCEV *S) {
6538   return getSignedRange(S).getSignedMin().isStrictlyPositive();
6539 }
6540
6541 bool ScalarEvolution::isKnownNonNegative(const SCEV *S) {
6542   return !getSignedRange(S).getSignedMin().isNegative();
6543 }
6544
6545 bool ScalarEvolution::isKnownNonPositive(const SCEV *S) {
6546   return !getSignedRange(S).getSignedMax().isStrictlyPositive();
6547 }
6548
6549 bool ScalarEvolution::isKnownNonZero(const SCEV *S) {
6550   return isKnownNegative(S) || isKnownPositive(S);
6551 }
6552
6553 bool ScalarEvolution::isKnownPredicate(ICmpInst::Predicate Pred,
6554                                        const SCEV *LHS, const SCEV *RHS) {
6555   // Canonicalize the inputs first.
6556   (void)SimplifyICmpOperands(Pred, LHS, RHS);
6557
6558   // If LHS or RHS is an addrec, check to see if the condition is true in
6559   // every iteration of the loop.
6560   // If LHS and RHS are both addrec, both conditions must be true in
6561   // every iteration of the loop.
6562   const SCEVAddRecExpr *LAR = dyn_cast<SCEVAddRecExpr>(LHS);
6563   const SCEVAddRecExpr *RAR = dyn_cast<SCEVAddRecExpr>(RHS);
6564   bool LeftGuarded = false;
6565   bool RightGuarded = false;
6566   if (LAR) {
6567     const Loop *L = LAR->getLoop();
6568     if (isLoopEntryGuardedByCond(L, Pred, LAR->getStart(), RHS) &&
6569         isLoopBackedgeGuardedByCond(L, Pred, LAR->getPostIncExpr(*this), RHS)) {
6570       if (!RAR) return true;
6571       LeftGuarded = true;
6572     }
6573   }
6574   if (RAR) {
6575     const Loop *L = RAR->getLoop();
6576     if (isLoopEntryGuardedByCond(L, Pred, LHS, RAR->getStart()) &&
6577         isLoopBackedgeGuardedByCond(L, Pred, LHS, RAR->getPostIncExpr(*this))) {
6578       if (!LAR) return true;
6579       RightGuarded = true;
6580     }
6581   }
6582   if (LeftGuarded && RightGuarded)
6583     return true;
6584
6585   // Otherwise see what can be done with known constant ranges.
6586   return isKnownPredicateWithRanges(Pred, LHS, RHS);
6587 }
6588
6589 bool
6590 ScalarEvolution::isKnownPredicateWithRanges(ICmpInst::Predicate Pred,
6591                                             const SCEV *LHS, const SCEV *RHS) {
6592   if (HasSameValue(LHS, RHS))
6593     return ICmpInst::isTrueWhenEqual(Pred);
6594
6595   // This code is split out from isKnownPredicate because it is called from
6596   // within isLoopEntryGuardedByCond.
6597   switch (Pred) {
6598   default:
6599     llvm_unreachable("Unexpected ICmpInst::Predicate value!");
6600   case ICmpInst::ICMP_SGT:
6601     std::swap(LHS, RHS);
6602   case ICmpInst::ICMP_SLT: {
6603     ConstantRange LHSRange = getSignedRange(LHS);
6604     ConstantRange RHSRange = getSignedRange(RHS);
6605     if (LHSRange.getSignedMax().slt(RHSRange.getSignedMin()))
6606       return true;
6607     if (LHSRange.getSignedMin().sge(RHSRange.getSignedMax()))
6608       return false;
6609     break;
6610   }
6611   case ICmpInst::ICMP_SGE:
6612     std::swap(LHS, RHS);
6613   case ICmpInst::ICMP_SLE: {
6614     ConstantRange LHSRange = getSignedRange(LHS);
6615     ConstantRange RHSRange = getSignedRange(RHS);
6616     if (LHSRange.getSignedMax().sle(RHSRange.getSignedMin()))
6617       return true;
6618     if (LHSRange.getSignedMin().sgt(RHSRange.getSignedMax()))
6619       return false;
6620     break;
6621   }
6622   case ICmpInst::ICMP_UGT:
6623     std::swap(LHS, RHS);
6624   case ICmpInst::ICMP_ULT: {
6625     ConstantRange LHSRange = getUnsignedRange(LHS);
6626     ConstantRange RHSRange = getUnsignedRange(RHS);
6627     if (LHSRange.getUnsignedMax().ult(RHSRange.getUnsignedMin()))
6628       return true;
6629     if (LHSRange.getUnsignedMin().uge(RHSRange.getUnsignedMax()))
6630       return false;
6631     break;
6632   }
6633   case ICmpInst::ICMP_UGE:
6634     std::swap(LHS, RHS);
6635   case ICmpInst::ICMP_ULE: {
6636     ConstantRange LHSRange = getUnsignedRange(LHS);
6637     ConstantRange RHSRange = getUnsignedRange(RHS);
6638     if (LHSRange.getUnsignedMax().ule(RHSRange.getUnsignedMin()))
6639       return true;
6640     if (LHSRange.getUnsignedMin().ugt(RHSRange.getUnsignedMax()))
6641       return false;
6642     break;
6643   }
6644   case ICmpInst::ICMP_NE: {
6645     if (getUnsignedRange(LHS).intersectWith(getUnsignedRange(RHS)).isEmptySet())
6646       return true;
6647     if (getSignedRange(LHS).intersectWith(getSignedRange(RHS)).isEmptySet())
6648       return true;
6649
6650     const SCEV *Diff = getMinusSCEV(LHS, RHS);
6651     if (isKnownNonZero(Diff))
6652       return true;
6653     break;
6654   }
6655   case ICmpInst::ICMP_EQ:
6656     // The check at the top of the function catches the case where
6657     // the values are known to be equal.
6658     break;
6659   }
6660   return false;
6661 }
6662
6663 /// isLoopBackedgeGuardedByCond - Test whether the backedge of the loop is
6664 /// protected by a conditional between LHS and RHS.  This is used to
6665 /// to eliminate casts.
6666 bool
6667 ScalarEvolution::isLoopBackedgeGuardedByCond(const Loop *L,
6668                                              ICmpInst::Predicate Pred,
6669                                              const SCEV *LHS, const SCEV *RHS) {
6670   // Interpret a null as meaning no loop, where there is obviously no guard
6671   // (interprocedural conditions notwithstanding).
6672   if (!L) return true;
6673
6674   if (isKnownPredicateWithRanges(Pred, LHS, RHS)) return true;
6675
6676   BasicBlock *Latch = L->getLoopLatch();
6677   if (!Latch)
6678     return false;
6679
6680   BranchInst *LoopContinuePredicate =
6681     dyn_cast<BranchInst>(Latch->getTerminator());
6682   if (LoopContinuePredicate && LoopContinuePredicate->isConditional() &&
6683       isImpliedCond(Pred, LHS, RHS,
6684                     LoopContinuePredicate->getCondition(),
6685                     LoopContinuePredicate->getSuccessor(0) != L->getHeader()))
6686     return true;
6687
6688   // Check conditions due to any @llvm.assume intrinsics.
6689   for (auto &AssumeVH : AC->assumptions()) {
6690     if (!AssumeVH)
6691       continue;
6692     auto *CI = cast<CallInst>(AssumeVH);
6693     if (!DT->dominates(CI, Latch->getTerminator()))
6694       continue;
6695
6696     if (isImpliedCond(Pred, LHS, RHS, CI->getArgOperand(0), false))
6697       return true;
6698   }
6699
6700   return false;
6701 }
6702
6703 /// isLoopEntryGuardedByCond - Test whether entry to the loop is protected
6704 /// by a conditional between LHS and RHS.  This is used to help avoid max
6705 /// expressions in loop trip counts, and to eliminate casts.
6706 bool
6707 ScalarEvolution::isLoopEntryGuardedByCond(const Loop *L,
6708                                           ICmpInst::Predicate Pred,
6709                                           const SCEV *LHS, const SCEV *RHS) {
6710   // Interpret a null as meaning no loop, where there is obviously no guard
6711   // (interprocedural conditions notwithstanding).
6712   if (!L) return false;
6713
6714   if (isKnownPredicateWithRanges(Pred, LHS, RHS)) return true;
6715
6716   // Starting at the loop predecessor, climb up the predecessor chain, as long
6717   // as there are predecessors that can be found that have unique successors
6718   // leading to the original header.
6719   for (std::pair<BasicBlock *, BasicBlock *>
6720          Pair(L->getLoopPredecessor(), L->getHeader());
6721        Pair.first;
6722        Pair = getPredecessorWithUniqueSuccessorForBB(Pair.first)) {
6723
6724     BranchInst *LoopEntryPredicate =
6725       dyn_cast<BranchInst>(Pair.first->getTerminator());
6726     if (!LoopEntryPredicate ||
6727         LoopEntryPredicate->isUnconditional())
6728       continue;
6729
6730     if (isImpliedCond(Pred, LHS, RHS,
6731                       LoopEntryPredicate->getCondition(),
6732                       LoopEntryPredicate->getSuccessor(0) != Pair.second))
6733       return true;
6734   }
6735
6736   // Check conditions due to any @llvm.assume intrinsics.
6737   for (auto &AssumeVH : AC->assumptions()) {
6738     if (!AssumeVH)
6739       continue;
6740     auto *CI = cast<CallInst>(AssumeVH);
6741     if (!DT->dominates(CI, L->getHeader()))
6742       continue;
6743
6744     if (isImpliedCond(Pred, LHS, RHS, CI->getArgOperand(0), false))
6745       return true;
6746   }
6747
6748   return false;
6749 }
6750
6751 /// RAII wrapper to prevent recursive application of isImpliedCond.
6752 /// ScalarEvolution's PendingLoopPredicates set must be empty unless we are
6753 /// currently evaluating isImpliedCond.
6754 struct MarkPendingLoopPredicate {
6755   Value *Cond;
6756   DenseSet<Value*> &LoopPreds;
6757   bool Pending;
6758
6759   MarkPendingLoopPredicate(Value *C, DenseSet<Value*> &LP)
6760     : Cond(C), LoopPreds(LP) {
6761     Pending = !LoopPreds.insert(Cond).second;
6762   }
6763   ~MarkPendingLoopPredicate() {
6764     if (!Pending)
6765       LoopPreds.erase(Cond);
6766   }
6767 };
6768
6769 /// isImpliedCond - Test whether the condition described by Pred, LHS,
6770 /// and RHS is true whenever the given Cond value evaluates to true.
6771 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred,
6772                                     const SCEV *LHS, const SCEV *RHS,
6773                                     Value *FoundCondValue,
6774                                     bool Inverse) {
6775   MarkPendingLoopPredicate Mark(FoundCondValue, PendingLoopPredicates);
6776   if (Mark.Pending)
6777     return false;
6778
6779   // Recursively handle And and Or conditions.
6780   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(FoundCondValue)) {
6781     if (BO->getOpcode() == Instruction::And) {
6782       if (!Inverse)
6783         return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
6784                isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
6785     } else if (BO->getOpcode() == Instruction::Or) {
6786       if (Inverse)
6787         return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
6788                isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
6789     }
6790   }
6791
6792   ICmpInst *ICI = dyn_cast<ICmpInst>(FoundCondValue);
6793   if (!ICI) return false;
6794
6795   // Bail if the ICmp's operands' types are wider than the needed type
6796   // before attempting to call getSCEV on them. This avoids infinite
6797   // recursion, since the analysis of widening casts can require loop
6798   // exit condition information for overflow checking, which would
6799   // lead back here.
6800   if (getTypeSizeInBits(LHS->getType()) <
6801       getTypeSizeInBits(ICI->getOperand(0)->getType()))
6802     return false;
6803
6804   // Now that we found a conditional branch that dominates the loop or controls
6805   // the loop latch. Check to see if it is the comparison we are looking for.
6806   ICmpInst::Predicate FoundPred;
6807   if (Inverse)
6808     FoundPred = ICI->getInversePredicate();
6809   else
6810     FoundPred = ICI->getPredicate();
6811
6812   const SCEV *FoundLHS = getSCEV(ICI->getOperand(0));
6813   const SCEV *FoundRHS = getSCEV(ICI->getOperand(1));
6814
6815   // Balance the types. The case where FoundLHS' type is wider than
6816   // LHS' type is checked for above.
6817   if (getTypeSizeInBits(LHS->getType()) >
6818       getTypeSizeInBits(FoundLHS->getType())) {
6819     if (CmpInst::isSigned(FoundPred)) {
6820       FoundLHS = getSignExtendExpr(FoundLHS, LHS->getType());
6821       FoundRHS = getSignExtendExpr(FoundRHS, LHS->getType());
6822     } else {
6823       FoundLHS = getZeroExtendExpr(FoundLHS, LHS->getType());
6824       FoundRHS = getZeroExtendExpr(FoundRHS, LHS->getType());
6825     }
6826   }
6827
6828   // Canonicalize the query to match the way instcombine will have
6829   // canonicalized the comparison.
6830   if (SimplifyICmpOperands(Pred, LHS, RHS))
6831     if (LHS == RHS)
6832       return CmpInst::isTrueWhenEqual(Pred);
6833   if (SimplifyICmpOperands(FoundPred, FoundLHS, FoundRHS))
6834     if (FoundLHS == FoundRHS)
6835       return CmpInst::isFalseWhenEqual(FoundPred);
6836
6837   // Check to see if we can make the LHS or RHS match.
6838   if (LHS == FoundRHS || RHS == FoundLHS) {
6839     if (isa<SCEVConstant>(RHS)) {
6840       std::swap(FoundLHS, FoundRHS);
6841       FoundPred = ICmpInst::getSwappedPredicate(FoundPred);
6842     } else {
6843       std::swap(LHS, RHS);
6844       Pred = ICmpInst::getSwappedPredicate(Pred);
6845     }
6846   }
6847
6848   // Check whether the found predicate is the same as the desired predicate.
6849   if (FoundPred == Pred)
6850     return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS);
6851
6852   // Check whether swapping the found predicate makes it the same as the
6853   // desired predicate.
6854   if (ICmpInst::getSwappedPredicate(FoundPred) == Pred) {
6855     if (isa<SCEVConstant>(RHS))
6856       return isImpliedCondOperands(Pred, LHS, RHS, FoundRHS, FoundLHS);
6857     else
6858       return isImpliedCondOperands(ICmpInst::getSwappedPredicate(Pred),
6859                                    RHS, LHS, FoundLHS, FoundRHS);
6860   }
6861
6862   // Check if we can make progress by sharpening ranges.
6863   if (FoundPred == ICmpInst::ICMP_NE &&
6864       (isa<SCEVConstant>(FoundLHS) || isa<SCEVConstant>(FoundRHS))) {
6865
6866     const SCEVConstant *C = nullptr;
6867     const SCEV *V = nullptr;
6868
6869     if (isa<SCEVConstant>(FoundLHS)) {
6870       C = cast<SCEVConstant>(FoundLHS);
6871       V = FoundRHS;
6872     } else {
6873       C = cast<SCEVConstant>(FoundRHS);
6874       V = FoundLHS;
6875     }
6876
6877     // The guarding predicate tells us that C != V. If the known range
6878     // of V is [C, t), we can sharpen the range to [C + 1, t).  The
6879     // range we consider has to correspond to same signedness as the
6880     // predicate we're interested in folding.
6881
6882     APInt Min = ICmpInst::isSigned(Pred) ?
6883         getSignedRange(V).getSignedMin() : getUnsignedRange(V).getUnsignedMin();
6884
6885     if (Min == C->getValue()->getValue()) {
6886       // Given (V >= Min && V != Min) we conclude V >= (Min + 1).
6887       // This is true even if (Min + 1) wraps around -- in case of
6888       // wraparound, (Min + 1) < Min, so (V >= Min => V >= (Min + 1)).
6889
6890       APInt SharperMin = Min + 1;
6891
6892       switch (Pred) {
6893         case ICmpInst::ICMP_SGE:
6894         case ICmpInst::ICMP_UGE:
6895           // We know V `Pred` SharperMin.  If this implies LHS `Pred`
6896           // RHS, we're done.
6897           if (isImpliedCondOperands(Pred, LHS, RHS, V,
6898                                     getConstant(SharperMin)))
6899             return true;
6900
6901         case ICmpInst::ICMP_SGT:
6902         case ICmpInst::ICMP_UGT:
6903           // We know from the range information that (V `Pred` Min ||
6904           // V == Min).  We know from the guarding condition that !(V
6905           // == Min).  This gives us
6906           //
6907           //       V `Pred` Min || V == Min && !(V == Min)
6908           //   =>  V `Pred` Min
6909           //
6910           // If V `Pred` Min implies LHS `Pred` RHS, we're done.
6911
6912           if (isImpliedCondOperands(Pred, LHS, RHS, V, getConstant(Min)))
6913             return true;
6914
6915         default:
6916           // No change
6917           break;
6918       }
6919     }
6920   }
6921
6922   // Check whether the actual condition is beyond sufficient.
6923   if (FoundPred == ICmpInst::ICMP_EQ)
6924     if (ICmpInst::isTrueWhenEqual(Pred))
6925       if (isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS))
6926         return true;
6927   if (Pred == ICmpInst::ICMP_NE)
6928     if (!ICmpInst::isTrueWhenEqual(FoundPred))
6929       if (isImpliedCondOperands(FoundPred, LHS, RHS, FoundLHS, FoundRHS))
6930         return true;
6931
6932   // Otherwise assume the worst.
6933   return false;
6934 }
6935
6936 /// isImpliedCondOperands - Test whether the condition described by Pred,
6937 /// LHS, and RHS is true whenever the condition described by Pred, FoundLHS,
6938 /// and FoundRHS is true.
6939 bool ScalarEvolution::isImpliedCondOperands(ICmpInst::Predicate Pred,
6940                                             const SCEV *LHS, const SCEV *RHS,
6941                                             const SCEV *FoundLHS,
6942                                             const SCEV *FoundRHS) {
6943   return isImpliedCondOperandsHelper(Pred, LHS, RHS,
6944                                      FoundLHS, FoundRHS) ||
6945          // ~x < ~y --> x > y
6946          isImpliedCondOperandsHelper(Pred, LHS, RHS,
6947                                      getNotSCEV(FoundRHS),
6948                                      getNotSCEV(FoundLHS));
6949 }
6950
6951
6952 /// If Expr computes ~A, return A else return nullptr
6953 static const SCEV *MatchNotExpr(const SCEV *Expr) {
6954   const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Expr);
6955   if (!Add || Add->getNumOperands() != 2) return nullptr;
6956
6957   const SCEVConstant *AddLHS = dyn_cast<SCEVConstant>(Add->getOperand(0));
6958   if (!(AddLHS && AddLHS->getValue()->getValue().isAllOnesValue()))
6959     return nullptr;
6960
6961   const SCEVMulExpr *AddRHS = dyn_cast<SCEVMulExpr>(Add->getOperand(1));
6962   if (!AddRHS || AddRHS->getNumOperands() != 2) return nullptr;
6963
6964   const SCEVConstant *MulLHS = dyn_cast<SCEVConstant>(AddRHS->getOperand(0));
6965   if (!(MulLHS && MulLHS->getValue()->getValue().isAllOnesValue()))
6966     return nullptr;
6967
6968   return AddRHS->getOperand(1);
6969 }
6970
6971
6972 /// Is MaybeMaxExpr an SMax or UMax of Candidate and some other values?
6973 template<typename MaxExprType>
6974 static bool IsMaxConsistingOf(const SCEV *MaybeMaxExpr,
6975                               const SCEV *Candidate) {
6976   const MaxExprType *MaxExpr = dyn_cast<MaxExprType>(MaybeMaxExpr);
6977   if (!MaxExpr) return false;
6978
6979   auto It = std::find(MaxExpr->op_begin(), MaxExpr->op_end(), Candidate);
6980   return It != MaxExpr->op_end();
6981 }
6982
6983
6984 /// Is MaybeMinExpr an SMin or UMin of Candidate and some other values?
6985 template<typename MaxExprType>
6986 static bool IsMinConsistingOf(ScalarEvolution &SE,
6987                               const SCEV *MaybeMinExpr,
6988                               const SCEV *Candidate) {
6989   const SCEV *MaybeMaxExpr = MatchNotExpr(MaybeMinExpr);
6990   if (!MaybeMaxExpr)
6991     return false;
6992
6993   return IsMaxConsistingOf<MaxExprType>(MaybeMaxExpr, SE.getNotSCEV(Candidate));
6994 }
6995
6996
6997 /// Is LHS `Pred` RHS true on the virtue of LHS or RHS being a Min or Max
6998 /// expression?
6999 static bool IsKnownPredicateViaMinOrMax(ScalarEvolution &SE,
7000                                         ICmpInst::Predicate Pred,
7001                                         const SCEV *LHS, const SCEV *RHS) {
7002   switch (Pred) {
7003   default:
7004     return false;
7005
7006   case ICmpInst::ICMP_SGE:
7007     std::swap(LHS, RHS);
7008     // fall through
7009   case ICmpInst::ICMP_SLE:
7010     return
7011       // min(A, ...) <= A
7012       IsMinConsistingOf<SCEVSMaxExpr>(SE, LHS, RHS) ||
7013       // A <= max(A, ...)
7014       IsMaxConsistingOf<SCEVSMaxExpr>(RHS, LHS);
7015
7016   case ICmpInst::ICMP_UGE:
7017     std::swap(LHS, RHS);
7018     // fall through
7019   case ICmpInst::ICMP_ULE:
7020     return
7021       // min(A, ...) <= A
7022       IsMinConsistingOf<SCEVUMaxExpr>(SE, LHS, RHS) ||
7023       // A <= max(A, ...)
7024       IsMaxConsistingOf<SCEVUMaxExpr>(RHS, LHS);
7025   }
7026
7027   llvm_unreachable("covered switch fell through?!");
7028 }
7029
7030 /// isImpliedCondOperandsHelper - Test whether the condition described by
7031 /// Pred, LHS, and RHS is true whenever the condition described by Pred,
7032 /// FoundLHS, and FoundRHS is true.
7033 bool
7034 ScalarEvolution::isImpliedCondOperandsHelper(ICmpInst::Predicate Pred,
7035                                              const SCEV *LHS, const SCEV *RHS,
7036                                              const SCEV *FoundLHS,
7037                                              const SCEV *FoundRHS) {
7038   auto IsKnownPredicateFull =
7039       [this](ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS) {
7040     return isKnownPredicateWithRanges(Pred, LHS, RHS) ||
7041         IsKnownPredicateViaMinOrMax(*this, Pred, LHS, RHS);
7042   };
7043
7044   switch (Pred) {
7045   default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
7046   case ICmpInst::ICMP_EQ:
7047   case ICmpInst::ICMP_NE:
7048     if (HasSameValue(LHS, FoundLHS) && HasSameValue(RHS, FoundRHS))
7049       return true;
7050     break;
7051   case ICmpInst::ICMP_SLT:
7052   case ICmpInst::ICMP_SLE:
7053     if (IsKnownPredicateFull(ICmpInst::ICMP_SLE, LHS, FoundLHS) &&
7054         IsKnownPredicateFull(ICmpInst::ICMP_SGE, RHS, FoundRHS))
7055       return true;
7056     break;
7057   case ICmpInst::ICMP_SGT:
7058   case ICmpInst::ICMP_SGE:
7059     if (IsKnownPredicateFull(ICmpInst::ICMP_SGE, LHS, FoundLHS) &&
7060         IsKnownPredicateFull(ICmpInst::ICMP_SLE, RHS, FoundRHS))
7061       return true;
7062     break;
7063   case ICmpInst::ICMP_ULT:
7064   case ICmpInst::ICMP_ULE:
7065     if (IsKnownPredicateFull(ICmpInst::ICMP_ULE, LHS, FoundLHS) &&
7066         IsKnownPredicateFull(ICmpInst::ICMP_UGE, RHS, FoundRHS))
7067       return true;
7068     break;
7069   case ICmpInst::ICMP_UGT:
7070   case ICmpInst::ICMP_UGE:
7071     if (IsKnownPredicateFull(ICmpInst::ICMP_UGE, LHS, FoundLHS) &&
7072         IsKnownPredicateFull(ICmpInst::ICMP_ULE, RHS, FoundRHS))
7073       return true;
7074     break;
7075   }
7076
7077   return false;
7078 }
7079
7080 // Verify if an linear IV with positive stride can overflow when in a
7081 // less-than comparison, knowing the invariant term of the comparison, the
7082 // stride and the knowledge of NSW/NUW flags on the recurrence.
7083 bool ScalarEvolution::doesIVOverflowOnLT(const SCEV *RHS, const SCEV *Stride,
7084                                          bool IsSigned, bool NoWrap) {
7085   if (NoWrap) return false;
7086
7087   unsigned BitWidth = getTypeSizeInBits(RHS->getType());
7088   const SCEV *One = getConstant(Stride->getType(), 1);
7089
7090   if (IsSigned) {
7091     APInt MaxRHS = getSignedRange(RHS).getSignedMax();
7092     APInt MaxValue = APInt::getSignedMaxValue(BitWidth);
7093     APInt MaxStrideMinusOne = getSignedRange(getMinusSCEV(Stride, One))
7094                                 .getSignedMax();
7095
7096     // SMaxRHS + SMaxStrideMinusOne > SMaxValue => overflow!
7097     return (MaxValue - MaxStrideMinusOne).slt(MaxRHS);
7098   }
7099
7100   APInt MaxRHS = getUnsignedRange(RHS).getUnsignedMax();
7101   APInt MaxValue = APInt::getMaxValue(BitWidth);
7102   APInt MaxStrideMinusOne = getUnsignedRange(getMinusSCEV(Stride, One))
7103                               .getUnsignedMax();
7104
7105   // UMaxRHS + UMaxStrideMinusOne > UMaxValue => overflow!
7106   return (MaxValue - MaxStrideMinusOne).ult(MaxRHS);
7107 }
7108
7109 // Verify if an linear IV with negative stride can overflow when in a
7110 // greater-than comparison, knowing the invariant term of the comparison,
7111 // the stride and the knowledge of NSW/NUW flags on the recurrence.
7112 bool ScalarEvolution::doesIVOverflowOnGT(const SCEV *RHS, const SCEV *Stride,
7113                                          bool IsSigned, bool NoWrap) {
7114   if (NoWrap) return false;
7115
7116   unsigned BitWidth = getTypeSizeInBits(RHS->getType());
7117   const SCEV *One = getConstant(Stride->getType(), 1);
7118
7119   if (IsSigned) {
7120     APInt MinRHS = getSignedRange(RHS).getSignedMin();
7121     APInt MinValue = APInt::getSignedMinValue(BitWidth);
7122     APInt MaxStrideMinusOne = getSignedRange(getMinusSCEV(Stride, One))
7123                                .getSignedMax();
7124
7125     // SMinRHS - SMaxStrideMinusOne < SMinValue => overflow!
7126     return (MinValue + MaxStrideMinusOne).sgt(MinRHS);
7127   }
7128
7129   APInt MinRHS = getUnsignedRange(RHS).getUnsignedMin();
7130   APInt MinValue = APInt::getMinValue(BitWidth);
7131   APInt MaxStrideMinusOne = getUnsignedRange(getMinusSCEV(Stride, One))
7132                             .getUnsignedMax();
7133
7134   // UMinRHS - UMaxStrideMinusOne < UMinValue => overflow!
7135   return (MinValue + MaxStrideMinusOne).ugt(MinRHS);
7136 }
7137
7138 // Compute the backedge taken count knowing the interval difference, the
7139 // stride and presence of the equality in the comparison.
7140 const SCEV *ScalarEvolution::computeBECount(const SCEV *Delta, const SCEV *Step,
7141                                             bool Equality) {
7142   const SCEV *One = getConstant(Step->getType(), 1);
7143   Delta = Equality ? getAddExpr(Delta, Step)
7144                    : getAddExpr(Delta, getMinusSCEV(Step, One));
7145   return getUDivExpr(Delta, Step);
7146 }
7147
7148 /// HowManyLessThans - Return the number of times a backedge containing the
7149 /// specified less-than comparison will execute.  If not computable, return
7150 /// CouldNotCompute.
7151 ///
7152 /// @param ControlsExit is true when the LHS < RHS condition directly controls
7153 /// the branch (loops exits only if condition is true). In this case, we can use
7154 /// NoWrapFlags to skip overflow checks.
7155 ScalarEvolution::ExitLimit
7156 ScalarEvolution::HowManyLessThans(const SCEV *LHS, const SCEV *RHS,
7157                                   const Loop *L, bool IsSigned,
7158                                   bool ControlsExit) {
7159   // We handle only IV < Invariant
7160   if (!isLoopInvariant(RHS, L))
7161     return getCouldNotCompute();
7162
7163   const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS);
7164
7165   // Avoid weird loops
7166   if (!IV || IV->getLoop() != L || !IV->isAffine())
7167     return getCouldNotCompute();
7168
7169   bool NoWrap = ControlsExit &&
7170                 IV->getNoWrapFlags(IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW);
7171
7172   const SCEV *Stride = IV->getStepRecurrence(*this);
7173
7174   // Avoid negative or zero stride values
7175   if (!isKnownPositive(Stride))
7176     return getCouldNotCompute();
7177
7178   // Avoid proven overflow cases: this will ensure that the backedge taken count
7179   // will not generate any unsigned overflow. Relaxed no-overflow conditions
7180   // exploit NoWrapFlags, allowing to optimize in presence of undefined
7181   // behaviors like the case of C language.
7182   if (!Stride->isOne() && doesIVOverflowOnLT(RHS, Stride, IsSigned, NoWrap))
7183     return getCouldNotCompute();
7184
7185   ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SLT
7186                                       : ICmpInst::ICMP_ULT;
7187   const SCEV *Start = IV->getStart();
7188   const SCEV *End = RHS;
7189   if (!isLoopEntryGuardedByCond(L, Cond, getMinusSCEV(Start, Stride), RHS)) {
7190     const SCEV *Diff = getMinusSCEV(RHS, Start);
7191     // If we have NoWrap set, then we can assume that the increment won't
7192     // overflow, in which case if RHS - Start is a constant, we don't need to
7193     // do a max operation since we can just figure it out statically
7194     if (NoWrap && isa<SCEVConstant>(Diff)) {
7195       APInt D = dyn_cast<const SCEVConstant>(Diff)->getValue()->getValue();
7196       if (D.isNegative())
7197         End = Start;
7198     } else
7199       End = IsSigned ? getSMaxExpr(RHS, Start)
7200                      : getUMaxExpr(RHS, Start);
7201   }
7202
7203   const SCEV *BECount = computeBECount(getMinusSCEV(End, Start), Stride, false);
7204
7205   APInt MinStart = IsSigned ? getSignedRange(Start).getSignedMin()
7206                             : getUnsignedRange(Start).getUnsignedMin();
7207
7208   APInt MinStride = IsSigned ? getSignedRange(Stride).getSignedMin()
7209                              : getUnsignedRange(Stride).getUnsignedMin();
7210
7211   unsigned BitWidth = getTypeSizeInBits(LHS->getType());
7212   APInt Limit = IsSigned ? APInt::getSignedMaxValue(BitWidth) - (MinStride - 1)
7213                          : APInt::getMaxValue(BitWidth) - (MinStride - 1);
7214
7215   // Although End can be a MAX expression we estimate MaxEnd considering only
7216   // the case End = RHS. This is safe because in the other case (End - Start)
7217   // is zero, leading to a zero maximum backedge taken count.
7218   APInt MaxEnd =
7219     IsSigned ? APIntOps::smin(getSignedRange(RHS).getSignedMax(), Limit)
7220              : APIntOps::umin(getUnsignedRange(RHS).getUnsignedMax(), Limit);
7221
7222   const SCEV *MaxBECount;
7223   if (isa<SCEVConstant>(BECount))
7224     MaxBECount = BECount;
7225   else
7226     MaxBECount = computeBECount(getConstant(MaxEnd - MinStart),
7227                                 getConstant(MinStride), false);
7228
7229   if (isa<SCEVCouldNotCompute>(MaxBECount))
7230     MaxBECount = BECount;
7231
7232   return ExitLimit(BECount, MaxBECount);
7233 }
7234
7235 ScalarEvolution::ExitLimit
7236 ScalarEvolution::HowManyGreaterThans(const SCEV *LHS, const SCEV *RHS,
7237                                      const Loop *L, bool IsSigned,
7238                                      bool ControlsExit) {
7239   // We handle only IV > Invariant
7240   if (!isLoopInvariant(RHS, L))
7241     return getCouldNotCompute();
7242
7243   const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS);
7244
7245   // Avoid weird loops
7246   if (!IV || IV->getLoop() != L || !IV->isAffine())
7247     return getCouldNotCompute();
7248
7249   bool NoWrap = ControlsExit &&
7250                 IV->getNoWrapFlags(IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW);
7251
7252   const SCEV *Stride = getNegativeSCEV(IV->getStepRecurrence(*this));
7253
7254   // Avoid negative or zero stride values
7255   if (!isKnownPositive(Stride))
7256     return getCouldNotCompute();
7257
7258   // Avoid proven overflow cases: this will ensure that the backedge taken count
7259   // will not generate any unsigned overflow. Relaxed no-overflow conditions
7260   // exploit NoWrapFlags, allowing to optimize in presence of undefined
7261   // behaviors like the case of C language.
7262   if (!Stride->isOne() && doesIVOverflowOnGT(RHS, Stride, IsSigned, NoWrap))
7263     return getCouldNotCompute();
7264
7265   ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SGT
7266                                       : ICmpInst::ICMP_UGT;
7267
7268   const SCEV *Start = IV->getStart();
7269   const SCEV *End = RHS;
7270   if (!isLoopEntryGuardedByCond(L, Cond, getAddExpr(Start, Stride), RHS)) {
7271     const SCEV *Diff = getMinusSCEV(RHS, Start);
7272     // If we have NoWrap set, then we can assume that the increment won't
7273     // overflow, in which case if RHS - Start is a constant, we don't need to
7274     // do a max operation since we can just figure it out statically
7275     if (NoWrap && isa<SCEVConstant>(Diff)) {
7276       APInt D = dyn_cast<const SCEVConstant>(Diff)->getValue()->getValue();
7277       if (!D.isNegative())
7278         End = Start;
7279     } else
7280       End = IsSigned ? getSMinExpr(RHS, Start)
7281                      : getUMinExpr(RHS, Start);
7282   }
7283
7284   const SCEV *BECount = computeBECount(getMinusSCEV(Start, End), Stride, false);
7285
7286   APInt MaxStart = IsSigned ? getSignedRange(Start).getSignedMax()
7287                             : getUnsignedRange(Start).getUnsignedMax();
7288
7289   APInt MinStride = IsSigned ? getSignedRange(Stride).getSignedMin()
7290                              : getUnsignedRange(Stride).getUnsignedMin();
7291
7292   unsigned BitWidth = getTypeSizeInBits(LHS->getType());
7293   APInt Limit = IsSigned ? APInt::getSignedMinValue(BitWidth) + (MinStride - 1)
7294                          : APInt::getMinValue(BitWidth) + (MinStride - 1);
7295
7296   // Although End can be a MIN expression we estimate MinEnd considering only
7297   // the case End = RHS. This is safe because in the other case (Start - End)
7298   // is zero, leading to a zero maximum backedge taken count.
7299   APInt MinEnd =
7300     IsSigned ? APIntOps::smax(getSignedRange(RHS).getSignedMin(), Limit)
7301              : APIntOps::umax(getUnsignedRange(RHS).getUnsignedMin(), Limit);
7302
7303
7304   const SCEV *MaxBECount = getCouldNotCompute();
7305   if (isa<SCEVConstant>(BECount))
7306     MaxBECount = BECount;
7307   else
7308     MaxBECount = computeBECount(getConstant(MaxStart - MinEnd),
7309                                 getConstant(MinStride), false);
7310
7311   if (isa<SCEVCouldNotCompute>(MaxBECount))
7312     MaxBECount = BECount;
7313
7314   return ExitLimit(BECount, MaxBECount);
7315 }
7316
7317 /// getNumIterationsInRange - Return the number of iterations of this loop that
7318 /// produce values in the specified constant range.  Another way of looking at
7319 /// this is that it returns the first iteration number where the value is not in
7320 /// the condition, thus computing the exit count. If the iteration count can't
7321 /// be computed, an instance of SCEVCouldNotCompute is returned.
7322 const SCEV *SCEVAddRecExpr::getNumIterationsInRange(ConstantRange Range,
7323                                                     ScalarEvolution &SE) const {
7324   if (Range.isFullSet())  // Infinite loop.
7325     return SE.getCouldNotCompute();
7326
7327   // If the start is a non-zero constant, shift the range to simplify things.
7328   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(getStart()))
7329     if (!SC->getValue()->isZero()) {
7330       SmallVector<const SCEV *, 4> Operands(op_begin(), op_end());
7331       Operands[0] = SE.getConstant(SC->getType(), 0);
7332       const SCEV *Shifted = SE.getAddRecExpr(Operands, getLoop(),
7333                                              getNoWrapFlags(FlagNW));
7334       if (const SCEVAddRecExpr *ShiftedAddRec =
7335             dyn_cast<SCEVAddRecExpr>(Shifted))
7336         return ShiftedAddRec->getNumIterationsInRange(
7337                            Range.subtract(SC->getValue()->getValue()), SE);
7338       // This is strange and shouldn't happen.
7339       return SE.getCouldNotCompute();
7340     }
7341
7342   // The only time we can solve this is when we have all constant indices.
7343   // Otherwise, we cannot determine the overflow conditions.
7344   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
7345     if (!isa<SCEVConstant>(getOperand(i)))
7346       return SE.getCouldNotCompute();
7347
7348
7349   // Okay at this point we know that all elements of the chrec are constants and
7350   // that the start element is zero.
7351
7352   // First check to see if the range contains zero.  If not, the first
7353   // iteration exits.
7354   unsigned BitWidth = SE.getTypeSizeInBits(getType());
7355   if (!Range.contains(APInt(BitWidth, 0)))
7356     return SE.getConstant(getType(), 0);
7357
7358   if (isAffine()) {
7359     // If this is an affine expression then we have this situation:
7360     //   Solve {0,+,A} in Range  ===  Ax in Range
7361
7362     // We know that zero is in the range.  If A is positive then we know that
7363     // the upper value of the range must be the first possible exit value.
7364     // If A is negative then the lower of the range is the last possible loop
7365     // value.  Also note that we already checked for a full range.
7366     APInt One(BitWidth,1);
7367     APInt A     = cast<SCEVConstant>(getOperand(1))->getValue()->getValue();
7368     APInt End = A.sge(One) ? (Range.getUpper() - One) : Range.getLower();
7369
7370     // The exit value should be (End+A)/A.
7371     APInt ExitVal = (End + A).udiv(A);
7372     ConstantInt *ExitValue = ConstantInt::get(SE.getContext(), ExitVal);
7373
7374     // Evaluate at the exit value.  If we really did fall out of the valid
7375     // range, then we computed our trip count, otherwise wrap around or other
7376     // things must have happened.
7377     ConstantInt *Val = EvaluateConstantChrecAtConstant(this, ExitValue, SE);
7378     if (Range.contains(Val->getValue()))
7379       return SE.getCouldNotCompute();  // Something strange happened
7380
7381     // Ensure that the previous value is in the range.  This is a sanity check.
7382     assert(Range.contains(
7383            EvaluateConstantChrecAtConstant(this,
7384            ConstantInt::get(SE.getContext(), ExitVal - One), SE)->getValue()) &&
7385            "Linear scev computation is off in a bad way!");
7386     return SE.getConstant(ExitValue);
7387   } else if (isQuadratic()) {
7388     // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of the
7389     // quadratic equation to solve it.  To do this, we must frame our problem in
7390     // terms of figuring out when zero is crossed, instead of when
7391     // Range.getUpper() is crossed.
7392     SmallVector<const SCEV *, 4> NewOps(op_begin(), op_end());
7393     NewOps[0] = SE.getNegativeSCEV(SE.getConstant(Range.getUpper()));
7394     const SCEV *NewAddRec = SE.getAddRecExpr(NewOps, getLoop(),
7395                                              // getNoWrapFlags(FlagNW)
7396                                              FlagAnyWrap);
7397
7398     // Next, solve the constructed addrec
7399     std::pair<const SCEV *,const SCEV *> Roots =
7400       SolveQuadraticEquation(cast<SCEVAddRecExpr>(NewAddRec), SE);
7401     const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
7402     const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
7403     if (R1) {
7404       // Pick the smallest positive root value.
7405       if (ConstantInt *CB =
7406           dyn_cast<ConstantInt>(ConstantExpr::getICmp(ICmpInst::ICMP_ULT,
7407                          R1->getValue(), R2->getValue()))) {
7408         if (!CB->getZExtValue())
7409           std::swap(R1, R2);   // R1 is the minimum root now.
7410
7411         // Make sure the root is not off by one.  The returned iteration should
7412         // not be in the range, but the previous one should be.  When solving
7413         // for "X*X < 5", for example, we should not return a root of 2.
7414         ConstantInt *R1Val = EvaluateConstantChrecAtConstant(this,
7415                                                              R1->getValue(),
7416                                                              SE);
7417         if (Range.contains(R1Val->getValue())) {
7418           // The next iteration must be out of the range...
7419           ConstantInt *NextVal =
7420                 ConstantInt::get(SE.getContext(), R1->getValue()->getValue()+1);
7421
7422           R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
7423           if (!Range.contains(R1Val->getValue()))
7424             return SE.getConstant(NextVal);
7425           return SE.getCouldNotCompute();  // Something strange happened
7426         }
7427
7428         // If R1 was not in the range, then it is a good return value.  Make
7429         // sure that R1-1 WAS in the range though, just in case.
7430         ConstantInt *NextVal =
7431                ConstantInt::get(SE.getContext(), R1->getValue()->getValue()-1);
7432         R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
7433         if (Range.contains(R1Val->getValue()))
7434           return R1;
7435         return SE.getCouldNotCompute();  // Something strange happened
7436       }
7437     }
7438   }
7439
7440   return SE.getCouldNotCompute();
7441 }
7442
7443 namespace {
7444 struct FindUndefs {
7445   bool Found;
7446   FindUndefs() : Found(false) {}
7447
7448   bool follow(const SCEV *S) {
7449     if (const SCEVUnknown *C = dyn_cast<SCEVUnknown>(S)) {
7450       if (isa<UndefValue>(C->getValue()))
7451         Found = true;
7452     } else if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S)) {
7453       if (isa<UndefValue>(C->getValue()))
7454         Found = true;
7455     }
7456
7457     // Keep looking if we haven't found it yet.
7458     return !Found;
7459   }
7460   bool isDone() const {
7461     // Stop recursion if we have found an undef.
7462     return Found;
7463   }
7464 };
7465 }
7466
7467 // Return true when S contains at least an undef value.
7468 static inline bool
7469 containsUndefs(const SCEV *S) {
7470   FindUndefs F;
7471   SCEVTraversal<FindUndefs> ST(F);
7472   ST.visitAll(S);
7473
7474   return F.Found;
7475 }
7476
7477 namespace {
7478 // Collect all steps of SCEV expressions.
7479 struct SCEVCollectStrides {
7480   ScalarEvolution &SE;
7481   SmallVectorImpl<const SCEV *> &Strides;
7482
7483   SCEVCollectStrides(ScalarEvolution &SE, SmallVectorImpl<const SCEV *> &S)
7484       : SE(SE), Strides(S) {}
7485
7486   bool follow(const SCEV *S) {
7487     if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S))
7488       Strides.push_back(AR->getStepRecurrence(SE));
7489     return true;
7490   }
7491   bool isDone() const { return false; }
7492 };
7493
7494 // Collect all SCEVUnknown and SCEVMulExpr expressions.
7495 struct SCEVCollectTerms {
7496   SmallVectorImpl<const SCEV *> &Terms;
7497
7498   SCEVCollectTerms(SmallVectorImpl<const SCEV *> &T)
7499       : Terms(T) {}
7500
7501   bool follow(const SCEV *S) {
7502     if (isa<SCEVUnknown>(S) || isa<SCEVMulExpr>(S)) {
7503       if (!containsUndefs(S))
7504         Terms.push_back(S);
7505
7506       // Stop recursion: once we collected a term, do not walk its operands.
7507       return false;
7508     }
7509
7510     // Keep looking.
7511     return true;
7512   }
7513   bool isDone() const { return false; }
7514 };
7515 }
7516
7517 /// Find parametric terms in this SCEVAddRecExpr.
7518 void SCEVAddRecExpr::collectParametricTerms(
7519     ScalarEvolution &SE, SmallVectorImpl<const SCEV *> &Terms) const {
7520   SmallVector<const SCEV *, 4> Strides;
7521   SCEVCollectStrides StrideCollector(SE, Strides);
7522   visitAll(this, StrideCollector);
7523
7524   DEBUG({
7525       dbgs() << "Strides:\n";
7526       for (const SCEV *S : Strides)
7527         dbgs() << *S << "\n";
7528     });
7529
7530   for (const SCEV *S : Strides) {
7531     SCEVCollectTerms TermCollector(Terms);
7532     visitAll(S, TermCollector);
7533   }
7534
7535   DEBUG({
7536       dbgs() << "Terms:\n";
7537       for (const SCEV *T : Terms)
7538         dbgs() << *T << "\n";
7539     });
7540 }
7541
7542 static bool findArrayDimensionsRec(ScalarEvolution &SE,
7543                                    SmallVectorImpl<const SCEV *> &Terms,
7544                                    SmallVectorImpl<const SCEV *> &Sizes) {
7545   int Last = Terms.size() - 1;
7546   const SCEV *Step = Terms[Last];
7547
7548   // End of recursion.
7549   if (Last == 0) {
7550     if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(Step)) {
7551       SmallVector<const SCEV *, 2> Qs;
7552       for (const SCEV *Op : M->operands())
7553         if (!isa<SCEVConstant>(Op))
7554           Qs.push_back(Op);
7555
7556       Step = SE.getMulExpr(Qs);
7557     }
7558
7559     Sizes.push_back(Step);
7560     return true;
7561   }
7562
7563   for (const SCEV *&Term : Terms) {
7564     // Normalize the terms before the next call to findArrayDimensionsRec.
7565     const SCEV *Q, *R;
7566     SCEVDivision::divide(SE, Term, Step, &Q, &R);
7567
7568     // Bail out when GCD does not evenly divide one of the terms.
7569     if (!R->isZero())
7570       return false;
7571
7572     Term = Q;
7573   }
7574
7575   // Remove all SCEVConstants.
7576   Terms.erase(std::remove_if(Terms.begin(), Terms.end(), [](const SCEV *E) {
7577                 return isa<SCEVConstant>(E);
7578               }),
7579               Terms.end());
7580
7581   if (Terms.size() > 0)
7582     if (!findArrayDimensionsRec(SE, Terms, Sizes))
7583       return false;
7584
7585   Sizes.push_back(Step);
7586   return true;
7587 }
7588
7589 namespace {
7590 struct FindParameter {
7591   bool FoundParameter;
7592   FindParameter() : FoundParameter(false) {}
7593
7594   bool follow(const SCEV *S) {
7595     if (isa<SCEVUnknown>(S)) {
7596       FoundParameter = true;
7597       // Stop recursion: we found a parameter.
7598       return false;
7599     }
7600     // Keep looking.
7601     return true;
7602   }
7603   bool isDone() const {
7604     // Stop recursion if we have found a parameter.
7605     return FoundParameter;
7606   }
7607 };
7608 }
7609
7610 // Returns true when S contains at least a SCEVUnknown parameter.
7611 static inline bool
7612 containsParameters(const SCEV *S) {
7613   FindParameter F;
7614   SCEVTraversal<FindParameter> ST(F);
7615   ST.visitAll(S);
7616
7617   return F.FoundParameter;
7618 }
7619
7620 // Returns true when one of the SCEVs of Terms contains a SCEVUnknown parameter.
7621 static inline bool
7622 containsParameters(SmallVectorImpl<const SCEV *> &Terms) {
7623   for (const SCEV *T : Terms)
7624     if (containsParameters(T))
7625       return true;
7626   return false;
7627 }
7628
7629 // Return the number of product terms in S.
7630 static inline int numberOfTerms(const SCEV *S) {
7631   if (const SCEVMulExpr *Expr = dyn_cast<SCEVMulExpr>(S))
7632     return Expr->getNumOperands();
7633   return 1;
7634 }
7635
7636 static const SCEV *removeConstantFactors(ScalarEvolution &SE, const SCEV *T) {
7637   if (isa<SCEVConstant>(T))
7638     return nullptr;
7639
7640   if (isa<SCEVUnknown>(T))
7641     return T;
7642
7643   if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(T)) {
7644     SmallVector<const SCEV *, 2> Factors;
7645     for (const SCEV *Op : M->operands())
7646       if (!isa<SCEVConstant>(Op))
7647         Factors.push_back(Op);
7648
7649     return SE.getMulExpr(Factors);
7650   }
7651
7652   return T;
7653 }
7654
7655 /// Return the size of an element read or written by Inst.
7656 const SCEV *ScalarEvolution::getElementSize(Instruction *Inst) {
7657   Type *Ty;
7658   if (StoreInst *Store = dyn_cast<StoreInst>(Inst))
7659     Ty = Store->getValueOperand()->getType();
7660   else if (LoadInst *Load = dyn_cast<LoadInst>(Inst))
7661     Ty = Load->getType();
7662   else
7663     return nullptr;
7664
7665   Type *ETy = getEffectiveSCEVType(PointerType::getUnqual(Ty));
7666   return getSizeOfExpr(ETy, Ty);
7667 }
7668
7669 /// Second step of delinearization: compute the array dimensions Sizes from the
7670 /// set of Terms extracted from the memory access function of this SCEVAddRec.
7671 void ScalarEvolution::findArrayDimensions(SmallVectorImpl<const SCEV *> &Terms,
7672                                           SmallVectorImpl<const SCEV *> &Sizes,
7673                                           const SCEV *ElementSize) const {
7674
7675   if (Terms.size() < 1 || !ElementSize)
7676     return;
7677
7678   // Early return when Terms do not contain parameters: we do not delinearize
7679   // non parametric SCEVs.
7680   if (!containsParameters(Terms))
7681     return;
7682
7683   DEBUG({
7684       dbgs() << "Terms:\n";
7685       for (const SCEV *T : Terms)
7686         dbgs() << *T << "\n";
7687     });
7688
7689   // Remove duplicates.
7690   std::sort(Terms.begin(), Terms.end());
7691   Terms.erase(std::unique(Terms.begin(), Terms.end()), Terms.end());
7692
7693   // Put larger terms first.
7694   std::sort(Terms.begin(), Terms.end(), [](const SCEV *LHS, const SCEV *RHS) {
7695     return numberOfTerms(LHS) > numberOfTerms(RHS);
7696   });
7697
7698   ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
7699
7700   // Divide all terms by the element size.
7701   for (const SCEV *&Term : Terms) {
7702     const SCEV *Q, *R;
7703     SCEVDivision::divide(SE, Term, ElementSize, &Q, &R);
7704     Term = Q;
7705   }
7706
7707   SmallVector<const SCEV *, 4> NewTerms;
7708
7709   // Remove constant factors.
7710   for (const SCEV *T : Terms)
7711     if (const SCEV *NewT = removeConstantFactors(SE, T))
7712       NewTerms.push_back(NewT);
7713
7714   DEBUG({
7715       dbgs() << "Terms after sorting:\n";
7716       for (const SCEV *T : NewTerms)
7717         dbgs() << *T << "\n";
7718     });
7719
7720   if (NewTerms.empty() ||
7721       !findArrayDimensionsRec(SE, NewTerms, Sizes)) {
7722     Sizes.clear();
7723     return;
7724   }
7725
7726   // The last element to be pushed into Sizes is the size of an element.
7727   Sizes.push_back(ElementSize);
7728
7729   DEBUG({
7730       dbgs() << "Sizes:\n";
7731       for (const SCEV *S : Sizes)
7732         dbgs() << *S << "\n";
7733     });
7734 }
7735
7736 /// Third step of delinearization: compute the access functions for the
7737 /// Subscripts based on the dimensions in Sizes.
7738 void SCEVAddRecExpr::computeAccessFunctions(
7739     ScalarEvolution &SE, SmallVectorImpl<const SCEV *> &Subscripts,
7740     SmallVectorImpl<const SCEV *> &Sizes) const {
7741
7742   // Early exit in case this SCEV is not an affine multivariate function.
7743   if (Sizes.empty() || !this->isAffine())
7744     return;
7745
7746   const SCEV *Res = this;
7747   int Last = Sizes.size() - 1;
7748   for (int i = Last; i >= 0; i--) {
7749     const SCEV *Q, *R;
7750     SCEVDivision::divide(SE, Res, Sizes[i], &Q, &R);
7751
7752     DEBUG({
7753         dbgs() << "Res: " << *Res << "\n";
7754         dbgs() << "Sizes[i]: " << *Sizes[i] << "\n";
7755         dbgs() << "Res divided by Sizes[i]:\n";
7756         dbgs() << "Quotient: " << *Q << "\n";
7757         dbgs() << "Remainder: " << *R << "\n";
7758       });
7759
7760     Res = Q;
7761
7762     // Do not record the last subscript corresponding to the size of elements in
7763     // the array.
7764     if (i == Last) {
7765
7766       // Bail out if the remainder is too complex.
7767       if (isa<SCEVAddRecExpr>(R)) {
7768         Subscripts.clear();
7769         Sizes.clear();
7770         return;
7771       }
7772
7773       continue;
7774     }
7775
7776     // Record the access function for the current subscript.
7777     Subscripts.push_back(R);
7778   }
7779
7780   // Also push in last position the remainder of the last division: it will be
7781   // the access function of the innermost dimension.
7782   Subscripts.push_back(Res);
7783
7784   std::reverse(Subscripts.begin(), Subscripts.end());
7785
7786   DEBUG({
7787       dbgs() << "Subscripts:\n";
7788       for (const SCEV *S : Subscripts)
7789         dbgs() << *S << "\n";
7790     });
7791 }
7792
7793 /// Splits the SCEV into two vectors of SCEVs representing the subscripts and
7794 /// sizes of an array access. Returns the remainder of the delinearization that
7795 /// is the offset start of the array.  The SCEV->delinearize algorithm computes
7796 /// the multiples of SCEV coefficients: that is a pattern matching of sub
7797 /// expressions in the stride and base of a SCEV corresponding to the
7798 /// computation of a GCD (greatest common divisor) of base and stride.  When
7799 /// SCEV->delinearize fails, it returns the SCEV unchanged.
7800 ///
7801 /// For example: when analyzing the memory access A[i][j][k] in this loop nest
7802 ///
7803 ///  void foo(long n, long m, long o, double A[n][m][o]) {
7804 ///
7805 ///    for (long i = 0; i < n; i++)
7806 ///      for (long j = 0; j < m; j++)
7807 ///        for (long k = 0; k < o; k++)
7808 ///          A[i][j][k] = 1.0;
7809 ///  }
7810 ///
7811 /// the delinearization input is the following AddRec SCEV:
7812 ///
7813 ///  AddRec: {{{%A,+,(8 * %m * %o)}<%for.i>,+,(8 * %o)}<%for.j>,+,8}<%for.k>
7814 ///
7815 /// From this SCEV, we are able to say that the base offset of the access is %A
7816 /// because it appears as an offset that does not divide any of the strides in
7817 /// the loops:
7818 ///
7819 ///  CHECK: Base offset: %A
7820 ///
7821 /// and then SCEV->delinearize determines the size of some of the dimensions of
7822 /// the array as these are the multiples by which the strides are happening:
7823 ///
7824 ///  CHECK: ArrayDecl[UnknownSize][%m][%o] with elements of sizeof(double) bytes.
7825 ///
7826 /// Note that the outermost dimension remains of UnknownSize because there are
7827 /// no strides that would help identifying the size of the last dimension: when
7828 /// the array has been statically allocated, one could compute the size of that
7829 /// dimension by dividing the overall size of the array by the size of the known
7830 /// dimensions: %m * %o * 8.
7831 ///
7832 /// Finally delinearize provides the access functions for the array reference
7833 /// that does correspond to A[i][j][k] of the above C testcase:
7834 ///
7835 ///  CHECK: ArrayRef[{0,+,1}<%for.i>][{0,+,1}<%for.j>][{0,+,1}<%for.k>]
7836 ///
7837 /// The testcases are checking the output of a function pass:
7838 /// DelinearizationPass that walks through all loads and stores of a function
7839 /// asking for the SCEV of the memory access with respect to all enclosing
7840 /// loops, calling SCEV->delinearize on that and printing the results.
7841
7842 void SCEVAddRecExpr::delinearize(ScalarEvolution &SE,
7843                                  SmallVectorImpl<const SCEV *> &Subscripts,
7844                                  SmallVectorImpl<const SCEV *> &Sizes,
7845                                  const SCEV *ElementSize) const {
7846   // First step: collect parametric terms.
7847   SmallVector<const SCEV *, 4> Terms;
7848   collectParametricTerms(SE, Terms);
7849
7850   if (Terms.empty())
7851     return;
7852
7853   // Second step: find subscript sizes.
7854   SE.findArrayDimensions(Terms, Sizes, ElementSize);
7855
7856   if (Sizes.empty())
7857     return;
7858
7859   // Third step: compute the access functions for each subscript.
7860   computeAccessFunctions(SE, Subscripts, Sizes);
7861
7862   if (Subscripts.empty())
7863     return;
7864
7865   DEBUG({
7866       dbgs() << "succeeded to delinearize " << *this << "\n";
7867       dbgs() << "ArrayDecl[UnknownSize]";
7868       for (const SCEV *S : Sizes)
7869         dbgs() << "[" << *S << "]";
7870
7871       dbgs() << "\nArrayRef";
7872       for (const SCEV *S : Subscripts)
7873         dbgs() << "[" << *S << "]";
7874       dbgs() << "\n";
7875     });
7876 }
7877
7878 //===----------------------------------------------------------------------===//
7879 //                   SCEVCallbackVH Class Implementation
7880 //===----------------------------------------------------------------------===//
7881
7882 void ScalarEvolution::SCEVCallbackVH::deleted() {
7883   assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
7884   if (PHINode *PN = dyn_cast<PHINode>(getValPtr()))
7885     SE->ConstantEvolutionLoopExitValue.erase(PN);
7886   SE->ValueExprMap.erase(getValPtr());
7887   // this now dangles!
7888 }
7889
7890 void ScalarEvolution::SCEVCallbackVH::allUsesReplacedWith(Value *V) {
7891   assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
7892
7893   // Forget all the expressions associated with users of the old value,
7894   // so that future queries will recompute the expressions using the new
7895   // value.
7896   Value *Old = getValPtr();
7897   SmallVector<User *, 16> Worklist(Old->user_begin(), Old->user_end());
7898   SmallPtrSet<User *, 8> Visited;
7899   while (!Worklist.empty()) {
7900     User *U = Worklist.pop_back_val();
7901     // Deleting the Old value will cause this to dangle. Postpone
7902     // that until everything else is done.
7903     if (U == Old)
7904       continue;
7905     if (!Visited.insert(U).second)
7906       continue;
7907     if (PHINode *PN = dyn_cast<PHINode>(U))
7908       SE->ConstantEvolutionLoopExitValue.erase(PN);
7909     SE->ValueExprMap.erase(U);
7910     Worklist.insert(Worklist.end(), U->user_begin(), U->user_end());
7911   }
7912   // Delete the Old value.
7913   if (PHINode *PN = dyn_cast<PHINode>(Old))
7914     SE->ConstantEvolutionLoopExitValue.erase(PN);
7915   SE->ValueExprMap.erase(Old);
7916   // this now dangles!
7917 }
7918
7919 ScalarEvolution::SCEVCallbackVH::SCEVCallbackVH(Value *V, ScalarEvolution *se)
7920   : CallbackVH(V), SE(se) {}
7921
7922 //===----------------------------------------------------------------------===//
7923 //                   ScalarEvolution Class Implementation
7924 //===----------------------------------------------------------------------===//
7925
7926 ScalarEvolution::ScalarEvolution()
7927   : FunctionPass(ID), ValuesAtScopes(64), LoopDispositions(64),
7928     BlockDispositions(64), FirstUnknown(nullptr) {
7929   initializeScalarEvolutionPass(*PassRegistry::getPassRegistry());
7930 }
7931
7932 bool ScalarEvolution::runOnFunction(Function &F) {
7933   this->F = &F;
7934   AC = &getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F);
7935   LI = &getAnalysis<LoopInfoWrapperPass>().getLoopInfo();
7936   TLI = &getAnalysis<TargetLibraryInfoWrapperPass>().getTLI();
7937   DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
7938   return false;
7939 }
7940
7941 void ScalarEvolution::releaseMemory() {
7942   // Iterate through all the SCEVUnknown instances and call their
7943   // destructors, so that they release their references to their values.
7944   for (SCEVUnknown *U = FirstUnknown; U; U = U->Next)
7945     U->~SCEVUnknown();
7946   FirstUnknown = nullptr;
7947
7948   ValueExprMap.clear();
7949
7950   // Free any extra memory created for ExitNotTakenInfo in the unlikely event
7951   // that a loop had multiple computable exits.
7952   for (DenseMap<const Loop*, BackedgeTakenInfo>::iterator I =
7953          BackedgeTakenCounts.begin(), E = BackedgeTakenCounts.end();
7954        I != E; ++I) {
7955     I->second.clear();
7956   }
7957
7958   assert(PendingLoopPredicates.empty() && "isImpliedCond garbage");
7959
7960   BackedgeTakenCounts.clear();
7961   ConstantEvolutionLoopExitValue.clear();
7962   ValuesAtScopes.clear();
7963   LoopDispositions.clear();
7964   BlockDispositions.clear();
7965   UnsignedRanges.clear();
7966   SignedRanges.clear();
7967   UniqueSCEVs.clear();
7968   SCEVAllocator.Reset();
7969 }
7970
7971 void ScalarEvolution::getAnalysisUsage(AnalysisUsage &AU) const {
7972   AU.setPreservesAll();
7973   AU.addRequired<AssumptionCacheTracker>();
7974   AU.addRequiredTransitive<LoopInfoWrapperPass>();
7975   AU.addRequiredTransitive<DominatorTreeWrapperPass>();
7976   AU.addRequired<TargetLibraryInfoWrapperPass>();
7977 }
7978
7979 bool ScalarEvolution::hasLoopInvariantBackedgeTakenCount(const Loop *L) {
7980   return !isa<SCEVCouldNotCompute>(getBackedgeTakenCount(L));
7981 }
7982
7983 static void PrintLoopInfo(raw_ostream &OS, ScalarEvolution *SE,
7984                           const Loop *L) {
7985   // Print all inner loops first
7986   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
7987     PrintLoopInfo(OS, SE, *I);
7988
7989   OS << "Loop ";
7990   L->getHeader()->printAsOperand(OS, /*PrintType=*/false);
7991   OS << ": ";
7992
7993   SmallVector<BasicBlock *, 8> ExitBlocks;
7994   L->getExitBlocks(ExitBlocks);
7995   if (ExitBlocks.size() != 1)
7996     OS << "<multiple exits> ";
7997
7998   if (SE->hasLoopInvariantBackedgeTakenCount(L)) {
7999     OS << "backedge-taken count is " << *SE->getBackedgeTakenCount(L);
8000   } else {
8001     OS << "Unpredictable backedge-taken count. ";
8002   }
8003
8004   OS << "\n"
8005         "Loop ";
8006   L->getHeader()->printAsOperand(OS, /*PrintType=*/false);
8007   OS << ": ";
8008
8009   if (!isa<SCEVCouldNotCompute>(SE->getMaxBackedgeTakenCount(L))) {
8010     OS << "max backedge-taken count is " << *SE->getMaxBackedgeTakenCount(L);
8011   } else {
8012     OS << "Unpredictable max backedge-taken count. ";
8013   }
8014
8015   OS << "\n";
8016 }
8017
8018 void ScalarEvolution::print(raw_ostream &OS, const Module *) const {
8019   // ScalarEvolution's implementation of the print method is to print
8020   // out SCEV values of all instructions that are interesting. Doing
8021   // this potentially causes it to create new SCEV objects though,
8022   // which technically conflicts with the const qualifier. This isn't
8023   // observable from outside the class though, so casting away the
8024   // const isn't dangerous.
8025   ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
8026
8027   OS << "Classifying expressions for: ";
8028   F->printAsOperand(OS, /*PrintType=*/false);
8029   OS << "\n";
8030   for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
8031     if (isSCEVable(I->getType()) && !isa<CmpInst>(*I)) {
8032       OS << *I << '\n';
8033       OS << "  -->  ";
8034       const SCEV *SV = SE.getSCEV(&*I);
8035       SV->print(OS);
8036       if (!isa<SCEVCouldNotCompute>(SV)) {
8037         OS << " U: ";
8038         SE.getUnsignedRange(SV).print(OS);
8039         OS << " S: ";
8040         SE.getSignedRange(SV).print(OS);
8041       }
8042
8043       const Loop *L = LI->getLoopFor((*I).getParent());
8044
8045       const SCEV *AtUse = SE.getSCEVAtScope(SV, L);
8046       if (AtUse != SV) {
8047         OS << "  -->  ";
8048         AtUse->print(OS);
8049         if (!isa<SCEVCouldNotCompute>(AtUse)) {
8050           OS << " U: ";
8051           SE.getUnsignedRange(AtUse).print(OS);
8052           OS << " S: ";
8053           SE.getSignedRange(AtUse).print(OS);
8054         }
8055       }
8056
8057       if (L) {
8058         OS << "\t\t" "Exits: ";
8059         const SCEV *ExitValue = SE.getSCEVAtScope(SV, L->getParentLoop());
8060         if (!SE.isLoopInvariant(ExitValue, L)) {
8061           OS << "<<Unknown>>";
8062         } else {
8063           OS << *ExitValue;
8064         }
8065       }
8066
8067       OS << "\n";
8068     }
8069
8070   OS << "Determining loop execution counts for: ";
8071   F->printAsOperand(OS, /*PrintType=*/false);
8072   OS << "\n";
8073   for (LoopInfo::iterator I = LI->begin(), E = LI->end(); I != E; ++I)
8074     PrintLoopInfo(OS, &SE, *I);
8075 }
8076
8077 ScalarEvolution::LoopDisposition
8078 ScalarEvolution::getLoopDisposition(const SCEV *S, const Loop *L) {
8079   auto &Values = LoopDispositions[S];
8080   for (auto &V : Values) {
8081     if (V.getPointer() == L)
8082       return V.getInt();
8083   }
8084   Values.emplace_back(L, LoopVariant);
8085   LoopDisposition D = computeLoopDisposition(S, L);
8086   auto &Values2 = LoopDispositions[S];
8087   for (auto &V : make_range(Values2.rbegin(), Values2.rend())) {
8088     if (V.getPointer() == L) {
8089       V.setInt(D);
8090       break;
8091     }
8092   }
8093   return D;
8094 }
8095
8096 ScalarEvolution::LoopDisposition
8097 ScalarEvolution::computeLoopDisposition(const SCEV *S, const Loop *L) {
8098   switch (static_cast<SCEVTypes>(S->getSCEVType())) {
8099   case scConstant:
8100     return LoopInvariant;
8101   case scTruncate:
8102   case scZeroExtend:
8103   case scSignExtend:
8104     return getLoopDisposition(cast<SCEVCastExpr>(S)->getOperand(), L);
8105   case scAddRecExpr: {
8106     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S);
8107
8108     // If L is the addrec's loop, it's computable.
8109     if (AR->getLoop() == L)
8110       return LoopComputable;
8111
8112     // Add recurrences are never invariant in the function-body (null loop).
8113     if (!L)
8114       return LoopVariant;
8115
8116     // This recurrence is variant w.r.t. L if L contains AR's loop.
8117     if (L->contains(AR->getLoop()))
8118       return LoopVariant;
8119
8120     // This recurrence is invariant w.r.t. L if AR's loop contains L.
8121     if (AR->getLoop()->contains(L))
8122       return LoopInvariant;
8123
8124     // This recurrence is variant w.r.t. L if any of its operands
8125     // are variant.
8126     for (SCEVAddRecExpr::op_iterator I = AR->op_begin(), E = AR->op_end();
8127          I != E; ++I)
8128       if (!isLoopInvariant(*I, L))
8129         return LoopVariant;
8130
8131     // Otherwise it's loop-invariant.
8132     return LoopInvariant;
8133   }
8134   case scAddExpr:
8135   case scMulExpr:
8136   case scUMaxExpr:
8137   case scSMaxExpr: {
8138     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S);
8139     bool HasVarying = false;
8140     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
8141          I != E; ++I) {
8142       LoopDisposition D = getLoopDisposition(*I, L);
8143       if (D == LoopVariant)
8144         return LoopVariant;
8145       if (D == LoopComputable)
8146         HasVarying = true;
8147     }
8148     return HasVarying ? LoopComputable : LoopInvariant;
8149   }
8150   case scUDivExpr: {
8151     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
8152     LoopDisposition LD = getLoopDisposition(UDiv->getLHS(), L);
8153     if (LD == LoopVariant)
8154       return LoopVariant;
8155     LoopDisposition RD = getLoopDisposition(UDiv->getRHS(), L);
8156     if (RD == LoopVariant)
8157       return LoopVariant;
8158     return (LD == LoopInvariant && RD == LoopInvariant) ?
8159            LoopInvariant : LoopComputable;
8160   }
8161   case scUnknown:
8162     // All non-instruction values are loop invariant.  All instructions are loop
8163     // invariant if they are not contained in the specified loop.
8164     // Instructions are never considered invariant in the function body
8165     // (null loop) because they are defined within the "loop".
8166     if (Instruction *I = dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue()))
8167       return (L && !L->contains(I)) ? LoopInvariant : LoopVariant;
8168     return LoopInvariant;
8169   case scCouldNotCompute:
8170     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
8171   }
8172   llvm_unreachable("Unknown SCEV kind!");
8173 }
8174
8175 bool ScalarEvolution::isLoopInvariant(const SCEV *S, const Loop *L) {
8176   return getLoopDisposition(S, L) == LoopInvariant;
8177 }
8178
8179 bool ScalarEvolution::hasComputableLoopEvolution(const SCEV *S, const Loop *L) {
8180   return getLoopDisposition(S, L) == LoopComputable;
8181 }
8182
8183 ScalarEvolution::BlockDisposition
8184 ScalarEvolution::getBlockDisposition(const SCEV *S, const BasicBlock *BB) {
8185   auto &Values = BlockDispositions[S];
8186   for (auto &V : Values) {
8187     if (V.getPointer() == BB)
8188       return V.getInt();
8189   }
8190   Values.emplace_back(BB, DoesNotDominateBlock);
8191   BlockDisposition D = computeBlockDisposition(S, BB);
8192   auto &Values2 = BlockDispositions[S];
8193   for (auto &V : make_range(Values2.rbegin(), Values2.rend())) {
8194     if (V.getPointer() == BB) {
8195       V.setInt(D);
8196       break;
8197     }
8198   }
8199   return D;
8200 }
8201
8202 ScalarEvolution::BlockDisposition
8203 ScalarEvolution::computeBlockDisposition(const SCEV *S, const BasicBlock *BB) {
8204   switch (static_cast<SCEVTypes>(S->getSCEVType())) {
8205   case scConstant:
8206     return ProperlyDominatesBlock;
8207   case scTruncate:
8208   case scZeroExtend:
8209   case scSignExtend:
8210     return getBlockDisposition(cast<SCEVCastExpr>(S)->getOperand(), BB);
8211   case scAddRecExpr: {
8212     // This uses a "dominates" query instead of "properly dominates" query
8213     // to test for proper dominance too, because the instruction which
8214     // produces the addrec's value is a PHI, and a PHI effectively properly
8215     // dominates its entire containing block.
8216     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S);
8217     if (!DT->dominates(AR->getLoop()->getHeader(), BB))
8218       return DoesNotDominateBlock;
8219   }
8220   // FALL THROUGH into SCEVNAryExpr handling.
8221   case scAddExpr:
8222   case scMulExpr:
8223   case scUMaxExpr:
8224   case scSMaxExpr: {
8225     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S);
8226     bool Proper = true;
8227     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
8228          I != E; ++I) {
8229       BlockDisposition D = getBlockDisposition(*I, BB);
8230       if (D == DoesNotDominateBlock)
8231         return DoesNotDominateBlock;
8232       if (D == DominatesBlock)
8233         Proper = false;
8234     }
8235     return Proper ? ProperlyDominatesBlock : DominatesBlock;
8236   }
8237   case scUDivExpr: {
8238     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
8239     const SCEV *LHS = UDiv->getLHS(), *RHS = UDiv->getRHS();
8240     BlockDisposition LD = getBlockDisposition(LHS, BB);
8241     if (LD == DoesNotDominateBlock)
8242       return DoesNotDominateBlock;
8243     BlockDisposition RD = getBlockDisposition(RHS, BB);
8244     if (RD == DoesNotDominateBlock)
8245       return DoesNotDominateBlock;
8246     return (LD == ProperlyDominatesBlock && RD == ProperlyDominatesBlock) ?
8247       ProperlyDominatesBlock : DominatesBlock;
8248   }
8249   case scUnknown:
8250     if (Instruction *I =
8251           dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue())) {
8252       if (I->getParent() == BB)
8253         return DominatesBlock;
8254       if (DT->properlyDominates(I->getParent(), BB))
8255         return ProperlyDominatesBlock;
8256       return DoesNotDominateBlock;
8257     }
8258     return ProperlyDominatesBlock;
8259   case scCouldNotCompute:
8260     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
8261   }
8262   llvm_unreachable("Unknown SCEV kind!");
8263 }
8264
8265 bool ScalarEvolution::dominates(const SCEV *S, const BasicBlock *BB) {
8266   return getBlockDisposition(S, BB) >= DominatesBlock;
8267 }
8268
8269 bool ScalarEvolution::properlyDominates(const SCEV *S, const BasicBlock *BB) {
8270   return getBlockDisposition(S, BB) == ProperlyDominatesBlock;
8271 }
8272
8273 namespace {
8274 // Search for a SCEV expression node within an expression tree.
8275 // Implements SCEVTraversal::Visitor.
8276 struct SCEVSearch {
8277   const SCEV *Node;
8278   bool IsFound;
8279
8280   SCEVSearch(const SCEV *N): Node(N), IsFound(false) {}
8281
8282   bool follow(const SCEV *S) {
8283     IsFound |= (S == Node);
8284     return !IsFound;
8285   }
8286   bool isDone() const { return IsFound; }
8287 };
8288 }
8289
8290 bool ScalarEvolution::hasOperand(const SCEV *S, const SCEV *Op) const {
8291   SCEVSearch Search(Op);
8292   visitAll(S, Search);
8293   return Search.IsFound;
8294 }
8295
8296 void ScalarEvolution::forgetMemoizedResults(const SCEV *S) {
8297   ValuesAtScopes.erase(S);
8298   LoopDispositions.erase(S);
8299   BlockDispositions.erase(S);
8300   UnsignedRanges.erase(S);
8301   SignedRanges.erase(S);
8302
8303   for (DenseMap<const Loop*, BackedgeTakenInfo>::iterator I =
8304          BackedgeTakenCounts.begin(), E = BackedgeTakenCounts.end(); I != E; ) {
8305     BackedgeTakenInfo &BEInfo = I->second;
8306     if (BEInfo.hasOperand(S, this)) {
8307       BEInfo.clear();
8308       BackedgeTakenCounts.erase(I++);
8309     }
8310     else
8311       ++I;
8312   }
8313 }
8314
8315 typedef DenseMap<const Loop *, std::string> VerifyMap;
8316
8317 /// replaceSubString - Replaces all occurrences of From in Str with To.
8318 static void replaceSubString(std::string &Str, StringRef From, StringRef To) {
8319   size_t Pos = 0;
8320   while ((Pos = Str.find(From, Pos)) != std::string::npos) {
8321     Str.replace(Pos, From.size(), To.data(), To.size());
8322     Pos += To.size();
8323   }
8324 }
8325
8326 /// getLoopBackedgeTakenCounts - Helper method for verifyAnalysis.
8327 static void
8328 getLoopBackedgeTakenCounts(Loop *L, VerifyMap &Map, ScalarEvolution &SE) {
8329   for (Loop::reverse_iterator I = L->rbegin(), E = L->rend(); I != E; ++I) {
8330     getLoopBackedgeTakenCounts(*I, Map, SE); // recurse.
8331
8332     std::string &S = Map[L];
8333     if (S.empty()) {
8334       raw_string_ostream OS(S);
8335       SE.getBackedgeTakenCount(L)->print(OS);
8336
8337       // false and 0 are semantically equivalent. This can happen in dead loops.
8338       replaceSubString(OS.str(), "false", "0");
8339       // Remove wrap flags, their use in SCEV is highly fragile.
8340       // FIXME: Remove this when SCEV gets smarter about them.
8341       replaceSubString(OS.str(), "<nw>", "");
8342       replaceSubString(OS.str(), "<nsw>", "");
8343       replaceSubString(OS.str(), "<nuw>", "");
8344     }
8345   }
8346 }
8347
8348 void ScalarEvolution::verifyAnalysis() const {
8349   if (!VerifySCEV)
8350     return;
8351
8352   ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
8353
8354   // Gather stringified backedge taken counts for all loops using SCEV's caches.
8355   // FIXME: It would be much better to store actual values instead of strings,
8356   //        but SCEV pointers will change if we drop the caches.
8357   VerifyMap BackedgeDumpsOld, BackedgeDumpsNew;
8358   for (LoopInfo::reverse_iterator I = LI->rbegin(), E = LI->rend(); I != E; ++I)
8359     getLoopBackedgeTakenCounts(*I, BackedgeDumpsOld, SE);
8360
8361   // Gather stringified backedge taken counts for all loops without using
8362   // SCEV's caches.
8363   SE.releaseMemory();
8364   for (LoopInfo::reverse_iterator I = LI->rbegin(), E = LI->rend(); I != E; ++I)
8365     getLoopBackedgeTakenCounts(*I, BackedgeDumpsNew, SE);
8366
8367   // Now compare whether they're the same with and without caches. This allows
8368   // verifying that no pass changed the cache.
8369   assert(BackedgeDumpsOld.size() == BackedgeDumpsNew.size() &&
8370          "New loops suddenly appeared!");
8371
8372   for (VerifyMap::iterator OldI = BackedgeDumpsOld.begin(),
8373                            OldE = BackedgeDumpsOld.end(),
8374                            NewI = BackedgeDumpsNew.begin();
8375        OldI != OldE; ++OldI, ++NewI) {
8376     assert(OldI->first == NewI->first && "Loop order changed!");
8377
8378     // Compare the stringified SCEVs. We don't care if undef backedgetaken count
8379     // changes.
8380     // FIXME: We currently ignore SCEV changes from/to CouldNotCompute. This
8381     // means that a pass is buggy or SCEV has to learn a new pattern but is
8382     // usually not harmful.
8383     if (OldI->second != NewI->second &&
8384         OldI->second.find("undef") == std::string::npos &&
8385         NewI->second.find("undef") == std::string::npos &&
8386         OldI->second != "***COULDNOTCOMPUTE***" &&
8387         NewI->second != "***COULDNOTCOMPUTE***") {
8388       dbgs() << "SCEVValidator: SCEV for loop '"
8389              << OldI->first->getHeader()->getName()
8390              << "' changed from '" << OldI->second
8391              << "' to '" << NewI->second << "'!\n";
8392       std::abort();
8393     }
8394   }
8395
8396   // TODO: Verify more things.
8397 }