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/ScalarEvolutionExpressions.h"
  63 #include "llvm/Constants.h"
  64 #include "llvm/DerivedTypes.h"
  65 #include "llvm/GlobalVariable.h"
  66 #include "llvm/GlobalAlias.h"
  67 #include "llvm/Instructions.h"
  68 #include "llvm/LLVMContext.h"
  69 #include "llvm/Operator.h"
  70 #include "llvm/Analysis/ConstantFolding.h"
  71 #include "llvm/Analysis/Dominators.h"
  72 #include "llvm/Analysis/InstructionSimplify.h"
  73 #include "llvm/Analysis/LoopInfo.h"
  74 #include "llvm/Analysis/ValueTracking.h"
  75 #include "llvm/Assembly/Writer.h"
  76 #include "llvm/Target/TargetData.h"
  77 #include "llvm/Support/CommandLine.h"
  78 #include "llvm/Support/ConstantRange.h"
  79 #include "llvm/Support/Debug.h"
  80 #include "llvm/Support/ErrorHandling.h"
  81 #include "llvm/Support/GetElementPtrTypeIterator.h"
  82 #include "llvm/Support/InstIterator.h"
  83 #include "llvm/Support/MathExtras.h"
  84 #include "llvm/Support/raw_ostream.h"
  85 #include "llvm/ADT/Statistic.h"
  86 #include "llvm/ADT/STLExtras.h"
  87 #include "llvm/ADT/SmallPtrSet.h"
  88 #include <algorithm>
  89 using namespace llvm;
  90
  91 STATISTIC(NumArrayLenItCounts,
  92           "Number of trip counts computed with array length");
  93 STATISTIC(NumTripCountsComputed,
  94           "Number of loops with predictable loop counts");
  95 STATISTIC(NumTripCountsNotComputed,
  96           "Number of loops without predictable loop counts");
  97 STATISTIC(NumBruteForceTripCountsComputed,
  98           "Number of loops with trip counts computed by force");
  99
 100 static cl::opt<unsigned>
 101 MaxBruteForceIterations("scalar-evolution-max-iterations", cl::ReallyHidden,
 102                         cl::desc("Maximum number of iterations SCEV will "
 103                                  "symbolically execute a constant "
 104                                  "derived loop"),
 105                         cl::init(100));
 106
 107 INITIALIZE_PASS_BEGIN(ScalarEvolution, "scalar-evolution",
 108                 "Scalar Evolution Analysis", false, true)
 109 INITIALIZE_PASS_DEPENDENCY(LoopInfo)
 110 INITIALIZE_PASS_DEPENDENCY(DominatorTree)
 111 INITIALIZE_PASS_END(ScalarEvolution, "scalar-evolution",
 112                 "Scalar Evolution Analysis", false, true)
 113 char ScalarEvolution::ID = 0;
 114
 115 //===----------------------------------------------------------------------===//
 116 //                           SCEV class definitions
 117 //===----------------------------------------------------------------------===//
 118
 119 //===----------------------------------------------------------------------===//
 120 // Implementation of the SCEV class.
 121 //
 122
 123 void SCEV::dump() const {
 124   print(dbgs());
 125   dbgs() << '\n';
 126 }
 127
 128 void SCEV::print(raw_ostream &OS) const {
 129   switch (getSCEVType()) {
 130   case scConstant:
 131     WriteAsOperand(OS, cast<SCEVConstant>(this)->getValue(), false);
 132     return;
 133   case scTruncate: {
 134     const SCEVTruncateExpr *Trunc = cast<SCEVTruncateExpr>(this);
 135     const SCEV *Op = Trunc->getOperand();
 136     OS << "(trunc " << *Op->getType() << " " << *Op << " to "
 137        << *Trunc->getType() << ")";
 138     return;
 139   }
 140   case scZeroExtend: {
 141     const SCEVZeroExtendExpr *ZExt = cast<SCEVZeroExtendExpr>(this);
 142     const SCEV *Op = ZExt->getOperand();
 143     OS << "(zext " << *Op->getType() << " " << *Op << " to "
 144        << *ZExt->getType() << ")";
 145     return;
 146   }
 147   case scSignExtend: {
 148     const SCEVSignExtendExpr *SExt = cast<SCEVSignExtendExpr>(this);
 149     const SCEV *Op = SExt->getOperand();
 150     OS << "(sext " << *Op->getType() << " " << *Op << " to "
 151        << *SExt->getType() << ")";
 152     return;
 153   }
 154   case scAddRecExpr: {
 155     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(this);
 156     OS << "{" << *AR->getOperand(0);
 157     for (unsigned i = 1, e = AR->getNumOperands(); i != e; ++i)
 158       OS << ",+," << *AR->getOperand(i);
 159     OS << "}<";
 160     if (AR->hasNoUnsignedWrap())
 161       OS << "nuw><";
 162     if (AR->hasNoSignedWrap())
 163       OS << "nsw><";
 164     WriteAsOperand(OS, AR->getLoop()->getHeader(), /*PrintType=*/false);
 165     OS << ">";
 166     return;
 167   }
 168   case scAddExpr:
 169   case scMulExpr:
 170   case scUMaxExpr:
 171   case scSMaxExpr: {
 172     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(this);
 173     const char *OpStr = 0;
 174     switch (NAry->getSCEVType()) {
 175     case scAddExpr: OpStr = " + "; break;
 176     case scMulExpr: OpStr = " * "; break;
 177     case scUMaxExpr: OpStr = " umax "; break;
 178     case scSMaxExpr: OpStr = " smax "; break;
 179     }
 180     OS << "(";
 181     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
 182          I != E; ++I) {
 183       OS << **I;
 184       if (llvm::next(I) != E)
 185         OS << OpStr;
 186     }
 187     OS << ")";
 188     return;
 189   }
 190   case scUDivExpr: {
 191     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(this);
 192     OS << "(" << *UDiv->getLHS() << " /u " << *UDiv->getRHS() << ")";
 193     return;
 194   }
 195   case scUnknown: {
 196     const SCEVUnknown *U = cast<SCEVUnknown>(this);
 197     const Type *AllocTy;
 198     if (U->isSizeOf(AllocTy)) {
 199       OS << "sizeof(" << *AllocTy << ")";
 200       return;
 201     }
 202     if (U->isAlignOf(AllocTy)) {
 203       OS << "alignof(" << *AllocTy << ")";
 204       return;
 205     }
 206
 207     const Type *CTy;
 208     Constant *FieldNo;
 209     if (U->isOffsetOf(CTy, FieldNo)) {
 210       OS << "offsetof(" << *CTy << ", ";
 211       WriteAsOperand(OS, FieldNo, false);
 212       OS << ")";
 213       return;
 214     }
 215
 216     // Otherwise just print it normally.
 217     WriteAsOperand(OS, U->getValue(), false);
 218     return;
 219   }
 220   case scCouldNotCompute:
 221     OS << "***COULDNOTCOMPUTE***";
 222     return;
 223   default: break;
 224   }
 225   llvm_unreachable("Unknown SCEV kind!");
 226 }
 227
 228 const Type *SCEV::getType() const {
 229   switch (getSCEVType()) {
 230   case scConstant:
 231     return cast<SCEVConstant>(this)->getType();
 232   case scTruncate:
 233   case scZeroExtend:
 234   case scSignExtend:
 235     return cast<SCEVCastExpr>(this)->getType();
 236   case scAddRecExpr:
 237   case scMulExpr:
 238   case scUMaxExpr:
 239   case scSMaxExpr:
 240     return cast<SCEVNAryExpr>(this)->getType();
 241   case scAddExpr:
 242     return cast<SCEVAddExpr>(this)->getType();
 243   case scUDivExpr:
 244     return cast<SCEVUDivExpr>(this)->getType();
 245   case scUnknown:
 246     return cast<SCEVUnknown>(this)->getType();
 247   case scCouldNotCompute:
 248     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
 249     return 0;
 250   default: break;
 251   }
 252   llvm_unreachable("Unknown SCEV kind!");
 253   return 0;
 254 }
 255
 256 bool SCEV::isZero() const {
 257   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
 258     return SC->getValue()->isZero();
 259   return false;
 260 }
 261
 262 bool SCEV::isOne() const {
 263   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
 264     return SC->getValue()->isOne();
 265   return false;
 266 }
 267
 268 bool SCEV::isAllOnesValue() const {
 269   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(this))
 270     return SC->getValue()->isAllOnesValue();
 271   return false;
 272 }
 273
 274 SCEVCouldNotCompute::SCEVCouldNotCompute() :
 275   SCEV(FoldingSetNodeIDRef(), scCouldNotCompute) {}
 276
 277 bool SCEVCouldNotCompute::classof(const SCEV *S) {
 278   return S->getSCEVType() == scCouldNotCompute;
 279 }
 280
 281 const SCEV *ScalarEvolution::getConstant(ConstantInt *V) {
 282   FoldingSetNodeID ID;
 283   ID.AddInteger(scConstant);
 284   ID.AddPointer(V);
 285   void *IP = 0;
 286   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
 287   SCEV *S = new (SCEVAllocator) SCEVConstant(ID.Intern(SCEVAllocator), V);
 288   UniqueSCEVs.InsertNode(S, IP);
 289   return S;
 290 }
 291
 292 const SCEV *ScalarEvolution::getConstant(const APInt& Val) {
 293   return getConstant(ConstantInt::get(getContext(), Val));
 294 }
 295
 296 const SCEV *
 297 ScalarEvolution::getConstant(const Type *Ty, uint64_t V, bool isSigned) {
 298   const IntegerType *ITy = cast<IntegerType>(getEffectiveSCEVType(Ty));
 299   return getConstant(ConstantInt::get(ITy, V, isSigned));
 300 }
 301
 302 SCEVCastExpr::SCEVCastExpr(const FoldingSetNodeIDRef ID,
 303                            unsigned SCEVTy, const SCEV *op, const Type *ty)
 304   : SCEV(ID, SCEVTy), Op(op), Ty(ty) {}
 305
 306 SCEVTruncateExpr::SCEVTruncateExpr(const FoldingSetNodeIDRef ID,
 307                                    const SCEV *op, const Type *ty)
 308   : SCEVCastExpr(ID, scTruncate, op, ty) {
 309   assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
 310          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
 311          "Cannot truncate non-integer value!");
 312 }
 313
 314 SCEVZeroExtendExpr::SCEVZeroExtendExpr(const FoldingSetNodeIDRef ID,
 315                                        const SCEV *op, const Type *ty)
 316   : SCEVCastExpr(ID, scZeroExtend, op, ty) {
 317   assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
 318          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
 319          "Cannot zero extend non-integer value!");
 320 }
 321
 322 SCEVSignExtendExpr::SCEVSignExtendExpr(const FoldingSetNodeIDRef ID,
 323                                        const SCEV *op, const Type *ty)
 324   : SCEVCastExpr(ID, scSignExtend, op, ty) {
 325   assert((Op->getType()->isIntegerTy() || Op->getType()->isPointerTy()) &&
 326          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
 327          "Cannot sign extend non-integer value!");
 328 }
 329
 330 void SCEVUnknown::deleted() {
 331   // Clear this SCEVUnknown from various maps.
 332   SE->forgetMemoizedResults(this);
 333
 334   // Remove this SCEVUnknown from the uniquing map.
 335   SE->UniqueSCEVs.RemoveNode(this);
 336
 337   // Release the value.
 338   setValPtr(0);
 339 }
 340
 341 void SCEVUnknown::allUsesReplacedWith(Value *New) {
 342   // Clear this SCEVUnknown from various maps.
 343   SE->forgetMemoizedResults(this);
 344
 345   // Remove this SCEVUnknown from the uniquing map.
 346   SE->UniqueSCEVs.RemoveNode(this);
 347
 348   // Update this SCEVUnknown to point to the new value. This is needed
 349   // because there may still be outstanding SCEVs which still point to
 350   // this SCEVUnknown.
 351   setValPtr(New);
 352 }
 353
 354 bool SCEVUnknown::isSizeOf(const Type *&AllocTy) const {
 355   if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
 356     if (VCE->getOpcode() == Instruction::PtrToInt)
 357       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
 358         if (CE->getOpcode() == Instruction::GetElementPtr &&
 359             CE->getOperand(0)->isNullValue() &&
 360             CE->getNumOperands() == 2)
 361           if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(1)))
 362             if (CI->isOne()) {
 363               AllocTy = cast<PointerType>(CE->getOperand(0)->getType())
 364                                  ->getElementType();
 365               return true;
 366             }
 367
 368   return false;
 369 }
 370
 371 bool SCEVUnknown::isAlignOf(const Type *&AllocTy) const {
 372   if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
 373     if (VCE->getOpcode() == Instruction::PtrToInt)
 374       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
 375         if (CE->getOpcode() == Instruction::GetElementPtr &&
 376             CE->getOperand(0)->isNullValue()) {
 377           const Type *Ty =
 378             cast<PointerType>(CE->getOperand(0)->getType())->getElementType();
 379           if (const StructType *STy = dyn_cast<StructType>(Ty))
 380             if (!STy->isPacked() &&
 381                 CE->getNumOperands() == 3 &&
 382                 CE->getOperand(1)->isNullValue()) {
 383               if (ConstantInt *CI = dyn_cast<ConstantInt>(CE->getOperand(2)))
 384                 if (CI->isOne() &&
 385                     STy->getNumElements() == 2 &&
 386                     STy->getElementType(0)->isIntegerTy(1)) {
 387                   AllocTy = STy->getElementType(1);
 388                   return true;
 389                 }
 390             }
 391         }
 392
 393   return false;
 394 }
 395
 396 bool SCEVUnknown::isOffsetOf(const Type *&CTy, Constant *&FieldNo) const {
 397   if (ConstantExpr *VCE = dyn_cast<ConstantExpr>(getValue()))
 398     if (VCE->getOpcode() == Instruction::PtrToInt)
 399       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(VCE->getOperand(0)))
 400         if (CE->getOpcode() == Instruction::GetElementPtr &&
 401             CE->getNumOperands() == 3 &&
 402             CE->getOperand(0)->isNullValue() &&
 403             CE->getOperand(1)->isNullValue()) {
 404           const Type *Ty =
 405             cast<PointerType>(CE->getOperand(0)->getType())->getElementType();
 406           // Ignore vector types here so that ScalarEvolutionExpander doesn't
 407           // emit getelementptrs that index into vectors.
 408           if (Ty->isStructTy() || Ty->isArrayTy()) {
 409             CTy = Ty;
 410             FieldNo = CE->getOperand(2);
 411             return true;
 412           }
 413         }
 414
 415   return false;
 416 }
 417
 418 //===----------------------------------------------------------------------===//
 419 //                               SCEV Utilities
 420 //===----------------------------------------------------------------------===//
 421
 422 namespace {
 423   /// SCEVComplexityCompare - Return true if the complexity of the LHS is less
 424   /// than the complexity of the RHS.  This comparator is used to canonicalize
 425   /// expressions.
 426   class SCEVComplexityCompare {
 427     const LoopInfo *const LI;
 428   public:
 429     explicit SCEVComplexityCompare(const LoopInfo *li) : LI(li) {}
 430
 431     // Return true or false if LHS is less than, or at least RHS, respectively.
 432     bool operator()(const SCEV *LHS, const SCEV *RHS) const {
 433       return compare(LHS, RHS) < 0;
 434     }
 435
 436     // Return negative, zero, or positive, if LHS is less than, equal to, or
 437     // greater than RHS, respectively. A three-way result allows recursive
 438     // comparisons to be more efficient.
 439     int compare(const SCEV *LHS, const SCEV *RHS) const {
 440       // Fast-path: SCEVs are uniqued so we can do a quick equality check.
 441       if (LHS == RHS)
 442         return 0;
 443
 444       // Primarily, sort the SCEVs by their getSCEVType().
 445       unsigned LType = LHS->getSCEVType(), RType = RHS->getSCEVType();
 446       if (LType != RType)
 447         return (int)LType - (int)RType;
 448
 449       // Aside from the getSCEVType() ordering, the particular ordering
 450       // isn't very important except that it's beneficial to be consistent,
 451       // so that (a + b) and (b + a) don't end up as different expressions.
 452       switch (LType) {
 453       case scUnknown: {
 454         const SCEVUnknown *LU = cast<SCEVUnknown>(LHS);
 455         const SCEVUnknown *RU = cast<SCEVUnknown>(RHS);
 456
 457         // Sort SCEVUnknown values with some loose heuristics. TODO: This is
 458         // not as complete as it could be.
 459         const Value *LV = LU->getValue(), *RV = RU->getValue();
 460
 461         // Order pointer values after integer values. This helps SCEVExpander
 462         // form GEPs.
 463         bool LIsPointer = LV->getType()->isPointerTy(),
 464              RIsPointer = RV->getType()->isPointerTy();
 465         if (LIsPointer != RIsPointer)
 466           return (int)LIsPointer - (int)RIsPointer;
 467
 468         // Compare getValueID values.
 469         unsigned LID = LV->getValueID(),
 470                  RID = RV->getValueID();
 471         if (LID != RID)
 472           return (int)LID - (int)RID;
 473
 474         // Sort arguments by their position.
 475         if (const Argument *LA = dyn_cast<Argument>(LV)) {
 476           const Argument *RA = cast<Argument>(RV);
 477           unsigned LArgNo = LA->getArgNo(), RArgNo = RA->getArgNo();
 478           return (int)LArgNo - (int)RArgNo;
 479         }
 480
 481         // For instructions, compare their loop depth, and their operand
 482         // count.  This is pretty loose.
 483         if (const Instruction *LInst = dyn_cast<Instruction>(LV)) {
 484           const Instruction *RInst = cast<Instruction>(RV);
 485
 486           // Compare loop depths.
 487           const BasicBlock *LParent = LInst->getParent(),
 488                            *RParent = RInst->getParent();
 489           if (LParent != RParent) {
 490             unsigned LDepth = LI->getLoopDepth(LParent),
 491                      RDepth = LI->getLoopDepth(RParent);
 492             if (LDepth != RDepth)
 493               return (int)LDepth - (int)RDepth;
 494           }
 495
 496           // Compare the number of operands.
 497           unsigned LNumOps = LInst->getNumOperands(),
 498                    RNumOps = RInst->getNumOperands();
 499           return (int)LNumOps - (int)RNumOps;
 500         }
 501
 502         return 0;
 503       }
 504
 505       case scConstant: {
 506         const SCEVConstant *LC = cast<SCEVConstant>(LHS);
 507         const SCEVConstant *RC = cast<SCEVConstant>(RHS);
 508
 509         // Compare constant values.
 510         const APInt &LA = LC->getValue()->getValue();
 511         const APInt &RA = RC->getValue()->getValue();
 512         unsigned LBitWidth = LA.getBitWidth(), RBitWidth = RA.getBitWidth();
 513         if (LBitWidth != RBitWidth)
 514           return (int)LBitWidth - (int)RBitWidth;
 515         return LA.ult(RA) ? -1 : 1;
 516       }
 517
 518       case scAddRecExpr: {
 519         const SCEVAddRecExpr *LA = cast<SCEVAddRecExpr>(LHS);
 520         const SCEVAddRecExpr *RA = cast<SCEVAddRecExpr>(RHS);
 521
 522         // Compare addrec loop depths.
 523         const Loop *LLoop = LA->getLoop(), *RLoop = RA->getLoop();
 524         if (LLoop != RLoop) {
 525           unsigned LDepth = LLoop->getLoopDepth(),
 526                    RDepth = RLoop->getLoopDepth();
 527           if (LDepth != RDepth)
 528             return (int)LDepth - (int)RDepth;
 529         }
 530
 531         // Addrec complexity grows with operand count.
 532         unsigned LNumOps = LA->getNumOperands(), RNumOps = RA->getNumOperands();
 533         if (LNumOps != RNumOps)
 534           return (int)LNumOps - (int)RNumOps;
 535
 536         // Lexicographically compare.
 537         for (unsigned i = 0; i != LNumOps; ++i) {
 538           long X = compare(LA->getOperand(i), RA->getOperand(i));
 539           if (X != 0)
 540             return X;
 541         }
 542
 543         return 0;
 544       }
 545
 546       case scAddExpr:
 547       case scMulExpr:
 548       case scSMaxExpr:
 549       case scUMaxExpr: {
 550         const SCEVNAryExpr *LC = cast<SCEVNAryExpr>(LHS);
 551         const SCEVNAryExpr *RC = cast<SCEVNAryExpr>(RHS);
 552
 553         // Lexicographically compare n-ary expressions.
 554         unsigned LNumOps = LC->getNumOperands(), RNumOps = RC->getNumOperands();
 555         for (unsigned i = 0; i != LNumOps; ++i) {
 556           if (i >= RNumOps)
 557             return 1;
 558           long X = compare(LC->getOperand(i), RC->getOperand(i));
 559           if (X != 0)
 560             return X;
 561         }
 562         return (int)LNumOps - (int)RNumOps;
 563       }
 564
 565       case scUDivExpr: {
 566         const SCEVUDivExpr *LC = cast<SCEVUDivExpr>(LHS);
 567         const SCEVUDivExpr *RC = cast<SCEVUDivExpr>(RHS);
 568
 569         // Lexicographically compare udiv expressions.
 570         long X = compare(LC->getLHS(), RC->getLHS());
 571         if (X != 0)
 572           return X;
 573         return compare(LC->getRHS(), RC->getRHS());
 574       }
 575
 576       case scTruncate:
 577       case scZeroExtend:
 578       case scSignExtend: {
 579         const SCEVCastExpr *LC = cast<SCEVCastExpr>(LHS);
 580         const SCEVCastExpr *RC = cast<SCEVCastExpr>(RHS);
 581
 582         // Compare cast expressions by operand.
 583         return compare(LC->getOperand(), RC->getOperand());
 584       }
 585
 586       default:
 587         break;
 588       }
 589
 590       llvm_unreachable("Unknown SCEV kind!");
 591       return 0;
 592     }
 593   };
 594 }
 595
 596 /// GroupByComplexity - Given a list of SCEV objects, order them by their
 597 /// complexity, and group objects of the same complexity together by value.
 598 /// When this routine is finished, we know that any duplicates in the vector are
 599 /// consecutive and that complexity is monotonically increasing.
 600 ///
 601 /// Note that we go take special precautions to ensure that we get deterministic
 602 /// results from this routine.  In other words, we don't want the results of
 603 /// this to depend on where the addresses of various SCEV objects happened to
 604 /// land in memory.
 605 ///
 606 static void GroupByComplexity(SmallVectorImpl<const SCEV *> &Ops,
 607                               LoopInfo *LI) {
 608   if (Ops.size() < 2) return;  // Noop
 609   if (Ops.size() == 2) {
 610     // This is the common case, which also happens to be trivially simple.
 611     // Special case it.
 612     const SCEV *&LHS = Ops[0], *&RHS = Ops[1];
 613     if (SCEVComplexityCompare(LI)(RHS, LHS))
 614       std::swap(LHS, RHS);
 615     return;
 616   }
 617
 618   // Do the rough sort by complexity.
 619   std::stable_sort(Ops.begin(), Ops.end(), SCEVComplexityCompare(LI));
 620
 621   // Now that we are sorted by complexity, group elements of the same
 622   // complexity.  Note that this is, at worst, N^2, but the vector is likely to
 623   // be extremely short in practice.  Note that we take this approach because we
 624   // do not want to depend on the addresses of the objects we are grouping.
 625   for (unsigned i = 0, e = Ops.size(); i != e-2; ++i) {
 626     const SCEV *S = Ops[i];
 627     unsigned Complexity = S->getSCEVType();
 628
 629     // If there are any objects of the same complexity and same value as this
 630     // one, group them.
 631     for (unsigned j = i+1; j != e && Ops[j]->getSCEVType() == Complexity; ++j) {
 632       if (Ops[j] == S) { // Found a duplicate.
 633         // Move it to immediately after i'th element.
 634         std::swap(Ops[i+1], Ops[j]);
 635         ++i;   // no need to rescan it.
 636         if (i == e-2) return;  // Done!
 637       }
 638     }
 639   }
 640 }
 641
 642
 643
 644 //===----------------------------------------------------------------------===//
 645 //                      Simple SCEV method implementations
 646 //===----------------------------------------------------------------------===//
 647
 648 /// BinomialCoefficient - Compute BC(It, K).  The result has width W.
 649 /// Assume, K > 0.
 650 static const SCEV *BinomialCoefficient(const SCEV *It, unsigned K,
 651                                        ScalarEvolution &SE,
 652                                        const Type* ResultTy) {
 653   // Handle the simplest case efficiently.
 654   if (K == 1)
 655     return SE.getTruncateOrZeroExtend(It, ResultTy);
 656
 657   // We are using the following formula for BC(It, K):
 658   //
 659   //   BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / K!
 660   //
 661   // Suppose, W is the bitwidth of the return value.  We must be prepared for
 662   // overflow.  Hence, we must assure that the result of our computation is
 663   // equal to the accurate one modulo 2^W.  Unfortunately, division isn't
 664   // safe in modular arithmetic.
 665   //
 666   // However, this code doesn't use exactly that formula; the formula it uses
 667   // is something like the following, where T is the number of factors of 2 in
 668   // K! (i.e. trailing zeros in the binary representation of K!), and ^ is
 669   // exponentiation:
 670   //
 671   //   BC(It, K) = (It * (It - 1) * ... * (It - K + 1)) / 2^T / (K! / 2^T)
 672   //
 673   // This formula is trivially equivalent to the previous formula.  However,
 674   // this formula can be implemented much more efficiently.  The trick is that
 675   // K! / 2^T is odd, and exact division by an odd number *is* safe in modular
 676   // arithmetic.  To do exact division in modular arithmetic, all we have
 677   // to do is multiply by the inverse.  Therefore, this step can be done at
 678   // width W.
 679   //
 680   // The next issue is how to safely do the division by 2^T.  The way this
 681   // is done is by doing the multiplication step at a width of at least W + T
 682   // bits.  This way, the bottom W+T bits of the product are accurate. Then,
 683   // when we perform the division by 2^T (which is equivalent to a right shift
 684   // by T), the bottom W bits are accurate.  Extra bits are okay; they'll get
 685   // truncated out after the division by 2^T.
 686   //
 687   // In comparison to just directly using the first formula, this technique
 688   // is much more efficient; using the first formula requires W * K bits,
 689   // but this formula less than W + K bits. Also, the first formula requires
 690   // a division step, whereas this formula only requires multiplies and shifts.
 691   //
 692   // It doesn't matter whether the subtraction step is done in the calculation
 693   // width or the input iteration count's width; if the subtraction overflows,
 694   // the result must be zero anyway.  We prefer here to do it in the width of
 695   // the induction variable because it helps a lot for certain cases; CodeGen
 696   // isn't smart enough to ignore the overflow, which leads to much less
 697   // efficient code if the width of the subtraction is wider than the native
 698   // register width.
 699   //
 700   // (It's possible to not widen at all by pulling out factors of 2 before
 701   // the multiplication; for example, K=2 can be calculated as
 702   // It/2*(It+(It*INT_MIN/INT_MIN)+-1). However, it requires
 703   // extra arithmetic, so it's not an obvious win, and it gets
 704   // much more complicated for K > 3.)
 705
 706   // Protection from insane SCEVs; this bound is conservative,
 707   // but it probably doesn't matter.
 708   if (K > 1000)
 709     return SE.getCouldNotCompute();
 710
 711   unsigned W = SE.getTypeSizeInBits(ResultTy);
 712
 713   // Calculate K! / 2^T and T; we divide out the factors of two before
 714   // multiplying for calculating K! / 2^T to avoid overflow.
 715   // Other overflow doesn't matter because we only care about the bottom
 716   // W bits of the result.
 717   APInt OddFactorial(W, 1);
 718   unsigned T = 1;
 719   for (unsigned i = 3; i <= K; ++i) {
 720     APInt Mult(W, i);
 721     unsigned TwoFactors = Mult.countTrailingZeros();
 722     T += TwoFactors;
 723     Mult = Mult.lshr(TwoFactors);
 724     OddFactorial *= Mult;
 725   }
 726
 727   // We need at least W + T bits for the multiplication step
 728   unsigned CalculationBits = W + T;
 729
 730   // Calculate 2^T, at width T+W.
 731   APInt DivFactor = APInt(CalculationBits, 1).shl(T);
 732
 733   // Calculate the multiplicative inverse of K! / 2^T;
 734   // this multiplication factor will perform the exact division by
 735   // K! / 2^T.
 736   APInt Mod = APInt::getSignedMinValue(W+1);
 737   APInt MultiplyFactor = OddFactorial.zext(W+1);
 738   MultiplyFactor = MultiplyFactor.multiplicativeInverse(Mod);
 739   MultiplyFactor = MultiplyFactor.trunc(W);
 740
 741   // Calculate the product, at width T+W
 742   const IntegerType *CalculationTy = IntegerType::get(SE.getContext(),
 743                                                       CalculationBits);
 744   const SCEV *Dividend = SE.getTruncateOrZeroExtend(It, CalculationTy);
 745   for (unsigned i = 1; i != K; ++i) {
 746     const SCEV *S = SE.getMinusSCEV(It, SE.getConstant(It->getType(), i));
 747     Dividend = SE.getMulExpr(Dividend,
 748                              SE.getTruncateOrZeroExtend(S, CalculationTy));
 749   }
 750
 751   // Divide by 2^T
 752   const SCEV *DivResult = SE.getUDivExpr(Dividend, SE.getConstant(DivFactor));
 753
 754   // Truncate the result, and divide by K! / 2^T.
 755
 756   return SE.getMulExpr(SE.getConstant(MultiplyFactor),
 757                        SE.getTruncateOrZeroExtend(DivResult, ResultTy));
 758 }
 759
 760 /// evaluateAtIteration - Return the value of this chain of recurrences at
 761 /// the specified iteration number.  We can evaluate this recurrence by
 762 /// multiplying each element in the chain by the binomial coefficient
 763 /// corresponding to it.  In other words, we can evaluate {A,+,B,+,C,+,D} as:
 764 ///
 765 ///   A*BC(It, 0) + B*BC(It, 1) + C*BC(It, 2) + D*BC(It, 3)
 766 ///
 767 /// where BC(It, k) stands for binomial coefficient.
 768 ///
 769 const SCEV *SCEVAddRecExpr::evaluateAtIteration(const SCEV *It,
 770                                                 ScalarEvolution &SE) const {
 771   const SCEV *Result = getStart();
 772   for (unsigned i = 1, e = getNumOperands(); i != e; ++i) {
 773     // The computation is correct in the face of overflow provided that the
 774     // multiplication is performed _after_ the evaluation of the binomial
 775     // coefficient.
 776     const SCEV *Coeff = BinomialCoefficient(It, i, SE, getType());
 777     if (isa<SCEVCouldNotCompute>(Coeff))
 778       return Coeff;
 779
 780     Result = SE.getAddExpr(Result, SE.getMulExpr(getOperand(i), Coeff));
 781   }
 782   return Result;
 783 }
 784
 785 //===----------------------------------------------------------------------===//
 786 //                    SCEV Expression folder implementations
 787 //===----------------------------------------------------------------------===//
 788
 789 const SCEV *ScalarEvolution::getTruncateExpr(const SCEV *Op,
 790                                              const Type *Ty) {
 791   assert(getTypeSizeInBits(Op->getType()) > getTypeSizeInBits(Ty) &&
 792          "This is not a truncating conversion!");
 793   assert(isSCEVable(Ty) &&
 794          "This is not a conversion to a SCEVable type!");
 795   Ty = getEffectiveSCEVType(Ty);
 796
 797   FoldingSetNodeID ID;
 798   ID.AddInteger(scTruncate);
 799   ID.AddPointer(Op);
 800   ID.AddPointer(Ty);
 801   void *IP = 0;
 802   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
 803
 804   // Fold if the operand is constant.
 805   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
 806     return getConstant(
 807       cast<ConstantInt>(ConstantExpr::getTrunc(SC->getValue(),
 808                                                getEffectiveSCEVType(Ty))));
 809
 810   // trunc(trunc(x)) --> trunc(x)
 811   if (const SCEVTruncateExpr *ST = dyn_cast<SCEVTruncateExpr>(Op))
 812     return getTruncateExpr(ST->getOperand(), Ty);
 813
 814   // trunc(sext(x)) --> sext(x) if widening or trunc(x) if narrowing
 815   if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op))
 816     return getTruncateOrSignExtend(SS->getOperand(), Ty);
 817
 818   // trunc(zext(x)) --> zext(x) if widening or trunc(x) if narrowing
 819   if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
 820     return getTruncateOrZeroExtend(SZ->getOperand(), Ty);
 821
 822   // If the input value is a chrec scev, truncate the chrec's operands.
 823   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(Op)) {
 824     SmallVector<const SCEV *, 4> Operands;
 825     for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i)
 826       Operands.push_back(getTruncateExpr(AddRec->getOperand(i), Ty));
 827     return getAddRecExpr(Operands, AddRec->getLoop());
 828   }
 829
 830   // As a special case, fold trunc(undef) to undef. We don't want to
 831   // know too much about SCEVUnknowns, but this special case is handy
 832   // and harmless.
 833   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(Op))
 834     if (isa<UndefValue>(U->getValue()))
 835       return getSCEV(UndefValue::get(Ty));
 836
 837   // The cast wasn't folded; create an explicit cast node. We can reuse
 838   // the existing insert position since if we get here, we won't have
 839   // made any changes which would invalidate it.
 840   SCEV *S = new (SCEVAllocator) SCEVTruncateExpr(ID.Intern(SCEVAllocator),
 841                                                  Op, Ty);
 842   UniqueSCEVs.InsertNode(S, IP);
 843   return S;
 844 }
 845
 846 const SCEV *ScalarEvolution::getZeroExtendExpr(const SCEV *Op,
 847                                                const Type *Ty) {
 848   assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
 849          "This is not an extending conversion!");
 850   assert(isSCEVable(Ty) &&
 851          "This is not a conversion to a SCEVable type!");
 852   Ty = getEffectiveSCEVType(Ty);
 853
 854   // Fold if the operand is constant.
 855   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
 856     return getConstant(
 857       cast<ConstantInt>(ConstantExpr::getZExt(SC->getValue(),
 858                                               getEffectiveSCEVType(Ty))));
 859
 860   // zext(zext(x)) --> zext(x)
 861   if (const SCEVZeroExtendExpr *SZ = dyn_cast<SCEVZeroExtendExpr>(Op))
 862     return getZeroExtendExpr(SZ->getOperand(), Ty);
 863
 864   // Before doing any expensive analysis, check to see if we've already
 865   // computed a SCEV for this Op and Ty.
 866   FoldingSetNodeID ID;
 867   ID.AddInteger(scZeroExtend);
 868   ID.AddPointer(Op);
 869   ID.AddPointer(Ty);
 870   void *IP = 0;
 871   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
 872
 873   // If the input value is a chrec scev, and we can prove that the value
 874   // did not overflow the old, smaller, value, we can zero extend all of the
 875   // operands (often constants).  This allows analysis of something like
 876   // this:  for (unsigned char X = 0; X < 100; ++X) { int Y = X; }
 877   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op))
 878     if (AR->isAffine()) {
 879       const SCEV *Start = AR->getStart();
 880       const SCEV *Step = AR->getStepRecurrence(*this);
 881       unsigned BitWidth = getTypeSizeInBits(AR->getType());
 882       const Loop *L = AR->getLoop();
 883
 884       // If we have special knowledge that this addrec won't overflow,
 885       // we don't need to do any further analysis.
 886       if (AR->hasNoUnsignedWrap())
 887         return getAddRecExpr(getZeroExtendExpr(Start, Ty),
 888                              getZeroExtendExpr(Step, Ty),
 889                              L);
 890
 891       // Check whether the backedge-taken count is SCEVCouldNotCompute.
 892       // Note that this serves two purposes: It filters out loops that are
 893       // simply not analyzable, and it covers the case where this code is
 894       // being called from within backedge-taken count analysis, such that
 895       // attempting to ask for the backedge-taken count would likely result
 896       // in infinite recursion. In the later case, the analysis code will
 897       // cope with a conservative value, and it will take care to purge
 898       // that value once it has finished.
 899       const SCEV *MaxBECount = getMaxBackedgeTakenCount(L);
 900       if (!isa<SCEVCouldNotCompute>(MaxBECount)) {
 901         // Manually compute the final value for AR, checking for
 902         // overflow.
 903
 904         // Check whether the backedge-taken count can be losslessly casted to
 905         // the addrec's type. The count is always unsigned.
 906         const SCEV *CastedMaxBECount =
 907           getTruncateOrZeroExtend(MaxBECount, Start->getType());
 908         const SCEV *RecastedMaxBECount =
 909           getTruncateOrZeroExtend(CastedMaxBECount, MaxBECount->getType());
 910         if (MaxBECount == RecastedMaxBECount) {
 911           const Type *WideTy = IntegerType::get(getContext(), BitWidth * 2);
 912           // Check whether Start+Step*MaxBECount has no unsigned overflow.
 913           const SCEV *ZMul = getMulExpr(CastedMaxBECount, Step);
 914           const SCEV *Add = getAddExpr(Start, ZMul);
 915           const SCEV *OperandExtendedAdd =
 916             getAddExpr(getZeroExtendExpr(Start, WideTy),
 917                        getMulExpr(getZeroExtendExpr(CastedMaxBECount, WideTy),
 918                                   getZeroExtendExpr(Step, WideTy)));
 919           if (getZeroExtendExpr(Add, WideTy) == OperandExtendedAdd)
 920             // Return the expression with the addrec on the outside.
 921             return getAddRecExpr(getZeroExtendExpr(Start, Ty),
 922                                  getZeroExtendExpr(Step, Ty),
 923                                  L);
 924
 925           // Similar to above, only this time treat the step value as signed.
 926           // This covers loops that count down.
 927           const SCEV *SMul = getMulExpr(CastedMaxBECount, Step);
 928           Add = getAddExpr(Start, SMul);
 929           OperandExtendedAdd =
 930             getAddExpr(getZeroExtendExpr(Start, WideTy),
 931                        getMulExpr(getZeroExtendExpr(CastedMaxBECount, WideTy),
 932                                   getSignExtendExpr(Step, WideTy)));
 933           if (getZeroExtendExpr(Add, WideTy) == OperandExtendedAdd)
 934             // Return the expression with the addrec on the outside.
 935             return getAddRecExpr(getZeroExtendExpr(Start, Ty),
 936                                  getSignExtendExpr(Step, Ty),
 937                                  L);
 938         }
 939
 940         // If the backedge is guarded by a comparison with the pre-inc value
 941         // the addrec is safe. Also, if the entry is guarded by a comparison
 942         // with the start value and the backedge is guarded by a comparison
 943         // with the post-inc value, the addrec is safe.
 944         if (isKnownPositive(Step)) {
 945           const SCEV *N = getConstant(APInt::getMinValue(BitWidth) -
 946                                       getUnsignedRange(Step).getUnsignedMax());
 947           if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT, AR, N) ||
 948               (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_ULT, Start, N) &&
 949                isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_ULT,
 950                                            AR->getPostIncExpr(*this), N)))
 951             // Return the expression with the addrec on the outside.
 952             return getAddRecExpr(getZeroExtendExpr(Start, Ty),
 953                                  getZeroExtendExpr(Step, Ty),
 954                                  L);
 955         } else if (isKnownNegative(Step)) {
 956           const SCEV *N = getConstant(APInt::getMaxValue(BitWidth) -
 957                                       getSignedRange(Step).getSignedMin());
 958           if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT, AR, N) ||
 959               (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_UGT, Start, N) &&
 960                isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_UGT,
 961                                            AR->getPostIncExpr(*this), N)))
 962             // Return the expression with the addrec on the outside.
 963             return getAddRecExpr(getZeroExtendExpr(Start, Ty),
 964                                  getSignExtendExpr(Step, Ty),
 965                                  L);
 966         }
 967       }
 968     }
 969
 970   // The cast wasn't folded; create an explicit cast node.
 971   // Recompute the insert position, as it may have been invalidated.
 972   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
 973   SCEV *S = new (SCEVAllocator) SCEVZeroExtendExpr(ID.Intern(SCEVAllocator),
 974                                                    Op, Ty);
 975   UniqueSCEVs.InsertNode(S, IP);
 976   return S;
 977 }
 978
 979 const SCEV *ScalarEvolution::getSignExtendExpr(const SCEV *Op,
 980                                                const Type *Ty) {
 981   assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
 982          "This is not an extending conversion!");
 983   assert(isSCEVable(Ty) &&
 984          "This is not a conversion to a SCEVable type!");
 985   Ty = getEffectiveSCEVType(Ty);
 986
 987   // Fold if the operand is constant.
 988   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
 989     return getConstant(
 990       cast<ConstantInt>(ConstantExpr::getSExt(SC->getValue(),
 991                                               getEffectiveSCEVType(Ty))));
 992
 993   // sext(sext(x)) --> sext(x)
 994   if (const SCEVSignExtendExpr *SS = dyn_cast<SCEVSignExtendExpr>(Op))
 995     return getSignExtendExpr(SS->getOperand(), Ty);
 996
 997   // Before doing any expensive analysis, check to see if we've already
 998   // computed a SCEV for this Op and Ty.
 999   FoldingSetNodeID ID;
