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