-//===- IntervalPartition.h - Interval partition Calculation ------*- C++ -*--=//
+//===- IntervalPartition.h - Interval partition Calculation -----*- C++ -*-===//
//
-// This file contains the declaration of the cfg::IntervalPartition class, which
-// calculates and represents the interval partition of a method, or a
+// The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file contains the declaration of the IntervalPartition class, which
+// calculates and represents the interval partition of a function, or a
// preexisting interval partition.
//
// In this way, the interval partition may be used to reduce a flow graph down
#define LLVM_INTERVAL_PARTITION_H
#include "llvm/Analysis/Interval.h"
+#include "llvm/Pass.h"
#include <map>
-class Method;
-
-namespace cfg {
+namespace llvm {
//===----------------------------------------------------------------------===//
//
// IntervalPartition - This class builds and holds an "interval partition" for
-// a method. This partition divides the control flow graph into a set of
-// maximal intervals, as defined with the properties above. Intuitively, a
-// BasicBlock is a (possibly nonexistent) loop with a "tail" of non looping
+// a function. This partition divides the control flow graph into a set of
+// maximal intervals, as defined with the properties above. Intuitively, an
+// interval is a (possibly nonexistent) loop with a "tail" of non looping
// nodes following it.
//
-class IntervalPartition {
- typedef map<BasicBlock*, Interval*> IntervalMapTy;
+class IntervalPartition : public FunctionPass {
+ typedef std::map<BasicBlock*, Interval*> IntervalMapTy;
IntervalMapTy IntervalMap;
- typedef vector<Interval*> IntervalListTy;
- IntervalListTy IntervalList;
+ typedef std::vector<Interval*> IntervalListTy;
Interval *RootInterval;
+ std::vector<Interval*> Intervals;
public:
- typedef IntervalListTy::iterator iterator;
+ static char ID; // Pass identification, replacement for typeid
-public:
- // IntervalPartition ctor - Build the partition for the specified method
- IntervalPartition(Method *M);
+ IntervalPartition() : FunctionPass(ID), RootInterval(0) {
+ initializeIntervalPartitionPass(*PassRegistry::getPassRegistry());
+ }
+
+ // run - Calculate the interval partition for this function
+ virtual bool runOnFunction(Function &F);
// IntervalPartition ctor - Build a reduced interval partition from an
// existing interval graph. This takes an additional boolean parameter to
//
IntervalPartition(IntervalPartition &I, bool);
- // Destructor - Free memory
- ~IntervalPartition();
+ // print - Show contents in human readable format...
+ virtual void print(raw_ostream &O, const Module* = 0) const;
// getRootInterval() - Return the root interval that contains the starting
- // block of the method.
+ // block of the function.
inline Interval *getRootInterval() { return RootInterval; }
// isDegeneratePartition() - Returns true if the interval partition contains
// a single interval, and thus cannot be simplified anymore.
- bool isDegeneratePartition() { return size() == 1; }
+ bool isDegeneratePartition() { return Intervals.size() == 1; }
// TODO: isIrreducible - look for triangle graph.
return I != IntervalMap.end() ? I->second : 0;
}
- // Iterators to iterate over all of the intervals in the method
- inline iterator begin() { return IntervalList.begin(); }
- inline iterator end() { return IntervalList.end(); }
- inline unsigned size() { return IntervalList.size(); }
+ // getAnalysisUsage - Implement the Pass API
+ virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.setPreservesAll();
+ }
+
+ // Interface to Intervals vector...
+ const std::vector<Interval*> &getIntervals() const { return Intervals; }
+
+ // releaseMemory - Reset state back to before function was analyzed
+ void releaseMemory();
private:
- // ProcessInterval - This method is used during the construction of the
- // interval graph. It walks through the source graph, recursively creating
- // an interval per invokation until the entire graph is covered. This uses
- // the ProcessNode method to add all of the nodes to the interval.
- //
- // This method is templated because it may operate on two different source
- // graphs: a basic block graph, or a preexisting interval graph.
- //
- template<class NodeTy, class OrigContainer>
- void ProcessInterval(NodeTy *Node, OrigContainer *OC);
-
- // ProcessNode - This method is called by ProcessInterval to add nodes to the
- // interval being constructed, and it is also called recursively as it walks
- // the source graph. A node is added to the current interval only if all of
- // its predecessors are already in the graph. This also takes care of keeping
- // the successor set of an interval up to date.
- //
- // This method is templated because it may operate on two different source
- // graphs: a basic block graph, or a preexisting interval graph.
- //
- template<class NodeTy, class OrigContainer>
- void ProcessNode(Interval *Int, NodeTy *Node, OrigContainer *OC);
-
- // addNodeToInterval - This method exists to assist the generic ProcessNode
- // with the task of adding a node to the new interval, depending on the
- // type of the source node. In the case of a CFG source graph (BasicBlock
- // case), the BasicBlock itself is added to the interval. In the case of
- // an IntervalPartition source graph (Interval case), all of the member
- // BasicBlocks are added to the interval.
+ // addIntervalToPartition - Add an interval to the internal list of intervals,
+ // and then add mappings from all of the basic blocks in the interval to the
+ // interval itself (in the IntervalMap).
//
- inline void addNodeToInterval(Interval *Int, Interval *I);
- inline void addNodeToInterval(Interval *Int, BasicBlock *BB);
+ void addIntervalToPartition(Interval *I);
// updatePredecessors - Interval generation only sets the successor fields of
// the interval data structures. After interval generation is complete,
- // run through all of the intervals and propogate successor info as
+ // run through all of the intervals and propagate successor info as
// predecessor info.
//
void updatePredecessors(Interval *Int);
};
-} // End namespace cfg
+} // End llvm namespace
#endif