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