[PM] Split the CallGraph out from the ModulePass which creates the
[oota-llvm.git] / include / llvm / Analysis / IntervalPartition.h
index 307a70a87cd9e5016cc91c974e4f0bda4b762c9b..8cade58cd324d1e5de3918dd84f86d44e1a4fb01 100644 (file)
@@ -1,4 +1,11 @@
-//===- IntervalPartition.h - Interval partition Calculation ------*- C++ -*--=//
+//===- IntervalPartition.h - Interval partition Calculation -----*- C++ -*-===//
+//
+//                     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
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef LLVM_INTERVAL_PARTITION_H
-#define LLVM_INTERVAL_PARTITION_H
+#ifndef LLVM_ANALYSIS_INTERVALPARTITION_H
+#define LLVM_ANALYSIS_INTERVALPARTITION_H
 
 #include "llvm/Analysis/Interval.h"
 #include "llvm/Pass.h"
+#include <map>
+
+namespace llvm {
 
 //===----------------------------------------------------------------------===//
 //
 // IntervalPartition - This class builds and holds an "interval partition" for
 // a function.  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
+// 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 : public FunctionPass, public std::vector<Interval*> {
+class IntervalPartition : public FunctionPass {
   typedef std::map<BasicBlock*, Interval*> IntervalMapTy;
   IntervalMapTy IntervalMap;
 
   typedef std::vector<Interval*> IntervalListTy;
   Interval *RootInterval;
+  std::vector<Interval*> Intervals;
 
 public:
-  static AnalysisID ID;    // We are an analysis, we must have an ID
-
-  IntervalPartition() : RootInterval(0) {}
+  static char ID; // Pass identification, replacement for typeid
 
-  const char *getPassName() const { return "Interval Partition Construction"; }
+  IntervalPartition() : FunctionPass(ID), RootInterval(0) {
+    initializeIntervalPartitionPass(*PassRegistry::getPassRegistry());
+  }
 
   // run - Calculate the interval partition for this function
   virtual bool runOnFunction(Function &F);
@@ -50,8 +61,8 @@ public:
   //
   IntervalPartition(IntervalPartition &I, bool);
 
-  // Destructor - Free memory
-  ~IntervalPartition() { destroy(); }
+  // 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 function.
@@ -59,7 +70,7 @@ public:
 
   // 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.
 
@@ -72,13 +83,15 @@ public:
   // getAnalysisUsage - Implement the Pass API
   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
     AU.setPreservesAll();
-    AU.addProvided(ID);
   }
 
-private:
-  // destroy - Reset state back to before function was analyzed
-  void destroy();
+  // Interface to Intervals vector...
+  const std::vector<Interval*> &getIntervals() const { return Intervals; }
+
+  // releaseMemory - Reset state back to before function was analyzed
+  void releaseMemory();
 
+private:
   // 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).
@@ -87,10 +100,12 @@ private:
 
   // 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 llvm namespace
+
 #endif