X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FAnalysis%2FInterval.h;h=01eba3f16c014f13e51335cfcfb2c262bfbb9bfe;hb=dabc5073b21bca077cf86a64fde9aa87cf654362;hp=33f7d4182ceff50d7666dba4ebad955f2914f9d3;hpb=75517097e71f79b0a6daaa02a8c0a038436863d4;p=oota-llvm.git diff --git a/include/llvm/Analysis/Interval.h b/include/llvm/Analysis/Interval.h index 33f7d4182ce..01eba3f16c0 100644 --- a/include/llvm/Analysis/Interval.h +++ b/include/llvm/Analysis/Interval.h @@ -1,8 +1,15 @@ -//===- llvm/Analysis/Interval.h - Interval Class Declaration -----*- C++ -*--=// +//===- llvm/Analysis/Interval.h - Interval Class Declaration ----*- C++ -*-===// // -// This file contains the declaration of the cfg::Interval class, which +// 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 @@ -10,30 +17,32 @@ // //===----------------------------------------------------------------------===// -#ifndef LLVM_INTERVAL_H -#define LLVM_INTERVAL_H +#ifndef LLVM_ANALYSIS_INTERVAL_H +#define LLVM_ANALYSIS_INTERVAL_H +#include "llvm/ADT/GraphTraits.h" #include -class BasicBlock; +namespace llvm { -namespace cfg { +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 { - // 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 vector::iterator succ_iterator; - typedef vector::iterator pred_iterator; - typedef vector::iterator node_iterator; + typedef std::vector::iterator succ_iterator; + typedef std::vector::iterator pred_iterator; + typedef std::vector::iterator node_iterator; inline Interval(BasicBlock *Header) : HeaderNode(Header) { Nodes.push_back(Header); @@ -41,22 +50,22 @@ public: inline BasicBlock *getHeaderNode() const { return HeaderNode; } - // Nodes - The basic blocks in this interval. - // - vector Nodes; + /// 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 neccesarily must be header nodes for other intervals. - // - vector Successors; + /// 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. - // - vector Predecessors; + /// 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 + /// 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; @@ -65,7 +74,7 @@ public: //return find(Nodes.begin(), Nodes.end(), BB) != Nodes.end(); } - // isSuccessor - find out if a basic block is a successor of this Interval + /// 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; @@ -74,31 +83,68 @@ public: //return find(Successors.begin(), Successors.end(), BB) != Successors.end(); } - // isLoop - Find out if there is a back edge in this interval... + /// 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; + } + + /// isLoop - Find out if there is a back edge in this interval... bool isLoop() const; -}; + /// print - Show contents in human readable format... + void print(raw_ostream &O) const; +}; -// succ_begin/succ_end - define global functions 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) { +/// 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) { +inline Interval::succ_iterator succ_end(Interval *I) { return I->Successors.end(); } -// pred_begin/pred_end - define global functions 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) { +/// 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) { +inline Interval::pred_iterator pred_end(Interval *I) { return I->Predecessors.end(); } -} // End namespace cfg +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); + } +}; + +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 llvm namespace #endif