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