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/Function.h"
  17 #include "llvm/Analysis/LoopPass.h"
  18 #include "llvm/Analysis/DominanceFrontier.h"
  19 #include "llvm/Analysis/CodeMetrics.h"
  20 #include "llvm/Analysis/ScalarEvolution.h"
  21 #include "llvm/Transforms/Utils/Local.h"
  22 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  23 #include "llvm/Transforms/Utils/SSAUpdater.h"
  24 #include "llvm/Transforms/Utils/ValueMapper.h"
  25 #include "llvm/Support/CommandLine.h"
  26 #include "llvm/Support/Debug.h"
  27 #include "llvm/ADT/Statistic.h"
  28 using namespace llvm;
  29
  30 #define MAX_HEADER_SIZE 16
  31
  32 STATISTIC(NumRotated, "Number of loops rotated");
  33 namespace {
  34
  35   class LoopRotate : public LoopPass {
  36   public:
  37     static char ID; // Pass ID, replacement for typeid
  38     LoopRotate() : LoopPass(ID) {
  39       initializeLoopRotatePass(*PassRegistry::getPassRegistry());
  40     }
  41
  42     // Rotate Loop L as many times as possible. Return true if
  43     // loop is rotated at least once.
  44     bool runOnLoop(Loop *L, LPPassManager &LPM);
  45
  46     // LCSSA form makes instruction renaming easier.
  47     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  48       AU.addPreserved<DominatorTree>();
  49       AU.addPreserved<DominanceFrontier>();
  50       AU.addRequired<LoopInfo>();
  51       AU.addPreserved<LoopInfo>();
  52       AU.addRequiredID(LoopSimplifyID);
  53       AU.addPreservedID(LoopSimplifyID);
  54       AU.addRequiredID(LCSSAID);
  55       AU.addPreservedID(LCSSAID);
  56       AU.addPreserved<ScalarEvolution>();
  57     }
  58
  59     // Helper functions
  60
  61     /// Do actual work
  62     bool rotateLoop(Loop *L, LPPassManager &LPM);
  63
  64     /// Initialize local data
  65     void initialize();
  66
  67     /// After loop rotation, loop pre-header has multiple sucessors.
  68     /// Insert one forwarding basic block to ensure that loop pre-header
  69     /// has only one successor.
  70     void preserveCanonicalLoopForm(LPPassManager &LPM);
  71
  72   private:
  73     Loop *L;
  74     BasicBlock *OrigHeader;
  75     BasicBlock *OrigPreHeader;
  76     BasicBlock *OrigLatch;
  77     BasicBlock *NewHeader;
  78     BasicBlock *Exit;
  79     LPPassManager *LPM_Ptr;
  80   };
  81 }
  82
  83 char LoopRotate::ID = 0;
  84 INITIALIZE_PASS_BEGIN(LoopRotate, "loop-rotate", "Rotate Loops", false, false)
  85 INITIALIZE_PASS_DEPENDENCY(LoopInfo)
  86 INITIALIZE_PASS_DEPENDENCY(LoopSimplify)
  87 INITIALIZE_PASS_DEPENDENCY(LCSSA)
  88 INITIALIZE_PASS_END(LoopRotate, "loop-rotate", "Rotate Loops", false, false)
  89
  90 Pass *llvm::createLoopRotatePass() { return new LoopRotate(); }
  91
  92 /// Rotate Loop L as many times as possible. Return true if
  93 /// the loop is rotated at least once.
  94 bool LoopRotate::runOnLoop(Loop *Lp, LPPassManager &LPM) {
  95
  96   bool RotatedOneLoop = false;
  97   initialize();
  98   LPM_Ptr = &LPM;
  99
 100   // One loop can be rotated multiple times.
 101   while (rotateLoop(Lp,LPM)) {
 102     RotatedOneLoop = true;
 103     initialize();
 104   }
 105
 106   return RotatedOneLoop;
 107 }
 108
 109 /// Rotate loop LP. Return true if the loop is rotated.
 110 bool LoopRotate::rotateLoop(Loop *Lp, LPPassManager &LPM) {
 111   L = Lp;
 112
 113   OrigPreHeader = L->getLoopPreheader();
 114   if (!OrigPreHeader) return false;
 115
 116   OrigLatch = L->getLoopLatch();
 117   if (!OrigLatch) return false;
 118
 119   OrigHeader =  L->getHeader();
 120
 121   // If the loop has only one block then there is not much to rotate.
 122   if (L->getBlocks().size() == 1)
 123     return false;
 124
 125   // If the loop header is not one of the loop exiting blocks then
 126   // either this loop is already rotated or it is not
 127   // suitable for loop rotation transformations.
 128   if (!L->isLoopExiting(OrigHeader))
 129     return false;
 130
 131   BranchInst *BI = dyn_cast<BranchInst>(OrigHeader->getTerminator());
 132   if (!BI)
 133     return false;
 134   assert(BI->isConditional() && "Branch Instruction is not conditional");
 135
 136   // Updating PHInodes in loops with multiple exits adds complexity.
 137   // Keep it simple, and restrict loop rotation to loops with one exit only.
 138   // In future, lift this restriction and support for multiple exits if
 139   // required.
 140   SmallVector<BasicBlock*, 8> ExitBlocks;
 141   L->getExitBlocks(ExitBlocks);
 142   if (ExitBlocks.size() > 1)
 143     return false;
 144
 145   // Check size of original header and reject loop if it is very big.
 146   {
 147     CodeMetrics Metrics;
 148     Metrics.analyzeBasicBlock(OrigHeader);
 149     if (Metrics.NumInsts > MAX_HEADER_SIZE)
 150       return false;
 151   }
 152
 153   // Now, this loop is suitable for rotation.
 154
 155   // Anything ScalarEvolution may know about this loop or the PHI nodes
 156   // in its header will soon be invalidated.
 157   if (ScalarEvolution *SE = getAnalysisIfAvailable<ScalarEvolution>())
 158     SE->forgetLoop(L);
 159
 160   // Find new Loop header. NewHeader is a Header's one and only successor
 161   // that is inside loop.  Header's other successor is outside the
 162   // loop.  Otherwise loop is not suitable for rotation.
 163   Exit = BI->getSuccessor(0);
 164   NewHeader = BI->getSuccessor(1);
 165   if (L->contains(Exit))
 166     std::swap(Exit, NewHeader);
 167   assert(NewHeader && "Unable to determine new loop header");
 168   assert(L->contains(NewHeader) && !L->contains(Exit) &&
 169          "Unable to determine loop header and exit blocks");
 170
 171   // This code assumes that the new header has exactly one predecessor.
 172   // Remove any single-entry PHI nodes in it.
 173   assert(NewHeader->getSinglePredecessor() &&
 174          "New header doesn't have one pred!");
 175   FoldSingleEntryPHINodes(NewHeader);
 176
 177   // Begin by walking OrigHeader and populating ValueMap with an entry for
 178   // each Instruction.
 179   BasicBlock::iterator I = OrigHeader->begin(), E = OrigHeader->end();
 180   ValueToValueMapTy ValueMap;
 181
 182   // For PHI nodes, the value available in OldPreHeader is just the
 183   // incoming value from OldPreHeader.
 184   for (; PHINode *PN = dyn_cast<PHINode>(I); ++I)
 185     ValueMap[PN] = PN->getIncomingValue(PN->getBasicBlockIndex(OrigPreHeader));
 186
 187   // For the rest of the instructions, either hoist to the OrigPreheader if
 188   // possible or create a clone in the OldPreHeader if not.
 189   TerminatorInst *LoopEntryBranch = OrigPreHeader->getTerminator();
 190   while (I != E) {
 191     Instruction *Inst = I++;
 192
 193     // If the instruction's operands are invariant and it doesn't read or write
 194     // memory, then it is safe to hoist.  Doing this doesn't change the order of
 195     // execution in the preheader, but does prevent the instruction from
 196     // executing in each iteration of the loop.  This means it is safe to hoist
 197     // something that might trap, but isn't safe to hoist something that reads
 198     // memory (without proving that the loop doesn't write).
 199     if (L->hasLoopInvariantOperands(Inst) &&
 200         !Inst->mayReadFromMemory() && !Inst->mayWriteToMemory() &&
 201         !isa<TerminatorInst>(Inst)) {
 202       Inst->moveBefore(LoopEntryBranch);
 203       continue;
 204     }
 205
 206     // Otherwise, create a duplicate of the instruction.
 207     Instruction *C = Inst->clone();
 208     C->setName(Inst->getName());
 209     C->insertBefore(LoopEntryBranch);
 210     ValueMap[Inst] = C;
 211   }
 212
 213   // Along with all the other instructions, we just cloned OrigHeader's
 214   // terminator into OrigPreHeader. Fix up the PHI nodes in each of OrigHeader's
 215   // successors by duplicating their incoming values for OrigHeader.
 216   TerminatorInst *TI = OrigHeader->getTerminator();
 217   for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i)
 218     for (BasicBlock::iterator BI = TI->getSuccessor(i)->begin();
 219          PHINode *PN = dyn_cast<PHINode>(BI); ++BI)
 220       PN->addIncoming(PN->getIncomingValueForBlock(OrigHeader), OrigPreHeader);
 221
 222   // Now that OrigPreHeader has a clone of OrigHeader's terminator, remove
 223   // OrigPreHeader's old terminator (the original branch into the loop), and
 224   // remove the corresponding incoming values from the PHI nodes in OrigHeader.
 225   LoopEntryBranch->eraseFromParent();
 226   for (I = OrigHeader->begin(); PHINode *PN = dyn_cast<PHINode>(I); ++I)
 227     PN->removeIncomingValue(PN->getBasicBlockIndex(OrigPreHeader));
 228
 229   // Now fix up users of the instructions in OrigHeader, inserting PHI nodes
 230   // as necessary.
 231   SSAUpdater SSA;
 232   for (I = OrigHeader->begin(); I != E; ++I) {
 233     Value *OrigHeaderVal = I;
 234     Value *OrigPreHeaderVal = ValueMap[OrigHeaderVal];
 235
 236     // If there are no uses of the value (e.g. because it returns void), there
 237     // is nothing to rewrite.
 238     if (OrigHeaderVal->use_empty() && OrigPreHeaderVal->use_empty())
 239       continue;
 240
 241     // The value now exits in two versions: the initial value in the preheader
 242     // and the loop "next" value in the original header.
 243     SSA.Initialize(OrigHeaderVal->getType(), OrigHeaderVal->getName());
 244     SSA.AddAvailableValue(OrigHeader, OrigHeaderVal);
 245     SSA.AddAvailableValue(OrigPreHeader, OrigPreHeaderVal);
 246
 247     // Visit each use of the OrigHeader instruction.
 248     for (Value::use_iterator UI = OrigHeaderVal->use_begin(),
 249          UE = OrigHeaderVal->use_end(); UI != UE; ) {
 250       // Grab the use before incrementing the iterator.
 251       Use &U = UI.getUse();
 252
 253       // Increment the iterator before removing the use from the list.
 254       ++UI;
 255
 256       // SSAUpdater can't handle a non-PHI use in the same block as an
 257       // earlier def. We can easily handle those cases manually.
 258       Instruction *UserInst = cast<Instruction>(U.getUser());
 259       if (!isa<PHINode>(UserInst)) {
 260         BasicBlock *UserBB = UserInst->getParent();
 261
 262         // The original users in the OrigHeader are already using the
 263         // original definitions.
 264         if (UserBB == OrigHeader)
 265           continue;
 266
 267         // Users in the OrigPreHeader need to use the value to which the
 268         // original definitions are mapped.
 269         if (UserBB == OrigPreHeader) {
 270           U = OrigPreHeaderVal;
 271           continue;
 272         }
 273       }
 274
 275       // Anything else can be handled by SSAUpdater.
 276       SSA.RewriteUse(U);
 277     }
 278   }
 279
 280   // NewHeader is now the header of the loop.
 281   L->moveToHeader(NewHeader);
 282
 283   // Move the original header to the bottom of the loop, where it now more
 284   // naturally belongs. This isn't necessary for correctness, and CodeGen can
 285   // usually reorder blocks on its own to fix things like this up, but it's
 286   // still nice to keep the IR readable.
 287   //
 288   // The original header should have only one predecessor at this point, since
 289   // we checked that the loop had a proper preheader and unique backedge before
 290   // we started.
 291   assert(OrigHeader->getSinglePredecessor() &&
 292          "Original loop header has too many predecessors after loop rotation!");
 293   OrigHeader->moveAfter(OrigHeader->getSinglePredecessor());
 294
 295   // Also, since this original header only has one predecessor, zap its
 296   // PHI nodes, which are now trivial.
 297   FoldSingleEntryPHINodes(OrigHeader);
 298
 299   // TODO: We could just go ahead and merge OrigHeader into its predecessor
 300   // at this point, if we don't mind updating dominator info.
 301
 302   // Establish a new preheader, update dominators, etc.
 303   preserveCanonicalLoopForm(LPM);
 304
 305   ++NumRotated;
 306   return true;
 307 }
 308
 309 /// Initialize local data
 310 void LoopRotate::initialize() {
 311   L = NULL;
 312   OrigHeader = NULL;
 313   OrigPreHeader = NULL;
 314   NewHeader = NULL;
 315   Exit = NULL;
 316 }
 317
 318 /// After loop rotation, loop pre-header has multiple sucessors.
 319 /// Insert one forwarding basic block to ensure that loop pre-header
 320 /// has only one successor.
 321 void LoopRotate::preserveCanonicalLoopForm(LPPassManager &LPM) {
 322
 323   // Right now original pre-header has two successors, new header and
 324   // exit block. Insert new block between original pre-header and
 325   // new header such that loop's new pre-header has only one successor.
 326   BasicBlock *NewPreHeader = BasicBlock::Create(OrigHeader->getContext(),
 327                                                 "bb.nph",
 328                                                 OrigHeader->getParent(),
 329                                                 NewHeader);
 330   LoopInfo &LI = getAnalysis<LoopInfo>();
 331   if (Loop *PL = LI.getLoopFor(OrigPreHeader))
 332     PL->addBasicBlockToLoop(NewPreHeader, LI.getBase());
 333   BranchInst::Create(NewHeader, NewPreHeader);
 334
 335   BranchInst *OrigPH_BI = cast<BranchInst>(OrigPreHeader->getTerminator());
 336   if (OrigPH_BI->getSuccessor(0) == NewHeader)
 337     OrigPH_BI->setSuccessor(0, NewPreHeader);
 338   else {
 339     assert(OrigPH_BI->getSuccessor(1) == NewHeader &&
 340            "Unexpected original pre-header terminator");
 341     OrigPH_BI->setSuccessor(1, NewPreHeader);
 342   }
 343
 344   PHINode *PN;
 345   for (BasicBlock::iterator I = NewHeader->begin();
 346        (PN = dyn_cast<PHINode>(I)); ++I) {
 347     int index = PN->getBasicBlockIndex(OrigPreHeader);
 348     assert(index != -1 && "Expected incoming value from Original PreHeader");
 349     PN->setIncomingBlock(index, NewPreHeader);
 350     assert(PN->getBasicBlockIndex(OrigPreHeader) == -1 &&
 351            "Expected only one incoming value from Original PreHeader");
 352   }
 353
 354   if (DominatorTree *DT = getAnalysisIfAvailable<DominatorTree>()) {
 355     DT->addNewBlock(NewPreHeader, OrigPreHeader);
 356     DT->changeImmediateDominator(L->getHeader(), NewPreHeader);
 357     DT->changeImmediateDominator(Exit, OrigPreHeader);
 358     for (Loop::block_iterator BI = L->block_begin(), BE = L->block_end();
 359          BI != BE; ++BI) {
 360       BasicBlock *B = *BI;
 361       if (L->getHeader() != B) {
 362         DomTreeNode *Node = DT->getNode(B);
 363         if (Node && Node->getBlock() == OrigHeader)
 364           DT->changeImmediateDominator(*BI, L->getHeader());
 365       }
 366     }
 367     DT->changeImmediateDominator(OrigHeader, OrigLatch);
 368   }
 369
 370   if (DominanceFrontier *DF = getAnalysisIfAvailable<DominanceFrontier>()) {
 371     // New Preheader's dominance frontier is Exit block.
 372     DominanceFrontier::DomSetType NewPHSet;
 373     NewPHSet.insert(Exit);
 374     DF->addBasicBlock(NewPreHeader, NewPHSet);
 375
 376     // New Header's dominance frontier now includes itself and Exit block
 377     DominanceFrontier::iterator HeadI = DF->find(L->getHeader());
 378     if (HeadI != DF->end()) {
 379       DominanceFrontier::DomSetType & HeaderSet = HeadI->second;
 380       HeaderSet.clear();
 381       HeaderSet.insert(L->getHeader());
 382       HeaderSet.insert(Exit);
 383     } else {
 384       DominanceFrontier::DomSetType HeaderSet;
 385       HeaderSet.insert(L->getHeader());
 386       HeaderSet.insert(Exit);
 387       DF->addBasicBlock(L->getHeader(), HeaderSet);
 388     }
 389
 390     // Original header (new Loop Latch)'s dominance frontier is Exit.
 391     DominanceFrontier::iterator LatchI = DF->find(L->getLoopLatch());
 392     if (LatchI != DF->end()) {
 393       DominanceFrontier::DomSetType &LatchSet = LatchI->second;
 394       LatchSet = LatchI->second;
 395       LatchSet.clear();
 396       LatchSet.insert(Exit);
 397     } else {
 398       DominanceFrontier::DomSetType LatchSet;
 399       LatchSet.insert(Exit);
 400       DF->addBasicBlock(L->getHeader(), LatchSet);
 401     }
 402
 403     // If a loop block dominates new loop latch then add to its frontiers
 404     // new header and Exit and remove new latch (which is equal to original
 405     // header).
 406     BasicBlock *NewLatch = L->getLoopLatch();
 407
 408     assert(NewLatch == OrigHeader && "NewLatch is inequal to OrigHeader");
 409
 410     if (DominatorTree *DT = getAnalysisIfAvailable<DominatorTree>()) {
 411       for (Loop::block_iterator BI = L->block_begin(), BE = L->block_end();
 412            BI != BE; ++BI) {
 413         BasicBlock *B = *BI;
 414         if (DT->dominates(B, NewLatch)) {
 415           DominanceFrontier::iterator BDFI = DF->find(B);
 416           if (BDFI != DF->end()) {
 417             DominanceFrontier::DomSetType &BSet = BDFI->second;
 418             BSet.erase(NewLatch);
 419             BSet.insert(L->getHeader());
 420             BSet.insert(Exit);
 421           } else {
 422             DominanceFrontier::DomSetType BSet;
 423             BSet.insert(L->getHeader());
 424             BSet.insert(Exit);
 425             DF->addBasicBlock(B, BSet);
 426           }
 427         }
 428       }
 429     }
 430   }
 431
 432   // Preserve canonical loop form, which means Exit block should
 433   // have only one predecessor.
 434   SplitEdge(L->getLoopLatch(), Exit, this);
 435
 436   assert(NewHeader && L->getHeader() == NewHeader &&
 437          "Invalid loop header after loop rotation");
 438   assert(NewPreHeader && L->getLoopPreheader() == NewPreHeader &&
 439          "Invalid loop preheader after loop rotation");
 440   assert(L->getLoopLatch() &&
 441          "Invalid loop latch after loop rotation");
 442 }