lib/Analysis/ScalarEvolution.cpp

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