lib/Analysis/ScalarEvolution.cpp

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