From 4dd88f6fbf6dc44ceba03b34aeab458536789b98 Mon Sep 17 00:00:00 2001 From: Chris Lattner Date: Mon, 25 Jun 2001 03:54:14 +0000 Subject: [PATCH] Big changes. Interval*.h is now more or less finalized. IntervalPartition is recoded to use IntervalIterators. IntervalIterators can now maintain their own memory or let an external entity do it. Loop depth is a new user of IntervalPartition for calculating the loop nesting depth of a basic block TODO: add IntervalPartition capability to split intervals between the looping portion and the "tail" portion. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@69 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/llvm/Analysis/Interval.h | 11 +++ include/llvm/Analysis/IntervalIterator.h | 95 +++++++++++++++-------- include/llvm/Analysis/IntervalPartition.h | 35 +-------- include/llvm/Analysis/LoopDepth.h | 29 +++++++ 4 files changed, 106 insertions(+), 64 deletions(-) create mode 100644 include/llvm/Analysis/LoopDepth.h diff --git a/include/llvm/Analysis/Interval.h b/include/llvm/Analysis/Interval.h index 33f7d4182ce..1d708b691cd 100644 --- a/include/llvm/Analysis/Interval.h +++ b/include/llvm/Analysis/Interval.h @@ -39,6 +39,9 @@ public: Nodes.push_back(Header); } + 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. @@ -74,6 +77,14 @@ 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. + // + 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; }; diff --git a/include/llvm/Analysis/IntervalIterator.h b/include/llvm/Analysis/IntervalIterator.h index ec70c8782df..60155022aa4 100644 --- a/include/llvm/Analysis/IntervalIterator.h +++ b/include/llvm/Analysis/IntervalIterator.h @@ -4,7 +4,22 @@ // graph of some sort. This iterator is parametric, allowing iterator over the // following types of graphs: // -// TODO +// 1. A Method* object, composed of BasicBlock nodes. +// 2. An IntervalPartition& object, composed of Interval nodes. +// +// This iterator is defined to walk the control flow graph, returning intervals +// in depth first order. These intervals are completely filled in except for +// the predecessor fields (the successor information is filled in however). +// +// By default, the intervals created by this iterator are deleted after they +// are no longer any use to the iterator. This behavior can be changed by +// passing a false value into the intervals_begin() function. This causes the +// IOwnMem member to be set, and the intervals to not be deleted. +// +// It is only safe to use this if all of the intervals are deleted by the caller +// and all of the intervals are processed. However, the user of the iterator is +// not allowed to modify or delete the intervals until after the iterator has +// been used completely. The IntervalPartition class uses this functionality. // //===----------------------------------------------------------------------===// @@ -20,14 +35,6 @@ namespace cfg { -// TODO: Provide an interval iterator that codifies the internals of -// IntervalPartition. Inside, it would have a stack of Interval*'s, and would -// walk the interval partition in depth first order. IntervalPartition would -// then be a client of this iterator. The iterator should work on Method*, -// const Method*, IntervalPartition*, and const IntervalPartition*. -// - - // getNodeHeader - Given a source graph node and the source graph, return the // BasicBlock that is the header node. This is the opposite of // getSourceGraphNode. @@ -51,7 +58,7 @@ inline Interval *getSourceGraphNode(IntervalPartition *IP, BasicBlock *BB) { // type of the source node. In the case of a CFG source graph (BasicBlock // case), the BasicBlock itself is added to the interval. // -inline void addNodeToInterval(Interval *Int, BasicBlock *BB){ +inline void addNodeToInterval(Interval *Int, BasicBlock *BB) { Int->Nodes.push_back(BB); } @@ -68,11 +75,16 @@ inline void addNodeToInterval(Interval *Int, Interval *I) { } + + + template class IntervalIterator { - stack > IntStack; + stack > IntStack; set Visited; OrigContainer_t *OrigContainer; + bool IOwnMem; // If True, delete intervals when done with them + // See file header for conditions of use public: typedef BasicBlock* _BB; @@ -80,36 +92,51 @@ public: typedef forward_iterator_tag iterator_category; IntervalIterator() {} // End iterator, empty stack - IntervalIterator(Method *M) { + IntervalIterator(Method *M, bool OwnMemory) : IOwnMem(OwnMemory) { OrigContainer = M; if (!ProcessInterval(M->getBasicBlocks().front())) { assert(0 && "ProcessInterval should never fail for first interval!"); } } - IntervalIterator(IntervalPartition &IP) { + IntervalIterator(IntervalPartition &IP, bool OwnMemory) : IOwnMem(OwnMemory) { OrigContainer = &IP; if (!ProcessInterval(IP.getRootInterval())) { assert(0 && "ProcessInterval should never fail for first interval!"); } } - inline bool operator==(const _Self& x) const { return IntStack == x.IntStack; } + inline ~IntervalIterator() { + if (IOwnMem) + while (!IntStack.empty()) { + delete operator*(); + IntStack.pop(); + } + } + + inline bool operator==(const _Self& x) const { return IntStack == x.IntStack;} inline bool operator!=(const _Self& x) const { return !operator==(x); } - inline Interval &operator*() const { return IntStack.top(); } - inline Interval *operator->() const { return &(operator*()); } + inline const Interval *operator*() const { return IntStack.top().first; } + inline Interval *operator*() { return IntStack.top().first; } + inline const Interval *operator->() const { return operator*(); } + inline Interval *operator->() { return operator*(); } - inline _Self& operator++() { // Preincrement + _Self& operator++() { // Preincrement + assert(!IntStack.empty() && "Attempting to use interval iterator at end!"); do { - // All of the intervals on the stack have been visited. Try visiting their - // successors now. - Interval &CurInt = IntStack.top().first; - Interval::iterator &SuccIt = IntStack.top().second,End = succ_end(&CurInt); + // All of the intervals on the stack have been visited. Try visiting + // their successors now. + Interval::succ_iterator &SuccIt = IntStack.top().second, + EndIt = succ_end(IntStack.top().first); + while (SuccIt != EndIt) { // Loop over all interval succs + bool Done = ProcessInterval(getSourceGraphNode(OrigContainer, *SuccIt)); + ++SuccIt; // Increment iterator + if (Done) return *this; // Found a new interval! Use it! + } - for (; SuccIt != End; ++SuccIt) // Loop over all interval successors - if (ProcessInterval(*SuccIt)) // Found a new interval! - return *this; // Use it! + // Free interval memory... if neccesary + if (IOwnMem) delete IntStack.top().first; // We ran out of successors for this interval... pop off the stack IntStack.pop(); @@ -134,15 +161,15 @@ private: BasicBlock *Header = getNodeHeader(Node); if (Visited.count(Header)) return false; - Interval Int(Header); + Interval *Int = new Interval(Header); Visited.insert(Header); // The header has now been visited! // Check all of our successors to see if they are in the interval... - for (typename NodeTy::succ_iterator I = succ_begin(Node), E = succ_end(Node); + for (typename NodeTy::succ_iterator I = succ_begin(Node),E = succ_end(Node); I != E; ++I) - ProcessNode(&Int, getSourceGraphNode(OrigContainer, *I)); + ProcessNode(Int, getSourceGraphNode(OrigContainer, *I)); - IntStack.push(make_pair(Int, succ_begin(&Int))); + IntStack.push(make_pair(Int, succ_begin(Int))); return true; } @@ -164,7 +191,7 @@ private: if (Visited.count(NodeHeader)) { // Node already been visited? if (Int->contains(NodeHeader)) { // Already in this interval... return; - } else { // In another interval, add as successor + } else { // In other interval, add as successor if (!Int->isSuccessor(NodeHeader)) // Add only if not already in set Int->Successors.push_back(NodeHeader); } @@ -203,15 +230,17 @@ typedef IntervalIterator method_interval_iterator; typedef IntervalIterator interval_part_interval_iterator; -inline method_interval_iterator intervals_begin(Method *M) { - return method_interval_iterator(M); +inline method_interval_iterator intervals_begin(Method *M, + bool DeleteInts = true) { + return method_interval_iterator(M, DeleteInts); } inline method_interval_iterator intervals_end(Method *M) { return method_interval_iterator(); } -inline interval_part_interval_iterator intervals_begin(IntervalPartition &IP) { - return interval_part_interval_iterator(IP); +inline interval_part_interval_iterator + intervals_begin(IntervalPartition &IP, bool DeleteIntervals = true) { + return interval_part_interval_iterator(IP, DeleteIntervals); } inline interval_part_interval_iterator intervals_end(IntervalPartition &IP) { diff --git a/include/llvm/Analysis/IntervalPartition.h b/include/llvm/Analysis/IntervalPartition.h index fd24b2fb987..796c840b9a8 100644 --- a/include/llvm/Analysis/IntervalPartition.h +++ b/include/llvm/Analysis/IntervalPartition.h @@ -77,38 +77,11 @@ public: inline unsigned size() { return IntervalList.size(); } private: - // ProcessInterval - This method is used during the construction of the - // interval graph. It walks through the source graph, recursively creating - // an interval per invokation until the entire graph is covered. This uses - // the ProcessNode method to add all of the nodes to the interval. + // addIntervalToPartition - Add an interval to the internal list of intervals, + // and then add mappings from all of the basic blocks in the interval to the + // interval itself (in the IntervalMap). // - // This method is templated because it may operate on two different source - // graphs: a basic block graph, or a preexisting interval graph. - // - template - void ProcessInterval(NodeTy *Node, OrigContainer *OC); - - // ProcessNode - This method is called by ProcessInterval to add nodes to the - // interval being constructed, and it is also called recursively as it walks - // the source graph. A node is added to the current interval only if all of - // its predecessors are already in the graph. This also takes care of keeping - // the successor set of an interval up to date. - // - // This method is templated because it may operate on two different source - // graphs: a basic block graph, or a preexisting interval graph. - // - template - void ProcessNode(Interval *Int, NodeTy *Node, OrigContainer *OC); - - // addNodeToInterval - This method exists to assist the generic ProcessNode - // with the task of adding a node to the new interval, depending on the - // type of the source node. In the case of a CFG source graph (BasicBlock - // case), the BasicBlock itself is added to the interval. In the case of - // an IntervalPartition source graph (Interval case), all of the member - // BasicBlocks are added to the interval. - // - inline void addNodeToInterval(Interval *Int, Interval *I); - inline void addNodeToInterval(Interval *Int, BasicBlock *BB); + void addIntervalToPartition(Interval *I); // updatePredecessors - Interval generation only sets the successor fields of // the interval data structures. After interval generation is complete, diff --git a/include/llvm/Analysis/LoopDepth.h b/include/llvm/Analysis/LoopDepth.h new file mode 100644 index 00000000000..76a590c31f2 --- /dev/null +++ b/include/llvm/Analysis/LoopDepth.h @@ -0,0 +1,29 @@ +//===- llvm/Analysis/LoopDepth.h - Loop Depth Calculation --------*- C++ -*--=// +// +// This file provides a simple class to calculate the loop depth of a +// BasicBlock. +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_ANALYSIS_LOOP_DEPTH_H +#define LLVM_ANALYSIS_LOOP_DEPTH_H + +#include +class BasicBlock; +class Method; +namespace cfg {class Interval; } + +class LoopDepthCalculator { + map LoopDepth; + inline void AddBB(const BasicBlock *BB); // Increment count for this block + inline void ProcessInterval(cfg::Interval *I); +public: + LoopDepthCalculator(Method *M); + + inline unsigned getLoopDepth(const BasicBlock *BB) const { + map::const_iterator I = LoopDepth.find(BB); + return I != LoopDepth.end() ? I->second : 0; + } +}; + +#endif