include/llvm/Analysis/IntervalPartition.h

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