X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FAnalysis%2FInterval.h;h=ca8ad73131a9d9169ccd573421c02916877a1976;hb=b2a33b46469a6d2c0e61122002079efb7d6d3f9c;hp=a17e655c9e4853652bacdd2d47f85216988367df;hpb=564de7d79bd0e7c3b42988b112f325f15cd575ea;p=oota-llvm.git diff --git a/include/llvm/Analysis/Interval.h b/include/llvm/Analysis/Interval.h index a17e655c9e4..ca8ad73131a 100644 --- a/include/llvm/Analysis/Interval.h +++ b/include/llvm/Analysis/Interval.h @@ -1,112 +1,153 @@ -//===- llvm/Analysis/Intervals.h - Interval partition Calculation-*- C++ -*--=// +//===- llvm/Analysis/Interval.h - Interval Class Declaration ----*- C++ -*-===// // -// This file contains the declaration of the cfg::IntervalPartition class, which -// calculates and represent the interval partition of a method. +// 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 Interval class, which +// represents a set of CFG nodes and is a portion of an interval partition. +// +// Intervals have some interesting and useful properties, including the +// following: +// 1. The header node of an interval dominates all of the elements of the +// interval // //===----------------------------------------------------------------------===// -#ifndef LLVM_INTERVALS_H -#define LLVM_INTERVALS_H +#ifndef LLVM_INTERVAL_H +#define LLVM_INTERVAL_H +#include "llvm/ADT/GraphTraits.h" #include -#include -#include - -class Method; -class BasicBlock; -namespace cfg { +namespace llvm { -class IntervalPartition; +class BasicBlock; +class raw_ostream; -// Interval Class - An Interval is a set of nodes defined such that every node -// in the interval has all of its predecessors in the interval (except for the -// header) +//===----------------------------------------------------------------------===// +// +/// Interval Class - An Interval is a set of nodes defined such that every node +/// in the interval has all of its predecessors in the interval (except for the +/// header) +/// class Interval { - friend class IntervalPartition; -public: - typedef vector::iterator succ_iterator; - typedef vector::iterator pred_iterator; - typedef vector::iterator node_iterator; - - // HeaderNode - The header BasicBlock, which dominates all BasicBlocks in this - // interval. Also, any loops in this interval must go through the HeaderNode. - // + /// HeaderNode - The header BasicBlock, which dominates all BasicBlocks in this + /// interval. Also, any loops in this interval must go through the HeaderNode. + /// BasicBlock *HeaderNode; +public: + typedef std::vector::iterator succ_iterator; + typedef std::vector::iterator pred_iterator; + typedef std::vector::iterator node_iterator; - // Nodes - The basic blocks in this interval. - // - vector Nodes; - - // Successors - List of BasicBlocks that are reachable directly from nodes in - // this interval, but are not in the interval themselves. - // These nodes neccesarily must be header nodes for other intervals. - // - vector Successors; - - // Predecessors - List of BasicBlocks that have this Interval's header block - // as one of their successors. - // - vector Predecessors; - - inline bool contains(BasicBlock *BB) { - return find(Nodes.begin(), Nodes.end(), BB) != Nodes.end(); + inline Interval(BasicBlock *Header) : HeaderNode(Header) { + Nodes.push_back(Header); } - inline bool isSuccessor(BasicBlock *BB) { - return find(Successors.begin(), Successors.end(), BB) != Successors.end(); + inline Interval(const Interval &I) // copy ctor + : HeaderNode(I.HeaderNode), Nodes(I.Nodes), Successors(I.Successors) {} + + inline BasicBlock *getHeaderNode() const { return HeaderNode; } + + /// Nodes - The basic blocks in this interval. + /// + std::vector Nodes; + + /// Successors - List of BasicBlocks that are reachable directly from nodes in + /// this interval, but are not in the interval themselves. + /// These nodes necessarily must be header nodes for other intervals. + /// + std::vector Successors; + + /// Predecessors - List of BasicBlocks that have this Interval's header block + /// as one of their successors. + /// + std::vector Predecessors; + + /// contains - Find out if a basic block is in this interval + inline bool contains(BasicBlock *BB) const { + for (unsigned i = 0; i < Nodes.size(); ++i) + if (Nodes[i] == BB) return true; + return false; + // I don't want the dependency on + //return find(Nodes.begin(), Nodes.end(), BB) != Nodes.end(); } -private: // Only accessable by IntervalPartition class - inline Interval(BasicBlock *Header) : HeaderNode(Header) { - Nodes.push_back(Header); + /// isSuccessor - find out if a basic block is a successor of this Interval + inline bool isSuccessor(BasicBlock *BB) const { + for (unsigned i = 0; i < Successors.size(); ++i) + if (Successors[i] == BB) return true; + return false; + // I don't want the dependency on + //return find(Successors.begin(), Successors.end(), BB) != Successors.end(); } -}; - -// 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 -// nodes following it. -// -class IntervalPartition { - typedef map IntervalMapTy; - IntervalMapTy IntervalMap; + /// Equality operator. It is only valid to compare two intervals from the + /// same partition, because of this, all we have to check is the header node + /// for equality. + /// + inline bool operator==(const Interval &I) const { + return HeaderNode == I.HeaderNode; + } - typedef vector IntervalListTy; - IntervalListTy IntervalList; - Interval *RootInterval; + /// isLoop - Find out if there is a back edge in this interval... + bool isLoop() const; -public: - typedef IntervalListTy::iterator iterator; + /// print - Show contents in human readable format... + void print(raw_ostream &O) const; +}; -public: - // IntervalPartition ctor - Build the partition for the specified method - IntervalPartition(Method *M); - - // getRootInterval() - Return the root interval that contains the starting - // block of the method - inline Interval *getRootInterval() { return RootInterval; } - - inline Interval *getBlockInterval(BasicBlock *BB) { - IntervalMapTy::iterator I = IntervalMap.find(BB); - if (I != IntervalMap.end()) - return I->second; - else - return 0; +/// succ_begin/succ_end - define methods so that Intervals may be used +/// just like BasicBlocks can with the succ_* functions, and *::succ_iterator. +/// +inline Interval::succ_iterator succ_begin(Interval *I) { + return I->Successors.begin(); +} +inline Interval::succ_iterator succ_end(Interval *I) { + return I->Successors.end(); +} + +/// pred_begin/pred_end - define methods so that Intervals may be used +/// just like BasicBlocks can with the pred_* functions, and *::pred_iterator. +/// +inline Interval::pred_iterator pred_begin(Interval *I) { + return I->Predecessors.begin(); +} +inline Interval::pred_iterator pred_end(Interval *I) { + return I->Predecessors.end(); +} + +template <> struct GraphTraits { + typedef Interval NodeType; + typedef Interval::succ_iterator ChildIteratorType; + + static NodeType *getEntryNode(Interval *I) { return I; } + + /// nodes_iterator/begin/end - Allow iteration over all nodes in the graph + static inline ChildIteratorType child_begin(NodeType *N) { + return succ_begin(N); } + static inline ChildIteratorType child_end(NodeType *N) { + return succ_end(N); + } +}; - // Iterators to iterate over all of the intervals in the method - inline iterator begin() { return IntervalList.begin(); } - inline iterator end() { return IntervalList.end(); } - -private: - void ProcessInterval(BasicBlock *Header); - void ProcessBasicBlock(Interval *I, BasicBlock *BB); - void UpdateSuccessors(Interval *Int); +template <> struct GraphTraits > { + typedef Interval NodeType; + typedef Interval::pred_iterator ChildIteratorType; + static NodeType *getEntryNode(Inverse G) { return G.Graph; } + static inline ChildIteratorType child_begin(NodeType *N) { + return pred_begin(N); + } + static inline ChildIteratorType child_end(NodeType *N) { + return pred_end(N); + } }; -} // End namespace cfg +} // End llvm namespace #endif