1 //===- IntervalIterator.h - Interval Iterator Declaration --------*- C++ -*--=//
3 // This file defines an iterator that enumerates the intervals in a control flow
4 // graph of some sort. This iterator is parametric, allowing iterator over the
5 // following types of graphs:
7 // 1. A Function* object, composed of BasicBlock nodes.
8 // 2. An IntervalPartition& object, composed of Interval nodes.
10 // This iterator is defined to walk the control flow graph, returning intervals
11 // in depth first order. These intervals are completely filled in except for
12 // the predecessor fields (the successor information is filled in however).
14 // By default, the intervals created by this iterator are deleted after they
15 // are no longer any use to the iterator. This behavior can be changed by
16 // passing a false value into the intervals_begin() function. This causes the
17 // IOwnMem member to be set, and the intervals to not be deleted.
19 // It is only safe to use this if all of the intervals are deleted by the caller
20 // and all of the intervals are processed. However, the user of the iterator is
21 // not allowed to modify or delete the intervals until after the iterator has
22 // been used completely. The IntervalPartition class uses this functionality.
24 //===----------------------------------------------------------------------===//
26 #ifndef LLVM_INTERVAL_ITERATOR_H
27 #define LLVM_INTERVAL_ITERATOR_H
29 #include "llvm/Analysis/IntervalPartition.h"
30 #include "llvm/Function.h"
31 #include "llvm/Support/CFG.h"
36 // getNodeHeader - Given a source graph node and the source graph, return the
37 // BasicBlock that is the header node. This is the opposite of
38 // getSourceGraphNode.
40 inline BasicBlock *getNodeHeader(BasicBlock *BB) { return BB; }
41 inline BasicBlock *getNodeHeader(Interval *I) { return I->getHeaderNode(); }
43 // getSourceGraphNode - Given a BasicBlock and the source graph, return the
44 // source graph node that corresponds to the BasicBlock. This is the opposite
47 inline BasicBlock *getSourceGraphNode(Function *, BasicBlock *BB) {
50 inline Interval *getSourceGraphNode(IntervalPartition *IP, BasicBlock *BB) {
51 return IP->getBlockInterval(BB);
54 // addNodeToInterval - This method exists to assist the generic ProcessNode
55 // with the task of adding a node to the new interval, depending on the
56 // type of the source node. In the case of a CFG source graph (BasicBlock
57 // case), the BasicBlock itself is added to the interval.
59 inline void addNodeToInterval(Interval *Int, BasicBlock *BB) {
60 Int->Nodes.push_back(BB);
63 // addNodeToInterval - This method exists to assist the generic ProcessNode
64 // with the task of adding a node to the new interval, depending on the
65 // type of the source node. In the case of a CFG source graph (BasicBlock
66 // case), the BasicBlock itself is added to the interval. In the case of
67 // an IntervalPartition source graph (Interval case), all of the member
68 // BasicBlocks are added to the interval.
70 inline void addNodeToInterval(Interval *Int, Interval *I) {
71 // Add all of the nodes in I as new nodes in Int.
72 copy(I->Nodes.begin(), I->Nodes.end(), back_inserter(Int->Nodes));
79 template<class NodeTy, class OrigContainer_t>
80 class IntervalIterator {
81 std::stack<std::pair<Interval*, typename Interval::succ_iterator> > IntStack;
82 std::set<BasicBlock*> Visited;
83 OrigContainer_t *OrigContainer;
84 bool IOwnMem; // If True, delete intervals when done with them
85 // See file header for conditions of use
87 typedef BasicBlock* _BB;
89 typedef IntervalIterator<NodeTy, OrigContainer_t> _Self;
90 typedef std::forward_iterator_tag iterator_category;
92 IntervalIterator() {} // End iterator, empty stack
93 IntervalIterator(Function *M, bool OwnMemory) : IOwnMem(OwnMemory) {
95 if (!ProcessInterval(&M->front())) {
96 assert(0 && "ProcessInterval should never fail for first interval!");
100 IntervalIterator(IntervalPartition &IP, bool OwnMemory) : IOwnMem(OwnMemory) {
102 if (!ProcessInterval(IP.getRootInterval())) {
103 assert(0 && "ProcessInterval should never fail for first interval!");
107 inline ~IntervalIterator() {
109 while (!IntStack.empty()) {
115 inline bool operator==(const _Self& x) const { return IntStack == x.IntStack;}
116 inline bool operator!=(const _Self& x) const { return !operator==(x); }
118 inline const Interval *operator*() const { return IntStack.top().first; }
119 inline Interval *operator*() { return IntStack.top().first; }
120 inline const Interval *operator->() const { return operator*(); }
121 inline Interval *operator->() { return operator*(); }
123 _Self& operator++() { // Preincrement
124 assert(!IntStack.empty() && "Attempting to use interval iterator at end!");
126 // All of the intervals on the stack have been visited. Try visiting
127 // their successors now.
128 Interval::succ_iterator &SuccIt = IntStack.top().second,
129 EndIt = succ_end(IntStack.top().first);
130 while (SuccIt != EndIt) { // Loop over all interval succs
131 bool Done = ProcessInterval(getSourceGraphNode(OrigContainer, *SuccIt));
132 ++SuccIt; // Increment iterator
133 if (Done) return *this; // Found a new interval! Use it!
136 // Free interval memory... if neccesary
137 if (IOwnMem) delete IntStack.top().first;
139 // We ran out of successors for this interval... pop off the stack
141 } while (!IntStack.empty());
145 inline _Self operator++(int) { // Postincrement
146 _Self tmp = *this; ++*this; return tmp;
150 // ProcessInterval - This method is used during the construction of the
151 // interval graph. It walks through the source graph, recursively creating
152 // an interval per invokation until the entire graph is covered. This uses
153 // the ProcessNode method to add all of the nodes to the interval.
155 // This method is templated because it may operate on two different source
156 // graphs: a basic block graph, or a preexisting interval graph.
158 bool ProcessInterval(NodeTy *Node) {
159 BasicBlock *Header = getNodeHeader(Node);
160 if (Visited.count(Header)) return false;
162 Interval *Int = new Interval(Header);
163 Visited.insert(Header); // The header has now been visited!
165 // Check all of our successors to see if they are in the interval...
166 for (typename NodeTy::succ_iterator I = succ_begin(Node),
167 E = succ_end(Node); I != E; ++I)
168 ProcessNode(Int, getSourceGraphNode(OrigContainer, *I));
170 IntStack.push(make_pair(Int, succ_begin(Int)));
174 // ProcessNode - This method is called by ProcessInterval to add nodes to the
175 // interval being constructed, and it is also called recursively as it walks
176 // the source graph. A node is added to the current interval only if all of
177 // its predecessors are already in the graph. This also takes care of keeping
178 // the successor set of an interval up to date.
180 // This method is templated because it may operate on two different source
181 // graphs: a basic block graph, or a preexisting interval graph.
183 void ProcessNode(Interval *Int, NodeTy *Node) {
184 assert(Int && "Null interval == bad!");
185 assert(Node && "Null Node == bad!");
187 BasicBlock *NodeHeader = getNodeHeader(Node);
189 if (Visited.count(NodeHeader)) { // Node already been visited?
190 if (Int->contains(NodeHeader)) { // Already in this interval...
192 } else { // In other interval, add as successor
193 if (!Int->isSuccessor(NodeHeader)) // Add only if not already in set
194 Int->Successors.push_back(NodeHeader);
196 } else { // Otherwise, not in interval yet
197 for (typename NodeTy::pred_iterator I = pred_begin(Node),
198 E = pred_end(Node); I != E; ++I) {
199 if (!Int->contains(*I)) { // If pred not in interval, we can't be
200 if (!Int->isSuccessor(NodeHeader)) // Add only if not already in set
201 Int->Successors.push_back(NodeHeader);
202 return; // See you later
206 // If we get here, then all of the predecessors of BB are in the interval
207 // already. In this case, we must add BB to the interval!
208 addNodeToInterval(Int, Node);
209 Visited.insert(NodeHeader); // The node has now been visited!
211 if (Int->isSuccessor(NodeHeader)) {
212 // If we were in the successor list from before... remove from succ list
213 Int->Successors.erase(remove(Int->Successors.begin(),
214 Int->Successors.end(), NodeHeader),
215 Int->Successors.end());
218 // Now that we have discovered that Node is in the interval, perhaps some
219 // of its successors are as well?
220 for (typename NodeTy::succ_iterator It = succ_begin(Node),
221 End = succ_end(Node); It != End; ++It)
222 ProcessNode(Int, getSourceGraphNode(OrigContainer, *It));
227 typedef IntervalIterator<BasicBlock, Function> function_interval_iterator;
228 typedef IntervalIterator<Interval, IntervalPartition> interval_part_interval_iterator;
231 inline function_interval_iterator intervals_begin(Function *F,
232 bool DeleteInts = true) {
233 return function_interval_iterator(F, DeleteInts);
235 inline function_interval_iterator intervals_end(Function *) {
236 return function_interval_iterator();
239 inline interval_part_interval_iterator
240 intervals_begin(IntervalPartition &IP, bool DeleteIntervals = true) {
241 return interval_part_interval_iterator(IP, DeleteIntervals);
244 inline interval_part_interval_iterator intervals_end(IntervalPartition &IP) {
245 return interval_part_interval_iterator();