include/llvm/Analysis/IntervalPartition.h

   1 //===- IntervalPartition.h - Interval partition Calculation ------*- C++ -*--=//
   2 //
   3 // This file contains the declaration of the IntervalPartition class, which
   4 // calculates and represents the interval partition of a function, or a
   5 // preexisting interval partition.
   6 //
   7 // In this way, the interval partition may be used to reduce a flow graph down
   8 // to its degenerate single node interval partition (unless it is irreducible).
   9 //
  10 // TODO: The IntervalPartition class should take a bool parameter that tells
  11 // whether it should add the "tails" of an interval to an interval itself or if
  12 // they should be represented as distinct intervals.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_INTERVAL_PARTITION_H
  17 #define LLVM_INTERVAL_PARTITION_H
  18
  19 #include "llvm/Analysis/Interval.h"
  20 #include "llvm/Pass.h"
  21
  22 //===----------------------------------------------------------------------===//
  23 //
  24 // IntervalPartition - This class builds and holds an "interval partition" for
  25 // a function.  This partition divides the control flow graph into a set of
  26 // maximal intervals, as defined with the properties above.  Intuitively, a
  27 // BasicBlock is a (possibly nonexistent) loop with a "tail" of non looping
  28 // nodes following it.
  29 //
  30 class IntervalPartition : public FunctionPass, public std::vector<Interval*> {
  31   typedef std::map<BasicBlock*, Interval*> IntervalMapTy;
  32   IntervalMapTy IntervalMap;
  33
  34   typedef std::vector<Interval*> IntervalListTy;
  35   Interval *RootInterval;
  36
  37 public:
  38   static AnalysisID ID;    // We are an analysis, we must have an ID
  39
  40   IntervalPartition() : RootInterval(0) {}
  41
  42   // run - Calculate the interval partition for this function
  43   virtual bool runOnFunction(Function &F);
  44
  45   // IntervalPartition ctor - Build a reduced interval partition from an
  46   // existing interval graph.  This takes an additional boolean parameter to
  47   // distinguish it from a copy constructor.  Always pass in false for now.
  48   //
  49   IntervalPartition(IntervalPartition &I, bool);
  50
  51   // Destructor - Free memory
  52   ~IntervalPartition() { destroy(); }
  53
  54   // print - Show contents in human readable format...
  55   virtual void print(std::ostream &O) const;
  56
  57   // getRootInterval() - Return the root interval that contains the starting
  58   // block of the function.
  59   inline Interval *getRootInterval() { return RootInterval; }
  60
  61   // isDegeneratePartition() - Returns true if the interval partition contains
  62   // a single interval, and thus cannot be simplified anymore.
  63   bool isDegeneratePartition() { return size() == 1; }
  64
  65   // TODO: isIrreducible - look for triangle graph.
  66
  67   // getBlockInterval - Return the interval that a basic block exists in.
  68   inline Interval *getBlockInterval(BasicBlock *BB) {
  69     IntervalMapTy::iterator I = IntervalMap.find(BB);
  70     return I != IntervalMap.end() ? I->second : 0;
  71   }
  72
  73   // getAnalysisUsage - Implement the Pass API
  74   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  75     AU.setPreservesAll();
  76     AU.addProvided(ID);
  77   }
  78
  79 private:
  80   // destroy - Reset state back to before function was analyzed
  81   void destroy();
  82
  83   // addIntervalToPartition - Add an interval to the internal list of intervals,
  84   // and then add mappings from all of the basic blocks in the interval to the
  85   // interval itself (in the IntervalMap).
  86   //
  87   void addIntervalToPartition(Interval *I);
  88
  89   // updatePredecessors - Interval generation only sets the successor fields of
  90   // the interval data structures.  After interval generation is complete,
  91   // run through all of the intervals and propogate successor info as
  92   // predecessor info.
  93   //
  94   void updatePredecessors(Interval *Int);
  95 };
  96
  97 #endif