lib/Analysis/ScalarEvolution.cpp

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