1000   ID.AddInteger(scSignExtend);
1001   ID.AddPointer(Op);
1002   ID.AddPointer(Ty);
1003   void *IP = 0;
1004   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1005
1006   // If the input value is a chrec scev, and we can prove that the value
1007   // did not overflow the old, smaller, value, we can sign extend all of the
1008   // operands (often constants).  This allows analysis of something like
1009   // this:  for (signed char X = 0; X < 100; ++X) { int Y = X; }
1010   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op))
1011     if (AR->isAffine()) {
1012       const SCEV *Start = AR->getStart();
1013       const SCEV *Step = AR->getStepRecurrence(*this);
1014       unsigned BitWidth = getTypeSizeInBits(AR->getType());
1015       const Loop *L = AR->getLoop();
1016
1017       // If we have special knowledge that this addrec won't overflow,
1018       // we don't need to do any further analysis.
1019       if (AR->hasNoSignedWrap())
1020         return getAddRecExpr(getSignExtendExpr(Start, Ty),
1021                              getSignExtendExpr(Step, Ty),
1022                              L);
1023
1024       // Check whether the backedge-taken count is SCEVCouldNotCompute.
1025       // Note that this serves two purposes: It filters out loops that are
1026       // simply not analyzable, and it covers the case where this code is
1027       // being called from within backedge-taken count analysis, such that
1028       // attempting to ask for the backedge-taken count would likely result
1029       // in infinite recursion. In the later case, the analysis code will
1030       // cope with a conservative value, and it will take care to purge
1031       // that value once it has finished.
1032       const SCEV *MaxBECount = getMaxBackedgeTakenCount(L);
1033       if (!isa<SCEVCouldNotCompute>(MaxBECount)) {
1034         // Manually compute the final value for AR, checking for
1035         // overflow.
1036
1037         // Check whether the backedge-taken count can be losslessly casted to
1038         // the addrec's type. The count is always unsigned.
1039         const SCEV *CastedMaxBECount =
1040           getTruncateOrZeroExtend(MaxBECount, Start->getType());
1041         const SCEV *RecastedMaxBECount =
1042           getTruncateOrZeroExtend(CastedMaxBECount, MaxBECount->getType());
1043         if (MaxBECount == RecastedMaxBECount) {
1044           const Type *WideTy = IntegerType::get(getContext(), BitWidth * 2);
1045           // Check whether Start+Step*MaxBECount has no signed overflow.
1046           const SCEV *SMul = getMulExpr(CastedMaxBECount, Step);
1047           const SCEV *Add = getAddExpr(Start, SMul);
1048           const SCEV *OperandExtendedAdd =
1049             getAddExpr(getSignExtendExpr(Start, WideTy),
1050                        getMulExpr(getZeroExtendExpr(CastedMaxBECount, WideTy),
1051                                   getSignExtendExpr(Step, WideTy)));
1052           if (getSignExtendExpr(Add, WideTy) == OperandExtendedAdd)
1053             // Return the expression with the addrec on the outside.
1054             return getAddRecExpr(getSignExtendExpr(Start, Ty),
1055                                  getSignExtendExpr(Step, Ty),
1056                                  L);
1057
1058           // Similar to above, only this time treat the step value as unsigned.
1059           // This covers loops that count up with an unsigned step.
1060           const SCEV *UMul = getMulExpr(CastedMaxBECount, Step);
1061           Add = getAddExpr(Start, UMul);
1062           OperandExtendedAdd =
1063             getAddExpr(getSignExtendExpr(Start, WideTy),
1064                        getMulExpr(getZeroExtendExpr(CastedMaxBECount, WideTy),
1065                                   getZeroExtendExpr(Step, WideTy)));
1066           if (getSignExtendExpr(Add, WideTy) == OperandExtendedAdd)
1067             // Return the expression with the addrec on the outside.
1068             return getAddRecExpr(getSignExtendExpr(Start, Ty),
1069                                  getZeroExtendExpr(Step, Ty),
1070                                  L);
1071         }
1072
1073         // If the backedge is guarded by a comparison with the pre-inc value
1074         // the addrec is safe. Also, if the entry is guarded by a comparison
1075         // with the start value and the backedge is guarded by a comparison
1076         // with the post-inc value, the addrec is safe.
1077         if (isKnownPositive(Step)) {
1078           const SCEV *N = getConstant(APInt::getSignedMinValue(BitWidth) -
1079                                       getSignedRange(Step).getSignedMax());
1080           if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_SLT, AR, N) ||
1081               (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_SLT, Start, N) &&
1082                isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_SLT,
1083                                            AR->getPostIncExpr(*this), N)))
1084             // Return the expression with the addrec on the outside.
1085             return getAddRecExpr(getSignExtendExpr(Start, Ty),
1086                                  getSignExtendExpr(Step, Ty),
1087                                  L);
1088         } else if (isKnownNegative(Step)) {
1089           const SCEV *N = getConstant(APInt::getSignedMaxValue(BitWidth) -
1090                                       getSignedRange(Step).getSignedMin());
1091           if (isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_SGT, AR, N) ||
1092               (isLoopEntryGuardedByCond(L, ICmpInst::ICMP_SGT, Start, N) &&
1093                isLoopBackedgeGuardedByCond(L, ICmpInst::ICMP_SGT,
1094                                            AR->getPostIncExpr(*this), N)))
1095             // Return the expression with the addrec on the outside.
1096             return getAddRecExpr(getSignExtendExpr(Start, Ty),
1097                                  getSignExtendExpr(Step, Ty),
1098                                  L);
1099         }
1100       }
1101     }
1102
1103   // The cast wasn't folded; create an explicit cast node.
1104   // Recompute the insert position, as it may have been invalidated.
1105   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1106   SCEV *S = new (SCEVAllocator) SCEVSignExtendExpr(ID.Intern(SCEVAllocator),
1107                                                    Op, Ty);
1108   UniqueSCEVs.InsertNode(S, IP);
1109   return S;
1110 }
1111
1112 /// getAnyExtendExpr - Return a SCEV for the given operand extended with
1113 /// unspecified bits out to the given type.
1114 ///
1115 const SCEV *ScalarEvolution::getAnyExtendExpr(const SCEV *Op,
1116                                               const Type *Ty) {
1117   assert(getTypeSizeInBits(Op->getType()) < getTypeSizeInBits(Ty) &&
1118          "This is not an extending conversion!");
1119   assert(isSCEVable(Ty) &&
1120          "This is not a conversion to a SCEVable type!");
1121   Ty = getEffectiveSCEVType(Ty);
1122
1123   // Sign-extend negative constants.
1124   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(Op))
1125     if (SC->getValue()->getValue().isNegative())
1126       return getSignExtendExpr(Op, Ty);
1127
1128   // Peel off a truncate cast.
1129   if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Op)) {
1130     const SCEV *NewOp = T->getOperand();
1131     if (getTypeSizeInBits(NewOp->getType()) < getTypeSizeInBits(Ty))
1132       return getAnyExtendExpr(NewOp, Ty);
1133     return getTruncateOrNoop(NewOp, Ty);
1134   }
1135
1136   // Next try a zext cast. If the cast is folded, use it.
1137   const SCEV *ZExt = getZeroExtendExpr(Op, Ty);
1138   if (!isa<SCEVZeroExtendExpr>(ZExt))
1139     return ZExt;
1140
1141   // Next try a sext cast. If the cast is folded, use it.
1142   const SCEV *SExt = getSignExtendExpr(Op, Ty);
1143   if (!isa<SCEVSignExtendExpr>(SExt))
1144     return SExt;
1145
1146   // Force the cast to be folded into the operands of an addrec.
1147   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Op)) {
1148     SmallVector<const SCEV *, 4> Ops;
1149     for (SCEVAddRecExpr::op_iterator I = AR->op_begin(), E = AR->op_end();
1150          I != E; ++I)
1151       Ops.push_back(getAnyExtendExpr(*I, Ty));
1152     return getAddRecExpr(Ops, AR->getLoop());
1153   }
1154
1155   // As a special case, fold anyext(undef) to undef. We don't want to
1156   // know too much about SCEVUnknowns, but this special case is handy
1157   // and harmless.
1158   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(Op))
1159     if (isa<UndefValue>(U->getValue()))
1160       return getSCEV(UndefValue::get(Ty));
1161
1162   // If the expression is obviously signed, use the sext cast value.
1163   if (isa<SCEVSMaxExpr>(Op))
1164     return SExt;
1165
1166   // Absent any other information, use the zext cast value.
1167   return ZExt;
1168 }
1169
1170 /// CollectAddOperandsWithScales - Process the given Ops list, which is
1171 /// a list of operands to be added under the given scale, update the given
1172 /// map. This is a helper function for getAddRecExpr. As an example of
1173 /// what it does, given a sequence of operands that would form an add
1174 /// expression like this:
1175 ///
1176 ///    m + n + 13 + (A * (o + p + (B * q + m + 29))) + r + (-1 * r)
1177 ///
1178 /// where A and B are constants, update the map with these values:
1179 ///
1180 ///    (m, 1+A*B), (n, 1), (o, A), (p, A), (q, A*B), (r, 0)
1181 ///
1182 /// and add 13 + A*B*29 to AccumulatedConstant.
1183 /// This will allow getAddRecExpr to produce this:
1184 ///
1185 ///    13+A*B*29 + n + (m * (1+A*B)) + ((o + p) * A) + (q * A*B)
1186 ///
1187 /// This form often exposes folding opportunities that are hidden in
1188 /// the original operand list.
1189 ///
1190 /// Return true iff it appears that any interesting folding opportunities
1191 /// may be exposed. This helps getAddRecExpr short-circuit extra work in
1192 /// the common case where no interesting opportunities are present, and
1193 /// is also used as a check to avoid infinite recursion.
1194 ///
1195 static bool
1196 CollectAddOperandsWithScales(DenseMap<const SCEV *, APInt> &M,
1197                              SmallVector<const SCEV *, 8> &NewOps,
1198                              APInt &AccumulatedConstant,
1199                              const SCEV *const *Ops, size_t NumOperands,
1200                              const APInt &Scale,
1201                              ScalarEvolution &SE) {
1202   bool Interesting = false;
1203
1204   // Iterate over the add operands. They are sorted, with constants first.
1205   unsigned i = 0;
1206   while (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) {
1207     ++i;
1208     // Pull a buried constant out to the outside.
1209     if (Scale != 1 || AccumulatedConstant != 0 || C->getValue()->isZero())
1210       Interesting = true;
1211     AccumulatedConstant += Scale * C->getValue()->getValue();
1212   }
1213
1214   // Next comes everything else. We're especially interested in multiplies
1215   // here, but they're in the middle, so just visit the rest with one loop.
1216   for (; i != NumOperands; ++i) {
1217     const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[i]);
1218     if (Mul && isa<SCEVConstant>(Mul->getOperand(0))) {
1219       APInt NewScale =
1220         Scale * cast<SCEVConstant>(Mul->getOperand(0))->getValue()->getValue();
1221       if (Mul->getNumOperands() == 2 && isa<SCEVAddExpr>(Mul->getOperand(1))) {
1222         // A multiplication of a constant with another add; recurse.
1223         const SCEVAddExpr *Add = cast<SCEVAddExpr>(Mul->getOperand(1));
1224         Interesting |=
1225           CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant,
1226                                        Add->op_begin(), Add->getNumOperands(),
1227                                        NewScale, SE);
1228       } else {
1229         // A multiplication of a constant with some other value. Update
1230         // the map.
1231         SmallVector<const SCEV *, 4> MulOps(Mul->op_begin()+1, Mul->op_end());
1232         const SCEV *Key = SE.getMulExpr(MulOps);
1233         std::pair<DenseMap<const SCEV *, APInt>::iterator, bool> Pair =
1234           M.insert(std::make_pair(Key, NewScale));
1235         if (Pair.second) {
1236           NewOps.push_back(Pair.first->first);
1237         } else {
1238           Pair.first->second += NewScale;
1239           // The map already had an entry for this value, which may indicate
1240           // a folding opportunity.
1241           Interesting = true;
1242         }
1243       }
1244     } else {
1245       // An ordinary operand. Update the map.
1246       std::pair<DenseMap<const SCEV *, APInt>::iterator, bool> Pair =
1247         M.insert(std::make_pair(Ops[i], Scale));
1248       if (Pair.second) {
1249         NewOps.push_back(Pair.first->first);
1250       } else {
1251         Pair.first->second += Scale;
1252         // The map already had an entry for this value, which may indicate
1253         // a folding opportunity.
1254         Interesting = true;
1255       }
1256     }
1257   }
1258
1259   return Interesting;
1260 }
1261
1262 namespace {
1263   struct APIntCompare {
1264     bool operator()(const APInt &LHS, const APInt &RHS) const {
1265       return LHS.ult(RHS);
1266     }
1267   };
1268 }
1269
1270 /// getAddExpr - Get a canonical add expression, or something simpler if
1271 /// possible.
1272 const SCEV *ScalarEvolution::getAddExpr(SmallVectorImpl<const SCEV *> &Ops,
1273                                         bool HasNUW, bool HasNSW) {
1274   assert(!Ops.empty() && "Cannot get empty add!");
1275   if (Ops.size() == 1) return Ops[0];
1276 #ifndef NDEBUG
1277   const Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
1278   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
1279     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
1280            "SCEVAddExpr operand types don't match!");
1281 #endif
1282
1283   // If HasNSW is true and all the operands are non-negative, infer HasNUW.
1284   if (!HasNUW && HasNSW) {
1285     bool All = true;
1286     for (SmallVectorImpl<const SCEV *>::const_iterator I = Ops.begin(),
1287          E = Ops.end(); I != E; ++I)
1288       if (!isKnownNonNegative(*I)) {
1289         All = false;
1290         break;
1291       }
1292     if (All) HasNUW = true;
1293   }
1294
1295   // Sort by complexity, this groups all similar expression types together.
1296   GroupByComplexity(Ops, LI);
1297
1298   // If there are any constants, fold them together.
1299   unsigned Idx = 0;
1300   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
1301     ++Idx;
1302     assert(Idx < Ops.size());
1303     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
1304       // We found two constants, fold them together!
1305       Ops[0] = getConstant(LHSC->getValue()->getValue() +
1306                            RHSC->getValue()->getValue());
1307       if (Ops.size() == 2) return Ops[0];
1308       Ops.erase(Ops.begin()+1);  // Erase the folded element
1309       LHSC = cast<SCEVConstant>(Ops[0]);
1310     }
1311
1312     // If we are left with a constant zero being added, strip it off.
1313     if (LHSC->getValue()->isZero()) {
1314       Ops.erase(Ops.begin());
1315       --Idx;
1316     }
1317
1318     if (Ops.size() == 1) return Ops[0];
1319   }
1320
1321   // Okay, check to see if the same value occurs in the operand list more than
1322   // once.  If so, merge them together into an multiply expression.  Since we
1323   // sorted the list, these values are required to be adjacent.
1324   const Type *Ty = Ops[0]->getType();
1325   bool FoundMatch = false;
1326   for (unsigned i = 0, e = Ops.size(); i != e-1; ++i)
1327     if (Ops[i] == Ops[i+1]) {      //  X + Y + Y  -->  X + Y*2
1328       // Scan ahead to count how many equal operands there are.
1329       unsigned Count = 2;
1330       while (i+Count != e && Ops[i+Count] == Ops[i])
1331         ++Count;
1332       // Merge the values into a multiply.
1333       const SCEV *Scale = getConstant(Ty, Count);
1334       const SCEV *Mul = getMulExpr(Scale, Ops[i]);
1335       if (Ops.size() == Count)
1336         return Mul;
1337       Ops[i] = Mul;
1338       Ops.erase(Ops.begin()+i+1, Ops.begin()+i+Count);
1339       --i; e -= Count - 1;
1340       FoundMatch = true;
1341     }
1342   if (FoundMatch)
1343     return getAddExpr(Ops, HasNUW, HasNSW);
1344
1345   // Check for truncates. If all the operands are truncated from the same
1346   // type, see if factoring out the truncate would permit the result to be
1347   // folded. eg., trunc(x) + m*trunc(n) --> trunc(x + trunc(m)*n)
1348   // if the contents of the resulting outer trunc fold to something simple.
1349   for (; Idx < Ops.size() && isa<SCEVTruncateExpr>(Ops[Idx]); ++Idx) {
1350     const SCEVTruncateExpr *Trunc = cast<SCEVTruncateExpr>(Ops[Idx]);
1351     const Type *DstType = Trunc->getType();
1352     const Type *SrcType = Trunc->getOperand()->getType();
1353     SmallVector<const SCEV *, 8> LargeOps;
1354     bool Ok = true;
1355     // Check all the operands to see if they can be represented in the
1356     // source type of the truncate.
1357     for (unsigned i = 0, e = Ops.size(); i != e; ++i) {
1358       if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(Ops[i])) {
1359         if (T->getOperand()->getType() != SrcType) {
1360           Ok = false;
1361           break;
1362         }
1363         LargeOps.push_back(T->getOperand());
1364       } else if (const SCEVConstant *C = dyn_cast<SCEVConstant>(Ops[i])) {
1365         LargeOps.push_back(getAnyExtendExpr(C, SrcType));
1366       } else if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(Ops[i])) {
1367         SmallVector<const SCEV *, 8> LargeMulOps;
1368         for (unsigned j = 0, f = M->getNumOperands(); j != f && Ok; ++j) {
1369           if (const SCEVTruncateExpr *T =
1370                 dyn_cast<SCEVTruncateExpr>(M->getOperand(j))) {
1371             if (T->getOperand()->getType() != SrcType) {
1372               Ok = false;
1373               break;
1374             }
1375             LargeMulOps.push_back(T->getOperand());
1376           } else if (const SCEVConstant *C =
1377                        dyn_cast<SCEVConstant>(M->getOperand(j))) {
1378             LargeMulOps.push_back(getAnyExtendExpr(C, SrcType));
1379           } else {
1380             Ok = false;
1381             break;
1382           }
1383         }
1384         if (Ok)
1385           LargeOps.push_back(getMulExpr(LargeMulOps));
1386       } else {
1387         Ok = false;
1388         break;
1389       }
1390     }
1391     if (Ok) {
1392       // Evaluate the expression in the larger type.
1393       const SCEV *Fold = getAddExpr(LargeOps, HasNUW, HasNSW);
1394       // If it folds to something simple, use it. Otherwise, don't.
1395       if (isa<SCEVConstant>(Fold) || isa<SCEVUnknown>(Fold))
1396         return getTruncateExpr(Fold, DstType);
1397     }
1398   }
1399
1400   // Skip past any other cast SCEVs.
1401   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddExpr)
1402     ++Idx;
1403
1404   // If there are add operands they would be next.
1405   if (Idx < Ops.size()) {
1406     bool DeletedAdd = false;
1407     while (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[Idx])) {
1408       // If we have an add, expand the add operands onto the end of the operands
1409       // list.
1410       Ops.erase(Ops.begin()+Idx);
1411       Ops.append(Add->op_begin(), Add->op_end());
1412       DeletedAdd = true;
1413     }
1414
1415     // If we deleted at least one add, we added operands to the end of the list,
1416     // and they are not necessarily sorted.  Recurse to resort and resimplify
1417     // any operands we just acquired.
1418     if (DeletedAdd)
1419       return getAddExpr(Ops);
1420   }
1421
1422   // Skip over the add expression until we get to a multiply.
1423   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr)
1424     ++Idx;
1425
1426   // Check to see if there are any folding opportunities present with
1427   // operands multiplied by constant values.
1428   if (Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx])) {
1429     uint64_t BitWidth = getTypeSizeInBits(Ty);
1430     DenseMap<const SCEV *, APInt> M;
1431     SmallVector<const SCEV *, 8> NewOps;
1432     APInt AccumulatedConstant(BitWidth, 0);
1433     if (CollectAddOperandsWithScales(M, NewOps, AccumulatedConstant,
1434                                      Ops.data(), Ops.size(),
1435                                      APInt(BitWidth, 1), *this)) {
1436       // Some interesting folding opportunity is present, so its worthwhile to
1437       // re-generate the operands list. Group the operands by constant scale,
1438       // to avoid multiplying by the same constant scale multiple times.
1439       std::map<APInt, SmallVector<const SCEV *, 4>, APIntCompare> MulOpLists;
1440       for (SmallVector<const SCEV *, 8>::const_iterator I = NewOps.begin(),
1441            E = NewOps.end(); I != E; ++I)
1442         MulOpLists[M.find(*I)->second].push_back(*I);
1443       // Re-generate the operands list.
1444       Ops.clear();
1445       if (AccumulatedConstant != 0)
1446         Ops.push_back(getConstant(AccumulatedConstant));
1447       for (std::map<APInt, SmallVector<const SCEV *, 4>, APIntCompare>::iterator
1448            I = MulOpLists.begin(), E = MulOpLists.end(); I != E; ++I)
1449         if (I->first != 0)
1450           Ops.push_back(getMulExpr(getConstant(I->first),
1451                                    getAddExpr(I->second)));
1452       if (Ops.empty())
1453         return getConstant(Ty, 0);
1454       if (Ops.size() == 1)
1455         return Ops[0];
1456       return getAddExpr(Ops);
1457     }
1458   }
1459
1460   // If we are adding something to a multiply expression, make sure the
1461   // something is not already an operand of the multiply.  If so, merge it into
1462   // the multiply.
1463   for (; Idx < Ops.size() && isa<SCEVMulExpr>(Ops[Idx]); ++Idx) {
1464     const SCEVMulExpr *Mul = cast<SCEVMulExpr>(Ops[Idx]);
1465     for (unsigned MulOp = 0, e = Mul->getNumOperands(); MulOp != e; ++MulOp) {
1466       const SCEV *MulOpSCEV = Mul->getOperand(MulOp);
1467       if (isa<SCEVConstant>(MulOpSCEV))
1468         continue;
1469       for (unsigned AddOp = 0, e = Ops.size(); AddOp != e; ++AddOp)
1470         if (MulOpSCEV == Ops[AddOp]) {
1471           // Fold W + X + (X * Y * Z)  -->  W + (X * ((Y*Z)+1))
1472           const SCEV *InnerMul = Mul->getOperand(MulOp == 0);
1473           if (Mul->getNumOperands() != 2) {
1474             // If the multiply has more than two operands, we must get the
1475             // Y*Z term.
1476             SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(),
1477                                                 Mul->op_begin()+MulOp);
1478             MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end());
1479             InnerMul = getMulExpr(MulOps);
1480           }
1481           const SCEV *One = getConstant(Ty, 1);
1482           const SCEV *AddOne = getAddExpr(One, InnerMul);
1483           const SCEV *OuterMul = getMulExpr(AddOne, MulOpSCEV);
1484           if (Ops.size() == 2) return OuterMul;
1485           if (AddOp < Idx) {
1486             Ops.erase(Ops.begin()+AddOp);
1487             Ops.erase(Ops.begin()+Idx-1);
1488           } else {
1489             Ops.erase(Ops.begin()+Idx);
1490             Ops.erase(Ops.begin()+AddOp-1);
1491           }
1492           Ops.push_back(OuterMul);
1493           return getAddExpr(Ops);
1494         }
1495
1496       // Check this multiply against other multiplies being added together.
1497       for (unsigned OtherMulIdx = Idx+1;
1498            OtherMulIdx < Ops.size() && isa<SCEVMulExpr>(Ops[OtherMulIdx]);
1499            ++OtherMulIdx) {
1500         const SCEVMulExpr *OtherMul = cast<SCEVMulExpr>(Ops[OtherMulIdx]);
1501         // If MulOp occurs in OtherMul, we can fold the two multiplies
1502         // together.
1503         for (unsigned OMulOp = 0, e = OtherMul->getNumOperands();
1504              OMulOp != e; ++OMulOp)
1505           if (OtherMul->getOperand(OMulOp) == MulOpSCEV) {
1506             // Fold X + (A*B*C) + (A*D*E) --> X + (A*(B*C+D*E))
1507             const SCEV *InnerMul1 = Mul->getOperand(MulOp == 0);
1508             if (Mul->getNumOperands() != 2) {
1509               SmallVector<const SCEV *, 4> MulOps(Mul->op_begin(),
1510                                                   Mul->op_begin()+MulOp);
1511               MulOps.append(Mul->op_begin()+MulOp+1, Mul->op_end());
1512               InnerMul1 = getMulExpr(MulOps);
1513             }
1514             const SCEV *InnerMul2 = OtherMul->getOperand(OMulOp == 0);
1515             if (OtherMul->getNumOperands() != 2) {
1516               SmallVector<const SCEV *, 4> MulOps(OtherMul->op_begin(),
1517                                                   OtherMul->op_begin()+OMulOp);
1518               MulOps.append(OtherMul->op_begin()+OMulOp+1, OtherMul->op_end());
1519               InnerMul2 = getMulExpr(MulOps);
1520             }
1521             const SCEV *InnerMulSum = getAddExpr(InnerMul1,InnerMul2);
1522             const SCEV *OuterMul = getMulExpr(MulOpSCEV, InnerMulSum);
1523             if (Ops.size() == 2) return OuterMul;
1524             Ops.erase(Ops.begin()+Idx);
1525             Ops.erase(Ops.begin()+OtherMulIdx-1);
1526             Ops.push_back(OuterMul);
1527             return getAddExpr(Ops);
1528           }
1529       }
1530     }
1531   }
1532
1533   // If there are any add recurrences in the operands list, see if any other
1534   // added values are loop invariant.  If so, we can fold them into the
1535   // recurrence.
1536   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr)
1537     ++Idx;
1538
1539   // Scan over all recurrences, trying to fold loop invariants into them.
1540   for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) {
1541     // Scan all of the other operands to this add and add them to the vector if
1542     // they are loop invariant w.r.t. the recurrence.
1543     SmallVector<const SCEV *, 8> LIOps;
1544     const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]);
1545     const Loop *AddRecLoop = AddRec->getLoop();
1546     for (unsigned i = 0, e = Ops.size(); i != e; ++i)
1547       if (isLoopInvariant(Ops[i], AddRecLoop)) {
1548         LIOps.push_back(Ops[i]);
1549         Ops.erase(Ops.begin()+i);
1550         --i; --e;
1551       }
1552
1553     // If we found some loop invariants, fold them into the recurrence.
1554     if (!LIOps.empty()) {
1555       //  NLI + LI + {Start,+,Step}  -->  NLI + {LI+Start,+,Step}
1556       LIOps.push_back(AddRec->getStart());
1557
1558       SmallVector<const SCEV *, 4> AddRecOps(AddRec->op_begin(),
1559                                              AddRec->op_end());
1560       AddRecOps[0] = getAddExpr(LIOps);
1561
1562       // Build the new addrec. Propagate the NUW and NSW flags if both the
1563       // outer add and the inner addrec are guaranteed to have no overflow.
1564       const SCEV *NewRec = getAddRecExpr(AddRecOps, AddRecLoop,
1565                                          HasNUW && AddRec->hasNoUnsignedWrap(),
1566                                          HasNSW && AddRec->hasNoSignedWrap());
1567
1568       // If all of the other operands were loop invariant, we are done.
1569       if (Ops.size() == 1) return NewRec;
1570
1571       // Otherwise, add the folded AddRec by the non-liv parts.
1572       for (unsigned i = 0;; ++i)
1573         if (Ops[i] == AddRec) {
1574           Ops[i] = NewRec;
1575           break;
1576         }
1577       return getAddExpr(Ops);
1578     }
1579
1580     // Okay, if there weren't any loop invariants to be folded, check to see if
1581     // there are multiple AddRec's with the same loop induction variable being
1582     // added together.  If so, we can fold them.
1583     for (unsigned OtherIdx = Idx+1;
1584          OtherIdx < Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
1585          ++OtherIdx)
1586       if (AddRecLoop == cast<SCEVAddRecExpr>(Ops[OtherIdx])->getLoop()) {
1587         // Other + {A,+,B}<L> + {C,+,D}<L>  -->  Other + {A+C,+,B+D}<L>
1588         SmallVector<const SCEV *, 4> AddRecOps(AddRec->op_begin(),
1589                                                AddRec->op_end());
1590         for (; OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
1591              ++OtherIdx)
1592           if (const SCEVAddRecExpr *OtherAddRec =
1593                 dyn_cast<SCEVAddRecExpr>(Ops[OtherIdx]))
1594             if (OtherAddRec->getLoop() == AddRecLoop) {
1595               for (unsigned i = 0, e = OtherAddRec->getNumOperands();
1596                    i != e; ++i) {
1597                 if (i >= AddRecOps.size()) {
1598                   AddRecOps.append(OtherAddRec->op_begin()+i,
1599                                    OtherAddRec->op_end());
1600                   break;
1601                 }
1602                 AddRecOps[i] = getAddExpr(AddRecOps[i],
1603                                           OtherAddRec->getOperand(i));
1604               }
1605               Ops.erase(Ops.begin() + OtherIdx); --OtherIdx;
1606             }
1607         Ops[Idx] = getAddRecExpr(AddRecOps, AddRecLoop);
1608         return getAddExpr(Ops);
1609       }
1610
1611     // Otherwise couldn't fold anything into this recurrence.  Move onto the
1612     // next one.
1613   }
1614
1615   // Okay, it looks like we really DO need an add expr.  Check to see if we
1616   // already have one, otherwise create a new one.
1617   FoldingSetNodeID ID;
1618   ID.AddInteger(scAddExpr);
1619   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
1620     ID.AddPointer(Ops[i]);
1621   void *IP = 0;
1622   SCEVAddExpr *S =
1623     static_cast<SCEVAddExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
1624   if (!S) {
1625     const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
1626     std::uninitialized_copy(Ops.begin(), Ops.end(), O);
1627     S = new (SCEVAllocator) SCEVAddExpr(ID.Intern(SCEVAllocator),
1628                                         O, Ops.size());
1629     UniqueSCEVs.InsertNode(S, IP);
1630   }
1631   if (HasNUW) S->setHasNoUnsignedWrap(true);
1632   if (HasNSW) S->setHasNoSignedWrap(true);
1633   return S;
1634 }
1635
1636 /// getMulExpr - Get a canonical multiply expression, or something simpler if
1637 /// possible.
1638 const SCEV *ScalarEvolution::getMulExpr(SmallVectorImpl<const SCEV *> &Ops,
1639                                         bool HasNUW, bool HasNSW) {
1640   assert(!Ops.empty() && "Cannot get empty mul!");
1641   if (Ops.size() == 1) return Ops[0];
1642 #ifndef NDEBUG
1643   const Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
1644   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
1645     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
1646            "SCEVMulExpr operand types don't match!");
1647 #endif
1648
1649   // If HasNSW is true and all the operands are non-negative, infer HasNUW.
1650   if (!HasNUW && HasNSW) {
1651     bool All = true;
1652     for (SmallVectorImpl<const SCEV *>::const_iterator I = Ops.begin(),
1653          E = Ops.end(); I != E; ++I)
1654       if (!isKnownNonNegative(*I)) {
1655         All = false;
1656         break;
1657       }
1658     if (All) HasNUW = true;
1659   }
1660
1661   // Sort by complexity, this groups all similar expression types together.
1662   GroupByComplexity(Ops, LI);
1663
1664   // If there are any constants, fold them together.
1665   unsigned Idx = 0;
1666   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
1667
1668     // C1*(C2+V) -> C1*C2 + C1*V
1669     if (Ops.size() == 2)
1670       if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1]))
1671         if (Add->getNumOperands() == 2 &&
1672             isa<SCEVConstant>(Add->getOperand(0)))
1673           return getAddExpr(getMulExpr(LHSC, Add->getOperand(0)),
1674                             getMulExpr(LHSC, Add->getOperand(1)));
1675
1676     ++Idx;
1677     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
1678       // We found two constants, fold them together!
1679       ConstantInt *Fold = ConstantInt::get(getContext(),
1680                                            LHSC->getValue()->getValue() *
1681                                            RHSC->getValue()->getValue());
1682       Ops[0] = getConstant(Fold);
1683       Ops.erase(Ops.begin()+1);  // Erase the folded element
1684       if (Ops.size() == 1) return Ops[0];
1685       LHSC = cast<SCEVConstant>(Ops[0]);
1686     }
1687
1688     // If we are left with a constant one being multiplied, strip it off.
1689     if (cast<SCEVConstant>(Ops[0])->getValue()->equalsInt(1)) {
1690       Ops.erase(Ops.begin());
1691       --Idx;
1692     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isZero()) {
1693       // If we have a multiply of zero, it will always be zero.
1694       return Ops[0];
1695     } else if (Ops[0]->isAllOnesValue()) {
1696       // If we have a mul by -1 of an add, try distributing the -1 among the
1697       // add operands.
1698       if (Ops.size() == 2)
1699         if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(Ops[1])) {
1700           SmallVector<const SCEV *, 4> NewOps;
1701           bool AnyFolded = false;
1702           for (SCEVAddRecExpr::op_iterator I = Add->op_begin(), E = Add->op_end();
1703                I != E; ++I) {
1704             const SCEV *Mul = getMulExpr(Ops[0], *I);
1705             if (!isa<SCEVMulExpr>(Mul)) AnyFolded = true;
1706             NewOps.push_back(Mul);
1707           }
1708           if (AnyFolded)
1709             return getAddExpr(NewOps);
1710         }
1711     }
1712
1713     if (Ops.size() == 1)
1714       return Ops[0];
1715   }
1716
1717   // Skip over the add expression until we get to a multiply.
1718   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scMulExpr)
1719     ++Idx;
1720
1721   // If there are mul operands inline them all into this expression.
1722   if (Idx < Ops.size()) {
1723     bool DeletedMul = false;
1724     while (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(Ops[Idx])) {
1725       // If we have an mul, expand the mul operands onto the end of the operands
1726       // list.
1727       Ops.erase(Ops.begin()+Idx);
1728       Ops.append(Mul->op_begin(), Mul->op_end());
1729       DeletedMul = true;
1730     }
1731
1732     // If we deleted at least one mul, we added operands to the end of the list,
1733     // and they are not necessarily sorted.  Recurse to resort and resimplify
1734     // any operands we just acquired.
1735     if (DeletedMul)
1736       return getMulExpr(Ops);
1737   }
1738
1739   // If there are any add recurrences in the operands list, see if any other
1740   // added values are loop invariant.  If so, we can fold them into the
1741   // recurrence.
1742   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scAddRecExpr)
1743     ++Idx;
1744
1745   // Scan over all recurrences, trying to fold loop invariants into them.
1746   for (; Idx < Ops.size() && isa<SCEVAddRecExpr>(Ops[Idx]); ++Idx) {
1747     // Scan all of the other operands to this mul and add them to the vector if
1748     // they are loop invariant w.r.t. the recurrence.
1749     SmallVector<const SCEV *, 8> LIOps;
1750     const SCEVAddRecExpr *AddRec = cast<SCEVAddRecExpr>(Ops[Idx]);
1751     const Loop *AddRecLoop = AddRec->getLoop();
1752     for (unsigned i = 0, e = Ops.size(); i != e; ++i)
1753       if (isLoopInvariant(Ops[i], AddRecLoop)) {
1754         LIOps.push_back(Ops[i]);
1755         Ops.erase(Ops.begin()+i);
1756         --i; --e;
1757       }
1758
1759     // If we found some loop invariants, fold them into the recurrence.
1760     if (!LIOps.empty()) {
1761       //  NLI * LI * {Start,+,Step}  -->  NLI * {LI*Start,+,LI*Step}
1762       SmallVector<const SCEV *, 4> NewOps;
1763       NewOps.reserve(AddRec->getNumOperands());
1764       const SCEV *Scale = getMulExpr(LIOps);
1765       for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i)
1766         NewOps.push_back(getMulExpr(Scale, AddRec->getOperand(i)));
1767
1768       // Build the new addrec. Propagate the NUW and NSW flags if both the
1769       // outer mul and the inner addrec are guaranteed to have no overflow.
1770       const SCEV *NewRec = getAddRecExpr(NewOps, AddRecLoop,
1771                                          HasNUW && AddRec->hasNoUnsignedWrap(),
1772                                          HasNSW && AddRec->hasNoSignedWrap());
1773
1774       // If all of the other operands were loop invariant, we are done.
1775       if (Ops.size() == 1) return NewRec;
1776
1777       // Otherwise, multiply the folded AddRec by the non-liv parts.
1778       for (unsigned i = 0;; ++i)
1779         if (Ops[i] == AddRec) {
1780           Ops[i] = NewRec;
1781           break;
1782         }
1783       return getMulExpr(Ops);
1784     }
1785
1786     // Okay, if there weren't any loop invariants to be folded, check to see if
1787     // there are multiple AddRec's with the same loop induction variable being
1788     // multiplied together.  If so, we can fold them.
1789     for (unsigned OtherIdx = Idx+1;
1790          OtherIdx < Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
1791          ++OtherIdx)
1792       if (AddRecLoop == cast<SCEVAddRecExpr>(Ops[OtherIdx])->getLoop()) {
1793         // F * G, where F = {A,+,B}<L> and G = {C,+,D}<L>  -->
1794         // {A*C,+,F*D + G*B + B*D}<L>
1795         for (; OtherIdx != Ops.size() && isa<SCEVAddRecExpr>(Ops[OtherIdx]);
1796              ++OtherIdx)
1797           if (const SCEVAddRecExpr *OtherAddRec =
1798                 dyn_cast<SCEVAddRecExpr>(Ops[OtherIdx]))
1799             if (OtherAddRec->getLoop() == AddRecLoop) {
1800               const SCEVAddRecExpr *F = AddRec, *G = OtherAddRec;
1801               const SCEV *NewStart = getMulExpr(F->getStart(), G->getStart());
1802               const SCEV *B = F->getStepRecurrence(*this);
1803               const SCEV *D = G->getStepRecurrence(*this);
1804               const SCEV *NewStep = getAddExpr(getMulExpr(F, D),
1805                                                getMulExpr(G, B),
1806                                                getMulExpr(B, D));
1807               const SCEV *NewAddRec = getAddRecExpr(NewStart, NewStep,
1808                                                     F->getLoop());
1809               if (Ops.size() == 2) return NewAddRec;
1810               Ops[Idx] = AddRec = cast<SCEVAddRecExpr>(NewAddRec);
1811               Ops.erase(Ops.begin() + OtherIdx); --OtherIdx;
1812             }
1813         return getMulExpr(Ops);
1814       }
1815
1816     // Otherwise couldn't fold anything into this recurrence.  Move onto the
1817     // next one.
1818   }
1819
1820   // Okay, it looks like we really DO need an mul expr.  Check to see if we
1821   // already have one, otherwise create a new one.
1822   FoldingSetNodeID ID;
1823   ID.AddInteger(scMulExpr);
1824   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
1825     ID.AddPointer(Ops[i]);
1826   void *IP = 0;
1827   SCEVMulExpr *S =
1828     static_cast<SCEVMulExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
1829   if (!S) {
1830     const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
1831     std::uninitialized_copy(Ops.begin(), Ops.end(), O);
1832     S = new (SCEVAllocator) SCEVMulExpr(ID.Intern(SCEVAllocator),
1833                                         O, Ops.size());
1834     UniqueSCEVs.InsertNode(S, IP);
1835   }
1836   if (HasNUW) S->setHasNoUnsignedWrap(true);
1837   if (HasNSW) S->setHasNoSignedWrap(true);
1838   return S;
1839 }
1840
1841 /// getUDivExpr - Get a canonical unsigned division expression, or something
1842 /// simpler if possible.
1843 const SCEV *ScalarEvolution::getUDivExpr(const SCEV *LHS,
1844                                          const SCEV *RHS) {
1845   assert(getEffectiveSCEVType(LHS->getType()) ==
1846          getEffectiveSCEVType(RHS->getType()) &&
1847          "SCEVUDivExpr operand types don't match!");
1848
1849   if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
1850     if (RHSC->getValue()->equalsInt(1))
1851       return LHS;                               // X udiv 1 --> x
1852     // If the denominator is zero, the result of the udiv is undefined. Don't
1853     // try to analyze it, because the resolution chosen here may differ from
1854     // the resolution chosen in other parts of the compiler.
1855     if (!RHSC->getValue()->isZero()) {
1856       // Determine if the division can be folded into the operands of
1857       // its operands.
1858       // TODO: Generalize this to non-constants by using known-bits information.
1859       const Type *Ty = LHS->getType();
1860       unsigned LZ = RHSC->getValue()->getValue().countLeadingZeros();
1861       unsigned MaxShiftAmt = getTypeSizeInBits(Ty) - LZ - 1;
1862       // For non-power-of-two values, effectively round the value up to the
1863       // nearest power of two.
1864       if (!RHSC->getValue()->getValue().isPowerOf2())
1865         ++MaxShiftAmt;
1866       const IntegerType *ExtTy =
1867         IntegerType::get(getContext(), getTypeSizeInBits(Ty) + MaxShiftAmt);
1868       // {X,+,N}/C --> {X/C,+,N/C} if safe and N/C can be folded.
1869       if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(LHS))
1870         if (const SCEVConstant *Step =
1871               dyn_cast<SCEVConstant>(AR->getStepRecurrence(*this)))
1872           if (!Step->getValue()->getValue()
1873                 .urem(RHSC->getValue()->getValue()) &&
1874               getZeroExtendExpr(AR, ExtTy) ==
1875               getAddRecExpr(getZeroExtendExpr(AR->getStart(), ExtTy),
1876                             getZeroExtendExpr(Step, ExtTy),
1877                             AR->getLoop())) {
1878             SmallVector<const SCEV *, 4> Operands;
1879             for (unsigned i = 0, e = AR->getNumOperands(); i != e; ++i)
1880               Operands.push_back(getUDivExpr(AR->getOperand(i), RHS));
1881             return getAddRecExpr(Operands, AR->getLoop());
1882           }
1883       // (A*B)/C --> A*(B/C) if safe and B/C can be folded.
1884       if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(LHS)) {
1885         SmallVector<const SCEV *, 4> Operands;
1886         for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i)
1887           Operands.push_back(getZeroExtendExpr(M->getOperand(i), ExtTy));
1888         if (getZeroExtendExpr(M, ExtTy) == getMulExpr(Operands))
1889           // Find an operand that's safely divisible.
1890           for (unsigned i = 0, e = M->getNumOperands(); i != e; ++i) {
1891             const SCEV *Op = M->getOperand(i);
1892             const SCEV *Div = getUDivExpr(Op, RHSC);
1893             if (!isa<SCEVUDivExpr>(Div) && getMulExpr(Div, RHSC) == Op) {
1894               Operands = SmallVector<const SCEV *, 4>(M->op_begin(),
1895                                                       M->op_end());
1896               Operands[i] = Div;
1897               return getMulExpr(Operands);
1898             }
1899           }
1900       }
1901       // (A+B)/C --> (A/C + B/C) if safe and A/C and B/C can be folded.
1902       if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(LHS)) {
1903         SmallVector<const SCEV *, 4> Operands;
1904         for (unsigned i = 0, e = A->getNumOperands(); i != e; ++i)
1905           Operands.push_back(getZeroExtendExpr(A->getOperand(i), ExtTy));
1906         if (getZeroExtendExpr(A, ExtTy) == getAddExpr(Operands)) {
1907           Operands.clear();
1908           for (unsigned i = 0, e = A->getNumOperands(); i != e; ++i) {
1909             const SCEV *Op = getUDivExpr(A->getOperand(i), RHS);
1910             if (isa<SCEVUDivExpr>(Op) ||
1911                 getMulExpr(Op, RHS) != A->getOperand(i))
1912               break;
1913             Operands.push_back(Op);
1914           }
1915           if (Operands.size() == A->getNumOperands())
1916             return getAddExpr(Operands);
1917         }
1918       }
1919
1920       // Fold if both operands are constant.
1921       if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
1922         Constant *LHSCV = LHSC->getValue();
1923         Constant *RHSCV = RHSC->getValue();
1924         return getConstant(cast<ConstantInt>(ConstantExpr::getUDiv(LHSCV,
1925                                                                    RHSCV)));
1926       }
1927     }
1928   }
1929
1930   FoldingSetNodeID ID;
1931   ID.AddInteger(scUDivExpr);
1932   ID.AddPointer(LHS);
1933   ID.AddPointer(RHS);
1934   void *IP = 0;
1935   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
1936   SCEV *S = new (SCEVAllocator) SCEVUDivExpr(ID.Intern(SCEVAllocator),
1937                                              LHS, RHS);
1938   UniqueSCEVs.InsertNode(S, IP);
1939   return S;
1940 }
1941
1942
1943 /// getAddRecExpr - Get an add recurrence expression for the specified loop.
1944 /// Simplify the expression as much as possible.
1945 const SCEV *ScalarEvolution::getAddRecExpr(const SCEV *Start,
1946                                            const SCEV *Step, const Loop *L,
1947                                            bool HasNUW, bool HasNSW) {
1948   SmallVector<const SCEV *, 4> Operands;
1949   Operands.push_back(Start);
1950   if (const SCEVAddRecExpr *StepChrec = dyn_cast<SCEVAddRecExpr>(Step))
1951     if (StepChrec->getLoop() == L) {
1952       Operands.append(StepChrec->op_begin(), StepChrec->op_end());
1953       return getAddRecExpr(Operands, L);
1954     }
1955
1956   Operands.push_back(Step);
1957   return getAddRecExpr(Operands, L, HasNUW, HasNSW);
1958 }
1959
1960 /// getAddRecExpr - Get an add recurrence expression for the specified loop.
1961 /// Simplify the expression as much as possible.
1962 const SCEV *
1963 ScalarEvolution::getAddRecExpr(SmallVectorImpl<const SCEV *> &Operands,
1964                                const Loop *L,
1965                                bool HasNUW, bool HasNSW) {
1966   if (Operands.size() == 1) return Operands[0];
1967 #ifndef NDEBUG
1968   const Type *ETy = getEffectiveSCEVType(Operands[0]->getType());
1969   for (unsigned i = 1, e = Operands.size(); i != e; ++i)
1970     assert(getEffectiveSCEVType(Operands[i]->getType()) == ETy &&
1971            "SCEVAddRecExpr operand types don't match!");
1972   for (unsigned i = 0, e = Operands.size(); i != e; ++i)
1973     assert(isLoopInvariant(Operands[i], L) &&
1974            "SCEVAddRecExpr operand is not loop-invariant!");
1975 #endif
1976
1977   if (Operands.back()->isZero()) {
1978     Operands.pop_back();
1979     return getAddRecExpr(Operands, L, HasNUW, HasNSW); // {X,+,0}  -->  X
1980   }
1981
1982   // It's tempting to want to call getMaxBackedgeTakenCount count here and
1983   // use that information to infer NUW and NSW flags. However, computing a
1984   // BE count requires calling getAddRecExpr, so we may not yet have a
1985   // meaningful BE count at this point (and if we don't, we'd be stuck
1986   // with a SCEVCouldNotCompute as the cached BE count).
1987
1988   // If HasNSW is true and all the operands are non-negative, infer HasNUW.
1989   if (!HasNUW && HasNSW) {
1990     bool All = true;
1991     for (SmallVectorImpl<const SCEV *>::const_iterator I = Operands.begin(),
1992          E = Operands.end(); I != E; ++I)
1993       if (!isKnownNonNegative(*I)) {
1994         All = false;
1995         break;
1996       }
1997     if (All) HasNUW = true;
1998   }
1999
2000   // Canonicalize nested AddRecs in by nesting them in order of loop depth.
2001   if (const SCEVAddRecExpr *NestedAR = dyn_cast<SCEVAddRecExpr>(Operands[0])) {
2002     const Loop *NestedLoop = NestedAR->getLoop();
2003     if (L->contains(NestedLoop) ?
2004         (L->getLoopDepth() < NestedLoop->getLoopDepth()) :
2005         (!NestedLoop->contains(L) &&
2006          DT->dominates(L->getHeader(), NestedLoop->getHeader()))) {
2007       SmallVector<const SCEV *, 4> NestedOperands(NestedAR->op_begin(),
2008                                                   NestedAR->op_end());
2009       Operands[0] = NestedAR->getStart();
2010       // AddRecs require their operands be loop-invariant with respect to their
2011       // loops. Don't perform this transformation if it would break this
2012       // requirement.
2013       bool AllInvariant = true;
2014       for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2015         if (!isLoopInvariant(Operands[i], L)) {
2016           AllInvariant = false;
2017           break;
2018         }
2019       if (AllInvariant) {
2020         NestedOperands[0] = getAddRecExpr(Operands, L);
2021         AllInvariant = true;
2022         for (unsigned i = 0, e = NestedOperands.size(); i != e; ++i)
2023           if (!isLoopInvariant(NestedOperands[i], NestedLoop)) {
2024             AllInvariant = false;
2025             break;
2026           }
2027         if (AllInvariant)
2028           // Ok, both add recurrences are valid after the transformation.
2029           return getAddRecExpr(NestedOperands, NestedLoop, HasNUW, HasNSW);
2030       }
2031       // Reset Operands to its original state.
2032       Operands[0] = NestedAR;
2033     }
2034   }
2035
2036   // Okay, it looks like we really DO need an addrec expr.  Check to see if we
2037   // already have one, otherwise create a new one.
2038   FoldingSetNodeID ID;
2039   ID.AddInteger(scAddRecExpr);
2040   for (unsigned i = 0, e = Operands.size(); i != e; ++i)
2041     ID.AddPointer(Operands[i]);
2042   ID.AddPointer(L);
2043   void *IP = 0;
2044   SCEVAddRecExpr *S =
2045     static_cast<SCEVAddRecExpr *>(UniqueSCEVs.FindNodeOrInsertPos(ID, IP));
2046   if (!S) {
2047     const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Operands.size());
2048     std::uninitialized_copy(Operands.begin(), Operands.end(), O);
2049     S = new (SCEVAllocator) SCEVAddRecExpr(ID.Intern(SCEVAllocator),
2050                                            O, Operands.size(), L);
2051     UniqueSCEVs.InsertNode(S, IP);
2052   }
2053   if (HasNUW) S->setHasNoUnsignedWrap(true);
2054   if (HasNSW) S->setHasNoSignedWrap(true);
2055   return S;
2056 }
2057
2058 const SCEV *ScalarEvolution::getSMaxExpr(const SCEV *LHS,
2059                                          const SCEV *RHS) {
2060   SmallVector<const SCEV *, 2> Ops;
2061   Ops.push_back(LHS);
2062   Ops.push_back(RHS);
2063   return getSMaxExpr(Ops);
2064 }
2065
2066 const SCEV *
2067 ScalarEvolution::getSMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
2068   assert(!Ops.empty() && "Cannot get empty smax!");
2069   if (Ops.size() == 1) return Ops[0];
2070 #ifndef NDEBUG
2071   const Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
2072   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
2073     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
2074            "SCEVSMaxExpr operand types don't match!");
2075 #endif
2076
2077   // Sort by complexity, this groups all similar expression types together.
2078   GroupByComplexity(Ops, LI);
2079
2080   // If there are any constants, fold them together.
2081   unsigned Idx = 0;
2082   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
2083     ++Idx;
2084     assert(Idx < Ops.size());
2085     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
2086       // We found two constants, fold them together!
2087       ConstantInt *Fold = ConstantInt::get(getContext(),
2088                               APIntOps::smax(LHSC->getValue()->getValue(),
2089                                              RHSC->getValue()->getValue()));
2090       Ops[0] = getConstant(Fold);
2091       Ops.erase(Ops.begin()+1);  // Erase the folded element
2092       if (Ops.size() == 1) return Ops[0];
2093       LHSC = cast<SCEVConstant>(Ops[0]);
2094     }
2095
2096     // If we are left with a constant minimum-int, strip it off.
2097     if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(true)) {
2098       Ops.erase(Ops.begin());
2099       --Idx;
2100     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(true)) {
2101       // If we have an smax with a constant maximum-int, it will always be
2102       // maximum-int.
2103       return Ops[0];
2104     }
2105
2106     if (Ops.size() == 1) return Ops[0];
2107   }
2108
2109   // Find the first SMax
2110   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scSMaxExpr)
2111     ++Idx;
2112
2113   // Check to see if one of the operands is an SMax. If so, expand its operands
2114   // onto our operand list, and recurse to simplify.
2115   if (Idx < Ops.size()) {
2116     bool DeletedSMax = false;
2117     while (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(Ops[Idx])) {
2118       Ops.erase(Ops.begin()+Idx);
2119       Ops.append(SMax->op_begin(), SMax->op_end());
2120       DeletedSMax = true;
2121     }
2122
2123     if (DeletedSMax)
2124       return getSMaxExpr(Ops);
2125   }
2126
2127   // Okay, check to see if the same value occurs in the operand list twice.  If
2128   // so, delete one.  Since we sorted the list, these values are required to
2129   // be adjacent.
2130   for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
2131     //  X smax Y smax Y  -->  X smax Y
2132     //  X smax Y         -->  X, if X is always greater than Y
2133     if (Ops[i] == Ops[i+1] ||
2134         isKnownPredicate(ICmpInst::ICMP_SGE, Ops[i], Ops[i+1])) {
2135       Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
2136       --i; --e;
2137     } else if (isKnownPredicate(ICmpInst::ICMP_SLE, Ops[i], Ops[i+1])) {
2138       Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
2139       --i; --e;
2140     }
2141
2142   if (Ops.size() == 1) return Ops[0];
2143
2144   assert(!Ops.empty() && "Reduced smax down to nothing!");
2145
2146   // Okay, it looks like we really DO need an smax expr.  Check to see if we
2147   // already have one, otherwise create a new one.
2148   FoldingSetNodeID ID;
2149   ID.AddInteger(scSMaxExpr);
2150   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2151     ID.AddPointer(Ops[i]);
2152   void *IP = 0;
2153   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
2154   const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
2155   std::uninitialized_copy(Ops.begin(), Ops.end(), O);
2156   SCEV *S = new (SCEVAllocator) SCEVSMaxExpr(ID.Intern(SCEVAllocator),
2157                                              O, Ops.size());
2158   UniqueSCEVs.InsertNode(S, IP);
2159   return S;
2160 }
2161
2162 const SCEV *ScalarEvolution::getUMaxExpr(const SCEV *LHS,
2163                                          const SCEV *RHS) {
2164   SmallVector<const SCEV *, 2> Ops;
2165   Ops.push_back(LHS);
2166   Ops.push_back(RHS);
2167   return getUMaxExpr(Ops);
2168 }
2169
2170 const SCEV *
2171 ScalarEvolution::getUMaxExpr(SmallVectorImpl<const SCEV *> &Ops) {
2172   assert(!Ops.empty() && "Cannot get empty umax!");
2173   if (Ops.size() == 1) return Ops[0];
2174 #ifndef NDEBUG
2175   const Type *ETy = getEffectiveSCEVType(Ops[0]->getType());
2176   for (unsigned i = 1, e = Ops.size(); i != e; ++i)
2177     assert(getEffectiveSCEVType(Ops[i]->getType()) == ETy &&
2178            "SCEVUMaxExpr operand types don't match!");
2179 #endif
2180
2181   // Sort by complexity, this groups all similar expression types together.
2182   GroupByComplexity(Ops, LI);
2183
2184   // If there are any constants, fold them together.
2185   unsigned Idx = 0;
2186   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(Ops[0])) {
2187     ++Idx;
2188     assert(Idx < Ops.size());
2189     while (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(Ops[Idx])) {
2190       // We found two constants, fold them together!
2191       ConstantInt *Fold = ConstantInt::get(getContext(),
2192                               APIntOps::umax(LHSC->getValue()->getValue(),
2193                                              RHSC->getValue()->getValue()));
2194       Ops[0] = getConstant(Fold);
2195       Ops.erase(Ops.begin()+1);  // Erase the folded element
2196       if (Ops.size() == 1) return Ops[0];
2197       LHSC = cast<SCEVConstant>(Ops[0]);
2198     }
2199
2200     // If we are left with a constant minimum-int, strip it off.
2201     if (cast<SCEVConstant>(Ops[0])->getValue()->isMinValue(false)) {
2202       Ops.erase(Ops.begin());
2203       --Idx;
2204     } else if (cast<SCEVConstant>(Ops[0])->getValue()->isMaxValue(false)) {
2205       // If we have an umax with a constant maximum-int, it will always be
2206       // maximum-int.
2207       return Ops[0];
2208     }
2209
2210     if (Ops.size() == 1) return Ops[0];
2211   }
2212
2213   // Find the first UMax
2214   while (Idx < Ops.size() && Ops[Idx]->getSCEVType() < scUMaxExpr)
2215     ++Idx;
2216
2217   // Check to see if one of the operands is a UMax. If so, expand its operands
2218   // onto our operand list, and recurse to simplify.
2219   if (Idx < Ops.size()) {
2220     bool DeletedUMax = false;
2221     while (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(Ops[Idx])) {
2222       Ops.erase(Ops.begin()+Idx);
2223       Ops.append(UMax->op_begin(), UMax->op_end());
2224       DeletedUMax = true;
2225     }
2226
2227     if (DeletedUMax)
2228       return getUMaxExpr(Ops);
2229   }
2230
2231   // Okay, check to see if the same value occurs in the operand list twice.  If
2232   // so, delete one.  Since we sorted the list, these values are required to
2233   // be adjacent.
2234   for (unsigned i = 0, e = Ops.size()-1; i != e; ++i)
2235     //  X umax Y umax Y  -->  X umax Y
2236     //  X umax Y         -->  X, if X is always greater than Y
2237     if (Ops[i] == Ops[i+1] ||
2238         isKnownPredicate(ICmpInst::ICMP_UGE, Ops[i], Ops[i+1])) {
2239       Ops.erase(Ops.begin()+i+1, Ops.begin()+i+2);
2240       --i; --e;
2241     } else if (isKnownPredicate(ICmpInst::ICMP_ULE, Ops[i], Ops[i+1])) {
2242       Ops.erase(Ops.begin()+i, Ops.begin()+i+1);
2243       --i; --e;
2244     }
2245
2246   if (Ops.size() == 1) return Ops[0];
2247
2248   assert(!Ops.empty() && "Reduced umax down to nothing!");
2249
2250   // Okay, it looks like we really DO need a umax expr.  Check to see if we
2251   // already have one, otherwise create a new one.
2252   FoldingSetNodeID ID;
2253   ID.AddInteger(scUMaxExpr);
2254   for (unsigned i = 0, e = Ops.size(); i != e; ++i)
2255     ID.AddPointer(Ops[i]);
2256   void *IP = 0;
2257   if (const SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) return S;
2258   const SCEV **O = SCEVAllocator.Allocate<const SCEV *>(Ops.size());
2259   std::uninitialized_copy(Ops.begin(), Ops.end(), O);
2260   SCEV *S = new (SCEVAllocator) SCEVUMaxExpr(ID.Intern(SCEVAllocator),
2261                                              O, Ops.size());
2262   UniqueSCEVs.InsertNode(S, IP);
2263   return S;
2264 }
2265
2266 const SCEV *ScalarEvolution::getSMinExpr(const SCEV *LHS,
2267                                          const SCEV *RHS) {
2268   // ~smax(~x, ~y) == smin(x, y).
2269   return getNotSCEV(getSMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
2270 }
2271
2272 const SCEV *ScalarEvolution::getUMinExpr(const SCEV *LHS,
2273                                          const SCEV *RHS) {
2274   // ~umax(~x, ~y) == umin(x, y)
2275   return getNotSCEV(getUMaxExpr(getNotSCEV(LHS), getNotSCEV(RHS)));
2276 }
2277
2278 const SCEV *ScalarEvolution::getSizeOfExpr(const Type *AllocTy) {
2279   // If we have TargetData, we can bypass creating a target-independent
2280   // constant expression and then folding it back into a ConstantInt.
2281   // This is just a compile-time optimization.
2282   if (TD)
2283     return getConstant(TD->getIntPtrType(getContext()),
2284                        TD->getTypeAllocSize(AllocTy));
2285
2286   Constant *C = ConstantExpr::getSizeOf(AllocTy);
2287   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
2288     if (Constant *Folded = ConstantFoldConstantExpression(CE, TD))
2289       C = Folded;
2290   const Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(AllocTy));
2291   return getTruncateOrZeroExtend(getSCEV(C), Ty);
2292 }
2293
2294 const SCEV *ScalarEvolution::getAlignOfExpr(const Type *AllocTy) {
2295   Constant *C = ConstantExpr::getAlignOf(AllocTy);
2296   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
2297     if (Constant *Folded = ConstantFoldConstantExpression(CE, TD))
2298       C = Folded;
2299   const Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(AllocTy));
2300   return getTruncateOrZeroExtend(getSCEV(C), Ty);
2301 }
2302
2303 const SCEV *ScalarEvolution::getOffsetOfExpr(const StructType *STy,
2304                                              unsigned FieldNo) {
2305   // If we have TargetData, we can bypass creating a target-independent
2306   // constant expression and then folding it back into a ConstantInt.
2307   // This is just a compile-time optimization.
2308   if (TD)
2309     return getConstant(TD->getIntPtrType(getContext()),
2310                        TD->getStructLayout(STy)->getElementOffset(FieldNo));
2311
2312   Constant *C = ConstantExpr::getOffsetOf(STy, FieldNo);
2313   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
2314     if (Constant *Folded = ConstantFoldConstantExpression(CE, TD))
2315       C = Folded;
2316   const Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(STy));
2317   return getTruncateOrZeroExtend(getSCEV(C), Ty);
2318 }
2319
2320 const SCEV *ScalarEvolution::getOffsetOfExpr(const Type *CTy,
2321                                              Constant *FieldNo) {
2322   Constant *C = ConstantExpr::getOffsetOf(CTy, FieldNo);
2323   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
2324     if (Constant *Folded = ConstantFoldConstantExpression(CE, TD))
2325       C = Folded;
2326   const Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(CTy));
2327   return getTruncateOrZeroExtend(getSCEV(C), Ty);
2328 }
2329
2330 const SCEV *ScalarEvolution::getUnknown(Value *V) {
2331   // Don't attempt to do anything other than create a SCEVUnknown object
2332   // here.  createSCEV only calls getUnknown after checking for all other
2333   // interesting possibilities, and any other code that calls getUnknown
2334   // is doing so in order to hide a value from SCEV canonicalization.
2335
2336   FoldingSetNodeID ID;
2337   ID.AddInteger(scUnknown);
2338   ID.AddPointer(V);
2339   void *IP = 0;
2340   if (SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) {
2341     assert(cast<SCEVUnknown>(S)->getValue() == V &&
2342            "Stale SCEVUnknown in uniquing map!");
2343     return S;
2344   }
2345   SCEV *S = new (SCEVAllocator) SCEVUnknown(ID.Intern(SCEVAllocator), V, this,
2346                                             FirstUnknown);
2347   FirstUnknown = cast<SCEVUnknown>(S);
2348   UniqueSCEVs.InsertNode(S, IP);
2349   return S;
2350 }
2351
2352 //===----------------------------------------------------------------------===//
2353 //            Basic SCEV Analysis and PHI Idiom Recognition Code
2354 //
2355
2356 /// isSCEVable - Test if values of the given type are analyzable within
2357 /// the SCEV framework. This primarily includes integer types, and it
2358 /// can optionally include pointer types if the ScalarEvolution class
2359 /// has access to target-specific information.
2360 bool ScalarEvolution::isSCEVable(const Type *Ty) const {
2361   // Integers and pointers are always SCEVable.
2362   return Ty->isIntegerTy() || Ty->isPointerTy();
2363 }
2364
2365 /// getTypeSizeInBits - Return the size in bits of the specified type,
2366 /// for which isSCEVable must return true.
2367 uint64_t ScalarEvolution::getTypeSizeInBits(const Type *Ty) const {
2368   assert(isSCEVable(Ty) && "Type is not SCEVable!");
2369
2370   // If we have a TargetData, use it!
2371   if (TD)
2372     return TD->getTypeSizeInBits(Ty);
2373
2374   // Integer types have fixed sizes.
2375   if (Ty->isIntegerTy())
2376     return Ty->getPrimitiveSizeInBits();
2377
2378   // The only other support type is pointer. Without TargetData, conservatively
2379   // assume pointers are 64-bit.
2380   assert(Ty->isPointerTy() && "isSCEVable permitted a non-SCEVable type!");
2381   return 64;
2382 }
2383
2384 /// getEffectiveSCEVType - Return a type with the same bitwidth as
2385 /// the given type and which represents how SCEV will treat the given
2386 /// type, for which isSCEVable must return true. For pointer types,
2387 /// this is the pointer-sized integer type.
2388 const Type *ScalarEvolution::getEffectiveSCEVType(const Type *Ty) const {
2389   assert(isSCEVable(Ty) && "Type is not SCEVable!");
2390
2391   if (Ty->isIntegerTy())
2392     return Ty;
2393
2394   // The only other support type is pointer.
2395   assert(Ty->isPointerTy() && "Unexpected non-pointer non-integer type!");
2396   if (TD) return TD->getIntPtrType(getContext());
2397
2398   // Without TargetData, conservatively assume pointers are 64-bit.
2399   return Type::getInt64Ty(getContext());
2400 }
2401
2402 const SCEV *ScalarEvolution::getCouldNotCompute() {
2403   return &CouldNotCompute;
2404 }
2405
2406 /// getSCEV - Return an existing SCEV if it exists, otherwise analyze the
2407 /// expression and create a new one.
2408 const SCEV *ScalarEvolution::getSCEV(Value *V) {
2409   assert(isSCEVable(V->getType()) && "Value is not SCEVable!");
2410
2411   ValueExprMapType::const_iterator I = ValueExprMap.find(V);
2412   if (I != ValueExprMap.end()) return I->second;
2413   const SCEV *S = createSCEV(V);
2414
2415   // The process of creating a SCEV for V may have caused other SCEVs
2416   // to have been created, so it's necessary to insert the new entry
2417   // from scratch, rather than trying to remember the insert position
2418   // above.
2419   ValueExprMap.insert(std::make_pair(SCEVCallbackVH(V, this), S));
2420   return S;
2421 }
2422
2423 /// getNegativeSCEV - Return a SCEV corresponding to -V = -1*V
2424 ///
2425 const SCEV *ScalarEvolution::getNegativeSCEV(const SCEV *V) {
2426   if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
2427     return getConstant(
2428                cast<ConstantInt>(ConstantExpr::getNeg(VC->getValue())));
2429
2430   const Type *Ty = V->getType();
2431   Ty = getEffectiveSCEVType(Ty);
2432   return getMulExpr(V,
2433                   getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty))));
2434 }
2435
2436 /// getNotSCEV - Return a SCEV corresponding to ~V = -1-V
2437 const SCEV *ScalarEvolution::getNotSCEV(const SCEV *V) {
2438   if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
2439     return getConstant(
2440                 cast<ConstantInt>(ConstantExpr::getNot(VC->getValue())));
2441
2442   const Type *Ty = V->getType();
2443   Ty = getEffectiveSCEVType(Ty);
2444   const SCEV *AllOnes =
2445                    getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty)));
2446   return getMinusSCEV(AllOnes, V);
2447 }
2448
2449 /// getMinusSCEV - Return a SCEV corresponding to LHS - RHS.
2450 ///
2451 const SCEV *ScalarEvolution::getMinusSCEV(const SCEV *LHS,
2452                                           const SCEV *RHS) {
2453   // Fast path: X - X --> 0.
2454   if (LHS == RHS)
2455     return getConstant(LHS->getType(), 0);
2456
2457   // X - Y --> X + -Y
2458   return getAddExpr(LHS, getNegativeSCEV(RHS));
2459 }
2460
2461 /// getTruncateOrZeroExtend - Return a SCEV corresponding to a conversion of the
2462 /// input value to the specified type.  If the type must be extended, it is zero
2463 /// extended.
2464 const SCEV *
2465 ScalarEvolution::getTruncateOrZeroExtend(const SCEV *V,
2466                                          const Type *Ty) {
2467   const Type *SrcTy = V->getType();
2468   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2469          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2470          "Cannot truncate or zero extend with non-integer arguments!");
2471   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2472     return V;  // No conversion
2473   if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
2474     return getTruncateExpr(V, Ty);
2475   return getZeroExtendExpr(V, Ty);
2476 }
2477
2478 /// getTruncateOrSignExtend - Return a SCEV corresponding to a conversion of the
2479 /// input value to the specified type.  If the type must be extended, it is sign
2480 /// extended.
2481 const SCEV *
2482 ScalarEvolution::getTruncateOrSignExtend(const SCEV *V,
2483                                          const Type *Ty) {
2484   const Type *SrcTy = V->getType();
2485   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2486          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2487          "Cannot truncate or zero extend with non-integer arguments!");
2488   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2489     return V;  // No conversion
2490   if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
2491     return getTruncateExpr(V, Ty);
2492   return getSignExtendExpr(V, Ty);
2493 }
2494
2495 /// getNoopOrZeroExtend - Return a SCEV corresponding to a conversion of the
2496 /// input value to the specified type.  If the type must be extended, it is zero
2497 /// extended.  The conversion must not be narrowing.
2498 const SCEV *
2499 ScalarEvolution::getNoopOrZeroExtend(const SCEV *V, const Type *Ty) {
2500   const Type *SrcTy = V->getType();
2501   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2502          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2503          "Cannot noop or zero extend with non-integer arguments!");
2504   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
2505          "getNoopOrZeroExtend cannot truncate!");
2506   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2507     return V;  // No conversion
2508   return getZeroExtendExpr(V, Ty);
2509 }
2510
2511 /// getNoopOrSignExtend - Return a SCEV corresponding to a conversion of the
2512 /// input value to the specified type.  If the type must be extended, it is sign
2513 /// extended.  The conversion must not be narrowing.
2514 const SCEV *
2515 ScalarEvolution::getNoopOrSignExtend(const SCEV *V, const Type *Ty) {
2516   const Type *SrcTy = V->getType();
2517   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2518          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2519          "Cannot noop or sign extend with non-integer arguments!");
2520   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
2521          "getNoopOrSignExtend cannot truncate!");
2522   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2523     return V;  // No conversion
2524   return getSignExtendExpr(V, Ty);
2525 }
2526
2527 /// getNoopOrAnyExtend - Return a SCEV corresponding to a conversion of
2528 /// the input value to the specified type. If the type must be extended,
2529 /// it is extended with unspecified bits. The conversion must not be
2530 /// narrowing.
2531 const SCEV *
2532 ScalarEvolution::getNoopOrAnyExtend(const SCEV *V, const Type *Ty) {
2533   const Type *SrcTy = V->getType();
2534   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2535          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2536          "Cannot noop or any extend with non-integer arguments!");
2537   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
2538          "getNoopOrAnyExtend cannot truncate!");
2539   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2540     return V;  // No conversion
2541   return getAnyExtendExpr(V, Ty);
2542 }
2543
2544 /// getTruncateOrNoop - Return a SCEV corresponding to a conversion of the
2545 /// input value to the specified type.  The conversion must not be widening.
2546 const SCEV *
2547 ScalarEvolution::getTruncateOrNoop(const SCEV *V, const Type *Ty) {
2548   const Type *SrcTy = V->getType();
2549   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2550          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2551          "Cannot truncate or noop with non-integer arguments!");
2552   assert(getTypeSizeInBits(SrcTy) >= getTypeSizeInBits(Ty) &&
2553          "getTruncateOrNoop cannot extend!");
2554   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2555     return V;  // No conversion
2556   return getTruncateExpr(V, Ty);
2557 }
2558
2559 /// getUMaxFromMismatchedTypes - Promote the operands to the wider of
2560 /// the types using zero-extension, and then perform a umax operation
2561 /// with them.
2562 const SCEV *ScalarEvolution::getUMaxFromMismatchedTypes(const SCEV *LHS,
2563                                                         const SCEV *RHS) {
2564   const SCEV *PromotedLHS = LHS;
2565   const SCEV *PromotedRHS = RHS;
2566
2567   if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
2568     PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
2569   else
2570     PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
2571
2572   return getUMaxExpr(PromotedLHS, PromotedRHS);
2573 }
2574
2575 /// getUMinFromMismatchedTypes - Promote the operands to the wider of
2576 /// the types using zero-extension, and then perform a umin operation
2577 /// with them.
2578 const SCEV *ScalarEvolution::getUMinFromMismatchedTypes(const SCEV *LHS,
2579                                                         const SCEV *RHS) {
2580   const SCEV *PromotedLHS = LHS;
2581   const SCEV *PromotedRHS = RHS;
2582
2583   if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
2584     PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
2585   else
2586     PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
2587
2588   return getUMinExpr(PromotedLHS, PromotedRHS);
2589 }
2590
2591 /// PushDefUseChildren - Push users of the given Instruction
2592 /// onto the given Worklist.
2593 static void
2594 PushDefUseChildren(Instruction *I,
2595                    SmallVectorImpl<Instruction *> &Worklist) {
2596   // Push the def-use children onto the Worklist stack.
2597   for (Value::use_iterator UI = I->use_begin(), UE = I->use_end();
2598        UI != UE; ++UI)
2599     Worklist.push_back(cast<Instruction>(*UI));
2600 }
2601
2602 /// ForgetSymbolicValue - This looks up computed SCEV values for all
2603 /// instructions that depend on the given instruction and removes them from
2604 /// the ValueExprMapType map if they reference SymName. This is used during PHI
2605 /// resolution.
2606 void
2607 ScalarEvolution::ForgetSymbolicName(Instruction *PN, const SCEV *SymName) {
2608   SmallVector<Instruction *, 16> Worklist;
2609   PushDefUseChildren(PN, Worklist);
2610
2611   SmallPtrSet<Instruction *, 8> Visited;
2612   Visited.insert(PN);
2613   while (!Worklist.empty()) {
2614     Instruction *I = Worklist.pop_back_val();
2615     if (!Visited.insert(I)) continue;
2616
2617     ValueExprMapType::iterator It =
2618       ValueExprMap.find(static_cast<Value *>(I));
2619     if (It != ValueExprMap.end()) {
2620       const SCEV *Old = It->second;
2621
2622       // Short-circuit the def-use traversal if the symbolic name
2623       // ceases to appear in expressions.
2624       if (Old != SymName && !hasOperand(Old, SymName))
2625         continue;
2626
2627       // SCEVUnknown for a PHI either means that it has an unrecognized
2628       // structure, it's a PHI that's in the progress of being computed
2629       // by createNodeForPHI, or it's a single-value PHI. In the first case,
2630       // additional loop trip count information isn't going to change anything.
2631       // In the second case, createNodeForPHI will perform the necessary
2632       // updates on its own when it gets to that point. In the third, we do
2633       // want to forget the SCEVUnknown.
2634       if (!isa<PHINode>(I) ||
2635           !isa<SCEVUnknown>(Old) ||
2636           (I != PN && Old == SymName)) {
2637         forgetMemoizedResults(Old);
2638         ValueExprMap.erase(It);
2639       }
2640     }
2641
2642     PushDefUseChildren(I, Worklist);
2643   }
2644 }
2645
2646 /// createNodeForPHI - PHI nodes have two cases.  Either the PHI node exists in
2647 /// a loop header, making it a potential recurrence, or it doesn't.
2648 ///
2649 const SCEV *ScalarEvolution::createNodeForPHI(PHINode *PN) {
2650   if (const Loop *L = LI->getLoopFor(PN->getParent()))
2651     if (L->getHeader() == PN->getParent()) {
2652       // The loop may have multiple entrances or multiple exits; we can analyze
2653       // this phi as an addrec if it has a unique entry value and a unique
2654       // backedge value.
2655       Value *BEValueV = 0, *StartValueV = 0;
2656       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
2657         Value *V = PN->getIncomingValue(i);
2658         if (L->contains(PN->getIncomingBlock(i))) {
2659           if (!BEValueV) {
2660             BEValueV = V;
2661           } else if (BEValueV != V) {
2662             BEValueV = 0;
2663             break;
2664           }
2665         } else if (!StartValueV) {
2666           StartValueV = V;
2667         } else if (StartValueV != V) {
2668           StartValueV = 0;
2669           break;
2670         }
2671       }
2672       if (BEValueV && StartValueV) {
2673         // While we are analyzing this PHI node, handle its value symbolically.
2674         const SCEV *SymbolicName = getUnknown(PN);
2675         assert(ValueExprMap.find(PN) == ValueExprMap.end() &&
2676                "PHI node already processed?");
2677         ValueExprMap.insert(std::make_pair(SCEVCallbackVH(PN, this), SymbolicName));
2678
2679         // Using this symbolic name for the PHI, analyze the value coming around
2680         // the back-edge.
2681         const SCEV *BEValue = getSCEV(BEValueV);
2682
2683         // NOTE: If BEValue is loop invariant, we know that the PHI node just
2684         // has a special value for the first iteration of the loop.
2685
2686         // If the value coming around the backedge is an add with the symbolic
2687         // value we just inserted, then we found a simple induction variable!
2688         if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(BEValue)) {
2689           // If there is a single occurrence of the symbolic value, replace it
2690           // with a recurrence.
2691           unsigned FoundIndex = Add->getNumOperands();
2692           for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
2693             if (Add->getOperand(i) == SymbolicName)
2694               if (FoundIndex == e) {
2695                 FoundIndex = i;
2696                 break;
2697               }
2698
2699           if (FoundIndex != Add->getNumOperands()) {
2700             // Create an add with everything but the specified operand.
2701             SmallVector<const SCEV *, 8> Ops;
2702             for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
2703               if (i != FoundIndex)
2704                 Ops.push_back(Add->getOperand(i));
2705             const SCEV *Accum = getAddExpr(Ops);
2706
2707             // This is not a valid addrec if the step amount is varying each
2708             // loop iteration, but is not itself an addrec in this loop.
2709             if (isLoopInvariant(Accum, L) ||
2710                 (isa<SCEVAddRecExpr>(Accum) &&
2711                  cast<SCEVAddRecExpr>(Accum)->getLoop() == L)) {
2712               bool HasNUW = false;
2713               bool HasNSW = false;
2714
2715               // If the increment doesn't overflow, then neither the addrec nor
2716               // the post-increment will overflow.
2717               if (const AddOperator *OBO = dyn_cast<AddOperator>(BEValueV)) {
2718                 if (OBO->hasNoUnsignedWrap())
2719                   HasNUW = true;
2720                 if (OBO->hasNoSignedWrap())
2721                   HasNSW = true;
2722               } else if (isa<GEPOperator>(BEValueV)) {
2723                 // If the increment is a GEP, then we know it won't perform an
2724                 // unsigned overflow, because the address space cannot be
2725                 // wrapped around.
2726                 HasNUW = true;
2727               }
2728
2729               const SCEV *StartVal = getSCEV(StartValueV);
2730               const SCEV *PHISCEV =
2731                 getAddRecExpr(StartVal, Accum, L, HasNUW, HasNSW);
2732
2733               // Since the no-wrap flags are on the increment, they apply to the
2734               // post-incremented value as well.
2735               if (isLoopInvariant(Accum, L))
2736                 (void)getAddRecExpr(getAddExpr(StartVal, Accum),
2737                                     Accum, L, HasNUW, HasNSW);
2738
2739               // Okay, for the entire analysis of this edge we assumed the PHI
2740               // to be symbolic.  We now need to go back and purge all of the
2741               // entries for the scalars that use the symbolic expression.
2742               ForgetSymbolicName(PN, SymbolicName);
2743               ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
2744               return PHISCEV;
2745             }
2746           }
2747         } else if (const SCEVAddRecExpr *AddRec =
2748                      dyn_cast<SCEVAddRecExpr>(BEValue)) {
2749           // Otherwise, this could be a loop like this:
2750           //     i = 0;  for (j = 1; ..; ++j) { ....  i = j; }
2751           // In this case, j = {1,+,1}  and BEValue is j.
2752           // Because the other in-value of i (0) fits the evolution of BEValue
2753           // i really is an addrec evolution.
2754           if (AddRec->getLoop() == L && AddRec->isAffine()) {
2755             const SCEV *StartVal = getSCEV(StartValueV);
2756
2757             // If StartVal = j.start - j.stride, we can use StartVal as the
2758             // initial step of the addrec evolution.
2759             if (StartVal == getMinusSCEV(AddRec->getOperand(0),
2760                                          AddRec->getOperand(1))) {
2761               const SCEV *PHISCEV =
2762                  getAddRecExpr(StartVal, AddRec->getOperand(1), L);
2763
2764               // Okay, for the entire analysis of this edge we assumed the PHI
2765               // to be symbolic.  We now need to go back and purge all of the
2766               // entries for the scalars that use the symbolic expression.
2767               ForgetSymbolicName(PN, SymbolicName);
2768               ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
2769               return PHISCEV;
2770             }
2771           }
2772         }
2773       }
2774     }
2775
2776   // If the PHI has a single incoming value, follow that value, unless the
2777   // PHI's incoming blocks are in a different loop, in which case doing so
2778   // risks breaking LCSSA form. Instcombine would normally zap these, but
2779   // it doesn't have DominatorTree information, so it may miss cases.
2780   if (Value *V = SimplifyInstruction(PN, TD, DT))
2781     if (LI->replacementPreservesLCSSAForm(PN, V))
2782       return getSCEV(V);
2783
2784   // If it's not a loop phi, we can't handle it yet.
2785   return getUnknown(PN);
2786 }
2787
2788 /// createNodeForGEP - Expand GEP instructions into add and multiply
2789 /// operations. This allows them to be analyzed by regular SCEV code.
2790 ///
2791 const SCEV *ScalarEvolution::createNodeForGEP(GEPOperator *GEP) {
2792
2793   // Don't blindly transfer the inbounds flag from the GEP instruction to the
2794   // Add expression, because the Instruction may be guarded by control flow
2795   // and the no-overflow bits may not be valid for the expression in any
2796   // context.
2797
2798   const Type *IntPtrTy = getEffectiveSCEVType(GEP->getType());
2799   Value *Base = GEP->getOperand(0);
2800   // Don't attempt to analyze GEPs over unsized objects.
2801   if (!cast<PointerType>(Base->getType())->getElementType()->isSized())
2802     return getUnknown(GEP);
2803   const SCEV *TotalOffset = getConstant(IntPtrTy, 0);
2804   gep_type_iterator GTI = gep_type_begin(GEP);
2805   for (GetElementPtrInst::op_iterator I = llvm::next(GEP->op_begin()),
2806                                       E = GEP->op_end();
2807        I != E; ++I) {
2808     Value *Index = *I;
2809     // Compute the (potentially symbolic) offset in bytes for this index.
2810     if (const StructType *STy = dyn_cast<StructType>(*GTI++)) {
2811       // For a struct, add the member offset.
2812       unsigned FieldNo = cast<ConstantInt>(Index)->getZExtValue();
2813       const SCEV *FieldOffset = getOffsetOfExpr(STy, FieldNo);
2814
2815       // Add the field offset to the running total offset.
2816       TotalOffset = getAddExpr(TotalOffset, FieldOffset);
2817     } else {
2818       // For an array, add the element offset, explicitly scaled.
2819       const SCEV *ElementSize = getSizeOfExpr(*GTI);
2820       const SCEV *IndexS = getSCEV(Index);
2821       // Getelementptr indices are signed.
2822       IndexS = getTruncateOrSignExtend(IndexS, IntPtrTy);
2823
2824       // Multiply the index by the element size to compute the element offset.
2825       const SCEV *LocalOffset = getMulExpr(IndexS, ElementSize);
2826
2827       // Add the element offset to the running total offset.
2828       TotalOffset = getAddExpr(TotalOffset, LocalOffset);
2829     }
2830   }
2831
2832   // Get the SCEV for the GEP base.
2833   const SCEV *BaseS = getSCEV(Base);
2834
2835   // Add the total offset from all the GEP indices to the base.
2836   return getAddExpr(BaseS, TotalOffset);
2837 }
2838
2839 /// GetMinTrailingZeros - Determine the minimum number of zero bits that S is
2840 /// guaranteed to end in (at every loop iteration).  It is, at the same time,
2841 /// the minimum number of times S is divisible by 2.  For example, given {4,+,8}
2842 /// it returns 2.  If S is guaranteed to be 0, it returns the bitwidth of S.
2843 uint32_t
2844 ScalarEvolution::GetMinTrailingZeros(const SCEV *S) {
2845   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
2846     return C->getValue()->getValue().countTrailingZeros();
2847
2848   if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(S))
2849     return std::min(GetMinTrailingZeros(T->getOperand()),
2850                     (uint32_t)getTypeSizeInBits(T->getType()));
2851
2852   if (const SCEVZeroExtendExpr *E = dyn_cast<SCEVZeroExtendExpr>(S)) {
2853     uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
2854     return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
2855              getTypeSizeInBits(E->getType()) : OpRes;
2856   }
2857
2858   if (const SCEVSignExtendExpr *E = dyn_cast<SCEVSignExtendExpr>(S)) {
2859     uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
2860     return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
2861              getTypeSizeInBits(E->getType()) : OpRes;
2862   }
2863
2864   if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(S)) {
2865     // The result is the min of all operands results.
2866     uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
2867     for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
2868       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
2869     return MinOpRes;
2870   }
2871
2872   if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(S)) {
2873     // The result is the sum of all operands results.
2874     uint32_t SumOpRes = GetMinTrailingZeros(M->getOperand(0));
2875     uint32_t BitWidth = getTypeSizeInBits(M->getType());
2876     for (unsigned i = 1, e = M->getNumOperands();
2877          SumOpRes != BitWidth && i != e; ++i)
2878       SumOpRes = std::min(SumOpRes + GetMinTrailingZeros(M->getOperand(i)),
2879                           BitWidth);
2880     return SumOpRes;
2881   }
2882
2883   if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(S)) {
2884     // The result is the min of all operands results.
2885     uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
2886     for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
2887       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
2888     return MinOpRes;
2889   }
2890
2891   if (const SCEVSMaxExpr *M = dyn_cast<SCEVSMaxExpr>(S)) {
2892     // The result is the min of all operands results.
2893     uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
2894     for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
2895       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
2896     return MinOpRes;
2897   }
2898
2899   if (const SCEVUMaxExpr *M = dyn_cast<SCEVUMaxExpr>(S)) {
2900     // The result is the min of all operands results.
2901     uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
2902     for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
2903       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
2904     return MinOpRes;
2905   }
2906
2907   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
2908     // For a SCEVUnknown, ask ValueTracking.
2909     unsigned BitWidth = getTypeSizeInBits(U->getType());
2910     APInt Mask = APInt::getAllOnesValue(BitWidth);
2911     APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
2912     ComputeMaskedBits(U->getValue(), Mask, Zeros, Ones);
2913     return Zeros.countTrailingOnes();
2914   }
2915
2916   // SCEVUDivExpr
2917   return 0;
2918 }
2919
2920 /// getUnsignedRange - Determine the unsigned range for a particular SCEV.
2921 ///
2922 ConstantRange
2923 ScalarEvolution::getUnsignedRange(const SCEV *S) {
2924   // See if we've computed this range already.
2925   DenseMap<const SCEV *, ConstantRange>::iterator I = UnsignedRanges.find(S);
2926   if (I != UnsignedRanges.end())
2927     return I->second;
2928
2929   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
2930     return setUnsignedRange(C, ConstantRange(C->getValue()->getValue()));
2931
2932   unsigned BitWidth = getTypeSizeInBits(S->getType());
2933   ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true);
2934
2935   // If the value has known zeros, the maximum unsigned value will have those
2936   // known zeros as well.
2937   uint32_t TZ = GetMinTrailingZeros(S);
2938   if (TZ != 0)
2939     ConservativeResult =
2940       ConstantRange(APInt::getMinValue(BitWidth),
2941                     APInt::getMaxValue(BitWidth).lshr(TZ).shl(TZ) + 1);
2942
2943   if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
2944     ConstantRange X = getUnsignedRange(Add->getOperand(0));
2945     for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i)
2946       X = X.add(getUnsignedRange(Add->getOperand(i)));
2947     return setUnsignedRange(Add, ConservativeResult.intersectWith(X));
2948   }
2949
2950   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
2951     ConstantRange X = getUnsignedRange(Mul->getOperand(0));
2952     for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i)
2953       X = X.multiply(getUnsignedRange(Mul->getOperand(i)));
2954     return setUnsignedRange(Mul, ConservativeResult.intersectWith(X));
2955   }
2956
2957   if (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(S)) {
2958     ConstantRange X = getUnsignedRange(SMax->getOperand(0));
2959     for (unsigned i = 1, e = SMax->getNumOperands(); i != e; ++i)
2960       X = X.smax(getUnsignedRange(SMax->getOperand(i)));
2961     return setUnsignedRange(SMax, ConservativeResult.intersectWith(X));
2962   }
2963
2964   if (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(S)) {
2965     ConstantRange X = getUnsignedRange(UMax->getOperand(0));
2966     for (unsigned i = 1, e = UMax->getNumOperands(); i != e; ++i)
2967       X = X.umax(getUnsignedRange(UMax->getOperand(i)));
2968     return setUnsignedRange(UMax, ConservativeResult.intersectWith(X));
2969   }
2970
2971   if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) {
2972     ConstantRange X = getUnsignedRange(UDiv->getLHS());
2973     ConstantRange Y = getUnsignedRange(UDiv->getRHS());
2974     return setUnsignedRange(UDiv, ConservativeResult.intersectWith(X.udiv(Y)));
2975   }
2976
2977   if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) {
2978     ConstantRange X = getUnsignedRange(ZExt->getOperand());
2979     return setUnsignedRange(ZExt,
2980       ConservativeResult.intersectWith(X.zeroExtend(BitWidth)));
2981   }
2982
2983   if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) {
2984     ConstantRange X = getUnsignedRange(SExt->getOperand());
2985     return setUnsignedRange(SExt,
2986       ConservativeResult.intersectWith(X.signExtend(BitWidth)));
2987   }
2988
2989   if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) {
2990     ConstantRange X = getUnsignedRange(Trunc->getOperand());
2991     return setUnsignedRange(Trunc,
2992       ConservativeResult.intersectWith(X.truncate(BitWidth)));
2993   }
2994
2995   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) {
2996     // If there's no unsigned wrap, the value will never be less than its
2997     // initial value.
2998     if (AddRec->hasNoUnsignedWrap())
2999       if (const SCEVConstant *C = dyn_cast<SCEVConstant>(AddRec->getStart()))
3000         if (!C->getValue()->isZero())
3001           ConservativeResult =
3002             ConservativeResult.intersectWith(
3003               ConstantRange(C->getValue()->getValue(), APInt(BitWidth, 0)));
3004
3005     // TODO: non-affine addrec
3006     if (AddRec->isAffine()) {
3007       const Type *Ty = AddRec->getType();
3008       const SCEV *MaxBECount = getMaxBackedgeTakenCount(AddRec->getLoop());
3009       if (!isa<SCEVCouldNotCompute>(MaxBECount) &&
3010           getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) {
3011         MaxBECount = getNoopOrZeroExtend(MaxBECount, Ty);
3012
3013         const SCEV *Start = AddRec->getStart();
3014         const SCEV *Step = AddRec->getStepRecurrence(*this);
3015
3016         ConstantRange StartRange = getUnsignedRange(Start);
3017         ConstantRange StepRange = getSignedRange(Step);
3018         ConstantRange MaxBECountRange = getUnsignedRange(MaxBECount);
3019         ConstantRange EndRange =
3020           StartRange.add(MaxBECountRange.multiply(StepRange));
3021
3022         // Check for overflow. This must be done with ConstantRange arithmetic
3023         // because we could be called from within the ScalarEvolution overflow
3024         // checking code.
3025         ConstantRange ExtStartRange = StartRange.zextOrTrunc(BitWidth*2+1);
3026         ConstantRange ExtStepRange = StepRange.sextOrTrunc(BitWidth*2+1);
3027         ConstantRange ExtMaxBECountRange =
3028           MaxBECountRange.zextOrTrunc(BitWidth*2+1);
3029         ConstantRange ExtEndRange = EndRange.zextOrTrunc(BitWidth*2+1);
3030         if (ExtStartRange.add(ExtMaxBECountRange.multiply(ExtStepRange)) !=
3031             ExtEndRange)
3032           return setUnsignedRange(AddRec, ConservativeResult);
3033
3034         APInt Min = APIntOps::umin(StartRange.getUnsignedMin(),
3035                                    EndRange.getUnsignedMin());
3036         APInt Max = APIntOps::umax(StartRange.getUnsignedMax(),
3037                                    EndRange.getUnsignedMax());
3038         if (Min.isMinValue() && Max.isMaxValue())
3039           return setUnsignedRange(AddRec, ConservativeResult);
3040         return setUnsignedRange(AddRec,
3041           ConservativeResult.intersectWith(ConstantRange(Min, Max+1)));
3042       }
3043     }
3044
3045     return setUnsignedRange(AddRec, ConservativeResult);
3046   }
3047
3048   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
3049     // For a SCEVUnknown, ask ValueTracking.
3050     APInt Mask = APInt::getAllOnesValue(BitWidth);
3051     APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
3052     ComputeMaskedBits(U->getValue(), Mask, Zeros, Ones, TD);
3053     if (Ones == ~Zeros + 1)
3054       return setUnsignedRange(U, ConservativeResult);
3055     return setUnsignedRange(U,
3056       ConservativeResult.intersectWith(ConstantRange(Ones, ~Zeros + 1)));
3057   }
3058
3059   return setUnsignedRange(S, ConservativeResult);
3060 }
3061
3062 /// getSignedRange - Determine the signed range for a particular SCEV.
3063 ///
3064 ConstantRange
3065 ScalarEvolution::getSignedRange(const SCEV *S) {
3066   DenseMap<const SCEV *, ConstantRange>::iterator I = SignedRanges.find(S);
3067   if (I != SignedRanges.end())
3068     return I->second;
3069
3070   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
3071     return setSignedRange(C, ConstantRange(C->getValue()->getValue()));
3072
3073   unsigned BitWidth = getTypeSizeInBits(S->getType());
3074   ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true);
3075
3076   // If the value has known zeros, the maximum signed value will have those
3077   // known zeros as well.
3078   uint32_t TZ = GetMinTrailingZeros(S);
3079   if (TZ != 0)
3080     ConservativeResult =
3081       ConstantRange(APInt::getSignedMinValue(BitWidth),
3082                     APInt::getSignedMaxValue(BitWidth).ashr(TZ).shl(TZ) + 1);
3083
3084   if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
3085     ConstantRange X = getSignedRange(Add->getOperand(0));
3086     for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i)
3087       X = X.add(getSignedRange(Add->getOperand(i)));
3088     return setSignedRange(Add, ConservativeResult.intersectWith(X));
3089   }
3090
3091   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
3092     ConstantRange X = getSignedRange(Mul->getOperand(0));
3093     for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i)
3094       X = X.multiply(getSignedRange(Mul->getOperand(i)));
3095     return setSignedRange(Mul, ConservativeResult.intersectWith(X));
3096   }
3097
3098   if (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(S)) {
3099     ConstantRange X = getSignedRange(SMax->getOperand(0));
3100     for (unsigned i = 1, e = SMax->getNumOperands(); i != e; ++i)
3101       X = X.smax(getSignedRange(SMax->getOperand(i)));
3102     return setSignedRange(SMax, ConservativeResult.intersectWith(X));
3103   }
3104
3105   if (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(S)) {
3106     ConstantRange X = getSignedRange(UMax->getOperand(0));
3107     for (unsigned i = 1, e = UMax->getNumOperands(); i != e; ++i)
3108       X = X.umax(getSignedRange(UMax->getOperand(i)));
3109     return setSignedRange(UMax, ConservativeResult.intersectWith(X));
3110   }
3111
3112   if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) {
3113     ConstantRange X = getSignedRange(UDiv->getLHS());
3114     ConstantRange Y = getSignedRange(UDiv->getRHS());
3115     return setSignedRange(UDiv, ConservativeResult.intersectWith(X.udiv(Y)));
3116   }
3117
3118   if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) {
3119     ConstantRange X = getSignedRange(ZExt->getOperand());
3120     return setSignedRange(ZExt,
3121       ConservativeResult.intersectWith(X.zeroExtend(BitWidth)));
3122   }
3123
3124   if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) {
3125     ConstantRange X = getSignedRange(SExt->getOperand());
3126     return setSignedRange(SExt,
3127       ConservativeResult.intersectWith(X.signExtend(BitWidth)));
3128   }
3129
3130   if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) {
3131     ConstantRange X = getSignedRange(Trunc->getOperand());
3132     return setSignedRange(Trunc,
3133       ConservativeResult.intersectWith(X.truncate(BitWidth)));
3134   }
3135
3136   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) {
3137     // If there's no signed wrap, and all the operands have the same sign or
3138     // zero, the value won't ever change sign.
3139     if (AddRec->hasNoSignedWrap()) {
3140       bool AllNonNeg = true;
3141       bool AllNonPos = true;
3142       for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
3143         if (!isKnownNonNegative(AddRec->getOperand(i))) AllNonNeg = false;
3144         if (!isKnownNonPositive(AddRec->getOperand(i))) AllNonPos = false;
3145       }
3146       if (AllNonNeg)
3147         ConservativeResult = ConservativeResult.intersectWith(
3148           ConstantRange(APInt(BitWidth, 0),
3149                         APInt::getSignedMinValue(BitWidth)));
3150       else if (AllNonPos)
3151         ConservativeResult = ConservativeResult.intersectWith(
3152           ConstantRange(APInt::getSignedMinValue(BitWidth),
3153                         APInt(BitWidth, 1)));
3154     }
3155
3156     // TODO: non-affine addrec
3157     if (AddRec->isAffine()) {
3158       const Type *Ty = AddRec->getType();
3159       const SCEV *MaxBECount = getMaxBackedgeTakenCount(AddRec->getLoop());
3160       if (!isa<SCEVCouldNotCompute>(MaxBECount) &&
3161           getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) {
3162         MaxBECount = getNoopOrZeroExtend(MaxBECount, Ty);
3163
3164         const SCEV *Start = AddRec->getStart();
3165         const SCEV *Step = AddRec->getStepRecurrence(*this);
3166
3167         ConstantRange StartRange = getSignedRange(Start);
3168         ConstantRange StepRange = getSignedRange(Step);
3169         ConstantRange MaxBECountRange = getUnsignedRange(MaxBECount);
3170         ConstantRange EndRange =
3171           StartRange.add(MaxBECountRange.multiply(StepRange));
3172
3173         // Check for overflow. This must be done with ConstantRange arithmetic
3174         // because we could be called from within the ScalarEvolution overflow
3175         // checking code.
3176         ConstantRange ExtStartRange = StartRange.sextOrTrunc(BitWidth*2+1);
3177         ConstantRange ExtStepRange = StepRange.sextOrTrunc(BitWidth*2+1);
3178         ConstantRange ExtMaxBECountRange =
3179           MaxBECountRange.zextOrTrunc(BitWidth*2+1);
3180         ConstantRange ExtEndRange = EndRange.sextOrTrunc(BitWidth*2+1);
3181         if (ExtStartRange.add(ExtMaxBECountRange.multiply(ExtStepRange)) !=
3182             ExtEndRange)
3183           return setSignedRange(AddRec, ConservativeResult);
3184
3185         APInt Min = APIntOps::smin(StartRange.getSignedMin(),
3186                                    EndRange.getSignedMin());
3187         APInt Max = APIntOps::smax(StartRange.getSignedMax(),
3188                                    EndRange.getSignedMax());
3189         if (Min.isMinSignedValue() && Max.isMaxSignedValue())
3190           return setSignedRange(AddRec, ConservativeResult);
3191         return setSignedRange(AddRec,
3192           ConservativeResult.intersectWith(ConstantRange(Min, Max+1)));
3193       }
3194     }
3195
3196     return setSignedRange(AddRec, ConservativeResult);
3197   }
3198
3199   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
3200     // For a SCEVUnknown, ask ValueTracking.
3201     if (!U->getValue()->getType()->isIntegerTy() && !TD)
3202       return setSignedRange(U, ConservativeResult);
3203     unsigned NS = ComputeNumSignBits(U->getValue(), TD);
3204     if (NS == 1)
3205       return setSignedRange(U, ConservativeResult);
3206     return setSignedRange(U, ConservativeResult.intersectWith(
3207       ConstantRange(APInt::getSignedMinValue(BitWidth).ashr(NS - 1),
3208                     APInt::getSignedMaxValue(BitWidth).ashr(NS - 1)+1)));
3209   }
3210
3211   return setSignedRange(S, ConservativeResult);
3212 }
3213
3214 /// createSCEV - We know that there is no SCEV for the specified value.
3215 /// Analyze the expression.
3216 ///
3217 const SCEV *ScalarEvolution::createSCEV(Value *V) {
3218   if (!isSCEVable(V->getType()))
3219     return getUnknown(V);
3220
3221   unsigned Opcode = Instruction::UserOp1;
3222   if (Instruction *I = dyn_cast<Instruction>(V)) {
3223     Opcode = I->getOpcode();
3224
3225     // Don't attempt to analyze instructions in blocks that aren't
3226     // reachable. Such instructions don't matter, and they aren't required
3227     // to obey basic rules for definitions dominating uses which this
3228     // analysis depends on.
3229     if (!DT->isReachableFromEntry(I->getParent()))
3230       return getUnknown(V);
3231   } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
3232     Opcode = CE->getOpcode();
3233   else if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
3234     return getConstant(CI);
3235   else if (isa<ConstantPointerNull>(V))
3236     return getConstant(V->getType(), 0);
3237   else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
3238     return GA->mayBeOverridden() ? getUnknown(V) : getSCEV(GA->getAliasee());
3239   else
3240     return getUnknown(V);
3241
3242   Operator *U = cast<Operator>(V);
3243   switch (Opcode) {
3244   case Instruction::Add: {
3245     // The simple thing to do would be to just call getSCEV on both operands
3246     // and call getAddExpr with the result. However if we're looking at a
3247     // bunch of things all added together, this can be quite inefficient,
3248     // because it leads to N-1 getAddExpr calls for N ultimate operands.
3249     // Instead, gather up all the operands and make a single getAddExpr call.
3250     // LLVM IR canonical form means we need only traverse the left operands.
3251     SmallVector<const SCEV *, 4> AddOps;
3252     AddOps.push_back(getSCEV(U->getOperand(1)));
3253     for (Value *Op = U->getOperand(0); ; Op = U->getOperand(0)) {
3254       unsigned Opcode = Op->getValueID() - Value::InstructionVal;
3255       if (Opcode != Instruction::Add && Opcode != Instruction::Sub)
3256         break;
3257       U = cast<Operator>(Op);
3258       const SCEV *Op1 = getSCEV(U->getOperand(1));
3259       if (Opcode == Instruction::Sub)
3260         AddOps.push_back(getNegativeSCEV(Op1));
3261       else
3262         AddOps.push_back(Op1);
3263     }
3264     AddOps.push_back(getSCEV(U->getOperand(0)));
3265     return getAddExpr(AddOps);
3266   }
3267   case Instruction::Mul: {
3268     // See the Add code above.
3269     SmallVector<const SCEV *, 4> MulOps;
3270     MulOps.push_back(getSCEV(U->getOperand(1)));
3271     for (Value *Op = U->getOperand(0);
3272          Op->getValueID() == Instruction::Mul + Value::InstructionVal;
3273          Op = U->getOperand(0)) {
3274       U = cast<Operator>(Op);
3275       MulOps.push_back(getSCEV(U->getOperand(1)));
3276     }
3277     MulOps.push_back(getSCEV(U->getOperand(0)));
3278     return getMulExpr(MulOps);
3279   }
3280   case Instruction::UDiv:
3281     return getUDivExpr(getSCEV(U->getOperand(0)),
3282                        getSCEV(U->getOperand(1)));
3283   case Instruction::Sub:
3284     return getMinusSCEV(getSCEV(U->getOperand(0)),
3285                         getSCEV(U->getOperand(1)));
3286   case Instruction::And:
3287     // For an expression like x&255 that merely masks off the high bits,
3288     // use zext(trunc(x)) as the SCEV expression.
3289     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
3290       if (CI->isNullValue())
3291         return getSCEV(U->getOperand(1));
3292       if (CI->isAllOnesValue())
3293         return getSCEV(U->getOperand(0));
3294       const APInt &A = CI->getValue();
3295
3296       // Instcombine's ShrinkDemandedConstant may strip bits out of
3297       // constants, obscuring what would otherwise be a low-bits mask.
3298       // Use ComputeMaskedBits to compute what ShrinkDemandedConstant
3299       // knew about to reconstruct a low-bits mask value.
3300       unsigned LZ = A.countLeadingZeros();
3301       unsigned BitWidth = A.getBitWidth();
3302       APInt AllOnes = APInt::getAllOnesValue(BitWidth);
3303       APInt KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
3304       ComputeMaskedBits(U->getOperand(0), AllOnes, KnownZero, KnownOne, TD);
3305
3306       APInt EffectiveMask = APInt::getLowBitsSet(BitWidth, BitWidth - LZ);
3307
3308       if (LZ != 0 && !((~A & ~KnownZero) & EffectiveMask))
3309         return
3310           getZeroExtendExpr(getTruncateExpr(getSCEV(U->getOperand(0)),
3311                                 IntegerType::get(getContext(), BitWidth - LZ)),
3312                             U->getType());
3313     }
3314     break;
3315
3316   case Instruction::Or:
3317     // If the RHS of the Or is a constant, we may have something like:
3318     // X*4+1 which got turned into X*4|1.  Handle this as an Add so loop
3319     // optimizations will transparently handle this case.
3320     //
3321     // In order for this transformation to be safe, the LHS must be of the
3322     // form X*(2^n) and the Or constant must be less than 2^n.
3323     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
3324       const SCEV *LHS = getSCEV(U->getOperand(0));
3325       const APInt &CIVal = CI->getValue();
3326       if (GetMinTrailingZeros(LHS) >=
3327           (CIVal.getBitWidth() - CIVal.countLeadingZeros())) {
3328         // Build a plain add SCEV.
3329         const SCEV *S = getAddExpr(LHS, getSCEV(CI));
3330         // If the LHS of the add was an addrec and it has no-wrap flags,
3331         // transfer the no-wrap flags, since an or won't introduce a wrap.
3332         if (const SCEVAddRecExpr *NewAR = dyn_cast<SCEVAddRecExpr>(S)) {
3333           const SCEVAddRecExpr *OldAR = cast<SCEVAddRecExpr>(LHS);
3334           if (OldAR->hasNoUnsignedWrap())
3335             const_cast<SCEVAddRecExpr *>(NewAR)->setHasNoUnsignedWrap(true);
3336           if (OldAR->hasNoSignedWrap())
3337             const_cast<SCEVAddRecExpr *>(NewAR)->setHasNoSignedWrap(true);
3338         }
3339         return S;
3340       }
3341     }
3342     break;
3343   case Instruction::Xor:
3344     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
3345       // If the RHS of the xor is a signbit, then this is just an add.
3346       // Instcombine turns add of signbit into xor as a strength reduction step.
3347       if (CI->getValue().isSignBit())
3348         return getAddExpr(getSCEV(U->getOperand(0)),
3349                           getSCEV(U->getOperand(1)));
3350
3351       // If the RHS of xor is -1, then this is a not operation.
3352       if (CI->isAllOnesValue())
3353         return getNotSCEV(getSCEV(U->getOperand(0)));
3354
3355       // Model xor(and(x, C), C) as and(~x, C), if C is a low-bits mask.
3356       // This is a variant of the check for xor with -1, and it handles
3357       // the case where instcombine has trimmed non-demanded bits out
3358       // of an xor with -1.
3359       if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U->getOperand(0)))
3360         if (ConstantInt *LCI = dyn_cast<ConstantInt>(BO->getOperand(1)))
3361           if (BO->getOpcode() == Instruction::And &&
3362               LCI->getValue() == CI->getValue())
3363             if (const SCEVZeroExtendExpr *Z =
3364                   dyn_cast<SCEVZeroExtendExpr>(getSCEV(U->getOperand(0)))) {
3365               const Type *UTy = U->getType();
3366               const SCEV *Z0 = Z->getOperand();
3367               const Type *Z0Ty = Z0->getType();
3368               unsigned Z0TySize = getTypeSizeInBits(Z0Ty);
3369
3370               // If C is a low-bits mask, the zero extend is serving to
3371               // mask off the high bits. Complement the operand and
3372               // re-apply the zext.
3373               if (APIntOps::isMask(Z0TySize, CI->getValue()))
3374                 return getZeroExtendExpr(getNotSCEV(Z0), UTy);
3375
3376               // If C is a single bit, it may be in the sign-bit position
3377               // before the zero-extend. In this case, represent the xor
3378               // using an add, which is equivalent, and re-apply the zext.
3379               APInt Trunc = CI->getValue().trunc(Z0TySize);
3380               if (Trunc.zext(getTypeSizeInBits(UTy)) == CI->getValue() &&
3381                   Trunc.isSignBit())
3382                 return getZeroExtendExpr(getAddExpr(Z0, getConstant(Trunc)),
3383                                          UTy);
3384             }
3385     }
3386     break;
3387
3388   case Instruction::Shl:
3389     // Turn shift left of a constant amount into a multiply.
3390     if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
3391       uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
3392
3393       // If the shift count is not less than the bitwidth, the result of
3394       // the shift is undefined. Don't try to analyze it, because the
3395       // resolution chosen here may differ from the resolution chosen in
3396       // other parts of the compiler.
3397       if (SA->getValue().uge(BitWidth))
3398         break;
3399
3400       Constant *X = ConstantInt::get(getContext(),
3401         APInt(BitWidth, 1).shl(SA->getZExtValue()));
3402       return getMulExpr(getSCEV(U->getOperand(0)), getSCEV(X));
3403     }
3404     break;
3405
3406   case Instruction::LShr:
3407     // Turn logical shift right of a constant into a unsigned divide.
3408     if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
3409       uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
3410
3411       // If the shift count is not less than the bitwidth, the result of
3412       // the shift is undefined. Don't try to analyze it, because the
3413       // resolution chosen here may differ from the resolution chosen in
3414       // other parts of the compiler.
3415       if (SA->getValue().uge(BitWidth))
3416         break;
3417
3418       Constant *X = ConstantInt::get(getContext(),
3419         APInt(BitWidth, 1).shl(SA->getZExtValue()));
3420       return getUDivExpr(getSCEV(U->getOperand(0)), getSCEV(X));
3421     }
3422     break;
3423
3424   case Instruction::AShr:
3425     // For a two-shift sext-inreg, use sext(trunc(x)) as the SCEV expression.
3426     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1)))
3427       if (Operator *L = dyn_cast<Operator>(U->getOperand(0)))
3428         if (L->getOpcode() == Instruction::Shl &&
3429             L->getOperand(1) == U->getOperand(1)) {
3430           uint64_t BitWidth = getTypeSizeInBits(U->getType());
3431
3432           // If the shift count is not less than the bitwidth, the result of
3433           // the shift is undefined. Don't try to analyze it, because the
3434           // resolution chosen here may differ from the resolution chosen in
3435           // other parts of the compiler.
3436           if (CI->getValue().uge(BitWidth))
3437             break;
3438
3439           uint64_t Amt = BitWidth - CI->getZExtValue();
3440           if (Amt == BitWidth)
3441             return getSCEV(L->getOperand(0));       // shift by zero --> noop
3442           return
3443             getSignExtendExpr(getTruncateExpr(getSCEV(L->getOperand(0)),
3444                                               IntegerType::get(getContext(),
3445                                                                Amt)),
3446                               U->getType());
3447         }
3448     break;
3449
3450   case Instruction::Trunc:
3451     return getTruncateExpr(getSCEV(U->getOperand(0)), U->getType());
3452
3453   case Instruction::ZExt:
3454     return getZeroExtendExpr(getSCEV(U->getOperand(0)), U->getType());
3455
3456   case Instruction::SExt:
3457     return getSignExtendExpr(getSCEV(U->getOperand(0)), U->getType());
3458
3459   case Instruction::BitCast:
3460     // BitCasts are no-op casts so we just eliminate the cast.
3461     if (isSCEVable(U->getType()) && isSCEVable(U->getOperand(0)->getType()))
3462       return getSCEV(U->getOperand(0));
3463     break;
3464
3465   // It's tempting to handle inttoptr and ptrtoint as no-ops, however this can
3466   // lead to pointer expressions which cannot safely be expanded to GEPs,
3467   // because ScalarEvolution doesn't respect the GEP aliasing rules when
3468   // simplifying integer expressions.
3469
3470   case Instruction::GetElementPtr:
3471     return createNodeForGEP(cast<GEPOperator>(U));
3472
3473   case Instruction::PHI:
3474     return createNodeForPHI(cast<PHINode>(U));
3475
3476   case Instruction::Select:
3477     // This could be a smax or umax that was lowered earlier.
3478     // Try to recover it.
3479     if (ICmpInst *ICI = dyn_cast<ICmpInst>(U->getOperand(0))) {
3480       Value *LHS = ICI->getOperand(0);
3481       Value *RHS = ICI->getOperand(1);
3482       switch (ICI->getPredicate()) {
3483       case ICmpInst::ICMP_SLT:
3484       case ICmpInst::ICMP_SLE:
3485         std::swap(LHS, RHS);
3486         // fall through
3487       case ICmpInst::ICMP_SGT:
3488       case ICmpInst::ICMP_SGE:
3489         // a >s b ? a+x : b+x  ->  smax(a, b)+x
3490         // a >s b ? b+x : a+x  ->  smin(a, b)+x
3491         if (LHS->getType() == U->getType()) {
3492           const SCEV *LS = getSCEV(LHS);
3493           const SCEV *RS = getSCEV(RHS);
3494           const SCEV *LA = getSCEV(U->getOperand(1));
3495           const SCEV *RA = getSCEV(U->getOperand(2));
3496           const SCEV *LDiff = getMinusSCEV(LA, LS);
3497           const SCEV *RDiff = getMinusSCEV(RA, RS);
3498           if (LDiff == RDiff)
3499             return getAddExpr(getSMaxExpr(LS, RS), LDiff);
3500           LDiff = getMinusSCEV(LA, RS);
3501           RDiff = getMinusSCEV(RA, LS);
3502           if (LDiff == RDiff)
3503             return getAddExpr(getSMinExpr(LS, RS), LDiff);
3504         }
3505         break;
3506       case ICmpInst::ICMP_ULT:
3507       case ICmpInst::ICMP_ULE:
3508         std::swap(LHS, RHS);
3509         // fall through
3510       case ICmpInst::ICMP_UGT:
3511       case ICmpInst::ICMP_UGE:
3512         // a >u b ? a+x : b+x  ->  umax(a, b)+x
3513         // a >u b ? b+x : a+x  ->  umin(a, b)+x
3514         if (LHS->getType() == U->getType()) {
3515           const SCEV *LS = getSCEV(LHS);
3516           const SCEV *RS = getSCEV(RHS);
3517           const SCEV *LA = getSCEV(U->getOperand(1));
3518           const SCEV *RA = getSCEV(U->getOperand(2));
3519           const SCEV *LDiff = getMinusSCEV(LA, LS);
3520           const SCEV *RDiff = getMinusSCEV(RA, RS);
3521           if (LDiff == RDiff)
3522             return getAddExpr(getUMaxExpr(LS, RS), LDiff);
3523           LDiff = getMinusSCEV(LA, RS);
3524           RDiff = getMinusSCEV(RA, LS);
3525           if (LDiff == RDiff)
3526             return getAddExpr(getUMinExpr(LS, RS), LDiff);
3527         }
3528         break;
3529       case ICmpInst::ICMP_NE:
3530         // n != 0 ? n+x : 1+x  ->  umax(n, 1)+x
3531         if (LHS->getType() == U->getType() &&
3532             isa<ConstantInt>(RHS) &&
3533             cast<ConstantInt>(RHS)->isZero()) {
3534           const SCEV *One = getConstant(LHS->getType(), 1);
3535           const SCEV *LS = getSCEV(LHS);
3536           const SCEV *LA = getSCEV(U->getOperand(1));
3537           const SCEV *RA = getSCEV(U->getOperand(2));
3538           const SCEV *LDiff = getMinusSCEV(LA, LS);
3539           const SCEV *RDiff = getMinusSCEV(RA, One);
3540           if (LDiff == RDiff)
3541             return getAddExpr(getUMaxExpr(One, LS), LDiff);
3542         }
3543         break;
3544       case ICmpInst::ICMP_EQ:
3545         // n == 0 ? 1+x : n+x  ->  umax(n, 1)+x
3546         if (LHS->getType() == U->getType() &&
3547             isa<ConstantInt>(RHS) &&
3548             cast<ConstantInt>(RHS)->isZero()) {
3549           const SCEV *One = getConstant(LHS->getType(), 1);
3550           const SCEV *LS = getSCEV(LHS);
3551           const SCEV *LA = getSCEV(U->getOperand(1));
3552           const SCEV *RA = getSCEV(U->getOperand(2));
3553           const SCEV *LDiff = getMinusSCEV(LA, One);
3554           const SCEV *RDiff = getMinusSCEV(RA, LS);
3555           if (LDiff == RDiff)
3556             return getAddExpr(getUMaxExpr(One, LS), LDiff);
3557         }
3558         break;
3559       default:
3560         break;
3561       }
3562     }
3563
3564   default: // We cannot analyze this expression.
3565     break;
3566   }
3567
3568   return getUnknown(V);
3569 }
3570
3571
3572
3573 //===----------------------------------------------------------------------===//
3574 //                   Iteration Count Computation Code
3575 //
3576
3577 /// getBackedgeTakenCount - If the specified loop has a predictable
3578 /// backedge-taken count, return it, otherwise return a SCEVCouldNotCompute
3579 /// object. The backedge-taken count is the number of times the loop header
3580 /// will be branched to from within the loop. This is one less than the
3581 /// trip count of the loop, since it doesn't count the first iteration,
3582 /// when the header is branched to from outside the loop.
3583 ///
3584 /// Note that it is not valid to call this method on a loop without a
3585 /// loop-invariant backedge-taken count (see
3586 /// hasLoopInvariantBackedgeTakenCount).
3587 ///
3588 const SCEV *ScalarEvolution::getBackedgeTakenCount(const Loop *L) {
3589   return getBackedgeTakenInfo(L).Exact;
3590 }
3591
3592 /// getMaxBackedgeTakenCount - Similar to getBackedgeTakenCount, except
3593 /// return the least SCEV value that is known never to be less than the
3594 /// actual backedge taken count.
3595 const SCEV *ScalarEvolution::getMaxBackedgeTakenCount(const Loop *L) {
3596   return getBackedgeTakenInfo(L).Max;
3597 }
3598
3599 /// PushLoopPHIs - Push PHI nodes in the header of the given loop
3600 /// onto the given Worklist.
3601 static void
3602 PushLoopPHIs(const Loop *L, SmallVectorImpl<Instruction *> &Worklist) {
3603   BasicBlock *Header = L->getHeader();
3604
3605   // Push all Loop-header PHIs onto the Worklist stack.
3606   for (BasicBlock::iterator I = Header->begin();
3607        PHINode *PN = dyn_cast<PHINode>(I); ++I)
3608     Worklist.push_back(PN);
3609 }
3610
3611 const ScalarEvolution::BackedgeTakenInfo &
3612 ScalarEvolution::getBackedgeTakenInfo(const Loop *L) {
3613   // Initially insert a CouldNotCompute for this loop. If the insertion
3614   // succeeds, proceed to actually compute a backedge-taken count and
3615   // update the value. The temporary CouldNotCompute value tells SCEV
3616   // code elsewhere that it shouldn't attempt to request a new
3617   // backedge-taken count, which could result in infinite recursion.
3618   std::pair<std::map<const Loop *, BackedgeTakenInfo>::iterator, bool> Pair =
3619     BackedgeTakenCounts.insert(std::make_pair(L, getCouldNotCompute()));
3620   if (!Pair.second)
3621     return Pair.first->second;
3622
3623   BackedgeTakenInfo BECount = ComputeBackedgeTakenCount(L);
3624   if (BECount.Exact != getCouldNotCompute()) {
3625     assert(isLoopInvariant(BECount.Exact, L) &&
3626            isLoopInvariant(BECount.Max, L) &&
3627            "Computed backedge-taken count isn't loop invariant for loop!");
3628     ++NumTripCountsComputed;
3629
3630     // Update the value in the map.
3631     Pair.first->second = BECount;
3632   } else {
3633     if (BECount.Max != getCouldNotCompute())
3634       // Update the value in the map.
3635       Pair.first->second = BECount;
3636     if (isa<PHINode>(L->getHeader()->begin()))
3637       // Only count loops that have phi nodes as not being computable.
3638       ++NumTripCountsNotComputed;
3639   }
3640
3641   // Now that we know more about the trip count for this loop, forget any
3642   // existing SCEV values for PHI nodes in this loop since they are only
3643   // conservative estimates made without the benefit of trip count
3644   // information. This is similar to the code in forgetLoop, except that
3645   // it handles SCEVUnknown PHI nodes specially.
3646   if (BECount.hasAnyInfo()) {
3647     SmallVector<Instruction *, 16> Worklist;
3648     PushLoopPHIs(L, Worklist);
3649
3650     SmallPtrSet<Instruction *, 8> Visited;
3651     while (!Worklist.empty()) {
3652       Instruction *I = Worklist.pop_back_val();
3653       if (!Visited.insert(I)) continue;
3654
3655       ValueExprMapType::iterator It =
3656         ValueExprMap.find(static_cast<Value *>(I));
3657       if (It != ValueExprMap.end()) {
3658         const SCEV *Old = It->second;
3659
3660         // SCEVUnknown for a PHI either means that it has an unrecognized
3661         // structure, or it's a PHI that's in the progress of being computed
3662         // by createNodeForPHI.  In the former case, additional loop trip
3663         // count information isn't going to change anything. In the later
3664         // case, createNodeForPHI will perform the necessary updates on its
3665         // own when it gets to that point.
3666         if (!isa<PHINode>(I) || !isa<SCEVUnknown>(Old)) {
3667           forgetMemoizedResults(Old);
3668           ValueExprMap.erase(It);
3669         }
3670         if (PHINode *PN = dyn_cast<PHINode>(I))
3671           ConstantEvolutionLoopExitValue.erase(PN);
3672       }
3673
3674       PushDefUseChildren(I, Worklist);
3675     }
3676   }
3677   return Pair.first->second;
3678 }
3679
3680 /// forgetLoop - This method should be called by the client when it has
3681 /// changed a loop in a way that may effect ScalarEvolution's ability to
3682 /// compute a trip count, or if the loop is deleted.
3683 void ScalarEvolution::forgetLoop(const Loop *L) {
3684   // Drop any stored trip count value.
3685   BackedgeTakenCounts.erase(L);
3686
3687   // Drop information about expressions based on loop-header PHIs.
3688   SmallVector<Instruction *, 16> Worklist;
3689   PushLoopPHIs(L, Worklist);
3690
3691   SmallPtrSet<Instruction *, 8> Visited;
3692   while (!Worklist.empty()) {
3693     Instruction *I = Worklist.pop_back_val();
3694     if (!Visited.insert(I)) continue;
3695
3696     ValueExprMapType::iterator It = ValueExprMap.find(static_cast<Value *>(I));
3697     if (It != ValueExprMap.end()) {
3698       forgetMemoizedResults(It->second);
3699       ValueExprMap.erase(It);
3700       if (PHINode *PN = dyn_cast<PHINode>(I))
3701         ConstantEvolutionLoopExitValue.erase(PN);
3702     }
3703
3704     PushDefUseChildren(I, Worklist);
3705   }
3706
3707   // Forget all contained loops too, to avoid dangling entries in the
3708   // ValuesAtScopes map.
3709   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
3710     forgetLoop(*I);
3711 }
3712
3713 /// forgetValue - This method should be called by the client when it has
3714 /// changed a value in a way that may effect its value, or which may
3715 /// disconnect it from a def-use chain linking it to a loop.
3716 void ScalarEvolution::forgetValue(Value *V) {
3717   Instruction *I = dyn_cast<Instruction>(V);
3718   if (!I) return;
3719
3720   // Drop information about expressions based on loop-header PHIs.
3721   SmallVector<Instruction *, 16> Worklist;
3722   Worklist.push_back(I);
3723
3724   SmallPtrSet<Instruction *, 8> Visited;
3725   while (!Worklist.empty()) {
3726     I = Worklist.pop_back_val();
3727     if (!Visited.insert(I)) continue;
3728
3729     ValueExprMapType::iterator It = ValueExprMap.find(static_cast<Value *>(I));
3730     if (It != ValueExprMap.end()) {
3731       forgetMemoizedResults(It->second);
3732       ValueExprMap.erase(It);
3733       if (PHINode *PN = dyn_cast<PHINode>(I))
3734         ConstantEvolutionLoopExitValue.erase(PN);
3735     }
3736
3737     PushDefUseChildren(I, Worklist);
3738   }
3739 }
3740
3741 /// ComputeBackedgeTakenCount - Compute the number of times the backedge
3742 /// of the specified loop will execute.
3743 ScalarEvolution::BackedgeTakenInfo
3744 ScalarEvolution::ComputeBackedgeTakenCount(const Loop *L) {
3745   SmallVector<BasicBlock *, 8> ExitingBlocks;
3746   L->getExitingBlocks(ExitingBlocks);
3747
3748   // Examine all exits and pick the most conservative values.
3749   const SCEV *BECount = getCouldNotCompute();
3750   const SCEV *MaxBECount = getCouldNotCompute();
3751   bool CouldNotComputeBECount = false;
3752   for (unsigned i = 0, e = ExitingBlocks.size(); i != e; ++i) {
3753     BackedgeTakenInfo NewBTI =
3754       ComputeBackedgeTakenCountFromExit(L, ExitingBlocks[i]);
3755
3756     if (NewBTI.Exact == getCouldNotCompute()) {
3757       // We couldn't compute an exact value for this exit, so
3758       // we won't be able to compute an exact value for the loop.
3759       CouldNotComputeBECount = true;
3760       BECount = getCouldNotCompute();
3761     } else if (!CouldNotComputeBECount) {
3762       if (BECount == getCouldNotCompute())
3763         BECount = NewBTI.Exact;
3764       else
3765         BECount = getUMinFromMismatchedTypes(BECount, NewBTI.Exact);
3766     }
3767     if (MaxBECount == getCouldNotCompute())
3768       MaxBECount = NewBTI.Max;
3769     else if (NewBTI.Max != getCouldNotCompute())
3770       MaxBECount = getUMinFromMismatchedTypes(MaxBECount, NewBTI.Max);
3771   }
3772
3773   return BackedgeTakenInfo(BECount, MaxBECount);
3774 }
3775
3776 /// ComputeBackedgeTakenCountFromExit - Compute the number of times the backedge
3777 /// of the specified loop will execute if it exits via the specified block.
3778 ScalarEvolution::BackedgeTakenInfo
3779 ScalarEvolution::ComputeBackedgeTakenCountFromExit(const Loop *L,
3780                                                    BasicBlock *ExitingBlock) {
3781
3782   // Okay, we've chosen an exiting block.  See what condition causes us to
3783   // exit at this block.
3784   //
3785   // FIXME: we should be able to handle switch instructions (with a single exit)
3786   BranchInst *ExitBr = dyn_cast<BranchInst>(ExitingBlock->getTerminator());
3787   if (ExitBr == 0) return getCouldNotCompute();
3788   assert(ExitBr->isConditional() && "If unconditional, it can't be in loop!");
3789
3790   // At this point, we know we have a conditional branch that determines whether
3791   // the loop is exited.  However, we don't know if the branch is executed each
3792   // time through the loop.  If not, then the execution count of the branch will
3793   // not be equal to the trip count of the loop.
3794   //
3795   // Currently we check for this by checking to see if the Exit branch goes to
3796   // the loop header.  If so, we know it will always execute the same number of
3797   // times as the loop.  We also handle the case where the exit block *is* the
3798   // loop header.  This is common for un-rotated loops.
3799   //
3800   // If both of those tests fail, walk up the unique predecessor chain to the
3801   // header, stopping if there is an edge that doesn't exit the loop. If the
3802   // header is reached, the execution count of the branch will be equal to the
3803   // trip count of the loop.
3804   //
3805   //  More extensive analysis could be done to handle more cases here.
3806   //
3807   if (ExitBr->getSuccessor(0) != L->getHeader() &&
3808       ExitBr->getSuccessor(1) != L->getHeader() &&
3809       ExitBr->getParent() != L->getHeader()) {
3810     // The simple checks failed, try climbing the unique predecessor chain
3811     // up to the header.
3812     bool Ok = false;
3813     for (BasicBlock *BB = ExitBr->getParent(); BB; ) {
3814       BasicBlock *Pred = BB->getUniquePredecessor();
3815       if (!Pred)
3816         return getCouldNotCompute();
3817       TerminatorInst *PredTerm = Pred->getTerminator();
3818       for (unsigned i = 0, e = PredTerm->getNumSuccessors(); i != e; ++i) {
3819         BasicBlock *PredSucc = PredTerm->getSuccessor(i);
3820         if (PredSucc == BB)
3821           continue;
3822         // If the predecessor has a successor that isn't BB and isn't
3823         // outside the loop, assume the worst.
3824         if (L->contains(PredSucc))
3825           return getCouldNotCompute();
3826       }
3827       if (Pred == L->getHeader()) {
3828         Ok = true;
3829         break;
3830       }
3831       BB = Pred;
3832     }
3833     if (!Ok)
3834       return getCouldNotCompute();
3835   }
3836
3837   // Proceed to the next level to examine the exit condition expression.
3838   return ComputeBackedgeTakenCountFromExitCond(L, ExitBr->getCondition(),
3839                                                ExitBr->getSuccessor(0),
3840                                                ExitBr->getSuccessor(1));
3841 }
3842
3843 /// ComputeBackedgeTakenCountFromExitCond - Compute the number of times the
3844 /// backedge of the specified loop will execute if its exit condition
3845 /// were a conditional branch of ExitCond, TBB, and FBB.
3846 ScalarEvolution::BackedgeTakenInfo
3847 ScalarEvolution::ComputeBackedgeTakenCountFromExitCond(const Loop *L,
3848                                                        Value *ExitCond,
3849                                                        BasicBlock *TBB,
3850                                                        BasicBlock *FBB) {
3851   // Check if the controlling expression for this loop is an And or Or.
3852   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(ExitCond)) {
3853     if (BO->getOpcode() == Instruction::And) {
3854       // Recurse on the operands of the and.
3855       BackedgeTakenInfo BTI0 =
3856         ComputeBackedgeTakenCountFromExitCond(L, BO->getOperand(0), TBB, FBB);
3857       BackedgeTakenInfo BTI1 =
3858         ComputeBackedgeTakenCountFromExitCond(L, BO->getOperand(1), TBB, FBB);
3859       const SCEV *BECount = getCouldNotCompute();
3860       const SCEV *MaxBECount = getCouldNotCompute();
3861       if (L->contains(TBB)) {
3862         // Both conditions must be true for the loop to continue executing.
3863         // Choose the less conservative count.
3864         if (BTI0.Exact == getCouldNotCompute() ||
3865             BTI1.Exact == getCouldNotCompute())
3866           BECount = getCouldNotCompute();
3867         else
3868           BECount = getUMinFromMismatchedTypes(BTI0.Exact, BTI1.Exact);
3869         if (BTI0.Max == getCouldNotCompute())
3870           MaxBECount = BTI1.Max;
3871         else if (BTI1.Max == getCouldNotCompute())
3872           MaxBECount = BTI0.Max;
3873         else
3874           MaxBECount = getUMinFromMismatchedTypes(BTI0.Max, BTI1.Max);
3875       } else {
3876         // Both conditions must be true at the same time for the loop to exit.
3877         // For now, be conservative.
3878         assert(L->contains(FBB) && "Loop block has no successor in loop!");
3879         if (BTI0.Max == BTI1.Max)
3880           MaxBECount = BTI0.Max;
3881         if (BTI0.Exact == BTI1.Exact)
3882           BECount = BTI0.Exact;
3883       }
3884
3885       return BackedgeTakenInfo(BECount, MaxBECount);
3886     }
3887     if (BO->getOpcode() == Instruction::Or) {
3888       // Recurse on the operands of the or.
3889       BackedgeTakenInfo BTI0 =
3890         ComputeBackedgeTakenCountFromExitCond(L, BO->getOperand(0), TBB, FBB);
3891       BackedgeTakenInfo BTI1 =
3892         ComputeBackedgeTakenCountFromExitCond(L, BO->getOperand(1), TBB, FBB);
3893       const SCEV *BECount = getCouldNotCompute();
3894       const SCEV *MaxBECount = getCouldNotCompute();
3895       if (L->contains(FBB)) {
3896         // Both conditions must be false for the loop to continue executing.
3897         // Choose the less conservative count.
3898         if (BTI0.Exact == getCouldNotCompute() ||
3899             BTI1.Exact == getCouldNotCompute())
3900           BECount = getCouldNotCompute();
3901         else
3902           BECount = getUMinFromMismatchedTypes(BTI0.Exact, BTI1.Exact);
3903         if (BTI0.Max == getCouldNotCompute())
3904           MaxBECount = BTI1.Max;
3905         else if (BTI1.Max == getCouldNotCompute())
3906           MaxBECount = BTI0.Max;
3907         else
3908           MaxBECount = getUMinFromMismatchedTypes(BTI0.Max, BTI1.Max);
3909       } else {
3910         // Both conditions must be false at the same time for the loop to exit.
3911         // For now, be conservative.
3912         assert(L->contains(TBB) && "Loop block has no successor in loop!");
3913         if (BTI0.Max == BTI1.Max)
3914           MaxBECount = BTI0.Max;
3915         if (BTI0.Exact == BTI1.Exact)
3916           BECount = BTI0.Exact;
3917       }
3918
3919       return BackedgeTakenInfo(BECount, MaxBECount);
3920     }
3921   }
3922
3923   // With an icmp, it may be feasible to compute an exact backedge-taken count.
3924   // Proceed to the next level to examine the icmp.
3925   if (ICmpInst *ExitCondICmp = dyn_cast<ICmpInst>(ExitCond))
3926     return ComputeBackedgeTakenCountFromExitCondICmp(L, ExitCondICmp, TBB, FBB);
3927
3928   // Check for a constant condition. These are normally stripped out by
3929   // SimplifyCFG, but ScalarEvolution may be used by a pass which wishes to
3930   // preserve the CFG and is temporarily leaving constant conditions
3931   // in place.
3932   if (ConstantInt *CI = dyn_cast<ConstantInt>(ExitCond)) {
3933     if (L->contains(FBB) == !CI->getZExtValue())
3934       // The backedge is always taken.
3935       return getCouldNotCompute();
3936     else
3937       // The backedge is never taken.
3938       return getConstant(CI->getType(), 0);
3939   }
3940
3941   // If it's not an integer or pointer comparison then compute it the hard way.
3942   return ComputeBackedgeTakenCountExhaustively(L, ExitCond, !L->contains(TBB));
3943 }
3944
3945 /// ComputeBackedgeTakenCountFromExitCondICmp - Compute the number of times the
3946 /// backedge of the specified loop will execute if its exit condition
3947 /// were a conditional branch of the ICmpInst ExitCond, TBB, and FBB.
3948 ScalarEvolution::BackedgeTakenInfo
3949 ScalarEvolution::ComputeBackedgeTakenCountFromExitCondICmp(const Loop *L,
3950                                                            ICmpInst *ExitCond,
3951                                                            BasicBlock *TBB,
3952                                                            BasicBlock *FBB) {
3953
3954   // If the condition was exit on true, convert the condition to exit on false
3955   ICmpInst::Predicate Cond;
3956   if (!L->contains(FBB))
3957     Cond = ExitCond->getPredicate();
3958   else
3959     Cond = ExitCond->getInversePredicate();
3960
3961   // Handle common loops like: for (X = "string"; *X; ++X)
3962   if (LoadInst *LI = dyn_cast<LoadInst>(ExitCond->getOperand(0)))
3963     if (Constant *RHS = dyn_cast<Constant>(ExitCond->getOperand(1))) {
3964       BackedgeTakenInfo ItCnt =
3965         ComputeLoadConstantCompareBackedgeTakenCount(LI, RHS, L, Cond);
3966       if (ItCnt.hasAnyInfo())
3967         return ItCnt;
3968     }
3969
3970   const SCEV *LHS = getSCEV(ExitCond->getOperand(0));
3971   const SCEV *RHS = getSCEV(ExitCond->getOperand(1));
3972
3973   // Try to evaluate any dependencies out of the loop.
3974   LHS = getSCEVAtScope(LHS, L);
3975   RHS = getSCEVAtScope(RHS, L);
3976
3977   // At this point, we would like to compute how many iterations of the
3978   // loop the predicate will return true for these inputs.
3979   if (isLoopInvariant(LHS, L) && !isLoopInvariant(RHS, L)) {
3980     // If there is a loop-invariant, force it into the RHS.
3981     std::swap(LHS, RHS);
3982     Cond = ICmpInst::getSwappedPredicate(Cond);
3983   }
3984
3985   // Simplify the operands before analyzing them.
3986   (void)SimplifyICmpOperands(Cond, LHS, RHS);
3987
3988   // If we have a comparison of a chrec against a constant, try to use value
3989   // ranges to answer this query.
3990   if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS))
3991     if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS))
3992       if (AddRec->getLoop() == L) {
3993         // Form the constant range.
3994         ConstantRange CompRange(
3995             ICmpInst::makeConstantRange(Cond, RHSC->getValue()->getValue()));
3996
3997         const SCEV *Ret = AddRec->getNumIterationsInRange(CompRange, *this);
3998         if (!isa<SCEVCouldNotCompute>(Ret)) return Ret;
3999       }
4000
4001   switch (Cond) {
4002   case ICmpInst::ICMP_NE: {                     // while (X != Y)
4003     // Convert to: while (X-Y != 0)
4004     BackedgeTakenInfo BTI = HowFarToZero(getMinusSCEV(LHS, RHS), L);
4005     if (BTI.hasAnyInfo()) return BTI;
4006     break;
4007   }
4008   case ICmpInst::ICMP_EQ: {                     // while (X == Y)
4009     // Convert to: while (X-Y == 0)
4010     BackedgeTakenInfo BTI = HowFarToNonZero(getMinusSCEV(LHS, RHS), L);
4011     if (BTI.hasAnyInfo()) return BTI;
4012     break;
4013   }
4014   case ICmpInst::ICMP_SLT: {
4015     BackedgeTakenInfo BTI = HowManyLessThans(LHS, RHS, L, true);
4016     if (BTI.hasAnyInfo()) return BTI;
4017     break;
4018   }
4019   case ICmpInst::ICMP_SGT: {
4020     BackedgeTakenInfo BTI = HowManyLessThans(getNotSCEV(LHS),
4021                                              getNotSCEV(RHS), L, true);
4022     if (BTI.hasAnyInfo()) return BTI;
4023     break;
4024   }
4025   case ICmpInst::ICMP_ULT: {
4026     BackedgeTakenInfo BTI = HowManyLessThans(LHS, RHS, L, false);
4027     if (BTI.hasAnyInfo()) return BTI;
4028     break;
4029   }
4030   case ICmpInst::ICMP_UGT: {
4031     BackedgeTakenInfo BTI = HowManyLessThans(getNotSCEV(LHS),
4032                                              getNotSCEV(RHS), L, false);
4033     if (BTI.hasAnyInfo()) return BTI;
4034     break;
4035   }
4036   default:
4037 #if 0
4038     dbgs() << "ComputeBackedgeTakenCount ";
4039     if (ExitCond->getOperand(0)->getType()->isUnsigned())
4040       dbgs() << "[unsigned] ";
4041     dbgs() << *LHS << "   "
4042          << Instruction::getOpcodeName(Instruction::ICmp)
4043          << "   " << *RHS << "\n";
4044 #endif
4045     break;
4046   }
4047   return
4048     ComputeBackedgeTakenCountExhaustively(L, ExitCond, !L->contains(TBB));
4049 }
4050
4051 static ConstantInt *
4052 EvaluateConstantChrecAtConstant(const SCEVAddRecExpr *AddRec, ConstantInt *C,
4053                                 ScalarEvolution &SE) {
4054   const SCEV *InVal = SE.getConstant(C);
4055   const SCEV *Val = AddRec->evaluateAtIteration(InVal, SE);
4056   assert(isa<SCEVConstant>(Val) &&
4057          "Evaluation of SCEV at constant didn't fold correctly?");
4058   return cast<SCEVConstant>(Val)->getValue();
4059 }
4060
4061 /// GetAddressedElementFromGlobal - Given a global variable with an initializer
4062 /// and a GEP expression (missing the pointer index) indexing into it, return
4063 /// the addressed element of the initializer or null if the index expression is
4064 /// invalid.
4065 static Constant *
4066 GetAddressedElementFromGlobal(GlobalVariable *GV,
4067                               const std::vector<ConstantInt*> &Indices) {
4068   Constant *Init = GV->getInitializer();
4069   for (unsigned i = 0, e = Indices.size(); i != e; ++i) {
4070     uint64_t Idx = Indices[i]->getZExtValue();
4071     if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Init)) {
4072       assert(Idx < CS->getNumOperands() && "Bad struct index!");
4073       Init = cast<Constant>(CS->getOperand(Idx));
4074     } else if (ConstantArray *CA = dyn_cast<ConstantArray>(Init)) {
4075       if (Idx >= CA->getNumOperands()) return 0;  // Bogus program
4076       Init = cast<Constant>(CA->getOperand(Idx));
4077     } else if (isa<ConstantAggregateZero>(Init)) {
4078       if (const StructType *STy = dyn_cast<StructType>(Init->getType())) {
4079         assert(Idx < STy->getNumElements() && "Bad struct index!");
4080         Init = Constant::getNullValue(STy->getElementType(Idx));
4081       } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Init->getType())) {
4082         if (Idx >= ATy->getNumElements()) return 0;  // Bogus program
4083         Init = Constant::getNullValue(ATy->getElementType());
4084       } else {
4085         llvm_unreachable("Unknown constant aggregate type!");
4086       }
4087       return 0;
4088     } else {
4089       return 0; // Unknown initializer type
4090     }
4091   }
4092   return Init;
4093 }
4094
4095 /// ComputeLoadConstantCompareBackedgeTakenCount - Given an exit condition of
4096 /// 'icmp op load X, cst', try to see if we can compute the backedge
4097 /// execution count.
4098 ScalarEvolution::BackedgeTakenInfo
4099 ScalarEvolution::ComputeLoadConstantCompareBackedgeTakenCount(
4100                                                 LoadInst *LI,
4101                                                 Constant *RHS,
4102                                                 const Loop *L,
4103                                                 ICmpInst::Predicate predicate) {
4104   if (LI->isVolatile()) return getCouldNotCompute();
4105
4106   // Check to see if the loaded pointer is a getelementptr of a global.
4107   // TODO: Use SCEV instead of manually grubbing with GEPs.
4108   GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0));
4109   if (!GEP) return getCouldNotCompute();
4110
4111   // Make sure that it is really a constant global we are gepping, with an
4112   // initializer, and make sure the first IDX is really 0.
4113   GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0));
4114   if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() ||
4115       GEP->getNumOperands() < 3 || !isa<Constant>(GEP->getOperand(1)) ||
4116       !cast<Constant>(GEP->getOperand(1))->isNullValue())
4117     return getCouldNotCompute();
4118
4119   // Okay, we allow one non-constant index into the GEP instruction.
4120   Value *VarIdx = 0;
4121   std::vector<ConstantInt*> Indexes;
4122   unsigned VarIdxNum = 0;
4123   for (unsigned i = 2, e = GEP->getNumOperands(); i != e; ++i)
4124     if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
4125       Indexes.push_back(CI);
4126     } else if (!isa<ConstantInt>(GEP->getOperand(i))) {
4127       if (VarIdx) return getCouldNotCompute();  // Multiple non-constant idx's.
4128       VarIdx = GEP->getOperand(i);
4129       VarIdxNum = i-2;
4130       Indexes.push_back(0);
4131     }
4132
4133   // Okay, we know we have a (load (gep GV, 0, X)) comparison with a constant.
4134   // Check to see if X is a loop variant variable value now.
4135   const SCEV *Idx = getSCEV(VarIdx);
4136   Idx = getSCEVAtScope(Idx, L);
4137
4138   // We can only recognize very limited forms of loop index expressions, in
4139   // particular, only affine AddRec's like {C1,+,C2}.
4140   const SCEVAddRecExpr *IdxExpr = dyn_cast<SCEVAddRecExpr>(Idx);
4141   if (!IdxExpr || !IdxExpr->isAffine() || isLoopInvariant(IdxExpr, L) ||
4142       !isa<SCEVConstant>(IdxExpr->getOperand(0)) ||
4143       !isa<SCEVConstant>(IdxExpr->getOperand(1)))
4144     return getCouldNotCompute();
4145
4146   unsigned MaxSteps = MaxBruteForceIterations;
4147   for (unsigned IterationNum = 0; IterationNum != MaxSteps; ++IterationNum) {
4148     ConstantInt *ItCst = ConstantInt::get(
4149                            cast<IntegerType>(IdxExpr->getType()), IterationNum);
4150     ConstantInt *Val = EvaluateConstantChrecAtConstant(IdxExpr, ItCst, *this);
4151
4152     // Form the GEP offset.
4153     Indexes[VarIdxNum] = Val;
4154
4155     Constant *Result = GetAddressedElementFromGlobal(GV, Indexes);
4156     if (Result == 0) break;  // Cannot compute!
4157
4158     // Evaluate the condition for this iteration.
4159     Result = ConstantExpr::getICmp(predicate, Result, RHS);
4160     if (!isa<ConstantInt>(Result)) break;  // Couldn't decide for sure
4161     if (cast<ConstantInt>(Result)->getValue().isMinValue()) {
4162 #if 0
4163       dbgs() << "\n***\n*** Computed loop count " << *ItCst
4164              << "\n*** From global " << *GV << "*** BB: " << *L->getHeader()
4165              << "***\n";
4166 #endif
4167       ++NumArrayLenItCounts;
4168       return getConstant(ItCst);   // Found terminating iteration!
4169     }
4170   }
4171   return getCouldNotCompute();
4172 }
4173
4174
4175 /// CanConstantFold - Return true if we can constant fold an instruction of the
4176 /// specified type, assuming that all operands were constants.
4177 static bool CanConstantFold(const Instruction *I) {
4178   if (isa<BinaryOperator>(I) || isa<CmpInst>(I) ||
4179       isa<SelectInst>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I))
4180     return true;
4181
4182   if (const CallInst *CI = dyn_cast<CallInst>(I))
4183     if (const Function *F = CI->getCalledFunction())
4184       return canConstantFoldCallTo(F);
4185   return false;
4186 }
4187
4188 /// getConstantEvolvingPHI - Given an LLVM value and a loop, return a PHI node
4189 /// in the loop that V is derived from.  We allow arbitrary operations along the
4190 /// way, but the operands of an operation must either be constants or a value
4191 /// derived from a constant PHI.  If this expression does not fit with these
4192 /// constraints, return null.
4193 static PHINode *getConstantEvolvingPHI(Value *V, const Loop *L) {
4194   // If this is not an instruction, or if this is an instruction outside of the
4195   // loop, it can't be derived from a loop PHI.
4196   Instruction *I = dyn_cast<Instruction>(V);
4197   if (I == 0 || !L->contains(I)) return 0;
4198
4199   if (PHINode *PN = dyn_cast<PHINode>(I)) {
4200     if (L->getHeader() == I->getParent())
4201       return PN;
4202     else
4203       // We don't currently keep track of the control flow needed to evaluate
4204       // PHIs, so we cannot handle PHIs inside of loops.
4205       return 0;
4206   }
4207
4208   // If we won't be able to constant fold this expression even if the operands
4209   // are constants, return early.
4210   if (!CanConstantFold(I)) return 0;
4211
4212   // Otherwise, we can evaluate this instruction if all of its operands are
4213   // constant or derived from a PHI node themselves.
4214   PHINode *PHI = 0;
4215   for (unsigned Op = 0, e = I->getNumOperands(); Op != e; ++Op)
4216     if (!isa<Constant>(I->getOperand(Op))) {
4217       PHINode *P = getConstantEvolvingPHI(I->getOperand(Op), L);
4218       if (P == 0) return 0;  // Not evolving from PHI
4219       if (PHI == 0)
4220         PHI = P;
4221       else if (PHI != P)
4222         return 0;  // Evolving from multiple different PHIs.
4223     }
4224
4225   // This is a expression evolving from a constant PHI!
4226   return PHI;
4227 }
4228
4229 /// EvaluateExpression - Given an expression that passes the
4230 /// getConstantEvolvingPHI predicate, evaluate its value assuming the PHI node
4231 /// in the loop has the value PHIVal.  If we can't fold this expression for some
4232 /// reason, return null.
4233 static Constant *EvaluateExpression(Value *V, Constant *PHIVal,
4234                                     const TargetData *TD) {
4235   if (isa<PHINode>(V)) return PHIVal;
4236   if (Constant *C = dyn_cast<Constant>(V)) return C;
4237   Instruction *I = cast<Instruction>(V);
4238
4239   std::vector<Constant*> Operands(I->getNumOperands());
4240
4241   for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
4242     Operands[i] = EvaluateExpression(I->getOperand(i), PHIVal, TD);
4243     if (Operands[i] == 0) return 0;
4244   }
4245
4246   if (const CmpInst *CI = dyn_cast<CmpInst>(I))
4247     return ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0],
4248                                            Operands[1], TD);
4249   return ConstantFoldInstOperands(I->getOpcode(), I->getType(),
4250                                   &Operands[0], Operands.size(), TD);
4251 }
4252
4253 /// getConstantEvolutionLoopExitValue - If we know that the specified Phi is
4254 /// in the header of its containing loop, we know the loop executes a
4255 /// constant number of times, and the PHI node is just a recurrence
4256 /// involving constants, fold it.
4257 Constant *
4258 ScalarEvolution::getConstantEvolutionLoopExitValue(PHINode *PN,
4259                                                    const APInt &BEs,
4260                                                    const Loop *L) {
4261   std::map<PHINode*, Constant*>::const_iterator I =
4262     ConstantEvolutionLoopExitValue.find(PN);
4263   if (I != ConstantEvolutionLoopExitValue.end())
4264     return I->second;
4265
4266   if (BEs.ugt(MaxBruteForceIterations))
4267     return ConstantEvolutionLoopExitValue[PN] = 0;  // Not going to evaluate it.
4268
4269   Constant *&RetVal = ConstantEvolutionLoopExitValue[PN];
4270
4271   // Since the loop is canonicalized, the PHI node must have two entries.  One
4272   // entry must be a constant (coming in from outside of the loop), and the
4273   // second must be derived from the same PHI.
4274   bool SecondIsBackedge = L->contains(PN->getIncomingBlock(1));
4275   Constant *StartCST =
4276     dyn_cast<Constant>(PN->getIncomingValue(!SecondIsBackedge));
4277   if (StartCST == 0)
4278     return RetVal = 0;  // Must be a constant.
4279
4280   Value *BEValue = PN->getIncomingValue(SecondIsBackedge);
4281   if (getConstantEvolvingPHI(BEValue, L) != PN &&
4282       !isa<Constant>(BEValue))
4283     return RetVal = 0;  // Not derived from same PHI.
4284
4285   // Execute the loop symbolically to determine the exit value.
4286   if (BEs.getActiveBits() >= 32)
4287     return RetVal = 0; // More than 2^32-1 iterations?? Not doing it!
4288
4289   unsigned NumIterations = BEs.getZExtValue(); // must be in range
4290   unsigned IterationNum = 0;
4291   for (Constant *PHIVal = StartCST; ; ++IterationNum) {
4292     if (IterationNum == NumIterations)
4293       return RetVal = PHIVal;  // Got exit value!
4294
4295     // Compute the value of the PHI node for the next iteration.
4296     Constant *NextPHI = EvaluateExpression(BEValue, PHIVal, TD);
4297     if (NextPHI == PHIVal)
4298       return RetVal = NextPHI;  // Stopped evolving!
4299     if (NextPHI == 0)
4300       return 0;        // Couldn't evaluate!
4301     PHIVal = NextPHI;
4302   }
4303 }
4304
4305 /// ComputeBackedgeTakenCountExhaustively - If the loop is known to execute a
4306 /// constant number of times (the condition evolves only from constants),
4307 /// try to evaluate a few iterations of the loop until we get the exit
4308 /// condition gets a value of ExitWhen (true or false).  If we cannot
4309 /// evaluate the trip count of the loop, return getCouldNotCompute().
4310 const SCEV *
4311 ScalarEvolution::ComputeBackedgeTakenCountExhaustively(const Loop *L,
4312                                                        Value *Cond,
4313                                                        bool ExitWhen) {
4314   PHINode *PN = getConstantEvolvingPHI(Cond, L);
4315   if (PN == 0) return getCouldNotCompute();
4316
4317   // If the loop is canonicalized, the PHI will have exactly two entries.
4318   // That's the only form we support here.
4319   if (PN->getNumIncomingValues() != 2) return getCouldNotCompute();
4320
4321   // One entry must be a constant (coming in from outside of the loop), and the
4322   // second must be derived from the same PHI.
4323   bool SecondIsBackedge = L->contains(PN->getIncomingBlock(1));
4324   Constant *StartCST =
4325     dyn_cast<Constant>(PN->getIncomingValue(!SecondIsBackedge));
4326   if (StartCST == 0) return getCouldNotCompute();  // Must be a constant.
4327
4328   Value *BEValue = PN->getIncomingValue(SecondIsBackedge);
4329   if (getConstantEvolvingPHI(BEValue, L) != PN &&
4330       !isa<Constant>(BEValue))
4331     return getCouldNotCompute();  // Not derived from same PHI.
4332
4333   // Okay, we find a PHI node that defines the trip count of this loop.  Execute
4334   // the loop symbolically to determine when the condition gets a value of
4335   // "ExitWhen".
4336   unsigned IterationNum = 0;
4337   unsigned MaxIterations = MaxBruteForceIterations;   // Limit analysis.
4338   for (Constant *PHIVal = StartCST;
4339        IterationNum != MaxIterations; ++IterationNum) {
4340     ConstantInt *CondVal =
4341       dyn_cast_or_null<ConstantInt>(EvaluateExpression(Cond, PHIVal, TD));
4342
4343     // Couldn't symbolically evaluate.
4344     if (!CondVal) return getCouldNotCompute();
4345
4346     if (CondVal->getValue() == uint64_t(ExitWhen)) {
4347       ++NumBruteForceTripCountsComputed;
4348       return getConstant(Type::getInt32Ty(getContext()), IterationNum);
4349     }
4350
4351     // Compute the value of the PHI node for the next iteration.
4352     Constant *NextPHI = EvaluateExpression(BEValue, PHIVal, TD);
4353     if (NextPHI == 0 || NextPHI == PHIVal)
4354       return getCouldNotCompute();// Couldn't evaluate or not making progress...
4355     PHIVal = NextPHI;
4356   }
4357
4358   // Too many iterations were needed to evaluate.
4359   return getCouldNotCompute();
4360 }
4361
4362 /// getSCEVAtScope - Return a SCEV expression for the specified value
4363 /// at the specified scope in the program.  The L value specifies a loop
4364 /// nest to evaluate the expression at, where null is the top-level or a
4365 /// specified loop is immediately inside of the loop.
4366 ///
4367 /// This method can be used to compute the exit value for a variable defined
4368 /// in a loop by querying what the value will hold in the parent loop.
4369 ///
4370 /// In the case that a relevant loop exit value cannot be computed, the
4371 /// original value V is returned.
4372 const SCEV *ScalarEvolution::getSCEVAtScope(const SCEV *V, const Loop *L) {
4373   // Check to see if we've folded this expression at this loop before.
4374   std::map<const Loop *, const SCEV *> &Values = ValuesAtScopes[V];
4375   std::pair<std::map<const Loop *, const SCEV *>::iterator, bool> Pair =
4376     Values.insert(std::make_pair(L, static_cast<const SCEV *>(0)));
4377   if (!Pair.second)
4378     return Pair.first->second ? Pair.first->second : V;
4379
4380   // Otherwise compute it.
4381   const SCEV *C = computeSCEVAtScope(V, L);
4382   ValuesAtScopes[V][L] = C;
4383   return C;
4384 }
4385
4386 const SCEV *ScalarEvolution::computeSCEVAtScope(const SCEV *V, const Loop *L) {
4387   if (isa<SCEVConstant>(V)) return V;
4388
4389   // If this instruction is evolved from a constant-evolving PHI, compute the
4390   // exit value from the loop without using SCEVs.
4391   if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V)) {
4392     if (Instruction *I = dyn_cast<Instruction>(SU->getValue())) {
4393       const Loop *LI = (*this->LI)[I->getParent()];
4394       if (LI && LI->getParentLoop() == L)  // Looking for loop exit value.
4395         if (PHINode *PN = dyn_cast<PHINode>(I))
4396           if (PN->getParent() == LI->getHeader()) {
4397             // Okay, there is no closed form solution for the PHI node.  Check
4398             // to see if the loop that contains it has a known backedge-taken
4399             // count.  If so, we may be able to force computation of the exit
4400             // value.
4401             const SCEV *BackedgeTakenCount = getBackedgeTakenCount(LI);
4402             if (const SCEVConstant *BTCC =
4403                   dyn_cast<SCEVConstant>(BackedgeTakenCount)) {
4404               // Okay, we know how many times the containing loop executes.  If
4405               // this is a constant evolving PHI node, get the final value at
4406               // the specified iteration number.
4407               Constant *RV = getConstantEvolutionLoopExitValue(PN,
4408                                                    BTCC->getValue()->getValue(),
4409                                                                LI);
4410               if (RV) return getSCEV(RV);
4411             }
4412           }
4413
4414       // Okay, this is an expression that we cannot symbolically evaluate
4415       // into a SCEV.  Check to see if it's possible to symbolically evaluate
4416       // the arguments into constants, and if so, try to constant propagate the
4417       // result.  This is particularly useful for computing loop exit values.
4418       if (CanConstantFold(I)) {
4419         SmallVector<Constant *, 4> Operands;
4420         bool MadeImprovement = false;
4421         for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
4422           Value *Op = I->getOperand(i);
4423           if (Constant *C = dyn_cast<Constant>(Op)) {
4424             Operands.push_back(C);
4425             continue;
4426           }
4427
4428           // If any of the operands is non-constant and if they are
4429           // non-integer and non-pointer, don't even try to analyze them
4430           // with scev techniques.
4431           if (!isSCEVable(Op->getType()))
4432             return V;
4433
4434           const SCEV *OrigV = getSCEV(Op);
4435           const SCEV *OpV = getSCEVAtScope(OrigV, L);
4436           MadeImprovement |= OrigV != OpV;
4437
4438           Constant *C = 0;
4439           if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(OpV))
4440             C = SC->getValue();
4441           if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(OpV))
4442             C = dyn_cast<Constant>(SU->getValue());
4443           if (!C) return V;
4444           if (C->getType() != Op->getType())
4445             C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
4446                                                               Op->getType(),
4447                                                               false),
4448                                       C, Op->getType());
4449           Operands.push_back(C);
4450         }
4451
4452         // Check to see if getSCEVAtScope actually made an improvement.
4453         if (MadeImprovement) {
4454           Constant *C = 0;
4455           if (const CmpInst *CI = dyn_cast<CmpInst>(I))
4456             C = ConstantFoldCompareInstOperands(CI->getPredicate(),
4457                                                 Operands[0], Operands[1], TD);
4458           else
4459             C = ConstantFoldInstOperands(I->getOpcode(), I->getType(),
4460                                          &Operands[0], Operands.size(), TD);
4461           if (!C) return V;
4462           return getSCEV(C);
4463         }
4464       }
4465     }
4466
4467     // This is some other type of SCEVUnknown, just return it.
4468     return V;
4469   }
4470
4471   if (const SCEVCommutativeExpr *Comm = dyn_cast<SCEVCommutativeExpr>(V)) {
4472     // Avoid performing the look-up in the common case where the specified
4473     // expression has no loop-variant portions.
4474     for (unsigned i = 0, e = Comm->getNumOperands(); i != e; ++i) {
4475       const SCEV *OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
4476       if (OpAtScope != Comm->getOperand(i)) {
4477         // Okay, at least one of these operands is loop variant but might be
4478         // foldable.  Build a new instance of the folded commutative expression.
4479         SmallVector<const SCEV *, 8> NewOps(Comm->op_begin(),
4480                                             Comm->op_begin()+i);
4481         NewOps.push_back(OpAtScope);
4482
4483         for (++i; i != e; ++i) {
4484           OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
4485           NewOps.push_back(OpAtScope);
4486         }
4487         if (isa<SCEVAddExpr>(Comm))
4488           return getAddExpr(NewOps);
4489         if (isa<SCEVMulExpr>(Comm))
4490           return getMulExpr(NewOps);
4491         if (isa<SCEVSMaxExpr>(Comm))
4492           return getSMaxExpr(NewOps);
4493         if (isa<SCEVUMaxExpr>(Comm))
4494           return getUMaxExpr(NewOps);
4495         llvm_unreachable("Unknown commutative SCEV type!");
4496       }
4497     }
4498     // If we got here, all operands are loop invariant.
4499     return Comm;
4500   }
4501
4502   if (const SCEVUDivExpr *Div = dyn_cast<SCEVUDivExpr>(V)) {
4503     const SCEV *LHS = getSCEVAtScope(Div->getLHS(), L);
4504     const SCEV *RHS = getSCEVAtScope(Div->getRHS(), L);
4505     if (LHS == Div->getLHS() && RHS == Div->getRHS())
4506       return Div;   // must be loop invariant
4507     return getUDivExpr(LHS, RHS);
4508   }
4509
4510   // If this is a loop recurrence for a loop that does not contain L, then we
4511   // are dealing with the final value computed by the loop.
4512   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V)) {
4513     // First, attempt to evaluate each operand.
4514     // Avoid performing the look-up in the common case where the specified
4515     // expression has no loop-variant portions.
4516     for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
4517       const SCEV *OpAtScope = getSCEVAtScope(AddRec->getOperand(i), L);
4518       if (OpAtScope == AddRec->getOperand(i))
4519         continue;
4520
4521       // Okay, at least one of these operands is loop variant but might be
4522       // foldable.  Build a new instance of the folded commutative expression.
4523       SmallVector<const SCEV *, 8> NewOps(AddRec->op_begin(),
4524                                           AddRec->op_begin()+i);
4525       NewOps.push_back(OpAtScope);
4526       for (++i; i != e; ++i)
4527         NewOps.push_back(getSCEVAtScope(AddRec->getOperand(i), L));
4528
4529       AddRec = cast<SCEVAddRecExpr>(getAddRecExpr(NewOps, AddRec->getLoop()));
4530       break;
4531     }
4532
4533     // If the scope is outside the addrec's loop, evaluate it by using the
4534     // loop exit value of the addrec.
4535     if (!AddRec->getLoop()->contains(L)) {
4536       // To evaluate this recurrence, we need to know how many times the AddRec
4537       // loop iterates.  Compute this now.
4538       const SCEV *BackedgeTakenCount = getBackedgeTakenCount(AddRec->getLoop());
4539       if (BackedgeTakenCount == getCouldNotCompute()) return AddRec;
4540
4541       // Then, evaluate the AddRec.
4542       return AddRec->evaluateAtIteration(BackedgeTakenCount, *this);
4543     }
4544
4545     return AddRec;
4546   }
4547
4548   if (const SCEVZeroExtendExpr *Cast = dyn_cast<SCEVZeroExtendExpr>(V)) {
4549     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
4550     if (Op == Cast->getOperand())
4551       return Cast;  // must be loop invariant
4552     return getZeroExtendExpr(Op, Cast->getType());
4553   }
4554
4555   if (const SCEVSignExtendExpr *Cast = dyn_cast<SCEVSignExtendExpr>(V)) {
4556     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
4557     if (Op == Cast->getOperand())
4558       return Cast;  // must be loop invariant
4559     return getSignExtendExpr(Op, Cast->getType());
4560   }
4561
4562   if (const SCEVTruncateExpr *Cast = dyn_cast<SCEVTruncateExpr>(V)) {
4563     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
4564     if (Op == Cast->getOperand())
4565       return Cast;  // must be loop invariant
4566     return getTruncateExpr(Op, Cast->getType());
4567   }
4568
4569   llvm_unreachable("Unknown SCEV type!");
4570   return 0;
4571 }
4572
4573 /// getSCEVAtScope - This is a convenience function which does
4574 /// getSCEVAtScope(getSCEV(V), L).
4575 const SCEV *ScalarEvolution::getSCEVAtScope(Value *V, const Loop *L) {
4576   return getSCEVAtScope(getSCEV(V), L);
4577 }
4578
4579 /// SolveLinEquationWithOverflow - Finds the minimum unsigned root of the
4580 /// following equation:
4581 ///
4582 ///     A * X = B (mod N)
4583 ///
4584 /// where N = 2^BW and BW is the common bit width of A and B. The signedness of
4585 /// A and B isn't important.
4586 ///
4587 /// If the equation does not have a solution, SCEVCouldNotCompute is returned.
4588 static const SCEV *SolveLinEquationWithOverflow(const APInt &A, const APInt &B,
4589                                                ScalarEvolution &SE) {
4590   uint32_t BW = A.getBitWidth();
4591   assert(BW == B.getBitWidth() && "Bit widths must be the same.");
4592   assert(A != 0 && "A must be non-zero.");
4593
4594   // 1. D = gcd(A, N)
4595   //
4596   // The gcd of A and N may have only one prime factor: 2. The number of
4597   // trailing zeros in A is its multiplicity
4598   uint32_t Mult2 = A.countTrailingZeros();
4599   // D = 2^Mult2
4600
4601   // 2. Check if B is divisible by D.
4602   //
4603   // B is divisible by D if and only if the multiplicity of prime factor 2 for B
4604   // is not less than multiplicity of this prime factor for D.
4605   if (B.countTrailingZeros() < Mult2)
4606     return SE.getCouldNotCompute();
4607
4608   // 3. Compute I: the multiplicative inverse of (A / D) in arithmetic
4609   // modulo (N / D).
4610   //
4611   // (N / D) may need BW+1 bits in its representation.  Hence, we'll use this
4612   // bit width during computations.
4613   APInt AD = A.lshr(Mult2).zext(BW + 1);  // AD = A / D
4614   APInt Mod(BW + 1, 0);
4615   Mod.setBit(BW - Mult2);  // Mod = N / D
4616   APInt I = AD.multiplicativeInverse(Mod);
4617
4618   // 4. Compute the minimum unsigned root of the equation:
4619   // I * (B / D) mod (N / D)
4620   APInt Result = (I * B.lshr(Mult2).zext(BW + 1)).urem(Mod);
4621
4622   // The result is guaranteed to be less than 2^BW so we may truncate it to BW
4623   // bits.
4624   return SE.getConstant(Result.trunc(BW));
4625 }
4626
4627 /// SolveQuadraticEquation - Find the roots of the quadratic equation for the
4628 /// given quadratic chrec {L,+,M,+,N}.  This returns either the two roots (which
4629 /// might be the same) or two SCEVCouldNotCompute objects.
4630 ///
4631 static std::pair<const SCEV *,const SCEV *>
4632 SolveQuadraticEquation(const SCEVAddRecExpr *AddRec, ScalarEvolution &SE) {
4633   assert(AddRec->getNumOperands() == 3 && "This is not a quadratic chrec!");
4634   const SCEVConstant *LC = dyn_cast<SCEVConstant>(AddRec->getOperand(0));
4635   const SCEVConstant *MC = dyn_cast<SCEVConstant>(AddRec->getOperand(1));
4636   const SCEVConstant *NC = dyn_cast<SCEVConstant>(AddRec->getOperand(2));
4637
4638   // We currently can only solve this if the coefficients are constants.
4639   if (!LC || !MC || !NC) {
4640     const SCEV *CNC = SE.getCouldNotCompute();
4641     return std::make_pair(CNC, CNC);
4642   }
4643
4644   uint32_t BitWidth = LC->getValue()->getValue().getBitWidth();
4645   const APInt &L = LC->getValue()->getValue();
4646   const APInt &M = MC->getValue()->getValue();
4647   const APInt &N = NC->getValue()->getValue();
4648   APInt Two(BitWidth, 2);
4649   APInt Four(BitWidth, 4);
4650
4651   {
4652     using namespace APIntOps;
4653     const APInt& C = L;
4654     // Convert from chrec coefficients to polynomial coefficients AX^2+BX+C
4655     // The B coefficient is M-N/2
4656     APInt B(M);
4657     B -= sdiv(N,Two);
4658
4659     // The A coefficient is N/2
4660     APInt A(N.sdiv(Two));
4661
4662     // Compute the B^2-4ac term.
4663     APInt SqrtTerm(B);
4664     SqrtTerm *= B;
4665     SqrtTerm -= Four * (A * C);
4666
4667     // Compute sqrt(B^2-4ac). This is guaranteed to be the nearest
4668     // integer value or else APInt::sqrt() will assert.
4669     APInt SqrtVal(SqrtTerm.sqrt());
4670
4671     // Compute the two solutions for the quadratic formula.
4672     // The divisions must be performed as signed divisions.
4673     APInt NegB(-B);
4674     APInt TwoA( A << 1 );
4675     if (TwoA.isMinValue()) {
4676       const SCEV *CNC = SE.getCouldNotCompute();
4677       return std::make_pair(CNC, CNC);
4678     }
4679
4680     LLVMContext &Context = SE.getContext();
4681
4682     ConstantInt *Solution1 =
4683       ConstantInt::get(Context, (NegB + SqrtVal).sdiv(TwoA));
4684     ConstantInt *Solution2 =
4685       ConstantInt::get(Context, (NegB - SqrtVal).sdiv(TwoA));
4686
4687     return std::make_pair(SE.getConstant(Solution1),
4688                           SE.getConstant(Solution2));
4689     } // end APIntOps namespace
4690 }
4691
4692 /// HowFarToZero - Return the number of times a backedge comparing the specified
4693 /// value to zero will execute.  If not computable, return CouldNotCompute.
4694 ScalarEvolution::BackedgeTakenInfo
4695 ScalarEvolution::HowFarToZero(const SCEV *V, const Loop *L) {
4696   // If the value is a constant
4697   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
4698     // If the value is already zero, the branch will execute zero times.
4699     if (C->getValue()->isZero()) return C;
4700     return getCouldNotCompute();  // Otherwise it will loop infinitely.
4701   }
4702
4703   const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V);
4704   if (!AddRec || AddRec->getLoop() != L)
4705     return getCouldNotCompute();
4706
4707   if (AddRec->isAffine()) {
4708     // If this is an affine expression, the execution count of this branch is
4709     // the minimum unsigned root of the following equation:
4710     //
4711     //     Start + Step*N = 0 (mod 2^BW)
4712     //
4713     // equivalent to:
4714     //
4715     //             Step*N = -Start (mod 2^BW)
4716     //
4717     // where BW is the common bit width of Start and Step.
4718
4719     // Get the initial value for the loop.
4720     const SCEV *Start = getSCEVAtScope(AddRec->getStart(),
4721                                        L->getParentLoop());
4722     const SCEV *Step = getSCEVAtScope(AddRec->getOperand(1),
4723                                       L->getParentLoop());
4724
4725     if (const SCEVConstant *StepC = dyn_cast<SCEVConstant>(Step)) {
4726       // For now we handle only constant steps.
4727
4728       // First, handle unitary steps.
4729       if (StepC->getValue()->equalsInt(1))      // 1*N = -Start (mod 2^BW), so:
4730         return getNegativeSCEV(Start);          //   N = -Start (as unsigned)
4731       if (StepC->getValue()->isAllOnesValue())  // -1*N = -Start (mod 2^BW), so:
4732         return Start;                           //    N = Start (as unsigned)
4733
4734       // Then, try to solve the above equation provided that Start is constant.
4735       if (const SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start))
4736         return SolveLinEquationWithOverflow(StepC->getValue()->getValue(),
4737                                             -StartC->getValue()->getValue(),
4738                                             *this);
4739     }
4740   } else if (AddRec->isQuadratic() && AddRec->getType()->isIntegerTy()) {
4741     // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of
4742     // the quadratic equation to solve it.
4743     std::pair<const SCEV *,const SCEV *> Roots = SolveQuadraticEquation(AddRec,
4744                                                                     *this);
4745     const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
4746     const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
4747     if (R1) {
4748 #if 0
4749       dbgs() << "HFTZ: " << *V << " - sol#1: " << *R1
4750              << "  sol#2: " << *R2 << "\n";
4751 #endif
4752       // Pick the smallest positive root value.
4753       if (ConstantInt *CB =
4754           dyn_cast<ConstantInt>(ConstantExpr::getICmp(ICmpInst::ICMP_ULT,
4755                                    R1->getValue(), R2->getValue()))) {
4756         if (CB->getZExtValue() == false)
4757           std::swap(R1, R2);   // R1 is the minimum root now.
4758
4759         // We can only use this value if the chrec ends up with an exact zero
4760         // value at this index.  When solving for "X*X != 5", for example, we
4761         // should not accept a root of 2.
4762         const SCEV *Val = AddRec->evaluateAtIteration(R1, *this);
4763         if (Val->isZero())
4764           return R1;  // We found a quadratic root!
4765       }
4766     }
4767   }
4768
4769   return getCouldNotCompute();
4770 }
4771
4772 /// HowFarToNonZero - Return the number of times a backedge checking the
4773 /// specified value for nonzero will execute.  If not computable, return
4774 /// CouldNotCompute
4775 ScalarEvolution::BackedgeTakenInfo
4776 ScalarEvolution::HowFarToNonZero(const SCEV *V, const Loop *L) {
4777   // Loops that look like: while (X == 0) are very strange indeed.  We don't
4778   // handle them yet except for the trivial case.  This could be expanded in the
4779   // future as needed.
4780
4781   // If the value is a constant, check to see if it is known to be non-zero
4782   // already.  If so, the backedge will execute zero times.
4783   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
4784     if (!C->getValue()->isNullValue())
4785       return getConstant(C->getType(), 0);
4786     return getCouldNotCompute();  // Otherwise it will loop infinitely.
4787   }
4788
4789   // We could implement others, but I really doubt anyone writes loops like
4790   // this, and if they did, they would already be constant folded.
4791   return getCouldNotCompute();
4792 }
4793
4794 /// getPredecessorWithUniqueSuccessorForBB - Return a predecessor of BB
4795 /// (which may not be an immediate predecessor) which has exactly one
4796 /// successor from which BB is reachable, or null if no such block is
4797 /// found.
4798 ///
4799 std::pair<BasicBlock *, BasicBlock *>
4800 ScalarEvolution::getPredecessorWithUniqueSuccessorForBB(BasicBlock *BB) {
4801   // If the block has a unique predecessor, then there is no path from the
4802   // predecessor to the block that does not go through the direct edge
4803   // from the predecessor to the block.
4804   if (BasicBlock *Pred = BB->getSinglePredecessor())
4805     return std::make_pair(Pred, BB);
4806
4807   // A loop's header is defined to be a block that dominates the loop.
4808   // If the header has a unique predecessor outside the loop, it must be
4809   // a block that has exactly one successor that can reach the loop.
4810   if (Loop *L = LI->getLoopFor(BB))
4811     return std::make_pair(L->getLoopPredecessor(), L->getHeader());
4812
4813   return std::pair<BasicBlock *, BasicBlock *>();
4814 }
4815
4816 /// HasSameValue - SCEV structural equivalence is usually sufficient for
4817 /// testing whether two expressions are equal, however for the purposes of
4818 /// looking for a condition guarding a loop, it can be useful to be a little
4819 /// more general, since a front-end may have replicated the controlling
4820 /// expression.
4821 ///
4822 static bool HasSameValue(const SCEV *A, const SCEV *B) {
4823   // Quick check to see if they are the same SCEV.
4824   if (A == B) return true;
4825
4826   // Otherwise, if they're both SCEVUnknown, it's possible that they hold
4827   // two different instructions with the same value. Check for this case.
4828   if (const SCEVUnknown *AU = dyn_cast<SCEVUnknown>(A))
4829     if (const SCEVUnknown *BU = dyn_cast<SCEVUnknown>(B))
4830       if (const Instruction *AI = dyn_cast<Instruction>(AU->getValue()))
4831         if (const Instruction *BI = dyn_cast<Instruction>(BU->getValue()))
4832           if (AI->isIdenticalTo(BI) && !AI->mayReadFromMemory())
4833             return true;
4834
4835   // Otherwise assume they may have a different value.
4836   return false;
4837 }
4838
4839 /// SimplifyICmpOperands - Simplify LHS and RHS in a comparison with
4840 /// predicate Pred. Return true iff any changes were made.
4841 ///
4842 bool ScalarEvolution::SimplifyICmpOperands(ICmpInst::Predicate &Pred,
4843                                            const SCEV *&LHS, const SCEV *&RHS) {
4844   bool Changed = false;
4845
4846   // Canonicalize a constant to the right side.
4847   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
4848     // Check for both operands constant.
4849     if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
4850       if (ConstantExpr::getICmp(Pred,
4851                                 LHSC->getValue(),
4852                                 RHSC->getValue())->isNullValue())
4853         goto trivially_false;
4854       else
4855         goto trivially_true;
4856     }
4857     // Otherwise swap the operands to put the constant on the right.
4858     std::swap(LHS, RHS);
4859     Pred = ICmpInst::getSwappedPredicate(Pred);
4860     Changed = true;
4861   }
4862
4863   // If we're comparing an addrec with a value which is loop-invariant in the
4864   // addrec's loop, put the addrec on the left. Also make a dominance check,
4865   // as both operands could be addrecs loop-invariant in each other's loop.
4866   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS)) {
4867     const Loop *L = AR->getLoop();
4868     if (isLoopInvariant(LHS, L) && properlyDominates(LHS, L->getHeader())) {
4869       std::swap(LHS, RHS);
4870       Pred = ICmpInst::getSwappedPredicate(Pred);
4871       Changed = true;
4872     }
4873   }
4874
4875   // If there's a constant operand, canonicalize comparisons with boundary
4876   // cases, and canonicalize *-or-equal comparisons to regular comparisons.
4877   if (const SCEVConstant *RC = dyn_cast<SCEVConstant>(RHS)) {
4878     const APInt &RA = RC->getValue()->getValue();
4879     switch (Pred) {
4880     default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
4881     case ICmpInst::ICMP_EQ:
4882     case ICmpInst::ICMP_NE:
4883       break;
4884     case ICmpInst::ICMP_UGE:
4885       if ((RA - 1).isMinValue()) {
4886         Pred = ICmpInst::ICMP_NE;
4887         RHS = getConstant(RA - 1);
4888         Changed = true;
4889         break;
4890       }
4891       if (RA.isMaxValue()) {
4892         Pred = ICmpInst::ICMP_EQ;
4893         Changed = true;
4894         break;
4895       }
4896       if (RA.isMinValue()) goto trivially_true;
4897
4898       Pred = ICmpInst::ICMP_UGT;
4899       RHS = getConstant(RA - 1);
4900       Changed = true;
4901       break;
4902     case ICmpInst::ICMP_ULE:
4903       if ((RA + 1).isMaxValue()) {
4904         Pred = ICmpInst::ICMP_NE;
4905         RHS = getConstant(RA + 1);
4906         Changed = true;
4907         break;
4908       }
4909       if (RA.isMinValue()) {
4910         Pred = ICmpInst::ICMP_EQ;
4911         Changed = true;
4912         break;
4913       }
4914       if (RA.isMaxValue()) goto trivially_true;
4915
4916       Pred = ICmpInst::ICMP_ULT;
4917       RHS = getConstant(RA + 1);
4918       Changed = true;
4919       break;
4920     case ICmpInst::ICMP_SGE:
4921       if ((RA - 1).isMinSignedValue()) {
4922         Pred = ICmpInst::ICMP_NE;
4923         RHS = getConstant(RA - 1);
4924         Changed = true;
4925         break;
4926       }
4927       if (RA.isMaxSignedValue()) {
4928         Pred = ICmpInst::ICMP_EQ;
4929         Changed = true;
4930         break;
4931       }
4932       if (RA.isMinSignedValue()) goto trivially_true;
4933
4934       Pred = ICmpInst::ICMP_SGT;
4935       RHS = getConstant(RA - 1);
4936       Changed = true;
4937       break;
4938     case ICmpInst::ICMP_SLE:
4939       if ((RA + 1).isMaxSignedValue()) {
4940         Pred = ICmpInst::ICMP_NE;
4941         RHS = getConstant(RA + 1);
4942         Changed = true;
4943         break;
4944       }
4945       if (RA.isMinSignedValue()) {
4946         Pred = ICmpInst::ICMP_EQ;
4947         Changed = true;
4948         break;
4949       }
4950       if (RA.isMaxSignedValue()) goto trivially_true;
4951
4952       Pred = ICmpInst::ICMP_SLT;
4953       RHS = getConstant(RA + 1);
4954       Changed = true;
4955       break;
4956     case ICmpInst::ICMP_UGT:
4957       if (RA.isMinValue()) {
4958         Pred = ICmpInst::ICMP_NE;
4959         Changed = true;
4960         break;
4961       }
4962       if ((RA + 1).isMaxValue()) {
4963         Pred = ICmpInst::ICMP_EQ;
4964         RHS = getConstant(RA + 1);
4965         Changed = true;
4966         break;
4967       }
4968       if (RA.isMaxValue()) goto trivially_false;
4969       break;
4970     case ICmpInst::ICMP_ULT:
4971       if (RA.isMaxValue()) {
4972         Pred = ICmpInst::ICMP_NE;
4973         Changed = true;
4974         break;
4975       }
4976       if ((RA - 1).isMinValue()) {
4977         Pred = ICmpInst::ICMP_EQ;
4978         RHS = getConstant(RA - 1);
4979         Changed = true;
4980         break;
4981       }
4982       if (RA.isMinValue()) goto trivially_false;
4983       break;
4984     case ICmpInst::ICMP_SGT:
4985       if (RA.isMinSignedValue()) {
4986         Pred = ICmpInst::ICMP_NE;
4987         Changed = true;
4988         break;
4989       }
4990       if ((RA + 1).isMaxSignedValue()) {
4991         Pred = ICmpInst::ICMP_EQ;
4992         RHS = getConstant(RA + 1);
4993         Changed = true;
4994         break;
4995       }
4996       if (RA.isMaxSignedValue()) goto trivially_false;
4997       break;
4998     case ICmpInst::ICMP_SLT:
4999       if (RA.isMaxSignedValue()) {
5000         Pred = ICmpInst::ICMP_NE;
5001         Changed = true;
5002         break;
5003       }
5004       if ((RA - 1).isMinSignedValue()) {
5005        Pred = ICmpInst::ICMP_EQ;
5006        RHS = getConstant(RA - 1);
5007         Changed = true;
5008        break;
5009       }
5010       if (RA.isMinSignedValue()) goto trivially_false;
5011       break;
5012     }
5013   }
5014
5015   // Check for obvious equality.
5016   if (HasSameValue(LHS, RHS)) {
5017     if (ICmpInst::isTrueWhenEqual(Pred))
5018       goto trivially_true;
5019     if (ICmpInst::isFalseWhenEqual(Pred))
5020       goto trivially_false;
5021   }
5022
5023   // If possible, canonicalize GE/LE comparisons to GT/LT comparisons, by
5024   // adding or subtracting 1 from one of the operands.
5025   switch (Pred) {
5026   case ICmpInst::ICMP_SLE:
5027     if (!getSignedRange(RHS).getSignedMax().isMaxSignedValue()) {
5028       RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
5029                        /*HasNUW=*/false, /*HasNSW=*/true);
5030       Pred = ICmpInst::ICMP_SLT;
5031       Changed = true;
5032     } else if (!getSignedRange(LHS).getSignedMin().isMinSignedValue()) {
5033       LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
5034                        /*HasNUW=*/false, /*HasNSW=*/true);
5035       Pred = ICmpInst::ICMP_SLT;
5036       Changed = true;
5037     }
5038     break;
5039   case ICmpInst::ICMP_SGE:
5040     if (!getSignedRange(RHS).getSignedMin().isMinSignedValue()) {
5041       RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
5042                        /*HasNUW=*/false, /*HasNSW=*/true);
5043       Pred = ICmpInst::ICMP_SGT;
5044       Changed = true;
5045     } else if (!getSignedRange(LHS).getSignedMax().isMaxSignedValue()) {
5046       LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
5047                        /*HasNUW=*/false, /*HasNSW=*/true);
5048       Pred = ICmpInst::ICMP_SGT;
5049       Changed = true;
5050     }
5051     break;
5052   case ICmpInst::ICMP_ULE:
5053     if (!getUnsignedRange(RHS).getUnsignedMax().isMaxValue()) {
5054       RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
5055                        /*HasNUW=*/true, /*HasNSW=*/false);
5056       Pred = ICmpInst::ICMP_ULT;
5057       Changed = true;
5058     } else if (!getUnsignedRange(LHS).getUnsignedMin().isMinValue()) {
5059       LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
5060                        /*HasNUW=*/true, /*HasNSW=*/false);
5061       Pred = ICmpInst::ICMP_ULT;
5062       Changed = true;
5063     }
5064     break;
5065   case ICmpInst::ICMP_UGE:
5066     if (!getUnsignedRange(RHS).getUnsignedMin().isMinValue()) {
5067       RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
5068                        /*HasNUW=*/true, /*HasNSW=*/false);
5069       Pred = ICmpInst::ICMP_UGT;
5070       Changed = true;
5071     } else if (!getUnsignedRange(LHS).getUnsignedMax().isMaxValue()) {
5072       LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
5073                        /*HasNUW=*/true, /*HasNSW=*/false);
5074       Pred = ICmpInst::ICMP_UGT;
5075       Changed = true;
5076     }
5077     break;
5078   default:
5079     break;
5080   }
5081
5082   // TODO: More simplifications are possible here.
5083
5084   return Changed;
5085
5086 trivially_true:
5087   // Return 0 == 0.
5088   LHS = RHS = getConstant(ConstantInt::getFalse(getContext()));
5089   Pred = ICmpInst::ICMP_EQ;
5090   return true;
5091
5092 trivially_false:
5093   // Return 0 != 0.
5094   LHS = RHS = getConstant(ConstantInt::getFalse(getContext()));
5095   Pred = ICmpInst::ICMP_NE;
5096   return true;
5097 }
5098
5099 bool ScalarEvolution::isKnownNegative(const SCEV *S) {
5100   return getSignedRange(S).getSignedMax().isNegative();
5101 }
5102
5103 bool ScalarEvolution::isKnownPositive(const SCEV *S) {
5104   return getSignedRange(S).getSignedMin().isStrictlyPositive();
5105 }
5106
5107 bool ScalarEvolution::isKnownNonNegative(const SCEV *S) {
5108   return !getSignedRange(S).getSignedMin().isNegative();
5109 }
5110
5111 bool ScalarEvolution::isKnownNonPositive(const SCEV *S) {
5112   return !getSignedRange(S).getSignedMax().isStrictlyPositive();
5113 }
5114
5115 bool ScalarEvolution::isKnownNonZero(const SCEV *S) {
5116   return isKnownNegative(S) || isKnownPositive(S);
5117 }
5118
5119 bool ScalarEvolution::isKnownPredicate(ICmpInst::Predicate Pred,
5120                                        const SCEV *LHS, const SCEV *RHS) {
5121   // Canonicalize the inputs first.
5122   (void)SimplifyICmpOperands(Pred, LHS, RHS);
5123
5124   // If LHS or RHS is an addrec, check to see if the condition is true in
5125   // every iteration of the loop.
5126   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(LHS))
5127     if (isLoopEntryGuardedByCond(
5128           AR->getLoop(), Pred, AR->getStart(), RHS) &&
5129         isLoopBackedgeGuardedByCond(
5130           AR->getLoop(), Pred, AR->getPostIncExpr(*this), RHS))
5131       return true;
5132   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS))
5133     if (isLoopEntryGuardedByCond(
5134           AR->getLoop(), Pred, LHS, AR->getStart()) &&
5135         isLoopBackedgeGuardedByCond(
5136           AR->getLoop(), Pred, LHS, AR->getPostIncExpr(*this)))
5137       return true;
5138
5139   // Otherwise see what can be done with known constant ranges.
5140   return isKnownPredicateWithRanges(Pred, LHS, RHS);
5141 }
5142
5143 bool
5144 ScalarEvolution::isKnownPredicateWithRanges(ICmpInst::Predicate Pred,
5145                                             const SCEV *LHS, const SCEV *RHS) {
5146   if (HasSameValue(LHS, RHS))
5147     return ICmpInst::isTrueWhenEqual(Pred);
5148
5149   // This code is split out from isKnownPredicate because it is called from
5150   // within isLoopEntryGuardedByCond.
5151   switch (Pred) {
5152   default:
5153     llvm_unreachable("Unexpected ICmpInst::Predicate value!");
5154     break;
5155   case ICmpInst::ICMP_SGT:
5156     Pred = ICmpInst::ICMP_SLT;
5157     std::swap(LHS, RHS);
5158   case ICmpInst::ICMP_SLT: {
5159     ConstantRange LHSRange = getSignedRange(LHS);
5160     ConstantRange RHSRange = getSignedRange(RHS);
5161     if (LHSRange.getSignedMax().slt(RHSRange.getSignedMin()))
5162       return true;
5163     if (LHSRange.getSignedMin().sge(RHSRange.getSignedMax()))
5164       return false;
5165     break;
5166   }
5167   case ICmpInst::ICMP_SGE:
5168     Pred = ICmpInst::ICMP_SLE;
5169     std::swap(LHS, RHS);
5170   case ICmpInst::ICMP_SLE: {
5171     ConstantRange LHSRange = getSignedRange(LHS);
5172     ConstantRange RHSRange = getSignedRange(RHS);
5173     if (LHSRange.getSignedMax().sle(RHSRange.getSignedMin()))
5174       return true;
5175     if (LHSRange.getSignedMin().sgt(RHSRange.getSignedMax()))
5176       return false;
5177     break;
5178   }
5179   case ICmpInst::ICMP_UGT:
5180     Pred = ICmpInst::ICMP_ULT;
5181     std::swap(LHS, RHS);
5182   case ICmpInst::ICMP_ULT: {
5183     ConstantRange LHSRange = getUnsignedRange(LHS);
5184     ConstantRange RHSRange = getUnsignedRange(RHS);
5185     if (LHSRange.getUnsignedMax().ult(RHSRange.getUnsignedMin()))
5186       return true;
5187     if (LHSRange.getUnsignedMin().uge(RHSRange.getUnsignedMax()))
5188       return false;
5189     break;
5190   }
5191   case ICmpInst::ICMP_UGE:
5192     Pred = ICmpInst::ICMP_ULE;
5193     std::swap(LHS, RHS);
5194   case ICmpInst::ICMP_ULE: {
5195     ConstantRange LHSRange = getUnsignedRange(LHS);
5196     ConstantRange RHSRange = getUnsignedRange(RHS);
5197     if (LHSRange.getUnsignedMax().ule(RHSRange.getUnsignedMin()))
5198       return true;
5199     if (LHSRange.getUnsignedMin().ugt(RHSRange.getUnsignedMax()))
5200       return false;
5201     break;
5202   }
5203   case ICmpInst::ICMP_NE: {
5204     if (getUnsignedRange(LHS).intersectWith(getUnsignedRange(RHS)).isEmptySet())
5205       return true;
5206     if (getSignedRange(LHS).intersectWith(getSignedRange(RHS)).isEmptySet())
5207       return true;
5208
5209     const SCEV *Diff = getMinusSCEV(LHS, RHS);
5210     if (isKnownNonZero(Diff))
5211       return true;
5212     break;
5213   }
5214   case ICmpInst::ICMP_EQ:
5215     // The check at the top of the function catches the case where
5216     // the values are known to be equal.
5217     break;
5218   }
5219   return false;
5220 }
5221
5222 /// isLoopBackedgeGuardedByCond - Test whether the backedge of the loop is
5223 /// protected by a conditional between LHS and RHS.  This is used to
5224 /// to eliminate casts.
5225 bool
5226 ScalarEvolution::isLoopBackedgeGuardedByCond(const Loop *L,
5227                                              ICmpInst::Predicate Pred,
5228                                              const SCEV *LHS, const SCEV *RHS) {
5229   // Interpret a null as meaning no loop, where there is obviously no guard
5230   // (interprocedural conditions notwithstanding).
5231   if (!L) return true;
5232
5233   BasicBlock *Latch = L->getLoopLatch();
5234   if (!Latch)
5235     return false;
5236
5237   BranchInst *LoopContinuePredicate =
5238     dyn_cast<BranchInst>(Latch->getTerminator());
5239   if (!LoopContinuePredicate ||
5240       LoopContinuePredicate->isUnconditional())
5241     return false;
5242
5243   return isImpliedCond(Pred, LHS, RHS,
5244                        LoopContinuePredicate->getCondition(),
5245                        LoopContinuePredicate->getSuccessor(0) != L->getHeader());
5246 }
5247
5248 /// isLoopEntryGuardedByCond - Test whether entry to the loop is protected
5249 /// by a conditional between LHS and RHS.  This is used to help avoid max
5250 /// expressions in loop trip counts, and to eliminate casts.
5251 bool
5252 ScalarEvolution::isLoopEntryGuardedByCond(const Loop *L,
5253                                           ICmpInst::Predicate Pred,
5254                                           const SCEV *LHS, const SCEV *RHS) {
5255   // Interpret a null as meaning no loop, where there is obviously no guard
5256   // (interprocedural conditions notwithstanding).
5257   if (!L) return false;
5258
5259   // Starting at the loop predecessor, climb up the predecessor chain, as long
5260   // as there are predecessors that can be found that have unique successors
5261   // leading to the original header.
5262   for (std::pair<BasicBlock *, BasicBlock *>
5263          Pair(L->getLoopPredecessor(), L->getHeader());
5264        Pair.first;
5265        Pair = getPredecessorWithUniqueSuccessorForBB(Pair.first)) {
5266
5267     BranchInst *LoopEntryPredicate =
5268       dyn_cast<BranchInst>(Pair.first->getTerminator());
5269     if (!LoopEntryPredicate ||
5270         LoopEntryPredicate->isUnconditional())
5271       continue;
5272
5273     if (isImpliedCond(Pred, LHS, RHS,
5274                       LoopEntryPredicate->getCondition(),
5275                       LoopEntryPredicate->getSuccessor(0) != Pair.second))
5276       return true;
5277   }
5278
5279   return false;
5280 }
5281
5282 /// isImpliedCond - Test whether the condition described by Pred, LHS,
5283 /// and RHS is true whenever the given Cond value evaluates to true.
5284 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred,
5285                                     const SCEV *LHS, const SCEV *RHS,
5286                                     Value *FoundCondValue,
5287                                     bool Inverse) {
5288   // Recursively handle And and Or conditions.
5289   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(FoundCondValue)) {
5290     if (BO->getOpcode() == Instruction::And) {
5291       if (!Inverse)
5292         return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
5293                isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
5294     } else if (BO->getOpcode() == Instruction::Or) {
5295       if (Inverse)
5296         return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
5297                isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
5298     }
5299   }
5300
5301   ICmpInst *ICI = dyn_cast<ICmpInst>(FoundCondValue);
5302   if (!ICI) return false;
5303
5304   // Bail if the ICmp's operands' types are wider than the needed type
5305   // before attempting to call getSCEV on them. This avoids infinite
5306   // recursion, since the analysis of widening casts can require loop
5307   // exit condition information for overflow checking, which would
5308   // lead back here.
5309   if (getTypeSizeInBits(LHS->getType()) <
5310       getTypeSizeInBits(ICI->getOperand(0)->getType()))
5311     return false;
5312
5313   // Now that we found a conditional branch that dominates the loop, check to
5314   // see if it is the comparison we are looking for.
5315   ICmpInst::Predicate FoundPred;
5316   if (Inverse)
5317     FoundPred = ICI->getInversePredicate();
5318   else
5319     FoundPred = ICI->getPredicate();
5320
5321   const SCEV *FoundLHS = getSCEV(ICI->getOperand(0));
5322   const SCEV *FoundRHS = getSCEV(ICI->getOperand(1));
5323
5324   // Balance the types. The case where FoundLHS' type is wider than
5325   // LHS' type is checked for above.
5326   if (getTypeSizeInBits(LHS->getType()) >
5327       getTypeSizeInBits(FoundLHS->getType())) {
5328     if (CmpInst::isSigned(Pred)) {
5329       FoundLHS = getSignExtendExpr(FoundLHS, LHS->getType());
5330       FoundRHS = getSignExtendExpr(FoundRHS, LHS->getType());
5331     } else {
5332       FoundLHS = getZeroExtendExpr(FoundLHS, LHS->getType());
5333       FoundRHS = getZeroExtendExpr(FoundRHS, LHS->getType());
5334     }
5335   }
5336
5337   // Canonicalize the query to match the way instcombine will have
5338   // canonicalized the comparison.
5339   if (SimplifyICmpOperands(Pred, LHS, RHS))
5340     if (LHS == RHS)
5341       return CmpInst::isTrueWhenEqual(Pred);
5342   if (SimplifyICmpOperands(FoundPred, FoundLHS, FoundRHS))
5343     if (FoundLHS == FoundRHS)
5344       return CmpInst::isFalseWhenEqual(Pred);
5345
5346   // Check to see if we can make the LHS or RHS match.
5347   if (LHS == FoundRHS || RHS == FoundLHS) {
5348     if (isa<SCEVConstant>(RHS)) {
5349       std::swap(FoundLHS, FoundRHS);
5350       FoundPred = ICmpInst::getSwappedPredicate(FoundPred);
5351     } else {
5352       std::swap(LHS, RHS);
5353       Pred = ICmpInst::getSwappedPredicate(Pred);
5354     }
5355   }
5356
5357   // Check whether the found predicate is the same as the desired predicate.
5358   if (FoundPred == Pred)
5359     return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS);
5360
5361   // Check whether swapping the found predicate makes it the same as the
5362   // desired predicate.
5363   if (ICmpInst::getSwappedPredicate(FoundPred) == Pred) {
5364     if (isa<SCEVConstant>(RHS))
5365       return isImpliedCondOperands(Pred, LHS, RHS, FoundRHS, FoundLHS);
5366     else
5367       return isImpliedCondOperands(ICmpInst::getSwappedPredicate(Pred),
5368                                    RHS, LHS, FoundLHS, FoundRHS);
5369   }
5370
5371   // Check whether the actual condition is beyond sufficient.
5372   if (FoundPred == ICmpInst::ICMP_EQ)
5373     if (ICmpInst::isTrueWhenEqual(Pred))
5374       if (isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS))
5375         return true;
5376   if (Pred == ICmpInst::ICMP_NE)
5377     if (!ICmpInst::isTrueWhenEqual(FoundPred))
5378       if (isImpliedCondOperands(FoundPred, LHS, RHS, FoundLHS, FoundRHS))
5379         return true;
5380
5381   // Otherwise assume the worst.
5382   return false;
5383 }
5384
5385 /// isImpliedCondOperands - Test whether the condition described by Pred,
5386 /// LHS, and RHS is true whenever the condition described by Pred, FoundLHS,
5387 /// and FoundRHS is true.
5388 bool ScalarEvolution::isImpliedCondOperands(ICmpInst::Predicate Pred,
5389                                             const SCEV *LHS, const SCEV *RHS,
5390                                             const SCEV *FoundLHS,
5391                                             const SCEV *FoundRHS) {
5392   return isImpliedCondOperandsHelper(Pred, LHS, RHS,
5393                                      FoundLHS, FoundRHS) ||
5394          // ~x < ~y --> x > y
5395          isImpliedCondOperandsHelper(Pred, LHS, RHS,
5396                                      getNotSCEV(FoundRHS),
5397                                      getNotSCEV(FoundLHS));
5398 }
5399
5400 /// isImpliedCondOperandsHelper - Test whether the condition described by
5401 /// Pred, LHS, and RHS is true whenever the condition described by Pred,
5402 /// FoundLHS, and FoundRHS is true.
5403 bool
5404 ScalarEvolution::isImpliedCondOperandsHelper(ICmpInst::Predicate Pred,
5405                                              const SCEV *LHS, const SCEV *RHS,
5406                                              const SCEV *FoundLHS,
5407                                              const SCEV *FoundRHS) {
5408   switch (Pred) {
5409   default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
5410   case ICmpInst::ICMP_EQ:
5411   case ICmpInst::ICMP_NE:
5412     if (HasSameValue(LHS, FoundLHS) && HasSameValue(RHS, FoundRHS))
5413       return true;
5414     break;
5415   case ICmpInst::ICMP_SLT:
5416   case ICmpInst::ICMP_SLE:
5417     if (isKnownPredicateWithRanges(ICmpInst::ICMP_SLE, LHS, FoundLHS) &&
5418         isKnownPredicateWithRanges(ICmpInst::ICMP_SGE, RHS, FoundRHS))
5419       return true;
5420     break;
5421   case ICmpInst::ICMP_SGT:
5422   case ICmpInst::ICMP_SGE:
5423     if (isKnownPredicateWithRanges(ICmpInst::ICMP_SGE, LHS, FoundLHS) &&
5424         isKnownPredicateWithRanges(ICmpInst::ICMP_SLE, RHS, FoundRHS))
5425       return true;
5426     break;
5427   case ICmpInst::ICMP_ULT:
5428   case ICmpInst::ICMP_ULE:
5429     if (isKnownPredicateWithRanges(ICmpInst::ICMP_ULE, LHS, FoundLHS) &&
5430         isKnownPredicateWithRanges(ICmpInst::ICMP_UGE, RHS, FoundRHS))
5431       return true;
5432     break;
5433   case ICmpInst::ICMP_UGT:
5434   case ICmpInst::ICMP_UGE:
5435     if (isKnownPredicateWithRanges(ICmpInst::ICMP_UGE, LHS, FoundLHS) &&
5436         isKnownPredicateWithRanges(ICmpInst::ICMP_ULE, RHS, FoundRHS))
5437       return true;
5438     break;
5439   }
5440
5441   return false;
5442 }
5443
5444 /// getBECount - Subtract the end and start values and divide by the step,
5445 /// rounding up, to get the number of times the backedge is executed. Return
5446 /// CouldNotCompute if an intermediate computation overflows.
5447 const SCEV *ScalarEvolution::getBECount(const SCEV *Start,
5448                                         const SCEV *End,
5449                                         const SCEV *Step,
5450                                         bool NoWrap) {
5451   assert(!isKnownNegative(Step) &&
5452          "This code doesn't handle negative strides yet!");
5453
5454   const Type *Ty = Start->getType();
5455   const SCEV *NegOne = getConstant(Ty, (uint64_t)-1);
5456   const SCEV *Diff = getMinusSCEV(End, Start);
5457   const SCEV *RoundUp = getAddExpr(Step, NegOne);
5458
5459   // Add an adjustment to the difference between End and Start so that
5460   // the division will effectively round up.
5461   const SCEV *Add = getAddExpr(Diff, RoundUp);
5462
5463   if (!NoWrap) {
5464     // Check Add for unsigned overflow.
5465     // TODO: More sophisticated things could be done here.
5466     const Type *WideTy = IntegerType::get(getContext(),
5467                                           getTypeSizeInBits(Ty) + 1);
5468     const SCEV *EDiff = getZeroExtendExpr(Diff, WideTy);
5469     const SCEV *ERoundUp = getZeroExtendExpr(RoundUp, WideTy);
5470     const SCEV *OperandExtendedAdd = getAddExpr(EDiff, ERoundUp);
5471     if (getZeroExtendExpr(Add, WideTy) != OperandExtendedAdd)
5472       return getCouldNotCompute();
5473   }
5474
5475   return getUDivExpr(Add, Step);
5476 }
5477
5478 /// HowManyLessThans - Return the number of times a backedge containing the
5479 /// specified less-than comparison will execute.  If not computable, return
5480 /// CouldNotCompute.
5481 ScalarEvolution::BackedgeTakenInfo
5482 ScalarEvolution::HowManyLessThans(const SCEV *LHS, const SCEV *RHS,
5483                                   const Loop *L, bool isSigned) {
5484   // Only handle:  "ADDREC < LoopInvariant".
5485   if (!isLoopInvariant(RHS, L)) return getCouldNotCompute();
5486
5487   const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS);
5488   if (!AddRec || AddRec->getLoop() != L)
5489     return getCouldNotCompute();
5490
5491   // Check to see if we have a flag which makes analysis easy.
5492   bool NoWrap = isSigned ? AddRec->hasNoSignedWrap() :
5493                            AddRec->hasNoUnsignedWrap();
5494
5495   if (AddRec->isAffine()) {
5496     unsigned BitWidth = getTypeSizeInBits(AddRec->getType());
5497     const SCEV *Step = AddRec->getStepRecurrence(*this);
5498
5499     if (Step->isZero())
5500       return getCouldNotCompute();
5501     if (Step->isOne()) {
5502       // With unit stride, the iteration never steps past the limit value.
5503     } else if (isKnownPositive(Step)) {
5504       // Test whether a positive iteration can step past the limit
5505       // value and past the maximum value for its type in a single step.
5506       // Note that it's not sufficient to check NoWrap here, because even
5507       // though the value after a wrap is undefined, it's not undefined
5508       // behavior, so if wrap does occur, the loop could either terminate or
5509       // loop infinitely, but in either case, the loop is guaranteed to
5510       // iterate at least until the iteration where the wrapping occurs.
5511       const SCEV *One = getConstant(Step->getType(), 1);
5512       if (isSigned) {
5513         APInt Max = APInt::getSignedMaxValue(BitWidth);
5514         if ((Max - getSignedRange(getMinusSCEV(Step, One)).getSignedMax())
5515               .slt(getSignedRange(RHS).getSignedMax()))
5516           return getCouldNotCompute();
5517       } else {
5518         APInt Max = APInt::getMaxValue(BitWidth);
5519         if ((Max - getUnsignedRange(getMinusSCEV(Step, One)).getUnsignedMax())
5520               .ult(getUnsignedRange(RHS).getUnsignedMax()))
5521           return getCouldNotCompute();
5522       }
5523     } else
5524       // TODO: Handle negative strides here and below.
5525       return getCouldNotCompute();
5526
5527     // We know the LHS is of the form {n,+,s} and the RHS is some loop-invariant
5528     // m.  So, we count the number of iterations in which {n,+,s} < m is true.
5529     // Note that we cannot simply return max(m-n,0)/s because it's not safe to
5530     // treat m-n as signed nor unsigned due to overflow possibility.
5531
5532     // First, we get the value of the LHS in the first iteration: n
5533     const SCEV *Start = AddRec->getOperand(0);
5534
5535     // Determine the minimum constant start value.
5536     const SCEV *MinStart = getConstant(isSigned ?
5537       getSignedRange(Start).getSignedMin() :
5538       getUnsignedRange(Start).getUnsignedMin());
5539
5540     // If we know that the condition is true in order to enter the loop,
5541     // then we know that it will run exactly (m-n)/s times. Otherwise, we
5542     // only know that it will execute (max(m,n)-n)/s times. In both cases,
5543     // the division must round up.
5544     const SCEV *End = RHS;
5545     if (!isLoopEntryGuardedByCond(L,
5546                                   isSigned ? ICmpInst::ICMP_SLT :
5547                                              ICmpInst::ICMP_ULT,
5548                                   getMinusSCEV(Start, Step), RHS))
5549       End = isSigned ? getSMaxExpr(RHS, Start)
5550                      : getUMaxExpr(RHS, Start);
5551
5552     // Determine the maximum constant end value.
5553     const SCEV *MaxEnd = getConstant(isSigned ?
5554       getSignedRange(End).getSignedMax() :
5555       getUnsignedRange(End).getUnsignedMax());
5556
5557     // If MaxEnd is within a step of the maximum integer value in its type,
5558     // adjust it down to the minimum value which would produce the same effect.
5559     // This allows the subsequent ceiling division of (N+(step-1))/step to
5560     // compute the correct value.
5561     const SCEV *StepMinusOne = getMinusSCEV(Step,
5562                                             getConstant(Step->getType(), 1));
5563     MaxEnd = isSigned ?
5564       getSMinExpr(MaxEnd,
5565                   getMinusSCEV(getConstant(APInt::getSignedMaxValue(BitWidth)),
5566                                StepMinusOne)) :
5567       getUMinExpr(MaxEnd,
5568                   getMinusSCEV(getConstant(APInt::getMaxValue(BitWidth)),
5569                                StepMinusOne));
5570
5571     // Finally, we subtract these two values and divide, rounding up, to get
5572     // the number of times the backedge is executed.
5573     const SCEV *BECount = getBECount(Start, End, Step, NoWrap);
5574
5575     // The maximum backedge count is similar, except using the minimum start
5576     // value and the maximum end value.
5577     const SCEV *MaxBECount = getBECount(MinStart, MaxEnd, Step, NoWrap);
5578
5579     return BackedgeTakenInfo(BECount, MaxBECount);
5580   }
5581
5582   return getCouldNotCompute();
5583 }
5584
5585 /// getNumIterationsInRange - Return the number of iterations of this loop that
5586 /// produce values in the specified constant range.  Another way of looking at
5587 /// this is that it returns the first iteration number where the value is not in
5588 /// the condition, thus computing the exit count. If the iteration count can't
5589 /// be computed, an instance of SCEVCouldNotCompute is returned.
5590 const SCEV *SCEVAddRecExpr::getNumIterationsInRange(ConstantRange Range,
5591                                                     ScalarEvolution &SE) const {
5592   if (Range.isFullSet())  // Infinite loop.
5593     return SE.getCouldNotCompute();
5594
5595   // If the start is a non-zero constant, shift the range to simplify things.
5596   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(getStart()))
5597     if (!SC->getValue()->isZero()) {
5598       SmallVector<const SCEV *, 4> Operands(op_begin(), op_end());
5599       Operands[0] = SE.getConstant(SC->getType(), 0);
5600       const SCEV *Shifted = SE.getAddRecExpr(Operands, getLoop());
5601       if (const SCEVAddRecExpr *ShiftedAddRec =
5602             dyn_cast<SCEVAddRecExpr>(Shifted))
5603         return ShiftedAddRec->getNumIterationsInRange(
5604                            Range.subtract(SC->getValue()->getValue()), SE);
5605       // This is strange and shouldn't happen.
5606       return SE.getCouldNotCompute();
5607     }
5608
5609   // The only time we can solve this is when we have all constant indices.
5610   // Otherwise, we cannot determine the overflow conditions.
5611   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
5612     if (!isa<SCEVConstant>(getOperand(i)))
5613       return SE.getCouldNotCompute();
5614
5615
5616   // Okay at this point we know that all elements of the chrec are constants and
5617   // that the start element is zero.
5618
5619   // First check to see if the range contains zero.  If not, the first
5620   // iteration exits.
5621   unsigned BitWidth = SE.getTypeSizeInBits(getType());
5622   if (!Range.contains(APInt(BitWidth, 0)))
5623     return SE.getConstant(getType(), 0);
5624
5625   if (isAffine()) {
5626     // If this is an affine expression then we have this situation:
5627     //   Solve {0,+,A} in Range  ===  Ax in Range
5628
5629     // We know that zero is in the range.  If A is positive then we know that
5630     // the upper value of the range must be the first possible exit value.
5631     // If A is negative then the lower of the range is the last possible loop
5632     // value.  Also note that we already checked for a full range.
5633     APInt One(BitWidth,1);
5634     APInt A     = cast<SCEVConstant>(getOperand(1))->getValue()->getValue();
5635     APInt End = A.sge(One) ? (Range.getUpper() - One) : Range.getLower();
5636
5637     // The exit value should be (End+A)/A.
5638     APInt ExitVal = (End + A).udiv(A);
5639     ConstantInt *ExitValue = ConstantInt::get(SE.getContext(), ExitVal);
5640
5641     // Evaluate at the exit value.  If we really did fall out of the valid
5642     // range, then we computed our trip count, otherwise wrap around or other
5643     // things must have happened.
5644     ConstantInt *Val = EvaluateConstantChrecAtConstant(this, ExitValue, SE);
5645     if (Range.contains(Val->getValue()))
5646       return SE.getCouldNotCompute();  // Something strange happened
5647
5648     // Ensure that the previous value is in the range.  This is a sanity check.
5649     assert(Range.contains(
5650            EvaluateConstantChrecAtConstant(this,
5651            ConstantInt::get(SE.getContext(), ExitVal - One), SE)->getValue()) &&
5652            "Linear scev computation is off in a bad way!");
5653     return SE.getConstant(ExitValue);
5654   } else if (isQuadratic()) {
5655     // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of the
5656     // quadratic equation to solve it.  To do this, we must frame our problem in
5657     // terms of figuring out when zero is crossed, instead of when
5658     // Range.getUpper() is crossed.
5659     SmallVector<const SCEV *, 4> NewOps(op_begin(), op_end());
5660     NewOps[0] = SE.getNegativeSCEV(SE.getConstant(Range.getUpper()));
5661     const SCEV *NewAddRec = SE.getAddRecExpr(NewOps, getLoop());
5662
5663     // Next, solve the constructed addrec
5664     std::pair<const SCEV *,const SCEV *> Roots =
5665       SolveQuadraticEquation(cast<SCEVAddRecExpr>(NewAddRec), SE);
5666     const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
5667     const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
5668     if (R1) {
5669       // Pick the smallest positive root value.
5670       if (ConstantInt *CB =
5671           dyn_cast<ConstantInt>(ConstantExpr::getICmp(ICmpInst::ICMP_ULT,
5672                          R1->getValue(), R2->getValue()))) {
5673         if (CB->getZExtValue() == false)
5674           std::swap(R1, R2);   // R1 is the minimum root now.
5675
5676         // Make sure the root is not off by one.  The returned iteration should
5677         // not be in the range, but the previous one should be.  When solving
5678         // for "X*X < 5", for example, we should not return a root of 2.
5679         ConstantInt *R1Val = EvaluateConstantChrecAtConstant(this,
5680                                                              R1->getValue(),
5681                                                              SE);
5682         if (Range.contains(R1Val->getValue())) {
5683           // The next iteration must be out of the range...
5684           ConstantInt *NextVal =
5685                 ConstantInt::get(SE.getContext(), R1->getValue()->getValue()+1);
5686
5687           R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
5688           if (!Range.contains(R1Val->getValue()))
5689             return SE.getConstant(NextVal);
5690           return SE.getCouldNotCompute();  // Something strange happened
5691         }
5692
5693         // If R1 was not in the range, then it is a good return value.  Make
5694         // sure that R1-1 WAS in the range though, just in case.
5695         ConstantInt *NextVal =
5696                ConstantInt::get(SE.getContext(), R1->getValue()->getValue()-1);
5697         R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
5698         if (Range.contains(R1Val->getValue()))
5699           return R1;
5700         return SE.getCouldNotCompute();  // Something strange happened
5701       }
5702     }
5703   }
5704
5705   return SE.getCouldNotCompute();
5706 }
5707
5708
5709
5710 //===----------------------------------------------------------------------===//
5711 //                   SCEVCallbackVH Class Implementation
5712 //===----------------------------------------------------------------------===//
5713
5714 void ScalarEvolution::SCEVCallbackVH::deleted() {
5715   assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
5716   if (PHINode *PN = dyn_cast<PHINode>(getValPtr()))
5717     SE->ConstantEvolutionLoopExitValue.erase(PN);
5718   SE->ValueExprMap.erase(getValPtr());
5719   // this now dangles!
5720 }
5721
5722 void ScalarEvolution::SCEVCallbackVH::allUsesReplacedWith(Value *V) {
5723   assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
5724
5725   // Forget all the expressions associated with users of the old value,
5726   // so that future queries will recompute the expressions using the new
5727   // value.
5728   Value *Old = getValPtr();
5729   SmallVector<User *, 16> Worklist;
5730   SmallPtrSet<User *, 8> Visited;
5731   for (Value::use_iterator UI = Old->use_begin(), UE = Old->use_end();
5732        UI != UE; ++UI)
5733     Worklist.push_back(*UI);
5734   while (!Worklist.empty()) {
5735     User *U = Worklist.pop_back_val();
5736     // Deleting the Old value will cause this to dangle. Postpone
5737     // that until everything else is done.
5738     if (U == Old)
5739       continue;
5740     if (!Visited.insert(U))
5741       continue;
5742     if (PHINode *PN = dyn_cast<PHINode>(U))
5743       SE->ConstantEvolutionLoopExitValue.erase(PN);
5744     SE->ValueExprMap.erase(U);
5745     for (Value::use_iterator UI = U->use_begin(), UE = U->use_end();
5746          UI != UE; ++UI)
5747       Worklist.push_back(*UI);
5748   }
5749   // Delete the Old value.
5750   if (PHINode *PN = dyn_cast<PHINode>(Old))
5751     SE->ConstantEvolutionLoopExitValue.erase(PN);
5752   SE->ValueExprMap.erase(Old);
5753   // this now dangles!
5754 }
5755
5756 ScalarEvolution::SCEVCallbackVH::SCEVCallbackVH(Value *V, ScalarEvolution *se)
5757   : CallbackVH(V), SE(se) {}
5758
5759 //===----------------------------------------------------------------------===//
5760 //                   ScalarEvolution Class Implementation
5761 //===----------------------------------------------------------------------===//
5762
5763 ScalarEvolution::ScalarEvolution()
5764   : FunctionPass(ID), FirstUnknown(0) {
5765   initializeScalarEvolutionPass(*PassRegistry::getPassRegistry());
5766 }
5767
5768 bool ScalarEvolution::runOnFunction(Function &F) {
5769   this->F = &F;
5770   LI = &getAnalysis<LoopInfo>();
5771   TD = getAnalysisIfAvailable<TargetData>();
5772   DT = &getAnalysis<DominatorTree>();
5773   return false;
5774 }
5775
5776 void ScalarEvolution::releaseMemory() {
5777   // Iterate through all the SCEVUnknown instances and call their
5778   // destructors, so that they release their references to their values.
5779   for (SCEVUnknown *U = FirstUnknown; U; U = U->Next)
5780     U->~SCEVUnknown();
5781   FirstUnknown = 0;
5782
5783   ValueExprMap.clear();
5784   BackedgeTakenCounts.clear();
5785   ConstantEvolutionLoopExitValue.clear();
5786   ValuesAtScopes.clear();
5787   LoopDispositions.clear();
5788   BlockDispositions.clear();
5789   UnsignedRanges.clear();
5790   SignedRanges.clear();
5791   UniqueSCEVs.clear();
5792   SCEVAllocator.Reset();
5793 }
5794
5795 void ScalarEvolution::getAnalysisUsage(AnalysisUsage &AU) const {
5796   AU.setPreservesAll();
5797   AU.addRequiredTransitive<LoopInfo>();
5798   AU.addRequiredTransitive<DominatorTree>();
5799 }
5800
5801 bool ScalarEvolution::hasLoopInvariantBackedgeTakenCount(const Loop *L) {
5802   return !isa<SCEVCouldNotCompute>(getBackedgeTakenCount(L));
5803 }
5804
5805 static void PrintLoopInfo(raw_ostream &OS, ScalarEvolution *SE,
5806                           const Loop *L) {
5807   // Print all inner loops first
5808   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
5809     PrintLoopInfo(OS, SE, *I);
5810
5811   OS << "Loop ";
5812   WriteAsOperand(OS, L->getHeader(), /*PrintType=*/false);
5813   OS << ": ";
5814
5815   SmallVector<BasicBlock *, 8> ExitBlocks;
5816   L->getExitBlocks(ExitBlocks);
5817   if (ExitBlocks.size() != 1)
5818     OS << "<multiple exits> ";
5819
5820   if (SE->hasLoopInvariantBackedgeTakenCount(L)) {
5821     OS << "backedge-taken count is " << *SE->getBackedgeTakenCount(L);
5822   } else {
5823     OS << "Unpredictable backedge-taken count. ";
5824   }
5825
5826   OS << "\n"
5827         "Loop ";
5828   WriteAsOperand(OS, L->getHeader(), /*PrintType=*/false);
5829   OS << ": ";
5830
5831   if (!isa<SCEVCouldNotCompute>(SE->getMaxBackedgeTakenCount(L))) {
5832     OS << "max backedge-taken count is " << *SE->getMaxBackedgeTakenCount(L);
5833   } else {
5834     OS << "Unpredictable max backedge-taken count. ";
5835   }
5836
5837   OS << "\n";
5838 }
5839
5840 void ScalarEvolution::print(raw_ostream &OS, const Module *) const {
5841   // ScalarEvolution's implementation of the print method is to print
5842   // out SCEV values of all instructions that are interesting. Doing
5843   // this potentially causes it to create new SCEV objects though,
5844   // which technically conflicts with the const qualifier. This isn't
5845   // observable from outside the class though, so casting away the
5846   // const isn't dangerous.
5847   ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
5848
5849   OS << "Classifying expressions for: ";
5850   WriteAsOperand(OS, F, /*PrintType=*/false);
5851   OS << "\n";
5852   for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
5853     if (isSCEVable(I->getType()) && !isa<CmpInst>(*I)) {
5854       OS << *I << '\n';
5855       OS << "  -->  ";
5856       const SCEV *SV = SE.getSCEV(&*I);
5857       SV->print(OS);
5858
5859       const Loop *L = LI->getLoopFor((*I).getParent());
5860
5861       const SCEV *AtUse = SE.getSCEVAtScope(SV, L);
5862       if (AtUse != SV) {
5863         OS << "  -->  ";
5864         AtUse->print(OS);
5865       }
5866
5867       if (L) {
5868         OS << "\t\t" "Exits: ";
5869         const SCEV *ExitValue = SE.getSCEVAtScope(SV, L->getParentLoop());
5870         if (!SE.isLoopInvariant(ExitValue, L)) {
5871           OS << "<<Unknown>>";
5872         } else {
5873           OS << *ExitValue;
5874         }
5875       }
5876
5877       OS << "\n";
5878     }
5879
5880   OS << "Determining loop execution counts for: ";
5881   WriteAsOperand(OS, F, /*PrintType=*/false);
5882   OS << "\n";
5883   for (LoopInfo::iterator I = LI->begin(), E = LI->end(); I != E; ++I)
5884     PrintLoopInfo(OS, &SE, *I);
5885 }
5886
5887 ScalarEvolution::LoopDisposition
5888 ScalarEvolution::getLoopDisposition(const SCEV *S, const Loop *L) {
5889   std::map<const Loop *, LoopDisposition> &Values = LoopDispositions[S];
5890   std::pair<std::map<const Loop *, LoopDisposition>::iterator, bool> Pair =
5891     Values.insert(std::make_pair(L, LoopVariant));
5892   if (!Pair.second)
5893     return Pair.first->second;
5894
5895   LoopDisposition D = computeLoopDisposition(S, L);
5896   return LoopDispositions[S][L] = D;
5897 }
5898
5899 ScalarEvolution::LoopDisposition
5900 ScalarEvolution::computeLoopDisposition(const SCEV *S, const Loop *L) {
5901   switch (S->getSCEVType()) {
5902   case scConstant:
5903     return LoopInvariant;
5904   case scTruncate:
5905   case scZeroExtend:
5906   case scSignExtend:
5907     return getLoopDisposition(cast<SCEVCastExpr>(S)->getOperand(), L);
5908   case scAddRecExpr: {
5909     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S);
5910
5911     // If L is the addrec's loop, it's computable.
5912     if (AR->getLoop() == L)
5913       return LoopComputable;
5914
5915     // Add recurrences are never invariant in the function-body (null loop).
5916     if (!L)
5917       return LoopVariant;
5918
5919     // This recurrence is variant w.r.t. L if L contains AR's loop.
5920     if (L->contains(AR->getLoop()))
5921       return LoopVariant;
5922
5923     // This recurrence is invariant w.r.t. L if AR's loop contains L.
5924     if (AR->getLoop()->contains(L))
5925       return LoopInvariant;
5926
5927     // This recurrence is variant w.r.t. L if any of its operands
5928     // are variant.
5929     for (SCEVAddRecExpr::op_iterator I = AR->op_begin(), E = AR->op_end();
5930          I != E; ++I)
5931       if (!isLoopInvariant(*I, L))
5932         return LoopVariant;
5933
5934     // Otherwise it's loop-invariant.
5935     return LoopInvariant;
5936   }
5937   case scAddExpr:
5938   case scMulExpr:
5939   case scUMaxExpr:
5940   case scSMaxExpr: {
5941     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S);
5942     bool HasVarying = false;
5943     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
5944          I != E; ++I) {
5945       LoopDisposition D = getLoopDisposition(*I, L);
5946       if (D == LoopVariant)
5947         return LoopVariant;
5948       if (D == LoopComputable)
5949         HasVarying = true;
5950     }
5951     return HasVarying ? LoopComputable : LoopInvariant;
5952   }
5953   case scUDivExpr: {
5954     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
5955     LoopDisposition LD = getLoopDisposition(UDiv->getLHS(), L);
5956     if (LD == LoopVariant)
5957       return LoopVariant;
5958     LoopDisposition RD = getLoopDisposition(UDiv->getRHS(), L);
5959     if (RD == LoopVariant)
5960       return LoopVariant;
5961     return (LD == LoopInvariant && RD == LoopInvariant) ?
5962            LoopInvariant : LoopComputable;
5963   }
5964   case scUnknown:
5965     // All non-instruction values are loop invariant.  All instructions are loop
5966     // invariant if they are not contained in the specified loop.
5967     // Instructions are never considered invariant in the function body
5968     // (null loop) because they are defined within the "loop".
5969     if (Instruction *I = dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue()))
5970       return (L && !L->contains(I)) ? LoopInvariant : LoopVariant;
5971     return LoopInvariant;
5972   case scCouldNotCompute:
5973     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
5974     return LoopVariant;
5975   default: break;
5976   }
5977   llvm_unreachable("Unknown SCEV kind!");
5978   return LoopVariant;
5979 }
5980
5981 bool ScalarEvolution::isLoopInvariant(const SCEV *S, const Loop *L) {
5982   return getLoopDisposition(S, L) == LoopInvariant;
5983 }
5984
5985 bool ScalarEvolution::hasComputableLoopEvolution(const SCEV *S, const Loop *L) {
5986   return getLoopDisposition(S, L) == LoopComputable;
5987 }
5988
5989 ScalarEvolution::BlockDisposition
5990 ScalarEvolution::getBlockDisposition(const SCEV *S, const BasicBlock *BB) {
5991   std::map<const BasicBlock *, BlockDisposition> &Values = BlockDispositions[S];
5992   std::pair<std::map<const BasicBlock *, BlockDisposition>::iterator, bool>
5993     Pair = Values.insert(std::make_pair(BB, DoesNotDominateBlock));
5994   if (!Pair.second)
5995     return Pair.first->second;
5996
5997   BlockDisposition D = computeBlockDisposition(S, BB);
5998   return BlockDispositions[S][BB] = D;
5999 }
6000
6001 ScalarEvolution::BlockDisposition
6002 ScalarEvolution::computeBlockDisposition(const SCEV *S, const BasicBlock *BB) {
6003   switch (S->getSCEVType()) {
6004   case scConstant:
6005     return ProperlyDominatesBlock;
6006   case scTruncate:
6007   case scZeroExtend:
6008   case scSignExtend:
6009     return getBlockDisposition(cast<SCEVCastExpr>(S)->getOperand(), BB);
6010   case scAddRecExpr: {
6011     // This uses a "dominates" query instead of "properly dominates" query
6012     // to test for proper dominance too, because the instruction which
6013     // produces the addrec's value is a PHI, and a PHI effectively properly
6014     // dominates its entire containing block.
6015     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S);
6016     if (!DT->dominates(AR->getLoop()->getHeader(), BB))
6017       return DoesNotDominateBlock;
6018   }
6019   // FALL THROUGH into SCEVNAryExpr handling.
6020   case scAddExpr:
6021   case scMulExpr:
6022   case scUMaxExpr:
6023   case scSMaxExpr: {
6024     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S);
6025     bool Proper = true;
6026     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
6027          I != E; ++I) {
6028       BlockDisposition D = getBlockDisposition(*I, BB);
6029       if (D == DoesNotDominateBlock)
6030         return DoesNotDominateBlock;
6031       if (D == DominatesBlock)
6032         Proper = false;
6033     }
6034     return Proper ? ProperlyDominatesBlock : DominatesBlock;
6035   }
6036   case scUDivExpr: {
6037     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
6038     const SCEV *LHS = UDiv->getLHS(), *RHS = UDiv->getRHS();
6039     BlockDisposition LD = getBlockDisposition(LHS, BB);
6040     if (LD == DoesNotDominateBlock)
6041       return DoesNotDominateBlock;
6042     BlockDisposition RD = getBlockDisposition(RHS, BB);
6043     if (RD == DoesNotDominateBlock)
6044       return DoesNotDominateBlock;
6045     return (LD == ProperlyDominatesBlock && RD == ProperlyDominatesBlock) ?
6046       ProperlyDominatesBlock : DominatesBlock;
6047   }
6048   case scUnknown:
6049     if (Instruction *I =
6050           dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue())) {
6051       if (I->getParent() == BB)
6052         return DominatesBlock;
6053       if (DT->properlyDominates(I->getParent(), BB))
6054         return ProperlyDominatesBlock;
6055       return DoesNotDominateBlock;
6056     }
6057     return ProperlyDominatesBlock;
6058   case scCouldNotCompute:
6059     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
6060     return DoesNotDominateBlock;
6061   default: break;
6062   }
6063   llvm_unreachable("Unknown SCEV kind!");
6064   return DoesNotDominateBlock;
6065 }
6066
6067 bool ScalarEvolution::dominates(const SCEV *S, const BasicBlock *BB) {
6068   return getBlockDisposition(S, BB) >= DominatesBlock;
6069 }
6070
6071 bool ScalarEvolution::properlyDominates(const SCEV *S, const BasicBlock *BB) {
6072   return getBlockDisposition(S, BB) == ProperlyDominatesBlock;
6073 }
6074
6075 bool ScalarEvolution::hasOperand(const SCEV *S, const SCEV *Op) const {
6076   switch (S->getSCEVType()) {
6077   case scConstant:
6078     return false;
6079   case scTruncate:
6080   case scZeroExtend:
6081   case scSignExtend: {
6082     const SCEVCastExpr *Cast = cast<SCEVCastExpr>(S);
6083     const SCEV *CastOp = Cast->getOperand();
6084     return Op == CastOp || hasOperand(CastOp, Op);
6085   }
6086   case scAddRecExpr:
6087   case scAddExpr:
6088   case scMulExpr:
6089   case scUMaxExpr:
6090   case scSMaxExpr: {
6091     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S);
6092     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
6093          I != E; ++I) {
6094       const SCEV *NAryOp = *I;
6095       if (NAryOp == Op || hasOperand(NAryOp, Op))
6096         return true;
6097     }
6098     return false;
6099   }
6100   case scUDivExpr: {
6101     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
6102     const SCEV *LHS = UDiv->getLHS(), *RHS = UDiv->getRHS();
6103     return LHS == Op || hasOperand(LHS, Op) ||
6104            RHS == Op || hasOperand(RHS, Op);
6105   }
6106   case scUnknown:
6107     return false;
6108   case scCouldNotCompute:
6109     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
6110     return false;
6111   default: break;
6112   }
6113   llvm_unreachable("Unknown SCEV kind!");
6114   return false;
6115 }
6116
6117 void ScalarEvolution::forgetMemoizedResults(const SCEV *S) {
6118   ValuesAtScopes.erase(S);
6119   LoopDispositions.erase(S);
6120   BlockDispositions.erase(S);
6121   UnsignedRanges.erase(S);
6122   SignedRanges.erase(S);
6123 }