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