lib/Analysis/LoopInfo.cpp

   1 //===- LoopInfo.cpp - Natural Loop Calculator -------------------------------=//
   2 //
   3 // This file defines the LoopInfo class that is used to identify natural loops
   4 // and determine the loop depth of various nodes of the CFG.  Note that the
   5 // loops identified may actually be several natural loops that share the same
   6 // header node... not just a single natural loop.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "llvm/Analysis/LoopInfo.h"
  11 #include "llvm/Analysis/Dominators.h"
  12 #include "llvm/Support/CFG.h"
  13 #include "llvm/Assembly/Writer.h"
  14 #include "Support/DepthFirstIterator.h"
  15 #include <algorithm>
  16
  17 static RegisterAnalysis<LoopInfo>
  18 X("loops", "Natural Loop Construction", true);
  19
  20 //===----------------------------------------------------------------------===//
  21 // Loop implementation
  22 //
  23 bool Loop::contains(const BasicBlock *BB) const {
  24   return find(Blocks.begin(), Blocks.end(), BB) != Blocks.end();
  25 }
  26
  27 bool Loop::isLoopExit(const BasicBlock *BB) const {
  28   for (BasicBlock::succ_const_iterator SI = succ_begin(BB), SE = succ_end(BB);
  29        SI != SE; ++SI) {
  30     if (! contains(*SI))
  31       return true;
  32   }
  33   return false;
  34 }
  35
  36 unsigned Loop::getNumBackEdges() const {
  37   unsigned numBackEdges = 0;
  38   BasicBlock *header = Blocks.front();
  39
  40   for (std::vector<BasicBlock*>::const_iterator I = Blocks.begin(),
  41          E = Blocks.end(); I != E; ++I) {
  42     for (BasicBlock::succ_iterator SI = succ_begin(*I), SE = succ_end(*I);
  43          SI != SE; ++SI)
  44       if (header == *SI)
  45         ++numBackEdges;
  46   }
  47   return numBackEdges;
  48 }
  49
  50 void Loop::print(std::ostream &OS) const {
  51   OS << std::string(getLoopDepth()*2, ' ') << "Loop Containing: ";
  52
  53   for (unsigned i = 0; i < getBlocks().size(); ++i) {
  54     if (i) OS << ",";
  55     WriteAsOperand(OS, (const Value*)getBlocks()[i]);
  56   }
  57   OS << "\n";
  58
  59   for (unsigned i = 0, e = getSubLoops().size(); i != e; ++i)
  60     getSubLoops()[i]->print(OS);
  61 }
  62
  63 //===----------------------------------------------------------------------===//
  64 // LoopInfo implementation
  65 //
  66 void LoopInfo::stub() {}
  67
  68 bool LoopInfo::runOnFunction(Function &) {
  69   releaseMemory();
  70   Calculate(getAnalysis<DominatorSet>());    // Update
  71   return false;
  72 }
  73
  74 void LoopInfo::releaseMemory() {
  75   for (std::vector<Loop*>::iterator I = TopLevelLoops.begin(),
  76          E = TopLevelLoops.end(); I != E; ++I)
  77     delete *I;   // Delete all of the loops...
  78
  79   BBMap.clear();                             // Reset internal state of analysis
  80   TopLevelLoops.clear();
  81 }
  82
  83
  84 void LoopInfo::Calculate(const DominatorSet &DS) {
  85   BasicBlock *RootNode = DS.getRoot();
  86
  87   for (df_iterator<BasicBlock*> NI = df_begin(RootNode),
  88          NE = df_end(RootNode); NI != NE; ++NI)
  89     if (Loop *L = ConsiderForLoop(*NI, DS))
  90       TopLevelLoops.push_back(L);
  91
  92   for (unsigned i = 0; i < TopLevelLoops.size(); ++i)
  93     TopLevelLoops[i]->setLoopDepth(1);
  94 }
  95
  96 void LoopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
  97   AU.setPreservesAll();
  98   AU.addRequired<DominatorSet>();
  99 }
 100
 101 void LoopInfo::print(std::ostream &OS) const {
 102   for (unsigned i = 0; i < TopLevelLoops.size(); ++i)
 103     TopLevelLoops[i]->print(OS);
 104 }
 105
 106 Loop *LoopInfo::ConsiderForLoop(BasicBlock *BB, const DominatorSet &DS) {
 107   if (BBMap.find(BB) != BBMap.end()) return 0;   // Haven't processed this node?
 108
 109   std::vector<BasicBlock *> TodoStack;
 110
 111   // Scan the predecessors of BB, checking to see if BB dominates any of
 112   // them.
 113   for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I)
 114     if (DS.dominates(BB, *I))   // If BB dominates it's predecessor...
 115       TodoStack.push_back(*I);
 116
 117   if (TodoStack.empty()) return 0;  // Doesn't dominate any predecessors...
 118
 119   // Create a new loop to represent this basic block...
 120   Loop *L = new Loop(BB);
 121   BBMap[BB] = L;
 122
 123   while (!TodoStack.empty()) {  // Process all the nodes in the loop
 124     BasicBlock *X = TodoStack.back();
 125     TodoStack.pop_back();
 126
 127     if (!L->contains(X)) {                  // As of yet unprocessed??
 128       L->Blocks.push_back(X);
 129
 130       // Add all of the predecessors of X to the end of the work stack...
 131       TodoStack.insert(TodoStack.end(), pred_begin(X), pred_end(X));
 132     }
 133   }
 134
 135   // Add the basic blocks that comprise this loop to the BBMap so that this
 136   // loop can be found for them.  Also check subsidary basic blocks to see if
 137   // they start subloops of their own.
 138   //
 139   for (std::vector<BasicBlock*>::reverse_iterator I = L->Blocks.rbegin(),
 140          E = L->Blocks.rend(); I != E; ++I)
 141
 142     // Check to see if this block starts a new loop
 143     if (*I != BB)
 144       if (Loop *NewLoop = ConsiderForLoop(*I, DS)) {
 145         L->SubLoops.push_back(NewLoop);
 146         NewLoop->ParentLoop = L;
 147       } else {
 148         std::map<BasicBlock*, Loop*>::iterator BBMI = BBMap.lower_bound(*I);
 149         if (BBMI == BBMap.end() || BBMI->first != *I) {  // Not in map yet...
 150           BBMap.insert(BBMI, std::make_pair(*I, L));
 151         } else {
 152           // If this is already in the BBMap then this means that we already
 153           // added a loop for it, but incorrectly added the loop to a higher
 154           // level loop instead of the current loop we are creating.  Fix this
 155           // now by moving the loop into the correct subloop.
 156           //
 157           Loop *SubLoop = BBMI->second;
 158           if (SubLoop->getHeader() == *I) { // Only do this once for the loop...
 159             Loop *OldSubLoopParent = SubLoop->getParentLoop();
 160             if (OldSubLoopParent != L) {
 161               // Remove SubLoop from OldSubLoopParent's list of subloops...
 162               std::vector<Loop*>::iterator I =
 163                 std::find(OldSubLoopParent->SubLoops.begin(),
 164                           OldSubLoopParent->SubLoops.end(), SubLoop);
 165               assert(I != OldSubLoopParent->SubLoops.end()
 166                      && "Loop parent doesn't contain loop?");
 167               OldSubLoopParent->SubLoops.erase(I);
 168               SubLoop->ParentLoop = L;
 169               L->SubLoops.push_back(SubLoop);
 170             }
 171           }
 172         }
 173       }
 174
 175   return L;
 176 }
 177
 178 /// getLoopPreheader - If there is a preheader for this loop, return it.  A
 179 /// loop has a preheader if there is only one edge to the header of the loop
 180 /// from outside of the loop.  If this is the case, the block branching to the
 181 /// header of the loop is the preheader node.  The "preheaders" pass can be
 182 /// "Required" to ensure that there is always a preheader node for every loop.
 183 ///
 184 /// This method returns null if there is no preheader for the loop (either
 185 /// because the loop is dead or because multiple blocks branch to the header
 186 /// node of this loop).
 187 ///
 188 BasicBlock *Loop::getLoopPreheader() const {
 189   // Keep track of nodes outside the loop branching to the header...
 190   BasicBlock *Out = 0;
 191
 192   // Loop over the predecessors of the header node...
 193   BasicBlock *Header = getHeader();
 194   for (pred_iterator PI = pred_begin(Header), PE = pred_end(Header);
 195        PI != PE; ++PI)
 196     if (!contains(*PI)) {     // If the block is not in the loop...
 197       if (Out && Out != *PI)
 198         return 0;             // Multiple predecessors outside the loop
 199       Out = *PI;
 200     }
 201
 202   // If there is exactly one preheader, return it.  If there was zero, then Out
 203   // is still null.
 204   return Out;
 205 }
 206
 207 /// addBasicBlockToLoop - This function is used by other analyses to update loop
 208 /// information.  NewBB is set to be a new member of the current loop.  Because
 209 /// of this, it is added as a member of all parent loops, and is added to the
 210 /// specified LoopInfo object as being in the current basic block.  It is not
 211 /// valid to replace the loop header with this method.
 212 ///
 213 void Loop::addBasicBlockToLoop(BasicBlock *NewBB, LoopInfo &LI) {
 214   assert(LI[getHeader()] == this && "Incorrect LI specified for this loop!");
 215   assert(NewBB && "Cannot add a null basic block to the loop!");
 216   assert(LI[NewBB] == 0 && "BasicBlock already in the loop!");
 217
 218   // Add the loop mapping to the LoopInfo object...
 219   LI.BBMap[NewBB] = this;
 220
 221   // Add the basic block to this loop and all parent loops...
 222   Loop *L = this;
 223   while (L) {
 224     L->Blocks.push_back(NewBB);
 225     L = L->getParentLoop();
 226   }
 227 }