//===- llvm/Analysis/LoopInfo.h - Natural Loop Calculator -------*- C++ -*-===//
-//
+//
// The LLVM Compiler Infrastructure
//
// This file was developed by the LLVM research group and is distributed under
// the University of Illinois Open Source License. See LICENSE.TXT for details.
-//
+//
//===----------------------------------------------------------------------===//
//
// This file defines the LoopInfo class that is used to identify natural loops
//
// This analysis calculates the nesting structure of loops in a function. For
// each natural loop identified, this analysis identifies natural loops
-// contained entirely within the function, the basic blocks the make up the
-// loop, the nesting depth of the loop, and the successor blocks of the loop.
+// contained entirely within the loop and the basic blocks the make up the loop.
+//
+// It can calculate on the fly various bits of information, for example:
//
-// It can calculate on the fly a variety of different bits of information, such
-// as whether there is a preheader for the loop, the number of back edges to the
-// header, and whether or not a particular block branches out of the loop.
+// * whether there is a preheader for the loop
+// * the number of back edges to the header
+// * whether or not a particular block branches out of the loop
+// * the successor blocks of the loop
+// * the loop depth
+// * the trip count
+// * etc...
//
//===----------------------------------------------------------------------===//
#define LLVM_ANALYSIS_LOOP_INFO_H
#include "llvm/Pass.h"
-#include "Support/GraphTraits.h"
-#include <set>
+#include "llvm/ADT/GraphTraits.h"
namespace llvm {
-class DominatorSet;
+struct ETForest;
class LoopInfo;
class PHINode;
class Instruction;
//===----------------------------------------------------------------------===//
-/// Loop class - Instances of this class are used to represent loops that are
-/// detected in the flow graph
+/// Loop class - Instances of this class are used to represent loops that are
+/// detected in the flow graph
///
class Loop {
Loop *ParentLoop;
std::vector<Loop*> SubLoops; // Loops contained entirely within this one
std::vector<BasicBlock*> Blocks; // First entry is the header node
- unsigned LoopDepth; // Nesting depth of this loop
Loop(const Loop &); // DO NOT IMPLEMENT
const Loop &operator=(const Loop &); // DO NOT IMPLEMENT
public:
/// Loop ctor - This creates an empty loop.
- Loop() : ParentLoop(0), LoopDepth(0) {
- }
+ Loop() : ParentLoop(0) {}
~Loop() {
for (unsigned i = 0, e = SubLoops.size(); i != e; ++i)
delete SubLoops[i];
}
- unsigned getLoopDepth() const { return LoopDepth; }
+ unsigned getLoopDepth() const {
+ unsigned D = 0;
+ for (const Loop *CurLoop = this; CurLoop; CurLoop = CurLoop->ParentLoop)
+ ++D;
+ return D;
+ }
BasicBlock *getHeader() const { return Blocks.front(); }
Loop *getParentLoop() const { return ParentLoop; }
/// iterator/begin/end - Return the loops contained entirely within this loop.
///
+ const std::vector<Loop*> &getSubLoops() const { return SubLoops; }
typedef std::vector<Loop*>::const_iterator iterator;
iterator begin() const { return SubLoops.begin(); }
iterator end() const { return SubLoops.end(); }
///
BasicBlock *getLoopPreheader() const;
+ /// getLoopLatch - If there is a latch block for this loop, return it. A
+ /// latch block is the canonical backedge for a loop. A loop header in normal
+ /// form has two edges into it: one from a preheader and one from a latch
+ /// block.
+ BasicBlock *getLoopLatch() const;
+
/// getCanonicalInductionVariable - Check to see if the loop has a canonical
/// induction variable: an integer recurrence that starts at 0 and increments
/// by one each time through the loop. If so, return the phi node that
Blocks.push_back(BB);
}
+ /// moveToHeader - This method is used to move BB (which must be part of this
+ /// loop) to be the loop header of the loop (the block that dominates all
+ /// others).
+ void moveToHeader(BasicBlock *BB) {
+ if (Blocks[0] == BB) return;
+ for (unsigned i = 0; ; ++i) {
+ assert(i != Blocks.size() && "Loop does not contain BB!");
+ if (Blocks[i] == BB) {
+ Blocks[i] = Blocks[0];
+ Blocks[0] = BB;
+ return;
+ }
+ }
+ }
+
/// removeBlockFromLoop - This removes the specified basic block from the
/// current loop, updating the Blocks as appropriate. This does not update
/// the mapping in the LoopInfo class.
private:
friend class LoopInfo;
Loop(BasicBlock *BB) : ParentLoop(0) {
- Blocks.push_back(BB); LoopDepth = 0;
- }
- void setLoopDepth(unsigned Level) {
- LoopDepth = Level;
- for (unsigned i = 0, e = SubLoops.size(); i != e; ++i)
- SubLoops[i]->setLoopDepth(Level+1);
+ Blocks.push_back(BB);
}
};
/// getLoopFor - Return the inner most loop that BB lives in. If a basic
/// block is in no loop (for example the entry node), null is returned.
///
- const Loop *getLoopFor(const BasicBlock *BB) const {
- std::map<BasicBlock *, Loop*>::const_iterator I=BBMap.find((BasicBlock*)BB);
+ Loop *getLoopFor(const BasicBlock *BB) const {
+ std::map<BasicBlock *, Loop*>::const_iterator I=
+ BBMap.find(const_cast<BasicBlock*>(BB));
return I != BBMap.end() ? I->second : 0;
}
/// operator[] - same as getLoopFor...
///
- inline const Loop *operator[](const BasicBlock *BB) const {
+ const Loop *operator[](const BasicBlock *BB) const {
return getLoopFor(BB);
}
// isLoopHeader - True if the block is a loop header node
bool isLoopHeader(BasicBlock *BB) const {
- return getLoopFor(BB)->getHeader() == BB;
+ const Loop *L = getLoopFor(BB);
+ return L && L->getHeader() == BB;
}
/// runOnFunction - Calculate the natural loop information.
virtual bool runOnFunction(Function &F);
virtual void releaseMemory();
- void print(std::ostream &O) const;
+ void print(std::ostream &O, const Module* = 0) const;
- /// getAnalysisUsage - Requires dominator sets
- ///
virtual void getAnalysisUsage(AnalysisUsage &AU) const;
/// removeLoop - This removes the specified top-level loop from this loop info
/// list with the indicated loop.
void changeTopLevelLoop(Loop *OldLoop, Loop *NewLoop);
+ /// addTopLevelLoop - This adds the specified loop to the collection of
+ /// top-level loops.
+ void addTopLevelLoop(Loop *New) {
+ assert(New->getParentLoop() == 0 && "Loop already in subloop!");
+ TopLevelLoops.push_back(New);
+ }
+
/// removeBlock - This method completely removes BB from all data structures,
/// including all of the Loop objects it is nested in and our mapping from
/// BasicBlocks to loops.
void removeBlock(BasicBlock *BB);
- static void stub(); // Noop
private:
- void Calculate(const DominatorSet &DS);
- Loop *ConsiderForLoop(BasicBlock *BB, const DominatorSet &DS);
+ void Calculate(ETForest &EF);
+ Loop *ConsiderForLoop(BasicBlock *BB, ETForest &EF);
void MoveSiblingLoopInto(Loop *NewChild, Loop *NewParent);
void InsertLoopInto(Loop *L, Loop *Parent);
};
-// Make sure that any clients of this file link in LoopInfo.cpp
-static IncludeFile
-LOOP_INFO_INCLUDE_FILE((void*)&LoopInfo::stub);
-
// Allow clients to walk the list of nested loops...
template <> struct GraphTraits<const Loop*> {
typedef const Loop NodeType;
typedef std::vector<Loop*>::const_iterator ChildIteratorType;
static NodeType *getEntryNode(const Loop *L) { return L; }
- static inline ChildIteratorType child_begin(NodeType *N) {
+ static inline ChildIteratorType child_begin(NodeType *N) {
return N->begin();
}
- static inline ChildIteratorType child_end(NodeType *N) {
+ static inline ChildIteratorType child_end(NodeType *N) {
return N->end();
}
};
typedef std::vector<Loop*>::const_iterator ChildIteratorType;
static NodeType *getEntryNode(Loop *L) { return L; }
- static inline ChildIteratorType child_begin(NodeType *N) {
+ static inline ChildIteratorType child_begin(NodeType *N) {
return N->begin();
}
- static inline ChildIteratorType child_end(NodeType *N) {
+ static inline ChildIteratorType child_end(NodeType *N) {
return N->end();
}
};
} // End llvm namespace
+// Make sure that any clients of this file link in LoopInfo.cpp
+FORCE_DEFINING_FILE_TO_BE_LINKED(LoopInfo)
+
#endif
projects / oota-llvm.git / blobdiff