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 "Support/DepthFirstIterator.h"
  14 #include <algorithm>
  15
  16 AnalysisID cfg::LoopInfo::ID(AnalysisID::create<cfg::LoopInfo>());
  17
  18 //===----------------------------------------------------------------------===//
  19 // cfg::Loop implementation
  20 //
  21 bool cfg::Loop::contains(BasicBlock *BB) const {
  22   return find(Blocks.begin(), Blocks.end(), BB) != Blocks.end();
  23 }
  24
  25 void cfg::LoopInfo::releaseMemory() {
  26   for (std::vector<Loop*>::iterator I = TopLevelLoops.begin(),
  27          E = TopLevelLoops.end(); I != E; ++I)
  28     delete *I;   // Delete all of the loops...
  29
  30   BBMap.clear();                             // Reset internal state of analysis
  31   TopLevelLoops.clear();
  32 }
  33
  34
  35 //===----------------------------------------------------------------------===//
  36 // cfg::LoopInfo implementation
  37 //
  38 bool cfg::LoopInfo::runOnFunction(Function *F) {
  39   releaseMemory();
  40   Calculate(getAnalysis<DominatorSet>());    // Update
  41   return false;
  42 }
  43
  44 void cfg::LoopInfo::Calculate(const DominatorSet &DS) {
  45   BasicBlock *RootNode = DS.getRoot();
  46
  47   for (df_iterator<BasicBlock*> NI = df_begin(RootNode),
  48          NE = df_end(RootNode); NI != NE; ++NI)
  49     if (Loop *L = ConsiderForLoop(*NI, DS))
  50       TopLevelLoops.push_back(L);
  51
  52   for (unsigned i = 0; i < TopLevelLoops.size(); ++i)
  53     TopLevelLoops[i]->setLoopDepth(1);
  54 }
  55
  56 void cfg::LoopInfo::getAnalysisUsage(AnalysisUsage &AU) const {
  57   AU.setPreservesAll();
  58   AU.addRequired(DominatorSet::ID);
  59   AU.addProvided(ID);
  60 }
  61
  62
  63 cfg::Loop *cfg::LoopInfo::ConsiderForLoop(BasicBlock *BB,
  64                                           const DominatorSet &DS) {
  65   if (BBMap.find(BB) != BBMap.end()) return 0;   // Havn't processed this node?
  66
  67   std::vector<BasicBlock *> TodoStack;
  68
  69   // Scan the predecessors of BB, checking to see if BB dominates any of
  70   // them.
  71   for (pred_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I)
  72     if (DS.dominates(BB, *I))   // If BB dominates it's predecessor...
  73       TodoStack.push_back(*I);
  74
  75   if (TodoStack.empty()) return 0;  // Doesn't dominate any predecessors...
  76
  77   // Create a new loop to represent this basic block...
  78   Loop *L = new Loop(BB);
  79   BBMap[BB] = L;
  80
  81   while (!TodoStack.empty()) {  // Process all the nodes in the loop
  82     BasicBlock *X = TodoStack.back();
  83     TodoStack.pop_back();
  84
  85     if (!L->contains(X)) {                  // As of yet unprocessed??
  86       L->Blocks.push_back(X);
  87
  88       // Add all of the predecessors of X to the end of the work stack...
  89       TodoStack.insert(TodoStack.end(), pred_begin(X), pred_end(X));
  90     }
  91   }
  92
  93   // Add the basic blocks that comprise this loop to the BBMap so that this
  94   // loop can be found for them.  Also check subsidary basic blocks to see if
  95   // they start subloops of their own.
  96   //
  97   for (std::vector<BasicBlock*>::reverse_iterator I = L->Blocks.rbegin(),
  98          E = L->Blocks.rend(); I != E; ++I) {
  99
 100     // Check to see if this block starts a new loop
 101     if (Loop *NewLoop = ConsiderForLoop(*I, DS)) {
 102       L->SubLoops.push_back(NewLoop);
 103       NewLoop->ParentLoop = L;
 104     }
 105
 106     if (BBMap.find(*I) == BBMap.end())
 107       BBMap.insert(std::make_pair(*I, L));
 108   }
 109
 110   return L;
 111 }