1 //===- llvm/Analysis/LoopInfo.h - Natural Loop Calculator --------*- C++ -*--=//
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 #ifndef LLVM_ANALYSIS_LOOP_INFO_H
11 #define LLVM_ANALYSIS_LOOP_INFO_H
13 #include "llvm/Pass.h"
20 //===----------------------------------------------------------------------===//
21 // Loop class - Instances of this class are used to represent loops that are
22 // detected in the flow graph
26 std::vector<const BasicBlock *> Blocks; // First entry is the header node
27 std::vector<Loop*> SubLoops; // Loops contained entirely within this one
28 unsigned LoopDepth; // Nesting depth of this loop
30 Loop(const Loop &); // DO NOT IMPLEMENT
31 const Loop &operator=(const Loop &); // DO NOT IMPLEMENT
34 inline unsigned getLoopDepth() const { return LoopDepth; }
35 inline const BasicBlock *getHeader() const { return Blocks.front(); }
37 // contains - Return true of the specified basic block is in this loop
38 bool contains(const BasicBlock *BB) const;
40 // getSubLoops - Return the loops contained entirely within this loop
41 inline const std::vector<Loop*> &getSubLoops() const { return SubLoops; }
42 inline const std::vector<const BasicBlock*> &getBlocks() const {
47 friend class LoopInfo;
48 inline Loop(const BasicBlock *BB) { Blocks.push_back(BB); LoopDepth = 0; }
50 for (unsigned i = 0, e = SubLoops.size(); i != e; ++i)
54 void setLoopDepth(unsigned Level) {
56 for (unsigned i = 0, e = SubLoops.size(); i != e; ++i)
57 SubLoops[i]->setLoopDepth(Level+1);
63 //===----------------------------------------------------------------------===//
64 // LoopInfo - This class builds and contains all of the top level loop
65 // structures in the specified function.
67 class LoopInfo : public FunctionPass {
68 // BBMap - Mapping of basic blocks to the inner most loop they occur in
69 std::map<const BasicBlock *, Loop*> BBMap;
70 std::vector<Loop*> TopLevelLoops;
72 static AnalysisID ID; // cfg::LoopInfo Analysis ID
74 // LoopInfo ctor - Calculate the natural loop information for a CFG
75 LoopInfo(AnalysisID id) { assert(id == ID); }
76 ~LoopInfo() { releaseMemory(); }
78 const std::vector<Loop*> &getTopLevelLoops() const { return TopLevelLoops; }
80 // getLoopFor - Return the inner most loop that BB lives in. If a basic block
81 // is in no loop (for example the entry node), null is returned.
83 const Loop *getLoopFor(const BasicBlock *BB) const {
84 std::map<const BasicBlock *, Loop*>::const_iterator I = BBMap.find(BB);
85 return I != BBMap.end() ? I->second : 0;
87 inline const Loop *operator[](const BasicBlock *BB) const {
88 return getLoopFor(BB);
91 // getLoopDepth - Return the loop nesting level of the specified block...
92 unsigned getLoopDepth(const BasicBlock *BB) const {
93 const Loop *L = getLoopFor(BB);
94 return L ? L->getLoopDepth() : 0;
98 // isLoopHeader - True if the block is a loop header node
99 bool isLoopHeader(const BasicBlock *BB) const {
100 return getLoopFor(BB)->getHeader() == BB;
102 // isLoopEnd - True if block jumps to loop entry
103 bool isLoopEnd(const BasicBlock *BB) const;
104 // isLoopExit - True if block is the loop exit
105 bool isLoopExit(const BasicBlock *BB) const;
108 // runOnFunction - Pass framework implementation
109 virtual bool runOnFunction(Function *F);
111 virtual void releaseMemory();
113 // getAnalysisUsage - Provide loop info, require dominator set
115 virtual void getAnalysisUsage(AnalysisUsage &AU) const;
118 void Calculate(const DominatorSet &DS);
119 Loop *ConsiderForLoop(const BasicBlock *BB, const DominatorSet &DS);
122 } // End namespace cfg