lib/Transforms/Scalar/LoopStrengthReduce.cpp

   1 //===- LoopStrengthReduce.cpp - Strength Reduce IVs in Loops --------------===//
   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 transformation analyzes and transforms the induction variables (and
  11 // computations derived from them) into forms suitable for efficient execution
  12 // on the target.
  13 //
  14 // This pass performs a strength reduction on array references inside loops that
  15 // have as one or more of their components the loop induction variable, it
  16 // rewrites expressions to take advantage of scaled-index addressing modes
  17 // available on the target, and it performs a variety of other optimizations
  18 // related to loop induction variables.
  19 //
  20 // Terminology note: this code has a lot of handling for "post-increment" or
  21 // "post-inc" users. This is not talking about post-increment addressing modes;
  22 // it is instead talking about code like this:
  23 //
  24 //   %i = phi [ 0, %entry ], [ %i.next, %latch ]
  25 //   ...
  26 //   %i.next = add %i, 1
  27 //   %c = icmp eq %i.next, %n
  28 //
  29 // The SCEV for %i is {0,+,1}<%L>. The SCEV for %i.next is {1,+,1}<%L>, however
  30 // it's useful to think about these as the same register, with some uses using
  31 // the value of the register before the add and some using // it after. In this
  32 // example, the icmp is a post-increment user, since it uses %i.next, which is
  33 // the value of the induction variable after the increment. The other common
  34 // case of post-increment users is users outside the loop.
  35 //
  36 // TODO: More sophistication in the way Formulae are generated and filtered.
  37 //
  38 // TODO: Handle multiple loops at a time.
  39 //
  40 // TODO: Should TargetLowering::AddrMode::BaseGV be changed to a ConstantExpr
  41 //       instead of a GlobalValue?
  42 //
  43 // TODO: When truncation is free, truncate ICmp users' operands to make it a
  44 //       smaller encoding (on x86 at least).
  45 //
  46 // TODO: When a negated register is used by an add (such as in a list of
  47 //       multiple base registers, or as the increment expression in an addrec),
  48 //       we may not actually need both reg and (-1 * reg) in registers; the
  49 //       negation can be implemented by using a sub instead of an add. The
  50 //       lack of support for taking this into consideration when making
  51 //       register pressure decisions is partly worked around by the "Special"
  52 //       use kind.
  53 //
  54 //===----------------------------------------------------------------------===//
  55
  56 #define DEBUG_TYPE "loop-reduce"
  57 #include "llvm/Transforms/Scalar.h"
  58 #include "llvm/Constants.h"
  59 #include "llvm/Instructions.h"
  60 #include "llvm/IntrinsicInst.h"
  61 #include "llvm/DerivedTypes.h"
  62 #include "llvm/Analysis/IVUsers.h"
  63 #include "llvm/Analysis/Dominators.h"
  64 #include "llvm/Analysis/LoopPass.h"
  65 #include "llvm/Analysis/ScalarEvolutionExpander.h"
  66 #include "llvm/Assembly/Writer.h"
  67 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  68 #include "llvm/Transforms/Utils/Local.h"
  69 #include "llvm/ADT/SmallBitVector.h"
  70 #include "llvm/ADT/SetVector.h"
  71 #include "llvm/ADT/DenseSet.h"
  72 #include "llvm/Support/Debug.h"
  73 #include "llvm/Support/CommandLine.h"
  74 #include "llvm/Support/ValueHandle.h"
  75 #include "llvm/Support/raw_ostream.h"
  76 #include "llvm/Target/TargetLowering.h"
  77 #include <algorithm>
  78 using namespace llvm;
  79
  80 // Temporary flag to cleanup congruent phis after LSR phi expansion.
  81 // It's currently disabled until we can determine whether it's truly useful or
  82 // not. The flag should be removed after the v3.0 release.
  83 // This is now needed for ivchains.
  84 static cl::opt<bool> EnablePhiElim(
  85   "enable-lsr-phielim", cl::Hidden, cl::init(true),
  86   cl::desc("Enable LSR phi elimination"));
  87
  88 #ifndef NDEBUG
  89 // Stress test IV chain generation.
  90 static cl::opt<bool> StressIVChain(
  91   "stress-ivchain", cl::Hidden, cl::init(false),
  92   cl::desc("Stress test LSR IV chains"));
  93 #else
  94 static bool StressIVChain = false;
  95 #endif
  96
  97 namespace {
  98
  99 /// RegSortData - This class holds data which is used to order reuse candidates.
 100 class RegSortData {
 101 public:
 102   /// UsedByIndices - This represents the set of LSRUse indices which reference
 103   /// a particular register.
 104   SmallBitVector UsedByIndices;
 105
 106   RegSortData() {}
 107
 108   void print(raw_ostream &OS) const;
 109   void dump() const;
 110 };
 111
 112 }
 113
 114 void RegSortData::print(raw_ostream &OS) const {
 115   OS << "[NumUses=" << UsedByIndices.count() << ']';
 116 }
 117
 118 void RegSortData::dump() const {
 119   print(errs()); errs() << '\n';
 120 }
 121
 122 namespace {
 123
 124 /// RegUseTracker - Map register candidates to information about how they are
 125 /// used.
 126 class RegUseTracker {
 127   typedef DenseMap<const SCEV *, RegSortData> RegUsesTy;
 128
 129   RegUsesTy RegUsesMap;
 130   SmallVector<const SCEV *, 16> RegSequence;
 131
 132 public:
 133   void CountRegister(const SCEV *Reg, size_t LUIdx);
 134   void DropRegister(const SCEV *Reg, size_t LUIdx);
 135   void SwapAndDropUse(size_t LUIdx, size_t LastLUIdx);
 136
 137   bool isRegUsedByUsesOtherThan(const SCEV *Reg, size_t LUIdx) const;
 138
 139   const SmallBitVector &getUsedByIndices(const SCEV *Reg) const;
 140
 141   void clear();
 142
 143   typedef SmallVectorImpl<const SCEV *>::iterator iterator;
 144   typedef SmallVectorImpl<const SCEV *>::const_iterator const_iterator;
 145   iterator begin() { return RegSequence.begin(); }
 146   iterator end()   { return RegSequence.end(); }
 147   const_iterator begin() const { return RegSequence.begin(); }
 148   const_iterator end() const   { return RegSequence.end(); }
 149 };
 150
 151 }
 152
 153 void
 154 RegUseTracker::CountRegister(const SCEV *Reg, size_t LUIdx) {
 155   std::pair<RegUsesTy::iterator, bool> Pair =
 156     RegUsesMap.insert(std::make_pair(Reg, RegSortData()));
 157   RegSortData &RSD = Pair.first->second;
 158   if (Pair.second)
 159     RegSequence.push_back(Reg);
 160   RSD.UsedByIndices.resize(std::max(RSD.UsedByIndices.size(), LUIdx + 1));
 161   RSD.UsedByIndices.set(LUIdx);
 162 }
 163
 164 void
 165 RegUseTracker::DropRegister(const SCEV *Reg, size_t LUIdx) {
 166   RegUsesTy::iterator It = RegUsesMap.find(Reg);
 167   assert(It != RegUsesMap.end());
 168   RegSortData &RSD = It->second;
 169   assert(RSD.UsedByIndices.size() > LUIdx);
 170   RSD.UsedByIndices.reset(LUIdx);
 171 }
 172
 173 void
 174 RegUseTracker::SwapAndDropUse(size_t LUIdx, size_t LastLUIdx) {
 175   assert(LUIdx <= LastLUIdx);
 176
 177   // Update RegUses. The data structure is not optimized for this purpose;
 178   // we must iterate through it and update each of the bit vectors.
 179   for (RegUsesTy::iterator I = RegUsesMap.begin(), E = RegUsesMap.end();
 180        I != E; ++I) {
 181     SmallBitVector &UsedByIndices = I->second.UsedByIndices;
 182     if (LUIdx < UsedByIndices.size())
 183       UsedByIndices[LUIdx] =
 184         LastLUIdx < UsedByIndices.size() ? UsedByIndices[LastLUIdx] : 0;
 185     UsedByIndices.resize(std::min(UsedByIndices.size(), LastLUIdx));
 186   }
 187 }
 188
 189 bool
 190 RegUseTracker::isRegUsedByUsesOtherThan(const SCEV *Reg, size_t LUIdx) const {
 191   RegUsesTy::const_iterator I = RegUsesMap.find(Reg);
 192   if (I == RegUsesMap.end())
 193     return false;
 194   const SmallBitVector &UsedByIndices = I->second.UsedByIndices;
 195   int i = UsedByIndices.find_first();
 196   if (i == -1) return false;
 197   if ((size_t)i != LUIdx) return true;
 198   return UsedByIndices.find_next(i) != -1;
 199 }
 200
 201 const SmallBitVector &RegUseTracker::getUsedByIndices(const SCEV *Reg) const {
 202   RegUsesTy::const_iterator I = RegUsesMap.find(Reg);
 203   assert(I != RegUsesMap.end() && "Unknown register!");
 204   return I->second.UsedByIndices;
 205 }
 206
 207 void RegUseTracker::clear() {
 208   RegUsesMap.clear();
 209   RegSequence.clear();
 210 }
 211
 212 namespace {
 213
 214 /// Formula - This class holds information that describes a formula for
 215 /// computing satisfying a use. It may include broken-out immediates and scaled
 216 /// registers.
 217 struct Formula {
 218   /// AM - This is used to represent complex addressing, as well as other kinds
 219   /// of interesting uses.
 220   TargetLowering::AddrMode AM;
 221
 222   /// BaseRegs - The list of "base" registers for this use. When this is
 223   /// non-empty, AM.HasBaseReg should be set to true.
 224   SmallVector<const SCEV *, 2> BaseRegs;
 225
 226   /// ScaledReg - The 'scaled' register for this use. This should be non-null
 227   /// when AM.Scale is not zero.
 228   const SCEV *ScaledReg;
 229
 230   /// UnfoldedOffset - An additional constant offset which added near the
 231   /// use. This requires a temporary register, but the offset itself can
 232   /// live in an add immediate field rather than a register.
 233   int64_t UnfoldedOffset;
 234
 235   Formula() : ScaledReg(0), UnfoldedOffset(0) {}
 236
 237   void InitialMatch(const SCEV *S, Loop *L, ScalarEvolution &SE);
 238
 239   unsigned getNumRegs() const;
 240   Type *getType() const;
 241
 242   void DeleteBaseReg(const SCEV *&S);
 243
 244   bool referencesReg(const SCEV *S) const;
 245   bool hasRegsUsedByUsesOtherThan(size_t LUIdx,
 246                                   const RegUseTracker &RegUses) const;
 247
 248   void print(raw_ostream &OS) const;
 249   void dump() const;
 250 };
 251
 252 }
 253
 254 /// DoInitialMatch - Recursion helper for InitialMatch.
 255 static void DoInitialMatch(const SCEV *S, Loop *L,
 256                            SmallVectorImpl<const SCEV *> &Good,
 257                            SmallVectorImpl<const SCEV *> &Bad,
 258                            ScalarEvolution &SE) {
 259   // Collect expressions which properly dominate the loop header.
 260   if (SE.properlyDominates(S, L->getHeader())) {
 261     Good.push_back(S);
 262     return;
 263   }
 264
 265   // Look at add operands.
 266   if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
 267     for (SCEVAddExpr::op_iterator I = Add->op_begin(), E = Add->op_end();
 268          I != E; ++I)
 269       DoInitialMatch(*I, L, Good, Bad, SE);
 270     return;
 271   }
 272
 273   // Look at addrec operands.
 274   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S))
 275     if (!AR->getStart()->isZero()) {
 276       DoInitialMatch(AR->getStart(), L, Good, Bad, SE);
 277       DoInitialMatch(SE.getAddRecExpr(SE.getConstant(AR->getType(), 0),
 278                                       AR->getStepRecurrence(SE),
 279                                       // FIXME: AR->getNoWrapFlags()
 280                                       AR->getLoop(), SCEV::FlagAnyWrap),
 281                      L, Good, Bad, SE);
 282       return;
 283     }
 284
 285   // Handle a multiplication by -1 (negation) if it didn't fold.
 286   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S))
 287     if (Mul->getOperand(0)->isAllOnesValue()) {
 288       SmallVector<const SCEV *, 4> Ops(Mul->op_begin()+1, Mul->op_end());
 289       const SCEV *NewMul = SE.getMulExpr(Ops);
 290
 291       SmallVector<const SCEV *, 4> MyGood;
 292       SmallVector<const SCEV *, 4> MyBad;
 293       DoInitialMatch(NewMul, L, MyGood, MyBad, SE);
 294       const SCEV *NegOne = SE.getSCEV(ConstantInt::getAllOnesValue(
 295         SE.getEffectiveSCEVType(NewMul->getType())));
 296       for (SmallVectorImpl<const SCEV *>::const_iterator I = MyGood.begin(),
 297            E = MyGood.end(); I != E; ++I)
 298         Good.push_back(SE.getMulExpr(NegOne, *I));
 299       for (SmallVectorImpl<const SCEV *>::const_iterator I = MyBad.begin(),
 300            E = MyBad.end(); I != E; ++I)
 301         Bad.push_back(SE.getMulExpr(NegOne, *I));
 302       return;
 303     }
 304
 305   // Ok, we can't do anything interesting. Just stuff the whole thing into a
 306   // register and hope for the best.
 307   Bad.push_back(S);
 308 }
 309
 310 /// InitialMatch - Incorporate loop-variant parts of S into this Formula,
 311 /// attempting to keep all loop-invariant and loop-computable values in a
 312 /// single base register.
 313 void Formula::InitialMatch(const SCEV *S, Loop *L, ScalarEvolution &SE) {
 314   SmallVector<const SCEV *, 4> Good;
 315   SmallVector<const SCEV *, 4> Bad;
 316   DoInitialMatch(S, L, Good, Bad, SE);
 317   if (!Good.empty()) {
 318     const SCEV *Sum = SE.getAddExpr(Good);
 319     if (!Sum->isZero())
 320       BaseRegs.push_back(Sum);
 321     AM.HasBaseReg = true;
 322   }
 323   if (!Bad.empty()) {
 324     const SCEV *Sum = SE.getAddExpr(Bad);
 325     if (!Sum->isZero())
 326       BaseRegs.push_back(Sum);
 327     AM.HasBaseReg = true;
 328   }
 329 }
 330
 331 /// getNumRegs - Return the total number of register operands used by this
 332 /// formula. This does not include register uses implied by non-constant
 333 /// addrec strides.
 334 unsigned Formula::getNumRegs() const {
 335   return !!ScaledReg + BaseRegs.size();
 336 }
 337
 338 /// getType - Return the type of this formula, if it has one, or null
 339 /// otherwise. This type is meaningless except for the bit size.
 340 Type *Formula::getType() const {
 341   return !BaseRegs.empty() ? BaseRegs.front()->getType() :
 342          ScaledReg ? ScaledReg->getType() :
 343          AM.BaseGV ? AM.BaseGV->getType() :
 344          0;
 345 }
 346
 347 /// DeleteBaseReg - Delete the given base reg from the BaseRegs list.
 348 void Formula::DeleteBaseReg(const SCEV *&S) {
 349   if (&S != &BaseRegs.back())
 350     std::swap(S, BaseRegs.back());
 351   BaseRegs.pop_back();
 352 }
 353
 354 /// referencesReg - Test if this formula references the given register.
 355 bool Formula::referencesReg(const SCEV *S) const {
 356   return S == ScaledReg ||
 357          std::find(BaseRegs.begin(), BaseRegs.end(), S) != BaseRegs.end();
 358 }
 359
 360 /// hasRegsUsedByUsesOtherThan - Test whether this formula uses registers
 361 /// which are used by uses other than the use with the given index.
 362 bool Formula::hasRegsUsedByUsesOtherThan(size_t LUIdx,
 363                                          const RegUseTracker &RegUses) const {
 364   if (ScaledReg)
 365     if (RegUses.isRegUsedByUsesOtherThan(ScaledReg, LUIdx))
 366       return true;
 367   for (SmallVectorImpl<const SCEV *>::const_iterator I = BaseRegs.begin(),
 368        E = BaseRegs.end(); I != E; ++I)
 369     if (RegUses.isRegUsedByUsesOtherThan(*I, LUIdx))
 370       return true;
 371   return false;
 372 }
 373
 374 void Formula::print(raw_ostream &OS) const {
 375   bool First = true;
 376   if (AM.BaseGV) {
 377     if (!First) OS << " + "; else First = false;
 378     WriteAsOperand(OS, AM.BaseGV, /*PrintType=*/false);
 379   }
 380   if (AM.BaseOffs != 0) {
 381     if (!First) OS << " + "; else First = false;
 382     OS << AM.BaseOffs;
 383   }
 384   for (SmallVectorImpl<const SCEV *>::const_iterator I = BaseRegs.begin(),
 385        E = BaseRegs.end(); I != E; ++I) {
 386     if (!First) OS << " + "; else First = false;
 387     OS << "reg(" << **I << ')';
 388   }
 389   if (AM.HasBaseReg && BaseRegs.empty()) {
 390     if (!First) OS << " + "; else First = false;
 391     OS << "**error: HasBaseReg**";
 392   } else if (!AM.HasBaseReg && !BaseRegs.empty()) {
 393     if (!First) OS << " + "; else First = false;
 394     OS << "**error: !HasBaseReg**";
 395   }
 396   if (AM.Scale != 0) {
 397     if (!First) OS << " + "; else First = false;
 398     OS << AM.Scale << "*reg(";
 399     if (ScaledReg)
 400       OS << *ScaledReg;
 401     else
 402       OS << "<unknown>";
 403     OS << ')';
 404   }
 405   if (UnfoldedOffset != 0) {
 406     if (!First) OS << " + "; else First = false;
 407     OS << "imm(" << UnfoldedOffset << ')';
 408   }
 409 }
 410
 411 void Formula::dump() const {
 412   print(errs()); errs() << '\n';
 413 }
 414
 415 /// isAddRecSExtable - Return true if the given addrec can be sign-extended
 416 /// without changing its value.
 417 static bool isAddRecSExtable(const SCEVAddRecExpr *AR, ScalarEvolution &SE) {
 418   Type *WideTy =
 419     IntegerType::get(SE.getContext(), SE.getTypeSizeInBits(AR->getType()) + 1);
 420   return isa<SCEVAddRecExpr>(SE.getSignExtendExpr(AR, WideTy));
 421 }
 422
 423 /// isAddSExtable - Return true if the given add can be sign-extended
 424 /// without changing its value.
 425 static bool isAddSExtable(const SCEVAddExpr *A, ScalarEvolution &SE) {
 426   Type *WideTy =
 427     IntegerType::get(SE.getContext(), SE.getTypeSizeInBits(A->getType()) + 1);
 428   return isa<SCEVAddExpr>(SE.getSignExtendExpr(A, WideTy));
 429 }
 430
 431 /// isMulSExtable - Return true if the given mul can be sign-extended
 432 /// without changing its value.
 433 static bool isMulSExtable(const SCEVMulExpr *M, ScalarEvolution &SE) {
 434   Type *WideTy =
 435     IntegerType::get(SE.getContext(),
 436                      SE.getTypeSizeInBits(M->getType()) * M->getNumOperands());
 437   return isa<SCEVMulExpr>(SE.getSignExtendExpr(M, WideTy));
 438 }
 439
 440 /// getExactSDiv - Return an expression for LHS /s RHS, if it can be determined
 441 /// and if the remainder is known to be zero,  or null otherwise. If
 442 /// IgnoreSignificantBits is true, expressions like (X * Y) /s Y are simplified
 443 /// to Y, ignoring that the multiplication may overflow, which is useful when
 444 /// the result will be used in a context where the most significant bits are
 445 /// ignored.
 446 static const SCEV *getExactSDiv(const SCEV *LHS, const SCEV *RHS,
 447                                 ScalarEvolution &SE,
 448                                 bool IgnoreSignificantBits = false) {
 449   // Handle the trivial case, which works for any SCEV type.
 450   if (LHS == RHS)
 451     return SE.getConstant(LHS->getType(), 1);
 452
 453   // Handle a few RHS special cases.
 454   const SCEVConstant *RC = dyn_cast<SCEVConstant>(RHS);
 455   if (RC) {
 456     const APInt &RA = RC->getValue()->getValue();
 457     // Handle x /s -1 as x * -1, to give ScalarEvolution a chance to do
 458     // some folding.
 459     if (RA.isAllOnesValue())
 460       return SE.getMulExpr(LHS, RC);
 461     // Handle x /s 1 as x.
 462     if (RA == 1)
 463       return LHS;
 464   }
 465
 466   // Check for a division of a constant by a constant.
 467   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(LHS)) {
 468     if (!RC)
 469       return 0;
 470     const APInt &LA = C->getValue()->getValue();
 471     const APInt &RA = RC->getValue()->getValue();
 472     if (LA.srem(RA) != 0)
 473       return 0;
 474     return SE.getConstant(LA.sdiv(RA));
 475   }
 476
 477   // Distribute the sdiv over addrec operands, if the addrec doesn't overflow.
 478   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(LHS)) {
 479     if (IgnoreSignificantBits || isAddRecSExtable(AR, SE)) {
 480       const SCEV *Step = getExactSDiv(AR->getStepRecurrence(SE), RHS, SE,
 481                                       IgnoreSignificantBits);
 482       if (!Step) return 0;
 483       const SCEV *Start = getExactSDiv(AR->getStart(), RHS, SE,
 484                                        IgnoreSignificantBits);
 485       if (!Start) return 0;
 486       // FlagNW is independent of the start value, step direction, and is
 487       // preserved with smaller magnitude steps.
 488       // FIXME: AR->getNoWrapFlags(SCEV::FlagNW)
 489       return SE.getAddRecExpr(Start, Step, AR->getLoop(), SCEV::FlagAnyWrap);
 490     }
 491     return 0;
 492   }
 493
 494   // Distribute the sdiv over add operands, if the add doesn't overflow.
 495   if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(LHS)) {
 496     if (IgnoreSignificantBits || isAddSExtable(Add, SE)) {
 497       SmallVector<const SCEV *, 8> Ops;
 498       for (SCEVAddExpr::op_iterator I = Add->op_begin(), E = Add->op_end();
 499            I != E; ++I) {
 500         const SCEV *Op = getExactSDiv(*I, RHS, SE,
 501                                       IgnoreSignificantBits);
 502         if (!Op) return 0;
 503         Ops.push_back(Op);
 504       }
 505       return SE.getAddExpr(Ops);
 506     }
 507     return 0;
 508   }
 509
 510   // Check for a multiply operand that we can pull RHS out of.
 511   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(LHS)) {
 512     if (IgnoreSignificantBits || isMulSExtable(Mul, SE)) {
 513       SmallVector<const SCEV *, 4> Ops;
 514       bool Found = false;
 515       for (SCEVMulExpr::op_iterator I = Mul->op_begin(), E = Mul->op_end();
 516            I != E; ++I) {
 517         const SCEV *S = *I;
 518         if (!Found)
 519           if (const SCEV *Q = getExactSDiv(S, RHS, SE,
 520                                            IgnoreSignificantBits)) {
 521             S = Q;
 522             Found = true;
 523           }
 524         Ops.push_back(S);
 525       }
 526       return Found ? SE.getMulExpr(Ops) : 0;
 527     }
 528     return 0;
 529   }
 530
 531   // Otherwise we don't know.
 532   return 0;
 533 }
 534
 535 /// ExtractImmediate - If S involves the addition of a constant integer value,
 536 /// return that integer value, and mutate S to point to a new SCEV with that
 537 /// value excluded.
 538 static int64_t ExtractImmediate(const SCEV *&S, ScalarEvolution &SE) {
 539   if (const SCEVConstant *C = dyn_cast<SCEVConstant>(S)) {
 540     if (C->getValue()->getValue().getMinSignedBits() <= 64) {
 541       S = SE.getConstant(C->getType(), 0);
 542       return C->getValue()->getSExtValue();
 543     }
 544   } else if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
 545     SmallVector<const SCEV *, 8> NewOps(Add->op_begin(), Add->op_end());
 546     int64_t Result = ExtractImmediate(NewOps.front(), SE);
 547     if (Result != 0)
 548       S = SE.getAddExpr(NewOps);
 549     return Result;
 550   } else if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S)) {
 551     SmallVector<const SCEV *, 8> NewOps(AR->op_begin(), AR->op_end());
 552     int64_t Result = ExtractImmediate(NewOps.front(), SE);
 553     if (Result != 0)
 554       S = SE.getAddRecExpr(NewOps, AR->getLoop(),
 555                            // FIXME: AR->getNoWrapFlags(SCEV::FlagNW)
 556                            SCEV::FlagAnyWrap);
 557     return Result;
 558   }
 559   return 0;
 560 }
 561
 562 /// ExtractSymbol - If S involves the addition of a GlobalValue address,
 563 /// return that symbol, and mutate S to point to a new SCEV with that
 564 /// value excluded.
 565 static GlobalValue *ExtractSymbol(const SCEV *&S, ScalarEvolution &SE) {
 566   if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
 567     if (GlobalValue *GV = dyn_cast<GlobalValue>(U->getValue())) {
 568       S = SE.getConstant(GV->getType(), 0);
 569       return GV;
 570     }
 571   } else if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
 572     SmallVector<const SCEV *, 8> NewOps(Add->op_begin(), Add->op_end());
 573     GlobalValue *Result = ExtractSymbol(NewOps.back(), SE);
 574     if (Result)
 575       S = SE.getAddExpr(NewOps);
 576     return Result;
 577   } else if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S)) {
 578     SmallVector<const SCEV *, 8> NewOps(AR->op_begin(), AR->op_end());
 579     GlobalValue *Result = ExtractSymbol(NewOps.front(), SE);
 580     if (Result)
 581       S = SE.getAddRecExpr(NewOps, AR->getLoop(),
 582                            // FIXME: AR->getNoWrapFlags(SCEV::FlagNW)
 583                            SCEV::FlagAnyWrap);
 584     return Result;
 585   }
 586   return 0;
 587 }
 588
 589 /// isAddressUse - Returns true if the specified instruction is using the
 590 /// specified value as an address.
 591 static bool isAddressUse(Instruction *Inst, Value *OperandVal) {
 592   bool isAddress = isa<LoadInst>(Inst);
 593   if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
 594     if (SI->getOperand(1) == OperandVal)
 595       isAddress = true;
 596   } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
 597     // Addressing modes can also be folded into prefetches and a variety
 598     // of intrinsics.
 599     switch (II->getIntrinsicID()) {
 600       default: break;
 601       case Intrinsic::prefetch:
 602       case Intrinsic::x86_sse_storeu_ps:
 603       case Intrinsic::x86_sse2_storeu_pd:
 604       case Intrinsic::x86_sse2_storeu_dq:
 605       case Intrinsic::x86_sse2_storel_dq:
 606         if (II->getArgOperand(0) == OperandVal)
 607           isAddress = true;
 608         break;
 609     }
 610   }
 611   return isAddress;
 612 }
 613
 614 /// getAccessType - Return the type of the memory being accessed.
 615 static Type *getAccessType(const Instruction *Inst) {
 616   Type *AccessTy = Inst->getType();
 617   if (const StoreInst *SI = dyn_cast<StoreInst>(Inst))
 618     AccessTy = SI->getOperand(0)->getType();
 619   else if (const IntrinsicInst *II = dyn_cast<IntrinsicInst>(Inst)) {
 620     // Addressing modes can also be folded into prefetches and a variety
 621     // of intrinsics.
 622     switch (II->getIntrinsicID()) {
 623     default: break;
 624     case Intrinsic::x86_sse_storeu_ps:
 625     case Intrinsic::x86_sse2_storeu_pd:
 626     case Intrinsic::x86_sse2_storeu_dq:
 627     case Intrinsic::x86_sse2_storel_dq:
 628       AccessTy = II->getArgOperand(0)->getType();
 629       break;
 630     }
 631   }
 632
 633   // All pointers have the same requirements, so canonicalize them to an
 634   // arbitrary pointer type to minimize variation.
 635   if (PointerType *PTy = dyn_cast<PointerType>(AccessTy))
 636     AccessTy = PointerType::get(IntegerType::get(PTy->getContext(), 1),
 637                                 PTy->getAddressSpace());
 638
 639   return AccessTy;
 640 }
 641
 642 /// isExistingPhi - Return true if this AddRec is already a phi in its loop.
 643 static bool isExistingPhi(const SCEVAddRecExpr *AR, ScalarEvolution &SE) {
 644   for (BasicBlock::iterator I = AR->getLoop()->getHeader()->begin();
 645        PHINode *PN = dyn_cast<PHINode>(I); ++I) {
 646     if (SE.isSCEVable(PN->getType()) &&
 647         (SE.getEffectiveSCEVType(PN->getType()) ==
 648          SE.getEffectiveSCEVType(AR->getType())) &&
 649         SE.getSCEV(PN) == AR)
 650       return true;
 651   }
 652   return false;
 653 }
 654
 655 /// Check if expanding this expression is likely to incur significant cost. This
 656 /// is tricky because SCEV doesn't track which expressions are actually computed
 657 /// by the current IR.
 658 ///
 659 /// We currently allow expansion of IV increments that involve adds,
 660 /// multiplication by constants, and AddRecs from existing phis.
 661 ///
 662 /// TODO: Allow UDivExpr if we can find an existing IV increment that is an
 663 /// obvious multiple of the UDivExpr.
 664 static bool isHighCostExpansion(const SCEV *S,
 665                                 SmallPtrSet<const SCEV*, 8> &Processed,
 666                                 ScalarEvolution &SE) {
 667   // Zero/One operand expressions
 668   switch (S->getSCEVType()) {
 669   case scUnknown:
 670   case scConstant:
 671     return false;
 672   case scTruncate:
 673     return isHighCostExpansion(cast<SCEVTruncateExpr>(S)->getOperand(),
 674                                Processed, SE);
 675   case scZeroExtend:
 676     return isHighCostExpansion(cast<SCEVZeroExtendExpr>(S)->getOperand(),
 677                                Processed, SE);
 678   case scSignExtend:
 679     return isHighCostExpansion(cast<SCEVSignExtendExpr>(S)->getOperand(),
 680                                Processed, SE);
 681   }
 682
 683   if (!Processed.insert(S))
 684     return false;
 685
 686   if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
 687     for (SCEVAddExpr::op_iterator I = Add->op_begin(), E = Add->op_end();
 688          I != E; ++I) {
 689       if (isHighCostExpansion(*I, Processed, SE))
 690         return true;
 691     }
 692     return false;
 693   }
 694
 695   if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
 696     if (Mul->getNumOperands() == 2) {
 697       // Multiplication by a constant is ok
 698       if (isa<SCEVConstant>(Mul->getOperand(0)))
 699         return isHighCostExpansion(Mul->getOperand(1), Processed, SE);
 700
 701       // If we have the value of one operand, check if an existing
 702       // multiplication already generates this expression.
 703       if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(Mul->getOperand(1))) {
 704         Value *UVal = U->getValue();
 705         for (Value::use_iterator UI = UVal->use_begin(), UE = UVal->use_end();
 706              UI != UE; ++UI) {
 707           Instruction *User = cast<Instruction>(*UI);
 708           if (User->getOpcode() == Instruction::Mul
 709               && SE.isSCEVable(User->getType())) {
 710             return SE.getSCEV(User) == Mul;
 711           }
 712         }
 713       }
 714     }
 715   }
 716
 717   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S)) {
 718     if (isExistingPhi(AR, SE))
 719       return false;
 720   }
 721
 722   // Fow now, consider any other type of expression (div/mul/min/max) high cost.
 723   return true;
 724 }
 725
 726 /// DeleteTriviallyDeadInstructions - If any of the instructions is the
 727 /// specified set are trivially dead, delete them and see if this makes any of
 728 /// their operands subsequently dead.
 729 static bool
 730 DeleteTriviallyDeadInstructions(SmallVectorImpl<WeakVH> &DeadInsts) {
 731   bool Changed = false;
 732
 733   while (!DeadInsts.empty()) {
 734     Instruction *I = dyn_cast_or_null<Instruction>(&*DeadInsts.pop_back_val());
 735
 736     if (I == 0 || !isInstructionTriviallyDead(I))
 737       continue;
 738
 739     for (User::op_iterator OI = I->op_begin(), E = I->op_end(); OI != E; ++OI)
 740       if (Instruction *U = dyn_cast<Instruction>(*OI)) {
 741         *OI = 0;
 742         if (U->use_empty())
 743           DeadInsts.push_back(U);
 744       }
 745
 746     I->eraseFromParent();
 747     Changed = true;
 748   }
 749
 750   return Changed;
 751 }
 752
 753 namespace {
 754
 755 /// Cost - This class is used to measure and compare candidate formulae.
 756 class Cost {
 757   /// TODO: Some of these could be merged. Also, a lexical ordering
 758   /// isn't always optimal.
 759   unsigned NumRegs;
 760   unsigned AddRecCost;
 761   unsigned NumIVMuls;
 762   unsigned NumBaseAdds;
 763   unsigned ImmCost;
 764   unsigned SetupCost;
 765
 766 public:
 767   Cost()
 768     : NumRegs(0), AddRecCost(0), NumIVMuls(0), NumBaseAdds(0), ImmCost(0),
 769       SetupCost(0) {}
 770
 771   bool operator<(const Cost &Other) const;
 772
 773   void Loose();
 774
 775 #ifndef NDEBUG
 776   // Once any of the metrics loses, they must all remain losers.
 777   bool isValid() {
 778     return ((NumRegs | AddRecCost | NumIVMuls | NumBaseAdds
 779              | ImmCost | SetupCost) != ~0u)
 780       || ((NumRegs & AddRecCost & NumIVMuls & NumBaseAdds
 781            & ImmCost & SetupCost) == ~0u);
 782   }
 783 #endif
 784
 785   bool isLoser() {
 786     assert(isValid() && "invalid cost");
 787     return NumRegs == ~0u;
 788   }
 789
 790   void RateFormula(const Formula &F,
 791                    SmallPtrSet<const SCEV *, 16> &Regs,
 792                    const DenseSet<const SCEV *> &VisitedRegs,
 793                    const Loop *L,
 794                    const SmallVectorImpl<int64_t> &Offsets,
 795                    ScalarEvolution &SE, DominatorTree &DT,
 796                    SmallPtrSet<const SCEV *, 16> *LoserRegs = 0);
 797
 798   void print(raw_ostream &OS) const;
 799   void dump() const;
 800
 801 private:
 802   void RateRegister(const SCEV *Reg,
 803                     SmallPtrSet<const SCEV *, 16> &Regs,
 804                     const Loop *L,
 805                     ScalarEvolution &SE, DominatorTree &DT);
 806   void RatePrimaryRegister(const SCEV *Reg,
 807                            SmallPtrSet<const SCEV *, 16> &Regs,
 808                            const Loop *L,
 809                            ScalarEvolution &SE, DominatorTree &DT,
 810                            SmallPtrSet<const SCEV *, 16> *LoserRegs);
 811 };
 812
 813 }
 814
 815 /// RateRegister - Tally up interesting quantities from the given register.
 816 void Cost::RateRegister(const SCEV *Reg,
 817                         SmallPtrSet<const SCEV *, 16> &Regs,
 818                         const Loop *L,
 819                         ScalarEvolution &SE, DominatorTree &DT) {
 820   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(Reg)) {
 821     // If this is an addrec for another loop, don't second-guess its addrec phi
 822     // nodes. LSR isn't currently smart enough to reason about more than one
 823     // loop at a time. LSR has already run on inner loops, will not run on outer
 824     // loops, and cannot be expected to change sibling loops.
 825     if (AR->getLoop() != L) {
 826       // If the AddRec exists, consider it's register free and leave it alone.
 827       if (isExistingPhi(AR, SE))
 828         return;
 829
 830       // Otherwise, do not consider this formula at all.
 831       Loose();
 832       return;
 833     }
 834     AddRecCost += 1; /// TODO: This should be a function of the stride.
 835
 836     // Add the step value register, if it needs one.
 837     // TODO: The non-affine case isn't precisely modeled here.
 838     if (!AR->isAffine() || !isa<SCEVConstant>(AR->getOperand(1))) {
 839       if (!Regs.count(AR->getOperand(1))) {
 840         RateRegister(AR->getOperand(1), Regs, L, SE, DT);
 841         if (isLoser())
 842           return;
 843       }
 844     }
 845   }
 846   ++NumRegs;
 847
 848   // Rough heuristic; favor registers which don't require extra setup
 849   // instructions in the preheader.
 850   if (!isa<SCEVUnknown>(Reg) &&
 851       !isa<SCEVConstant>(Reg) &&
 852       !(isa<SCEVAddRecExpr>(Reg) &&
 853         (isa<SCEVUnknown>(cast<SCEVAddRecExpr>(Reg)->getStart()) ||
 854          isa<SCEVConstant>(cast<SCEVAddRecExpr>(Reg)->getStart()))))
 855     ++SetupCost;
 856
 857     NumIVMuls += isa<SCEVMulExpr>(Reg) &&
 858                  SE.hasComputableLoopEvolution(Reg, L);
 859 }
 860
 861 /// RatePrimaryRegister - Record this register in the set. If we haven't seen it
 862 /// before, rate it. Optional LoserRegs provides a way to declare any formula
 863 /// that refers to one of those regs an instant loser.
 864 void Cost::RatePrimaryRegister(const SCEV *Reg,
 865                                SmallPtrSet<const SCEV *, 16> &Regs,
 866                                const Loop *L,
 867                                ScalarEvolution &SE, DominatorTree &DT,
 868                                SmallPtrSet<const SCEV *, 16> *LoserRegs) {
 869   if (LoserRegs && LoserRegs->count(Reg)) {
 870     Loose();
 871     return;
 872   }
 873   if (Regs.insert(Reg)) {
 874     RateRegister(Reg, Regs, L, SE, DT);
 875     if (isLoser())
 876       LoserRegs->insert(Reg);
 877   }
 878 }
 879
 880 void Cost::RateFormula(const Formula &F,
 881                        SmallPtrSet<const SCEV *, 16> &Regs,
 882                        const DenseSet<const SCEV *> &VisitedRegs,
 883                        const Loop *L,
 884                        const SmallVectorImpl<int64_t> &Offsets,
 885                        ScalarEvolution &SE, DominatorTree &DT,
 886                        SmallPtrSet<const SCEV *, 16> *LoserRegs) {
 887   // Tally up the registers.
 888   if (const SCEV *ScaledReg = F.ScaledReg) {
 889     if (VisitedRegs.count(ScaledReg)) {
 890       Loose();
 891       return;
 892     }
 893     RatePrimaryRegister(ScaledReg, Regs, L, SE, DT, LoserRegs);
 894     if (isLoser())
 895       return;
 896   }
 897   for (SmallVectorImpl<const SCEV *>::const_iterator I = F.BaseRegs.begin(),
 898        E = F.BaseRegs.end(); I != E; ++I) {
 899     const SCEV *BaseReg = *I;
 900     if (VisitedRegs.count(BaseReg)) {
 901       Loose();
 902       return;
 903     }
 904     RatePrimaryRegister(BaseReg, Regs, L, SE, DT, LoserRegs);
 905     if (isLoser())
 906       return;
 907   }
 908
 909   // Determine how many (unfolded) adds we'll need inside the loop.
 910   size_t NumBaseParts = F.BaseRegs.size() + (F.UnfoldedOffset != 0);
 911   if (NumBaseParts > 1)
 912     NumBaseAdds += NumBaseParts - 1;
 913
 914   // Tally up the non-zero immediates.
 915   for (SmallVectorImpl<int64_t>::const_iterator I = Offsets.begin(),
 916        E = Offsets.end(); I != E; ++I) {
 917     int64_t Offset = (uint64_t)*I + F.AM.BaseOffs;
 918     if (F.AM.BaseGV)
 919       ImmCost += 64; // Handle symbolic values conservatively.
 920                      // TODO: This should probably be the pointer size.
 921     else if (Offset != 0)
 922       ImmCost += APInt(64, Offset, true).getMinSignedBits();
 923   }
 924   assert(isValid() && "invalid cost");
 925 }
 926
 927 /// Loose - Set this cost to a losing value.
 928 void Cost::Loose() {
 929   NumRegs = ~0u;
 930   AddRecCost = ~0u;
 931   NumIVMuls = ~0u;
 932   NumBaseAdds = ~0u;
 933   ImmCost = ~0u;
 934   SetupCost = ~0u;
 935 }
 936
 937 /// operator< - Choose the lower cost.
 938 bool Cost::operator<(const Cost &Other) const {
 939   if (NumRegs != Other.NumRegs)
 940     return NumRegs < Other.NumRegs;
 941   if (AddRecCost != Other.AddRecCost)
 942     return AddRecCost < Other.AddRecCost;
 943   if (NumIVMuls != Other.NumIVMuls)
 944     return NumIVMuls < Other.NumIVMuls;
 945   if (NumBaseAdds != Other.NumBaseAdds)
 946     return NumBaseAdds < Other.NumBaseAdds;
 947   if (ImmCost != Other.ImmCost)
 948     return ImmCost < Other.ImmCost;
 949   if (SetupCost != Other.SetupCost)
 950     return SetupCost < Other.SetupCost;
 951   return false;
 952 }
 953
 954 void Cost::print(raw_ostream &OS) const {
 955   OS << NumRegs << " reg" << (NumRegs == 1 ? "" : "s");
 956   if (AddRecCost != 0)
 957     OS << ", with addrec cost " << AddRecCost;
 958   if (NumIVMuls != 0)
 959     OS << ", plus " << NumIVMuls << " IV mul" << (NumIVMuls == 1 ? "" : "s");
 960   if (NumBaseAdds != 0)
 961     OS << ", plus " << NumBaseAdds << " base add"
 962        << (NumBaseAdds == 1 ? "" : "s");
 963   if (ImmCost != 0)
 964     OS << ", plus " << ImmCost << " imm cost";
 965   if (SetupCost != 0)
 966     OS << ", plus " << SetupCost << " setup cost";
 967 }
 968
 969 void Cost::dump() const {
 970   print(errs()); errs() << '\n';
 971 }
 972
 973 namespace {
 974
 975 /// LSRFixup - An operand value in an instruction which is to be replaced
 976 /// with some equivalent, possibly strength-reduced, replacement.
 977 struct LSRFixup {
 978   /// UserInst - The instruction which will be updated.
 979   Instruction *UserInst;
 980
 981   /// OperandValToReplace - The operand of the instruction which will
 982   /// be replaced. The operand may be used more than once; every instance
 983   /// will be replaced.
 984   Value *OperandValToReplace;
 985
 986   /// PostIncLoops - If this user is to use the post-incremented value of an
 987   /// induction variable, this variable is non-null and holds the loop
 988   /// associated with the induction variable.
 989   PostIncLoopSet PostIncLoops;
 990
 991   /// LUIdx - The index of the LSRUse describing the expression which
 992   /// this fixup needs, minus an offset (below).
 993   size_t LUIdx;
 994
 995   /// Offset - A constant offset to be added to the LSRUse expression.
 996   /// This allows multiple fixups to share the same LSRUse with different
 997   /// offsets, for example in an unrolled loop.
 998   int64_t Offset;
 999
1000   bool isUseFullyOutsideLoop(const Loop *L) const;
1001
1002   LSRFixup();
1003
1004   void print(raw_ostream &OS) const;
1005   void dump() const;
1006 };
1007
1008 }
1009
1010 LSRFixup::LSRFixup()
1011   : UserInst(0), OperandValToReplace(0), LUIdx(~size_t(0)), Offset(0) {}
1012
1013 /// isUseFullyOutsideLoop - Test whether this fixup always uses its
1014 /// value outside of the given loop.
1015 bool LSRFixup::isUseFullyOutsideLoop(const Loop *L) const {
1016   // PHI nodes use their value in their incoming blocks.
1017   if (const PHINode *PN = dyn_cast<PHINode>(UserInst)) {
1018     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1019       if (PN->getIncomingValue(i) == OperandValToReplace &&
1020           L->contains(PN->getIncomingBlock(i)))
1021         return false;
1022     return true;
1023   }
1024
1025   return !L->contains(UserInst);
1026 }
1027
1028 void LSRFixup::print(raw_ostream &OS) const {
1029   OS << "UserInst=";
1030   // Store is common and interesting enough to be worth special-casing.
1031   if (StoreInst *Store = dyn_cast<StoreInst>(UserInst)) {
1032     OS << "store ";
1033     WriteAsOperand(OS, Store->getOperand(0), /*PrintType=*/false);
1034   } else if (UserInst->getType()->isVoidTy())
1035     OS << UserInst->getOpcodeName();
1036   else
1037     WriteAsOperand(OS, UserInst, /*PrintType=*/false);
1038
1039   OS << ", OperandValToReplace=";
1040   WriteAsOperand(OS, OperandValToReplace, /*PrintType=*/false);
1041
1042   for (PostIncLoopSet::const_iterator I = PostIncLoops.begin(),
1043        E = PostIncLoops.end(); I != E; ++I) {
1044     OS << ", PostIncLoop=";
1045     WriteAsOperand(OS, (*I)->getHeader(), /*PrintType=*/false);
1046   }
1047
1048   if (LUIdx != ~size_t(0))
1049     OS << ", LUIdx=" << LUIdx;
1050
1051   if (Offset != 0)
1052     OS << ", Offset=" << Offset;
1053 }
1054
1055 void LSRFixup::dump() const {
1056   print(errs()); errs() << '\n';
1057 }
1058
1059 namespace {
1060
1061 /// UniquifierDenseMapInfo - A DenseMapInfo implementation for holding
1062 /// DenseMaps and DenseSets of sorted SmallVectors of const SCEV*.
1063 struct UniquifierDenseMapInfo {
1064   static SmallVector<const SCEV *, 2> getEmptyKey() {
1065     SmallVector<const SCEV *, 2> V;
1066     V.push_back(reinterpret_cast<const SCEV *>(-1));
1067     return V;
1068   }
1069
1070   static SmallVector<const SCEV *, 2> getTombstoneKey() {
1071     SmallVector<const SCEV *, 2> V;
1072     V.push_back(reinterpret_cast<const SCEV *>(-2));
1073     return V;
1074   }
1075
1076   static unsigned getHashValue(const SmallVector<const SCEV *, 2> &V) {
1077     unsigned Result = 0;
1078     for (SmallVectorImpl<const SCEV *>::const_iterator I = V.begin(),
1079          E = V.end(); I != E; ++I)
1080       Result ^= DenseMapInfo<const SCEV *>::getHashValue(*I);
1081     return Result;
1082   }
1083
1084   static bool isEqual(const SmallVector<const SCEV *, 2> &LHS,
1085                       const SmallVector<const SCEV *, 2> &RHS) {
1086     return LHS == RHS;
1087   }
1088 };
1089
1090 /// LSRUse - This class holds the state that LSR keeps for each use in
1091 /// IVUsers, as well as uses invented by LSR itself. It includes information
1092 /// about what kinds of things can be folded into the user, information about
1093 /// the user itself, and information about how the use may be satisfied.
1094 /// TODO: Represent multiple users of the same expression in common?
1095 class LSRUse {
1096   DenseSet<SmallVector<const SCEV *, 2>, UniquifierDenseMapInfo> Uniquifier;
1097
1098 public:
1099   /// KindType - An enum for a kind of use, indicating what types of
1100   /// scaled and immediate operands it might support.
1101   enum KindType {
1102     Basic,   ///< A normal use, with no folding.
1103     Special, ///< A special case of basic, allowing -1 scales.
1104     Address, ///< An address use; folding according to TargetLowering
1105     ICmpZero ///< An equality icmp with both operands folded into one.
1106     // TODO: Add a generic icmp too?
1107   };
1108
1109   KindType Kind;
1110   Type *AccessTy;
1111
1112   SmallVector<int64_t, 8> Offsets;
1113   int64_t MinOffset;
1114   int64_t MaxOffset;
1115
1116   /// AllFixupsOutsideLoop - This records whether all of the fixups using this
1117   /// LSRUse are outside of the loop, in which case some special-case heuristics
1118   /// may be used.
1119   bool AllFixupsOutsideLoop;
1120
1121   /// WidestFixupType - This records the widest use type for any fixup using
1122   /// this LSRUse. FindUseWithSimilarFormula can't consider uses with different
1123   /// max fixup widths to be equivalent, because the narrower one may be relying
1124   /// on the implicit truncation to truncate away bogus bits.
1125   Type *WidestFixupType;
1126
1127   /// Formulae - A list of ways to build a value that can satisfy this user.
1128   /// After the list is populated, one of these is selected heuristically and
1129   /// used to formulate a replacement for OperandValToReplace in UserInst.
1130   SmallVector<Formula, 12> Formulae;
1131
1132   /// Regs - The set of register candidates used by all formulae in this LSRUse.
1133   SmallPtrSet<const SCEV *, 4> Regs;
1134
1135   LSRUse(KindType K, Type *T) : Kind(K), AccessTy(T),
1136                                       MinOffset(INT64_MAX),
1137                                       MaxOffset(INT64_MIN),
1138                                       AllFixupsOutsideLoop(true),
1139                                       WidestFixupType(0) {}
1140
1141   bool HasFormulaWithSameRegs(const Formula &F) const;
1142   bool InsertFormula(const Formula &F);
1143   void DeleteFormula(Formula &F);
1144   void RecomputeRegs(size_t LUIdx, RegUseTracker &Reguses);
1145
1146   void print(raw_ostream &OS) const;
1147   void dump() const;
1148 };
1149
1150 }
1151
1152 /// HasFormula - Test whether this use as a formula which has the same
1153 /// registers as the given formula.
1154 bool LSRUse::HasFormulaWithSameRegs(const Formula &F) const {
1155   SmallVector<const SCEV *, 2> Key = F.BaseRegs;
1156   if (F.ScaledReg) Key.push_back(F.ScaledReg);
1157   // Unstable sort by host order ok, because this is only used for uniquifying.
1158   std::sort(Key.begin(), Key.end());
1159   return Uniquifier.count(Key);
1160 }
1161
1162 /// InsertFormula - If the given formula has not yet been inserted, add it to
1163 /// the list, and return true. Return false otherwise.
1164 bool LSRUse::InsertFormula(const Formula &F) {
1165   SmallVector<const SCEV *, 2> Key = F.BaseRegs;
1166   if (F.ScaledReg) Key.push_back(F.ScaledReg);
1167   // Unstable sort by host order ok, because this is only used for uniquifying.
1168   std::sort(Key.begin(), Key.end());
1169
1170   if (!Uniquifier.insert(Key).second)
1171     return false;
1172
1173   // Using a register to hold the value of 0 is not profitable.
1174   assert((!F.ScaledReg || !F.ScaledReg->isZero()) &&
1175          "Zero allocated in a scaled register!");
1176 #ifndef NDEBUG
1177   for (SmallVectorImpl<const SCEV *>::const_iterator I =
1178        F.BaseRegs.begin(), E = F.BaseRegs.end(); I != E; ++I)
1179     assert(!(*I)->isZero() && "Zero allocated in a base register!");
1180 #endif
1181
1182   // Add the formula to the list.
1183   Formulae.push_back(F);
1184
1185   // Record registers now being used by this use.
1186   Regs.insert(F.BaseRegs.begin(), F.BaseRegs.end());
1187
1188   return true;
1189 }
1190
1191 /// DeleteFormula - Remove the given formula from this use's list.
1192 void LSRUse::DeleteFormula(Formula &F) {
1193   if (&F != &Formulae.back())
1194     std::swap(F, Formulae.back());
1195   Formulae.pop_back();
1196 }
1197
1198 /// RecomputeRegs - Recompute the Regs field, and update RegUses.
1199 void LSRUse::RecomputeRegs(size_t LUIdx, RegUseTracker &RegUses) {
1200   // Now that we've filtered out some formulae, recompute the Regs set.
1201   SmallPtrSet<const SCEV *, 4> OldRegs = Regs;
1202   Regs.clear();
1203   for (SmallVectorImpl<Formula>::const_iterator I = Formulae.begin(),
1204        E = Formulae.end(); I != E; ++I) {
1205     const Formula &F = *I;
1206     if (F.ScaledReg) Regs.insert(F.ScaledReg);
1207     Regs.insert(F.BaseRegs.begin(), F.BaseRegs.end());
1208   }
1209
1210   // Update the RegTracker.
1211   for (SmallPtrSet<const SCEV *, 4>::iterator I = OldRegs.begin(),
1212        E = OldRegs.end(); I != E; ++I)
1213     if (!Regs.count(*I))
1214       RegUses.DropRegister(*I, LUIdx);
1215 }
1216
1217 void LSRUse::print(raw_ostream &OS) const {
1218   OS << "LSR Use: Kind=";
1219   switch (Kind) {
1220   case Basic:    OS << "Basic"; break;
1221   case Special:  OS << "Special"; break;
1222   case ICmpZero: OS << "ICmpZero"; break;
1223   case Address:
1224     OS << "Address of ";
1225     if (AccessTy->isPointerTy())
1226       OS << "pointer"; // the full pointer type could be really verbose
1227     else
1228       OS << *AccessTy;
1229   }
1230
1231   OS << ", Offsets={";
1232   for (SmallVectorImpl<int64_t>::const_iterator I = Offsets.begin(),
1233        E = Offsets.end(); I != E; ++I) {
1234     OS << *I;
1235     if (llvm::next(I) != E)
1236       OS << ',';
1237   }
1238   OS << '}';
1239
1240   if (AllFixupsOutsideLoop)
1241     OS << ", all-fixups-outside-loop";
1242
1243   if (WidestFixupType)
1244     OS << ", widest fixup type: " << *WidestFixupType;
1245 }
1246
1247 void LSRUse::dump() const {
1248   print(errs()); errs() << '\n';
1249 }
1250
1251 /// isLegalUse - Test whether the use described by AM is "legal", meaning it can
1252 /// be completely folded into the user instruction at isel time. This includes
1253 /// address-mode folding and special icmp tricks.
1254 static bool isLegalUse(const TargetLowering::AddrMode &AM,
1255                        LSRUse::KindType Kind, Type *AccessTy,
1256                        const TargetLowering *TLI) {
1257   switch (Kind) {
1258   case LSRUse::Address:
1259     // If we have low-level target information, ask the target if it can
1260     // completely fold this address.
1261     if (TLI) return TLI->isLegalAddressingMode(AM, AccessTy);
1262
1263     // Otherwise, just guess that reg+reg addressing is legal.
1264     return !AM.BaseGV && AM.BaseOffs == 0 && AM.Scale <= 1;
1265
1266   case LSRUse::ICmpZero:
1267     // There's not even a target hook for querying whether it would be legal to
1268     // fold a GV into an ICmp.
1269     if (AM.BaseGV)
1270       return false;
1271
1272     // ICmp only has two operands; don't allow more than two non-trivial parts.
1273     if (AM.Scale != 0 && AM.HasBaseReg && AM.BaseOffs != 0)
1274       return false;
1275
1276     // ICmp only supports no scale or a -1 scale, as we can "fold" a -1 scale by
1277     // putting the scaled register in the other operand of the icmp.
1278     if (AM.Scale != 0 && AM.Scale != -1)
1279       return false;
1280
1281     // If we have low-level target information, ask the target if it can fold an
1282     // integer immediate on an icmp.
1283     if (AM.BaseOffs != 0) {
1284       if (TLI) return TLI->isLegalICmpImmediate(-(uint64_t)AM.BaseOffs);
1285       return false;
1286     }
1287
1288     return true;
1289
1290   case LSRUse::Basic:
1291     // Only handle single-register values.
1292     return !AM.BaseGV && AM.Scale == 0 && AM.BaseOffs == 0;
1293
1294   case LSRUse::Special:
1295     // Only handle -1 scales, or no scale.
1296     return AM.Scale == 0 || AM.Scale == -1;
1297   }
1298
1299   llvm_unreachable("Invalid LSRUse Kind!");
1300 }
1301
1302 static bool isLegalUse(TargetLowering::AddrMode AM,
1303                        int64_t MinOffset, int64_t MaxOffset,
1304                        LSRUse::KindType Kind, Type *AccessTy,
1305                        const TargetLowering *TLI) {
1306   // Check for overflow.
1307   if (((int64_t)((uint64_t)AM.BaseOffs + MinOffset) > AM.BaseOffs) !=
1308       (MinOffset > 0))
1309     return false;
1310   AM.BaseOffs = (uint64_t)AM.BaseOffs + MinOffset;
1311   if (isLegalUse(AM, Kind, AccessTy, TLI)) {
1312     AM.BaseOffs = (uint64_t)AM.BaseOffs - MinOffset;
1313     // Check for overflow.
1314     if (((int64_t)((uint64_t)AM.BaseOffs + MaxOffset) > AM.BaseOffs) !=
1315         (MaxOffset > 0))
1316       return false;
1317     AM.BaseOffs = (uint64_t)AM.BaseOffs + MaxOffset;
1318     return isLegalUse(AM, Kind, AccessTy, TLI);
1319   }
1320   return false;
1321 }
1322
1323 static bool isAlwaysFoldable(int64_t BaseOffs,
1324                              GlobalValue *BaseGV,
1325                              bool HasBaseReg,
1326                              LSRUse::KindType Kind, Type *AccessTy,
1327                              const TargetLowering *TLI) {
1328   // Fast-path: zero is always foldable.
1329   if (BaseOffs == 0 && !BaseGV) return true;
1330
1331   // Conservatively, create an address with an immediate and a
1332   // base and a scale.
1333   TargetLowering::AddrMode AM;
1334   AM.BaseOffs = BaseOffs;
1335   AM.BaseGV = BaseGV;
1336   AM.HasBaseReg = HasBaseReg;
1337   AM.Scale = Kind == LSRUse::ICmpZero ? -1 : 1;
1338
1339   // Canonicalize a scale of 1 to a base register if the formula doesn't
1340   // already have a base register.
1341   if (!AM.HasBaseReg && AM.Scale == 1) {
1342     AM.Scale = 0;
1343     AM.HasBaseReg = true;
1344   }
1345
1346   return isLegalUse(AM, Kind, AccessTy, TLI);
1347 }
1348
1349 static bool isAlwaysFoldable(const SCEV *S,
1350                              int64_t MinOffset, int64_t MaxOffset,
1351                              bool HasBaseReg,
1352                              LSRUse::KindType Kind, Type *AccessTy,
1353                              const TargetLowering *TLI,
1354                              ScalarEvolution &SE) {
1355   // Fast-path: zero is always foldable.
1356   if (S->isZero()) return true;
1357
1358   // Conservatively, create an address with an immediate and a
1359   // base and a scale.
1360   int64_t BaseOffs = ExtractImmediate(S, SE);
1361   GlobalValue *BaseGV = ExtractSymbol(S, SE);
1362
1363   // If there's anything else involved, it's not foldable.
1364   if (!S->isZero()) return false;
1365
1366   // Fast-path: zero is always foldable.
1367   if (BaseOffs == 0 && !BaseGV) return true;
1368
1369   // Conservatively, create an address with an immediate and a
1370   // base and a scale.
1371   TargetLowering::AddrMode AM;
1372   AM.BaseOffs = BaseOffs;
1373   AM.BaseGV = BaseGV;
1374   AM.HasBaseReg = HasBaseReg;
1375   AM.Scale = Kind == LSRUse::ICmpZero ? -1 : 1;
1376
1377   return isLegalUse(AM, MinOffset, MaxOffset, Kind, AccessTy, TLI);
1378 }
1379
1380 namespace {
1381
1382 /// UseMapDenseMapInfo - A DenseMapInfo implementation for holding
1383 /// DenseMaps and DenseSets of pairs of const SCEV* and LSRUse::Kind.
1384 struct UseMapDenseMapInfo {
1385   static std::pair<const SCEV *, LSRUse::KindType> getEmptyKey() {
1386     return std::make_pair(reinterpret_cast<const SCEV *>(-1), LSRUse::Basic);
1387   }
1388
1389   static std::pair<const SCEV *, LSRUse::KindType> getTombstoneKey() {
1390     return std::make_pair(reinterpret_cast<const SCEV *>(-2), LSRUse::Basic);
1391   }
1392
1393   static unsigned
1394   getHashValue(const std::pair<const SCEV *, LSRUse::KindType> &V) {
1395     unsigned Result = DenseMapInfo<const SCEV *>::getHashValue(V.first);
1396     Result ^= DenseMapInfo<unsigned>::getHashValue(unsigned(V.second));
1397     return Result;
1398   }
1399
1400   static bool isEqual(const std::pair<const SCEV *, LSRUse::KindType> &LHS,
1401                       const std::pair<const SCEV *, LSRUse::KindType> &RHS) {
1402     return LHS == RHS;
1403   }
1404 };
1405
1406 /// IVInc - An individual increment in a Chain of IV increments.
1407 /// Relate an IV user to an expression that computes the IV it uses from the IV
1408 /// used by the previous link in the Chain.
1409 ///
1410 /// For the head of a chain, IncExpr holds the absolute SCEV expression for the
1411 /// original IVOperand. The head of the chain's IVOperand is only valid during
1412 /// chain collection, before LSR replaces IV users. During chain generation,
1413 /// IncExpr can be used to find the new IVOperand that computes the same
1414 /// expression.
1415 struct IVInc {
1416   Instruction *UserInst;
1417   Value* IVOperand;
1418   const SCEV *IncExpr;
1419
1420   IVInc(Instruction *U, Value *O, const SCEV *E):
1421     UserInst(U), IVOperand(O), IncExpr(E) {}
1422 };
1423
1424 // IVChain - The list of IV increments in program order.
1425 // We typically add the head of a chain without finding subsequent links.
1426 typedef SmallVector<IVInc,1> IVChain;
1427
1428 /// ChainUsers - Helper for CollectChains to track multiple IV increment uses.
1429 /// Distinguish between FarUsers that definitely cross IV increments and
1430 /// NearUsers that may be used between IV increments.
1431 struct ChainUsers {
1432   SmallPtrSet<Instruction*, 4> FarUsers;
1433   SmallPtrSet<Instruction*, 4> NearUsers;
1434 };
1435
1436 /// LSRInstance - This class holds state for the main loop strength reduction
1437 /// logic.
1438 class LSRInstance {
1439   IVUsers &IU;
1440   ScalarEvolution &SE;
1441   DominatorTree &DT;
1442   LoopInfo &LI;
1443   const TargetLowering *const TLI;
1444   Loop *const L;
1445   bool Changed;
1446
1447   /// IVIncInsertPos - This is the insert position that the current loop's
1448   /// induction variable increment should be placed. In simple loops, this is
1449   /// the latch block's terminator. But in more complicated cases, this is a
1450   /// position which will dominate all the in-loop post-increment users.
1451   Instruction *IVIncInsertPos;
1452
1453   /// Factors - Interesting factors between use strides.
1454   SmallSetVector<int64_t, 8> Factors;
1455
1456   /// Types - Interesting use types, to facilitate truncation reuse.
1457   SmallSetVector<Type *, 4> Types;
1458
1459   /// Fixups - The list of operands which are to be replaced.
1460   SmallVector<LSRFixup, 16> Fixups;
1461
1462   /// Uses - The list of interesting uses.
1463   SmallVector<LSRUse, 16> Uses;
1464
1465   /// RegUses - Track which uses use which register candidates.
1466   RegUseTracker RegUses;
1467
1468   // Limit the number of chains to avoid quadratic behavior. We don't expect to
1469   // have more than a few IV increment chains in a loop. Missing a Chain falls
1470   // back to normal LSR behavior for those uses.
1471   static const unsigned MaxChains = 8;
1472
1473   /// IVChainVec - IV users can form a chain of IV increments.
1474   SmallVector<IVChain, MaxChains> IVChainVec;
1475
1476   /// IVIncSet - IV users that belong to profitable IVChains.
1477   SmallPtrSet<Use*, MaxChains> IVIncSet;
1478
1479   void OptimizeShadowIV();
1480   bool FindIVUserForCond(ICmpInst *Cond, IVStrideUse *&CondUse);
1481   ICmpInst *OptimizeMax(ICmpInst *Cond, IVStrideUse* &CondUse);
1482   void OptimizeLoopTermCond();
1483
1484   void ChainInstruction(Instruction *UserInst, Instruction *IVOper,
1485                         SmallVectorImpl<ChainUsers> &ChainUsersVec);
1486   void FinalizeChain(IVChain &Chain);
1487   void CollectChains();
1488   void GenerateIVChain(const IVChain &Chain, SCEVExpander &Rewriter,
1489                        SmallVectorImpl<WeakVH> &DeadInsts);
1490
1491   void CollectInterestingTypesAndFactors();
1492   void CollectFixupsAndInitialFormulae();
1493
1494   LSRFixup &getNewFixup() {
1495     Fixups.push_back(LSRFixup());
1496     return Fixups.back();
1497   }
1498
1499   // Support for sharing of LSRUses between LSRFixups.
1500   typedef DenseMap<std::pair<const SCEV *, LSRUse::KindType>,
1501                    size_t,
1502                    UseMapDenseMapInfo> UseMapTy;
1503   UseMapTy UseMap;
1504
1505   bool reconcileNewOffset(LSRUse &LU, int64_t NewOffset, bool HasBaseReg,
1506                           LSRUse::KindType Kind, Type *AccessTy);
1507
1508   std::pair<size_t, int64_t> getUse(const SCEV *&Expr,
1509                                     LSRUse::KindType Kind,
1510                                     Type *AccessTy);
1511
1512   void DeleteUse(LSRUse &LU, size_t LUIdx);
1513
1514   LSRUse *FindUseWithSimilarFormula(const Formula &F, const LSRUse &OrigLU);
1515
1516   void InsertInitialFormula(const SCEV *S, LSRUse &LU, size_t LUIdx);
1517   void InsertSupplementalFormula(const SCEV *S, LSRUse &LU, size_t LUIdx);
1518   void CountRegisters(const Formula &F, size_t LUIdx);
1519   bool InsertFormula(LSRUse &LU, unsigned LUIdx, const Formula &F);
1520
1521   void CollectLoopInvariantFixupsAndFormulae();
1522
1523   void GenerateReassociations(LSRUse &LU, unsigned LUIdx, Formula Base,
1524                               unsigned Depth = 0);
1525   void GenerateCombinations(LSRUse &LU, unsigned LUIdx, Formula Base);
1526   void GenerateSymbolicOffsets(LSRUse &LU, unsigned LUIdx, Formula Base);
1527   void GenerateConstantOffsets(LSRUse &LU, unsigned LUIdx, Formula Base);
1528   void GenerateICmpZeroScales(LSRUse &LU, unsigned LUIdx, Formula Base);
1529   void GenerateScales(LSRUse &LU, unsigned LUIdx, Formula Base);
1530   void GenerateTruncates(LSRUse &LU, unsigned LUIdx, Formula Base);
1531   void GenerateCrossUseConstantOffsets();
1532   void GenerateAllReuseFormulae();
1533
1534   void FilterOutUndesirableDedicatedRegisters();
1535
1536   size_t EstimateSearchSpaceComplexity() const;
1537   void NarrowSearchSpaceByDetectingSupersets();
1538   void NarrowSearchSpaceByCollapsingUnrolledCode();
1539   void NarrowSearchSpaceByRefilteringUndesirableDedicatedRegisters();
1540   void NarrowSearchSpaceByPickingWinnerRegs();
1541   void NarrowSearchSpaceUsingHeuristics();
1542
1543   void SolveRecurse(SmallVectorImpl<const Formula *> &Solution,
1544                     Cost &SolutionCost,
1545                     SmallVectorImpl<const Formula *> &Workspace,
1546                     const Cost &CurCost,
1547                     const SmallPtrSet<const SCEV *, 16> &CurRegs,
1548                     DenseSet<const SCEV *> &VisitedRegs) const;
1549   void Solve(SmallVectorImpl<const Formula *> &Solution) const;
1550
1551   BasicBlock::iterator
1552     HoistInsertPosition(BasicBlock::iterator IP,
1553                         const SmallVectorImpl<Instruction *> &Inputs) const;
1554   BasicBlock::iterator
1555     AdjustInsertPositionForExpand(BasicBlock::iterator IP,
1556                                   const LSRFixup &LF,
1557                                   const LSRUse &LU,
1558                                   SCEVExpander &Rewriter) const;
1559
1560   Value *Expand(const LSRFixup &LF,
1561                 const Formula &F,
1562                 BasicBlock::iterator IP,
1563                 SCEVExpander &Rewriter,
1564                 SmallVectorImpl<WeakVH> &DeadInsts) const;
1565   void RewriteForPHI(PHINode *PN, const LSRFixup &LF,
1566                      const Formula &F,
1567                      SCEVExpander &Rewriter,
1568                      SmallVectorImpl<WeakVH> &DeadInsts,
1569                      Pass *P) const;
1570   void Rewrite(const LSRFixup &LF,
1571                const Formula &F,
1572                SCEVExpander &Rewriter,
1573                SmallVectorImpl<WeakVH> &DeadInsts,
1574                Pass *P) const;
1575   void ImplementSolution(const SmallVectorImpl<const Formula *> &Solution,
1576                          Pass *P);
1577
1578 public:
1579   LSRInstance(const TargetLowering *tli, Loop *l, Pass *P);
1580
1581   bool getChanged() const { return Changed; }
1582
1583   void print_factors_and_types(raw_ostream &OS) const;
1584   void print_fixups(raw_ostream &OS) const;
1585   void print_uses(raw_ostream &OS) const;
1586   void print(raw_ostream &OS) const;
1587   void dump() const;
1588 };
1589
1590 }
1591
1592 /// OptimizeShadowIV - If IV is used in a int-to-float cast
1593 /// inside the loop then try to eliminate the cast operation.
1594 void LSRInstance::OptimizeShadowIV() {
1595   const SCEV *BackedgeTakenCount = SE.getBackedgeTakenCount(L);
1596   if (isa<SCEVCouldNotCompute>(BackedgeTakenCount))
1597     return;
1598
1599   for (IVUsers::const_iterator UI = IU.begin(), E = IU.end();
1600        UI != E; /* empty */) {
1601     IVUsers::const_iterator CandidateUI = UI;
1602     ++UI;
1603     Instruction *ShadowUse = CandidateUI->getUser();
1604     Type *DestTy = NULL;
1605     bool IsSigned = false;
1606
1607     /* If shadow use is a int->float cast then insert a second IV
1608        to eliminate this cast.
1609
1610          for (unsigned i = 0; i < n; ++i)
1611            foo((double)i);
1612
1613        is transformed into
1614
1615          double d = 0.0;
1616          for (unsigned i = 0; i < n; ++i, ++d)
1617            foo(d);
1618     */
1619     if (UIToFPInst *UCast = dyn_cast<UIToFPInst>(CandidateUI->getUser())) {
1620       IsSigned = false;
1621       DestTy = UCast->getDestTy();
1622     }
1623     else if (SIToFPInst *SCast = dyn_cast<SIToFPInst>(CandidateUI->getUser())) {
1624       IsSigned = true;
1625       DestTy = SCast->getDestTy();
1626     }
1627     if (!DestTy) continue;
1628
1629     if (TLI) {
1630       // If target does not support DestTy natively then do not apply
1631       // this transformation.
1632       EVT DVT = TLI->getValueType(DestTy);
1633       if (!TLI->isTypeLegal(DVT)) continue;
1634     }
1635
1636     PHINode *PH = dyn_cast<PHINode>(ShadowUse->getOperand(0));
1637     if (!PH) continue;
1638     if (PH->getNumIncomingValues() != 2) continue;
1639
1640     Type *SrcTy = PH->getType();
1641     int Mantissa = DestTy->getFPMantissaWidth();
1642     if (Mantissa == -1) continue;
1643     if ((int)SE.getTypeSizeInBits(SrcTy) > Mantissa)
1644       continue;
1645
1646     unsigned Entry, Latch;
1647     if (PH->getIncomingBlock(0) == L->getLoopPreheader()) {
1648       Entry = 0;
1649       Latch = 1;
1650     } else {
1651       Entry = 1;
1652       Latch = 0;
1653     }
1654
1655     ConstantInt *Init = dyn_cast<ConstantInt>(PH->getIncomingValue(Entry));
1656     if (!Init) continue;
1657     Constant *NewInit = ConstantFP::get(DestTy, IsSigned ?
1658                                         (double)Init->getSExtValue() :
1659                                         (double)Init->getZExtValue());
1660
1661     BinaryOperator *Incr =
1662       dyn_cast<BinaryOperator>(PH->getIncomingValue(Latch));
1663     if (!Incr) continue;
1664     if (Incr->getOpcode() != Instruction::Add
1665         && Incr->getOpcode() != Instruction::Sub)
1666       continue;
1667
1668     /* Initialize new IV, double d = 0.0 in above example. */
1669     ConstantInt *C = NULL;
1670     if (Incr->getOperand(0) == PH)
1671       C = dyn_cast<ConstantInt>(Incr->getOperand(1));
1672     else if (Incr->getOperand(1) == PH)
1673       C = dyn_cast<ConstantInt>(Incr->getOperand(0));
1674     else
1675       continue;
1676
1677     if (!C) continue;
1678
1679     // Ignore negative constants, as the code below doesn't handle them
1680     // correctly. TODO: Remove this restriction.
1681     if (!C->getValue().isStrictlyPositive()) continue;
1682
1683     /* Add new PHINode. */
1684     PHINode *NewPH = PHINode::Create(DestTy, 2, "IV.S.", PH);
1685
1686     /* create new increment. '++d' in above example. */
1687     Constant *CFP = ConstantFP::get(DestTy, C->getZExtValue());
1688     BinaryOperator *NewIncr =
1689       BinaryOperator::Create(Incr->getOpcode() == Instruction::Add ?
1690                                Instruction::FAdd : Instruction::FSub,
1691                              NewPH, CFP, "IV.S.next.", Incr);
1692
1693     NewPH->addIncoming(NewInit, PH->getIncomingBlock(Entry));
1694     NewPH->addIncoming(NewIncr, PH->getIncomingBlock(Latch));
1695
1696     /* Remove cast operation */
1697     ShadowUse->replaceAllUsesWith(NewPH);
1698     ShadowUse->eraseFromParent();
1699     Changed = true;
1700     break;
1701   }
1702 }
1703
1704 /// FindIVUserForCond - If Cond has an operand that is an expression of an IV,
1705 /// set the IV user and stride information and return true, otherwise return
1706 /// false.
1707 bool LSRInstance::FindIVUserForCond(ICmpInst *Cond, IVStrideUse *&CondUse) {
1708   for (IVUsers::iterator UI = IU.begin(), E = IU.end(); UI != E; ++UI)
1709     if (UI->getUser() == Cond) {
1710       // NOTE: we could handle setcc instructions with multiple uses here, but
1711       // InstCombine does it as well for simple uses, it's not clear that it
1712       // occurs enough in real life to handle.
1713       CondUse = UI;
1714       return true;
1715     }
1716   return false;
1717 }
1718
1719 /// OptimizeMax - Rewrite the loop's terminating condition if it uses
1720 /// a max computation.
1721 ///
1722 /// This is a narrow solution to a specific, but acute, problem. For loops
1723 /// like this:
1724 ///
1725 ///   i = 0;
1726 ///   do {
1727 ///     p[i] = 0.0;
1728 ///   } while (++i < n);
1729 ///
1730 /// the trip count isn't just 'n', because 'n' might not be positive. And
1731 /// unfortunately this can come up even for loops where the user didn't use
1732 /// a C do-while loop. For example, seemingly well-behaved top-test loops
1733 /// will commonly be lowered like this:
1734 //
1735 ///   if (n > 0) {
1736 ///     i = 0;
1737 ///     do {
1738 ///       p[i] = 0.0;
1739 ///     } while (++i < n);
1740 ///   }
1741 ///
1742 /// and then it's possible for subsequent optimization to obscure the if
1743 /// test in such a way that indvars can't find it.
1744 ///
1745 /// When indvars can't find the if test in loops like this, it creates a
1746 /// max expression, which allows it to give the loop a canonical
1747 /// induction variable:
1748 ///
1749 ///   i = 0;
1750 ///   max = n < 1 ? 1 : n;
1751 ///   do {
1752 ///     p[i] = 0.0;
1753 ///   } while (++i != max);
1754 ///
1755 /// Canonical induction variables are necessary because the loop passes
1756 /// are designed around them. The most obvious example of this is the
1757 /// LoopInfo analysis, which doesn't remember trip count values. It
1758 /// expects to be able to rediscover the trip count each time it is
1759 /// needed, and it does this using a simple analysis that only succeeds if
1760 /// the loop has a canonical induction variable.
1761 ///
1762 /// However, when it comes time to generate code, the maximum operation
1763 /// can be quite costly, especially if it's inside of an outer loop.
1764 ///
1765 /// This function solves this problem by detecting this type of loop and
1766 /// rewriting their conditions from ICMP_NE back to ICMP_SLT, and deleting
1767 /// the instructions for the maximum computation.
1768 ///
1769 ICmpInst *LSRInstance::OptimizeMax(ICmpInst *Cond, IVStrideUse* &CondUse) {
1770   // Check that the loop matches the pattern we're looking for.
1771   if (Cond->getPredicate() != CmpInst::ICMP_EQ &&
1772       Cond->getPredicate() != CmpInst::ICMP_NE)
1773     return Cond;
1774
1775   SelectInst *Sel = dyn_cast<SelectInst>(Cond->getOperand(1));
1776   if (!Sel || !Sel->hasOneUse()) return Cond;
1777
1778   const SCEV *BackedgeTakenCount = SE.getBackedgeTakenCount(L);
1779   if (isa<SCEVCouldNotCompute>(BackedgeTakenCount))
1780     return Cond;
1781   const SCEV *One = SE.getConstant(BackedgeTakenCount->getType(), 1);
1782
1783   // Add one to the backedge-taken count to get the trip count.
1784   const SCEV *IterationCount = SE.getAddExpr(One, BackedgeTakenCount);
1785   if (IterationCount != SE.getSCEV(Sel)) return Cond;
1786
1787   // Check for a max calculation that matches the pattern. There's no check
1788   // for ICMP_ULE here because the comparison would be with zero, which
1789   // isn't interesting.
1790   CmpInst::Predicate Pred = ICmpInst::BAD_ICMP_PREDICATE;
1791   const SCEVNAryExpr *Max = 0;
1792   if (const SCEVSMaxExpr *S = dyn_cast<SCEVSMaxExpr>(BackedgeTakenCount)) {
1793     Pred = ICmpInst::ICMP_SLE;
1794     Max = S;
1795   } else if (const SCEVSMaxExpr *S = dyn_cast<SCEVSMaxExpr>(IterationCount)) {
1796     Pred = ICmpInst::ICMP_SLT;
1797     Max = S;
1798   } else if (const SCEVUMaxExpr *U = dyn_cast<SCEVUMaxExpr>(IterationCount)) {
1799     Pred = ICmpInst::ICMP_ULT;
1800     Max = U;
1801   } else {
1802     // No match; bail.
1803     return Cond;
1804   }
1805
1806   // To handle a max with more than two operands, this optimization would
1807   // require additional checking and setup.
1808   if (Max->getNumOperands() != 2)
1809     return Cond;
1810
1811   const SCEV *MaxLHS = Max->getOperand(0);
1812   const SCEV *MaxRHS = Max->getOperand(1);
1813
1814   // ScalarEvolution canonicalizes constants to the left. For < and >, look
1815   // for a comparison with 1. For <= and >=, a comparison with zero.
1816   if (!MaxLHS ||
1817       (ICmpInst::isTrueWhenEqual(Pred) ? !MaxLHS->isZero() : (MaxLHS != One)))
1818     return Cond;
1819
1820   // Check the relevant induction variable for conformance to
1821   // the pattern.
1822   const SCEV *IV = SE.getSCEV(Cond->getOperand(0));
1823   const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(IV);
1824   if (!AR || !AR->isAffine() ||
1825       AR->getStart() != One ||
1826       AR->getStepRecurrence(SE) != One)
1827     return Cond;
1828
1829   assert(AR->getLoop() == L &&
1830          "Loop condition operand is an addrec in a different loop!");
1831
1832   // Check the right operand of the select, and remember it, as it will
1833   // be used in the new comparison instruction.
1834   Value *NewRHS = 0;
1835   if (ICmpInst::isTrueWhenEqual(Pred)) {
1836     // Look for n+1, and grab n.
1837     if (AddOperator *BO = dyn_cast<AddOperator>(Sel->getOperand(1)))
1838       if (isa<ConstantInt>(BO->getOperand(1)) &&
1839           cast<ConstantInt>(BO->getOperand(1))->isOne() &&
1840           SE.getSCEV(BO->getOperand(0)) == MaxRHS)
1841         NewRHS = BO->getOperand(0);
1842     if (AddOperator *BO = dyn_cast<AddOperator>(Sel->getOperand(2)))
1843       if (isa<ConstantInt>(BO->getOperand(1)) &&
1844           cast<ConstantInt>(BO->getOperand(1))->isOne() &&
1845           SE.getSCEV(BO->getOperand(0)) == MaxRHS)
1846         NewRHS = BO->getOperand(0);
1847     if (!NewRHS)
1848       return Cond;
1849   } else if (SE.getSCEV(Sel->getOperand(1)) == MaxRHS)
1850     NewRHS = Sel->getOperand(1);
1851   else if (SE.getSCEV(Sel->getOperand(2)) == MaxRHS)
1852     NewRHS = Sel->getOperand(2);
1853   else if (const SCEVUnknown *SU = dyn_cast<SCEVUnknown>(MaxRHS))
1854     NewRHS = SU->getValue();
1855   else
1856     // Max doesn't match expected pattern.
1857     return Cond;
1858
1859   // Determine the new comparison opcode. It may be signed or unsigned,
1860   // and the original comparison may be either equality or inequality.
1861   if (Cond->getPredicate() == CmpInst::ICMP_EQ)
1862     Pred = CmpInst::getInversePredicate(Pred);
1863
1864   // Ok, everything looks ok to change the condition into an SLT or SGE and
1865   // delete the max calculation.
1866   ICmpInst *NewCond =
1867     new ICmpInst(Cond, Pred, Cond->getOperand(0), NewRHS, "scmp");
1868
1869   // Delete the max calculation instructions.
1870   Cond->replaceAllUsesWith(NewCond);
1871   CondUse->setUser(NewCond);
1872   Instruction *Cmp = cast<Instruction>(Sel->getOperand(0));
1873   Cond->eraseFromParent();
1874   Sel->eraseFromParent();
1875   if (Cmp->use_empty())
1876     Cmp->eraseFromParent();
1877   return NewCond;
1878 }
1879
1880 /// OptimizeLoopTermCond - Change loop terminating condition to use the
1881 /// postinc iv when possible.
1882 void
1883 LSRInstance::OptimizeLoopTermCond() {
1884   SmallPtrSet<Instruction *, 4> PostIncs;
1885
1886   BasicBlock *LatchBlock = L->getLoopLatch();
1887   SmallVector<BasicBlock*, 8> ExitingBlocks;
1888   L->getExitingBlocks(ExitingBlocks);
1889
1890   for (unsigned i = 0, e = ExitingBlocks.size(); i != e; ++i) {
1891     BasicBlock *ExitingBlock = ExitingBlocks[i];
1892
1893     // Get the terminating condition for the loop if possible.  If we
1894     // can, we want to change it to use a post-incremented version of its
1895     // induction variable, to allow coalescing the live ranges for the IV into
1896     // one register value.
1897
1898     BranchInst *TermBr = dyn_cast<BranchInst>(ExitingBlock->getTerminator());
1899     if (!TermBr)
1900       continue;
1901     // FIXME: Overly conservative, termination condition could be an 'or' etc..
1902     if (TermBr->isUnconditional() || !isa<ICmpInst>(TermBr->getCondition()))
1903       continue;
1904
1905     // Search IVUsesByStride to find Cond's IVUse if there is one.
1906     IVStrideUse *CondUse = 0;
1907     ICmpInst *Cond = cast<ICmpInst>(TermBr->getCondition());
1908     if (!FindIVUserForCond(Cond, CondUse))
1909       continue;
1910
1911     // If the trip count is computed in terms of a max (due to ScalarEvolution
1912     // being unable to find a sufficient guard, for example), change the loop
1913     // comparison to use SLT or ULT instead of NE.
1914     // One consequence of doing this now is that it disrupts the count-down
1915     // optimization. That's not always a bad thing though, because in such
1916     // cases it may still be worthwhile to avoid a max.
1917     Cond = OptimizeMax(Cond, CondUse);
1918
1919     // If this exiting block dominates the latch block, it may also use
1920     // the post-inc value if it won't be shared with other uses.
1921     // Check for dominance.
1922     if (!DT.dominates(ExitingBlock, LatchBlock))
1923       continue;
1924
1925     // Conservatively avoid trying to use the post-inc value in non-latch
1926     // exits if there may be pre-inc users in intervening blocks.
1927     if (LatchBlock != ExitingBlock)
1928       for (IVUsers::const_iterator UI = IU.begin(), E = IU.end(); UI != E; ++UI)
1929         // Test if the use is reachable from the exiting block. This dominator
1930         // query is a conservative approximation of reachability.
1931         if (&*UI != CondUse &&
1932             !DT.properlyDominates(UI->getUser()->getParent(), ExitingBlock)) {
1933           // Conservatively assume there may be reuse if the quotient of their
1934           // strides could be a legal scale.
1935           const SCEV *A = IU.getStride(*CondUse, L);
1936           const SCEV *B = IU.getStride(*UI, L);
1937           if (!A || !B) continue;
1938           if (SE.getTypeSizeInBits(A->getType()) !=
1939               SE.getTypeSizeInBits(B->getType())) {
1940             if (SE.getTypeSizeInBits(A->getType()) >
1941                 SE.getTypeSizeInBits(B->getType()))
1942               B = SE.getSignExtendExpr(B, A->getType());
1943             else
1944               A = SE.getSignExtendExpr(A, B->getType());
1945           }
1946           if (const SCEVConstant *D =
1947                 dyn_cast_or_null<SCEVConstant>(getExactSDiv(B, A, SE))) {
1948             const ConstantInt *C = D->getValue();
1949             // Stride of one or negative one can have reuse with non-addresses.
1950             if (C->isOne() || C->isAllOnesValue())
1951               goto decline_post_inc;
1952             // Avoid weird situations.
1953             if (C->getValue().getMinSignedBits() >= 64 ||
1954                 C->getValue().isMinSignedValue())
1955               goto decline_post_inc;
1956             // Without TLI, assume that any stride might be valid, and so any
1957             // use might be shared.
1958             if (!TLI)
1959               goto decline_post_inc;
1960             // Check for possible scaled-address reuse.
1961             Type *AccessTy = getAccessType(UI->getUser());
1962             TargetLowering::AddrMode AM;
1963             AM.Scale = C->getSExtValue();
1964             if (TLI->isLegalAddressingMode(AM, AccessTy))
1965               goto decline_post_inc;
1966             AM.Scale = -AM.Scale;
1967             if (TLI->isLegalAddressingMode(AM, AccessTy))
1968               goto decline_post_inc;
1969           }
1970         }
1971
1972     DEBUG(dbgs() << "  Change loop exiting icmp to use postinc iv: "
1973                  << *Cond << '\n');
1974
1975     // It's possible for the setcc instruction to be anywhere in the loop, and
1976     // possible for it to have multiple users.  If it is not immediately before
1977     // the exiting block branch, move it.
1978     if (&*++BasicBlock::iterator(Cond) != TermBr) {
1979       if (Cond->hasOneUse()) {
1980         Cond->moveBefore(TermBr);
1981       } else {
1982         // Clone the terminating condition and insert into the loopend.
1983         ICmpInst *OldCond = Cond;
1984         Cond = cast<ICmpInst>(Cond->clone());
1985         Cond->setName(L->getHeader()->getName() + ".termcond");
1986         ExitingBlock->getInstList().insert(TermBr, Cond);
1987
1988         // Clone the IVUse, as the old use still exists!
1989         CondUse = &IU.AddUser(Cond, CondUse->getOperandValToReplace());
1990         TermBr->replaceUsesOfWith(OldCond, Cond);
1991       }
1992     }
1993
1994     // If we get to here, we know that we can transform the setcc instruction to
1995     // use the post-incremented version of the IV, allowing us to coalesce the
1996     // live ranges for the IV correctly.
1997     CondUse->transformToPostInc(L);
1998     Changed = true;
1999
2000     PostIncs.insert(Cond);
2001   decline_post_inc:;
2002   }
2003
2004   // Determine an insertion point for the loop induction variable increment. It
2005   // must dominate all the post-inc comparisons we just set up, and it must
2006   // dominate the loop latch edge.
2007   IVIncInsertPos = L->getLoopLatch()->getTerminator();
2008   for (SmallPtrSet<Instruction *, 4>::const_iterator I = PostIncs.begin(),
2009        E = PostIncs.end(); I != E; ++I) {
2010     BasicBlock *BB =
2011       DT.findNearestCommonDominator(IVIncInsertPos->getParent(),
2012                                     (*I)->getParent());
2013     if (BB == (*I)->getParent())
2014       IVIncInsertPos = *I;
2015     else if (BB != IVIncInsertPos->getParent())
2016       IVIncInsertPos = BB->getTerminator();
2017   }
2018 }
2019
2020 /// reconcileNewOffset - Determine if the given use can accommodate a fixup
2021 /// at the given offset and other details. If so, update the use and
2022 /// return true.
2023 bool
2024 LSRInstance::reconcileNewOffset(LSRUse &LU, int64_t NewOffset, bool HasBaseReg,
2025                                 LSRUse::KindType Kind, Type *AccessTy) {
2026   int64_t NewMinOffset = LU.MinOffset;
2027   int64_t NewMaxOffset = LU.MaxOffset;
2028   Type *NewAccessTy = AccessTy;
2029
2030   // Check for a mismatched kind. It's tempting to collapse mismatched kinds to
2031   // something conservative, however this can pessimize in the case that one of
2032   // the uses will have all its uses outside the loop, for example.
2033   if (LU.Kind != Kind)
2034     return false;
2035   // Conservatively assume HasBaseReg is true for now.
2036   if (NewOffset < LU.MinOffset) {
2037     if (!isAlwaysFoldable(LU.MaxOffset - NewOffset, 0, HasBaseReg,
2038                           Kind, AccessTy, TLI))
2039       return false;
2040     NewMinOffset = NewOffset;
2041   } else if (NewOffset > LU.MaxOffset) {
2042     if (!isAlwaysFoldable(NewOffset - LU.MinOffset, 0, HasBaseReg,
2043                           Kind, AccessTy, TLI))
2044       return false;
2045     NewMaxOffset = NewOffset;
2046   }
2047   // Check for a mismatched access type, and fall back conservatively as needed.
2048   // TODO: Be less conservative when the type is similar and can use the same
2049   // addressing modes.
2050   if (Kind == LSRUse::Address && AccessTy != LU.AccessTy)
2051     NewAccessTy = Type::getVoidTy(AccessTy->getContext());
2052
2053   // Update the use.
2054   LU.MinOffset = NewMinOffset;
2055   LU.MaxOffset = NewMaxOffset;
2056   LU.AccessTy = NewAccessTy;
2057   if (NewOffset != LU.Offsets.back())
2058     LU.Offsets.push_back(NewOffset);
2059   return true;
2060 }
2061
2062 /// getUse - Return an LSRUse index and an offset value for a fixup which
2063 /// needs the given expression, with the given kind and optional access type.
2064 /// Either reuse an existing use or create a new one, as needed.
2065 std::pair<size_t, int64_t>
2066 LSRInstance::getUse(const SCEV *&Expr,
2067                     LSRUse::KindType Kind, Type *AccessTy) {
2068   const SCEV *Copy = Expr;
2069   int64_t Offset = ExtractImmediate(Expr, SE);
2070
2071   // Basic uses can't accept any offset, for example.
2072   if (!isAlwaysFoldable(Offset, 0, /*HasBaseReg=*/true, Kind, AccessTy, TLI)) {
2073     Expr = Copy;
2074     Offset = 0;
2075   }
2076
2077   std::pair<UseMapTy::iterator, bool> P =
2078     UseMap.insert(std::make_pair(std::make_pair(Expr, Kind), 0));
2079   if (!P.second) {
2080     // A use already existed with this base.
2081     size_t LUIdx = P.first->second;
2082     LSRUse &LU = Uses[LUIdx];
2083     if (reconcileNewOffset(LU, Offset, /*HasBaseReg=*/true, Kind, AccessTy))
2084       // Reuse this use.
2085       return std::make_pair(LUIdx, Offset);
2086   }
2087
2088   // Create a new use.
2089   size_t LUIdx = Uses.size();
2090   P.first->second = LUIdx;
2091   Uses.push_back(LSRUse(Kind, AccessTy));
2092   LSRUse &LU = Uses[LUIdx];
2093
2094   // We don't need to track redundant offsets, but we don't need to go out
2095   // of our way here to avoid them.
2096   if (LU.Offsets.empty() || Offset != LU.Offsets.back())
2097     LU.Offsets.push_back(Offset);
2098
2099   LU.MinOffset = Offset;
2100   LU.MaxOffset = Offset;
2101   return std::make_pair(LUIdx, Offset);
2102 }
2103
2104 /// DeleteUse - Delete the given use from the Uses list.
2105 void LSRInstance::DeleteUse(LSRUse &LU, size_t LUIdx) {
2106   if (&LU != &Uses.back())
2107     std::swap(LU, Uses.back());
2108   Uses.pop_back();
2109
2110   // Update RegUses.
2111   RegUses.SwapAndDropUse(LUIdx, Uses.size());
2112 }
2113
2114 /// FindUseWithFormula - Look for a use distinct from OrigLU which is has
2115 /// a formula that has the same registers as the given formula.
2116 LSRUse *
2117 LSRInstance::FindUseWithSimilarFormula(const Formula &OrigF,
2118                                        const LSRUse &OrigLU) {
2119   // Search all uses for the formula. This could be more clever.
2120   for (size_t LUIdx = 0, NumUses = Uses.size(); LUIdx != NumUses; ++LUIdx) {
2121     LSRUse &LU = Uses[LUIdx];
2122     // Check whether this use is close enough to OrigLU, to see whether it's
2123     // worthwhile looking through its formulae.
2124     // Ignore ICmpZero uses because they may contain formulae generated by
2125     // GenerateICmpZeroScales, in which case adding fixup offsets may
2126     // be invalid.
2127     if (&LU != &OrigLU &&
2128         LU.Kind != LSRUse::ICmpZero &&
2129         LU.Kind == OrigLU.Kind && OrigLU.AccessTy == LU.AccessTy &&
2130         LU.WidestFixupType == OrigLU.WidestFixupType &&
2131         LU.HasFormulaWithSameRegs(OrigF)) {
2132       // Scan through this use's formulae.
2133       for (SmallVectorImpl<Formula>::const_iterator I = LU.Formulae.begin(),
2134            E = LU.Formulae.end(); I != E; ++I) {
2135         const Formula &F = *I;
2136         // Check to see if this formula has the same registers and symbols
2137         // as OrigF.
2138         if (F.BaseRegs == OrigF.BaseRegs &&
2139             F.ScaledReg == OrigF.ScaledReg &&
2140             F.AM.BaseGV == OrigF.AM.BaseGV &&
2141             F.AM.Scale == OrigF.AM.Scale &&
2142             F.UnfoldedOffset == OrigF.UnfoldedOffset) {
2143           if (F.AM.BaseOffs == 0)
2144             return &LU;
2145           // This is the formula where all the registers and symbols matched;
2146           // there aren't going to be any others. Since we declined it, we
2147           // can skip the rest of the formulae and procede to the next LSRUse.
2148           break;
2149         }
2150       }
2151     }
2152   }
2153
2154   // Nothing looked good.
2155   return 0;
2156 }
2157
2158 void LSRInstance::CollectInterestingTypesAndFactors() {
2159   SmallSetVector<const SCEV *, 4> Strides;
2160
2161   // Collect interesting types and strides.
2162   SmallVector<const SCEV *, 4> Worklist;
2163   for (IVUsers::const_iterator UI = IU.begin(), E = IU.end(); UI != E; ++UI) {
2164     const SCEV *Expr = IU.getExpr(*UI);
2165
2166     // Collect interesting types.
2167     Types.insert(SE.getEffectiveSCEVType(Expr->getType()));
2168
2169     // Add strides for mentioned loops.
2170     Worklist.push_back(Expr);
2171     do {
2172       const SCEV *S = Worklist.pop_back_val();
2173       if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S)) {
2174         if (AR->getLoop() == L)
2175           Strides.insert(AR->getStepRecurrence(SE));
2176         Worklist.push_back(AR->getStart());
2177       } else if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
2178         Worklist.append(Add->op_begin(), Add->op_end());
2179       }
2180     } while (!Worklist.empty());
2181   }
2182
2183   // Compute interesting factors from the set of interesting strides.
2184   for (SmallSetVector<const SCEV *, 4>::const_iterator
2185        I = Strides.begin(), E = Strides.end(); I != E; ++I)
2186     for (SmallSetVector<const SCEV *, 4>::const_iterator NewStrideIter =
2187          llvm::next(I); NewStrideIter != E; ++NewStrideIter) {
2188       const SCEV *OldStride = *I;
2189       const SCEV *NewStride = *NewStrideIter;
2190
2191       if (SE.getTypeSizeInBits(OldStride->getType()) !=
2192           SE.getTypeSizeInBits(NewStride->getType())) {
2193         if (SE.getTypeSizeInBits(OldStride->getType()) >
2194             SE.getTypeSizeInBits(NewStride->getType()))
2195           NewStride = SE.getSignExtendExpr(NewStride, OldStride->getType());
2196         else
2197           OldStride = SE.getSignExtendExpr(OldStride, NewStride->getType());
2198       }
2199       if (const SCEVConstant *Factor =
2200             dyn_cast_or_null<SCEVConstant>(getExactSDiv(NewStride, OldStride,
2201                                                         SE, true))) {
2202         if (Factor->getValue()->getValue().getMinSignedBits() <= 64)
2203           Factors.insert(Factor->getValue()->getValue().getSExtValue());
2204       } else if (const SCEVConstant *Factor =
2205                    dyn_cast_or_null<SCEVConstant>(getExactSDiv(OldStride,
2206                                                                NewStride,
2207                                                                SE, true))) {
2208         if (Factor->getValue()->getValue().getMinSignedBits() <= 64)
2209           Factors.insert(Factor->getValue()->getValue().getSExtValue());
2210       }
2211     }
2212
2213   // If all uses use the same type, don't bother looking for truncation-based
2214   // reuse.
2215   if (Types.size() == 1)
2216     Types.clear();
2217
2218   DEBUG(print_factors_and_types(dbgs()));
2219 }
2220
2221 /// findIVOperand - Helper for CollectChains that finds an IV operand (computed
2222 /// by an AddRec in this loop) within [OI,OE) or returns OE. If IVUsers mapped
2223 /// Instructions to IVStrideUses, we could partially skip this.
2224 static User::op_iterator
2225 findIVOperand(User::op_iterator OI, User::op_iterator OE,
2226               Loop *L, ScalarEvolution &SE) {
2227   for(; OI != OE; ++OI) {
2228     if (Instruction *Oper = dyn_cast<Instruction>(*OI)) {
2229       if (!SE.isSCEVable(Oper->getType()))
2230         continue;
2231
2232       if (const SCEVAddRecExpr *AR =
2233           dyn_cast<SCEVAddRecExpr>(SE.getSCEV(Oper))) {
2234         if (AR->getLoop() == L)
2235           break;
2236       }
2237     }
2238   }
2239   return OI;
2240 }
2241
2242 /// getWideOperand - IVChain logic must consistenctly peek base TruncInst
2243 /// operands, so wrap it in a convenient helper.
2244 static Value *getWideOperand(Value *Oper) {
2245   if (TruncInst *Trunc = dyn_cast<TruncInst>(Oper))
2246     return Trunc->getOperand(0);
2247   return Oper;
2248 }
2249
2250 /// isCompatibleIVType - Return true if we allow an IV chain to include both
2251 /// types.
2252 static bool isCompatibleIVType(Value *LVal, Value *RVal) {
2253   Type *LType = LVal->getType();
2254   Type *RType = RVal->getType();
2255   return (LType == RType) || (LType->isPointerTy() && RType->isPointerTy());
2256 }
2257
2258 /// getExprBase - Return an approximation of this SCEV expression's "base", or
2259 /// NULL for any constant. Returning the expression itself is
2260 /// conservative. Returning a deeper subexpression is more precise and valid as
2261 /// long as it isn't less complex than another subexpression. For expressions
2262 /// involving multiple unscaled values, we need to return the pointer-type
2263 /// SCEVUnknown. This avoids forming chains across objects, such as:
2264 /// PrevOper==a[i], IVOper==b[i], IVInc==b-a.
2265 ///
2266 /// Since SCEVUnknown is the rightmost type, and pointers are the rightmost
2267 /// SCEVUnknown, we simply return the rightmost SCEV operand.
2268 static const SCEV *getExprBase(const SCEV *S) {
2269   switch (S->getSCEVType()) {
2270   default: // uncluding scUnknown.
2271     return S;
2272   case scConstant:
2273     return 0;
2274   case scTruncate:
2275     return getExprBase(cast<SCEVTruncateExpr>(S)->getOperand());
2276   case scZeroExtend:
2277     return getExprBase(cast<SCEVZeroExtendExpr>(S)->getOperand());
2278   case scSignExtend:
2279     return getExprBase(cast<SCEVSignExtendExpr>(S)->getOperand());
2280   case scAddExpr: {
2281     // Skip over scaled operands (scMulExpr) to follow add operands as long as
2282     // there's nothing more complex.
2283     // FIXME: not sure if we want to recognize negation.
2284     const SCEVAddExpr *Add = cast<SCEVAddExpr>(S);
2285     for (std::reverse_iterator<SCEVAddExpr::op_iterator> I(Add->op_end()),
2286            E(Add->op_begin()); I != E; ++I) {
2287       const SCEV *SubExpr = *I;
2288       if (SubExpr->getSCEVType() == scAddExpr)
2289         return getExprBase(SubExpr);
2290
2291       if (SubExpr->getSCEVType() != scMulExpr)
2292         return SubExpr;
2293     }
2294     return S; // all operands are scaled, be conservative.
2295   }
2296   case scAddRecExpr:
2297     return getExprBase(cast<SCEVAddRecExpr>(S)->getStart());
2298   }
2299 }
2300
2301 /// Return true if the chain increment is profitable to expand into a loop
2302 /// invariant value, which may require its own register. A profitable chain
2303 /// increment will be an offset relative to the same base. We allow such offsets
2304 /// to potentially be used as chain increment as long as it's not obviously
2305 /// expensive to expand using real instructions.
2306 static const SCEV *
2307 getProfitableChainIncrement(Value *NextIV, Value *PrevIV,
2308                             const IVChain &Chain, Loop *L,
2309                             ScalarEvolution &SE, const TargetLowering *TLI) {
2310   // Prune the solution space aggressively by checking that both IV operands
2311   // are expressions that operate on the same unscaled SCEVUnknown. This
2312   // "base" will be canceled by the subsequent getMinusSCEV call. Checking first
2313   // avoids creating extra SCEV expressions.
2314   const SCEV *OperExpr = SE.getSCEV(NextIV);
2315   const SCEV *PrevExpr = SE.getSCEV(PrevIV);
2316   if (getExprBase(OperExpr) != getExprBase(PrevExpr) && !StressIVChain)
2317     return 0;
2318
2319   const SCEV *IncExpr = SE.getMinusSCEV(OperExpr, PrevExpr);
2320   if (!SE.isLoopInvariant(IncExpr, L))
2321     return 0;
2322
2323   // We are not able to expand an increment unless it is loop invariant,
2324   // however, the following checks are purely for profitability.
2325   if (StressIVChain)
2326     return IncExpr;
2327
2328   // Do not replace a constant offset from IV head with a nonconstant IV
2329   // increment.
2330   if (!isa<SCEVConstant>(IncExpr)) {
2331     const SCEV *HeadExpr = SE.getSCEV(getWideOperand(Chain[0].IVOperand));
2332     if (isa<SCEVConstant>(SE.getMinusSCEV(OperExpr, HeadExpr)))
2333       return 0;
2334   }
2335
2336   SmallPtrSet<const SCEV*, 8> Processed;
2337   if (isHighCostExpansion(IncExpr, Processed, SE))
2338     return 0;
2339
2340   return IncExpr;
2341 }
2342
2343 /// Return true if the number of registers needed for the chain is estimated to
2344 /// be less than the number required for the individual IV users. First prohibit
2345 /// any IV users that keep the IV live across increments (the Users set should
2346 /// be empty). Next count the number and type of increments in the chain.
2347 ///
2348 /// Chaining IVs can lead to considerable code bloat if ISEL doesn't
2349 /// effectively use postinc addressing modes. Only consider it profitable it the
2350 /// increments can be computed in fewer registers when chained.
2351 ///
2352 /// TODO: Consider IVInc free if it's already used in another chains.
2353 static bool
2354 isProfitableChain(IVChain &Chain, SmallPtrSet<Instruction*, 4> &Users,
2355                   ScalarEvolution &SE, const TargetLowering *TLI) {
2356   if (StressIVChain)
2357     return true;
2358
2359   if (Chain.size() <= 2)
2360     return false;
2361
2362   if (!Users.empty()) {
2363     DEBUG(dbgs() << "Chain: " << *Chain[0].UserInst << " users:\n";
2364           for (SmallPtrSet<Instruction*, 4>::const_iterator I = Users.begin(),
2365                  E = Users.end(); I != E; ++I) {
2366             dbgs() << "  " << **I << "\n";
2367           });
2368     return false;
2369   }
2370   assert(!Chain.empty() && "empty IV chains are not allowed");
2371
2372   // The chain itself may require a register, so intialize cost to 1.
2373   int cost = 1;
2374
2375   // A complete chain likely eliminates the need for keeping the original IV in
2376   // a register. LSR does not currently know how to form a complete chain unless
2377   // the header phi already exists.
2378   if (isa<PHINode>(Chain.back().UserInst)
2379       && SE.getSCEV(Chain.back().UserInst) == Chain[0].IncExpr) {
2380     --cost;
2381   }
2382   const SCEV *LastIncExpr = 0;
2383   unsigned NumConstIncrements = 0;
2384   unsigned NumVarIncrements = 0;
2385   unsigned NumReusedIncrements = 0;
2386   for (IVChain::const_iterator I = llvm::next(Chain.begin()), E = Chain.end();
2387        I != E; ++I) {
2388
2389     if (I->IncExpr->isZero())
2390       continue;
2391
2392     // Incrementing by zero or some constant is neutral. We assume constants can
2393     // be folded into an addressing mode or an add's immediate operand.
2394     if (isa<SCEVConstant>(I->IncExpr)) {
2395       ++NumConstIncrements;
2396       continue;
2397     }
2398
2399     if (I->IncExpr == LastIncExpr)
2400       ++NumReusedIncrements;
2401     else
2402       ++NumVarIncrements;
2403
2404     LastIncExpr = I->IncExpr;
2405   }
2406   // An IV chain with a single increment is handled by LSR's postinc
2407   // uses. However, a chain with multiple increments requires keeping the IV's
2408   // value live longer than it needs to be if chained.
2409   if (NumConstIncrements > 1)
2410     --cost;
2411
2412   // Materializing increment expressions in the preheader that didn't exist in
2413   // the original code may cost a register. For example, sign-extended array
2414   // indices can produce ridiculous increments like this:
2415   // IV + ((sext i32 (2 * %s) to i64) + (-1 * (sext i32 %s to i64)))
2416   cost += NumVarIncrements;
2417
2418   // Reusing variable increments likely saves a register to hold the multiple of
2419   // the stride.
2420   cost -= NumReusedIncrements;
2421
2422   DEBUG(dbgs() << "Chain: " << *Chain[0].UserInst << " Cost: " << cost << "\n");
2423
2424   return cost < 0;
2425 }
2426
2427 /// ChainInstruction - Add this IV user to an existing chain or make it the head
2428 /// of a new chain.
2429 void LSRInstance::ChainInstruction(Instruction *UserInst, Instruction *IVOper,
2430                                    SmallVectorImpl<ChainUsers> &ChainUsersVec) {
2431   // When IVs are used as types of varying widths, they are generally converted
2432   // to a wider type with some uses remaining narrow under a (free) trunc.
2433   Value *NextIV = getWideOperand(IVOper);
2434
2435   // Visit all existing chains. Check if its IVOper can be computed as a
2436   // profitable loop invariant increment from the last link in the Chain.
2437   unsigned ChainIdx = 0, NChains = IVChainVec.size();
2438   const SCEV *LastIncExpr = 0;
2439   for (; ChainIdx < NChains; ++ChainIdx) {
2440     Value *PrevIV = getWideOperand(IVChainVec[ChainIdx].back().IVOperand);
2441     if (!isCompatibleIVType(PrevIV, NextIV))
2442       continue;
2443
2444     // A phi nodes terminates a chain.
2445     if (isa<PHINode>(UserInst)
2446         && isa<PHINode>(IVChainVec[ChainIdx].back().UserInst))
2447       continue;
2448
2449     if (const SCEV *IncExpr =
2450         getProfitableChainIncrement(NextIV, PrevIV, IVChainVec[ChainIdx],
2451                                     L, SE, TLI)) {
2452       LastIncExpr = IncExpr;
2453       break;
2454     }
2455   }
2456   // If we haven't found a chain, create a new one, unless we hit the max. Don't
2457   // bother for phi nodes, because they must be last in the chain.
2458   if (ChainIdx == NChains) {
2459     if (isa<PHINode>(UserInst))
2460       return;
2461     if (NChains >= MaxChains && !StressIVChain) {
2462       DEBUG(dbgs() << "IV Chain Limit\n");
2463       return;
2464     }
2465     LastIncExpr = SE.getSCEV(NextIV);
2466     // IVUsers may have skipped over sign/zero extensions. We don't currently
2467     // attempt to form chains involving extensions unless they can be hoisted
2468     // into this loop's AddRec.
2469     if (!isa<SCEVAddRecExpr>(LastIncExpr))
2470       return;
2471     ++NChains;
2472     IVChainVec.resize(NChains);
2473     ChainUsersVec.resize(NChains);
2474     DEBUG(dbgs() << "IV Head: (" << *UserInst << ") IV=" << *LastIncExpr
2475           << "\n");
2476   }
2477   else
2478     DEBUG(dbgs() << "IV  Inc: (" << *UserInst << ") IV+" << *LastIncExpr
2479           << "\n");
2480
2481   // Add this IV user to the end of the chain.
2482   IVChainVec[ChainIdx].push_back(IVInc(UserInst, IVOper, LastIncExpr));
2483
2484   SmallPtrSet<Instruction*,4> &NearUsers = ChainUsersVec[ChainIdx].NearUsers;
2485   // This chain's NearUsers become FarUsers.
2486   if (!LastIncExpr->isZero()) {
2487     ChainUsersVec[ChainIdx].FarUsers.insert(NearUsers.begin(),
2488                                             NearUsers.end());
2489     NearUsers.clear();
2490   }
2491
2492   // All other uses of IVOperand become near uses of the chain.
2493   // We currently ignore intermediate values within SCEV expressions, assuming
2494   // they will eventually be used be the current chain, or can be computed
2495   // from one of the chain increments. To be more precise we could
2496   // transitively follow its user and only add leaf IV users to the set.
2497   for (Value::use_iterator UseIter = IVOper->use_begin(),
2498          UseEnd = IVOper->use_end(); UseIter != UseEnd; ++UseIter) {
2499     Instruction *OtherUse = dyn_cast<Instruction>(*UseIter);
2500     if (SE.isSCEVable(OtherUse->getType())
2501         && !isa<SCEVUnknown>(SE.getSCEV(OtherUse))
2502         && IU.isIVUserOrOperand(OtherUse)) {
2503       continue;
2504     }
2505     if (OtherUse && OtherUse != UserInst)
2506       NearUsers.insert(OtherUse);
2507   }
2508
2509   // Since this user is part of the chain, it's no longer considered a use
2510   // of the chain.
2511   ChainUsersVec[ChainIdx].FarUsers.erase(UserInst);
2512 }
2513
2514 /// CollectChains - Populate the vector of Chains.
2515 ///
2516 /// This decreases ILP at the architecture level. Targets with ample registers,
2517 /// multiple memory ports, and no register renaming probably don't want
2518 /// this. However, such targets should probably disable LSR altogether.
2519 ///
2520 /// The job of LSR is to make a reasonable choice of induction variables across
2521 /// the loop. Subsequent passes can easily "unchain" computation exposing more
2522 /// ILP *within the loop* if the target wants it.
2523 ///
2524 /// Finding the best IV chain is potentially a scheduling problem. Since LSR
2525 /// will not reorder memory operations, it will recognize this as a chain, but
2526 /// will generate redundant IV increments. Ideally this would be corrected later
2527 /// by a smart scheduler:
2528 ///        = A[i]
2529 ///        = A[i+x]
2530 /// A[i]   =
2531 /// A[i+x] =
2532 ///
2533 /// TODO: Walk the entire domtree within this loop, not just the path to the
2534 /// loop latch. This will discover chains on side paths, but requires
2535 /// maintaining multiple copies of the Chains state.
2536 void LSRInstance::CollectChains() {
2537   SmallVector<ChainUsers, 8> ChainUsersVec;
2538
2539   SmallVector<BasicBlock *,8> LatchPath;
2540   BasicBlock *LoopHeader = L->getHeader();
2541   for (DomTreeNode *Rung = DT.getNode(L->getLoopLatch());
2542        Rung->getBlock() != LoopHeader; Rung = Rung->getIDom()) {
2543     LatchPath.push_back(Rung->getBlock());
2544   }
2545   LatchPath.push_back(LoopHeader);
2546
2547   // Walk the instruction stream from the loop header to the loop latch.
2548   for (SmallVectorImpl<BasicBlock *>::reverse_iterator
2549          BBIter = LatchPath.rbegin(), BBEnd = LatchPath.rend();
2550        BBIter != BBEnd; ++BBIter) {
2551     for (BasicBlock::iterator I = (*BBIter)->begin(), E = (*BBIter)->end();
2552          I != E; ++I) {
2553       // Skip instructions that weren't seen by IVUsers analysis.
2554       if (isa<PHINode>(I) || !IU.isIVUserOrOperand(I))
2555         continue;
2556
2557       // Ignore users that are part of a SCEV expression. This way we only
2558       // consider leaf IV Users. This effectively rediscovers a portion of
2559       // IVUsers analysis but in program order this time.
2560       if (SE.isSCEVable(I->getType()) && !isa<SCEVUnknown>(SE.getSCEV(I)))
2561         continue;
2562
2563       // Remove this instruction from any NearUsers set it may be in.
2564       for (unsigned ChainIdx = 0, NChains = IVChainVec.size();
2565            ChainIdx < NChains; ++ChainIdx) {
2566         ChainUsersVec[ChainIdx].NearUsers.erase(I);
2567       }
2568       // Search for operands that can be chained.
2569       SmallPtrSet<Instruction*, 4> UniqueOperands;
2570       User::op_iterator IVOpEnd = I->op_end();
2571       User::op_iterator IVOpIter = findIVOperand(I->op_begin(), IVOpEnd, L, SE);
2572       while (IVOpIter != IVOpEnd) {
2573         Instruction *IVOpInst = cast<Instruction>(*IVOpIter);
2574         if (UniqueOperands.insert(IVOpInst))
2575           ChainInstruction(I, IVOpInst, ChainUsersVec);
2576         IVOpIter = findIVOperand(llvm::next(IVOpIter), IVOpEnd, L, SE);
2577       }
2578     } // Continue walking down the instructions.
2579   } // Continue walking down the domtree.
2580   // Visit phi backedges to determine if the chain can generate the IV postinc.
2581   for (BasicBlock::iterator I = L->getHeader()->begin();
2582        PHINode *PN = dyn_cast<PHINode>(I); ++I) {
2583     if (!SE.isSCEVable(PN->getType()))
2584       continue;
2585
2586     Instruction *IncV =
2587       dyn_cast<Instruction>(PN->getIncomingValueForBlock(L->getLoopLatch()));
2588     if (IncV)
2589       ChainInstruction(PN, IncV, ChainUsersVec);
2590   }
2591   // Remove any unprofitable chains.
2592   unsigned ChainIdx = 0;
2593   for (unsigned UsersIdx = 0, NChains = IVChainVec.size();
2594        UsersIdx < NChains; ++UsersIdx) {
2595     if (!isProfitableChain(IVChainVec[UsersIdx],
2596                            ChainUsersVec[UsersIdx].FarUsers, SE, TLI))
2597       continue;
2598     // Preserve the chain at UsesIdx.
2599     if (ChainIdx != UsersIdx)
2600       IVChainVec[ChainIdx] = IVChainVec[UsersIdx];
2601     FinalizeChain(IVChainVec[ChainIdx]);
2602     ++ChainIdx;
2603   }
2604   IVChainVec.resize(ChainIdx);
2605 }
2606
2607 void LSRInstance::FinalizeChain(IVChain &Chain) {
2608   assert(!Chain.empty() && "empty IV chains are not allowed");
2609   DEBUG(dbgs() << "Final Chain: " << *Chain[0].UserInst << "\n");
2610
2611   for (IVChain::const_iterator I = llvm::next(Chain.begin()), E = Chain.end();
2612        I != E; ++I) {
2613     DEBUG(dbgs() << "        Inc: " << *I->UserInst << "\n");
2614     User::op_iterator UseI =
2615       std::find(I->UserInst->op_begin(), I->UserInst->op_end(), I->IVOperand);
2616     assert(UseI != I->UserInst->op_end() && "cannot find IV operand");
2617     IVIncSet.insert(UseI);
2618   }
2619 }
2620
2621 /// Return true if the IVInc can be folded into an addressing mode.
2622 static bool canFoldIVIncExpr(const SCEV *IncExpr, Instruction *UserInst,
2623                              Value *Operand, const TargetLowering *TLI) {
2624   const SCEVConstant *IncConst = dyn_cast<SCEVConstant>(IncExpr);
2625   if (!IncConst || !isAddressUse(UserInst, Operand))
2626     return false;
2627
2628   if (IncConst->getValue()->getValue().getMinSignedBits() > 64)
2629     return false;
2630
2631   int64_t IncOffset = IncConst->getValue()->getSExtValue();
2632   if (!isAlwaysFoldable(IncOffset, /*BaseGV=*/0, /*HaseBaseReg=*/false,
2633                        LSRUse::Address, getAccessType(UserInst), TLI))
2634     return false;
2635
2636   return true;
2637 }
2638
2639 /// GenerateIVChains - Generate an add or subtract for each IVInc in a chain to
2640 /// materialize the IV user's operand from the previous IV user's operand.
2641 void LSRInstance::GenerateIVChain(const IVChain &Chain, SCEVExpander &Rewriter,
2642                                   SmallVectorImpl<WeakVH> &DeadInsts) {
2643   // Find the new IVOperand for the head of the chain. It may have been replaced
2644   // by LSR.
2645   const IVInc &Head = Chain[0];
2646   User::op_iterator IVOpEnd = Head.UserInst->op_end();
2647   User::op_iterator IVOpIter = findIVOperand(Head.UserInst->op_begin(),
2648                                              IVOpEnd, L, SE);
2649   Value *IVSrc = 0;
2650   while (IVOpIter != IVOpEnd) {
2651     IVSrc = getWideOperand(*IVOpIter);
2652
2653     // If this operand computes the expression that the chain needs, we may use
2654     // it. (Check this after setting IVSrc which is used below.)
2655     //
2656     // Note that if Head.IncExpr is wider than IVSrc, then this phi is too
2657     // narrow for the chain, so we can no longer use it. We do allow using a
2658     // wider phi, assuming the LSR checked for free truncation. In that case we
2659     // should already have a truncate on this operand such that
2660     // getSCEV(IVSrc) == IncExpr.
2661     if (SE.getSCEV(*IVOpIter) == Head.IncExpr
2662         || SE.getSCEV(IVSrc) == Head.IncExpr) {
2663       break;
2664     }
2665     IVOpIter = findIVOperand(llvm::next(IVOpIter), IVOpEnd, L, SE);
2666   }
2667   if (IVOpIter == IVOpEnd) {
2668     // Gracefully give up on this chain.
2669     DEBUG(dbgs() << "Concealed chain head: " << *Head.UserInst << "\n");
2670     return;
2671   }
2672
2673   DEBUG(dbgs() << "Generate chain at: " << *IVSrc << "\n");
2674   Type *IVTy = IVSrc->getType();
2675   Type *IntTy = SE.getEffectiveSCEVType(IVTy);
2676   const SCEV *LeftOverExpr = 0;
2677   for (IVChain::const_iterator IncI = llvm::next(Chain.begin()),
2678          IncE = Chain.end(); IncI != IncE; ++IncI) {
2679
2680     Instruction *InsertPt = IncI->UserInst;
2681     if (isa<PHINode>(InsertPt))
2682       InsertPt = L->getLoopLatch()->getTerminator();
2683
2684     // IVOper will replace the current IV User's operand. IVSrc is the IV
2685     // value currently held in a register.
2686     Value *IVOper = IVSrc;
2687     if (!IncI->IncExpr->isZero()) {
2688       // IncExpr was the result of subtraction of two narrow values, so must
2689       // be signed.
2690       const SCEV *IncExpr = SE.getNoopOrSignExtend(IncI->IncExpr, IntTy);
2691       LeftOverExpr = LeftOverExpr ?
2692         SE.getAddExpr(LeftOverExpr, IncExpr) : IncExpr;
2693     }
2694     if (LeftOverExpr && !LeftOverExpr->isZero()) {
2695       // Expand the IV increment.
2696       Rewriter.clearPostInc();
2697       Value *IncV = Rewriter.expandCodeFor(LeftOverExpr, IntTy, InsertPt);
2698       const SCEV *IVOperExpr = SE.getAddExpr(SE.getUnknown(IVSrc),
2699                                              SE.getUnknown(IncV));
2700       IVOper = Rewriter.expandCodeFor(IVOperExpr, IVTy, InsertPt);
2701
2702       // If an IV increment can't be folded, use it as the next IV value.
2703       if (!canFoldIVIncExpr(LeftOverExpr, IncI->UserInst, IncI->IVOperand,
2704                             TLI)) {
2705         assert(IVTy == IVOper->getType() && "inconsistent IV increment type");
2706         IVSrc = IVOper;
2707         LeftOverExpr = 0;
2708       }
2709     }
2710     Type *OperTy = IncI->IVOperand->getType();
2711     if (IVTy != OperTy) {
2712       assert(SE.getTypeSizeInBits(IVTy) >= SE.getTypeSizeInBits(OperTy) &&
2713              "cannot extend a chained IV");
2714       IRBuilder<> Builder(InsertPt);
2715       IVOper = Builder.CreateTruncOrBitCast(IVOper, OperTy, "lsr.chain");
2716     }
2717     IncI->UserInst->replaceUsesOfWith(IncI->IVOperand, IVOper);
2718     DeadInsts.push_back(IncI->IVOperand);
2719   }
2720   // If LSR created a new, wider phi, we may also replace its postinc. We only
2721   // do this if we also found a wide value for the head of the chain.
2722   if (isa<PHINode>(Chain.back().UserInst)) {
2723     for (BasicBlock::iterator I = L->getHeader()->begin();
2724          PHINode *Phi = dyn_cast<PHINode>(I); ++I) {
2725       if (!isCompatibleIVType(Phi, IVSrc))
2726         continue;
2727       Instruction *PostIncV = dyn_cast<Instruction>(
2728         Phi->getIncomingValueForBlock(L->getLoopLatch()));
2729       if (!PostIncV || (SE.getSCEV(PostIncV) != SE.getSCEV(IVSrc)))
2730         continue;
2731       Value *IVOper = IVSrc;
2732       Type *PostIncTy = PostIncV->getType();
2733       if (IVTy != PostIncTy) {
2734         assert(PostIncTy->isPointerTy() && "mixing int/ptr IV types");
2735         IRBuilder<> Builder(L->getLoopLatch()->getTerminator());
2736         Builder.SetCurrentDebugLocation(PostIncV->getDebugLoc());
2737         IVOper = Builder.CreatePointerCast(IVSrc, PostIncTy, "lsr.chain");
2738       }
2739       Phi->replaceUsesOfWith(PostIncV, IVOper);
2740       DeadInsts.push_back(PostIncV);
2741     }
2742   }
2743 }
2744
2745 void LSRInstance::CollectFixupsAndInitialFormulae() {
2746   for (IVUsers::const_iterator UI = IU.begin(), E = IU.end(); UI != E; ++UI) {
2747     Instruction *UserInst = UI->getUser();
2748     // Skip IV users that are part of profitable IV Chains.
2749     User::op_iterator UseI = std::find(UserInst->op_begin(), UserInst->op_end(),
2750                                        UI->getOperandValToReplace());
2751     assert(UseI != UserInst->op_end() && "cannot find IV operand");
2752     if (IVIncSet.count(UseI))
2753       continue;
2754
2755     // Record the uses.
2756     LSRFixup &LF = getNewFixup();
2757     LF.UserInst = UserInst;
2758     LF.OperandValToReplace = UI->getOperandValToReplace();
2759     LF.PostIncLoops = UI->getPostIncLoops();
2760
2761     LSRUse::KindType Kind = LSRUse::Basic;
2762     Type *AccessTy = 0;
2763     if (isAddressUse(LF.UserInst, LF.OperandValToReplace)) {
2764       Kind = LSRUse::Address;
2765       AccessTy = getAccessType(LF.UserInst);
2766     }
2767
2768     const SCEV *S = IU.getExpr(*UI);
2769
2770     // Equality (== and !=) ICmps are special. We can rewrite (i == N) as
2771     // (N - i == 0), and this allows (N - i) to be the expression that we work
2772     // with rather than just N or i, so we can consider the register
2773     // requirements for both N and i at the same time. Limiting this code to
2774     // equality icmps is not a problem because all interesting loops use
2775     // equality icmps, thanks to IndVarSimplify.
2776     if (ICmpInst *CI = dyn_cast<ICmpInst>(LF.UserInst))
2777       if (CI->isEquality()) {
2778         // Swap the operands if needed to put the OperandValToReplace on the
2779         // left, for consistency.
2780         Value *NV = CI->getOperand(1);
2781         if (NV == LF.OperandValToReplace) {
2782           CI->setOperand(1, CI->getOperand(0));
2783           CI->setOperand(0, NV);
2784           NV = CI->getOperand(1);
2785           Changed = true;
2786         }
2787
2788         // x == y  -->  x - y == 0
2789         const SCEV *N = SE.getSCEV(NV);
2790         if (SE.isLoopInvariant(N, L)) {
2791           // S is normalized, so normalize N before folding it into S
2792           // to keep the result normalized.
2793           N = TransformForPostIncUse(Normalize, N, CI, 0,
2794                                      LF.PostIncLoops, SE, DT);
2795           Kind = LSRUse::ICmpZero;
2796           S = SE.getMinusSCEV(N, S);
2797         }
2798
2799         // -1 and the negations of all interesting strides (except the negation
2800         // of -1) are now also interesting.
2801         for (size_t i = 0, e = Factors.size(); i != e; ++i)
2802           if (Factors[i] != -1)
2803             Factors.insert(-(uint64_t)Factors[i]);
2804         Factors.insert(-1);
2805       }
2806
2807     // Set up the initial formula for this use.
2808     std::pair<size_t, int64_t> P = getUse(S, Kind, AccessTy);
2809     LF.LUIdx = P.first;
2810     LF.Offset = P.second;
2811     LSRUse &LU = Uses[LF.LUIdx];
2812     LU.AllFixupsOutsideLoop &= LF.isUseFullyOutsideLoop(L);
2813     if (!LU.WidestFixupType ||
2814         SE.getTypeSizeInBits(LU.WidestFixupType) <
2815         SE.getTypeSizeInBits(LF.OperandValToReplace->getType()))
2816       LU.WidestFixupType = LF.OperandValToReplace->getType();
2817
2818     // If this is the first use of this LSRUse, give it a formula.
2819     if (LU.Formulae.empty()) {
2820       InsertInitialFormula(S, LU, LF.LUIdx);
2821       CountRegisters(LU.Formulae.back(), LF.LUIdx);
2822     }
2823   }
2824
2825   DEBUG(print_fixups(dbgs()));
2826 }
2827
2828 /// InsertInitialFormula - Insert a formula for the given expression into
2829 /// the given use, separating out loop-variant portions from loop-invariant
2830 /// and loop-computable portions.
2831 void
2832 LSRInstance::InsertInitialFormula(const SCEV *S, LSRUse &LU, size_t LUIdx) {
2833   Formula F;
2834   F.InitialMatch(S, L, SE);
2835   bool Inserted = InsertFormula(LU, LUIdx, F);
2836   assert(Inserted && "Initial formula already exists!"); (void)Inserted;
2837 }
2838
2839 /// InsertSupplementalFormula - Insert a simple single-register formula for
2840 /// the given expression into the given use.
2841 void
2842 LSRInstance::InsertSupplementalFormula(const SCEV *S,
2843                                        LSRUse &LU, size_t LUIdx) {
2844   Formula F;
2845   F.BaseRegs.push_back(S);
2846   F.AM.HasBaseReg = true;
2847   bool Inserted = InsertFormula(LU, LUIdx, F);
2848   assert(Inserted && "Supplemental formula already exists!"); (void)Inserted;
2849 }
2850
2851 /// CountRegisters - Note which registers are used by the given formula,
2852 /// updating RegUses.
2853 void LSRInstance::CountRegisters(const Formula &F, size_t LUIdx) {
2854   if (F.ScaledReg)
2855     RegUses.CountRegister(F.ScaledReg, LUIdx);
2856   for (SmallVectorImpl<const SCEV *>::const_iterator I = F.BaseRegs.begin(),
2857        E = F.BaseRegs.end(); I != E; ++I)
2858     RegUses.CountRegister(*I, LUIdx);
2859 }
2860
2861 /// InsertFormula - If the given formula has not yet been inserted, add it to
2862 /// the list, and return true. Return false otherwise.
2863 bool LSRInstance::InsertFormula(LSRUse &LU, unsigned LUIdx, const Formula &F) {
2864   if (!LU.InsertFormula(F))
2865     return false;
2866
2867   CountRegisters(F, LUIdx);
2868   return true;
2869 }
2870
2871 /// CollectLoopInvariantFixupsAndFormulae - Check for other uses of
2872 /// loop-invariant values which we're tracking. These other uses will pin these
2873 /// values in registers, making them less profitable for elimination.
2874 /// TODO: This currently misses non-constant addrec step registers.
2875 /// TODO: Should this give more weight to users inside the loop?
2876 void
2877 LSRInstance::CollectLoopInvariantFixupsAndFormulae() {
2878   SmallVector<const SCEV *, 8> Worklist(RegUses.begin(), RegUses.end());
2879   SmallPtrSet<const SCEV *, 8> Inserted;
2880
2881   while (!Worklist.empty()) {
2882     const SCEV *S = Worklist.pop_back_val();
2883
2884     if (const SCEVNAryExpr *N = dyn_cast<SCEVNAryExpr>(S))
2885       Worklist.append(N->op_begin(), N->op_end());
2886     else if (const SCEVCastExpr *C = dyn_cast<SCEVCastExpr>(S))
2887       Worklist.push_back(C->getOperand());
2888     else if (const SCEVUDivExpr *D = dyn_cast<SCEVUDivExpr>(S)) {
2889       Worklist.push_back(D->getLHS());
2890       Worklist.push_back(D->getRHS());
2891     } else if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(S)) {
2892       if (!Inserted.insert(U)) continue;
2893       const Value *V = U->getValue();
2894       if (const Instruction *Inst = dyn_cast<Instruction>(V)) {
2895         // Look for instructions defined outside the loop.
2896         if (L->contains(Inst)) continue;
2897       } else if (isa<UndefValue>(V))
2898         // Undef doesn't have a live range, so it doesn't matter.
2899         continue;
2900       for (Value::const_use_iterator UI = V->use_begin(), UE = V->use_end();
2901            UI != UE; ++UI) {
2902         const Instruction *UserInst = dyn_cast<Instruction>(*UI);
2903         // Ignore non-instructions.
2904         if (!UserInst)
2905           continue;
2906         // Ignore instructions in other functions (as can happen with
2907         // Constants).
2908         if (UserInst->getParent()->getParent() != L->getHeader()->getParent())
2909           continue;
2910         // Ignore instructions not dominated by the loop.
2911         const BasicBlock *UseBB = !isa<PHINode>(UserInst) ?
2912           UserInst->getParent() :
2913           cast<PHINode>(UserInst)->getIncomingBlock(
2914             PHINode::getIncomingValueNumForOperand(UI.getOperandNo()));
2915         if (!DT.dominates(L->getHeader(), UseBB))
2916           continue;
2917         // Ignore uses which are part of other SCEV expressions, to avoid
2918         // analyzing them multiple times.
2919         if (SE.isSCEVable(UserInst->getType())) {
2920           const SCEV *UserS = SE.getSCEV(const_cast<Instruction *>(UserInst));
2921           // If the user is a no-op, look through to its uses.
2922           if (!isa<SCEVUnknown>(UserS))
2923             continue;
2924           if (UserS == U) {
2925             Worklist.push_back(
2926               SE.getUnknown(const_cast<Instruction *>(UserInst)));
2927             continue;
2928           }
2929         }
2930         // Ignore icmp instructions which are already being analyzed.
2931         if (const ICmpInst *ICI = dyn_cast<ICmpInst>(UserInst)) {
2932           unsigned OtherIdx = !UI.getOperandNo();
2933           Value *OtherOp = const_cast<Value *>(ICI->getOperand(OtherIdx));
2934           if (SE.hasComputableLoopEvolution(SE.getSCEV(OtherOp), L))
2935             continue;
2936         }
2937
2938         LSRFixup &LF = getNewFixup();
2939         LF.UserInst = const_cast<Instruction *>(UserInst);
2940         LF.OperandValToReplace = UI.getUse();
2941         std::pair<size_t, int64_t> P = getUse(S, LSRUse::Basic, 0);
2942         LF.LUIdx = P.first;
2943         LF.Offset = P.second;
2944         LSRUse &LU = Uses[LF.LUIdx];
2945         LU.AllFixupsOutsideLoop &= LF.isUseFullyOutsideLoop(L);
2946         if (!LU.WidestFixupType ||
2947             SE.getTypeSizeInBits(LU.WidestFixupType) <
2948             SE.getTypeSizeInBits(LF.OperandValToReplace->getType()))
2949           LU.WidestFixupType = LF.OperandValToReplace->getType();
2950         InsertSupplementalFormula(U, LU, LF.LUIdx);
2951         CountRegisters(LU.Formulae.back(), Uses.size() - 1);
2952         break;
2953       }
2954     }
2955   }
2956 }
2957
2958 /// CollectSubexprs - Split S into subexpressions which can be pulled out into
2959 /// separate registers. If C is non-null, multiply each subexpression by C.
2960 static void CollectSubexprs(const SCEV *S, const SCEVConstant *C,
2961                             SmallVectorImpl<const SCEV *> &Ops,
2962                             const Loop *L,
2963                             ScalarEvolution &SE) {
2964   if (const SCEVAddExpr *Add = dyn_cast<SCEVAddExpr>(S)) {
2965     // Break out add operands.
2966     for (SCEVAddExpr::op_iterator I = Add->op_begin(), E = Add->op_end();
2967          I != E; ++I)
2968       CollectSubexprs(*I, C, Ops, L, SE);
2969     return;
2970   } else if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S)) {
2971     // Split a non-zero base out of an addrec.
2972     if (!AR->getStart()->isZero()) {
2973       CollectSubexprs(SE.getAddRecExpr(SE.getConstant(AR->getType(), 0),
2974                                        AR->getStepRecurrence(SE),
2975                                        AR->getLoop(),
2976                                        //FIXME: AR->getNoWrapFlags(SCEV::FlagNW)
2977                                        SCEV::FlagAnyWrap),
2978                       C, Ops, L, SE);
2979       CollectSubexprs(AR->getStart(), C, Ops, L, SE);
2980       return;
2981     }
2982   } else if (const SCEVMulExpr *Mul = dyn_cast<SCEVMulExpr>(S)) {
2983     // Break (C * (a + b + c)) into C*a + C*b + C*c.
2984     if (Mul->getNumOperands() == 2)
2985       if (const SCEVConstant *Op0 =
2986             dyn_cast<SCEVConstant>(Mul->getOperand(0))) {
2987         CollectSubexprs(Mul->getOperand(1),
2988                         C ? cast<SCEVConstant>(SE.getMulExpr(C, Op0)) : Op0,
2989                         Ops, L, SE);
2990         return;
2991       }
2992   }
2993
2994   // Otherwise use the value itself, optionally with a scale applied.
2995   Ops.push_back(C ? SE.getMulExpr(C, S) : S);
2996 }
2997
2998 /// GenerateReassociations - Split out subexpressions from adds and the bases of
2999 /// addrecs.
3000 void LSRInstance::GenerateReassociations(LSRUse &LU, unsigned LUIdx,
3001                                          Formula Base,
3002                                          unsigned Depth) {
3003   // Arbitrarily cap recursion to protect compile time.
3004   if (Depth >= 3) return;
3005
3006   for (size_t i = 0, e = Base.BaseRegs.size(); i != e; ++i) {
3007     const SCEV *BaseReg = Base.BaseRegs[i];
3008
3009     SmallVector<const SCEV *, 8> AddOps;
3010     CollectSubexprs(BaseReg, 0, AddOps, L, SE);
3011
3012     if (AddOps.size() == 1) continue;
3013
3014     for (SmallVectorImpl<const SCEV *>::const_iterator J = AddOps.begin(),
3015          JE = AddOps.end(); J != JE; ++J) {
3016
3017       // Loop-variant "unknown" values are uninteresting; we won't be able to
3018       // do anything meaningful with them.
3019       if (isa<SCEVUnknown>(*J) && !SE.isLoopInvariant(*J, L))
3020         continue;
3021
3022       // Don't pull a constant into a register if the constant could be folded
3023       // into an immediate field.
3024       if (isAlwaysFoldable(*J, LU.MinOffset, LU.MaxOffset,
3025                            Base.getNumRegs() > 1,
3026                            LU.Kind, LU.AccessTy, TLI, SE))
3027         continue;
3028
3029       // Collect all operands except *J.
3030       SmallVector<const SCEV *, 8> InnerAddOps
3031         (((const SmallVector<const SCEV *, 8> &)AddOps).begin(), J);
3032       InnerAddOps.append
3033         (llvm::next(J), ((const SmallVector<const SCEV *, 8> &)AddOps).end());
3034
3035       // Don't leave just a constant behind in a register if the constant could
3036       // be folded into an immediate field.
3037       if (InnerAddOps.size() == 1 &&
3038           isAlwaysFoldable(InnerAddOps[0], LU.MinOffset, LU.MaxOffset,
3039                            Base.getNumRegs() > 1,
3040                            LU.Kind, LU.AccessTy, TLI, SE))
3041         continue;
3042
3043       const SCEV *InnerSum = SE.getAddExpr(InnerAddOps);
3044       if (InnerSum->isZero())
3045         continue;
3046       Formula F = Base;
3047
3048       // Add the remaining pieces of the add back into the new formula.
3049       const SCEVConstant *InnerSumSC = dyn_cast<SCEVConstant>(InnerSum);
3050       if (TLI && InnerSumSC &&
3051           SE.getTypeSizeInBits(InnerSumSC->getType()) <= 64 &&
3052           TLI->isLegalAddImmediate((uint64_t)F.UnfoldedOffset +
3053                                    InnerSumSC->getValue()->getZExtValue())) {
3054         F.UnfoldedOffset = (uint64_t)F.UnfoldedOffset +
3055                            InnerSumSC->getValue()->getZExtValue();
3056         F.BaseRegs.erase(F.BaseRegs.begin() + i);
3057       } else
3058         F.BaseRegs[i] = InnerSum;
3059
3060       // Add J as its own register, or an unfolded immediate.
3061       const SCEVConstant *SC = dyn_cast<SCEVConstant>(*J);
3062       if (TLI && SC && SE.getTypeSizeInBits(SC->getType()) <= 64 &&
3063           TLI->isLegalAddImmediate((uint64_t)F.UnfoldedOffset +
3064                                    SC->getValue()->getZExtValue()))
3065         F.UnfoldedOffset = (uint64_t)F.UnfoldedOffset +
3066                            SC->getValue()->getZExtValue();
3067       else
3068         F.BaseRegs.push_back(*J);
3069
3070       if (InsertFormula(LU, LUIdx, F))
3071         // If that formula hadn't been seen before, recurse to find more like
3072         // it.
3073         GenerateReassociations(LU, LUIdx, LU.Formulae.back(), Depth+1);
3074     }
3075   }
3076 }
3077
3078 /// GenerateCombinations - Generate a formula consisting of all of the
3079 /// loop-dominating registers added into a single register.
3080 void LSRInstance::GenerateCombinations(LSRUse &LU, unsigned LUIdx,
3081                                        Formula Base) {
3082   // This method is only interesting on a plurality of registers.
3083   if (Base.BaseRegs.size() <= 1) return;
3084
3085   Formula F = Base;
3086   F.BaseRegs.clear();
3087   SmallVector<const SCEV *, 4> Ops;
3088   for (SmallVectorImpl<const SCEV *>::const_iterator
3089        I = Base.BaseRegs.begin(), E = Base.BaseRegs.end(); I != E; ++I) {
3090     const SCEV *BaseReg = *I;
3091     if (SE.properlyDominates(BaseReg, L->getHeader()) &&
3092         !SE.hasComputableLoopEvolution(BaseReg, L))
3093       Ops.push_back(BaseReg);
3094     else
3095       F.BaseRegs.push_back(BaseReg);
3096   }
3097   if (Ops.size() > 1) {
3098     const SCEV *Sum = SE.getAddExpr(Ops);
3099     // TODO: If Sum is zero, it probably means ScalarEvolution missed an
3100     // opportunity to fold something. For now, just ignore such cases
3101     // rather than proceed with zero in a register.
3102     if (!Sum->isZero()) {
3103       F.BaseRegs.push_back(Sum);
3104       (void)InsertFormula(LU, LUIdx, F);
3105     }
3106   }
3107 }
3108
3109 /// GenerateSymbolicOffsets - Generate reuse formulae using symbolic offsets.
3110 void LSRInstance::GenerateSymbolicOffsets(LSRUse &LU, unsigned LUIdx,
3111                                           Formula Base) {
3112   // We can't add a symbolic offset if the address already contains one.
3113   if (Base.AM.BaseGV) return;
3114
3115   for (size_t i = 0, e = Base.BaseRegs.size(); i != e; ++i) {
3116     const SCEV *G = Base.BaseRegs[i];
3117     GlobalValue *GV = ExtractSymbol(G, SE);
3118     if (G->isZero() || !GV)
3119       continue;
3120     Formula F = Base;
3121     F.AM.BaseGV = GV;
3122     if (!isLegalUse(F.AM, LU.MinOffset, LU.MaxOffset,
3123                     LU.Kind, LU.AccessTy, TLI))
3124       continue;
3125     F.BaseRegs[i] = G;
3126     (void)InsertFormula(LU, LUIdx, F);
3127   }
3128 }
3129
3130 /// GenerateConstantOffsets - Generate reuse formulae using symbolic offsets.
3131 void LSRInstance::GenerateConstantOffsets(LSRUse &LU, unsigned LUIdx,
3132                                           Formula Base) {
3133   // TODO: For now, just add the min and max offset, because it usually isn't
3134   // worthwhile looking at everything inbetween.
3135   SmallVector<int64_t, 2> Worklist;
3136   Worklist.push_back(LU.MinOffset);
3137   if (LU.MaxOffset != LU.MinOffset)
3138     Worklist.push_back(LU.MaxOffset);
3139
3140   for (size_t i = 0, e = Base.BaseRegs.size(); i != e; ++i) {
3141     const SCEV *G = Base.BaseRegs[i];
3142
3143     for (SmallVectorImpl<int64_t>::const_iterator I = Worklist.begin(),
3144          E = Worklist.end(); I != E; ++I) {
3145       Formula F = Base;
3146       F.AM.BaseOffs = (uint64_t)Base.AM.BaseOffs - *I;
3147       if (isLegalUse(F.AM, LU.MinOffset - *I, LU.MaxOffset - *I,
3148                      LU.Kind, LU.AccessTy, TLI)) {
3149         // Add the offset to the base register.
3150         const SCEV *NewG = SE.getAddExpr(SE.getConstant(G->getType(), *I), G);
3151         // If it cancelled out, drop the base register, otherwise update it.
3152         if (NewG->isZero()) {
3153           std::swap(F.BaseRegs[i], F.BaseRegs.back());
3154           F.BaseRegs.pop_back();
3155         } else
3156           F.BaseRegs[i] = NewG;
3157
3158         (void)InsertFormula(LU, LUIdx, F);
3159       }
3160     }
3161
3162     int64_t Imm = ExtractImmediate(G, SE);
3163     if (G->isZero() || Imm == 0)
3164       continue;
3165     Formula F = Base;
3166     F.AM.BaseOffs = (uint64_t)F.AM.BaseOffs + Imm;
3167     if (!isLegalUse(F.AM, LU.MinOffset, LU.MaxOffset,
3168                     LU.Kind, LU.AccessTy, TLI))
3169       continue;
3170     F.BaseRegs[i] = G;
3171     (void)InsertFormula(LU, LUIdx, F);
3172   }
3173 }
3174
3175 /// GenerateICmpZeroScales - For ICmpZero, check to see if we can scale up
3176 /// the comparison. For example, x == y -> x*c == y*c.
3177 void LSRInstance::GenerateICmpZeroScales(LSRUse &LU, unsigned LUIdx,
3178                                          Formula Base) {
3179   if (LU.Kind != LSRUse::ICmpZero) return;
3180
3181   // Determine the integer type for the base formula.
3182   Type *IntTy = Base.getType();
3183   if (!IntTy) return;
3184   if (SE.getTypeSizeInBits(IntTy) > 64) return;
3185
3186   // Don't do this if there is more than one offset.
3187   if (LU.MinOffset != LU.MaxOffset) return;
3188
3189   assert(!Base.AM.BaseGV && "ICmpZero use is not legal!");
3190
3191   // Check each interesting stride.
3192   for (SmallSetVector<int64_t, 8>::const_iterator
3193        I = Factors.begin(), E = Factors.end(); I != E; ++I) {
3194     int64_t Factor = *I;
3195
3196     // Check that the multiplication doesn't overflow.
3197     if (Base.AM.BaseOffs == INT64_MIN && Factor == -1)
3198       continue;
3199     int64_t NewBaseOffs = (uint64_t)Base.AM.BaseOffs * Factor;
3200     if (NewBaseOffs / Factor != Base.AM.BaseOffs)
3201       continue;
3202
3203     // Check that multiplying with the use offset doesn't overflow.
3204     int64_t Offset = LU.MinOffset;
3205     if (Offset == INT64_MIN && Factor == -1)
3206       continue;
3207     Offset = (uint64_t)Offset * Factor;
3208     if (Offset / Factor != LU.MinOffset)
3209       continue;
3210
3211     Formula F = Base;
3212     F.AM.BaseOffs = NewBaseOffs;
3213
3214     // Check that this scale is legal.
3215     if (!isLegalUse(F.AM, Offset, Offset, LU.Kind, LU.AccessTy, TLI))
3216       continue;
3217
3218     // Compensate for the use having MinOffset built into it.
3219     F.AM.BaseOffs = (uint64_t)F.AM.BaseOffs + Offset - LU.MinOffset;
3220
3221     const SCEV *FactorS = SE.getConstant(IntTy, Factor);
3222
3223     // Check that multiplying with each base register doesn't overflow.
3224     for (size_t i = 0, e = F.BaseRegs.size(); i != e; ++i) {
3225       F.BaseRegs[i] = SE.getMulExpr(F.BaseRegs[i], FactorS);
3226       if (getExactSDiv(F.BaseRegs[i], FactorS, SE) != Base.BaseRegs[i])
3227         goto next;
3228     }
3229
3230     // Check that multiplying with the scaled register doesn't overflow.
3231     if (F.ScaledReg) {
3232       F.ScaledReg = SE.getMulExpr(F.ScaledReg, FactorS);
3233       if (getExactSDiv(F.ScaledReg, FactorS, SE) != Base.ScaledReg)
3234         continue;
3235     }
3236
3237     // Check that multiplying with the unfolded offset doesn't overflow.
3238     if (F.UnfoldedOffset != 0) {
3239       if (F.UnfoldedOffset == INT64_MIN && Factor == -1)
3240         continue;
3241       F.UnfoldedOffset = (uint64_t)F.UnfoldedOffset * Factor;
3242       if (F.UnfoldedOffset / Factor != Base.UnfoldedOffset)
3243         continue;
3244     }
3245
3246     // If we make it here and it's legal, add it.
3247     (void)InsertFormula(LU, LUIdx, F);
3248   next:;
3249   }
3250 }
3251
3252 /// GenerateScales - Generate stride factor reuse formulae by making use of
3253 /// scaled-offset address modes, for example.
3254 void LSRInstance::GenerateScales(LSRUse &LU, unsigned LUIdx, Formula Base) {
3255   // Determine the integer type for the base formula.
3256   Type *IntTy = Base.getType();
3257   if (!IntTy) return;
3258
3259   // If this Formula already has a scaled register, we can't add another one.
3260   if (Base.AM.Scale != 0) return;
3261
3262   // Check each interesting stride.
3263   for (SmallSetVector<int64_t, 8>::const_iterator
3264        I = Factors.begin(), E = Factors.end(); I != E; ++I) {
3265     int64_t Factor = *I;
3266
3267     Base.AM.Scale = Factor;
3268     Base.AM.HasBaseReg = Base.BaseRegs.size() > 1;
3269     // Check whether this scale is going to be legal.
3270     if (!isLegalUse(Base.AM, LU.MinOffset, LU.MaxOffset,
3271                     LU.Kind, LU.AccessTy, TLI)) {
3272       // As a special-case, handle special out-of-loop Basic users specially.
3273       // TODO: Reconsider this special case.
3274       if (LU.Kind == LSRUse::Basic &&
3275           isLegalUse(Base.AM, LU.MinOffset, LU.MaxOffset,
3276                      LSRUse::Special, LU.AccessTy, TLI) &&
3277           LU.AllFixupsOutsideLoop)
3278         LU.Kind = LSRUse::Special;
3279       else
3280         continue;
3281     }
3282     // For an ICmpZero, negating a solitary base register won't lead to
3283     // new solutions.
3284     if (LU.Kind == LSRUse::ICmpZero &&
3285         !Base.AM.HasBaseReg && Base.AM.BaseOffs == 0 && !Base.AM.BaseGV)
3286       continue;
3287     // For each addrec base reg, apply the scale, if possible.
3288     for (size_t i = 0, e = Base.BaseRegs.size(); i != e; ++i)
3289       if (const SCEVAddRecExpr *AR =
3290             dyn_cast<SCEVAddRecExpr>(Base.BaseRegs[i])) {
3291         const SCEV *FactorS = SE.getConstant(IntTy, Factor);
3292         if (FactorS->isZero())
3293           continue;
3294         // Divide out the factor, ignoring high bits, since we'll be
3295         // scaling the value back up in the end.
3296         if (const SCEV *Quotient = getExactSDiv(AR, FactorS, SE, true)) {
3297           // TODO: This could be optimized to avoid all the copying.
3298           Formula F = Base;
3299           F.ScaledReg = Quotient;
3300           F.DeleteBaseReg(F.BaseRegs[i]);
3301           (void)InsertFormula(LU, LUIdx, F);
3302         }
3303       }
3304   }
3305 }
3306
3307 /// GenerateTruncates - Generate reuse formulae from different IV types.
3308 void LSRInstance::GenerateTruncates(LSRUse &LU, unsigned LUIdx, Formula Base) {
3309   // This requires TargetLowering to tell us which truncates are free.
3310   if (!TLI) return;
3311
3312   // Don't bother truncating symbolic values.
3313   if (Base.AM.BaseGV) return;
3314
3315   // Determine the integer type for the base formula.
3316   Type *DstTy = Base.getType();
3317   if (!DstTy) return;
3318   DstTy = SE.getEffectiveSCEVType(DstTy);
3319
3320   for (SmallSetVector<Type *, 4>::const_iterator
3321        I = Types.begin(), E = Types.end(); I != E; ++I) {
3322     Type *SrcTy = *I;
3323     if (SrcTy != DstTy && TLI->isTruncateFree(SrcTy, DstTy)) {
3324       Formula F = Base;
3325
3326       if (F.ScaledReg) F.ScaledReg = SE.getAnyExtendExpr(F.ScaledReg, *I);
3327       for (SmallVectorImpl<const SCEV *>::iterator J = F.BaseRegs.begin(),
3328            JE = F.BaseRegs.end(); J != JE; ++J)
3329         *J = SE.getAnyExtendExpr(*J, SrcTy);
3330
3331       // TODO: This assumes we've done basic processing on all uses and
3332       // have an idea what the register usage is.
3333       if (!F.hasRegsUsedByUsesOtherThan(LUIdx, RegUses))
3334         continue;
3335
3336       (void)InsertFormula(LU, LUIdx, F);
3337     }
3338   }
3339 }
3340
3341 namespace {
3342
3343 /// WorkItem - Helper class for GenerateCrossUseConstantOffsets. It's used to
3344 /// defer modifications so that the search phase doesn't have to worry about
3345 /// the data structures moving underneath it.
3346 struct WorkItem {
3347   size_t LUIdx;
3348   int64_t Imm;
3349   const SCEV *OrigReg;
3350
3351   WorkItem(size_t LI, int64_t I, const SCEV *R)
3352     : LUIdx(LI), Imm(I), OrigReg(R) {}
3353
3354   void print(raw_ostream &OS) const;
3355   void dump() const;
3356 };
3357
3358 }
3359
3360 void WorkItem::print(raw_ostream &OS) const {
3361   OS << "in formulae referencing " << *OrigReg << " in use " << LUIdx
3362      << " , add offset " << Imm;
3363 }
3364
3365 void WorkItem::dump() const {
3366   print(errs()); errs() << '\n';
3367 }
3368
3369 /// GenerateCrossUseConstantOffsets - Look for registers which are a constant
3370 /// distance apart and try to form reuse opportunities between them.
3371 void LSRInstance::GenerateCrossUseConstantOffsets() {
3372   // Group the registers by their value without any added constant offset.
3373   typedef std::map<int64_t, const SCEV *> ImmMapTy;
3374   typedef DenseMap<const SCEV *, ImmMapTy> RegMapTy;
3375   RegMapTy Map;
3376   DenseMap<const SCEV *, SmallBitVector> UsedByIndicesMap;
3377   SmallVector<const SCEV *, 8> Sequence;
3378   for (RegUseTracker::const_iterator I = RegUses.begin(), E = RegUses.end();
3379        I != E; ++I) {
3380     const SCEV *Reg = *I;
3381     int64_t Imm = ExtractImmediate(Reg, SE);
3382     std::pair<RegMapTy::iterator, bool> Pair =
3383       Map.insert(std::make_pair(Reg, ImmMapTy()));
3384     if (Pair.second)
3385       Sequence.push_back(Reg);
3386     Pair.first->second.insert(std::make_pair(Imm, *I));
3387     UsedByIndicesMap[Reg] |= RegUses.getUsedByIndices(*I);
3388   }
3389
3390   // Now examine each set of registers with the same base value. Build up
3391   // a list of work to do and do the work in a separate step so that we're
3392   // not adding formulae and register counts while we're searching.
3393   SmallVector<WorkItem, 32> WorkItems;
3394   SmallSet<std::pair<size_t, int64_t>, 32> UniqueItems;
3395   for (SmallVectorImpl<const SCEV *>::const_iterator I = Sequence.begin(),
3396        E = Sequence.end(); I != E; ++I) {
3397     const SCEV *Reg = *I;
3398     const ImmMapTy &Imms = Map.find(Reg)->second;
3399
3400     // It's not worthwhile looking for reuse if there's only one offset.
3401     if (Imms.size() == 1)
3402       continue;
3403
3404     DEBUG(dbgs() << "Generating cross-use offsets for " << *Reg << ':';
3405           for (ImmMapTy::const_iterator J = Imms.begin(), JE = Imms.end();
3406                J != JE; ++J)
3407             dbgs() << ' ' << J->first;
3408           dbgs() << '\n');
3409
3410     // Examine each offset.
3411     for (ImmMapTy::const_iterator J = Imms.begin(), JE = Imms.end();
3412          J != JE; ++J) {
3413       const SCEV *OrigReg = J->second;
3414
3415       int64_t JImm = J->first;
3416       const SmallBitVector &UsedByIndices = RegUses.getUsedByIndices(OrigReg);
3417
3418       if (!isa<SCEVConstant>(OrigReg) &&
3419           UsedByIndicesMap[Reg].count() == 1) {
3420         DEBUG(dbgs() << "Skipping cross-use reuse for " << *OrigReg << '\n');
3421         continue;
3422       }
3423
3424       // Conservatively examine offsets between this orig reg a few selected
3425       // other orig regs.
3426       ImmMapTy::const_iterator OtherImms[] = {
3427         Imms.begin(), prior(Imms.end()),
3428         Imms.lower_bound((Imms.begin()->first + prior(Imms.end())->first) / 2)
3429       };
3430       for (size_t i = 0, e = array_lengthof(OtherImms); i != e; ++i) {
3431         ImmMapTy::const_iterator M = OtherImms[i];
3432         if (M == J || M == JE) continue;
3433
3434         // Compute the difference between the two.
3435         int64_t Imm = (uint64_t)JImm - M->first;
3436         for (int LUIdx = UsedByIndices.find_first(); LUIdx != -1;
3437              LUIdx = UsedByIndices.find_next(LUIdx))
3438           // Make a memo of this use, offset, and register tuple.
3439           if (UniqueItems.insert(std::make_pair(LUIdx, Imm)))
3440             WorkItems.push_back(WorkItem(LUIdx, Imm, OrigReg));
3441       }
3442     }
3443   }
3444
3445   Map.clear();
3446   Sequence.clear();
3447   UsedByIndicesMap.clear();
3448   UniqueItems.clear();
3449
3450   // Now iterate through the worklist and add new formulae.
3451   for (SmallVectorImpl<WorkItem>::const_iterator I = WorkItems.begin(),
3452        E = WorkItems.end(); I != E; ++I) {
3453     const WorkItem &WI = *I;
3454     size_t LUIdx = WI.LUIdx;
3455     LSRUse &LU = Uses[LUIdx];
3456     int64_t Imm = WI.Imm;
3457     const SCEV *OrigReg = WI.OrigReg;
3458
3459     Type *IntTy = SE.getEffectiveSCEVType(OrigReg->getType());
3460     const SCEV *NegImmS = SE.getSCEV(ConstantInt::get(IntTy, -(uint64_t)Imm));
3461     unsigned BitWidth = SE.getTypeSizeInBits(IntTy);
3462
3463     // TODO: Use a more targeted data structure.
3464     for (size_t L = 0, LE = LU.Formulae.size(); L != LE; ++L) {
3465       const Formula &F = LU.Formulae[L];
3466       // Use the immediate in the scaled register.
3467       if (F.ScaledReg == OrigReg) {
3468         int64_t Offs = (uint64_t)F.AM.BaseOffs +
3469                        Imm * (uint64_t)F.AM.Scale;
3470         // Don't create 50 + reg(-50).
3471         if (F.referencesReg(SE.getSCEV(
3472                    ConstantInt::get(IntTy, -(uint64_t)Offs))))
3473           continue;
3474         Formula NewF = F;
3475         NewF.AM.BaseOffs = Offs;
3476         if (!isLegalUse(NewF.AM, LU.MinOffset, LU.MaxOffset,
3477                         LU.Kind, LU.AccessTy, TLI))
3478           continue;
3479         NewF.ScaledReg = SE.getAddExpr(NegImmS, NewF.ScaledReg);
3480
3481         // If the new scale is a constant in a register, and adding the constant
3482         // value to the immediate would produce a value closer to zero than the
3483         // immediate itself, then the formula isn't worthwhile.
3484         if (const SCEVConstant *C = dyn_cast<SCEVConstant>(NewF.ScaledReg))
3485           if (C->getValue()->isNegative() !=
3486                 (NewF.AM.BaseOffs < 0) &&
3487               (C->getValue()->getValue().abs() * APInt(BitWidth, F.AM.Scale))
3488                 .ule(abs64(NewF.AM.BaseOffs)))
3489             continue;
3490
3491         // OK, looks good.
3492         (void)InsertFormula(LU, LUIdx, NewF);
3493       } else {
3494         // Use the immediate in a base register.
3495         for (size_t N = 0, NE = F.BaseRegs.size(); N != NE; ++N) {
3496           const SCEV *BaseReg = F.BaseRegs[N];
3497           if (BaseReg != OrigReg)
3498             continue;
3499           Formula NewF = F;
3500           NewF.AM.BaseOffs = (uint64_t)NewF.AM.BaseOffs + Imm;
3501           if (!isLegalUse(NewF.AM, LU.MinOffset, LU.MaxOffset,
3502                           LU.Kind, LU.AccessTy, TLI)) {
3503             if (!TLI ||
3504                 !TLI->isLegalAddImmediate((uint64_t)NewF.UnfoldedOffset + Imm))
3505               continue;
3506             NewF = F;
3507             NewF.UnfoldedOffset = (uint64_t)NewF.UnfoldedOffset + Imm;
3508           }
3509           NewF.BaseRegs[N] = SE.getAddExpr(NegImmS, BaseReg);
3510
3511           // If the new formula has a constant in a register, and adding the
3512           // constant value to the immediate would produce a value closer to
3513           // zero than the immediate itself, then the formula isn't worthwhile.
3514           for (SmallVectorImpl<const SCEV *>::const_iterator
3515                J = NewF.BaseRegs.begin(), JE = NewF.BaseRegs.end();
3516                J != JE; ++J)
3517             if (const SCEVConstant *C = dyn_cast<SCEVConstant>(*J))
3518               if ((C->getValue()->getValue() + NewF.AM.BaseOffs).abs().slt(
3519                    abs64(NewF.AM.BaseOffs)) &&
3520                   (C->getValue()->getValue() +
3521                    NewF.AM.BaseOffs).countTrailingZeros() >=
3522                    CountTrailingZeros_64(NewF.AM.BaseOffs))
3523                 goto skip_formula;
3524
3525           // Ok, looks good.
3526           (void)InsertFormula(LU, LUIdx, NewF);
3527           break;
3528         skip_formula:;
3529         }
3530       }
3531     }
3532   }
3533 }
3534
3535 /// GenerateAllReuseFormulae - Generate formulae for each use.
3536 void
3537 LSRInstance::GenerateAllReuseFormulae() {
3538   // This is split into multiple loops so that hasRegsUsedByUsesOtherThan
3539   // queries are more precise.
3540   for (size_t LUIdx = 0, NumUses = Uses.size(); LUIdx != NumUses; ++LUIdx) {
3541     LSRUse &LU = Uses[LUIdx];
3542     for (size_t i = 0, f = LU.Formulae.size(); i != f; ++i)
3543       GenerateReassociations(LU, LUIdx, LU.Formulae[i]);
3544     for (size_t i = 0, f = LU.Formulae.size(); i != f; ++i)
3545       GenerateCombinations(LU, LUIdx, LU.Formulae[i]);
3546   }
3547   for (size_t LUIdx = 0, NumUses = Uses.size(); LUIdx != NumUses; ++LUIdx) {
3548     LSRUse &LU = Uses[LUIdx];
3549     for (size_t i = 0, f = LU.Formulae.size(); i != f; ++i)
3550       GenerateSymbolicOffsets(LU, LUIdx, LU.Formulae[i]);
3551     for (size_t i = 0, f = LU.Formulae.size(); i != f; ++i)
3552       GenerateConstantOffsets(LU, LUIdx, LU.Formulae[i]);
3553     for (size_t i = 0, f = LU.Formulae.size(); i != f; ++i)
3554       GenerateICmpZeroScales(LU, LUIdx, LU.Formulae[i]);
3555     for (size_t i = 0, f = LU.Formulae.size(); i != f; ++i)
3556       GenerateScales(LU, LUIdx, LU.Formulae[i]);
3557   }
3558   for (size_t LUIdx = 0, NumUses = Uses.size(); LUIdx != NumUses; ++LUIdx) {
3559     LSRUse &LU = Uses[LUIdx];
3560     for (size_t i = 0, f = LU.Formulae.size(); i != f; ++i)
3561       GenerateTruncates(LU, LUIdx, LU.Formulae[i]);
3562   }
3563
3564   GenerateCrossUseConstantOffsets();
3565
3566   DEBUG(dbgs() << "\n"
3567                   "After generating reuse formulae:\n";
3568         print_uses(dbgs()));
3569 }
3570
3571 /// If there are multiple formulae with the same set of registers used
3572 /// by other uses, pick the best one and delete the others.
3573 void LSRInstance::FilterOutUndesirableDedicatedRegisters() {
3574   DenseSet<const SCEV *> VisitedRegs;
3575   SmallPtrSet<const SCEV *, 16> Regs;
3576   SmallPtrSet<const SCEV *, 16> LoserRegs;
3577 #ifndef NDEBUG
3578   bool ChangedFormulae = false;
3579 #endif
3580
3581   // Collect the best formula for each unique set of shared registers. This
3582   // is reset for each use.
3583   typedef DenseMap<SmallVector<const SCEV *, 2>, size_t, UniquifierDenseMapInfo>
3584     BestFormulaeTy;
3585   BestFormulaeTy BestFormulae;
3586
3587   for (size_t LUIdx = 0, NumUses = Uses.size(); LUIdx != NumUses; ++LUIdx) {
3588     LSRUse &LU = Uses[LUIdx];
3589     DEBUG(dbgs() << "Filtering for use "; LU.print(dbgs()); dbgs() << '\n');
3590
3591     bool Any = false;
3592     for (size_t FIdx = 0, NumForms = LU.Formulae.size();
3593          FIdx != NumForms; ++FIdx) {
3594       Formula &F = LU.Formulae[FIdx];
3595
3596       // Some formulas are instant losers. For example, they may depend on
3597       // nonexistent AddRecs from other loops. These need to be filtered
3598       // immediately, otherwise heuristics could choose them over others leading
3599       // to an unsatisfactory solution. Passing LoserRegs into RateFormula here
3600       // avoids the need to recompute this information across formulae using the
3601       // same bad AddRec. Passing LoserRegs is also essential unless we remove
3602       // the corresponding bad register from the Regs set.
3603       Cost CostF;
3604       Regs.clear();
3605       CostF.RateFormula(F, Regs, VisitedRegs, L, LU.Offsets, SE, DT,
3606                         &LoserRegs);
3607       if (CostF.isLoser()) {
3608         // During initial formula generation, undesirable formulae are generated
3609         // by uses within other loops that have some non-trivial address mode or
3610         // use the postinc form of the IV. LSR needs to provide these formulae
3611         // as the basis of rediscovering the desired formula that uses an AddRec
3612         // corresponding to the existing phi. Once all formulae have been
3613         // generated, these initial losers may be pruned.
3614         DEBUG(dbgs() << "  Filtering loser "; F.print(dbgs());
3615               dbgs() << "\n");
3616       }
3617       else {
3618         SmallVector<const SCEV *, 2> Key;
3619         for (SmallVectorImpl<const SCEV *>::const_iterator J = F.BaseRegs.begin(),
3620                JE = F.BaseRegs.end(); J != JE; ++J) {
3621           const SCEV *Reg = *J;
3622           if (RegUses.isRegUsedByUsesOtherThan(Reg, LUIdx))
3623             Key.push_back(Reg);
3624         }
3625         if (F.ScaledReg &&
3626             RegUses.isRegUsedByUsesOtherThan(F.ScaledReg, LUIdx))
3627           Key.push_back(F.ScaledReg);
3628         // Unstable sort by host order ok, because this is only used for
3629         // uniquifying.
3630         std::sort(Key.begin(), Key.end());
3631
3632         std::pair<BestFormulaeTy::const_iterator, bool> P =
3633           BestFormulae.insert(std::make_pair(Key, FIdx));
3634         if (P.second)
3635           continue;
3636
3637         Formula &Best = LU.Formulae[P.first->second];
3638
3639         Cost CostBest;
3640         Regs.clear();
3641         CostBest.RateFormula(Best, Regs, VisitedRegs, L, LU.Offsets, SE, DT);
3642         if (CostF < CostBest)
3643           std::swap(F, Best);
3644         DEBUG(dbgs() << "  Filtering out formula "; F.print(dbgs());
3645               dbgs() << "\n"
3646                         "    in favor of formula "; Best.print(dbgs());
3647               dbgs() << '\n');
3648       }
3649 #ifndef NDEBUG
3650       ChangedFormulae = true;
3651 #endif
3652       LU.DeleteFormula(F);
3653       --FIdx;
3654       --NumForms;
3655       Any = true;
3656     }
3657
3658     // Now that we've filtered out some formulae, recompute the Regs set.
3659     if (Any)
3660       LU.RecomputeRegs(LUIdx, RegUses);
3661
3662     // Reset this to prepare for the next use.
3663     BestFormulae.clear();
3664   }
3665
3666   DEBUG(if (ChangedFormulae) {
3667           dbgs() << "\n"
3668                     "After filtering out undesirable candidates:\n";
3669           print_uses(dbgs());
3670         });
3671 }
3672
3673 // This is a rough guess that seems to work fairly well.
3674 static const size_t ComplexityLimit = UINT16_MAX;
3675
3676 /// EstimateSearchSpaceComplexity - Estimate the worst-case number of
3677 /// solutions the solver might have to consider. It almost never considers
3678 /// this many solutions because it prune the search space, but the pruning
3679 /// isn't always sufficient.
3680 size_t LSRInstance::EstimateSearchSpaceComplexity() const {
3681   size_t Power = 1;
3682   for (SmallVectorImpl<LSRUse>::const_iterator I = Uses.begin(),
3683        E = Uses.end(); I != E; ++I) {
3684     size_t FSize = I->Formulae.size();
3685     if (FSize >= ComplexityLimit) {
3686       Power = ComplexityLimit;
3687       break;
3688     }
3689     Power *= FSize;
3690     if (Power >= ComplexityLimit)
3691       break;
3692   }
3693   return Power;
3694 }
3695
3696 /// NarrowSearchSpaceByDetectingSupersets - When one formula uses a superset
3697 /// of the registers of another formula, it won't help reduce register
3698 /// pressure (though it may not necessarily hurt register pressure); remove
3699 /// it to simplify the system.
3700 void LSRInstance::NarrowSearchSpaceByDetectingSupersets() {
3701   if (EstimateSearchSpaceComplexity() >= ComplexityLimit) {
3702     DEBUG(dbgs() << "The search space is too complex.\n");
3703
3704     DEBUG(dbgs() << "Narrowing the search space by eliminating formulae "
3705                     "which use a superset of registers used by other "
3706                     "formulae.\n");
3707
3708     for (size_t LUIdx = 0, NumUses = Uses.size(); LUIdx != NumUses; ++LUIdx) {
3709       LSRUse &LU = Uses[LUIdx];
3710       bool Any = false;
3711       for (size_t i = 0, e = LU.Formulae.size(); i != e; ++i) {
3712         Formula &F = LU.Formulae[i];
3713         // Look for a formula with a constant or GV in a register. If the use
3714         // also has a formula with that same value in an immediate field,
3715         // delete the one that uses a register.
3716         for (SmallVectorImpl<const SCEV *>::const_iterator
3717              I = F.BaseRegs.begin(), E = F.BaseRegs.end(); I != E; ++I) {
3718           if (const SCEVConstant *C = dyn_cast<SCEVConstant>(*I)) {
3719             Formula NewF = F;
3720             NewF.AM.BaseOffs += C->getValue()->getSExtValue();
3721             NewF.BaseRegs.erase(NewF.BaseRegs.begin() +
3722                                 (I - F.BaseRegs.begin()));
3723             if (LU.HasFormulaWithSameRegs(NewF)) {
3724               DEBUG(dbgs() << "  Deleting "; F.print(dbgs()); dbgs() << '\n');
3725               LU.DeleteFormula(F);
3726               --i;
3727               --e;
3728               Any = true;
3729               break;
3730             }
3731           } else if (const SCEVUnknown *U = dyn_cast<SCEVUnknown>(*I)) {
3732             if (GlobalValue *GV = dyn_cast<GlobalValue>(U->getValue()))
3733               if (!F.AM.BaseGV) {
3734                 Formula NewF = F;
3735                 NewF.AM.BaseGV = GV;
3736                 NewF.BaseRegs.erase(NewF.BaseRegs.begin() +
3737                                     (I - F.BaseRegs.begin()));
3738                 if (LU.HasFormulaWithSameRegs(NewF)) {
3739                   DEBUG(dbgs() << "  Deleting "; F.print(dbgs());
3740                         dbgs() << '\n');
3741                   LU.DeleteFormula(F);
3742                   --i;
3743                   --e;
3744                   Any = true;
3745                   break;
3746                 }
3747               }
3748           }
3749         }
3750       }
3751       if (Any)
3752         LU.RecomputeRegs(LUIdx, RegUses);
3753     }
3754
3755     DEBUG(dbgs() << "After pre-selection:\n";
3756           print_uses(dbgs()));
3757   }
3758 }
3759
3760 /// NarrowSearchSpaceByCollapsingUnrolledCode - When there are many registers
3761 /// for expressions like A, A+1, A+2, etc., allocate a single register for
3762 /// them.
3763 void LSRInstance::NarrowSearchSpaceByCollapsingUnrolledCode() {
3764   if (EstimateSearchSpaceComplexity() >= ComplexityLimit) {
3765     DEBUG(dbgs() << "The search space is too complex.\n");
3766
3767     DEBUG(dbgs() << "Narrowing the search space by assuming that uses "
3768                     "separated by a constant offset will use the same "
3769                     "registers.\n");
3770
3771     // This is especially useful for unrolled loops.
3772
3773     for (size_t LUIdx = 0, NumUses = Uses.size(); LUIdx != NumUses; ++LUIdx) {
3774       LSRUse &LU = Uses[LUIdx];
3775       for (SmallVectorImpl<Formula>::const_iterator I = LU.Formulae.begin(),
3776            E = LU.Formulae.end(); I != E; ++I) {
3777         const Formula &F = *I;
3778         if (F.AM.BaseOffs != 0 && F.AM.Scale == 0) {
3779           if (LSRUse *LUThatHas = FindUseWithSimilarFormula(F, LU)) {
3780             if (reconcileNewOffset(*LUThatHas, F.AM.BaseOffs,
3781                                    /*HasBaseReg=*/false,
3782                                    LU.Kind, LU.AccessTy)) {
3783               DEBUG(dbgs() << "  Deleting use "; LU.print(dbgs());
3784                     dbgs() << '\n');
3785
3786               LUThatHas->AllFixupsOutsideLoop &= LU.AllFixupsOutsideLoop;
3787
3788               // Update the relocs to reference the new use.
3789               for (SmallVectorImpl<LSRFixup>::iterator I = Fixups.begin(),
3790                    E = Fixups.end(); I != E; ++I) {
3791                 LSRFixup &Fixup = *I;
3792                 if (Fixup.LUIdx == LUIdx) {
3793                   Fixup.LUIdx = LUThatHas - &Uses.front();
3794                   Fixup.Offset += F.AM.BaseOffs;
3795                   // Add the new offset to LUThatHas' offset list.
3796                   if (LUThatHas->Offsets.back() != Fixup.Offset) {
3797                     LUThatHas->Offsets.push_back(Fixup.Offset);
3798                     if (Fixup.Offset > LUThatHas->MaxOffset)
3799                       LUThatHas->MaxOffset = Fixup.Offset;
3800                     if (Fixup.Offset < LUThatHas->MinOffset)
3801                       LUThatHas->MinOffset = Fixup.Offset;
3802                   }
3803                   DEBUG(dbgs() << "New fixup has offset "
3804                                << Fixup.Offset << '\n');
3805                 }
3806                 if (Fixup.LUIdx == NumUses-1)
3807                   Fixup.LUIdx = LUIdx;
3808               }
3809
3810               // Delete formulae from the new use which are no longer legal.
3811               bool Any = false;
3812               for (size_t i = 0, e = LUThatHas->Formulae.size(); i != e; ++i) {
3813                 Formula &F = LUThatHas->Formulae[i];
3814                 if (!isLegalUse(F.AM,
3815                                 LUThatHas->MinOffset, LUThatHas->MaxOffset,
3816                                 LUThatHas->Kind, LUThatHas->AccessTy, TLI)) {
3817                   DEBUG(dbgs() << "  Deleting "; F.print(dbgs());
3818                         dbgs() << '\n');
3819                   LUThatHas->DeleteFormula(F);
3820                   --i;
3821                   --e;
3822                   Any = true;
3823                 }
3824               }
3825               if (Any)
3826                 LUThatHas->RecomputeRegs(LUThatHas - &Uses.front(), RegUses);
3827
3828               // Delete the old use.
3829               DeleteUse(LU, LUIdx);
3830               --LUIdx;
3831               --NumUses;
3832               break;
3833             }
3834           }
3835         }
3836       }
3837     }
3838
3839     DEBUG(dbgs() << "After pre-selection:\n";
3840           print_uses(dbgs()));
3841   }
3842 }
3843
3844 /// NarrowSearchSpaceByRefilteringUndesirableDedicatedRegisters - Call
3845 /// FilterOutUndesirableDedicatedRegisters again, if necessary, now that
3846 /// we've done more filtering, as it may be able to find more formulae to
3847 /// eliminate.
3848 void LSRInstance::NarrowSearchSpaceByRefilteringUndesirableDedicatedRegisters(){
3849   if (EstimateSearchSpaceComplexity() >= ComplexityLimit) {
3850     DEBUG(dbgs() << "The search space is too complex.\n");
3851
3852     DEBUG(dbgs() << "Narrowing the search space by re-filtering out "
3853                     "undesirable dedicated registers.\n");
3854
3855     FilterOutUndesirableDedicatedRegisters();
3856
3857     DEBUG(dbgs() << "After pre-selection:\n";
3858           print_uses(dbgs()));
3859   }
3860 }
3861
3862 /// NarrowSearchSpaceByPickingWinnerRegs - Pick a register which seems likely
3863 /// to be profitable, and then in any use which has any reference to that
3864 /// register, delete all formulae which do not reference that register.
3865 void LSRInstance::NarrowSearchSpaceByPickingWinnerRegs() {
3866   // With all other options exhausted, loop until the system is simple
3867   // enough to handle.
3868   SmallPtrSet<const SCEV *, 4> Taken;
3869   while (EstimateSearchSpaceComplexity() >= ComplexityLimit) {
3870     // Ok, we have too many of formulae on our hands to conveniently handle.
3871     // Use a rough heuristic to thin out the list.
3872     DEBUG(dbgs() << "The search space is too complex.\n");
3873
3874     // Pick the register which is used by the most LSRUses, which is likely
3875     // to be a good reuse register candidate.
3876     const SCEV *Best = 0;
3877     unsigned BestNum = 0;
3878     for (RegUseTracker::const_iterator I = RegUses.begin(), E = RegUses.end();
3879          I != E; ++I) {
3880       const SCEV *Reg = *I;
3881       if (Taken.count(Reg))
3882         continue;
3883       if (!Best)
3884         Best = Reg;
3885       else {
3886         unsigned Count = RegUses.getUsedByIndices(Reg).count();
3887         if (Count > BestNum) {
3888           Best = Reg;
3889           BestNum = Count;
3890         }
3891       }
3892     }
3893
3894     DEBUG(dbgs() << "Narrowing the search space by assuming " << *Best
3895                  << " will yield profitable reuse.\n");
3896     Taken.insert(Best);
3897
3898     // In any use with formulae which references this register, delete formulae
3899     // which don't reference it.
3900     for (size_t LUIdx = 0, NumUses = Uses.size(); LUIdx != NumUses; ++LUIdx) {
3901       LSRUse &LU = Uses[LUIdx];
3902       if (!LU.Regs.count(Best)) continue;
3903
3904       bool Any = false;
3905       for (size_t i = 0, e = LU.Formulae.size(); i != e; ++i) {
3906         Formula &F = LU.Formulae[i];
3907         if (!F.referencesReg(Best)) {
3908           DEBUG(dbgs() << "  Deleting "; F.print(dbgs()); dbgs() << '\n');
3909           LU.DeleteFormula(F);
3910           --e;
3911           --i;
3912           Any = true;
3913           assert(e != 0 && "Use has no formulae left! Is Regs inconsistent?");
3914           continue;
3915         }
3916       }
3917
3918       if (Any)
3919         LU.RecomputeRegs(LUIdx, RegUses);
3920     }
3921
3922     DEBUG(dbgs() << "After pre-selection:\n";
3923           print_uses(dbgs()));
3924   }
3925 }
3926
3927 /// NarrowSearchSpaceUsingHeuristics - If there are an extraordinary number of
3928 /// formulae to choose from, use some rough heuristics to prune down the number
3929 /// of formulae. This keeps the main solver from taking an extraordinary amount
3930 /// of time in some worst-case scenarios.
3931 void LSRInstance::NarrowSearchSpaceUsingHeuristics() {
3932   NarrowSearchSpaceByDetectingSupersets();
3933   NarrowSearchSpaceByCollapsingUnrolledCode();
3934   NarrowSearchSpaceByRefilteringUndesirableDedicatedRegisters();
3935   NarrowSearchSpaceByPickingWinnerRegs();
3936 }
3937
3938 /// SolveRecurse - This is the recursive solver.
3939 void LSRInstance::SolveRecurse(SmallVectorImpl<const Formula *> &Solution,
3940                                Cost &SolutionCost,
3941                                SmallVectorImpl<const Formula *> &Workspace,
3942                                const Cost &CurCost,
3943                                const SmallPtrSet<const SCEV *, 16> &CurRegs,
3944                                DenseSet<const SCEV *> &VisitedRegs) const {
3945   // Some ideas:
3946   //  - prune more:
3947   //    - use more aggressive filtering
3948   //    - sort the formula so that the most profitable solutions are found first
3949   //    - sort the uses too
3950   //  - search faster:
3951   //    - don't compute a cost, and then compare. compare while computing a cost
3952   //      and bail early.
3953   //    - track register sets with SmallBitVector
3954
3955   const LSRUse &LU = Uses[Workspace.size()];
3956
3957   // If this use references any register that's already a part of the
3958   // in-progress solution, consider it a requirement that a formula must
3959   // reference that register in order to be considered. This prunes out
3960   // unprofitable searching.
3961   SmallSetVector<const SCEV *, 4> ReqRegs;
3962   for (SmallPtrSet<const SCEV *, 16>::const_iterator I = CurRegs.begin(),
3963        E = CurRegs.end(); I != E; ++I)
3964     if (LU.Regs.count(*I))
3965       ReqRegs.insert(*I);
3966
3967   SmallPtrSet<const SCEV *, 16> NewRegs;
3968   Cost NewCost;
3969   for (SmallVectorImpl<Formula>::const_iterator I = LU.Formulae.begin(),
3970        E = LU.Formulae.end(); I != E; ++I) {
3971     const Formula &F = *I;
3972
3973     // Ignore formulae which do not use any of the required registers.
3974     bool SatisfiedReqReg = true;
3975     for (SmallSetVector<const SCEV *, 4>::const_iterator J = ReqRegs.begin(),
3976          JE = ReqRegs.end(); J != JE; ++J) {
3977       const SCEV *Reg = *J;
3978       if ((!F.ScaledReg || F.ScaledReg != Reg) &&
3979           std::find(F.BaseRegs.begin(), F.BaseRegs.end(), Reg) ==
3980           F.BaseRegs.end()) {
3981         SatisfiedReqReg = false;
3982         break;
3983       }
3984     }
3985     if (!SatisfiedReqReg) {
3986       // If none of the formulae satisfied the required registers, then we could
3987       // clear ReqRegs and try again. Currently, we simply give up in this case.
3988       continue;
3989     }
3990
3991     // Evaluate the cost of the current formula. If it's already worse than
3992     // the current best, prune the search at that point.
3993     NewCost = CurCost;
3994     NewRegs = CurRegs;
3995     NewCost.RateFormula(F, NewRegs, VisitedRegs, L, LU.Offsets, SE, DT);
3996     if (NewCost < SolutionCost) {
3997       Workspace.push_back(&F);
3998       if (Workspace.size() != Uses.size()) {
3999         SolveRecurse(Solution, SolutionCost, Workspace, NewCost,
4000                      NewRegs, VisitedRegs);
4001         if (F.getNumRegs() == 1 && Workspace.size() == 1)
4002           VisitedRegs.insert(F.ScaledReg ? F.ScaledReg : F.BaseRegs[0]);
4003       } else {
4004         DEBUG(dbgs() << "New best at "; NewCost.print(dbgs());
4005               dbgs() << ".\n Regs:";
4006               for (SmallPtrSet<const SCEV *, 16>::const_iterator
4007                    I = NewRegs.begin(), E = NewRegs.end(); I != E; ++I)
4008                 dbgs() << ' ' << **I;
4009               dbgs() << '\n');
4010
4011         SolutionCost = NewCost;
4012         Solution = Workspace;
4013       }
4014       Workspace.pop_back();
4015     }
4016   }
4017 }
4018
4019 /// Solve - Choose one formula from each use. Return the results in the given
4020 /// Solution vector.
4021 void LSRInstance::Solve(SmallVectorImpl<const Formula *> &Solution) const {
4022   SmallVector<const Formula *, 8> Workspace;
4023   Cost SolutionCost;
4024   SolutionCost.Loose();
4025   Cost CurCost;
4026   SmallPtrSet<const SCEV *, 16> CurRegs;
4027   DenseSet<const SCEV *> VisitedRegs;
4028   Workspace.reserve(Uses.size());
4029
4030   // SolveRecurse does all the work.
4031   SolveRecurse(Solution, SolutionCost, Workspace, CurCost,
4032                CurRegs, VisitedRegs);
4033   if (Solution.empty()) {
4034     DEBUG(dbgs() << "\nNo Satisfactory Solution\n");
4035     return;
4036   }
4037
4038   // Ok, we've now made all our decisions.
4039   DEBUG(dbgs() << "\n"
4040                   "The chosen solution requires "; SolutionCost.print(dbgs());
4041         dbgs() << ":\n";
4042         for (size_t i = 0, e = Uses.size(); i != e; ++i) {
4043           dbgs() << "  ";
4044           Uses[i].print(dbgs());
4045           dbgs() << "\n"
4046                     "    ";
4047           Solution[i]->print(dbgs());
4048           dbgs() << '\n';
4049         });
4050
4051   assert(Solution.size() == Uses.size() && "Malformed solution!");
4052 }
4053
4054 /// HoistInsertPosition - Helper for AdjustInsertPositionForExpand. Climb up
4055 /// the dominator tree far as we can go while still being dominated by the
4056 /// input positions. This helps canonicalize the insert position, which
4057 /// encourages sharing.
4058 BasicBlock::iterator
4059 LSRInstance::HoistInsertPosition(BasicBlock::iterator IP,
4060                                  const SmallVectorImpl<Instruction *> &Inputs)
4061                                                                          const {
4062   for (;;) {
4063     const Loop *IPLoop = LI.getLoopFor(IP->getParent());
4064     unsigned IPLoopDepth = IPLoop ? IPLoop->getLoopDepth() : 0;
4065
4066     BasicBlock *IDom;
4067     for (DomTreeNode *Rung = DT.getNode(IP->getParent()); ; ) {
4068       if (!Rung) return IP;
4069       Rung = Rung->getIDom();
4070       if (!Rung) return IP;
4071       IDom = Rung->getBlock();
4072
4073       // Don't climb into a loop though.
4074       const Loop *IDomLoop = LI.getLoopFor(IDom);
4075       unsigned IDomDepth = IDomLoop ? IDomLoop->getLoopDepth() : 0;
4076       if (IDomDepth <= IPLoopDepth &&
4077           (IDomDepth != IPLoopDepth || IDomLoop == IPLoop))
4078         break;
4079     }
4080
4081     bool AllDominate = true;
4082     Instruction *BetterPos = 0;
4083     Instruction *Tentative = IDom->getTerminator();
4084     for (SmallVectorImpl<Instruction *>::const_iterator I = Inputs.begin(),
4085          E = Inputs.end(); I != E; ++I) {
4086       Instruction *Inst = *I;
4087       if (Inst == Tentative || !DT.dominates(Inst, Tentative)) {
4088         AllDominate = false;
4089         break;
4090       }
4091       // Attempt to find an insert position in the middle of the block,
4092       // instead of at the end, so that it can be used for other expansions.
4093       if (IDom == Inst->getParent() &&
4094           (!BetterPos || DT.dominates(BetterPos, Inst)))
4095         BetterPos = llvm::next(BasicBlock::iterator(Inst));
4096     }
4097     if (!AllDominate)
4098       break;
4099     if (BetterPos)
4100       IP = BetterPos;
4101     else
4102       IP = Tentative;
4103   }
4104
4105   return IP;
4106 }
4107
4108 /// AdjustInsertPositionForExpand - Determine an input position which will be
4109 /// dominated by the operands and which will dominate the result.
4110 BasicBlock::iterator
4111 LSRInstance::AdjustInsertPositionForExpand(BasicBlock::iterator LowestIP,
4112                                            const LSRFixup &LF,
4113                                            const LSRUse &LU,
4114                                            SCEVExpander &Rewriter) const {
4115   // Collect some instructions which must be dominated by the
4116   // expanding replacement. These must be dominated by any operands that
4117   // will be required in the expansion.
4118   SmallVector<Instruction *, 4> Inputs;
4119   if (Instruction *I = dyn_cast<Instruction>(LF.OperandValToReplace))
4120     Inputs.push_back(I);
4121   if (LU.Kind == LSRUse::ICmpZero)
4122     if (Instruction *I =
4123           dyn_cast<Instruction>(cast<ICmpInst>(LF.UserInst)->getOperand(1)))
4124       Inputs.push_back(I);
4125   if (LF.PostIncLoops.count(L)) {
4126     if (LF.isUseFullyOutsideLoop(L))
4127       Inputs.push_back(L->getLoopLatch()->getTerminator());
4128     else
4129       Inputs.push_back(IVIncInsertPos);
4130   }
4131   // The expansion must also be dominated by the increment positions of any
4132   // loops it for which it is using post-inc mode.
4133   for (PostIncLoopSet::const_iterator I = LF.PostIncLoops.begin(),
4134        E = LF.PostIncLoops.end(); I != E; ++I) {
4135     const Loop *PIL = *I;
4136     if (PIL == L) continue;
4137
4138     // Be dominated by the loop exit.
4139     SmallVector<BasicBlock *, 4> ExitingBlocks;
4140     PIL->getExitingBlocks(ExitingBlocks);
4141     if (!ExitingBlocks.empty()) {
4142       BasicBlock *BB = ExitingBlocks[0];
4143       for (unsigned i = 1, e = ExitingBlocks.size(); i != e; ++i)
4144         BB = DT.findNearestCommonDominator(BB, ExitingBlocks[i]);
4145       Inputs.push_back(BB->getTerminator());
4146     }
4147   }
4148
4149   assert(!isa<PHINode>(LowestIP) && !isa<LandingPadInst>(LowestIP)
4150          && !isa<DbgInfoIntrinsic>(LowestIP) &&
4151          "Insertion point must be a normal instruction");
4152
4153   // Then, climb up the immediate dominator tree as far as we can go while
4154   // still being dominated by the input positions.
4155   BasicBlock::iterator IP = HoistInsertPosition(LowestIP, Inputs);
4156
4157   // Don't insert instructions before PHI nodes.
4158   while (isa<PHINode>(IP)) ++IP;
4159
4160   // Ignore landingpad instructions.
4161   while (isa<LandingPadInst>(IP)) ++IP;
4162
4163   // Ignore debug intrinsics.
4164   while (isa<DbgInfoIntrinsic>(IP)) ++IP;
4165
4166   // Set IP below instructions recently inserted by SCEVExpander. This keeps the
4167   // IP consistent across expansions and allows the previously inserted
4168   // instructions to be reused by subsequent expansion.
4169   while (Rewriter.isInsertedInstruction(IP) && IP != LowestIP) ++IP;
4170
4171   return IP;
4172 }
4173
4174 /// Expand - Emit instructions for the leading candidate expression for this
4175 /// LSRUse (this is called "expanding").
4176 Value *LSRInstance::Expand(const LSRFixup &LF,
4177                            const Formula &F,
4178                            BasicBlock::iterator IP,
4179                            SCEVExpander &Rewriter,
4180                            SmallVectorImpl<WeakVH> &DeadInsts) const {
4181   const LSRUse &LU = Uses[LF.LUIdx];
4182
4183   // Determine an input position which will be dominated by the operands and
4184   // which will dominate the result.
4185   IP = AdjustInsertPositionForExpand(IP, LF, LU, Rewriter);
4186
4187   // Inform the Rewriter if we have a post-increment use, so that it can
4188   // perform an advantageous expansion.
4189   Rewriter.setPostInc(LF.PostIncLoops);
4190
4191   // This is the type that the user actually needs.
4192   Type *OpTy = LF.OperandValToReplace->getType();
4193   // This will be the type that we'll initially expand to.
4194   Type *Ty = F.getType();
4195   if (!Ty)
4196     // No type known; just expand directly to the ultimate type.
4197     Ty = OpTy;
4198   else if (SE.getEffectiveSCEVType(Ty) == SE.getEffectiveSCEVType(OpTy))
4199     // Expand directly to the ultimate type if it's the right size.
4200     Ty = OpTy;
4201   // This is the type to do integer arithmetic in.
4202   Type *IntTy = SE.getEffectiveSCEVType(Ty);
4203
4204   // Build up a list of operands to add together to form the full base.
4205   SmallVector<const SCEV *, 8> Ops;
4206
4207   // Expand the BaseRegs portion.
4208   for (SmallVectorImpl<const SCEV *>::const_iterator I = F.BaseRegs.begin(),
4209        E = F.BaseRegs.end(); I != E; ++I) {
4210     const SCEV *Reg = *I;
4211     assert(!Reg->isZero() && "Zero allocated in a base register!");
4212
4213     // If we're expanding for a post-inc user, make the post-inc adjustment.
4214     PostIncLoopSet &Loops = const_cast<PostIncLoopSet &>(LF.PostIncLoops);
4215     Reg = TransformForPostIncUse(Denormalize, Reg,
4216                                  LF.UserInst, LF.OperandValToReplace,
4217                                  Loops, SE, DT);
4218
4219     Ops.push_back(SE.getUnknown(Rewriter.expandCodeFor(Reg, 0, IP)));
4220   }
4221
4222   // Flush the operand list to suppress SCEVExpander hoisting.
4223   if (!Ops.empty()) {
4224     Value *FullV = Rewriter.expandCodeFor(SE.getAddExpr(Ops), Ty, IP);
4225     Ops.clear();
4226     Ops.push_back(SE.getUnknown(FullV));
4227   }
4228
4229   // Expand the ScaledReg portion.
4230   Value *ICmpScaledV = 0;
4231   if (F.AM.Scale != 0) {
4232     const SCEV *ScaledS = F.ScaledReg;
4233
4234     // If we're expanding for a post-inc user, make the post-inc adjustment.
4235     PostIncLoopSet &Loops = const_cast<PostIncLoopSet &>(LF.PostIncLoops);
4236     ScaledS = TransformForPostIncUse(Denormalize, ScaledS,
4237                                      LF.UserInst, LF.OperandValToReplace,
4238                                      Loops, SE, DT);
4239
4240     if (LU.Kind == LSRUse::ICmpZero) {
4241       // An interesting way of "folding" with an icmp is to use a negated
4242       // scale, which we'll implement by inserting it into the other operand
4243       // of the icmp.
4244       assert(F.AM.Scale == -1 &&
4245              "The only scale supported by ICmpZero uses is -1!");
4246       ICmpScaledV = Rewriter.expandCodeFor(ScaledS, 0, IP);
4247     } else {
4248       // Otherwise just expand the scaled register and an explicit scale,
4249       // which is expected to be matched as part of the address.
4250       ScaledS = SE.getUnknown(Rewriter.expandCodeFor(ScaledS, 0, IP));
4251       ScaledS = SE.getMulExpr(ScaledS,
4252                               SE.getConstant(ScaledS->getType(), F.AM.Scale));
4253       Ops.push_back(ScaledS);
4254
4255       // Flush the operand list to suppress SCEVExpander hoisting.
4256       Value *FullV = Rewriter.expandCodeFor(SE.getAddExpr(Ops), Ty, IP);
4257       Ops.clear();
4258       Ops.push_back(SE.getUnknown(FullV));
4259     }
4260   }
4261
4262   // Expand the GV portion.
4263   if (F.AM.BaseGV) {
4264     Ops.push_back(SE.getUnknown(F.AM.BaseGV));
4265
4266     // Flush the operand list to suppress SCEVExpander hoisting.
4267     Value *FullV = Rewriter.expandCodeFor(SE.getAddExpr(Ops), Ty, IP);
4268     Ops.clear();
4269     Ops.push_back(SE.getUnknown(FullV));
4270   }
4271
4272   // Expand the immediate portion.
4273   int64_t Offset = (uint64_t)F.AM.BaseOffs + LF.Offset;
4274   if (Offset != 0) {
4275     if (LU.Kind == LSRUse::ICmpZero) {
4276       // The other interesting way of "folding" with an ICmpZero is to use a
4277       // negated immediate.
4278       if (!ICmpScaledV)
4279         ICmpScaledV = ConstantInt::get(IntTy, -(uint64_t)Offset);
4280       else {
4281         Ops.push_back(SE.getUnknown(ICmpScaledV));
4282         ICmpScaledV = ConstantInt::get(IntTy, Offset);
4283       }
4284     } else {
4285       // Just add the immediate values. These again are expected to be matched
4286       // as part of the address.
4287       Ops.push_back(SE.getUnknown(ConstantInt::getSigned(IntTy, Offset)));
4288     }
4289   }
4290
4291   // Expand the unfolded offset portion.
4292   int64_t UnfoldedOffset = F.UnfoldedOffset;
4293   if (UnfoldedOffset != 0) {
4294     // Just add the immediate values.
4295     Ops.push_back(SE.getUnknown(ConstantInt::getSigned(IntTy,
4296                                                        UnfoldedOffset)));
4297   }
4298
4299   // Emit instructions summing all the operands.
4300   const SCEV *FullS = Ops.empty() ?
4301                       SE.getConstant(IntTy, 0) :
4302                       SE.getAddExpr(Ops);
4303   Value *FullV = Rewriter.expandCodeFor(FullS, Ty, IP);
4304
4305   // We're done expanding now, so reset the rewriter.
4306   Rewriter.clearPostInc();
4307
4308   // An ICmpZero Formula represents an ICmp which we're handling as a
4309   // comparison against zero. Now that we've expanded an expression for that
4310   // form, update the ICmp's other operand.
4311   if (LU.Kind == LSRUse::ICmpZero) {
4312     ICmpInst *CI = cast<ICmpInst>(LF.UserInst);
4313     DeadInsts.push_back(CI->getOperand(1));
4314     assert(!F.AM.BaseGV && "ICmp does not support folding a global value and "
4315                            "a scale at the same time!");
4316     if (F.AM.Scale == -1) {
4317       if (ICmpScaledV->getType() != OpTy) {
4318         Instruction *Cast =
4319           CastInst::Create(CastInst::getCastOpcode(ICmpScaledV, false,
4320                                                    OpTy, false),
4321                            ICmpScaledV, OpTy, "tmp", CI);
4322         ICmpScaledV = Cast;
4323       }
4324       CI->setOperand(1, ICmpScaledV);
4325     } else {
4326       assert(F.AM.Scale == 0 &&
4327              "ICmp does not support folding a global value and "
4328              "a scale at the same time!");
4329       Constant *C = ConstantInt::getSigned(SE.getEffectiveSCEVType(OpTy),
4330                                            -(uint64_t)Offset);
4331       if (C->getType() != OpTy)
4332         C = ConstantExpr::getCast(CastInst::getCastOpcode(C, false,
4333                                                           OpTy, false),
4334                                   C, OpTy);
4335
4336       CI->setOperand(1, C);
4337     }
4338   }
4339
4340   return FullV;
4341 }
4342
4343 /// RewriteForPHI - Helper for Rewrite. PHI nodes are special because the use
4344 /// of their operands effectively happens in their predecessor blocks, so the
4345 /// expression may need to be expanded in multiple places.
4346 void LSRInstance::RewriteForPHI(PHINode *PN,
4347                                 const LSRFixup &LF,
4348                                 const Formula &F,
4349                                 SCEVExpander &Rewriter,
4350                                 SmallVectorImpl<WeakVH> &DeadInsts,
4351                                 Pass *P) const {
4352   DenseMap<BasicBlock *, Value *> Inserted;
4353   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
4354     if (PN->getIncomingValue(i) == LF.OperandValToReplace) {
4355       BasicBlock *BB = PN->getIncomingBlock(i);
4356
4357       // If this is a critical edge, split the edge so that we do not insert
4358       // the code on all predecessor/successor paths.  We do this unless this
4359       // is the canonical backedge for this loop, which complicates post-inc
4360       // users.
4361       if (e != 1 && BB->getTerminator()->getNumSuccessors() > 1 &&
4362           !isa<IndirectBrInst>(BB->getTerminator())) {
4363         BasicBlock *Parent = PN->getParent();
4364         Loop *PNLoop = LI.getLoopFor(Parent);
4365         if (!PNLoop || Parent != PNLoop->getHeader()) {
4366           // Split the critical edge.
4367           BasicBlock *NewBB = 0;
4368           if (!Parent->isLandingPad()) {
4369             NewBB = SplitCriticalEdge(BB, Parent, P,
4370                                       /*MergeIdenticalEdges=*/true,
4371                                       /*DontDeleteUselessPhis=*/true);
4372           } else {
4373             SmallVector<BasicBlock*, 2> NewBBs;
4374             SplitLandingPadPredecessors(Parent, BB, "", "", P, NewBBs);
4375             NewBB = NewBBs[0];
4376           }
4377
4378           // If PN is outside of the loop and BB is in the loop, we want to
4379           // move the block to be immediately before the PHI block, not
4380           // immediately after BB.
4381           if (L->contains(BB) && !L->contains(PN))
4382             NewBB->moveBefore(PN->getParent());
4383
4384           // Splitting the edge can reduce the number of PHI entries we have.
4385           e = PN->getNumIncomingValues();
4386           BB = NewBB;
4387           i = PN->getBasicBlockIndex(BB);
4388         }
4389       }
4390
4391       std::pair<DenseMap<BasicBlock *, Value *>::iterator, bool> Pair =
4392         Inserted.insert(std::make_pair(BB, static_cast<Value *>(0)));
4393       if (!Pair.second)
4394         PN->setIncomingValue(i, Pair.first->second);
4395       else {
4396         Value *FullV = Expand(LF, F, BB->getTerminator(), Rewriter, DeadInsts);
4397
4398         // If this is reuse-by-noop-cast, insert the noop cast.
4399         Type *OpTy = LF.OperandValToReplace->getType();
4400         if (FullV->getType() != OpTy)
4401           FullV =
4402             CastInst::Create(CastInst::getCastOpcode(FullV, false,
4403                                                      OpTy, false),
4404                              FullV, LF.OperandValToReplace->getType(),
4405                              "tmp", BB->getTerminator());
4406
4407         PN->setIncomingValue(i, FullV);
4408         Pair.first->second = FullV;
4409       }
4410     }
4411 }
4412
4413 /// Rewrite - Emit instructions for the leading candidate expression for this
4414 /// LSRUse (this is called "expanding"), and update the UserInst to reference
4415 /// the newly expanded value.
4416 void LSRInstance::Rewrite(const LSRFixup &LF,
4417                           const Formula &F,
4418                           SCEVExpander &Rewriter,
4419                           SmallVectorImpl<WeakVH> &DeadInsts,
4420                           Pass *P) const {
4421   // First, find an insertion point that dominates UserInst. For PHI nodes,
4422   // find the nearest block which dominates all the relevant uses.
4423   if (PHINode *PN = dyn_cast<PHINode>(LF.UserInst)) {
4424     RewriteForPHI(PN, LF, F, Rewriter, DeadInsts, P);
4425   } else {
4426     Value *FullV = Expand(LF, F, LF.UserInst, Rewriter, DeadInsts);
4427
4428     // If this is reuse-by-noop-cast, insert the noop cast.
4429     Type *OpTy = LF.OperandValToReplace->getType();
4430     if (FullV->getType() != OpTy) {
4431       Instruction *Cast =
4432         CastInst::Create(CastInst::getCastOpcode(FullV, false, OpTy, false),
4433                          FullV, OpTy, "tmp", LF.UserInst);
4434       FullV = Cast;
4435     }
4436
4437     // Update the user. ICmpZero is handled specially here (for now) because
4438     // Expand may have updated one of the operands of the icmp already, and
4439     // its new value may happen to be equal to LF.OperandValToReplace, in
4440     // which case doing replaceUsesOfWith leads to replacing both operands
4441     // with the same value. TODO: Reorganize this.
4442     if (Uses[LF.LUIdx].Kind == LSRUse::ICmpZero)
4443       LF.UserInst->setOperand(0, FullV);
4444     else
4445       LF.UserInst->replaceUsesOfWith(LF.OperandValToReplace, FullV);
4446   }
4447
4448   DeadInsts.push_back(LF.OperandValToReplace);
4449 }
4450
4451 /// ImplementSolution - Rewrite all the fixup locations with new values,
4452 /// following the chosen solution.
4453 void
4454 LSRInstance::ImplementSolution(const SmallVectorImpl<const Formula *> &Solution,
4455                                Pass *P) {
4456   // Keep track of instructions we may have made dead, so that
4457   // we can remove them after we are done working.
4458   SmallVector<WeakVH, 16> DeadInsts;
4459
4460   SCEVExpander Rewriter(SE, "lsr");
4461 #ifndef NDEBUG
4462   Rewriter.setDebugType(DEBUG_TYPE);
4463 #endif
4464   Rewriter.disableCanonicalMode();
4465   Rewriter.enableLSRMode();
4466   Rewriter.setIVIncInsertPos(L, IVIncInsertPos);
4467
4468   // Mark phi nodes that terminate chains so the expander tries to reuse them.
4469   for (SmallVectorImpl<IVChain>::const_iterator ChainI = IVChainVec.begin(),
4470          ChainE = IVChainVec.end(); ChainI != ChainE; ++ChainI) {
4471     if (PHINode *PN = dyn_cast<PHINode>(ChainI->back().UserInst))
4472       Rewriter.setChainedPhi(PN);
4473   }
4474
4475   // Expand the new value definitions and update the users.
4476   for (SmallVectorImpl<LSRFixup>::const_iterator I = Fixups.begin(),
4477        E = Fixups.end(); I != E; ++I) {
4478     const LSRFixup &Fixup = *I;
4479
4480     Rewrite(Fixup, *Solution[Fixup.LUIdx], Rewriter, DeadInsts, P);
4481
4482     Changed = true;
4483   }
4484
4485   for (SmallVectorImpl<IVChain>::const_iterator ChainI = IVChainVec.begin(),
4486          ChainE = IVChainVec.end(); ChainI != ChainE; ++ChainI) {
4487     GenerateIVChain(*ChainI, Rewriter, DeadInsts);
4488     Changed = true;
4489   }
4490   // Clean up after ourselves. This must be done before deleting any
4491   // instructions.
4492   Rewriter.clear();
4493
4494   Changed |= DeleteTriviallyDeadInstructions(DeadInsts);
4495 }
4496
4497 LSRInstance::LSRInstance(const TargetLowering *tli, Loop *l, Pass *P)
4498   : IU(P->getAnalysis<IVUsers>()),
4499     SE(P->getAnalysis<ScalarEvolution>()),
4500     DT(P->getAnalysis<DominatorTree>()),
4501     LI(P->getAnalysis<LoopInfo>()),
4502     TLI(tli), L(l), Changed(false), IVIncInsertPos(0) {
4503
4504   // If LoopSimplify form is not available, stay out of trouble.
4505   if (!L->isLoopSimplifyForm())
4506     return;
4507
4508   // If there's no interesting work to be done, bail early.
4509   if (IU.empty()) return;
4510
4511 #ifndef NDEBUG
4512   // All dominating loops must have preheaders, or SCEVExpander may not be able
4513   // to materialize an AddRecExpr whose Start is an outer AddRecExpr.
4514   //
4515   // IVUsers analysis should only create users that are dominated by simple loop
4516   // headers. Since this loop should dominate all of its users, its user list
4517   // should be empty if this loop itself is not within a simple loop nest.
4518   for (DomTreeNode *Rung = DT.getNode(L->getLoopPreheader());
4519        Rung; Rung = Rung->getIDom()) {
4520     BasicBlock *BB = Rung->getBlock();
4521     const Loop *DomLoop = LI.getLoopFor(BB);
4522     if (DomLoop && DomLoop->getHeader() == BB) {
4523       assert(DomLoop->getLoopPreheader() && "LSR needs a simplified loop nest");
4524     }
4525   }
4526 #endif // DEBUG
4527
4528   DEBUG(dbgs() << "\nLSR on loop ";
4529         WriteAsOperand(dbgs(), L->getHeader(), /*PrintType=*/false);
4530         dbgs() << ":\n");
4531
4532   // First, perform some low-level loop optimizations.
4533   OptimizeShadowIV();
4534   OptimizeLoopTermCond();
4535
4536   // If loop preparation eliminates all interesting IV users, bail.
4537   if (IU.empty()) return;
4538
4539   // Skip nested loops until we can model them better with formulae.
4540   if (!L->empty()) {
4541     DEBUG(dbgs() << "LSR skipping outer loop " << *L << "\n");
4542     return;
4543   }
4544
4545   // Start collecting data and preparing for the solver.
4546   CollectChains();
4547   CollectInterestingTypesAndFactors();
4548   CollectFixupsAndInitialFormulae();
4549   CollectLoopInvariantFixupsAndFormulae();
4550
4551   assert(!Uses.empty() && "IVUsers reported at least one use");
4552   DEBUG(dbgs() << "LSR found " << Uses.size() << " uses:\n";
4553         print_uses(dbgs()));
4554
4555   // Now use the reuse data to generate a bunch of interesting ways
4556   // to formulate the values needed for the uses.
4557   GenerateAllReuseFormulae();
4558
4559   FilterOutUndesirableDedicatedRegisters();
4560   NarrowSearchSpaceUsingHeuristics();
4561
4562   SmallVector<const Formula *, 8> Solution;
4563   Solve(Solution);
4564
4565   // Release memory that is no longer needed.
4566   Factors.clear();
4567   Types.clear();
4568   RegUses.clear();
4569
4570   if (Solution.empty())
4571     return;
4572
4573 #ifndef NDEBUG
4574   // Formulae should be legal.
4575   for (SmallVectorImpl<LSRUse>::const_iterator I = Uses.begin(),
4576        E = Uses.end(); I != E; ++I) {
4577      const LSRUse &LU = *I;
4578      for (SmallVectorImpl<Formula>::const_iterator J = LU.Formulae.begin(),
4579           JE = LU.Formulae.end(); J != JE; ++J)
4580         assert(isLegalUse(J->AM, LU.MinOffset, LU.MaxOffset,
4581                           LU.Kind, LU.AccessTy, TLI) &&
4582                "Illegal formula generated!");
4583   };
4584 #endif
4585
4586   // Now that we've decided what we want, make it so.
4587   ImplementSolution(Solution, P);
4588 }
4589
4590 void LSRInstance::print_factors_and_types(raw_ostream &OS) const {
4591   if (Factors.empty() && Types.empty()) return;
4592
4593   OS << "LSR has identified the following interesting factors and types: ";
4594   bool First = true;
4595
4596   for (SmallSetVector<int64_t, 8>::const_iterator
4597        I = Factors.begin(), E = Factors.end(); I != E; ++I) {
4598     if (!First) OS << ", ";
4599     First = false;
4600     OS << '*' << *I;
4601   }
4602
4603   for (SmallSetVector<Type *, 4>::const_iterator
4604        I = Types.begin(), E = Types.end(); I != E; ++I) {
4605     if (!First) OS << ", ";
4606     First = false;
4607     OS << '(' << **I << ')';
4608   }
4609   OS << '\n';
4610 }
4611
4612 void LSRInstance::print_fixups(raw_ostream &OS) const {
4613   OS << "LSR is examining the following fixup sites:\n";
4614   for (SmallVectorImpl<LSRFixup>::const_iterator I = Fixups.begin(),
4615        E = Fixups.end(); I != E; ++I) {
4616     dbgs() << "  ";
4617     I->print(OS);
4618     OS << '\n';
4619   }
4620 }
4621
4622 void LSRInstance::print_uses(raw_ostream &OS) const {
4623   OS << "LSR is examining the following uses:\n";
4624   for (SmallVectorImpl<LSRUse>::const_iterator I = Uses.begin(),
4625        E = Uses.end(); I != E; ++I) {
4626     const LSRUse &LU = *I;
4627     dbgs() << "  ";
4628     LU.print(OS);
4629     OS << '\n';
4630     for (SmallVectorImpl<Formula>::const_iterator J = LU.Formulae.begin(),
4631          JE = LU.Formulae.end(); J != JE; ++J) {
4632       OS << "    ";
4633       J->print(OS);
4634       OS << '\n';
4635     }
4636   }
4637 }
4638
4639 void LSRInstance::print(raw_ostream &OS) const {
4640   print_factors_and_types(OS);
4641   print_fixups(OS);
4642   print_uses(OS);
4643 }
4644
4645 void LSRInstance::dump() const {
4646   print(errs()); errs() << '\n';
4647 }
4648
4649 namespace {
4650
4651 class LoopStrengthReduce : public LoopPass {
4652   /// TLI - Keep a pointer of a TargetLowering to consult for determining
4653   /// transformation profitability.
4654   const TargetLowering *const TLI;
4655
4656 public:
4657   static char ID; // Pass ID, replacement for typeid
4658   explicit LoopStrengthReduce(const TargetLowering *tli = 0);
4659
4660 private:
4661   bool runOnLoop(Loop *L, LPPassManager &LPM);
4662   void getAnalysisUsage(AnalysisUsage &AU) const;
4663 };
4664
4665 }
4666
4667 char LoopStrengthReduce::ID = 0;
4668 INITIALIZE_PASS_BEGIN(LoopStrengthReduce, "loop-reduce",
4669                 "Loop Strength Reduction", false, false)
4670 INITIALIZE_PASS_DEPENDENCY(DominatorTree)
4671 INITIALIZE_PASS_DEPENDENCY(ScalarEvolution)
4672 INITIALIZE_PASS_DEPENDENCY(IVUsers)
4673 INITIALIZE_PASS_DEPENDENCY(LoopInfo)
4674 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
4675 INITIALIZE_PASS_END(LoopStrengthReduce, "loop-reduce",
4676                 "Loop Strength Reduction", false, false)
4677
4678
4679 Pass *llvm::createLoopStrengthReducePass(const TargetLowering *TLI) {
4680   return new LoopStrengthReduce(TLI);
4681 }
4682
4683 LoopStrengthReduce::LoopStrengthReduce(const TargetLowering *tli)
4684   : LoopPass(ID), TLI(tli) {
4685     initializeLoopStrengthReducePass(*PassRegistry::getPassRegistry());
4686   }
4687
4688 void LoopStrengthReduce::getAnalysisUsage(AnalysisUsage &AU) const {
4689   // We split critical edges, so we change the CFG.  However, we do update
4690   // many analyses if they are around.
4691   AU.addPreservedID(LoopSimplifyID);
4692
4693   AU.addRequired<LoopInfo>();
4694   AU.addPreserved<LoopInfo>();
4695   AU.addRequiredID(LoopSimplifyID);
4696   AU.addRequired<DominatorTree>();
4697   AU.addPreserved<DominatorTree>();
4698   AU.addRequired<ScalarEvolution>();
4699   AU.addPreserved<ScalarEvolution>();
4700   // Requiring LoopSimplify a second time here prevents IVUsers from running
4701   // twice, since LoopSimplify was invalidated by running ScalarEvolution.
4702   AU.addRequiredID(LoopSimplifyID);
4703   AU.addRequired<IVUsers>();
4704   AU.addPreserved<IVUsers>();
4705 }
4706
4707 bool LoopStrengthReduce::runOnLoop(Loop *L, LPPassManager & /*LPM*/) {
4708   bool Changed = false;
4709
4710   // Run the main LSR transformation.
4711   Changed |= LSRInstance(TLI, L, this).getChanged();
4712
4713   // Remove any extra phis created by processing inner loops.
4714   Changed |= DeleteDeadPHIs(L->getHeader());
4715   if (EnablePhiElim) {
4716     SmallVector<WeakVH, 16> DeadInsts;
4717     SCEVExpander Rewriter(getAnalysis<ScalarEvolution>(), "lsr");
4718 #ifndef NDEBUG
4719     Rewriter.setDebugType(DEBUG_TYPE);
4720 #endif
4721     unsigned numFolded = Rewriter.
4722       replaceCongruentIVs(L, &getAnalysis<DominatorTree>(), DeadInsts, TLI);
4723     if (numFolded) {
4724       Changed = true;
4725       DeleteTriviallyDeadInstructions(DeadInsts);
4726       DeleteDeadPHIs(L->getHeader());
4727     }
4728   }
4729   return Changed;
4730 }