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