lib/Analysis/ScalarEvolution.cpp

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