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