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