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 = dyn_cast<SCEVMulExpr>(LHS);
2296         if (!Mul)
2297           return getUDivExactExpr(LHS, RHS);
2298       }
2299     }
2300   }
2301
2302   for (int i = 0, e = Mul->getNumOperands(); i != e; ++i) {
2303     if (Mul->getOperand(i) == RHS) {
2304       SmallVector<const SCEV *, 2> Operands;
2305       Operands.append(Mul->op_begin(), Mul->op_begin() + i);
2306       Operands.append(Mul->op_begin() + i + 1, Mul->op_end());
2307       return getMulExpr(Operands);
2308     }
2309   }
2310
2311   return getUDivExpr(LHS, RHS);
2312 }
2313
2314 /// getAddRecExpr - Get an add recurrence expression for the specified loop.
2315 /// Simplify the expression as much as possible.
2316 const SCEV *ScalarEvolution::getAddRecExpr(const SCEV *Start, const SCEV *Step,
2317                                            const Loop *L,
2318                                            SCEV::NoWrapFlags Flags) {
2319   SmallVector<const SCEV *, 4> Operands;
2320   Operands.push_back(Start);
2321   if (const SCEVAddRecExpr *StepChrec = dyn_cast<SCEVAddRecExpr>(Step))
2322     if (StepChrec->getLoop() == L) {
2323       Operands.append(StepChrec->op_begin(), StepChrec->op_end());
2324       return getAddRecExpr(Operands, L, maskFlags(Flags, SCEV::FlagNW));
2325     }
2326
2327   Operands.push_back(Step);
2328   return getAddRecExpr(Operands, L, Flags);
2329 }
2330
2331 /// getAddRecExpr - Get an add recurrence expression for the specified loop.
2332 /// Simplify the expression as much as possible.
2333 const SCEV *
2334 ScalarEvolution::getAddRecExpr(SmallVectorImpl<const SCEV *> &Operands,
2335                                const Loop *L, SCEV::NoWrapFlags Flags) {
2336   if (Operands.size() == 1) return Operands[0];
2337 #ifndef NDEBUG
2338   Type *ETy = getEffectiveSCEVType(Operands[0]->getType());
2339   for (unsigned i = 1, e = Operands.size(); i != e; ++i)
2340     assert(getEffectiveSCEVType(Operands[i]->getType()) == ETy &&
2341            "SCEVAddRecExpr operand types don't match!");
2342   for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2343     assert(isLoopInvariant(Operands[i], L) &&
2344            "SCEVAddRecExpr operand is not loop-invariant!");
2345 #endif
2346
2347   if (Operands.back()->isZero()) {
2348     Operands.pop_back();
2349     return getAddRecExpr(Operands, L, SCEV::FlagAnyWrap); // {X,+,0}  -->  X
2350   }
2351
2352   // It's tempting to want to call getMaxBackedgeTakenCount count here and
2353   // use that information to infer NUW and NSW flags. However, computing a
2354   // BE count requires calling getAddRecExpr, so we may not yet have a
2355   // meaningful BE count at this point (and if we don't, we'd be stuck
2356   // with a SCEVCouldNotCompute as the cached BE count).
2357
2358   // If FlagNSW is true and all the operands are non-negative, infer FlagNUW.
2359   // And vice-versa.
2360   int SignOrUnsignMask = SCEV::FlagNUW | SCEV::FlagNSW;
2361   SCEV::NoWrapFlags SignOrUnsignWrap = maskFlags(Flags, SignOrUnsignMask);
2362   if (SignOrUnsignWrap && (SignOrUnsignWrap != SignOrUnsignMask)) {
2363     bool All = true;
2364     for (SmallVectorImpl<const SCEV *>::const_iterator I = Operands.begin(),
2365          E = Operands.end(); I != E; ++I)
2366       if (!isKnownNonNegative(*I)) {
2367         All = false;
2368         break;
2369       }
2370     if (All) Flags = setFlags(Flags, (SCEV::NoWrapFlags)SignOrUnsignMask);
2371   }
2372
2373   // Canonicalize nested AddRecs in by nesting them in order of loop depth.
2374   if (const SCEVAddRecExpr *NestedAR = dyn_cast<SCEVAddRecExpr>(Operands[0])) {
2375     const Loop *NestedLoop = NestedAR->getLoop();
2376     if (L->contains(NestedLoop) ?
2377         (L->getLoopDepth() < NestedLoop->getLoopDepth()) :
2378         (!NestedLoop->contains(L) &&
2379          DT->dominates(L->getHeader(), NestedLoop->getHeader()))) {
2380       SmallVector<const SCEV *, 4> NestedOperands(NestedAR->op_begin(),
2381                                                   NestedAR->op_end());
2382       Operands[0] = NestedAR->getStart();
2383       // AddRecs require their operands be loop-invariant with respect to their
2384       // loops. Don't perform this transformation if it would break this
2385       // requirement.
2386       bool AllInvariant = true;
2387       for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2388         if (!isLoopInvariant(Operands[i], L)) {
2389           AllInvariant = false;
2390           break;
2391         }
2392       if (AllInvariant) {
2393         // Create a recurrence for the outer loop with the same step size.
2394         //
2395         // The outer recurrence keeps its NW flag but only keeps NUW/NSW if the
2396         // inner recurrence has the same property.
2397         SCEV::NoWrapFlags OuterFlags =
2398           maskFlags(Flags, SCEV::FlagNW | NestedAR->getNoWrapFlags());
2399
2400         NestedOperands[0] = getAddRecExpr(Operands, L, OuterFlags);
2401         AllInvariant = true;
2402         for (unsigned i = 0, e = NestedOperands.size(); i != e; ++i)
2403           if (!isLoopInvariant(NestedOperands[i], NestedLoop)) {
2404             AllInvariant = false;
2405             break;
2406           }
2407         if (AllInvariant) {
2408           // Ok, both add recurrences are valid after the transformation.
2409           //
2410           // The inner recurrence keeps its NW flag but only keeps NUW/NSW if
2411           // the outer recurrence has the same property.
2412           SCEV::NoWrapFlags InnerFlags =
2413             maskFlags(NestedAR->getNoWrapFlags(), SCEV::FlagNW | Flags);
2414           return getAddRecExpr(NestedOperands, NestedLoop, InnerFlags);
2415         }
2416       }
2417       // Reset Operands to its original state.
2418       Operands[0] = NestedAR;
2419     }
2420   }
2421
2422   // Okay, it looks like we really DO need an addrec expr.  Check to see if we
2423   // already have one, otherwise create a new one.
2424   FoldingSetNodeID ID;
2425   ID.AddInteger(scAddRecExpr);
2426   for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2427     ID.AddPointer(Operands[i]);
2428   ID.AddPointer(L);
2429   void *IP = 0;
2430   SCEVAddRecExpr *S =
2431     static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
2432   if (!S) {
2433     const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Operands.size());
2434     std::uninitialized_copy(Operands.begin(), Operands.end(), O);
2435     S = new (SCEVAllocator) SCEVAddRecExpr(ID.Intern(SCEVAllocator),
2436                                            O, Operands.size(), L);
2437     UniqueSCEVs.InsertNode(S, IP);
2438   }
2439   S->setNoWrapFlags(Flags);
2440   return S;
2441 }
2442
2443 const SCEV *ScalarEvolution::getSMaxExpr(const SCEV *LHS,
2444                                          const SCEV *RHS) {
2445   SmallVector<const SCEV *, 2> Ops;
2446   Ops.push_back(LHS);
2447   Ops.push_back(RHS);
2448   return getSMaxExpr(Ops);
2449 }
2450
2451 const SCEV *
2452 ScalarEvolution::getSMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
2453   assert(!Ops.empty() && "Cannot get empty smax!");
2454   if (Ops.size() == 1) return Ops[0];
2455 #ifndef NDEBUG
2456   Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
2457   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
2458     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
2459            "SCEVSMaxExpr operand types don't match!");
2460 #endif
2461
2462   // Sort by complexity, this groups all similar expression types together.
2463   GroupByComplexity(Ops, LI);
2464
2465   // If there are any constants, fold them together.
2466   unsigned Idx = 0;
2467   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
2468     ++Idx;
2469     assert(Idx < Ops.size());
2470     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
2471       // We found two constants, fold them together!
2472       ConstantInt *Fold = ConstantInt::get(getContext(),
2473                               APIntOps::smax(LHSC->getValue()->getValue(),
2474                                              RHSC->getValue()->getValue()));
2475       Ops[0] = getConstant(Fold);
2476       Ops.erase(Ops.begin()+1);  // Erase the folded element
2477       if (Ops.size() == 1) return Ops[0];
2478       LHSC = cast<SCEVConstant>(Ops[0]);
2479     }
2480
2481     // If we are left with a constant minimum-int, strip it off.
2482     if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(true)) {
2483       Ops.erase(Ops.begin());
2484       --Idx;
2485     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(true)) {
2486       // If we have an smax with a constant maximum-int, it will always be
2487       // maximum-int.
2488       return Ops[0];
2489     }
2490
2491     if (Ops.size() == 1) return Ops[0];
2492   }
2493
2494   // Find the first SMax
2495   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scSMaxExpr)
2496     ++Idx;
2497
2498   // Check to see if one of the operands is an SMax. If so, expand its operands
2499   // onto our operand list, and recurse to simplify.
2500   if (Idx < Ops.size()) {
2501     bool DeletedSMax = false;
2502     while (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(Ops[Idx])) {
2503       Ops.erase(Ops.begin()+Idx);
2504       Ops.append(SMax->op_begin(), SMax->op_end());
2505       DeletedSMax = true;
2506     }
2507
2508     if (DeletedSMax)
2509       return getSMaxExpr(Ops);
2510   }
2511
2512   // Okay, check to see if the same value occurs in the operand list twice.  If
2513   // so, delete one.  Since we sorted the list, these values are required to
2514   // be adjacent.
2515   for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
2516     //  X smax Y smax Y  -->  X smax Y
2517     //  X smax Y         -->  X, if X is always greater than Y
2518     if (Ops[i] == Ops[i+1] ||
2519         isKnownPredicate(ICmpInst::ICMP_SGE, Ops[i], Ops[i+1])) {
2520       Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
2521       --i; --e;
2522     } else if (isKnownPredicate(ICmpInst::ICMP_SLE, Ops[i], Ops[i+1])) {
2523       Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
2524       --i; --e;
2525     }
2526
2527   if (Ops.size() == 1) return Ops[0];
2528
2529   assert(!Ops.empty() && "Reduced smax down to nothing!");
2530
2531   // Okay, it looks like we really DO need an smax expr.  Check to see if we
2532   // already have one, otherwise create a new one.
2533   FoldingSetNodeID ID;
2534   ID.AddInteger(scSMaxExpr);
2535   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2536     ID.AddPointer(Ops[i]);
2537   void *IP = 0;
2538   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
2539   const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
2540   std::uninitialized_copy(Ops.begin(), Ops.end(), O);
2541   SCEV *S = new (SCEVAllocator) SCEVSMaxExpr(ID.Intern(SCEVAllocator),
2542                                              O, Ops.size());
2543   UniqueSCEVs.InsertNode(S, IP);
2544   return S;
2545 }
2546
2547 const SCEV *ScalarEvolution::getUMaxExpr(const SCEV *LHS,
2548                                          const SCEV *RHS) {
2549   SmallVector<const SCEV *, 2> Ops;
2550   Ops.push_back(LHS);
2551   Ops.push_back(RHS);
2552   return getUMaxExpr(Ops);
2553 }
2554
2555 const SCEV *
2556 ScalarEvolution::getUMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
2557   assert(!Ops.empty() && "Cannot get empty umax!");
2558   if (Ops.size() == 1) return Ops[0];
2559 #ifndef NDEBUG
2560   Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
2561   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
2562     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
2563            "SCEVUMaxExpr operand types don't match!");
2564 #endif
2565
2566   // Sort by complexity, this groups all similar expression types together.
2567   GroupByComplexity(Ops, LI);
2568
2569   // If there are any constants, fold them together.
2570   unsigned Idx = 0;
2571   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
2572     ++Idx;
2573     assert(Idx < Ops.size());
2574     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
2575       // We found two constants, fold them together!
2576       ConstantInt *Fold = ConstantInt::get(getContext(),
2577                               APIntOps::umax(LHSC->getValue()->getValue(),
2578                                              RHSC->getValue()->getValue()));
2579       Ops[0] = getConstant(Fold);
2580       Ops.erase(Ops.begin()+1);  // Erase the folded element
2581       if (Ops.size() == 1) return Ops[0];
2582       LHSC = cast<SCEVConstant>(Ops[0]);
2583     }
2584
2585     // If we are left with a constant minimum-int, strip it off.
2586     if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(false)) {
2587       Ops.erase(Ops.begin());
2588       --Idx;
2589     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(false)) {
2590       // If we have an umax with a constant maximum-int, it will always be
2591       // maximum-int.
2592       return Ops[0];
2593     }
2594
2595     if (Ops.size() == 1) return Ops[0];
2596   }
2597
2598   // Find the first UMax
2599   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scUMaxExpr)
2600     ++Idx;
2601
2602   // Check to see if one of the operands is a UMax. If so, expand its operands
2603   // onto our operand list, and recurse to simplify.
2604   if (Idx < Ops.size()) {
2605     bool DeletedUMax = false;
2606     while (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(Ops[Idx])) {
2607       Ops.erase(Ops.begin()+Idx);
2608       Ops.append(UMax->op_begin(), UMax->op_end());
2609       DeletedUMax = true;
2610     }
2611
2612     if (DeletedUMax)
2613       return getUMaxExpr(Ops);
2614   }
2615
2616   // Okay, check to see if the same value occurs in the operand list twice.  If
2617   // so, delete one.  Since we sorted the list, these values are required to
2618   // be adjacent.
2619   for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
2620     //  X umax Y umax Y  -->  X umax Y
2621     //  X umax Y         -->  X, if X is always greater than Y
2622     if (Ops[i] == Ops[i+1] ||
2623         isKnownPredicate(ICmpInst::ICMP_UGE, Ops[i], Ops[i+1])) {
2624       Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
2625       --i; --e;
2626     } else if (isKnownPredicate(ICmpInst::ICMP_ULE, Ops[i], Ops[i+1])) {
2627       Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
2628       --i; --e;
2629     }
2630
2631   if (Ops.size() == 1) return Ops[0];
2632
2633   assert(!Ops.empty() && "Reduced umax down to nothing!");
2634
2635   // Okay, it looks like we really DO need a umax expr.  Check to see if we
2636   // already have one, otherwise create a new one.
2637   FoldingSetNodeID ID;
2638   ID.AddInteger(scUMaxExpr);
2639   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2640     ID.AddPointer(Ops[i]);
2641   void *IP = 0;
2642   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
2643   const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
2644   std::uninitialized_copy(Ops.begin(), Ops.end(), O);
2645   SCEV *S = new (SCEVAllocator) SCEVUMaxExpr(ID.Intern(SCEVAllocator),
2646                                              O, Ops.size());
2647   UniqueSCEVs.InsertNode(S, IP);
2648   return S;
2649 }
2650
2651 const SCEV *ScalarEvolution::getSMinExpr(const SCEV *LHS,
2652                                          const SCEV *RHS) {
2653   // ~smax(~x, ~y) == smin(x, y).
2654   return getNotSCEV(getSMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
2655 }
2656
2657 const SCEV *ScalarEvolution::getUMinExpr(const SCEV *LHS,
2658                                          const SCEV *RHS) {
2659   // ~umax(~x, ~y) == umin(x, y)
2660   return getNotSCEV(getUMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
2661 }
2662
2663 const SCEV *ScalarEvolution::getSizeOfExpr(Type *IntTy, Type *AllocTy) {
2664   // If we have DataLayout, we can bypass creating a target-independent
2665   // constant expression and then folding it back into a ConstantInt.
2666   // This is just a compile-time optimization.
2667   if (TD)
2668     return getConstant(IntTy, TD->getTypeAllocSize(AllocTy));
2669
2670   Constant *C = ConstantExpr::getSizeOf(AllocTy);
2671   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
2672     if (Constant *Folded = ConstantFoldConstantExpression(CE, TD, TLI))
2673       C = Folded;
2674   Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(AllocTy));
2675   assert(Ty == IntTy && "Effective SCEV type doesn't match");
2676   return getTruncateOrZeroExtend(getSCEV(C), Ty);
2677 }
2678
2679 const SCEV *ScalarEvolution::getOffsetOfExpr(Type *IntTy,
2680                                              StructType *STy,
2681                                              unsigned FieldNo) {
2682   // If we have DataLayout, we can bypass creating a target-independent
2683   // constant expression and then folding it back into a ConstantInt.
2684   // This is just a compile-time optimization.
2685   if (TD) {
2686     return getConstant(IntTy,
2687                        TD->getStructLayout(STy)->getElementOffset(FieldNo));
2688   }
2689
2690   Constant *C = ConstantExpr::getOffsetOf(STy, FieldNo);
2691   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
2692     if (Constant *Folded = ConstantFoldConstantExpression(CE, TD, TLI))
2693       C = Folded;
2694
2695   Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(STy));
2696   return getTruncateOrZeroExtend(getSCEV(C), Ty);
2697 }
2698
2699 const SCEV *ScalarEvolution::getUnknown(Value *V) {
2700   // Don't attempt to do anything other than create a SCEVUnknown object
2701   // here.  createSCEV only calls getUnknown after checking for all other
2702   // interesting possibilities, and any other code that calls getUnknown
2703   // is doing so in order to hide a value from SCEV canonicalization.
2704
2705   FoldingSetNodeID ID;
2706   ID.AddInteger(scUnknown);
2707   ID.AddPointer(V);
2708   void *IP = 0;
2709   if (SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) {
2710     assert(cast<SCEVUnknown>(S)->getValue() == V &&
2711            "Stale SCEVUnknown in uniquing map!");
2712     return S;
2713   }
2714   SCEV *S = new (SCEVAllocator) SCEVUnknown(ID.Intern(SCEVAllocator), V, this,
2715                                             FirstUnknown);
2716   FirstUnknown = cast<SCEVUnknown>(S);
2717   UniqueSCEVs.InsertNode(S, IP);
2718   return S;
2719 }
2720
2721 //===----------------------------------------------------------------------===//
2722 //            Basic SCEV Analysis and PHI Idiom Recognition Code
2723 //
2724
2725 /// isSCEVable - Test if values of the given type are analyzable within
2726 /// the SCEV framework. This primarily includes integer types, and it
2727 /// can optionally include pointer types if the ScalarEvolution class
2728 /// has access to target-specific information.
2729 bool ScalarEvolution::isSCEVable(Type *Ty) const {
2730   // Integers and pointers are always SCEVable.
2731   return Ty->isIntegerTy() || Ty->isPointerTy();
2732 }
2733
2734 /// getTypeSizeInBits - Return the size in bits of the specified type,
2735 /// for which isSCEVable must return true.
2736 uint64_t ScalarEvolution::getTypeSizeInBits(Type *Ty) const {
2737   assert(isSCEVable(Ty) && "Type is not SCEVable!");
2738
2739   // If we have a DataLayout, use it!
2740   if (TD)
2741     return TD->getTypeSizeInBits(Ty);
2742
2743   // Integer types have fixed sizes.
2744   if (Ty->isIntegerTy())
2745     return Ty->getPrimitiveSizeInBits();
2746
2747   // The only other support type is pointer. Without DataLayout, conservatively
2748   // assume pointers are 64-bit.
2749   assert(Ty->isPointerTy() && "isSCEVable permitted a non-SCEVable type!");
2750   return 64;
2751 }
2752
2753 /// getEffectiveSCEVType - Return a type with the same bitwidth as
2754 /// the given type and which represents how SCEV will treat the given
2755 /// type, for which isSCEVable must return true. For pointer types,
2756 /// this is the pointer-sized integer type.
2757 Type *ScalarEvolution::getEffectiveSCEVType(Type *Ty) const {
2758   assert(isSCEVable(Ty) && "Type is not SCEVable!");
2759
2760   if (Ty->isIntegerTy()) {
2761     return Ty;
2762   }
2763
2764   // The only other support type is pointer.
2765   assert(Ty->isPointerTy() && "Unexpected non-pointer non-integer type!");
2766
2767   if (TD)
2768     return TD->getIntPtrType(Ty);
2769
2770   // Without DataLayout, conservatively assume pointers are 64-bit.
2771   return Type::getInt64Ty(getContext());
2772 }
2773
2774 const SCEV *ScalarEvolution::getCouldNotCompute() {
2775   return &CouldNotCompute;
2776 }
2777
2778 namespace {
2779   // Helper class working with SCEVTraversal to figure out if a SCEV contains
2780   // a SCEVUnknown with null value-pointer. FindInvalidSCEVUnknown::FindOne
2781   // is set iff if find such SCEVUnknown.
2782   //
2783   struct FindInvalidSCEVUnknown {
2784     bool FindOne;
2785     FindInvalidSCEVUnknown() { FindOne = false; }
2786     bool follow(const SCEV *S) {
2787       switch (S->getSCEVType()) {
2788       case scConstant:
2789         return false;
2790       case scUnknown:
2791         if (!cast<SCEVUnknown>(S)->getValue())
2792           FindOne = true;
2793         return false;
2794       default:
2795         return true;
2796       }
2797     }
2798     bool isDone() const { return FindOne; }
2799   };
2800 }
2801
2802 bool ScalarEvolution::checkValidity(const SCEV *S) const {
2803   FindInvalidSCEVUnknown F;
2804   SCEVTraversal<FindInvalidSCEVUnknown> ST(F);
2805   ST.visitAll(S);
2806
2807   return !F.FindOne;
2808 }
2809
2810 /// getSCEV - Return an existing SCEV if it exists, otherwise analyze the
2811 /// expression and create a new one.
2812 const SCEV *ScalarEvolution::getSCEV(Value *V) {
2813   assert(isSCEVable(V->getType()) && "Value is not SCEVable!");
2814
2815   ValueExprMapType::iterator I = ValueExprMap.find_as(V);
2816   if (I != ValueExprMap.end()) {
2817     const SCEV *S = I->second;
2818     if (checkValidity(S))
2819       return S;
2820     else
2821       ValueExprMap.erase(I);
2822   }
2823   const SCEV *S = createSCEV(V);
2824
2825   // The process of creating a SCEV for V may have caused other SCEVs
2826   // to have been created, so it's necessary to insert the new entry
2827   // from scratch, rather than trying to remember the insert position
2828   // above.
2829   ValueExprMap.insert(std::make_pair(SCEVCallbackVH(V, this), S));
2830   return S;
2831 }
2832
2833 /// getNegativeSCEV - Return a SCEV corresponding to -V = -1*V
2834 ///
2835 const SCEV *ScalarEvolution::getNegativeSCEV(const SCEV *V) {
2836   if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
2837     return getConstant(
2838                cast<ConstantInt>(ConstantExpr::getNeg(VC->getValue())));
2839
2840   Type *Ty = V->getType();
2841   Ty = getEffectiveSCEVType(Ty);
2842   return getMulExpr(V,
2843                   getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty))));
2844 }
2845
2846 /// getNotSCEV - Return a SCEV corresponding to ~V = -1-V
2847 const SCEV *ScalarEvolution::getNotSCEV(const SCEV *V) {
2848   if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
2849     return getConstant(
2850                 cast<ConstantInt>(ConstantExpr::getNot(VC->getValue())));
2851
2852   Type *Ty = V->getType();
2853   Ty = getEffectiveSCEVType(Ty);
2854   const SCEV *AllOnes =
2855                    getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty)));
2856   return getMinusSCEV(AllOnes, V);
2857 }
2858
2859 /// getMinusSCEV - Return LHS-RHS.  Minus is represented in SCEV as A+B*-1.
2860 const SCEV *ScalarEvolution::getMinusSCEV(const SCEV *LHS, const SCEV *RHS,
2861                                           SCEV::NoWrapFlags Flags) {
2862   assert(!maskFlags(Flags, SCEV::FlagNUW) && "subtraction does not have NUW");
2863
2864   // Fast path: X - X --> 0.
2865   if (LHS == RHS)
2866     return getConstant(LHS->getType(), 0);
2867
2868   // X - Y --> X + -Y
2869   return getAddExpr(LHS, getNegativeSCEV(RHS), Flags);
2870 }
2871
2872 /// getTruncateOrZeroExtend - Return a SCEV corresponding to a conversion of the
2873 /// input value to the specified type.  If the type must be extended, it is zero
2874 /// extended.
2875 const SCEV *
2876 ScalarEvolution::getTruncateOrZeroExtend(const SCEV *V, Type *Ty) {
2877   Type *SrcTy = V->getType();
2878   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2879          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2880          "Cannot truncate or zero extend with non-integer arguments!");
2881   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2882     return V;  // No conversion
2883   if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
2884     return getTruncateExpr(V, Ty);
2885   return getZeroExtendExpr(V, Ty);
2886 }
2887
2888 /// getTruncateOrSignExtend - Return a SCEV corresponding to a conversion of the
2889 /// input value to the specified type.  If the type must be extended, it is sign
2890 /// extended.
2891 const SCEV *
2892 ScalarEvolution::getTruncateOrSignExtend(const SCEV *V,
2893                                          Type *Ty) {
2894   Type *SrcTy = V->getType();
2895   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2896          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2897          "Cannot truncate or zero extend with non-integer arguments!");
2898   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2899     return V;  // No conversion
2900   if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
2901     return getTruncateExpr(V, Ty);
2902   return getSignExtendExpr(V, Ty);
2903 }
2904
2905 /// getNoopOrZeroExtend - Return a SCEV corresponding to a conversion of the
2906 /// input value to the specified type.  If the type must be extended, it is zero
2907 /// extended.  The conversion must not be narrowing.
2908 const SCEV *
2909 ScalarEvolution::getNoopOrZeroExtend(const SCEV *V, Type *Ty) {
2910   Type *SrcTy = V->getType();
2911   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2912          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2913          "Cannot noop or zero extend with non-integer arguments!");
2914   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
2915          "getNoopOrZeroExtend cannot truncate!");
2916   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2917     return V;  // No conversion
2918   return getZeroExtendExpr(V, Ty);
2919 }
2920
2921 /// getNoopOrSignExtend - Return a SCEV corresponding to a conversion of the
2922 /// input value to the specified type.  If the type must be extended, it is sign
2923 /// extended.  The conversion must not be narrowing.
2924 const SCEV *
2925 ScalarEvolution::getNoopOrSignExtend(const SCEV *V, Type *Ty) {
2926   Type *SrcTy = V->getType();
2927   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2928          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2929          "Cannot noop or sign extend with non-integer arguments!");
2930   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
2931          "getNoopOrSignExtend cannot truncate!");
2932   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2933     return V;  // No conversion
2934   return getSignExtendExpr(V, Ty);
2935 }
2936
2937 /// getNoopOrAnyExtend - Return a SCEV corresponding to a conversion of
2938 /// the input value to the specified type. If the type must be extended,
2939 /// it is extended with unspecified bits. The conversion must not be
2940 /// narrowing.
2941 const SCEV *
2942 ScalarEvolution::getNoopOrAnyExtend(const SCEV *V, Type *Ty) {
2943   Type *SrcTy = V->getType();
2944   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2945          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2946          "Cannot noop or any extend with non-integer arguments!");
2947   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
2948          "getNoopOrAnyExtend cannot truncate!");
2949   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2950     return V;  // No conversion
2951   return getAnyExtendExpr(V, Ty);
2952 }
2953
2954 /// getTruncateOrNoop - Return a SCEV corresponding to a conversion of the
2955 /// input value to the specified type.  The conversion must not be widening.
2956 const SCEV *
2957 ScalarEvolution::getTruncateOrNoop(const SCEV *V, Type *Ty) {
2958   Type *SrcTy = V->getType();
2959   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2960          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2961          "Cannot truncate or noop with non-integer arguments!");
2962   assert(getTypeSizeInBits(SrcTy) >= getTypeSizeInBits(Ty) &&
2963          "getTruncateOrNoop cannot extend!");
2964   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2965     return V;  // No conversion
2966   return getTruncateExpr(V, Ty);
2967 }
2968
2969 /// getUMaxFromMismatchedTypes - Promote the operands to the wider of
2970 /// the types using zero-extension, and then perform a umax operation
2971 /// with them.
2972 const SCEV *ScalarEvolution::getUMaxFromMismatchedTypes(const SCEV *LHS,
2973                                                         const SCEV *RHS) {
2974   const SCEV *PromotedLHS = LHS;
2975   const SCEV *PromotedRHS = RHS;
2976
2977   if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
2978     PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
2979   else
2980     PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
2981
2982   return getUMaxExpr(PromotedLHS, PromotedRHS);
2983 }
2984
2985 /// getUMinFromMismatchedTypes - Promote the operands to the wider of
2986 /// the types using zero-extension, and then perform a umin operation
2987 /// with them.
2988 const SCEV *ScalarEvolution::getUMinFromMismatchedTypes(const SCEV *LHS,
2989                                                         const SCEV *RHS) {
2990   const SCEV *PromotedLHS = LHS;
2991   const SCEV *PromotedRHS = RHS;
2992
2993   if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
2994     PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
2995   else
2996     PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
2997
2998   return getUMinExpr(PromotedLHS, PromotedRHS);
2999 }
3000
3001 /// getPointerBase - Transitively follow the chain of pointer-type operands
3002 /// until reaching a SCEV that does not have a single pointer operand. This
3003 /// returns a SCEVUnknown pointer for well-formed pointer-type expressions,
3004 /// but corner cases do exist.
3005 const SCEV *ScalarEvolution::getPointerBase(const SCEV *V) {
3006   // A pointer operand may evaluate to a nonpointer expression, such as null.
3007   if (!V->getType()->isPointerTy())
3008     return V;
3009
3010   if (const SCEVCastExpr *Cast = dyn_cast<SCEVCastExpr>(V)) {
3011     return getPointerBase(Cast->getOperand());
3012   }
3013   else if (const SCEVNAryExpr *NAry = dyn_cast<SCEVNAryExpr>(V)) {
3014     const SCEV *PtrOp = 0;
3015     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
3016          I != E; ++I) {
3017       if ((*I)->getType()->isPointerTy()) {
3018         // Cannot find the base of an expression with multiple pointer operands.
3019         if (PtrOp)
3020           return V;
3021         PtrOp = *I;
3022       }
3023     }
3024     if (!PtrOp)
3025       return V;
3026     return getPointerBase(PtrOp);
3027   }
3028   return V;
3029 }
3030
3031 /// PushDefUseChildren - Push users of the given Instruction
3032 /// onto the given Worklist.
3033 static void
3034 PushDefUseChildren(Instruction *I,
3035                    SmallVectorImpl<Instruction *> &Worklist) {
3036   // Push the def-use children onto the Worklist stack.
3037   for (Value::use_iterator UI = I->use_begin(), UE = I->use_end();
3038        UI != UE; ++UI)
3039     Worklist.push_back(cast<Instruction>(*UI));
3040 }
3041
3042 /// ForgetSymbolicValue - This looks up computed SCEV values for all
3043 /// instructions that depend on the given instruction and removes them from
3044 /// the ValueExprMapType map if they reference SymName. This is used during PHI
3045 /// resolution.
3046 void
3047 ScalarEvolution::ForgetSymbolicName(Instruction *PN, const SCEV *SymName) {
3048   SmallVector<Instruction *, 16> Worklist;
3049   PushDefUseChildren(PN, Worklist);
3050
3051   SmallPtrSet<Instruction *, 8> Visited;
3052   Visited.insert(PN);
3053   while (!Worklist.empty()) {
3054     Instruction *I = Worklist.pop_back_val();
3055     if (!Visited.insert(I)) continue;
3056
3057     ValueExprMapType::iterator It =
3058       ValueExprMap.find_as(static_cast<Value *>(I));
3059     if (It != ValueExprMap.end()) {
3060       const SCEV *Old = It->second;
3061
3062       // Short-circuit the def-use traversal if the symbolic name
3063       // ceases to appear in expressions.
3064       if (Old != SymName && !hasOperand(Old, SymName))
3065         continue;
3066
3067       // SCEVUnknown for a PHI either means that it has an unrecognized
3068       // structure, it's a PHI that's in the progress of being computed
3069       // by createNodeForPHI, or it's a single-value PHI. In the first case,
3070       // additional loop trip count information isn't going to change anything.
3071       // In the second case, createNodeForPHI will perform the necessary
3072       // updates on its own when it gets to that point. In the third, we do
3073       // want to forget the SCEVUnknown.
3074       if (!isa<PHINode>(I) ||
3075           !isa<SCEVUnknown>(Old) ||
3076           (I != PN && Old == SymName)) {
3077         forgetMemoizedResults(Old);
3078         ValueExprMap.erase(It);
3079       }
3080     }
3081
3082     PushDefUseChildren(I, Worklist);
3083   }
3084 }
3085
3086 /// createNodeForPHI - PHI nodes have two cases.  Either the PHI node exists in
3087 /// a loop header, making it a potential recurrence, or it doesn't.
3088 ///
3089 const SCEV *ScalarEvolution::createNodeForPHI(PHINode *PN) {
3090   if (const Loop *L = LI->getLoopFor(PN->getParent()))
3091     if (L->getHeader() == PN->getParent()) {
3092       // The loop may have multiple entrances or multiple exits; we can analyze
3093       // this phi as an addrec if it has a unique entry value and a unique
3094       // backedge value.
3095       Value *BEValueV = 0, *StartValueV = 0;
3096       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
3097         Value *V = PN->getIncomingValue(i);
3098         if (L->contains(PN->getIncomingBlock(i))) {
3099           if (!BEValueV) {
3100             BEValueV = V;
3101           } else if (BEValueV != V) {
3102             BEValueV = 0;
3103             break;
3104           }
3105         } else if (!StartValueV) {
3106           StartValueV = V;
3107         } else if (StartValueV != V) {
3108           StartValueV = 0;
3109           break;
3110         }
3111       }
3112       if (BEValueV && StartValueV) {
3113         // While we are analyzing this PHI node, handle its value symbolically.
3114         const SCEV *SymbolicName = getUnknown(PN);
3115         assert(ValueExprMap.find_as(PN) == ValueExprMap.end() &&
3116                "PHI node already processed?");
3117         ValueExprMap.insert(std::make_pair(SCEVCallbackVH(PN, this), SymbolicName));
3118
3119         // Using this symbolic name for the PHI, analyze the value coming around
3120         // the back-edge.
3121         const SCEV *BEValue = getSCEV(BEValueV);
3122
3123         // NOTE: If BEValue is loop invariant, we know that the PHI node just
3124         // has a special value for the first iteration of the loop.
3125
3126         // If the value coming around the backedge is an add with the symbolic
3127         // value we just inserted, then we found a simple induction variable!
3128         if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(BEValue)) {
3129           // If there is a single occurrence of the symbolic value, replace it
3130           // with a recurrence.
3131           unsigned FoundIndex = Add->getNumOperands();
3132           for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
3133             if (Add->getOperand(i) == SymbolicName)
3134               if (FoundIndex == e) {
3135                 FoundIndex = i;
3136                 break;
3137               }
3138
3139           if (FoundIndex != Add->getNumOperands()) {
3140             // Create an add with everything but the specified operand.
3141             SmallVector<const SCEV *, 8> Ops;
3142             for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
3143               if (i != FoundIndex)
3144                 Ops.push_back(Add->getOperand(i));
3145             const SCEV *Accum = getAddExpr(Ops);
3146
3147             // This is not a valid addrec if the step amount is varying each
3148             // loop iteration, but is not itself an addrec in this loop.
3149             if (isLoopInvariant(Accum, L) ||
3150                 (isa<SCEVAddRecExpr>(Accum) &&
3151                  cast<SCEVAddRecExpr>(Accum)->getLoop() == L)) {
3152               SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap;
3153
3154               // If the increment doesn't overflow, then neither the addrec nor
3155               // the post-increment will overflow.
3156               if (const AddOperator *OBO = dyn_cast<AddOperator>(BEValueV)) {
3157                 if (OBO->hasNoUnsignedWrap())
3158                   Flags = setFlags(Flags, SCEV::FlagNUW);
3159                 if (OBO->hasNoSignedWrap())
3160                   Flags = setFlags(Flags, SCEV::FlagNSW);
3161               } else if (GEPOperator *GEP = dyn_cast<GEPOperator>(BEValueV)) {
3162                 // If the increment is an inbounds GEP, then we know the address
3163                 // space cannot be wrapped around. We cannot make any guarantee
3164                 // about signed or unsigned overflow because pointers are
3165                 // unsigned but we may have a negative index from the base
3166                 // pointer. We can guarantee that no unsigned wrap occurs if the
3167                 // indices form a positive value.
3168                 if (GEP->isInBounds()) {
3169                   Flags = setFlags(Flags, SCEV::FlagNW);
3170
3171                   const SCEV *Ptr = getSCEV(GEP->getPointerOperand());
3172                   if (isKnownPositive(getMinusSCEV(getSCEV(GEP), Ptr)))
3173                     Flags = setFlags(Flags, SCEV::FlagNUW);
3174                 }
3175               } else if (const SubOperator *OBO =
3176                            dyn_cast<SubOperator>(BEValueV)) {
3177                 if (OBO->hasNoUnsignedWrap())
3178                   Flags = setFlags(Flags, SCEV::FlagNUW);
3179                 if (OBO->hasNoSignedWrap())
3180                   Flags = setFlags(Flags, SCEV::FlagNSW);
3181               }
3182
3183               const SCEV *StartVal = getSCEV(StartValueV);
3184               const SCEV *PHISCEV = getAddRecExpr(StartVal, Accum, L, Flags);
3185
3186               // Since the no-wrap flags are on the increment, they apply to the
3187               // post-incremented value as well.
3188               if (isLoopInvariant(Accum, L))
3189                 (void)getAddRecExpr(getAddExpr(StartVal, Accum),
3190                                     Accum, L, Flags);
3191
3192               // Okay, for the entire analysis of this edge we assumed the PHI
3193               // to be symbolic.  We now need to go back and purge all of the
3194               // entries for the scalars that use the symbolic expression.
3195               ForgetSymbolicName(PN, SymbolicName);
3196               ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
3197               return PHISCEV;
3198             }
3199           }
3200         } else if (const SCEVAddRecExpr *AddRec =
3201                      dyn_cast<SCEVAddRecExpr>(BEValue)) {
3202           // Otherwise, this could be a loop like this:
3203           //     i = 0;  for (j = 1; ..; ++j) { ....  i = j; }
3204           // In this case, j = {1,+,1}  and BEValue is j.
3205           // Because the other in-value of i (0) fits the evolution of BEValue
3206           // i really is an addrec evolution.
3207           if (AddRec->getLoop() == L && AddRec->isAffine()) {
3208             const SCEV *StartVal = getSCEV(StartValueV);
3209
3210             // If StartVal = j.start - j.stride, we can use StartVal as the
3211             // initial step of the addrec evolution.
3212             if (StartVal == getMinusSCEV(AddRec->getOperand(0),
3213                                          AddRec->getOperand(1))) {
3214               // FIXME: For constant StartVal, we should be able to infer
3215               // no-wrap flags.
3216               const SCEV *PHISCEV =
3217                 getAddRecExpr(StartVal, AddRec->getOperand(1), L,
3218                               SCEV::FlagAnyWrap);
3219
3220               // Okay, for the entire analysis of this edge we assumed the PHI
3221               // to be symbolic.  We now need to go back and purge all of the
3222               // entries for the scalars that use the symbolic expression.
3223               ForgetSymbolicName(PN, SymbolicName);
3224               ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
3225               return PHISCEV;
3226             }
3227           }
3228         }
3229       }
3230     }
3231
3232   // If the PHI has a single incoming value, follow that value, unless the
3233   // PHI's incoming blocks are in a different loop, in which case doing so
3234   // risks breaking LCSSA form. Instcombine would normally zap these, but
3235   // it doesn't have DominatorTree information, so it may miss cases.
3236   if (Value *V = SimplifyInstruction(PN, TD, TLI, DT))
3237     if (LI->replacementPreservesLCSSAForm(PN, V))
3238       return getSCEV(V);
3239
3240   // If it's not a loop phi, we can't handle it yet.
3241   return getUnknown(PN);
3242 }
3243
3244 /// createNodeForGEP - Expand GEP instructions into add and multiply
3245 /// operations. This allows them to be analyzed by regular SCEV code.
3246 ///
3247 const SCEV *ScalarEvolution::createNodeForGEP(GEPOperator *GEP) {
3248   Type *IntPtrTy = getEffectiveSCEVType(GEP->getType());
3249   Value *Base = GEP->getOperand(0);
3250   // Don't attempt to analyze GEPs over unsized objects.
3251   if (!Base->getType()->getPointerElementType()->isSized())
3252     return getUnknown(GEP);
3253
3254   // Don't blindly transfer the inbounds flag from the GEP instruction to the
3255   // Add expression, because the Instruction may be guarded by control flow
3256   // and the no-overflow bits may not be valid for the expression in any
3257   // context.
3258   SCEV::NoWrapFlags Wrap = GEP->isInBounds() ? SCEV::FlagNSW : SCEV::FlagAnyWrap;
3259
3260   const SCEV *TotalOffset = getConstant(IntPtrTy, 0);
3261   gep_type_iterator GTI = gep_type_begin(GEP);
3262   for (GetElementPtrInst::op_iterator I = llvm::next(GEP->op_begin()),
3263                                       E = GEP->op_end();
3264        I != E; ++I) {
3265     Value *Index = *I;
3266     // Compute the (potentially symbolic) offset in bytes for this index.
3267     if (StructType *STy = dyn_cast<StructType>(*GTI++)) {
3268       // For a struct, add the member offset.
3269       unsigned FieldNo = cast<ConstantInt>(Index)->getZExtValue();
3270       const SCEV *FieldOffset = getOffsetOfExpr(IntPtrTy, STy, FieldNo);
3271
3272       // Add the field offset to the running total offset.
3273       TotalOffset = getAddExpr(TotalOffset, FieldOffset);
3274     } else {
3275       // For an array, add the element offset, explicitly scaled.
3276       const SCEV *ElementSize = getSizeOfExpr(IntPtrTy, *GTI);
3277       const SCEV *IndexS = getSCEV(Index);
3278       // Getelementptr indices are signed.
3279       IndexS = getTruncateOrSignExtend(IndexS, IntPtrTy);
3280
3281       // Multiply the index by the element size to compute the element offset.
3282       const SCEV *LocalOffset = getMulExpr(IndexS, ElementSize, Wrap);
3283
3284       // Add the element offset to the running total offset.
3285       TotalOffset = getAddExpr(TotalOffset, LocalOffset);
3286     }
3287   }
3288
3289   // Get the SCEV for the GEP base.
3290   const SCEV *BaseS = getSCEV(Base);
3291
3292   // Add the total offset from all the GEP indices to the base.
3293   return getAddExpr(BaseS, TotalOffset, Wrap);
3294 }
3295
3296 /// GetMinTrailingZeros - Determine the minimum number of zero bits that S is
3297 /// guaranteed to end in (at every loop iteration).  It is, at the same time,
3298 /// the minimum number of times S is divisible by 2.  For example, given {4,+,8}
3299 /// it returns 2.  If S is guaranteed to be 0, it returns the bitwidth of S.
3300 uint32_t
3301 ScalarEvolution::GetMinTrailingZeros(const SCEV *S) {
3302   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
3303     return C->getValue()->getValue().countTrailingZeros();
3304
3305   if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(S))
3306     return std::min(GetMinTrailingZeros(T->getOperand()),
3307                     (uint32_t)getTypeSizeInBits(T->getType()));
3308
3309   if (const SCEVZeroExtendExpr *E = dyn_cast<SCEVZeroExtendExpr>(S)) {
3310     uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
3311     return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
3312              getTypeSizeInBits(E->getType()) : OpRes;
3313   }
3314
3315   if (const SCEVSignExtendExpr *E = dyn_cast<SCEVSignExtendExpr>(S)) {
3316     uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
3317     return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
3318              getTypeSizeInBits(E->getType()) : OpRes;
3319   }
3320
3321   if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(S)) {
3322     // The result is the min of all operands results.
3323     uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
3324     for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
3325       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
3326     return MinOpRes;
3327   }
3328
3329   if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(S)) {
3330     // The result is the sum of all operands results.
3331     uint32_t SumOpRes = GetMinTrailingZeros(M->getOperand(0));
3332     uint32_t BitWidth = getTypeSizeInBits(M->getType());
3333     for (unsigned i = 1, e = M->getNumOperands();
3334          SumOpRes != BitWidth && i != e; ++i)
3335       SumOpRes = std::min(SumOpRes + GetMinTrailingZeros(M->getOperand(i)),
3336                           BitWidth);
3337     return SumOpRes;
3338   }
3339
3340   if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(S)) {
3341     // The result is the min of all operands results.
3342     uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
3343     for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
3344       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
3345     return MinOpRes;
3346   }
3347
3348   if (const SCEVSMaxExpr *M = dyn_cast<SCEVSMaxExpr>(S)) {
3349     // The result is the min of all operands results.
3350     uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
3351     for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
3352       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
3353     return MinOpRes;
3354   }
3355
3356   if (const SCEVUMaxExpr *M = dyn_cast<SCEVUMaxExpr>(S)) {
3357     // The result is the min of all operands results.
3358     uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
3359     for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
3360       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
3361     return MinOpRes;
3362   }
3363
3364   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
3365     // For a SCEVUnknown, ask ValueTracking.
3366     unsigned BitWidth = getTypeSizeInBits(U->getType());
3367     APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
3368     ComputeMaskedBits(U->getValue(), Zeros, Ones);
3369     return Zeros.countTrailingOnes();
3370   }
3371
3372   // SCEVUDivExpr
3373   return 0;
3374 }
3375
3376 /// getUnsignedRange - Determine the unsigned range for a particular SCEV.
3377 ///
3378 ConstantRange
3379 ScalarEvolution::getUnsignedRange(const SCEV *S) {
3380   // See if we've computed this range already.
3381   DenseMap<const SCEV *, ConstantRange>::iterator I = UnsignedRanges.find(S);
3382   if (I != UnsignedRanges.end())
3383     return I->second;
3384
3385   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
3386     return setUnsignedRange(C, ConstantRange(C->getValue()->getValue()));
3387
3388   unsigned BitWidth = getTypeSizeInBits(S->getType());
3389   ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true);
3390
3391   // If the value has known zeros, the maximum unsigned value will have those
3392   // known zeros as well.
3393   uint32_t TZ = GetMinTrailingZeros(S);
3394   if (TZ != 0)
3395     ConservativeResult =
3396       ConstantRange(APInt::getMinValue(BitWidth),
3397                     APInt::getMaxValue(BitWidth).lshr(TZ).shl(TZ) + 1);
3398
3399   if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
3400     ConstantRange X = getUnsignedRange(Add->getOperand(0));
3401     for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i)
3402       X = X.add(getUnsignedRange(Add->getOperand(i)));
3403     return setUnsignedRange(Add, ConservativeResult.intersectWith(X));
3404   }
3405
3406   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
3407     ConstantRange X = getUnsignedRange(Mul->getOperand(0));
3408     for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i)
3409       X = X.multiply(getUnsignedRange(Mul->getOperand(i)));
3410     return setUnsignedRange(Mul, ConservativeResult.intersectWith(X));
3411   }
3412
3413   if (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(S)) {
3414     ConstantRange X = getUnsignedRange(SMax->getOperand(0));
3415     for (unsigned i = 1, e = SMax->getNumOperands(); i != e; ++i)
3416       X = X.smax(getUnsignedRange(SMax->getOperand(i)));
3417     return setUnsignedRange(SMax, ConservativeResult.intersectWith(X));
3418   }
3419
3420   if (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(S)) {
3421     ConstantRange X = getUnsignedRange(UMax->getOperand(0));
3422     for (unsigned i = 1, e = UMax->getNumOperands(); i != e; ++i)
3423       X = X.umax(getUnsignedRange(UMax->getOperand(i)));
3424     return setUnsignedRange(UMax, ConservativeResult.intersectWith(X));
3425   }
3426
3427   if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) {
3428     ConstantRange X = getUnsignedRange(UDiv->getLHS());
3429     ConstantRange Y = getUnsignedRange(UDiv->getRHS());
3430     return setUnsignedRange(UDiv, ConservativeResult.intersectWith(X.udiv(Y)));
3431   }
3432
3433   if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) {
3434     ConstantRange X = getUnsignedRange(ZExt->getOperand());
3435     return setUnsignedRange(ZExt,
3436       ConservativeResult.intersectWith(X.zeroExtend(BitWidth)));
3437   }
3438
3439   if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) {
3440     ConstantRange X = getUnsignedRange(SExt->getOperand());
3441     return setUnsignedRange(SExt,
3442       ConservativeResult.intersectWith(X.signExtend(BitWidth)));
3443   }
3444
3445   if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) {
3446     ConstantRange X = getUnsignedRange(Trunc->getOperand());
3447     return setUnsignedRange(Trunc,
3448       ConservativeResult.intersectWith(X.truncate(BitWidth)));
3449   }
3450
3451   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) {
3452     // If there's no unsigned wrap, the value will never be less than its
3453     // initial value.
3454     if (AddRec->getNoWrapFlags(SCEV::FlagNUW))
3455       if (const SCEVConstant *C = dyn_cast<SCEVConstant>(AddRec->getStart()))
3456         if (!C->getValue()->isZero())
3457           ConservativeResult =
3458             ConservativeResult.intersectWith(
3459               ConstantRange(C->getValue()->getValue(), APInt(BitWidth, 0)));
3460
3461     // TODO: non-affine addrec
3462     if (AddRec->isAffine()) {
3463       Type *Ty = AddRec->getType();
3464       const SCEV *MaxBECount = getMaxBackedgeTakenCount(AddRec->getLoop());
3465       if (!isa<SCEVCouldNotCompute>(MaxBECount) &&
3466           getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) {
3467         MaxBECount = getNoopOrZeroExtend(MaxBECount, Ty);
3468
3469         const SCEV *Start = AddRec->getStart();
3470         const SCEV *Step = AddRec->getStepRecurrence(*this);
3471
3472         ConstantRange StartRange = getUnsignedRange(Start);
3473         ConstantRange StepRange = getSignedRange(Step);
3474         ConstantRange MaxBECountRange = getUnsignedRange(MaxBECount);
3475         ConstantRange EndRange =
3476           StartRange.add(MaxBECountRange.multiply(StepRange));
3477
3478         // Check for overflow. This must be done with ConstantRange arithmetic
3479         // because we could be called from within the ScalarEvolution overflow
3480         // checking code.
3481         ConstantRange ExtStartRange = StartRange.zextOrTrunc(BitWidth*2+1);
3482         ConstantRange ExtStepRange = StepRange.sextOrTrunc(BitWidth*2+1);
3483         ConstantRange ExtMaxBECountRange =
3484           MaxBECountRange.zextOrTrunc(BitWidth*2+1);
3485         ConstantRange ExtEndRange = EndRange.zextOrTrunc(BitWidth*2+1);
3486         if (ExtStartRange.add(ExtMaxBECountRange.multiply(ExtStepRange)) !=
3487             ExtEndRange)
3488           return setUnsignedRange(AddRec, ConservativeResult);
3489
3490         APInt Min = APIntOps::umin(StartRange.getUnsignedMin(),
3491                                    EndRange.getUnsignedMin());
3492         APInt Max = APIntOps::umax(StartRange.getUnsignedMax(),
3493                                    EndRange.getUnsignedMax());
3494         if (Min.isMinValue() && Max.isMaxValue())
3495           return setUnsignedRange(AddRec, ConservativeResult);
3496         return setUnsignedRange(AddRec,
3497           ConservativeResult.intersectWith(ConstantRange(Min, Max+1)));
3498       }
3499     }
3500
3501     return setUnsignedRange(AddRec, ConservativeResult);
3502   }
3503
3504   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
3505     // For a SCEVUnknown, ask ValueTracking.
3506     APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
3507     ComputeMaskedBits(U->getValue(), Zeros, Ones, TD);
3508     if (Ones == ~Zeros + 1)
3509       return setUnsignedRange(U, ConservativeResult);
3510     return setUnsignedRange(U,
3511       ConservativeResult.intersectWith(ConstantRange(Ones, ~Zeros + 1)));
3512   }
3513
3514   return setUnsignedRange(S, ConservativeResult);
3515 }
3516
3517 /// getSignedRange - Determine the signed range for a particular SCEV.
3518 ///
3519 ConstantRange
3520 ScalarEvolution::getSignedRange(const SCEV *S) {
3521   // See if we've computed this range already.
3522   DenseMap<const SCEV *, ConstantRange>::iterator I = SignedRanges.find(S);
3523   if (I != SignedRanges.end())
3524     return I->second;
3525
3526   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
3527     return setSignedRange(C, ConstantRange(C->getValue()->getValue()));
3528
3529   unsigned BitWidth = getTypeSizeInBits(S->getType());
3530   ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true);
3531
3532   // If the value has known zeros, the maximum signed value will have those
3533   // known zeros as well.
3534   uint32_t TZ = GetMinTrailingZeros(S);
3535   if (TZ != 0)
3536     ConservativeResult =
3537       ConstantRange(APInt::getSignedMinValue(BitWidth),
3538                     APInt::getSignedMaxValue(BitWidth).ashr(TZ).shl(TZ) + 1);
3539
3540   if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
3541     ConstantRange X = getSignedRange(Add->getOperand(0));
3542     for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i)
3543       X = X.add(getSignedRange(Add->getOperand(i)));
3544     return setSignedRange(Add, ConservativeResult.intersectWith(X));
3545   }
3546
3547   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
3548     ConstantRange X = getSignedRange(Mul->getOperand(0));
3549     for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i)
3550       X = X.multiply(getSignedRange(Mul->getOperand(i)));
3551     return setSignedRange(Mul, ConservativeResult.intersectWith(X));
3552   }
3553
3554   if (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(S)) {
3555     ConstantRange X = getSignedRange(SMax->getOperand(0));
3556     for (unsigned i = 1, e = SMax->getNumOperands(); i != e; ++i)
3557       X = X.smax(getSignedRange(SMax->getOperand(i)));
3558     return setSignedRange(SMax, ConservativeResult.intersectWith(X));
3559   }
3560
3561   if (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(S)) {
3562     ConstantRange X = getSignedRange(UMax->getOperand(0));
3563     for (unsigned i = 1, e = UMax->getNumOperands(); i != e; ++i)
3564       X = X.umax(getSignedRange(UMax->getOperand(i)));
3565     return setSignedRange(UMax, ConservativeResult.intersectWith(X));
3566   }
3567
3568   if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) {
3569     ConstantRange X = getSignedRange(UDiv->getLHS());
3570     ConstantRange Y = getSignedRange(UDiv->getRHS());
3571     return setSignedRange(UDiv, ConservativeResult.intersectWith(X.udiv(Y)));
3572   }
3573
3574   if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) {
3575     ConstantRange X = getSignedRange(ZExt->getOperand());
3576     return setSignedRange(ZExt,
3577       ConservativeResult.intersectWith(X.zeroExtend(BitWidth)));
3578   }
3579
3580   if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) {
3581     ConstantRange X = getSignedRange(SExt->getOperand());
3582     return setSignedRange(SExt,
3583       ConservativeResult.intersectWith(X.signExtend(BitWidth)));
3584   }
3585
3586   if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) {
3587     ConstantRange X = getSignedRange(Trunc->getOperand());
3588     return setSignedRange(Trunc,
3589       ConservativeResult.intersectWith(X.truncate(BitWidth)));
3590   }
3591
3592   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) {
3593     // If there's no signed wrap, and all the operands have the same sign or
3594     // zero, the value won't ever change sign.
3595     if (AddRec->getNoWrapFlags(SCEV::FlagNSW)) {
3596       bool AllNonNeg = true;
3597       bool AllNonPos = true;
3598       for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
3599         if (!isKnownNonNegative(AddRec->getOperand(i))) AllNonNeg = false;
3600         if (!isKnownNonPositive(AddRec->getOperand(i))) AllNonPos = false;
3601       }
3602       if (AllNonNeg)
3603         ConservativeResult = ConservativeResult.intersectWith(
3604           ConstantRange(APInt(BitWidth, 0),
3605                         APInt::getSignedMinValue(BitWidth)));
3606       else if (AllNonPos)
3607         ConservativeResult = ConservativeResult.intersectWith(
3608           ConstantRange(APInt::getSignedMinValue(BitWidth),
3609                         APInt(BitWidth, 1)));
3610     }
3611
3612     // TODO: non-affine addrec
3613     if (AddRec->isAffine()) {
3614       Type *Ty = AddRec->getType();
3615       const SCEV *MaxBECount = getMaxBackedgeTakenCount(AddRec->getLoop());
3616       if (!isa<SCEVCouldNotCompute>(MaxBECount) &&
3617           getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) {
3618         MaxBECount = getNoopOrZeroExtend(MaxBECount, Ty);
3619
3620         const SCEV *Start = AddRec->getStart();
3621         const SCEV *Step = AddRec->getStepRecurrence(*this);
3622
3623         ConstantRange StartRange = getSignedRange(Start);
3624         ConstantRange StepRange = getSignedRange(Step);
3625         ConstantRange MaxBECountRange = getUnsignedRange(MaxBECount);
3626         ConstantRange EndRange =
3627           StartRange.add(MaxBECountRange.multiply(StepRange));
3628
3629         // Check for overflow. This must be done with ConstantRange arithmetic
3630         // because we could be called from within the ScalarEvolution overflow
3631         // checking code.
3632         ConstantRange ExtStartRange = StartRange.sextOrTrunc(BitWidth*2+1);
3633         ConstantRange ExtStepRange = StepRange.sextOrTrunc(BitWidth*2+1);
3634         ConstantRange ExtMaxBECountRange =
3635           MaxBECountRange.zextOrTrunc(BitWidth*2+1);
3636         ConstantRange ExtEndRange = EndRange.sextOrTrunc(BitWidth*2+1);
3637         if (ExtStartRange.add(ExtMaxBECountRange.multiply(ExtStepRange)) !=
3638             ExtEndRange)
3639           return setSignedRange(AddRec, ConservativeResult);
3640
3641         APInt Min = APIntOps::smin(StartRange.getSignedMin(),
3642                                    EndRange.getSignedMin());
3643         APInt Max = APIntOps::smax(StartRange.getSignedMax(),
3644                                    EndRange.getSignedMax());
3645         if (Min.isMinSignedValue() && Max.isMaxSignedValue())
3646           return setSignedRange(AddRec, ConservativeResult);
3647         return setSignedRange(AddRec,
3648           ConservativeResult.intersectWith(ConstantRange(Min, Max+1)));
3649       }
3650     }
3651
3652     return setSignedRange(AddRec, ConservativeResult);
3653   }
3654
3655   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
3656     // For a SCEVUnknown, ask ValueTracking.
3657     if (!U->getValue()->getType()->isIntegerTy() && !TD)
3658       return setSignedRange(U, ConservativeResult);
3659     unsigned NS = ComputeNumSignBits(U->getValue(), TD);
3660     if (NS <= 1)
3661       return setSignedRange(U, ConservativeResult);
3662     return setSignedRange(U, ConservativeResult.intersectWith(
3663       ConstantRange(APInt::getSignedMinValue(BitWidth).ashr(NS - 1),
3664                     APInt::getSignedMaxValue(BitWidth).ashr(NS - 1)+1)));
3665   }
3666
3667   return setSignedRange(S, ConservativeResult);
3668 }
3669
3670 /// createSCEV - We know that there is no SCEV for the specified value.
3671 /// Analyze the expression.
3672 ///
3673 const SCEV *ScalarEvolution::createSCEV(Value *V) {
3674   if (!isSCEVable(V->getType()))
3675     return getUnknown(V);
3676
3677   unsigned Opcode = Instruction::UserOp1;
3678   if (Instruction *I = dyn_cast<Instruction>(V)) {
3679     Opcode = I->getOpcode();
3680
3681     // Don't attempt to analyze instructions in blocks that aren't
3682     // reachable. Such instructions don't matter, and they aren't required
3683     // to obey basic rules for definitions dominating uses which this
3684     // analysis depends on.
3685     if (!DT->isReachableFromEntry(I->getParent()))
3686       return getUnknown(V);
3687   } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
3688     Opcode = CE->getOpcode();
3689   else if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
3690     return getConstant(CI);
3691   else if (isa<ConstantPointerNull>(V))
3692     return getConstant(V->getType(), 0);
3693   else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
3694     return GA->mayBeOverridden() ? getUnknown(V) : getSCEV(GA->getAliasee());
3695   else
3696     return getUnknown(V);
3697
3698   Operator *U = cast<Operator>(V);
3699   switch (Opcode) {
3700   case Instruction::Add: {
3701     // The simple thing to do would be to just call getSCEV on both operands
3702     // and call getAddExpr with the result. However if we're looking at a
3703     // bunch of things all added together, this can be quite inefficient,
3704     // because it leads to N-1 getAddExpr calls for N ultimate operands.
3705     // Instead, gather up all the operands and make a single getAddExpr call.
3706     // LLVM IR canonical form means we need only traverse the left operands.
3707     //
3708     // Don't apply this instruction's NSW or NUW flags to the new
3709     // expression. The instruction may be guarded by control flow that the
3710     // no-wrap behavior depends on. Non-control-equivalent instructions can be
3711     // mapped to the same SCEV expression, and it would be incorrect to transfer
3712     // NSW/NUW semantics to those operations.
3713     SmallVector<const SCEV *, 4> AddOps;
3714     AddOps.push_back(getSCEV(U->getOperand(1)));
3715     for (Value *Op = U->getOperand(0); ; Op = U->getOperand(0)) {
3716       unsigned Opcode = Op->getValueID() - Value::InstructionVal;
3717       if (Opcode != Instruction::Add && Opcode != Instruction::Sub)
3718         break;
3719       U = cast<Operator>(Op);
3720       const SCEV *Op1 = getSCEV(U->getOperand(1));
3721       if (Opcode == Instruction::Sub)
3722         AddOps.push_back(getNegativeSCEV(Op1));
3723       else
3724         AddOps.push_back(Op1);
3725     }
3726     AddOps.push_back(getSCEV(U->getOperand(0)));
3727     return getAddExpr(AddOps);
3728   }
3729   case Instruction::Mul: {
3730     // Don't transfer NSW/NUW for the same reason as AddExpr.
3731     SmallVector<const SCEV *, 4> MulOps;
3732     MulOps.push_back(getSCEV(U->getOperand(1)));
3733     for (Value *Op = U->getOperand(0);
3734          Op->getValueID() == Instruction::Mul + Value::InstructionVal;
3735          Op = U->getOperand(0)) {
3736       U = cast<Operator>(Op);
3737       MulOps.push_back(getSCEV(U->getOperand(1)));
3738     }
3739     MulOps.push_back(getSCEV(U->getOperand(0)));
3740     return getMulExpr(MulOps);
3741   }
3742   case Instruction::UDiv:
3743     return getUDivExpr(getSCEV(U->getOperand(0)),
3744                        getSCEV(U->getOperand(1)));
3745   case Instruction::Sub:
3746     return getMinusSCEV(getSCEV(U->getOperand(0)),
3747                         getSCEV(U->getOperand(1)));
3748   case Instruction::And:
3749     // For an expression like x&255 that merely masks off the high bits,
3750     // use zext(trunc(x)) as the SCEV expression.
3751     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
3752       if (CI->isNullValue())
3753         return getSCEV(U->getOperand(1));
3754       if (CI->isAllOnesValue())
3755         return getSCEV(U->getOperand(0));
3756       const APInt &A = CI->getValue();
3757
3758       // Instcombine's ShrinkDemandedConstant may strip bits out of
3759       // constants, obscuring what would otherwise be a low-bits mask.
3760       // Use ComputeMaskedBits to compute what ShrinkDemandedConstant
3761       // knew about to reconstruct a low-bits mask value.
3762       unsigned LZ = A.countLeadingZeros();
3763       unsigned TZ = A.countTrailingZeros();
3764       unsigned BitWidth = A.getBitWidth();
3765       APInt KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
3766       ComputeMaskedBits(U->getOperand(0), KnownZero, KnownOne, TD);
3767
3768       APInt EffectiveMask =
3769           APInt::getLowBitsSet(BitWidth, BitWidth - LZ - TZ).shl(TZ);
3770       if ((LZ != 0 || TZ != 0) && !((~A & ~KnownZero) & EffectiveMask)) {
3771         const SCEV *MulCount = getConstant(
3772             ConstantInt::get(getContext(), APInt::getOneBitSet(BitWidth, TZ)));
3773         return getMulExpr(
3774             getZeroExtendExpr(
3775                 getTruncateExpr(
3776                     getUDivExactExpr(getSCEV(U->getOperand(0)), MulCount),
3777                     IntegerType::get(getContext(), BitWidth - LZ - TZ)),
3778                 U->getType()),
3779             MulCount);
3780       }
3781     }
3782     break;
3783
3784   case Instruction::Or:
3785     // If the RHS of the Or is a constant, we may have something like:
3786     // X*4+1 which got turned into X*4|1.  Handle this as an Add so loop
3787     // optimizations will transparently handle this case.
3788     //
3789     // In order for this transformation to be safe, the LHS must be of the
3790     // form X*(2^n) and the Or constant must be less than 2^n.
3791     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
3792       const SCEV *LHS = getSCEV(U->getOperand(0));
3793       const APInt &CIVal = CI->getValue();
3794       if (GetMinTrailingZeros(LHS) >=
3795           (CIVal.getBitWidth() - CIVal.countLeadingZeros())) {
3796         // Build a plain add SCEV.
3797         const SCEV *S = getAddExpr(LHS, getSCEV(CI));
3798         // If the LHS of the add was an addrec and it has no-wrap flags,
3799         // transfer the no-wrap flags, since an or won't introduce a wrap.
3800         if (const SCEVAddRecExpr *NewAR = dyn_cast<SCEVAddRecExpr>(S)) {
3801           const SCEVAddRecExpr *OldAR = cast<SCEVAddRecExpr>(LHS);
3802           const_cast<SCEVAddRecExpr *>(NewAR)->setNoWrapFlags(
3803             OldAR->getNoWrapFlags());
3804         }
3805         return S;
3806       }
3807     }
3808     break;
3809   case Instruction::Xor:
3810     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
3811       // If the RHS of the xor is a signbit, then this is just an add.
3812       // Instcombine turns add of signbit into xor as a strength reduction step.
3813       if (CI->getValue().isSignBit())
3814         return getAddExpr(getSCEV(U->getOperand(0)),
3815                           getSCEV(U->getOperand(1)));
3816
3817       // If the RHS of xor is -1, then this is a not operation.
3818       if (CI->isAllOnesValue())
3819         return getNotSCEV(getSCEV(U->getOperand(0)));
3820
3821       // Model xor(and(x, C), C) as and(~x, C), if C is a low-bits mask.
3822       // This is a variant of the check for xor with -1, and it handles
3823       // the case where instcombine has trimmed non-demanded bits out
3824       // of an xor with -1.
3825       if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U->getOperand(0)))
3826         if (ConstantInt *LCI = dyn_cast<ConstantInt>(BO->getOperand(1)))
3827           if (BO->getOpcode() == Instruction::And &&
3828               LCI->getValue() == CI->getValue())
3829             if (const SCEVZeroExtendExpr *Z =
3830                   dyn_cast<SCEVZeroExtendExpr>(getSCEV(U->getOperand(0)))) {
3831               Type *UTy = U->getType();
3832               const SCEV *Z0 = Z->getOperand();
3833               Type *Z0Ty = Z0->getType();
3834               unsigned Z0TySize = getTypeSizeInBits(Z0Ty);
3835
3836               // If C is a low-bits mask, the zero extend is serving to
3837               // mask off the high bits. Complement the operand and
3838               // re-apply the zext.
3839               if (APIntOps::isMask(Z0TySize, CI->getValue()))
3840                 return getZeroExtendExpr(getNotSCEV(Z0), UTy);
3841
3842               // If C is a single bit, it may be in the sign-bit position
3843               // before the zero-extend. In this case, represent the xor
3844               // using an add, which is equivalent, and re-apply the zext.
3845               APInt Trunc = CI->getValue().trunc(Z0TySize);
3846               if (Trunc.zext(getTypeSizeInBits(UTy)) == CI->getValue() &&
3847                   Trunc.isSignBit())
3848                 return getZeroExtendExpr(getAddExpr(Z0, getConstant(Trunc)),
3849                                          UTy);
3850             }
3851     }
3852     break;
3853
3854   case Instruction::Shl:
3855     // Turn shift left of a constant amount into a multiply.
3856     if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
3857       uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
3858
3859       // If the shift count is not less than the bitwidth, the result of
3860       // the shift is undefined. Don't try to analyze it, because the
3861       // resolution chosen here may differ from the resolution chosen in
3862       // other parts of the compiler.
3863       if (SA->getValue().uge(BitWidth))
3864         break;
3865
3866       Constant *X = ConstantInt::get(getContext(),
3867         APInt::getOneBitSet(BitWidth, SA->getZExtValue()));
3868       return getMulExpr(getSCEV(U->getOperand(0)), getSCEV(X));
3869     }
3870     break;
3871
3872   case Instruction::LShr:
3873     // Turn logical shift right of a constant into a unsigned divide.
3874     if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
3875       uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
3876
3877       // If the shift count is not less than the bitwidth, the result of
3878       // the shift is undefined. Don't try to analyze it, because the
3879       // resolution chosen here may differ from the resolution chosen in
3880       // other parts of the compiler.
3881       if (SA->getValue().uge(BitWidth))
3882         break;
3883
3884       Constant *X = ConstantInt::get(getContext(),
3885         APInt::getOneBitSet(BitWidth, SA->getZExtValue()));
3886       return getUDivExpr(getSCEV(U->getOperand(0)), getSCEV(X));
3887     }
3888     break;
3889
3890   case Instruction::AShr:
3891     // For a two-shift sext-inreg, use sext(trunc(x)) as the SCEV expression.
3892     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1)))
3893       if (Operator *L = dyn_cast<Operator>(U->getOperand(0)))
3894         if (L->getOpcode() == Instruction::Shl &&
3895             L->getOperand(1) == U->getOperand(1)) {
3896           uint64_t BitWidth = getTypeSizeInBits(U->getType());
3897
3898           // If the shift count is not less than the bitwidth, the result of
3899           // the shift is undefined. Don't try to analyze it, because the
3900           // resolution chosen here may differ from the resolution chosen in
3901           // other parts of the compiler.
3902           if (CI->getValue().uge(BitWidth))
3903             break;
3904
3905           uint64_t Amt = BitWidth - CI->getZExtValue();
3906           if (Amt == BitWidth)
3907             return getSCEV(L->getOperand(0));       // shift by zero --> noop
3908           return
3909             getSignExtendExpr(getTruncateExpr(getSCEV(L->getOperand(0)),
3910                                               IntegerType::get(getContext(),
3911                                                                Amt)),
3912                               U->getType());
3913         }
3914     break;
3915
3916   case Instruction::Trunc:
3917     return getTruncateExpr(getSCEV(U->getOperand(0)), U->getType());
3918
3919   case Instruction::ZExt:
3920     return getZeroExtendExpr(getSCEV(U->getOperand(0)), U->getType());
3921
3922   case Instruction::SExt:
3923     return getSignExtendExpr(getSCEV(U->getOperand(0)), U->getType());
3924
3925   case Instruction::BitCast:
3926     // BitCasts are no-op casts so we just eliminate the cast.
3927     if (isSCEVable(U->getType()) && isSCEVable(U->getOperand(0)->getType()))
3928       return getSCEV(U->getOperand(0));
3929     break;
3930
3931   // It's tempting to handle inttoptr and ptrtoint as no-ops, however this can
3932   // lead to pointer expressions which cannot safely be expanded to GEPs,
3933   // because ScalarEvolution doesn't respect the GEP aliasing rules when
3934   // simplifying integer expressions.
3935
3936   case Instruction::GetElementPtr:
3937     return createNodeForGEP(cast<GEPOperator>(U));
3938
3939   case Instruction::PHI:
3940     return createNodeForPHI(cast<PHINode>(U));
3941
3942   case Instruction::Select:
3943     // This could be a smax or umax that was lowered earlier.
3944     // Try to recover it.
3945     if (ICmpInst *ICI = dyn_cast<ICmpInst>(U->getOperand(0))) {
3946       Value *LHS = ICI->getOperand(0);
3947       Value *RHS = ICI->getOperand(1);
3948       switch (ICI->getPredicate()) {
3949       case ICmpInst::ICMP_SLT:
3950       case ICmpInst::ICMP_SLE:
3951         std::swap(LHS, RHS);
3952         // fall through
3953       case ICmpInst::ICMP_SGT:
3954       case ICmpInst::ICMP_SGE:
3955         // a >s b ? a+x : b+x  ->  smax(a, b)+x
3956         // a >s b ? b+x : a+x  ->  smin(a, b)+x
3957         if (LHS->getType() == U->getType()) {
3958           const SCEV *LS = getSCEV(LHS);
3959           const SCEV *RS = getSCEV(RHS);
3960           const SCEV *LA = getSCEV(U->getOperand(1));
3961           const SCEV *RA = getSCEV(U->getOperand(2));
3962           const SCEV *LDiff = getMinusSCEV(LA, LS);
3963           const SCEV *RDiff = getMinusSCEV(RA, RS);
3964           if (LDiff == RDiff)
3965             return getAddExpr(getSMaxExpr(LS, RS), LDiff);
3966           LDiff = getMinusSCEV(LA, RS);
3967           RDiff = getMinusSCEV(RA, LS);
3968           if (LDiff == RDiff)
3969             return getAddExpr(getSMinExpr(LS, RS), LDiff);
3970         }
3971         break;
3972       case ICmpInst::ICMP_ULT:
3973       case ICmpInst::ICMP_ULE:
3974         std::swap(LHS, RHS);
3975         // fall through
3976       case ICmpInst::ICMP_UGT:
3977       case ICmpInst::ICMP_UGE:
3978         // a >u b ? a+x : b+x  ->  umax(a, b)+x
3979         // a >u b ? b+x : a+x  ->  umin(a, b)+x
3980         if (LHS->getType() == U->getType()) {
3981           const SCEV *LS = getSCEV(LHS);
3982           const SCEV *RS = getSCEV(RHS);
3983           const SCEV *LA = getSCEV(U->getOperand(1));
3984           const SCEV *RA = getSCEV(U->getOperand(2));
3985           const SCEV *LDiff = getMinusSCEV(LA, LS);
3986           const SCEV *RDiff = getMinusSCEV(RA, RS);
3987           if (LDiff == RDiff)
3988             return getAddExpr(getUMaxExpr(LS, RS), LDiff);
3989           LDiff = getMinusSCEV(LA, RS);
3990           RDiff = getMinusSCEV(RA, LS);
3991           if (LDiff == RDiff)
3992             return getAddExpr(getUMinExpr(LS, RS), LDiff);
3993         }
3994         break;
3995       case ICmpInst::ICMP_NE:
3996         // n != 0 ? n+x : 1+x  ->  umax(n, 1)+x
3997         if (LHS->getType() == U->getType() &&
3998             isa<ConstantInt>(RHS) &&
3999             cast<ConstantInt>(RHS)->isZero()) {
4000           const SCEV *One = getConstant(LHS->getType(), 1);
4001           const SCEV *LS = getSCEV(LHS);
4002           const SCEV *LA = getSCEV(U->getOperand(1));
4003           const SCEV *RA = getSCEV(U->getOperand(2));
4004           const SCEV *LDiff = getMinusSCEV(LA, LS);
4005           const SCEV *RDiff = getMinusSCEV(RA, One);
4006           if (LDiff == RDiff)
4007             return getAddExpr(getUMaxExpr(One, LS), LDiff);
4008         }
4009         break;
4010       case ICmpInst::ICMP_EQ:
4011         // n == 0 ? 1+x : n+x  ->  umax(n, 1)+x
4012         if (LHS->getType() == U->getType() &&
4013             isa<ConstantInt>(RHS) &&
4014             cast<ConstantInt>(RHS)->isZero()) {
4015           const SCEV *One = getConstant(LHS->getType(), 1);
4016           const SCEV *LS = getSCEV(LHS);
4017           const SCEV *LA = getSCEV(U->getOperand(1));
4018           const SCEV *RA = getSCEV(U->getOperand(2));
4019           const SCEV *LDiff = getMinusSCEV(LA, One);
4020           const SCEV *RDiff = getMinusSCEV(RA, LS);
4021           if (LDiff == RDiff)
4022             return getAddExpr(getUMaxExpr(One, LS), LDiff);
4023         }
4024         break;
4025       default:
4026         break;
4027       }
4028     }
4029
4030   default: // We cannot analyze this expression.
4031     break;
4032   }
4033
4034   return getUnknown(V);
4035 }
4036
4037
4038
4039 //===----------------------------------------------------------------------===//
4040 //                   Iteration Count Computation Code
4041 //
4042
4043 /// getSmallConstantTripCount - Returns the maximum trip count of this loop as a
4044 /// normal unsigned value. Returns 0 if the trip count is unknown or not
4045 /// constant. Will also return 0 if the maximum trip count is very large (>=
4046 /// 2^32).
4047 ///
4048 /// This "trip count" assumes that control exits via ExitingBlock. More
4049 /// precisely, it is the number of times that control may reach ExitingBlock
4050 /// before taking the branch. For loops with multiple exits, it may not be the
4051 /// number times that the loop header executes because the loop may exit
4052 /// prematurely via another branch.
4053 ///
4054 /// FIXME: We conservatively call getBackedgeTakenCount(L) instead of
4055 /// getExitCount(L, ExitingBlock) to compute a safe trip count considering all
4056 /// loop exits. getExitCount() may return an exact count for this branch
4057 /// assuming no-signed-wrap. The number of well-defined iterations may actually
4058 /// be higher than this trip count if this exit test is skipped and the loop
4059 /// exits via a different branch. Ideally, getExitCount() would know whether it
4060 /// depends on a NSW assumption, and we would only fall back to a conservative
4061 /// trip count in that case.
4062 unsigned ScalarEvolution::
4063 getSmallConstantTripCount(Loop *L, BasicBlock * /*ExitingBlock*/) {
4064   const SCEVConstant *ExitCount =
4065     dyn_cast<SCEVConstant>(getBackedgeTakenCount(L));
4066   if (!ExitCount)
4067     return 0;
4068
4069   ConstantInt *ExitConst = ExitCount->getValue();
4070
4071   // Guard against huge trip counts.
4072   if (ExitConst->getValue().getActiveBits() > 32)
4073     return 0;
4074
4075   // In case of integer overflow, this returns 0, which is correct.
4076   return ((unsigned)ExitConst->getZExtValue()) + 1;
4077 }
4078
4079 /// getSmallConstantTripMultiple - Returns the largest constant divisor of the
4080 /// trip count of this loop as a normal unsigned value, if possible. This
4081 /// means that the actual trip count is always a multiple of the returned
4082 /// value (don't forget the trip count could very well be zero as well!).
4083 ///
4084 /// Returns 1 if the trip count is unknown or not guaranteed to be the
4085 /// multiple of a constant (which is also the case if the trip count is simply
4086 /// constant, use getSmallConstantTripCount for that case), Will also return 1
4087 /// if the trip count is very large (>= 2^32).
4088 ///
4089 /// As explained in the comments for getSmallConstantTripCount, this assumes
4090 /// that control exits the loop via ExitingBlock.
4091 unsigned ScalarEvolution::
4092 getSmallConstantTripMultiple(Loop *L, BasicBlock * /*ExitingBlock*/) {
4093   const SCEV *ExitCount = getBackedgeTakenCount(L);
4094   if (ExitCount == getCouldNotCompute())
4095     return 1;
4096
4097   // Get the trip count from the BE count by adding 1.
4098   const SCEV *TCMul = getAddExpr(ExitCount,
4099                                  getConstant(ExitCount->getType(), 1));
4100   // FIXME: SCEV distributes multiplication as V1*C1 + V2*C1. We could attempt
4101   // to factor simple cases.
4102   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(TCMul))
4103     TCMul = Mul->getOperand(0);
4104
4105   const SCEVConstant *MulC = dyn_cast<SCEVConstant>(TCMul);
4106   if (!MulC)
4107     return 1;
4108
4109   ConstantInt *Result = MulC->getValue();
4110
4111   // Guard against huge trip counts (this requires checking
4112   // for zero to handle the case where the trip count == -1 and the
4113   // addition wraps).
4114   if (!Result || Result->getValue().getActiveBits() > 32 ||
4115       Result->getValue().getActiveBits() == 0)
4116     return 1;
4117
4118   return (unsigned)Result->getZExtValue();
4119 }
4120
4121 // getExitCount - Get the expression for the number of loop iterations for which
4122 // this loop is guaranteed not to exit via ExitingBlock. Otherwise return
4123 // SCEVCouldNotCompute.
4124 const SCEV *ScalarEvolution::getExitCount(Loop *L, BasicBlock *ExitingBlock) {
4125   return getBackedgeTakenInfo(L).getExact(ExitingBlock, this);
4126 }
4127
4128 /// getBackedgeTakenCount - If the specified loop has a predictable
4129 /// backedge-taken count, return it, otherwise return a SCEVCouldNotCompute
4130 /// object. The backedge-taken count is the number of times the loop header
4131 /// will be branched to from within the loop. This is one less than the
4132 /// trip count of the loop, since it doesn't count the first iteration,
4133 /// when the header is branched to from outside the loop.
4134 ///
4135 /// Note that it is not valid to call this method on a loop without a
4136 /// loop-invariant backedge-taken count (see
4137 /// hasLoopInvariantBackedgeTakenCount).
4138 ///
4139 const SCEV *ScalarEvolution::getBackedgeTakenCount(const Loop *L) {
4140   return getBackedgeTakenInfo(L).getExact(this);
4141 }
4142
4143 /// getMaxBackedgeTakenCount - Similar to getBackedgeTakenCount, except
4144 /// return the least SCEV value that is known never to be less than the
4145 /// actual backedge taken count.
4146 const SCEV *ScalarEvolution::getMaxBackedgeTakenCount(const Loop *L) {
4147   return getBackedgeTakenInfo(L).getMax(this);
4148 }
4149
4150 /// PushLoopPHIs - Push PHI nodes in the header of the given loop
4151 /// onto the given Worklist.
4152 static void
4153 PushLoopPHIs(const Loop *L, SmallVectorImpl<Instruction *> &Worklist) {
4154   BasicBlock *Header = L->getHeader();
4155
4156   // Push all Loop-header PHIs onto the Worklist stack.
4157   for (BasicBlock::iterator I = Header->begin();
4158        PHINode *PN = dyn_cast<PHINode>(I); ++I)
4159     Worklist.push_back(PN);
4160 }
4161
4162 const ScalarEvolution::BackedgeTakenInfo &
4163 ScalarEvolution::getBackedgeTakenInfo(const Loop *L) {
4164   // Initially insert an invalid entry for this loop. If the insertion
4165   // succeeds, proceed to actually compute a backedge-taken count and
4166   // update the value. The temporary CouldNotCompute value tells SCEV
4167   // code elsewhere that it shouldn't attempt to request a new
4168   // backedge-taken count, which could result in infinite recursion.
4169   std::pair<DenseMap<const Loop *, BackedgeTakenInfo>::iterator, bool> Pair =
4170     BackedgeTakenCounts.insert(std::make_pair(L, BackedgeTakenInfo()));
4171   if (!Pair.second)
4172     return Pair.first->second;
4173
4174   // ComputeBackedgeTakenCount may allocate memory for its result. Inserting it
4175   // into the BackedgeTakenCounts map transfers ownership. Otherwise, the result
4176   // must be cleared in this scope.
4177   BackedgeTakenInfo Result = ComputeBackedgeTakenCount(L);
4178
4179   if (Result.getExact(this) != getCouldNotCompute()) {
4180     assert(isLoopInvariant(Result.getExact(this), L) &&
4181            isLoopInvariant(Result.getMax(this), L) &&
4182            "Computed backedge-taken count isn't loop invariant for loop!");
4183     ++NumTripCountsComputed;
4184   }
4185   else if (Result.getMax(this) == getCouldNotCompute() &&
4186            isa<PHINode>(L->getHeader()->begin())) {
4187     // Only count loops that have phi nodes as not being computable.
4188     ++NumTripCountsNotComputed;
4189   }
4190
4191   // Now that we know more about the trip count for this loop, forget any
4192   // existing SCEV values for PHI nodes in this loop since they are only
4193   // conservative estimates made without the benefit of trip count
4194   // information. This is similar to the code in forgetLoop, except that
4195   // it handles SCEVUnknown PHI nodes specially.
4196   if (Result.hasAnyInfo()) {
4197     SmallVector<Instruction *, 16> Worklist;
4198     PushLoopPHIs(L, Worklist);
4199
4200     SmallPtrSet<Instruction *, 8> Visited;
4201     while (!Worklist.empty()) {
4202       Instruction *I = Worklist.pop_back_val();
4203       if (!Visited.insert(I)) continue;
4204
4205       ValueExprMapType::iterator It =
4206         ValueExprMap.find_as(static_cast<Value *>(I));
4207       if (It != ValueExprMap.end()) {
4208         const SCEV *Old = It->second;
4209
4210         // SCEVUnknown for a PHI either means that it has an unrecognized
4211         // structure, or it's a PHI that's in the progress of being computed
4212         // by createNodeForPHI.  In the former case, additional loop trip
4213         // count information isn't going to change anything. In the later
4214         // case, createNodeForPHI will perform the necessary updates on its
4215         // own when it gets to that point.
4216         if (!isa<PHINode>(I) || !isa<SCEVUnknown>(Old)) {
4217           forgetMemoizedResults(Old);
4218           ValueExprMap.erase(It);
4219         }
4220         if (PHINode *PN = dyn_cast<PHINode>(I))
4221           ConstantEvolutionLoopExitValue.erase(PN);
4222       }
4223
4224       PushDefUseChildren(I, Worklist);
4225     }
4226   }
4227
4228   // Re-lookup the insert position, since the call to
4229   // ComputeBackedgeTakenCount above could result in a
4230   // recusive call to getBackedgeTakenInfo (on a different
4231   // loop), which would invalidate the iterator computed
4232   // earlier.
4233   return BackedgeTakenCounts.find(L)->second = Result;
4234 }
4235
4236 /// forgetLoop - This method should be called by the client when it has
4237 /// changed a loop in a way that may effect ScalarEvolution's ability to
4238 /// compute a trip count, or if the loop is deleted.
4239 void ScalarEvolution::forgetLoop(const Loop *L) {
4240   // Drop any stored trip count value.
4241   DenseMap<const Loop*, BackedgeTakenInfo>::iterator BTCPos =
4242     BackedgeTakenCounts.find(L);
4243   if (BTCPos != BackedgeTakenCounts.end()) {
4244     BTCPos->second.clear();
4245     BackedgeTakenCounts.erase(BTCPos);
4246   }
4247
4248   // Drop information about expressions based on loop-header PHIs.
4249   SmallVector<Instruction *, 16> Worklist;
4250   PushLoopPHIs(L, Worklist);
4251
4252   SmallPtrSet<Instruction *, 8> Visited;
4253   while (!Worklist.empty()) {
4254     Instruction *I = Worklist.pop_back_val();
4255     if (!Visited.insert(I)) continue;
4256
4257     ValueExprMapType::iterator It =
4258       ValueExprMap.find_as(static_cast<Value *>(I));
4259     if (It != ValueExprMap.end()) {
4260       forgetMemoizedResults(It->second);
4261       ValueExprMap.erase(It);
4262       if (PHINode *PN = dyn_cast<PHINode>(I))
4263         ConstantEvolutionLoopExitValue.erase(PN);
4264     }
4265
4266     PushDefUseChildren(I, Worklist);
4267   }
4268
4269   // Forget all contained loops too, to avoid dangling entries in the
4270   // ValuesAtScopes map.
4271   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
4272     forgetLoop(*I);
4273 }
4274
4275 /// forgetValue - This method should be called by the client when it has
4276 /// changed a value in a way that may effect its value, or which may
4277 /// disconnect it from a def-use chain linking it to a loop.
4278 void ScalarEvolution::forgetValue(Value *V) {
4279   Instruction *I = dyn_cast<Instruction>(V);
4280   if (!I) return;
4281
4282   // Drop information about expressions based on loop-header PHIs.
4283   SmallVector<Instruction *, 16> Worklist;
4284   Worklist.push_back(I);
4285
4286   SmallPtrSet<Instruction *, 8> Visited;
4287   while (!Worklist.empty()) {
4288     I = Worklist.pop_back_val();
4289     if (!Visited.insert(I)) continue;
4290
4291     ValueExprMapType::iterator It =
4292       ValueExprMap.find_as(static_cast<Value *>(I));
4293     if (It != ValueExprMap.end()) {
4294       forgetMemoizedResults(It->second);
4295       ValueExprMap.erase(It);
4296       if (PHINode *PN = dyn_cast<PHINode>(I))
4297         ConstantEvolutionLoopExitValue.erase(PN);
4298     }
4299
4300     PushDefUseChildren(I, Worklist);
4301   }
4302 }
4303
4304 /// getExact - Get the exact loop backedge taken count considering all loop
4305 /// exits. A computable result can only be return for loops with a single exit.
4306 /// Returning the minimum taken count among all exits is incorrect because one
4307 /// of the loop's exit limit's may have been skipped. HowFarToZero assumes that
4308 /// the limit of each loop test is never skipped. This is a valid assumption as
4309 /// long as the loop exits via that test. For precise results, it is the
4310 /// caller's responsibility to specify the relevant loop exit using
4311 /// getExact(ExitingBlock, SE).
4312 const SCEV *
4313 ScalarEvolution::BackedgeTakenInfo::getExact(ScalarEvolution *SE) const {
4314   // If any exits were not computable, the loop is not computable.
4315   if (!ExitNotTaken.isCompleteList()) return SE->getCouldNotCompute();
4316
4317   // We need exactly one computable exit.
4318   if (!ExitNotTaken.ExitingBlock) return SE->getCouldNotCompute();
4319   assert(ExitNotTaken.ExactNotTaken && "uninitialized not-taken info");
4320
4321   const SCEV *BECount = 0;
4322   for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
4323        ENT != 0; ENT = ENT->getNextExit()) {
4324
4325     assert(ENT->ExactNotTaken != SE->getCouldNotCompute() && "bad exit SCEV");
4326
4327     if (!BECount)
4328       BECount = ENT->ExactNotTaken;
4329     else if (BECount != ENT->ExactNotTaken)
4330       return SE->getCouldNotCompute();
4331   }
4332   assert(BECount && "Invalid not taken count for loop exit");
4333   return BECount;
4334 }
4335
4336 /// getExact - Get the exact not taken count for this loop exit.
4337 const SCEV *
4338 ScalarEvolution::BackedgeTakenInfo::getExact(BasicBlock *ExitingBlock,
4339                                              ScalarEvolution *SE) const {
4340   for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
4341        ENT != 0; ENT = ENT->getNextExit()) {
4342
4343     if (ENT->ExitingBlock == ExitingBlock)
4344       return ENT->ExactNotTaken;
4345   }
4346   return SE->getCouldNotCompute();
4347 }
4348
4349 /// getMax - Get the max backedge taken count for the loop.
4350 const SCEV *
4351 ScalarEvolution::BackedgeTakenInfo::getMax(ScalarEvolution *SE) const {
4352   return Max ? Max : SE->getCouldNotCompute();
4353 }
4354
4355 bool ScalarEvolution::BackedgeTakenInfo::hasOperand(const SCEV *S,
4356                                                     ScalarEvolution *SE) const {
4357   if (Max && Max != SE->getCouldNotCompute() && SE->hasOperand(Max, S))
4358     return true;
4359
4360   if (!ExitNotTaken.ExitingBlock)
4361     return false;
4362
4363   for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
4364        ENT != 0; ENT = ENT->getNextExit()) {
4365
4366     if (ENT->ExactNotTaken != SE->getCouldNotCompute()
4367         && SE->hasOperand(ENT->ExactNotTaken, S)) {
4368       return true;
4369     }
4370   }
4371   return false;
4372 }
4373
4374 /// Allocate memory for BackedgeTakenInfo and copy the not-taken count of each
4375 /// computable exit into a persistent ExitNotTakenInfo array.
4376 ScalarEvolution::BackedgeTakenInfo::BackedgeTakenInfo(
4377   SmallVectorImpl< std::pair<BasicBlock *, const SCEV *> > &ExitCounts,
4378   bool Complete, const SCEV *MaxCount) : Max(MaxCount) {
4379
4380   if (!Complete)
4381     ExitNotTaken.setIncomplete();
4382
4383   unsigned NumExits = ExitCounts.size();
4384   if (NumExits == 0) return;
4385
4386   ExitNotTaken.ExitingBlock = ExitCounts[0].first;
4387   ExitNotTaken.ExactNotTaken = ExitCounts[0].second;
4388   if (NumExits == 1) return;
4389
4390   // Handle the rare case of multiple computable exits.
4391   ExitNotTakenInfo *ENT = new ExitNotTakenInfo[NumExits-1];
4392
4393   ExitNotTakenInfo *PrevENT = &ExitNotTaken;
4394   for (unsigned i = 1; i < NumExits; ++i, PrevENT = ENT, ++ENT) {
4395     PrevENT->setNextExit(ENT);
4396     ENT->ExitingBlock = ExitCounts[i].first;
4397     ENT->ExactNotTaken = ExitCounts[i].second;
4398   }
4399 }
4400
4401 /// clear - Invalidate this result and free the ExitNotTakenInfo array.
4402 void ScalarEvolution::BackedgeTakenInfo::clear() {
4403   ExitNotTaken.ExitingBlock = 0;
4404   ExitNotTaken.ExactNotTaken = 0;
4405   delete[] ExitNotTaken.getNextExit();
4406 }
4407
4408 /// ComputeBackedgeTakenCount - Compute the number of times the backedge
4409 /// of the specified loop will execute.
4410 ScalarEvolution::BackedgeTakenInfo
4411 ScalarEvolution::ComputeBackedgeTakenCount(const Loop *L) {
4412   SmallVector<BasicBlock *, 8> ExitingBlocks;
4413   L->getExitingBlocks(ExitingBlocks);
4414
4415   // Examine all exits and pick the most conservative values.
4416   const SCEV *MaxBECount = getCouldNotCompute();
4417   bool CouldComputeBECount = true;
4418   BasicBlock *Latch = L->getLoopLatch(); // may be NULL.
4419   const SCEV *LatchMaxCount = 0;
4420   SmallVector<std::pair<BasicBlock *, const SCEV *>, 4> ExitCounts;
4421   for (unsigned i = 0, e = ExitingBlocks.size(); i != e; ++i) {
4422     ExitLimit EL = ComputeExitLimit(L, ExitingBlocks[i]);
4423     if (EL.Exact == getCouldNotCompute())
4424       // We couldn't compute an exact value for this exit, so
4425       // we won't be able to compute an exact value for the loop.
4426       CouldComputeBECount = false;
4427     else
4428       ExitCounts.push_back(std::make_pair(ExitingBlocks[i], EL.Exact));
4429
4430     if (MaxBECount == getCouldNotCompute())
4431       MaxBECount = EL.Max;
4432     else if (EL.Max != getCouldNotCompute()) {
4433       // We cannot take the "min" MaxBECount, because non-unit stride loops may
4434       // skip some loop tests. Taking the max over the exits is sufficiently
4435       // conservative.  TODO: We could do better taking into consideration
4436       // non-latch exits that dominate the latch.
4437       if (EL.MustExit && ExitingBlocks[i] == Latch)
4438         LatchMaxCount = EL.Max;
4439       else
4440         MaxBECount = getUMaxFromMismatchedTypes(MaxBECount, EL.Max);
4441     }
4442   }
4443   // Be more precise in the easy case of a loop latch that must exit.
4444   if (LatchMaxCount) {
4445     MaxBECount = getUMinFromMismatchedTypes(MaxBECount, LatchMaxCount);
4446   }
4447   return BackedgeTakenInfo(ExitCounts, CouldComputeBECount, MaxBECount);
4448 }
4449
4450 /// ComputeExitLimit - Compute the number of times the backedge of the specified
4451 /// loop will execute if it exits via the specified block.
4452 ScalarEvolution::ExitLimit
4453 ScalarEvolution::ComputeExitLimit(const Loop *L, BasicBlock *ExitingBlock) {
4454
4455   // Okay, we've chosen an exiting block.  See what condition causes us to
4456   // exit at this block.
4457   //
4458   // FIXME: we should be able to handle switch instructions (with a single exit)
4459   BranchInst *ExitBr = dyn_cast<BranchInst>(ExitingBlock->getTerminator());
4460   if (ExitBr == 0) return getCouldNotCompute();
4461   assert(ExitBr->isConditional() && "If unconditional, it can't be in loop!");
4462
4463   // At this point, we know we have a conditional branch that determines whether
4464   // the loop is exited.  However, we don't know if the branch is executed each
4465   // time through the loop.  If not, then the execution count of the branch will
4466   // not be equal to the trip count of the loop.
4467   //
4468   // Currently we check for this by checking to see if the Exit branch goes to
4469   // the loop header.  If so, we know it will always execute the same number of
4470   // times as the loop.  We also handle the case where the exit block *is* the
4471   // loop header.  This is common for un-rotated loops.
4472   //
4473   // If both of those tests fail, walk up the unique predecessor chain to the
4474   // header, stopping if there is an edge that doesn't exit the loop. If the
4475   // header is reached, the execution count of the branch will be equal to the
4476   // trip count of the loop.
4477   //
4478   //  More extensive analysis could be done to handle more cases here.
4479   //
4480   if (ExitBr->getSuccessor(0) != L->getHeader() &&
4481       ExitBr->getSuccessor(1) != L->getHeader() &&
4482       ExitBr->getParent() != L->getHeader()) {
4483     // The simple checks failed, try climbing the unique predecessor chain
4484     // up to the header.
4485     bool Ok = false;
4486     for (BasicBlock *BB = ExitBr->getParent(); BB; ) {
4487       BasicBlock *Pred = BB->getUniquePredecessor();
4488       if (!Pred)
4489         return getCouldNotCompute();
4490       TerminatorInst *PredTerm = Pred->getTerminator();
4491       for (unsigned i = 0, e = PredTerm->getNumSuccessors(); i != e; ++i) {
4492         BasicBlock *PredSucc = PredTerm->getSuccessor(i);
4493         if (PredSucc == BB)
4494           continue;
4495         // If the predecessor has a successor that isn't BB and isn't
4496         // outside the loop, assume the worst.
4497         if (L->contains(PredSucc))
4498           return getCouldNotCompute();
4499       }
4500       if (Pred == L->getHeader()) {
4501         Ok = true;
4502         break;
4503       }
4504       BB = Pred;
4505     }
4506     if (!Ok)
4507       return getCouldNotCompute();
4508   }
4509
4510   // Proceed to the next level to examine the exit condition expression.
4511   return ComputeExitLimitFromCond(L, ExitBr->getCondition(),
4512                                   ExitBr->getSuccessor(0),
4513                                   ExitBr->getSuccessor(1),
4514                                   /*IsSubExpr=*/false);
4515 }
4516
4517 /// ComputeExitLimitFromCond - Compute the number of times the
4518 /// backedge of the specified loop will execute if its exit condition
4519 /// were a conditional branch of ExitCond, TBB, and FBB.
4520 ///
4521 /// @param IsSubExpr is true if ExitCond does not directly control the exit
4522 /// branch. In this case, we cannot assume that the loop only exits when the
4523 /// condition is true and cannot infer that failing to meet the condition prior
4524 /// to integer wraparound results in undefined behavior.
4525 ScalarEvolution::ExitLimit
4526 ScalarEvolution::ComputeExitLimitFromCond(const Loop *L,
4527                                           Value *ExitCond,
4528                                           BasicBlock *TBB,
4529                                           BasicBlock *FBB,
4530                                           bool IsSubExpr) {
4531   // Check if the controlling expression for this loop is an And or Or.
4532   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(ExitCond)) {
4533     if (BO->getOpcode() == Instruction::And) {
4534       // Recurse on the operands of the and.
4535       bool EitherMayExit = L->contains(TBB);
4536       ExitLimit EL0 = ComputeExitLimitFromCond(L, BO->getOperand(0), TBB, FBB,
4537                                                IsSubExpr || EitherMayExit);
4538       ExitLimit EL1 = ComputeExitLimitFromCond(L, BO->getOperand(1), TBB, FBB,
4539                                                IsSubExpr || EitherMayExit);
4540       const SCEV *BECount = getCouldNotCompute();
4541       const SCEV *MaxBECount = getCouldNotCompute();
4542       bool MustExit = false;
4543       if (EitherMayExit) {
4544         // Both conditions must be true for the loop to continue executing.
4545         // Choose the less conservative count.
4546         if (EL0.Exact == getCouldNotCompute() ||
4547             EL1.Exact == getCouldNotCompute())
4548           BECount = getCouldNotCompute();
4549         else
4550           BECount = getUMinFromMismatchedTypes(EL0.Exact, EL1.Exact);
4551         if (EL0.Max == getCouldNotCompute())
4552           MaxBECount = EL1.Max;
4553         else if (EL1.Max == getCouldNotCompute())
4554           MaxBECount = EL0.Max;
4555         else
4556           MaxBECount = getUMinFromMismatchedTypes(EL0.Max, EL1.Max);
4557         MustExit = EL0.MustExit || EL1.MustExit;
4558       } else {
4559         // Both conditions must be true at the same time for the loop to exit.
4560         // For now, be conservative.
4561         assert(L->contains(FBB) && "Loop block has no successor in loop!");
4562         if (EL0.Max == EL1.Max)
4563           MaxBECount = EL0.Max;
4564         if (EL0.Exact == EL1.Exact)
4565           BECount = EL0.Exact;
4566         MustExit = EL0.MustExit && EL1.MustExit;
4567       }
4568
4569       return ExitLimit(BECount, MaxBECount, MustExit);
4570     }
4571     if (BO->getOpcode() == Instruction::Or) {
4572       // Recurse on the operands of the or.
4573       bool EitherMayExit = L->contains(FBB);
4574       ExitLimit EL0 = ComputeExitLimitFromCond(L, BO->getOperand(0), TBB, FBB,
4575                                                IsSubExpr || EitherMayExit);
4576       ExitLimit EL1 = ComputeExitLimitFromCond(L, BO->getOperand(1), TBB, FBB,
4577                                                IsSubExpr || EitherMayExit);
4578       const SCEV *BECount = getCouldNotCompute();
4579       const SCEV *MaxBECount = getCouldNotCompute();
4580       bool MustExit = false;
4581       if (EitherMayExit) {
4582         // Both conditions must be false for the loop to continue executing.
4583         // Choose the less conservative count.
4584         if (EL0.Exact == getCouldNotCompute() ||
4585             EL1.Exact == getCouldNotCompute())
4586           BECount = getCouldNotCompute();
4587         else
4588           BECount = getUMinFromMismatchedTypes(EL0.Exact, EL1.Exact);
4589         if (EL0.Max == getCouldNotCompute())
4590           MaxBECount = EL1.Max;
4591         else if (EL1.Max == getCouldNotCompute())
4592           MaxBECount = EL0.Max;
4593         else
4594           MaxBECount = getUMinFromMismatchedTypes(EL0.Max, EL1.Max);
4595         MustExit = EL0.MustExit || EL1.MustExit;
4596       } else {
4597         // Both conditions must be false at the same time for the loop to exit.
4598         // For now, be conservative.
4599         assert(L->contains(TBB) && "Loop block has no successor in loop!");
4600         if (EL0.Max == EL1.Max)
4601           MaxBECount = EL0.Max;
4602         if (EL0.Exact == EL1.Exact)
4603           BECount = EL0.Exact;
4604         MustExit = EL0.MustExit && EL1.MustExit;
4605       }
4606
4607       return ExitLimit(BECount, MaxBECount, MustExit);
4608     }
4609   }
4610
4611   // With an icmp, it may be feasible to compute an exact backedge-taken count.
4612   // Proceed to the next level to examine the icmp.
4613   if (ICmpInst *ExitCondICmp = dyn_cast<ICmpInst>(ExitCond))
4614     return ComputeExitLimitFromICmp(L, ExitCondICmp, TBB, FBB, IsSubExpr);
4615
4616   // Check for a constant condition. These are normally stripped out by
4617   // SimplifyCFG, but ScalarEvolution may be used by a pass which wishes to
4618   // preserve the CFG and is temporarily leaving constant conditions
4619   // in place.
4620   if (ConstantInt *CI = dyn_cast<ConstantInt>(ExitCond)) {
4621     if (L->contains(FBB) == !CI->getZExtValue())
4622       // The backedge is always taken.
4623       return getCouldNotCompute();
4624     else
4625       // The backedge is never taken.
4626       return getConstant(CI->getType(), 0);
4627   }
4628
4629   // If it's not an integer or pointer comparison then compute it the hard way.
4630   return ComputeExitCountExhaustively(L, ExitCond, !L->contains(TBB));
4631 }
4632
4633 /// ComputeExitLimitFromICmp - Compute the number of times the
4634 /// backedge of the specified loop will execute if its exit condition
4635 /// were a conditional branch of the ICmpInst ExitCond, TBB, and FBB.
4636 ScalarEvolution::ExitLimit
4637 ScalarEvolution::ComputeExitLimitFromICmp(const Loop *L,
4638                                           ICmpInst *ExitCond,
4639                                           BasicBlock *TBB,
4640                                           BasicBlock *FBB,
4641                                           bool IsSubExpr) {
4642
4643   // If the condition was exit on true, convert the condition to exit on false
4644   ICmpInst::Predicate Cond;
4645   if (!L->contains(FBB))
4646     Cond = ExitCond->getPredicate();
4647   else
4648     Cond = ExitCond->getInversePredicate();
4649
4650   // Handle common loops like: for (X = "string"; *X; ++X)
4651   if (LoadInst *LI = dyn_cast<LoadInst>(ExitCond->getOperand(0)))
4652     if (Constant *RHS = dyn_cast<Constant>(ExitCond->getOperand(1))) {
4653       ExitLimit ItCnt =
4654         ComputeLoadConstantCompareExitLimit(LI, RHS, L, Cond);
4655       if (ItCnt.hasAnyInfo())
4656         return ItCnt;
4657     }
4658
4659   const SCEV *LHS = getSCEV(ExitCond->getOperand(0));
4660   const SCEV *RHS = getSCEV(ExitCond->getOperand(1));
4661
4662   // Try to evaluate any dependencies out of the loop.
4663   LHS = getSCEVAtScope(LHS, L);
4664   RHS = getSCEVAtScope(RHS, L);
4665
4666   // At this point, we would like to compute how many iterations of the
4667   // loop the predicate will return true for these inputs.
4668   if (isLoopInvariant(LHS, L) && !isLoopInvariant(RHS, L)) {
4669     // If there is a loop-invariant, force it into the RHS.
4670     std::swap(LHS, RHS);
4671     Cond = ICmpInst::getSwappedPredicate(Cond);
4672   }
4673
4674   // Simplify the operands before analyzing them.
4675   (void)SimplifyICmpOperands(Cond, LHS, RHS);
4676
4677   // If we have a comparison of a chrec against a constant, try to use value
4678   // ranges to answer this query.
4679   if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS))
4680     if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS))
4681       if (AddRec->getLoop() == L) {
4682         // Form the constant range.
4683         ConstantRange CompRange(
4684             ICmpInst::makeConstantRange(Cond, RHSC->getValue()->getValue()));
4685
4686         const SCEV *Ret = AddRec->getNumIterationsInRange(CompRange, *this);
4687         if (!isa<SCEVCouldNotCompute>(Ret)) return Ret;
4688       }
4689
4690   switch (Cond) {
4691   case ICmpInst::ICMP_NE: {                     // while (X != Y)
4692     // Convert to: while (X-Y != 0)
4693     ExitLimit EL = HowFarToZero(getMinusSCEV(LHS, RHS), L, IsSubExpr);
4694     if (EL.hasAnyInfo()) return EL;
4695     break;
4696   }
4697   case ICmpInst::ICMP_EQ: {                     // while (X == Y)
4698     // Convert to: while (X-Y == 0)
4699     ExitLimit EL = HowFarToNonZero(getMinusSCEV(LHS, RHS), L);
4700     if (EL.hasAnyInfo()) return EL;
4701     break;
4702   }
4703   case ICmpInst::ICMP_SLT:
4704   case ICmpInst::ICMP_ULT: {                    // while (X < Y)
4705     bool IsSigned = Cond == ICmpInst::ICMP_SLT;
4706     ExitLimit EL = HowManyLessThans(LHS, RHS, L, IsSigned, IsSubExpr);
4707     if (EL.hasAnyInfo()) return EL;
4708     break;
4709   }
4710   case ICmpInst::ICMP_SGT:
4711   case ICmpInst::ICMP_UGT: {                    // while (X > Y)
4712     bool IsSigned = Cond == ICmpInst::ICMP_SGT;
4713     ExitLimit EL = HowManyGreaterThans(LHS, RHS, L, IsSigned, IsSubExpr);
4714     if (EL.hasAnyInfo()) return EL;
4715     break;
4716   }
4717   default:
4718 #if 0
4719     dbgs() << "ComputeBackedgeTakenCount ";
4720     if (ExitCond->getOperand(0)->getType()->isUnsigned())
4721       dbgs() << "[unsigned] ";
4722     dbgs() << *LHS << "   "
4723          << Instruction::getOpcodeName(Instruction::ICmp)
4724          << "   " << *RHS << "\n";
4725 #endif
4726     break;
4727   }
4728   return ComputeExitCountExhaustively(L, ExitCond, !L->contains(TBB));
4729 }
4730
4731 static ConstantInt *
4732 EvaluateConstantChrecAtConstant(const SCEVAddRecExpr *AddRec, ConstantInt *C,
4733                                 ScalarEvolution &SE) {
4734   const SCEV *InVal = SE.getConstant(C);
4735   const SCEV *Val = AddRec->evaluateAtIteration(InVal, SE);
4736   assert(isa<SCEVConstant>(Val) &&
4737          "Evaluation of SCEV at constant didn't fold correctly?");
4738   return cast<SCEVConstant>(Val)->getValue();
4739 }
4740
4741 /// ComputeLoadConstantCompareExitLimit - Given an exit condition of
4742 /// 'icmp op load X, cst', try to see if we can compute the backedge
4743 /// execution count.
4744 ScalarEvolution::ExitLimit
4745 ScalarEvolution::ComputeLoadConstantCompareExitLimit(
4746   LoadInst *LI,
4747   Constant *RHS,
4748   const Loop *L,
4749   ICmpInst::Predicate predicate) {
4750
4751   if (LI->isVolatile()) return getCouldNotCompute();
4752
4753   // Check to see if the loaded pointer is a getelementptr of a global.
4754   // TODO: Use SCEV instead of manually grubbing with GEPs.
4755   GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0));
4756   if (!GEP) return getCouldNotCompute();
4757
4758   // Make sure that it is really a constant global we are gepping, with an
4759   // initializer, and make sure the first IDX is really 0.
4760   GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0));
4761   if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() ||
4762       GEP->getNumOperands() < 3 || !isa<Constant>(GEP->getOperand(1)) ||
4763       !cast<Constant>(GEP->getOperand(1))->isNullValue())
4764     return getCouldNotCompute();
4765
4766   // Okay, we allow one non-constant index into the GEP instruction.
4767   Value *VarIdx = 0;
4768   std::vector<Constant*> Indexes;
4769   unsigned VarIdxNum = 0;
4770   for (unsigned i = 2, e = GEP->getNumOperands(); i != e; ++i)
4771     if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
4772       Indexes.push_back(CI);
4773     } else if (!isa<ConstantInt>(GEP->getOperand(i))) {
4774       if (VarIdx) return getCouldNotCompute();  // Multiple non-constant idx's.
4775       VarIdx = GEP->getOperand(i);
4776       VarIdxNum = i-2;
4777       Indexes.push_back(0);
4778     }
4779
4780   // Loop-invariant loads may be a byproduct of loop optimization. Skip them.
4781   if (!VarIdx)
4782     return getCouldNotCompute();
4783
4784   // Okay, we know we have a (load (gep GV, 0, X)) comparison with a constant.
4785   // Check to see if X is a loop variant variable value now.
4786   const SCEV *Idx = getSCEV(VarIdx);
4787   Idx = getSCEVAtScope(Idx, L);
4788
4789   // We can only recognize very limited forms of loop index expressions, in
4790   // particular, only affine AddRec's like {C1,+,C2}.
4791   const SCEVAddRecExpr *IdxExpr = dyn_cast<SCEVAddRecExpr>(Idx);
4792   if (!IdxExpr || !IdxExpr->isAffine() || isLoopInvariant(IdxExpr, L) ||
4793       !isa<SCEVConstant>(IdxExpr->getOperand(0)) ||
4794       !isa<SCEVConstant>(IdxExpr->getOperand(1)))
4795     return getCouldNotCompute();
4796
4797   unsigned MaxSteps = MaxBruteForceIterations;
4798   for (unsigned IterationNum = 0; IterationNum != MaxSteps; ++IterationNum) {
4799     ConstantInt *ItCst = ConstantInt::get(
4800                            cast<IntegerType>(IdxExpr->getType()), IterationNum);
4801     ConstantInt *Val = EvaluateConstantChrecAtConstant(IdxExpr, ItCst, *this);
4802
4803     // Form the GEP offset.
4804     Indexes[VarIdxNum] = Val;
4805
4806     Constant *Result = ConstantFoldLoadThroughGEPIndices(GV->getInitializer(),
4807                                                          Indexes);
4808     if (Result == 0) break;  // Cannot compute!
4809
4810     // Evaluate the condition for this iteration.
4811     Result = ConstantExpr::getICmp(predicate, Result, RHS);
4812     if (!isa<ConstantInt>(Result)) break;  // Couldn't decide for sure
4813     if (cast<ConstantInt>(Result)->getValue().isMinValue()) {
4814 #if 0
4815       dbgs() << "\n***\n*** Computed loop count " << *ItCst
4816              << "\n*** From global " << *GV << "*** BB: " << *L->getHeader()
4817              << "***\n";
4818 #endif
4819       ++NumArrayLenItCounts;
4820       return getConstant(ItCst);   // Found terminating iteration!
4821     }
4822   }
4823   return getCouldNotCompute();
4824 }
4825
4826
4827 /// CanConstantFold - Return true if we can constant fold an instruction of the
4828 /// specified type, assuming that all operands were constants.
4829 static bool CanConstantFold(const Instruction *I) {
4830   if (isa<BinaryOperator>(I) || isa<CmpInst>(I) ||
4831       isa<SelectInst>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I) ||
4832       isa<LoadInst>(I))
4833     return true;
4834
4835   if (const CallInst *CI = dyn_cast<CallInst>(I))
4836     if (const Function *F = CI->getCalledFunction())
4837       return canConstantFoldCallTo(F);
4838   return false;
4839 }
4840
4841 /// Determine whether this instruction can constant evolve within this loop
4842 /// assuming its operands can all constant evolve.
4843 static bool canConstantEvolve(Instruction *I, const Loop *L) {
4844   // An instruction outside of the loop can't be derived from a loop PHI.
4845   if (!L->contains(I)) return false;
4846
4847   if (isa<PHINode>(I)) {
4848     if (L->getHeader() == I->getParent())
4849       return true;
4850     else
4851       // We don't currently keep track of the control flow needed to evaluate
4852       // PHIs, so we cannot handle PHIs inside of loops.
4853       return false;
4854   }
4855
4856   // If we won't be able to constant fold this expression even if the operands
4857   // are constants, bail early.
4858   return CanConstantFold(I);
4859 }
4860
4861 /// getConstantEvolvingPHIOperands - Implement getConstantEvolvingPHI by
4862 /// recursing through each instruction operand until reaching a loop header phi.
4863 static PHINode *
4864 getConstantEvolvingPHIOperands(Instruction *UseInst, const Loop *L,
4865                                DenseMap<Instruction *, PHINode *> &PHIMap) {
4866
4867   // Otherwise, we can evaluate this instruction if all of its operands are
4868   // constant or derived from a PHI node themselves.
4869   PHINode *PHI = 0;
4870   for (Instruction::op_iterator OpI = UseInst->op_begin(),
4871          OpE = UseInst->op_end(); OpI != OpE; ++OpI) {
4872
4873     if (isa<Constant>(*OpI)) continue;
4874
4875     Instruction *OpInst = dyn_cast<Instruction>(*OpI);
4876     if (!OpInst || !canConstantEvolve(OpInst, L)) return 0;
4877
4878     PHINode *P = dyn_cast<PHINode>(OpInst);
4879     if (!P)
4880       // If this operand is already visited, reuse the prior result.
4881       // We may have P != PHI if this is the deepest point at which the
4882       // inconsistent paths meet.
4883       P = PHIMap.lookup(OpInst);
4884     if (!P) {
4885       // Recurse and memoize the results, whether a phi is found or not.
4886       // This recursive call invalidates pointers into PHIMap.
4887       P = getConstantEvolvingPHIOperands(OpInst, L, PHIMap);
4888       PHIMap[OpInst] = P;
4889     }
4890     if (P == 0) return 0;        // Not evolving from PHI
4891     if (PHI && PHI != P) return 0;  // Evolving from multiple different PHIs.
4892     PHI = P;
4893   }
4894   // This is a expression evolving from a constant PHI!
4895   return PHI;
4896 }
4897
4898 /// getConstantEvolvingPHI - Given an LLVM value and a loop, return a PHI node
4899 /// in the loop that V is derived from.  We allow arbitrary operations along the
4900 /// way, but the operands of an operation must either be constants or a value
4901 /// derived from a constant PHI.  If this expression does not fit with these
4902 /// constraints, return null.
4903 static PHINode *getConstantEvolvingPHI(Value *V, const Loop *L) {
4904   Instruction *I = dyn_cast<Instruction>(V);
4905   if (I == 0 || !canConstantEvolve(I, L)) return 0;
4906
4907   if (PHINode *PN = dyn_cast<PHINode>(I)) {
4908     return PN;
4909   }
4910
4911   // Record non-constant instructions contained by the loop.
4912   DenseMap<Instruction *, PHINode *> PHIMap;
4913   return getConstantEvolvingPHIOperands(I, L, PHIMap);
4914 }
4915
4916 /// EvaluateExpression - Given an expression that passes the
4917 /// getConstantEvolvingPHI predicate, evaluate its value assuming the PHI node
4918 /// in the loop has the value PHIVal.  If we can't fold this expression for some
4919 /// reason, return null.
4920 static Constant *EvaluateExpression(Value *V, const Loop *L,
4921                                     DenseMap<Instruction *, Constant *> &Vals,
4922                                     const DataLayout *TD,
4923                                     const TargetLibraryInfo *TLI) {
4924   // Convenient constant check, but redundant for recursive calls.
4925   if (Constant *C = dyn_cast<Constant>(V)) return C;
4926   Instruction *I = dyn_cast<Instruction>(V);
4927   if (!I) return 0;
4928
4929   if (Constant *C = Vals.lookup(I)) return C;
4930
4931   // An instruction inside the loop depends on a value outside the loop that we
4932   // weren't given a mapping for, or a value such as a call inside the loop.
4933   if (!canConstantEvolve(I, L)) return 0;
4934
4935   // An unmapped PHI can be due to a branch or another loop inside this loop,
4936   // or due to this not being the initial iteration through a loop where we
4937   // couldn't compute the evolution of this particular PHI last time.
4938   if (isa<PHINode>(I)) return 0;
4939
4940   std::vector<Constant*> Operands(I->getNumOperands());
4941
4942   for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
4943     Instruction *Operand = dyn_cast<Instruction>(I->getOperand(i));
4944     if (!Operand) {
4945       Operands[i] = dyn_cast<Constant>(I->getOperand(i));
4946       if (!Operands[i]) return 0;
4947       continue;
4948     }
4949     Constant *C = EvaluateExpression(Operand, L, Vals, TD, TLI);
4950     Vals[Operand] = C;
4951     if (!C) return 0;
4952     Operands[i] = C;
4953   }
4954
4955   if (CmpInst *CI = dyn_cast<CmpInst>(I))
4956     return ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0],
4957                                            Operands[1], TD, TLI);
4958   if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
4959     if (!LI->isVolatile())
4960       return ConstantFoldLoadFromConstPtr(Operands[0], TD);
4961   }
4962   return ConstantFoldInstOperands(I->getOpcode(), I->getType(), Operands, TD,
4963                                   TLI);
4964 }
4965
4966 /// getConstantEvolutionLoopExitValue - If we know that the specified Phi is
4967 /// in the header of its containing loop, we know the loop executes a
4968 /// constant number of times, and the PHI node is just a recurrence
4969 /// involving constants, fold it.
4970 Constant *
4971 ScalarEvolution::getConstantEvolutionLoopExitValue(PHINode *PN,
4972                                                    const APInt &BEs,
4973                                                    const Loop *L) {
4974   DenseMap<PHINode*, Constant*>::const_iterator I =
4975     ConstantEvolutionLoopExitValue.find(PN);
4976   if (I != ConstantEvolutionLoopExitValue.end())
4977     return I->second;
4978
4979   if (BEs.ugt(MaxBruteForceIterations))
4980     return ConstantEvolutionLoopExitValue[PN] = 0;  // Not going to evaluate it.
4981
4982   Constant *&RetVal = ConstantEvolutionLoopExitValue[PN];
4983
4984   DenseMap<Instruction *, Constant *> CurrentIterVals;
4985   BasicBlock *Header = L->getHeader();
4986   assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!");
4987
4988   // Since the loop is canonicalized, the PHI node must have two entries.  One
4989   // entry must be a constant (coming in from outside of the loop), and the
4990   // second must be derived from the same PHI.
4991   bool SecondIsBackedge = L->contains(PN->getIncomingBlock(1));
4992   PHINode *PHI = 0;
4993   for (BasicBlock::iterator I = Header->begin();
4994        (PHI = dyn_cast<PHINode>(I)); ++I) {
4995     Constant *StartCST =
4996       dyn_cast<Constant>(PHI->getIncomingValue(!SecondIsBackedge));
4997     if (StartCST == 0) continue;
4998     CurrentIterVals[PHI] = StartCST;
4999   }
5000   if (!CurrentIterVals.count(PN))
5001     return RetVal = 0;
5002
5003   Value *BEValue = PN->getIncomingValue(SecondIsBackedge);
5004
5005   // Execute the loop symbolically to determine the exit value.
5006   if (BEs.getActiveBits() >= 32)
5007     return RetVal = 0; // More than 2^32-1 iterations?? Not doing it!
5008
5009   unsigned NumIterations = BEs.getZExtValue(); // must be in range
5010   unsigned IterationNum = 0;
5011   for (; ; ++IterationNum) {
5012     if (IterationNum == NumIterations)
5013       return RetVal = CurrentIterVals[PN];  // Got exit value!
5014
5015     // Compute the value of the PHIs for the next iteration.
5016     // EvaluateExpression adds non-phi values to the CurrentIterVals map.
5017     DenseMap<Instruction *, Constant *> NextIterVals;
5018     Constant *NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, TD,
5019                                            TLI);
5020     if (NextPHI == 0)
5021       return 0;        // Couldn't evaluate!
5022     NextIterVals[PN] = NextPHI;
5023
5024     bool StoppedEvolving = NextPHI == CurrentIterVals[PN];
5025
5026     // Also evaluate the other PHI nodes.  However, we don't get to stop if we
5027     // cease to be able to evaluate one of them or if they stop evolving,
5028     // because that doesn't necessarily prevent us from computing PN.
5029     SmallVector<std::pair<PHINode *, Constant *>, 8> PHIsToCompute;
5030     for (DenseMap<Instruction *, Constant *>::const_iterator
5031            I = CurrentIterVals.begin(), E = CurrentIterVals.end(); I != E; ++I){
5032       PHINode *PHI = dyn_cast<PHINode>(I->first);
5033       if (!PHI || PHI == PN || PHI->getParent() != Header) continue;
5034       PHIsToCompute.push_back(std::make_pair(PHI, I->second));
5035     }
5036     // We use two distinct loops because EvaluateExpression may invalidate any
5037     // iterators into CurrentIterVals.
5038     for (SmallVectorImpl<std::pair<PHINode *, Constant*> >::const_iterator
5039              I = PHIsToCompute.begin(), E = PHIsToCompute.end(); I != E; ++I) {
5040       PHINode *PHI = I->first;
5041       Constant *&NextPHI = NextIterVals[PHI];
5042       if (!NextPHI) {   // Not already computed.
5043         Value *BEValue = PHI->getIncomingValue(SecondIsBackedge);
5044         NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, TD, TLI);
5045       }
5046       if (NextPHI != I->second)
5047         StoppedEvolving = false;
5048     }
5049
5050     // If all entries in CurrentIterVals == NextIterVals then we can stop
5051     // iterating, the loop can't continue to change.
5052     if (StoppedEvolving)
5053       return RetVal = CurrentIterVals[PN];
5054
5055     CurrentIterVals.swap(NextIterVals);
5056   }
5057 }
5058
5059 /// ComputeExitCountExhaustively - If the loop is known to execute a
5060 /// constant number of times (the condition evolves only from constants),
5061 /// try to evaluate a few iterations of the loop until we get the exit
5062 /// condition gets a value of ExitWhen (true or false).  If we cannot
5063 /// evaluate the trip count of the loop, return getCouldNotCompute().
5064 const SCEV *ScalarEvolution::ComputeExitCountExhaustively(const Loop *L,
5065                                                           Value *Cond,
5066                                                           bool ExitWhen) {
5067   PHINode *PN = getConstantEvolvingPHI(Cond, L);
5068   if (PN == 0) return getCouldNotCompute();
5069
5070   // If the loop is canonicalized, the PHI will have exactly two entries.
5071   // That's the only form we support here.
5072   if (PN->getNumIncomingValues() != 2) return getCouldNotCompute();
5073
5074   DenseMap<Instruction *, Constant *> CurrentIterVals;
5075   BasicBlock *Header = L->getHeader();
5076   assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!");
5077
5078   // One entry must be a constant (coming in from outside of the loop), and the
5079   // second must be derived from the same PHI.
5080   bool SecondIsBackedge = L->contains(PN->getIncomingBlock(1));
5081   PHINode *PHI = 0;
5082   for (BasicBlock::iterator I = Header->begin();
5083        (PHI = dyn_cast<PHINode>(I)); ++I) {
5084     Constant *StartCST =
5085       dyn_cast<Constant>(PHI->getIncomingValue(!SecondIsBackedge));
5086     if (StartCST == 0) continue;
5087     CurrentIterVals[PHI] = StartCST;
5088   }
5089   if (!CurrentIterVals.count(PN))
5090     return getCouldNotCompute();
5091
5092   // Okay, we find a PHI node that defines the trip count of this loop.  Execute
5093   // the loop symbolically to determine when the condition gets a value of
5094   // "ExitWhen".
5095
5096   unsigned MaxIterations = MaxBruteForceIterations;   // Limit analysis.
5097   for (unsigned IterationNum = 0; IterationNum != MaxIterations;++IterationNum){
5098     ConstantInt *CondVal =
5099       dyn_cast_or_null<ConstantInt>(EvaluateExpression(Cond, L, CurrentIterVals,
5100                                                        TD, TLI));
5101
5102     // Couldn't symbolically evaluate.
5103     if (!CondVal) return getCouldNotCompute();
5104
5105     if (CondVal->getValue() == uint64_t(ExitWhen)) {
5106       ++NumBruteForceTripCountsComputed;
5107       return getConstant(Type::getInt32Ty(getContext()), IterationNum);
5108     }
5109
5110     // Update all the PHI nodes for the next iteration.
5111     DenseMap<Instruction *, Constant *> NextIterVals;
5112
5113     // Create a list of which PHIs we need to compute. We want to do this before
5114     // calling EvaluateExpression on them because that may invalidate iterators
5115     // into CurrentIterVals.
5116     SmallVector<PHINode *, 8> PHIsToCompute;
5117     for (DenseMap<Instruction *, Constant *>::const_iterator
5118            I = CurrentIterVals.begin(), E = CurrentIterVals.end(); I != E; ++I){
5119       PHINode *PHI = dyn_cast<PHINode>(I->first);
5120       if (!PHI || PHI->getParent() != Header) continue;
5121       PHIsToCompute.push_back(PHI);
5122     }
5123     for (SmallVectorImpl<PHINode *>::const_iterator I = PHIsToCompute.begin(),
5124              E = PHIsToCompute.end(); I != E; ++I) {
5125       PHINode *PHI = *I;
5126       Constant *&NextPHI = NextIterVals[PHI];
5127       if (NextPHI) continue;    // Already computed!
5128
5129       Value *BEValue = PHI->getIncomingValue(SecondIsBackedge);
5130       NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, TD, TLI);
5131     }
5132     CurrentIterVals.swap(NextIterVals);
5133   }
5134
5135   // Too many iterations were needed to evaluate.
5136   return getCouldNotCompute();
5137 }
5138
5139 /// getSCEVAtScope - Return a SCEV expression for the specified value
5140 /// at the specified scope in the program.  The L value specifies a loop
5141 /// nest to evaluate the expression at, where null is the top-level or a
5142 /// specified loop is immediately inside of the loop.
5143 ///
5144 /// This method can be used to compute the exit value for a variable defined
5145 /// in a loop by querying what the value will hold in the parent loop.
5146 ///
5147 /// In the case that a relevant loop exit value cannot be computed, the
5148 /// original value V is returned.
5149 const SCEV *ScalarEvolution::getSCEVAtScope(const SCEV *V, const Loop *L) {
5150   // Check to see if we've folded this expression at this loop before.
5151   SmallVector<std::pair<const Loop *, const SCEV *>, 2> &Values = ValuesAtScopes[V];
5152   for (unsigned u = 0; u < Values.size(); u++) {
5153     if (Values[u].first == L)
5154       return Values[u].second ? Values[u].second : V;
5155   }
5156   Values.push_back(std::make_pair(L, static_cast<const SCEV *>(0)));
5157   // Otherwise compute it.
5158   const SCEV *C = computeSCEVAtScope(V, L);
5159   SmallVector<std::pair<const Loop *, const SCEV *>, 2> &Values2 = ValuesAtScopes[V];
5160   for (unsigned u = Values2.size(); u > 0; u--) {
5161     if (Values2[u - 1].first == L) {
5162       Values2[u - 1].second = C;
5163       break;
5164     }
5165   }
5166   return C;
5167 }
5168
5169 /// This builds up a Constant using the ConstantExpr interface.  That way, we
5170 /// will return Constants for objects which aren't represented by a
5171 /// SCEVConstant, because SCEVConstant is restricted to ConstantInt.
5172 /// Returns NULL if the SCEV isn't representable as a Constant.
5173 static Constant *BuildConstantFromSCEV(const SCEV *V) {
5174   switch (V->getSCEVType()) {
5175     default:  // TODO: smax, umax.
5176     case scCouldNotCompute:
5177     case scAddRecExpr:
5178       break;
5179     case scConstant:
5180       return cast<SCEVConstant>(V)->getValue();
5181     case scUnknown:
5182       return dyn_cast<Constant>(cast<SCEVUnknown>(V)->getValue());
5183     case scSignExtend: {
5184       const SCEVSignExtendExpr *SS = cast<SCEVSignExtendExpr>(V);
5185       if (Constant *CastOp = BuildConstantFromSCEV(SS->getOperand()))
5186         return ConstantExpr::getSExt(CastOp, SS->getType());
5187       break;
5188     }
5189     case scZeroExtend: {
5190       const SCEVZeroExtendExpr *SZ = cast<SCEVZeroExtendExpr>(V);
5191       if (Constant *CastOp = BuildConstantFromSCEV(SZ->getOperand()))
5192         return ConstantExpr::getZExt(CastOp, SZ->getType());
5193       break;
5194     }
5195     case scTruncate: {
5196       const SCEVTruncateExpr *ST = cast<SCEVTruncateExpr>(V);
5197       if (Constant *CastOp = BuildConstantFromSCEV(ST->getOperand()))
5198         return ConstantExpr::getTrunc(CastOp, ST->getType());
5199       break;
5200     }
5201     case scAddExpr: {
5202       const SCEVAddExpr *SA = cast<SCEVAddExpr>(V);
5203       if (Constant *C = BuildConstantFromSCEV(SA->getOperand(0))) {
5204         if (PointerType *PTy = dyn_cast<PointerType>(C->getType())) {
5205           unsigned AS = PTy->getAddressSpace();
5206           Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS);
5207           C = ConstantExpr::getBitCast(C, DestPtrTy);
5208         }
5209         for (unsigned i = 1, e = SA->getNumOperands(); i != e; ++i) {
5210           Constant *C2 = BuildConstantFromSCEV(SA->getOperand(i));
5211           if (!C2) return 0;
5212
5213           // First pointer!
5214           if (!C->getType()->isPointerTy() && C2->getType()->isPointerTy()) {
5215             unsigned AS = C2->getType()->getPointerAddressSpace();
5216             std::swap(C, C2);
5217             Type *DestPtrTy = Type::getInt8PtrTy(C->getContext(), AS);
5218             // The offsets have been converted to bytes.  We can add bytes to an
5219             // i8* by GEP with the byte count in the first index.
5220             C = ConstantExpr::getBitCast(C, DestPtrTy);
5221           }
5222
5223           // Don't bother trying to sum two pointers. We probably can't
5224           // statically compute a load that results from it anyway.
5225           if (C2->getType()->isPointerTy())
5226             return 0;
5227
5228           if (PointerType *PTy = dyn_cast<PointerType>(C->getType())) {
5229             if (PTy->getElementType()->isStructTy())
5230               C2 = ConstantExpr::getIntegerCast(
5231                   C2, Type::getInt32Ty(C->getContext()), true);
5232             C = ConstantExpr::getGetElementPtr(C, C2);
5233           } else
5234             C = ConstantExpr::getAdd(C, C2);
5235         }
5236         return C;
5237       }
5238       break;
5239     }
5240     case scMulExpr: {
5241       const SCEVMulExpr *SM = cast<SCEVMulExpr>(V);
5242       if (Constant *C = BuildConstantFromSCEV(SM->getOperand(0))) {
5243         // Don't bother with pointers at all.
5244         if (C->getType()->isPointerTy()) return 0;
5245         for (unsigned i = 1, e = SM->getNumOperands(); i != e; ++i) {
5246           Constant *C2 = BuildConstantFromSCEV(SM->getOperand(i));
5247           if (!C2 || C2->getType()->isPointerTy()) return 0;
5248           C = ConstantExpr::getMul(C, C2);
5249         }
5250         return C;
5251       }
5252       break;
5253     }
5254     case scUDivExpr: {
5255       const SCEVUDivExpr *SU = cast<SCEVUDivExpr>(V);
5256       if (Constant *LHS = BuildConstantFromSCEV(SU->getLHS()))
5257         if (Constant *RHS = BuildConstantFromSCEV(SU->getRHS()))
5258           if (LHS->getType() == RHS->getType())
5259             return ConstantExpr::getUDiv(LHS, RHS);
5260       break;
5261     }
5262   }
5263   return 0;
5264 }
5265
5266 const SCEV *ScalarEvolution::computeSCEVAtScope(const SCEV *V, const Loop *L) {
5267   if (isa<SCEVConstant>(V)) return V;
5268
5269   // If this instruction is evolved from a constant-evolving PHI, compute the
5270   // exit value from the loop without using SCEVs.
5271   if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V)) {
5272     if (Instruction *I = dyn_cast<Instruction>(SU->getValue())) {
5273       const Loop *LI = (*this->LI)[I->getParent()];
5274       if (LI && LI->getParentLoop() == L)  // Looking for loop exit value.
5275         if (PHINode *PN = dyn_cast<PHINode>(I))
5276           if (PN->getParent() == LI->getHeader()) {
5277             // Okay, there is no closed form solution for the PHI node.  Check
5278             // to see if the loop that contains it has a known backedge-taken
5279             // count.  If so, we may be able to force computation of the exit
5280             // value.
5281             const SCEV *BackedgeTakenCount = getBackedgeTakenCount(LI);
5282             if (const SCEVConstant *BTCC =
5283                   dyn_cast<SCEVConstant>(BackedgeTakenCount)) {
5284               // Okay, we know how many times the containing loop executes.  If
5285               // this is a constant evolving PHI node, get the final value at
5286               // the specified iteration number.
5287               Constant *RV = getConstantEvolutionLoopExitValue(PN,
5288                                                    BTCC->getValue()->getValue(),
5289                                                                LI);
5290               if (RV) return getSCEV(RV);
5291             }
5292           }
5293
5294       // Okay, this is an expression that we cannot symbolically evaluate
5295       // into a SCEV.  Check to see if it's possible to symbolically evaluate
5296       // the arguments into constants, and if so, try to constant propagate the
5297       // result.  This is particularly useful for computing loop exit values.
5298       if (CanConstantFold(I)) {
5299         SmallVector<Constant *, 4> Operands;
5300         bool MadeImprovement = false;
5301         for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
5302           Value *Op = I->getOperand(i);
5303           if (Constant *C = dyn_cast<Constant>(Op)) {
5304             Operands.push_back(C);
5305             continue;
5306           }
5307
5308           // If any of the operands is non-constant and if they are
5309           // non-integer and non-pointer, don't even try to analyze them
5310           // with scev techniques.
5311           if (!isSCEVable(Op->getType()))
5312             return V;
5313
5314           const SCEV *OrigV = getSCEV(Op);
5315           const SCEV *OpV = getSCEVAtScope(OrigV, L);
5316           MadeImprovement |= OrigV != OpV;
5317
5318           Constant *C = BuildConstantFromSCEV(OpV);
5319           if (!C) return V;
5320           if (C->getType() != Op->getType())
5321             C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
5322                                                               Op->getType(),
5323                                                               false),
5324                                       C, Op->getType());
5325           Operands.push_back(C);
5326         }
5327
5328         // Check to see if getSCEVAtScope actually made an improvement.
5329         if (MadeImprovement) {
5330           Constant *C = 0;
5331           if (const CmpInst *CI = dyn_cast<CmpInst>(I))
5332             C = ConstantFoldCompareInstOperands(CI->getPredicate(),
5333                                                 Operands[0], Operands[1], TD,
5334                                                 TLI);
5335           else if (const LoadInst *LI = dyn_cast<LoadInst>(I)) {
5336             if (!LI->isVolatile())
5337               C = ConstantFoldLoadFromConstPtr(Operands[0], TD);
5338           } else
5339             C = ConstantFoldInstOperands(I->getOpcode(), I->getType(),
5340                                          Operands, TD, TLI);
5341           if (!C) return V;
5342           return getSCEV(C);
5343         }
5344       }
5345     }
5346
5347     // This is some other type of SCEVUnknown, just return it.
5348     return V;
5349   }
5350
5351   if (const SCEVCommutativeExpr *Comm = dyn_cast<SCEVCommutativeExpr>(V)) {
5352     // Avoid performing the look-up in the common case where the specified
5353     // expression has no loop-variant portions.
5354     for (unsigned i = 0, e = Comm->getNumOperands(); i != e; ++i) {
5355       const SCEV *OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
5356       if (OpAtScope != Comm->getOperand(i)) {
5357         // Okay, at least one of these operands is loop variant but might be
5358         // foldable.  Build a new instance of the folded commutative expression.
5359         SmallVector<const SCEV *, 8> NewOps(Comm->op_begin(),
5360                                             Comm->op_begin()+i);
5361         NewOps.push_back(OpAtScope);
5362
5363         for (++i; i != e; ++i) {
5364           OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
5365           NewOps.push_back(OpAtScope);
5366         }
5367         if (isa<SCEVAddExpr>(Comm))
5368           return getAddExpr(NewOps);
5369         if (isa<SCEVMulExpr>(Comm))
5370           return getMulExpr(NewOps);
5371         if (isa<SCEVSMaxExpr>(Comm))
5372           return getSMaxExpr(NewOps);
5373         if (isa<SCEVUMaxExpr>(Comm))
5374           return getUMaxExpr(NewOps);
5375         llvm_unreachable("Unknown commutative SCEV type!");
5376       }
5377     }
5378     // If we got here, all operands are loop invariant.
5379     return Comm;
5380   }
5381
5382   if (const SCEVUDivExpr *Div = dyn_cast<SCEVUDivExpr>(V)) {
5383     const SCEV *LHS = getSCEVAtScope(Div->getLHS(), L);
5384     const SCEV *RHS = getSCEVAtScope(Div->getRHS(), L);
5385     if (LHS == Div->getLHS() && RHS == Div->getRHS())
5386       return Div;   // must be loop invariant
5387     return getUDivExpr(LHS, RHS);
5388   }
5389
5390   // If this is a loop recurrence for a loop that does not contain L, then we
5391   // are dealing with the final value computed by the loop.
5392   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V)) {
5393     // First, attempt to evaluate each operand.
5394     // Avoid performing the look-up in the common case where the specified
5395     // expression has no loop-variant portions.
5396     for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
5397       const SCEV *OpAtScope = getSCEVAtScope(AddRec->getOperand(i), L);
5398       if (OpAtScope == AddRec->getOperand(i))
5399         continue;
5400
5401       // Okay, at least one of these operands is loop variant but might be
5402       // foldable.  Build a new instance of the folded commutative expression.
5403       SmallVector<const SCEV *, 8> NewOps(AddRec->op_begin(),
5404                                           AddRec->op_begin()+i);
5405       NewOps.push_back(OpAtScope);
5406       for (++i; i != e; ++i)
5407         NewOps.push_back(getSCEVAtScope(AddRec->getOperand(i), L));
5408
5409       const SCEV *FoldedRec =
5410         getAddRecExpr(NewOps, AddRec->getLoop(),
5411                       AddRec->getNoWrapFlags(SCEV::FlagNW));
5412       AddRec = dyn_cast<SCEVAddRecExpr>(FoldedRec);
5413       // The addrec may be folded to a nonrecurrence, for example, if the
5414       // induction variable is multiplied by zero after constant folding. Go
5415       // ahead and return the folded value.
5416       if (!AddRec)
5417         return FoldedRec;
5418       break;
5419     }
5420
5421     // If the scope is outside the addrec's loop, evaluate it by using the
5422     // loop exit value of the addrec.
5423     if (!AddRec->getLoop()->contains(L)) {
5424       // To evaluate this recurrence, we need to know how many times the AddRec
5425       // loop iterates.  Compute this now.
5426       const SCEV *BackedgeTakenCount = getBackedgeTakenCount(AddRec->getLoop());
5427       if (BackedgeTakenCount == getCouldNotCompute()) return AddRec;
5428
5429       // Then, evaluate the AddRec.
5430       return AddRec->evaluateAtIteration(BackedgeTakenCount, *this);
5431     }
5432
5433     return AddRec;
5434   }
5435
5436   if (const SCEVZeroExtendExpr *Cast = dyn_cast<SCEVZeroExtendExpr>(V)) {
5437     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
5438     if (Op == Cast->getOperand())
5439       return Cast;  // must be loop invariant
5440     return getZeroExtendExpr(Op, Cast->getType());
5441   }
5442
5443   if (const SCEVSignExtendExpr *Cast = dyn_cast<SCEVSignExtendExpr>(V)) {
5444     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
5445     if (Op == Cast->getOperand())
5446       return Cast;  // must be loop invariant
5447     return getSignExtendExpr(Op, Cast->getType());
5448   }
5449
5450   if (const SCEVTruncateExpr *Cast = dyn_cast<SCEVTruncateExpr>(V)) {
5451     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
5452     if (Op == Cast->getOperand())
5453       return Cast;  // must be loop invariant
5454     return getTruncateExpr(Op, Cast->getType());
5455   }
5456
5457   llvm_unreachable("Unknown SCEV type!");
5458 }
5459
5460 /// getSCEVAtScope - This is a convenience function which does
5461 /// getSCEVAtScope(getSCEV(V), L).
5462 const SCEV *ScalarEvolution::getSCEVAtScope(Value *V, const Loop *L) {
5463   return getSCEVAtScope(getSCEV(V), L);
5464 }
5465
5466 /// SolveLinEquationWithOverflow - Finds the minimum unsigned root of the
5467 /// following equation:
5468 ///
5469 ///     A * X = B (mod N)
5470 ///
5471 /// where N = 2^BW and BW is the common bit width of A and B. The signedness of
5472 /// A and B isn't important.
5473 ///
5474 /// If the equation does not have a solution, SCEVCouldNotCompute is returned.
5475 static const SCEV *SolveLinEquationWithOverflow(const APInt &A, const APInt &B,
5476                                                ScalarEvolution &SE) {
5477   uint32_t BW = A.getBitWidth();
5478   assert(BW == B.getBitWidth() && "Bit widths must be the same.");
5479   assert(A != 0 && "A must be non-zero.");
5480
5481   // 1. D = gcd(A, N)
5482   //
5483   // The gcd of A and N may have only one prime factor: 2. The number of
5484   // trailing zeros in A is its multiplicity
5485   uint32_t Mult2 = A.countTrailingZeros();
5486   // D = 2^Mult2
5487
5488   // 2. Check if B is divisible by D.
5489   //
5490   // B is divisible by D if and only if the multiplicity of prime factor 2 for B
5491   // is not less than multiplicity of this prime factor for D.
5492   if (B.countTrailingZeros() < Mult2)
5493     return SE.getCouldNotCompute();
5494
5495   // 3. Compute I: the multiplicative inverse of (A / D) in arithmetic
5496   // modulo (N / D).
5497   //
5498   // (N / D) may need BW+1 bits in its representation.  Hence, we'll use this
5499   // bit width during computations.
5500   APInt AD = A.lshr(Mult2).zext(BW + 1);  // AD = A / D
5501   APInt Mod(BW + 1, 0);
5502   Mod.setBit(BW - Mult2);  // Mod = N / D
5503   APInt I = AD.multiplicativeInverse(Mod);
5504
5505   // 4. Compute the minimum unsigned root of the equation:
5506   // I * (B / D) mod (N / D)
5507   APInt Result = (I * B.lshr(Mult2).zext(BW + 1)).urem(Mod);
5508
5509   // The result is guaranteed to be less than 2^BW so we may truncate it to BW
5510   // bits.
5511   return SE.getConstant(Result.trunc(BW));
5512 }
5513
5514 /// SolveQuadraticEquation - Find the roots of the quadratic equation for the
5515 /// given quadratic chrec {L,+,M,+,N}.  This returns either the two roots (which
5516 /// might be the same) or two SCEVCouldNotCompute objects.
5517 ///
5518 static std::pair<const SCEV *,const SCEV *>
5519 SolveQuadraticEquation(const SCEVAddRecExpr *AddRec, ScalarEvolution &SE) {
5520   assert(AddRec->getNumOperands() == 3 && "This is not a quadratic chrec!");
5521   const SCEVConstant *LC = dyn_cast<SCEVConstant>(AddRec->getOperand(0));
5522   const SCEVConstant *MC = dyn_cast<SCEVConstant>(AddRec->getOperand(1));
5523   const SCEVConstant *NC = dyn_cast<SCEVConstant>(AddRec->getOperand(2));
5524
5525   // We currently can only solve this if the coefficients are constants.
5526   if (!LC || !MC || !NC) {
5527     const SCEV *CNC = SE.getCouldNotCompute();
5528     return std::make_pair(CNC, CNC);
5529   }
5530
5531   uint32_t BitWidth = LC->getValue()->getValue().getBitWidth();
5532   const APInt &L = LC->getValue()->getValue();
5533   const APInt &M = MC->getValue()->getValue();
5534   const APInt &N = NC->getValue()->getValue();
5535   APInt Two(BitWidth, 2);
5536   APInt Four(BitWidth, 4);
5537
5538   {
5539     using namespace APIntOps;
5540     const APInt& C = L;
5541     // Convert from chrec coefficients to polynomial coefficients AX^2+BX+C
5542     // The B coefficient is M-N/2
5543     APInt B(M);
5544     B -= sdiv(N,Two);
5545
5546     // The A coefficient is N/2
5547     APInt A(N.sdiv(Two));
5548
5549     // Compute the B^2-4ac term.
5550     APInt SqrtTerm(B);
5551     SqrtTerm *= B;
5552     SqrtTerm -= Four * (A * C);
5553
5554     if (SqrtTerm.isNegative()) {
5555       // The loop is provably infinite.
5556       const SCEV *CNC = SE.getCouldNotCompute();
5557       return std::make_pair(CNC, CNC);
5558     }
5559
5560     // Compute sqrt(B^2-4ac). This is guaranteed to be the nearest
5561     // integer value or else APInt::sqrt() will assert.
5562     APInt SqrtVal(SqrtTerm.sqrt());
5563
5564     // Compute the two solutions for the quadratic formula.
5565     // The divisions must be performed as signed divisions.
5566     APInt NegB(-B);
5567     APInt TwoA(A << 1);
5568     if (TwoA.isMinValue()) {
5569       const SCEV *CNC = SE.getCouldNotCompute();
5570       return std::make_pair(CNC, CNC);
5571     }
5572
5573     LLVMContext &Context = SE.getContext();
5574
5575     ConstantInt *Solution1 =
5576       ConstantInt::get(Context, (NegB + SqrtVal).sdiv(TwoA));
5577     ConstantInt *Solution2 =
5578       ConstantInt::get(Context, (NegB - SqrtVal).sdiv(TwoA));
5579
5580     return std::make_pair(SE.getConstant(Solution1),
5581                           SE.getConstant(Solution2));
5582   } // end APIntOps namespace
5583 }
5584
5585 /// HowFarToZero - Return the number of times a backedge comparing the specified
5586 /// value to zero will execute.  If not computable, return CouldNotCompute.
5587 ///
5588 /// This is only used for loops with a "x != y" exit test. The exit condition is
5589 /// now expressed as a single expression, V = x-y. So the exit test is
5590 /// effectively V != 0.  We know and take advantage of the fact that this
5591 /// expression only being used in a comparison by zero context.
5592 ScalarEvolution::ExitLimit
5593 ScalarEvolution::HowFarToZero(const SCEV *V, const Loop *L, bool IsSubExpr) {
5594   // If the value is a constant
5595   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
5596     // If the value is already zero, the branch will execute zero times.
5597     if (C->getValue()->isZero()) return C;
5598     return getCouldNotCompute();  // Otherwise it will loop infinitely.
5599   }
5600
5601   const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V);
5602   if (!AddRec || AddRec->getLoop() != L)
5603     return getCouldNotCompute();
5604
5605   // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of
5606   // the quadratic equation to solve it.
5607   if (AddRec->isQuadratic() && AddRec->getType()->isIntegerTy()) {
5608     std::pair<const SCEV *,const SCEV *> Roots =
5609       SolveQuadraticEquation(AddRec, *this);
5610     const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
5611     const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
5612     if (R1 && R2) {
5613 #if 0
5614       dbgs() << "HFTZ: " << *V << " - sol#1: " << *R1
5615              << "  sol#2: " << *R2 << "\n";
5616 #endif
5617       // Pick the smallest positive root value.
5618       if (ConstantInt *CB =
5619           dyn_cast<ConstantInt>(ConstantExpr::getICmp(CmpInst::ICMP_ULT,
5620                                                       R1->getValue(),
5621                                                       R2->getValue()))) {
5622         if (CB->getZExtValue() == false)
5623           std::swap(R1, R2);   // R1 is the minimum root now.
5624
5625         // We can only use this value if the chrec ends up with an exact zero
5626         // value at this index.  When solving for "X*X != 5", for example, we
5627         // should not accept a root of 2.
5628         const SCEV *Val = AddRec->evaluateAtIteration(R1, *this);
5629         if (Val->isZero())
5630           return R1;  // We found a quadratic root!
5631       }
5632     }
5633     return getCouldNotCompute();
5634   }
5635
5636   // Otherwise we can only handle this if it is affine.
5637   if (!AddRec->isAffine())
5638     return getCouldNotCompute();
5639
5640   // If this is an affine expression, the execution count of this branch is
5641   // the minimum unsigned root of the following equation:
5642   //
5643   //     Start + Step*N = 0 (mod 2^BW)
5644   //
5645   // equivalent to:
5646   //
5647   //             Step*N = -Start (mod 2^BW)
5648   //
5649   // where BW is the common bit width of Start and Step.
5650
5651   // Get the initial value for the loop.
5652   const SCEV *Start = getSCEVAtScope(AddRec->getStart(), L->getParentLoop());
5653   const SCEV *Step = getSCEVAtScope(AddRec->getOperand(1), L->getParentLoop());
5654
5655   // For now we handle only constant steps.
5656   //
5657   // TODO: Handle a nonconstant Step given AddRec<NUW>. If the
5658   // AddRec is NUW, then (in an unsigned sense) it cannot be counting up to wrap
5659   // to 0, it must be counting down to equal 0. Consequently, N = Start / -Step.
5660   // We have not yet seen any such cases.
5661   const SCEVConstant *StepC = dyn_cast<SCEVConstant>(Step);
5662   if (StepC == 0 || StepC->getValue()->equalsInt(0))
5663     return getCouldNotCompute();
5664
5665   // For positive steps (counting up until unsigned overflow):
5666   //   N = -Start/Step (as unsigned)
5667   // For negative steps (counting down to zero):
5668   //   N = Start/-Step
5669   // First compute the unsigned distance from zero in the direction of Step.
5670   bool CountDown = StepC->getValue()->getValue().isNegative();
5671   const SCEV *Distance = CountDown ? Start : getNegativeSCEV(Start);
5672
5673   // Handle unitary steps, which cannot wraparound.
5674   // 1*N = -Start; -1*N = Start (mod 2^BW), so:
5675   //   N = Distance (as unsigned)
5676   if (StepC->getValue()->equalsInt(1) || StepC->getValue()->isAllOnesValue()) {
5677     ConstantRange CR = getUnsignedRange(Start);
5678     const SCEV *MaxBECount;
5679     if (!CountDown && CR.getUnsignedMin().isMinValue())
5680       // When counting up, the worst starting value is 1, not 0.
5681       MaxBECount = CR.getUnsignedMax().isMinValue()
5682         ? getConstant(APInt::getMinValue(CR.getBitWidth()))
5683         : getConstant(APInt::getMaxValue(CR.getBitWidth()));
5684     else
5685       MaxBECount = getConstant(CountDown ? CR.getUnsignedMax()
5686                                          : -CR.getUnsignedMin());
5687     return ExitLimit(Distance, MaxBECount, /*MustExit=*/true);
5688   }
5689
5690   // If the recurrence is known not to wraparound, unsigned divide computes the
5691   // back edge count. (Ideally we would have an "isexact" bit for udiv). We know
5692   // that the value will either become zero (and thus the loop terminates), that
5693   // the loop will terminate through some other exit condition first, or that
5694   // the loop has undefined behavior.  This means we can't "miss" the exit
5695   // value, even with nonunit stride, and exit later via the same branch. Note
5696   // that we can skip this exit if loop later exits via a different
5697   // branch. Hence MustExit=false.
5698   //
5699   // This is only valid for expressions that directly compute the loop exit. It
5700   // is invalid for subexpressions in which the loop may exit through this
5701   // branch even if this subexpression is false. In that case, the trip count
5702   // computed by this udiv could be smaller than the number of well-defined
5703   // iterations.
5704   if (!IsSubExpr && AddRec->getNoWrapFlags(SCEV::FlagNW)) {
5705     const SCEV *Exact =
5706       getUDivExpr(Distance, CountDown ? getNegativeSCEV(Step) : Step);
5707     return ExitLimit(Exact, Exact, /*MustExit=*/false);
5708   }
5709   // Then, try to solve the above equation provided that Start is constant.
5710   if (const SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start))
5711     return SolveLinEquationWithOverflow(StepC->getValue()->getValue(),
5712                                         -StartC->getValue()->getValue(),
5713                                         *this);
5714   return getCouldNotCompute();
5715 }
5716
5717 /// HowFarToNonZero - Return the number of times a backedge checking the
5718 /// specified value for nonzero will execute.  If not computable, return
5719 /// CouldNotCompute
5720 ScalarEvolution::ExitLimit
5721 ScalarEvolution::HowFarToNonZero(const SCEV *V, const Loop *L) {
5722   // Loops that look like: while (X == 0) are very strange indeed.  We don't
5723   // handle them yet except for the trivial case.  This could be expanded in the
5724   // future as needed.
5725
5726   // If the value is a constant, check to see if it is known to be non-zero
5727   // already.  If so, the backedge will execute zero times.
5728   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
5729     if (!C->getValue()->isNullValue())
5730       return getConstant(C->getType(), 0);
5731     return getCouldNotCompute();  // Otherwise it will loop infinitely.
5732   }
5733
5734   // We could implement others, but I really doubt anyone writes loops like
5735   // this, and if they did, they would already be constant folded.
5736   return getCouldNotCompute();
5737 }
5738
5739 /// getPredecessorWithUniqueSuccessorForBB - Return a predecessor of BB
5740 /// (which may not be an immediate predecessor) which has exactly one
5741 /// successor from which BB is reachable, or null if no such block is
5742 /// found.
5743 ///
5744 std::pair<BasicBlock *, BasicBlock *>
5745 ScalarEvolution::getPredecessorWithUniqueSuccessorForBB(BasicBlock *BB) {
5746   // If the block has a unique predecessor, then there is no path from the
5747   // predecessor to the block that does not go through the direct edge
5748   // from the predecessor to the block.
5749   if (BasicBlock *Pred = BB->getSinglePredecessor())
5750     return std::make_pair(Pred, BB);
5751
5752   // A loop's header is defined to be a block that dominates the loop.
5753   // If the header has a unique predecessor outside the loop, it must be
5754   // a block that has exactly one successor that can reach the loop.
5755   if (Loop *L = LI->getLoopFor(BB))
5756     return std::make_pair(L->getLoopPredecessor(), L->getHeader());
5757
5758   return std::pair<BasicBlock *, BasicBlock *>();
5759 }
5760
5761 /// HasSameValue - SCEV structural equivalence is usually sufficient for
5762 /// testing whether two expressions are equal, however for the purposes of
5763 /// looking for a condition guarding a loop, it can be useful to be a little
5764 /// more general, since a front-end may have replicated the controlling
5765 /// expression.
5766 ///
5767 static bool HasSameValue(const SCEV *A, const SCEV *B) {
5768   // Quick check to see if they are the same SCEV.
5769   if (A == B) return true;
5770
5771   // Otherwise, if they're both SCEVUnknown, it's possible that they hold
5772   // two different instructions with the same value. Check for this case.
5773   if (const SCEVUnknown *AU = dyn_cast<SCEVUnknown>(A))
5774     if (const SCEVUnknown *BU = dyn_cast<SCEVUnknown>(B))
5775       if (const Instruction *AI = dyn_cast<Instruction>(AU->getValue()))
5776         if (const Instruction *BI = dyn_cast<Instruction>(BU->getValue()))
5777           if (AI->isIdenticalTo(BI) && !AI->mayReadFromMemory())
5778             return true;
5779
5780   // Otherwise assume they may have a different value.
5781   return false;
5782 }
5783
5784 /// SimplifyICmpOperands - Simplify LHS and RHS in a comparison with
5785 /// predicate Pred. Return true iff any changes were made.
5786 ///
5787 bool ScalarEvolution::SimplifyICmpOperands(ICmpInst::Predicate &Pred,
5788                                            const SCEV *&LHS, const SCEV *&RHS,
5789                                            unsigned Depth) {
5790   bool Changed = false;
5791
5792   // If we hit the max recursion limit bail out.
5793   if (Depth >= 3)
5794     return false;
5795
5796   // Canonicalize a constant to the right side.
5797   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
5798     // Check for both operands constant.
5799     if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
5800       if (ConstantExpr::getICmp(Pred,
5801                                 LHSC->getValue(),
5802                                 RHSC->getValue())->isNullValue())
5803         goto trivially_false;
5804       else
5805         goto trivially_true;
5806     }
5807     // Otherwise swap the operands to put the constant on the right.
5808     std::swap(LHS, RHS);
5809     Pred = ICmpInst::getSwappedPredicate(Pred);
5810     Changed = true;
5811   }
5812
5813   // If we're comparing an addrec with a value which is loop-invariant in the
5814   // addrec's loop, put the addrec on the left. Also make a dominance check,
5815   // as both operands could be addrecs loop-invariant in each other's loop.
5816   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS)) {
5817     const Loop *L = AR->getLoop();
5818     if (isLoopInvariant(LHS, L) && properlyDominates(LHS, L->getHeader())) {
5819       std::swap(LHS, RHS);
5820       Pred = ICmpInst::getSwappedPredicate(Pred);
5821       Changed = true;
5822     }
5823   }
5824
5825   // If there's a constant operand, canonicalize comparisons with boundary
5826   // cases, and canonicalize *-or-equal comparisons to regular comparisons.
5827   if (const SCEVConstant *RC = dyn_cast<SCEVConstant>(RHS)) {
5828     const APInt &RA = RC->getValue()->getValue();
5829     switch (Pred) {
5830     default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
5831     case ICmpInst::ICMP_EQ:
5832     case ICmpInst::ICMP_NE:
5833       // Fold ((-1) * %a) + %b == 0 (equivalent to %b-%a == 0) into %a == %b.
5834       if (!RA)
5835         if (const SCEVAddExpr *AE = dyn_cast<SCEVAddExpr>(LHS))
5836           if (const SCEVMulExpr *ME = dyn_cast<SCEVMulExpr>(AE->getOperand(0)))
5837             if (AE->getNumOperands() == 2 && ME->getNumOperands() == 2 &&
5838                 ME->getOperand(0)->isAllOnesValue()) {
5839               RHS = AE->getOperand(1);
5840               LHS = ME->getOperand(1);
5841               Changed = true;
5842             }
5843       break;
5844     case ICmpInst::ICMP_UGE:
5845       if ((RA - 1).isMinValue()) {
5846         Pred = ICmpInst::ICMP_NE;
5847         RHS = getConstant(RA - 1);
5848         Changed = true;
5849         break;
5850       }
5851       if (RA.isMaxValue()) {
5852         Pred = ICmpInst::ICMP_EQ;
5853         Changed = true;
5854         break;
5855       }
5856       if (RA.isMinValue()) goto trivially_true;
5857
5858       Pred = ICmpInst::ICMP_UGT;
5859       RHS = getConstant(RA - 1);
5860       Changed = true;
5861       break;
5862     case ICmpInst::ICMP_ULE:
5863       if ((RA + 1).isMaxValue()) {
5864         Pred = ICmpInst::ICMP_NE;
5865         RHS = getConstant(RA + 1);
5866         Changed = true;
5867         break;
5868       }
5869       if (RA.isMinValue()) {
5870         Pred = ICmpInst::ICMP_EQ;
5871         Changed = true;
5872         break;
5873       }
5874       if (RA.isMaxValue()) goto trivially_true;
5875
5876       Pred = ICmpInst::ICMP_ULT;
5877       RHS = getConstant(RA + 1);
5878       Changed = true;
5879       break;
5880     case ICmpInst::ICMP_SGE:
5881       if ((RA - 1).isMinSignedValue()) {
5882         Pred = ICmpInst::ICMP_NE;
5883         RHS = getConstant(RA - 1);
5884         Changed = true;
5885         break;
5886       }
5887       if (RA.isMaxSignedValue()) {
5888         Pred = ICmpInst::ICMP_EQ;
5889         Changed = true;
5890         break;
5891       }
5892       if (RA.isMinSignedValue()) goto trivially_true;
5893
5894       Pred = ICmpInst::ICMP_SGT;
5895       RHS = getConstant(RA - 1);
5896       Changed = true;
5897       break;
5898     case ICmpInst::ICMP_SLE:
5899       if ((RA + 1).isMaxSignedValue()) {
5900         Pred = ICmpInst::ICMP_NE;
5901         RHS = getConstant(RA + 1);
5902         Changed = true;
5903         break;
5904       }
5905       if (RA.isMinSignedValue()) {
5906         Pred = ICmpInst::ICMP_EQ;
5907         Changed = true;
5908         break;
5909       }
5910       if (RA.isMaxSignedValue()) goto trivially_true;
5911
5912       Pred = ICmpInst::ICMP_SLT;
5913       RHS = getConstant(RA + 1);
5914       Changed = true;
5915       break;
5916     case ICmpInst::ICMP_UGT:
5917       if (RA.isMinValue()) {
5918         Pred = ICmpInst::ICMP_NE;
5919         Changed = true;
5920         break;
5921       }
5922       if ((RA + 1).isMaxValue()) {
5923         Pred = ICmpInst::ICMP_EQ;
5924         RHS = getConstant(RA + 1);
5925         Changed = true;
5926         break;
5927       }
5928       if (RA.isMaxValue()) goto trivially_false;
5929       break;
5930     case ICmpInst::ICMP_ULT:
5931       if (RA.isMaxValue()) {
5932         Pred = ICmpInst::ICMP_NE;
5933         Changed = true;
5934         break;
5935       }
5936       if ((RA - 1).isMinValue()) {
5937         Pred = ICmpInst::ICMP_EQ;
5938         RHS = getConstant(RA - 1);
5939         Changed = true;
5940         break;
5941       }
5942       if (RA.isMinValue()) goto trivially_false;
5943       break;
5944     case ICmpInst::ICMP_SGT:
5945       if (RA.isMinSignedValue()) {
5946         Pred = ICmpInst::ICMP_NE;
5947         Changed = true;
5948         break;
5949       }
5950       if ((RA + 1).isMaxSignedValue()) {
5951         Pred = ICmpInst::ICMP_EQ;
5952         RHS = getConstant(RA + 1);
5953         Changed = true;
5954         break;
5955       }
5956       if (RA.isMaxSignedValue()) goto trivially_false;
5957       break;
5958     case ICmpInst::ICMP_SLT:
5959       if (RA.isMaxSignedValue()) {
5960         Pred = ICmpInst::ICMP_NE;
5961         Changed = true;
5962         break;
5963       }
5964       if ((RA - 1).isMinSignedValue()) {
5965        Pred = ICmpInst::ICMP_EQ;
5966        RHS = getConstant(RA - 1);
5967         Changed = true;
5968        break;
5969       }
5970       if (RA.isMinSignedValue()) goto trivially_false;
5971       break;
5972     }
5973   }
5974
5975   // Check for obvious equality.
5976   if (HasSameValue(LHS, RHS)) {
5977     if (ICmpInst::isTrueWhenEqual(Pred))
5978       goto trivially_true;
5979     if (ICmpInst::isFalseWhenEqual(Pred))
5980       goto trivially_false;
5981   }
5982
5983   // If possible, canonicalize GE/LE comparisons to GT/LT comparisons, by
5984   // adding or subtracting 1 from one of the operands.
5985   switch (Pred) {
5986   case ICmpInst::ICMP_SLE:
5987     if (!getSignedRange(RHS).getSignedMax().isMaxSignedValue()) {
5988       RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
5989                        SCEV::FlagNSW);
5990       Pred = ICmpInst::ICMP_SLT;
5991       Changed = true;
5992     } else if (!getSignedRange(LHS).getSignedMin().isMinSignedValue()) {
5993       LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
5994                        SCEV::FlagNSW);
5995       Pred = ICmpInst::ICMP_SLT;
5996       Changed = true;
5997     }
5998     break;
5999   case ICmpInst::ICMP_SGE:
6000     if (!getSignedRange(RHS).getSignedMin().isMinSignedValue()) {
6001       RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
6002                        SCEV::FlagNSW);
6003       Pred = ICmpInst::ICMP_SGT;
6004       Changed = true;
6005     } else if (!getSignedRange(LHS).getSignedMax().isMaxSignedValue()) {
6006       LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
6007                        SCEV::FlagNSW);
6008       Pred = ICmpInst::ICMP_SGT;
6009       Changed = true;
6010     }
6011     break;
6012   case ICmpInst::ICMP_ULE:
6013     if (!getUnsignedRange(RHS).getUnsignedMax().isMaxValue()) {
6014       RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
6015                        SCEV::FlagNUW);
6016       Pred = ICmpInst::ICMP_ULT;
6017       Changed = true;
6018     } else if (!getUnsignedRange(LHS).getUnsignedMin().isMinValue()) {
6019       LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
6020                        SCEV::FlagNUW);
6021       Pred = ICmpInst::ICMP_ULT;
6022       Changed = true;
6023     }
6024     break;
6025   case ICmpInst::ICMP_UGE:
6026     if (!getUnsignedRange(RHS).getUnsignedMin().isMinValue()) {
6027       RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
6028                        SCEV::FlagNUW);
6029       Pred = ICmpInst::ICMP_UGT;
6030       Changed = true;
6031     } else if (!getUnsignedRange(LHS).getUnsignedMax().isMaxValue()) {
6032       LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
6033                        SCEV::FlagNUW);
6034       Pred = ICmpInst::ICMP_UGT;
6035       Changed = true;
6036     }
6037     break;
6038   default:
6039     break;
6040   }
6041
6042   // TODO: More simplifications are possible here.
6043
6044   // Recursively simplify until we either hit a recursion limit or nothing
6045   // changes.
6046   if (Changed)
6047     return SimplifyICmpOperands(Pred, LHS, RHS, Depth+1);
6048
6049   return Changed;
6050
6051 trivially_true:
6052   // Return 0 == 0.
6053   LHS = RHS = getConstant(ConstantInt::getFalse(getContext()));
6054   Pred = ICmpInst::ICMP_EQ;
6055   return true;
6056
6057 trivially_false:
6058   // Return 0 != 0.
6059   LHS = RHS = getConstant(ConstantInt::getFalse(getContext()));
6060   Pred = ICmpInst::ICMP_NE;
6061   return true;
6062 }
6063
6064 bool ScalarEvolution::isKnownNegative(const SCEV *S) {
6065   return getSignedRange(S).getSignedMax().isNegative();
6066 }
6067
6068 bool ScalarEvolution::isKnownPositive(const SCEV *S) {
6069   return getSignedRange(S).getSignedMin().isStrictlyPositive();
6070 }
6071
6072 bool ScalarEvolution::isKnownNonNegative(const SCEV *S) {
6073   return !getSignedRange(S).getSignedMin().isNegative();
6074 }
6075
6076 bool ScalarEvolution::isKnownNonPositive(const SCEV *S) {
6077   return !getSignedRange(S).getSignedMax().isStrictlyPositive();
6078 }
6079
6080 bool ScalarEvolution::isKnownNonZero(const SCEV *S) {
6081   return isKnownNegative(S) || isKnownPositive(S);
6082 }
6083
6084 bool ScalarEvolution::isKnownPredicate(ICmpInst::Predicate Pred,
6085                                        const SCEV *LHS, const SCEV *RHS) {
6086   // Canonicalize the inputs first.
6087   (void)SimplifyICmpOperands(Pred, LHS, RHS);
6088
6089   // If LHS or RHS is an addrec, check to see if the condition is true in
6090   // every iteration of the loop.
6091   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(LHS))
6092     if (isLoopEntryGuardedByCond(
6093           AR->getLoop(), Pred, AR->getStart(), RHS) &&
6094         isLoopBackedgeGuardedByCond(
6095           AR->getLoop(), Pred, AR->getPostIncExpr(*this), RHS))
6096       return true;
6097   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS))
6098     if (isLoopEntryGuardedByCond(
6099           AR->getLoop(), Pred, LHS, AR->getStart()) &&
6100         isLoopBackedgeGuardedByCond(
6101           AR->getLoop(), Pred, LHS, AR->getPostIncExpr(*this)))
6102       return true;
6103
6104   // Otherwise see what can be done with known constant ranges.
6105   return isKnownPredicateWithRanges(Pred, LHS, RHS);
6106 }
6107
6108 bool
6109 ScalarEvolution::isKnownPredicateWithRanges(ICmpInst::Predicate Pred,
6110                                             const SCEV *LHS, const SCEV *RHS) {
6111   if (HasSameValue(LHS, RHS))
6112     return ICmpInst::isTrueWhenEqual(Pred);
6113
6114   // This code is split out from isKnownPredicate because it is called from
6115   // within isLoopEntryGuardedByCond.
6116   switch (Pred) {
6117   default:
6118     llvm_unreachable("Unexpected ICmpInst::Predicate value!");
6119   case ICmpInst::ICMP_SGT:
6120     Pred = ICmpInst::ICMP_SLT;
6121     std::swap(LHS, RHS);
6122   case ICmpInst::ICMP_SLT: {
6123     ConstantRange LHSRange = getSignedRange(LHS);
6124     ConstantRange RHSRange = getSignedRange(RHS);
6125     if (LHSRange.getSignedMax().slt(RHSRange.getSignedMin()))
6126       return true;
6127     if (LHSRange.getSignedMin().sge(RHSRange.getSignedMax()))
6128       return false;
6129     break;
6130   }
6131   case ICmpInst::ICMP_SGE:
6132     Pred = ICmpInst::ICMP_SLE;
6133     std::swap(LHS, RHS);
6134   case ICmpInst::ICMP_SLE: {
6135     ConstantRange LHSRange = getSignedRange(LHS);
6136     ConstantRange RHSRange = getSignedRange(RHS);
6137     if (LHSRange.getSignedMax().sle(RHSRange.getSignedMin()))
6138       return true;
6139     if (LHSRange.getSignedMin().sgt(RHSRange.getSignedMax()))
6140       return false;
6141     break;
6142   }
6143   case ICmpInst::ICMP_UGT:
6144     Pred = ICmpInst::ICMP_ULT;
6145     std::swap(LHS, RHS);
6146   case ICmpInst::ICMP_ULT: {
6147     ConstantRange LHSRange = getUnsignedRange(LHS);
6148     ConstantRange RHSRange = getUnsignedRange(RHS);
6149     if (LHSRange.getUnsignedMax().ult(RHSRange.getUnsignedMin()))
6150       return true;
6151     if (LHSRange.getUnsignedMin().uge(RHSRange.getUnsignedMax()))
6152       return false;
6153     break;
6154   }
6155   case ICmpInst::ICMP_UGE:
6156     Pred = ICmpInst::ICMP_ULE;
6157     std::swap(LHS, RHS);
6158   case ICmpInst::ICMP_ULE: {
6159     ConstantRange LHSRange = getUnsignedRange(LHS);
6160     ConstantRange RHSRange = getUnsignedRange(RHS);
6161     if (LHSRange.getUnsignedMax().ule(RHSRange.getUnsignedMin()))
6162       return true;
6163     if (LHSRange.getUnsignedMin().ugt(RHSRange.getUnsignedMax()))
6164       return false;
6165     break;
6166   }
6167   case ICmpInst::ICMP_NE: {
6168     if (getUnsignedRange(LHS).intersectWith(getUnsignedRange(RHS)).isEmptySet())
6169       return true;
6170     if (getSignedRange(LHS).intersectWith(getSignedRange(RHS)).isEmptySet())
6171       return true;
6172
6173     const SCEV *Diff = getMinusSCEV(LHS, RHS);
6174     if (isKnownNonZero(Diff))
6175       return true;
6176     break;
6177   }
6178   case ICmpInst::ICMP_EQ:
6179     // The check at the top of the function catches the case where
6180     // the values are known to be equal.
6181     break;
6182   }
6183   return false;
6184 }
6185
6186 /// isLoopBackedgeGuardedByCond - Test whether the backedge of the loop is
6187 /// protected by a conditional between LHS and RHS.  This is used to
6188 /// to eliminate casts.
6189 bool
6190 ScalarEvolution::isLoopBackedgeGuardedByCond(const Loop *L,
6191                                              ICmpInst::Predicate Pred,
6192                                              const SCEV *LHS, const SCEV *RHS) {
6193   // Interpret a null as meaning no loop, where there is obviously no guard
6194   // (interprocedural conditions notwithstanding).
6195   if (!L) return true;
6196
6197   BasicBlock *Latch = L->getLoopLatch();
6198   if (!Latch)
6199     return false;
6200
6201   BranchInst *LoopContinuePredicate =
6202     dyn_cast<BranchInst>(Latch->getTerminator());
6203   if (!LoopContinuePredicate ||
6204       LoopContinuePredicate->isUnconditional())
6205     return false;
6206
6207   return isImpliedCond(Pred, LHS, RHS,
6208                        LoopContinuePredicate->getCondition(),
6209                        LoopContinuePredicate->getSuccessor(0) != L->getHeader());
6210 }
6211
6212 /// isLoopEntryGuardedByCond - Test whether entry to the loop is protected
6213 /// by a conditional between LHS and RHS.  This is used to help avoid max
6214 /// expressions in loop trip counts, and to eliminate casts.
6215 bool
6216 ScalarEvolution::isLoopEntryGuardedByCond(const Loop *L,
6217                                           ICmpInst::Predicate Pred,
6218                                           const SCEV *LHS, const SCEV *RHS) {
6219   // Interpret a null as meaning no loop, where there is obviously no guard
6220   // (interprocedural conditions notwithstanding).
6221   if (!L) return false;
6222
6223   // Starting at the loop predecessor, climb up the predecessor chain, as long
6224   // as there are predecessors that can be found that have unique successors
6225   // leading to the original header.
6226   for (std::pair<BasicBlock *, BasicBlock *>
6227          Pair(L->getLoopPredecessor(), L->getHeader());
6228        Pair.first;
6229        Pair = getPredecessorWithUniqueSuccessorForBB(Pair.first)) {
6230
6231     BranchInst *LoopEntryPredicate =
6232       dyn_cast<BranchInst>(Pair.first->getTerminator());
6233     if (!LoopEntryPredicate ||
6234         LoopEntryPredicate->isUnconditional())
6235       continue;
6236
6237     if (isImpliedCond(Pred, LHS, RHS,
6238                       LoopEntryPredicate->getCondition(),
6239                       LoopEntryPredicate->getSuccessor(0) != Pair.second))
6240       return true;
6241   }
6242
6243   return false;
6244 }
6245
6246 /// RAII wrapper to prevent recursive application of isImpliedCond.
6247 /// ScalarEvolution's PendingLoopPredicates set must be empty unless we are
6248 /// currently evaluating isImpliedCond.
6249 struct MarkPendingLoopPredicate {
6250   Value *Cond;
6251   DenseSet<Value*> &LoopPreds;
6252   bool Pending;
6253
6254   MarkPendingLoopPredicate(Value *C, DenseSet<Value*> &LP)
6255     : Cond(C), LoopPreds(LP) {
6256     Pending = !LoopPreds.insert(Cond).second;
6257   }
6258   ~MarkPendingLoopPredicate() {
6259     if (!Pending)
6260       LoopPreds.erase(Cond);
6261   }
6262 };
6263
6264 /// isImpliedCond - Test whether the condition described by Pred, LHS,
6265 /// and RHS is true whenever the given Cond value evaluates to true.
6266 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred,
6267                                     const SCEV *LHS, const SCEV *RHS,
6268                                     Value *FoundCondValue,
6269                                     bool Inverse) {
6270   MarkPendingLoopPredicate Mark(FoundCondValue, PendingLoopPredicates);
6271   if (Mark.Pending)
6272     return false;
6273
6274   // Recursively handle And and Or conditions.
6275   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(FoundCondValue)) {
6276     if (BO->getOpcode() == Instruction::And) {
6277       if (!Inverse)
6278         return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
6279                isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
6280     } else if (BO->getOpcode() == Instruction::Or) {
6281       if (Inverse)
6282         return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
6283                isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
6284     }
6285   }
6286
6287   ICmpInst *ICI = dyn_cast<ICmpInst>(FoundCondValue);
6288   if (!ICI) return false;
6289
6290   // Bail if the ICmp's operands' types are wider than the needed type
6291   // before attempting to call getSCEV on them. This avoids infinite
6292   // recursion, since the analysis of widening casts can require loop
6293   // exit condition information for overflow checking, which would
6294   // lead back here.
6295   if (getTypeSizeInBits(LHS->getType()) <
6296       getTypeSizeInBits(ICI->getOperand(0)->getType()))
6297     return false;
6298
6299   // Now that we found a conditional branch that dominates the loop or controls
6300   // the loop latch. Check to see if it is the comparison we are looking for.
6301   ICmpInst::Predicate FoundPred;
6302   if (Inverse)
6303     FoundPred = ICI->getInversePredicate();
6304   else
6305     FoundPred = ICI->getPredicate();
6306
6307   const SCEV *FoundLHS = getSCEV(ICI->getOperand(0));
6308   const SCEV *FoundRHS = getSCEV(ICI->getOperand(1));
6309
6310   // Balance the types. The case where FoundLHS' type is wider than
6311   // LHS' type is checked for above.
6312   if (getTypeSizeInBits(LHS->getType()) >
6313       getTypeSizeInBits(FoundLHS->getType())) {
6314     if (CmpInst::isSigned(FoundPred)) {
6315       FoundLHS = getSignExtendExpr(FoundLHS, LHS->getType());
6316       FoundRHS = getSignExtendExpr(FoundRHS, LHS->getType());
6317     } else {
6318       FoundLHS = getZeroExtendExpr(FoundLHS, LHS->getType());
6319       FoundRHS = getZeroExtendExpr(FoundRHS, LHS->getType());
6320     }
6321   }
6322
6323   // Canonicalize the query to match the way instcombine will have
6324   // canonicalized the comparison.
6325   if (SimplifyICmpOperands(Pred, LHS, RHS))
6326     if (LHS == RHS)
6327       return CmpInst::isTrueWhenEqual(Pred);
6328   if (SimplifyICmpOperands(FoundPred, FoundLHS, FoundRHS))
6329     if (FoundLHS == FoundRHS)
6330       return CmpInst::isFalseWhenEqual(FoundPred);
6331
6332   // Check to see if we can make the LHS or RHS match.
6333   if (LHS == FoundRHS || RHS == FoundLHS) {
6334     if (isa<SCEVConstant>(RHS)) {
6335       std::swap(FoundLHS, FoundRHS);
6336       FoundPred = ICmpInst::getSwappedPredicate(FoundPred);
6337     } else {
6338       std::swap(LHS, RHS);
6339       Pred = ICmpInst::getSwappedPredicate(Pred);
6340     }
6341   }
6342
6343   // Check whether the found predicate is the same as the desired predicate.
6344   if (FoundPred == Pred)
6345     return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS);
6346
6347   // Check whether swapping the found predicate makes it the same as the
6348   // desired predicate.
6349   if (ICmpInst::getSwappedPredicate(FoundPred) == Pred) {
6350     if (isa<SCEVConstant>(RHS))
6351       return isImpliedCondOperands(Pred, LHS, RHS, FoundRHS, FoundLHS);
6352     else
6353       return isImpliedCondOperands(ICmpInst::getSwappedPredicate(Pred),
6354                                    RHS, LHS, FoundLHS, FoundRHS);
6355   }
6356
6357   // Check whether the actual condition is beyond sufficient.
6358   if (FoundPred == ICmpInst::ICMP_EQ)
6359     if (ICmpInst::isTrueWhenEqual(Pred))
6360       if (isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS))
6361         return true;
6362   if (Pred == ICmpInst::ICMP_NE)
6363     if (!ICmpInst::isTrueWhenEqual(FoundPred))
6364       if (isImpliedCondOperands(FoundPred, LHS, RHS, FoundLHS, FoundRHS))
6365         return true;
6366
6367   // Otherwise assume the worst.
6368   return false;
6369 }
6370
6371 /// isImpliedCondOperands - Test whether the condition described by Pred,
6372 /// LHS, and RHS is true whenever the condition described by Pred, FoundLHS,
6373 /// and FoundRHS is true.
6374 bool ScalarEvolution::isImpliedCondOperands(ICmpInst::Predicate Pred,
6375                                             const SCEV *LHS, const SCEV *RHS,
6376                                             const SCEV *FoundLHS,
6377                                             const SCEV *FoundRHS) {
6378   return isImpliedCondOperandsHelper(Pred, LHS, RHS,
6379                                      FoundLHS, FoundRHS) ||
6380          // ~x < ~y --> x > y
6381          isImpliedCondOperandsHelper(Pred, LHS, RHS,
6382                                      getNotSCEV(FoundRHS),
6383                                      getNotSCEV(FoundLHS));
6384 }
6385
6386 /// isImpliedCondOperandsHelper - Test whether the condition described by
6387 /// Pred, LHS, and RHS is true whenever the condition described by Pred,
6388 /// FoundLHS, and FoundRHS is true.
6389 bool
6390 ScalarEvolution::isImpliedCondOperandsHelper(ICmpInst::Predicate Pred,
6391                                              const SCEV *LHS, const SCEV *RHS,
6392                                              const SCEV *FoundLHS,
6393                                              const SCEV *FoundRHS) {
6394   switch (Pred) {
6395   default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
6396   case ICmpInst::ICMP_EQ:
6397   case ICmpInst::ICMP_NE:
6398     if (HasSameValue(LHS, FoundLHS) && HasSameValue(RHS, FoundRHS))
6399       return true;
6400     break;
6401   case ICmpInst::ICMP_SLT:
6402   case ICmpInst::ICMP_SLE:
6403     if (isKnownPredicateWithRanges(ICmpInst::ICMP_SLE, LHS, FoundLHS) &&
6404         isKnownPredicateWithRanges(ICmpInst::ICMP_SGE, RHS, FoundRHS))
6405       return true;
6406     break;
6407   case ICmpInst::ICMP_SGT:
6408   case ICmpInst::ICMP_SGE:
6409     if (isKnownPredicateWithRanges(ICmpInst::ICMP_SGE, LHS, FoundLHS) &&
6410         isKnownPredicateWithRanges(ICmpInst::ICMP_SLE, RHS, FoundRHS))
6411       return true;
6412     break;
6413   case ICmpInst::ICMP_ULT:
6414   case ICmpInst::ICMP_ULE:
6415     if (isKnownPredicateWithRanges(ICmpInst::ICMP_ULE, LHS, FoundLHS) &&
6416         isKnownPredicateWithRanges(ICmpInst::ICMP_UGE, RHS, FoundRHS))
6417       return true;
6418     break;
6419   case ICmpInst::ICMP_UGT:
6420   case ICmpInst::ICMP_UGE:
6421     if (isKnownPredicateWithRanges(ICmpInst::ICMP_UGE, LHS, FoundLHS) &&
6422         isKnownPredicateWithRanges(ICmpInst::ICMP_ULE, RHS, FoundRHS))
6423       return true;
6424     break;
6425   }
6426
6427   return false;
6428 }
6429
6430 // Verify if an linear IV with positive stride can overflow when in a
6431 // less-than comparison, knowing the invariant term of the comparison, the
6432 // stride and the knowledge of NSW/NUW flags on the recurrence.
6433 bool ScalarEvolution::doesIVOverflowOnLT(const SCEV *RHS, const SCEV *Stride,
6434                                          bool IsSigned, bool NoWrap) {
6435   if (NoWrap) return false;
6436
6437   unsigned BitWidth = getTypeSizeInBits(RHS->getType());
6438   const SCEV *One = getConstant(Stride->getType(), 1);
6439
6440   if (IsSigned) {
6441     APInt MaxRHS = getSignedRange(RHS).getSignedMax();
6442     APInt MaxValue = APInt::getSignedMaxValue(BitWidth);
6443     APInt MaxStrideMinusOne = getSignedRange(getMinusSCEV(Stride, One))
6444                                 .getSignedMax();
6445
6446     // SMaxRHS + SMaxStrideMinusOne > SMaxValue => overflow!
6447     return (MaxValue - MaxStrideMinusOne).slt(MaxRHS);
6448   }
6449
6450   APInt MaxRHS = getUnsignedRange(RHS).getUnsignedMax();
6451   APInt MaxValue = APInt::getMaxValue(BitWidth);
6452   APInt MaxStrideMinusOne = getUnsignedRange(getMinusSCEV(Stride, One))
6453                               .getUnsignedMax();
6454
6455   // UMaxRHS + UMaxStrideMinusOne > UMaxValue => overflow!
6456   return (MaxValue - MaxStrideMinusOne).ult(MaxRHS);
6457 }
6458
6459 // Verify if an linear IV with negative stride can overflow when in a
6460 // greater-than comparison, knowing the invariant term of the comparison,
6461 // the stride and the knowledge of NSW/NUW flags on the recurrence.
6462 bool ScalarEvolution::doesIVOverflowOnGT(const SCEV *RHS, const SCEV *Stride,
6463                                          bool IsSigned, bool NoWrap) {
6464   if (NoWrap) return false;
6465
6466   unsigned BitWidth = getTypeSizeInBits(RHS->getType());
6467   const SCEV *One = getConstant(Stride->getType(), 1);
6468
6469   if (IsSigned) {
6470     APInt MinRHS = getSignedRange(RHS).getSignedMin();
6471     APInt MinValue = APInt::getSignedMinValue(BitWidth);
6472     APInt MaxStrideMinusOne = getSignedRange(getMinusSCEV(Stride, One))
6473                                .getSignedMax();
6474
6475     // SMinRHS - SMaxStrideMinusOne < SMinValue => overflow!
6476     return (MinValue + MaxStrideMinusOne).sgt(MinRHS);
6477   }
6478
6479   APInt MinRHS = getUnsignedRange(RHS).getUnsignedMin();
6480   APInt MinValue = APInt::getMinValue(BitWidth);
6481   APInt MaxStrideMinusOne = getUnsignedRange(getMinusSCEV(Stride, One))
6482                             .getUnsignedMax();
6483
6484   // UMinRHS - UMaxStrideMinusOne < UMinValue => overflow!
6485   return (MinValue + MaxStrideMinusOne).ugt(MinRHS);
6486 }
6487
6488 // Compute the backedge taken count knowing the interval difference, the
6489 // stride and presence of the equality in the comparison.
6490 const SCEV *ScalarEvolution::computeBECount(const SCEV *Delta, const SCEV *Step,
6491                                             bool Equality) {
6492   const SCEV *One = getConstant(Step->getType(), 1);
6493   Delta = Equality ? getAddExpr(Delta, Step)
6494                    : getAddExpr(Delta, getMinusSCEV(Step, One));
6495   return getUDivExpr(Delta, Step);
6496 }
6497
6498 /// HowManyLessThans - Return the number of times a backedge containing the
6499 /// specified less-than comparison will execute.  If not computable, return
6500 /// CouldNotCompute.
6501 ///
6502 /// @param IsSubExpr is true when the LHS < RHS condition does not directly
6503 /// control the branch. In this case, we can only compute an iteration count for
6504 /// a subexpression that cannot overflow before evaluating true.
6505 ScalarEvolution::ExitLimit
6506 ScalarEvolution::HowManyLessThans(const SCEV *LHS, const SCEV *RHS,
6507                                   const Loop *L, bool IsSigned,
6508                                   bool IsSubExpr) {
6509   // We handle only IV < Invariant
6510   if (!isLoopInvariant(RHS, L))
6511     return getCouldNotCompute();
6512
6513   const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS);
6514
6515   // Avoid weird loops
6516   if (!IV || IV->getLoop() != L || !IV->isAffine())
6517     return getCouldNotCompute();
6518
6519   bool NoWrap = !IsSubExpr &&
6520                 IV->getNoWrapFlags(IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW);
6521
6522   const SCEV *Stride = IV->getStepRecurrence(*this);
6523
6524   // Avoid negative or zero stride values
6525   if (!isKnownPositive(Stride))
6526     return getCouldNotCompute();
6527
6528   // Avoid proven overflow cases: this will ensure that the backedge taken count
6529   // will not generate any unsigned overflow. Relaxed no-overflow conditions
6530   // exploit NoWrapFlags, allowing to optimize in presence of undefined
6531   // behaviors like the case of C language.
6532   if (!Stride->isOne() && doesIVOverflowOnLT(RHS, Stride, IsSigned, NoWrap))
6533     return getCouldNotCompute();
6534
6535   ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SLT
6536                                       : ICmpInst::ICMP_ULT;
6537   const SCEV *Start = IV->getStart();
6538   const SCEV *End = RHS;
6539   if (!isLoopEntryGuardedByCond(L, Cond, getMinusSCEV(Start, Stride), RHS))
6540     End = IsSigned ? getSMaxExpr(RHS, Start)
6541                    : getUMaxExpr(RHS, Start);
6542
6543   const SCEV *BECount = computeBECount(getMinusSCEV(End, Start), Stride, false);
6544
6545   APInt MinStart = IsSigned ? getSignedRange(Start).getSignedMin()
6546                             : getUnsignedRange(Start).getUnsignedMin();
6547
6548   APInt MinStride = IsSigned ? getSignedRange(Stride).getSignedMin()
6549                              : getUnsignedRange(Stride).getUnsignedMin();
6550
6551   unsigned BitWidth = getTypeSizeInBits(LHS->getType());
6552   APInt Limit = IsSigned ? APInt::getSignedMaxValue(BitWidth) - (MinStride - 1)
6553                          : APInt::getMaxValue(BitWidth) - (MinStride - 1);
6554
6555   // Although End can be a MAX expression we estimate MaxEnd considering only
6556   // the case End = RHS. This is safe because in the other case (End - Start)
6557   // is zero, leading to a zero maximum backedge taken count.
6558   APInt MaxEnd =
6559     IsSigned ? APIntOps::smin(getSignedRange(RHS).getSignedMax(), Limit)
6560              : APIntOps::umin(getUnsignedRange(RHS).getUnsignedMax(), Limit);
6561
6562   const SCEV *MaxBECount = getCouldNotCompute();
6563   if (isa<SCEVConstant>(BECount))
6564     MaxBECount = BECount;
6565   else
6566     MaxBECount = computeBECount(getConstant(MaxEnd - MinStart),
6567                                 getConstant(MinStride), false);
6568
6569   if (isa<SCEVCouldNotCompute>(MaxBECount))
6570     MaxBECount = BECount;
6571
6572   return ExitLimit(BECount, MaxBECount, /*MustExit=*/true);
6573 }
6574
6575 ScalarEvolution::ExitLimit
6576 ScalarEvolution::HowManyGreaterThans(const SCEV *LHS, const SCEV *RHS,
6577                                      const Loop *L, bool IsSigned,
6578                                      bool IsSubExpr) {
6579   // We handle only IV > Invariant
6580   if (!isLoopInvariant(RHS, L))
6581     return getCouldNotCompute();
6582
6583   const SCEVAddRecExpr *IV = dyn_cast<SCEVAddRecExpr>(LHS);
6584
6585   // Avoid weird loops
6586   if (!IV || IV->getLoop() != L || !IV->isAffine())
6587     return getCouldNotCompute();
6588
6589   bool NoWrap = !IsSubExpr &&
6590                 IV->getNoWrapFlags(IsSigned ? SCEV::FlagNSW : SCEV::FlagNUW);
6591
6592   const SCEV *Stride = getNegativeSCEV(IV->getStepRecurrence(*this));
6593
6594   // Avoid negative or zero stride values
6595   if (!isKnownPositive(Stride))
6596     return getCouldNotCompute();
6597
6598   // Avoid proven overflow cases: this will ensure that the backedge taken count
6599   // will not generate any unsigned overflow. Relaxed no-overflow conditions
6600   // exploit NoWrapFlags, allowing to optimize in presence of undefined
6601   // behaviors like the case of C language.
6602   if (!Stride->isOne() && doesIVOverflowOnGT(RHS, Stride, IsSigned, NoWrap))
6603     return getCouldNotCompute();
6604
6605   ICmpInst::Predicate Cond = IsSigned ? ICmpInst::ICMP_SGT
6606                                       : ICmpInst::ICMP_UGT;
6607
6608   const SCEV *Start = IV->getStart();
6609   const SCEV *End = RHS;
6610   if (!isLoopEntryGuardedByCond(L, Cond, getAddExpr(Start, Stride), RHS))
6611     End = IsSigned ? getSMinExpr(RHS, Start)
6612                    : getUMinExpr(RHS, Start);
6613
6614   const SCEV *BECount = computeBECount(getMinusSCEV(Start, End), Stride, false);
6615
6616   APInt MaxStart = IsSigned ? getSignedRange(Start).getSignedMax()
6617                             : getUnsignedRange(Start).getUnsignedMax();
6618
6619   APInt MinStride = IsSigned ? getSignedRange(Stride).getSignedMin()
6620                              : getUnsignedRange(Stride).getUnsignedMin();
6621
6622   unsigned BitWidth = getTypeSizeInBits(LHS->getType());
6623   APInt Limit = IsSigned ? APInt::getSignedMinValue(BitWidth) + (MinStride - 1)
6624                          : APInt::getMinValue(BitWidth) + (MinStride - 1);
6625
6626   // Although End can be a MIN expression we estimate MinEnd considering only
6627   // the case End = RHS. This is safe because in the other case (Start - End)
6628   // is zero, leading to a zero maximum backedge taken count.
6629   APInt MinEnd =
6630     IsSigned ? APIntOps::smax(getSignedRange(RHS).getSignedMin(), Limit)
6631              : APIntOps::umax(getUnsignedRange(RHS).getUnsignedMin(), Limit);
6632
6633
6634   const SCEV *MaxBECount = getCouldNotCompute();
6635   if (isa<SCEVConstant>(BECount))
6636     MaxBECount = BECount;
6637   else
6638     MaxBECount = computeBECount(getConstant(MaxStart - MinEnd),
6639                                 getConstant(MinStride), false);
6640
6641   if (isa<SCEVCouldNotCompute>(MaxBECount))
6642     MaxBECount = BECount;
6643
6644   return ExitLimit(BECount, MaxBECount, /*MustExit=*/true);
6645 }
6646
6647 /// getNumIterationsInRange - Return the number of iterations of this loop that
6648 /// produce values in the specified constant range.  Another way of looking at
6649 /// this is that it returns the first iteration number where the value is not in
6650 /// the condition, thus computing the exit count. If the iteration count can't
6651 /// be computed, an instance of SCEVCouldNotCompute is returned.
6652 const SCEV *SCEVAddRecExpr::getNumIterationsInRange(ConstantRange Range,
6653                                                     ScalarEvolution &SE) const {
6654   if (Range.isFullSet())  // Infinite loop.
6655     return SE.getCouldNotCompute();
6656
6657   // If the start is a non-zero constant, shift the range to simplify things.
6658   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(getStart()))
6659     if (!SC->getValue()->isZero()) {
6660       SmallVector<const SCEV *, 4> Operands(op_begin(), op_end());
6661       Operands[0] = SE.getConstant(SC->getType(), 0);
6662       const SCEV *Shifted = SE.getAddRecExpr(Operands, getLoop(),
6663                                              getNoWrapFlags(FlagNW));
6664       if (const SCEVAddRecExpr *ShiftedAddRec =
6665             dyn_cast<SCEVAddRecExpr>(Shifted))
6666         return ShiftedAddRec->getNumIterationsInRange(
6667                            Range.subtract(SC->getValue()->getValue()), SE);
6668       // This is strange and shouldn't happen.
6669       return SE.getCouldNotCompute();
6670     }
6671
6672   // The only time we can solve this is when we have all constant indices.
6673   // Otherwise, we cannot determine the overflow conditions.
6674   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
6675     if (!isa<SCEVConstant>(getOperand(i)))
6676       return SE.getCouldNotCompute();
6677
6678
6679   // Okay at this point we know that all elements of the chrec are constants and
6680   // that the start element is zero.
6681
6682   // First check to see if the range contains zero.  If not, the first
6683   // iteration exits.
6684   unsigned BitWidth = SE.getTypeSizeInBits(getType());
6685   if (!Range.contains(APInt(BitWidth, 0)))
6686     return SE.getConstant(getType(), 0);
6687
6688   if (isAffine()) {
6689     // If this is an affine expression then we have this situation:
6690     //   Solve {0,+,A} in Range  ===  Ax in Range
6691
6692     // We know that zero is in the range.  If A is positive then we know that
6693     // the upper value of the range must be the first possible exit value.
6694     // If A is negative then the lower of the range is the last possible loop
6695     // value.  Also note that we already checked for a full range.
6696     APInt One(BitWidth,1);
6697     APInt A     = cast<SCEVConstant>(getOperand(1))->getValue()->getValue();
6698     APInt End = A.sge(One) ? (Range.getUpper() - One) : Range.getLower();
6699
6700     // The exit value should be (End+A)/A.
6701     APInt ExitVal = (End + A).udiv(A);
6702     ConstantInt *ExitValue = ConstantInt::get(SE.getContext(), ExitVal);
6703
6704     // Evaluate at the exit value.  If we really did fall out of the valid
6705     // range, then we computed our trip count, otherwise wrap around or other
6706     // things must have happened.
6707     ConstantInt *Val = EvaluateConstantChrecAtConstant(this, ExitValue, SE);
6708     if (Range.contains(Val->getValue()))
6709       return SE.getCouldNotCompute();  // Something strange happened
6710
6711     // Ensure that the previous value is in the range.  This is a sanity check.
6712     assert(Range.contains(
6713            EvaluateConstantChrecAtConstant(this,
6714            ConstantInt::get(SE.getContext(), ExitVal - One), SE)->getValue()) &&
6715            "Linear scev computation is off in a bad way!");
6716     return SE.getConstant(ExitValue);
6717   } else if (isQuadratic()) {
6718     // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of the
6719     // quadratic equation to solve it.  To do this, we must frame our problem in
6720     // terms of figuring out when zero is crossed, instead of when
6721     // Range.getUpper() is crossed.
6722     SmallVector<const SCEV *, 4> NewOps(op_begin(), op_end());
6723     NewOps[0] = SE.getNegativeSCEV(SE.getConstant(Range.getUpper()));
6724     const SCEV *NewAddRec = SE.getAddRecExpr(NewOps, getLoop(),
6725                                              // getNoWrapFlags(FlagNW)
6726                                              FlagAnyWrap);
6727
6728     // Next, solve the constructed addrec
6729     std::pair<const SCEV *,const SCEV *> Roots =
6730       SolveQuadraticEquation(cast<SCEVAddRecExpr>(NewAddRec), SE);
6731     const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
6732     const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
6733     if (R1) {
6734       // Pick the smallest positive root value.
6735       if (ConstantInt *CB =
6736           dyn_cast<ConstantInt>(ConstantExpr::getICmp(ICmpInst::ICMP_ULT,
6737                          R1->getValue(), R2->getValue()))) {
6738         if (CB->getZExtValue() == false)
6739           std::swap(R1, R2);   // R1 is the minimum root now.
6740
6741         // Make sure the root is not off by one.  The returned iteration should
6742         // not be in the range, but the previous one should be.  When solving
6743         // for "X*X < 5", for example, we should not return a root of 2.
6744         ConstantInt *R1Val = EvaluateConstantChrecAtConstant(this,
6745                                                              R1->getValue(),
6746                                                              SE);
6747         if (Range.contains(R1Val->getValue())) {
6748           // The next iteration must be out of the range...
6749           ConstantInt *NextVal =
6750                 ConstantInt::get(SE.getContext(), R1->getValue()->getValue()+1);
6751
6752           R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
6753           if (!Range.contains(R1Val->getValue()))
6754             return SE.getConstant(NextVal);
6755           return SE.getCouldNotCompute();  // Something strange happened
6756         }
6757
6758         // If R1 was not in the range, then it is a good return value.  Make
6759         // sure that R1-1 WAS in the range though, just in case.
6760         ConstantInt *NextVal =
6761                ConstantInt::get(SE.getContext(), R1->getValue()->getValue()-1);
6762         R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
6763         if (Range.contains(R1Val->getValue()))
6764           return R1;
6765         return SE.getCouldNotCompute();  // Something strange happened
6766       }
6767     }
6768   }
6769
6770   return SE.getCouldNotCompute();
6771 }
6772
6773 static const APInt srem(const SCEVConstant *C1, const SCEVConstant *C2) {
6774   APInt A = C1->getValue()->getValue();
6775   APInt B = C2->getValue()->getValue();
6776   uint32_t ABW = A.getBitWidth();
6777   uint32_t BBW = B.getBitWidth();
6778
6779   if (ABW > BBW)
6780     B = B.sext(ABW);
6781   else if (ABW < BBW)
6782     A = A.sext(BBW);
6783
6784   return APIntOps::srem(A, B);
6785 }
6786
6787 static const APInt sdiv(const SCEVConstant *C1, const SCEVConstant *C2) {
6788   APInt A = C1->getValue()->getValue();
6789   APInt B = C2->getValue()->getValue();
6790   uint32_t ABW = A.getBitWidth();
6791   uint32_t BBW = B.getBitWidth();
6792
6793   if (ABW > BBW)
6794     B = B.sext(ABW);
6795   else if (ABW < BBW)
6796     A = A.sext(BBW);
6797
6798   return APIntOps::sdiv(A, B);
6799 }
6800
6801 namespace {
6802 struct SCEVGCD : public SCEVVisitor<SCEVGCD, const SCEV *> {
6803 public:
6804   // Pattern match Step into Start. When Step is a multiply expression, find
6805   // the largest subexpression of Step that appears in Start. When Start is an
6806   // add expression, try to match Step in the subexpressions of Start, non
6807   // matching subexpressions are returned under Remainder.
6808   static const SCEV *findGCD(ScalarEvolution &SE, const SCEV *Start,
6809                              const SCEV *Step, const SCEV **Remainder) {
6810     assert(Remainder && "Remainder should not be NULL");
6811     SCEVGCD R(SE, Step, SE.getConstant(Step->getType(), 0));
6812     const SCEV *Res = R.visit(Start);
6813     *Remainder = R.Remainder;
6814     return Res;
6815   }
6816
6817   SCEVGCD(ScalarEvolution &S, const SCEV *G, const SCEV *R)
6818       : SE(S), GCD(G), Remainder(R) {
6819     Zero = SE.getConstant(GCD->getType(), 0);
6820     One = SE.getConstant(GCD->getType(), 1);
6821   }
6822
6823   const SCEV *visitConstant(const SCEVConstant *Constant) {
6824     if (GCD == Constant || Constant == Zero)
6825       return GCD;
6826
6827     if (const SCEVConstant *CGCD = dyn_cast<SCEVConstant>(GCD)) {
6828       const SCEV *Res = SE.getConstant(gcd(Constant, CGCD));
6829       if (Res != One)
6830         return Res;
6831
6832       Remainder = SE.getConstant(srem(Constant, CGCD));
6833       Constant = cast<SCEVConstant>(SE.getMinusSCEV(Constant, Remainder));
6834       Res = SE.getConstant(gcd(Constant, CGCD));
6835       return Res;
6836     }
6837
6838     // When GCD is not a constant, it could be that the GCD is an Add, Mul,
6839     // AddRec, etc., in which case we want to find out how many times the
6840     // Constant divides the GCD: we then return that as the new GCD.
6841     const SCEV *Rem = Zero;
6842     const SCEV *Res = findGCD(SE, GCD, Constant, &Rem);
6843
6844     if (Res == One || Rem != Zero) {
6845       Remainder = Constant;
6846       return One;
6847     }
6848
6849     assert(isa<SCEVConstant>(Res) && "Res should be a constant");
6850     Remainder = SE.getConstant(srem(Constant, cast<SCEVConstant>(Res)));
6851     return Res;
6852   }
6853
6854   const SCEV *visitTruncateExpr(const SCEVTruncateExpr *Expr) {
6855     if (GCD != Expr)
6856       Remainder = Expr;
6857     return GCD;
6858   }
6859
6860   const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *Expr) {
6861     if (GCD != Expr)
6862       Remainder = Expr;
6863     return GCD;
6864   }
6865
6866   const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *Expr) {
6867     if (GCD != Expr)
6868       Remainder = Expr;
6869     return GCD;
6870   }
6871
6872   const SCEV *visitAddExpr(const SCEVAddExpr *Expr) {
6873     if (GCD == Expr)
6874       return GCD;
6875
6876     for (int i = 0, e = Expr->getNumOperands(); i < e; ++i) {
6877       const SCEV *Rem = Zero;
6878       const SCEV *Res = findGCD(SE, Expr->getOperand(e - 1 - i), GCD, &Rem);
6879
6880       // FIXME: There may be ambiguous situations: for instance,
6881       // GCD(-4 + (3 * %m), 2 * %m) where 2 divides -4 and %m divides (3 * %m).
6882       // The order in which the AddExpr is traversed computes a different GCD
6883       // and Remainder.
6884       if (Res != One)
6885         GCD = Res;
6886       if (Rem != Zero)
6887         Remainder = SE.getAddExpr(Remainder, Rem);
6888     }
6889
6890     return GCD;
6891   }
6892
6893   const SCEV *visitMulExpr(const SCEVMulExpr *Expr) {
6894     if (GCD == Expr)
6895       return GCD;
6896
6897     for (int i = 0, e = Expr->getNumOperands(); i < e; ++i) {
6898       if (Expr->getOperand(i) == GCD)
6899         return GCD;
6900     }
6901
6902     // If we have not returned yet, it means that GCD is not part of Expr.
6903     const SCEV *PartialGCD = One;
6904     for (int i = 0, e = Expr->getNumOperands(); i < e; ++i) {
6905       const SCEV *Rem = Zero;
6906       const SCEV *Res = findGCD(SE, Expr->getOperand(i), GCD, &Rem);
6907       if (Rem != Zero)
6908         // GCD does not divide Expr->getOperand(i).
6909         continue;
6910
6911       if (Res == GCD)
6912         return GCD;
6913       PartialGCD = SE.getMulExpr(PartialGCD, Res);
6914       if (PartialGCD == GCD)
6915         return GCD;
6916     }
6917
6918     if (PartialGCD != One)
6919       return PartialGCD;
6920
6921     Remainder = Expr;
6922     const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(GCD);
6923     if (!Mul)
6924       return PartialGCD;
6925
6926     // When the GCD is a multiply expression, try to decompose it:
6927     // this occurs when Step does not divide the Start expression
6928     // as in: {(-4 + (3 * %m)),+,(2 * %m)}
6929     for (int i = 0, e = Mul->getNumOperands(); i < e; ++i) {
6930       const SCEV *Rem = Zero;
6931       const SCEV *Res = findGCD(SE, Expr, Mul->getOperand(i), &Rem);
6932       if (Rem == Zero) {
6933         Remainder = Rem;
6934         return Res;
6935       }
6936     }
6937
6938     return PartialGCD;
6939   }
6940
6941   const SCEV *visitUDivExpr(const SCEVUDivExpr *Expr) {
6942     if (GCD != Expr)
6943       Remainder = Expr;
6944     return GCD;
6945   }
6946
6947   const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) {
6948     if (GCD == Expr)
6949       return GCD;
6950
6951     if (!Expr->isAffine()) {
6952       Remainder = Expr;
6953       return GCD;
6954     }
6955
6956     const SCEV *Rem = Zero;
6957     const SCEV *Res = findGCD(SE, Expr->getOperand(0), GCD, &Rem);
6958     if (Rem != Zero)
6959       Remainder = SE.getAddExpr(Remainder, Rem);
6960
6961     Rem = Zero;
6962     Res = findGCD(SE, Expr->getOperand(1), Res, &Rem);
6963     if (Rem != Zero) {
6964       Remainder = Expr;
6965       return GCD;
6966     }
6967
6968     return Res;
6969   }
6970
6971   const SCEV *visitSMaxExpr(const SCEVSMaxExpr *Expr) {
6972     if (GCD != Expr)
6973       Remainder = Expr;
6974     return GCD;
6975   }
6976
6977   const SCEV *visitUMaxExpr(const SCEVUMaxExpr *Expr) {
6978     if (GCD != Expr)
6979       Remainder = Expr;
6980     return GCD;
6981   }
6982
6983   const SCEV *visitUnknown(const SCEVUnknown *Expr) {
6984     if (GCD != Expr)
6985       Remainder = Expr;
6986     return GCD;
6987   }
6988
6989   const SCEV *visitCouldNotCompute(const SCEVCouldNotCompute *Expr) {
6990     return One;
6991   }
6992
6993 private:
6994   ScalarEvolution &SE;
6995   const SCEV *GCD, *Remainder, *Zero, *One;
6996 };
6997
6998 struct SCEVDivision : public SCEVVisitor<SCEVDivision, const SCEV *> {
6999 public:
7000   // Remove from Start all multiples of Step.
7001   static const SCEV *divide(ScalarEvolution &SE, const SCEV *Start,
7002                             const SCEV *Step) {
7003     SCEVDivision D(SE, Step);
7004     const SCEV *Rem = D.Zero;
7005     (void)Rem;
7006     // The division is guaranteed to succeed: Step should divide Start with no
7007     // remainder.
7008     assert(Step == SCEVGCD::findGCD(SE, Start, Step, &Rem) && Rem == D.Zero &&
7009            "Step should divide Start with no remainder.");
7010     return D.visit(Start);
7011   }
7012
7013   SCEVDivision(ScalarEvolution &S, const SCEV *G) : SE(S), GCD(G) {
7014     Zero = SE.getConstant(GCD->getType(), 0);
7015     One = SE.getConstant(GCD->getType(), 1);
7016   }
7017
7018   const SCEV *visitConstant(const SCEVConstant *Constant) {
7019     if (GCD == Constant)
7020       return One;
7021
7022     if (const SCEVConstant *CGCD = dyn_cast<SCEVConstant>(GCD))
7023       return SE.getConstant(sdiv(Constant, CGCD));
7024     return Constant;
7025   }
7026
7027   const SCEV *visitTruncateExpr(const SCEVTruncateExpr *Expr) {
7028     if (GCD == Expr)
7029       return One;
7030     return Expr;
7031   }
7032
7033   const SCEV *visitZeroExtendExpr(const SCEVZeroExtendExpr *Expr) {
7034     if (GCD == Expr)
7035       return One;
7036     return Expr;
7037   }
7038
7039   const SCEV *visitSignExtendExpr(const SCEVSignExtendExpr *Expr) {
7040     if (GCD == Expr)
7041       return One;
7042     return Expr;
7043   }
7044
7045   const SCEV *visitAddExpr(const SCEVAddExpr *Expr) {
7046     if (GCD == Expr)
7047       return One;
7048
7049     SmallVector<const SCEV *, 2> Operands;
7050     for (int i = 0, e = Expr->getNumOperands(); i < e; ++i)
7051       Operands.push_back(divide(SE, Expr->getOperand(i), GCD));
7052
7053     if (Operands.size() == 1)
7054       return Operands[0];
7055     return SE.getAddExpr(Operands);
7056   }
7057
7058   const SCEV *visitMulExpr(const SCEVMulExpr *Expr) {
7059     if (GCD == Expr)
7060       return One;
7061
7062     bool FoundGCDTerm = false;
7063     for (int i = 0, e = Expr->getNumOperands(); i < e; ++i)
7064       if (Expr->getOperand(i) == GCD)
7065         FoundGCDTerm = true;
7066
7067     SmallVector<const SCEV *, 2> Operands;
7068     if (FoundGCDTerm) {
7069       FoundGCDTerm = false;
7070       for (int i = 0, e = Expr->getNumOperands(); i < e; ++i) {
7071         if (FoundGCDTerm)
7072           Operands.push_back(Expr->getOperand(i));
7073         else if (Expr->getOperand(i) == GCD)
7074           FoundGCDTerm = true;
7075         else
7076           Operands.push_back(Expr->getOperand(i));
7077       }
7078     } else {
7079       FoundGCDTerm = false;
7080       const SCEV *PartialGCD = One;
7081       for (int i = 0, e = Expr->getNumOperands(); i < e; ++i) {
7082         if (PartialGCD == GCD) {
7083           Operands.push_back(Expr->getOperand(i));
7084           continue;
7085         }
7086
7087         const SCEV *Rem = Zero;
7088         const SCEV *Res = SCEVGCD::findGCD(SE, Expr->getOperand(i), GCD, &Rem);
7089         if (Rem == Zero) {
7090           PartialGCD = SE.getMulExpr(PartialGCD, Res);
7091           Operands.push_back(divide(SE, Expr->getOperand(i), GCD));
7092         } else {
7093           Operands.push_back(Expr->getOperand(i));
7094         }
7095       }
7096     }
7097
7098     if (Operands.size() == 1)
7099       return Operands[0];
7100     return SE.getMulExpr(Operands);
7101   }
7102
7103   const SCEV *visitUDivExpr(const SCEVUDivExpr *Expr) {
7104     if (GCD == Expr)
7105       return One;
7106     return Expr;
7107   }
7108
7109   const SCEV *visitAddRecExpr(const SCEVAddRecExpr *Expr) {
7110     if (GCD == Expr)
7111       return One;
7112
7113     assert(Expr->isAffine() && "Expr should be affine");
7114
7115     const SCEV *Start = divide(SE, Expr->getStart(), GCD);
7116     const SCEV *Step = divide(SE, Expr->getStepRecurrence(SE), GCD);
7117
7118     return SE.getAddRecExpr(Start, Step, Expr->getLoop(),
7119                             Expr->getNoWrapFlags());
7120   }
7121
7122   const SCEV *visitSMaxExpr(const SCEVSMaxExpr *Expr) {
7123     if (GCD == Expr)
7124       return One;
7125     return Expr;
7126   }
7127
7128   const SCEV *visitUMaxExpr(const SCEVUMaxExpr *Expr) {
7129     if (GCD == Expr)
7130       return One;
7131     return Expr;
7132   }
7133
7134   const SCEV *visitUnknown(const SCEVUnknown *Expr) {
7135     if (GCD == Expr)
7136       return One;
7137     return Expr;
7138   }
7139
7140   const SCEV *visitCouldNotCompute(const SCEVCouldNotCompute *Expr) {
7141     return Expr;
7142   }
7143
7144 private:
7145   ScalarEvolution &SE;
7146   const SCEV *GCD, *Zero, *One;
7147 };
7148 }
7149
7150 /// Splits the SCEV into two vectors of SCEVs representing the subscripts and
7151 /// sizes of an array access. Returns the remainder of the delinearization that
7152 /// is the offset start of the array.  The SCEV->delinearize algorithm computes
7153 /// the multiples of SCEV coefficients: that is a pattern matching of sub
7154 /// expressions in the stride and base of a SCEV corresponding to the
7155 /// computation of a GCD (greatest common divisor) of base and stride.  When
7156 /// SCEV->delinearize fails, it returns the SCEV unchanged.
7157 ///
7158 /// For example: when analyzing the memory access A[i][j][k] in this loop nest
7159 ///
7160 ///  void foo(long n, long m, long o, double A[n][m][o]) {
7161 ///
7162 ///    for (long i = 0; i < n; i++)
7163 ///      for (long j = 0; j < m; j++)
7164 ///        for (long k = 0; k < o; k++)
7165 ///          A[i][j][k] = 1.0;
7166 ///  }
7167 ///
7168 /// the delinearization input is the following AddRec SCEV:
7169 ///
7170 ///  AddRec: {{{%A,+,(8 * %m * %o)}<%for.i>,+,(8 * %o)}<%for.j>,+,8}<%for.k>
7171 ///
7172 /// From this SCEV, we are able to say that the base offset of the access is %A
7173 /// because it appears as an offset that does not divide any of the strides in
7174 /// the loops:
7175 ///
7176 ///  CHECK: Base offset: %A
7177 ///
7178 /// and then SCEV->delinearize determines the size of some of the dimensions of
7179 /// the array as these are the multiples by which the strides are happening:
7180 ///
7181 ///  CHECK: ArrayDecl[UnknownSize][%m][%o] with elements of sizeof(double) bytes.
7182 ///
7183 /// Note that the outermost dimension remains of UnknownSize because there are
7184 /// no strides that would help identifying the size of the last dimension: when
7185 /// the array has been statically allocated, one could compute the size of that
7186 /// dimension by dividing the overall size of the array by the size of the known
7187 /// dimensions: %m * %o * 8.
7188 ///
7189 /// Finally delinearize provides the access functions for the array reference
7190 /// that does correspond to A[i][j][k] of the above C testcase:
7191 ///
7192 ///  CHECK: ArrayRef[{0,+,1}<%for.i>][{0,+,1}<%for.j>][{0,+,1}<%for.k>]
7193 ///
7194 /// The testcases are checking the output of a function pass:
7195 /// DelinearizationPass that walks through all loads and stores of a function
7196 /// asking for the SCEV of the memory access with respect to all enclosing
7197 /// loops, calling SCEV->delinearize on that and printing the results.
7198
7199 const SCEV *
7200 SCEVAddRecExpr::delinearize(ScalarEvolution &SE,
7201                             SmallVectorImpl<const SCEV *> &Subscripts,
7202                             SmallVectorImpl<const SCEV *> &Sizes) const {
7203   // Early exit in case this SCEV is not an affine multivariate function.
7204   if (!this->isAffine())
7205     return this;
7206
7207   const SCEV *Start = this->getStart();
7208   const SCEV *Step = this->getStepRecurrence(SE);
7209
7210   // Build the SCEV representation of the canonical induction variable in the
7211   // loop of this SCEV.
7212   const SCEV *Zero = SE.getConstant(this->getType(), 0);
7213   const SCEV *One = SE.getConstant(this->getType(), 1);
7214   const SCEV *IV =
7215       SE.getAddRecExpr(Zero, One, this->getLoop(), this->getNoWrapFlags());
7216
7217   DEBUG(dbgs() << "(delinearize: " << *this << "\n");
7218
7219   // Currently we fail to delinearize when the stride of this SCEV is 1. We
7220   // could decide to not fail in this case: we could just return 1 for the size
7221   // of the subscript, and this same SCEV for the access function.
7222   if (Step == One) {
7223     DEBUG(dbgs() << "failed to delinearize " << *this << "\n)\n");
7224     return this;
7225   }
7226
7227   // Find the GCD and Remainder of the Start and Step coefficients of this SCEV.
7228   const SCEV *Remainder = NULL;
7229   const SCEV *GCD = SCEVGCD::findGCD(SE, Start, Step, &Remainder);
7230
7231   DEBUG(dbgs() << "GCD: " << *GCD << "\n");
7232   DEBUG(dbgs() << "Remainder: " << *Remainder << "\n");
7233
7234   // Same remark as above: we currently fail the delinearization, although we
7235   // can very well handle this special case.
7236   if (GCD == One) {
7237     DEBUG(dbgs() << "failed to delinearize " << *this << "\n)\n");
7238     return this;
7239   }
7240
7241   // As findGCD computed Remainder, GCD divides "Start - Remainder." The
7242   // Quotient is then this SCEV without Remainder, scaled down by the GCD.  The
7243   // Quotient is what will be used in the next subscript delinearization.
7244   const SCEV *Quotient =
7245       SCEVDivision::divide(SE, SE.getMinusSCEV(Start, Remainder), GCD);
7246   DEBUG(dbgs() << "Quotient: " << *Quotient << "\n");
7247
7248   const SCEV *Rem;
7249   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Quotient))
7250     // Recursively call delinearize on the Quotient until there are no more
7251     // multiples that can be recognized.
7252     Rem = AR->delinearize(SE, Subscripts, Sizes);
7253   else
7254     Rem = Quotient;
7255
7256   // Scale up the canonical induction variable IV by whatever remains from the
7257   // Step after division by the GCD: the GCD is the size of all the sub-array.
7258   if (Step != GCD) {
7259     Step = SCEVDivision::divide(SE, Step, GCD);
7260     IV = SE.getMulExpr(IV, Step);
7261   }
7262   // The access function in the current subscript is computed as the canonical
7263   // induction variable IV (potentially scaled up by the step) and offset by
7264   // Rem, the offset of delinearization in the sub-array.
7265   const SCEV *Index = SE.getAddExpr(IV, Rem);
7266
7267   // Record the access function and the size of the current subscript.
7268   Subscripts.push_back(Index);
7269   Sizes.push_back(GCD);
7270
7271 #ifndef NDEBUG
7272   int Size = Sizes.size();
7273   DEBUG(dbgs() << "succeeded to delinearize " << *this << "\n");
7274   DEBUG(dbgs() << "ArrayDecl[UnknownSize]");
7275   for (int i = 0; i < Size - 1; i++)
7276     DEBUG(dbgs() << "[" << *Sizes[i] << "]");
7277   DEBUG(dbgs() << " with elements of " << *Sizes[Size - 1] << " bytes.\n");
7278
7279   DEBUG(dbgs() << "ArrayRef");
7280   for (int i = 0; i < Size; i++)
7281     DEBUG(dbgs() << "[" << *Subscripts[i] << "]");
7282   DEBUG(dbgs() << "\n)\n");
7283 #endif
7284
7285   return Remainder;
7286 }
7287
7288 //===----------------------------------------------------------------------===//
7289 //                   SCEVCallbackVH Class Implementation
7290 //===----------------------------------------------------------------------===//
7291
7292 void ScalarEvolution::SCEVCallbackVH::deleted() {
7293   assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
7294   if (PHINode *PN = dyn_cast<PHINode>(getValPtr()))
7295     SE->ConstantEvolutionLoopExitValue.erase(PN);
7296   SE->ValueExprMap.erase(getValPtr());
7297   // this now dangles!
7298 }
7299
7300 void ScalarEvolution::SCEVCallbackVH::allUsesReplacedWith(Value *V) {
7301   assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
7302
7303   // Forget all the expressions associated with users of the old value,
7304   // so that future queries will recompute the expressions using the new
7305   // value.
7306   Value *Old = getValPtr();
7307   SmallVector<User *, 16> Worklist;
7308   SmallPtrSet<User *, 8> Visited;
7309   for (Value::use_iterator UI = Old->use_begin(), UE = Old->use_end();
7310        UI != UE; ++UI)
7311     Worklist.push_back(*UI);
7312   while (!Worklist.empty()) {
7313     User *U = Worklist.pop_back_val();
7314     // Deleting the Old value will cause this to dangle. Postpone
7315     // that until everything else is done.
7316     if (U == Old)
7317       continue;
7318     if (!Visited.insert(U))
7319       continue;
7320     if (PHINode *PN = dyn_cast<PHINode>(U))
7321       SE->ConstantEvolutionLoopExitValue.erase(PN);
7322     SE->ValueExprMap.erase(U);
7323     for (Value::use_iterator UI = U->use_begin(), UE = U->use_end();
7324          UI != UE; ++UI)
7325       Worklist.push_back(*UI);
7326   }
7327   // Delete the Old value.
7328   if (PHINode *PN = dyn_cast<PHINode>(Old))
7329     SE->ConstantEvolutionLoopExitValue.erase(PN);
7330   SE->ValueExprMap.erase(Old);
7331   // this now dangles!
7332 }
7333
7334 ScalarEvolution::SCEVCallbackVH::SCEVCallbackVH(Value *V, ScalarEvolution *se)
7335   : CallbackVH(V), SE(se) {}
7336
7337 //===----------------------------------------------------------------------===//
7338 //                   ScalarEvolution Class Implementation
7339 //===----------------------------------------------------------------------===//
7340
7341 ScalarEvolution::ScalarEvolution()
7342   : FunctionPass(ID), ValuesAtScopes(64), LoopDispositions(64), BlockDispositions(64), FirstUnknown(0) {
7343   initializeScalarEvolutionPass(*PassRegistry::getPassRegistry());
7344 }
7345
7346 bool ScalarEvolution::runOnFunction(Function &F) {
7347   this->F = &F;
7348   LI = &getAnalysis<LoopInfo>();
7349   TD = getAnalysisIfAvailable<DataLayout>();
7350   TLI = &getAnalysis<TargetLibraryInfo>();
7351   DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
7352   return false;
7353 }
7354
7355 void ScalarEvolution::releaseMemory() {
7356   // Iterate through all the SCEVUnknown instances and call their
7357   // destructors, so that they release their references to their values.
7358   for (SCEVUnknown *U = FirstUnknown; U; U = U->Next)
7359     U->~SCEVUnknown();
7360   FirstUnknown = 0;
7361
7362   ValueExprMap.clear();
7363
7364   // Free any extra memory created for ExitNotTakenInfo in the unlikely event
7365   // that a loop had multiple computable exits.
7366   for (DenseMap<const Loop*, BackedgeTakenInfo>::iterator I =
7367          BackedgeTakenCounts.begin(), E = BackedgeTakenCounts.end();
7368        I != E; ++I) {
7369     I->second.clear();
7370   }
7371
7372   assert(PendingLoopPredicates.empty() && "isImpliedCond garbage");
7373
7374   BackedgeTakenCounts.clear();
7375   ConstantEvolutionLoopExitValue.clear();
7376   ValuesAtScopes.clear();
7377   LoopDispositions.clear();
7378   BlockDispositions.clear();
7379   UnsignedRanges.clear();
7380   SignedRanges.clear();
7381   UniqueSCEVs.clear();
7382   SCEVAllocator.Reset();
7383 }
7384
7385 void ScalarEvolution::getAnalysisUsage(AnalysisUsage &AU) const {
7386   AU.setPreservesAll();
7387   AU.addRequiredTransitive<LoopInfo>();
7388   AU.addRequiredTransitive<DominatorTreeWrapperPass>();
7389   AU.addRequired<TargetLibraryInfo>();
7390 }
7391
7392 bool ScalarEvolution::hasLoopInvariantBackedgeTakenCount(const Loop *L) {
7393   return !isa<SCEVCouldNotCompute>(getBackedgeTakenCount(L));
7394 }
7395
7396 static void PrintLoopInfo(raw_ostream &OS, ScalarEvolution *SE,
7397                           const Loop *L) {
7398   // Print all inner loops first
7399   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
7400     PrintLoopInfo(OS, SE, *I);
7401
7402   OS << "Loop ";
7403   L->getHeader()->printAsOperand(OS, /*PrintType=*/false);
7404   OS << ": ";
7405
7406   SmallVector<BasicBlock *, 8> ExitBlocks;
7407   L->getExitBlocks(ExitBlocks);
7408   if (ExitBlocks.size() != 1)
7409     OS << "<multiple exits> ";
7410
7411   if (SE->hasLoopInvariantBackedgeTakenCount(L)) {
7412     OS << "backedge-taken count is " << *SE->getBackedgeTakenCount(L);
7413   } else {
7414     OS << "Unpredictable backedge-taken count. ";
7415   }
7416
7417   OS << "\n"
7418         "Loop ";
7419   L->getHeader()->printAsOperand(OS, /*PrintType=*/false);
7420   OS << ": ";
7421
7422   if (!isa<SCEVCouldNotCompute>(SE->getMaxBackedgeTakenCount(L))) {
7423     OS << "max backedge-taken count is " << *SE->getMaxBackedgeTakenCount(L);
7424   } else {
7425     OS << "Unpredictable max backedge-taken count. ";
7426   }
7427
7428   OS << "\n";
7429 }
7430
7431 void ScalarEvolution::print(raw_ostream &OS, const Module *) const {
7432   // ScalarEvolution's implementation of the print method is to print
7433   // out SCEV values of all instructions that are interesting. Doing
7434   // this potentially causes it to create new SCEV objects though,
7435   // which technically conflicts with the const qualifier. This isn't
7436   // observable from outside the class though, so casting away the
7437   // const isn't dangerous.
7438   ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
7439
7440   OS << "Classifying expressions for: ";
7441   F->printAsOperand(OS, /*PrintType=*/false);
7442   OS << "\n";
7443   for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
7444     if (isSCEVable(I->getType()) && !isa<CmpInst>(*I)) {
7445       OS << *I << '\n';
7446       OS << "  -->  ";
7447       const SCEV *SV = SE.getSCEV(&*I);
7448       SV->print(OS);
7449
7450       const Loop *L = LI->getLoopFor((*I).getParent());
7451
7452       const SCEV *AtUse = SE.getSCEVAtScope(SV, L);
7453       if (AtUse != SV) {
7454         OS << "  -->  ";
7455         AtUse->print(OS);
7456       }
7457
7458       if (L) {
7459         OS << "\t\t" "Exits: ";
7460         const SCEV *ExitValue = SE.getSCEVAtScope(SV, L->getParentLoop());
7461         if (!SE.isLoopInvariant(ExitValue, L)) {
7462           OS << "<<Unknown>>";
7463         } else {
7464           OS << *ExitValue;
7465         }
7466       }
7467
7468       OS << "\n";
7469     }
7470
7471   OS << "Determining loop execution counts for: ";
7472   F->printAsOperand(OS, /*PrintType=*/false);
7473   OS << "\n";
7474   for (LoopInfo::iterator I = LI->begin(), E = LI->end(); I != E; ++I)
7475     PrintLoopInfo(OS, &SE, *I);
7476 }
7477
7478 ScalarEvolution::LoopDisposition
7479 ScalarEvolution::getLoopDisposition(const SCEV *S, const Loop *L) {
7480   SmallVector<std::pair<const Loop *, LoopDisposition>, 2> &Values = LoopDispositions[S];
7481   for (unsigned u = 0; u < Values.size(); u++) {
7482     if (Values[u].first == L)
7483       return Values[u].second;
7484   }
7485   Values.push_back(std::make_pair(L, LoopVariant));
7486   LoopDisposition D = computeLoopDisposition(S, L);
7487   SmallVector<std::pair<const Loop *, LoopDisposition>, 2> &Values2 = LoopDispositions[S];
7488   for (unsigned u = Values2.size(); u > 0; u--) {
7489     if (Values2[u - 1].first == L) {
7490       Values2[u - 1].second = D;
7491       break;
7492     }
7493   }
7494   return D;
7495 }
7496
7497 ScalarEvolution::LoopDisposition
7498 ScalarEvolution::computeLoopDisposition(const SCEV *S, const Loop *L) {
7499   switch (S->getSCEVType()) {
7500   case scConstant:
7501     return LoopInvariant;
7502   case scTruncate:
7503   case scZeroExtend:
7504   case scSignExtend:
7505     return getLoopDisposition(cast<SCEVCastExpr>(S)->getOperand(), L);
7506   case scAddRecExpr: {
7507     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S);
7508
7509     // If L is the addrec's loop, it's computable.
7510     if (AR->getLoop() == L)
7511       return LoopComputable;
7512
7513     // Add recurrences are never invariant in the function-body (null loop).
7514     if (!L)
7515       return LoopVariant;
7516
7517     // This recurrence is variant w.r.t. L if L contains AR's loop.
7518     if (L->contains(AR->getLoop()))
7519       return LoopVariant;
7520
7521     // This recurrence is invariant w.r.t. L if AR's loop contains L.
7522     if (AR->getLoop()->contains(L))
7523       return LoopInvariant;
7524
7525     // This recurrence is variant w.r.t. L if any of its operands
7526     // are variant.
7527     for (SCEVAddRecExpr::op_iterator I = AR->op_begin(), E = AR->op_end();
7528          I != E; ++I)
7529       if (!isLoopInvariant(*I, L))
7530         return LoopVariant;
7531
7532     // Otherwise it's loop-invariant.
7533     return LoopInvariant;
7534   }
7535   case scAddExpr:
7536   case scMulExpr:
7537   case scUMaxExpr:
7538   case scSMaxExpr: {
7539     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S);
7540     bool HasVarying = false;
7541     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
7542          I != E; ++I) {
7543       LoopDisposition D = getLoopDisposition(*I, L);
7544       if (D == LoopVariant)
7545         return LoopVariant;
7546       if (D == LoopComputable)
7547         HasVarying = true;
7548     }
7549     return HasVarying ? LoopComputable : LoopInvariant;
7550   }
7551   case scUDivExpr: {
7552     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
7553     LoopDisposition LD = getLoopDisposition(UDiv->getLHS(), L);
7554     if (LD == LoopVariant)
7555       return LoopVariant;
7556     LoopDisposition RD = getLoopDisposition(UDiv->getRHS(), L);
7557     if (RD == LoopVariant)
7558       return LoopVariant;
7559     return (LD == LoopInvariant && RD == LoopInvariant) ?
7560            LoopInvariant : LoopComputable;
7561   }
7562   case scUnknown:
7563     // All non-instruction values are loop invariant.  All instructions are loop
7564     // invariant if they are not contained in the specified loop.
7565     // Instructions are never considered invariant in the function body
7566     // (null loop) because they are defined within the "loop".
7567     if (Instruction *I = dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue()))
7568       return (L && !L->contains(I)) ? LoopInvariant : LoopVariant;
7569     return LoopInvariant;
7570   case scCouldNotCompute:
7571     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
7572   default: llvm_unreachable("Unknown SCEV kind!");
7573   }
7574 }
7575
7576 bool ScalarEvolution::isLoopInvariant(const SCEV *S, const Loop *L) {
7577   return getLoopDisposition(S, L) == LoopInvariant;
7578 }
7579
7580 bool ScalarEvolution::hasComputableLoopEvolution(const SCEV *S, const Loop *L) {
7581   return getLoopDisposition(S, L) == LoopComputable;
7582 }
7583
7584 ScalarEvolution::BlockDisposition
7585 ScalarEvolution::getBlockDisposition(const SCEV *S, const BasicBlock *BB) {
7586   SmallVector<std::pair<const BasicBlock *, BlockDisposition>, 2> &Values = BlockDispositions[S];
7587   for (unsigned u = 0; u < Values.size(); u++) {
7588     if (Values[u].first == BB)
7589       return Values[u].second;
7590   }
7591   Values.push_back(std::make_pair(BB, DoesNotDominateBlock));
7592   BlockDisposition D = computeBlockDisposition(S, BB);
7593   SmallVector<std::pair<const BasicBlock *, BlockDisposition>, 2> &Values2 = BlockDispositions[S];
7594   for (unsigned u = Values2.size(); u > 0; u--) {
7595     if (Values2[u - 1].first == BB) {
7596       Values2[u - 1].second = D;
7597       break;
7598     }
7599   }
7600   return D;
7601 }
7602
7603 ScalarEvolution::BlockDisposition
7604 ScalarEvolution::computeBlockDisposition(const SCEV *S, const BasicBlock *BB) {
7605   switch (S->getSCEVType()) {
7606   case scConstant:
7607     return ProperlyDominatesBlock;
7608   case scTruncate:
7609   case scZeroExtend:
7610   case scSignExtend:
7611     return getBlockDisposition(cast<SCEVCastExpr>(S)->getOperand(), BB);
7612   case scAddRecExpr: {
7613     // This uses a "dominates" query instead of "properly dominates" query
7614     // to test for proper dominance too, because the instruction which
7615     // produces the addrec's value is a PHI, and a PHI effectively properly
7616     // dominates its entire containing block.
7617     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S);
7618     if (!DT->dominates(AR->getLoop()->getHeader(), BB))
7619       return DoesNotDominateBlock;
7620   }
7621   // FALL THROUGH into SCEVNAryExpr handling.
7622   case scAddExpr:
7623   case scMulExpr:
7624   case scUMaxExpr:
7625   case scSMaxExpr: {
7626     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S);
7627     bool Proper = true;
7628     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
7629          I != E; ++I) {
7630       BlockDisposition D = getBlockDisposition(*I, BB);
7631       if (D == DoesNotDominateBlock)
7632         return DoesNotDominateBlock;
7633       if (D == DominatesBlock)
7634         Proper = false;
7635     }
7636     return Proper ? ProperlyDominatesBlock : DominatesBlock;
7637   }
7638   case scUDivExpr: {
7639     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
7640     const SCEV *LHS = UDiv->getLHS(), *RHS = UDiv->getRHS();
7641     BlockDisposition LD = getBlockDisposition(LHS, BB);
7642     if (LD == DoesNotDominateBlock)
7643       return DoesNotDominateBlock;
7644     BlockDisposition RD = getBlockDisposition(RHS, BB);
7645     if (RD == DoesNotDominateBlock)
7646       return DoesNotDominateBlock;
7647     return (LD == ProperlyDominatesBlock && RD == ProperlyDominatesBlock) ?
7648       ProperlyDominatesBlock : DominatesBlock;
7649   }
7650   case scUnknown:
7651     if (Instruction *I =
7652           dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue())) {
7653       if (I->getParent() == BB)
7654         return DominatesBlock;
7655       if (DT->properlyDominates(I->getParent(), BB))
7656         return ProperlyDominatesBlock;
7657       return DoesNotDominateBlock;
7658     }
7659     return ProperlyDominatesBlock;
7660   case scCouldNotCompute:
7661     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
7662   default:
7663     llvm_unreachable("Unknown SCEV kind!");
7664   }
7665 }
7666
7667 bool ScalarEvolution::dominates(const SCEV *S, const BasicBlock *BB) {
7668   return getBlockDisposition(S, BB) >= DominatesBlock;
7669 }
7670
7671 bool ScalarEvolution::properlyDominates(const SCEV *S, const BasicBlock *BB) {
7672   return getBlockDisposition(S, BB) == ProperlyDominatesBlock;
7673 }
7674
7675 namespace {
7676 // Search for a SCEV expression node within an expression tree.
7677 // Implements SCEVTraversal::Visitor.
7678 struct SCEVSearch {
7679   const SCEV *Node;
7680   bool IsFound;
7681
7682   SCEVSearch(const SCEV *N): Node(N), IsFound(false) {}
7683
7684   bool follow(const SCEV *S) {
7685     IsFound |= (S == Node);
7686     return !IsFound;
7687   }
7688   bool isDone() const { return IsFound; }
7689 };
7690 }
7691
7692 bool ScalarEvolution::hasOperand(const SCEV *S, const SCEV *Op) const {
7693   SCEVSearch Search(Op);
7694   visitAll(S, Search);
7695   return Search.IsFound;
7696 }
7697
7698 void ScalarEvolution::forgetMemoizedResults(const SCEV *S) {
7699   ValuesAtScopes.erase(S);
7700   LoopDispositions.erase(S);
7701   BlockDispositions.erase(S);
7702   UnsignedRanges.erase(S);
7703   SignedRanges.erase(S);
7704
7705   for (DenseMap<const Loop*, BackedgeTakenInfo>::iterator I =
7706          BackedgeTakenCounts.begin(), E = BackedgeTakenCounts.end(); I != E; ) {
7707     BackedgeTakenInfo &BEInfo = I->second;
7708     if (BEInfo.hasOperand(S, this)) {
7709       BEInfo.clear();
7710       BackedgeTakenCounts.erase(I++);
7711     }
7712     else
7713       ++I;
7714   }
7715 }
7716
7717 typedef DenseMap<const Loop *, std::string> VerifyMap;
7718
7719 /// replaceSubString - Replaces all occurrences of From in Str with To.
7720 static void replaceSubString(std::string &Str, StringRef From, StringRef To) {
7721   size_t Pos = 0;
7722   while ((Pos = Str.find(From, Pos)) != std::string::npos) {
7723     Str.replace(Pos, From.size(), To.data(), To.size());
7724     Pos += To.size();
7725   }
7726 }
7727
7728 /// getLoopBackedgeTakenCounts - Helper method for verifyAnalysis.
7729 static void
7730 getLoopBackedgeTakenCounts(Loop *L, VerifyMap &Map, ScalarEvolution &SE) {
7731   for (Loop::reverse_iterator I = L->rbegin(), E = L->rend(); I != E; ++I) {
7732     getLoopBackedgeTakenCounts(*I, Map, SE); // recurse.
7733
7734     std::string &S = Map[L];
7735     if (S.empty()) {
7736       raw_string_ostream OS(S);
7737       SE.getBackedgeTakenCount(L)->print(OS);
7738
7739       // false and 0 are semantically equivalent. This can happen in dead loops.
7740       replaceSubString(OS.str(), "false", "0");
7741       // Remove wrap flags, their use in SCEV is highly fragile.
7742       // FIXME: Remove this when SCEV gets smarter about them.
7743       replaceSubString(OS.str(), "<nw>", "");
7744       replaceSubString(OS.str(), "<nsw>", "");
7745       replaceSubString(OS.str(), "<nuw>", "");
7746     }
7747   }
7748 }
7749
7750 void ScalarEvolution::verifyAnalysis() const {
7751   if (!VerifySCEV)
7752     return;
7753
7754   ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
7755
7756   // Gather stringified backedge taken counts for all loops using SCEV's caches.
7757   // FIXME: It would be much better to store actual values instead of strings,
7758   //        but SCEV pointers will change if we drop the caches.
7759   VerifyMap BackedgeDumpsOld, BackedgeDumpsNew;
7760   for (LoopInfo::reverse_iterator I = LI->rbegin(), E = LI->rend(); I != E; ++I)
7761     getLoopBackedgeTakenCounts(*I, BackedgeDumpsOld, SE);
7762
7763   // Gather stringified backedge taken counts for all loops without using
7764   // SCEV's caches.
7765   SE.releaseMemory();
7766   for (LoopInfo::reverse_iterator I = LI->rbegin(), E = LI->rend(); I != E; ++I)
7767     getLoopBackedgeTakenCounts(*I, BackedgeDumpsNew, SE);
7768
7769   // Now compare whether they're the same with and without caches. This allows
7770   // verifying that no pass changed the cache.
7771   assert(BackedgeDumpsOld.size() == BackedgeDumpsNew.size() &&
7772          "New loops suddenly appeared!");
7773
7774   for (VerifyMap::iterator OldI = BackedgeDumpsOld.begin(),
7775                            OldE = BackedgeDumpsOld.end(),
7776                            NewI = BackedgeDumpsNew.begin();
7777        OldI != OldE; ++OldI, ++NewI) {
7778     assert(OldI->first == NewI->first && "Loop order changed!");
7779
7780     // Compare the stringified SCEVs. We don't care if undef backedgetaken count
7781     // changes.
7782     // FIXME: We currently ignore SCEV changes from/to CouldNotCompute. This
7783     // means that a pass is buggy or SCEV has to learn a new pattern but is
7784     // usually not harmful.
7785     if (OldI->second != NewI->second &&
7786         OldI->second.find("undef") == std::string::npos &&
7787         NewI->second.find("undef") == std::string::npos &&
7788         OldI->second != "***COULDNOTCOMPUTE***" &&
7789         NewI->second != "***COULDNOTCOMPUTE***") {
7790       dbgs() << "SCEVValidator: SCEV for loop '"
7791              << OldI->first->getHeader()->getName()
7792              << "' changed from '" << OldI->second
7793              << "' to '" << NewI->second << "'!\n";
7794       std::abort();
7795     }
7796   }
7797
7798   // TODO: Verify more things.
7799 }