lib/Transforms/Scalar/LoopRotation.cpp

   1 //===- LoopRotation.cpp - Loop Rotation 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 file implements Loop Rotation Pass.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "loop-rotate"
  15 #include "llvm/Transforms/Scalar.h"
  16 #include "llvm/ADT/Statistic.h"
  17 #include "llvm/Analysis/CodeMetrics.h"
  18 #include "llvm/Analysis/InstructionSimplify.h"
  19 #include "llvm/Analysis/LoopPass.h"
  20 #include "llvm/Analysis/ScalarEvolution.h"
  21 #include "llvm/Analysis/TargetTransformInfo.h"
  22 #include "llvm/Analysis/ValueTracking.h"
  23 #include "llvm/IR/Dominators.h"
  24 #include "llvm/IR/Function.h"
  25 #include "llvm/IR/IntrinsicInst.h"
  26 #include "llvm/Support/CFG.h"
  27 #include "llvm/Support/Debug.h"
  28 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  29 #include "llvm/Transforms/Utils/Local.h"
  30 #include "llvm/Transforms/Utils/SSAUpdater.h"
  31 #include "llvm/Transforms/Utils/ValueMapper.h"
  32 using namespace llvm;
  33
  34 #define MAX_HEADER_SIZE 16
  35
  36 STATISTIC(NumRotated, "Number of loops rotated");
  37 namespace {
  38
  39   class LoopRotate : public LoopPass {
  40   public:
  41     static char ID; // Pass ID, replacement for typeid
  42     LoopRotate() : LoopPass(ID) {
  43       initializeLoopRotatePass(*PassRegistry::getPassRegistry());
  44     }
  45
  46     // LCSSA form makes instruction renaming easier.
  47     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  48       AU.addPreserved<DominatorTree>();
  49       AU.addRequired<LoopInfo>();
  50       AU.addPreserved<LoopInfo>();
  51       AU.addRequiredID(LoopSimplifyID);
  52       AU.addPreservedID(LoopSimplifyID);
  53       AU.addRequiredID(LCSSAID);
  54       AU.addPreservedID(LCSSAID);
  55       AU.addPreserved<ScalarEvolution>();
  56       AU.addRequired<TargetTransformInfo>();
  57     }
  58
  59     bool runOnLoop(Loop *L, LPPassManager &LPM);
  60     bool simplifyLoopLatch(Loop *L);
  61     bool rotateLoop(Loop *L, bool SimplifiedLatch);
  62
  63   private:
  64     LoopInfo *LI;
  65     const TargetTransformInfo *TTI;
  66   };
  67 }
  68
  69 char LoopRotate::ID = 0;
  70 INITIALIZE_PASS_BEGIN(LoopRotate, "loop-rotate", "Rotate Loops", false, false)
  71 INITIALIZE_AG_DEPENDENCY(TargetTransformInfo)
  72 INITIALIZE_PASS_DEPENDENCY(LoopInfo)
  73 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
  74 INITIALIZE_PASS_DEPENDENCY(LCSSA)
  75 INITIALIZE_PASS_END(LoopRotate, "loop-rotate", "Rotate Loops", false, false)
  76
  77 Pass *llvm::createLoopRotatePass() { return new LoopRotate(); }
  78
  79 /// Rotate Loop L as many times as possible. Return true if
  80 /// the loop is rotated at least once.
  81 bool LoopRotate::runOnLoop(Loop *L, LPPassManager &LPM) {
  82   LI = &getAnalysis<LoopInfo>();
  83   TTI = &getAnalysis<TargetTransformInfo>();
  84
  85   // Simplify the loop latch before attempting to rotate the header
  86   // upward. Rotation may not be needed if the loop tail can be folded into the
  87   // loop exit.
  88   bool SimplifiedLatch = simplifyLoopLatch(L);
  89
  90   // One loop can be rotated multiple times.
  91   bool MadeChange = false;
  92   while (rotateLoop(L, SimplifiedLatch)) {
  93     MadeChange = true;
  94     SimplifiedLatch = false;
  95   }
  96   return MadeChange;
  97 }
  98
  99 /// RewriteUsesOfClonedInstructions - We just cloned the instructions from the
 100 /// old header into the preheader.  If there were uses of the values produced by
 101 /// these instruction that were outside of the loop, we have to insert PHI nodes
 102 /// to merge the two values.  Do this now.
 103 static void RewriteUsesOfClonedInstructions(BasicBlock *OrigHeader,
 104                                             BasicBlock *OrigPreheader,
 105                                             ValueToValueMapTy &ValueMap) {
 106   // Remove PHI node entries that are no longer live.
 107   BasicBlock::iterator I, E = OrigHeader->end();
 108   for (I = OrigHeader->begin(); PHINode *PN = dyn_cast<PHINode>(I); ++I)
 109     PN->removeIncomingValue(PN->getBasicBlockIndex(OrigPreheader));
 110
 111   // Now fix up users of the instructions in OrigHeader, inserting PHI nodes
 112   // as necessary.
 113   SSAUpdater SSA;
 114   for (I = OrigHeader->begin(); I != E; ++I) {
 115     Value *OrigHeaderVal = I;
 116
 117     // If there are no uses of the value (e.g. because it returns void), there
 118     // is nothing to rewrite.
 119     if (OrigHeaderVal->use_empty())
 120       continue;
 121
 122     Value *OrigPreHeaderVal = ValueMap[OrigHeaderVal];
 123
 124     // The value now exits in two versions: the initial value in the preheader
 125     // and the loop "next" value in the original header.
 126     SSA.Initialize(OrigHeaderVal->getType(), OrigHeaderVal->getName());
 127     SSA.AddAvailableValue(OrigHeader, OrigHeaderVal);
 128     SSA.AddAvailableValue(OrigPreheader, OrigPreHeaderVal);
 129
 130     // Visit each use of the OrigHeader instruction.
 131     for (Value::use_iterator UI = OrigHeaderVal->use_begin(),
 132          UE = OrigHeaderVal->use_end(); UI != UE; ) {
 133       // Grab the use before incrementing the iterator.
 134       Use &U = UI.getUse();
 135
 136       // Increment the iterator before removing the use from the list.
 137       ++UI;
 138
 139       // SSAUpdater can't handle a non-PHI use in the same block as an
 140       // earlier def. We can easily handle those cases manually.
 141       Instruction *UserInst = cast<Instruction>(U.getUser());
 142       if (!isa<PHINode>(UserInst)) {
 143         BasicBlock *UserBB = UserInst->getParent();
 144
 145         // The original users in the OrigHeader are already using the
 146         // original definitions.
 147         if (UserBB == OrigHeader)
 148           continue;
 149
 150         // Users in the OrigPreHeader need to use the value to which the
 151         // original definitions are mapped.
 152         if (UserBB == OrigPreheader) {
 153           U = OrigPreHeaderVal;
 154           continue;
 155         }
 156       }
 157
 158       // Anything else can be handled by SSAUpdater.
 159       SSA.RewriteUse(U);
 160     }
 161   }
 162 }
 163
 164 /// Determine whether the instructions in this range my be safely and cheaply
 165 /// speculated. This is not an important enough situation to develop complex
 166 /// heuristics. We handle a single arithmetic instruction along with any type
 167 /// conversions.
 168 static bool shouldSpeculateInstrs(BasicBlock::iterator Begin,
 169                                   BasicBlock::iterator End) {
 170   bool seenIncrement = false;
 171   for (BasicBlock::iterator I = Begin; I != End; ++I) {
 172
 173     if (!isSafeToSpeculativelyExecute(I))
 174       return false;
 175
 176     if (isa<DbgInfoIntrinsic>(I))
 177       continue;
 178
 179     switch (I->getOpcode()) {
 180     default:
 181       return false;
 182     case Instruction::GetElementPtr:
 183       // GEPs are cheap if all indices are constant.
 184       if (!cast<GEPOperator>(I)->hasAllConstantIndices())
 185         return false;
 186       // fall-thru to increment case
 187     case Instruction::Add:
 188     case Instruction::Sub:
 189     case Instruction::And:
 190     case Instruction::Or:
 191     case Instruction::Xor:
 192     case Instruction::Shl:
 193     case Instruction::LShr:
 194     case Instruction::AShr:
 195       if (seenIncrement)
 196         return false;
 197       seenIncrement = true;
 198       break;
 199     case Instruction::Trunc:
 200     case Instruction::ZExt:
 201     case Instruction::SExt:
 202       // ignore type conversions
 203       break;
 204     }
 205   }
 206   return true;
 207 }
 208
 209 /// Fold the loop tail into the loop exit by speculating the loop tail
 210 /// instructions. Typically, this is a single post-increment. In the case of a
 211 /// simple 2-block loop, hoisting the increment can be much better than
 212 /// duplicating the entire loop header. In the cast of loops with early exits,
 213 /// rotation will not work anyway, but simplifyLoopLatch will put the loop in
 214 /// canonical form so downstream passes can handle it.
 215 ///
 216 /// I don't believe this invalidates SCEV.
 217 bool LoopRotate::simplifyLoopLatch(Loop *L) {
 218   BasicBlock *Latch = L->getLoopLatch();
 219   if (!Latch || Latch->hasAddressTaken())
 220     return false;
 221
 222   BranchInst *Jmp = dyn_cast<BranchInst>(Latch->getTerminator());
 223   if (!Jmp || !Jmp->isUnconditional())
 224     return false;
 225
 226   BasicBlock *LastExit = Latch->getSinglePredecessor();
 227   if (!LastExit || !L->isLoopExiting(LastExit))
 228     return false;
 229
 230   BranchInst *BI = dyn_cast<BranchInst>(LastExit->getTerminator());
 231   if (!BI)
 232     return false;
 233
 234   if (!shouldSpeculateInstrs(Latch->begin(), Jmp))
 235     return false;
 236
 237   DEBUG(dbgs() << "Folding loop latch " << Latch->getName() << " into "
 238         << LastExit->getName() << "\n");
 239
 240   // Hoist the instructions from Latch into LastExit.
 241   LastExit->getInstList().splice(BI, Latch->getInstList(), Latch->begin(), Jmp);
 242
 243   unsigned FallThruPath = BI->getSuccessor(0) == Latch ? 0 : 1;
 244   BasicBlock *Header = Jmp->getSuccessor(0);
 245   assert(Header == L->getHeader() && "expected a backward branch");
 246
 247   // Remove Latch from the CFG so that LastExit becomes the new Latch.
 248   BI->setSuccessor(FallThruPath, Header);
 249   Latch->replaceSuccessorsPhiUsesWith(LastExit);
 250   Jmp->eraseFromParent();
 251
 252   // Nuke the Latch block.
 253   assert(Latch->empty() && "unable to evacuate Latch");
 254   LI->removeBlock(Latch);
 255   if (DominatorTree *DT = getAnalysisIfAvailable<DominatorTree>())
 256     DT->eraseNode(Latch);
 257   Latch->eraseFromParent();
 258   return true;
 259 }
 260
 261 /// Rotate loop LP. Return true if the loop is rotated.
 262 ///
 263 /// \param SimplifiedLatch is true if the latch was just folded into the final
 264 /// loop exit. In this case we may want to rotate even though the new latch is
 265 /// now an exiting branch. This rotation would have happened had the latch not
 266 /// been simplified. However, if SimplifiedLatch is false, then we avoid
 267 /// rotating loops in which the latch exits to avoid excessive or endless
 268 /// rotation. LoopRotate should be repeatable and converge to a canonical
 269 /// form. This property is satisfied because simplifying the loop latch can only
 270 /// happen once across multiple invocations of the LoopRotate pass.
 271 bool LoopRotate::rotateLoop(Loop *L, bool SimplifiedLatch) {
 272   // If the loop has only one block then there is not much to rotate.
 273   if (L->getBlocks().size() == 1)
 274     return false;
 275
 276   BasicBlock *OrigHeader = L->getHeader();
 277   BasicBlock *OrigLatch = L->getLoopLatch();
 278
 279   BranchInst *BI = dyn_cast<BranchInst>(OrigHeader->getTerminator());
 280   if (BI == 0 || BI->isUnconditional())
 281     return false;
 282
 283   // If the loop header is not one of the loop exiting blocks then
 284   // either this loop is already rotated or it is not
 285   // suitable for loop rotation transformations.
 286   if (!L->isLoopExiting(OrigHeader))
 287     return false;
 288
 289   // If the loop latch already contains a branch that leaves the loop then the
 290   // loop is already rotated.
 291   if (OrigLatch == 0)
 292     return false;
 293
 294   // Rotate if either the loop latch does *not* exit the loop, or if the loop
 295   // latch was just simplified.
 296   if (L->isLoopExiting(OrigLatch) && !SimplifiedLatch)
 297     return false;
 298
 299   // Check size of original header and reject loop if it is very big or we can't
 300   // duplicate blocks inside it.
 301   {
 302     CodeMetrics Metrics;
 303     Metrics.analyzeBasicBlock(OrigHeader, *TTI);
 304     if (Metrics.notDuplicatable) {
 305       DEBUG(dbgs() << "LoopRotation: NOT rotating - contains non-duplicatable"
 306             << " instructions: "; L->dump());
 307       return false;
 308     }
 309     if (Metrics.NumInsts > MAX_HEADER_SIZE)
 310       return false;
 311   }
 312
 313   // Now, this loop is suitable for rotation.
 314   BasicBlock *OrigPreheader = L->getLoopPreheader();
 315
 316   // If the loop could not be converted to canonical form, it must have an
 317   // indirectbr in it, just give up.
 318   if (OrigPreheader == 0)
 319     return false;
 320
 321   // Anything ScalarEvolution may know about this loop or the PHI nodes
 322   // in its header will soon be invalidated.
 323   if (ScalarEvolution *SE = getAnalysisIfAvailable<ScalarEvolution>())
 324     SE->forgetLoop(L);
 325
 326   DEBUG(dbgs() << "LoopRotation: rotating "; L->dump());
 327
 328   // Find new Loop header. NewHeader is a Header's one and only successor
 329   // that is inside loop.  Header's other successor is outside the
 330   // loop.  Otherwise loop is not suitable for rotation.
 331   BasicBlock *Exit = BI->getSuccessor(0);
 332   BasicBlock *NewHeader = BI->getSuccessor(1);
 333   if (L->contains(Exit))
 334     std::swap(Exit, NewHeader);
 335   assert(NewHeader && "Unable to determine new loop header");
 336   assert(L->contains(NewHeader) && !L->contains(Exit) &&
 337          "Unable to determine loop header and exit blocks");
 338
 339   // This code assumes that the new header has exactly one predecessor.
 340   // Remove any single-entry PHI nodes in it.
 341   assert(NewHeader->getSinglePredecessor() &&
 342          "New header doesn't have one pred!");
 343   FoldSingleEntryPHINodes(NewHeader);
 344
 345   // Begin by walking OrigHeader and populating ValueMap with an entry for
 346   // each Instruction.
 347   BasicBlock::iterator I = OrigHeader->begin(), E = OrigHeader->end();
 348   ValueToValueMapTy ValueMap;
 349
 350   // For PHI nodes, the value available in OldPreHeader is just the
 351   // incoming value from OldPreHeader.
 352   for (; PHINode *PN = dyn_cast<PHINode>(I); ++I)
 353     ValueMap[PN] = PN->getIncomingValueForBlock(OrigPreheader);
 354
 355   // For the rest of the instructions, either hoist to the OrigPreheader if
 356   // possible or create a clone in the OldPreHeader if not.
 357   TerminatorInst *LoopEntryBranch = OrigPreheader->getTerminator();
 358   while (I != E) {
 359     Instruction *Inst = I++;
 360
 361     // If the instruction's operands are invariant and it doesn't read or write
 362     // memory, then it is safe to hoist.  Doing this doesn't change the order of
 363     // execution in the preheader, but does prevent the instruction from
 364     // executing in each iteration of the loop.  This means it is safe to hoist
 365     // something that might trap, but isn't safe to hoist something that reads
 366     // memory (without proving that the loop doesn't write).
 367     if (L->hasLoopInvariantOperands(Inst) &&
 368         !Inst->mayReadFromMemory() && !Inst->mayWriteToMemory() &&
 369         !isa<TerminatorInst>(Inst) && !isa<DbgInfoIntrinsic>(Inst) &&
 370         !isa<AllocaInst>(Inst)) {
 371       Inst->moveBefore(LoopEntryBranch);
 372       continue;
 373     }
 374
 375     // Otherwise, create a duplicate of the instruction.
 376     Instruction *C = Inst->clone();
 377
 378     // Eagerly remap the operands of the instruction.
 379     RemapInstruction(C, ValueMap,
 380                      RF_NoModuleLevelChanges|RF_IgnoreMissingEntries);
 381
 382     // With the operands remapped, see if the instruction constant folds or is
 383     // otherwise simplifyable.  This commonly occurs because the entry from PHI
 384     // nodes allows icmps and other instructions to fold.
 385     Value *V = SimplifyInstruction(C);
 386     if (V && LI->replacementPreservesLCSSAForm(C, V)) {
 387       // If so, then delete the temporary instruction and stick the folded value
 388       // in the map.
 389       delete C;
 390       ValueMap[Inst] = V;
 391     } else {
 392       // Otherwise, stick the new instruction into the new block!
 393       C->setName(Inst->getName());
 394       C->insertBefore(LoopEntryBranch);
 395       ValueMap[Inst] = C;
 396     }
 397   }
 398
 399   // Along with all the other instructions, we just cloned OrigHeader's
 400   // terminator into OrigPreHeader. Fix up the PHI nodes in each of OrigHeader's
 401   // successors by duplicating their incoming values for OrigHeader.
 402   TerminatorInst *TI = OrigHeader->getTerminator();
 403   for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i)
 404     for (BasicBlock::iterator BI = TI->getSuccessor(i)->begin();
 405          PHINode *PN = dyn_cast<PHINode>(BI); ++BI)
 406       PN->addIncoming(PN->getIncomingValueForBlock(OrigHeader), OrigPreheader);
 407
 408   // Now that OrigPreHeader has a clone of OrigHeader's terminator, remove
 409   // OrigPreHeader's old terminator (the original branch into the loop), and
 410   // remove the corresponding incoming values from the PHI nodes in OrigHeader.
 411   LoopEntryBranch->eraseFromParent();
 412
 413   // If there were any uses of instructions in the duplicated block outside the
 414   // loop, update them, inserting PHI nodes as required
 415   RewriteUsesOfClonedInstructions(OrigHeader, OrigPreheader, ValueMap);
 416
 417   // NewHeader is now the header of the loop.
 418   L->moveToHeader(NewHeader);
 419   assert(L->getHeader() == NewHeader && "Latch block is our new header");
 420
 421
 422   // At this point, we've finished our major CFG changes.  As part of cloning
 423   // the loop into the preheader we've simplified instructions and the
 424   // duplicated conditional branch may now be branching on a constant.  If it is
 425   // branching on a constant and if that constant means that we enter the loop,
 426   // then we fold away the cond branch to an uncond branch.  This simplifies the
 427   // loop in cases important for nested loops, and it also means we don't have
 428   // to split as many edges.
 429   BranchInst *PHBI = cast<BranchInst>(OrigPreheader->getTerminator());
 430   assert(PHBI->isConditional() && "Should be clone of BI condbr!");
 431   if (!isa<ConstantInt>(PHBI->getCondition()) ||
 432       PHBI->getSuccessor(cast<ConstantInt>(PHBI->getCondition())->isZero())
 433           != NewHeader) {
 434     // The conditional branch can't be folded, handle the general case.
 435     // Update DominatorTree to reflect the CFG change we just made.  Then split
 436     // edges as necessary to preserve LoopSimplify form.
 437     if (DominatorTree *DT = getAnalysisIfAvailable<DominatorTree>()) {
 438       // Everything that was dominated by the old loop header is now dominated
 439       // by the original loop preheader. Conceptually the header was merged
 440       // into the preheader, even though we reuse the actual block as a new
 441       // loop latch.
 442       DomTreeNode *OrigHeaderNode = DT->getNode(OrigHeader);
 443       SmallVector<DomTreeNode *, 8> HeaderChildren(OrigHeaderNode->begin(),
 444                                                    OrigHeaderNode->end());
 445       DomTreeNode *OrigPreheaderNode = DT->getNode(OrigPreheader);
 446       for (unsigned I = 0, E = HeaderChildren.size(); I != E; ++I)
 447         DT->changeImmediateDominator(HeaderChildren[I], OrigPreheaderNode);
 448
 449       assert(DT->getNode(Exit)->getIDom() == OrigPreheaderNode);
 450       assert(DT->getNode(NewHeader)->getIDom() == OrigPreheaderNode);
 451
 452       // Update OrigHeader to be dominated by the new header block.
 453       DT->changeImmediateDominator(OrigHeader, OrigLatch);
 454     }
 455
 456     // Right now OrigPreHeader has two successors, NewHeader and ExitBlock, and
 457     // thus is not a preheader anymore.
 458     // Split the edge to form a real preheader.
 459     BasicBlock *NewPH = SplitCriticalEdge(OrigPreheader, NewHeader, this);
 460     NewPH->setName(NewHeader->getName() + ".lr.ph");
 461
 462     // Preserve canonical loop form, which means that 'Exit' should have only
 463     // one predecessor.
 464     BasicBlock *ExitSplit = SplitCriticalEdge(L->getLoopLatch(), Exit, this);
 465     ExitSplit->moveBefore(Exit);
 466   } else {
 467     // We can fold the conditional branch in the preheader, this makes things
 468     // simpler. The first step is to remove the extra edge to the Exit block.
 469     Exit->removePredecessor(OrigPreheader, true /*preserve LCSSA*/);
 470     BranchInst *NewBI = BranchInst::Create(NewHeader, PHBI);
 471     NewBI->setDebugLoc(PHBI->getDebugLoc());
 472     PHBI->eraseFromParent();
 473
 474     // With our CFG finalized, update DomTree if it is available.
 475     if (DominatorTree *DT = getAnalysisIfAvailable<DominatorTree>()) {
 476       // Update OrigHeader to be dominated by the new header block.
 477       DT->changeImmediateDominator(NewHeader, OrigPreheader);
 478       DT->changeImmediateDominator(OrigHeader, OrigLatch);
 479
 480       // Brute force incremental dominator tree update. Call
 481       // findNearestCommonDominator on all CFG predecessors of each child of the
 482       // original header.
 483       DomTreeNode *OrigHeaderNode = DT->getNode(OrigHeader);
 484       SmallVector<DomTreeNode *, 8> HeaderChildren(OrigHeaderNode->begin(),
 485                                                    OrigHeaderNode->end());
 486       bool Changed;
 487       do {
 488         Changed = false;
 489         for (unsigned I = 0, E = HeaderChildren.size(); I != E; ++I) {
 490           DomTreeNode *Node = HeaderChildren[I];
 491           BasicBlock *BB = Node->getBlock();
 492
 493           pred_iterator PI = pred_begin(BB);
 494           BasicBlock *NearestDom = *PI;
 495           for (pred_iterator PE = pred_end(BB); PI != PE; ++PI)
 496             NearestDom = DT->findNearestCommonDominator(NearestDom, *PI);
 497
 498           // Remember if this changes the DomTree.
 499           if (Node->getIDom()->getBlock() != NearestDom) {
 500             DT->changeImmediateDominator(BB, NearestDom);
 501             Changed = true;
 502           }
 503         }
 504
 505       // If the dominator changed, this may have an effect on other
 506       // predecessors, continue until we reach a fixpoint.
 507       } while (Changed);
 508     }
 509   }
 510
 511   assert(L->getLoopPreheader() && "Invalid loop preheader after loop rotation");
 512   assert(L->getLoopLatch() && "Invalid loop latch after loop rotation");
 513
 514   // Now that the CFG and DomTree are in a consistent state again, try to merge
 515   // the OrigHeader block into OrigLatch.  This will succeed if they are
 516   // connected by an unconditional branch.  This is just a cleanup so the
 517   // emitted code isn't too gross in this common case.
 518   MergeBlockIntoPredecessor(OrigHeader, this);
 519
 520   DEBUG(dbgs() << "LoopRotation: into "; L->dump());
 521
 522   ++NumRotated;
 523   return true;
 524 }