lib/Transforms/Scalar/LoopRerollPass.cpp

   1 //===-- LoopReroll.cpp - Loop rerolling pass ------------------------------===//
   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 pass implements a simple loop reroller.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "loop-reroll"
  15 #include "llvm/Transforms/Scalar.h"
  16 #include "llvm/ADT/STLExtras.h"
  17 #include "llvm/ADT/SmallSet.h"
  18 #include "llvm/ADT/Statistic.h"
  19 #include "llvm/Analysis/AliasAnalysis.h"
  20 #include "llvm/Analysis/AliasSetTracker.h"
  21 #include "llvm/Analysis/LoopPass.h"
  22 #include "llvm/Analysis/ScalarEvolution.h"
  23 #include "llvm/Analysis/ScalarEvolutionExpander.h"
  24 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
  25 #include "llvm/Analysis/ValueTracking.h"
  26 #include "llvm/IR/DataLayout.h"
  27 #include "llvm/IR/Dominators.h"
  28 #include "llvm/IR/IntrinsicInst.h"
  29 #include "llvm/Support/CommandLine.h"
  30 #include "llvm/Support/Debug.h"
  31 #include "llvm/Support/raw_ostream.h"
  32 #include "llvm/Target/TargetLibraryInfo.h"
  33 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  34 #include "llvm/Transforms/Utils/Local.h"
  35 #include "llvm/Transforms/Utils/LoopUtils.h"
  36
  37 using namespace llvm;
  38
  39 STATISTIC(NumRerolledLoops, "Number of rerolled loops");
  40
  41 static cl::opt<unsigned>
  42 MaxInc("max-reroll-increment", cl::init(2048), cl::Hidden,
  43   cl::desc("The maximum increment for loop rerolling"));
  44
  45 // This loop re-rolling transformation aims to transform loops like this:
  46 //
  47 // int foo(int a);
  48 // void bar(int *x) {
  49 //   for (int i = 0; i < 500; i += 3) {
  50 //     foo(i);
  51 //     foo(i+1);
  52 //     foo(i+2);
  53 //   }
  54 // }
  55 //
  56 // into a loop like this:
  57 //
  58 // void bar(int *x) {
  59 //   for (int i = 0; i < 500; ++i)
  60 //     foo(i);
  61 // }
  62 //
  63 // It does this by looking for loops that, besides the latch code, are composed
  64 // of isomorphic DAGs of instructions, with each DAG rooted at some increment
  65 // to the induction variable, and where each DAG is isomorphic to the DAG
  66 // rooted at the induction variable (excepting the sub-DAGs which root the
  67 // other induction-variable increments). In other words, we're looking for loop
  68 // bodies of the form:
  69 //
  70 // %iv = phi [ (preheader, ...), (body, %iv.next) ]
  71 // f(%iv)
  72 // %iv.1 = add %iv, 1                <-- a root increment
  73 // f(%iv.1)
  74 // %iv.2 = add %iv, 2                <-- a root increment
  75 // f(%iv.2)
  76 // %iv.scale_m_1 = add %iv, scale-1  <-- a root increment
  77 // f(%iv.scale_m_1)
  78 // ...
  79 // %iv.next = add %iv, scale
  80 // %cmp = icmp(%iv, ...)
  81 // br %cmp, header, exit
  82 //
  83 // where each f(i) is a set of instructions that, collectively, are a function
  84 // only of i (and other loop-invariant values).
  85 //
  86 // As a special case, we can also reroll loops like this:
  87 //
  88 // int foo(int);
  89 // void bar(int *x) {
  90 //   for (int i = 0; i < 500; ++i) {
  91 //     x[3*i] = foo(0);
  92 //     x[3*i+1] = foo(0);
  93 //     x[3*i+2] = foo(0);
  94 //   }
  95 // }
  96 //
  97 // into this:
  98 //
  99 // void bar(int *x) {
 100 //   for (int i = 0; i < 1500; ++i)
 101 //     x[i] = foo(0);
 102 // }
 103 //
 104 // in which case, we're looking for inputs like this:
 105 //
 106 // %iv = phi [ (preheader, ...), (body, %iv.next) ]
 107 // %scaled.iv = mul %iv, scale
 108 // f(%scaled.iv)
 109 // %scaled.iv.1 = add %scaled.iv, 1
 110 // f(%scaled.iv.1)
 111 // %scaled.iv.2 = add %scaled.iv, 2
 112 // f(%scaled.iv.2)
 113 // %scaled.iv.scale_m_1 = add %scaled.iv, scale-1
 114 // f(%scaled.iv.scale_m_1)
 115 // ...
 116 // %iv.next = add %iv, 1
 117 // %cmp = icmp(%iv, ...)
 118 // br %cmp, header, exit
 119
 120 namespace {
 121   class LoopReroll : public LoopPass {
 122   public:
 123     static char ID; // Pass ID, replacement for typeid
 124     LoopReroll() : LoopPass(ID) {
 125       initializeLoopRerollPass(*PassRegistry::getPassRegistry());
 126     }
 127
 128     bool runOnLoop(Loop *L, LPPassManager &LPM) override;
 129
 130     void getAnalysisUsage(AnalysisUsage &AU) const override {
 131       AU.addRequired<AliasAnalysis>();
 132       AU.addRequired<LoopInfo>();
 133       AU.addPreserved<LoopInfo>();
 134       AU.addRequired<DominatorTreeWrapperPass>();
 135       AU.addPreserved<DominatorTreeWrapperPass>();
 136       AU.addRequired<ScalarEvolution>();
 137       AU.addRequired<TargetLibraryInfo>();
 138     }
 139
 140 protected:
 141     AliasAnalysis *AA;
 142     LoopInfo *LI;
 143     ScalarEvolution *SE;
 144     const DataLayout *DL;
 145     TargetLibraryInfo *TLI;
 146     DominatorTree *DT;
 147
 148     typedef SmallVector<Instruction *, 16> SmallInstructionVector;
 149     typedef SmallSet<Instruction *, 16>   SmallInstructionSet;
 150
 151     // A chain of isomorphic instructions, indentified by a single-use PHI,
 152     // representing a reduction. Only the last value may be used outside the
 153     // loop.
 154     struct SimpleLoopReduction {
 155       SimpleLoopReduction(Instruction *P, Loop *L)
 156         : Valid(false), Instructions(1, P) {
 157         assert(isa<PHINode>(P) && "First reduction instruction must be a PHI");
 158         add(L);
 159       }
 160
 161       bool valid() const {
 162         return Valid;
 163       }
 164
 165       Instruction *getPHI() const {
 166         assert(Valid && "Using invalid reduction");
 167         return Instructions.front();
 168       }
 169
 170       Instruction *getReducedValue() const {
 171         assert(Valid && "Using invalid reduction");
 172         return Instructions.back();
 173       }
 174
 175       Instruction *get(size_t i) const {
 176         assert(Valid && "Using invalid reduction");
 177         return Instructions[i+1];
 178       }
 179
 180       Instruction *operator [] (size_t i) const { return get(i); }
 181
 182       // The size, ignoring the initial PHI.
 183       size_t size() const {
 184         assert(Valid && "Using invalid reduction");
 185         return Instructions.size()-1;
 186       }
 187
 188       typedef SmallInstructionVector::iterator iterator;
 189       typedef SmallInstructionVector::const_iterator const_iterator;
 190
 191       iterator begin() {
 192         assert(Valid && "Using invalid reduction");
 193         return std::next(Instructions.begin());
 194       }
 195
 196       const_iterator begin() const {
 197         assert(Valid && "Using invalid reduction");
 198         return std::next(Instructions.begin());
 199       }
 200
 201       iterator end() { return Instructions.end(); }
 202       const_iterator end() const { return Instructions.end(); }
 203
 204     protected:
 205       bool Valid;
 206       SmallInstructionVector Instructions;
 207
 208       void add(Loop *L);
 209     };
 210
 211     // The set of all reductions, and state tracking of possible reductions
 212     // during loop instruction processing.
 213     struct ReductionTracker {
 214       typedef SmallVector<SimpleLoopReduction, 16> SmallReductionVector;
 215
 216       // Add a new possible reduction.
 217       void addSLR(SimpleLoopReduction &SLR) {
 218         PossibleReds.push_back(SLR);
 219       }
 220
 221       // Setup to track possible reductions corresponding to the provided
 222       // rerolling scale. Only reductions with a number of non-PHI instructions
 223       // that is divisible by the scale are considered. Three instructions sets
 224       // are filled in:
 225       //   - A set of all possible instructions in eligible reductions.
 226       //   - A set of all PHIs in eligible reductions
 227       //   - A set of all reduced values (last instructions) in eligible reductions.
 228       void restrictToScale(uint64_t Scale,
 229                            SmallInstructionSet &PossibleRedSet,
 230                            SmallInstructionSet &PossibleRedPHISet,
 231                            SmallInstructionSet &PossibleRedLastSet) {
 232         PossibleRedIdx.clear();
 233         PossibleRedIter.clear();
 234         Reds.clear();
 235
 236         for (unsigned i = 0, e = PossibleReds.size(); i != e; ++i)
 237           if (PossibleReds[i].size() % Scale == 0) {
 238             PossibleRedLastSet.insert(PossibleReds[i].getReducedValue());
 239             PossibleRedPHISet.insert(PossibleReds[i].getPHI());
 240
 241             PossibleRedSet.insert(PossibleReds[i].getPHI());
 242             PossibleRedIdx[PossibleReds[i].getPHI()] = i;
 243             for (SimpleLoopReduction::iterator J = PossibleReds[i].begin(),
 244                  JE = PossibleReds[i].end(); J != JE; ++J) {
 245               PossibleRedSet.insert(*J);
 246               PossibleRedIdx[*J] = i;
 247             }
 248           }
 249       }
 250
 251       // The functions below are used while processing the loop instructions.
 252
 253       // Are the two instructions both from reductions, and furthermore, from
 254       // the same reduction?
 255       bool isPairInSame(Instruction *J1, Instruction *J2) {
 256         DenseMap<Instruction *, int>::iterator J1I = PossibleRedIdx.find(J1);
 257         if (J1I != PossibleRedIdx.end()) {
 258           DenseMap<Instruction *, int>::iterator J2I = PossibleRedIdx.find(J2);
 259           if (J2I != PossibleRedIdx.end() && J1I->second == J2I->second)
 260             return true;
 261         }
 262
 263         return false;
 264       }
 265
 266       // The two provided instructions, the first from the base iteration, and
 267       // the second from iteration i, form a matched pair. If these are part of
 268       // a reduction, record that fact.
 269       void recordPair(Instruction *J1, Instruction *J2, unsigned i) {
 270         if (PossibleRedIdx.count(J1)) {
 271           assert(PossibleRedIdx.count(J2) &&
 272                  "Recording reduction vs. non-reduction instruction?");
 273
 274           PossibleRedIter[J1] = 0;
 275           PossibleRedIter[J2] = i;
 276
 277           int Idx = PossibleRedIdx[J1];
 278           assert(Idx == PossibleRedIdx[J2] &&
 279                  "Recording pair from different reductions?");
 280           Reds.insert(Idx);
 281         }
 282       }
 283
 284       // The functions below can be called after we've finished processing all
 285       // instructions in the loop, and we know which reductions were selected.
 286
 287       // Is the provided instruction the PHI of a reduction selected for
 288       // rerolling?
 289       bool isSelectedPHI(Instruction *J) {
 290         if (!isa<PHINode>(J))
 291           return false;
 292
 293         for (DenseSet<int>::iterator RI = Reds.begin(), RIE = Reds.end();
 294              RI != RIE; ++RI) {
 295           int i = *RI;
 296           if (cast<Instruction>(J) == PossibleReds[i].getPHI())
 297             return true;
 298         }
 299
 300         return false;
 301       }
 302
 303       bool validateSelected();
 304       void replaceSelected();
 305
 306     protected:
 307       // The vector of all possible reductions (for any scale).
 308       SmallReductionVector PossibleReds;
 309
 310       DenseMap<Instruction *, int> PossibleRedIdx;
 311       DenseMap<Instruction *, int> PossibleRedIter;
 312       DenseSet<int> Reds;
 313     };
 314
 315     void collectPossibleIVs(Loop *L, SmallInstructionVector &PossibleIVs);
 316     void collectPossibleReductions(Loop *L,
 317            ReductionTracker &Reductions);
 318     void collectInLoopUserSet(Loop *L,
 319            const SmallInstructionVector &Roots,
 320            const SmallInstructionSet &Exclude,
 321            const SmallInstructionSet &Final,
 322            DenseSet<Instruction *> &Users);
 323     void collectInLoopUserSet(Loop *L,
 324            Instruction * Root,
 325            const SmallInstructionSet &Exclude,
 326            const SmallInstructionSet &Final,
 327            DenseSet<Instruction *> &Users);
 328     bool findScaleFromMul(Instruction *RealIV, uint64_t &Scale,
 329                           Instruction *&IV,
 330                           SmallInstructionVector &LoopIncs);
 331     bool collectAllRoots(Loop *L, uint64_t Inc, uint64_t Scale, Instruction *IV,
 332                          SmallVector<SmallInstructionVector, 32> &Roots,
 333                          SmallInstructionSet &AllRoots,
 334                          SmallInstructionVector &LoopIncs);
 335     bool reroll(Instruction *IV, Loop *L, BasicBlock *Header, const SCEV *IterCount,
 336                 ReductionTracker &Reductions);
 337   };
 338 }
 339
 340 char LoopReroll::ID = 0;
 341 INITIALIZE_PASS_BEGIN(LoopReroll, "loop-reroll", "Reroll loops", false, false)
 342 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
 343 INITIALIZE_PASS_DEPENDENCY(LoopInfo)
 344 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
 345 INITIALIZE_PASS_DEPENDENCY(ScalarEvolution)
 346 INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfo)
 347 INITIALIZE_PASS_END(LoopReroll, "loop-reroll", "Reroll loops", false, false)
 348
 349 Pass *llvm::createLoopRerollPass() {
 350   return new LoopReroll;
 351 }
 352
 353 // Returns true if the provided instruction is used outside the given loop.
 354 // This operates like Instruction::isUsedOutsideOfBlock, but considers PHIs in
 355 // non-loop blocks to be outside the loop.
 356 static bool hasUsesOutsideLoop(Instruction *I, Loop *L) {
 357   for (User *U : I->users())
 358     if (!L->contains(cast<Instruction>(U)))
 359       return true;
 360
 361   return false;
 362 }
 363
 364 // Collect the list of loop induction variables with respect to which it might
 365 // be possible to reroll the loop.
 366 void LoopReroll::collectPossibleIVs(Loop *L,
 367                                     SmallInstructionVector &PossibleIVs) {
 368   BasicBlock *Header = L->getHeader();
 369   for (BasicBlock::iterator I = Header->begin(),
 370        IE = Header->getFirstInsertionPt(); I != IE; ++I) {
 371     if (!isa<PHINode>(I))
 372       continue;
 373     if (!I->getType()->isIntegerTy())
 374       continue;
 375
 376     if (const SCEVAddRecExpr *PHISCEV =
 377         dyn_cast<SCEVAddRecExpr>(SE->getSCEV(I))) {
 378       if (PHISCEV->getLoop() != L)
 379         continue;
 380       if (!PHISCEV->isAffine())
 381         continue;
 382       if (const SCEVConstant *IncSCEV =
 383           dyn_cast<SCEVConstant>(PHISCEV->getStepRecurrence(*SE))) {
 384         if (!IncSCEV->getValue()->getValue().isStrictlyPositive())
 385           continue;
 386         if (IncSCEV->getValue()->uge(MaxInc))
 387           continue;
 388
 389         DEBUG(dbgs() << "LRR: Possible IV: " << *I << " = " <<
 390               *PHISCEV << "\n");
 391         PossibleIVs.push_back(I);
 392       }
 393     }
 394   }
 395 }
 396
 397 // Add the remainder of the reduction-variable chain to the instruction vector
 398 // (the initial PHINode has already been added). If successful, the object is
 399 // marked as valid.
 400 void LoopReroll::SimpleLoopReduction::add(Loop *L) {
 401   assert(!Valid && "Cannot add to an already-valid chain");
 402
 403   // The reduction variable must be a chain of single-use instructions
 404   // (including the PHI), except for the last value (which is used by the PHI
 405   // and also outside the loop).
 406   Instruction *C = Instructions.front();
 407
 408   do {
 409     C = cast<Instruction>(*C->user_begin());
 410     if (C->hasOneUse()) {
 411       if (!C->isBinaryOp())
 412         return;
 413
 414       if (!(isa<PHINode>(Instructions.back()) ||
 415             C->isSameOperationAs(Instructions.back())))
 416         return;
 417
 418       Instructions.push_back(C);
 419     }
 420   } while (C->hasOneUse());
 421
 422   if (Instructions.size() < 2 ||
 423       !C->isSameOperationAs(Instructions.back()) ||
 424       C->use_empty())
 425     return;
 426
 427   // C is now the (potential) last instruction in the reduction chain.
 428   for (User *U : C->users())
 429     // The only in-loop user can be the initial PHI.
 430     if (L->contains(cast<Instruction>(U)))
 431       if (cast<Instruction>(U) != Instructions.front())
 432         return;
 433
 434   Instructions.push_back(C);
 435   Valid = true;
 436 }
 437
 438 // Collect the vector of possible reduction variables.
 439 void LoopReroll::collectPossibleReductions(Loop *L,
 440   ReductionTracker &Reductions) {
 441   BasicBlock *Header = L->getHeader();
 442   for (BasicBlock::iterator I = Header->begin(),
 443        IE = Header->getFirstInsertionPt(); I != IE; ++I) {
 444     if (!isa<PHINode>(I))
 445       continue;
 446     if (!I->getType()->isSingleValueType())
 447       continue;
 448
 449     SimpleLoopReduction SLR(I, L);
 450     if (!SLR.valid())
 451       continue;
 452
 453     DEBUG(dbgs() << "LRR: Possible reduction: " << *I << " (with " <<
 454           SLR.size() << " chained instructions)\n");
 455     Reductions.addSLR(SLR);
 456   }
 457 }
 458
 459 // Collect the set of all users of the provided root instruction. This set of
 460 // users contains not only the direct users of the root instruction, but also
 461 // all users of those users, and so on. There are two exceptions:
 462 //
 463 //   1. Instructions in the set of excluded instructions are never added to the
 464 //   use set (even if they are users). This is used, for example, to exclude
 465 //   including root increments in the use set of the primary IV.
 466 //
 467 //   2. Instructions in the set of final instructions are added to the use set
 468 //   if they are users, but their users are not added. This is used, for
 469 //   example, to prevent a reduction update from forcing all later reduction
 470 //   updates into the use set.
 471 void LoopReroll::collectInLoopUserSet(Loop *L,
 472   Instruction *Root, const SmallInstructionSet &Exclude,
 473   const SmallInstructionSet &Final,
 474   DenseSet<Instruction *> &Users) {
 475   SmallInstructionVector Queue(1, Root);
 476   while (!Queue.empty()) {
 477     Instruction *I = Queue.pop_back_val();
 478     if (!Users.insert(I).second)
 479       continue;
 480
 481     if (!Final.count(I))
 482       for (Use &U : I->uses()) {
 483         Instruction *User = cast<Instruction>(U.getUser());
 484         if (PHINode *PN = dyn_cast<PHINode>(User)) {
 485           // Ignore "wrap-around" uses to PHIs of this loop's header.
 486           if (PN->getIncomingBlock(U) == L->getHeader())
 487             continue;
 488         }
 489
 490         if (L->contains(User) && !Exclude.count(User)) {
 491           Queue.push_back(User);
 492         }
 493       }
 494
 495     // We also want to collect single-user "feeder" values.
 496     for (User::op_iterator OI = I->op_begin(),
 497          OIE = I->op_end(); OI != OIE; ++OI) {
 498       if (Instruction *Op = dyn_cast<Instruction>(*OI))
 499         if (Op->hasOneUse() && L->contains(Op) && !Exclude.count(Op) &&
 500             !Final.count(Op))
 501           Queue.push_back(Op);
 502     }
 503   }
 504 }
 505
 506 // Collect all of the users of all of the provided root instructions (combined
 507 // into a single set).
 508 void LoopReroll::collectInLoopUserSet(Loop *L,
 509   const SmallInstructionVector &Roots,
 510   const SmallInstructionSet &Exclude,
 511   const SmallInstructionSet &Final,
 512   DenseSet<Instruction *> &Users) {
 513   for (SmallInstructionVector::const_iterator I = Roots.begin(),
 514        IE = Roots.end(); I != IE; ++I)
 515     collectInLoopUserSet(L, *I, Exclude, Final, Users);
 516 }
 517
 518 static bool isSimpleLoadStore(Instruction *I) {
 519   if (LoadInst *LI = dyn_cast<LoadInst>(I))
 520     return LI->isSimple();
 521   if (StoreInst *SI = dyn_cast<StoreInst>(I))
 522     return SI->isSimple();
 523   if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(I))
 524     return !MI->isVolatile();
 525   return false;
 526 }
 527
 528 // Recognize loops that are setup like this:
 529 //
 530 // %iv = phi [ (preheader, ...), (body, %iv.next) ]
 531 // %scaled.iv = mul %iv, scale
 532 // f(%scaled.iv)
 533 // %scaled.iv.1 = add %scaled.iv, 1
 534 // f(%scaled.iv.1)
 535 // %scaled.iv.2 = add %scaled.iv, 2
 536 // f(%scaled.iv.2)
 537 // %scaled.iv.scale_m_1 = add %scaled.iv, scale-1
 538 // f(%scaled.iv.scale_m_1)
 539 // ...
 540 // %iv.next = add %iv, 1
 541 // %cmp = icmp(%iv, ...)
 542 // br %cmp, header, exit
 543 //
 544 // and, if found, set IV = %scaled.iv, and add %iv.next to LoopIncs.
 545 bool LoopReroll::findScaleFromMul(Instruction *RealIV, uint64_t &Scale,
 546                                   Instruction *&IV,
 547                                   SmallInstructionVector &LoopIncs) {
 548   // This is a special case: here we're looking for all uses (except for
 549   // the increment) to be multiplied by a common factor. The increment must
 550   // be by one. This is to capture loops like:
 551   //   for (int i = 0; i < 500; ++i) {
 552   //     foo(3*i); foo(3*i+1); foo(3*i+2);
 553   //   }
 554   if (RealIV->getNumUses() != 2)
 555     return false;
 556   const SCEVAddRecExpr *RealIVSCEV = cast<SCEVAddRecExpr>(SE->getSCEV(RealIV));
 557   Instruction *User1 = cast<Instruction>(*RealIV->user_begin()),
 558               *User2 = cast<Instruction>(*std::next(RealIV->user_begin()));
 559   if (!SE->isSCEVable(User1->getType()) || !SE->isSCEVable(User2->getType()))
 560     return false;
 561   const SCEVAddRecExpr *User1SCEV =
 562                          dyn_cast<SCEVAddRecExpr>(SE->getSCEV(User1)),
 563                        *User2SCEV =
 564                          dyn_cast<SCEVAddRecExpr>(SE->getSCEV(User2));
 565   if (!User1SCEV || !User1SCEV->isAffine() ||
 566       !User2SCEV || !User2SCEV->isAffine())
 567     return false;
 568
 569   // We assume below that User1 is the scale multiply and User2 is the
 570   // increment. If this can't be true, then swap them.
 571   if (User1SCEV == RealIVSCEV->getPostIncExpr(*SE)) {
 572     std::swap(User1, User2);
 573     std::swap(User1SCEV, User2SCEV);
 574   }
 575
 576   if (User2SCEV != RealIVSCEV->getPostIncExpr(*SE))
 577     return false;
 578   assert(User2SCEV->getStepRecurrence(*SE)->isOne() &&
 579          "Invalid non-unit step for multiplicative scaling");
 580   LoopIncs.push_back(User2);
 581
 582   if (const SCEVConstant *MulScale =
 583       dyn_cast<SCEVConstant>(User1SCEV->getStepRecurrence(*SE))) {
 584     // Make sure that both the start and step have the same multiplier.
 585     if (RealIVSCEV->getStart()->getType() != MulScale->getType())
 586       return false;
 587     if (SE->getMulExpr(RealIVSCEV->getStart(), MulScale) !=
 588         User1SCEV->getStart())
 589       return false;
 590
 591     ConstantInt *MulScaleCI = MulScale->getValue();
 592     if (!MulScaleCI->uge(2) || MulScaleCI->uge(MaxInc))
 593       return false;
 594     Scale = MulScaleCI->getZExtValue();
 595     IV = User1;
 596   } else
 597     return false;
 598
 599   DEBUG(dbgs() << "LRR: Found possible scaling " << *User1 << "\n");
 600   return true;
 601 }
 602
 603 // Collect all root increments with respect to the provided induction variable
 604 // (normally the PHI, but sometimes a multiply). A root increment is an
 605 // instruction, normally an add, with a positive constant less than Scale. In a
 606 // rerollable loop, each of these increments is the root of an instruction
 607 // graph isomorphic to the others. Also, we collect the final induction
 608 // increment (the increment equal to the Scale), and its users in LoopIncs.
 609 bool LoopReroll::collectAllRoots(Loop *L, uint64_t Inc, uint64_t Scale,
 610                                  Instruction *IV,
 611                                  SmallVector<SmallInstructionVector, 32> &Roots,
 612                                  SmallInstructionSet &AllRoots,
 613                                  SmallInstructionVector &LoopIncs) {
 614   for (User *U : IV->users()) {
 615     Instruction *UI = cast<Instruction>(U);
 616     if (!SE->isSCEVable(UI->getType()))
 617       continue;
 618     if (UI->getType() != IV->getType())
 619       continue;
 620     if (!L->contains(UI))
 621       continue;
 622     if (hasUsesOutsideLoop(UI, L))
 623       continue;
 624
 625     if (const SCEVConstant *Diff = dyn_cast<SCEVConstant>(SE->getMinusSCEV(
 626           SE->getSCEV(UI), SE->getSCEV(IV)))) {
 627       uint64_t Idx = Diff->getValue()->getValue().getZExtValue();
 628       if (Idx > 0 && Idx < Scale) {
 629         Roots[Idx-1].push_back(UI);
 630         AllRoots.insert(UI);
 631       } else if (Idx == Scale && Inc > 1) {
 632         LoopIncs.push_back(UI);
 633       }
 634     }
 635   }
 636
 637   if (Roots[0].empty())
 638     return false;
 639   bool AllSame = true;
 640   for (unsigned i = 1; i < Scale-1; ++i)
 641     if (Roots[i].size() != Roots[0].size()) {
 642       AllSame = false;
 643       break;
 644     }
 645
 646   if (!AllSame)
 647     return false;
 648
 649   return true;
 650 }
 651
 652 // Validate the selected reductions. All iterations must have an isomorphic
 653 // part of the reduction chain and, for non-associative reductions, the chain
 654 // entries must appear in order.
 655 bool LoopReroll::ReductionTracker::validateSelected() {
 656   // For a non-associative reduction, the chain entries must appear in order.
 657   for (DenseSet<int>::iterator RI = Reds.begin(), RIE = Reds.end();
 658        RI != RIE; ++RI) {
 659     int i = *RI;
 660     int PrevIter = 0, BaseCount = 0, Count = 0;
 661     for (SimpleLoopReduction::iterator J = PossibleReds[i].begin(),
 662          JE = PossibleReds[i].end(); J != JE; ++J) {
 663         // Note that all instructions in the chain must have been found because
 664         // all instructions in the function must have been assigned to some
 665         // iteration.
 666       int Iter = PossibleRedIter[*J];
 667       if (Iter != PrevIter && Iter != PrevIter + 1 &&
 668           !PossibleReds[i].getReducedValue()->isAssociative()) {
 669         DEBUG(dbgs() << "LRR: Out-of-order non-associative reduction: " <<
 670                         *J << "\n");
 671         return false;
 672       }
 673
 674       if (Iter != PrevIter) {
 675         if (Count != BaseCount) {
 676           DEBUG(dbgs() << "LRR: Iteration " << PrevIter <<
 677                 " reduction use count " << Count <<
 678                 " is not equal to the base use count " <<
 679                 BaseCount << "\n");
 680           return false;
 681         }
 682
 683         Count = 0;
 684       }
 685
 686       ++Count;
 687       if (Iter == 0)
 688         ++BaseCount;
 689
 690       PrevIter = Iter;
 691     }
 692   }
 693
 694   return true;
 695 }
 696
 697 // For all selected reductions, remove all parts except those in the first
 698 // iteration (and the PHI). Replace outside uses of the reduced value with uses
 699 // of the first-iteration reduced value (in other words, reroll the selected
 700 // reductions).
 701 void LoopReroll::ReductionTracker::replaceSelected() {
 702   // Fixup reductions to refer to the last instruction associated with the
 703   // first iteration (not the last).
 704   for (DenseSet<int>::iterator RI = Reds.begin(), RIE = Reds.end();
 705        RI != RIE; ++RI) {
 706     int i = *RI;
 707     int j = 0;
 708     for (int e = PossibleReds[i].size(); j != e; ++j)
 709       if (PossibleRedIter[PossibleReds[i][j]] != 0) {
 710         --j;
 711         break;
 712       }
 713
 714     // Replace users with the new end-of-chain value.
 715     SmallInstructionVector Users;
 716     for (User *U : PossibleReds[i].getReducedValue()->users())
 717       Users.push_back(cast<Instruction>(U));
 718
 719     for (SmallInstructionVector::iterator J = Users.begin(),
 720          JE = Users.end(); J != JE; ++J)
 721       (*J)->replaceUsesOfWith(PossibleReds[i].getReducedValue(),
 722                               PossibleReds[i][j]);
 723   }
 724 }
 725
 726 // Reroll the provided loop with respect to the provided induction variable.
 727 // Generally, we're looking for a loop like this:
 728 //
 729 // %iv = phi [ (preheader, ...), (body, %iv.next) ]
 730 // f(%iv)
 731 // %iv.1 = add %iv, 1                <-- a root increment
 732 // f(%iv.1)
 733 // %iv.2 = add %iv, 2                <-- a root increment
 734 // f(%iv.2)
 735 // %iv.scale_m_1 = add %iv, scale-1  <-- a root increment
 736 // f(%iv.scale_m_1)
 737 // ...
 738 // %iv.next = add %iv, scale
 739 // %cmp = icmp(%iv, ...)
 740 // br %cmp, header, exit
 741 //
 742 // Notably, we do not require that f(%iv), f(%iv.1), etc. be isolated groups of
 743 // instructions. In other words, the instructions in f(%iv), f(%iv.1), etc. can
 744 // be intermixed with eachother. The restriction imposed by this algorithm is
 745 // that the relative order of the isomorphic instructions in f(%iv), f(%iv.1),
 746 // etc. be the same.
 747 //
 748 // First, we collect the use set of %iv, excluding the other increment roots.
 749 // This gives us f(%iv). Then we iterate over the loop instructions (scale-1)
 750 // times, having collected the use set of f(%iv.(i+1)), during which we:
 751 //   - Ensure that the next unmatched instruction in f(%iv) is isomorphic to
 752 //     the next unmatched instruction in f(%iv.(i+1)).
 753 //   - Ensure that both matched instructions don't have any external users
 754 //     (with the exception of last-in-chain reduction instructions).
 755 //   - Track the (aliasing) write set, and other side effects, of all
 756 //     instructions that belong to future iterations that come before the matched
 757 //     instructions. If the matched instructions read from that write set, then
 758 //     f(%iv) or f(%iv.(i+1)) has some dependency on instructions in
 759 //     f(%iv.(j+1)) for some j > i, and we cannot reroll the loop. Similarly,
 760 //     if any of these future instructions had side effects (could not be
 761 //     speculatively executed), and so do the matched instructions, when we
 762 //     cannot reorder those side-effect-producing instructions, and rerolling
 763 //     fails.
 764 //
 765 // Finally, we make sure that all loop instructions are either loop increment
 766 // roots, belong to simple latch code, parts of validated reductions, part of
 767 // f(%iv) or part of some f(%iv.i). If all of that is true (and all reductions
 768 // have been validated), then we reroll the loop.
 769 bool LoopReroll::reroll(Instruction *IV, Loop *L, BasicBlock *Header,
 770                         const SCEV *IterCount,
 771                         ReductionTracker &Reductions) {
 772   const SCEVAddRecExpr *RealIVSCEV = cast<SCEVAddRecExpr>(SE->getSCEV(IV));
 773   uint64_t Inc = cast<SCEVConstant>(RealIVSCEV->getOperand(1))->
 774                    getValue()->getZExtValue();
 775   // The collection of loop increment instructions.
 776   SmallInstructionVector LoopIncs;
 777   uint64_t Scale = Inc;
 778
 779   // The effective induction variable, IV, is normally also the real induction
 780   // variable. When we're dealing with a loop like:
 781   //   for (int i = 0; i < 500; ++i)
 782   //     x[3*i] = ...;
 783   //     x[3*i+1] = ...;
 784   //     x[3*i+2] = ...;
 785   // then the real IV is still i, but the effective IV is (3*i).
 786   Instruction *RealIV = IV;
 787   if (Inc == 1 && !findScaleFromMul(RealIV, Scale, IV, LoopIncs))
 788     return false;
 789
 790   assert(Scale <= MaxInc && "Scale is too large");
 791   assert(Scale > 1 && "Scale must be at least 2");
 792
 793   // The set of increment instructions for each increment value.
 794   SmallVector<SmallInstructionVector, 32> Roots(Scale-1);
 795   SmallInstructionSet AllRoots;
 796   if (!collectAllRoots(L, Inc, Scale, IV, Roots, AllRoots, LoopIncs))
 797     return false;
 798
 799   DEBUG(dbgs() << "LRR: Found all root induction increments for: " <<
 800                   *RealIV << "\n");
 801
 802   // An array of just the possible reductions for this scale factor. When we
 803   // collect the set of all users of some root instructions, these reduction
 804   // instructions are treated as 'final' (their uses are not considered).
 805   // This is important because we don't want the root use set to search down
 806   // the reduction chain.
 807   SmallInstructionSet PossibleRedSet;
 808   SmallInstructionSet PossibleRedLastSet, PossibleRedPHISet;
 809   Reductions.restrictToScale(Scale, PossibleRedSet, PossibleRedPHISet,
 810                              PossibleRedLastSet);
 811
 812   // We now need to check for equivalence of the use graph of each root with
 813   // that of the primary induction variable (excluding the roots). Our goal
 814   // here is not to solve the full graph isomorphism problem, but rather to
 815   // catch common cases without a lot of work. As a result, we will assume
 816   // that the relative order of the instructions in each unrolled iteration
 817   // is the same (although we will not make an assumption about how the
 818   // different iterations are intermixed). Note that while the order must be
 819   // the same, the instructions may not be in the same basic block.
 820   SmallInstructionSet Exclude(AllRoots);
 821   Exclude.insert(LoopIncs.begin(), LoopIncs.end());
 822
 823   DenseSet<Instruction *> BaseUseSet;
 824   collectInLoopUserSet(L, IV, Exclude, PossibleRedSet, BaseUseSet);
 825
 826   DenseSet<Instruction *> AllRootUses;
 827   std::vector<DenseSet<Instruction *> > RootUseSets(Scale-1);
 828
 829   bool MatchFailed = false;
 830   for (unsigned i = 0; i < Scale-1 && !MatchFailed; ++i) {
 831     DenseSet<Instruction *> &RootUseSet = RootUseSets[i];
 832     collectInLoopUserSet(L, Roots[i], SmallInstructionSet(),
 833                          PossibleRedSet, RootUseSet);
 834
 835     DEBUG(dbgs() << "LRR: base use set size: " << BaseUseSet.size() <<
 836                     " vs. iteration increment " << (i+1) <<
 837                     " use set size: " << RootUseSet.size() << "\n");
 838
 839     if (BaseUseSet.size() != RootUseSet.size()) {
 840       MatchFailed = true;
 841       break;
 842     }
 843
 844     // In addition to regular aliasing information, we need to look for
 845     // instructions from later (future) iterations that have side effects
 846     // preventing us from reordering them past other instructions with side
 847     // effects.
 848     bool FutureSideEffects = false;
 849     AliasSetTracker AST(*AA);
 850
 851     // The map between instructions in f(%iv.(i+1)) and f(%iv).
 852     DenseMap<Value *, Value *> BaseMap;
 853
 854     assert(L->getNumBlocks() == 1 && "Cannot handle multi-block loops");
 855     for (BasicBlock::iterator J1 = Header->begin(), J2 = Header->begin(),
 856          JE = Header->end(); J1 != JE && !MatchFailed; ++J1) {
 857       if (cast<Instruction>(J1) == RealIV)
 858         continue;
 859       if (cast<Instruction>(J1) == IV)
 860         continue;
 861       if (!BaseUseSet.count(J1))
 862         continue;
 863       if (PossibleRedPHISet.count(J1)) // Skip reduction PHIs.
 864         continue;
 865
 866       while (J2 != JE && (!RootUseSet.count(J2) ||
 867              std::find(Roots[i].begin(), Roots[i].end(), J2) !=
 868                Roots[i].end())) {
 869         // As we iterate through the instructions, instructions that don't
 870         // belong to previous iterations (or the base case), must belong to
 871         // future iterations. We want to track the alias set of writes from
 872         // previous iterations.
 873         if (!isa<PHINode>(J2) && !BaseUseSet.count(J2) &&
 874             !AllRootUses.count(J2)) {
 875           if (J2->mayWriteToMemory())
 876             AST.add(J2);
 877
 878           // Note: This is specifically guarded by a check on isa<PHINode>,
 879           // which while a valid (somewhat arbitrary) micro-optimization, is
 880           // needed because otherwise isSafeToSpeculativelyExecute returns
 881           // false on PHI nodes.
 882           if (!isSimpleLoadStore(J2) && !isSafeToSpeculativelyExecute(J2, DL))
 883             FutureSideEffects = true;
 884         }
 885
 886         ++J2;
 887       }
 888
 889       if (!J1->isSameOperationAs(J2)) {
 890         DEBUG(dbgs() << "LRR: iteration root match failed at " << *J1 <<
 891                         " vs. " << *J2 << "\n");
 892         MatchFailed = true;
 893         break;
 894       }
 895
 896       // Make sure that this instruction, which is in the use set of this
 897       // root instruction, does not also belong to the base set or the set of
 898       // some previous root instruction.
 899       if (BaseUseSet.count(J2) || AllRootUses.count(J2)) {
 900         DEBUG(dbgs() << "LRR: iteration root match failed at " << *J1 <<
 901                         " vs. " << *J2 << " (prev. case overlap)\n");
 902         MatchFailed = true;
 903         break;
 904       }
 905
 906       // Make sure that we don't alias with any instruction in the alias set
 907       // tracker. If we do, then we depend on a future iteration, and we
 908       // can't reroll.
 909       if (J2->mayReadFromMemory()) {
 910         for (AliasSetTracker::iterator K = AST.begin(), KE = AST.end();
 911              K != KE && !MatchFailed; ++K) {
 912           if (K->aliasesUnknownInst(J2, *AA)) {
 913             DEBUG(dbgs() << "LRR: iteration root match failed at " << *J1 <<
 914                             " vs. " << *J2 << " (depends on future store)\n");
 915             MatchFailed = true;
 916             break;
 917           }
 918         }
 919       }
 920
 921       // If we've past an instruction from a future iteration that may have
 922       // side effects, and this instruction might also, then we can't reorder
 923       // them, and this matching fails. As an exception, we allow the alias
 924       // set tracker to handle regular (simple) load/store dependencies.
 925       if (FutureSideEffects &&
 926             ((!isSimpleLoadStore(J1) && !isSafeToSpeculativelyExecute(J1)) ||
 927              (!isSimpleLoadStore(J2) && !isSafeToSpeculativelyExecute(J2)))) {
 928         DEBUG(dbgs() << "LRR: iteration root match failed at " << *J1 <<
 929                         " vs. " << *J2 <<
 930                         " (side effects prevent reordering)\n");
 931         MatchFailed = true;
 932         break;
 933       }
 934
 935       // For instructions that are part of a reduction, if the operation is
 936       // associative, then don't bother matching the operands (because we
 937       // already know that the instructions are isomorphic, and the order
 938       // within the iteration does not matter). For non-associative reductions,
 939       // we do need to match the operands, because we need to reject
 940       // out-of-order instructions within an iteration!
 941       // For example (assume floating-point addition), we need to reject this:
 942       //   x += a[i]; x += b[i];
 943       //   x += a[i+1]; x += b[i+1];
 944       //   x += b[i+2]; x += a[i+2];
 945       bool InReduction = Reductions.isPairInSame(J1, J2);
 946
 947       if (!(InReduction && J1->isAssociative())) {
 948         bool Swapped = false, SomeOpMatched = false;;
 949         for (unsigned j = 0; j < J1->getNumOperands() && !MatchFailed; ++j) {
 950           Value *Op2 = J2->getOperand(j);
 951
 952           // If this is part of a reduction (and the operation is not
 953           // associatve), then we match all operands, but not those that are
 954           // part of the reduction.
 955           if (InReduction)
 956             if (Instruction *Op2I = dyn_cast<Instruction>(Op2))
 957               if (Reductions.isPairInSame(J2, Op2I))
 958                 continue;
 959
 960           DenseMap<Value *, Value *>::iterator BMI = BaseMap.find(Op2);
 961           if (BMI != BaseMap.end())
 962             Op2 = BMI->second;
 963           else if (std::find(Roots[i].begin(), Roots[i].end(),
 964                              (Instruction*) Op2) != Roots[i].end())
 965             Op2 = IV;
 966
 967           if (J1->getOperand(Swapped ? unsigned(!j) : j) != Op2) {
 968             // If we've not already decided to swap the matched operands, and
 969             // we've not already matched our first operand (note that we could
 970             // have skipped matching the first operand because it is part of a
 971             // reduction above), and the instruction is commutative, then try
 972             // the swapped match.
 973             if (!Swapped && J1->isCommutative() && !SomeOpMatched &&
 974                 J1->getOperand(!j) == Op2) {
 975               Swapped = true;
 976             } else {
 977               DEBUG(dbgs() << "LRR: iteration root match failed at " << *J1 <<
 978                               " vs. " << *J2 << " (operand " << j << ")\n");
 979               MatchFailed = true;
 980               break;
 981             }
 982           }
 983
 984           SomeOpMatched = true;
 985         }
 986       }
 987
 988       if ((!PossibleRedLastSet.count(J1) && hasUsesOutsideLoop(J1, L)) ||
 989           (!PossibleRedLastSet.count(J2) && hasUsesOutsideLoop(J2, L))) {
 990         DEBUG(dbgs() << "LRR: iteration root match failed at " << *J1 <<
 991                         " vs. " << *J2 << " (uses outside loop)\n");
 992         MatchFailed = true;
 993         break;
 994       }
 995
 996       if (!MatchFailed)
 997         BaseMap.insert(std::pair<Value *, Value *>(J2, J1));
 998
 999       AllRootUses.insert(J2);
1000       Reductions.recordPair(J1, J2, i+1);
1001
1002       ++J2;
1003     }
1004   }
1005
1006   if (MatchFailed)
1007     return false;
1008
1009   DEBUG(dbgs() << "LRR: Matched all iteration increments for " <<
1010                   *RealIV << "\n");
1011
1012   DenseSet<Instruction *> LoopIncUseSet;
1013   collectInLoopUserSet(L, LoopIncs, SmallInstructionSet(),
1014                        SmallInstructionSet(), LoopIncUseSet);
1015   DEBUG(dbgs() << "LRR: Loop increment set size: " <<
1016                   LoopIncUseSet.size() << "\n");
1017
1018   // Make sure that all instructions in the loop have been included in some
1019   // use set.
1020   for (BasicBlock::iterator J = Header->begin(), JE = Header->end();
1021        J != JE; ++J) {
1022     if (isa<DbgInfoIntrinsic>(J))
1023       continue;
1024     if (cast<Instruction>(J) == RealIV)
1025       continue;
1026     if (cast<Instruction>(J) == IV)
1027       continue;
1028     if (BaseUseSet.count(J) || AllRootUses.count(J) ||
1029         (LoopIncUseSet.count(J) && (J->isTerminator() ||
1030                                     isSafeToSpeculativelyExecute(J, DL))))
1031       continue;
1032
1033     if (AllRoots.count(J))
1034       continue;
1035
1036     if (Reductions.isSelectedPHI(J))
1037       continue;
1038
1039     DEBUG(dbgs() << "LRR: aborting reroll based on " << *RealIV <<
1040                     " unprocessed instruction found: " << *J << "\n");
1041     MatchFailed = true;
1042     break;
1043   }
1044
1045   if (MatchFailed)
1046     return false;
1047
1048   DEBUG(dbgs() << "LRR: all instructions processed from " <<
1049                   *RealIV << "\n");
1050
1051   if (!Reductions.validateSelected())
1052     return false;
1053
1054   // At this point, we've validated the rerolling, and we're committed to
1055   // making changes!
1056
1057   Reductions.replaceSelected();
1058
1059   // Remove instructions associated with non-base iterations.
1060   for (BasicBlock::reverse_iterator J = Header->rbegin();
1061        J != Header->rend();) {
1062     if (AllRootUses.count(&*J)) {
1063       Instruction *D = &*J;
1064       DEBUG(dbgs() << "LRR: removing: " << *D << "\n");
1065       D->eraseFromParent();
1066       continue;
1067     }
1068
1069     ++J;
1070   }
1071
1072   // Insert the new induction variable.
1073   const SCEV *Start = RealIVSCEV->getStart();
1074   if (Inc == 1)
1075     Start = SE->getMulExpr(Start,
1076                            SE->getConstant(Start->getType(), Scale));
1077   const SCEVAddRecExpr *H =
1078     cast<SCEVAddRecExpr>(SE->getAddRecExpr(Start,
1079                            SE->getConstant(RealIVSCEV->getType(), 1),
1080                            L, SCEV::FlagAnyWrap));
1081   { // Limit the lifetime of SCEVExpander.
1082     SCEVExpander Expander(*SE, "reroll");
1083     Value *NewIV = Expander.expandCodeFor(H, IV->getType(), Header->begin());
1084
1085     for (DenseSet<Instruction *>::iterator J = BaseUseSet.begin(),
1086          JE = BaseUseSet.end(); J != JE; ++J)
1087       (*J)->replaceUsesOfWith(IV, NewIV);
1088
1089     if (BranchInst *BI = dyn_cast<BranchInst>(Header->getTerminator())) {
1090       if (LoopIncUseSet.count(BI)) {
1091         const SCEV *ICSCEV = RealIVSCEV->evaluateAtIteration(IterCount, *SE);
1092         if (Inc == 1)
1093           ICSCEV =
1094             SE->getMulExpr(ICSCEV, SE->getConstant(ICSCEV->getType(), Scale));
1095         // Iteration count SCEV minus 1
1096         const SCEV *ICMinus1SCEV =
1097           SE->getMinusSCEV(ICSCEV, SE->getConstant(ICSCEV->getType(), 1));
1098
1099         Value *ICMinus1; // Iteration count minus 1
1100         if (isa<SCEVConstant>(ICMinus1SCEV)) {
1101           ICMinus1 = Expander.expandCodeFor(ICMinus1SCEV, NewIV->getType(), BI);
1102         } else {
1103           BasicBlock *Preheader = L->getLoopPreheader();
1104           if (!Preheader)
1105             Preheader = InsertPreheaderForLoop(L, this);
1106
1107           ICMinus1 = Expander.expandCodeFor(ICMinus1SCEV, NewIV->getType(),
1108                                             Preheader->getTerminator());
1109         }
1110
1111         Value *Cond = new ICmpInst(BI, CmpInst::ICMP_EQ, NewIV, ICMinus1,
1112                                    "exitcond");
1113         BI->setCondition(Cond);
1114
1115         if (BI->getSuccessor(1) != Header)
1116           BI->swapSuccessors();
1117       }
1118     }
1119   }
1120
1121   SimplifyInstructionsInBlock(Header, DL, TLI);
1122   DeleteDeadPHIs(Header, TLI);
1123   ++NumRerolledLoops;
1124   return true;
1125 }
1126
1127 bool LoopReroll::runOnLoop(Loop *L, LPPassManager &LPM) {
1128   if (skipOptnoneFunction(L))
1129     return false;
1130
1131   AA = &getAnalysis<AliasAnalysis>();
1132   LI = &getAnalysis<LoopInfo>();
1133   SE = &getAnalysis<ScalarEvolution>();
1134   TLI = &getAnalysis<TargetLibraryInfo>();
1135   DataLayoutPass *DLP = getAnalysisIfAvailable<DataLayoutPass>();
1136   DL = DLP ? &DLP->getDataLayout() : 0;
1137   DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
1138
1139   BasicBlock *Header = L->getHeader();
1140   DEBUG(dbgs() << "LRR: F[" << Header->getParent()->getName() <<
1141         "] Loop %" << Header->getName() << " (" <<
1142         L->getNumBlocks() << " block(s))\n");
1143
1144   bool Changed = false;
1145
1146   // For now, we'll handle only single BB loops.
1147   if (L->getNumBlocks() > 1)
1148     return Changed;
1149
1150   if (!SE->hasLoopInvariantBackedgeTakenCount(L))
1151     return Changed;
1152
1153   const SCEV *LIBETC = SE->getBackedgeTakenCount(L);
1154   const SCEV *IterCount =
1155     SE->getAddExpr(LIBETC, SE->getConstant(LIBETC->getType(), 1));
1156   DEBUG(dbgs() << "LRR: iteration count = " << *IterCount << "\n");
1157
1158   // First, we need to find the induction variable with respect to which we can
1159   // reroll (there may be several possible options).
1160   SmallInstructionVector PossibleIVs;
1161   collectPossibleIVs(L, PossibleIVs);
1162
1163   if (PossibleIVs.empty()) {
1164     DEBUG(dbgs() << "LRR: No possible IVs found\n");
1165     return Changed;
1166   }
1167
1168   ReductionTracker Reductions;
1169   collectPossibleReductions(L, Reductions);
1170
1171   // For each possible IV, collect the associated possible set of 'root' nodes
1172   // (i+1, i+2, etc.).
1173   for (SmallInstructionVector::iterator I = PossibleIVs.begin(),
1174        IE = PossibleIVs.end(); I != IE; ++I)
1175     if (reroll(*I, L, Header, IterCount, Reductions)) {
1176       Changed = true;
1177       break;
1178     }
1179
1180   return Changed;
1181 }
1182