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::getAlignOfExpr(Type *AllocTy) {
2610   Constant *C = ConstantExpr::getAlignOf(AllocTy);
2611   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
2612     if (Constant *Folded = ConstantFoldConstantExpression(CE, TD, TLI))
2613       C = Folded;
2614   Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(AllocTy));
2615   return getTruncateOrZeroExtend(getSCEV(C), Ty);
2616 }
2617
2618 const SCEV *ScalarEvolution::getOffsetOfExpr(Type *IntTy,
2619                                              StructType *STy,
2620                                              unsigned FieldNo) {
2621   // If we have DataLayout, we can bypass creating a target-independent
2622   // constant expression and then folding it back into a ConstantInt.
2623   // This is just a compile-time optimization.
2624   if (TD) {
2625     return getConstant(IntTy,
2626                        TD->getStructLayout(STy)->getElementOffset(FieldNo));
2627   }
2628
2629   Constant *C = ConstantExpr::getOffsetOf(STy, FieldNo);
2630   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
2631     if (Constant *Folded = ConstantFoldConstantExpression(CE, TD, TLI))
2632       C = Folded;
2633   Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(STy));
2634   return getTruncateOrZeroExtend(getSCEV(C), Ty);
2635 }
2636
2637 const SCEV *ScalarEvolution::getOffsetOfExpr(Type *IntTy,
2638                                              Type *CTy,
2639                                              Constant *FieldNo) {
2640   Constant *C = ConstantExpr::getOffsetOf(CTy, FieldNo);
2641   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
2642     if (Constant *Folded = ConstantFoldConstantExpression(CE, TD, TLI))
2643       C = Folded;
2644   Type *Ty = getEffectiveSCEVType(PointerType::getUnqual(CTy));
2645   return getTruncateOrZeroExtend(getSCEV(C), Ty);
2646 }
2647
2648 const SCEV *ScalarEvolution::getUnknown(Value *V) {
2649   // Don't attempt to do anything other than create a SCEVUnknown object
2650   // here.  createSCEV only calls getUnknown after checking for all other
2651   // interesting possibilities, and any other code that calls getUnknown
2652   // is doing so in order to hide a value from SCEV canonicalization.
2653
2654   FoldingSetNodeID ID;
2655   ID.AddInteger(scUnknown);
2656   ID.AddPointer(V);
2657   void *IP = 0;
2658   if (SCEV *S = UniqueSCEVs.FindNodeOrInsertPos(ID, IP)) {
2659     assert(cast<SCEVUnknown>(S)->getValue() == V &&
2660            "Stale SCEVUnknown in uniquing map!");
2661     return S;
2662   }
2663   SCEV *S = new (SCEVAllocator) SCEVUnknown(ID.Intern(SCEVAllocator), V, this,
2664                                             FirstUnknown);
2665   FirstUnknown = cast<SCEVUnknown>(S);
2666   UniqueSCEVs.InsertNode(S, IP);
2667   return S;
2668 }
2669
2670 //===----------------------------------------------------------------------===//
2671 //            Basic SCEV Analysis and PHI Idiom Recognition Code
2672 //
2673
2674 /// isSCEVable - Test if values of the given type are analyzable within
2675 /// the SCEV framework. This primarily includes integer types, and it
2676 /// can optionally include pointer types if the ScalarEvolution class
2677 /// has access to target-specific information.
2678 bool ScalarEvolution::isSCEVable(Type *Ty) const {
2679   // Integers and pointers are always SCEVable.
2680   return Ty->isIntegerTy() || Ty->isPointerTy();
2681 }
2682
2683 /// getTypeSizeInBits - Return the size in bits of the specified type,
2684 /// for which isSCEVable must return true.
2685 uint64_t ScalarEvolution::getTypeSizeInBits(Type *Ty) const {
2686   assert(isSCEVable(Ty) && "Type is not SCEVable!");
2687
2688   // If we have a DataLayout, use it!
2689   if (TD)
2690     return TD->getTypeSizeInBits(Ty);
2691
2692   // Integer types have fixed sizes.
2693   if (Ty->isIntegerTy())
2694     return Ty->getPrimitiveSizeInBits();
2695
2696   // The only other support type is pointer. Without DataLayout, conservatively
2697   // assume pointers are 64-bit.
2698   assert(Ty->isPointerTy() && "isSCEVable permitted a non-SCEVable type!");
2699   return 64;
2700 }
2701
2702 /// getEffectiveSCEVType - Return a type with the same bitwidth as
2703 /// the given type and which represents how SCEV will treat the given
2704 /// type, for which isSCEVable must return true. For pointer types,
2705 /// this is the pointer-sized integer type.
2706 Type *ScalarEvolution::getEffectiveSCEVType(Type *Ty) const {
2707   assert(isSCEVable(Ty) && "Type is not SCEVable!");
2708
2709   if (Ty->isIntegerTy()) {
2710     return Ty;
2711   }
2712
2713   // The only other support type is pointer.
2714   assert(Ty->isPointerTy() && "Unexpected non-pointer non-integer type!");
2715
2716   if (TD)
2717     return TD->getIntPtrType(Ty);
2718
2719   // Without DataLayout, conservatively assume pointers are 64-bit.
2720   return Type::getInt64Ty(getContext());
2721 }
2722
2723 const SCEV *ScalarEvolution::getCouldNotCompute() {
2724   return &CouldNotCompute;
2725 }
2726
2727 namespace {
2728   // Helper class working with SCEVTraversal to figure out if a SCEV contains
2729   // a SCEVUnknown with null value-pointer. FindInvalidSCEVUnknown::FindOne
2730   // is set iff if find such SCEVUnknown.
2731   //
2732   struct FindInvalidSCEVUnknown {
2733     bool FindOne;
2734     FindInvalidSCEVUnknown() { FindOne = false; }
2735     bool follow(const SCEV *S) {
2736       switch (S->getSCEVType()) {
2737       case scConstant:
2738         return false;
2739       case scUnknown:
2740         if (!cast<SCEVUnknown>(S)->getValue())
2741           FindOne = true;
2742         return false;
2743       default:
2744         return true;
2745       }
2746     }
2747     bool isDone() const { return FindOne; }
2748   };
2749 }
2750
2751 bool ScalarEvolution::checkValidity(const SCEV *S) const {
2752   FindInvalidSCEVUnknown F;
2753   SCEVTraversal<FindInvalidSCEVUnknown> ST(F);
2754   ST.visitAll(S);
2755
2756   return !F.FindOne;
2757 }
2758
2759 /// getSCEV - Return an existing SCEV if it exists, otherwise analyze the
2760 /// expression and create a new one.
2761 const SCEV *ScalarEvolution::getSCEV(Value *V) {
2762   assert(isSCEVable(V->getType()) && "Value is not SCEVable!");
2763
2764   ValueExprMapType::iterator I = ValueExprMap.find_as(V);
2765   if (I != ValueExprMap.end()) {
2766     const SCEV *S = I->second;
2767     if (checkValidity(S))
2768       return S;
2769     else
2770       ValueExprMap.erase(I);
2771   }
2772   const SCEV *S = createSCEV(V);
2773
2774   // The process of creating a SCEV for V may have caused other SCEVs
2775   // to have been created, so it's necessary to insert the new entry
2776   // from scratch, rather than trying to remember the insert position
2777   // above.
2778   ValueExprMap.insert(std::make_pair(SCEVCallbackVH(V, this), S));
2779   return S;
2780 }
2781
2782 /// getNegativeSCEV - Return a SCEV corresponding to -V = -1*V
2783 ///
2784 const SCEV *ScalarEvolution::getNegativeSCEV(const SCEV *V) {
2785   if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
2786     return getConstant(
2787                cast<ConstantInt>(ConstantExpr::getNeg(VC->getValue())));
2788
2789   Type *Ty = V->getType();
2790   Ty = getEffectiveSCEVType(Ty);
2791   return getMulExpr(V,
2792                   getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty))));
2793 }
2794
2795 /// getNotSCEV - Return a SCEV corresponding to ~V = -1-V
2796 const SCEV *ScalarEvolution::getNotSCEV(const SCEV *V) {
2797   if (const SCEVConstant *VC = dyn_cast<SCEVConstant>(V))
2798     return getConstant(
2799                 cast<ConstantInt>(ConstantExpr::getNot(VC->getValue())));
2800
2801   Type *Ty = V->getType();
2802   Ty = getEffectiveSCEVType(Ty);
2803   const SCEV *AllOnes =
2804                    getConstant(cast<ConstantInt>(Constant::getAllOnesValue(Ty)));
2805   return getMinusSCEV(AllOnes, V);
2806 }
2807
2808 /// getMinusSCEV - Return LHS-RHS.  Minus is represented in SCEV as A+B*-1.
2809 const SCEV *ScalarEvolution::getMinusSCEV(const SCEV *LHS, const SCEV *RHS,
2810                                           SCEV::NoWrapFlags Flags) {
2811   assert(!maskFlags(Flags, SCEV::FlagNUW) && "subtraction does not have NUW");
2812
2813   // Fast path: X - X --> 0.
2814   if (LHS == RHS)
2815     return getConstant(LHS->getType(), 0);
2816
2817   // X - Y --> X + -Y
2818   return getAddExpr(LHS, getNegativeSCEV(RHS), Flags);
2819 }
2820
2821 /// getTruncateOrZeroExtend - Return a SCEV corresponding to a conversion of the
2822 /// input value to the specified type.  If the type must be extended, it is zero
2823 /// extended.
2824 const SCEV *
2825 ScalarEvolution::getTruncateOrZeroExtend(const SCEV *V, Type *Ty) {
2826   Type *SrcTy = V->getType();
2827   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2828          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2829          "Cannot truncate or zero extend with non-integer arguments!");
2830   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2831     return V;  // No conversion
2832   if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
2833     return getTruncateExpr(V, Ty);
2834   return getZeroExtendExpr(V, Ty);
2835 }
2836
2837 /// getTruncateOrSignExtend - Return a SCEV corresponding to a conversion of the
2838 /// input value to the specified type.  If the type must be extended, it is sign
2839 /// extended.
2840 const SCEV *
2841 ScalarEvolution::getTruncateOrSignExtend(const SCEV *V,
2842                                          Type *Ty) {
2843   Type *SrcTy = V->getType();
2844   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2845          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2846          "Cannot truncate or zero extend with non-integer arguments!");
2847   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2848     return V;  // No conversion
2849   if (getTypeSizeInBits(SrcTy) > getTypeSizeInBits(Ty))
2850     return getTruncateExpr(V, Ty);
2851   return getSignExtendExpr(V, Ty);
2852 }
2853
2854 /// getNoopOrZeroExtend - Return a SCEV corresponding to a conversion of the
2855 /// input value to the specified type.  If the type must be extended, it is zero
2856 /// extended.  The conversion must not be narrowing.
2857 const SCEV *
2858 ScalarEvolution::getNoopOrZeroExtend(const SCEV *V, Type *Ty) {
2859   Type *SrcTy = V->getType();
2860   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2861          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2862          "Cannot noop or zero extend with non-integer arguments!");
2863   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
2864          "getNoopOrZeroExtend cannot truncate!");
2865   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2866     return V;  // No conversion
2867   return getZeroExtendExpr(V, Ty);
2868 }
2869
2870 /// getNoopOrSignExtend - Return a SCEV corresponding to a conversion of the
2871 /// input value to the specified type.  If the type must be extended, it is sign
2872 /// extended.  The conversion must not be narrowing.
2873 const SCEV *
2874 ScalarEvolution::getNoopOrSignExtend(const SCEV *V, Type *Ty) {
2875   Type *SrcTy = V->getType();
2876   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2877          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2878          "Cannot noop or sign extend with non-integer arguments!");
2879   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
2880          "getNoopOrSignExtend cannot truncate!");
2881   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2882     return V;  // No conversion
2883   return getSignExtendExpr(V, Ty);
2884 }
2885
2886 /// getNoopOrAnyExtend - Return a SCEV corresponding to a conversion of
2887 /// the input value to the specified type. If the type must be extended,
2888 /// it is extended with unspecified bits. The conversion must not be
2889 /// narrowing.
2890 const SCEV *
2891 ScalarEvolution::getNoopOrAnyExtend(const SCEV *V, Type *Ty) {
2892   Type *SrcTy = V->getType();
2893   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2894          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2895          "Cannot noop or any extend with non-integer arguments!");
2896   assert(getTypeSizeInBits(SrcTy) <= getTypeSizeInBits(Ty) &&
2897          "getNoopOrAnyExtend cannot truncate!");
2898   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2899     return V;  // No conversion
2900   return getAnyExtendExpr(V, Ty);
2901 }
2902
2903 /// getTruncateOrNoop - Return a SCEV corresponding to a conversion of the
2904 /// input value to the specified type.  The conversion must not be widening.
2905 const SCEV *
2906 ScalarEvolution::getTruncateOrNoop(const SCEV *V, Type *Ty) {
2907   Type *SrcTy = V->getType();
2908   assert((SrcTy->isIntegerTy() || SrcTy->isPointerTy()) &&
2909          (Ty->isIntegerTy() || Ty->isPointerTy()) &&
2910          "Cannot truncate or noop with non-integer arguments!");
2911   assert(getTypeSizeInBits(SrcTy) >= getTypeSizeInBits(Ty) &&
2912          "getTruncateOrNoop cannot extend!");
2913   if (getTypeSizeInBits(SrcTy) == getTypeSizeInBits(Ty))
2914     return V;  // No conversion
2915   return getTruncateExpr(V, Ty);
2916 }
2917
2918 /// getUMaxFromMismatchedTypes - Promote the operands to the wider of
2919 /// the types using zero-extension, and then perform a umax operation
2920 /// with them.
2921 const SCEV *ScalarEvolution::getUMaxFromMismatchedTypes(const SCEV *LHS,
2922                                                         const SCEV *RHS) {
2923   const SCEV *PromotedLHS = LHS;
2924   const SCEV *PromotedRHS = RHS;
2925
2926   if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
2927     PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
2928   else
2929     PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
2930
2931   return getUMaxExpr(PromotedLHS, PromotedRHS);
2932 }
2933
2934 /// getUMinFromMismatchedTypes - Promote the operands to the wider of
2935 /// the types using zero-extension, and then perform a umin operation
2936 /// with them.
2937 const SCEV *ScalarEvolution::getUMinFromMismatchedTypes(const SCEV *LHS,
2938                                                         const SCEV *RHS) {
2939   const SCEV *PromotedLHS = LHS;
2940   const SCEV *PromotedRHS = RHS;
2941
2942   if (getTypeSizeInBits(LHS->getType()) > getTypeSizeInBits(RHS->getType()))
2943     PromotedRHS = getZeroExtendExpr(RHS, LHS->getType());
2944   else
2945     PromotedLHS = getNoopOrZeroExtend(LHS, RHS->getType());
2946
2947   return getUMinExpr(PromotedLHS, PromotedRHS);
2948 }
2949
2950 /// getPointerBase - Transitively follow the chain of pointer-type operands
2951 /// until reaching a SCEV that does not have a single pointer operand. This
2952 /// returns a SCEVUnknown pointer for well-formed pointer-type expressions,
2953 /// but corner cases do exist.
2954 const SCEV *ScalarEvolution::getPointerBase(const SCEV *V) {
2955   // A pointer operand may evaluate to a nonpointer expression, such as null.
2956   if (!V->getType()->isPointerTy())
2957     return V;
2958
2959   if (const SCEVCastExpr *Cast = dyn_cast<SCEVCastExpr>(V)) {
2960     return getPointerBase(Cast->getOperand());
2961   }
2962   else if (const SCEVNAryExpr *NAry = dyn_cast<SCEVNAryExpr>(V)) {
2963     const SCEV *PtrOp = 0;
2964     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
2965          I != E; ++I) {
2966       if ((*I)->getType()->isPointerTy()) {
2967         // Cannot find the base of an expression with multiple pointer operands.
2968         if (PtrOp)
2969           return V;
2970         PtrOp = *I;
2971       }
2972     }
2973     if (!PtrOp)
2974       return V;
2975     return getPointerBase(PtrOp);
2976   }
2977   return V;
2978 }
2979
2980 /// PushDefUseChildren - Push users of the given Instruction
2981 /// onto the given Worklist.
2982 static void
2983 PushDefUseChildren(Instruction *I,
2984                    SmallVectorImpl<Instruction *> &Worklist) {
2985   // Push the def-use children onto the Worklist stack.
2986   for (Value::use_iterator UI = I->use_begin(), UE = I->use_end();
2987        UI != UE; ++UI)
2988     Worklist.push_back(cast<Instruction>(*UI));
2989 }
2990
2991 /// ForgetSymbolicValue - This looks up computed SCEV values for all
2992 /// instructions that depend on the given instruction and removes them from
2993 /// the ValueExprMapType map if they reference SymName. This is used during PHI
2994 /// resolution.
2995 void
2996 ScalarEvolution::ForgetSymbolicName(Instruction *PN, const SCEV *SymName) {
2997   SmallVector<Instruction *, 16> Worklist;
2998   PushDefUseChildren(PN, Worklist);
2999
3000   SmallPtrSet<Instruction *, 8> Visited;
3001   Visited.insert(PN);
3002   while (!Worklist.empty()) {
3003     Instruction *I = Worklist.pop_back_val();
3004     if (!Visited.insert(I)) continue;
3005
3006     ValueExprMapType::iterator It =
3007       ValueExprMap.find_as(static_cast<Value *>(I));
3008     if (It != ValueExprMap.end()) {
3009       const SCEV *Old = It->second;
3010
3011       // Short-circuit the def-use traversal if the symbolic name
3012       // ceases to appear in expressions.
3013       if (Old != SymName && !hasOperand(Old, SymName))
3014         continue;
3015
3016       // SCEVUnknown for a PHI either means that it has an unrecognized
3017       // structure, it's a PHI that's in the progress of being computed
3018       // by createNodeForPHI, or it's a single-value PHI. In the first case,
3019       // additional loop trip count information isn't going to change anything.
3020       // In the second case, createNodeForPHI will perform the necessary
3021       // updates on its own when it gets to that point. In the third, we do
3022       // want to forget the SCEVUnknown.
3023       if (!isa<PHINode>(I) ||
3024           !isa<SCEVUnknown>(Old) ||
3025           (I != PN && Old == SymName)) {
3026         forgetMemoizedResults(Old);
3027         ValueExprMap.erase(It);
3028       }
3029     }
3030
3031     PushDefUseChildren(I, Worklist);
3032   }
3033 }
3034
3035 /// createNodeForPHI - PHI nodes have two cases.  Either the PHI node exists in
3036 /// a loop header, making it a potential recurrence, or it doesn't.
3037 ///
3038 const SCEV *ScalarEvolution::createNodeForPHI(PHINode *PN) {
3039   if (const Loop *L = LI->getLoopFor(PN->getParent()))
3040     if (L->getHeader() == PN->getParent()) {
3041       // The loop may have multiple entrances or multiple exits; we can analyze
3042       // this phi as an addrec if it has a unique entry value and a unique
3043       // backedge value.
3044       Value *BEValueV = 0, *StartValueV = 0;
3045       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
3046         Value *V = PN->getIncomingValue(i);
3047         if (L->contains(PN->getIncomingBlock(i))) {
3048           if (!BEValueV) {
3049             BEValueV = V;
3050           } else if (BEValueV != V) {
3051             BEValueV = 0;
3052             break;
3053           }
3054         } else if (!StartValueV) {
3055           StartValueV = V;
3056         } else if (StartValueV != V) {
3057           StartValueV = 0;
3058           break;
3059         }
3060       }
3061       if (BEValueV && StartValueV) {
3062         // While we are analyzing this PHI node, handle its value symbolically.
3063         const SCEV *SymbolicName = getUnknown(PN);
3064         assert(ValueExprMap.find_as(PN) == ValueExprMap.end() &&
3065                "PHI node already processed?");
3066         ValueExprMap.insert(std::make_pair(SCEVCallbackVH(PN, this), SymbolicName));
3067
3068         // Using this symbolic name for the PHI, analyze the value coming around
3069         // the back-edge.
3070         const SCEV *BEValue = getSCEV(BEValueV);
3071
3072         // NOTE: If BEValue is loop invariant, we know that the PHI node just
3073         // has a special value for the first iteration of the loop.
3074
3075         // If the value coming around the backedge is an add with the symbolic
3076         // value we just inserted, then we found a simple induction variable!
3077         if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(BEValue)) {
3078           // If there is a single occurrence of the symbolic value, replace it
3079           // with a recurrence.
3080           unsigned FoundIndex = Add->getNumOperands();
3081           for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
3082             if (Add->getOperand(i) == SymbolicName)
3083               if (FoundIndex == e) {
3084                 FoundIndex = i;
3085                 break;
3086               }
3087
3088           if (FoundIndex != Add->getNumOperands()) {
3089             // Create an add with everything but the specified operand.
3090             SmallVector<const SCEV *, 8> Ops;
3091             for (unsigned i = 0, e = Add->getNumOperands(); i != e; ++i)
3092               if (i != FoundIndex)
3093                 Ops.push_back(Add->getOperand(i));
3094             const SCEV *Accum = getAddExpr(Ops);
3095
3096             // This is not a valid addrec if the step amount is varying each
3097             // loop iteration, but is not itself an addrec in this loop.
3098             if (isLoopInvariant(Accum, L) ||
3099                 (isa<SCEVAddRecExpr>(Accum) &&
3100                  cast<SCEVAddRecExpr>(Accum)->getLoop() == L)) {
3101               SCEV::NoWrapFlags Flags = SCEV::FlagAnyWrap;
3102
3103               // If the increment doesn't overflow, then neither the addrec nor
3104               // the post-increment will overflow.
3105               if (const AddOperator *OBO = dyn_cast<AddOperator>(BEValueV)) {
3106                 if (OBO->hasNoUnsignedWrap())
3107                   Flags = setFlags(Flags, SCEV::FlagNUW);
3108                 if (OBO->hasNoSignedWrap())
3109                   Flags = setFlags(Flags, SCEV::FlagNSW);
3110               } else if (const GEPOperator *GEP =
3111                          dyn_cast<GEPOperator>(BEValueV)) {
3112                 // If the increment is an inbounds GEP, then we know the address
3113                 // space cannot be wrapped around. We cannot make any guarantee
3114                 // about signed or unsigned overflow because pointers are
3115                 // unsigned but we may have a negative index from the base
3116                 // pointer.
3117                 if (GEP->isInBounds())
3118                   Flags = setFlags(Flags, SCEV::FlagNW);
3119               }
3120
3121               const SCEV *StartVal = getSCEV(StartValueV);
3122               const SCEV *PHISCEV = getAddRecExpr(StartVal, Accum, L, Flags);
3123
3124               // Since the no-wrap flags are on the increment, they apply to the
3125               // post-incremented value as well.
3126               if (isLoopInvariant(Accum, L))
3127                 (void)getAddRecExpr(getAddExpr(StartVal, Accum),
3128                                     Accum, L, Flags);
3129
3130               // Okay, for the entire analysis of this edge we assumed the PHI
3131               // to be symbolic.  We now need to go back and purge all of the
3132               // entries for the scalars that use the symbolic expression.
3133               ForgetSymbolicName(PN, SymbolicName);
3134               ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
3135               return PHISCEV;
3136             }
3137           }
3138         } else if (const SCEVAddRecExpr *AddRec =
3139                      dyn_cast<SCEVAddRecExpr>(BEValue)) {
3140           // Otherwise, this could be a loop like this:
3141           //     i = 0;  for (j = 1; ..; ++j) { ....  i = j; }
3142           // In this case, j = {1,+,1}  and BEValue is j.
3143           // Because the other in-value of i (0) fits the evolution of BEValue
3144           // i really is an addrec evolution.
3145           if (AddRec->getLoop() == L && AddRec->isAffine()) {
3146             const SCEV *StartVal = getSCEV(StartValueV);
3147
3148             // If StartVal = j.start - j.stride, we can use StartVal as the
3149             // initial step of the addrec evolution.
3150             if (StartVal == getMinusSCEV(AddRec->getOperand(0),
3151                                          AddRec->getOperand(1))) {
3152               // FIXME: For constant StartVal, we should be able to infer
3153               // no-wrap flags.
3154               const SCEV *PHISCEV =
3155                 getAddRecExpr(StartVal, AddRec->getOperand(1), L,
3156                               SCEV::FlagAnyWrap);
3157
3158               // Okay, for the entire analysis of this edge we assumed the PHI
3159               // to be symbolic.  We now need to go back and purge all of the
3160               // entries for the scalars that use the symbolic expression.
3161               ForgetSymbolicName(PN, SymbolicName);
3162               ValueExprMap[SCEVCallbackVH(PN, this)] = PHISCEV;
3163               return PHISCEV;
3164             }
3165           }
3166         }
3167       }
3168     }
3169
3170   // If the PHI has a single incoming value, follow that value, unless the
3171   // PHI's incoming blocks are in a different loop, in which case doing so
3172   // risks breaking LCSSA form. Instcombine would normally zap these, but
3173   // it doesn't have DominatorTree information, so it may miss cases.
3174   if (Value *V = SimplifyInstruction(PN, TD, TLI, DT))
3175     if (LI->replacementPreservesLCSSAForm(PN, V))
3176       return getSCEV(V);
3177
3178   // If it's not a loop phi, we can't handle it yet.
3179   return getUnknown(PN);
3180 }
3181
3182 /// createNodeForGEP - Expand GEP instructions into add and multiply
3183 /// operations. This allows them to be analyzed by regular SCEV code.
3184 ///
3185 const SCEV *ScalarEvolution::createNodeForGEP(GEPOperator *GEP) {
3186   Type *IntPtrTy = getEffectiveSCEVType(GEP->getType());
3187   Value *Base = GEP->getOperand(0);
3188   // Don't attempt to analyze GEPs over unsized objects.
3189   if (!cast<PointerType>(Base->getType())->getElementType()->isSized())
3190     return getUnknown(GEP);
3191
3192   // Don't blindly transfer the inbounds flag from the GEP instruction to the
3193   // Add expression, because the Instruction may be guarded by control flow
3194   // and the no-overflow bits may not be valid for the expression in any
3195   // context.
3196   SCEV::NoWrapFlags Wrap = GEP->isInBounds() ? SCEV::FlagNSW : SCEV::FlagAnyWrap;
3197
3198   const SCEV *TotalOffset = getConstant(IntPtrTy, 0);
3199   gep_type_iterator GTI = gep_type_begin(GEP);
3200   for (GetElementPtrInst::op_iterator I = llvm::next(GEP->op_begin()),
3201                                       E = GEP->op_end();
3202        I != E; ++I) {
3203     Value *Index = *I;
3204     // Compute the (potentially symbolic) offset in bytes for this index.
3205     if (StructType *STy = dyn_cast<StructType>(*GTI++)) {
3206       // For a struct, add the member offset.
3207       unsigned FieldNo = cast<ConstantInt>(Index)->getZExtValue();
3208       const SCEV *FieldOffset = getOffsetOfExpr(IntPtrTy, STy, FieldNo);
3209
3210       // Add the field offset to the running total offset.
3211       TotalOffset = getAddExpr(TotalOffset, FieldOffset);
3212     } else {
3213       // For an array, add the element offset, explicitly scaled.
3214       const SCEV *ElementSize = getSizeOfExpr(IntPtrTy, *GTI);
3215       const SCEV *IndexS = getSCEV(Index);
3216       // Getelementptr indices are signed.
3217       IndexS = getTruncateOrSignExtend(IndexS, IntPtrTy);
3218
3219       // Multiply the index by the element size to compute the element offset.
3220       const SCEV *LocalOffset = getMulExpr(IndexS, ElementSize, Wrap);
3221
3222       // Add the element offset to the running total offset.
3223       TotalOffset = getAddExpr(TotalOffset, LocalOffset);
3224     }
3225   }
3226
3227   // Get the SCEV for the GEP base.
3228   const SCEV *BaseS = getSCEV(Base);
3229
3230   // Add the total offset from all the GEP indices to the base.
3231   return getAddExpr(BaseS, TotalOffset, Wrap);
3232 }
3233
3234 /// GetMinTrailingZeros - Determine the minimum number of zero bits that S is
3235 /// guaranteed to end in (at every loop iteration).  It is, at the same time,
3236 /// the minimum number of times S is divisible by 2.  For example, given {4,+,8}
3237 /// it returns 2.  If S is guaranteed to be 0, it returns the bitwidth of S.
3238 uint32_t
3239 ScalarEvolution::GetMinTrailingZeros(const SCEV *S) {
3240   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
3241     return C->getValue()->getValue().countTrailingZeros();
3242
3243   if (const SCEVTruncateExpr *T = dyn_cast<SCEVTruncateExpr>(S))
3244     return std::min(GetMinTrailingZeros(T->getOperand()),
3245                     (uint32_t)getTypeSizeInBits(T->getType()));
3246
3247   if (const SCEVZeroExtendExpr *E = dyn_cast<SCEVZeroExtendExpr>(S)) {
3248     uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
3249     return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
3250              getTypeSizeInBits(E->getType()) : OpRes;
3251   }
3252
3253   if (const SCEVSignExtendExpr *E = dyn_cast<SCEVSignExtendExpr>(S)) {
3254     uint32_t OpRes = GetMinTrailingZeros(E->getOperand());
3255     return OpRes == getTypeSizeInBits(E->getOperand()->getType()) ?
3256              getTypeSizeInBits(E->getType()) : OpRes;
3257   }
3258
3259   if (const SCEVAddExpr *A = dyn_cast<SCEVAddExpr>(S)) {
3260     // The result is the min of all operands results.
3261     uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
3262     for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
3263       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
3264     return MinOpRes;
3265   }
3266
3267   if (const SCEVMulExpr *M = dyn_cast<SCEVMulExpr>(S)) {
3268     // The result is the sum of all operands results.
3269     uint32_t SumOpRes = GetMinTrailingZeros(M->getOperand(0));
3270     uint32_t BitWidth = getTypeSizeInBits(M->getType());
3271     for (unsigned i = 1, e = M->getNumOperands();
3272          SumOpRes != BitWidth && i != e; ++i)
3273       SumOpRes = std::min(SumOpRes + GetMinTrailingZeros(M->getOperand(i)),
3274                           BitWidth);
3275     return SumOpRes;
3276   }
3277
3278   if (const SCEVAddRecExpr *A = dyn_cast<SCEVAddRecExpr>(S)) {
3279     // The result is the min of all operands results.
3280     uint32_t MinOpRes = GetMinTrailingZeros(A->getOperand(0));
3281     for (unsigned i = 1, e = A->getNumOperands(); MinOpRes && i != e; ++i)
3282       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(A->getOperand(i)));
3283     return MinOpRes;
3284   }
3285
3286   if (const SCEVSMaxExpr *M = dyn_cast<SCEVSMaxExpr>(S)) {
3287     // The result is the min of all operands results.
3288     uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
3289     for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
3290       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
3291     return MinOpRes;
3292   }
3293
3294   if (const SCEVUMaxExpr *M = dyn_cast<SCEVUMaxExpr>(S)) {
3295     // The result is the min of all operands results.
3296     uint32_t MinOpRes = GetMinTrailingZeros(M->getOperand(0));
3297     for (unsigned i = 1, e = M->getNumOperands(); MinOpRes && i != e; ++i)
3298       MinOpRes = std::min(MinOpRes, GetMinTrailingZeros(M->getOperand(i)));
3299     return MinOpRes;
3300   }
3301
3302   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
3303     // For a SCEVUnknown, ask ValueTracking.
3304     unsigned BitWidth = getTypeSizeInBits(U->getType());
3305     APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
3306     ComputeMaskedBits(U->getValue(), Zeros, Ones);
3307     return Zeros.countTrailingOnes();
3308   }
3309
3310   // SCEVUDivExpr
3311   return 0;
3312 }
3313
3314 /// getUnsignedRange - Determine the unsigned range for a particular SCEV.
3315 ///
3316 ConstantRange
3317 ScalarEvolution::getUnsignedRange(const SCEV *S) {
3318   // See if we've computed this range already.
3319   DenseMap<const SCEV *, ConstantRange>::iterator I = UnsignedRanges.find(S);
3320   if (I != UnsignedRanges.end())
3321     return I->second;
3322
3323   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
3324     return setUnsignedRange(C, ConstantRange(C->getValue()->getValue()));
3325
3326   unsigned BitWidth = getTypeSizeInBits(S->getType());
3327   ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true);
3328
3329   // If the value has known zeros, the maximum unsigned value will have those
3330   // known zeros as well.
3331   uint32_t TZ = GetMinTrailingZeros(S);
3332   if (TZ != 0)
3333     ConservativeResult =
3334       ConstantRange(APInt::getMinValue(BitWidth),
3335                     APInt::getMaxValue(BitWidth).lshr(TZ).shl(TZ) + 1);
3336
3337   if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
3338     ConstantRange X = getUnsignedRange(Add->getOperand(0));
3339     for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i)
3340       X = X.add(getUnsignedRange(Add->getOperand(i)));
3341     return setUnsignedRange(Add, ConservativeResult.intersectWith(X));
3342   }
3343
3344   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
3345     ConstantRange X = getUnsignedRange(Mul->getOperand(0));
3346     for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i)
3347       X = X.multiply(getUnsignedRange(Mul->getOperand(i)));
3348     return setUnsignedRange(Mul, ConservativeResult.intersectWith(X));
3349   }
3350
3351   if (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(S)) {
3352     ConstantRange X = getUnsignedRange(SMax->getOperand(0));
3353     for (unsigned i = 1, e = SMax->getNumOperands(); i != e; ++i)
3354       X = X.smax(getUnsignedRange(SMax->getOperand(i)));
3355     return setUnsignedRange(SMax, ConservativeResult.intersectWith(X));
3356   }
3357
3358   if (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(S)) {
3359     ConstantRange X = getUnsignedRange(UMax->getOperand(0));
3360     for (unsigned i = 1, e = UMax->getNumOperands(); i != e; ++i)
3361       X = X.umax(getUnsignedRange(UMax->getOperand(i)));
3362     return setUnsignedRange(UMax, ConservativeResult.intersectWith(X));
3363   }
3364
3365   if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) {
3366     ConstantRange X = getUnsignedRange(UDiv->getLHS());
3367     ConstantRange Y = getUnsignedRange(UDiv->getRHS());
3368     return setUnsignedRange(UDiv, ConservativeResult.intersectWith(X.udiv(Y)));
3369   }
3370
3371   if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) {
3372     ConstantRange X = getUnsignedRange(ZExt->getOperand());
3373     return setUnsignedRange(ZExt,
3374       ConservativeResult.intersectWith(X.zeroExtend(BitWidth)));
3375   }
3376
3377   if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) {
3378     ConstantRange X = getUnsignedRange(SExt->getOperand());
3379     return setUnsignedRange(SExt,
3380       ConservativeResult.intersectWith(X.signExtend(BitWidth)));
3381   }
3382
3383   if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) {
3384     ConstantRange X = getUnsignedRange(Trunc->getOperand());
3385     return setUnsignedRange(Trunc,
3386       ConservativeResult.intersectWith(X.truncate(BitWidth)));
3387   }
3388
3389   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) {
3390     // If there's no unsigned wrap, the value will never be less than its
3391     // initial value.
3392     if (AddRec->getNoWrapFlags(SCEV::FlagNUW))
3393       if (const SCEVConstant *C = dyn_cast<SCEVConstant>(AddRec->getStart()))
3394         if (!C->getValue()->isZero())
3395           ConservativeResult =
3396             ConservativeResult.intersectWith(
3397               ConstantRange(C->getValue()->getValue(), APInt(BitWidth, 0)));
3398
3399     // TODO: non-affine addrec
3400     if (AddRec->isAffine()) {
3401       Type *Ty = AddRec->getType();
3402       const SCEV *MaxBECount = getMaxBackedgeTakenCount(AddRec->getLoop());
3403       if (!isa<SCEVCouldNotCompute>(MaxBECount) &&
3404           getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) {
3405         MaxBECount = getNoopOrZeroExtend(MaxBECount, Ty);
3406
3407         const SCEV *Start = AddRec->getStart();
3408         const SCEV *Step = AddRec->getStepRecurrence(*this);
3409
3410         ConstantRange StartRange = getUnsignedRange(Start);
3411         ConstantRange StepRange = getSignedRange(Step);
3412         ConstantRange MaxBECountRange = getUnsignedRange(MaxBECount);
3413         ConstantRange EndRange =
3414           StartRange.add(MaxBECountRange.multiply(StepRange));
3415
3416         // Check for overflow. This must be done with ConstantRange arithmetic
3417         // because we could be called from within the ScalarEvolution overflow
3418         // checking code.
3419         ConstantRange ExtStartRange = StartRange.zextOrTrunc(BitWidth*2+1);
3420         ConstantRange ExtStepRange = StepRange.sextOrTrunc(BitWidth*2+1);
3421         ConstantRange ExtMaxBECountRange =
3422           MaxBECountRange.zextOrTrunc(BitWidth*2+1);
3423         ConstantRange ExtEndRange = EndRange.zextOrTrunc(BitWidth*2+1);
3424         if (ExtStartRange.add(ExtMaxBECountRange.multiply(ExtStepRange)) !=
3425             ExtEndRange)
3426           return setUnsignedRange(AddRec, ConservativeResult);
3427
3428         APInt Min = APIntOps::umin(StartRange.getUnsignedMin(),
3429                                    EndRange.getUnsignedMin());
3430         APInt Max = APIntOps::umax(StartRange.getUnsignedMax(),
3431                                    EndRange.getUnsignedMax());
3432         if (Min.isMinValue() && Max.isMaxValue())
3433           return setUnsignedRange(AddRec, ConservativeResult);
3434         return setUnsignedRange(AddRec,
3435           ConservativeResult.intersectWith(ConstantRange(Min, Max+1)));
3436       }
3437     }
3438
3439     return setUnsignedRange(AddRec, ConservativeResult);
3440   }
3441
3442   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
3443     // For a SCEVUnknown, ask ValueTracking.
3444     APInt Zeros(BitWidth, 0), Ones(BitWidth, 0);
3445     ComputeMaskedBits(U->getValue(), Zeros, Ones, TD);
3446     if (Ones == ~Zeros + 1)
3447       return setUnsignedRange(U, ConservativeResult);
3448     return setUnsignedRange(U,
3449       ConservativeResult.intersectWith(ConstantRange(Ones, ~Zeros + 1)));
3450   }
3451
3452   return setUnsignedRange(S, ConservativeResult);
3453 }
3454
3455 /// getSignedRange - Determine the signed range for a particular SCEV.
3456 ///
3457 ConstantRange
3458 ScalarEvolution::getSignedRange(const SCEV *S) {
3459   // See if we've computed this range already.
3460   DenseMap<const SCEV *, ConstantRange>::iterator I = SignedRanges.find(S);
3461   if (I != SignedRanges.end())
3462     return I->second;
3463
3464   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S))
3465     return setSignedRange(C, ConstantRange(C->getValue()->getValue()));
3466
3467   unsigned BitWidth = getTypeSizeInBits(S->getType());
3468   ConstantRange ConservativeResult(BitWidth, /*isFullSet=*/true);
3469
3470   // If the value has known zeros, the maximum signed value will have those
3471   // known zeros as well.
3472   uint32_t TZ = GetMinTrailingZeros(S);
3473   if (TZ != 0)
3474     ConservativeResult =
3475       ConstantRange(APInt::getSignedMinValue(BitWidth),
3476                     APInt::getSignedMaxValue(BitWidth).ashr(TZ).shl(TZ) + 1);
3477
3478   if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
3479     ConstantRange X = getSignedRange(Add->getOperand(0));
3480     for (unsigned i = 1, e = Add->getNumOperands(); i != e; ++i)
3481       X = X.add(getSignedRange(Add->getOperand(i)));
3482     return setSignedRange(Add, ConservativeResult.intersectWith(X));
3483   }
3484
3485   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
3486     ConstantRange X = getSignedRange(Mul->getOperand(0));
3487     for (unsigned i = 1, e = Mul->getNumOperands(); i != e; ++i)
3488       X = X.multiply(getSignedRange(Mul->getOperand(i)));
3489     return setSignedRange(Mul, ConservativeResult.intersectWith(X));
3490   }
3491
3492   if (const SCEVSMaxExpr *SMax = dyn_cast<SCEVSMaxExpr>(S)) {
3493     ConstantRange X = getSignedRange(SMax->getOperand(0));
3494     for (unsigned i = 1, e = SMax->getNumOperands(); i != e; ++i)
3495       X = X.smax(getSignedRange(SMax->getOperand(i)));
3496     return setSignedRange(SMax, ConservativeResult.intersectWith(X));
3497   }
3498
3499   if (const SCEVUMaxExpr *UMax = dyn_cast<SCEVUMaxExpr>(S)) {
3500     ConstantRange X = getSignedRange(UMax->getOperand(0));
3501     for (unsigned i = 1, e = UMax->getNumOperands(); i != e; ++i)
3502       X = X.umax(getSignedRange(UMax->getOperand(i)));
3503     return setSignedRange(UMax, ConservativeResult.intersectWith(X));
3504   }
3505
3506   if (const SCEVUDivExpr *UDiv = dyn_cast<SCEVUDivExpr>(S)) {
3507     ConstantRange X = getSignedRange(UDiv->getLHS());
3508     ConstantRange Y = getSignedRange(UDiv->getRHS());
3509     return setSignedRange(UDiv, ConservativeResult.intersectWith(X.udiv(Y)));
3510   }
3511
3512   if (const SCEVZeroExtendExpr *ZExt = dyn_cast<SCEVZeroExtendExpr>(S)) {
3513     ConstantRange X = getSignedRange(ZExt->getOperand());
3514     return setSignedRange(ZExt,
3515       ConservativeResult.intersectWith(X.zeroExtend(BitWidth)));
3516   }
3517
3518   if (const SCEVSignExtendExpr *SExt = dyn_cast<SCEVSignExtendExpr>(S)) {
3519     ConstantRange X = getSignedRange(SExt->getOperand());
3520     return setSignedRange(SExt,
3521       ConservativeResult.intersectWith(X.signExtend(BitWidth)));
3522   }
3523
3524   if (const SCEVTruncateExpr *Trunc = dyn_cast<SCEVTruncateExpr>(S)) {
3525     ConstantRange X = getSignedRange(Trunc->getOperand());
3526     return setSignedRange(Trunc,
3527       ConservativeResult.intersectWith(X.truncate(BitWidth)));
3528   }
3529
3530   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(S)) {
3531     // If there's no signed wrap, and all the operands have the same sign or
3532     // zero, the value won't ever change sign.
3533     if (AddRec->getNoWrapFlags(SCEV::FlagNSW)) {
3534       bool AllNonNeg = true;
3535       bool AllNonPos = true;
3536       for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
3537         if (!isKnownNonNegative(AddRec->getOperand(i))) AllNonNeg = false;
3538         if (!isKnownNonPositive(AddRec->getOperand(i))) AllNonPos = false;
3539       }
3540       if (AllNonNeg)
3541         ConservativeResult = ConservativeResult.intersectWith(
3542           ConstantRange(APInt(BitWidth, 0),
3543                         APInt::getSignedMinValue(BitWidth)));
3544       else if (AllNonPos)
3545         ConservativeResult = ConservativeResult.intersectWith(
3546           ConstantRange(APInt::getSignedMinValue(BitWidth),
3547                         APInt(BitWidth, 1)));
3548     }
3549
3550     // TODO: non-affine addrec
3551     if (AddRec->isAffine()) {
3552       Type *Ty = AddRec->getType();
3553       const SCEV *MaxBECount = getMaxBackedgeTakenCount(AddRec->getLoop());
3554       if (!isa<SCEVCouldNotCompute>(MaxBECount) &&
3555           getTypeSizeInBits(MaxBECount->getType()) <= BitWidth) {
3556         MaxBECount = getNoopOrZeroExtend(MaxBECount, Ty);
3557
3558         const SCEV *Start = AddRec->getStart();
3559         const SCEV *Step = AddRec->getStepRecurrence(*this);
3560
3561         ConstantRange StartRange = getSignedRange(Start);
3562         ConstantRange StepRange = getSignedRange(Step);
3563         ConstantRange MaxBECountRange = getUnsignedRange(MaxBECount);
3564         ConstantRange EndRange =
3565           StartRange.add(MaxBECountRange.multiply(StepRange));
3566
3567         // Check for overflow. This must be done with ConstantRange arithmetic
3568         // because we could be called from within the ScalarEvolution overflow
3569         // checking code.
3570         ConstantRange ExtStartRange = StartRange.sextOrTrunc(BitWidth*2+1);
3571         ConstantRange ExtStepRange = StepRange.sextOrTrunc(BitWidth*2+1);
3572         ConstantRange ExtMaxBECountRange =
3573           MaxBECountRange.zextOrTrunc(BitWidth*2+1);
3574         ConstantRange ExtEndRange = EndRange.sextOrTrunc(BitWidth*2+1);
3575         if (ExtStartRange.add(ExtMaxBECountRange.multiply(ExtStepRange)) !=
3576             ExtEndRange)
3577           return setSignedRange(AddRec, ConservativeResult);
3578
3579         APInt Min = APIntOps::smin(StartRange.getSignedMin(),
3580                                    EndRange.getSignedMin());
3581         APInt Max = APIntOps::smax(StartRange.getSignedMax(),
3582                                    EndRange.getSignedMax());
3583         if (Min.isMinSignedValue() && Max.isMaxSignedValue())
3584           return setSignedRange(AddRec, ConservativeResult);
3585         return setSignedRange(AddRec,
3586           ConservativeResult.intersectWith(ConstantRange(Min, Max+1)));
3587       }
3588     }
3589
3590     return setSignedRange(AddRec, ConservativeResult);
3591   }
3592
3593   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
3594     // For a SCEVUnknown, ask ValueTracking.
3595     if (!U->getValue()->getType()->isIntegerTy() && !TD)
3596       return setSignedRange(U, ConservativeResult);
3597     unsigned NS = ComputeNumSignBits(U->getValue(), TD);
3598     if (NS <= 1)
3599       return setSignedRange(U, ConservativeResult);
3600     return setSignedRange(U, ConservativeResult.intersectWith(
3601       ConstantRange(APInt::getSignedMinValue(BitWidth).ashr(NS - 1),
3602                     APInt::getSignedMaxValue(BitWidth).ashr(NS - 1)+1)));
3603   }
3604
3605   return setSignedRange(S, ConservativeResult);
3606 }
3607
3608 /// createSCEV - We know that there is no SCEV for the specified value.
3609 /// Analyze the expression.
3610 ///
3611 const SCEV *ScalarEvolution::createSCEV(Value *V) {
3612   if (!isSCEVable(V->getType()))
3613     return getUnknown(V);
3614
3615   unsigned Opcode = Instruction::UserOp1;
3616   if (Instruction *I = dyn_cast<Instruction>(V)) {
3617     Opcode = I->getOpcode();
3618
3619     // Don't attempt to analyze instructions in blocks that aren't
3620     // reachable. Such instructions don't matter, and they aren't required
3621     // to obey basic rules for definitions dominating uses which this
3622     // analysis depends on.
3623     if (!DT->isReachableFromEntry(I->getParent()))
3624       return getUnknown(V);
3625   } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
3626     Opcode = CE->getOpcode();
3627   else if (ConstantInt *CI = dyn_cast<ConstantInt>(V))
3628     return getConstant(CI);
3629   else if (isa<ConstantPointerNull>(V))
3630     return getConstant(V->getType(), 0);
3631   else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V))
3632     return GA->mayBeOverridden() ? getUnknown(V) : getSCEV(GA->getAliasee());
3633   else
3634     return getUnknown(V);
3635
3636   Operator *U = cast<Operator>(V);
3637   switch (Opcode) {
3638   case Instruction::Add: {
3639     // The simple thing to do would be to just call getSCEV on both operands
3640     // and call getAddExpr with the result. However if we're looking at a
3641     // bunch of things all added together, this can be quite inefficient,
3642     // because it leads to N-1 getAddExpr calls for N ultimate operands.
3643     // Instead, gather up all the operands and make a single getAddExpr call.
3644     // LLVM IR canonical form means we need only traverse the left operands.
3645     //
3646     // Don't apply this instruction's NSW or NUW flags to the new
3647     // expression. The instruction may be guarded by control flow that the
3648     // no-wrap behavior depends on. Non-control-equivalent instructions can be
3649     // mapped to the same SCEV expression, and it would be incorrect to transfer
3650     // NSW/NUW semantics to those operations.
3651     SmallVector<const SCEV *, 4> AddOps;
3652     AddOps.push_back(getSCEV(U->getOperand(1)));
3653     for (Value *Op = U->getOperand(0); ; Op = U->getOperand(0)) {
3654       unsigned Opcode = Op->getValueID() - Value::InstructionVal;
3655       if (Opcode != Instruction::Add && Opcode != Instruction::Sub)
3656         break;
3657       U = cast<Operator>(Op);
3658       const SCEV *Op1 = getSCEV(U->getOperand(1));
3659       if (Opcode == Instruction::Sub)
3660         AddOps.push_back(getNegativeSCEV(Op1));
3661       else
3662         AddOps.push_back(Op1);
3663     }
3664     AddOps.push_back(getSCEV(U->getOperand(0)));
3665     return getAddExpr(AddOps);
3666   }
3667   case Instruction::Mul: {
3668     // Don't transfer NSW/NUW for the same reason as AddExpr.
3669     SmallVector<const SCEV *, 4> MulOps;
3670     MulOps.push_back(getSCEV(U->getOperand(1)));
3671     for (Value *Op = U->getOperand(0);
3672          Op->getValueID() == Instruction::Mul + Value::InstructionVal;
3673          Op = U->getOperand(0)) {
3674       U = cast<Operator>(Op);
3675       MulOps.push_back(getSCEV(U->getOperand(1)));
3676     }
3677     MulOps.push_back(getSCEV(U->getOperand(0)));
3678     return getMulExpr(MulOps);
3679   }
3680   case Instruction::UDiv:
3681     return getUDivExpr(getSCEV(U->getOperand(0)),
3682                        getSCEV(U->getOperand(1)));
3683   case Instruction::Sub:
3684     return getMinusSCEV(getSCEV(U->getOperand(0)),
3685                         getSCEV(U->getOperand(1)));
3686   case Instruction::And:
3687     // For an expression like x&255 that merely masks off the high bits,
3688     // use zext(trunc(x)) as the SCEV expression.
3689     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
3690       if (CI->isNullValue())
3691         return getSCEV(U->getOperand(1));
3692       if (CI->isAllOnesValue())
3693         return getSCEV(U->getOperand(0));
3694       const APInt &A = CI->getValue();
3695
3696       // Instcombine's ShrinkDemandedConstant may strip bits out of
3697       // constants, obscuring what would otherwise be a low-bits mask.
3698       // Use ComputeMaskedBits to compute what ShrinkDemandedConstant
3699       // knew about to reconstruct a low-bits mask value.
3700       unsigned LZ = A.countLeadingZeros();
3701       unsigned BitWidth = A.getBitWidth();
3702       APInt KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
3703       ComputeMaskedBits(U->getOperand(0), KnownZero, KnownOne, TD);
3704
3705       APInt EffectiveMask = APInt::getLowBitsSet(BitWidth, BitWidth - LZ);
3706
3707       if (LZ != 0 && !((~A & ~KnownZero) & EffectiveMask))
3708         return
3709           getZeroExtendExpr(getTruncateExpr(getSCEV(U->getOperand(0)),
3710                                 IntegerType::get(getContext(), BitWidth - LZ)),
3711                             U->getType());
3712     }
3713     break;
3714
3715   case Instruction::Or:
3716     // If the RHS of the Or is a constant, we may have something like:
3717     // X*4+1 which got turned into X*4|1.  Handle this as an Add so loop
3718     // optimizations will transparently handle this case.
3719     //
3720     // In order for this transformation to be safe, the LHS must be of the
3721     // form X*(2^n) and the Or constant must be less than 2^n.
3722     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
3723       const SCEV *LHS = getSCEV(U->getOperand(0));
3724       const APInt &CIVal = CI->getValue();
3725       if (GetMinTrailingZeros(LHS) >=
3726           (CIVal.getBitWidth() - CIVal.countLeadingZeros())) {
3727         // Build a plain add SCEV.
3728         const SCEV *S = getAddExpr(LHS, getSCEV(CI));
3729         // If the LHS of the add was an addrec and it has no-wrap flags,
3730         // transfer the no-wrap flags, since an or won't introduce a wrap.
3731         if (const SCEVAddRecExpr *NewAR = dyn_cast<SCEVAddRecExpr>(S)) {
3732           const SCEVAddRecExpr *OldAR = cast<SCEVAddRecExpr>(LHS);
3733           const_cast<SCEVAddRecExpr *>(NewAR)->setNoWrapFlags(
3734             OldAR->getNoWrapFlags());
3735         }
3736         return S;
3737       }
3738     }
3739     break;
3740   case Instruction::Xor:
3741     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1))) {
3742       // If the RHS of the xor is a signbit, then this is just an add.
3743       // Instcombine turns add of signbit into xor as a strength reduction step.
3744       if (CI->getValue().isSignBit())
3745         return getAddExpr(getSCEV(U->getOperand(0)),
3746                           getSCEV(U->getOperand(1)));
3747
3748       // If the RHS of xor is -1, then this is a not operation.
3749       if (CI->isAllOnesValue())
3750         return getNotSCEV(getSCEV(U->getOperand(0)));
3751
3752       // Model xor(and(x, C), C) as and(~x, C), if C is a low-bits mask.
3753       // This is a variant of the check for xor with -1, and it handles
3754       // the case where instcombine has trimmed non-demanded bits out
3755       // of an xor with -1.
3756       if (BinaryOperator *BO = dyn_cast<BinaryOperator>(U->getOperand(0)))
3757         if (ConstantInt *LCI = dyn_cast<ConstantInt>(BO->getOperand(1)))
3758           if (BO->getOpcode() == Instruction::And &&
3759               LCI->getValue() == CI->getValue())
3760             if (const SCEVZeroExtendExpr *Z =
3761                   dyn_cast<SCEVZeroExtendExpr>(getSCEV(U->getOperand(0)))) {
3762               Type *UTy = U->getType();
3763               const SCEV *Z0 = Z->getOperand();
3764               Type *Z0Ty = Z0->getType();
3765               unsigned Z0TySize = getTypeSizeInBits(Z0Ty);
3766
3767               // If C is a low-bits mask, the zero extend is serving to
3768               // mask off the high bits. Complement the operand and
3769               // re-apply the zext.
3770               if (APIntOps::isMask(Z0TySize, CI->getValue()))
3771                 return getZeroExtendExpr(getNotSCEV(Z0), UTy);
3772
3773               // If C is a single bit, it may be in the sign-bit position
3774               // before the zero-extend. In this case, represent the xor
3775               // using an add, which is equivalent, and re-apply the zext.
3776               APInt Trunc = CI->getValue().trunc(Z0TySize);
3777               if (Trunc.zext(getTypeSizeInBits(UTy)) == CI->getValue() &&
3778                   Trunc.isSignBit())
3779                 return getZeroExtendExpr(getAddExpr(Z0, getConstant(Trunc)),
3780                                          UTy);
3781             }
3782     }
3783     break;
3784
3785   case Instruction::Shl:
3786     // Turn shift left of a constant amount into a multiply.
3787     if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
3788       uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
3789
3790       // If the shift count is not less than the bitwidth, the result of
3791       // the shift is undefined. Don't try to analyze it, because the
3792       // resolution chosen here may differ from the resolution chosen in
3793       // other parts of the compiler.
3794       if (SA->getValue().uge(BitWidth))
3795         break;
3796
3797       Constant *X = ConstantInt::get(getContext(),
3798         APInt::getOneBitSet(BitWidth, SA->getZExtValue()));
3799       return getMulExpr(getSCEV(U->getOperand(0)), getSCEV(X));
3800     }
3801     break;
3802
3803   case Instruction::LShr:
3804     // Turn logical shift right of a constant into a unsigned divide.
3805     if (ConstantInt *SA = dyn_cast<ConstantInt>(U->getOperand(1))) {
3806       uint32_t BitWidth = cast<IntegerType>(U->getType())->getBitWidth();
3807
3808       // If the shift count is not less than the bitwidth, the result of
3809       // the shift is undefined. Don't try to analyze it, because the
3810       // resolution chosen here may differ from the resolution chosen in
3811       // other parts of the compiler.
3812       if (SA->getValue().uge(BitWidth))
3813         break;
3814
3815       Constant *X = ConstantInt::get(getContext(),
3816         APInt::getOneBitSet(BitWidth, SA->getZExtValue()));
3817       return getUDivExpr(getSCEV(U->getOperand(0)), getSCEV(X));
3818     }
3819     break;
3820
3821   case Instruction::AShr:
3822     // For a two-shift sext-inreg, use sext(trunc(x)) as the SCEV expression.
3823     if (ConstantInt *CI = dyn_cast<ConstantInt>(U->getOperand(1)))
3824       if (Operator *L = dyn_cast<Operator>(U->getOperand(0)))
3825         if (L->getOpcode() == Instruction::Shl &&
3826             L->getOperand(1) == U->getOperand(1)) {
3827           uint64_t BitWidth = getTypeSizeInBits(U->getType());
3828
3829           // If the shift count is not less than the bitwidth, the result of
3830           // the shift is undefined. Don't try to analyze it, because the
3831           // resolution chosen here may differ from the resolution chosen in
3832           // other parts of the compiler.
3833           if (CI->getValue().uge(BitWidth))
3834             break;
3835
3836           uint64_t Amt = BitWidth - CI->getZExtValue();
3837           if (Amt == BitWidth)
3838             return getSCEV(L->getOperand(0));       // shift by zero --> noop
3839           return
3840             getSignExtendExpr(getTruncateExpr(getSCEV(L->getOperand(0)),
3841                                               IntegerType::get(getContext(),
3842                                                                Amt)),
3843                               U->getType());
3844         }
3845     break;
3846
3847   case Instruction::Trunc:
3848     return getTruncateExpr(getSCEV(U->getOperand(0)), U->getType());
3849
3850   case Instruction::ZExt:
3851     return getZeroExtendExpr(getSCEV(U->getOperand(0)), U->getType());
3852
3853   case Instruction::SExt:
3854     return getSignExtendExpr(getSCEV(U->getOperand(0)), U->getType());
3855
3856   case Instruction::BitCast:
3857     // BitCasts are no-op casts so we just eliminate the cast.
3858     if (isSCEVable(U->getType()) && isSCEVable(U->getOperand(0)->getType()))
3859       return getSCEV(U->getOperand(0));
3860     break;
3861
3862   // It's tempting to handle inttoptr and ptrtoint as no-ops, however this can
3863   // lead to pointer expressions which cannot safely be expanded to GEPs,
3864   // because ScalarEvolution doesn't respect the GEP aliasing rules when
3865   // simplifying integer expressions.
3866
3867   case Instruction::GetElementPtr:
3868     return createNodeForGEP(cast<GEPOperator>(U));
3869
3870   case Instruction::PHI:
3871     return createNodeForPHI(cast<PHINode>(U));
3872
3873   case Instruction::Select:
3874     // This could be a smax or umax that was lowered earlier.
3875     // Try to recover it.
3876     if (ICmpInst *ICI = dyn_cast<ICmpInst>(U->getOperand(0))) {
3877       Value *LHS = ICI->getOperand(0);
3878       Value *RHS = ICI->getOperand(1);
3879       switch (ICI->getPredicate()) {
3880       case ICmpInst::ICMP_SLT:
3881       case ICmpInst::ICMP_SLE:
3882         std::swap(LHS, RHS);
3883         // fall through
3884       case ICmpInst::ICMP_SGT:
3885       case ICmpInst::ICMP_SGE:
3886         // a >s b ? a+x : b+x  ->  smax(a, b)+x
3887         // a >s b ? b+x : a+x  ->  smin(a, b)+x
3888         if (LHS->getType() == U->getType()) {
3889           const SCEV *LS = getSCEV(LHS);
3890           const SCEV *RS = getSCEV(RHS);
3891           const SCEV *LA = getSCEV(U->getOperand(1));
3892           const SCEV *RA = getSCEV(U->getOperand(2));
3893           const SCEV *LDiff = getMinusSCEV(LA, LS);
3894           const SCEV *RDiff = getMinusSCEV(RA, RS);
3895           if (LDiff == RDiff)
3896             return getAddExpr(getSMaxExpr(LS, RS), LDiff);
3897           LDiff = getMinusSCEV(LA, RS);
3898           RDiff = getMinusSCEV(RA, LS);
3899           if (LDiff == RDiff)
3900             return getAddExpr(getSMinExpr(LS, RS), LDiff);
3901         }
3902         break;
3903       case ICmpInst::ICMP_ULT:
3904       case ICmpInst::ICMP_ULE:
3905         std::swap(LHS, RHS);
3906         // fall through
3907       case ICmpInst::ICMP_UGT:
3908       case ICmpInst::ICMP_UGE:
3909         // a >u b ? a+x : b+x  ->  umax(a, b)+x
3910         // a >u b ? b+x : a+x  ->  umin(a, b)+x
3911         if (LHS->getType() == U->getType()) {
3912           const SCEV *LS = getSCEV(LHS);
3913           const SCEV *RS = getSCEV(RHS);
3914           const SCEV *LA = getSCEV(U->getOperand(1));
3915           const SCEV *RA = getSCEV(U->getOperand(2));
3916           const SCEV *LDiff = getMinusSCEV(LA, LS);
3917           const SCEV *RDiff = getMinusSCEV(RA, RS);
3918           if (LDiff == RDiff)
3919             return getAddExpr(getUMaxExpr(LS, RS), LDiff);
3920           LDiff = getMinusSCEV(LA, RS);
3921           RDiff = getMinusSCEV(RA, LS);
3922           if (LDiff == RDiff)
3923             return getAddExpr(getUMinExpr(LS, RS), LDiff);
3924         }
3925         break;
3926       case ICmpInst::ICMP_NE:
3927         // n != 0 ? n+x : 1+x  ->  umax(n, 1)+x
3928         if (LHS->getType() == U->getType() &&
3929             isa<ConstantInt>(RHS) &&
3930             cast<ConstantInt>(RHS)->isZero()) {
3931           const SCEV *One = getConstant(LHS->getType(), 1);
3932           const SCEV *LS = getSCEV(LHS);
3933           const SCEV *LA = getSCEV(U->getOperand(1));
3934           const SCEV *RA = getSCEV(U->getOperand(2));
3935           const SCEV *LDiff = getMinusSCEV(LA, LS);
3936           const SCEV *RDiff = getMinusSCEV(RA, One);
3937           if (LDiff == RDiff)
3938             return getAddExpr(getUMaxExpr(One, LS), LDiff);
3939         }
3940         break;
3941       case ICmpInst::ICMP_EQ:
3942         // n == 0 ? 1+x : n+x  ->  umax(n, 1)+x
3943         if (LHS->getType() == U->getType() &&
3944             isa<ConstantInt>(RHS) &&
3945             cast<ConstantInt>(RHS)->isZero()) {
3946           const SCEV *One = getConstant(LHS->getType(), 1);
3947           const SCEV *LS = getSCEV(LHS);
3948           const SCEV *LA = getSCEV(U->getOperand(1));
3949           const SCEV *RA = getSCEV(U->getOperand(2));
3950           const SCEV *LDiff = getMinusSCEV(LA, One);
3951           const SCEV *RDiff = getMinusSCEV(RA, LS);
3952           if (LDiff == RDiff)
3953             return getAddExpr(getUMaxExpr(One, LS), LDiff);
3954         }
3955         break;
3956       default:
3957         break;
3958       }
3959     }
3960
3961   default: // We cannot analyze this expression.
3962     break;
3963   }
3964
3965   return getUnknown(V);
3966 }
3967
3968
3969
3970 //===----------------------------------------------------------------------===//
3971 //                   Iteration Count Computation Code
3972 //
3973
3974 /// getSmallConstantTripCount - Returns the maximum trip count of this loop as a
3975 /// normal unsigned value. Returns 0 if the trip count is unknown or not
3976 /// constant. Will also return 0 if the maximum trip count is very large (>=
3977 /// 2^32).
3978 ///
3979 /// This "trip count" assumes that control exits via ExitingBlock. More
3980 /// precisely, it is the number of times that control may reach ExitingBlock
3981 /// before taking the branch. For loops with multiple exits, it may not be the
3982 /// number times that the loop header executes because the loop may exit
3983 /// prematurely via another branch.
3984 ///
3985 /// FIXME: We conservatively call getBackedgeTakenCount(L) instead of
3986 /// getExitCount(L, ExitingBlock) to compute a safe trip count considering all
3987 /// loop exits. getExitCount() may return an exact count for this branch
3988 /// assuming no-signed-wrap. The number of well-defined iterations may actually
3989 /// be higher than this trip count if this exit test is skipped and the loop
3990 /// exits via a different branch. Ideally, getExitCount() would know whether it
3991 /// depends on a NSW assumption, and we would only fall back to a conservative
3992 /// trip count in that case.
3993 unsigned ScalarEvolution::
3994 getSmallConstantTripCount(Loop *L, BasicBlock * /*ExitingBlock*/) {
3995   const SCEVConstant *ExitCount =
3996     dyn_cast<SCEVConstant>(getBackedgeTakenCount(L));
3997   if (!ExitCount)
3998     return 0;
3999
4000   ConstantInt *ExitConst = ExitCount->getValue();
4001
4002   // Guard against huge trip counts.
4003   if (ExitConst->getValue().getActiveBits() > 32)
4004     return 0;
4005
4006   // In case of integer overflow, this returns 0, which is correct.
4007   return ((unsigned)ExitConst->getZExtValue()) + 1;
4008 }
4009
4010 /// getSmallConstantTripMultiple - Returns the largest constant divisor of the
4011 /// trip count of this loop as a normal unsigned value, if possible. This
4012 /// means that the actual trip count is always a multiple of the returned
4013 /// value (don't forget the trip count could very well be zero as well!).
4014 ///
4015 /// Returns 1 if the trip count is unknown or not guaranteed to be the
4016 /// multiple of a constant (which is also the case if the trip count is simply
4017 /// constant, use getSmallConstantTripCount for that case), Will also return 1
4018 /// if the trip count is very large (>= 2^32).
4019 ///
4020 /// As explained in the comments for getSmallConstantTripCount, this assumes
4021 /// that control exits the loop via ExitingBlock.
4022 unsigned ScalarEvolution::
4023 getSmallConstantTripMultiple(Loop *L, BasicBlock * /*ExitingBlock*/) {
4024   const SCEV *ExitCount = getBackedgeTakenCount(L);
4025   if (ExitCount == getCouldNotCompute())
4026     return 1;
4027
4028   // Get the trip count from the BE count by adding 1.
4029   const SCEV *TCMul = getAddExpr(ExitCount,
4030                                  getConstant(ExitCount->getType(), 1));
4031   // FIXME: SCEV distributes multiplication as V1*C1 + V2*C1. We could attempt
4032   // to factor simple cases.
4033   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(TCMul))
4034     TCMul = Mul->getOperand(0);
4035
4036   const SCEVConstant *MulC = dyn_cast<SCEVConstant>(TCMul);
4037   if (!MulC)
4038     return 1;
4039
4040   ConstantInt *Result = MulC->getValue();
4041
4042   // Guard against huge trip counts (this requires checking
4043   // for zero to handle the case where the trip count == -1 and the
4044   // addition wraps).
4045   if (!Result || Result->getValue().getActiveBits() > 32 ||
4046       Result->getValue().getActiveBits() == 0)
4047     return 1;
4048
4049   return (unsigned)Result->getZExtValue();
4050 }
4051
4052 // getExitCount - Get the expression for the number of loop iterations for which
4053 // this loop is guaranteed not to exit via ExitingBlock. Otherwise return
4054 // SCEVCouldNotCompute.
4055 const SCEV *ScalarEvolution::getExitCount(Loop *L, BasicBlock *ExitingBlock) {
4056   return getBackedgeTakenInfo(L).getExact(ExitingBlock, this);
4057 }
4058
4059 /// getBackedgeTakenCount - If the specified loop has a predictable
4060 /// backedge-taken count, return it, otherwise return a SCEVCouldNotCompute
4061 /// object. The backedge-taken count is the number of times the loop header
4062 /// will be branched to from within the loop. This is one less than the
4063 /// trip count of the loop, since it doesn't count the first iteration,
4064 /// when the header is branched to from outside the loop.
4065 ///
4066 /// Note that it is not valid to call this method on a loop without a
4067 /// loop-invariant backedge-taken count (see
4068 /// hasLoopInvariantBackedgeTakenCount).
4069 ///
4070 const SCEV *ScalarEvolution::getBackedgeTakenCount(const Loop *L) {
4071   return getBackedgeTakenInfo(L).getExact(this);
4072 }
4073
4074 /// getMaxBackedgeTakenCount - Similar to getBackedgeTakenCount, except
4075 /// return the least SCEV value that is known never to be less than the
4076 /// actual backedge taken count.
4077 const SCEV *ScalarEvolution::getMaxBackedgeTakenCount(const Loop *L) {
4078   return getBackedgeTakenInfo(L).getMax(this);
4079 }
4080
4081 /// PushLoopPHIs - Push PHI nodes in the header of the given loop
4082 /// onto the given Worklist.
4083 static void
4084 PushLoopPHIs(const Loop *L, SmallVectorImpl<Instruction *> &Worklist) {
4085   BasicBlock *Header = L->getHeader();
4086
4087   // Push all Loop-header PHIs onto the Worklist stack.
4088   for (BasicBlock::iterator I = Header->begin();
4089        PHINode *PN = dyn_cast<PHINode>(I); ++I)
4090     Worklist.push_back(PN);
4091 }
4092
4093 const ScalarEvolution::BackedgeTakenInfo &
4094 ScalarEvolution::getBackedgeTakenInfo(const Loop *L) {
4095   // Initially insert an invalid entry for this loop. If the insertion
4096   // succeeds, proceed to actually compute a backedge-taken count and
4097   // update the value. The temporary CouldNotCompute value tells SCEV
4098   // code elsewhere that it shouldn't attempt to request a new
4099   // backedge-taken count, which could result in infinite recursion.
4100   std::pair<DenseMap<const Loop *, BackedgeTakenInfo>::iterator, bool> Pair =
4101     BackedgeTakenCounts.insert(std::make_pair(L, BackedgeTakenInfo()));
4102   if (!Pair.second)
4103     return Pair.first->second;
4104
4105   // ComputeBackedgeTakenCount may allocate memory for its result. Inserting it
4106   // into the BackedgeTakenCounts map transfers ownership. Otherwise, the result
4107   // must be cleared in this scope.
4108   BackedgeTakenInfo Result = ComputeBackedgeTakenCount(L);
4109
4110   if (Result.getExact(this) != getCouldNotCompute()) {
4111     assert(isLoopInvariant(Result.getExact(this), L) &&
4112            isLoopInvariant(Result.getMax(this), L) &&
4113            "Computed backedge-taken count isn't loop invariant for loop!");
4114     ++NumTripCountsComputed;
4115   }
4116   else if (Result.getMax(this) == getCouldNotCompute() &&
4117            isa<PHINode>(L->getHeader()->begin())) {
4118     // Only count loops that have phi nodes as not being computable.
4119     ++NumTripCountsNotComputed;
4120   }
4121
4122   // Now that we know more about the trip count for this loop, forget any
4123   // existing SCEV values for PHI nodes in this loop since they are only
4124   // conservative estimates made without the benefit of trip count
4125   // information. This is similar to the code in forgetLoop, except that
4126   // it handles SCEVUnknown PHI nodes specially.
4127   if (Result.hasAnyInfo()) {
4128     SmallVector<Instruction *, 16> Worklist;
4129     PushLoopPHIs(L, Worklist);
4130
4131     SmallPtrSet<Instruction *, 8> Visited;
4132     while (!Worklist.empty()) {
4133       Instruction *I = Worklist.pop_back_val();
4134       if (!Visited.insert(I)) continue;
4135
4136       ValueExprMapType::iterator It =
4137         ValueExprMap.find_as(static_cast<Value *>(I));
4138       if (It != ValueExprMap.end()) {
4139         const SCEV *Old = It->second;
4140
4141         // SCEVUnknown for a PHI either means that it has an unrecognized
4142         // structure, or it's a PHI that's in the progress of being computed
4143         // by createNodeForPHI.  In the former case, additional loop trip
4144         // count information isn't going to change anything. In the later
4145         // case, createNodeForPHI will perform the necessary updates on its
4146         // own when it gets to that point.
4147         if (!isa<PHINode>(I) || !isa<SCEVUnknown>(Old)) {
4148           forgetMemoizedResults(Old);
4149           ValueExprMap.erase(It);
4150         }
4151         if (PHINode *PN = dyn_cast<PHINode>(I))
4152           ConstantEvolutionLoopExitValue.erase(PN);
4153       }
4154
4155       PushDefUseChildren(I, Worklist);
4156     }
4157   }
4158
4159   // Re-lookup the insert position, since the call to
4160   // ComputeBackedgeTakenCount above could result in a
4161   // recusive call to getBackedgeTakenInfo (on a different
4162   // loop), which would invalidate the iterator computed
4163   // earlier.
4164   return BackedgeTakenCounts.find(L)->second = Result;
4165 }
4166
4167 /// forgetLoop - This method should be called by the client when it has
4168 /// changed a loop in a way that may effect ScalarEvolution's ability to
4169 /// compute a trip count, or if the loop is deleted.
4170 void ScalarEvolution::forgetLoop(const Loop *L) {
4171   // Drop any stored trip count value.
4172   DenseMap<const Loop*, BackedgeTakenInfo>::iterator BTCPos =
4173     BackedgeTakenCounts.find(L);
4174   if (BTCPos != BackedgeTakenCounts.end()) {
4175     BTCPos->second.clear();
4176     BackedgeTakenCounts.erase(BTCPos);
4177   }
4178
4179   // Drop information about expressions based on loop-header PHIs.
4180   SmallVector<Instruction *, 16> Worklist;
4181   PushLoopPHIs(L, Worklist);
4182
4183   SmallPtrSet<Instruction *, 8> Visited;
4184   while (!Worklist.empty()) {
4185     Instruction *I = Worklist.pop_back_val();
4186     if (!Visited.insert(I)) continue;
4187
4188     ValueExprMapType::iterator It =
4189       ValueExprMap.find_as(static_cast<Value *>(I));
4190     if (It != ValueExprMap.end()) {
4191       forgetMemoizedResults(It->second);
4192       ValueExprMap.erase(It);
4193       if (PHINode *PN = dyn_cast<PHINode>(I))
4194         ConstantEvolutionLoopExitValue.erase(PN);
4195     }
4196
4197     PushDefUseChildren(I, Worklist);
4198   }
4199
4200   // Forget all contained loops too, to avoid dangling entries in the
4201   // ValuesAtScopes map.
4202   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
4203     forgetLoop(*I);
4204 }
4205
4206 /// forgetValue - This method should be called by the client when it has
4207 /// changed a value in a way that may effect its value, or which may
4208 /// disconnect it from a def-use chain linking it to a loop.
4209 void ScalarEvolution::forgetValue(Value *V) {
4210   Instruction *I = dyn_cast<Instruction>(V);
4211   if (!I) return;
4212
4213   // Drop information about expressions based on loop-header PHIs.
4214   SmallVector<Instruction *, 16> Worklist;
4215   Worklist.push_back(I);
4216
4217   SmallPtrSet<Instruction *, 8> Visited;
4218   while (!Worklist.empty()) {
4219     I = Worklist.pop_back_val();
4220     if (!Visited.insert(I)) continue;
4221
4222     ValueExprMapType::iterator It =
4223       ValueExprMap.find_as(static_cast<Value *>(I));
4224     if (It != ValueExprMap.end()) {
4225       forgetMemoizedResults(It->second);
4226       ValueExprMap.erase(It);
4227       if (PHINode *PN = dyn_cast<PHINode>(I))
4228         ConstantEvolutionLoopExitValue.erase(PN);
4229     }
4230
4231     PushDefUseChildren(I, Worklist);
4232   }
4233 }
4234
4235 /// getExact - Get the exact loop backedge taken count considering all loop
4236 /// exits. A computable result can only be return for loops with a single exit.
4237 /// Returning the minimum taken count among all exits is incorrect because one
4238 /// of the loop's exit limit's may have been skipped. HowFarToZero assumes that
4239 /// the limit of each loop test is never skipped. This is a valid assumption as
4240 /// long as the loop exits via that test. For precise results, it is the
4241 /// caller's responsibility to specify the relevant loop exit using
4242 /// getExact(ExitingBlock, SE).
4243 const SCEV *
4244 ScalarEvolution::BackedgeTakenInfo::getExact(ScalarEvolution *SE) const {
4245   // If any exits were not computable, the loop is not computable.
4246   if (!ExitNotTaken.isCompleteList()) return SE->getCouldNotCompute();
4247
4248   // We need exactly one computable exit.
4249   if (!ExitNotTaken.ExitingBlock) return SE->getCouldNotCompute();
4250   assert(ExitNotTaken.ExactNotTaken && "uninitialized not-taken info");
4251
4252   const SCEV *BECount = 0;
4253   for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
4254        ENT != 0; ENT = ENT->getNextExit()) {
4255
4256     assert(ENT->ExactNotTaken != SE->getCouldNotCompute() && "bad exit SCEV");
4257
4258     if (!BECount)
4259       BECount = ENT->ExactNotTaken;
4260     else if (BECount != ENT->ExactNotTaken)
4261       return SE->getCouldNotCompute();
4262   }
4263   assert(BECount && "Invalid not taken count for loop exit");
4264   return BECount;
4265 }
4266
4267 /// getExact - Get the exact not taken count for this loop exit.
4268 const SCEV *
4269 ScalarEvolution::BackedgeTakenInfo::getExact(BasicBlock *ExitingBlock,
4270                                              ScalarEvolution *SE) const {
4271   for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
4272        ENT != 0; ENT = ENT->getNextExit()) {
4273
4274     if (ENT->ExitingBlock == ExitingBlock)
4275       return ENT->ExactNotTaken;
4276   }
4277   return SE->getCouldNotCompute();
4278 }
4279
4280 /// getMax - Get the max backedge taken count for the loop.
4281 const SCEV *
4282 ScalarEvolution::BackedgeTakenInfo::getMax(ScalarEvolution *SE) const {
4283   return Max ? Max : SE->getCouldNotCompute();
4284 }
4285
4286 bool ScalarEvolution::BackedgeTakenInfo::hasOperand(const SCEV *S,
4287                                                     ScalarEvolution *SE) const {
4288   if (Max && Max != SE->getCouldNotCompute() && SE->hasOperand(Max, S))
4289     return true;
4290
4291   if (!ExitNotTaken.ExitingBlock)
4292     return false;
4293
4294   for (const ExitNotTakenInfo *ENT = &ExitNotTaken;
4295        ENT != 0; ENT = ENT->getNextExit()) {
4296
4297     if (ENT->ExactNotTaken != SE->getCouldNotCompute()
4298         && SE->hasOperand(ENT->ExactNotTaken, S)) {
4299       return true;
4300     }
4301   }
4302   return false;
4303 }
4304
4305 /// Allocate memory for BackedgeTakenInfo and copy the not-taken count of each
4306 /// computable exit into a persistent ExitNotTakenInfo array.
4307 ScalarEvolution::BackedgeTakenInfo::BackedgeTakenInfo(
4308   SmallVectorImpl< std::pair<BasicBlock *, const SCEV *> > &ExitCounts,
4309   bool Complete, const SCEV *MaxCount) : Max(MaxCount) {
4310
4311   if (!Complete)
4312     ExitNotTaken.setIncomplete();
4313
4314   unsigned NumExits = ExitCounts.size();
4315   if (NumExits == 0) return;
4316
4317   ExitNotTaken.ExitingBlock = ExitCounts[0].first;
4318   ExitNotTaken.ExactNotTaken = ExitCounts[0].second;
4319   if (NumExits == 1) return;
4320
4321   // Handle the rare case of multiple computable exits.
4322   ExitNotTakenInfo *ENT = new ExitNotTakenInfo[NumExits-1];
4323
4324   ExitNotTakenInfo *PrevENT = &ExitNotTaken;
4325   for (unsigned i = 1; i < NumExits; ++i, PrevENT = ENT, ++ENT) {
4326     PrevENT->setNextExit(ENT);
4327     ENT->ExitingBlock = ExitCounts[i].first;
4328     ENT->ExactNotTaken = ExitCounts[i].second;
4329   }
4330 }
4331
4332 /// clear - Invalidate this result and free the ExitNotTakenInfo array.
4333 void ScalarEvolution::BackedgeTakenInfo::clear() {
4334   ExitNotTaken.ExitingBlock = 0;
4335   ExitNotTaken.ExactNotTaken = 0;
4336   delete[] ExitNotTaken.getNextExit();
4337 }
4338
4339 /// ComputeBackedgeTakenCount - Compute the number of times the backedge
4340 /// of the specified loop will execute.
4341 ScalarEvolution::BackedgeTakenInfo
4342 ScalarEvolution::ComputeBackedgeTakenCount(const Loop *L) {
4343   SmallVector<BasicBlock *, 8> ExitingBlocks;
4344   L->getExitingBlocks(ExitingBlocks);
4345
4346   // Examine all exits and pick the most conservative values.
4347   const SCEV *MaxBECount = getCouldNotCompute();
4348   bool CouldComputeBECount = true;
4349   SmallVector<std::pair<BasicBlock *, const SCEV *>, 4> ExitCounts;
4350   for (unsigned i = 0, e = ExitingBlocks.size(); i != e; ++i) {
4351     ExitLimit EL = ComputeExitLimit(L, ExitingBlocks[i]);
4352     if (EL.Exact == getCouldNotCompute())
4353       // We couldn't compute an exact value for this exit, so
4354       // we won't be able to compute an exact value for the loop.
4355       CouldComputeBECount = false;
4356     else
4357       ExitCounts.push_back(std::make_pair(ExitingBlocks[i], EL.Exact));
4358
4359     if (MaxBECount == getCouldNotCompute())
4360       MaxBECount = EL.Max;
4361     else if (EL.Max != getCouldNotCompute()) {
4362       // We cannot take the "min" MaxBECount, because non-unit stride loops may
4363       // skip some loop tests. Taking the max over the exits is sufficiently
4364       // conservative.  TODO: We could do better taking into consideration
4365       // that (1) the loop has unit stride (2) the last loop test is
4366       // less-than/greater-than (3) any loop test is less-than/greater-than AND
4367       // falls-through some constant times less then the other tests.
4368       MaxBECount = getUMaxFromMismatchedTypes(MaxBECount, EL.Max);
4369     }
4370   }
4371
4372   return BackedgeTakenInfo(ExitCounts, CouldComputeBECount, MaxBECount);
4373 }
4374
4375 /// ComputeExitLimit - Compute the number of times the backedge of the specified
4376 /// loop will execute if it exits via the specified block.
4377 ScalarEvolution::ExitLimit
4378 ScalarEvolution::ComputeExitLimit(const Loop *L, BasicBlock *ExitingBlock) {
4379
4380   // Okay, we've chosen an exiting block.  See what condition causes us to
4381   // exit at this block.
4382   //
4383   // FIXME: we should be able to handle switch instructions (with a single exit)
4384   BranchInst *ExitBr = dyn_cast<BranchInst>(ExitingBlock->getTerminator());
4385   if (ExitBr == 0) return getCouldNotCompute();
4386   assert(ExitBr->isConditional() && "If unconditional, it can't be in loop!");
4387
4388   // At this point, we know we have a conditional branch that determines whether
4389   // the loop is exited.  However, we don't know if the branch is executed each
4390   // time through the loop.  If not, then the execution count of the branch will
4391   // not be equal to the trip count of the loop.
4392   //
4393   // Currently we check for this by checking to see if the Exit branch goes to
4394   // the loop header.  If so, we know it will always execute the same number of
4395   // times as the loop.  We also handle the case where the exit block *is* the
4396   // loop header.  This is common for un-rotated loops.
4397   //
4398   // If both of those tests fail, walk up the unique predecessor chain to the
4399   // header, stopping if there is an edge that doesn't exit the loop. If the
4400   // header is reached, the execution count of the branch will be equal to the
4401   // trip count of the loop.
4402   //
4403   //  More extensive analysis could be done to handle more cases here.
4404   //
4405   if (ExitBr->getSuccessor(0) != L->getHeader() &&
4406       ExitBr->getSuccessor(1) != L->getHeader() &&
4407       ExitBr->getParent() != L->getHeader()) {
4408     // The simple checks failed, try climbing the unique predecessor chain
4409     // up to the header.
4410     bool Ok = false;
4411     for (BasicBlock *BB = ExitBr->getParent(); BB; ) {
4412       BasicBlock *Pred = BB->getUniquePredecessor();
4413       if (!Pred)
4414         return getCouldNotCompute();
4415       TerminatorInst *PredTerm = Pred->getTerminator();
4416       for (unsigned i = 0, e = PredTerm->getNumSuccessors(); i != e; ++i) {
4417         BasicBlock *PredSucc = PredTerm->getSuccessor(i);
4418         if (PredSucc == BB)
4419           continue;
4420         // If the predecessor has a successor that isn't BB and isn't
4421         // outside the loop, assume the worst.
4422         if (L->contains(PredSucc))
4423           return getCouldNotCompute();
4424       }
4425       if (Pred == L->getHeader()) {
4426         Ok = true;
4427         break;
4428       }
4429       BB = Pred;
4430     }
4431     if (!Ok)
4432       return getCouldNotCompute();
4433   }
4434
4435   // Proceed to the next level to examine the exit condition expression.
4436   return ComputeExitLimitFromCond(L, ExitBr->getCondition(),
4437                                   ExitBr->getSuccessor(0),
4438                                   ExitBr->getSuccessor(1),
4439                                   /*IsSubExpr=*/false);
4440 }
4441
4442 /// ComputeExitLimitFromCond - Compute the number of times the
4443 /// backedge of the specified loop will execute if its exit condition
4444 /// were a conditional branch of ExitCond, TBB, and FBB.
4445 ///
4446 /// @param IsSubExpr is true if ExitCond does not directly control the exit
4447 /// branch. In this case, we cannot assume that the loop only exits when the
4448 /// condition is true and cannot infer that failing to meet the condition prior
4449 /// to integer wraparound results in undefined behavior.
4450 ScalarEvolution::ExitLimit
4451 ScalarEvolution::ComputeExitLimitFromCond(const Loop *L,
4452                                           Value *ExitCond,
4453                                           BasicBlock *TBB,
4454                                           BasicBlock *FBB,
4455                                           bool IsSubExpr) {
4456   // Check if the controlling expression for this loop is an And or Or.
4457   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(ExitCond)) {
4458     if (BO->getOpcode() == Instruction::And) {
4459       // Recurse on the operands of the and.
4460       bool EitherMayExit = L->contains(TBB);
4461       ExitLimit EL0 = ComputeExitLimitFromCond(L, BO->getOperand(0), TBB, FBB,
4462                                                IsSubExpr || EitherMayExit);
4463       ExitLimit EL1 = ComputeExitLimitFromCond(L, BO->getOperand(1), TBB, FBB,
4464                                                IsSubExpr || EitherMayExit);
4465       const SCEV *BECount = getCouldNotCompute();
4466       const SCEV *MaxBECount = getCouldNotCompute();
4467       if (EitherMayExit) {
4468         // Both conditions must be true for the loop to continue executing.
4469         // Choose the less conservative count.
4470         if (EL0.Exact == getCouldNotCompute() ||
4471             EL1.Exact == getCouldNotCompute())
4472           BECount = getCouldNotCompute();
4473         else
4474           BECount = getUMinFromMismatchedTypes(EL0.Exact, EL1.Exact);
4475         if (EL0.Max == getCouldNotCompute())
4476           MaxBECount = EL1.Max;
4477         else if (EL1.Max == getCouldNotCompute())
4478           MaxBECount = EL0.Max;
4479         else
4480           MaxBECount = getUMinFromMismatchedTypes(EL0.Max, EL1.Max);
4481       } else {
4482         // Both conditions must be true at the same time for the loop to exit.
4483         // For now, be conservative.
4484         assert(L->contains(FBB) && "Loop block has no successor in loop!");
4485         if (EL0.Max == EL1.Max)
4486           MaxBECount = EL0.Max;
4487         if (EL0.Exact == EL1.Exact)
4488           BECount = EL0.Exact;
4489       }
4490
4491       return ExitLimit(BECount, MaxBECount);
4492     }
4493     if (BO->getOpcode() == Instruction::Or) {
4494       // Recurse on the operands of the or.
4495       bool EitherMayExit = L->contains(FBB);
4496       ExitLimit EL0 = ComputeExitLimitFromCond(L, BO->getOperand(0), TBB, FBB,
4497                                                IsSubExpr || EitherMayExit);
4498       ExitLimit EL1 = ComputeExitLimitFromCond(L, BO->getOperand(1), TBB, FBB,
4499                                                IsSubExpr || EitherMayExit);
4500       const SCEV *BECount = getCouldNotCompute();
4501       const SCEV *MaxBECount = getCouldNotCompute();
4502       if (EitherMayExit) {
4503         // Both conditions must be false for the loop to continue executing.
4504         // Choose the less conservative count.
4505         if (EL0.Exact == getCouldNotCompute() ||
4506             EL1.Exact == getCouldNotCompute())
4507           BECount = getCouldNotCompute();
4508         else
4509           BECount = getUMinFromMismatchedTypes(EL0.Exact, EL1.Exact);
4510         if (EL0.Max == getCouldNotCompute())
4511           MaxBECount = EL1.Max;
4512         else if (EL1.Max == getCouldNotCompute())
4513           MaxBECount = EL0.Max;
4514         else
4515           MaxBECount = getUMinFromMismatchedTypes(EL0.Max, EL1.Max);
4516       } else {
4517         // Both conditions must be false at the same time for the loop to exit.
4518         // For now, be conservative.
4519         assert(L->contains(TBB) && "Loop block has no successor in loop!");
4520         if (EL0.Max == EL1.Max)
4521           MaxBECount = EL0.Max;
4522         if (EL0.Exact == EL1.Exact)
4523           BECount = EL0.Exact;
4524       }
4525
4526       return ExitLimit(BECount, MaxBECount);
4527     }
4528   }
4529
4530   // With an icmp, it may be feasible to compute an exact backedge-taken count.
4531   // Proceed to the next level to examine the icmp.
4532   if (ICmpInst *ExitCondICmp = dyn_cast<ICmpInst>(ExitCond))
4533     return ComputeExitLimitFromICmp(L, ExitCondICmp, TBB, FBB, IsSubExpr);
4534
4535   // Check for a constant condition. These are normally stripped out by
4536   // SimplifyCFG, but ScalarEvolution may be used by a pass which wishes to
4537   // preserve the CFG and is temporarily leaving constant conditions
4538   // in place.
4539   if (ConstantInt *CI = dyn_cast<ConstantInt>(ExitCond)) {
4540     if (L->contains(FBB) == !CI->getZExtValue())
4541       // The backedge is always taken.
4542       return getCouldNotCompute();
4543     else
4544       // The backedge is never taken.
4545       return getConstant(CI->getType(), 0);
4546   }
4547
4548   // If it's not an integer or pointer comparison then compute it the hard way.
4549   return ComputeExitCountExhaustively(L, ExitCond, !L->contains(TBB));
4550 }
4551
4552 /// ComputeExitLimitFromICmp - Compute the number of times the
4553 /// backedge of the specified loop will execute if its exit condition
4554 /// were a conditional branch of the ICmpInst ExitCond, TBB, and FBB.
4555 ScalarEvolution::ExitLimit
4556 ScalarEvolution::ComputeExitLimitFromICmp(const Loop *L,
4557                                           ICmpInst *ExitCond,
4558                                           BasicBlock *TBB,
4559                                           BasicBlock *FBB,
4560                                           bool IsSubExpr) {
4561
4562   // If the condition was exit on true, convert the condition to exit on false
4563   ICmpInst::Predicate Cond;
4564   if (!L->contains(FBB))
4565     Cond = ExitCond->getPredicate();
4566   else
4567     Cond = ExitCond->getInversePredicate();
4568
4569   // Handle common loops like: for (X = "string"; *X; ++X)
4570   if (LoadInst *LI = dyn_cast<LoadInst>(ExitCond->getOperand(0)))
4571     if (Constant *RHS = dyn_cast<Constant>(ExitCond->getOperand(1))) {
4572       ExitLimit ItCnt =
4573         ComputeLoadConstantCompareExitLimit(LI, RHS, L, Cond);
4574       if (ItCnt.hasAnyInfo())
4575         return ItCnt;
4576     }
4577
4578   const SCEV *LHS = getSCEV(ExitCond->getOperand(0));
4579   const SCEV *RHS = getSCEV(ExitCond->getOperand(1));
4580
4581   // Try to evaluate any dependencies out of the loop.
4582   LHS = getSCEVAtScope(LHS, L);
4583   RHS = getSCEVAtScope(RHS, L);
4584
4585   // At this point, we would like to compute how many iterations of the
4586   // loop the predicate will return true for these inputs.
4587   if (isLoopInvariant(LHS, L) && !isLoopInvariant(RHS, L)) {
4588     // If there is a loop-invariant, force it into the RHS.
4589     std::swap(LHS, RHS);
4590     Cond = ICmpInst::getSwappedPredicate(Cond);
4591   }
4592
4593   // Simplify the operands before analyzing them.
4594   (void)SimplifyICmpOperands(Cond, LHS, RHS);
4595
4596   // If we have a comparison of a chrec against a constant, try to use value
4597   // ranges to answer this query.
4598   if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS))
4599     if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS))
4600       if (AddRec->getLoop() == L) {
4601         // Form the constant range.
4602         ConstantRange CompRange(
4603             ICmpInst::makeConstantRange(Cond, RHSC->getValue()->getValue()));
4604
4605         const SCEV *Ret = AddRec->getNumIterationsInRange(CompRange, *this);
4606         if (!isa<SCEVCouldNotCompute>(Ret)) return Ret;
4607       }
4608
4609   switch (Cond) {
4610   case ICmpInst::ICMP_NE: {                     // while (X != Y)
4611     // Convert to: while (X-Y != 0)
4612     ExitLimit EL = HowFarToZero(getMinusSCEV(LHS, RHS), L, IsSubExpr);
4613     if (EL.hasAnyInfo()) return EL;
4614     break;
4615   }
4616   case ICmpInst::ICMP_EQ: {                     // while (X == Y)
4617     // Convert to: while (X-Y == 0)
4618     ExitLimit EL = HowFarToNonZero(getMinusSCEV(LHS, RHS), L);
4619     if (EL.hasAnyInfo()) return EL;
4620     break;
4621   }
4622   case ICmpInst::ICMP_SLT: {
4623     ExitLimit EL = HowManyLessThans(LHS, RHS, L, true, IsSubExpr);
4624     if (EL.hasAnyInfo()) return EL;
4625     break;
4626   }
4627   case ICmpInst::ICMP_SGT: {
4628     ExitLimit EL = HowManyLessThans(getNotSCEV(LHS),
4629                                     getNotSCEV(RHS), L, true, IsSubExpr);
4630     if (EL.hasAnyInfo()) return EL;
4631     break;
4632   }
4633   case ICmpInst::ICMP_ULT: {
4634     ExitLimit EL = HowManyLessThans(LHS, RHS, L, false, IsSubExpr);
4635     if (EL.hasAnyInfo()) return EL;
4636     break;
4637   }
4638   case ICmpInst::ICMP_UGT: {
4639     ExitLimit EL = HowManyLessThans(getNotSCEV(LHS),
4640                                     getNotSCEV(RHS), L, false, IsSubExpr);
4641     if (EL.hasAnyInfo()) return EL;
4642     break;
4643   }
4644   default:
4645 #if 0
4646     dbgs() << "ComputeBackedgeTakenCount ";
4647     if (ExitCond->getOperand(0)->getType()->isUnsigned())
4648       dbgs() << "[unsigned] ";
4649     dbgs() << *LHS << "   "
4650          << Instruction::getOpcodeName(Instruction::ICmp)
4651          << "   " << *RHS << "\n";
4652 #endif
4653     break;
4654   }
4655   return ComputeExitCountExhaustively(L, ExitCond, !L->contains(TBB));
4656 }
4657
4658 static ConstantInt *
4659 EvaluateConstantChrecAtConstant(const SCEVAddRecExpr *AddRec, ConstantInt *C,
4660                                 ScalarEvolution &SE) {
4661   const SCEV *InVal = SE.getConstant(C);
4662   const SCEV *Val = AddRec->evaluateAtIteration(InVal, SE);
4663   assert(isa<SCEVConstant>(Val) &&
4664          "Evaluation of SCEV at constant didn't fold correctly?");
4665   return cast<SCEVConstant>(Val)->getValue();
4666 }
4667
4668 /// ComputeLoadConstantCompareExitLimit - Given an exit condition of
4669 /// 'icmp op load X, cst', try to see if we can compute the backedge
4670 /// execution count.
4671 ScalarEvolution::ExitLimit
4672 ScalarEvolution::ComputeLoadConstantCompareExitLimit(
4673   LoadInst *LI,
4674   Constant *RHS,
4675   const Loop *L,
4676   ICmpInst::Predicate predicate) {
4677
4678   if (LI->isVolatile()) return getCouldNotCompute();
4679
4680   // Check to see if the loaded pointer is a getelementptr of a global.
4681   // TODO: Use SCEV instead of manually grubbing with GEPs.
4682   GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(LI->getOperand(0));
4683   if (!GEP) return getCouldNotCompute();
4684
4685   // Make sure that it is really a constant global we are gepping, with an
4686   // initializer, and make sure the first IDX is really 0.
4687   GlobalVariable *GV = dyn_cast<GlobalVariable>(GEP->getOperand(0));
4688   if (!GV || !GV->isConstant() || !GV->hasDefinitiveInitializer() ||
4689       GEP->getNumOperands() < 3 || !isa<Constant>(GEP->getOperand(1)) ||
4690       !cast<Constant>(GEP->getOperand(1))->isNullValue())
4691     return getCouldNotCompute();
4692
4693   // Okay, we allow one non-constant index into the GEP instruction.
4694   Value *VarIdx = 0;
4695   std::vector<Constant*> Indexes;
4696   unsigned VarIdxNum = 0;
4697   for (unsigned i = 2, e = GEP->getNumOperands(); i != e; ++i)
4698     if (ConstantInt *CI = dyn_cast<ConstantInt>(GEP->getOperand(i))) {
4699       Indexes.push_back(CI);
4700     } else if (!isa<ConstantInt>(GEP->getOperand(i))) {
4701       if (VarIdx) return getCouldNotCompute();  // Multiple non-constant idx's.
4702       VarIdx = GEP->getOperand(i);
4703       VarIdxNum = i-2;
4704       Indexes.push_back(0);
4705     }
4706
4707   // Loop-invariant loads may be a byproduct of loop optimization. Skip them.
4708   if (!VarIdx)
4709     return getCouldNotCompute();
4710
4711   // Okay, we know we have a (load (gep GV, 0, X)) comparison with a constant.
4712   // Check to see if X is a loop variant variable value now.
4713   const SCEV *Idx = getSCEV(VarIdx);
4714   Idx = getSCEVAtScope(Idx, L);
4715
4716   // We can only recognize very limited forms of loop index expressions, in
4717   // particular, only affine AddRec's like {C1,+,C2}.
4718   const SCEVAddRecExpr *IdxExpr = dyn_cast<SCEVAddRecExpr>(Idx);
4719   if (!IdxExpr || !IdxExpr->isAffine() || isLoopInvariant(IdxExpr, L) ||
4720       !isa<SCEVConstant>(IdxExpr->getOperand(0)) ||
4721       !isa<SCEVConstant>(IdxExpr->getOperand(1)))
4722     return getCouldNotCompute();
4723
4724   unsigned MaxSteps = MaxBruteForceIterations;
4725   for (unsigned IterationNum = 0; IterationNum != MaxSteps; ++IterationNum) {
4726     ConstantInt *ItCst = ConstantInt::get(
4727                            cast<IntegerType>(IdxExpr->getType()), IterationNum);
4728     ConstantInt *Val = EvaluateConstantChrecAtConstant(IdxExpr, ItCst, *this);
4729
4730     // Form the GEP offset.
4731     Indexes[VarIdxNum] = Val;
4732
4733     Constant *Result = ConstantFoldLoadThroughGEPIndices(GV->getInitializer(),
4734                                                          Indexes);
4735     if (Result == 0) break;  // Cannot compute!
4736
4737     // Evaluate the condition for this iteration.
4738     Result = ConstantExpr::getICmp(predicate, Result, RHS);
4739     if (!isa<ConstantInt>(Result)) break;  // Couldn't decide for sure
4740     if (cast<ConstantInt>(Result)->getValue().isMinValue()) {
4741 #if 0
4742       dbgs() << "\n***\n*** Computed loop count " << *ItCst
4743              << "\n*** From global " << *GV << "*** BB: " << *L->getHeader()
4744              << "***\n";
4745 #endif
4746       ++NumArrayLenItCounts;
4747       return getConstant(ItCst);   // Found terminating iteration!
4748     }
4749   }
4750   return getCouldNotCompute();
4751 }
4752
4753
4754 /// CanConstantFold - Return true if we can constant fold an instruction of the
4755 /// specified type, assuming that all operands were constants.
4756 static bool CanConstantFold(const Instruction *I) {
4757   if (isa<BinaryOperator>(I) || isa<CmpInst>(I) ||
4758       isa<SelectInst>(I) || isa<CastInst>(I) || isa<GetElementPtrInst>(I) ||
4759       isa<LoadInst>(I))
4760     return true;
4761
4762   if (const CallInst *CI = dyn_cast<CallInst>(I))
4763     if (const Function *F = CI->getCalledFunction())
4764       return canConstantFoldCallTo(F);
4765   return false;
4766 }
4767
4768 /// Determine whether this instruction can constant evolve within this loop
4769 /// assuming its operands can all constant evolve.
4770 static bool canConstantEvolve(Instruction *I, const Loop *L) {
4771   // An instruction outside of the loop can't be derived from a loop PHI.
4772   if (!L->contains(I)) return false;
4773
4774   if (isa<PHINode>(I)) {
4775     if (L->getHeader() == I->getParent())
4776       return true;
4777     else
4778       // We don't currently keep track of the control flow needed to evaluate
4779       // PHIs, so we cannot handle PHIs inside of loops.
4780       return false;
4781   }
4782
4783   // If we won't be able to constant fold this expression even if the operands
4784   // are constants, bail early.
4785   return CanConstantFold(I);
4786 }
4787
4788 /// getConstantEvolvingPHIOperands - Implement getConstantEvolvingPHI by
4789 /// recursing through each instruction operand until reaching a loop header phi.
4790 static PHINode *
4791 getConstantEvolvingPHIOperands(Instruction *UseInst, const Loop *L,
4792                                DenseMap<Instruction *, PHINode *> &PHIMap) {
4793
4794   // Otherwise, we can evaluate this instruction if all of its operands are
4795   // constant or derived from a PHI node themselves.
4796   PHINode *PHI = 0;
4797   for (Instruction::op_iterator OpI = UseInst->op_begin(),
4798          OpE = UseInst->op_end(); OpI != OpE; ++OpI) {
4799
4800     if (isa<Constant>(*OpI)) continue;
4801
4802     Instruction *OpInst = dyn_cast<Instruction>(*OpI);
4803     if (!OpInst || !canConstantEvolve(OpInst, L)) return 0;
4804
4805     PHINode *P = dyn_cast<PHINode>(OpInst);
4806     if (!P)
4807       // If this operand is already visited, reuse the prior result.
4808       // We may have P != PHI if this is the deepest point at which the
4809       // inconsistent paths meet.
4810       P = PHIMap.lookup(OpInst);
4811     if (!P) {
4812       // Recurse and memoize the results, whether a phi is found or not.
4813       // This recursive call invalidates pointers into PHIMap.
4814       P = getConstantEvolvingPHIOperands(OpInst, L, PHIMap);
4815       PHIMap[OpInst] = P;
4816     }
4817     if (P == 0) return 0;        // Not evolving from PHI
4818     if (PHI && PHI != P) return 0;  // Evolving from multiple different PHIs.
4819     PHI = P;
4820   }
4821   // This is a expression evolving from a constant PHI!
4822   return PHI;
4823 }
4824
4825 /// getConstantEvolvingPHI - Given an LLVM value and a loop, return a PHI node
4826 /// in the loop that V is derived from.  We allow arbitrary operations along the
4827 /// way, but the operands of an operation must either be constants or a value
4828 /// derived from a constant PHI.  If this expression does not fit with these
4829 /// constraints, return null.
4830 static PHINode *getConstantEvolvingPHI(Value *V, const Loop *L) {
4831   Instruction *I = dyn_cast<Instruction>(V);
4832   if (I == 0 || !canConstantEvolve(I, L)) return 0;
4833
4834   if (PHINode *PN = dyn_cast<PHINode>(I)) {
4835     return PN;
4836   }
4837
4838   // Record non-constant instructions contained by the loop.
4839   DenseMap<Instruction *, PHINode *> PHIMap;
4840   return getConstantEvolvingPHIOperands(I, L, PHIMap);
4841 }
4842
4843 /// EvaluateExpression - Given an expression that passes the
4844 /// getConstantEvolvingPHI predicate, evaluate its value assuming the PHI node
4845 /// in the loop has the value PHIVal.  If we can't fold this expression for some
4846 /// reason, return null.
4847 static Constant *EvaluateExpression(Value *V, const Loop *L,
4848                                     DenseMap<Instruction *, Constant *> &Vals,
4849                                     const DataLayout *TD,
4850                                     const TargetLibraryInfo *TLI) {
4851   // Convenient constant check, but redundant for recursive calls.
4852   if (Constant *C = dyn_cast<Constant>(V)) return C;
4853   Instruction *I = dyn_cast<Instruction>(V);
4854   if (!I) return 0;
4855
4856   if (Constant *C = Vals.lookup(I)) return C;
4857
4858   // An instruction inside the loop depends on a value outside the loop that we
4859   // weren't given a mapping for, or a value such as a call inside the loop.
4860   if (!canConstantEvolve(I, L)) return 0;
4861
4862   // An unmapped PHI can be due to a branch or another loop inside this loop,
4863   // or due to this not being the initial iteration through a loop where we
4864   // couldn't compute the evolution of this particular PHI last time.
4865   if (isa<PHINode>(I)) return 0;
4866
4867   std::vector<Constant*> Operands(I->getNumOperands());
4868
4869   for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
4870     Instruction *Operand = dyn_cast<Instruction>(I->getOperand(i));
4871     if (!Operand) {
4872       Operands[i] = dyn_cast<Constant>(I->getOperand(i));
4873       if (!Operands[i]) return 0;
4874       continue;
4875     }
4876     Constant *C = EvaluateExpression(Operand, L, Vals, TD, TLI);
4877     Vals[Operand] = C;
4878     if (!C) return 0;
4879     Operands[i] = C;
4880   }
4881
4882   if (CmpInst *CI = dyn_cast<CmpInst>(I))
4883     return ConstantFoldCompareInstOperands(CI->getPredicate(), Operands[0],
4884                                            Operands[1], TD, TLI);
4885   if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
4886     if (!LI->isVolatile())
4887       return ConstantFoldLoadFromConstPtr(Operands[0], TD);
4888   }
4889   return ConstantFoldInstOperands(I->getOpcode(), I->getType(), Operands, TD,
4890                                   TLI);
4891 }
4892
4893 /// getConstantEvolutionLoopExitValue - If we know that the specified Phi is
4894 /// in the header of its containing loop, we know the loop executes a
4895 /// constant number of times, and the PHI node is just a recurrence
4896 /// involving constants, fold it.
4897 Constant *
4898 ScalarEvolution::getConstantEvolutionLoopExitValue(PHINode *PN,
4899                                                    const APInt &BEs,
4900                                                    const Loop *L) {
4901   DenseMap<PHINode*, Constant*>::const_iterator I =
4902     ConstantEvolutionLoopExitValue.find(PN);
4903   if (I != ConstantEvolutionLoopExitValue.end())
4904     return I->second;
4905
4906   if (BEs.ugt(MaxBruteForceIterations))
4907     return ConstantEvolutionLoopExitValue[PN] = 0;  // Not going to evaluate it.
4908
4909   Constant *&RetVal = ConstantEvolutionLoopExitValue[PN];
4910
4911   DenseMap<Instruction *, Constant *> CurrentIterVals;
4912   BasicBlock *Header = L->getHeader();
4913   assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!");
4914
4915   // Since the loop is canonicalized, the PHI node must have two entries.  One
4916   // entry must be a constant (coming in from outside of the loop), and the
4917   // second must be derived from the same PHI.
4918   bool SecondIsBackedge = L->contains(PN->getIncomingBlock(1));
4919   PHINode *PHI = 0;
4920   for (BasicBlock::iterator I = Header->begin();
4921        (PHI = dyn_cast<PHINode>(I)); ++I) {
4922     Constant *StartCST =
4923       dyn_cast<Constant>(PHI->getIncomingValue(!SecondIsBackedge));
4924     if (StartCST == 0) continue;
4925     CurrentIterVals[PHI] = StartCST;
4926   }
4927   if (!CurrentIterVals.count(PN))
4928     return RetVal = 0;
4929
4930   Value *BEValue = PN->getIncomingValue(SecondIsBackedge);
4931
4932   // Execute the loop symbolically to determine the exit value.
4933   if (BEs.getActiveBits() >= 32)
4934     return RetVal = 0; // More than 2^32-1 iterations?? Not doing it!
4935
4936   unsigned NumIterations = BEs.getZExtValue(); // must be in range
4937   unsigned IterationNum = 0;
4938   for (; ; ++IterationNum) {
4939     if (IterationNum == NumIterations)
4940       return RetVal = CurrentIterVals[PN];  // Got exit value!
4941
4942     // Compute the value of the PHIs for the next iteration.
4943     // EvaluateExpression adds non-phi values to the CurrentIterVals map.
4944     DenseMap<Instruction *, Constant *> NextIterVals;
4945     Constant *NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, TD,
4946                                            TLI);
4947     if (NextPHI == 0)
4948       return 0;        // Couldn't evaluate!
4949     NextIterVals[PN] = NextPHI;
4950
4951     bool StoppedEvolving = NextPHI == CurrentIterVals[PN];
4952
4953     // Also evaluate the other PHI nodes.  However, we don't get to stop if we
4954     // cease to be able to evaluate one of them or if they stop evolving,
4955     // because that doesn't necessarily prevent us from computing PN.
4956     SmallVector<std::pair<PHINode *, Constant *>, 8> PHIsToCompute;
4957     for (DenseMap<Instruction *, Constant *>::const_iterator
4958            I = CurrentIterVals.begin(), E = CurrentIterVals.end(); I != E; ++I){
4959       PHINode *PHI = dyn_cast<PHINode>(I->first);
4960       if (!PHI || PHI == PN || PHI->getParent() != Header) continue;
4961       PHIsToCompute.push_back(std::make_pair(PHI, I->second));
4962     }
4963     // We use two distinct loops because EvaluateExpression may invalidate any
4964     // iterators into CurrentIterVals.
4965     for (SmallVectorImpl<std::pair<PHINode *, Constant*> >::const_iterator
4966              I = PHIsToCompute.begin(), E = PHIsToCompute.end(); I != E; ++I) {
4967       PHINode *PHI = I->first;
4968       Constant *&NextPHI = NextIterVals[PHI];
4969       if (!NextPHI) {   // Not already computed.
4970         Value *BEValue = PHI->getIncomingValue(SecondIsBackedge);
4971         NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, TD, TLI);
4972       }
4973       if (NextPHI != I->second)
4974         StoppedEvolving = false;
4975     }
4976
4977     // If all entries in CurrentIterVals == NextIterVals then we can stop
4978     // iterating, the loop can't continue to change.
4979     if (StoppedEvolving)
4980       return RetVal = CurrentIterVals[PN];
4981
4982     CurrentIterVals.swap(NextIterVals);
4983   }
4984 }
4985
4986 /// ComputeExitCountExhaustively - If the loop is known to execute a
4987 /// constant number of times (the condition evolves only from constants),
4988 /// try to evaluate a few iterations of the loop until we get the exit
4989 /// condition gets a value of ExitWhen (true or false).  If we cannot
4990 /// evaluate the trip count of the loop, return getCouldNotCompute().
4991 const SCEV *ScalarEvolution::ComputeExitCountExhaustively(const Loop *L,
4992                                                           Value *Cond,
4993                                                           bool ExitWhen) {
4994   PHINode *PN = getConstantEvolvingPHI(Cond, L);
4995   if (PN == 0) return getCouldNotCompute();
4996
4997   // If the loop is canonicalized, the PHI will have exactly two entries.
4998   // That's the only form we support here.
4999   if (PN->getNumIncomingValues() != 2) return getCouldNotCompute();
5000
5001   DenseMap<Instruction *, Constant *> CurrentIterVals;
5002   BasicBlock *Header = L->getHeader();
5003   assert(PN->getParent() == Header && "Can't evaluate PHI not in loop header!");
5004
5005   // One entry must be a constant (coming in from outside of the loop), and the
5006   // second must be derived from the same PHI.
5007   bool SecondIsBackedge = L->contains(PN->getIncomingBlock(1));
5008   PHINode *PHI = 0;
5009   for (BasicBlock::iterator I = Header->begin();
5010        (PHI = dyn_cast<PHINode>(I)); ++I) {
5011     Constant *StartCST =
5012       dyn_cast<Constant>(PHI->getIncomingValue(!SecondIsBackedge));
5013     if (StartCST == 0) continue;
5014     CurrentIterVals[PHI] = StartCST;
5015   }
5016   if (!CurrentIterVals.count(PN))
5017     return getCouldNotCompute();
5018
5019   // Okay, we find a PHI node that defines the trip count of this loop.  Execute
5020   // the loop symbolically to determine when the condition gets a value of
5021   // "ExitWhen".
5022
5023   unsigned MaxIterations = MaxBruteForceIterations;   // Limit analysis.
5024   for (unsigned IterationNum = 0; IterationNum != MaxIterations;++IterationNum){
5025     ConstantInt *CondVal =
5026       dyn_cast_or_null<ConstantInt>(EvaluateExpression(Cond, L, CurrentIterVals,
5027                                                        TD, TLI));
5028
5029     // Couldn't symbolically evaluate.
5030     if (!CondVal) return getCouldNotCompute();
5031
5032     if (CondVal->getValue() == uint64_t(ExitWhen)) {
5033       ++NumBruteForceTripCountsComputed;
5034       return getConstant(Type::getInt32Ty(getContext()), IterationNum);
5035     }
5036
5037     // Update all the PHI nodes for the next iteration.
5038     DenseMap<Instruction *, Constant *> NextIterVals;
5039
5040     // Create a list of which PHIs we need to compute. We want to do this before
5041     // calling EvaluateExpression on them because that may invalidate iterators
5042     // into CurrentIterVals.
5043     SmallVector<PHINode *, 8> PHIsToCompute;
5044     for (DenseMap<Instruction *, Constant *>::const_iterator
5045            I = CurrentIterVals.begin(), E = CurrentIterVals.end(); I != E; ++I){
5046       PHINode *PHI = dyn_cast<PHINode>(I->first);
5047       if (!PHI || PHI->getParent() != Header) continue;
5048       PHIsToCompute.push_back(PHI);
5049     }
5050     for (SmallVectorImpl<PHINode *>::const_iterator I = PHIsToCompute.begin(),
5051              E = PHIsToCompute.end(); I != E; ++I) {
5052       PHINode *PHI = *I;
5053       Constant *&NextPHI = NextIterVals[PHI];
5054       if (NextPHI) continue;    // Already computed!
5055
5056       Value *BEValue = PHI->getIncomingValue(SecondIsBackedge);
5057       NextPHI = EvaluateExpression(BEValue, L, CurrentIterVals, TD, TLI);
5058     }
5059     CurrentIterVals.swap(NextIterVals);
5060   }
5061
5062   // Too many iterations were needed to evaluate.
5063   return getCouldNotCompute();
5064 }
5065
5066 /// getSCEVAtScope - Return a SCEV expression for the specified value
5067 /// at the specified scope in the program.  The L value specifies a loop
5068 /// nest to evaluate the expression at, where null is the top-level or a
5069 /// specified loop is immediately inside of the loop.
5070 ///
5071 /// This method can be used to compute the exit value for a variable defined
5072 /// in a loop by querying what the value will hold in the parent loop.
5073 ///
5074 /// In the case that a relevant loop exit value cannot be computed, the
5075 /// original value V is returned.
5076 const SCEV *ScalarEvolution::getSCEVAtScope(const SCEV *V, const Loop *L) {
5077   // Check to see if we've folded this expression at this loop before.
5078   std::map<const Loop *, const SCEV *> &Values = ValuesAtScopes[V];
5079   std::pair<std::map<const Loop *, const SCEV *>::iterator, bool> Pair =
5080     Values.insert(std::make_pair(L, static_cast<const SCEV *>(0)));
5081   if (!Pair.second)
5082     return Pair.first->second ? Pair.first->second : V;
5083
5084   // Otherwise compute it.
5085   const SCEV *C = computeSCEVAtScope(V, L);
5086   ValuesAtScopes[V][L] = C;
5087   return C;
5088 }
5089
5090 /// This builds up a Constant using the ConstantExpr interface.  That way, we
5091 /// will return Constants for objects which aren't represented by a
5092 /// SCEVConstant, because SCEVConstant is restricted to ConstantInt.
5093 /// Returns NULL if the SCEV isn't representable as a Constant.
5094 static Constant *BuildConstantFromSCEV(const SCEV *V) {
5095   switch (V->getSCEVType()) {
5096     default:  // TODO: smax, umax.
5097     case scCouldNotCompute:
5098     case scAddRecExpr:
5099       break;
5100     case scConstant:
5101       return cast<SCEVConstant>(V)->getValue();
5102     case scUnknown:
5103       return dyn_cast<Constant>(cast<SCEVUnknown>(V)->getValue());
5104     case scSignExtend: {
5105       const SCEVSignExtendExpr *SS = cast<SCEVSignExtendExpr>(V);
5106       if (Constant *CastOp = BuildConstantFromSCEV(SS->getOperand()))
5107         return ConstantExpr::getSExt(CastOp, SS->getType());
5108       break;
5109     }
5110     case scZeroExtend: {
5111       const SCEVZeroExtendExpr *SZ = cast<SCEVZeroExtendExpr>(V);
5112       if (Constant *CastOp = BuildConstantFromSCEV(SZ->getOperand()))
5113         return ConstantExpr::getZExt(CastOp, SZ->getType());
5114       break;
5115     }
5116     case scTruncate: {
5117       const SCEVTruncateExpr *ST = cast<SCEVTruncateExpr>(V);
5118       if (Constant *CastOp = BuildConstantFromSCEV(ST->getOperand()))
5119         return ConstantExpr::getTrunc(CastOp, ST->getType());
5120       break;
5121     }
5122     case scAddExpr: {
5123       const SCEVAddExpr *SA = cast<SCEVAddExpr>(V);
5124       if (Constant *C = BuildConstantFromSCEV(SA->getOperand(0))) {
5125         if (C->getType()->isPointerTy())
5126           C = ConstantExpr::getBitCast(C, Type::getInt8PtrTy(C->getContext()));
5127         for (unsigned i = 1, e = SA->getNumOperands(); i != e; ++i) {
5128           Constant *C2 = BuildConstantFromSCEV(SA->getOperand(i));
5129           if (!C2) return 0;
5130
5131           // First pointer!
5132           if (!C->getType()->isPointerTy() && C2->getType()->isPointerTy()) {
5133             std::swap(C, C2);
5134             // The offsets have been converted to bytes.  We can add bytes to an
5135             // i8* by GEP with the byte count in the first index.
5136             C = ConstantExpr::getBitCast(C,Type::getInt8PtrTy(C->getContext()));
5137           }
5138
5139           // Don't bother trying to sum two pointers. We probably can't
5140           // statically compute a load that results from it anyway.
5141           if (C2->getType()->isPointerTy())
5142             return 0;
5143
5144           if (C->getType()->isPointerTy()) {
5145             if (cast<PointerType>(C->getType())->getElementType()->isStructTy())
5146               C2 = ConstantExpr::getIntegerCast(
5147                   C2, Type::getInt32Ty(C->getContext()), true);
5148             C = ConstantExpr::getGetElementPtr(C, C2);
5149           } else
5150             C = ConstantExpr::getAdd(C, C2);
5151         }
5152         return C;
5153       }
5154       break;
5155     }
5156     case scMulExpr: {
5157       const SCEVMulExpr *SM = cast<SCEVMulExpr>(V);
5158       if (Constant *C = BuildConstantFromSCEV(SM->getOperand(0))) {
5159         // Don't bother with pointers at all.
5160         if (C->getType()->isPointerTy()) return 0;
5161         for (unsigned i = 1, e = SM->getNumOperands(); i != e; ++i) {
5162           Constant *C2 = BuildConstantFromSCEV(SM->getOperand(i));
5163           if (!C2 || C2->getType()->isPointerTy()) return 0;
5164           C = ConstantExpr::getMul(C, C2);
5165         }
5166         return C;
5167       }
5168       break;
5169     }
5170     case scUDivExpr: {
5171       const SCEVUDivExpr *SU = cast<SCEVUDivExpr>(V);
5172       if (Constant *LHS = BuildConstantFromSCEV(SU->getLHS()))
5173         if (Constant *RHS = BuildConstantFromSCEV(SU->getRHS()))
5174           if (LHS->getType() == RHS->getType())
5175             return ConstantExpr::getUDiv(LHS, RHS);
5176       break;
5177     }
5178   }
5179   return 0;
5180 }
5181
5182 const SCEV *ScalarEvolution::computeSCEVAtScope(const SCEV *V, const Loop *L) {
5183   if (isa<SCEVConstant>(V)) return V;
5184
5185   // If this instruction is evolved from a constant-evolving PHI, compute the
5186   // exit value from the loop without using SCEVs.
5187   if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(V)) {
5188     if (Instruction *I = dyn_cast<Instruction>(SU->getValue())) {
5189       const Loop *LI = (*this->LI)[I->getParent()];
5190       if (LI && LI->getParentLoop() == L)  // Looking for loop exit value.
5191         if (PHINode *PN = dyn_cast<PHINode>(I))
5192           if (PN->getParent() == LI->getHeader()) {
5193             // Okay, there is no closed form solution for the PHI node.  Check
5194             // to see if the loop that contains it has a known backedge-taken
5195             // count.  If so, we may be able to force computation of the exit
5196             // value.
5197             const SCEV *BackedgeTakenCount = getBackedgeTakenCount(LI);
5198             if (const SCEVConstant *BTCC =
5199                   dyn_cast<SCEVConstant>(BackedgeTakenCount)) {
5200               // Okay, we know how many times the containing loop executes.  If
5201               // this is a constant evolving PHI node, get the final value at
5202               // the specified iteration number.
5203               Constant *RV = getConstantEvolutionLoopExitValue(PN,
5204                                                    BTCC->getValue()->getValue(),
5205                                                                LI);
5206               if (RV) return getSCEV(RV);
5207             }
5208           }
5209
5210       // Okay, this is an expression that we cannot symbolically evaluate
5211       // into a SCEV.  Check to see if it's possible to symbolically evaluate
5212       // the arguments into constants, and if so, try to constant propagate the
5213       // result.  This is particularly useful for computing loop exit values.
5214       if (CanConstantFold(I)) {
5215         SmallVector<Constant *, 4> Operands;
5216         bool MadeImprovement = false;
5217         for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
5218           Value *Op = I->getOperand(i);
5219           if (Constant *C = dyn_cast<Constant>(Op)) {
5220             Operands.push_back(C);
5221             continue;
5222           }
5223
5224           // If any of the operands is non-constant and if they are
5225           // non-integer and non-pointer, don't even try to analyze them
5226           // with scev techniques.
5227           if (!isSCEVable(Op->getType()))
5228             return V;
5229
5230           const SCEV *OrigV = getSCEV(Op);
5231           const SCEV *OpV = getSCEVAtScope(OrigV, L);
5232           MadeImprovement |= OrigV != OpV;
5233
5234           Constant *C = BuildConstantFromSCEV(OpV);
5235           if (!C) return V;
5236           if (C->getType() != Op->getType())
5237             C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
5238                                                               Op->getType(),
5239                                                               false),
5240                                       C, Op->getType());
5241           Operands.push_back(C);
5242         }
5243
5244         // Check to see if getSCEVAtScope actually made an improvement.
5245         if (MadeImprovement) {
5246           Constant *C = 0;
5247           if (const CmpInst *CI = dyn_cast<CmpInst>(I))
5248             C = ConstantFoldCompareInstOperands(CI->getPredicate(),
5249                                                 Operands[0], Operands[1], TD,
5250                                                 TLI);
5251           else if (const LoadInst *LI = dyn_cast<LoadInst>(I)) {
5252             if (!LI->isVolatile())
5253               C = ConstantFoldLoadFromConstPtr(Operands[0], TD);
5254           } else
5255             C = ConstantFoldInstOperands(I->getOpcode(), I->getType(),
5256                                          Operands, TD, TLI);
5257           if (!C) return V;
5258           return getSCEV(C);
5259         }
5260       }
5261     }
5262
5263     // This is some other type of SCEVUnknown, just return it.
5264     return V;
5265   }
5266
5267   if (const SCEVCommutativeExpr *Comm = dyn_cast<SCEVCommutativeExpr>(V)) {
5268     // Avoid performing the look-up in the common case where the specified
5269     // expression has no loop-variant portions.
5270     for (unsigned i = 0, e = Comm->getNumOperands(); i != e; ++i) {
5271       const SCEV *OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
5272       if (OpAtScope != Comm->getOperand(i)) {
5273         // Okay, at least one of these operands is loop variant but might be
5274         // foldable.  Build a new instance of the folded commutative expression.
5275         SmallVector<const SCEV *, 8> NewOps(Comm->op_begin(),
5276                                             Comm->op_begin()+i);
5277         NewOps.push_back(OpAtScope);
5278
5279         for (++i; i != e; ++i) {
5280           OpAtScope = getSCEVAtScope(Comm->getOperand(i), L);
5281           NewOps.push_back(OpAtScope);
5282         }
5283         if (isa<SCEVAddExpr>(Comm))
5284           return getAddExpr(NewOps);
5285         if (isa<SCEVMulExpr>(Comm))
5286           return getMulExpr(NewOps);
5287         if (isa<SCEVSMaxExpr>(Comm))
5288           return getSMaxExpr(NewOps);
5289         if (isa<SCEVUMaxExpr>(Comm))
5290           return getUMaxExpr(NewOps);
5291         llvm_unreachable("Unknown commutative SCEV type!");
5292       }
5293     }
5294     // If we got here, all operands are loop invariant.
5295     return Comm;
5296   }
5297
5298   if (const SCEVUDivExpr *Div = dyn_cast<SCEVUDivExpr>(V)) {
5299     const SCEV *LHS = getSCEVAtScope(Div->getLHS(), L);
5300     const SCEV *RHS = getSCEVAtScope(Div->getRHS(), L);
5301     if (LHS == Div->getLHS() && RHS == Div->getRHS())
5302       return Div;   // must be loop invariant
5303     return getUDivExpr(LHS, RHS);
5304   }
5305
5306   // If this is a loop recurrence for a loop that does not contain L, then we
5307   // are dealing with the final value computed by the loop.
5308   if (const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V)) {
5309     // First, attempt to evaluate each operand.
5310     // Avoid performing the look-up in the common case where the specified
5311     // expression has no loop-variant portions.
5312     for (unsigned i = 0, e = AddRec->getNumOperands(); i != e; ++i) {
5313       const SCEV *OpAtScope = getSCEVAtScope(AddRec->getOperand(i), L);
5314       if (OpAtScope == AddRec->getOperand(i))
5315         continue;
5316
5317       // Okay, at least one of these operands is loop variant but might be
5318       // foldable.  Build a new instance of the folded commutative expression.
5319       SmallVector<const SCEV *, 8> NewOps(AddRec->op_begin(),
5320                                           AddRec->op_begin()+i);
5321       NewOps.push_back(OpAtScope);
5322       for (++i; i != e; ++i)
5323         NewOps.push_back(getSCEVAtScope(AddRec->getOperand(i), L));
5324
5325       const SCEV *FoldedRec =
5326         getAddRecExpr(NewOps, AddRec->getLoop(),
5327                       AddRec->getNoWrapFlags(SCEV::FlagNW));
5328       AddRec = dyn_cast<SCEVAddRecExpr>(FoldedRec);
5329       // The addrec may be folded to a nonrecurrence, for example, if the
5330       // induction variable is multiplied by zero after constant folding. Go
5331       // ahead and return the folded value.
5332       if (!AddRec)
5333         return FoldedRec;
5334       break;
5335     }
5336
5337     // If the scope is outside the addrec's loop, evaluate it by using the
5338     // loop exit value of the addrec.
5339     if (!AddRec->getLoop()->contains(L)) {
5340       // To evaluate this recurrence, we need to know how many times the AddRec
5341       // loop iterates.  Compute this now.
5342       const SCEV *BackedgeTakenCount = getBackedgeTakenCount(AddRec->getLoop());
5343       if (BackedgeTakenCount == getCouldNotCompute()) return AddRec;
5344
5345       // Then, evaluate the AddRec.
5346       return AddRec->evaluateAtIteration(BackedgeTakenCount, *this);
5347     }
5348
5349     return AddRec;
5350   }
5351
5352   if (const SCEVZeroExtendExpr *Cast = dyn_cast<SCEVZeroExtendExpr>(V)) {
5353     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
5354     if (Op == Cast->getOperand())
5355       return Cast;  // must be loop invariant
5356     return getZeroExtendExpr(Op, Cast->getType());
5357   }
5358
5359   if (const SCEVSignExtendExpr *Cast = dyn_cast<SCEVSignExtendExpr>(V)) {
5360     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
5361     if (Op == Cast->getOperand())
5362       return Cast;  // must be loop invariant
5363     return getSignExtendExpr(Op, Cast->getType());
5364   }
5365
5366   if (const SCEVTruncateExpr *Cast = dyn_cast<SCEVTruncateExpr>(V)) {
5367     const SCEV *Op = getSCEVAtScope(Cast->getOperand(), L);
5368     if (Op == Cast->getOperand())
5369       return Cast;  // must be loop invariant
5370     return getTruncateExpr(Op, Cast->getType());
5371   }
5372
5373   llvm_unreachable("Unknown SCEV type!");
5374 }
5375
5376 /// getSCEVAtScope - This is a convenience function which does
5377 /// getSCEVAtScope(getSCEV(V), L).
5378 const SCEV *ScalarEvolution::getSCEVAtScope(Value *V, const Loop *L) {
5379   return getSCEVAtScope(getSCEV(V), L);
5380 }
5381
5382 /// SolveLinEquationWithOverflow - Finds the minimum unsigned root of the
5383 /// following equation:
5384 ///
5385 ///     A * X = B (mod N)
5386 ///
5387 /// where N = 2^BW and BW is the common bit width of A and B. The signedness of
5388 /// A and B isn't important.
5389 ///
5390 /// If the equation does not have a solution, SCEVCouldNotCompute is returned.
5391 static const SCEV *SolveLinEquationWithOverflow(const APInt &A, const APInt &B,
5392                                                ScalarEvolution &SE) {
5393   uint32_t BW = A.getBitWidth();
5394   assert(BW == B.getBitWidth() && "Bit widths must be the same.");
5395   assert(A != 0 && "A must be non-zero.");
5396
5397   // 1. D = gcd(A, N)
5398   //
5399   // The gcd of A and N may have only one prime factor: 2. The number of
5400   // trailing zeros in A is its multiplicity
5401   uint32_t Mult2 = A.countTrailingZeros();
5402   // D = 2^Mult2
5403
5404   // 2. Check if B is divisible by D.
5405   //
5406   // B is divisible by D if and only if the multiplicity of prime factor 2 for B
5407   // is not less than multiplicity of this prime factor for D.
5408   if (B.countTrailingZeros() < Mult2)
5409     return SE.getCouldNotCompute();
5410
5411   // 3. Compute I: the multiplicative inverse of (A / D) in arithmetic
5412   // modulo (N / D).
5413   //
5414   // (N / D) may need BW+1 bits in its representation.  Hence, we'll use this
5415   // bit width during computations.
5416   APInt AD = A.lshr(Mult2).zext(BW + 1);  // AD = A / D
5417   APInt Mod(BW + 1, 0);
5418   Mod.setBit(BW - Mult2);  // Mod = N / D
5419   APInt I = AD.multiplicativeInverse(Mod);
5420
5421   // 4. Compute the minimum unsigned root of the equation:
5422   // I * (B / D) mod (N / D)
5423   APInt Result = (I * B.lshr(Mult2).zext(BW + 1)).urem(Mod);
5424
5425   // The result is guaranteed to be less than 2^BW so we may truncate it to BW
5426   // bits.
5427   return SE.getConstant(Result.trunc(BW));
5428 }
5429
5430 /// SolveQuadraticEquation - Find the roots of the quadratic equation for the
5431 /// given quadratic chrec {L,+,M,+,N}.  This returns either the two roots (which
5432 /// might be the same) or two SCEVCouldNotCompute objects.
5433 ///
5434 static std::pair<const SCEV *,const SCEV *>
5435 SolveQuadraticEquation(const SCEVAddRecExpr *AddRec, ScalarEvolution &SE) {
5436   assert(AddRec->getNumOperands() == 3 && "This is not a quadratic chrec!");
5437   const SCEVConstant *LC = dyn_cast<SCEVConstant>(AddRec->getOperand(0));
5438   const SCEVConstant *MC = dyn_cast<SCEVConstant>(AddRec->getOperand(1));
5439   const SCEVConstant *NC = dyn_cast<SCEVConstant>(AddRec->getOperand(2));
5440
5441   // We currently can only solve this if the coefficients are constants.
5442   if (!LC || !MC || !NC) {
5443     const SCEV *CNC = SE.getCouldNotCompute();
5444     return std::make_pair(CNC, CNC);
5445   }
5446
5447   uint32_t BitWidth = LC->getValue()->getValue().getBitWidth();
5448   const APInt &L = LC->getValue()->getValue();
5449   const APInt &M = MC->getValue()->getValue();
5450   const APInt &N = NC->getValue()->getValue();
5451   APInt Two(BitWidth, 2);
5452   APInt Four(BitWidth, 4);
5453
5454   {
5455     using namespace APIntOps;
5456     const APInt& C = L;
5457     // Convert from chrec coefficients to polynomial coefficients AX^2+BX+C
5458     // The B coefficient is M-N/2
5459     APInt B(M);
5460     B -= sdiv(N,Two);
5461
5462     // The A coefficient is N/2
5463     APInt A(N.sdiv(Two));
5464
5465     // Compute the B^2-4ac term.
5466     APInt SqrtTerm(B);
5467     SqrtTerm *= B;
5468     SqrtTerm -= Four * (A * C);
5469
5470     if (SqrtTerm.isNegative()) {
5471       // The loop is provably infinite.
5472       const SCEV *CNC = SE.getCouldNotCompute();
5473       return std::make_pair(CNC, CNC);
5474     }
5475
5476     // Compute sqrt(B^2-4ac). This is guaranteed to be the nearest
5477     // integer value or else APInt::sqrt() will assert.
5478     APInt SqrtVal(SqrtTerm.sqrt());
5479
5480     // Compute the two solutions for the quadratic formula.
5481     // The divisions must be performed as signed divisions.
5482     APInt NegB(-B);
5483     APInt TwoA(A << 1);
5484     if (TwoA.isMinValue()) {
5485       const SCEV *CNC = SE.getCouldNotCompute();
5486       return std::make_pair(CNC, CNC);
5487     }
5488
5489     LLVMContext &Context = SE.getContext();
5490
5491     ConstantInt *Solution1 =
5492       ConstantInt::get(Context, (NegB + SqrtVal).sdiv(TwoA));
5493     ConstantInt *Solution2 =
5494       ConstantInt::get(Context, (NegB - SqrtVal).sdiv(TwoA));
5495
5496     return std::make_pair(SE.getConstant(Solution1),
5497                           SE.getConstant(Solution2));
5498   } // end APIntOps namespace
5499 }
5500
5501 /// HowFarToZero - Return the number of times a backedge comparing the specified
5502 /// value to zero will execute.  If not computable, return CouldNotCompute.
5503 ///
5504 /// This is only used for loops with a "x != y" exit test. The exit condition is
5505 /// now expressed as a single expression, V = x-y. So the exit test is
5506 /// effectively V != 0.  We know and take advantage of the fact that this
5507 /// expression only being used in a comparison by zero context.
5508 ScalarEvolution::ExitLimit
5509 ScalarEvolution::HowFarToZero(const SCEV *V, const Loop *L, bool IsSubExpr) {
5510   // If the value is a constant
5511   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
5512     // If the value is already zero, the branch will execute zero times.
5513     if (C->getValue()->isZero()) return C;
5514     return getCouldNotCompute();  // Otherwise it will loop infinitely.
5515   }
5516
5517   const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(V);
5518   if (!AddRec || AddRec->getLoop() != L)
5519     return getCouldNotCompute();
5520
5521   // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of
5522   // the quadratic equation to solve it.
5523   if (AddRec->isQuadratic() && AddRec->getType()->isIntegerTy()) {
5524     std::pair<const SCEV *,const SCEV *> Roots =
5525       SolveQuadraticEquation(AddRec, *this);
5526     const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
5527     const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
5528     if (R1 && R2) {
5529 #if 0
5530       dbgs() << "HFTZ: " << *V << " - sol#1: " << *R1
5531              << "  sol#2: " << *R2 << "\n";
5532 #endif
5533       // Pick the smallest positive root value.
5534       if (ConstantInt *CB =
5535           dyn_cast<ConstantInt>(ConstantExpr::getICmp(CmpInst::ICMP_ULT,
5536                                                       R1->getValue(),
5537                                                       R2->getValue()))) {
5538         if (CB->getZExtValue() == false)
5539           std::swap(R1, R2);   // R1 is the minimum root now.
5540
5541         // We can only use this value if the chrec ends up with an exact zero
5542         // value at this index.  When solving for "X*X != 5", for example, we
5543         // should not accept a root of 2.
5544         const SCEV *Val = AddRec->evaluateAtIteration(R1, *this);
5545         if (Val->isZero())
5546           return R1;  // We found a quadratic root!
5547       }
5548     }
5549     return getCouldNotCompute();
5550   }
5551
5552   // Otherwise we can only handle this if it is affine.
5553   if (!AddRec->isAffine())
5554     return getCouldNotCompute();
5555
5556   // If this is an affine expression, the execution count of this branch is
5557   // the minimum unsigned root of the following equation:
5558   //
5559   //     Start + Step*N = 0 (mod 2^BW)
5560   //
5561   // equivalent to:
5562   //
5563   //             Step*N = -Start (mod 2^BW)
5564   //
5565   // where BW is the common bit width of Start and Step.
5566
5567   // Get the initial value for the loop.
5568   const SCEV *Start = getSCEVAtScope(AddRec->getStart(), L->getParentLoop());
5569   const SCEV *Step = getSCEVAtScope(AddRec->getOperand(1), L->getParentLoop());
5570
5571   // For now we handle only constant steps.
5572   //
5573   // TODO: Handle a nonconstant Step given AddRec<NUW>. If the
5574   // AddRec is NUW, then (in an unsigned sense) it cannot be counting up to wrap
5575   // to 0, it must be counting down to equal 0. Consequently, N = Start / -Step.
5576   // We have not yet seen any such cases.
5577   const SCEVConstant *StepC = dyn_cast<SCEVConstant>(Step);
5578   if (StepC == 0 || StepC->getValue()->equalsInt(0))
5579     return getCouldNotCompute();
5580
5581   // For positive steps (counting up until unsigned overflow):
5582   //   N = -Start/Step (as unsigned)
5583   // For negative steps (counting down to zero):
5584   //   N = Start/-Step
5585   // First compute the unsigned distance from zero in the direction of Step.
5586   bool CountDown = StepC->getValue()->getValue().isNegative();
5587   const SCEV *Distance = CountDown ? Start : getNegativeSCEV(Start);
5588
5589   // Handle unitary steps, which cannot wraparound.
5590   // 1*N = -Start; -1*N = Start (mod 2^BW), so:
5591   //   N = Distance (as unsigned)
5592   if (StepC->getValue()->equalsInt(1) || StepC->getValue()->isAllOnesValue()) {
5593     ConstantRange CR = getUnsignedRange(Start);
5594     const SCEV *MaxBECount;
5595     if (!CountDown && CR.getUnsignedMin().isMinValue())
5596       // When counting up, the worst starting value is 1, not 0.
5597       MaxBECount = CR.getUnsignedMax().isMinValue()
5598         ? getConstant(APInt::getMinValue(CR.getBitWidth()))
5599         : getConstant(APInt::getMaxValue(CR.getBitWidth()));
5600     else
5601       MaxBECount = getConstant(CountDown ? CR.getUnsignedMax()
5602                                          : -CR.getUnsignedMin());
5603     return ExitLimit(Distance, MaxBECount);
5604   }
5605
5606   // If the recurrence is known not to wraparound, unsigned divide computes the
5607   // back edge count. (Ideally we would have an "isexact" bit for udiv). We know
5608   // that the value will either become zero (and thus the loop terminates), that
5609   // the loop will terminate through some other exit condition first, or that
5610   // the loop has undefined behavior.  This means we can't "miss" the exit
5611   // value, even with nonunit stride.
5612   //
5613   // This is only valid for expressions that directly compute the loop exit. It
5614   // is invalid for subexpressions in which the loop may exit through this
5615   // branch even if this subexpression is false. In that case, the trip count
5616   // computed by this udiv could be smaller than the number of well-defined
5617   // iterations.
5618   if (!IsSubExpr && AddRec->getNoWrapFlags(SCEV::FlagNW))
5619     return getUDivExpr(Distance, CountDown ? getNegativeSCEV(Step) : Step);
5620
5621   // Then, try to solve the above equation provided that Start is constant.
5622   if (const SCEVConstant *StartC = dyn_cast<SCEVConstant>(Start))
5623     return SolveLinEquationWithOverflow(StepC->getValue()->getValue(),
5624                                         -StartC->getValue()->getValue(),
5625                                         *this);
5626   return getCouldNotCompute();
5627 }
5628
5629 /// HowFarToNonZero - Return the number of times a backedge checking the
5630 /// specified value for nonzero will execute.  If not computable, return
5631 /// CouldNotCompute
5632 ScalarEvolution::ExitLimit
5633 ScalarEvolution::HowFarToNonZero(const SCEV *V, const Loop *L) {
5634   // Loops that look like: while (X == 0) are very strange indeed.  We don't
5635   // handle them yet except for the trivial case.  This could be expanded in the
5636   // future as needed.
5637
5638   // If the value is a constant, check to see if it is known to be non-zero
5639   // already.  If so, the backedge will execute zero times.
5640   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(V)) {
5641     if (!C->getValue()->isNullValue())
5642       return getConstant(C->getType(), 0);
5643     return getCouldNotCompute();  // Otherwise it will loop infinitely.
5644   }
5645
5646   // We could implement others, but I really doubt anyone writes loops like
5647   // this, and if they did, they would already be constant folded.
5648   return getCouldNotCompute();
5649 }
5650
5651 /// getPredecessorWithUniqueSuccessorForBB - Return a predecessor of BB
5652 /// (which may not be an immediate predecessor) which has exactly one
5653 /// successor from which BB is reachable, or null if no such block is
5654 /// found.
5655 ///
5656 std::pair<BasicBlock *, BasicBlock *>
5657 ScalarEvolution::getPredecessorWithUniqueSuccessorForBB(BasicBlock *BB) {
5658   // If the block has a unique predecessor, then there is no path from the
5659   // predecessor to the block that does not go through the direct edge
5660   // from the predecessor to the block.
5661   if (BasicBlock *Pred = BB->getSinglePredecessor())
5662     return std::make_pair(Pred, BB);
5663
5664   // A loop's header is defined to be a block that dominates the loop.
5665   // If the header has a unique predecessor outside the loop, it must be
5666   // a block that has exactly one successor that can reach the loop.
5667   if (Loop *L = LI->getLoopFor(BB))
5668     return std::make_pair(L->getLoopPredecessor(), L->getHeader());
5669
5670   return std::pair<BasicBlock *, BasicBlock *>();
5671 }
5672
5673 /// HasSameValue - SCEV structural equivalence is usually sufficient for
5674 /// testing whether two expressions are equal, however for the purposes of
5675 /// looking for a condition guarding a loop, it can be useful to be a little
5676 /// more general, since a front-end may have replicated the controlling
5677 /// expression.
5678 ///
5679 static bool HasSameValue(const SCEV *A, const SCEV *B) {
5680   // Quick check to see if they are the same SCEV.
5681   if (A == B) return true;
5682
5683   // Otherwise, if they're both SCEVUnknown, it's possible that they hold
5684   // two different instructions with the same value. Check for this case.
5685   if (const SCEVUnknown *AU = dyn_cast<SCEVUnknown>(A))
5686     if (const SCEVUnknown *BU = dyn_cast<SCEVUnknown>(B))
5687       if (const Instruction *AI = dyn_cast<Instruction>(AU->getValue()))
5688         if (const Instruction *BI = dyn_cast<Instruction>(BU->getValue()))
5689           if (AI->isIdenticalTo(BI) && !AI->mayReadFromMemory())
5690             return true;
5691
5692   // Otherwise assume they may have a different value.
5693   return false;
5694 }
5695
5696 /// SimplifyICmpOperands - Simplify LHS and RHS in a comparison with
5697 /// predicate Pred. Return true iff any changes were made.
5698 ///
5699 bool ScalarEvolution::SimplifyICmpOperands(ICmpInst::Predicate &Pred,
5700                                            const SCEV *&LHS, const SCEV *&RHS,
5701                                            unsigned Depth) {
5702   bool Changed = false;
5703
5704   // If we hit the max recursion limit bail out.
5705   if (Depth >= 3)
5706     return false;
5707
5708   // Canonicalize a constant to the right side.
5709   if (const SCEVConstant *LHSC = dyn_cast<SCEVConstant>(LHS)) {
5710     // Check for both operands constant.
5711     if (const SCEVConstant *RHSC = dyn_cast<SCEVConstant>(RHS)) {
5712       if (ConstantExpr::getICmp(Pred,
5713                                 LHSC->getValue(),
5714                                 RHSC->getValue())->isNullValue())
5715         goto trivially_false;
5716       else
5717         goto trivially_true;
5718     }
5719     // Otherwise swap the operands to put the constant on the right.
5720     std::swap(LHS, RHS);
5721     Pred = ICmpInst::getSwappedPredicate(Pred);
5722     Changed = true;
5723   }
5724
5725   // If we're comparing an addrec with a value which is loop-invariant in the
5726   // addrec's loop, put the addrec on the left. Also make a dominance check,
5727   // as both operands could be addrecs loop-invariant in each other's loop.
5728   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS)) {
5729     const Loop *L = AR->getLoop();
5730     if (isLoopInvariant(LHS, L) && properlyDominates(LHS, L->getHeader())) {
5731       std::swap(LHS, RHS);
5732       Pred = ICmpInst::getSwappedPredicate(Pred);
5733       Changed = true;
5734     }
5735   }
5736
5737   // If there's a constant operand, canonicalize comparisons with boundary
5738   // cases, and canonicalize *-or-equal comparisons to regular comparisons.
5739   if (const SCEVConstant *RC = dyn_cast<SCEVConstant>(RHS)) {
5740     const APInt &RA = RC->getValue()->getValue();
5741     switch (Pred) {
5742     default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
5743     case ICmpInst::ICMP_EQ:
5744     case ICmpInst::ICMP_NE:
5745       // Fold ((-1) * %a) + %b == 0 (equivalent to %b-%a == 0) into %a == %b.
5746       if (!RA)
5747         if (const SCEVAddExpr *AE = dyn_cast<SCEVAddExpr>(LHS))
5748           if (const SCEVMulExpr *ME = dyn_cast<SCEVMulExpr>(AE->getOperand(0)))
5749             if (AE->getNumOperands() == 2 && ME->getNumOperands() == 2 &&
5750                 ME->getOperand(0)->isAllOnesValue()) {
5751               RHS = AE->getOperand(1);
5752               LHS = ME->getOperand(1);
5753               Changed = true;
5754             }
5755       break;
5756     case ICmpInst::ICMP_UGE:
5757       if ((RA - 1).isMinValue()) {
5758         Pred = ICmpInst::ICMP_NE;
5759         RHS = getConstant(RA - 1);
5760         Changed = true;
5761         break;
5762       }
5763       if (RA.isMaxValue()) {
5764         Pred = ICmpInst::ICMP_EQ;
5765         Changed = true;
5766         break;
5767       }
5768       if (RA.isMinValue()) goto trivially_true;
5769
5770       Pred = ICmpInst::ICMP_UGT;
5771       RHS = getConstant(RA - 1);
5772       Changed = true;
5773       break;
5774     case ICmpInst::ICMP_ULE:
5775       if ((RA + 1).isMaxValue()) {
5776         Pred = ICmpInst::ICMP_NE;
5777         RHS = getConstant(RA + 1);
5778         Changed = true;
5779         break;
5780       }
5781       if (RA.isMinValue()) {
5782         Pred = ICmpInst::ICMP_EQ;
5783         Changed = true;
5784         break;
5785       }
5786       if (RA.isMaxValue()) goto trivially_true;
5787
5788       Pred = ICmpInst::ICMP_ULT;
5789       RHS = getConstant(RA + 1);
5790       Changed = true;
5791       break;
5792     case ICmpInst::ICMP_SGE:
5793       if ((RA - 1).isMinSignedValue()) {
5794         Pred = ICmpInst::ICMP_NE;
5795         RHS = getConstant(RA - 1);
5796         Changed = true;
5797         break;
5798       }
5799       if (RA.isMaxSignedValue()) {
5800         Pred = ICmpInst::ICMP_EQ;
5801         Changed = true;
5802         break;
5803       }
5804       if (RA.isMinSignedValue()) goto trivially_true;
5805
5806       Pred = ICmpInst::ICMP_SGT;
5807       RHS = getConstant(RA - 1);
5808       Changed = true;
5809       break;
5810     case ICmpInst::ICMP_SLE:
5811       if ((RA + 1).isMaxSignedValue()) {
5812         Pred = ICmpInst::ICMP_NE;
5813         RHS = getConstant(RA + 1);
5814         Changed = true;
5815         break;
5816       }
5817       if (RA.isMinSignedValue()) {
5818         Pred = ICmpInst::ICMP_EQ;
5819         Changed = true;
5820         break;
5821       }
5822       if (RA.isMaxSignedValue()) goto trivially_true;
5823
5824       Pred = ICmpInst::ICMP_SLT;
5825       RHS = getConstant(RA + 1);
5826       Changed = true;
5827       break;
5828     case ICmpInst::ICMP_UGT:
5829       if (RA.isMinValue()) {
5830         Pred = ICmpInst::ICMP_NE;
5831         Changed = true;
5832         break;
5833       }
5834       if ((RA + 1).isMaxValue()) {
5835         Pred = ICmpInst::ICMP_EQ;
5836         RHS = getConstant(RA + 1);
5837         Changed = true;
5838         break;
5839       }
5840       if (RA.isMaxValue()) goto trivially_false;
5841       break;
5842     case ICmpInst::ICMP_ULT:
5843       if (RA.isMaxValue()) {
5844         Pred = ICmpInst::ICMP_NE;
5845         Changed = true;
5846         break;
5847       }
5848       if ((RA - 1).isMinValue()) {
5849         Pred = ICmpInst::ICMP_EQ;
5850         RHS = getConstant(RA - 1);
5851         Changed = true;
5852         break;
5853       }
5854       if (RA.isMinValue()) goto trivially_false;
5855       break;
5856     case ICmpInst::ICMP_SGT:
5857       if (RA.isMinSignedValue()) {
5858         Pred = ICmpInst::ICMP_NE;
5859         Changed = true;
5860         break;
5861       }
5862       if ((RA + 1).isMaxSignedValue()) {
5863         Pred = ICmpInst::ICMP_EQ;
5864         RHS = getConstant(RA + 1);
5865         Changed = true;
5866         break;
5867       }
5868       if (RA.isMaxSignedValue()) goto trivially_false;
5869       break;
5870     case ICmpInst::ICMP_SLT:
5871       if (RA.isMaxSignedValue()) {
5872         Pred = ICmpInst::ICMP_NE;
5873         Changed = true;
5874         break;
5875       }
5876       if ((RA - 1).isMinSignedValue()) {
5877        Pred = ICmpInst::ICMP_EQ;
5878        RHS = getConstant(RA - 1);
5879         Changed = true;
5880        break;
5881       }
5882       if (RA.isMinSignedValue()) goto trivially_false;
5883       break;
5884     }
5885   }
5886
5887   // Check for obvious equality.
5888   if (HasSameValue(LHS, RHS)) {
5889     if (ICmpInst::isTrueWhenEqual(Pred))
5890       goto trivially_true;
5891     if (ICmpInst::isFalseWhenEqual(Pred))
5892       goto trivially_false;
5893   }
5894
5895   // If possible, canonicalize GE/LE comparisons to GT/LT comparisons, by
5896   // adding or subtracting 1 from one of the operands.
5897   switch (Pred) {
5898   case ICmpInst::ICMP_SLE:
5899     if (!getSignedRange(RHS).getSignedMax().isMaxSignedValue()) {
5900       RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
5901                        SCEV::FlagNSW);
5902       Pred = ICmpInst::ICMP_SLT;
5903       Changed = true;
5904     } else if (!getSignedRange(LHS).getSignedMin().isMinSignedValue()) {
5905       LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
5906                        SCEV::FlagNSW);
5907       Pred = ICmpInst::ICMP_SLT;
5908       Changed = true;
5909     }
5910     break;
5911   case ICmpInst::ICMP_SGE:
5912     if (!getSignedRange(RHS).getSignedMin().isMinSignedValue()) {
5913       RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
5914                        SCEV::FlagNSW);
5915       Pred = ICmpInst::ICMP_SGT;
5916       Changed = true;
5917     } else if (!getSignedRange(LHS).getSignedMax().isMaxSignedValue()) {
5918       LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
5919                        SCEV::FlagNSW);
5920       Pred = ICmpInst::ICMP_SGT;
5921       Changed = true;
5922     }
5923     break;
5924   case ICmpInst::ICMP_ULE:
5925     if (!getUnsignedRange(RHS).getUnsignedMax().isMaxValue()) {
5926       RHS = getAddExpr(getConstant(RHS->getType(), 1, true), RHS,
5927                        SCEV::FlagNUW);
5928       Pred = ICmpInst::ICMP_ULT;
5929       Changed = true;
5930     } else if (!getUnsignedRange(LHS).getUnsignedMin().isMinValue()) {
5931       LHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), LHS,
5932                        SCEV::FlagNUW);
5933       Pred = ICmpInst::ICMP_ULT;
5934       Changed = true;
5935     }
5936     break;
5937   case ICmpInst::ICMP_UGE:
5938     if (!getUnsignedRange(RHS).getUnsignedMin().isMinValue()) {
5939       RHS = getAddExpr(getConstant(RHS->getType(), (uint64_t)-1, true), RHS,
5940                        SCEV::FlagNUW);
5941       Pred = ICmpInst::ICMP_UGT;
5942       Changed = true;
5943     } else if (!getUnsignedRange(LHS).getUnsignedMax().isMaxValue()) {
5944       LHS = getAddExpr(getConstant(RHS->getType(), 1, true), LHS,
5945                        SCEV::FlagNUW);
5946       Pred = ICmpInst::ICMP_UGT;
5947       Changed = true;
5948     }
5949     break;
5950   default:
5951     break;
5952   }
5953
5954   // TODO: More simplifications are possible here.
5955
5956   // Recursively simplify until we either hit a recursion limit or nothing
5957   // changes.
5958   if (Changed)
5959     return SimplifyICmpOperands(Pred, LHS, RHS, Depth+1);
5960
5961   return Changed;
5962
5963 trivially_true:
5964   // Return 0 == 0.
5965   LHS = RHS = getConstant(ConstantInt::getFalse(getContext()));
5966   Pred = ICmpInst::ICMP_EQ;
5967   return true;
5968
5969 trivially_false:
5970   // Return 0 != 0.
5971   LHS = RHS = getConstant(ConstantInt::getFalse(getContext()));
5972   Pred = ICmpInst::ICMP_NE;
5973   return true;
5974 }
5975
5976 bool ScalarEvolution::isKnownNegative(const SCEV *S) {
5977   return getSignedRange(S).getSignedMax().isNegative();
5978 }
5979
5980 bool ScalarEvolution::isKnownPositive(const SCEV *S) {
5981   return getSignedRange(S).getSignedMin().isStrictlyPositive();
5982 }
5983
5984 bool ScalarEvolution::isKnownNonNegative(const SCEV *S) {
5985   return !getSignedRange(S).getSignedMin().isNegative();
5986 }
5987
5988 bool ScalarEvolution::isKnownNonPositive(const SCEV *S) {
5989   return !getSignedRange(S).getSignedMax().isStrictlyPositive();
5990 }
5991
5992 bool ScalarEvolution::isKnownNonZero(const SCEV *S) {
5993   return isKnownNegative(S) || isKnownPositive(S);
5994 }
5995
5996 bool ScalarEvolution::isKnownPredicate(ICmpInst::Predicate Pred,
5997                                        const SCEV *LHS, const SCEV *RHS) {
5998   // Canonicalize the inputs first.
5999   (void)SimplifyICmpOperands(Pred, LHS, RHS);
6000
6001   // If LHS or RHS is an addrec, check to see if the condition is true in
6002   // every iteration of the loop.
6003   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(LHS))
6004     if (isLoopEntryGuardedByCond(
6005           AR->getLoop(), Pred, AR->getStart(), RHS) &&
6006         isLoopBackedgeGuardedByCond(
6007           AR->getLoop(), Pred, AR->getPostIncExpr(*this), RHS))
6008       return true;
6009   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(RHS))
6010     if (isLoopEntryGuardedByCond(
6011           AR->getLoop(), Pred, LHS, AR->getStart()) &&
6012         isLoopBackedgeGuardedByCond(
6013           AR->getLoop(), Pred, LHS, AR->getPostIncExpr(*this)))
6014       return true;
6015
6016   // Otherwise see what can be done with known constant ranges.
6017   return isKnownPredicateWithRanges(Pred, LHS, RHS);
6018 }
6019
6020 bool
6021 ScalarEvolution::isKnownPredicateWithRanges(ICmpInst::Predicate Pred,
6022                                             const SCEV *LHS, const SCEV *RHS) {
6023   if (HasSameValue(LHS, RHS))
6024     return ICmpInst::isTrueWhenEqual(Pred);
6025
6026   // This code is split out from isKnownPredicate because it is called from
6027   // within isLoopEntryGuardedByCond.
6028   switch (Pred) {
6029   default:
6030     llvm_unreachable("Unexpected ICmpInst::Predicate value!");
6031   case ICmpInst::ICMP_SGT:
6032     Pred = ICmpInst::ICMP_SLT;
6033     std::swap(LHS, RHS);
6034   case ICmpInst::ICMP_SLT: {
6035     ConstantRange LHSRange = getSignedRange(LHS);
6036     ConstantRange RHSRange = getSignedRange(RHS);
6037     if (LHSRange.getSignedMax().slt(RHSRange.getSignedMin()))
6038       return true;
6039     if (LHSRange.getSignedMin().sge(RHSRange.getSignedMax()))
6040       return false;
6041     break;
6042   }
6043   case ICmpInst::ICMP_SGE:
6044     Pred = ICmpInst::ICMP_SLE;
6045     std::swap(LHS, RHS);
6046   case ICmpInst::ICMP_SLE: {
6047     ConstantRange LHSRange = getSignedRange(LHS);
6048     ConstantRange RHSRange = getSignedRange(RHS);
6049     if (LHSRange.getSignedMax().sle(RHSRange.getSignedMin()))
6050       return true;
6051     if (LHSRange.getSignedMin().sgt(RHSRange.getSignedMax()))
6052       return false;
6053     break;
6054   }
6055   case ICmpInst::ICMP_UGT:
6056     Pred = ICmpInst::ICMP_ULT;
6057     std::swap(LHS, RHS);
6058   case ICmpInst::ICMP_ULT: {
6059     ConstantRange LHSRange = getUnsignedRange(LHS);
6060     ConstantRange RHSRange = getUnsignedRange(RHS);
6061     if (LHSRange.getUnsignedMax().ult(RHSRange.getUnsignedMin()))
6062       return true;
6063     if (LHSRange.getUnsignedMin().uge(RHSRange.getUnsignedMax()))
6064       return false;
6065     break;
6066   }
6067   case ICmpInst::ICMP_UGE:
6068     Pred = ICmpInst::ICMP_ULE;
6069     std::swap(LHS, RHS);
6070   case ICmpInst::ICMP_ULE: {
6071     ConstantRange LHSRange = getUnsignedRange(LHS);
6072     ConstantRange RHSRange = getUnsignedRange(RHS);
6073     if (LHSRange.getUnsignedMax().ule(RHSRange.getUnsignedMin()))
6074       return true;
6075     if (LHSRange.getUnsignedMin().ugt(RHSRange.getUnsignedMax()))
6076       return false;
6077     break;
6078   }
6079   case ICmpInst::ICMP_NE: {
6080     if (getUnsignedRange(LHS).intersectWith(getUnsignedRange(RHS)).isEmptySet())
6081       return true;
6082     if (getSignedRange(LHS).intersectWith(getSignedRange(RHS)).isEmptySet())
6083       return true;
6084
6085     const SCEV *Diff = getMinusSCEV(LHS, RHS);
6086     if (isKnownNonZero(Diff))
6087       return true;
6088     break;
6089   }
6090   case ICmpInst::ICMP_EQ:
6091     // The check at the top of the function catches the case where
6092     // the values are known to be equal.
6093     break;
6094   }
6095   return false;
6096 }
6097
6098 /// isLoopBackedgeGuardedByCond - Test whether the backedge of the loop is
6099 /// protected by a conditional between LHS and RHS.  This is used to
6100 /// to eliminate casts.
6101 bool
6102 ScalarEvolution::isLoopBackedgeGuardedByCond(const Loop *L,
6103                                              ICmpInst::Predicate Pred,
6104                                              const SCEV *LHS, const SCEV *RHS) {
6105   // Interpret a null as meaning no loop, where there is obviously no guard
6106   // (interprocedural conditions notwithstanding).
6107   if (!L) return true;
6108
6109   BasicBlock *Latch = L->getLoopLatch();
6110   if (!Latch)
6111     return false;
6112
6113   BranchInst *LoopContinuePredicate =
6114     dyn_cast<BranchInst>(Latch->getTerminator());
6115   if (!LoopContinuePredicate ||
6116       LoopContinuePredicate->isUnconditional())
6117     return false;
6118
6119   return isImpliedCond(Pred, LHS, RHS,
6120                        LoopContinuePredicate->getCondition(),
6121                        LoopContinuePredicate->getSuccessor(0) != L->getHeader());
6122 }
6123
6124 /// isLoopEntryGuardedByCond - Test whether entry to the loop is protected
6125 /// by a conditional between LHS and RHS.  This is used to help avoid max
6126 /// expressions in loop trip counts, and to eliminate casts.
6127 bool
6128 ScalarEvolution::isLoopEntryGuardedByCond(const Loop *L,
6129                                           ICmpInst::Predicate Pred,
6130                                           const SCEV *LHS, const SCEV *RHS) {
6131   // Interpret a null as meaning no loop, where there is obviously no guard
6132   // (interprocedural conditions notwithstanding).
6133   if (!L) return false;
6134
6135   // Starting at the loop predecessor, climb up the predecessor chain, as long
6136   // as there are predecessors that can be found that have unique successors
6137   // leading to the original header.
6138   for (std::pair<BasicBlock *, BasicBlock *>
6139          Pair(L->getLoopPredecessor(), L->getHeader());
6140        Pair.first;
6141        Pair = getPredecessorWithUniqueSuccessorForBB(Pair.first)) {
6142
6143     BranchInst *LoopEntryPredicate =
6144       dyn_cast<BranchInst>(Pair.first->getTerminator());
6145     if (!LoopEntryPredicate ||
6146         LoopEntryPredicate->isUnconditional())
6147       continue;
6148
6149     if (isImpliedCond(Pred, LHS, RHS,
6150                       LoopEntryPredicate->getCondition(),
6151                       LoopEntryPredicate->getSuccessor(0) != Pair.second))
6152       return true;
6153   }
6154
6155   return false;
6156 }
6157
6158 /// RAII wrapper to prevent recursive application of isImpliedCond.
6159 /// ScalarEvolution's PendingLoopPredicates set must be empty unless we are
6160 /// currently evaluating isImpliedCond.
6161 struct MarkPendingLoopPredicate {
6162   Value *Cond;
6163   DenseSet<Value*> &LoopPreds;
6164   bool Pending;
6165
6166   MarkPendingLoopPredicate(Value *C, DenseSet<Value*> &LP)
6167     : Cond(C), LoopPreds(LP) {
6168     Pending = !LoopPreds.insert(Cond).second;
6169   }
6170   ~MarkPendingLoopPredicate() {
6171     if (!Pending)
6172       LoopPreds.erase(Cond);
6173   }
6174 };
6175
6176 /// isImpliedCond - Test whether the condition described by Pred, LHS,
6177 /// and RHS is true whenever the given Cond value evaluates to true.
6178 bool ScalarEvolution::isImpliedCond(ICmpInst::Predicate Pred,
6179                                     const SCEV *LHS, const SCEV *RHS,
6180                                     Value *FoundCondValue,
6181                                     bool Inverse) {
6182   MarkPendingLoopPredicate Mark(FoundCondValue, PendingLoopPredicates);
6183   if (Mark.Pending)
6184     return false;
6185
6186   // Recursively handle And and Or conditions.
6187   if (BinaryOperator *BO = dyn_cast<BinaryOperator>(FoundCondValue)) {
6188     if (BO->getOpcode() == Instruction::And) {
6189       if (!Inverse)
6190         return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
6191                isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
6192     } else if (BO->getOpcode() == Instruction::Or) {
6193       if (Inverse)
6194         return isImpliedCond(Pred, LHS, RHS, BO->getOperand(0), Inverse) ||
6195                isImpliedCond(Pred, LHS, RHS, BO->getOperand(1), Inverse);
6196     }
6197   }
6198
6199   ICmpInst *ICI = dyn_cast<ICmpInst>(FoundCondValue);
6200   if (!ICI) return false;
6201
6202   // Bail if the ICmp's operands' types are wider than the needed type
6203   // before attempting to call getSCEV on them. This avoids infinite
6204   // recursion, since the analysis of widening casts can require loop
6205   // exit condition information for overflow checking, which would
6206   // lead back here.
6207   if (getTypeSizeInBits(LHS->getType()) <
6208       getTypeSizeInBits(ICI->getOperand(0)->getType()))
6209     return false;
6210
6211   // Now that we found a conditional branch that dominates the loop or controls
6212   // the loop latch. Check to see if it is the comparison we are looking for.
6213   ICmpInst::Predicate FoundPred;
6214   if (Inverse)
6215     FoundPred = ICI->getInversePredicate();
6216   else
6217     FoundPred = ICI->getPredicate();
6218
6219   const SCEV *FoundLHS = getSCEV(ICI->getOperand(0));
6220   const SCEV *FoundRHS = getSCEV(ICI->getOperand(1));
6221
6222   // Balance the types. The case where FoundLHS' type is wider than
6223   // LHS' type is checked for above.
6224   if (getTypeSizeInBits(LHS->getType()) >
6225       getTypeSizeInBits(FoundLHS->getType())) {
6226     if (CmpInst::isSigned(Pred)) {
6227       FoundLHS = getSignExtendExpr(FoundLHS, LHS->getType());
6228       FoundRHS = getSignExtendExpr(FoundRHS, LHS->getType());
6229     } else {
6230       FoundLHS = getZeroExtendExpr(FoundLHS, LHS->getType());
6231       FoundRHS = getZeroExtendExpr(FoundRHS, LHS->getType());
6232     }
6233   }
6234
6235   // Canonicalize the query to match the way instcombine will have
6236   // canonicalized the comparison.
6237   if (SimplifyICmpOperands(Pred, LHS, RHS))
6238     if (LHS == RHS)
6239       return CmpInst::isTrueWhenEqual(Pred);
6240   if (SimplifyICmpOperands(FoundPred, FoundLHS, FoundRHS))
6241     if (FoundLHS == FoundRHS)
6242       return CmpInst::isFalseWhenEqual(FoundPred);
6243
6244   // Check to see if we can make the LHS or RHS match.
6245   if (LHS == FoundRHS || RHS == FoundLHS) {
6246     if (isa<SCEVConstant>(RHS)) {
6247       std::swap(FoundLHS, FoundRHS);
6248       FoundPred = ICmpInst::getSwappedPredicate(FoundPred);
6249     } else {
6250       std::swap(LHS, RHS);
6251       Pred = ICmpInst::getSwappedPredicate(Pred);
6252     }
6253   }
6254
6255   // Check whether the found predicate is the same as the desired predicate.
6256   if (FoundPred == Pred)
6257     return isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS);
6258
6259   // Check whether swapping the found predicate makes it the same as the
6260   // desired predicate.
6261   if (ICmpInst::getSwappedPredicate(FoundPred) == Pred) {
6262     if (isa<SCEVConstant>(RHS))
6263       return isImpliedCondOperands(Pred, LHS, RHS, FoundRHS, FoundLHS);
6264     else
6265       return isImpliedCondOperands(ICmpInst::getSwappedPredicate(Pred),
6266                                    RHS, LHS, FoundLHS, FoundRHS);
6267   }
6268
6269   // Check whether the actual condition is beyond sufficient.
6270   if (FoundPred == ICmpInst::ICMP_EQ)
6271     if (ICmpInst::isTrueWhenEqual(Pred))
6272       if (isImpliedCondOperands(Pred, LHS, RHS, FoundLHS, FoundRHS))
6273         return true;
6274   if (Pred == ICmpInst::ICMP_NE)
6275     if (!ICmpInst::isTrueWhenEqual(FoundPred))
6276       if (isImpliedCondOperands(FoundPred, LHS, RHS, FoundLHS, FoundRHS))
6277         return true;
6278
6279   // Otherwise assume the worst.
6280   return false;
6281 }
6282
6283 /// isImpliedCondOperands - Test whether the condition described by Pred,
6284 /// LHS, and RHS is true whenever the condition described by Pred, FoundLHS,
6285 /// and FoundRHS is true.
6286 bool ScalarEvolution::isImpliedCondOperands(ICmpInst::Predicate Pred,
6287                                             const SCEV *LHS, const SCEV *RHS,
6288                                             const SCEV *FoundLHS,
6289                                             const SCEV *FoundRHS) {
6290   return isImpliedCondOperandsHelper(Pred, LHS, RHS,
6291                                      FoundLHS, FoundRHS) ||
6292          // ~x < ~y --> x > y
6293          isImpliedCondOperandsHelper(Pred, LHS, RHS,
6294                                      getNotSCEV(FoundRHS),
6295                                      getNotSCEV(FoundLHS));
6296 }
6297
6298 /// isImpliedCondOperandsHelper - Test whether the condition described by
6299 /// Pred, LHS, and RHS is true whenever the condition described by Pred,
6300 /// FoundLHS, and FoundRHS is true.
6301 bool
6302 ScalarEvolution::isImpliedCondOperandsHelper(ICmpInst::Predicate Pred,
6303                                              const SCEV *LHS, const SCEV *RHS,
6304                                              const SCEV *FoundLHS,
6305                                              const SCEV *FoundRHS) {
6306   switch (Pred) {
6307   default: llvm_unreachable("Unexpected ICmpInst::Predicate value!");
6308   case ICmpInst::ICMP_EQ:
6309   case ICmpInst::ICMP_NE:
6310     if (HasSameValue(LHS, FoundLHS) && HasSameValue(RHS, FoundRHS))
6311       return true;
6312     break;
6313   case ICmpInst::ICMP_SLT:
6314   case ICmpInst::ICMP_SLE:
6315     if (isKnownPredicateWithRanges(ICmpInst::ICMP_SLE, LHS, FoundLHS) &&
6316         isKnownPredicateWithRanges(ICmpInst::ICMP_SGE, RHS, FoundRHS))
6317       return true;
6318     break;
6319   case ICmpInst::ICMP_SGT:
6320   case ICmpInst::ICMP_SGE:
6321     if (isKnownPredicateWithRanges(ICmpInst::ICMP_SGE, LHS, FoundLHS) &&
6322         isKnownPredicateWithRanges(ICmpInst::ICMP_SLE, RHS, FoundRHS))
6323       return true;
6324     break;
6325   case ICmpInst::ICMP_ULT:
6326   case ICmpInst::ICMP_ULE:
6327     if (isKnownPredicateWithRanges(ICmpInst::ICMP_ULE, LHS, FoundLHS) &&
6328         isKnownPredicateWithRanges(ICmpInst::ICMP_UGE, RHS, FoundRHS))
6329       return true;
6330     break;
6331   case ICmpInst::ICMP_UGT:
6332   case ICmpInst::ICMP_UGE:
6333     if (isKnownPredicateWithRanges(ICmpInst::ICMP_UGE, LHS, FoundLHS) &&
6334         isKnownPredicateWithRanges(ICmpInst::ICMP_ULE, RHS, FoundRHS))
6335       return true;
6336     break;
6337   }
6338
6339   return false;
6340 }
6341
6342 /// getBECount - Subtract the end and start values and divide by the step,
6343 /// rounding up, to get the number of times the backedge is executed. Return
6344 /// CouldNotCompute if an intermediate computation overflows.
6345 const SCEV *ScalarEvolution::getBECount(const SCEV *Start,
6346                                         const SCEV *End,
6347                                         const SCEV *Step,
6348                                         bool NoWrap) {
6349   assert(!isKnownNegative(Step) &&
6350          "This code doesn't handle negative strides yet!");
6351
6352   Type *Ty = Start->getType();
6353
6354   // When Start == End, we have an exact BECount == 0. Short-circuit this case
6355   // here because SCEV may not be able to determine that the unsigned division
6356   // after rounding is zero.
6357   if (Start == End)
6358     return getConstant(Ty, 0);
6359
6360   const SCEV *NegOne = getConstant(Ty, (uint64_t)-1);
6361   const SCEV *Diff = getMinusSCEV(End, Start);
6362   const SCEV *RoundUp = getAddExpr(Step, NegOne);
6363
6364   // Add an adjustment to the difference between End and Start so that
6365   // the division will effectively round up.
6366   const SCEV *Add = getAddExpr(Diff, RoundUp);
6367
6368   if (!NoWrap) {
6369     // Check Add for unsigned overflow.
6370     // TODO: More sophisticated things could be done here.
6371     Type *WideTy = IntegerType::get(getContext(),
6372                                           getTypeSizeInBits(Ty) + 1);
6373     const SCEV *EDiff = getZeroExtendExpr(Diff, WideTy);
6374     const SCEV *ERoundUp = getZeroExtendExpr(RoundUp, WideTy);
6375     const SCEV *OperandExtendedAdd = getAddExpr(EDiff, ERoundUp);
6376     if (getZeroExtendExpr(Add, WideTy) != OperandExtendedAdd)
6377       return getCouldNotCompute();
6378   }
6379
6380   return getUDivExpr(Add, Step);
6381 }
6382
6383 /// HowManyLessThans - Return the number of times a backedge containing the
6384 /// specified less-than comparison will execute.  If not computable, return
6385 /// CouldNotCompute.
6386 ///
6387 /// @param IsSubExpr is true when the LHS < RHS condition does not directly
6388 /// control the branch. In this case, we can only compute an iteration count for
6389 /// a subexpression that cannot overflow before evaluating true.
6390 ScalarEvolution::ExitLimit
6391 ScalarEvolution::HowManyLessThans(const SCEV *LHS, const SCEV *RHS,
6392                                   const Loop *L, bool isSigned,
6393                                   bool IsSubExpr) {
6394   // Only handle:  "ADDREC < LoopInvariant".
6395   if (!isLoopInvariant(RHS, L)) return getCouldNotCompute();
6396
6397   const SCEVAddRecExpr *AddRec = dyn_cast<SCEVAddRecExpr>(LHS);
6398   if (!AddRec || AddRec->getLoop() != L)
6399     return getCouldNotCompute();
6400
6401   if (AddRec->isAffine()) {
6402     unsigned BitWidth = getTypeSizeInBits(AddRec->getType());
6403     const SCEV *Step = AddRec->getStepRecurrence(*this);
6404
6405     if (Step->isZero())
6406       return getCouldNotCompute();
6407     if (Step->isOne()) {
6408       // With unit stride, the iteration never steps past the limit value.
6409     } else if (isKnownPositive(Step)) {
6410       // Test whether a positive iteration can step past the limit value and
6411       // past the maximum value for its type in a single step. The NSW/NUW flags
6412       // can imply that stepping past RHS would immediately result in undefined
6413       // behavior. No self-wrap is not useful here because the loop counter may
6414       // signed or unsigned wrap but continue iterating and terminate with
6415       // defined behavior without ever self-wrapping.
6416       const SCEV *One = getConstant(Step->getType(), 1);
6417       if (isSigned) {
6418         if (!AddRec->getNoWrapFlags(SCEV::FlagNSW)) {
6419           APInt Max = APInt::getSignedMaxValue(BitWidth);
6420           if ((Max - getSignedRange(getMinusSCEV(Step, One)).getSignedMax())
6421               .slt(getSignedRange(RHS).getSignedMax()))
6422             return getCouldNotCompute();
6423         }
6424       } else if (!AddRec->getNoWrapFlags(SCEV::FlagNUW)){
6425         APInt Max = APInt::getMaxValue(BitWidth);
6426         if ((Max - getUnsignedRange(getMinusSCEV(Step, One)).getUnsignedMax())
6427               .ult(getUnsignedRange(RHS).getUnsignedMax()))
6428           return getCouldNotCompute();
6429       }
6430     } else
6431       // TODO: Handle negative strides here and below.
6432       return getCouldNotCompute();
6433
6434     // We know the LHS is of the form {n,+,s} and the RHS is some loop-invariant
6435     // m.  So, we count the number of iterations in which {n,+,s} < m is true.
6436     // Note that we cannot simply return max(m-n,0)/s because it's not safe to
6437     // treat m-n as signed nor unsigned due to overflow possibility.
6438
6439     // First, we get the value of the LHS in the first iteration: n
6440     const SCEV *Start = AddRec->getOperand(0);
6441
6442     // Determine the minimum constant start value.
6443     const SCEV *MinStart = getConstant(isSigned ?
6444       getSignedRange(Start).getSignedMin() :
6445       getUnsignedRange(Start).getUnsignedMin());
6446
6447     // If we know that the condition is true in order to enter the loop,
6448     // then we know that it will run exactly (m-n)/s times. Otherwise, we
6449     // only know that it will execute (max(m,n)-n)/s times. In both cases,
6450     // the division must round up.
6451     const SCEV *End = RHS;
6452     if (!isLoopEntryGuardedByCond(L,
6453                                   isSigned ? ICmpInst::ICMP_SLT :
6454                                              ICmpInst::ICMP_ULT,
6455                                   getMinusSCEV(Start, Step), RHS))
6456       End = isSigned ? getSMaxExpr(RHS, Start)
6457                      : getUMaxExpr(RHS, Start);
6458
6459     // Determine the maximum constant end value.
6460     const SCEV *MaxEnd = getConstant(isSigned ?
6461       getSignedRange(End).getSignedMax() :
6462       getUnsignedRange(End).getUnsignedMax());
6463
6464     // If MaxEnd is within a step of the maximum integer value in its type,
6465     // adjust it down to the minimum value which would produce the same effect.
6466     // This allows the subsequent ceiling division of (N+(step-1))/step to
6467     // compute the correct value.
6468     const SCEV *StepMinusOne = getMinusSCEV(Step,
6469                                             getConstant(Step->getType(), 1));
6470     MaxEnd = isSigned ?
6471       getSMinExpr(MaxEnd,
6472                   getMinusSCEV(getConstant(APInt::getSignedMaxValue(BitWidth)),
6473                                StepMinusOne)) :
6474       getUMinExpr(MaxEnd,
6475                   getMinusSCEV(getConstant(APInt::getMaxValue(BitWidth)),
6476                                StepMinusOne));
6477
6478     // If the loop counter does not self-wrap, then the trip count may be
6479     // computed by dividing the distance by the step. This is independent of
6480     // signed or unsigned wrap.
6481     bool NoWrap = false;
6482     if (!IsSubExpr) {
6483       NoWrap = AddRec->getNoWrapFlags(
6484         (SCEV::NoWrapFlags)(((isSigned ? SCEV::FlagNSW : SCEV::FlagNUW))
6485                             | SCEV::FlagNW));
6486     }
6487     // Finally, we subtract these two values and divide, rounding up, to get
6488     // the number of times the backedge is executed.
6489     const SCEV *BECount = getBECount(Start, End, Step, NoWrap);
6490
6491     // The maximum backedge count is similar, except using the minimum start
6492     // value and the maximum end value.
6493     // If we already have an exact constant BECount, use it instead.
6494     const SCEV *MaxBECount = isa<SCEVConstant>(BECount) ? BECount
6495       : getBECount(MinStart, MaxEnd, Step, NoWrap);
6496
6497     // If the stride is nonconstant, and NoWrap == true, then
6498     // getBECount(MinStart, MaxEnd) may not compute. This would result in an
6499     // exact BECount and invalid MaxBECount, which should be avoided to catch
6500     // more optimization opportunities.
6501     if (isa<SCEVCouldNotCompute>(MaxBECount))
6502       MaxBECount = BECount;
6503
6504     return ExitLimit(BECount, MaxBECount);
6505   }
6506
6507   return getCouldNotCompute();
6508 }
6509
6510 /// getNumIterationsInRange - Return the number of iterations of this loop that
6511 /// produce values in the specified constant range.  Another way of looking at
6512 /// this is that it returns the first iteration number where the value is not in
6513 /// the condition, thus computing the exit count. If the iteration count can't
6514 /// be computed, an instance of SCEVCouldNotCompute is returned.
6515 const SCEV *SCEVAddRecExpr::getNumIterationsInRange(ConstantRange Range,
6516                                                     ScalarEvolution &SE) const {
6517   if (Range.isFullSet())  // Infinite loop.
6518     return SE.getCouldNotCompute();
6519
6520   // If the start is a non-zero constant, shift the range to simplify things.
6521   if (const SCEVConstant *SC = dyn_cast<SCEVConstant>(getStart()))
6522     if (!SC->getValue()->isZero()) {
6523       SmallVector<const SCEV *, 4> Operands(op_begin(), op_end());
6524       Operands[0] = SE.getConstant(SC->getType(), 0);
6525       const SCEV *Shifted = SE.getAddRecExpr(Operands, getLoop(),
6526                                              getNoWrapFlags(FlagNW));
6527       if (const SCEVAddRecExpr *ShiftedAddRec =
6528             dyn_cast<SCEVAddRecExpr>(Shifted))
6529         return ShiftedAddRec->getNumIterationsInRange(
6530                            Range.subtract(SC->getValue()->getValue()), SE);
6531       // This is strange and shouldn't happen.
6532       return SE.getCouldNotCompute();
6533     }
6534
6535   // The only time we can solve this is when we have all constant indices.
6536   // Otherwise, we cannot determine the overflow conditions.
6537   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
6538     if (!isa<SCEVConstant>(getOperand(i)))
6539       return SE.getCouldNotCompute();
6540
6541
6542   // Okay at this point we know that all elements of the chrec are constants and
6543   // that the start element is zero.
6544
6545   // First check to see if the range contains zero.  If not, the first
6546   // iteration exits.
6547   unsigned BitWidth = SE.getTypeSizeInBits(getType());
6548   if (!Range.contains(APInt(BitWidth, 0)))
6549     return SE.getConstant(getType(), 0);
6550
6551   if (isAffine()) {
6552     // If this is an affine expression then we have this situation:
6553     //   Solve {0,+,A} in Range  ===  Ax in Range
6554
6555     // We know that zero is in the range.  If A is positive then we know that
6556     // the upper value of the range must be the first possible exit value.
6557     // If A is negative then the lower of the range is the last possible loop
6558     // value.  Also note that we already checked for a full range.
6559     APInt One(BitWidth,1);
6560     APInt A     = cast<SCEVConstant>(getOperand(1))->getValue()->getValue();
6561     APInt End = A.sge(One) ? (Range.getUpper() - One) : Range.getLower();
6562
6563     // The exit value should be (End+A)/A.
6564     APInt ExitVal = (End + A).udiv(A);
6565     ConstantInt *ExitValue = ConstantInt::get(SE.getContext(), ExitVal);
6566
6567     // Evaluate at the exit value.  If we really did fall out of the valid
6568     // range, then we computed our trip count, otherwise wrap around or other
6569     // things must have happened.
6570     ConstantInt *Val = EvaluateConstantChrecAtConstant(this, ExitValue, SE);
6571     if (Range.contains(Val->getValue()))
6572       return SE.getCouldNotCompute();  // Something strange happened
6573
6574     // Ensure that the previous value is in the range.  This is a sanity check.
6575     assert(Range.contains(
6576            EvaluateConstantChrecAtConstant(this,
6577            ConstantInt::get(SE.getContext(), ExitVal - One), SE)->getValue()) &&
6578            "Linear scev computation is off in a bad way!");
6579     return SE.getConstant(ExitValue);
6580   } else if (isQuadratic()) {
6581     // If this is a quadratic (3-term) AddRec {L,+,M,+,N}, find the roots of the
6582     // quadratic equation to solve it.  To do this, we must frame our problem in
6583     // terms of figuring out when zero is crossed, instead of when
6584     // Range.getUpper() is crossed.
6585     SmallVector<const SCEV *, 4> NewOps(op_begin(), op_end());
6586     NewOps[0] = SE.getNegativeSCEV(SE.getConstant(Range.getUpper()));
6587     const SCEV *NewAddRec = SE.getAddRecExpr(NewOps, getLoop(),
6588                                              // getNoWrapFlags(FlagNW)
6589                                              FlagAnyWrap);
6590
6591     // Next, solve the constructed addrec
6592     std::pair<const SCEV *,const SCEV *> Roots =
6593       SolveQuadraticEquation(cast<SCEVAddRecExpr>(NewAddRec), SE);
6594     const SCEVConstant *R1 = dyn_cast<SCEVConstant>(Roots.first);
6595     const SCEVConstant *R2 = dyn_cast<SCEVConstant>(Roots.second);
6596     if (R1) {
6597       // Pick the smallest positive root value.
6598       if (ConstantInt *CB =
6599           dyn_cast<ConstantInt>(ConstantExpr::getICmp(ICmpInst::ICMP_ULT,
6600                          R1->getValue(), R2->getValue()))) {
6601         if (CB->getZExtValue() == false)
6602           std::swap(R1, R2);   // R1 is the minimum root now.
6603
6604         // Make sure the root is not off by one.  The returned iteration should
6605         // not be in the range, but the previous one should be.  When solving
6606         // for "X*X < 5", for example, we should not return a root of 2.
6607         ConstantInt *R1Val = EvaluateConstantChrecAtConstant(this,
6608                                                              R1->getValue(),
6609                                                              SE);
6610         if (Range.contains(R1Val->getValue())) {
6611           // The next iteration must be out of the range...
6612           ConstantInt *NextVal =
6613                 ConstantInt::get(SE.getContext(), R1->getValue()->getValue()+1);
6614
6615           R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
6616           if (!Range.contains(R1Val->getValue()))
6617             return SE.getConstant(NextVal);
6618           return SE.getCouldNotCompute();  // Something strange happened
6619         }
6620
6621         // If R1 was not in the range, then it is a good return value.  Make
6622         // sure that R1-1 WAS in the range though, just in case.
6623         ConstantInt *NextVal =
6624                ConstantInt::get(SE.getContext(), R1->getValue()->getValue()-1);
6625         R1Val = EvaluateConstantChrecAtConstant(this, NextVal, SE);
6626         if (Range.contains(R1Val->getValue()))
6627           return R1;
6628         return SE.getCouldNotCompute();  // Something strange happened
6629       }
6630     }
6631   }
6632
6633   return SE.getCouldNotCompute();
6634 }
6635
6636
6637
6638 //===----------------------------------------------------------------------===//
6639 //                   SCEVCallbackVH Class Implementation
6640 //===----------------------------------------------------------------------===//
6641
6642 void ScalarEvolution::SCEVCallbackVH::deleted() {
6643   assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
6644   if (PHINode *PN = dyn_cast<PHINode>(getValPtr()))
6645     SE->ConstantEvolutionLoopExitValue.erase(PN);
6646   SE->ValueExprMap.erase(getValPtr());
6647   // this now dangles!
6648 }
6649
6650 void ScalarEvolution::SCEVCallbackVH::allUsesReplacedWith(Value *V) {
6651   assert(SE && "SCEVCallbackVH called with a null ScalarEvolution!");
6652
6653   // Forget all the expressions associated with users of the old value,
6654   // so that future queries will recompute the expressions using the new
6655   // value.
6656   Value *Old = getValPtr();
6657   SmallVector<User *, 16> Worklist;
6658   SmallPtrSet<User *, 8> Visited;
6659   for (Value::use_iterator UI = Old->use_begin(), UE = Old->use_end();
6660        UI != UE; ++UI)
6661     Worklist.push_back(*UI);
6662   while (!Worklist.empty()) {
6663     User *U = Worklist.pop_back_val();
6664     // Deleting the Old value will cause this to dangle. Postpone
6665     // that until everything else is done.
6666     if (U == Old)
6667       continue;
6668     if (!Visited.insert(U))
6669       continue;
6670     if (PHINode *PN = dyn_cast<PHINode>(U))
6671       SE->ConstantEvolutionLoopExitValue.erase(PN);
6672     SE->ValueExprMap.erase(U);
6673     for (Value::use_iterator UI = U->use_begin(), UE = U->use_end();
6674          UI != UE; ++UI)
6675       Worklist.push_back(*UI);
6676   }
6677   // Delete the Old value.
6678   if (PHINode *PN = dyn_cast<PHINode>(Old))
6679     SE->ConstantEvolutionLoopExitValue.erase(PN);
6680   SE->ValueExprMap.erase(Old);
6681   // this now dangles!
6682 }
6683
6684 ScalarEvolution::SCEVCallbackVH::SCEVCallbackVH(Value *V, ScalarEvolution *se)
6685   : CallbackVH(V), SE(se) {}
6686
6687 //===----------------------------------------------------------------------===//
6688 //                   ScalarEvolution Class Implementation
6689 //===----------------------------------------------------------------------===//
6690
6691 ScalarEvolution::ScalarEvolution()
6692   : FunctionPass(ID), FirstUnknown(0) {
6693   initializeScalarEvolutionPass(*PassRegistry::getPassRegistry());
6694 }
6695
6696 bool ScalarEvolution::runOnFunction(Function &F) {
6697   this->F = &F;
6698   LI = &getAnalysis<LoopInfo>();
6699   TD = getAnalysisIfAvailable<DataLayout>();
6700   TLI = &getAnalysis<TargetLibraryInfo>();
6701   DT = &getAnalysis<DominatorTree>();
6702   return false;
6703 }
6704
6705 void ScalarEvolution::releaseMemory() {
6706   // Iterate through all the SCEVUnknown instances and call their
6707   // destructors, so that they release their references to their values.
6708   for (SCEVUnknown *U = FirstUnknown; U; U = U->Next)
6709     U->~SCEVUnknown();
6710   FirstUnknown = 0;
6711
6712   ValueExprMap.clear();
6713
6714   // Free any extra memory created for ExitNotTakenInfo in the unlikely event
6715   // that a loop had multiple computable exits.
6716   for (DenseMap<const Loop*, BackedgeTakenInfo>::iterator I =
6717          BackedgeTakenCounts.begin(), E = BackedgeTakenCounts.end();
6718        I != E; ++I) {
6719     I->second.clear();
6720   }
6721
6722   assert(PendingLoopPredicates.empty() && "isImpliedCond garbage");
6723
6724   BackedgeTakenCounts.clear();
6725   ConstantEvolutionLoopExitValue.clear();
6726   ValuesAtScopes.clear();
6727   LoopDispositions.clear();
6728   BlockDispositions.clear();
6729   UnsignedRanges.clear();
6730   SignedRanges.clear();
6731   UniqueSCEVs.clear();
6732   SCEVAllocator.Reset();
6733 }
6734
6735 void ScalarEvolution::getAnalysisUsage(AnalysisUsage &AU) const {
6736   AU.setPreservesAll();
6737   AU.addRequiredTransitive<LoopInfo>();
6738   AU.addRequiredTransitive<DominatorTree>();
6739   AU.addRequired<TargetLibraryInfo>();
6740 }
6741
6742 bool ScalarEvolution::hasLoopInvariantBackedgeTakenCount(const Loop *L) {
6743   return !isa<SCEVCouldNotCompute>(getBackedgeTakenCount(L));
6744 }
6745
6746 static void PrintLoopInfo(raw_ostream &OS, ScalarEvolution *SE,
6747                           const Loop *L) {
6748   // Print all inner loops first
6749   for (Loop::iterator I = L->begin(), E = L->end(); I != E; ++I)
6750     PrintLoopInfo(OS, SE, *I);
6751
6752   OS << "Loop ";
6753   WriteAsOperand(OS, L->getHeader(), /*PrintType=*/false);
6754   OS << ": ";
6755
6756   SmallVector<BasicBlock *, 8> ExitBlocks;
6757   L->getExitBlocks(ExitBlocks);
6758   if (ExitBlocks.size() != 1)
6759     OS << "<multiple exits> ";
6760
6761   if (SE->hasLoopInvariantBackedgeTakenCount(L)) {
6762     OS << "backedge-taken count is " << *SE->getBackedgeTakenCount(L);
6763   } else {
6764     OS << "Unpredictable backedge-taken count. ";
6765   }
6766
6767   OS << "\n"
6768         "Loop ";
6769   WriteAsOperand(OS, L->getHeader(), /*PrintType=*/false);
6770   OS << ": ";
6771
6772   if (!isa<SCEVCouldNotCompute>(SE->getMaxBackedgeTakenCount(L))) {
6773     OS << "max backedge-taken count is " << *SE->getMaxBackedgeTakenCount(L);
6774   } else {
6775     OS << "Unpredictable max backedge-taken count. ";
6776   }
6777
6778   OS << "\n";
6779 }
6780
6781 void ScalarEvolution::print(raw_ostream &OS, const Module *) const {
6782   // ScalarEvolution's implementation of the print method is to print
6783   // out SCEV values of all instructions that are interesting. Doing
6784   // this potentially causes it to create new SCEV objects though,
6785   // which technically conflicts with the const qualifier. This isn't
6786   // observable from outside the class though, so casting away the
6787   // const isn't dangerous.
6788   ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
6789
6790   OS << "Classifying expressions for: ";
6791   WriteAsOperand(OS, F, /*PrintType=*/false);
6792   OS << "\n";
6793   for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
6794     if (isSCEVable(I->getType()) && !isa<CmpInst>(*I)) {
6795       OS << *I << '\n';
6796       OS << "  -->  ";
6797       const SCEV *SV = SE.getSCEV(&*I);
6798       SV->print(OS);
6799
6800       const Loop *L = LI->getLoopFor((*I).getParent());
6801
6802       const SCEV *AtUse = SE.getSCEVAtScope(SV, L);
6803       if (AtUse != SV) {
6804         OS << "  -->  ";
6805         AtUse->print(OS);
6806       }
6807
6808       if (L) {
6809         OS << "\t\t" "Exits: ";
6810         const SCEV *ExitValue = SE.getSCEVAtScope(SV, L->getParentLoop());
6811         if (!SE.isLoopInvariant(ExitValue, L)) {
6812           OS << "<<Unknown>>";
6813         } else {
6814           OS << *ExitValue;
6815         }
6816       }
6817
6818       OS << "\n";
6819     }
6820
6821   OS << "Determining loop execution counts for: ";
6822   WriteAsOperand(OS, F, /*PrintType=*/false);
6823   OS << "\n";
6824   for (LoopInfo::iterator I = LI->begin(), E = LI->end(); I != E; ++I)
6825     PrintLoopInfo(OS, &SE, *I);
6826 }
6827
6828 ScalarEvolution::LoopDisposition
6829 ScalarEvolution::getLoopDisposition(const SCEV *S, const Loop *L) {
6830   std::map<const Loop *, LoopDisposition> &Values = LoopDispositions[S];
6831   std::pair<std::map<const Loop *, LoopDisposition>::iterator, bool> Pair =
6832     Values.insert(std::make_pair(L, LoopVariant));
6833   if (!Pair.second)
6834     return Pair.first->second;
6835
6836   LoopDisposition D = computeLoopDisposition(S, L);
6837   return LoopDispositions[S][L] = D;
6838 }
6839
6840 ScalarEvolution::LoopDisposition
6841 ScalarEvolution::computeLoopDisposition(const SCEV *S, const Loop *L) {
6842   switch (S->getSCEVType()) {
6843   case scConstant:
6844     return LoopInvariant;
6845   case scTruncate:
6846   case scZeroExtend:
6847   case scSignExtend:
6848     return getLoopDisposition(cast<SCEVCastExpr>(S)->getOperand(), L);
6849   case scAddRecExpr: {
6850     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S);
6851
6852     // If L is the addrec's loop, it's computable.
6853     if (AR->getLoop() == L)
6854       return LoopComputable;
6855
6856     // Add recurrences are never invariant in the function-body (null loop).
6857     if (!L)
6858       return LoopVariant;
6859
6860     // This recurrence is variant w.r.t. L if L contains AR's loop.
6861     if (L->contains(AR->getLoop()))
6862       return LoopVariant;
6863
6864     // This recurrence is invariant w.r.t. L if AR's loop contains L.
6865     if (AR->getLoop()->contains(L))
6866       return LoopInvariant;
6867
6868     // This recurrence is variant w.r.t. L if any of its operands
6869     // are variant.
6870     for (SCEVAddRecExpr::op_iterator I = AR->op_begin(), E = AR->op_end();
6871          I != E; ++I)
6872       if (!isLoopInvariant(*I, L))
6873         return LoopVariant;
6874
6875     // Otherwise it's loop-invariant.
6876     return LoopInvariant;
6877   }
6878   case scAddExpr:
6879   case scMulExpr:
6880   case scUMaxExpr:
6881   case scSMaxExpr: {
6882     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S);
6883     bool HasVarying = false;
6884     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
6885          I != E; ++I) {
6886       LoopDisposition D = getLoopDisposition(*I, L);
6887       if (D == LoopVariant)
6888         return LoopVariant;
6889       if (D == LoopComputable)
6890         HasVarying = true;
6891     }
6892     return HasVarying ? LoopComputable : LoopInvariant;
6893   }
6894   case scUDivExpr: {
6895     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
6896     LoopDisposition LD = getLoopDisposition(UDiv->getLHS(), L);
6897     if (LD == LoopVariant)
6898       return LoopVariant;
6899     LoopDisposition RD = getLoopDisposition(UDiv->getRHS(), L);
6900     if (RD == LoopVariant)
6901       return LoopVariant;
6902     return (LD == LoopInvariant && RD == LoopInvariant) ?
6903            LoopInvariant : LoopComputable;
6904   }
6905   case scUnknown:
6906     // All non-instruction values are loop invariant.  All instructions are loop
6907     // invariant if they are not contained in the specified loop.
6908     // Instructions are never considered invariant in the function body
6909     // (null loop) because they are defined within the "loop".
6910     if (Instruction *I = dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue()))
6911       return (L && !L->contains(I)) ? LoopInvariant : LoopVariant;
6912     return LoopInvariant;
6913   case scCouldNotCompute:
6914     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
6915   default: llvm_unreachable("Unknown SCEV kind!");
6916   }
6917 }
6918
6919 bool ScalarEvolution::isLoopInvariant(const SCEV *S, const Loop *L) {
6920   return getLoopDisposition(S, L) == LoopInvariant;
6921 }
6922
6923 bool ScalarEvolution::hasComputableLoopEvolution(const SCEV *S, const Loop *L) {
6924   return getLoopDisposition(S, L) == LoopComputable;
6925 }
6926
6927 ScalarEvolution::BlockDisposition
6928 ScalarEvolution::getBlockDisposition(const SCEV *S, const BasicBlock *BB) {
6929   std::map<const BasicBlock *, BlockDisposition> &Values = BlockDispositions[S];
6930   std::pair<std::map<const BasicBlock *, BlockDisposition>::iterator, bool>
6931     Pair = Values.insert(std::make_pair(BB, DoesNotDominateBlock));
6932   if (!Pair.second)
6933     return Pair.first->second;
6934
6935   BlockDisposition D = computeBlockDisposition(S, BB);
6936   return BlockDispositions[S][BB] = D;
6937 }
6938
6939 ScalarEvolution::BlockDisposition
6940 ScalarEvolution::computeBlockDisposition(const SCEV *S, const BasicBlock *BB) {
6941   switch (S->getSCEVType()) {
6942   case scConstant:
6943     return ProperlyDominatesBlock;
6944   case scTruncate:
6945   case scZeroExtend:
6946   case scSignExtend:
6947     return getBlockDisposition(cast<SCEVCastExpr>(S)->getOperand(), BB);
6948   case scAddRecExpr: {
6949     // This uses a "dominates" query instead of "properly dominates" query
6950     // to test for proper dominance too, because the instruction which
6951     // produces the addrec's value is a PHI, and a PHI effectively properly
6952     // dominates its entire containing block.
6953     const SCEVAddRecExpr *AR = cast<SCEVAddRecExpr>(S);
6954     if (!DT->dominates(AR->getLoop()->getHeader(), BB))
6955       return DoesNotDominateBlock;
6956   }
6957   // FALL THROUGH into SCEVNAryExpr handling.
6958   case scAddExpr:
6959   case scMulExpr:
6960   case scUMaxExpr:
6961   case scSMaxExpr: {
6962     const SCEVNAryExpr *NAry = cast<SCEVNAryExpr>(S);
6963     bool Proper = true;
6964     for (SCEVNAryExpr::op_iterator I = NAry->op_begin(), E = NAry->op_end();
6965          I != E; ++I) {
6966       BlockDisposition D = getBlockDisposition(*I, BB);
6967       if (D == DoesNotDominateBlock)
6968         return DoesNotDominateBlock;
6969       if (D == DominatesBlock)
6970         Proper = false;
6971     }
6972     return Proper ? ProperlyDominatesBlock : DominatesBlock;
6973   }
6974   case scUDivExpr: {
6975     const SCEVUDivExpr *UDiv = cast<SCEVUDivExpr>(S);
6976     const SCEV *LHS = UDiv->getLHS(), *RHS = UDiv->getRHS();
6977     BlockDisposition LD = getBlockDisposition(LHS, BB);
6978     if (LD == DoesNotDominateBlock)
6979       return DoesNotDominateBlock;
6980     BlockDisposition RD = getBlockDisposition(RHS, BB);
6981     if (RD == DoesNotDominateBlock)
6982       return DoesNotDominateBlock;
6983     return (LD == ProperlyDominatesBlock && RD == ProperlyDominatesBlock) ?
6984       ProperlyDominatesBlock : DominatesBlock;
6985   }
6986   case scUnknown:
6987     if (Instruction *I =
6988           dyn_cast<Instruction>(cast<SCEVUnknown>(S)->getValue())) {
6989       if (I->getParent() == BB)
6990         return DominatesBlock;
6991       if (DT->properlyDominates(I->getParent(), BB))
6992         return ProperlyDominatesBlock;
6993       return DoesNotDominateBlock;
6994     }
6995     return ProperlyDominatesBlock;
6996   case scCouldNotCompute:
6997     llvm_unreachable("Attempt to use a SCEVCouldNotCompute object!");
6998   default:
6999     llvm_unreachable("Unknown SCEV kind!");
7000   }
7001 }
7002
7003 bool ScalarEvolution::dominates(const SCEV *S, const BasicBlock *BB) {
7004   return getBlockDisposition(S, BB) >= DominatesBlock;
7005 }
7006
7007 bool ScalarEvolution::properlyDominates(const SCEV *S, const BasicBlock *BB) {
7008   return getBlockDisposition(S, BB) == ProperlyDominatesBlock;
7009 }
7010
7011 namespace {
7012 // Search for a SCEV expression node within an expression tree.
7013 // Implements SCEVTraversal::Visitor.
7014 struct SCEVSearch {
7015   const SCEV *Node;
7016   bool IsFound;
7017
7018   SCEVSearch(const SCEV *N): Node(N), IsFound(false) {}
7019
7020   bool follow(const SCEV *S) {
7021     IsFound |= (S == Node);
7022     return !IsFound;
7023   }
7024   bool isDone() const { return IsFound; }
7025 };
7026 }
7027
7028 bool ScalarEvolution::hasOperand(const SCEV *S, const SCEV *Op) const {
7029   SCEVSearch Search(Op);
7030   visitAll(S, Search);
7031   return Search.IsFound;
7032 }
7033
7034 void ScalarEvolution::forgetMemoizedResults(const SCEV *S) {
7035   ValuesAtScopes.erase(S);
7036   LoopDispositions.erase(S);
7037   BlockDispositions.erase(S);
7038   UnsignedRanges.erase(S);
7039   SignedRanges.erase(S);
7040
7041   for (DenseMap<const Loop*, BackedgeTakenInfo>::iterator I =
7042          BackedgeTakenCounts.begin(), E = BackedgeTakenCounts.end(); I != E; ) {
7043     BackedgeTakenInfo &BEInfo = I->second;
7044     if (BEInfo.hasOperand(S, this)) {
7045       BEInfo.clear();
7046       BackedgeTakenCounts.erase(I++);
7047     }
7048     else
7049       ++I;
7050   }
7051 }
7052
7053 typedef DenseMap<const Loop *, std::string> VerifyMap;
7054
7055 /// replaceSubString - Replaces all occurences of From in Str with To.
7056 static void replaceSubString(std::string &Str, StringRef From, StringRef To) {
7057   size_t Pos = 0;
7058   while ((Pos = Str.find(From, Pos)) != std::string::npos) {
7059     Str.replace(Pos, From.size(), To.data(), To.size());
7060     Pos += To.size();
7061   }
7062 }
7063
7064 /// getLoopBackedgeTakenCounts - Helper method for verifyAnalysis.
7065 static void
7066 getLoopBackedgeTakenCounts(Loop *L, VerifyMap &Map, ScalarEvolution &SE) {
7067   for (Loop::reverse_iterator I = L->rbegin(), E = L->rend(); I != E; ++I) {
7068     getLoopBackedgeTakenCounts(*I, Map, SE); // recurse.
7069
7070     std::string &S = Map[L];
7071     if (S.empty()) {
7072       raw_string_ostream OS(S);
7073       SE.getBackedgeTakenCount(L)->print(OS);
7074
7075       // false and 0 are semantically equivalent. This can happen in dead loops.
7076       replaceSubString(OS.str(), "false", "0");
7077       // Remove wrap flags, their use in SCEV is highly fragile.
7078       // FIXME: Remove this when SCEV gets smarter about them.
7079       replaceSubString(OS.str(), "<nw>", "");
7080       replaceSubString(OS.str(), "<nsw>", "");
7081       replaceSubString(OS.str(), "<nuw>", "");
7082     }
7083   }
7084 }
7085
7086 void ScalarEvolution::verifyAnalysis() const {
7087   if (!VerifySCEV)
7088     return;
7089
7090   ScalarEvolution &SE = *const_cast<ScalarEvolution *>(this);
7091
7092   // Gather stringified backedge taken counts for all loops using SCEV's caches.
7093   // FIXME: It would be much better to store actual values instead of strings,
7094   //        but SCEV pointers will change if we drop the caches.
7095   VerifyMap BackedgeDumpsOld, BackedgeDumpsNew;
7096   for (LoopInfo::reverse_iterator I = LI->rbegin(), E = LI->rend(); I != E; ++I)
7097     getLoopBackedgeTakenCounts(*I, BackedgeDumpsOld, SE);
7098
7099   // Gather stringified backedge taken counts for all loops without using
7100   // SCEV's caches.
7101   SE.releaseMemory();
7102   for (LoopInfo::reverse_iterator I = LI->rbegin(), E = LI->rend(); I != E; ++I)
7103     getLoopBackedgeTakenCounts(*I, BackedgeDumpsNew, SE);
7104
7105   // Now compare whether they're the same with and without caches. This allows
7106   // verifying that no pass changed the cache.
7107   assert(BackedgeDumpsOld.size() == BackedgeDumpsNew.size() &&
7108          "New loops suddenly appeared!");
7109
7110   for (VerifyMap::iterator OldI = BackedgeDumpsOld.begin(),
7111                            OldE = BackedgeDumpsOld.end(),
7112                            NewI = BackedgeDumpsNew.begin();
7113        OldI != OldE; ++OldI, ++NewI) {
7114     assert(OldI->first == NewI->first && "Loop order changed!");
7115
7116     // Compare the stringified SCEVs. We don't care if undef backedgetaken count
7117     // changes.
7118     // FIXME: We currently ignore SCEV changes from/to CouldNotCompute. This
7119     // means that a pass is buggy or SCEV has to learn a new pattern but is
7120     // usually not harmful.
7121     if (OldI->second != NewI->second &&
7122         OldI->second.find("undef") == std::string::npos &&
7123         NewI->second.find("undef") == std::string::npos &&
7124         OldI->second != "***COULDNOTCOMPUTE***" &&
7125         NewI->second != "***COULDNOTCOMPUTE***") {
7126       dbgs() << "SCEVValidator: SCEV for loop '"
7127              << OldI->first->getHeader()->getName()
7128              << "' changed from '" << OldI->second
7129              << "' to '" << NewI->second << "'!\n";
7130       std::abort();
7131     }
7132   }
7133
7134   // TODO: Verify more things.
7135 }