1 //===- LoopInfo.cpp - Natural Loop Calculator -------------------------------=//
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.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/Analysis/LoopInfo.h"
11 #include "llvm/Analysis/Dominators.h"
12 #include "llvm/Support/CFG.h"
13 #include "Support/DepthFirstIterator.h"
16 AnalysisID cfg::LoopInfo::ID(AnalysisID::create<cfg::LoopInfo>());
18 //===----------------------------------------------------------------------===//
19 // cfg::Loop implementation
21 bool cfg::Loop::contains(const BasicBlock *BB) const {
22 return find(Blocks.begin(), Blocks.end(), BB) != Blocks.end();
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...
30 BBMap.clear(); // Reset internal state of analysis
31 TopLevelLoops.clear();
35 //===----------------------------------------------------------------------===//
36 // cfg::LoopInfo implementation
38 bool cfg::LoopInfo::runOnMethod(Function *F) {
40 Calculate(getAnalysis<DominatorSet>()); // Update
44 void cfg::LoopInfo::Calculate(const DominatorSet &DS) {
45 const BasicBlock *RootNode = DS.getRoot();
47 for (df_iterator<const 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);
52 for (unsigned i = 0; i < TopLevelLoops.size(); ++i)
53 TopLevelLoops[i]->setLoopDepth(1);
56 void cfg::LoopInfo::getAnalysisUsageInfo(Pass::AnalysisSet &Required,
57 Pass::AnalysisSet &Destroyed,
58 Pass::AnalysisSet &Provided) {
59 Required.push_back(DominatorSet::ID);
60 Provided.push_back(ID);
64 cfg::Loop *cfg::LoopInfo::ConsiderForLoop(const BasicBlock *BB,
65 const DominatorSet &DS) {
66 if (BBMap.find(BB) != BBMap.end()) return 0; // Havn't processed this node?
68 std::vector<const BasicBlock *> TodoStack;
70 // Scan the predecessors of BB, checking to see if BB dominates any of
72 for (pred_const_iterator I = pred_begin(BB), E = pred_end(BB); I != E; ++I)
73 if (DS.dominates(BB, *I)) // If BB dominates it's predecessor...
74 TodoStack.push_back(*I);
76 if (TodoStack.empty()) return 0; // Doesn't dominate any predecessors...
78 // Create a new loop to represent this basic block...
79 Loop *L = new Loop(BB);
82 while (!TodoStack.empty()) { // Process all the nodes in the loop
83 const BasicBlock *X = TodoStack.back();
86 if (!L->contains(X)) { // As of yet unprocessed??
87 L->Blocks.push_back(X);
89 // Add all of the predecessors of X to the end of the work stack...
90 TodoStack.insert(TodoStack.end(), pred_begin(X), pred_end(X));
94 // Add the basic blocks that comprise this loop to the BBMap so that this
95 // loop can be found for them. Also check subsidary basic blocks to see if
96 // they start subloops of their own.
98 for (std::vector<const BasicBlock*>::reverse_iterator I = L->Blocks.rbegin(),
99 E = L->Blocks.rend(); I != E; ++I) {
101 // Check to see if this block starts a new loop
102 if (Loop *NewLoop = ConsiderForLoop(*I, DS)) {
103 L->SubLoops.push_back(NewLoop);
104 NewLoop->ParentLoop = L;
107 if (BBMap.find(*I) == BBMap.end())
108 BBMap.insert(std::make_pair(*I, L));