include/llvm/Analysis/IntervalPartition.h

   1 //===- IntervalPartition.h - Interval partition Calculation -----*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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   IntervalPartition() : RootInterval(0) {}
  49
  50   // run - Calculate the interval partition for this function
  51   virtual bool runOnFunction(Function &F);
  52
  53   // IntervalPartition ctor - Build a reduced interval partition from an
  54   // existing interval graph.  This takes an additional boolean parameter to
  55   // distinguish it from a copy constructor.  Always pass in false for now.
  56   //
  57   IntervalPartition(IntervalPartition &I, bool);
  58
  59   // Destructor - Free memory
  60   ~IntervalPartition() { destroy(); }
  61
  62   // print - Show contents in human readable format...
  63   virtual void print(std::ostream &O, const Module* = 0) const;
  64   void print(std::ostream *O, const Module* M = 0) const {
  65     if (O) print(*O, M);
  66   }
  67
  68   // getRootInterval() - Return the root interval that contains the starting
  69   // block of the function.
  70   inline Interval *getRootInterval() { return RootInterval; }
  71
  72   // isDegeneratePartition() - Returns true if the interval partition contains
  73   // a single interval, and thus cannot be simplified anymore.
  74   bool isDegeneratePartition() { return Intervals.size() == 1; }
  75
  76   // TODO: isIrreducible - look for triangle graph.
  77
  78   // getBlockInterval - Return the interval that a basic block exists in.
  79   inline Interval *getBlockInterval(BasicBlock *BB) {
  80     IntervalMapTy::iterator I = IntervalMap.find(BB);
  81     return I != IntervalMap.end() ? I->second : 0;
  82   }
  83
  84   // getAnalysisUsage - Implement the Pass API
  85   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  86     AU.setPreservesAll();
  87   }
  88
  89   // Interface to Intervals vector...
  90   const std::vector<Interval*> &getIntervals() const { return Intervals; }
  91
  92 private:
  93   // destroy - Reset state back to before function was analyzed
  94   void destroy();
  95
  96   // addIntervalToPartition - Add an interval to the internal list of intervals,
  97   // and then add mappings from all of the basic blocks in the interval to the
  98   // interval itself (in the IntervalMap).
  99   //
 100   void addIntervalToPartition(Interval *I);
 101
 102   // updatePredecessors - Interval generation only sets the successor fields of
 103   // the interval data structures.  After interval generation is complete,
 104   // run through all of the intervals and propagate successor info as
 105   // predecessor info.
 106   //
 107   void updatePredecessors(Interval *Int);
 108 };
 109
 110 } // End llvm namespace
 111
 112 #endif