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 (const SCEV *Op : AddRec->operands())
1136       Operands.push_back(getTruncateExpr(Op, 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 (const SCEV *Op : AR->operands())
2642               Operands.push_back(getUDivExpr(Op, RHS));
2643             return getAddRecExpr(Operands, AR->getLoop(), SCEV::FlagNW);
2644           }
2645           /// Get a canonical UDivExpr for a recurrence.
2646           /// {X,+,N}/C => {Y,+,N}/C where Y=X-(X%N). Safe when C%N=0.
2647           // We can currently only fold X%N if X is constant.
2648           const SCEVConstant *StartC = dyn_cast<SCEVConstant>(AR->getStart());
2649           if (StartC && !DivInt.urem(StepInt) &&
2650               getZeroExtendExpr(AR, ExtTy) ==
2651               getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy),
2652                             getZeroExtendExpr(Step, ExtTy),
2653                             AR->getLoop(), SCEV::FlagAnyWrap)) {
2654             const APInt &StartInt = StartC->getValue()->getValue();
2655             const APInt &StartRem = StartInt.urem(StepInt);
2656             if (StartRem != 0)
2657               LHS = getAddRecExpr(getConstant(StartInt - StartRem), Step,
2658                                   AR->getLoop(), SCEV::FlagNW);
2659           }
2660         }
2661       // (A*B)/C --> A*(B/C) if safe and B/C can be folded.
2662       if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(LHS)) {
2663         SmallVector<const SCEV *, 4> Operands;
2664         for (const SCEV *Op : M->operands())
2665           Operands.push_back(getZeroExtendExpr(Op, ExtTy));
2666         if (getZeroExtendExpr(M, ExtTy) == getMulExpr(Operands))
2667           // Find an operand that's safely divisible.
2668           for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i) {
2669             const SCEV *Op = M->getOperand(i);
2670             const SCEV *Div = getUDivExpr(Op, RHSC);
2671             if (!isa<SCEVUDivExpr>(Div) && getMulExpr(Div, RHSC) == Op) {
2672               Operands = SmallVector<const SCEV *, 4>(M->op_begin(),
2673                                                       M->op_end());
2674               Operands[i] = Div;
2675               return getMulExpr(Operands);
2676             }
2677           }
2678       }
2679       // (A+B)/C --> (A/C + B/C) if safe and A/C and B/C can be folded.
2680       if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(LHS)) {
2681         SmallVector<const SCEV *, 4> Operands;
2682         for (const SCEV *Op : A->operands())
2683           Operands.push_back(getZeroExtendExpr(Op, ExtTy));
2684         if (getZeroExtendExpr(A, ExtTy) == getAddExpr(Operands)) {
2685           Operands.clear();
2686           for (unsigned i = 0, e = A->getNumOperands(); i != e; ++i) {
2687             const SCEV *Op = getUDivExpr(A->getOperand(i), RHS);
2688             if (isa<SCEVUDivExpr>(Op) ||
2689                 getMulExpr(Op, RHS) != A->getOperand(i))
2690               break;
2691             Operands.push_back(Op);
2692           }
2693           if (Operands.size() == A->getNumOperands())
2694             return getAddExpr(Operands);
2695         }
2696       }
2697
2698       // Fold if both operands are constant.
2699       if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
2700         Constant *LHSCV = LHSC->getValue();
2701         Constant *RHSCV = RHSC->getValue();
2702         return getConstant(cast<ConstantInt>(ConstantExpr::getUDiv(LHSCV,
2703                                                                    RHSCV)));
2704       }
2705     }
2706   }
2707
2708   FoldingSetNodeID ID;
2709   ID.AddInteger(scUDivExpr);
2710   ID.AddPointer(LHS);
2711   ID.AddPointer(RHS);
2712   void *IP = nullptr;
2713   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
2714   SCEV *S = new (SCEVAllocator) SCEVUDivExpr(ID.Intern(SCEVAllocator),
2715                                              LHS, RHS);
2716   UniqueSCEVs.InsertNode(S, IP);
2717   return S;
2718 }
2719
2720 static const APInt gcd(const SCEVConstant *C1, const SCEVConstant *C2) {
2721   APInt A = C1->getValue()->getValue().abs();
2722   APInt B = C2->getValue()->getValue().abs();
2723   uint32_t ABW = A.getBitWidth();
2724   uint32_t BBW = B.getBitWidth();
2725
2726   if (ABW > BBW)
2727     B = B.zext(ABW);
2728   else if (ABW < BBW)
2729     A = A.zext(BBW);
2730
2731   return APIntOps::GreatestCommonDivisor(A, B);
2732 }
2733
2734 /// getUDivExactExpr - Get a canonical unsigned division expression, or
2735 /// something simpler if possible. There is no representation for an exact udiv
2736 /// in SCEV IR, but we can attempt to remove factors from the LHS and RHS.
2737 /// We can't do this when it's not exact because the udiv may be clearing bits.
2738 const SCEV *ScalarEvolution::getUDivExactExpr(const SCEV *LHS,
2739                                               const SCEV *RHS) {
2740   // TODO: we could try to find factors in all sorts of things, but for now we
2741   // just deal with u/exact (multiply, constant). See SCEVDivision towards the
2742   // end of this file for inspiration.
2743
2744   const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(LHS);
2745   if (!Mul)
2746     return getUDivExpr(LHS, RHS);
2747
2748   if (const SCEVConstant *RHSCst = dyn_cast<SCEVConstant>(RHS)) {
2749     // If the mulexpr multiplies by a constant, then that constant must be the
2750     // first element of the mulexpr.
2751     if (const SCEVConstant *LHSCst =
2752             dyn_cast<SCEVConstant>(Mul->getOperand(0))) {
2753       if (LHSCst == RHSCst) {
2754         SmallVector<const SCEV *, 2> Operands;
2755         Operands.append(Mul->op_begin() + 1, Mul->op_end());
2756         return getMulExpr(Operands);
2757       }
2758
2759       // We can't just assume that LHSCst divides RHSCst cleanly, it could be
2760       // that there's a factor provided by one of the other terms. We need to
2761       // check.
2762       APInt Factor = gcd(LHSCst, RHSCst);
2763       if (!Factor.isIntN(1)) {
2764         LHSCst = cast<SCEVConstant>(
2765             getConstant(LHSCst->getValue()->getValue().udiv(Factor)));
2766         RHSCst = cast<SCEVConstant>(
2767             getConstant(RHSCst->getValue()->getValue().udiv(Factor)));
2768         SmallVector<const SCEV *, 2> Operands;
2769         Operands.push_back(LHSCst);
2770         Operands.append(Mul->op_begin() + 1, Mul->op_end());
2771         LHS = getMulExpr(Operands);
2772         RHS = RHSCst;
2773         Mul = dyn_cast<SCEVMulExpr>(LHS);
2774         if (!Mul)
2775           return getUDivExactExpr(LHS, RHS);
2776       }
2777     }
2778   }
2779
2780   for (int i = 0, e = Mul->getNumOperands(); i != e; ++i) {
2781     if (Mul->getOperand(i) == RHS) {
2782       SmallVector<const SCEV *, 2> Operands;
2783       Operands.append(Mul->op_begin(), Mul->op_begin() + i);
2784       Operands.append(Mul->op_begin() + i + 1, Mul->op_end());
2785       return getMulExpr(Operands);
2786     }
2787   }
2788
2789   return getUDivExpr(LHS, RHS);
2790 }
2791
2792 /// getAddRecExpr - Get an add recurrence expression for the specified loop.
2793 /// Simplify the expression as much as possible.
2794 const SCEV *ScalarEvolution::getAddRecExpr(const SCEV *Start, const SCEV *Step,
2795                                            const Loop *L,
2796                                            SCEV::NoWrapFlags Flags) {
2797   SmallVector<const SCEV *, 4> Operands;
2798   Operands.push_back(Start);
2799   if (const SCEVAddRecExpr *StepChrec = dyn_cast<SCEVAddRecExpr>(Step))
2800     if (StepChrec->getLoop() == L) {
2801       Operands.append(StepChrec->op_begin(), StepChrec->op_end());
2802       return getAddRecExpr(Operands, L, maskFlags(Flags, SCEV::FlagNW));
2803     }
2804
2805   Operands.push_back(Step);
2806   return getAddRecExpr(Operands, L, Flags);
2807 }
2808
2809 /// getAddRecExpr - Get an add recurrence expression for the specified loop.
2810 /// Simplify the expression as much as possible.
2811 const SCEV *
2812 ScalarEvolution::getAddRecExpr(SmallVectorImpl<const SCEV *> &Operands,
2813                                const Loop *L, SCEV::NoWrapFlags Flags) {
2814   if (Operands.size() == 1) return Operands[0];
2815 #ifndef NDEBUG
2816   Type *ETy = getEffectiveSCEVType(Operands[0]->getType());
2817   for (unsigned i = 1, e = Operands.size(); i != e; ++i)
2818     assert(getEffectiveSCEVType(Operands[i]->getType()) == ETy &&
2819            "SCEVAddRecExpr operand types don't match!");
2820   for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2821     assert(isLoopInvariant(Operands[i], L) &&
2822            "SCEVAddRecExpr operand is not loop-invariant!");
2823 #endif
2824
2825   if (Operands.back()->isZero()) {
2826     Operands.pop_back();
2827     return getAddRecExpr(Operands, L, SCEV::FlagAnyWrap); // {X,+,0}  -->  X
2828   }
2829
2830   // It's tempting to want to call getMaxBackedgeTakenCount count here and
2831   // use that information to infer NUW and NSW flags. However, computing a
2832   // BE count requires calling getAddRecExpr, so we may not yet have a
2833   // meaningful BE count at this point (and if we don't, we'd be stuck
2834   // with a SCEVCouldNotCompute as the cached BE count).
2835
2836   Flags = StrengthenNoWrapFlags(this, scAddRecExpr, Operands, Flags);
2837
2838   // Canonicalize nested AddRecs in by nesting them in order of loop depth.
2839   if (const SCEVAddRecExpr *NestedAR = dyn_cast<SCEVAddRecExpr>(Operands[0])) {
2840     const Loop *NestedLoop = NestedAR->getLoop();
2841     if (L->contains(NestedLoop)
2842             ? (L->getLoopDepth() < NestedLoop->getLoopDepth())
2843             : (!NestedLoop->contains(L) &&
2844                DT.dominates(L->getHeader(), NestedLoop->getHeader()))) {
2845       SmallVector<const SCEV *, 4> NestedOperands(NestedAR->op_begin(),
2846                                                   NestedAR->op_end());
2847       Operands[0] = NestedAR->getStart();
2848       // AddRecs require their operands be loop-invariant with respect to their
2849       // loops. Don't perform this transformation if it would break this
2850       // requirement.
2851       bool AllInvariant = true;
2852       for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2853         if (!isLoopInvariant(Operands[i], L)) {
2854           AllInvariant = false;
2855           break;
2856         }
2857       if (AllInvariant) {
2858         // Create a recurrence for the outer loop with the same step size.
2859         //
2860         // The outer recurrence keeps its NW flag but only keeps NUW/NSW if the
2861         // inner recurrence has the same property.
2862         SCEV::NoWrapFlags OuterFlags =
2863           maskFlags(Flags, SCEV::FlagNW | NestedAR->getNoWrapFlags());
2864
2865         NestedOperands[0] = getAddRecExpr(Operands, L, OuterFlags);
2866         AllInvariant = true;
2867         for (unsigned i = 0, e = NestedOperands.size(); i != e; ++i)
2868           if (!isLoopInvariant(NestedOperands[i], NestedLoop)) {
2869             AllInvariant = false;
2870             break;
2871           }
2872         if (AllInvariant) {
2873           // Ok, both add recurrences are valid after the transformation.
2874           //
2875           // The inner recurrence keeps its NW flag but only keeps NUW/NSW if
2876           // the outer recurrence has the same property.
2877           SCEV::NoWrapFlags InnerFlags =
2878             maskFlags(NestedAR->getNoWrapFlags(), SCEV::FlagNW | Flags);
2879           return getAddRecExpr(NestedOperands, NestedLoop, InnerFlags);
2880         }
2881       }
2882       // Reset Operands to its original state.
2883       Operands[0] = NestedAR;
2884     }
2885   }
2886
2887   // Okay, it looks like we really DO need an addrec expr.  Check to see if we
2888   // already have one, otherwise create a new one.
2889   FoldingSetNodeID ID;
2890   ID.AddInteger(scAddRecExpr);
2891   for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2892     ID.AddPointer(Operands[i]);
2893   ID.AddPointer(L);
2894   void *IP = nullptr;
2895   SCEVAddRecExpr *S =
2896     static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
2897   if (!S) {
2898     const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Operands.size());
2899     std::uninitialized_copy(Operands.begin(), Operands.end(), O);
2900     S = new (SCEVAllocator) SCEVAddRecExpr(ID.Intern(SCEVAllocator),
2901                                            O, Operands.size(), L);
2902     UniqueSCEVs.InsertNode(S, IP);
2903   }
2904   S->setNoWrapFlags(Flags);
2905   return S;
2906 }
2907
2908 const SCEV *
2909 ScalarEvolution::getGEPExpr(Type *PointeeType, const SCEV *BaseExpr,
2910                             const SmallVectorImpl<const SCEV *> &IndexExprs,
2911                             bool InBounds) {
2912   // getSCEV(Base)->getType() has the same address space as Base->getType()
2913   // because SCEV::getType() preserves the address space.
2914   Type *IntPtrTy = getEffectiveSCEVType(BaseExpr->getType());
2915   // FIXME(PR23527): Don't blindly transfer the inbounds flag from the GEP
2916   // instruction to its SCEV, because the Instruction may be guarded by control
2917   // flow and the no-overflow bits may not be valid for the expression in any
2918   // context. This can be fixed similarly to how these flags are handled for
2919   // adds.
2920   SCEV::NoWrapFlags Wrap = InBounds ? SCEV::FlagNSW : SCEV::FlagAnyWrap;
2921
2922   const SCEV *TotalOffset = getZero(IntPtrTy);
2923   // The address space is unimportant. The first thing we do on CurTy is getting
2924   // its element type.
2925   Type *CurTy = PointerType::getUnqual(PointeeType);
2926   for (const SCEV *IndexExpr : IndexExprs) {
2927     // Compute the (potentially symbolic) offset in bytes for this index.
2928     if (StructType *STy = dyn_cast<StructType>(CurTy)) {
2929       // For a struct, add the member offset.
2930       ConstantInt *Index = cast<SCEVConstant>(IndexExpr)->getValue();
2931       unsigned FieldNo = Index->getZExtValue();
2932       const SCEV *FieldOffset = getOffsetOfExpr(IntPtrTy, STy, FieldNo);
2933
2934       // Add the field offset to the running total offset.
2935       TotalOffset = getAddExpr(TotalOffset, FieldOffset);
2936
2937       // Update CurTy to the type of the field at Index.
2938       CurTy = STy->getTypeAtIndex(Index);
2939     } else {
2940       // Update CurTy to its element type.
2941       CurTy = cast<SequentialType>(CurTy)->getElementType();
2942       // For an array, add the element offset, explicitly scaled.
2943       const SCEV *ElementSize = getSizeOfExpr(IntPtrTy, CurTy);
2944       // Getelementptr indices are signed.
2945       IndexExpr = getTruncateOrSignExtend(IndexExpr, IntPtrTy);
2946
2947       // Multiply the index by the element size to compute the element offset.
2948       const SCEV *LocalOffset = getMulExpr(IndexExpr, ElementSize, Wrap);
2949
2950       // Add the element offset to the running total offset.
2951       TotalOffset = getAddExpr(TotalOffset, LocalOffset);
2952     }
2953   }
2954
2955   // Add the total offset from all the GEP indices to the base.
2956   return getAddExpr(BaseExpr, TotalOffset, Wrap);
2957 }
2958
2959 const SCEV *ScalarEvolution::getSMaxExpr(const SCEV *LHS,
2960                                          const SCEV *RHS) {
2961   SmallVector<const SCEV *, 2> Ops;
2962   Ops.push_back(LHS);
2963   Ops.push_back(RHS);
2964   return getSMaxExpr(Ops);
2965 }
2966
2967 const SCEV *
2968 ScalarEvolution::getSMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
2969   assert(!Ops.empty() && "Cannot get empty smax!");
2970   if (Ops.size() == 1) return Ops[0];
2971 #ifndef NDEBUG
2972   Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
2973   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
2974     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
2975            "SCEVSMaxExpr operand types don't match!");
2976 #endif
2977
2978   // Sort by complexity, this groups all similar expression types together.
2979   GroupByComplexity(Ops, &LI);
2980
2981   // If there are any constants, fold them together.
2982   unsigned Idx = 0;
2983   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
2984     ++Idx;
2985     assert(Idx < Ops.size());
2986     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
2987       // We found two constants, fold them together!
2988       ConstantInt *Fold = ConstantInt::get(getContext(),
2989                               APIntOps::smax(LHSC->getValue()->getValue(),
2990                                              RHSC->getValue()->getValue()));
2991       Ops[0] = getConstant(Fold);
2992       Ops.erase(Ops.begin()+1);  // Erase the folded element
2993       if (Ops.size() == 1) return Ops[0];
2994       LHSC = cast<SCEVConstant>(Ops[0]);
2995     }
2996
2997     // If we are left with a constant minimum-int, strip it off.
2998     if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(true)) {
2999       Ops.erase(Ops.begin());
3000       --Idx;
3001     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(true)) {
3002       // If we have an smax with a constant maximum-int, it will always be
3003       // maximum-int.
3004       return Ops[0];
3005     }
3006
3007     if (Ops.size() == 1) return Ops[0];
3008   }
3009
3010   // Find the first SMax
3011   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scSMaxExpr)
3012     ++Idx;
3013
3014   // Check to see if one of the operands is an SMax. If so, expand its operands
3015   // onto our operand list, and recurse to simplify.
3016   if (Idx < Ops.size()) {
3017     bool DeletedSMax = false;
3018     while (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(Ops[Idx])) {
3019       Ops.erase(Ops.begin()+Idx);
3020       Ops.append(SMax->op_begin(), SMax->op_end());
3021       DeletedSMax = true;
3022     }
3023
3024     if (DeletedSMax)
3025       return getSMaxExpr(Ops);
3026   }
3027
3028   // Okay, check to see if the same value occurs in the operand list twice.  If
3029   // so, delete one.  Since we sorted the list, these values are required to
3030   // be adjacent.
3031   for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
3032     //  X smax Y smax Y  -->  X smax Y
3033     //  X smax Y         -->  X, if X is always greater than Y
3034     if (Ops[i] == Ops[i+1] ||
3035         isKnownPredicate(ICmpInst::ICMP_SGE, Ops[i], Ops[i+1])) {
3036       Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
3037       --i; --e;
3038     } else if (isKnownPredicate(ICmpInst::ICMP_SLE, Ops[i], Ops[i+1])) {
3039       Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
3040       --i; --e;
3041     }
3042
3043   if (Ops.size() == 1) return Ops[0];
3044
3045   assert(!Ops.empty() && "Reduced smax down to nothing!");
3046
3047   // Okay, it looks like we really DO need an smax expr.  Check to see if we
3048   // already have one, otherwise create a new one.
3049   FoldingSetNodeID ID;
3050   ID.AddInteger(scSMaxExpr);
3051   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
3052     ID.AddPointer(Ops[i]);
3053   void *IP = nullptr;
3054   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
3055   const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
3056   std::uninitialized_copy(Ops.begin(), Ops.end(), O);
3057   SCEV *S = new (SCEVAllocator) SCEVSMaxExpr(ID.Intern(SCEVAllocator),
3058                                              O, Ops.size());
3059   UniqueSCEVs.InsertNode(S, IP);
3060   return S;
3061 }
3062
3063 const SCEV *ScalarEvolution::getUMaxExpr(const SCEV *LHS,
3064                                          const SCEV *RHS) {
3065   SmallVector<const SCEV *, 2> Ops;
3066   Ops.push_back(LHS);
3067   Ops.push_back(RHS);
3068   return getUMaxExpr(Ops);
3069 }
3070
3071 const SCEV *
3072 ScalarEvolution::getUMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
3073   assert(!Ops.empty() && "Cannot get empty umax!");
3074   if (Ops.size() == 1) return Ops[0];
3075 #ifndef NDEBUG
3076   Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
3077   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
3078     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
3079            "SCEVUMaxExpr operand types don't match!");
3080 #endif
3081
3082   // Sort by complexity, this groups all similar expression types together.
3083   GroupByComplexity(Ops, &LI);
3084
3085   // If there are any constants, fold them together.
3086   unsigned Idx = 0;
3087   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
3088     ++Idx;
3089     assert(Idx < Ops.size());
3090     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
3091       // We found two constants, fold them together!
3092       ConstantInt *Fold = ConstantInt::get(getContext(),
3093                               APIntOps::umax(LHSC->getValue()->getValue(),
3094                                              RHSC->getValue()->getValue()));
3095       Ops[0] = getConstant(Fold);
3096       Ops.erase(Ops.begin()+1);  // Erase the folded element
3097       if (Ops.size() == 1) return Ops[0];
3098       LHSC = cast<SCEVConstant>(Ops[0]);
3099     }
3100
3101     // If we are left with a constant minimum-int, strip it off.
3102     if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(false)) {
3103       Ops.erase(Ops.begin());
3104       --Idx;
3105     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(false)) {
3106       // If we have an umax with a constant maximum-int, it will always be
3107       // maximum-int.
3108       return Ops[0];
3109     }
3110
3111     if (Ops.size() == 1) return Ops[0];
3112   }
3113
3114   // Find the first UMax
3115   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scUMaxExpr)
3116     ++Idx;
3117
3118   // Check to see if one of the operands is a UMax. If so, expand its operands
3119   // onto our operand list, and recurse to simplify.
3120   if (Idx < Ops.size()) {
3121     bool DeletedUMax = false;
3122     while (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(Ops[Idx])) {
3123       Ops.erase(Ops.begin()+Idx);
3124       Ops.append(UMax->op_begin(), UMax->op_end());
3125       DeletedUMax = true;
3126     }
3127
3128     if (DeletedUMax)
3129       return getUMaxExpr(Ops);
3130   }
3131
3132   // Okay, check to see if the same value occurs in the operand list twice.  If
3133   // so, delete one.  Since we sorted the list, these values are required to
3134   // be adjacent.
3135   for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
3136     //  X umax Y umax Y  -->  X umax Y
3137     //  X umax Y         -->  X, if X is always greater than Y
3138     if (Ops[i] == Ops[i+1] ||
3139         isKnownPredicate(ICmpInst::ICMP_UGE, Ops[i], Ops[i+1])) {
3140       Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
3141       --i; --e;
3142     } else if (isKnownPredicate(ICmpInst::ICMP_ULE, Ops[i], Ops[i+1])) {
3143       Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
3144       --i; --e;
3145     }
3146
3147   if (Ops.size() == 1) return Ops[0];
3148
3149   assert(!Ops.empty() && "Reduced umax down to nothing!");
3150
3151   // Okay, it looks like we really DO need a umax expr.  Check to see if we
3152   // already have one, otherwise create a new one.
3153   FoldingSetNodeID ID;
3154   ID.AddInteger(scUMaxExpr);
3155   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
3156     ID.AddPointer(Ops[i]);
3157   void *IP = nullptr;
3158   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
3159   const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
3160   std::uninitialized_copy(Ops.begin(), Ops.end(), O);
3161   SCEV *S = new (SCEVAllocator) SCEVUMaxExpr(ID.Intern(SCEVAllocator),
3162                                              O, Ops.size());
3163   UniqueSCEVs.InsertNode(S, IP);
3164   return S;
3165 }
3166
3167 const SCEV *ScalarEvolution::getSMinExpr(const SCEV *LHS,
3168                                          const SCEV *RHS) {
3169   // ~smax(~x, ~y) == smin(x, y).
3170   return getNotSCEV(getSMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
3171 }
3172
3173 const SCEV *ScalarEvolution::getUMinExpr(const SCEV *LHS,
3174                                          const SCEV *RHS) {
3175   // ~umax(~x, ~y) == umin(x, y)
3176   return getNotSCEV(getUMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
3177 }
3178
3179 const SCEV *ScalarEvolution::getSizeOfExpr(Type *IntTy, Type *AllocTy) {
3180   // We can bypass creating a target-independent
3181   // constant expression and then folding it back into a ConstantInt.
3182   // This is just a compile-time optimization.
3183   return getConstant(IntTy,
3184                      F.getParent()->getDataLayout().getTypeAllocSize(AllocTy));
3185 }
3186
3187 const SCEV *ScalarEvolution::getOffsetOfExpr(Type *IntTy,
3188                                              StructType *STy,
3189                                              unsigned FieldNo) {
3190   // We can bypass creating a target-independent
3191   // constant expression and then folding it back into a ConstantInt.
3192   // This is just a compile-time optimization.
3193   return getConstant(
3194       IntTy,
3195       F.getParent()->getDataLayout().getStructLayout(STy)->getElementOffset(
3196           FieldNo));
3197 }
3198
3199 const SCEV *ScalarEvolution::getUnknown(Value *V) {
3200   // Don't attempt to do anything other than create a SCEVUnknown object
3201   // here.  createSCEV only calls getUnknown after checking for all other
3202   // interesting possibilities, and any other code that calls getUnknown
3203   // is doing so in order to hide a value from SCEV canonicalization.
3204
3205   FoldingSetNodeID ID;
3206   ID.AddInteger(scUnknown);
3207   ID.AddPointer(V);
3208   void *IP = nullptr;
3209   if (SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) {
3210     assert(cast<SCEVUnknown>(S)->getValue() == V &&
3211            "Stale SCEVUnknown in uniquing map!");
3212     return S;
3213   }
3214   SCEV *S = new (SCEVAllocator) SCEVUnknown(ID.Intern(SCEVAllocator), V, this,
3215                                             FirstUnknown);
3216   FirstUnknown = cast<SCEVUnknown>(S);
3217   UniqueSCEVs.InsertNode(S, IP);
3218   return S;
3219 }
3220
3221 //===----------------------------------------------------------------------===//
3222 //            Basic SCEV Analysis and PHI Idiom Recognition Code
3223 //
3224
3225 /// isSCEVable - Test if values of the given type are analyzable within
3226 /// the SCEV framework. This primarily includes integer types, and it
3227 /// can optionally include pointer types if the ScalarEvolution class
3228 /// has access to target-specific information.
3229 bool ScalarEvolution::isSCEVable(Type *Ty) const {
3230   // Integers and pointers are always SCEVable.
3231   return Ty->isIntegerTy() || Ty->isPointerTy();
3232 }
3233
3234 /// getTypeSizeInBits - Return the size in bits of the specified type,
3235 /// for which isSCEVable must return true.
3236 uint64_t ScalarEvolution::getTypeSizeInBits(Type *Ty) const {
3237   assert(isSCEVable(Ty) && "Type is not SCEVable!");
3238   return F.getParent()->getDataLayout().getTypeSizeInBits(Ty);
3239 }
3240
3241 /// getEffectiveSCEVType - Return a type with the same bitwidth as
3242 /// the given type and which represents how SCEV will treat the given
3243 /// type, for which isSCEVable must return true. For pointer types,
3244 /// this is the pointer-sized integer type.
3245 Type *ScalarEvolution::getEffectiveSCEVType(Type *Ty) const {
3246   assert(isSCEVable(Ty) && "Type is not SCEVable!");
3247
3248   if (Ty->isIntegerTy()) {
3249     return Ty;
3250   }
3251
3252   // The only other support type is pointer.
3253   assert(Ty->isPointerTy() && "Unexpected non-pointer non-integer type!");
3254   return F.getParent()->getDataLayout().getIntPtrType(Ty);
3255 }
3256
3257 const SCEV *ScalarEvolution::getCouldNotCompute() {
3258   return CouldNotCompute.get();
3259 }
3260
3261 namespace {
3262   // Helper class working with SCEVTraversal to figure out if a SCEV contains
3263   // a SCEVUnknown with null value-pointer. FindInvalidSCEVUnknown::FindOne
3264   // is set iff if find such SCEVUnknown.
3265   //
3266   struct FindInvalidSCEVUnknown {
3267     bool FindOne;
3268     FindInvalidSCEVUnknown() { FindOne = false; }
3269     bool follow(const SCEV *S) {
3270       switch (static_cast<SCEVTypes>(S->getSCEVType())) {
3271       case scConstant:
3272         return false;
3273       case scUnknown:
3274         if (!cast<SCEVUnknown>(S)->getValue())
3275           FindOne = true;
3276         return false;
3277       default:
3278         return true;
3279       }
3280     }
3281     bool isDone() const { return FindOne; }
3282   };
3283 }
3284
3285 bool ScalarEvolution::checkValidity(const SCEV *S) const {
3286   FindInvalidSCEVUnknown F;
3287   SCEVTraversal<FindInvalidSCEVUnknown> ST(F);
3288   ST.visitAll(S);
3289
3290   return !F.FindOne;
3291 }
3292
3293 /// getSCEV - Return an existing SCEV if it exists, otherwise analyze the
3294 /// expression and create a new one.
3295 const SCEV *ScalarEvolution::getSCEV(Value *V) {
3296   assert(isSCEVable(V->getType()) && "Value is not SCEVable!");
3297
3298   const SCEV *S = getExistingSCEV(V);
3299   if (S == nullptr) {
3300     S = createSCEV(V);
3301     ValueExprMap.insert(std::make_pair(SCEVCallbackVH(V, this), S));
3302   }
3303   return S;
3304 }
3305
3306 const SCEV *ScalarEvolution::getExistingSCEV(Value *V) {
3307   assert(isSCEVable(V->getType()) && "Value is not SCEVable!");
3308
3309   ValueExprMapType::iterator I = ValueExprMap.find_as(V);
3310   if (I != ValueExprMap.end()) {
3311     const SCEV *S = I->second;
3312     if (checkValidity(S))
3313       return S;
3314     ValueExprMap.erase(I);
3315   }
3316   return nullptr;
3317 }
3318
3319 /// getNegativeSCEV - Return a SCEV corresponding to -V = -1*V
3320 ///
3321 const SCEV *ScalarEvolution::getNegativeSCEV(const SCEV *V,
3322                                              SCEV::NoWrapFlags Flags) {
3323   if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
3324     return getConstant(
3325                cast<ConstantInt>(ConstantExpr::getNeg(VC->getValue())));
3326
3327   Type *Ty = V->getType();
3328   Ty = getEffectiveSCEVType(Ty);
3329   return getMulExpr(
3330       V, getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty))), Flags);
3331 }
3332
3333 /// getNotSCEV - Return a SCEV corresponding to ~V = -1-V
3334 const SCEV *ScalarEvolution::getNotSCEV(const SCEV *V) {
3335   if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
3336     return getConstant(
3337                 cast<ConstantInt>(ConstantExpr::getNot(VC->getValue())));
3338
3339   Type *Ty = V->getType();
3340   Ty = getEffectiveSCEVType(Ty);
3341   const SCEV *AllOnes =
3342                    getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty)));
3343   return getMinusSCEV(AllOnes, V);
3344 }
3345
3346 /// getMinusSCEV - Return LHS-RHS.  Minus is represented in SCEV as A+B*-1.
3347 const SCEV *ScalarEvolution::getMinusSCEV(const SCEV *LHS, const SCEV *RHS,
3348                                           SCEV::NoWrapFlags Flags) {
3349   // Fast path: X - X --> 0.
3350   if (LHS == RHS)
3351     return getZero(LHS->getType());
3352
3353   // We represent LHS - RHS as LHS + (-1)*RHS. This transformation
3354   // makes it so that we cannot make much use of NUW.
3355   auto AddFlags = SCEV::FlagAnyWrap;
3356   const bool RHSIsNotMinSigned =
3357       !getSignedRange(RHS).getSignedMin().isMinSignedValue();
3358   if (maskFlags(Flags, SCEV::FlagNSW) == SCEV::FlagNSW) {
3359     // Let M be the minimum representable signed value. Then (-1)*RHS
3360     // signed-wraps if and only if RHS is M. That can happen even for
3361     // a NSW subtraction because e.g. (-1)*M signed-wraps even though
3362     // -1 - M does not. So to transfer NSW from LHS - RHS to LHS +
3363     // (-1)*RHS, we need to prove that RHS != M.
3364     //
3365     // If LHS is non-negative and we know that LHS - RHS does not
3366     // signed-wrap, then RHS cannot be M. So we can rule out signed-wrap
3367     // either by proving that RHS > M or that LHS >= 0.
3368     if (RHSIsNotMinSigned || isKnownNonNegative(LHS)) {
3369       AddFlags = SCEV::FlagNSW;
3370     }
3371   }
3372
3373   // FIXME: Find a correct way to transfer NSW to (-1)*M when LHS -
3374   // RHS is NSW and LHS >= 0.
3375   //
3376   // The difficulty here is that the NSW flag may have been proven
3377   // relative to a loop that is to be found in a recurrence in LHS and
3378   // not in RHS. Applying NSW to (-1)*M may then let the NSW have a
3379   // larger scope than intended.
3380   auto NegFlags = RHSIsNotMinSigned ? SCEV::FlagNSW : SCEV::FlagAnyWrap;
3381
3382   return getAddExpr(LHS, getNegativeSCEV(RHS, NegFlags), AddFlags);
3383 }
3384
3385 /// getTruncateOrZeroExtend - Return a SCEV corresponding to a conversion of the
3386 /// input value to the specified type.  If the type must be extended, it is zero
3387 /// extended.
3388 const SCEV *
3389 ScalarEvolution::getTruncateOrZeroExtend(const SCEV *V, Type *Ty) {
3390   Type *SrcTy = V->getType();
3391   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3392          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3393          "Cannot truncate or zero extend with non-integer arguments!");
3394   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3395     return V;  // No conversion
3396   if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
3397     return getTruncateExpr(V, Ty);
3398   return getZeroExtendExpr(V, Ty);
3399 }
3400
3401 /// getTruncateOrSignExtend - Return a SCEV corresponding to a conversion of the
3402 /// input value to the specified type.  If the type must be extended, it is sign
3403 /// extended.
3404 const SCEV *
3405 ScalarEvolution::getTruncateOrSignExtend(const SCEV *V,
3406                                          Type *Ty) {
3407   Type *SrcTy = V->getType();
3408   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3409          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3410          "Cannot truncate or zero extend with non-integer arguments!");
3411   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3412     return V;  // No conversion
3413   if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
3414     return getTruncateExpr(V, Ty);
3415   return getSignExtendExpr(V, Ty);
3416 }
3417
3418 /// getNoopOrZeroExtend - Return a SCEV corresponding to a conversion of the
3419 /// input value to the specified type.  If the type must be extended, it is zero
3420 /// extended.  The conversion must not be narrowing.
3421 const SCEV *
3422 ScalarEvolution::getNoopOrZeroExtend(const SCEV *V, Type *Ty) {
3423   Type *SrcTy = V->getType();
3424   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3425          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3426          "Cannot noop or zero extend with non-integer arguments!");
3427   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
3428          "getNoopOrZeroExtend cannot truncate!");
3429   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3430     return V;  // No conversion
3431   return getZeroExtendExpr(V, Ty);
3432 }
3433
3434 /// getNoopOrSignExtend - Return a SCEV corresponding to a conversion of the
3435 /// input value to the specified type.  If the type must be extended, it is sign
3436 /// extended.  The conversion must not be narrowing.
3437 const SCEV *
3438 ScalarEvolution::getNoopOrSignExtend(const SCEV *V, Type *Ty) {
3439   Type *SrcTy = V->getType();
3440   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3441          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3442          "Cannot noop or sign extend with non-integer arguments!");
3443   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
3444          "getNoopOrSignExtend cannot truncate!");
3445   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3446     return V;  // No conversion
3447   return getSignExtendExpr(V, Ty);
3448 }
3449
3450 /// getNoopOrAnyExtend - Return a SCEV corresponding to a conversion of
3451 /// the input value to the specified type. If the type must be extended,
3452 /// it is extended with unspecified bits. The conversion must not be
3453 /// narrowing.
3454 const SCEV *
3455 ScalarEvolution::getNoopOrAnyExtend(const SCEV *V, Type *Ty) {
3456   Type *SrcTy = V->getType();
3457   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3458          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3459          "Cannot noop or any extend with non-integer arguments!");
3460   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
3461          "getNoopOrAnyExtend cannot truncate!");
3462   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3463     return V;  // No conversion
3464   return getAnyExtendExpr(V, Ty);
3465 }
3466
3467 /// getTruncateOrNoop - Return a SCEV corresponding to a conversion of the
3468 /// input value to the specified type.  The conversion must not be widening.
3469 const SCEV *
3470 ScalarEvolution::getTruncateOrNoop(const SCEV *V, Type *Ty) {
3471   Type *SrcTy = V->getType();
3472   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
3473          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
3474          "Cannot truncate or noop with non-integer arguments!");
3475   assert(getTypeSizeInBits(SrcTy) >= getTypeSizeInBits(Ty) &&
3476          "getTruncateOrNoop cannot extend!");
3477   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
3478     return V;  // No conversion
3479   return getTruncateExpr(V, Ty);
3480 }
3481
3482 /// getUMaxFromMismatchedTypes - Promote the operands to the wider of
3483 /// the types using zero-extension, and then perform a umax operation
3484 /// with them.
3485 const SCEV *ScalarEvolution::getUMaxFromMismatchedTypes(const SCEV *LHS,
3486                                                         const SCEV *RHS) {
3487   const SCEV *PromotedLHS = LHS;
3488   const SCEV *PromotedRHS = RHS;
3489
3490   if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
3491     PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
3492   else
3493     PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
3494
3495   return getUMaxExpr(PromotedLHS, PromotedRHS);
3496 }
3497
3498 /// getUMinFromMismatchedTypes - Promote the operands to the wider of
3499 /// the types using zero-extension, and then perform a umin operation
3500 /// with them.
3501 const SCEV *ScalarEvolution::getUMinFromMismatchedTypes(const SCEV *LHS,
3502                                                         const SCEV *RHS) {
3503   const SCEV *PromotedLHS = LHS;
3504   const SCEV *PromotedRHS = RHS;
3505
3506   if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
3507     PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
3508   else
3509     PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
3510
3511   return getUMinExpr(PromotedLHS, PromotedRHS);
3512 }
3513
3514 /// getPointerBase - Transitively follow the chain of pointer-type operands
3515 /// until reaching a SCEV that does not have a single pointer operand. This
3516 /// returns a SCEVUnknown pointer for well-formed pointer-type expressions,
3517 /// but corner cases do exist.
3518 const SCEV *ScalarEvolution::getPointerBase(const SCEV *V) {
3519   // A pointer operand may evaluate to a nonpointer expression, such as null.
3520   if (!V->getType()->isPointerTy())
3521     return V;
3522
3523   if (const SCEVCastExpr *Cast = dyn_cast<SCEVCastExpr>(V)) {
3524     return getPointerBase(Cast->getOperand());
3525   }
3526   else if (const SCEVNAryExpr *NAry = dyn_cast<SCEVNAryExpr>(V)) {
3527     const SCEV *PtrOp = nullptr;
3528     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
3529          I != E; ++I) {
3530       if ((*I)->getType()->isPointerTy()) {
3531         // Cannot find the base of an expression with multiple pointer operands.
3532         if (PtrOp)
3533           return V;
3534         PtrOp = *I;
3535       }
3536     }
3537     if (!PtrOp)
3538       return V;
3539     return getPointerBase(PtrOp);
3540   }
3541   return V;
3542 }
3543
3544 /// PushDefUseChildren - Push users of the given Instruction
3545 /// onto the given Worklist.
3546 static void
3547 PushDefUseChildren(Instruction *I,
3548                    SmallVectorImpl<Instruction *> &Worklist) {
3549   // Push the def-use children onto the Worklist stack.
3550   for (User *U : I->users())
3551     Worklist.push_back(cast<Instruction>(U));
3552 }
3553
3554 /// ForgetSymbolicValue - This looks up computed SCEV values for all
3555 /// instructions that depend on the given instruction and removes them from
3556 /// the ValueExprMapType map if they reference SymName. This is used during PHI
3557 /// resolution.
3558 void
3559 ScalarEvolution::ForgetSymbolicName(Instruction *PN, const SCEV *SymName) {
3560   SmallVector<Instruction *, 16> Worklist;
3561   PushDefUseChildren(PN, Worklist);
3562
3563   SmallPtrSet<Instruction *, 8> Visited;
3564   Visited.insert(PN);
3565   while (!Worklist.empty()) {
3566     Instruction *I = Worklist.pop_back_val();
3567     if (!Visited.insert(I).second)
3568       continue;
3569
3570     ValueExprMapType::iterator It =
3571       ValueExprMap.find_as(static_cast<Value *>(I));
3572     if (It != ValueExprMap.end()) {
3573       const SCEV *Old = It->second;
3574
3575       // Short-circuit the def-use traversal if the symbolic name
3576       // ceases to appear in expressions.
3577       if (Old != SymName && !hasOperand(Old, SymName))
3578         continue;
3579
3580       // SCEVUnknown for a PHI either means that it has an unrecognized
3581       // structure, it's a PHI that's in the progress of being computed
3582       // by createNodeForPHI, or it's a single-value PHI. In the first case,
3583       // additional loop trip count information isn't going to change anything.
3584       // In the second case, createNodeForPHI will perform the necessary
3585       // updates on its own when it gets to that point. In the third, we do
3586       // want to forget the SCEVUnknown.
3587       if (!isa<PHINode>(I) ||
3588           !isa<SCEVUnknown>(Old) ||
3589           (I != PN && Old == SymName)) {
3590         forgetMemoizedResults(Old);
3591         ValueExprMap.erase(It);
3592       }
3593     }
3594
3595     PushDefUseChildren(I, Worklist);
3596   }
3597 }
3598
3599 const SCEV *ScalarEvolution::createAddRecFromPHI(PHINode *PN) {
3600   const Loop *L = LI.getLoopFor(PN->getParent());
3601   if (!L || L->getHeader() != PN->getParent())
3602     return nullptr;
3603
3604   // The loop may have multiple entrances or multiple exits; we can analyze
3605   // this phi as an addrec if it has a unique entry value and a unique
3606   // backedge value.
3607   Value *BEValueV = nullptr, *StartValueV = nullptr;
3608   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
3609     Value *V = PN->getIncomingValue(i);
3610     if (L->contains(PN->getIncomingBlock(i))) {
3611       if (!BEValueV) {
3612         BEValueV = V;
3613       } else if (BEValueV != V) {
3614         BEValueV = nullptr;
3615         break;
3616       }
3617     } else if (!StartValueV) {
3618       StartValueV = V;
3619     } else if (StartValueV != V) {
3620       StartValueV = nullptr;
3621       break;
3622     }
3623   }
3624   if (BEValueV && StartValueV) {
3625     // While we are analyzing this PHI node, handle its value symbolically.
3626     const SCEV *SymbolicName = getUnknown(PN);
3627     assert(ValueExprMap.find_as(PN) == ValueExprMap.end() &&
3628            "PHI node already processed?");
3629     ValueExprMap.insert(std::make_pair(SCEVCallbackVH(PN, this), SymbolicName));
3630
3631     // Using this symbolic name for the PHI, analyze the value coming around
3632     // the back-edge.
3633     const SCEV *BEValue = getSCEV(BEValueV);
3634
3635     // NOTE: If BEValue is loop invariant, we know that the PHI node just
3636     // has a special value for the first iteration of the loop.
3637
3638     // If the value coming around the backedge is an add with the symbolic
3639     // value we just inserted, then we found a simple induction variable!
3640     if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(BEValue)) {
3641       // If there is a single occurrence of the symbolic value, replace it
3642       // with a recurrence.
3643       unsigned FoundIndex = Add->getNumOperands();
3644       for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
3645         if (Add->getOperand(i) == SymbolicName)
3646           if (FoundIndex == e) {
3647             FoundIndex = i;
3648             break;
3649           }
3650
3651       if (FoundIndex != Add->getNumOperands()) {
3652         // Create an add with everything but the specified operand.
3653         SmallVector<const SCEV *, 8> Ops;
3654         for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
3655           if (i != FoundIndex)
3656             Ops.push_back(Add->getOperand(i));
3657         const SCEV *Accum = getAddExpr(Ops);
3658
3659         // This is not a valid addrec if the step amount is varying each
3660         // loop iteration, but is not itself an addrec in this loop.
3661         if (isLoopInvariant(Accum, L) ||
3662             (isa<SCEVAddRecExpr>(Accum) &&
3663              cast<SCEVAddRecExpr>(Accum)->getLoop() == L)) {
3664           SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap;
3665
3666           // If the increment doesn't overflow, then neither the addrec nor
3667           // the post-increment will overflow.
3668           if (const AddOperator *OBO = dyn_cast<AddOperator>(BEValueV)) {
3669             if (OBO->getOperand(0) == PN) {
3670               if (OBO->hasNoUnsignedWrap())
3671                 Flags = setFlags(Flags, SCEV::FlagNUW);
3672               if (OBO->hasNoSignedWrap())
3673                 Flags = setFlags(Flags, SCEV::FlagNSW);
3674             }
3675           } else if (GEPOperator *GEP = dyn_cast<GEPOperator>(BEValueV)) {
3676             // If the increment is an inbounds GEP, then we know the address
3677             // space cannot be wrapped around. We cannot make any guarantee
3678             // about signed or unsigned overflow because pointers are
3679             // unsigned but we may have a negative index from the base
3680             // pointer. We can guarantee that no unsigned wrap occurs if the
3681             // indices form a positive value.
3682             if (GEP->isInBounds() && GEP->getOperand(0) == PN) {
3683               Flags = setFlags(Flags, SCEV::FlagNW);
3684
3685               const SCEV *Ptr = getSCEV(GEP->getPointerOperand());
3686               if (isKnownPositive(getMinusSCEV(getSCEV(GEP), Ptr)))
3687                 Flags = setFlags(Flags, SCEV::FlagNUW);
3688             }
3689
3690             // We cannot transfer nuw and nsw flags from subtraction
3691             // operations -- sub nuw X, Y is not the same as add nuw X, -Y
3692             // for instance.
3693           }
3694
3695           const SCEV *StartVal = getSCEV(StartValueV);
3696           const SCEV *PHISCEV = getAddRecExpr(StartVal, Accum, L, Flags);
3697
3698           // Since the no-wrap flags are on the increment, they apply to the
3699           // post-incremented value as well.
3700           if (isLoopInvariant(Accum, L))
3701             (void)getAddRecExpr(getAddExpr(StartVal, Accum), Accum, L, Flags);
3702
3703           // Okay, for the entire analysis of this edge we assumed the PHI
3704           // to be symbolic.  We now need to go back and purge all of the
3705           // entries for the scalars that use the symbolic expression.
3706           ForgetSymbolicName(PN, SymbolicName);
3707           ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
3708           return PHISCEV;
3709         }
3710       }
3711     } else if (const SCEVAddRecExpr *AddRec =
3712                    dyn_cast<SCEVAddRecExpr>(BEValue)) {
3713       // Otherwise, this could be a loop like this:
3714       //     i = 0;  for (j = 1; ..; ++j) { ....  i = j; }
3715       // In this case, j = {1,+,1}  and BEValue is j.
3716       // Because the other in-value of i (0) fits the evolution of BEValue
3717       // i really is an addrec evolution.
3718       if (AddRec->getLoop() == L && AddRec->isAffine()) {
3719         const SCEV *StartVal = getSCEV(StartValueV);
3720
3721         // If StartVal = j.start - j.stride, we can use StartVal as the
3722         // initial step of the addrec evolution.
3723         if (StartVal ==
3724             getMinusSCEV(AddRec->getOperand(0), AddRec->getOperand(1))) {
3725           // FIXME: For constant StartVal, we should be able to infer
3726           // no-wrap flags.
3727           const SCEV *PHISCEV = getAddRecExpr(StartVal, AddRec->getOperand(1),
3728                                               L, SCEV::FlagAnyWrap);
3729
3730           // Okay, for the entire analysis of this edge we assumed the PHI
3731           // to be symbolic.  We now need to go back and purge all of the
3732           // entries for the scalars that use the symbolic expression.
3733           ForgetSymbolicName(PN, SymbolicName);
3734           ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
3735           return PHISCEV;
3736         }
3737       }
3738     }
3739   }
3740
3741   return nullptr;
3742 }
3743
3744 // Checks if the SCEV S is available at BB.  S is considered available at BB
3745 // if S can be materialized at BB without introducing a fault.
3746 static bool IsAvailableOnEntry(const Loop *L, DominatorTree &DT, const SCEV *S,
3747                                BasicBlock *BB) {
3748   struct CheckAvailable {
3749     bool TraversalDone = false;
3750     bool Available = true;
3751
3752     const Loop *L = nullptr;  // The loop BB is in (can be nullptr)
3753     BasicBlock *BB = nullptr;
3754     DominatorTree &DT;
3755
3756     CheckAvailable(const Loop *L, BasicBlock *BB, DominatorTree &DT)
3757       : L(L), BB(BB), DT(DT) {}
3758
3759     bool setUnavailable() {
3760       TraversalDone = true;
3761       Available = false;
3762       return false;
3763     }
3764
3765     bool follow(const SCEV *S) {
3766       switch (S->getSCEVType()) {
3767       case scConstant: case scTruncate: case scZeroExtend: case scSignExtend:
3768       case scAddExpr: case scMulExpr: case scUMaxExpr: case scSMaxExpr:
3769       // These expressions are available if their operand(s) is/are.
3770       return true;
3771
3772       case scAddRecExpr: {
3773         // We allow add recurrences that are on the loop BB is in, or some
3774         // outer loop.  This guarantees availability because the value of the
3775         // add recurrence at BB is simply the "current" value of the induction
3776         // variable.  We can relax this in the future; for instance an add
3777         // recurrence on a sibling dominating loop is also available at BB.
3778         const auto *ARLoop = cast<SCEVAddRecExpr>(S)->getLoop();
3779         if (L && (ARLoop == L || ARLoop->contains(L)))
3780           return true;
3781
3782         return setUnavailable();
3783       }
3784
3785       case scUnknown: {
3786         // For SCEVUnknown, we check for simple dominance.
3787         const auto *SU = cast<SCEVUnknown>(S);
3788         Value *V = SU->getValue();
3789
3790         if (isa<Argument>(V))
3791           return false;
3792
3793         if (isa<Instruction>(V) && DT.dominates(cast<Instruction>(V), BB))
3794           return false;
3795
3796         return setUnavailable();
3797       }
3798
3799       case scUDivExpr:
3800       case scCouldNotCompute:
3801       // We do not try to smart about these at all.
3802       return setUnavailable();
3803       }
3804       llvm_unreachable("switch should be fully covered!");
3805     }
3806
3807     bool isDone() { return TraversalDone; }
3808   };
3809
3810   CheckAvailable CA(L, BB, DT);
3811   SCEVTraversal<CheckAvailable> ST(CA);
3812
3813   ST.visitAll(S);
3814   return CA.Available;
3815 }
3816
3817 // Try to match a control flow sequence that branches out at BI and merges back
3818 // at Merge into a "C ? LHS : RHS" select pattern.  Return true on a successful
3819 // match.
3820 static bool BrPHIToSelect(DominatorTree &DT, BranchInst *BI, PHINode *Merge,
3821                           Value *&C, Value *&LHS, Value *&RHS) {
3822   C = BI->getCondition();
3823
3824   BasicBlockEdge LeftEdge(BI->getParent(), BI->getSuccessor(0));
3825   BasicBlockEdge RightEdge(BI->getParent(), BI->getSuccessor(1));
3826
3827   if (!LeftEdge.isSingleEdge())
3828     return false;
3829
3830   assert(RightEdge.isSingleEdge() && "Follows from LeftEdge.isSingleEdge()");
3831
3832   Use &LeftUse = Merge->getOperandUse(0);
3833   Use &RightUse = Merge->getOperandUse(1);
3834
3835   if (DT.dominates(LeftEdge, LeftUse) && DT.dominates(RightEdge, RightUse)) {
3836     LHS = LeftUse;
3837     RHS = RightUse;
3838     return true;
3839   }
3840
3841   if (DT.dominates(LeftEdge, RightUse) && DT.dominates(RightEdge, LeftUse)) {
3842     LHS = RightUse;
3843     RHS = LeftUse;
3844     return true;
3845   }
3846
3847   return false;
3848 }
3849
3850 const SCEV *ScalarEvolution::createNodeFromSelectLikePHI(PHINode *PN) {
3851   if (PN->getNumIncomingValues() == 2) {
3852     const Loop *L = LI.getLoopFor(PN->getParent());
3853
3854     // Try to match
3855     //
3856     //  br %cond, label %left, label %right
3857     // left:
3858     //  br label %merge
3859     // right:
3860     //  br label %merge
3861     // merge:
3862     //  V = phi [ %x, %left ], [ %y, %right ]
3863     //
3864     // as "select %cond, %x, %y"
3865
3866     BasicBlock *IDom = DT[PN->getParent()]->getIDom()->getBlock();
3867     assert(IDom && "At least the entry block should dominate PN");
3868
3869     auto *BI = dyn_cast<BranchInst>(IDom->getTerminator());
3870     Value *Cond = nullptr, *LHS = nullptr, *RHS = nullptr;
3871
3872     if (BI && BI->isConditional() &&
3873         BrPHIToSelect(DT, BI, PN, Cond, LHS, RHS) &&
3874         IsAvailableOnEntry(L, DT, getSCEV(LHS), PN->getParent()) &&
3875         IsAvailableOnEntry(L, DT, getSCEV(RHS), PN->getParent()))
3876       return createNodeForSelectOrPHI(PN, Cond, LHS, RHS);
3877   }
3878
3879   return nullptr;
3880 }
3881
3882 const SCEV *ScalarEvolution::createNodeForPHI(PHINode *PN) {
3883   if (const SCEV *S = createAddRecFromPHI(PN))
3884     return S;
3885
3886   if (const SCEV *S = createNodeFromSelectLikePHI(PN))
3887     return S;
3888
3889   // If the PHI has a single incoming value, follow that value, unless the
3890   // PHI's incoming blocks are in a different loop, in which case doing so
3891   // risks breaking LCSSA form. Instcombine would normally zap these, but
3892   // it doesn't have DominatorTree information, so it may miss cases.
3893   if (Value *V = SimplifyInstruction(PN, F.getParent()->getDataLayout(), &TLI,
3894                                      &DT, &AC))
3895     if (LI.replacementPreservesLCSSAForm(PN, V))
3896       return getSCEV(V);
3897
3898   // If it's not a loop phi, we can't handle it yet.
3899   return getUnknown(PN);
3900 }
3901
3902 const SCEV *ScalarEvolution::createNodeForSelectOrPHI(Instruction *I,
3903                                                       Value *Cond,
3904                                                       Value *TrueVal,
3905                                                       Value *FalseVal) {
3906   // Handle "constant" branch or select. This can occur for instance when a
3907   // loop pass transforms an inner loop and moves on to process the outer loop.
3908   if (auto *CI = dyn_cast<ConstantInt>(Cond))
3909     return getSCEV(CI->isOne() ? TrueVal : FalseVal);
3910
3911   // Try to match some simple smax or umax patterns.
3912   auto *ICI = dyn_cast<ICmpInst>(Cond);
3913   if (!ICI)
3914     return getUnknown(I);
3915
3916   Value *LHS = ICI->getOperand(0);
3917   Value *RHS = ICI->getOperand(1);
3918
3919   switch (ICI->getPredicate()) {
3920   case ICmpInst::ICMP_SLT:
3921   case ICmpInst::ICMP_SLE:
3922     std::swap(LHS, RHS);
3923   // fall through
3924   case ICmpInst::ICMP_SGT:
3925   case ICmpInst::ICMP_SGE:
3926     // a >s b ? a+x : b+x  ->  smax(a, b)+x
3927     // a >s b ? b+x : a+x  ->  smin(a, b)+x
3928     if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType())) {
3929       const SCEV *LS = getNoopOrSignExtend(getSCEV(LHS), I->getType());
3930       const SCEV *RS = getNoopOrSignExtend(getSCEV(RHS), I->getType());
3931       const SCEV *LA = getSCEV(TrueVal);
3932       const SCEV *RA = getSCEV(FalseVal);
3933       const SCEV *LDiff = getMinusSCEV(LA, LS);
3934       const SCEV *RDiff = getMinusSCEV(RA, RS);
3935       if (LDiff == RDiff)
3936         return getAddExpr(getSMaxExpr(LS, RS), LDiff);
3937       LDiff = getMinusSCEV(LA, RS);
3938       RDiff = getMinusSCEV(RA, LS);
3939       if (LDiff == RDiff)
3940         return getAddExpr(getSMinExpr(LS, RS), LDiff);
3941     }
3942     break;
3943   case ICmpInst::ICMP_ULT:
3944   case ICmpInst::ICMP_ULE:
3945     std::swap(LHS, RHS);
3946   // fall through
3947   case ICmpInst::ICMP_UGT:
3948   case ICmpInst::ICMP_UGE:
3949     // a >u b ? a+x : b+x  ->  umax(a, b)+x
3950     // a >u b ? b+x : a+x  ->  umin(a, b)+x
3951     if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType())) {
3952       const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), I->getType());
3953       const SCEV *RS = getNoopOrZeroExtend(getSCEV(RHS), I->getType());
3954       const SCEV *LA = getSCEV(TrueVal);
3955       const SCEV *RA = getSCEV(FalseVal);
3956       const SCEV *LDiff = getMinusSCEV(LA, LS);
3957       const SCEV *RDiff = getMinusSCEV(RA, RS);
3958       if (LDiff == RDiff)
3959         return getAddExpr(getUMaxExpr(LS, RS), LDiff);
3960       LDiff = getMinusSCEV(LA, RS);
3961       RDiff = getMinusSCEV(RA, LS);
3962       if (LDiff == RDiff)
3963         return getAddExpr(getUMinExpr(LS, RS), LDiff);
3964     }
3965     break;
3966   case ICmpInst::ICMP_NE:
3967     // n != 0 ? n+x : 1+x  ->  umax(n, 1)+x
3968     if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType()) &&
3969         isa<ConstantInt>(RHS) && cast<ConstantInt>(RHS)->isZero()) {
3970       const SCEV *One = getOne(I->getType());
3971       const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), I->getType());
3972       const SCEV *LA = getSCEV(TrueVal);
3973       const SCEV *RA = getSCEV(FalseVal);
3974       const SCEV *LDiff = getMinusSCEV(LA, LS);
3975       const SCEV *RDiff = getMinusSCEV(RA, One);
3976       if (LDiff == RDiff)
3977         return getAddExpr(getUMaxExpr(One, LS), LDiff);
3978     }
3979     break;
3980   case ICmpInst::ICMP_EQ:
3981     // n == 0 ? 1+x : n+x  ->  umax(n, 1)+x
3982     if (getTypeSizeInBits(LHS->getType()) <= getTypeSizeInBits(I->getType()) &&
3983         isa<ConstantInt>(RHS) && cast<ConstantInt>(RHS)->isZero()) {
3984       const SCEV *One = getOne(I->getType());
3985       const SCEV *LS = getNoopOrZeroExtend(getSCEV(LHS), I->getType());
3986       const SCEV *LA = getSCEV(TrueVal);
3987       const SCEV *RA = getSCEV(FalseVal);
3988       const SCEV *LDiff = getMinusSCEV(LA, One);
3989       const SCEV *RDiff = getMinusSCEV(RA, LS);
3990       if (LDiff == RDiff)
3991         return getAddExpr(getUMaxExpr(One, LS), LDiff);
3992     }
3993     break;
3994   default:
3995     break;
3996   }
3997
3998   return getUnknown(I);
3999 }
4000
4001 /// createNodeForGEP - Expand GEP instructions into add and multiply
4002 /// operations. This allows them to be analyzed by regular SCEV code.
4003 ///
4004 const SCEV *ScalarEvolution::createNodeForGEP(GEPOperator *GEP) {
4005   Value *Base = GEP->getOperand(0);
4006   // Don't attempt to analyze GEPs over unsized objects.
4007   if (!Base->getType()->getPointerElementType()->isSized())
4008     return getUnknown(GEP);
4009
4010   SmallVector<const SCEV *, 4> IndexExprs;
4011   for (auto Index = GEP->idx_begin(); Index != GEP->idx_end(); ++Index)
4012     IndexExprs.push_back(getSCEV(*Index));
4013   return getGEPExpr(GEP->getSourceElementType(), getSCEV(Base), IndexExprs,
4014                     GEP->isInBounds());
4015 }
4016
4017 /// GetMinTrailingZeros - Determine the minimum number of zero bits that S is
4018 /// guaranteed to end in (at every loop iteration).  It is, at the same time,
4019 /// the minimum number of times S is divisible by 2.  For example, given {4,+,8}
4020 /// it returns 2.  If S is guaranteed to be 0, it returns the bitwidth of S.
4021 uint32_t
4022 ScalarEvolution::GetMinTrailingZeros(const SCEV *S) {
4023   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
4024     return C->getValue()->getValue().countTrailingZeros();
4025
4026   if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(S))
4027     return std::min(GetMinTrailingZeros(T->getOperand()),
4028                     (uint32_t)getTypeSizeInBits(T->getType()));
4029
4030   if (const SCEVZeroExtendExpr *E = dyn_cast<SCEVZeroExtendExpr>(S)) {
4031     uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
4032     return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
4033              getTypeSizeInBits(E->getType()) : OpRes;
4034   }
4035
4036   if (const SCEVSignExtendExpr *E = dyn_cast<SCEVSignExtendExpr>(S)) {
4037     uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
4038     return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
4039              getTypeSizeInBits(E->getType()) : OpRes;
4040   }
4041
4042   if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(S)) {
4043     // The result is the min of all operands results.
4044     uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
4045     for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
4046       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
4047     return MinOpRes;
4048   }
4049
4050   if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(S)) {
4051     // The result is the sum of all operands results.
4052     uint32_t SumOpRes = GetMinTrailingZeros(M->getOperand(0));
4053     uint32_t BitWidth = getTypeSizeInBits(M->getType());
4054     for (unsigned i = 1, e = M->getNumOperands();
4055          SumOpRes != BitWidth && i != e; ++i)
4056       SumOpRes = std::min(SumOpRes + GetMinTrailingZeros(M->getOperand(i)),
4057                           BitWidth);
4058     return SumOpRes;
4059   }
4060
4061   if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(S)) {
4062     // The result is the min of all operands results.
4063     uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
4064     for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
4065       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
4066     return MinOpRes;
4067   }
4068
4069   if (const SCEVSMaxExpr *M = dyn_cast<SCEVSMaxExpr>(S)) {
4070     // The result is the min of all operands results.
4071     uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
4072     for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
4073       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
4074     return MinOpRes;
4075   }
4076
4077   if (const SCEVUMaxExpr *M = dyn_cast<SCEVUMaxExpr>(S)) {
4078     // The result is the min of all operands results.
4079     uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
4080     for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
4081       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
4082     return MinOpRes;
4083   }
4084
4085   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
4086     // For a SCEVUnknown, ask ValueTracking.
4087     unsigned BitWidth = getTypeSizeInBits(U->getType());
4088     APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
4089     computeKnownBits(U->getValue(), Zeros, Ones, F.getParent()->getDataLayout(),
4090                      0, &AC, nullptr, &DT);
4091     return Zeros.countTrailingOnes();
4092   }
4093
4094   // SCEVUDivExpr
4095   return 0;
4096 }
4097
4098 /// GetRangeFromMetadata - Helper method to assign a range to V from
4099 /// metadata present in the IR.
4100 static Optional<ConstantRange> GetRangeFromMetadata(Value *V) {
4101   if (Instruction *I = dyn_cast<Instruction>(V)) {
4102     if (MDNode *MD = I->getMetadata(LLVMContext::MD_range)) {
4103       ConstantRange TotalRange(
4104           cast<IntegerType>(I->getType())->getBitWidth(), false);
4105
4106       unsigned NumRanges = MD->getNumOperands() / 2;
4107       assert(NumRanges >= 1);
4108
4109       for (unsigned i = 0; i < NumRanges; ++i) {
4110         ConstantInt *Lower =
4111             mdconst::extract<ConstantInt>(MD->getOperand(2 * i + 0));
4112         ConstantInt *Upper =
4113             mdconst::extract<ConstantInt>(MD->getOperand(2 * i + 1));
4114         ConstantRange Range(Lower->getValue(), Upper->getValue());
4115         TotalRange = TotalRange.unionWith(Range);
4116       }
4117
4118       return TotalRange;
4119     }
4120   }
4121
4122   return None;
4123 }
4124
4125 /// getRange - Determine the range for a particular SCEV.  If SignHint is
4126 /// HINT_RANGE_UNSIGNED (resp. HINT_RANGE_SIGNED) then getRange prefers ranges
4127 /// with a "cleaner" unsigned (resp. signed) representation.
4128 ///
4129 ConstantRange
4130 ScalarEvolution::getRange(const SCEV *S,
4131                           ScalarEvolution::RangeSignHint SignHint) {
4132   DenseMap<const SCEV *, ConstantRange> &Cache =
4133       SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED ? UnsignedRanges
4134                                                        : SignedRanges;
4135
4136   // See if we've computed this range already.
4137   DenseMap<const SCEV *, ConstantRange>::iterator I = Cache.find(S);
4138   if (I != Cache.end())
4139     return I->second;
4140
4141   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
4142     return setRange(C, SignHint, ConstantRange(C->getValue()->getValue()));
4143
4144   unsigned BitWidth = getTypeSizeInBits(S->getType());
4145   ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true);
4146
4147   // If the value has known zeros, the maximum value will have those known zeros
4148   // as well.
4149   uint32_t TZ = GetMinTrailingZeros(S);
4150   if (TZ != 0) {
4151     if (SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED)
4152       ConservativeResult =
4153           ConstantRange(APInt::getMinValue(BitWidth),
4154                         APInt::getMaxValue(BitWidth).lshr(TZ).shl(TZ) + 1);
4155     else
4156       ConservativeResult = ConstantRange(
4157           APInt::getSignedMinValue(BitWidth),
4158           APInt::getSignedMaxValue(BitWidth).ashr(TZ).shl(TZ) + 1);
4159   }
4160
4161   if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
4162     ConstantRange X = getRange(Add->getOperand(0), SignHint);
4163     for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i)
4164       X = X.add(getRange(Add->getOperand(i), SignHint));
4165     return setRange(Add, SignHint, ConservativeResult.intersectWith(X));
4166   }
4167
4168   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
4169     ConstantRange X = getRange(Mul->getOperand(0), SignHint);
4170     for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i)
4171       X = X.multiply(getRange(Mul->getOperand(i), SignHint));
4172     return setRange(Mul, SignHint, ConservativeResult.intersectWith(X));
4173   }
4174
4175   if (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(S)) {
4176     ConstantRange X = getRange(SMax->getOperand(0), SignHint);
4177     for (unsigned i = 1, e = SMax->getNumOperands(); i != e; ++i)
4178       X = X.smax(getRange(SMax->getOperand(i), SignHint));
4179     return setRange(SMax, SignHint, ConservativeResult.intersectWith(X));
4180   }
4181
4182   if (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(S)) {
4183     ConstantRange X = getRange(UMax->getOperand(0), SignHint);
4184     for (unsigned i = 1, e = UMax->getNumOperands(); i != e; ++i)
4185       X = X.umax(getRange(UMax->getOperand(i), SignHint));
4186     return setRange(UMax, SignHint, ConservativeResult.intersectWith(X));
4187   }
4188
4189   if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) {
4190     ConstantRange X = getRange(UDiv->getLHS(), SignHint);
4191     ConstantRange Y = getRange(UDiv->getRHS(), SignHint);
4192     return setRange(UDiv, SignHint,
4193                     ConservativeResult.intersectWith(X.udiv(Y)));
4194   }
4195
4196   if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) {
4197     ConstantRange X = getRange(ZExt->getOperand(), SignHint);
4198     return setRange(ZExt, SignHint,
4199                     ConservativeResult.intersectWith(X.zeroExtend(BitWidth)));
4200   }
4201
4202   if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) {
4203     ConstantRange X = getRange(SExt->getOperand(), SignHint);
4204     return setRange(SExt, SignHint,
4205                     ConservativeResult.intersectWith(X.signExtend(BitWidth)));
4206   }
4207
4208   if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) {
4209     ConstantRange X = getRange(Trunc->getOperand(), SignHint);
4210     return setRange(Trunc, SignHint,
4211                     ConservativeResult.intersectWith(X.truncate(BitWidth)));
4212   }
4213
4214   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) {
4215     // If there's no unsigned wrap, the value will never be less than its
4216     // initial value.
4217     if (AddRec->getNoWrapFlags(SCEV::FlagNUW))
4218       if (const SCEVConstant *C = dyn_cast<SCEVConstant>(AddRec->getStart()))
4219         if (!C->getValue()->isZero())
4220           ConservativeResult =
4221             ConservativeResult.intersectWith(
4222               ConstantRange(C->getValue()->getValue(), APInt(BitWidth, 0)));
4223
4224     // If there's no signed wrap, and all the operands have the same sign or
4225     // zero, the value won't ever change sign.
4226     if (AddRec->getNoWrapFlags(SCEV::FlagNSW)) {
4227       bool AllNonNeg = true;
4228       bool AllNonPos = true;
4229       for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
4230         if (!isKnownNonNegative(AddRec->getOperand(i))) AllNonNeg = false;
4231         if (!isKnownNonPositive(AddRec->getOperand(i))) AllNonPos = false;
4232       }
4233       if (AllNonNeg)
4234         ConservativeResult = ConservativeResult.intersectWith(
4235           ConstantRange(APInt(BitWidth, 0),
4236                         APInt::getSignedMinValue(BitWidth)));
4237       else if (AllNonPos)
4238         ConservativeResult = ConservativeResult.intersectWith(
4239           ConstantRange(APInt::getSignedMinValue(BitWidth),
4240                         APInt(BitWidth, 1)));
4241     }
4242
4243     // TODO: non-affine addrec
4244     if (AddRec->isAffine()) {
4245       Type *Ty = AddRec->getType();
4246       const SCEV *MaxBECount = getMaxBackedgeTakenCount(AddRec->getLoop());
4247       if (!isa<SCEVCouldNotCompute>(MaxBECount) &&
4248           getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) {
4249
4250         // Check for overflow.  This must be done with ConstantRange arithmetic
4251         // because we could be called from within the ScalarEvolution overflow
4252         // checking code.
4253
4254         MaxBECount = getNoopOrZeroExtend(MaxBECount, Ty);
4255         ConstantRange MaxBECountRange = getUnsignedRange(MaxBECount);
4256         ConstantRange ZExtMaxBECountRange =
4257             MaxBECountRange.zextOrTrunc(BitWidth * 2 + 1);
4258
4259         const SCEV *Start = AddRec->getStart();
4260         const SCEV *Step = AddRec->getStepRecurrence(*this);
4261         ConstantRange StepSRange = getSignedRange(Step);
4262         ConstantRange SExtStepSRange = StepSRange.sextOrTrunc(BitWidth * 2 + 1);
4263
4264         ConstantRange StartURange = getUnsignedRange(Start);
4265         ConstantRange EndURange =
4266             StartURange.add(MaxBECountRange.multiply(StepSRange));
4267
4268         // Check for unsigned overflow.
4269         ConstantRange ZExtStartURange =
4270             StartURange.zextOrTrunc(BitWidth * 2 + 1);
4271         ConstantRange ZExtEndURange = EndURange.zextOrTrunc(BitWidth * 2 + 1);
4272         if (ZExtStartURange.add(ZExtMaxBECountRange.multiply(SExtStepSRange)) ==
4273             ZExtEndURange) {
4274           APInt Min = APIntOps::umin(StartURange.getUnsignedMin(),
4275                                      EndURange.getUnsignedMin());
4276           APInt Max = APIntOps::umax(StartURange.getUnsignedMax(),
4277                                      EndURange.getUnsignedMax());
4278           bool IsFullRange = Min.isMinValue() && Max.isMaxValue();
4279           if (!IsFullRange)
4280             ConservativeResult =
4281                 ConservativeResult.intersectWith(ConstantRange(Min, Max + 1));
4282         }
4283
4284         ConstantRange StartSRange = getSignedRange(Start);
4285         ConstantRange EndSRange =
4286             StartSRange.add(MaxBECountRange.multiply(StepSRange));
4287
4288         // Check for signed overflow. This must be done with ConstantRange
4289         // arithmetic because we could be called from within the ScalarEvolution
4290         // overflow checking code.
4291         ConstantRange SExtStartSRange =
4292             StartSRange.sextOrTrunc(BitWidth * 2 + 1);
4293         ConstantRange SExtEndSRange = EndSRange.sextOrTrunc(BitWidth * 2 + 1);
4294         if (SExtStartSRange.add(ZExtMaxBECountRange.multiply(SExtStepSRange)) ==
4295             SExtEndSRange) {
4296           APInt Min = APIntOps::smin(StartSRange.getSignedMin(),
4297                                      EndSRange.getSignedMin());
4298           APInt Max = APIntOps::smax(StartSRange.getSignedMax(),
4299                                      EndSRange.getSignedMax());
4300           bool IsFullRange = Min.isMinSignedValue() && Max.isMaxSignedValue();
4301           if (!IsFullRange)
4302             ConservativeResult =
4303                 ConservativeResult.intersectWith(ConstantRange(Min, Max + 1));
4304         }
4305       }
4306     }
4307
4308     return setRange(AddRec, SignHint, ConservativeResult);
4309   }
4310
4311   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
4312     // Check if the IR explicitly contains !range metadata.
4313     Optional<ConstantRange> MDRange = GetRangeFromMetadata(U->getValue());
4314     if (MDRange.hasValue())
4315       ConservativeResult = ConservativeResult.intersectWith(MDRange.getValue());
4316
4317     // Split here to avoid paying the compile-time cost of calling both
4318     // computeKnownBits and ComputeNumSignBits.  This restriction can be lifted
4319     // if needed.
4320     const DataLayout &DL = F.getParent()->getDataLayout();
4321     if (SignHint == ScalarEvolution::HINT_RANGE_UNSIGNED) {
4322       // For a SCEVUnknown, ask ValueTracking.
4323       APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
4324       computeKnownBits(U->getValue(), Zeros, Ones, DL, 0, &AC, nullptr, &DT);
4325       if (Ones != ~Zeros + 1)
4326         ConservativeResult =
4327             ConservativeResult.intersectWith(ConstantRange(Ones, ~Zeros + 1));
4328     } else {
4329       assert(SignHint == ScalarEvolution::HINT_RANGE_SIGNED &&
4330              "generalize as needed!");
4331       unsigned NS = ComputeNumSignBits(U->getValue(), DL, 0, &AC, nullptr, &DT);
4332       if (NS > 1)
4333         ConservativeResult = ConservativeResult.intersectWith(
4334             ConstantRange(APInt::getSignedMinValue(BitWidth).ashr(NS - 1),
4335                           APInt::getSignedMaxValue(BitWidth).ashr(NS - 1) + 1));
4336     }
4337
4338     return setRange(U, SignHint, ConservativeResult);
4339   }
4340
4341   return setRange(S, SignHint, ConservativeResult);
4342 }
4343
4344 SCEV::NoWrapFlags ScalarEvolution::getNoWrapFlagsFromUB(const Value *V) {
4345   if (isa<ConstantExpr>(V)) return SCEV::FlagAnyWrap;
4346   const BinaryOperator *BinOp = cast<BinaryOperator>(V);
4347
4348   // Return early if there are no flags to propagate to the SCEV.
4349   SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap;
4350   if (BinOp->hasNoUnsignedWrap())
4351     Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNUW);
4352   if (BinOp->hasNoSignedWrap())
4353     Flags = ScalarEvolution::setFlags(Flags, SCEV::FlagNSW);
4354   if (Flags == SCEV::FlagAnyWrap) {
4355     return SCEV::FlagAnyWrap;
4356   }
4357
4358   // Here we check that BinOp is in the header of the innermost loop
4359   // containing BinOp, since we only deal with instructions in the loop
4360   // header. The actual loop we need to check later will come from an add
4361   // recurrence, but getting that requires computing the SCEV of the operands,
4362   // which can be expensive. This check we can do cheaply to rule out some
4363   // cases early.
4364   Loop *innermostContainingLoop = LI.getLoopFor(BinOp->getParent());
4365   if (innermostContainingLoop == nullptr ||
4366       innermostContainingLoop->getHeader() != BinOp->getParent())
4367     return SCEV::FlagAnyWrap;
4368
4369   // Only proceed if we can prove that BinOp does not yield poison.
4370   if (!isKnownNotFullPoison(BinOp)) return SCEV::FlagAnyWrap;
4371
4372   // At this point we know that if V is executed, then it does not wrap
4373   // according to at least one of NSW or NUW. If V is not executed, then we do
4374   // not know if the calculation that V represents would wrap. Multiple
4375   // instructions can map to the same SCEV. If we apply NSW or NUW from V to
4376   // the SCEV, we must guarantee no wrapping for that SCEV also when it is
4377   // derived from other instructions that map to the same SCEV. We cannot make
4378   // that guarantee for cases where V is not executed. So we need to find the
4379   // loop that V is considered in relation to and prove that V is executed for
4380   // every iteration of that loop. That implies that the value that V
4381   // calculates does not wrap anywhere in the loop, so then we can apply the
4382   // flags to the SCEV.
4383   //
4384   // We check isLoopInvariant to disambiguate in case we are adding two
4385   // recurrences from different loops, so that we know which loop to prove
4386   // that V is executed in.
4387   for (int OpIndex = 0; OpIndex < 2; ++OpIndex) {
4388     const SCEV *Op = getSCEV(BinOp->getOperand(OpIndex));
4389     if (auto *AddRec = dyn_cast<SCEVAddRecExpr>(Op)) {
4390       const int OtherOpIndex = 1 - OpIndex;
4391       const SCEV *OtherOp = getSCEV(BinOp->getOperand(OtherOpIndex));
4392       if (isLoopInvariant(OtherOp, AddRec->getLoop()) &&
4393           isGuaranteedToExecuteForEveryIteration(BinOp, AddRec->getLoop()))
4394         return Flags;
4395     }
4396   }
4397   return SCEV::FlagAnyWrap;
4398 }
4399
4400 /// createSCEV - We know that there is no SCEV for the specified value.  Analyze
4401 /// the expression.
4402 ///
4403 const SCEV *ScalarEvolution::createSCEV(Value *V) {
4404   if (!isSCEVable(V->getType()))
4405     return getUnknown(V);
4406
4407   unsigned Opcode = Instruction::UserOp1;
4408   if (Instruction *I = dyn_cast<Instruction>(V)) {
4409     Opcode = I->getOpcode();
4410
4411     // Don't attempt to analyze instructions in blocks that aren't
4412     // reachable. Such instructions don't matter, and they aren't required
4413     // to obey basic rules for definitions dominating uses which this
4414     // analysis depends on.
4415     if (!DT.isReachableFromEntry(I->getParent()))
4416       return getUnknown(V);
4417   } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
4418     Opcode = CE->getOpcode();
4419   else if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
4420     return getConstant(CI);
4421   else if (isa<ConstantPointerNull>(V))
4422     return getZero(V->getType());
4423   else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
4424     return GA->mayBeOverridden() ? getUnknown(V) : getSCEV(GA->getAliasee());
4425   else
4426     return getUnknown(V);
4427
4428   Operator *U = cast<Operator>(V);
4429   switch (Opcode) {
4430   case Instruction::Add: {
4431     // The simple thing to do would be to just call getSCEV on both operands
4432     // and call getAddExpr with the result. However if we're looking at a
4433     // bunch of things all added together, this can be quite inefficient,
4434     // because it leads to N-1 getAddExpr calls for N ultimate operands.
4435     // Instead, gather up all the operands and make a single getAddExpr call.
4436     // LLVM IR canonical form means we need only traverse the left operands.
4437     SmallVector<const SCEV *, 4> AddOps;
4438     for (Value *Op = U;; Op = U->getOperand(0)) {
4439       U = dyn_cast<Operator>(Op);
4440       unsigned Opcode = U ? U->getOpcode() : 0;
4441       if (!U || (Opcode != Instruction::Add && Opcode != Instruction::Sub)) {
4442         assert(Op != V && "V should be an add");
4443         AddOps.push_back(getSCEV(Op));
4444         break;
4445       }
4446
4447       if (auto *OpSCEV = getExistingSCEV(U)) {
4448         AddOps.push_back(OpSCEV);
4449         break;
4450       }
4451
4452       // If a NUW or NSW flag can be applied to the SCEV for this
4453       // addition, then compute the SCEV for this addition by itself
4454       // with a separate call to getAddExpr. We need to do that
4455       // instead of pushing the operands of the addition onto AddOps,
4456       // since the flags are only known to apply to this particular
4457       // addition - they may not apply to other additions that can be
4458       // formed with operands from AddOps.
4459       const SCEV *RHS = getSCEV(U->getOperand(1));
4460       SCEV::NoWrapFlags Flags = getNoWrapFlagsFromUB(U);
4461       if (Flags != SCEV::FlagAnyWrap) {
4462         const SCEV *LHS = getSCEV(U->getOperand(0));
4463         if (Opcode == Instruction::Sub)
4464           AddOps.push_back(getMinusSCEV(LHS, RHS, Flags));
4465         else
4466           AddOps.push_back(getAddExpr(LHS, RHS, Flags));
4467         break;
4468       }
4469
4470       if (Opcode == Instruction::Sub)
4471         AddOps.push_back(getNegativeSCEV(RHS));
4472       else
4473         AddOps.push_back(RHS);
4474     }
4475     return getAddExpr(AddOps);
4476   }
4477
4478   case Instruction::Mul: {
4479     SmallVector<const SCEV *, 4> MulOps;
4480     for (Value *Op = U;; Op = U->getOperand(0)) {
4481       U = dyn_cast<Operator>(Op);
4482       if (!U || U->getOpcode() != Instruction::Mul) {
4483         assert(Op != V && "V should be a mul");
4484         MulOps.push_back(getSCEV(Op));
4485         break;
4486       }
4487
4488       if (auto *OpSCEV = getExistingSCEV(U)) {
4489         MulOps.push_back(OpSCEV);
4490         break;
4491       }
4492
4493       SCEV::NoWrapFlags Flags = getNoWrapFlagsFromUB(U);
4494       if (Flags != SCEV::FlagAnyWrap) {
4495         MulOps.push_back(getMulExpr(getSCEV(U->getOperand(0)),
4496                                     getSCEV(U->getOperand(1)), Flags));
4497         break;
4498       }
4499
4500       MulOps.push_back(getSCEV(U->getOperand(1)));
4501     }
4502     return getMulExpr(MulOps);
4503   }
4504   case Instruction::UDiv:
4505     return getUDivExpr(getSCEV(U->getOperand(0)),
4506                        getSCEV(U->getOperand(1)));
4507   case Instruction::Sub:
4508     return getMinusSCEV(getSCEV(U->getOperand(0)), getSCEV(U->getOperand(1)),
4509                         getNoWrapFlagsFromUB(U));
4510   case Instruction::And:
4511     // For an expression like x&255 that merely masks off the high bits,
4512     // use zext(trunc(x)) as the SCEV expression.
4513     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
4514       if (CI->isNullValue())
4515         return getSCEV(U->getOperand(1));
4516       if (CI->isAllOnesValue())
4517         return getSCEV(U->getOperand(0));
4518       const APInt &A = CI->getValue();
4519
4520       // Instcombine's ShrinkDemandedConstant may strip bits out of
4521       // constants, obscuring what would otherwise be a low-bits mask.
4522       // Use computeKnownBits to compute what ShrinkDemandedConstant
4523       // knew about to reconstruct a low-bits mask value.
4524       unsigned LZ = A.countLeadingZeros();
4525       unsigned TZ = A.countTrailingZeros();
4526       unsigned BitWidth = A.getBitWidth();
4527       APInt KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
4528       computeKnownBits(U->getOperand(0), KnownZero, KnownOne,
4529                        F.getParent()->getDataLayout(), 0, &AC, nullptr, &DT);
4530
4531       APInt EffectiveMask =
4532           APInt::getLowBitsSet(BitWidth, BitWidth - LZ - TZ).shl(TZ);
4533       if ((LZ != 0 || TZ != 0) && !((~A & ~KnownZero) & EffectiveMask)) {
4534         const SCEV *MulCount = getConstant(
4535             ConstantInt::get(getContext(), APInt::getOneBitSet(BitWidth, TZ)));
4536         return getMulExpr(
4537             getZeroExtendExpr(
4538                 getTruncateExpr(
4539                     getUDivExactExpr(getSCEV(U->getOperand(0)), MulCount),
4540                     IntegerType::get(getContext(), BitWidth - LZ - TZ)),
4541                 U->getType()),
4542             MulCount);
4543       }
4544     }
4545     break;
4546
4547   case Instruction::Or:
4548     // If the RHS of the Or is a constant, we may have something like:
4549     // X*4+1 which got turned into X*4|1.  Handle this as an Add so loop
4550     // optimizations will transparently handle this case.
4551     //
4552     // In order for this transformation to be safe, the LHS must be of the
4553     // form X*(2^n) and the Or constant must be less than 2^n.
4554     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
4555       const SCEV *LHS = getSCEV(U->getOperand(0));
4556       const APInt &CIVal = CI->getValue();
4557       if (GetMinTrailingZeros(LHS) >=
4558           (CIVal.getBitWidth() - CIVal.countLeadingZeros())) {
4559         // Build a plain add SCEV.
4560         const SCEV *S = getAddExpr(LHS, getSCEV(CI));
4561         // If the LHS of the add was an addrec and it has no-wrap flags,
4562         // transfer the no-wrap flags, since an or won't introduce a wrap.
4563         if (const SCEVAddRecExpr *NewAR = dyn_cast<SCEVAddRecExpr>(S)) {
4564           const SCEVAddRecExpr *OldAR = cast<SCEVAddRecExpr>(LHS);
4565           const_cast<SCEVAddRecExpr *>(NewAR)->setNoWrapFlags(
4566             OldAR->getNoWrapFlags());
4567         }
4568         return S;
4569       }
4570     }
4571     break;
4572   case Instruction::Xor:
4573     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
4574       // If the RHS of the xor is a signbit, then this is just an add.
4575       // Instcombine turns add of signbit into xor as a strength reduction step.
4576       if (CI->getValue().isSignBit())
4577         return getAddExpr(getSCEV(U->getOperand(0)),
4578                           getSCEV(U->getOperand(1)));
4579
4580       // If the RHS of xor is -1, then this is a not operation.
4581       if (CI->isAllOnesValue())
4582         return getNotSCEV(getSCEV(U->getOperand(0)));
4583
4584       // Model xor(and(x, C), C) as and(~x, C), if C is a low-bits mask.
4585       // This is a variant of the check for xor with -1, and it handles
4586       // the case where instcombine has trimmed non-demanded bits out
4587       // of an xor with -1.
4588       if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U->getOperand(0)))
4589         if (ConstantInt *LCI = dyn_cast<ConstantInt>(BO->getOperand(1)))
4590           if (BO->getOpcode() == Instruction::And &&
4591               LCI->getValue() == CI->getValue())
4592             if (const SCEVZeroExtendExpr *Z =
4593                   dyn_cast<SCEVZeroExtendExpr>(getSCEV(U->getOperand(0)))) {
4594               Type *UTy = U->getType();
4595               const SCEV *Z0 = Z->getOperand();
4596               Type *Z0Ty = Z0->getType();
4597               unsigned Z0TySize = getTypeSizeInBits(Z0Ty);
4598
4599               // If C is a low-bits mask, the zero extend is serving to
4600               // mask off the high bits. Complement the operand and
4601               // re-apply the zext.
4602               if (APIntOps::isMask(Z0TySize, CI->getValue()))
4603                 return getZeroExtendExpr(getNotSCEV(Z0), UTy);
4604
4605               // If C is a single bit, it may be in the sign-bit position
4606               // before the zero-extend. In this case, represent the xor
4607               // using an add, which is equivalent, and re-apply the zext.
4608               APInt Trunc = CI->getValue().trunc(Z0TySize);
4609               if (Trunc.zext(getTypeSizeInBits(UTy)) == CI->getValue() &&
4610                   Trunc.isSignBit())
4611                 return getZeroExtendExpr(getAddExpr(Z0, getConstant(Trunc)),
4612                                          UTy);
4613             }
4614     }
4615     break;
4616
4617   case Instruction::Shl:
4618     // Turn shift left of a constant amount into a multiply.
4619     if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
4620       uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
4621
4622       // If the shift count is not less than the bitwidth, the result of
4623       // the shift is undefined. Don't try to analyze it, because the
4624       // resolution chosen here may differ from the resolution chosen in
4625       // other parts of the compiler.
4626       if (SA->getValue().uge(BitWidth))
4627         break;
4628
4629       // It is currently not resolved how to interpret NSW for left
4630       // shift by BitWidth - 1, so we avoid applying flags in that
4631       // case. Remove this check (or this comment) once the situation
4632       // is resolved. See
4633       // http://lists.llvm.org/pipermail/llvm-dev/2015-April/084195.html
4634       // and http://reviews.llvm.org/D8890 .
4635       auto Flags = SCEV::FlagAnyWrap;
4636       if (SA->getValue().ult(BitWidth - 1)) Flags = getNoWrapFlagsFromUB(U);
4637
4638       Constant *X = ConstantInt::get(getContext(),
4639         APInt::getOneBitSet(BitWidth, SA->getZExtValue()));
4640       return getMulExpr(getSCEV(U->getOperand(0)), getSCEV(X), Flags);
4641     }
4642     break;
4643
4644   case Instruction::LShr:
4645     // Turn logical shift right of a constant into a unsigned divide.
4646     if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
4647       uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
4648
4649       // If the shift count is not less than the bitwidth, the result of
4650       // the shift is undefined. Don't try to analyze it, because the
4651       // resolution chosen here may differ from the resolution chosen in
4652       // other parts of the compiler.
4653       if (SA->getValue().uge(BitWidth))
4654         break;
4655
4656       Constant *X = ConstantInt::get(getContext(),
4657         APInt::getOneBitSet(BitWidth, SA->getZExtValue()));
4658       return getUDivExpr(getSCEV(U->getOperand(0)), getSCEV(X));
4659     }
4660     break;
4661
4662   case Instruction::AShr:
4663     // For a two-shift sext-inreg, use sext(trunc(x)) as the SCEV expression.
4664     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1)))
4665       if (Operator *L = dyn_cast<Operator>(U->getOperand(0)))
4666         if (L->getOpcode() == Instruction::Shl &&
4667             L->getOperand(1) == U->getOperand(1)) {
4668           uint64_t BitWidth = getTypeSizeInBits(U->getType());
4669
4670           // If the shift count is not less than the bitwidth, the result of
4671           // the shift is undefined. Don't try to analyze it, because the
4672           // resolution chosen here may differ from the resolution chosen in
4673           // other parts of the compiler.
4674           if (CI->getValue().uge(BitWidth))
4675             break;
4676
4677           uint64_t Amt = BitWidth - CI->getZExtValue();
4678           if (Amt == BitWidth)
4679             return getSCEV(L->getOperand(0));       // shift by zero --> noop
4680           return
4681             getSignExtendExpr(getTruncateExpr(getSCEV(L->getOperand(0)),
4682                                               IntegerType::get(getContext(),
4683                                                                Amt)),
4684                               U->getType());
4685         }
4686     break;
4687
4688   case Instruction::Trunc:
4689     return getTruncateExpr(getSCEV(U->getOperand(0)), U->getType());
4690
4691   case Instruction::ZExt:
4692     return getZeroExtendExpr(getSCEV(U->getOperand(0)), U->getType());
4693
4694   case Instruction::SExt:
4695     return getSignExtendExpr(getSCEV(U->getOperand(0)), U->getType());
4696
4697   case Instruction::BitCast:
4698     // BitCasts are no-op casts so we just eliminate the cast.
4699     if (isSCEVable(U->getType()) && isSCEVable(U->getOperand(0)->getType()))
4700       return getSCEV(U->getOperand(0));
4701     break;
4702
4703   // It's tempting to handle inttoptr and ptrtoint as no-ops, however this can
4704   // lead to pointer expressions which cannot safely be expanded to GEPs,
4705   // because ScalarEvolution doesn't respect the GEP aliasing rules when
4706   // simplifying integer expressions.
4707
4708   case Instruction::GetElementPtr:
4709     return createNodeForGEP(cast<GEPOperator>(U));
4710
4711   case Instruction::PHI:
4712     return createNodeForPHI(cast<PHINode>(U));
4713
4714   case Instruction::Select:
4715     // U can also be a select constant expr, which let fall through.  Since
4716     // createNodeForSelect only works for a condition that is an `ICmpInst`, and
4717     // constant expressions cannot have instructions as operands, we'd have
4718     // returned getUnknown for a select constant expressions anyway.
4719     if (isa<Instruction>(U))
4720       return createNodeForSelectOrPHI(cast<Instruction>(U), U->getOperand(0),
4721                                       U->getOperand(1), U->getOperand(2));
4722
4723   default: // We cannot analyze this expression.
4724     break;
4725   }
4726
4727   return getUnknown(V);
4728 }
4729
4730
4731
4732 //===----------------------------------------------------------------------===//
4733 //                   Iteration Count Computation Code
4734 //
4735
4736 unsigned ScalarEvolution::getSmallConstantTripCount(Loop *L) {
4737   if (BasicBlock *ExitingBB = L->getExitingBlock())
4738     return getSmallConstantTripCount(L, ExitingBB);
4739
4740   // No trip count information for multiple exits.
4741   return 0;
4742 }
4743
4744 /// getSmallConstantTripCount - Returns the maximum trip count of this loop as a
4745 /// normal unsigned value. Returns 0 if the trip count is unknown or not
4746 /// constant. Will also return 0 if the maximum trip count is very large (>=
4747 /// 2^32).
4748 ///
4749 /// This "trip count" assumes that control exits via ExitingBlock. More
4750 /// precisely, it is the number of times that control may reach ExitingBlock
4751 /// before taking the branch. For loops with multiple exits, it may not be the
4752 /// number times that the loop header executes because the loop may exit
4753 /// prematurely via another branch.
4754 unsigned ScalarEvolution::getSmallConstantTripCount(Loop *L,
4755                                                     BasicBlock *ExitingBlock) {
4756   assert(ExitingBlock && "Must pass a non-null exiting block!");
4757   assert(L->isLoopExiting(ExitingBlock) &&
4758          "Exiting block must actually branch out of the loop!");
4759   const SCEVConstant *ExitCount =
4760       dyn_cast<SCEVConstant>(getExitCount(L, ExitingBlock));
4761   if (!ExitCount)
4762     return 0;
4763
4764   ConstantInt *ExitConst = ExitCount->getValue();
4765
4766   // Guard against huge trip counts.
4767   if (ExitConst->getValue().getActiveBits() > 32)
4768     return 0;
4769
4770   // In case of integer overflow, this returns 0, which is correct.
4771   return ((unsigned)ExitConst->getZExtValue()) + 1;
4772 }
4773
4774 unsigned ScalarEvolution::getSmallConstantTripMultiple(Loop *L) {
4775   if (BasicBlock *ExitingBB = L->getExitingBlock())
4776     return getSmallConstantTripMultiple(L, ExitingBB);
4777
4778   // No trip multiple information for multiple exits.
4779   return 0;
4780 }
4781
4782 /// getSmallConstantTripMultiple - Returns the largest constant divisor of the
4783 /// trip count of this loop as a normal unsigned value, if possible. This
4784 /// means that the actual trip count is always a multiple of the returned
4785 /// value (don't forget the trip count could very well be zero as well!).
4786 ///
4787 /// Returns 1 if the trip count is unknown or not guaranteed to be the
4788 /// multiple of a constant (which is also the case if the trip count is simply
4789 /// constant, use getSmallConstantTripCount for that case), Will also return 1
4790 /// if the trip count is very large (>= 2^32).
4791 ///
4792 /// As explained in the comments for getSmallConstantTripCount, this assumes
4793 /// that control exits the loop via ExitingBlock.
4794 unsigned
4795 ScalarEvolution::getSmallConstantTripMultiple(Loop *L,
4796                                               BasicBlock *ExitingBlock) {
4797   assert(ExitingBlock && "Must pass a non-null exiting block!");
4798   assert(L->isLoopExiting(ExitingBlock) &&
4799          "Exiting block must actually branch out of the loop!");
4800   const SCEV *ExitCount = getExitCount(L, ExitingBlock);
4801   if (ExitCount == getCouldNotCompute())
4802     return 1;
4803
4804   // Get the trip count from the BE count by adding 1.
4805   const SCEV *TCMul = getAddExpr(ExitCount, getOne(ExitCount->getType()));
4806   // FIXME: SCEV distributes multiplication as V1*C1 + V2*C1. We could attempt
4807   // to factor simple cases.
4808   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(TCMul))
4809     TCMul = Mul->getOperand(0);
4810
4811   const SCEVConstant *MulC = dyn_cast<SCEVConstant>(TCMul);
4812   if (!MulC)
4813     return 1;
4814
4815   ConstantInt *Result = MulC->getValue();
4816
4817   // Guard against huge trip counts (this requires checking
4818   // for zero to handle the case where the trip count == -1 and the
4819   // addition wraps).
4820   if (!Result || Result->getValue().getActiveBits() > 32 ||
4821       Result->getValue().getActiveBits() == 0)
4822     return 1;
4823
4824   return (unsigned)Result->getZExtValue();
4825 }
4826
4827 // getExitCount - Get the expression for the number of loop iterations for which
4828 // this loop is guaranteed not to exit via ExitingBlock. Otherwise return
4829 // SCEVCouldNotCompute.
4830 const SCEV *ScalarEvolution::getExitCount(Loop *L, BasicBlock *ExitingBlock) {
4831   return getBackedgeTakenInfo(L).getExact(ExitingBlock, this);
4832 }
4833
4834 /// getBackedgeTakenCount - If the specified loop has a predictable
4835 /// backedge-taken count, return it, otherwise return a SCEVCouldNotCompute
4836 /// object. The backedge-taken count is the number of times the loop header
4837 /// will be branched to from within the loop. This is one less than the
4838 /// trip count of the loop, since it doesn't count the first iteration,
4839 /// when the header is branched to from outside the loop.
4840 ///
4841 /// Note that it is not valid to call this method on a loop without a
4842 /// loop-invariant backedge-taken count (see
4843 /// hasLoopInvariantBackedgeTakenCount).
4844 ///
4845 const SCEV *ScalarEvolution::getBackedgeTakenCount(const Loop *L) {
4846   return getBackedgeTakenInfo(L).getExact(this);
4847 }
4848
4849 /// getMaxBackedgeTakenCount - Similar to getBackedgeTakenCount, except
4850 /// return the least SCEV value that is known never to be less than the
4851 /// actual backedge taken count.
4852 const SCEV *ScalarEvolution::getMaxBackedgeTakenCount(const Loop *L) {
4853   return getBackedgeTakenInfo(L).getMax(this);
4854 }
4855
4856 /// PushLoopPHIs - Push PHI nodes in the header of the given loop
4857 /// onto the given Worklist.
4858 static void
4859 PushLoopPHIs(const Loop *L, SmallVectorImpl<Instruction *> &Worklist) {
4860   BasicBlock *Header = L->getHeader();
4861
4862   // Push all Loop-header PHIs onto the Worklist stack.
4863   for (BasicBlock::iterator I = Header->begin();
4864        PHINode *PN = dyn_cast<PHINode>(I); ++I)
4865     Worklist.push_back(PN);
4866 }
4867
4868 const ScalarEvolution::BackedgeTakenInfo &
4869 ScalarEvolution::getBackedgeTakenInfo(const Loop *L) {
4870   // Initially insert an invalid entry for this loop. If the insertion
4871   // succeeds, proceed to actually compute a backedge-taken count and
4872   // update the value. The temporary CouldNotCompute value tells SCEV
4873   // code elsewhere that it shouldn't attempt to request a new
4874   // backedge-taken count, which could result in infinite recursion.
4875   std::pair<DenseMap<const Loop *, BackedgeTakenInfo>::iterator, bool> Pair =
4876     BackedgeTakenCounts.insert(std::make_pair(L, BackedgeTakenInfo()));
4877   if (!Pair.second)
4878     return Pair.first->second;
4879
4880   // computeBackedgeTakenCount may allocate memory for its result. Inserting it
4881   // into the BackedgeTakenCounts map transfers ownership. Otherwise, the result
4882   // must be cleared in this scope.
4883   BackedgeTakenInfo Result = computeBackedgeTakenCount(L);
4884
4885   if (Result.getExact(this) != getCouldNotCompute()) {
4886     assert(isLoopInvariant(Result.getExact(this), L) &&
4887            isLoopInvariant(Result.getMax(this), L) &&
4888            "Computed backedge-taken count isn't loop invariant for loop!");
4889     ++NumTripCountsComputed;
4890   }
4891   else if (Result.getMax(this) == getCouldNotCompute() &&
4892            isa<PHINode>(L->getHeader()->begin())) {
4893     // Only count loops that have phi nodes as not being computable.
4894     ++NumTripCountsNotComputed;
4895   }
4896
4897   // Now that we know more about the trip count for this loop, forget any
4898   // existing SCEV values for PHI nodes in this loop since they are only
4899   // conservative estimates made without the benefit of trip count
4900   // information. This is similar to the code in forgetLoop, except that
4901   // it handles SCEVUnknown PHI nodes specially.
4902   if (Result.hasAnyInfo()) {
4903     SmallVector<Instruction *, 16> Worklist;
4904     PushLoopPHIs(L, Worklist);
4905
4906     SmallPtrSet<Instruction *, 8> Visited;
4907     while (!Worklist.empty()) {
4908       Instruction *I = Worklist.pop_back_val();
4909       if (!Visited.insert(I).second)
4910         continue;
4911
4912       ValueExprMapType::iterator It =
4913         ValueExprMap.find_as(static_cast<Value *>(I));
4914       if (It != ValueExprMap.end()) {
4915         const SCEV *Old = It->second;
4916
4917         // SCEVUnknown for a PHI either means that it has an unrecognized
4918         // structure, or it's a PHI that's in the progress of being computed
4919         // by createNodeForPHI.  In the former case, additional loop trip
4920         // count information isn't going to change anything. In the later
4921         // case, createNodeForPHI will perform the necessary updates on its
4922         // own when it gets to that point.
4923         if (!isa<PHINode>(I) || !isa<SCEVUnknown>(Old)) {
4924           forgetMemoizedResults(Old);
4925           ValueExprMap.erase(It);
4926         }
4927         if (PHINode *PN = dyn_cast<PHINode>(I))
4928           ConstantEvolutionLoopExitValue.erase(PN);
4929       }
4930
4931       PushDefUseChildren(I, Worklist);
4932     }
4933   }
4934
4935   // Re-lookup the insert position, since the call to
4936   // computeBackedgeTakenCount above could result in a
4937   // recusive call to getBackedgeTakenInfo (on a different
4938   // loop), which would invalidate the iterator computed
4939   // earlier.
4940   return BackedgeTakenCounts.find(L)->second = Result;
4941 }
4942
4943 /// forgetLoop - This method should be called by the client when it has
4944 /// changed a loop in a way that may effect ScalarEvolution's ability to
4945 /// compute a trip count, or if the loop is deleted.
4946 void ScalarEvolution::forgetLoop(const Loop *L) {
4947   // Drop any stored trip count value.
4948   DenseMap<const Loop*, BackedgeTakenInfo>::iterator BTCPos =
4949     BackedgeTakenCounts.find(L);
4950   if (BTCPos != BackedgeTakenCounts.end()) {
4951     BTCPos->second.clear();
4952     BackedgeTakenCounts.erase(BTCPos);
4953   }
4954
4955   // Drop information about expressions based on loop-header PHIs.
4956   SmallVector<Instruction *, 16> Worklist;
4957   PushLoopPHIs(L, Worklist);
4958
4959   SmallPtrSet<Instruction *, 8> Visited;
4960   while (!Worklist.empty()) {
4961     Instruction *I = Worklist.pop_back_val();
4962     if (!Visited.insert(I).second)
4963       continue;
4964
4965     ValueExprMapType::iterator It =
4966       ValueExprMap.find_as(static_cast<Value *>(I));
4967     if (It != ValueExprMap.end()) {
4968       forgetMemoizedResults(It->second);
4969       ValueExprMap.erase(It);
4970       if (PHINode *PN = dyn_cast<PHINode>(I))
4971         ConstantEvolutionLoopExitValue.erase(PN);
4972     }
4973
4974     PushDefUseChildren(I, Worklist);
4975   }
4976
4977   // Forget all contained loops too, to avoid dangling entries in the
4978   // ValuesAtScopes map.
4979   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
4980     forgetLoop(*I);
4981 }
4982
4983 /// forgetValue - This method should be called by the client when it has
4984 /// changed a value in a way that may effect its value, or which may
4985 /// disconnect it from a def-use chain linking it to a loop.
4986 void ScalarEvolution::forgetValue(Value *V) {
4987   Instruction *I = dyn_cast<Instruction>(V);
4988   if (!I) return;
4989
4990   // Drop information about expressions based on loop-header PHIs.
4991   SmallVector<Instruction *, 16> Worklist;
4992   Worklist.push_back(I);
4993
4994   SmallPtrSet<Instruction *, 8> Visited;
4995   while (!Worklist.empty()) {
4996     I = Worklist.pop_back_val();
4997     if (!Visited.insert(I).second)
4998       continue;
4999
5000     ValueExprMapType::iterator It =
5001       ValueExprMap.find_as(static_cast<Value *>(I));
5002     if (It != ValueExprMap.end()) {
5003       forgetMemoizedResults(It->second);
5004       ValueExprMap.erase(It);
5005       if (PHINode *PN = dyn_cast<PHINode>(I))
5006         ConstantEvolutionLoopExitValue.erase(PN);
5007     }
5008
5009     PushDefUseChildren(I, Worklist);
5010   }
5011 }
5012
5013 /// getExact - Get the exact loop backedge taken count considering all loop
5014 /// exits. A computable result can only be returned for loops with a single
5015 /// exit.  Returning the minimum taken count among all exits is incorrect
5016 /// because one of the loop's exit limit's may have been skipped. HowFarToZero
5017 /// assumes that the limit of each loop test is never skipped. This is a valid
5018 /// assumption as long as the loop exits via that test. For precise results, it
5019 /// is the caller's responsibility to specify the relevant loop exit using
5020 /// getExact(ExitingBlock, SE).
5021 const SCEV *
5022 ScalarEvolution::BackedgeTakenInfo::getExact(ScalarEvolution *SE) const {
5023   // If any exits were not computable, the loop is not computable.
5024   if (!ExitNotTaken.isCompleteList()) return SE->getCouldNotCompute();
5025
5026   // We need exactly one computable exit.
5027   if (!ExitNotTaken.ExitingBlock) return SE->getCouldNotCompute();
5028   assert(ExitNotTaken.ExactNotTaken && "uninitialized not-taken info");
5029
5030   const SCEV *BECount = nullptr;
5031   for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
5032        ENT != nullptr; ENT = ENT->getNextExit()) {
5033
5034     assert(ENT->ExactNotTaken != SE->getCouldNotCompute() && "bad exit SCEV");
5035
5036     if (!BECount)
5037       BECount = ENT->ExactNotTaken;
5038     else if (BECount != ENT->ExactNotTaken)
5039       return SE->getCouldNotCompute();
5040   }
5041   assert(BECount && "Invalid not taken count for loop exit");
5042   return BECount;
5043 }
5044
5045 /// getExact - Get the exact not taken count for this loop exit.
5046 const SCEV *
5047 ScalarEvolution::BackedgeTakenInfo::getExact(BasicBlock *ExitingBlock,
5048                                              ScalarEvolution *SE) const {
5049   for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
5050        ENT != nullptr; ENT = ENT->getNextExit()) {
5051
5052     if (ENT->ExitingBlock == ExitingBlock)
5053       return ENT->ExactNotTaken;
5054   }
5055   return SE->getCouldNotCompute();
5056 }
5057
5058 /// getMax - Get the max backedge taken count for the loop.
5059 const SCEV *
5060 ScalarEvolution::BackedgeTakenInfo::getMax(ScalarEvolution *SE) const {
5061   return Max ? Max : SE->getCouldNotCompute();
5062 }
5063
5064 bool ScalarEvolution::BackedgeTakenInfo::hasOperand(const SCEV *S,
5065                                                     ScalarEvolution *SE) const {
5066   if (Max && Max != SE->getCouldNotCompute() && SE->hasOperand(Max, S))
5067     return true;
5068
5069   if (!ExitNotTaken.ExitingBlock)
5070     return false;
5071
5072   for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
5073        ENT != nullptr; ENT = ENT->getNextExit()) {
5074
5075     if (ENT->ExactNotTaken != SE->getCouldNotCompute()
5076         && SE->hasOperand(ENT->ExactNotTaken, S)) {
5077       return true;
5078     }
5079   }
5080   return false;
5081 }
5082
5083 /// Allocate memory for BackedgeTakenInfo and copy the not-taken count of each
5084 /// computable exit into a persistent ExitNotTakenInfo array.
5085 ScalarEvolution::BackedgeTakenInfo::BackedgeTakenInfo(
5086   SmallVectorImpl< std::pair<BasicBlock *, const SCEV *> > &ExitCounts,
5087   bool Complete, const SCEV *MaxCount) : Max(MaxCount) {
5088
5089   if (!Complete)
5090     ExitNotTaken.setIncomplete();
5091
5092   unsigned NumExits = ExitCounts.size();
5093   if (NumExits == 0) return;
5094
5095   ExitNotTaken.ExitingBlock = ExitCounts[0].first;
5096   ExitNotTaken.ExactNotTaken = ExitCounts[0].second;
5097   if (NumExits == 1) return;
5098
5099   // Handle the rare case of multiple computable exits.
5100   ExitNotTakenInfo *ENT = new ExitNotTakenInfo[NumExits-1];
5101
5102   ExitNotTakenInfo *PrevENT = &ExitNotTaken;
5103   for (unsigned i = 1; i < NumExits; ++i, PrevENT = ENT, ++ENT) {
5104     PrevENT->setNextExit(ENT);
5105     ENT->ExitingBlock = ExitCounts[i].first;
5106     ENT->ExactNotTaken = ExitCounts[i].second;
5107   }
5108 }
5109
5110 /// clear - Invalidate this result and free the ExitNotTakenInfo array.
5111 void ScalarEvolution::BackedgeTakenInfo::clear() {
5112   ExitNotTaken.ExitingBlock = nullptr;
5113   ExitNotTaken.ExactNotTaken = nullptr;
5114   delete[] ExitNotTaken.getNextExit();
5115 }
5116
5117 /// computeBackedgeTakenCount - Compute the number of times the backedge
5118 /// of the specified loop will execute.
5119 ScalarEvolution::BackedgeTakenInfo
5120 ScalarEvolution::computeBackedgeTakenCount(const Loop *L) {
5121   SmallVector<BasicBlock *, 8> ExitingBlocks;
5122   L->getExitingBlocks(ExitingBlocks);
5123
5124   SmallVector<std::pair<BasicBlock *, const SCEV *>, 4> ExitCounts;
5125   bool CouldComputeBECount = true;
5126   BasicBlock *Latch = L->getLoopLatch(); // may be NULL.
5127   const SCEV *MustExitMaxBECount = nullptr;
5128   const SCEV *MayExitMaxBECount = nullptr;
5129
5130   // Compute the ExitLimit for each loop exit. Use this to populate ExitCounts
5131   // and compute maxBECount.
5132   for (unsigned i = 0, e = ExitingBlocks.size(); i != e; ++i) {
5133     BasicBlock *ExitBB = ExitingBlocks[i];
5134     ExitLimit EL = computeExitLimit(L, ExitBB);
5135
5136     // 1. For each exit that can be computed, add an entry to ExitCounts.
5137     // CouldComputeBECount is true only if all exits can be computed.
5138     if (EL.Exact == getCouldNotCompute())
5139       // We couldn't compute an exact value for this exit, so
5140       // we won't be able to compute an exact value for the loop.
5141       CouldComputeBECount = false;
5142     else
5143       ExitCounts.push_back(std::make_pair(ExitBB, EL.Exact));
5144
5145     // 2. Derive the loop's MaxBECount from each exit's max number of
5146     // non-exiting iterations. Partition the loop exits into two kinds:
5147     // LoopMustExits and LoopMayExits.
5148     //
5149     // If the exit dominates the loop latch, it is a LoopMustExit otherwise it
5150     // is a LoopMayExit.  If any computable LoopMustExit is found, then
5151     // MaxBECount is the minimum EL.Max of computable LoopMustExits. Otherwise,
5152     // MaxBECount is conservatively the maximum EL.Max, where CouldNotCompute is
5153     // considered greater than any computable EL.Max.
5154     if (EL.Max != getCouldNotCompute() && Latch &&
5155         DT.dominates(ExitBB, Latch)) {
5156       if (!MustExitMaxBECount)
5157         MustExitMaxBECount = EL.Max;
5158       else {
5159         MustExitMaxBECount =
5160           getUMinFromMismatchedTypes(MustExitMaxBECount, EL.Max);
5161       }
5162     } else if (MayExitMaxBECount != getCouldNotCompute()) {
5163       if (!MayExitMaxBECount || EL.Max == getCouldNotCompute())
5164         MayExitMaxBECount = EL.Max;
5165       else {
5166         MayExitMaxBECount =
5167           getUMaxFromMismatchedTypes(MayExitMaxBECount, EL.Max);
5168       }
5169     }
5170   }
5171   const SCEV *MaxBECount = MustExitMaxBECount ? MustExitMaxBECount :
5172     (MayExitMaxBECount ? MayExitMaxBECount : getCouldNotCompute());
5173   return BackedgeTakenInfo(ExitCounts, CouldComputeBECount, MaxBECount);
5174 }
5175
5176 ScalarEvolution::ExitLimit
5177 ScalarEvolution::computeExitLimit(const Loop *L, BasicBlock *ExitingBlock) {
5178
5179   // Okay, we've chosen an exiting block.  See what condition causes us to exit
5180   // at this block and remember the exit block and whether all other targets
5181   // lead to the loop header.
5182   bool MustExecuteLoopHeader = true;
5183   BasicBlock *Exit = nullptr;
5184   for (succ_iterator SI = succ_begin(ExitingBlock), SE = succ_end(ExitingBlock);
5185        SI != SE; ++SI)
5186     if (!L->contains(*SI)) {
5187       if (Exit) // Multiple exit successors.
5188         return getCouldNotCompute();
5189       Exit = *SI;
5190     } else if (*SI != L->getHeader()) {
5191       MustExecuteLoopHeader = false;
5192     }
5193
5194   // At this point, we know we have a conditional branch that determines whether
5195   // the loop is exited.  However, we don't know if the branch is executed each
5196   // time through the loop.  If not, then the execution count of the branch will
5197   // not be equal to the trip count of the loop.
5198   //
5199   // Currently we check for this by checking to see if the Exit branch goes to
5200   // the loop header.  If so, we know it will always execute the same number of
5201   // times as the loop.  We also handle the case where the exit block *is* the
5202   // loop header.  This is common for un-rotated loops.
5203   //
5204   // If both of those tests fail, walk up the unique predecessor chain to the
5205   // header, stopping if there is an edge that doesn't exit the loop. If the
5206   // header is reached, the execution count of the branch will be equal to the
5207   // trip count of the loop.
5208   //
5209   //  More extensive analysis could be done to handle more cases here.
5210   //
5211   if (!MustExecuteLoopHeader && ExitingBlock != L->getHeader()) {
5212     // The simple checks failed, try climbing the unique predecessor chain
5213     // up to the header.
5214     bool Ok = false;
5215     for (BasicBlock *BB = ExitingBlock; BB; ) {
5216       BasicBlock *Pred = BB->getUniquePredecessor();
5217       if (!Pred)
5218         return getCouldNotCompute();
5219       TerminatorInst *PredTerm = Pred->getTerminator();
5220       for (const BasicBlock *PredSucc : PredTerm->successors()) {
5221         if (PredSucc == BB)
5222           continue;
5223         // If the predecessor has a successor that isn't BB and isn't
5224         // outside the loop, assume the worst.
5225         if (L->contains(PredSucc))
5226           return getCouldNotCompute();
5227       }
5228       if (Pred == L->getHeader()) {
5229         Ok = true;
5230         break;
5231       }
5232       BB = Pred;
5233     }
5234     if (!Ok)
5235       return getCouldNotCompute();
5236   }
5237
5238   bool IsOnlyExit = (L->getExitingBlock() != nullptr);
5239   TerminatorInst *Term = ExitingBlock->getTerminator();
5240   if (BranchInst *BI = dyn_cast<BranchInst>(Term)) {
5241     assert(BI->isConditional() && "If unconditional, it can't be in loop!");
5242     // Proceed to the next level to examine the exit condition expression.
5243     return computeExitLimitFromCond(L, BI->getCondition(), BI->getSuccessor(0),
5244                                     BI->getSuccessor(1),
5245                                     /*ControlsExit=*/IsOnlyExit);
5246   }
5247
5248   if (SwitchInst *SI = dyn_cast<SwitchInst>(Term))
5249     return computeExitLimitFromSingleExitSwitch(L, SI, Exit,
5250                                                 /*ControlsExit=*/IsOnlyExit);
5251
5252   return getCouldNotCompute();
5253 }
5254
5255 /// computeExitLimitFromCond - Compute the number of times the
5256 /// backedge of the specified loop will execute if its exit condition
5257 /// were a conditional branch of ExitCond, TBB, and FBB.
5258 ///
5259 /// @param ControlsExit is true if ExitCond directly controls the exit
5260 /// branch. In this case, we can assume that the loop exits only if the
5261 /// condition is true and can infer that failing to meet the condition prior to
5262 /// integer wraparound results in undefined behavior.
5263 ScalarEvolution::ExitLimit
5264 ScalarEvolution::computeExitLimitFromCond(const Loop *L,
5265                                           Value *ExitCond,
5266                                           BasicBlock *TBB,
5267                                           BasicBlock *FBB,
5268                                           bool ControlsExit) {
5269   // Check if the controlling expression for this loop is an And or Or.
5270   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(ExitCond)) {
5271     if (BO->getOpcode() == Instruction::And) {
5272       // Recurse on the operands of the and.
5273       bool EitherMayExit = L->contains(TBB);
5274       ExitLimit EL0 = computeExitLimitFromCond(L, BO->getOperand(0), TBB, FBB,
5275                                                ControlsExit && !EitherMayExit);
5276       ExitLimit EL1 = computeExitLimitFromCond(L, BO->getOperand(1), TBB, FBB,
5277                                                ControlsExit && !EitherMayExit);
5278       const SCEV *BECount = getCouldNotCompute();
5279       const SCEV *MaxBECount = getCouldNotCompute();
5280       if (EitherMayExit) {
5281         // Both conditions must be true for the loop to continue executing.
5282         // Choose the less conservative count.
5283         if (EL0.Exact == getCouldNotCompute() ||
5284             EL1.Exact == getCouldNotCompute())
5285           BECount = getCouldNotCompute();
5286         else
5287           BECount = getUMinFromMismatchedTypes(EL0.Exact, EL1.Exact);
5288         if (EL0.Max == getCouldNotCompute())
5289           MaxBECount = EL1.Max;
5290         else if (EL1.Max == getCouldNotCompute())
5291           MaxBECount = EL0.Max;
5292         else
5293           MaxBECount = getUMinFromMismatchedTypes(EL0.Max, EL1.Max);
5294       } else {
5295         // Both conditions must be true at the same time for the loop to exit.
5296         // For now, be conservative.
5297         assert(L->contains(FBB) && "Loop block has no successor in loop!");
5298         if (EL0.Max == EL1.Max)
5299           MaxBECount = EL0.Max;
5300         if (EL0.Exact == EL1.Exact)
5301           BECount = EL0.Exact;
5302       }
5303
5304       return ExitLimit(BECount, MaxBECount);
5305     }
5306     if (BO->getOpcode() == Instruction::Or) {
5307       // Recurse on the operands of the or.
5308       bool EitherMayExit = L->contains(FBB);
5309       ExitLimit EL0 = computeExitLimitFromCond(L, BO->getOperand(0), TBB, FBB,
5310                                                ControlsExit && !EitherMayExit);
5311       ExitLimit EL1 = computeExitLimitFromCond(L, BO->getOperand(1), TBB, FBB,
5312                                                ControlsExit && !EitherMayExit);
5313       const SCEV *BECount = getCouldNotCompute();
5314       const SCEV *MaxBECount = getCouldNotCompute();
5315       if (EitherMayExit) {
5316         // Both conditions must be false for the loop to continue executing.
5317         // Choose the less conservative count.
5318         if (EL0.Exact == getCouldNotCompute() ||
5319             EL1.Exact == getCouldNotCompute())
5320           BECount = getCouldNotCompute();
5321         else
5322           BECount = getUMinFromMismatchedTypes(EL0.Exact, EL1.Exact);
5323         if (EL0.Max == getCouldNotCompute())
5324           MaxBECount = EL1.Max;
5325         else if (EL1.Max == getCouldNotCompute())
5326           MaxBECount = EL0.Max;
5327         else
5328           MaxBECount = getUMinFromMismatchedTypes(EL0.Max, EL1.Max);
5329       } else {
5330         // Both conditions must be false at the same time for the loop to exit.
5331         // For now, be conservative.
5332         assert(L->contains(TBB) && "Loop block has no successor in loop!");
5333         if (EL0.Max == EL1.Max)
5334           MaxBECount = EL0.Max;
5335         if (EL0.Exact == EL1.Exact)
5336           BECount = EL0.Exact;
5337       }
5338
5339       return ExitLimit(BECount, MaxBECount);
5340     }
5341   }
5342
5343   // With an icmp, it may be feasible to compute an exact backedge-taken count.
5344   // Proceed to the next level to examine the icmp.
5345   if (ICmpInst *ExitCondICmp = dyn_cast<ICmpInst>(ExitCond))
5346     return computeExitLimitFromICmp(L, ExitCondICmp, TBB, FBB, ControlsExit);
5347
5348   // Check for a constant condition. These are normally stripped out by
5349   // SimplifyCFG, but ScalarEvolution may be used by a pass which wishes to
5350   // preserve the CFG and is temporarily leaving constant conditions
5351   // in place.
5352   if (ConstantInt *CI = dyn_cast<ConstantInt>(ExitCond)) {
5353     if (L->contains(FBB) == !CI->getZExtValue())
5354       // The backedge is always taken.
5355       return getCouldNotCompute();
5356     else
5357       // The backedge is never taken.
5358       return getZero(CI->getType());
5359   }
5360
5361   // If it's not an integer or pointer comparison then compute it the hard way.
5362   return computeExitCountExhaustively(L, ExitCond, !L->contains(TBB));
5363 }
5364
5365 ScalarEvolution::ExitLimit
5366 ScalarEvolution::computeExitLimitFromICmp(const Loop *L,
5367                                           ICmpInst *ExitCond,
5368                                           BasicBlock *TBB,
5369                                           BasicBlock *FBB,
5370                                           bool ControlsExit) {
5371
5372   // If the condition was exit on true, convert the condition to exit on false
5373   ICmpInst::Predicate Cond;
5374   if (!L->contains(FBB))
5375     Cond = ExitCond->getPredicate();
5376   else
5377     Cond = ExitCond->getInversePredicate();
5378
5379   // Handle common loops like: for (X = "string"; *X; ++X)
5380   if (LoadInst *LI = dyn_cast<LoadInst>(ExitCond->getOperand(0)))
5381     if (Constant *RHS = dyn_cast<Constant>(ExitCond->getOperand(1))) {
5382       ExitLimit ItCnt =
5383         computeLoadConstantCompareExitLimit(LI, RHS, L, Cond);
5384       if (ItCnt.hasAnyInfo())
5385         return ItCnt;
5386     }
5387
5388   const SCEV *LHS = getSCEV(ExitCond->getOperand(0));
5389   const SCEV *RHS = getSCEV(ExitCond->getOperand(1));
5390
5391   // Try to evaluate any dependencies out of the loop.
5392   LHS = getSCEVAtScope(LHS, L);
5393   RHS = getSCEVAtScope(RHS, L);
5394
5395   // At this point, we would like to compute how many iterations of the
5396   // loop the predicate will return true for these inputs.
5397   if (isLoopInvariant(LHS, L) && !isLoopInvariant(RHS, L)) {
5398     // If there is a loop-invariant, force it into the RHS.
5399     std::swap(LHS, RHS);
5400     Cond = ICmpInst::getSwappedPredicate(Cond);
5401   }
5402
5403   // Simplify the operands before analyzing them.
5404   (void)SimplifyICmpOperands(Cond, LHS, RHS);
5405
5406   // If we have a comparison of a chrec against a constant, try to use value
5407   // ranges to answer this query.
5408   if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS))
5409     if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS))
5410       if (AddRec->getLoop() == L) {
5411         // Form the constant range.
5412         ConstantRange CompRange(
5413             ICmpInst::makeConstantRange(Cond, RHSC->getValue()->getValue()));
5414
5415         const SCEV *Ret = AddRec->getNumIterationsInRange(CompRange, *this);
5416         if (!isa<SCEVCouldNotCompute>(Ret)) return Ret;
5417       }
5418
5419   switch (Cond) {
5420   case ICmpInst::ICMP_NE: {                     // while (X != Y)
5421     // Convert to: while (X-Y != 0)
5422     ExitLimit EL = HowFarToZero(getMinusSCEV(LHS, RHS), L, ControlsExit);
5423     if (EL.hasAnyInfo()) return EL;
5424     break;
5425   }
5426   case ICmpInst::ICMP_EQ: {                     // while (X == Y)
5427     // Convert to: while (X-Y == 0)
5428     ExitLimit EL = HowFarToNonZero(getMinusSCEV(LHS, RHS), L);
5429     if (EL.hasAnyInfo()) return EL;
5430     break;
5431   }
5432   case ICmpInst::ICMP_SLT:
5433   case ICmpInst::ICMP_ULT: {                    // while (X < Y)
5434     bool IsSigned = Cond == ICmpInst::ICMP_SLT;
5435     ExitLimit EL = HowManyLessThans(LHS, RHS, L, IsSigned, ControlsExit);
5436     if (EL.hasAnyInfo()) return EL;
5437     break;
5438   }
5439   case ICmpInst::ICMP_SGT:
5440   case ICmpInst::ICMP_UGT: {                    // while (X > Y)
5441     bool IsSigned = Cond == ICmpInst::ICMP_SGT;
5442     ExitLimit EL = HowManyGreaterThans(LHS, RHS, L, IsSigned, ControlsExit);
5443     if (EL.hasAnyInfo()) return EL;
5444     break;
5445   }
5446   default:
5447 #if 0
5448     dbgs() << "computeBackedgeTakenCount ";
5449     if (ExitCond->getOperand(0)->getType()->isUnsigned())
5450       dbgs() << "[unsigned] ";
5451     dbgs() << *LHS << "   "
5452          << Instruction::getOpcodeName(Instruction::ICmp)
5453          << "   " << *RHS << "\n";
5454 #endif
5455     break;
5456   }
5457   return computeExitCountExhaustively(L, ExitCond, !L->contains(TBB));
5458 }
5459
5460 ScalarEvolution::ExitLimit
5461 ScalarEvolution::computeExitLimitFromSingleExitSwitch(const Loop *L,
5462                                                       SwitchInst *Switch,
5463                                                       BasicBlock *ExitingBlock,
5464                                                       bool ControlsExit) {
5465   assert(!L->contains(ExitingBlock) && "Not an exiting block!");
5466
5467   // Give up if the exit is the default dest of a switch.
5468   if (Switch->getDefaultDest() == ExitingBlock)
5469     return getCouldNotCompute();
5470
5471   assert(L->contains(Switch->getDefaultDest()) &&
5472          "Default case must not exit the loop!");
5473   const SCEV *LHS = getSCEVAtScope(Switch->getCondition(), L);
5474   const SCEV *RHS = getConstant(Switch->findCaseDest(ExitingBlock));
5475
5476   // while (X != Y) --> while (X-Y != 0)
5477   ExitLimit EL = HowFarToZero(getMinusSCEV(LHS, RHS), L, ControlsExit);
5478   if (EL.hasAnyInfo())
5479     return EL;
5480
5481   return getCouldNotCompute();
5482 }
5483
5484 static ConstantInt *
5485 EvaluateConstantChrecAtConstant(const SCEVAddRecExpr *AddRec, ConstantInt *C,
5486                                 ScalarEvolution &SE) {
5487   const SCEV *InVal = SE.getConstant(C);
5488   const SCEV *Val = AddRec->evaluateAtIteration(InVal, SE);
5489   assert(isa<SCEVConstant>(Val) &&
5490          "Evaluation of SCEV at constant didn't fold correctly?");
5491   return cast<SCEVConstant>(Val)->getValue();
5492 }
5493
5494 /// computeLoadConstantCompareExitLimit - Given an exit condition of
5495 /// 'icmp op load X, cst', try to see if we can compute the backedge
5496 /// execution count.
5497 ScalarEvolution::ExitLimit
5498 ScalarEvolution::computeLoadConstantCompareExitLimit(
5499   LoadInst *LI,
5500   Constant *RHS,
5501   const Loop *L,
5502   ICmpInst::Predicate predicate) {
5503
5504   if (LI->isVolatile()) return getCouldNotCompute();
5505
5506   // Check to see if the loaded pointer is a getelementptr of a global.
5507   // TODO: Use SCEV instead of manually grubbing with GEPs.
5508   GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0));
5509   if (!GEP) return getCouldNotCompute();
5510
5511   // Make sure that it is really a constant global we are gepping, with an
5512   // initializer, and make sure the first IDX is really 0.
5513   GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0));
5514   if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() ||
5515       GEP->getNumOperands() < 3 || !isa<Constant>(GEP->getOperand(1)) ||
5516       !cast<Constant>(GEP->getOperand(1))->isNullValue())
5517     return getCouldNotCompute();
5518
5519   // Okay, we allow one non-constant index into the GEP instruction.
5520   Value *VarIdx = nullptr;
5521   std::vector<Constant*> Indexes;
5522   unsigned VarIdxNum = 0;
5523   for (unsigned i = 2, e = GEP->getNumOperands(); i != e; ++i)
5524     if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
5525       Indexes.push_back(CI);
5526     } else if (!isa<ConstantInt>(GEP->getOperand(i))) {
5527       if (VarIdx) return getCouldNotCompute();  // Multiple non-constant idx's.
5528       VarIdx = GEP->getOperand(i);
5529       VarIdxNum = i-2;
5530       Indexes.push_back(nullptr);
5531     }
5532
5533   // Loop-invariant loads may be a byproduct of loop optimization. Skip them.
5534   if (!VarIdx)
5535     return getCouldNotCompute();
5536
5537   // Okay, we know we have a (load (gep GV, 0, X)) comparison with a constant.
5538   // Check to see if X is a loop variant variable value now.
5539   const SCEV *Idx = getSCEV(VarIdx);
5540   Idx = getSCEVAtScope(Idx, L);
5541
5542   // We can only recognize very limited forms of loop index expressions, in
5543   // particular, only affine AddRec's like {C1,+,C2}.
5544   const SCEVAddRecExpr *IdxExpr = dyn_cast<SCEVAddRecExpr>(Idx);
5545   if (!IdxExpr || !IdxExpr->isAffine() || isLoopInvariant(IdxExpr, L) ||
5546       !isa<SCEVConstant>(IdxExpr->getOperand(0)) ||
5547       !isa<SCEVConstant>(IdxExpr->getOperand(1)))
5548     return getCouldNotCompute();
5549
5550   unsigned MaxSteps = MaxBruteForceIterations;
5551   for (unsigned IterationNum = 0; IterationNum != MaxSteps; ++IterationNum) {
5552     ConstantInt *ItCst = ConstantInt::get(
5553                            cast<IntegerType>(IdxExpr->getType()), IterationNum);
5554     ConstantInt *Val = EvaluateConstantChrecAtConstant(IdxExpr, ItCst, *this);
5555
5556     // Form the GEP offset.
5557     Indexes[VarIdxNum] = Val;
5558
5559     Constant *Result = ConstantFoldLoadThroughGEPIndices(GV->getInitializer(),
5560                                                          Indexes);
5561     if (!Result) break;  // Cannot compute!
5562
5563     // Evaluate the condition for this iteration.
5564     Result = ConstantExpr::getICmp(predicate, Result, RHS);
5565     if (!isa<ConstantInt>(Result)) break;  // Couldn't decide for sure
5566     if (cast<ConstantInt>(Result)->getValue().isMinValue()) {
5567 #if 0
5568       dbgs() << "\n***\n*** Computed loop count " << *ItCst
5569              << "\n*** From global " << *GV << "*** BB: " << *L->getHeader()
5570              << "***\n";
5571 #endif
5572       ++NumArrayLenItCounts;
5573       return getConstant(ItCst);   // Found terminating iteration!
5574     }
5575   }
5576   return getCouldNotCompute();
5577 }
5578
5579
5580 /// CanConstantFold - Return true if we can constant fold an instruction of the
5581 /// specified type, assuming that all operands were constants.
5582 static bool CanConstantFold(const Instruction *I) {
5583   if (isa<BinaryOperator>(I) || isa<CmpInst>(I) ||
5584       isa<SelectInst>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I) ||
5585       isa<LoadInst>(I))
5586     return true;
5587
5588   if (const CallInst *CI = dyn_cast<CallInst>(I))
5589     if (const Function *F = CI->getCalledFunction())
5590       return canConstantFoldCallTo(F);
5591   return false;
5592 }
5593
5594 /// Determine whether this instruction can constant evolve within this loop
5595 /// assuming its operands can all constant evolve.
5596 static bool canConstantEvolve(Instruction *I, const Loop *L) {
5597   // An instruction outside of the loop can't be derived from a loop PHI.
5598   if (!L->contains(I)) return false;
5599
5600   if (isa<PHINode>(I)) {
5601     // We don't currently keep track of the control flow needed to evaluate
5602     // PHIs, so we cannot handle PHIs inside of loops.
5603     return L->getHeader() == I->getParent();
5604   }
5605
5606   // If we won't be able to constant fold this expression even if the operands
5607   // are constants, bail early.
5608   return CanConstantFold(I);
5609 }
5610
5611 /// getConstantEvolvingPHIOperands - Implement getConstantEvolvingPHI by
5612 /// recursing through each instruction operand until reaching a loop header phi.
5613 static PHINode *
5614 getConstantEvolvingPHIOperands(Instruction *UseInst, const Loop *L,
5615                                DenseMap<Instruction *, PHINode *> &PHIMap) {
5616
5617   // Otherwise, we can evaluate this instruction if all of its operands are
5618   // constant or derived from a PHI node themselves.
5619   PHINode *PHI = nullptr;
5620   for (Instruction::op_iterator OpI = UseInst->op_begin(),
5621          OpE = UseInst->op_end(); OpI != OpE; ++OpI) {
5622
5623     if (isa<Constant>(*OpI)) continue;
5624
5625     Instruction *OpInst = dyn_cast<Instruction>(*OpI);
5626     if (!OpInst || !canConstantEvolve(OpInst, L)) return nullptr;
5627
5628     PHINode *P = dyn_cast<PHINode>(OpInst);
5629     if (!P)
5630       // If this operand is already visited, reuse the prior result.
5631       // We may have P != PHI if this is the deepest point at which the
5632       // inconsistent paths meet.
5633       P = PHIMap.lookup(OpInst);
5634     if (!P) {
5635       // Recurse and memoize the results, whether a phi is found or not.
5636       // This recursive call invalidates pointers into PHIMap.
5637       P = getConstantEvolvingPHIOperands(OpInst, L, PHIMap);
5638       PHIMap[OpInst] = P;
5639     }
5640     if (!P)
5641       return nullptr;  // Not evolving from PHI
5642     if (PHI && PHI != P)
5643       return nullptr;  // Evolving from multiple different PHIs.
5644     PHI = P;
5645   }
5646   // This is a expression evolving from a constant PHI!
5647   return PHI;
5648 }
5649
5650 /// getConstantEvolvingPHI - Given an LLVM value and a loop, return a PHI node
5651 /// in the loop that V is derived from.  We allow arbitrary operations along the
5652 /// way, but the operands of an operation must either be constants or a value
5653 /// derived from a constant PHI.  If this expression does not fit with these
5654 /// constraints, return null.
5655 static PHINode *getConstantEvolvingPHI(Value *V, const Loop *L) {
5656   Instruction *I = dyn_cast<Instruction>(V);
5657   if (!I || !canConstantEvolve(I, L)) return nullptr;
5658
5659   if (PHINode *PN = dyn_cast<PHINode>(I)) {
5660     return PN;
5661   }
5662
5663   // Record non-constant instructions contained by the loop.
5664   DenseMap<Instruction *, PHINode *> PHIMap;
5665   return getConstantEvolvingPHIOperands(I, L, PHIMap);
5666 }
5667
5668 /// EvaluateExpression - Given an expression that passes the
5669 /// getConstantEvolvingPHI predicate, evaluate its value assuming the PHI node
5670 /// in the loop has the value PHIVal.  If we can't fold this expression for some
5671 /// reason, return null.
5672 static Constant *EvaluateExpression(Value *V, const Loop *L,
5673                                     DenseMap<Instruction *, Constant *> &Vals,
5674                                     const DataLayout &DL,
5675                                     const TargetLibraryInfo *TLI) {
5676   // Convenient constant check, but redundant for recursive calls.
5677   if (Constant *C = dyn_cast<Constant>(V)) return C;
5678   Instruction *I = dyn_cast<Instruction>(V);
5679   if (!I) return nullptr;
5680
5681   if (Constant *C = Vals.lookup(I)) return C;
5682
5683   // An instruction inside the loop depends on a value outside the loop that we
5684   // weren't given a mapping for, or a value such as a call inside the loop.
5685   if (!canConstantEvolve(I, L)) return nullptr;
5686
5687   // An unmapped PHI can be due to a branch or another loop inside this loop,
5688   // or due to this not being the initial iteration through a loop where we
5689   // couldn't compute the evolution of this particular PHI last time.
5690   if (isa<PHINode>(I)) return nullptr;
5691
5692   std::vector<Constant*> Operands(I->getNumOperands());
5693
5694   for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
5695     Instruction *Operand = dyn_cast<Instruction>(I->getOperand(i));
5696     if (!Operand) {
5697       Operands[i] = dyn_cast<Constant>(I->getOperand(i));
5698       if (!Operands[i]) return nullptr;
5699       continue;
5700     }
5701     Constant *C = EvaluateExpression(Operand, L, Vals, DL, TLI);
5702     Vals[Operand] = C;
5703     if (!C) return nullptr;
5704     Operands[i] = C;
5705   }
5706
5707   if (CmpInst *CI = dyn_cast<CmpInst>(I))
5708     return ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0],
5709                                            Operands[1], DL, TLI);
5710   if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
5711     if (!LI->isVolatile())
5712       return ConstantFoldLoadFromConstPtr(Operands[0], DL);
5713   }
5714   return ConstantFoldInstOperands(I->getOpcode(), I->getType(), Operands, DL,
5715                                   TLI);
5716 }
5717
5718 /// getConstantEvolutionLoopExitValue - If we know that the specified Phi is
5719 /// in the header of its containing loop, we know the loop executes a
5720 /// constant number of times, and the PHI node is just a recurrence
5721 /// involving constants, fold it.
5722 Constant *
5723 ScalarEvolution::getConstantEvolutionLoopExitValue(PHINode *PN,
5724                                                    const APInt &BEs,
5725                                                    const Loop *L) {
5726   auto I = ConstantEvolutionLoopExitValue.find(PN);
5727   if (I != ConstantEvolutionLoopExitValue.end())
5728     return I->second;
5729
5730   if (BEs.ugt(MaxBruteForceIterations))
5731     return ConstantEvolutionLoopExitValue[PN] = nullptr;  // Not going to evaluate it.
5732
5733   Constant *&RetVal = ConstantEvolutionLoopExitValue[PN];
5734
5735   DenseMap<Instruction *, Constant *> CurrentIterVals;
5736   BasicBlock *Header = L->getHeader();
5737   assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!");
5738
5739   BasicBlock *Latch = L->getLoopLatch();
5740   if (!Latch)
5741     return nullptr;
5742
5743   // Since the loop has one latch, the PHI node must have two entries.  One
5744   // entry must be a constant (coming in from outside of the loop), and the
5745   // second must be derived from the same PHI.
5746
5747   BasicBlock *NonLatch = Latch == PN->getIncomingBlock(0)
5748                              ? PN->getIncomingBlock(1)
5749                              : PN->getIncomingBlock(0);
5750
5751   assert(PN->getNumIncomingValues() == 2 && "Follows from having one latch!");
5752
5753   // Note: not all PHI nodes in the same block have to have their incoming
5754   // values in the same order, so we use the basic block to look up the incoming
5755   // value, not an index.
5756
5757   for (auto &I : *Header) {
5758     PHINode *PHI = dyn_cast<PHINode>(&I);
5759     if (!PHI) break;
5760     auto *StartCST =
5761         dyn_cast<Constant>(PHI->getIncomingValueForBlock(NonLatch));
5762     if (!StartCST) continue;
5763     CurrentIterVals[PHI] = StartCST;
5764   }
5765   if (!CurrentIterVals.count(PN))
5766     return RetVal = nullptr;
5767
5768   Value *BEValue = PN->getIncomingValueForBlock(Latch);
5769
5770   // Execute the loop symbolically to determine the exit value.
5771   if (BEs.getActiveBits() >= 32)
5772     return RetVal = nullptr; // More than 2^32-1 iterations?? Not doing it!
5773
5774   unsigned NumIterations = BEs.getZExtValue(); // must be in range
5775   unsigned IterationNum = 0;
5776   const DataLayout &DL = F.getParent()->getDataLayout();
5777   for (; ; ++IterationNum) {
5778     if (IterationNum == NumIterations)
5779       return RetVal = CurrentIterVals[PN];  // Got exit value!
5780
5781     // Compute the value of the PHIs for the next iteration.
5782     // EvaluateExpression adds non-phi values to the CurrentIterVals map.
5783     DenseMap<Instruction *, Constant *> NextIterVals;
5784     Constant *NextPHI =
5785         EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI);
5786     if (!NextPHI)
5787       return nullptr;        // Couldn't evaluate!
5788     NextIterVals[PN] = NextPHI;
5789
5790     bool StoppedEvolving = NextPHI == CurrentIterVals[PN];
5791
5792     // Also evaluate the other PHI nodes.  However, we don't get to stop if we
5793     // cease to be able to evaluate one of them or if they stop evolving,
5794     // because that doesn't necessarily prevent us from computing PN.
5795     SmallVector<std::pair<PHINode *, Constant *>, 8> PHIsToCompute;
5796     for (const auto &I : CurrentIterVals) {
5797       PHINode *PHI = dyn_cast<PHINode>(I.first);
5798       if (!PHI || PHI == PN || PHI->getParent() != Header) continue;
5799       PHIsToCompute.emplace_back(PHI, I.second);
5800     }
5801     // We use two distinct loops because EvaluateExpression may invalidate any
5802     // iterators into CurrentIterVals.
5803     for (const auto &I : PHIsToCompute) {
5804       PHINode *PHI = I.first;
5805       Constant *&NextPHI = NextIterVals[PHI];
5806       if (!NextPHI) {   // Not already computed.
5807         Value *BEValue = PHI->getIncomingValueForBlock(Latch);
5808         NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI);
5809       }
5810       if (NextPHI != I.second)
5811         StoppedEvolving = false;
5812     }
5813
5814     // If all entries in CurrentIterVals == NextIterVals then we can stop
5815     // iterating, the loop can't continue to change.
5816     if (StoppedEvolving)
5817       return RetVal = CurrentIterVals[PN];
5818
5819     CurrentIterVals.swap(NextIterVals);
5820   }
5821 }
5822
5823 const SCEV *ScalarEvolution::computeExitCountExhaustively(const Loop *L,
5824                                                           Value *Cond,
5825                                                           bool ExitWhen) {
5826   PHINode *PN = getConstantEvolvingPHI(Cond, L);
5827   if (!PN) return getCouldNotCompute();
5828
5829   // If the loop is canonicalized, the PHI will have exactly two entries.
5830   // That's the only form we support here.
5831   if (PN->getNumIncomingValues() != 2) return getCouldNotCompute();
5832
5833   DenseMap<Instruction *, Constant *> CurrentIterVals;
5834   BasicBlock *Header = L->getHeader();
5835   assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!");
5836
5837   BasicBlock *Latch = L->getLoopLatch();
5838   assert(Latch && "Should follow from NumIncomingValues == 2!");
5839
5840   // NonLatch is the preheader, or something equivalent.
5841   BasicBlock *NonLatch = Latch == PN->getIncomingBlock(0)
5842                              ? PN->getIncomingBlock(1)
5843                              : PN->getIncomingBlock(0);
5844
5845   // Note: not all PHI nodes in the same block have to have their incoming
5846   // values in the same order, so we use the basic block to look up the incoming
5847   // value, not an index.
5848
5849   for (auto &I : *Header) {
5850     PHINode *PHI = dyn_cast<PHINode>(&I);
5851     if (!PHI)
5852       break;
5853     auto *StartCST =
5854       dyn_cast<Constant>(PHI->getIncomingValueForBlock(NonLatch));
5855     if (!StartCST) continue;
5856     CurrentIterVals[PHI] = StartCST;
5857   }
5858   if (!CurrentIterVals.count(PN))
5859     return getCouldNotCompute();
5860
5861   // Okay, we find a PHI node that defines the trip count of this loop.  Execute
5862   // the loop symbolically to determine when the condition gets a value of
5863   // "ExitWhen".
5864   unsigned MaxIterations = MaxBruteForceIterations;   // Limit analysis.
5865   const DataLayout &DL = F.getParent()->getDataLayout();
5866   for (unsigned IterationNum = 0; IterationNum != MaxIterations;++IterationNum){
5867     auto *CondVal = dyn_cast_or_null<ConstantInt>(
5868         EvaluateExpression(Cond, L, CurrentIterVals, DL, &TLI));
5869
5870     // Couldn't symbolically evaluate.
5871     if (!CondVal) return getCouldNotCompute();
5872
5873     if (CondVal->getValue() == uint64_t(ExitWhen)) {
5874       ++NumBruteForceTripCountsComputed;
5875       return getConstant(Type::getInt32Ty(getContext()), IterationNum);
5876     }
5877
5878     // Update all the PHI nodes for the next iteration.
5879     DenseMap<Instruction *, Constant *> NextIterVals;
5880
5881     // Create a list of which PHIs we need to compute. We want to do this before
5882     // calling EvaluateExpression on them because that may invalidate iterators
5883     // into CurrentIterVals.
5884     SmallVector<PHINode *, 8> PHIsToCompute;
5885     for (const auto &I : CurrentIterVals) {
5886       PHINode *PHI = dyn_cast<PHINode>(I.first);
5887       if (!PHI || PHI->getParent() != Header) continue;
5888       PHIsToCompute.push_back(PHI);
5889     }
5890     for (PHINode *PHI : PHIsToCompute) {
5891       Constant *&NextPHI = NextIterVals[PHI];
5892       if (NextPHI) continue;    // Already computed!
5893
5894       Value *BEValue = PHI->getIncomingValueForBlock(Latch);
5895       NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, DL, &TLI);
5896     }
5897     CurrentIterVals.swap(NextIterVals);
5898   }
5899
5900   // Too many iterations were needed to evaluate.
5901   return getCouldNotCompute();
5902 }
5903
5904 /// getSCEVAtScope - Return a SCEV expression for the specified value
5905 /// at the specified scope in the program.  The L value specifies a loop
5906 /// nest to evaluate the expression at, where null is the top-level or a
5907 /// specified loop is immediately inside of the loop.
5908 ///
5909 /// This method can be used to compute the exit value for a variable defined
5910 /// in a loop by querying what the value will hold in the parent loop.
5911 ///
5912 /// In the case that a relevant loop exit value cannot be computed, the
5913 /// original value V is returned.
5914 const SCEV *ScalarEvolution::getSCEVAtScope(const SCEV *V, const Loop *L) {
5915   // Check to see if we've folded this expression at this loop before.
5916   SmallVector<std::pair<const Loop *, const SCEV *>, 2> &Values = ValuesAtScopes[V];
5917   for (unsigned u = 0; u < Values.size(); u++) {
5918     if (Values[u].first == L)
5919       return Values[u].second ? Values[u].second : V;
5920   }
5921   Values.push_back(std::make_pair(L, static_cast<const SCEV *>(nullptr)));
5922   // Otherwise compute it.
5923   const SCEV *C = computeSCEVAtScope(V, L);
5924   SmallVector<std::pair<const Loop *, const SCEV *>, 2> &Values2 = ValuesAtScopes[V];
5925   for (unsigned u = Values2.size(); u > 0; u--) {
5926     if (Values2[u - 1].first == L) {
5927       Values2[u - 1].second = C;
5928       break;
5929     }
5930   }
5931   return C;
5932 }
5933
5934 /// This builds up a Constant using the ConstantExpr interface.  That way, we
5935 /// will return Constants for objects which aren't represented by a
5936 /// SCEVConstant, because SCEVConstant is restricted to ConstantInt.
5937 /// Returns NULL if the SCEV isn't representable as a Constant.
5938 static Constant *BuildConstantFromSCEV(const SCEV *V) {
5939   switch (static_cast<SCEVTypes>(V->getSCEVType())) {
5940     case scCouldNotCompute:
5941     case scAddRecExpr:
5942       break;
5943     case scConstant:
5944       return cast<SCEVConstant>(V)->getValue();
5945     case scUnknown:
5946       return dyn_cast<Constant>(cast<SCEVUnknown>(V)->getValue());
5947     case scSignExtend: {
5948       const SCEVSignExtendExpr *SS = cast<SCEVSignExtendExpr>(V);
5949       if (Constant *CastOp = BuildConstantFromSCEV(SS->getOperand()))
5950         return ConstantExpr::getSExt(CastOp, SS->getType());
5951       break;
5952     }
5953     case scZeroExtend: {
5954       const SCEVZeroExtendExpr *SZ = cast<SCEVZeroExtendExpr>(V);
5955       if (Constant *CastOp = BuildConstantFromSCEV(SZ->getOperand()))
5956         return ConstantExpr::getZExt(CastOp, SZ->getType());
5957       break;
5958     }
5959     case scTruncate: {
5960       const SCEVTruncateExpr *ST = cast<SCEVTruncateExpr>(V);
5961       if (Constant *CastOp = BuildConstantFromSCEV(ST->getOperand()))
5962         return ConstantExpr::getTrunc(CastOp, ST->getType());
5963       break;
5964     }
5965     case scAddExpr: {
5966       const SCEVAddExpr *SA = cast<SCEVAddExpr>(V);
5967       if (Constant *C = BuildConstantFromSCEV(SA->getOperand(0))) {
5968         if (PointerType *PTy = dyn_cast<PointerType>(C->getType())) {
5969           unsigned AS = PTy->getAddressSpace();
5970           Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS);
5971           C = ConstantExpr::getBitCast(C, DestPtrTy);
5972         }
5973         for (unsigned i = 1, e = SA->getNumOperands(); i != e; ++i) {
5974           Constant *C2 = BuildConstantFromSCEV(SA->getOperand(i));
5975           if (!C2) return nullptr;
5976
5977           // First pointer!
5978           if (!C->getType()->isPointerTy() && C2->getType()->isPointerTy()) {
5979             unsigned AS = C2->getType()->getPointerAddressSpace();
5980             std::swap(C, C2);
5981             Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS);
5982             // The offsets have been converted to bytes.  We can add bytes to an
5983             // i8* by GEP with the byte count in the first index.
5984             C = ConstantExpr::getBitCast(C, DestPtrTy);
5985           }
5986
5987           // Don't bother trying to sum two pointers. We probably can't
5988           // statically compute a load that results from it anyway.
5989           if (C2->getType()->isPointerTy())
5990             return nullptr;
5991
5992           if (PointerType *PTy = dyn_cast<PointerType>(C->getType())) {
5993             if (PTy->getElementType()->isStructTy())
5994               C2 = ConstantExpr::getIntegerCast(
5995                   C2, Type::getInt32Ty(C->getContext()), true);
5996             C = ConstantExpr::getGetElementPtr(PTy->getElementType(), C, C2);
5997           } else
5998             C = ConstantExpr::getAdd(C, C2);
5999         }
6000         return C;
6001       }
6002       break;
6003     }
6004     case scMulExpr: {
6005       const SCEVMulExpr *SM = cast<SCEVMulExpr>(V);
6006       if (Constant *C = BuildConstantFromSCEV(SM->getOperand(0))) {
6007         // Don't bother with pointers at all.
6008         if (C->getType()->isPointerTy()) return nullptr;
6009         for (unsigned i = 1, e = SM->getNumOperands(); i != e; ++i) {
6010           Constant *C2 = BuildConstantFromSCEV(SM->getOperand(i));
6011           if (!C2 || C2->getType()->isPointerTy()) return nullptr;
6012           C = ConstantExpr::getMul(C, C2);
6013         }
6014         return C;
6015       }
6016       break;
6017     }
6018     case scUDivExpr: {
6019       const SCEVUDivExpr *SU = cast<SCEVUDivExpr>(V);
6020       if (Constant *LHS = BuildConstantFromSCEV(SU->getLHS()))
6021         if (Constant *RHS = BuildConstantFromSCEV(SU->getRHS()))
6022           if (LHS->getType() == RHS->getType())
6023             return ConstantExpr::getUDiv(LHS, RHS);
6024       break;
6025     }
6026     case scSMaxExpr:
6027     case scUMaxExpr:
6028       break; // TODO: smax, umax.
6029   }
6030   return nullptr;
6031 }
6032
6033 const SCEV *ScalarEvolution::computeSCEVAtScope(const SCEV *V, const Loop *L) {
6034   if (isa<SCEVConstant>(V)) return V;
6035
6036   // If this instruction is evolved from a constant-evolving PHI, compute the
6037   // exit value from the loop without using SCEVs.
6038   if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V)) {
6039     if (Instruction *I = dyn_cast<Instruction>(SU->getValue())) {
6040       const Loop *LI = this->LI[I->getParent()];
6041       if (LI && LI->getParentLoop() == L)  // Looking for loop exit value.
6042         if (PHINode *PN = dyn_cast<PHINode>(I))
6043           if (PN->getParent() == LI->getHeader()) {
6044             // Okay, there is no closed form solution for the PHI node.  Check
6045             // to see if the loop that contains it has a known backedge-taken
6046             // count.  If so, we may be able to force computation of the exit
6047             // value.
6048             const SCEV *BackedgeTakenCount = getBackedgeTakenCount(LI);
6049             if (const SCEVConstant *BTCC =
6050                   dyn_cast<SCEVConstant>(BackedgeTakenCount)) {
6051               // Okay, we know how many times the containing loop executes.  If
6052               // this is a constant evolving PHI node, get the final value at
6053               // the specified iteration number.
6054               Constant *RV = getConstantEvolutionLoopExitValue(PN,
6055                                                    BTCC->getValue()->getValue(),
6056                                                                LI);
6057               if (RV) return getSCEV(RV);
6058             }
6059           }
6060
6061       // Okay, this is an expression that we cannot symbolically evaluate
6062       // into a SCEV.  Check to see if it's possible to symbolically evaluate
6063       // the arguments into constants, and if so, try to constant propagate the
6064       // result.  This is particularly useful for computing loop exit values.
6065       if (CanConstantFold(I)) {
6066         SmallVector<Constant *, 4> Operands;
6067         bool MadeImprovement = false;
6068         for (Value *Op : I->operands()) {
6069           if (Constant *C = dyn_cast<Constant>(Op)) {
6070             Operands.push_back(C);
6071             continue;
6072           }
6073
6074           // If any of the operands is non-constant and if they are
6075           // non-integer and non-pointer, don't even try to analyze them
6076           // with scev techniques.
6077           if (!isSCEVable(Op->getType()))
6078             return V;
6079
6080           const SCEV *OrigV = getSCEV(Op);
6081           const SCEV *OpV = getSCEVAtScope(OrigV, L);
6082           MadeImprovement |= OrigV != OpV;
6083
6084           Constant *C = BuildConstantFromSCEV(OpV);
6085           if (!C) return V;
6086           if (C->getType() != Op->getType())
6087             C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
6088                                                               Op->getType(),
6089                                                               false),
6090                                       C, Op->getType());
6091           Operands.push_back(C);
6092         }
6093
6094         // Check to see if getSCEVAtScope actually made an improvement.
6095         if (MadeImprovement) {
6096           Constant *C = nullptr;
6097           const DataLayout &DL = F.getParent()->getDataLayout();
6098           if (const CmpInst *CI = dyn_cast<CmpInst>(I))
6099             C = ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0],
6100                                                 Operands[1], DL, &TLI);
6101           else if (const LoadInst *LI = dyn_cast<LoadInst>(I)) {
6102             if (!LI->isVolatile())
6103               C = ConstantFoldLoadFromConstPtr(Operands[0], DL);
6104           } else
6105             C = ConstantFoldInstOperands(I->getOpcode(), I->getType(), Operands,
6106                                          DL, &TLI);
6107           if (!C) return V;
6108           return getSCEV(C);
6109         }
6110       }
6111     }
6112
6113     // This is some other type of SCEVUnknown, just return it.
6114     return V;
6115   }
6116
6117   if (const SCEVCommutativeExpr *Comm = dyn_cast<SCEVCommutativeExpr>(V)) {
6118     // Avoid performing the look-up in the common case where the specified
6119     // expression has no loop-variant portions.
6120     for (unsigned i = 0, e = Comm->getNumOperands(); i != e; ++i) {
6121       const SCEV *OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
6122       if (OpAtScope != Comm->getOperand(i)) {
6123         // Okay, at least one of these operands is loop variant but might be
6124         // foldable.  Build a new instance of the folded commutative expression.
6125         SmallVector<const SCEV *, 8> NewOps(Comm->op_begin(),
6126                                             Comm->op_begin()+i);
6127         NewOps.push_back(OpAtScope);
6128
6129         for (++i; i != e; ++i) {
6130           OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
6131           NewOps.push_back(OpAtScope);
6132         }
6133         if (isa<SCEVAddExpr>(Comm))
6134           return getAddExpr(NewOps);
6135         if (isa<SCEVMulExpr>(Comm))
6136           return getMulExpr(NewOps);
6137         if (isa<SCEVSMaxExpr>(Comm))
6138           return getSMaxExpr(NewOps);
6139         if (isa<SCEVUMaxExpr>(Comm))
6140           return getUMaxExpr(NewOps);
6141         llvm_unreachable("Unknown commutative SCEV type!");
6142       }
6143     }
6144     // If we got here, all operands are loop invariant.
6145     return Comm;
6146   }
6147
6148   if (const SCEVUDivExpr *Div = dyn_cast<SCEVUDivExpr>(V)) {
6149     const SCEV *LHS = getSCEVAtScope(Div->getLHS(), L);
6150     const SCEV *RHS = getSCEVAtScope(Div->getRHS(), L);
6151     if (LHS == Div->getLHS() && RHS == Div->getRHS())
6152       return Div;   // must be loop invariant
6153     return getUDivExpr(LHS, RHS);
6154   }
6155
6156   // If this is a loop recurrence for a loop that does not contain L, then we
6157   // are dealing with the final value computed by the loop.
6158   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V)) {
6159     // First, attempt to evaluate each operand.
6160     // Avoid performing the look-up in the common case where the specified
6161     // expression has no loop-variant portions.
6162     for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
6163       const SCEV *OpAtScope = getSCEVAtScope(AddRec->getOperand(i), L);
6164       if (OpAtScope == AddRec->getOperand(i))
6165         continue;
6166
6167       // Okay, at least one of these operands is loop variant but might be
6168       // foldable.  Build a new instance of the folded commutative expression.
6169       SmallVector<const SCEV *, 8> NewOps(AddRec->op_begin(),
6170                                           AddRec->op_begin()+i);
6171       NewOps.push_back(OpAtScope);
6172       for (++i; i != e; ++i)
6173         NewOps.push_back(getSCEVAtScope(AddRec->getOperand(i), L));
6174
6175       const SCEV *FoldedRec =
6176         getAddRecExpr(NewOps, AddRec->getLoop(),
6177                       AddRec->getNoWrapFlags(SCEV::FlagNW));
6178       AddRec = dyn_cast<SCEVAddRecExpr>(FoldedRec);
6179       // The addrec may be folded to a nonrecurrence, for example, if the
6180       // induction variable is multiplied by zero after constant folding. Go
6181       // ahead and return the folded value.
6182       if (!AddRec)
6183         return FoldedRec;
6184       break;
6185     }
6186
6187     // If the scope is outside the addrec's loop, evaluate it by using the
6188     // loop exit value of the addrec.
6189     if (!AddRec->getLoop()->contains(L)) {
6190       // To evaluate this recurrence, we need to know how many times the AddRec
6191       // loop iterates.  Compute this now.
6192       const SCEV *BackedgeTakenCount = getBackedgeTakenCount(AddRec->getLoop());
6193       if (BackedgeTakenCount == getCouldNotCompute()) return AddRec;
6194
6195       // Then, evaluate the AddRec.
6196       return AddRec->evaluateAtIteration(BackedgeTakenCount, *this);
6197     }
6198
6199     return AddRec;
6200   }
6201
6202   if (const SCEVZeroExtendExpr *Cast = dyn_cast<SCEVZeroExtendExpr>(V)) {
6203     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
6204     if (Op == Cast->getOperand())
6205       return Cast;  // must be loop invariant
6206     return getZeroExtendExpr(Op, Cast->getType());
6207   }
6208
6209   if (const SCEVSignExtendExpr *Cast = dyn_cast<SCEVSignExtendExpr>(V)) {
6210     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
6211     if (Op == Cast->getOperand())
6212       return Cast;  // must be loop invariant
6213     return getSignExtendExpr(Op, Cast->getType());
6214   }
6215
6216   if (const SCEVTruncateExpr *Cast = dyn_cast<SCEVTruncateExpr>(V)) {
6217     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
6218     if (Op == Cast->getOperand())
6219       return Cast;  // must be loop invariant
6220     return getTruncateExpr(Op, Cast->getType());
6221   }
6222
6223   llvm_unreachable("Unknown SCEV type!");
6224 }
6225
6226 /// getSCEVAtScope - This is a convenience function which does
6227 /// getSCEVAtScope(getSCEV(V), L).
6228 const SCEV *ScalarEvolution::getSCEVAtScope(Value *V, const Loop *L) {
6229   return getSCEVAtScope(getSCEV(V), L);
6230 }
6231
6232 /// SolveLinEquationWithOverflow - Finds the minimum unsigned root of the
6233 /// following equation:
6234 ///
6235 ///     A * X = B (mod N)
6236 ///
6237 /// where N = 2^BW and BW is the common bit width of A and B. The signedness of
6238 /// A and B isn't important.
6239 ///
6240 /// If the equation does not have a solution, SCEVCouldNotCompute is returned.
6241 static const SCEV *SolveLinEquationWithOverflow(const APInt &A, const APInt &B,
6242                                                ScalarEvolution &SE) {
6243   uint32_t BW = A.getBitWidth();
6244   assert(BW == B.getBitWidth() && "Bit widths must be the same.");
6245   assert(A != 0 && "A must be non-zero.");
6246
6247   // 1. D = gcd(A, N)
6248   //
6249   // The gcd of A and N may have only one prime factor: 2. The number of
6250   // trailing zeros in A is its multiplicity
6251   uint32_t Mult2 = A.countTrailingZeros();
6252   // D = 2^Mult2
6253
6254   // 2. Check if B is divisible by D.
6255   //
6256   // B is divisible by D if and only if the multiplicity of prime factor 2 for B
6257   // is not less than multiplicity of this prime factor for D.
6258   if (B.countTrailingZeros() < Mult2)
6259     return SE.getCouldNotCompute();
6260
6261   // 3. Compute I: the multiplicative inverse of (A / D) in arithmetic
6262   // modulo (N / D).
6263   //
6264   // (N / D) may need BW+1 bits in its representation.  Hence, we'll use this
6265   // bit width during computations.
6266   APInt AD = A.lshr(Mult2).zext(BW + 1);  // AD = A / D
6267   APInt Mod(BW + 1, 0);
6268   Mod.setBit(BW - Mult2);  // Mod = N / D
6269   APInt I = AD.multiplicativeInverse(Mod);
6270
6271   // 4. Compute the minimum unsigned root of the equation:
6272   // I * (B / D) mod (N / D)
6273   APInt Result = (I * B.lshr(Mult2).zext(BW + 1)).urem(Mod);
6274
6275   // The result is guaranteed to be less than 2^BW so we may truncate it to BW
6276   // bits.
6277   return SE.getConstant(Result.trunc(BW));
6278 }
6279
6280 /// SolveQuadraticEquation - Find the roots of the quadratic equation for the
6281 /// given quadratic chrec {L,+,M,+,N}.  This returns either the two roots (which
6282 /// might be the same) or two SCEVCouldNotCompute objects.
6283 ///
6284 static std::pair<const SCEV *,const SCEV *>
6285 SolveQuadraticEquation(const SCEVAddRecExpr *AddRec, ScalarEvolution &SE) {
6286   assert(AddRec->getNumOperands() == 3 && "This is not a quadratic chrec!");
6287   const SCEVConstant *LC = dyn_cast<SCEVConstant>(AddRec->getOperand(0));
6288   const SCEVConstant *MC = dyn_cast<SCEVConstant>(AddRec->getOperand(1));
6289   const SCEVConstant *NC = dyn_cast<SCEVConstant>(AddRec->getOperand(2));
6290
6291   // We currently can only solve this if the coefficients are constants.
6292   if (!LC || !MC || !NC) {
6293     const SCEV *CNC = SE.getCouldNotCompute();
6294     return std::make_pair(CNC, CNC);
6295   }
6296
6297   uint32_t BitWidth = LC->getValue()->getValue().getBitWidth();
6298   const APInt &L = LC->getValue()->getValue();
6299   const APInt &M = MC->getValue()->getValue();
6300   const APInt &N = NC->getValue()->getValue();
6301   APInt Two(BitWidth, 2);
6302   APInt Four(BitWidth, 4);
6303
6304   {
6305     using namespace APIntOps;
6306     const APInt& C = L;
6307     // Convert from chrec coefficients to polynomial coefficients AX^2+BX+C
6308     // The B coefficient is M-N/2
6309     APInt B(M);
6310     B -= sdiv(N,Two);
6311
6312     // The A coefficient is N/2
6313     APInt A(N.sdiv(Two));
6314
6315     // Compute the B^2-4ac term.
6316     APInt SqrtTerm(B);
6317     SqrtTerm *= B;
6318     SqrtTerm -= Four * (A * C);
6319
6320     if (SqrtTerm.isNegative()) {
6321       // The loop is provably infinite.
6322       const SCEV *CNC = SE.getCouldNotCompute();
6323       return std::make_pair(CNC, CNC);
6324     }
6325
6326     // Compute sqrt(B^2-4ac). This is guaranteed to be the nearest
6327     // integer value or else APInt::sqrt() will assert.
6328     APInt SqrtVal(SqrtTerm.sqrt());
6329
6330     // Compute the two solutions for the quadratic formula.
6331     // The divisions must be performed as signed divisions.
6332     APInt NegB(-B);
6333     APInt TwoA(A << 1);
6334     if (TwoA.isMinValue()) {
6335       const SCEV *CNC = SE.getCouldNotCompute();
6336       return std::make_pair(CNC, CNC);
6337     }
6338
6339     LLVMContext &Context = SE.getContext();
6340
6341     ConstantInt *Solution1 =
6342       ConstantInt::get(Context, (NegB + SqrtVal).sdiv(TwoA));
6343     ConstantInt *Solution2 =
6344       ConstantInt::get(Context, (NegB - SqrtVal).sdiv(TwoA));
6345
6346     return std::make_pair(SE.getConstant(Solution1),
6347                           SE.getConstant(Solution2));
6348   } // end APIntOps namespace
6349 }
6350
6351 /// HowFarToZero - Return the number of times a backedge comparing the specified
6352 /// value to zero will execute.  If not computable, return CouldNotCompute.
6353 ///
6354 /// This is only used for loops with a "x != y" exit test. The exit condition is
6355 /// now expressed as a single expression, V = x-y. So the exit test is
6356 /// effectively V != 0.  We know and take advantage of the fact that this
6357 /// expression only being used in a comparison by zero context.
6358 ScalarEvolution::ExitLimit
6359 ScalarEvolution::HowFarToZero(const SCEV *V, const Loop *L, bool ControlsExit) {
6360   // If the value is a constant
6361   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
6362     // If the value is already zero, the branch will execute zero times.
6363     if (C->getValue()->isZero()) return C;
6364     return getCouldNotCompute();  // Otherwise it will loop infinitely.
6365   }
6366
6367   const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V);
6368   if (!AddRec || AddRec->getLoop() != L)
6369     return getCouldNotCompute();
6370
6371   // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of
6372   // the quadratic equation to solve it.
6373   if (AddRec->isQuadratic() && AddRec->getType()->isIntegerTy()) {
6374     std::pair<const SCEV *,const SCEV *> Roots =
6375       SolveQuadraticEquation(AddRec, *this);
6376     const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
6377     const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
6378     if (R1 && R2) {
6379 #if 0
6380       dbgs() << "HFTZ: " << *V << " - sol#1: " << *R1
6381              << "  sol#2: " << *R2 << "\n";
6382 #endif
6383       // Pick the smallest positive root value.
6384       if (ConstantInt *CB =
6385           dyn_cast<ConstantInt>(ConstantExpr::getICmp(CmpInst::ICMP_ULT,
6386                                                       R1->getValue(),
6387                                                       R2->getValue()))) {
6388         if (!CB->getZExtValue())
6389           std::swap(R1, R2);   // R1 is the minimum root now.
6390
6391         // We can only use this value if the chrec ends up with an exact zero
6392         // value at this index.  When solving for "X*X != 5", for example, we
6393         // should not accept a root of 2.
6394         const SCEV *Val = AddRec->evaluateAtIteration(R1, *this);
6395         if (Val->isZero())
6396           return R1;  // We found a quadratic root!
6397       }
6398     }
6399     return getCouldNotCompute();
6400   }
6401
6402   // Otherwise we can only handle this if it is affine.
6403   if (!AddRec->isAffine())
6404     return getCouldNotCompute();
6405
6406   // If this is an affine expression, the execution count of this branch is
6407   // the minimum unsigned root of the following equation:
6408   //
6409   //     Start + Step*N = 0 (mod 2^BW)
6410   //
6411   // equivalent to:
6412   //
6413   //             Step*N = -Start (mod 2^BW)
6414   //
6415   // where BW is the common bit width of Start and Step.
6416
6417   // Get the initial value for the loop.
6418   const SCEV *Start = getSCEVAtScope(AddRec->getStart(), L->getParentLoop());
6419   const SCEV *Step = getSCEVAtScope(AddRec->getOperand(1), L->getParentLoop());
6420
6421   // For now we handle only constant steps.
6422   //
6423   // TODO: Handle a nonconstant Step given AddRec<NUW>. If the
6424   // AddRec is NUW, then (in an unsigned sense) it cannot be counting up to wrap
6425   // to 0, it must be counting down to equal 0. Consequently, N = Start / -Step.
6426   // We have not yet seen any such cases.
6427   const SCEVConstant *StepC = dyn_cast<SCEVConstant>(Step);
6428   if (!StepC || StepC->getValue()->equalsInt(0))
6429     return getCouldNotCompute();
6430
6431   // For positive steps (counting up until unsigned overflow):
6432   //   N = -Start/Step (as unsigned)
6433   // For negative steps (counting down to zero):
6434   //   N = Start/-Step
6435   // First compute the unsigned distance from zero in the direction of Step.
6436   bool CountDown = StepC->getValue()->getValue().isNegative();
6437   const SCEV *Distance = CountDown ? Start : getNegativeSCEV(Start);
6438
6439   // Handle unitary steps, which cannot wraparound.
6440   // 1*N = -Start; -1*N = Start (mod 2^BW), so:
6441   //   N = Distance (as unsigned)
6442   if (StepC->getValue()->equalsInt(1) || StepC->getValue()->isAllOnesValue()) {
6443     ConstantRange CR = getUnsignedRange(Start);
6444     const SCEV *MaxBECount;
6445     if (!CountDown && CR.getUnsignedMin().isMinValue())
6446       // When counting up, the worst starting value is 1, not 0.
6447       MaxBECount = CR.getUnsignedMax().isMinValue()
6448         ? getConstant(APInt::getMinValue(CR.getBitWidth()))
6449         : getConstant(APInt::getMaxValue(CR.getBitWidth()));
6450     else
6451       MaxBECount = getConstant(CountDown ? CR.getUnsignedMax()
6452                                          : -CR.getUnsignedMin());
6453     return ExitLimit(Distance, MaxBECount);
6454   }
6455
6456   // As a special case, handle the instance where Step is a positive power of
6457   // two. In this case, determining whether Step divides Distance evenly can be
6458   // done by counting and comparing the number of trailing zeros of Step and
6459   // Distance.
6460   if (!CountDown) {
6461     const APInt &StepV = StepC->getValue()->getValue();
6462     // StepV.isPowerOf2() returns true if StepV is an positive power of two.  It
6463     // also returns true if StepV is maximally negative (eg, INT_MIN), but that
6464     // case is not handled as this code is guarded by !CountDown.
6465     if (StepV.isPowerOf2() &&
6466         GetMinTrailingZeros(Distance) >= StepV.countTrailingZeros()) {
6467       // Here we've constrained the equation to be of the form
6468       //
6469       //   2^(N + k) * Distance' = (StepV == 2^N) * X (mod 2^W)  ... (0)
6470       //
6471       // where we're operating on a W bit wide integer domain and k is
6472       // non-negative.  The smallest unsigned solution for X is the trip count.
6473       //
6474       // (0) is equivalent to:
6475       //
6476       //      2^(N + k) * Distance' - 2^N * X = L * 2^W
6477       // <=>  2^N(2^k * Distance' - X) = L * 2^(W - N) * 2^N
6478       // <=>  2^k * Distance' - X = L * 2^(W - N)
6479       // <=>  2^k * Distance'     = L * 2^(W - N) + X    ... (1)
6480       //
6481       // The smallest X satisfying (1) is unsigned remainder of dividing the LHS
6482       // by 2^(W - N).
6483       //
6484       // <=>  X = 2^k * Distance' URem 2^(W - N)   ... (2)
6485       //
6486       // E.g. say we're solving
6487       //
6488       //   2 * Val = 2 * X  (in i8)   ... (3)
6489       //
6490       // then from (2), we get X = Val URem i8 128 (k = 0 in this case).
6491       //
6492       // Note: It is tempting to solve (3) by setting X = Val, but Val is not
6493       // necessarily the smallest unsigned value of X that satisfies (3).
6494       // E.g. if Val is i8 -127 then the smallest value of X that satisfies (3)
6495       // is i8 1, not i8 -127
6496
6497       const auto *ModuloResult = getUDivExactExpr(Distance, Step);
6498
6499       // Since SCEV does not have a URem node, we construct one using a truncate
6500       // and a zero extend.
6501
6502       unsigned NarrowWidth = StepV.getBitWidth() - StepV.countTrailingZeros();
6503       auto *NarrowTy = IntegerType::get(getContext(), NarrowWidth);
6504       auto *WideTy = Distance->getType();
6505
6506       return getZeroExtendExpr(getTruncateExpr(ModuloResult, NarrowTy), WideTy);
6507     }
6508   }
6509
6510   // If the condition controls loop exit (the loop exits only if the expression
6511   // is true) and the addition is no-wrap we can use unsigned divide to
6512   // compute the backedge count.  In this case, the step may not divide the
6513   // distance, but we don't care because if the condition is "missed" the loop
6514   // will have undefined behavior due to wrapping.
6515   if (ControlsExit && AddRec->getNoWrapFlags(SCEV::FlagNW)) {
6516     const SCEV *Exact =
6517         getUDivExpr(Distance, CountDown ? getNegativeSCEV(Step) : Step);
6518     return ExitLimit(Exact, Exact);
6519   }
6520
6521   // Then, try to solve the above equation provided that Start is constant.
6522   if (const SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start))
6523     return SolveLinEquationWithOverflow(StepC->getValue()->getValue(),
6524                                         -StartC->getValue()->getValue(),
6525                                         *this);
6526   return getCouldNotCompute();
6527 }
6528
6529 /// HowFarToNonZero - Return the number of times a backedge checking the
6530 /// specified value for nonzero will execute.  If not computable, return
6531 /// CouldNotCompute
6532 ScalarEvolution::ExitLimit
6533 ScalarEvolution::HowFarToNonZero(const SCEV *V, const Loop *L) {
6534   // Loops that look like: while (X == 0) are very strange indeed.  We don't
6535   // handle them yet except for the trivial case.  This could be expanded in the
6536   // future as needed.
6537
6538   // If the value is a constant, check to see if it is known to be non-zero
6539   // already.  If so, the backedge will execute zero times.
6540   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
6541     if (!C->getValue()->isNullValue())
6542       return getZero(C->getType());
6543     return getCouldNotCompute();  // Otherwise it will loop infinitely.
6544   }
6545
6546   // We could implement others, but I really doubt anyone writes loops like
6547   // this, and if they did, they would already be constant folded.
6548   return getCouldNotCompute();
6549 }
6550
6551 /// getPredecessorWithUniqueSuccessorForBB - Return a predecessor of BB
6552 /// (which may not be an immediate predecessor) which has exactly one
6553 /// successor from which BB is reachable, or null if no such block is
6554 /// found.
6555 ///
6556 std::pair<BasicBlock *, BasicBlock *>
6557 ScalarEvolution::getPredecessorWithUniqueSuccessorForBB(BasicBlock *BB) {
6558   // If the block has a unique predecessor, then there is no path from the
6559   // predecessor to the block that does not go through the direct edge
6560   // from the predecessor to the block.
6561   if (BasicBlock *Pred = BB->getSinglePredecessor())
6562     return std::make_pair(Pred, BB);
6563
6564   // A loop's header is defined to be a block that dominates the loop.
6565   // If the header has a unique predecessor outside the loop, it must be
6566   // a block that has exactly one successor that can reach the loop.
6567   if (Loop *L = LI.getLoopFor(BB))
6568     return std::make_pair(L->getLoopPredecessor(), L->getHeader());
6569
6570   return std::pair<BasicBlock *, BasicBlock *>();
6571 }
6572
6573 /// HasSameValue - SCEV structural equivalence is usually sufficient for
6574 /// testing whether two expressions are equal, however for the purposes of
6575 /// looking for a condition guarding a loop, it can be useful to be a little
6576 /// more general, since a front-end may have replicated the controlling
6577 /// expression.
6578 ///
6579 static bool HasSameValue(const SCEV *A, const SCEV *B) {
6580   // Quick check to see if they are the same SCEV.
6581   if (A == B) return true;
6582
6583   auto ComputesEqualValues = [](const Instruction *A, const Instruction *B) {
6584     // Not all instructions that are "identical" compute the same value.  For
6585     // instance, two distinct alloca instructions allocating the same type are
6586     // identical and do not read memory; but compute distinct values.
6587     return A->isIdenticalTo(B) && (isa<BinaryOperator>(A) || isa<GetElementPtrInst>(A));
6588   };
6589
6590   // Otherwise, if they're both SCEVUnknown, it's possible that they hold
6591   // two different instructions with the same value. Check for this case.
6592   if (const SCEVUnknown *AU = dyn_cast<SCEVUnknown>(A))
6593     if (const SCEVUnknown *BU = dyn_cast<SCEVUnknown>(B))
6594       if (const Instruction *AI = dyn_cast<Instruction>(AU->getValue()))
6595         if (const Instruction *BI = dyn_cast<Instruction>(BU->getValue()))
6596           if (ComputesEqualValues(AI, BI))
6597             return true;
6598
6599   // Otherwise assume they may have a different value.
6600   return false;
6601 }
6602
6603 /// SimplifyICmpOperands - Simplify LHS and RHS in a comparison with
6604 /// predicate Pred. Return true iff any changes were made.
6605 ///
6606 bool ScalarEvolution::SimplifyICmpOperands(ICmpInst::Predicate &Pred,
6607                                            const SCEV *&LHS, const SCEV *&RHS,
6608                                            unsigned Depth) {
6609   bool Changed = false;
6610
6611   // If we hit the max recursion limit bail out.
6612   if (Depth >= 3)
6613     return false;
6614
6615   // Canonicalize a constant to the right side.
6616   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
6617     // Check for both operands constant.
6618     if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
6619       if (ConstantExpr::getICmp(Pred,
6620                                 LHSC->getValue(),
6621                                 RHSC->getValue())->isNullValue())
6622         goto trivially_false;
6623       else
6624         goto trivially_true;
6625     }
6626     // Otherwise swap the operands to put the constant on the right.
6627     std::swap(LHS, RHS);
6628     Pred = ICmpInst::getSwappedPredicate(Pred);
6629     Changed = true;
6630   }
6631
6632   // If we're comparing an addrec with a value which is loop-invariant in the
6633   // addrec's loop, put the addrec on the left. Also make a dominance check,
6634   // as both operands could be addrecs loop-invariant in each other's loop.
6635   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS)) {
6636     const Loop *L = AR->getLoop();
6637     if (isLoopInvariant(LHS, L) && properlyDominates(LHS, L->getHeader())) {
6638       std::swap(LHS, RHS);
6639       Pred = ICmpInst::getSwappedPredicate(Pred);
6640       Changed = true;
6641     }
6642   }
6643
6644   // If there's a constant operand, canonicalize comparisons with boundary
6645   // cases, and canonicalize *-or-equal comparisons to regular comparisons.
6646   if (const SCEVConstant *RC = dyn_cast<SCEVConstant>(RHS)) {
6647     const APInt &RA = RC->getValue()->getValue();
6648     switch (Pred) {
6649     default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
6650     case ICmpInst::ICMP_EQ:
6651     case ICmpInst::ICMP_NE:
6652       // Fold ((-1) * %a) + %b == 0 (equivalent to %b-%a == 0) into %a == %b.
6653       if (!RA)
6654         if (const SCEVAddExpr *AE = dyn_cast<SCEVAddExpr>(LHS))
6655           if (const SCEVMulExpr *ME = dyn_cast<SCEVMulExpr>(AE->getOperand(0)))
6656             if (AE->getNumOperands() == 2 && ME->getNumOperands() == 2 &&
6657                 ME->getOperand(0)->isAllOnesValue()) {
6658               RHS = AE->getOperand(1);
6659               LHS = ME->getOperand(1);
6660               Changed = true;
6661             }
6662       break;
6663     case ICmpInst::ICMP_UGE:
6664       if ((RA - 1).isMinValue()) {
6665         Pred = ICmpInst::ICMP_NE;
6666         RHS = getConstant(RA - 1);
6667         Changed = true;
6668         break;
6669       }
6670       if (RA.isMaxValue()) {
6671         Pred = ICmpInst::ICMP_EQ;
6672         Changed = true;
6673         break;
6674       }
6675       if (RA.isMinValue()) goto trivially_true;
6676
6677       Pred = ICmpInst::ICMP_UGT;
6678       RHS = getConstant(RA - 1);
6679       Changed = true;
6680       break;
6681     case ICmpInst::ICMP_ULE:
6682       if ((RA + 1).isMaxValue()) {
6683         Pred = ICmpInst::ICMP_NE;
6684         RHS = getConstant(RA + 1);
6685         Changed = true;
6686         break;
6687       }
6688       if (RA.isMinValue()) {
6689         Pred = ICmpInst::ICMP_EQ;
6690         Changed = true;
6691         break;
6692       }
6693       if (RA.isMaxValue()) goto trivially_true;
6694
6695       Pred = ICmpInst::ICMP_ULT;
6696       RHS = getConstant(RA + 1);
6697       Changed = true;
6698       break;
6699     case ICmpInst::ICMP_SGE:
6700       if ((RA - 1).isMinSignedValue()) {
6701         Pred = ICmpInst::ICMP_NE;
6702         RHS = getConstant(RA - 1);
6703         Changed = true;
6704         break;
6705       }
6706       if (RA.isMaxSignedValue()) {
6707         Pred = ICmpInst::ICMP_EQ;
6708         Changed = true;
6709         break;
6710       }
6711       if (RA.isMinSignedValue()) goto trivially_true;
6712
6713       Pred = ICmpInst::ICMP_SGT;
6714       RHS = getConstant(RA - 1);
6715       Changed = true;
6716       break;
6717     case ICmpInst::ICMP_SLE:
6718       if ((RA + 1).isMaxSignedValue()) {
6719         Pred = ICmpInst::ICMP_NE;
6720         RHS = getConstant(RA + 1);
6721         Changed = true;
6722         break;
6723       }
6724       if (RA.isMinSignedValue()) {
6725         Pred = ICmpInst::ICMP_EQ;
6726         Changed = true;
6727         break;
6728       }
6729       if (RA.isMaxSignedValue()) goto trivially_true;
6730
6731       Pred = ICmpInst::ICMP_SLT;
6732       RHS = getConstant(RA + 1);
6733       Changed = true;
6734       break;
6735     case ICmpInst::ICMP_UGT:
6736       if (RA.isMinValue()) {
6737         Pred = ICmpInst::ICMP_NE;
6738         Changed = true;
6739         break;
6740       }
6741       if ((RA + 1).isMaxValue()) {
6742         Pred = ICmpInst::ICMP_EQ;
6743         RHS = getConstant(RA + 1);
6744         Changed = true;
6745         break;
6746       }
6747       if (RA.isMaxValue()) goto trivially_false;
6748       break;
6749     case ICmpInst::ICMP_ULT:
6750       if (RA.isMaxValue()) {
6751         Pred = ICmpInst::ICMP_NE;
6752         Changed = true;
6753         break;
6754       }
6755       if ((RA - 1).isMinValue()) {
6756         Pred = ICmpInst::ICMP_EQ;
6757         RHS = getConstant(RA - 1);
6758         Changed = true;
6759         break;
6760       }
6761       if (RA.isMinValue()) goto trivially_false;
6762       break;
6763     case ICmpInst::ICMP_SGT:
6764       if (RA.isMinSignedValue()) {
6765         Pred = ICmpInst::ICMP_NE;
6766         Changed = true;
6767         break;
6768       }
6769       if ((RA + 1).isMaxSignedValue()) {
6770         Pred = ICmpInst::ICMP_EQ;
6771         RHS = getConstant(RA + 1);
6772         Changed = true;
6773         break;
6774       }
6775       if (RA.isMaxSignedValue()) goto trivially_false;
6776       break;
6777     case ICmpInst::ICMP_SLT:
6778       if (RA.isMaxSignedValue()) {
6779         Pred = ICmpInst::ICMP_NE;
6780         Changed = true;
6781         break;
6782       }
6783       if ((RA - 1).isMinSignedValue()) {
6784        Pred = ICmpInst::ICMP_EQ;
6785        RHS = getConstant(RA - 1);
6786         Changed = true;
6787        break;
6788       }
6789       if (RA.isMinSignedValue()) goto trivially_false;
6790       break;
6791     }
6792   }
6793
6794   // Check for obvious equality.
6795   if (HasSameValue(LHS, RHS)) {
6796     if (ICmpInst::isTrueWhenEqual(Pred))
6797       goto trivially_true;
6798     if (ICmpInst::isFalseWhenEqual(Pred))
6799       goto trivially_false;
6800   }
6801
6802   // If possible, canonicalize GE/LE comparisons to GT/LT comparisons, by
6803   // adding or subtracting 1 from one of the operands.
6804   switch (Pred) {
6805   case ICmpInst::ICMP_SLE:
6806     if (!getSignedRange(RHS).getSignedMax().isMaxSignedValue()) {
6807       RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
6808                        SCEV::FlagNSW);
6809       Pred = ICmpInst::ICMP_SLT;
6810       Changed = true;
6811     } else if (!getSignedRange(LHS).getSignedMin().isMinSignedValue()) {
6812       LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
6813                        SCEV::FlagNSW);
6814       Pred = ICmpInst::ICMP_SLT;
6815       Changed = true;
6816     }
6817     break;
6818   case ICmpInst::ICMP_SGE:
6819     if (!getSignedRange(RHS).getSignedMin().isMinSignedValue()) {
6820       RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
6821                        SCEV::FlagNSW);
6822       Pred = ICmpInst::ICMP_SGT;
6823       Changed = true;
6824     } else if (!getSignedRange(LHS).getSignedMax().isMaxSignedValue()) {
6825       LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
6826                        SCEV::FlagNSW);
6827       Pred = ICmpInst::ICMP_SGT;
6828       Changed = true;
6829     }
6830     break;
6831   case ICmpInst::ICMP_ULE:
6832     if (!getUnsignedRange(RHS).getUnsignedMax().isMaxValue()) {
6833       RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
6834                        SCEV::FlagNUW);
6835       Pred = ICmpInst::ICMP_ULT;
6836       Changed = true;
6837     } else if (!getUnsignedRange(LHS).getUnsignedMin().isMinValue()) {
6838       LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
6839                        SCEV::FlagNUW);
6840       Pred = ICmpInst::ICMP_ULT;
6841       Changed = true;
6842     }
6843     break;
6844   case ICmpInst::ICMP_UGE:
6845     if (!getUnsignedRange(RHS).getUnsignedMin().isMinValue()) {
6846       RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
6847                        SCEV::FlagNUW);
6848       Pred = ICmpInst::ICMP_UGT;
6849       Changed = true;
6850     } else if (!getUnsignedRange(LHS).getUnsignedMax().isMaxValue()) {
6851       LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
6852                        SCEV::FlagNUW);
6853       Pred = ICmpInst::ICMP_UGT;
6854       Changed = true;
6855     }
6856     break;
6857   default:
6858     break;
6859   }
6860
6861   // TODO: More simplifications are possible here.
6862
6863   // Recursively simplify until we either hit a recursion limit or nothing
6864   // changes.
6865   if (Changed)
6866     return SimplifyICmpOperands(Pred, LHS, RHS, Depth+1);
6867
6868   return Changed;
6869
6870 trivially_true:
6871   // Return 0 == 0.
6872   LHS = RHS = getConstant(ConstantInt::getFalse(getContext()));
6873   Pred = ICmpInst::ICMP_EQ;
6874   return true;
6875
6876 trivially_false:
6877   // Return 0 != 0.
6878   LHS = RHS = getConstant(ConstantInt::getFalse(getContext()));
6879   Pred = ICmpInst::ICMP_NE;
6880   return true;
6881 }
6882
6883 bool ScalarEvolution::isKnownNegative(const SCEV *S) {
6884   return getSignedRange(S).getSignedMax().isNegative();
6885 }
6886
6887 bool ScalarEvolution::isKnownPositive(const SCEV *S) {
6888   return getSignedRange(S).getSignedMin().isStrictlyPositive();
6889 }
6890
6891 bool ScalarEvolution::isKnownNonNegative(const SCEV *S) {
6892   return !getSignedRange(S).getSignedMin().isNegative();
6893 }
6894
6895 bool ScalarEvolution::isKnownNonPositive(const SCEV *S) {
6896   return !getSignedRange(S).getSignedMax().isStrictlyPositive();
6897 }
6898
6899 bool ScalarEvolution::isKnownNonZero(const SCEV *S) {
6900   return isKnownNegative(S) || isKnownPositive(S);
6901 }
6902
6903 bool ScalarEvolution::isKnownPredicate(ICmpInst::Predicate Pred,
6904                                        const SCEV *LHS, const SCEV *RHS) {
6905   // Canonicalize the inputs first.
6906   (void)SimplifyICmpOperands(Pred, LHS, RHS);
6907
6908   // If LHS or RHS is an addrec, check to see if the condition is true in
6909   // every iteration of the loop.
6910   // If LHS and RHS are both addrec, both conditions must be true in
6911   // every iteration of the loop.
6912   const SCEVAddRecExpr *LAR = dyn_cast<SCEVAddRecExpr>(LHS);
6913   const SCEVAddRecExpr *RAR = dyn_cast<SCEVAddRecExpr>(RHS);
6914   bool LeftGuarded = false;
6915   bool RightGuarded = false;
6916   if (LAR) {
6917     const Loop *L = LAR->getLoop();
6918     if (isLoopEntryGuardedByCond(L, Pred, LAR->getStart(), RHS) &&
6919         isLoopBackedgeGuardedByCond(L, Pred, LAR->getPostIncExpr(*this), RHS)) {
6920       if (!RAR) return true;
6921       LeftGuarded = true;
6922     }
6923   }
6924   if (RAR) {
6925     const Loop *L = RAR->getLoop();
6926     if (isLoopEntryGuardedByCond(L, Pred, LHS, RAR->getStart()) &&
6927         isLoopBackedgeGuardedByCond(L, Pred, LHS, RAR->getPostIncExpr(*this))) {
6928       if (!LAR) return true;
6929       RightGuarded = true;
6930     }
6931   }
6932   if (LeftGuarded && RightGuarded)
6933     return true;
6934
6935   if (isKnownPredicateViaSplitting(Pred, LHS, RHS))
6936     return true;
6937
6938   // Otherwise see what can be done with known constant ranges.
6939   return isKnownPredicateWithRanges(Pred, LHS, RHS);
6940 }
6941
6942 bool ScalarEvolution::isMonotonicPredicate(const SCEVAddRecExpr *LHS,
6943                                            ICmpInst::Predicate Pred,
6944                                            bool &Increasing) {
6945   bool Result = isMonotonicPredicateImpl(LHS, Pred, Increasing);
6946
6947 #ifndef NDEBUG
6948   // Verify an invariant: inverting the predicate should turn a monotonically
6949   // increasing change to a monotonically decreasing one, and vice versa.
6950   bool IncreasingSwapped;
6951   bool ResultSwapped = isMonotonicPredicateImpl(
6952       LHS, ICmpInst::getSwappedPredicate(Pred), IncreasingSwapped);
6953
6954   assert(Result == ResultSwapped && "should be able to analyze both!");
6955   if (ResultSwapped)
6956     assert(Increasing == !IncreasingSwapped &&
6957            "monotonicity should flip as we flip the predicate");
6958 #endif
6959
6960   return Result;
6961 }
6962
6963 bool ScalarEvolution::isMonotonicPredicateImpl(const SCEVAddRecExpr *LHS,
6964                                                ICmpInst::Predicate Pred,
6965                                                bool &Increasing) {
6966
6967   // A zero step value for LHS means the induction variable is essentially a
6968   // loop invariant value. We don't really depend on the predicate actually
6969   // flipping from false to true (for increasing predicates, and the other way
6970   // around for decreasing predicates), all we care about is that *if* the
6971   // predicate changes then it only changes from false to true.
6972   //
6973   // A zero step value in itself is not very useful, but there may be places
6974   // where SCEV can prove X >= 0 but not prove X > 0, so it is helpful to be
6975   // as general as possible.
6976
6977   switch (Pred) {
6978   default:
6979     return false; // Conservative answer
6980
6981   case ICmpInst::ICMP_UGT:
6982   case ICmpInst::ICMP_UGE:
6983   case ICmpInst::ICMP_ULT:
6984   case ICmpInst::ICMP_ULE:
6985     if (!LHS->getNoWrapFlags(SCEV::FlagNUW))
6986       return false;
6987
6988     Increasing = Pred == ICmpInst::ICMP_UGT || Pred == ICmpInst::ICMP_UGE;
6989     return true;
6990
6991   case ICmpInst::ICMP_SGT:
6992   case ICmpInst::ICMP_SGE:
6993   case ICmpInst::ICMP_SLT:
6994   case ICmpInst::ICMP_SLE: {
6995     if (!LHS->getNoWrapFlags(SCEV::FlagNSW))
6996       return false;
6997
6998     const SCEV *Step = LHS->getStepRecurrence(*this);
6999
7000     if (isKnownNonNegative(Step)) {
7001       Increasing = Pred == ICmpInst::ICMP_SGT || Pred == ICmpInst::ICMP_SGE;
7002       return true;
7003     }
7004
7005     if (isKnownNonPositive(Step)) {
7006       Increasing = Pred == ICmpInst::ICMP_SLT || Pred == ICmpInst::ICMP_SLE;
7007       return true;
7008     }
7009
7010     return false;
7011   }
7012
7013   }
7014
7015   llvm_unreachable("switch has default clause!");
7016 }
7017
7018 bool ScalarEvolution::isLoopInvariantPredicate(
7019     ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS, const Loop *L,
7020     ICmpInst::Predicate &InvariantPred, const SCEV *&InvariantLHS,
7021     const SCEV *&InvariantRHS) {
7022
7023   // If there is a loop-invariant, force it into the RHS, otherwise bail out.
7024   if (!isLoopInvariant(RHS, L)) {
7025     if (!isLoopInvariant(LHS, L))
7026       return false;
7027
7028     std::swap(LHS, RHS);
7029     Pred = ICmpInst::getSwappedPredicate(Pred);
7030   }
7031
7032   const SCEVAddRecExpr *ArLHS = dyn_cast<SCEVAddRecExpr>(LHS);
7033   if (!ArLHS || ArLHS->getLoop() != L)
7034     return false;
7035
7036   bool Increasing;
7037   if (!isMonotonicPredicate(ArLHS, Pred, Increasing))
7038     return false;
7039
7040   // If the predicate "ArLHS `Pred` RHS" monotonically increases from false to
7041   // true as the loop iterates, and the backedge is control dependent on
7042   // "ArLHS `Pred` RHS" == true then we can reason as follows:
7043   //
7044   //   * if the predicate was false in the first iteration then the predicate
7045   //     is never evaluated again, since the loop exits without taking the
7046   //     backedge.
7047   //   * if the predicate was true in the first iteration then it will
7048   //     continue to be true for all future iterations since it is
7049   //     monotonically increasing.
7050   //
7051   // For both the above possibilities, we can replace the loop varying
7052   // predicate with its value on the first iteration of the loop (which is
7053   // loop invariant).
7054   //
7055   // A similar reasoning applies for a monotonically decreasing predicate, by
7056   // replacing true with false and false with true in the above two bullets.
7057
7058   auto P = Increasing ? Pred : ICmpInst::getInversePredicate(Pred);
7059
7060   if (!isLoopBackedgeGuardedByCond(L, P, LHS, RHS))
7061     return false;
7062
7063   InvariantPred = Pred;
7064   InvariantLHS = ArLHS->getStart();
7065   InvariantRHS = RHS;
7066   return true;
7067 }
7068
7069 bool
7070 ScalarEvolution::isKnownPredicateWithRanges(ICmpInst::Predicate Pred,
7071                                             const SCEV *LHS, const SCEV *RHS) {
7072   if (HasSameValue(LHS, RHS))
7073     return ICmpInst::isTrueWhenEqual(Pred);
7074
7075   // This code is split out from isKnownPredicate because it is called from
7076   // within isLoopEntryGuardedByCond.
7077   switch (Pred) {
7078   default:
7079     llvm_unreachable("Unexpected ICmpInst::Predicate value!");
7080   case ICmpInst::ICMP_SGT:
7081     std::swap(LHS, RHS);
7082   case ICmpInst::ICMP_SLT: {
7083     ConstantRange LHSRange = getSignedRange(LHS);
7084     ConstantRange RHSRange = getSignedRange(RHS);
7085     if (LHSRange.getSignedMax().slt(RHSRange.getSignedMin()))
7086       return true;
7087     if (LHSRange.getSignedMin().sge(RHSRange.getSignedMax()))
7088       return false;
7089     break;
7090   }
7091   case ICmpInst::ICMP_SGE:
7092     std::swap(LHS, RHS);
7093   case ICmpInst::ICMP_SLE: {
7094     ConstantRange LHSRange = getSignedRange(LHS);
7095     ConstantRange RHSRange = getSignedRange(RHS);
7096     if (LHSRange.getSignedMax().sle(RHSRange.getSignedMin()))
7097       return true;
7098     if (LHSRange.getSignedMin().sgt(RHSRange.getSignedMax()))
7099       return false;
7100     break;
7101   }
7102   case ICmpInst::ICMP_UGT:
7103     std::swap(LHS, RHS);
7104   case ICmpInst::ICMP_ULT: {
7105     ConstantRange LHSRange = getUnsignedRange(LHS);
7106     ConstantRange RHSRange = getUnsignedRange(RHS);
7107     if (LHSRange.getUnsignedMax().ult(RHSRange.getUnsignedMin()))
7108       return true;
7109     if (LHSRange.getUnsignedMin().uge(RHSRange.getUnsignedMax()))
7110       return false;
7111     break;
7112   }
7113   case ICmpInst::ICMP_UGE:
7114     std::swap(LHS, RHS);
7115   case ICmpInst::ICMP_ULE: {
7116     ConstantRange LHSRange = getUnsignedRange(LHS);
7117     ConstantRange RHSRange = getUnsignedRange(RHS);
7118     if (LHSRange.getUnsignedMax().ule(RHSRange.getUnsignedMin()))
7119       return true;
7120     if (LHSRange.getUnsignedMin().ugt(RHSRange.getUnsignedMax()))
7121       return false;
7122     break;
7123   }
7124   case ICmpInst::ICMP_NE: {
7125     if (getUnsignedRange(LHS).intersectWith(getUnsignedRange(RHS)).isEmptySet())
7126       return true;
7127     if (getSignedRange(LHS).intersectWith(getSignedRange(RHS)).isEmptySet())
7128       return true;
7129
7130     const SCEV *Diff = getMinusSCEV(LHS, RHS);
7131     if (isKnownNonZero(Diff))
7132       return true;
7133     break;
7134   }
7135   case ICmpInst::ICMP_EQ:
7136     // The check at the top of the function catches the case where
7137     // the values are known to be equal.
7138     break;
7139   }
7140   return false;
7141 }
7142
7143 bool ScalarEvolution::isKnownPredicateViaSplitting(ICmpInst::Predicate Pred,
7144                                                    const SCEV *LHS,
7145                                                    const SCEV *RHS) {
7146   if (Pred != ICmpInst::ICMP_ULT || ProvingSplitPredicate)
7147     return false;
7148
7149   // Allowing arbitrary number of activations of isKnownPredicateViaSplitting on
7150   // the stack can result in exponential time complexity.
7151   SaveAndRestore<bool> Restore(ProvingSplitPredicate, true);
7152
7153   // If L >= 0 then I `ult` L <=> I >= 0 && I `slt` L
7154   //
7155   // To prove L >= 0 we use isKnownNonNegative whereas to prove I >= 0 we use
7156   // isKnownPredicate.  isKnownPredicate is more powerful, but also more
7157   // expensive; and using isKnownNonNegative(RHS) is sufficient for most of the
7158   // interesting cases seen in practice.  We can consider "upgrading" L >= 0 to
7159   // use isKnownPredicate later if needed.
7160   if (isKnownNonNegative(RHS) &&
7161       isKnownPredicate(CmpInst::ICMP_SGE, LHS, getZero(LHS->getType())) &&
7162       isKnownPredicate(CmpInst::ICMP_SLT, LHS, RHS))
7163     return true;
7164
7165   return false;
7166 }
7167
7168 /// isLoopBackedgeGuardedByCond - Test whether the backedge of the loop is
7169 /// protected by a conditional between LHS and RHS.  This is used to
7170 /// to eliminate casts.
7171 bool
7172 ScalarEvolution::isLoopBackedgeGuardedByCond(const Loop *L,
7173                                              ICmpInst::Predicate Pred,
7174                                              const SCEV *LHS, const SCEV *RHS) {
7175   // Interpret a null as meaning no loop, where there is obviously no guard
7176   // (interprocedural conditions notwithstanding).
7177   if (!L) return true;
7178
7179   if (isKnownPredicateWithRanges(Pred, LHS, RHS)) return true;
7180
7181   BasicBlock *Latch = L->getLoopLatch();
7182   if (!Latch)
7183     return false;
7184
7185   BranchInst *LoopContinuePredicate =
7186     dyn_cast<BranchInst>(Latch->getTerminator());
7187   if (LoopContinuePredicate && LoopContinuePredicate->isConditional() &&
7188       isImpliedCond(Pred, LHS, RHS,
7189                     LoopContinuePredicate->getCondition(),
7190                     LoopContinuePredicate->getSuccessor(0) != L->getHeader()))
7191     return true;
7192
7193   // We don't want more than one activation of the following loops on the stack
7194   // -- that can lead to O(n!) time complexity.
7195   if (WalkingBEDominatingConds)
7196     return false;
7197
7198   SaveAndRestore<bool> ClearOnExit(WalkingBEDominatingConds, true);
7199
7200   // See if we can exploit a trip count to prove the predicate.
7201   const auto &BETakenInfo = getBackedgeTakenInfo(L);
7202   const SCEV *LatchBECount = BETakenInfo.getExact(Latch, this);
7203   if (LatchBECount != getCouldNotCompute()) {
7204     // We know that Latch branches back to the loop header exactly
7205     // LatchBECount times.  This means the backdege condition at Latch is
7206     // equivalent to  "{0,+,1} u< LatchBECount".
7207     Type *Ty = LatchBECount->getType();
7208     auto NoWrapFlags = SCEV::NoWrapFlags(SCEV::FlagNUW | SCEV::FlagNW);
7209     const SCEV *LoopCounter =
7210       getAddRecExpr(getZero(Ty), getOne(Ty), L, NoWrapFlags);
7211     if (isImpliedCond(Pred, LHS, RHS, ICmpInst::ICMP_ULT, LoopCounter,
7212                       LatchBECount))
7213       return true;
7214   }
7215
7216   // Check conditions due to any @llvm.assume intrinsics.
7217   for (auto &AssumeVH : AC.assumptions()) {
7218     if (!AssumeVH)
7219       continue;
7220     auto *CI = cast<CallInst>(AssumeVH);
7221     if (!DT.dominates(CI, Latch->getTerminator()))
7222       continue;
7223
7224     if (isImpliedCond(Pred, LHS, RHS, CI->getArgOperand(0), false))
7225       return true;
7226   }
7227
7228   // If the loop is not reachable from the entry block, we risk running into an
7229   // infinite loop as we walk up into the dom tree.  These loops do not matter
7230   // anyway, so we just return a conservative answer when we see them.
7231   if (!DT.isReachableFromEntry(L->getHeader()))
7232     return false;
7233
7234   for (DomTreeNode *DTN = DT[Latch], *HeaderDTN = DT[L->getHeader()];
7235        DTN != HeaderDTN; DTN = DTN->getIDom()) {
7236
7237     assert(DTN && "should reach the loop header before reaching the root!");
7238
7239     BasicBlock *BB = DTN->getBlock();
7240     BasicBlock *PBB = BB->getSinglePredecessor();
7241     if (!PBB)
7242       continue;
7243
7244     BranchInst *ContinuePredicate = dyn_cast<BranchInst>(PBB->getTerminator());
7245     if (!ContinuePredicate || !ContinuePredicate->isConditional())
7246       continue;
7247
7248     Value *Condition = ContinuePredicate->getCondition();
7249
7250     // If we have an edge `E` within the loop body that dominates the only
7251     // latch, the condition guarding `E` also guards the backedge.  This
7252     // reasoning works only for loops with a single latch.
7253
7254     BasicBlockEdge DominatingEdge(PBB, BB);
7255     if (DominatingEdge.isSingleEdge()) {
7256       // We're constructively (and conservatively) enumerating edges within the
7257       // loop body that dominate the latch.  The dominator tree better agree
7258       // with us on this:
7259       assert(DT.dominates(DominatingEdge, Latch) && "should be!");
7260
7261       if (isImpliedCond(Pred, LHS, RHS, Condition,
7262                         BB != ContinuePredicate->getSuccessor(0)))
7263         return true;
7264     }
7265   }
7266
7267   return false;
7268 }
7269
7270 /// isLoopEntryGuardedByCond - Test whether entry to the loop is protected
7271 /// by a conditional between LHS and RHS.  This is used to help avoid max
7272 /// expressions in loop trip counts, and to eliminate casts.
7273 bool
7274 ScalarEvolution::isLoopEntryGuardedByCond(const Loop *L,
7275                                           ICmpInst::Predicate Pred,
7276                                           const SCEV *LHS, const SCEV *RHS) {
7277   // Interpret a null as meaning no loop, where there is obviously no guard
7278   // (interprocedural conditions notwithstanding).
7279   if (!L) return false;
7280
7281   if (isKnownPredicateWithRanges(Pred, LHS, RHS)) return true;
7282
7283   // Starting at the loop predecessor, climb up the predecessor chain, as long
7284   // as there are predecessors that can be found that have unique successors
7285   // leading to the original header.
7286   for (std::pair<BasicBlock *, BasicBlock *>
7287          Pair(L->getLoopPredecessor(), L->getHeader());
7288        Pair.first;
7289        Pair = getPredecessorWithUniqueSuccessorForBB(Pair.first)) {
7290
7291     BranchInst *LoopEntryPredicate =
7292       dyn_cast<BranchInst>(Pair.first->getTerminator());
7293     if (!LoopEntryPredicate ||
7294         LoopEntryPredicate->isUnconditional())
7295       continue;
7296
7297     if (isImpliedCond(Pred, LHS, RHS,
7298                       LoopEntryPredicate->getCondition(),
7299                       LoopEntryPredicate->getSuccessor(0) != Pair.second))
7300       return true;
7301   }
7302
7303   // Check conditions due to any @llvm.assume intrinsics.
7304   for (auto &AssumeVH : AC.assumptions()) {
7305     if (!AssumeVH)
7306       continue;
7307     auto *CI = cast<CallInst>(AssumeVH);
7308     if (!DT.dominates(CI, L->getHeader()))
7309       continue;
7310
7311     if (isImpliedCond(Pred, LHS, RHS, CI->getArgOperand(0), false))
7312       return true;
7313   }
7314
7315   return false;
7316 }
7317
7318 /// RAII wrapper to prevent recursive application of isImpliedCond.
7319 /// ScalarEvolution's PendingLoopPredicates set must be empty unless we are
7320 /// currently evaluating isImpliedCond.
7321 struct MarkPendingLoopPredicate {
7322   Value *Cond;
7323   DenseSet<Value*> &LoopPreds;
7324   bool Pending;
7325
7326   MarkPendingLoopPredicate(Value *C, DenseSet<Value*> &LP)
7327     : Cond(C), LoopPreds(LP) {
7328     Pending = !LoopPreds.insert(Cond).second;
7329   }
7330   ~MarkPendingLoopPredicate() {
7331     if (!Pending)
7332       LoopPreds.erase(Cond);
7333   }
7334 };
7335
7336 /// isImpliedCond - Test whether the condition described by Pred, LHS,
7337 /// and RHS is true whenever the given Cond value evaluates to true.
7338 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred,
7339                                     const SCEV *LHS, const SCEV *RHS,
7340                                     Value *FoundCondValue,
7341                                     bool Inverse) {
7342   MarkPendingLoopPredicate Mark(FoundCondValue, PendingLoopPredicates);
7343   if (Mark.Pending)
7344     return false;
7345
7346   // Recursively handle And and Or conditions.
7347   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(FoundCondValue)) {
7348     if (BO->getOpcode() == Instruction::And) {
7349       if (!Inverse)
7350         return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
7351                isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
7352     } else if (BO->getOpcode() == Instruction::Or) {
7353       if (Inverse)
7354         return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
7355                isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
7356     }
7357   }
7358
7359   ICmpInst *ICI = dyn_cast<ICmpInst>(FoundCondValue);
7360   if (!ICI) return false;
7361
7362   // Now that we found a conditional branch that dominates the loop or controls
7363   // the loop latch. Check to see if it is the comparison we are looking for.
7364   ICmpInst::Predicate FoundPred;
7365   if (Inverse)
7366     FoundPred = ICI->getInversePredicate();
7367   else
7368     FoundPred = ICI->getPredicate();
7369
7370   const SCEV *FoundLHS = getSCEV(ICI->getOperand(0));
7371   const SCEV *FoundRHS = getSCEV(ICI->getOperand(1));
7372
7373   return isImpliedCond(Pred, LHS, RHS, FoundPred, FoundLHS, FoundRHS);
7374 }
7375
7376 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred, const SCEV *LHS,
7377                                     const SCEV *RHS,
7378                                     ICmpInst::Predicate FoundPred,
7379                                     const SCEV *FoundLHS,
7380                                     const SCEV *FoundRHS) {
7381   // Balance the types.
7382   if (getTypeSizeInBits(LHS->getType()) <
7383       getTypeSizeInBits(FoundLHS->getType())) {
7384     if (CmpInst::isSigned(Pred)) {
7385       LHS = getSignExtendExpr(LHS, FoundLHS->getType());
7386       RHS = getSignExtendExpr(RHS, FoundLHS->getType());
7387     } else {
7388       LHS = getZeroExtendExpr(LHS, FoundLHS->getType());
7389       RHS = getZeroExtendExpr(RHS, FoundLHS->getType());
7390     }
7391   } else if (getTypeSizeInBits(LHS->getType()) >
7392       getTypeSizeInBits(FoundLHS->getType())) {
7393     if (CmpInst::isSigned(FoundPred)) {
7394       FoundLHS = getSignExtendExpr(FoundLHS, LHS->getType());
7395       FoundRHS = getSignExtendExpr(FoundRHS, LHS->getType());
7396     } else {
7397       FoundLHS = getZeroExtendExpr(FoundLHS, LHS->getType());
7398       FoundRHS = getZeroExtendExpr(FoundRHS, LHS->getType());
7399     }
7400   }
7401
7402   // Canonicalize the query to match the way instcombine will have
7403   // canonicalized the comparison.
7404   if (SimplifyICmpOperands(Pred, LHS, RHS))
7405     if (LHS == RHS)
7406       return CmpInst::isTrueWhenEqual(Pred);
7407   if (SimplifyICmpOperands(FoundPred, FoundLHS, FoundRHS))
7408     if (FoundLHS == FoundRHS)
7409       return CmpInst::isFalseWhenEqual(FoundPred);
7410
7411   // Check to see if we can make the LHS or RHS match.
7412   if (LHS == FoundRHS || RHS == FoundLHS) {
7413     if (isa<SCEVConstant>(RHS)) {
7414       std::swap(FoundLHS, FoundRHS);
7415       FoundPred = ICmpInst::getSwappedPredicate(FoundPred);
7416     } else {
7417       std::swap(LHS, RHS);
7418       Pred = ICmpInst::getSwappedPredicate(Pred);
7419     }
7420   }
7421
7422   // Check whether the found predicate is the same as the desired predicate.
7423   if (FoundPred == Pred)
7424     return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS);
7425
7426   // Check whether swapping the found predicate makes it the same as the
7427   // desired predicate.
7428   if (ICmpInst::getSwappedPredicate(FoundPred) == Pred) {
7429     if (isa<SCEVConstant>(RHS))
7430       return isImpliedCondOperands(Pred, LHS, RHS, FoundRHS, FoundLHS);
7431     else
7432       return isImpliedCondOperands(ICmpInst::getSwappedPredicate(Pred),
7433                                    RHS, LHS, FoundLHS, FoundRHS);
7434   }
7435
7436   // Check if we can make progress by sharpening ranges.
7437   if (FoundPred == ICmpInst::ICMP_NE &&
7438       (isa<SCEVConstant>(FoundLHS) || isa<SCEVConstant>(FoundRHS))) {
7439
7440     const SCEVConstant *C = nullptr;
7441     const SCEV *V = nullptr;
7442
7443     if (isa<SCEVConstant>(FoundLHS)) {
7444       C = cast<SCEVConstant>(FoundLHS);
7445       V = FoundRHS;
7446     } else {
7447       C = cast<SCEVConstant>(FoundRHS);
7448       V = FoundLHS;
7449     }
7450
7451     // The guarding predicate tells us that C != V. If the known range
7452     // of V is [C, t), we can sharpen the range to [C + 1, t).  The
7453     // range we consider has to correspond to same signedness as the
7454     // predicate we're interested in folding.
7455
7456     APInt Min = ICmpInst::isSigned(Pred) ?
7457         getSignedRange(V).getSignedMin() : getUnsignedRange(V).getUnsignedMin();
7458
7459     if (Min == C->getValue()->getValue()) {
7460       // Given (V >= Min && V != Min) we conclude V >= (Min + 1).
7461       // This is true even if (Min + 1) wraps around -- in case of
7462       // wraparound, (Min + 1) < Min, so (V >= Min => V >= (Min + 1)).
7463
7464       APInt SharperMin = Min + 1;
7465
7466       switch (Pred) {
7467         case ICmpInst::ICMP_SGE:
7468         case ICmpInst::ICMP_UGE:
7469           // We know V `Pred` SharperMin.  If this implies LHS `Pred`
7470           // RHS, we're done.
7471           if (isImpliedCondOperands(Pred, LHS, RHS, V,
7472                                     getConstant(SharperMin)))
7473             return true;
7474
7475         case ICmpInst::ICMP_SGT:
7476         case ICmpInst::ICMP_UGT:
7477           // We know from the range information that (V `Pred` Min ||
7478           // V == Min).  We know from the guarding condition that !(V
7479           // == Min).  This gives us
7480           //
7481           //       V `Pred` Min || V == Min && !(V == Min)
7482           //   =>  V `Pred` Min
7483           //
7484           // If V `Pred` Min implies LHS `Pred` RHS, we're done.
7485
7486           if (isImpliedCondOperands(Pred, LHS, RHS, V, getConstant(Min)))
7487             return true;
7488
7489         default:
7490           // No change
7491           break;
7492       }
7493     }
7494   }
7495
7496   // Check whether the actual condition is beyond sufficient.
7497   if (FoundPred == ICmpInst::ICMP_EQ)
7498     if (ICmpInst::isTrueWhenEqual(Pred))
7499       if (isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS))
7500         return true;
7501   if (Pred == ICmpInst::ICMP_NE)
7502     if (!ICmpInst::isTrueWhenEqual(FoundPred))
7503       if (isImpliedCondOperands(FoundPred, LHS, RHS, FoundLHS, FoundRHS))
7504         return true;
7505
7506   // Otherwise assume the worst.
7507   return false;
7508 }
7509
7510 bool ScalarEvolution::splitBinaryAdd(const SCEV *Expr,
7511                                      const SCEV *&L, const SCEV *&R,
7512                                      SCEV::NoWrapFlags &Flags) {
7513   const auto *AE = dyn_cast<SCEVAddExpr>(Expr);
7514   if (!AE || AE->getNumOperands() != 2)
7515     return false;
7516
7517   L = AE->getOperand(0);
7518   R = AE->getOperand(1);
7519   Flags = AE->getNoWrapFlags();
7520   return true;
7521 }
7522
7523 bool ScalarEvolution::computeConstantDifference(const SCEV *Less,
7524                                                 const SCEV *More,
7525                                                 APInt &C) {
7526   // We avoid subtracting expressions here because this function is usually
7527   // fairly deep in the call stack (i.e. is called many times).
7528
7529   if (isa<SCEVAddRecExpr>(Less) && isa<SCEVAddRecExpr>(More)) {
7530     const auto *LAR = cast<SCEVAddRecExpr>(Less);
7531     const auto *MAR = cast<SCEVAddRecExpr>(More);
7532
7533     if (LAR->getLoop() != MAR->getLoop())
7534       return false;
7535
7536     // We look at affine expressions only; not for correctness but to keep
7537     // getStepRecurrence cheap.
7538     if (!LAR->isAffine() || !MAR->isAffine())
7539       return false;
7540
7541     if (LAR->getStepRecurrence(*this) != MAR->getStepRecurrence(*this))
7542       return false;
7543
7544     Less = LAR->getStart();
7545     More = MAR->getStart();
7546
7547     // fall through
7548   }
7549
7550   if (isa<SCEVConstant>(Less) && isa<SCEVConstant>(More)) {
7551     const auto &M = cast<SCEVConstant>(More)->getValue()->getValue();
7552     const auto &L = cast<SCEVConstant>(Less)->getValue()->getValue();
7553     C = M - L;
7554     return true;
7555   }
7556
7557   const SCEV *L, *R;
7558   SCEV::NoWrapFlags Flags;
7559   if (splitBinaryAdd(Less, L, R, Flags))
7560     if (const auto *LC = dyn_cast<SCEVConstant>(L))
7561       if (R == More) {
7562         C = -(LC->getValue()->getValue());
7563         return true;
7564       }
7565
7566   if (splitBinaryAdd(More, L, R, Flags))
7567     if (const auto *LC = dyn_cast<SCEVConstant>(L))
7568       if (R == Less) {
7569         C = LC->getValue()->getValue();
7570         return true;
7571       }
7572
7573   return false;
7574 }
7575
7576 bool ScalarEvolution::isImpliedCondOperandsViaNoOverflow(
7577     ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS,
7578     const SCEV *FoundLHS, const SCEV *FoundRHS) {
7579   if (Pred != CmpInst::ICMP_SLT && Pred != CmpInst::ICMP_ULT)
7580     return false;
7581
7582   const auto *AddRecLHS = dyn_cast<SCEVAddRecExpr>(LHS);
7583   if (!AddRecLHS)
7584     return false;
7585
7586   const auto *AddRecFoundLHS = dyn_cast<SCEVAddRecExpr>(FoundLHS);
7587   if (!AddRecFoundLHS)
7588     return false;
7589
7590   // We'd like to let SCEV reason about control dependencies, so we constrain
7591   // both the inequalities to be about add recurrences on the same loop.  This
7592   // way we can use isLoopEntryGuardedByCond later.
7593
7594   const Loop *L = AddRecFoundLHS->getLoop();
7595   if (L != AddRecLHS->getLoop())
7596     return false;
7597
7598   //  FoundLHS u< FoundRHS u< -C =>  (FoundLHS + C) u< (FoundRHS + C) ... (1)
7599   //
7600   //  FoundLHS s< FoundRHS s< INT_MIN - C => (FoundLHS + C) s< (FoundRHS + C)
7601   //                                                                  ... (2)
7602   //
7603   // Informal proof for (2), assuming (1) [*]:
7604   //
7605   // We'll also assume (A s< B) <=> ((A + INT_MIN) u< (B + INT_MIN)) ... (3)[**]
7606   //
7607   // Then
7608   //
7609   //       FoundLHS s< FoundRHS s< INT_MIN - C
7610   // <=>  (FoundLHS + INT_MIN) u< (FoundRHS + INT_MIN) u< -C   [ using (3) ]
7611   // <=>  (FoundLHS + INT_MIN + C) u< (FoundRHS + INT_MIN + C) [ using (1) ]
7612   // <=>  (FoundLHS + INT_MIN + C + INT_MIN) s<
7613   //                        (FoundRHS + INT_MIN + C + INT_MIN) [ using (3) ]
7614   // <=>  FoundLHS + C s< FoundRHS + C
7615   //
7616   // [*]: (1) can be proved by ruling out overflow.
7617   //
7618   // [**]: This can be proved by analyzing all the four possibilities:
7619   //    (A s< 0, B s< 0), (A s< 0, B s>= 0), (A s>= 0, B s< 0) and
7620   //    (A s>= 0, B s>= 0).
7621   //
7622   // Note:
7623   // Despite (2), "FoundRHS s< INT_MIN - C" does not mean that "FoundRHS + C"
7624   // will not sign underflow.  For instance, say FoundLHS = (i8 -128), FoundRHS
7625   // = (i8 -127) and C = (i8 -100).  Then INT_MIN - C = (i8 -28), and FoundRHS
7626   // s< (INT_MIN - C).  Lack of sign overflow / underflow in "FoundRHS + C" is
7627   // neither necessary nor sufficient to prove "(FoundLHS + C) s< (FoundRHS +
7628   // C)".
7629
7630   APInt LDiff, RDiff;
7631   if (!computeConstantDifference(FoundLHS, LHS, LDiff) ||
7632       !computeConstantDifference(FoundRHS, RHS, RDiff) ||
7633       LDiff != RDiff)
7634     return false;
7635
7636   if (LDiff == 0)
7637     return true;
7638
7639   APInt FoundRHSLimit;
7640
7641   if (Pred == CmpInst::ICMP_ULT) {
7642     FoundRHSLimit = -RDiff;
7643   } else {
7644     assert(Pred == CmpInst::ICMP_SLT && "Checked above!");
7645     FoundRHSLimit = APInt::getSignedMinValue(getTypeSizeInBits(RHS->getType())) - RDiff;
7646   }
7647
7648   // Try to prove (1) or (2), as needed.
7649   return isLoopEntryGuardedByCond(L, Pred, FoundRHS,
7650                                   getConstant(FoundRHSLimit));
7651 }
7652
7653 /// isImpliedCondOperands - Test whether the condition described by Pred,
7654 /// LHS, and RHS is true whenever the condition described by Pred, FoundLHS,
7655 /// and FoundRHS is true.
7656 bool ScalarEvolution::isImpliedCondOperands(ICmpInst::Predicate Pred,
7657                                             const SCEV *LHS, const SCEV *RHS,
7658                                             const SCEV *FoundLHS,
7659                                             const SCEV *FoundRHS) {
7660   if (isImpliedCondOperandsViaRanges(Pred, LHS, RHS, FoundLHS, FoundRHS))
7661     return true;
7662
7663   if (isImpliedCondOperandsViaNoOverflow(Pred, LHS, RHS, FoundLHS, FoundRHS))
7664     return true;
7665
7666   return isImpliedCondOperandsHelper(Pred, LHS, RHS,
7667                                      FoundLHS, FoundRHS) ||
7668          // ~x < ~y --> x > y
7669          isImpliedCondOperandsHelper(Pred, LHS, RHS,
7670                                      getNotSCEV(FoundRHS),
7671                                      getNotSCEV(FoundLHS));
7672 }
7673
7674
7675 /// If Expr computes ~A, return A else return nullptr
7676 static const SCEV *MatchNotExpr(const SCEV *Expr) {
7677   const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Expr);
7678   if (!Add || Add->getNumOperands() != 2 ||
7679       !Add->getOperand(0)->isAllOnesValue())
7680     return nullptr;
7681
7682   const SCEVMulExpr *AddRHS = dyn_cast<SCEVMulExpr>(Add->getOperand(1));
7683   if (!AddRHS || AddRHS->getNumOperands() != 2 ||
7684       !AddRHS->getOperand(0)->isAllOnesValue())
7685     return nullptr;
7686
7687   return AddRHS->getOperand(1);
7688 }
7689
7690
7691 /// Is MaybeMaxExpr an SMax or UMax of Candidate and some other values?
7692 template<typename MaxExprType>
7693 static bool IsMaxConsistingOf(const SCEV *MaybeMaxExpr,
7694                               const SCEV *Candidate) {
7695   const MaxExprType *MaxExpr = dyn_cast<MaxExprType>(MaybeMaxExpr);
7696   if (!MaxExpr) return false;
7697
7698   auto It = std::find(MaxExpr->op_begin(), MaxExpr->op_end(), Candidate);
7699   return It != MaxExpr->op_end();
7700 }
7701
7702
7703 /// Is MaybeMinExpr an SMin or UMin of Candidate and some other values?
7704 template<typename MaxExprType>
7705 static bool IsMinConsistingOf(ScalarEvolution &SE,
7706                               const SCEV *MaybeMinExpr,
7707                               const SCEV *Candidate) {
7708   const SCEV *MaybeMaxExpr = MatchNotExpr(MaybeMinExpr);
7709   if (!MaybeMaxExpr)
7710     return false;
7711
7712   return IsMaxConsistingOf<MaxExprType>(MaybeMaxExpr, SE.getNotSCEV(Candidate));
7713 }
7714
7715 static bool IsKnownPredicateViaAddRecStart(ScalarEvolution &SE,
7716                                            ICmpInst::Predicate Pred,
7717                                            const SCEV *LHS, const SCEV *RHS) {
7718
7719   // If both sides are affine addrecs for the same loop, with equal
7720   // steps, and we know the recurrences don't wrap, then we only
7721   // need to check the predicate on the starting values.
7722
7723   if (!ICmpInst::isRelational(Pred))
7724     return false;
7725
7726   const SCEVAddRecExpr *LAR = dyn_cast<SCEVAddRecExpr>(LHS);
7727   if (!LAR)
7728     return false;
7729   const SCEVAddRecExpr *RAR = dyn_cast<SCEVAddRecExpr>(RHS);
7730   if (!RAR)
7731     return false;
7732   if (LAR->getLoop() != RAR->getLoop())
7733     return false;
7734   if (!LAR->isAffine() || !RAR->isAffine())
7735     return false;
7736
7737   if (LAR->getStepRecurrence(SE) != RAR->getStepRecurrence(SE))
7738     return false;
7739
7740   SCEV::NoWrapFlags NW = ICmpInst::isSigned(Pred) ?
7741                          SCEV::FlagNSW : SCEV::FlagNUW;
7742   if (!LAR->getNoWrapFlags(NW) || !RAR->getNoWrapFlags(NW))
7743     return false;
7744
7745   return SE.isKnownPredicate(Pred, LAR->getStart(), RAR->getStart());
7746 }
7747
7748 /// Is LHS `Pred` RHS true on the virtue of LHS or RHS being a Min or Max
7749 /// expression?
7750 static bool IsKnownPredicateViaMinOrMax(ScalarEvolution &SE,
7751                                         ICmpInst::Predicate Pred,
7752                                         const SCEV *LHS, const SCEV *RHS) {
7753   switch (Pred) {
7754   default:
7755     return false;
7756
7757   case ICmpInst::ICMP_SGE:
7758     std::swap(LHS, RHS);
7759     // fall through
7760   case ICmpInst::ICMP_SLE:
7761     return
7762       // min(A, ...) <= A
7763       IsMinConsistingOf<SCEVSMaxExpr>(SE, LHS, RHS) ||
7764       // A <= max(A, ...)
7765       IsMaxConsistingOf<SCEVSMaxExpr>(RHS, LHS);
7766
7767   case ICmpInst::ICMP_UGE:
7768     std::swap(LHS, RHS);
7769     // fall through
7770   case ICmpInst::ICMP_ULE:
7771     return
7772       // min(A, ...) <= A
7773       IsMinConsistingOf<SCEVUMaxExpr>(SE, LHS, RHS) ||
7774       // A <= max(A, ...)
7775       IsMaxConsistingOf<SCEVUMaxExpr>(RHS, LHS);
7776   }
7777
7778   llvm_unreachable("covered switch fell through?!");
7779 }
7780
7781 /// isImpliedCondOperandsHelper - Test whether the condition described by
7782 /// Pred, LHS, and RHS is true whenever the condition described by Pred,
7783 /// FoundLHS, and FoundRHS is true.
7784 bool
7785 ScalarEvolution::isImpliedCondOperandsHelper(ICmpInst::Predicate Pred,
7786                                              const SCEV *LHS, const SCEV *RHS,
7787                                              const SCEV *FoundLHS,
7788                                              const SCEV *FoundRHS) {
7789   auto IsKnownPredicateFull =
7790       [this](ICmpInst::Predicate Pred, const SCEV *LHS, const SCEV *RHS) {
7791     return isKnownPredicateWithRanges(Pred, LHS, RHS) ||
7792         IsKnownPredicateViaMinOrMax(*this, Pred, LHS, RHS) ||
7793         IsKnownPredicateViaAddRecStart(*this, Pred, LHS, RHS);
7794   };
7795
7796   switch (Pred) {
7797   default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
7798   case ICmpInst::ICMP_EQ:
7799   case ICmpInst::ICMP_NE:
7800     if (HasSameValue(LHS, FoundLHS) && HasSameValue(RHS, FoundRHS))
7801       return true;
7802     break;
7803   case ICmpInst::ICMP_SLT:
7804   case ICmpInst::ICMP_SLE:
7805     if (IsKnownPredicateFull(ICmpInst::ICMP_SLE, LHS, FoundLHS) &&
7806         IsKnownPredicateFull(ICmpInst::ICMP_SGE, RHS, FoundRHS))
7807       return true;
7808     break;
7809   case ICmpInst::ICMP_SGT:
7810   case ICmpInst::ICMP_SGE:
7811     if (IsKnownPredicateFull(ICmpInst::ICMP_SGE, LHS, FoundLHS) &&
7812         IsKnownPredicateFull(ICmpInst::ICMP_SLE, RHS, FoundRHS))
7813       return true;
7814     break;
7815   case ICmpInst::ICMP_ULT:
7816   case ICmpInst::ICMP_ULE:
7817     if (IsKnownPredicateFull(ICmpInst::ICMP_ULE, LHS, FoundLHS) &&
7818         IsKnownPredicateFull(ICmpInst::ICMP_UGE, RHS, FoundRHS))
7819       return true;
7820     break;
7821   case ICmpInst::ICMP_UGT:
7822   case ICmpInst::ICMP_UGE:
7823     if (IsKnownPredicateFull(ICmpInst::ICMP_UGE, LHS, FoundLHS) &&
7824         IsKnownPredicateFull(ICmpInst::ICMP_ULE, RHS, FoundRHS))
7825       return true;
7826     break;
7827   }
7828
7829   return false;
7830 }
7831
7832 /// isImpliedCondOperandsViaRanges - helper function for isImpliedCondOperands.
7833 /// Tries to get cases like "X `sgt` 0 => X - 1 `sgt` -1".
7834 bool ScalarEvolution::isImpliedCondOperandsViaRanges(ICmpInst::Predicate Pred,
7835                                                      const SCEV *LHS,
7836                                                      const SCEV *RHS,
7837                                                      const SCEV *FoundLHS,
7838                                                      const SCEV *FoundRHS) {
7839   if (!isa<SCEVConstant>(RHS) || !isa<SCEVConstant>(FoundRHS))
7840     // The restriction on `FoundRHS` be lifted easily -- it exists only to
7841     // reduce the compile time impact of this optimization.
7842     return false;
7843
7844   const SCEVAddExpr *AddLHS = dyn_cast<SCEVAddExpr>(LHS);
7845   if (!AddLHS || AddLHS->getOperand(1) != FoundLHS ||
7846       !isa<SCEVConstant>(AddLHS->getOperand(0)))
7847     return false;
7848
7849   APInt ConstFoundRHS = cast<SCEVConstant>(FoundRHS)->getValue()->getValue();
7850
7851   // `FoundLHSRange` is the range we know `FoundLHS` to be in by virtue of the
7852   // antecedent "`FoundLHS` `Pred` `FoundRHS`".
7853   ConstantRange FoundLHSRange =
7854       ConstantRange::makeAllowedICmpRegion(Pred, ConstFoundRHS);
7855
7856   // Since `LHS` is `FoundLHS` + `AddLHS->getOperand(0)`, we can compute a range
7857   // for `LHS`:
7858   APInt Addend =
7859       cast<SCEVConstant>(AddLHS->getOperand(0))->getValue()->getValue();
7860   ConstantRange LHSRange = FoundLHSRange.add(ConstantRange(Addend));
7861
7862   // We can also compute the range of values for `LHS` that satisfy the
7863   // consequent, "`LHS` `Pred` `RHS`":
7864   APInt ConstRHS = cast<SCEVConstant>(RHS)->getValue()->getValue();
7865   ConstantRange SatisfyingLHSRange =
7866       ConstantRange::makeSatisfyingICmpRegion(Pred, ConstRHS);
7867
7868   // The antecedent implies the consequent if every value of `LHS` that
7869   // satisfies the antecedent also satisfies the consequent.
7870   return SatisfyingLHSRange.contains(LHSRange);
7871 }
7872
7873 // Verify if an linear IV with positive stride can overflow when in a
7874 // less-than comparison, knowing the invariant term of the comparison, the
7875 // stride and the knowledge of NSW/NUW flags on the recurrence.
7876 bool ScalarEvolution::doesIVOverflowOnLT(const SCEV *RHS, const SCEV *Stride,
7877                                          bool IsSigned, bool NoWrap) {
7878   if (NoWrap) return false;
7879
7880   unsigned BitWidth = getTypeSizeInBits(RHS->getType());
7881   const SCEV *One = getOne(Stride->getType());
7882
7883   if (IsSigned) {
7884     APInt MaxRHS = getSignedRange(RHS).getSignedMax();
7885     APInt MaxValue = APInt::getSignedMaxValue(BitWidth);
7886     APInt MaxStrideMinusOne = getSignedRange(getMinusSCEV(Stride, One))
7887                                 .getSignedMax();
7888
7889     // SMaxRHS + SMaxStrideMinusOne > SMaxValue => overflow!
7890     return (MaxValue - MaxStrideMinusOne).slt(MaxRHS);
7891   }
7892
7893   APInt MaxRHS = getUnsignedRange(RHS).getUnsignedMax();
7894   APInt MaxValue = APInt::getMaxValue(BitWidth);
7895   APInt MaxStrideMinusOne = getUnsignedRange(getMinusSCEV(Stride, One))
7896                               .getUnsignedMax();
7897
7898   // UMaxRHS + UMaxStrideMinusOne > UMaxValue => overflow!
7899   return (MaxValue - MaxStrideMinusOne).ult(MaxRHS);
7900 }
7901
7902 // Verify if an linear IV with negative stride can overflow when in a
7903 // greater-than comparison, knowing the invariant term of the comparison,
7904 // the stride and the knowledge of NSW/NUW flags on the recurrence.
7905 bool ScalarEvolution::doesIVOverflowOnGT(const SCEV *RHS, const SCEV *Stride,
7906                                          bool IsSigned, bool NoWrap) {
7907   if (NoWrap) return false;
7908
7909   unsigned BitWidth = getTypeSizeInBits(RHS->getType());
7910   const SCEV *One = getOne(Stride->getType());
7911
7912   if (IsSigned) {
7913     APInt MinRHS = getSignedRange(RHS).getSignedMin();
7914     APInt MinValue = APInt::getSignedMinValue(BitWidth);
7915     APInt MaxStrideMinusOne = getSignedRange(getMinusSCEV(Stride, One))
7916                                .getSignedMax();
7917
7918     // SMinRHS - SMaxStrideMinusOne < SMinValue => overflow!
7919     return (MinValue + MaxStrideMinusOne).sgt(MinRHS);
7920   }
7921
7922   APInt MinRHS = getUnsignedRange(RHS).getUnsignedMin();
7923   APInt MinValue = APInt::getMinValue(BitWidth);
7924   APInt MaxStrideMinusOne = getUnsignedRange(getMinusSCEV(Stride, One))
7925                             .getUnsignedMax();
7926
7927   // UMinRHS - UMaxStrideMinusOne < UMinValue => overflow!
7928   return (MinValue + MaxStrideMinusOne).ugt(MinRHS);
7929 }
7930
7931 // Compute the backedge taken count knowing the interval difference, the
7932 // stride and presence of the equality in the comparison.
7933 const SCEV *ScalarEvolution::computeBECount(const SCEV *Delta, const SCEV *Step,
7934                                             bool Equality) {
7935   const SCEV *One = getOne(Step->getType());
7936   Delta = Equality ? getAddExpr(Delta, Step)
7937                    : getAddExpr(Delta, getMinusSCEV(Step, One));
7938   return getUDivExpr(Delta, Step);
7939 }
7940
7941 /// HowManyLessThans - Return the number of times a backedge containing the
7942 /// specified less-than comparison will execute.  If not computable, return
7943 /// CouldNotCompute.
7944 ///
7945 /// @param ControlsExit is true when the LHS < RHS condition directly controls
7946 /// the branch (loops exits only if condition is true). In this case, we can use
7947 /// NoWrapFlags to skip overflow checks.
7948 ScalarEvolution::ExitLimit
7949 ScalarEvolution::HowManyLessThans(const SCEV *LHS, const SCEV *RHS,
7950                                   const Loop *L, bool IsSigned,
7951                                   bool ControlsExit) {
7952   // We handle only IV < Invariant
7953   if (!isLoopInvariant(RHS, L))
7954     return getCouldNotCompute();
7955
7956   const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS);
7957
7958   // Avoid weird loops
7959   if (!IV || IV->getLoop() != L || !IV->isAffine())
7960     return getCouldNotCompute();
7961
7962   bool NoWrap = ControlsExit &&
7963                 IV->getNoWrapFlags(IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW);
7964
7965   const SCEV *Stride = IV->getStepRecurrence(*this);
7966
7967   // Avoid negative or zero stride values
7968   if (!isKnownPositive(Stride))
7969     return getCouldNotCompute();
7970
7971   // Avoid proven overflow cases: this will ensure that the backedge taken count
7972   // will not generate any unsigned overflow. Relaxed no-overflow conditions
7973   // exploit NoWrapFlags, allowing to optimize in presence of undefined
7974   // behaviors like the case of C language.
7975   if (!Stride->isOne() && doesIVOverflowOnLT(RHS, Stride, IsSigned, NoWrap))
7976     return getCouldNotCompute();
7977
7978   ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SLT
7979                                       : ICmpInst::ICMP_ULT;
7980   const SCEV *Start = IV->getStart();
7981   const SCEV *End = RHS;
7982   if (!isLoopEntryGuardedByCond(L, Cond, getMinusSCEV(Start, Stride), RHS)) {
7983     const SCEV *Diff = getMinusSCEV(RHS, Start);
7984     // If we have NoWrap set, then we can assume that the increment won't
7985     // overflow, in which case if RHS - Start is a constant, we don't need to
7986     // do a max operation since we can just figure it out statically
7987     if (NoWrap && isa<SCEVConstant>(Diff)) {
7988       APInt D = dyn_cast<const SCEVConstant>(Diff)->getValue()->getValue();
7989       if (D.isNegative())
7990         End = Start;
7991     } else
7992       End = IsSigned ? getSMaxExpr(RHS, Start)
7993                      : getUMaxExpr(RHS, Start);
7994   }
7995
7996   const SCEV *BECount = computeBECount(getMinusSCEV(End, Start), Stride, false);
7997
7998   APInt MinStart = IsSigned ? getSignedRange(Start).getSignedMin()
7999                             : getUnsignedRange(Start).getUnsignedMin();
8000
8001   APInt MinStride = IsSigned ? getSignedRange(Stride).getSignedMin()
8002                              : getUnsignedRange(Stride).getUnsignedMin();
8003
8004   unsigned BitWidth = getTypeSizeInBits(LHS->getType());
8005   APInt Limit = IsSigned ? APInt::getSignedMaxValue(BitWidth) - (MinStride - 1)
8006                          : APInt::getMaxValue(BitWidth) - (MinStride - 1);
8007
8008   // Although End can be a MAX expression we estimate MaxEnd considering only
8009   // the case End = RHS. This is safe because in the other case (End - Start)
8010   // is zero, leading to a zero maximum backedge taken count.
8011   APInt MaxEnd =
8012     IsSigned ? APIntOps::smin(getSignedRange(RHS).getSignedMax(), Limit)
8013              : APIntOps::umin(getUnsignedRange(RHS).getUnsignedMax(), Limit);
8014
8015   const SCEV *MaxBECount;
8016   if (isa<SCEVConstant>(BECount))
8017     MaxBECount = BECount;
8018   else
8019     MaxBECount = computeBECount(getConstant(MaxEnd - MinStart),
8020                                 getConstant(MinStride), false);
8021
8022   if (isa<SCEVCouldNotCompute>(MaxBECount))
8023     MaxBECount = BECount;
8024
8025   return ExitLimit(BECount, MaxBECount);
8026 }
8027
8028 ScalarEvolution::ExitLimit
8029 ScalarEvolution::HowManyGreaterThans(const SCEV *LHS, const SCEV *RHS,
8030                                      const Loop *L, bool IsSigned,
8031                                      bool ControlsExit) {
8032   // We handle only IV > Invariant
8033   if (!isLoopInvariant(RHS, L))
8034     return getCouldNotCompute();
8035
8036   const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS);
8037
8038   // Avoid weird loops
8039   if (!IV || IV->getLoop() != L || !IV->isAffine())
8040     return getCouldNotCompute();
8041
8042   bool NoWrap = ControlsExit &&
8043                 IV->getNoWrapFlags(IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW);
8044
8045   const SCEV *Stride = getNegativeSCEV(IV->getStepRecurrence(*this));
8046
8047   // Avoid negative or zero stride values
8048   if (!isKnownPositive(Stride))
8049     return getCouldNotCompute();
8050
8051   // Avoid proven overflow cases: this will ensure that the backedge taken count
8052   // will not generate any unsigned overflow. Relaxed no-overflow conditions
8053   // exploit NoWrapFlags, allowing to optimize in presence of undefined
8054   // behaviors like the case of C language.
8055   if (!Stride->isOne() && doesIVOverflowOnGT(RHS, Stride, IsSigned, NoWrap))
8056     return getCouldNotCompute();
8057
8058   ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SGT
8059                                       : ICmpInst::ICMP_UGT;
8060
8061   const SCEV *Start = IV->getStart();
8062   const SCEV *End = RHS;
8063   if (!isLoopEntryGuardedByCond(L, Cond, getAddExpr(Start, Stride), RHS)) {
8064     const SCEV *Diff = getMinusSCEV(RHS, Start);
8065     // If we have NoWrap set, then we can assume that the increment won't
8066     // overflow, in which case if RHS - Start is a constant, we don't need to
8067     // do a max operation since we can just figure it out statically
8068     if (NoWrap && isa<SCEVConstant>(Diff)) {
8069       APInt D = dyn_cast<const SCEVConstant>(Diff)->getValue()->getValue();
8070       if (!D.isNegative())
8071         End = Start;
8072     } else
8073       End = IsSigned ? getSMinExpr(RHS, Start)
8074                      : getUMinExpr(RHS, Start);
8075   }
8076
8077   const SCEV *BECount = computeBECount(getMinusSCEV(Start, End), Stride, false);
8078
8079   APInt MaxStart = IsSigned ? getSignedRange(Start).getSignedMax()
8080                             : getUnsignedRange(Start).getUnsignedMax();
8081
8082   APInt MinStride = IsSigned ? getSignedRange(Stride).getSignedMin()
8083                              : getUnsignedRange(Stride).getUnsignedMin();
8084
8085   unsigned BitWidth = getTypeSizeInBits(LHS->getType());
8086   APInt Limit = IsSigned ? APInt::getSignedMinValue(BitWidth) + (MinStride - 1)
8087                          : APInt::getMinValue(BitWidth) + (MinStride - 1);
8088
8089   // Although End can be a MIN expression we estimate MinEnd considering only
8090   // the case End = RHS. This is safe because in the other case (Start - End)
8091   // is zero, leading to a zero maximum backedge taken count.
8092   APInt MinEnd =
8093     IsSigned ? APIntOps::smax(getSignedRange(RHS).getSignedMin(), Limit)
8094              : APIntOps::umax(getUnsignedRange(RHS).getUnsignedMin(), Limit);
8095
8096
8097   const SCEV *MaxBECount = getCouldNotCompute();
8098   if (isa<SCEVConstant>(BECount))
8099     MaxBECount = BECount;
8100   else
8101     MaxBECount = computeBECount(getConstant(MaxStart - MinEnd),
8102                                 getConstant(MinStride), false);
8103
8104   if (isa<SCEVCouldNotCompute>(MaxBECount))
8105     MaxBECount = BECount;
8106
8107   return ExitLimit(BECount, MaxBECount);
8108 }
8109
8110 /// getNumIterationsInRange - Return the number of iterations of this loop that
8111 /// produce values in the specified constant range.  Another way of looking at
8112 /// this is that it returns the first iteration number where the value is not in
8113 /// the condition, thus computing the exit count. If the iteration count can't
8114 /// be computed, an instance of SCEVCouldNotCompute is returned.
8115 const SCEV *SCEVAddRecExpr::getNumIterationsInRange(ConstantRange Range,
8116                                                     ScalarEvolution &SE) const {
8117   if (Range.isFullSet())  // Infinite loop.
8118     return SE.getCouldNotCompute();
8119
8120   // If the start is a non-zero constant, shift the range to simplify things.
8121   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(getStart()))
8122     if (!SC->getValue()->isZero()) {
8123       SmallVector<const SCEV *, 4> Operands(op_begin(), op_end());
8124       Operands[0] = SE.getZero(SC->getType());
8125       const SCEV *Shifted = SE.getAddRecExpr(Operands, getLoop(),
8126                                              getNoWrapFlags(FlagNW));
8127       if (const SCEVAddRecExpr *ShiftedAddRec =
8128             dyn_cast<SCEVAddRecExpr>(Shifted))
8129         return ShiftedAddRec->getNumIterationsInRange(
8130                            Range.subtract(SC->getValue()->getValue()), SE);
8131       // This is strange and shouldn't happen.
8132       return SE.getCouldNotCompute();
8133     }
8134
8135   // The only time we can solve this is when we have all constant indices.
8136   // Otherwise, we cannot determine the overflow conditions.
8137   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
8138     if (!isa<SCEVConstant>(getOperand(i)))
8139       return SE.getCouldNotCompute();
8140
8141
8142   // Okay at this point we know that all elements of the chrec are constants and
8143   // that the start element is zero.
8144
8145   // First check to see if the range contains zero.  If not, the first
8146   // iteration exits.
8147   unsigned BitWidth = SE.getTypeSizeInBits(getType());
8148   if (!Range.contains(APInt(BitWidth, 0)))
8149     return SE.getZero(getType());
8150
8151   if (isAffine()) {
8152     // If this is an affine expression then we have this situation:
8153     //   Solve {0,+,A} in Range  ===  Ax in Range
8154
8155     // We know that zero is in the range.  If A is positive then we know that
8156     // the upper value of the range must be the first possible exit value.
8157     // If A is negative then the lower of the range is the last possible loop
8158     // value.  Also note that we already checked for a full range.
8159     APInt One(BitWidth,1);
8160     APInt A     = cast<SCEVConstant>(getOperand(1))->getValue()->getValue();
8161     APInt End = A.sge(One) ? (Range.getUpper() - One) : Range.getLower();
8162
8163     // The exit value should be (End+A)/A.
8164     APInt ExitVal = (End + A).udiv(A);
8165     ConstantInt *ExitValue = ConstantInt::get(SE.getContext(), ExitVal);
8166
8167     // Evaluate at the exit value.  If we really did fall out of the valid
8168     // range, then we computed our trip count, otherwise wrap around or other
8169     // things must have happened.
8170     ConstantInt *Val = EvaluateConstantChrecAtConstant(this, ExitValue, SE);
8171     if (Range.contains(Val->getValue()))
8172       return SE.getCouldNotCompute();  // Something strange happened
8173
8174     // Ensure that the previous value is in the range.  This is a sanity check.
8175     assert(Range.contains(
8176            EvaluateConstantChrecAtConstant(this,
8177            ConstantInt::get(SE.getContext(), ExitVal - One), SE)->getValue()) &&
8178            "Linear scev computation is off in a bad way!");
8179     return SE.getConstant(ExitValue);
8180   } else if (isQuadratic()) {
8181     // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of the
8182     // quadratic equation to solve it.  To do this, we must frame our problem in
8183     // terms of figuring out when zero is crossed, instead of when
8184     // Range.getUpper() is crossed.
8185     SmallVector<const SCEV *, 4> NewOps(op_begin(), op_end());
8186     NewOps[0] = SE.getNegativeSCEV(SE.getConstant(Range.getUpper()));
8187     const SCEV *NewAddRec = SE.getAddRecExpr(NewOps, getLoop(),
8188                                              // getNoWrapFlags(FlagNW)
8189                                              FlagAnyWrap);
8190
8191     // Next, solve the constructed addrec
8192     std::pair<const SCEV *,const SCEV *> Roots =
8193       SolveQuadraticEquation(cast<SCEVAddRecExpr>(NewAddRec), SE);
8194     const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
8195     const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
8196     if (R1) {
8197       // Pick the smallest positive root value.
8198       if (ConstantInt *CB =
8199           dyn_cast<ConstantInt>(ConstantExpr::getICmp(ICmpInst::ICMP_ULT,
8200                          R1->getValue(), R2->getValue()))) {
8201         if (!CB->getZExtValue())
8202           std::swap(R1, R2);   // R1 is the minimum root now.
8203
8204         // Make sure the root is not off by one.  The returned iteration should
8205         // not be in the range, but the previous one should be.  When solving
8206         // for "X*X < 5", for example, we should not return a root of 2.
8207         ConstantInt *R1Val = EvaluateConstantChrecAtConstant(this,
8208                                                              R1->getValue(),
8209                                                              SE);
8210         if (Range.contains(R1Val->getValue())) {
8211           // The next iteration must be out of the range...
8212           ConstantInt *NextVal =
8213                 ConstantInt::get(SE.getContext(), R1->getValue()->getValue()+1);
8214
8215           R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
8216           if (!Range.contains(R1Val->getValue()))
8217             return SE.getConstant(NextVal);
8218           return SE.getCouldNotCompute();  // Something strange happened
8219         }
8220
8221         // If R1 was not in the range, then it is a good return value.  Make
8222         // sure that R1-1 WAS in the range though, just in case.
8223         ConstantInt *NextVal =
8224                ConstantInt::get(SE.getContext(), R1->getValue()->getValue()-1);
8225         R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
8226         if (Range.contains(R1Val->getValue()))
8227           return R1;
8228         return SE.getCouldNotCompute();  // Something strange happened
8229       }
8230     }
8231   }
8232
8233   return SE.getCouldNotCompute();
8234 }
8235
8236 namespace {
8237 struct FindUndefs {
8238   bool Found;
8239   FindUndefs() : Found(false) {}
8240
8241   bool follow(const SCEV *S) {
8242     if (const SCEVUnknown *C = dyn_cast<SCEVUnknown>(S)) {
8243       if (isa<UndefValue>(C->getValue()))
8244         Found = true;
8245     } else if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S)) {
8246       if (isa<UndefValue>(C->getValue()))
8247         Found = true;
8248     }
8249
8250     // Keep looking if we haven't found it yet.
8251     return !Found;
8252   }
8253   bool isDone() const {
8254     // Stop recursion if we have found an undef.
8255     return Found;
8256   }
8257 };
8258 }
8259
8260 // Return true when S contains at least an undef value.
8261 static inline bool
8262 containsUndefs(const SCEV *S) {
8263   FindUndefs F;
8264   SCEVTraversal<FindUndefs> ST(F);
8265   ST.visitAll(S);
8266
8267   return F.Found;
8268 }
8269
8270 namespace {
8271 // Collect all steps of SCEV expressions.
8272 struct SCEVCollectStrides {
8273   ScalarEvolution &SE;
8274   SmallVectorImpl<const SCEV *> &Strides;
8275
8276   SCEVCollectStrides(ScalarEvolution &SE, SmallVectorImpl<const SCEV *> &S)
8277       : SE(SE), Strides(S) {}
8278
8279   bool follow(const SCEV *S) {
8280     if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S))
8281       Strides.push_back(AR->getStepRecurrence(SE));
8282     return true;
8283   }
8284   bool isDone() const { return false; }
8285 };
8286
8287 // Collect all SCEVUnknown and SCEVMulExpr expressions.
8288 struct SCEVCollectTerms {
8289   SmallVectorImpl<const SCEV *> &Terms;
8290
8291   SCEVCollectTerms(SmallVectorImpl<const SCEV *> &T)
8292       : Terms(T) {}
8293
8294   bool follow(const SCEV *S) {
8295     if (isa<SCEVUnknown>(S) || isa<SCEVMulExpr>(S)) {
8296       if (!containsUndefs(S))
8297         Terms.push_back(S);
8298
8299       // Stop recursion: once we collected a term, do not walk its operands.
8300       return false;
8301     }
8302
8303     // Keep looking.
8304     return true;
8305   }
8306   bool isDone() const { return false; }
8307 };
8308
8309 // Check if a SCEV contains an AddRecExpr.
8310 struct SCEVHasAddRec {
8311   bool &ContainsAddRec;
8312
8313   SCEVHasAddRec(bool &ContainsAddRec) : ContainsAddRec(ContainsAddRec) {
8314    ContainsAddRec = false;
8315   }
8316
8317   bool follow(const SCEV *S) {
8318     if (isa<SCEVAddRecExpr>(S)) {
8319       ContainsAddRec = true;
8320
8321       // Stop recursion: once we collected a term, do not walk its operands.
8322       return false;
8323     }
8324
8325     // Keep looking.
8326     return true;
8327   }
8328   bool isDone() const { return false; }
8329 };
8330
8331 // Find factors that are multiplied with an expression that (possibly as a
8332 // subexpression) contains an AddRecExpr. In the expression:
8333 //
8334 //  8 * (100 +  %p * %q * (%a + {0, +, 1}_loop))
8335 //
8336 // "%p * %q" are factors multiplied by the expression "(%a + {0, +, 1}_loop)"
8337 // that contains the AddRec {0, +, 1}_loop. %p * %q are likely to be array size
8338 // parameters as they form a product with an induction variable.
8339 //
8340 // This collector expects all array size parameters to be in the same MulExpr.
8341 // It might be necessary to later add support for collecting parameters that are
8342 // spread over different nested MulExpr.
8343 struct SCEVCollectAddRecMultiplies {
8344   SmallVectorImpl<const SCEV *> &Terms;
8345   ScalarEvolution &SE;
8346
8347   SCEVCollectAddRecMultiplies(SmallVectorImpl<const SCEV *> &T, ScalarEvolution &SE)
8348       : Terms(T), SE(SE) {}
8349
8350   bool follow(const SCEV *S) {
8351     if (auto *Mul = dyn_cast<SCEVMulExpr>(S)) {
8352       bool HasAddRec = false;
8353       SmallVector<const SCEV *, 0> Operands;
8354       for (auto Op : Mul->operands()) {
8355         if (isa<SCEVUnknown>(Op)) {
8356           Operands.push_back(Op);
8357         } else {
8358           bool ContainsAddRec;
8359           SCEVHasAddRec ContiansAddRec(ContainsAddRec);
8360           visitAll(Op, ContiansAddRec);
8361           HasAddRec |= ContainsAddRec;
8362         }
8363       }
8364       if (Operands.size() == 0)
8365         return true;
8366
8367       if (!HasAddRec)
8368         return false;
8369
8370       Terms.push_back(SE.getMulExpr(Operands));
8371       // Stop recursion: once we collected a term, do not walk its operands.
8372       return false;
8373     }
8374
8375     // Keep looking.
8376     return true;
8377   }
8378   bool isDone() const { return false; }
8379 };
8380 }
8381
8382 /// Find parametric terms in this SCEVAddRecExpr. We first for parameters in
8383 /// two places:
8384 ///   1) The strides of AddRec expressions.
8385 ///   2) Unknowns that are multiplied with AddRec expressions.
8386 void ScalarEvolution::collectParametricTerms(const SCEV *Expr,
8387     SmallVectorImpl<const SCEV *> &Terms) {
8388   SmallVector<const SCEV *, 4> Strides;
8389   SCEVCollectStrides StrideCollector(*this, Strides);
8390   visitAll(Expr, StrideCollector);
8391
8392   DEBUG({
8393       dbgs() << "Strides:\n";
8394       for (const SCEV *S : Strides)
8395         dbgs() << *S << "\n";
8396     });
8397
8398   for (const SCEV *S : Strides) {
8399     SCEVCollectTerms TermCollector(Terms);
8400     visitAll(S, TermCollector);
8401   }
8402
8403   DEBUG({
8404       dbgs() << "Terms:\n";
8405       for (const SCEV *T : Terms)
8406         dbgs() << *T << "\n";
8407     });
8408
8409   SCEVCollectAddRecMultiplies MulCollector(Terms, *this);
8410   visitAll(Expr, MulCollector);
8411 }
8412
8413 static bool findArrayDimensionsRec(ScalarEvolution &SE,
8414                                    SmallVectorImpl<const SCEV *> &Terms,
8415                                    SmallVectorImpl<const SCEV *> &Sizes) {
8416   int Last = Terms.size() - 1;
8417   const SCEV *Step = Terms[Last];
8418
8419   // End of recursion.
8420   if (Last == 0) {
8421     if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(Step)) {
8422       SmallVector<const SCEV *, 2> Qs;
8423       for (const SCEV *Op : M->operands())
8424         if (!isa<SCEVConstant>(Op))
8425           Qs.push_back(Op);
8426
8427       Step = SE.getMulExpr(Qs);
8428     }
8429
8430     Sizes.push_back(Step);
8431     return true;
8432   }
8433
8434   for (const SCEV *&Term : Terms) {
8435     // Normalize the terms before the next call to findArrayDimensionsRec.
8436     const SCEV *Q, *R;
8437     SCEVDivision::divide(SE, Term, Step, &Q, &R);
8438
8439     // Bail out when GCD does not evenly divide one of the terms.
8440     if (!R->isZero())
8441       return false;
8442
8443     Term = Q;
8444   }
8445
8446   // Remove all SCEVConstants.
8447   Terms.erase(std::remove_if(Terms.begin(), Terms.end(), [](const SCEV *E) {
8448                 return isa<SCEVConstant>(E);
8449               }),
8450               Terms.end());
8451
8452   if (Terms.size() > 0)
8453     if (!findArrayDimensionsRec(SE, Terms, Sizes))
8454       return false;
8455
8456   Sizes.push_back(Step);
8457   return true;
8458 }
8459
8460 namespace {
8461 struct FindParameter {
8462   bool FoundParameter;
8463   FindParameter() : FoundParameter(false) {}
8464
8465   bool follow(const SCEV *S) {
8466     if (isa<SCEVUnknown>(S)) {
8467       FoundParameter = true;
8468       // Stop recursion: we found a parameter.
8469       return false;
8470     }
8471     // Keep looking.
8472     return true;
8473   }
8474   bool isDone() const {
8475     // Stop recursion if we have found a parameter.
8476     return FoundParameter;
8477   }
8478 };
8479 }
8480
8481 // Returns true when S contains at least a SCEVUnknown parameter.
8482 static inline bool
8483 containsParameters(const SCEV *S) {
8484   FindParameter F;
8485   SCEVTraversal<FindParameter> ST(F);
8486   ST.visitAll(S);
8487
8488   return F.FoundParameter;
8489 }
8490
8491 // Returns true when one of the SCEVs of Terms contains a SCEVUnknown parameter.
8492 static inline bool
8493 containsParameters(SmallVectorImpl<const SCEV *> &Terms) {
8494   for (const SCEV *T : Terms)
8495     if (containsParameters(T))
8496       return true;
8497   return false;
8498 }
8499
8500 // Return the number of product terms in S.
8501 static inline int numberOfTerms(const SCEV *S) {
8502   if (const SCEVMulExpr *Expr = dyn_cast<SCEVMulExpr>(S))
8503     return Expr->getNumOperands();
8504   return 1;
8505 }
8506
8507 static const SCEV *removeConstantFactors(ScalarEvolution &SE, const SCEV *T) {
8508   if (isa<SCEVConstant>(T))
8509     return nullptr;
8510
8511   if (isa<SCEVUnknown>(T))
8512     return T;
8513
8514   if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(T)) {
8515     SmallVector<const SCEV *, 2> Factors;
8516     for (const SCEV *Op : M->operands())
8517       if (!isa<SCEVConstant>(Op))
8518         Factors.push_back(Op);
8519
8520     return SE.getMulExpr(Factors);
8521   }
8522
8523   return T;
8524 }
8525
8526 /// Return the size of an element read or written by Inst.
8527 const SCEV *ScalarEvolution::getElementSize(Instruction *Inst) {
8528   Type *Ty;
8529   if (StoreInst *Store = dyn_cast<StoreInst>(Inst))
8530     Ty = Store->getValueOperand()->getType();
8531   else if (LoadInst *Load = dyn_cast<LoadInst>(Inst))
8532     Ty = Load->getType();
8533   else
8534     return nullptr;
8535
8536   Type *ETy = getEffectiveSCEVType(PointerType::getUnqual(Ty));
8537   return getSizeOfExpr(ETy, Ty);
8538 }
8539
8540 /// Second step of delinearization: compute the array dimensions Sizes from the
8541 /// set of Terms extracted from the memory access function of this SCEVAddRec.
8542 void ScalarEvolution::findArrayDimensions(SmallVectorImpl<const SCEV *> &Terms,
8543                                           SmallVectorImpl<const SCEV *> &Sizes,
8544                                           const SCEV *ElementSize) const {
8545
8546   if (Terms.size() < 1 || !ElementSize)
8547     return;
8548
8549   // Early return when Terms do not contain parameters: we do not delinearize
8550   // non parametric SCEVs.
8551   if (!containsParameters(Terms))
8552     return;
8553
8554   DEBUG({
8555       dbgs() << "Terms:\n";
8556       for (const SCEV *T : Terms)
8557         dbgs() << *T << "\n";
8558     });
8559
8560   // Remove duplicates.
8561   std::sort(Terms.begin(), Terms.end());
8562   Terms.erase(std::unique(Terms.begin(), Terms.end()), Terms.end());
8563
8564   // Put larger terms first.
8565   std::sort(Terms.begin(), Terms.end(), [](const SCEV *LHS, const SCEV *RHS) {
8566     return numberOfTerms(LHS) > numberOfTerms(RHS);
8567   });
8568
8569   ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
8570
8571   // Try to divide all terms by the element size. If term is not divisible by
8572   // element size, proceed with the original term.
8573   for (const SCEV *&Term : Terms) {
8574     const SCEV *Q, *R;
8575     SCEVDivision::divide(SE, Term, ElementSize, &Q, &R);
8576     if (!Q->isZero())
8577       Term = Q;
8578   }
8579
8580   SmallVector<const SCEV *, 4> NewTerms;
8581
8582   // Remove constant factors.
8583   for (const SCEV *T : Terms)
8584     if (const SCEV *NewT = removeConstantFactors(SE, T))
8585       NewTerms.push_back(NewT);
8586
8587   DEBUG({
8588       dbgs() << "Terms after sorting:\n";
8589       for (const SCEV *T : NewTerms)
8590         dbgs() << *T << "\n";
8591     });
8592
8593   if (NewTerms.empty() ||
8594       !findArrayDimensionsRec(SE, NewTerms, Sizes)) {
8595     Sizes.clear();
8596     return;
8597   }
8598
8599   // The last element to be pushed into Sizes is the size of an element.
8600   Sizes.push_back(ElementSize);
8601
8602   DEBUG({
8603       dbgs() << "Sizes:\n";
8604       for (const SCEV *S : Sizes)
8605         dbgs() << *S << "\n";
8606     });
8607 }
8608
8609 /// Third step of delinearization: compute the access functions for the
8610 /// Subscripts based on the dimensions in Sizes.
8611 void ScalarEvolution::computeAccessFunctions(
8612     const SCEV *Expr, SmallVectorImpl<const SCEV *> &Subscripts,
8613     SmallVectorImpl<const SCEV *> &Sizes) {
8614
8615   // Early exit in case this SCEV is not an affine multivariate function.
8616   if (Sizes.empty())
8617     return;
8618
8619   if (auto *AR = dyn_cast<SCEVAddRecExpr>(Expr))
8620     if (!AR->isAffine())
8621       return;
8622
8623   const SCEV *Res = Expr;
8624   int Last = Sizes.size() - 1;
8625   for (int i = Last; i >= 0; i--) {
8626     const SCEV *Q, *R;
8627     SCEVDivision::divide(*this, Res, Sizes[i], &Q, &R);
8628
8629     DEBUG({
8630         dbgs() << "Res: " << *Res << "\n";
8631         dbgs() << "Sizes[i]: " << *Sizes[i] << "\n";
8632         dbgs() << "Res divided by Sizes[i]:\n";
8633         dbgs() << "Quotient: " << *Q << "\n";
8634         dbgs() << "Remainder: " << *R << "\n";
8635       });
8636
8637     Res = Q;
8638
8639     // Do not record the last subscript corresponding to the size of elements in
8640     // the array.
8641     if (i == Last) {
8642
8643       // Bail out if the remainder is too complex.
8644       if (isa<SCEVAddRecExpr>(R)) {
8645         Subscripts.clear();
8646         Sizes.clear();
8647         return;
8648       }
8649
8650       continue;
8651     }
8652
8653     // Record the access function for the current subscript.
8654     Subscripts.push_back(R);
8655   }
8656
8657   // Also push in last position the remainder of the last division: it will be
8658   // the access function of the innermost dimension.
8659   Subscripts.push_back(Res);
8660
8661   std::reverse(Subscripts.begin(), Subscripts.end());
8662
8663   DEBUG({
8664       dbgs() << "Subscripts:\n";
8665       for (const SCEV *S : Subscripts)
8666         dbgs() << *S << "\n";
8667     });
8668 }
8669
8670 /// Splits the SCEV into two vectors of SCEVs representing the subscripts and
8671 /// sizes of an array access. Returns the remainder of the delinearization that
8672 /// is the offset start of the array.  The SCEV->delinearize algorithm computes
8673 /// the multiples of SCEV coefficients: that is a pattern matching of sub
8674 /// expressions in the stride and base of a SCEV corresponding to the
8675 /// computation of a GCD (greatest common divisor) of base and stride.  When
8676 /// SCEV->delinearize fails, it returns the SCEV unchanged.
8677 ///
8678 /// For example: when analyzing the memory access A[i][j][k] in this loop nest
8679 ///
8680 ///  void foo(long n, long m, long o, double A[n][m][o]) {
8681 ///
8682 ///    for (long i = 0; i < n; i++)
8683 ///      for (long j = 0; j < m; j++)
8684 ///        for (long k = 0; k < o; k++)
8685 ///          A[i][j][k] = 1.0;
8686 ///  }
8687 ///
8688 /// the delinearization input is the following AddRec SCEV:
8689 ///
8690 ///  AddRec: {{{%A,+,(8 * %m * %o)}<%for.i>,+,(8 * %o)}<%for.j>,+,8}<%for.k>
8691 ///
8692 /// From this SCEV, we are able to say that the base offset of the access is %A
8693 /// because it appears as an offset that does not divide any of the strides in
8694 /// the loops:
8695 ///
8696 ///  CHECK: Base offset: %A
8697 ///
8698 /// and then SCEV->delinearize determines the size of some of the dimensions of
8699 /// the array as these are the multiples by which the strides are happening:
8700 ///
8701 ///  CHECK: ArrayDecl[UnknownSize][%m][%o] with elements of sizeof(double) bytes.
8702 ///
8703 /// Note that the outermost dimension remains of UnknownSize because there are
8704 /// no strides that would help identifying the size of the last dimension: when
8705 /// the array has been statically allocated, one could compute the size of that
8706 /// dimension by dividing the overall size of the array by the size of the known
8707 /// dimensions: %m * %o * 8.
8708 ///
8709 /// Finally delinearize provides the access functions for the array reference
8710 /// that does correspond to A[i][j][k] of the above C testcase:
8711 ///
8712 ///  CHECK: ArrayRef[{0,+,1}<%for.i>][{0,+,1}<%for.j>][{0,+,1}<%for.k>]
8713 ///
8714 /// The testcases are checking the output of a function pass:
8715 /// DelinearizationPass that walks through all loads and stores of a function
8716 /// asking for the SCEV of the memory access with respect to all enclosing
8717 /// loops, calling SCEV->delinearize on that and printing the results.
8718
8719 void ScalarEvolution::delinearize(const SCEV *Expr,
8720                                  SmallVectorImpl<const SCEV *> &Subscripts,
8721                                  SmallVectorImpl<const SCEV *> &Sizes,
8722                                  const SCEV *ElementSize) {
8723   // First step: collect parametric terms.
8724   SmallVector<const SCEV *, 4> Terms;
8725   collectParametricTerms(Expr, Terms);
8726
8727   if (Terms.empty())
8728     return;
8729
8730   // Second step: find subscript sizes.
8731   findArrayDimensions(Terms, Sizes, ElementSize);
8732
8733   if (Sizes.empty())
8734     return;
8735
8736   // Third step: compute the access functions for each subscript.
8737   computeAccessFunctions(Expr, Subscripts, Sizes);
8738
8739   if (Subscripts.empty())
8740     return;
8741
8742   DEBUG({
8743       dbgs() << "succeeded to delinearize " << *Expr << "\n";
8744       dbgs() << "ArrayDecl[UnknownSize]";
8745       for (const SCEV *S : Sizes)
8746         dbgs() << "[" << *S << "]";
8747
8748       dbgs() << "\nArrayRef";
8749       for (const SCEV *S : Subscripts)
8750         dbgs() << "[" << *S << "]";
8751       dbgs() << "\n";
8752     });
8753 }
8754
8755 //===----------------------------------------------------------------------===//
8756 //                   SCEVCallbackVH Class Implementation
8757 //===----------------------------------------------------------------------===//
8758
8759 void ScalarEvolution::SCEVCallbackVH::deleted() {
8760   assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
8761   if (PHINode *PN = dyn_cast<PHINode>(getValPtr()))
8762     SE->ConstantEvolutionLoopExitValue.erase(PN);
8763   SE->ValueExprMap.erase(getValPtr());
8764   // this now dangles!
8765 }
8766
8767 void ScalarEvolution::SCEVCallbackVH::allUsesReplacedWith(Value *V) {
8768   assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
8769
8770   // Forget all the expressions associated with users of the old value,
8771   // so that future queries will recompute the expressions using the new
8772   // value.
8773   Value *Old = getValPtr();
8774   SmallVector<User *, 16> Worklist(Old->user_begin(), Old->user_end());
8775   SmallPtrSet<User *, 8> Visited;
8776   while (!Worklist.empty()) {
8777     User *U = Worklist.pop_back_val();
8778     // Deleting the Old value will cause this to dangle. Postpone
8779     // that until everything else is done.
8780     if (U == Old)
8781       continue;
8782     if (!Visited.insert(U).second)
8783       continue;
8784     if (PHINode *PN = dyn_cast<PHINode>(U))
8785       SE->ConstantEvolutionLoopExitValue.erase(PN);
8786     SE->ValueExprMap.erase(U);
8787     Worklist.insert(Worklist.end(), U->user_begin(), U->user_end());
8788   }
8789   // Delete the Old value.
8790   if (PHINode *PN = dyn_cast<PHINode>(Old))
8791     SE->ConstantEvolutionLoopExitValue.erase(PN);
8792   SE->ValueExprMap.erase(Old);
8793   // this now dangles!
8794 }
8795
8796 ScalarEvolution::SCEVCallbackVH::SCEVCallbackVH(Value *V, ScalarEvolution *se)
8797   : CallbackVH(V), SE(se) {}
8798
8799 //===----------------------------------------------------------------------===//
8800 //                   ScalarEvolution Class Implementation
8801 //===----------------------------------------------------------------------===//
8802
8803 ScalarEvolution::ScalarEvolution(Function &F, TargetLibraryInfo &TLI,
8804                                  AssumptionCache &AC, DominatorTree &DT,
8805                                  LoopInfo &LI)
8806     : F(F), TLI(TLI), AC(AC), DT(DT), LI(LI),
8807       CouldNotCompute(new SCEVCouldNotCompute()),
8808       WalkingBEDominatingConds(false), ProvingSplitPredicate(false),
8809       ValuesAtScopes(64), LoopDispositions(64), BlockDispositions(64),
8810       FirstUnknown(nullptr) {}
8811
8812 ScalarEvolution::ScalarEvolution(ScalarEvolution &&Arg)
8813     : F(Arg.F), TLI(Arg.TLI), AC(Arg.AC), DT(Arg.DT), LI(Arg.LI),
8814       CouldNotCompute(std::move(Arg.CouldNotCompute)),
8815       ValueExprMap(std::move(Arg.ValueExprMap)),
8816       WalkingBEDominatingConds(false), ProvingSplitPredicate(false),
8817       BackedgeTakenCounts(std::move(Arg.BackedgeTakenCounts)),
8818       ConstantEvolutionLoopExitValue(
8819           std::move(Arg.ConstantEvolutionLoopExitValue)),
8820       ValuesAtScopes(std::move(Arg.ValuesAtScopes)),
8821       LoopDispositions(std::move(Arg.LoopDispositions)),
8822       BlockDispositions(std::move(Arg.BlockDispositions)),
8823       UnsignedRanges(std::move(Arg.UnsignedRanges)),
8824       SignedRanges(std::move(Arg.SignedRanges)),
8825       UniqueSCEVs(std::move(Arg.UniqueSCEVs)),
8826       SCEVAllocator(std::move(Arg.SCEVAllocator)),
8827       FirstUnknown(Arg.FirstUnknown) {
8828   Arg.FirstUnknown = nullptr;
8829 }
8830
8831 ScalarEvolution::~ScalarEvolution() {
8832   // Iterate through all the SCEVUnknown instances and call their
8833   // destructors, so that they release their references to their values.
8834   for (SCEVUnknown *U = FirstUnknown; U;) {
8835     SCEVUnknown *Tmp = U;
8836     U = U->Next;
8837     Tmp->~SCEVUnknown();
8838   }
8839   FirstUnknown = nullptr;
8840
8841   ValueExprMap.clear();
8842
8843   // Free any extra memory created for ExitNotTakenInfo in the unlikely event
8844   // that a loop had multiple computable exits.
8845   for (auto &BTCI : BackedgeTakenCounts)
8846     BTCI.second.clear();
8847
8848   assert(PendingLoopPredicates.empty() && "isImpliedCond garbage");
8849   assert(!WalkingBEDominatingConds && "isLoopBackedgeGuardedByCond garbage!");
8850   assert(!ProvingSplitPredicate && "ProvingSplitPredicate garbage!");
8851 }
8852
8853 bool ScalarEvolution::hasLoopInvariantBackedgeTakenCount(const Loop *L) {
8854   return !isa<SCEVCouldNotCompute>(getBackedgeTakenCount(L));
8855 }
8856
8857 static void PrintLoopInfo(raw_ostream &OS, ScalarEvolution *SE,
8858                           const Loop *L) {
8859   // Print all inner loops first
8860   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
8861     PrintLoopInfo(OS, SE, *I);
8862
8863   OS << "Loop ";
8864   L->getHeader()->printAsOperand(OS, /*PrintType=*/false);
8865   OS << ": ";
8866
8867   SmallVector<BasicBlock *, 8> ExitBlocks;
8868   L->getExitBlocks(ExitBlocks);
8869   if (ExitBlocks.size() != 1)
8870     OS << "<multiple exits> ";
8871
8872   if (SE->hasLoopInvariantBackedgeTakenCount(L)) {
8873     OS << "backedge-taken count is " << *SE->getBackedgeTakenCount(L);
8874   } else {
8875     OS << "Unpredictable backedge-taken count. ";
8876   }
8877
8878   OS << "\n"
8879         "Loop ";
8880   L->getHeader()->printAsOperand(OS, /*PrintType=*/false);
8881   OS << ": ";
8882
8883   if (!isa<SCEVCouldNotCompute>(SE->getMaxBackedgeTakenCount(L))) {
8884     OS << "max backedge-taken count is " << *SE->getMaxBackedgeTakenCount(L);
8885   } else {
8886     OS << "Unpredictable max backedge-taken count. ";
8887   }
8888
8889   OS << "\n";
8890 }
8891
8892 void ScalarEvolution::print(raw_ostream &OS) const {
8893   // ScalarEvolution's implementation of the print method is to print
8894   // out SCEV values of all instructions that are interesting. Doing
8895   // this potentially causes it to create new SCEV objects though,
8896   // which technically conflicts with the const qualifier. This isn't
8897   // observable from outside the class though, so casting away the
8898   // const isn't dangerous.
8899   ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
8900
8901   OS << "Classifying expressions for: ";
8902   F.printAsOperand(OS, /*PrintType=*/false);
8903   OS << "\n";
8904   for (Instruction &I : instructions(F))
8905     if (isSCEVable(I.getType()) && !isa<CmpInst>(I)) {
8906       OS << I << '\n';
8907       OS << "  -->  ";
8908       const SCEV *SV = SE.getSCEV(&I);
8909       SV->print(OS);
8910       if (!isa<SCEVCouldNotCompute>(SV)) {
8911         OS << " U: ";
8912         SE.getUnsignedRange(SV).print(OS);
8913         OS << " S: ";
8914         SE.getSignedRange(SV).print(OS);
8915       }
8916
8917       const Loop *L = LI.getLoopFor(I.getParent());
8918
8919       const SCEV *AtUse = SE.getSCEVAtScope(SV, L);
8920       if (AtUse != SV) {
8921         OS << "  -->  ";
8922         AtUse->print(OS);
8923         if (!isa<SCEVCouldNotCompute>(AtUse)) {
8924           OS << " U: ";
8925           SE.getUnsignedRange(AtUse).print(OS);
8926           OS << " S: ";
8927           SE.getSignedRange(AtUse).print(OS);
8928         }
8929       }
8930
8931       if (L) {
8932         OS << "\t\t" "Exits: ";
8933         const SCEV *ExitValue = SE.getSCEVAtScope(SV, L->getParentLoop());
8934         if (!SE.isLoopInvariant(ExitValue, L)) {
8935           OS << "<<Unknown>>";
8936         } else {
8937           OS << *ExitValue;
8938         }
8939       }
8940
8941       OS << "\n";
8942     }
8943
8944   OS << "Determining loop execution counts for: ";
8945   F.printAsOperand(OS, /*PrintType=*/false);
8946   OS << "\n";
8947   for (LoopInfo::iterator I = LI.begin(), E = LI.end(); I != E; ++I)
8948     PrintLoopInfo(OS, &SE, *I);
8949 }
8950
8951 ScalarEvolution::LoopDisposition
8952 ScalarEvolution::getLoopDisposition(const SCEV *S, const Loop *L) {
8953   auto &Values = LoopDispositions[S];
8954   for (auto &V : Values) {
8955     if (V.getPointer() == L)
8956       return V.getInt();
8957   }
8958   Values.emplace_back(L, LoopVariant);
8959   LoopDisposition D = computeLoopDisposition(S, L);
8960   auto &Values2 = LoopDispositions[S];
8961   for (auto &V : make_range(Values2.rbegin(), Values2.rend())) {
8962     if (V.getPointer() == L) {
8963       V.setInt(D);
8964       break;
8965     }
8966   }
8967   return D;
8968 }
8969
8970 ScalarEvolution::LoopDisposition
8971 ScalarEvolution::computeLoopDisposition(const SCEV *S, const Loop *L) {
8972   switch (static_cast<SCEVTypes>(S->getSCEVType())) {
8973   case scConstant:
8974     return LoopInvariant;
8975   case scTruncate:
8976   case scZeroExtend:
8977   case scSignExtend:
8978     return getLoopDisposition(cast<SCEVCastExpr>(S)->getOperand(), L);
8979   case scAddRecExpr: {
8980     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S);
8981
8982     // If L is the addrec's loop, it's computable.
8983     if (AR->getLoop() == L)
8984       return LoopComputable;
8985
8986     // Add recurrences are never invariant in the function-body (null loop).
8987     if (!L)
8988       return LoopVariant;
8989
8990     // This recurrence is variant w.r.t. L if L contains AR's loop.
8991     if (L->contains(AR->getLoop()))
8992       return LoopVariant;
8993
8994     // This recurrence is invariant w.r.t. L if AR's loop contains L.
8995     if (AR->getLoop()->contains(L))
8996       return LoopInvariant;
8997
8998     // This recurrence is variant w.r.t. L if any of its operands
8999     // are variant.
9000     for (SCEVAddRecExpr::op_iterator I = AR->op_begin(), E = AR->op_end();
9001          I != E; ++I)
9002       if (!isLoopInvariant(*I, L))
9003         return LoopVariant;
9004
9005     // Otherwise it's loop-invariant.
9006     return LoopInvariant;
9007   }
9008   case scAddExpr:
9009   case scMulExpr:
9010   case scUMaxExpr:
9011   case scSMaxExpr: {
9012     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S);
9013     bool HasVarying = false;
9014     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
9015          I != E; ++I) {
9016       LoopDisposition D = getLoopDisposition(*I, L);
9017       if (D == LoopVariant)
9018         return LoopVariant;
9019       if (D == LoopComputable)
9020         HasVarying = true;
9021     }
9022     return HasVarying ? LoopComputable : LoopInvariant;
9023   }
9024   case scUDivExpr: {
9025     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
9026     LoopDisposition LD = getLoopDisposition(UDiv->getLHS(), L);
9027     if (LD == LoopVariant)
9028       return LoopVariant;
9029     LoopDisposition RD = getLoopDisposition(UDiv->getRHS(), L);
9030     if (RD == LoopVariant)
9031       return LoopVariant;
9032     return (LD == LoopInvariant && RD == LoopInvariant) ?
9033            LoopInvariant : LoopComputable;
9034   }
9035   case scUnknown:
9036     // All non-instruction values are loop invariant.  All instructions are loop
9037     // invariant if they are not contained in the specified loop.
9038     // Instructions are never considered invariant in the function body
9039     // (null loop) because they are defined within the "loop".
9040     if (Instruction *I = dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue()))
9041       return (L && !L->contains(I)) ? LoopInvariant : LoopVariant;
9042     return LoopInvariant;
9043   case scCouldNotCompute:
9044     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
9045   }
9046   llvm_unreachable("Unknown SCEV kind!");
9047 }
9048
9049 bool ScalarEvolution::isLoopInvariant(const SCEV *S, const Loop *L) {
9050   return getLoopDisposition(S, L) == LoopInvariant;
9051 }
9052
9053 bool ScalarEvolution::hasComputableLoopEvolution(const SCEV *S, const Loop *L) {
9054   return getLoopDisposition(S, L) == LoopComputable;
9055 }
9056
9057 ScalarEvolution::BlockDisposition
9058 ScalarEvolution::getBlockDisposition(const SCEV *S, const BasicBlock *BB) {
9059   auto &Values = BlockDispositions[S];
9060   for (auto &V : Values) {
9061     if (V.getPointer() == BB)
9062       return V.getInt();
9063   }
9064   Values.emplace_back(BB, DoesNotDominateBlock);
9065   BlockDisposition D = computeBlockDisposition(S, BB);
9066   auto &Values2 = BlockDispositions[S];
9067   for (auto &V : make_range(Values2.rbegin(), Values2.rend())) {
9068     if (V.getPointer() == BB) {
9069       V.setInt(D);
9070       break;
9071     }
9072   }
9073   return D;
9074 }
9075
9076 ScalarEvolution::BlockDisposition
9077 ScalarEvolution::computeBlockDisposition(const SCEV *S, const BasicBlock *BB) {
9078   switch (static_cast<SCEVTypes>(S->getSCEVType())) {
9079   case scConstant:
9080     return ProperlyDominatesBlock;
9081   case scTruncate:
9082   case scZeroExtend:
9083   case scSignExtend:
9084     return getBlockDisposition(cast<SCEVCastExpr>(S)->getOperand(), BB);
9085   case scAddRecExpr: {
9086     // This uses a "dominates" query instead of "properly dominates" query
9087     // to test for proper dominance too, because the instruction which
9088     // produces the addrec's value is a PHI, and a PHI effectively properly
9089     // dominates its entire containing block.
9090     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S);
9091     if (!DT.dominates(AR->getLoop()->getHeader(), BB))
9092       return DoesNotDominateBlock;
9093   }
9094   // FALL THROUGH into SCEVNAryExpr handling.
9095   case scAddExpr:
9096   case scMulExpr:
9097   case scUMaxExpr:
9098   case scSMaxExpr: {
9099     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S);
9100     bool Proper = true;
9101     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
9102          I != E; ++I) {
9103       BlockDisposition D = getBlockDisposition(*I, BB);
9104       if (D == DoesNotDominateBlock)
9105         return DoesNotDominateBlock;
9106       if (D == DominatesBlock)
9107         Proper = false;
9108     }
9109     return Proper ? ProperlyDominatesBlock : DominatesBlock;
9110   }
9111   case scUDivExpr: {
9112     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
9113     const SCEV *LHS = UDiv->getLHS(), *RHS = UDiv->getRHS();
9114     BlockDisposition LD = getBlockDisposition(LHS, BB);
9115     if (LD == DoesNotDominateBlock)
9116       return DoesNotDominateBlock;
9117     BlockDisposition RD = getBlockDisposition(RHS, BB);
9118     if (RD == DoesNotDominateBlock)
9119       return DoesNotDominateBlock;
9120     return (LD == ProperlyDominatesBlock && RD == ProperlyDominatesBlock) ?
9121       ProperlyDominatesBlock : DominatesBlock;
9122   }
9123   case scUnknown:
9124     if (Instruction *I =
9125           dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue())) {
9126       if (I->getParent() == BB)
9127         return DominatesBlock;
9128       if (DT.properlyDominates(I->getParent(), BB))
9129         return ProperlyDominatesBlock;
9130       return DoesNotDominateBlock;
9131     }
9132     return ProperlyDominatesBlock;
9133   case scCouldNotCompute:
9134     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
9135   }
9136   llvm_unreachable("Unknown SCEV kind!");
9137 }
9138
9139 bool ScalarEvolution::dominates(const SCEV *S, const BasicBlock *BB) {
9140   return getBlockDisposition(S, BB) >= DominatesBlock;
9141 }
9142
9143 bool ScalarEvolution::properlyDominates(const SCEV *S, const BasicBlock *BB) {
9144   return getBlockDisposition(S, BB) == ProperlyDominatesBlock;
9145 }
9146
9147 namespace {
9148 // Search for a SCEV expression node within an expression tree.
9149 // Implements SCEVTraversal::Visitor.
9150 struct SCEVSearch {
9151   const SCEV *Node;
9152   bool IsFound;
9153
9154   SCEVSearch(const SCEV *N): Node(N), IsFound(false) {}
9155
9156   bool follow(const SCEV *S) {
9157     IsFound |= (S == Node);
9158     return !IsFound;
9159   }
9160   bool isDone() const { return IsFound; }
9161 };
9162 }
9163
9164 bool ScalarEvolution::hasOperand(const SCEV *S, const SCEV *Op) const {
9165   SCEVSearch Search(Op);
9166   visitAll(S, Search);
9167   return Search.IsFound;
9168 }
9169
9170 void ScalarEvolution::forgetMemoizedResults(const SCEV *S) {
9171   ValuesAtScopes.erase(S);
9172   LoopDispositions.erase(S);
9173   BlockDispositions.erase(S);
9174   UnsignedRanges.erase(S);
9175   SignedRanges.erase(S);
9176
9177   for (DenseMap<const Loop*, BackedgeTakenInfo>::iterator I =
9178          BackedgeTakenCounts.begin(), E = BackedgeTakenCounts.end(); I != E; ) {
9179     BackedgeTakenInfo &BEInfo = I->second;
9180     if (BEInfo.hasOperand(S, this)) {
9181       BEInfo.clear();
9182       BackedgeTakenCounts.erase(I++);
9183     }
9184     else
9185       ++I;
9186   }
9187 }
9188
9189 typedef DenseMap<const Loop *, std::string> VerifyMap;
9190
9191 /// replaceSubString - Replaces all occurrences of From in Str with To.
9192 static void replaceSubString(std::string &Str, StringRef From, StringRef To) {
9193   size_t Pos = 0;
9194   while ((Pos = Str.find(From, Pos)) != std::string::npos) {
9195     Str.replace(Pos, From.size(), To.data(), To.size());
9196     Pos += To.size();
9197   }
9198 }
9199
9200 /// getLoopBackedgeTakenCounts - Helper method for verifyAnalysis.
9201 static void
9202 getLoopBackedgeTakenCounts(Loop *L, VerifyMap &Map, ScalarEvolution &SE) {
9203   for (Loop::reverse_iterator I = L->rbegin(), E = L->rend(); I != E; ++I) {
9204     getLoopBackedgeTakenCounts(*I, Map, SE); // recurse.
9205
9206     std::string &S = Map[L];
9207     if (S.empty()) {
9208       raw_string_ostream OS(S);
9209       SE.getBackedgeTakenCount(L)->print(OS);
9210
9211       // false and 0 are semantically equivalent. This can happen in dead loops.
9212       replaceSubString(OS.str(), "false", "0");
9213       // Remove wrap flags, their use in SCEV is highly fragile.
9214       // FIXME: Remove this when SCEV gets smarter about them.
9215       replaceSubString(OS.str(), "<nw>", "");
9216       replaceSubString(OS.str(), "<nsw>", "");
9217       replaceSubString(OS.str(), "<nuw>", "");
9218     }
9219   }
9220 }
9221
9222 void ScalarEvolution::verify() const {
9223   ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
9224
9225   // Gather stringified backedge taken counts for all loops using SCEV's caches.
9226   // FIXME: It would be much better to store actual values instead of strings,
9227   //        but SCEV pointers will change if we drop the caches.
9228   VerifyMap BackedgeDumpsOld, BackedgeDumpsNew;
9229   for (LoopInfo::reverse_iterator I = LI.rbegin(), E = LI.rend(); I != E; ++I)
9230     getLoopBackedgeTakenCounts(*I, BackedgeDumpsOld, SE);
9231
9232   // Gather stringified backedge taken counts for all loops using a fresh
9233   // ScalarEvolution object.
9234   ScalarEvolution SE2(F, TLI, AC, DT, LI);
9235   for (LoopInfo::reverse_iterator I = LI.rbegin(), E = LI.rend(); I != E; ++I)
9236     getLoopBackedgeTakenCounts(*I, BackedgeDumpsNew, SE2);
9237
9238   // Now compare whether they're the same with and without caches. This allows
9239   // verifying that no pass changed the cache.
9240   assert(BackedgeDumpsOld.size() == BackedgeDumpsNew.size() &&
9241          "New loops suddenly appeared!");
9242
9243   for (VerifyMap::iterator OldI = BackedgeDumpsOld.begin(),
9244                            OldE = BackedgeDumpsOld.end(),
9245                            NewI = BackedgeDumpsNew.begin();
9246        OldI != OldE; ++OldI, ++NewI) {
9247     assert(OldI->first == NewI->first && "Loop order changed!");
9248
9249     // Compare the stringified SCEVs. We don't care if undef backedgetaken count
9250     // changes.
9251     // FIXME: We currently ignore SCEV changes from/to CouldNotCompute. This
9252     // means that a pass is buggy or SCEV has to learn a new pattern but is
9253     // usually not harmful.
9254     if (OldI->second != NewI->second &&
9255         OldI->second.find("undef") == std::string::npos &&
9256         NewI->second.find("undef") == std::string::npos &&
9257         OldI->second != "***COULDNOTCOMPUTE***" &&
9258         NewI->second != "***COULDNOTCOMPUTE***") {
9259       dbgs() << "SCEVValidator: SCEV for loop '"
9260              << OldI->first->getHeader()->getName()
9261              << "' changed from '" << OldI->second
9262              << "' to '" << NewI->second << "'!\n";
9263       std::abort();
9264     }
9265   }
9266
9267   // TODO: Verify more things.
9268 }
9269
9270 char ScalarEvolutionAnalysis::PassID;
9271
9272 ScalarEvolution ScalarEvolutionAnalysis::run(Function &F,
9273                                              AnalysisManager<Function> *AM) {
9274   return ScalarEvolution(F, AM->getResult<TargetLibraryAnalysis>(F),
9275                          AM->getResult<AssumptionAnalysis>(F),
9276                          AM->getResult<DominatorTreeAnalysis>(F),
9277                          AM->getResult<LoopAnalysis>(F));
9278 }
9279
9280 PreservedAnalyses
9281 ScalarEvolutionPrinterPass::run(Function &F, AnalysisManager<Function> *AM) {
9282   AM->getResult<ScalarEvolutionAnalysis>(F).print(OS);
9283   return PreservedAnalyses::all();
9284 }
9285
9286 INITIALIZE_PASS_BEGIN(ScalarEvolutionWrapperPass, "scalar-evolution",
9287                       "Scalar Evolution Analysis", false, true)
9288 INITIALIZE_PASS_DEPENDENCY(AssumptionCacheTracker)
9289 INITIALIZE_PASS_DEPENDENCY(LoopInfoWrapperPass)
9290 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
9291 INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)
9292 INITIALIZE_PASS_END(ScalarEvolutionWrapperPass, "scalar-evolution",
9293                     "Scalar Evolution Analysis", false, true)
9294 char ScalarEvolutionWrapperPass::ID = 0;
9295
9296 ScalarEvolutionWrapperPass::ScalarEvolutionWrapperPass() : FunctionPass(ID) {
9297   initializeScalarEvolutionWrapperPassPass(*PassRegistry::getPassRegistry());
9298 }
9299
9300 bool ScalarEvolutionWrapperPass::runOnFunction(Function &F) {
9301   SE.reset(new ScalarEvolution(
9302       F, getAnalysis<TargetLibraryInfoWrapperPass>().getTLI(),
9303       getAnalysis<AssumptionCacheTracker>().getAssumptionCache(F),
9304       getAnalysis<DominatorTreeWrapperPass>().getDomTree(),
9305       getAnalysis<LoopInfoWrapperPass>().getLoopInfo()));
9306   return false;
9307 }
9308
9309 void ScalarEvolutionWrapperPass::releaseMemory() { SE.reset(); }
9310
9311 void ScalarEvolutionWrapperPass::print(raw_ostream &OS, const Module *) const {
9312   SE->print(OS);
9313 }
9314
9315 void ScalarEvolutionWrapperPass::verifyAnalysis() const {
9316   if (!VerifySCEV)
9317     return;
9318
9319   SE->verify();
9320 }
9321
9322 void ScalarEvolutionWrapperPass::getAnalysisUsage(AnalysisUsage &AU) const {
9323   AU.setPreservesAll();
9324   AU.addRequiredTransitive<AssumptionCacheTracker>();
9325   AU.addRequiredTransitive<LoopInfoWrapperPass>();
9326   AU.addRequiredTransitive<DominatorTreeWrapperPass>();
9327   AU.addRequiredTransitive<TargetLibraryInfoWrapperPass>();
9328 }