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