X-Git-Url: http://plrg.eecs.uci.edu/git/?p=oota-llvm.git;a=blobdiff_plain;f=include%2Fllvm%2FAnalysis%2FInterval.h;h=5ce1260eca1f93d9e4e4f5053452183ad71f0c52;hp=18f3a88c7e916048c2a87d7fb4b609b05f0fed61;hb=674be02d525d4e24bc6943ed9274958c580bcfbc;hpb=697954c15da58bd8b186dbafdedd8b06db770201 diff --git a/include/llvm/Analysis/Interval.h b/include/llvm/Analysis/Interval.h index 18f3a88c7e9..5ce1260eca1 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,25 +17,27 @@ // //===----------------------------------------------------------------------===// -#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 std::vector::iterator succ_iterator; @@ -44,22 +53,22 @@ public: inline BasicBlock *getHeaderNode() const { return HeaderNode; } - // Nodes - The basic blocks in this interval. - // + /// 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. - // + /// 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. - // + /// 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; @@ -68,7 +77,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; @@ -77,31 +86,68 @@ public: //return find(Successors.begin(), Successors.end(), BB) != Successors.end(); } - // 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. - // + /// 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... + /// 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 methods so that Intervals may be used - // just like BasicBlocks can with the succ_* functions, and *::succ_iterator. - // - inline succ_iterator succ_begin() { return Successors.begin(); } - inline succ_iterator succ_end() { return 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() { return Predecessors.begin(); } - inline Interval::pred_iterator pred_end() { return Predecessors.end(); } +/// 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); + } +}; + +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