lib/Transforms/Scalar/LoopStrengthReduce.cpp

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