-//===-- Support/TarjanSCCIterator.h -Generic Tarjan SCC iterator -*- C++ -*--=//
+//===---- ADT/SCCIterator.h - Strongly Connected Comp. Iter. ----*- C++ -*-===//
//
-// This builds on the Support/GraphTraits.h file to find the strongly
-// connected components (SCCs) of a graph in O(N+E) time using
-// Tarjan's DFS algorithm.
+// The LLVM Compiler Infrastructure
//
-// The SCC iterator has the important property that if a node in SCC S1
-// has an edge to a node in SCC S2, then it visits S1 *after* S2.
-//
-// To visit S1 *before* S2, use the TarjanSCCIterator on the Inverse graph.
-// (NOTE: This requires some simple wrappers and is not supported yet.)
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+/// \file
+///
+/// This builds on the llvm/ADT/GraphTraits.h file to find the strongly
+/// connected components (SCCs) of a graph in O(N+E) time using Tarjan's DFS
+/// algorithm.
+///
+/// The SCC iterator has the important property that if a node in SCC S1 has an
+/// edge to a node in SCC S2, then it visits S1 *after* S2.
+///
+/// To visit S1 *before* S2, use the scc_iterator on the Inverse graph. (NOTE:
+/// This requires some simple wrappers and is not supported yet.)
+///
//===----------------------------------------------------------------------===//
-#ifndef LLVM_SUPPORT_TARJANSCC_ITERATOR_H
-#define LLVM_SUPPORT_TARJANSCC_ITERATOR_H
+#ifndef LLVM_ADT_SCCITERATOR_H
+#define LLVM_ADT_SCCITERATOR_H
-#include "Support/GraphTraits.h"
-#include <Support/Statistic.h>
-#include <Support/iterator>
+#include "llvm/ADT/DenseMap.h"
+#include "llvm/ADT/GraphTraits.h"
+#include "llvm/ADT/iterator.h"
#include <vector>
-#include <stack>
-#include <map>
-
-
-//--------------------------------------------------------------------------
-// class SCC : A simple representation of an SCC in a generic Graph.
-//--------------------------------------------------------------------------
-
-template<class GraphT, class GT = GraphTraits<GraphT> >
-struct SCC: public std::vector<typename GT::NodeType*> {
+namespace llvm {
+
+/// \brief Enumerate the SCCs of a directed graph in reverse topological order
+/// of the SCC DAG.
+///
+/// This is implemented using Tarjan's DFS algorithm using an internal stack to
+/// build up a vector of nodes in a particular SCC. Note that it is a forward
+/// iterator and thus you cannot backtrack or re-visit nodes.
+template <class GraphT, class GT = GraphTraits<GraphT>>
+class scc_iterator
+ : public iterator_facade_base<
+ scc_iterator<GraphT, GT>, std::forward_iterator_tag,
+ const std::vector<typename GT::NodeType *>, ptrdiff_t> {
typedef typename GT::NodeType NodeType;
typedef typename GT::ChildIteratorType ChildItTy;
+ typedef std::vector<NodeType *> SccTy;
+ typedef typename scc_iterator::reference reference;
+
+ /// Element of VisitStack during DFS.
+ struct StackElement {
+ NodeType *Node; ///< The current node pointer.
+ ChildItTy NextChild; ///< The next child, modified inplace during DFS.
+ unsigned MinVisited; ///< Minimum uplink value of all children of Node.
+
+ StackElement(NodeType *Node, const ChildItTy &Child, unsigned Min)
+ : Node(Node), NextChild(Child), MinVisited(Min) {}
+
+ bool operator==(const StackElement &Other) const {
+ return Node == Other.Node &&
+ NextChild == Other.NextChild &&
+ MinVisited == Other.MinVisited;
+ }
+ };
+
+ /// The visit counters used to detect when a complete SCC is on the stack.
+ /// visitNum is the global counter.
+ ///
+ /// nodeVisitNumbers are per-node visit numbers, also used as DFS flags.
+ unsigned visitNum;
+ DenseMap<NodeType *, unsigned> nodeVisitNumbers;
+
+ /// Stack holding nodes of the SCC.
+ std::vector<NodeType *> SCCNodeStack;
+
+ /// The current SCC, retrieved using operator*().
+ SccTy CurrentSCC;
- typedef std::vector<typename GT::NodeType*> super;
- typedef typename super::iterator iterator;
- typedef typename super::const_iterator const_iterator;
- typedef typename super::reverse_iterator reverse_iterator;
- typedef typename super::const_reverse_iterator const_reverse_iterator;
-
- // HasLoop() -- Test if this SCC has a loop. If it has more than one
- // node, this is trivially true. If not, it may still contain a loop
- // if the node has an edge back to itself.
- bool HasLoop() const {
- if (size() > 1) return true;
- NodeType* N = front();
- for (ChildItTy CI=GT::child_begin(N), CE=GT::child_end(N); CI != CE; ++CI)
- if (*CI == N)
- return true;
- return false;
- }
-};
-
-//--------------------------------------------------------------------------
-// class TarjanSCC_iterator: Enumerate the SCCs of a directed graph, in
-// reverse topological order of the SCC DAG.
-//--------------------------------------------------------------------------
+ /// DFS stack, Used to maintain the ordering. The top contains the current
+ /// node, the next child to visit, and the minimum uplink value of all child
+ std::vector<StackElement> VisitStack;
-namespace {
- Statistic<> NumSCCs("NumSCCs", "Number of Strongly Connected Components");
- Statistic<> MaxSCCSize("MaxSCCSize", "Size of largest Strongly Connected Component");
-}
+ /// A single "visit" within the non-recursive DFS traversal.
+ void DFSVisitOne(NodeType *N);
-template<class GraphT, class GT = GraphTraits<GraphT> >
-class TarjanSCC_iterator : public forward_iterator<SCC<GraphT, GT>, ptrdiff_t>
-{
- typedef SCC<GraphT, GT> SccTy;
- typedef forward_iterator<SccTy, ptrdiff_t> super;
- typedef typename super::reference reference;
- typedef typename super::pointer pointer;
- typedef typename GT::NodeType NodeType;
- typedef typename GT::ChildIteratorType ChildItTy;
+ /// The stack-based DFS traversal; defined below.
+ void DFSVisitChildren();
- // The visit counters used to detect when a complete SCC is on the stack.
- // visitNum is the global counter.
- // nodeVisitNumbers are per-node visit numbers, also used as DFS flags.
- unsigned long visitNum;
- std::map<NodeType *, unsigned long> nodeVisitNumbers;
+ /// Compute the next SCC using the DFS traversal.
+ void GetNextSCC();
- // SCCNodeStack - Stack holding nodes of the SCC.
- std::stack<NodeType *> SCCNodeStack;
+ scc_iterator(NodeType *entryN) : visitNum(0) {
+ DFSVisitOne(entryN);
+ GetNextSCC();
+ }
- // CurrentSCC - The current SCC, retrieved using operator*().
- SccTy CurrentSCC;
+ /// End is when the DFS stack is empty.
+ scc_iterator() {}
- // VisitStack - Used to maintain the ordering. Top = current block
- // First element is basic block pointer, second is the 'next child' to visit
- std::stack<std::pair<NodeType *, ChildItTy> > VisitStack;
-
- // MinVistNumStack - Stack holding the "min" values for each node in the DFS.
- // This is used to track the minimum uplink values for all children of
- // the corresponding node on the VisitStack.
- std::stack<unsigned long> MinVisitNumStack;
-
- // A single "visit" within the non-recursive DFS traversal.
- void DFSVisitOne(NodeType* N) {
- ++visitNum; // Global counter for the visit order
- nodeVisitNumbers[N] = visitNum;
- SCCNodeStack.push(N);
- MinVisitNumStack.push(visitNum);
- VisitStack.push(make_pair(N, GT::child_begin(N)));
- DEBUG(std::cerr << "TarjanSCC: Node " << N <<
- " : visitNum = " << visitNum << "\n");
+public:
+ static scc_iterator begin(const GraphT &G) {
+ return scc_iterator(GT::getEntryNode(G));
}
+ static scc_iterator end(const GraphT &) { return scc_iterator(); }
- // The stack-based DFS traversal; defined below.
- void DFSVisitChildren() {
- assert(!VisitStack.empty());
- while (VisitStack.top().second != GT::child_end(VisitStack.top().first))
- { // TOS has at least one more child so continue DFS
- NodeType *childN = *VisitStack.top().second++;
- if (nodeVisitNumbers.find(childN) == nodeVisitNumbers.end())
- { // this node has never been seen
- DFSVisitOne(childN);
- }
- else
- {
- unsigned long childNum = nodeVisitNumbers[childN];
- if (MinVisitNumStack.top() > childNum)
- MinVisitNumStack.top() = childNum;
- }
- }
+ /// \brief Direct loop termination test which is more efficient than
+ /// comparison with \c end().
+ bool isAtEnd() const {
+ assert(!CurrentSCC.empty() || VisitStack.empty());
+ return CurrentSCC.empty();
}
- // Compute the next SCC using the DFS traversal.
- void GetNextSCC() {
- assert(VisitStack.size() == MinVisitNumStack.size());
- CurrentSCC.clear(); // Prepare to compute the next SCC
- while (! VisitStack.empty())
- {
- DFSVisitChildren();
-
- assert(VisitStack.top().second==GT::child_end(VisitStack.top().first));
- NodeType* visitingN = VisitStack.top().first;
- unsigned long minVisitNum = MinVisitNumStack.top();
- VisitStack.pop();
- MinVisitNumStack.pop();
- if (! MinVisitNumStack.empty() && MinVisitNumStack.top() > minVisitNum)
- MinVisitNumStack.top() = minVisitNum;
-
- DEBUG(std::cerr << "TarjanSCC: Popped node " << visitingN <<
- " : minVisitNum = " << minVisitNum << "; Node visit num = " <<
- nodeVisitNumbers[visitingN] << "\n");
-
- if (minVisitNum == nodeVisitNumbers[visitingN])
- { // A full SCC is on the SCCNodeStack! It includes all nodes below
- // visitingN on the stack. Copy those nodes to CurrentSCC,
- // reset their minVisit values, and return (this suspends
- // the DFS traversal till the next ++).
- do {
- CurrentSCC.push_back(SCCNodeStack.top());
- SCCNodeStack.pop();
- nodeVisitNumbers[CurrentSCC.back()] = ~0UL;
- } while (CurrentSCC.back() != visitingN);
-
- ++NumSCCs;
- if (CurrentSCC.size() > MaxSCCSize) MaxSCCSize = CurrentSCC.size();
-
- return;
- }
- }
+ bool operator==(const scc_iterator &x) const {
+ return VisitStack == x.VisitStack && CurrentSCC == x.CurrentSCC;
}
- inline TarjanSCC_iterator(NodeType *entryN) : visitNum(0) {
- DFSVisitOne(entryN);
+ scc_iterator &operator++() {
GetNextSCC();
+ return *this;
}
- inline TarjanSCC_iterator() { /* End is when DFS stack is empty */ }
-
-public:
- typedef TarjanSCC_iterator<GraphT, GT> _Self;
-
- // Provide static "constructors"...
- static inline _Self begin(GraphT& G) { return _Self(GT::getEntryNode(G)); }
- static inline _Self end (GraphT& G) { return _Self(); }
- // Direct loop termination test (I.fini() is more efficient than I == end())
- inline bool fini() const {
- return VisitStack.empty();
+ reference operator*() const {
+ assert(!CurrentSCC.empty() && "Dereferencing END SCC iterator!");
+ return CurrentSCC;
}
- inline bool operator==(const _Self& x) const {
- return VisitStack == x.VisitStack;
+ /// \brief Test if the current SCC has a loop.
+ ///
+ /// If the SCC has more than one node, this is trivially true. If not, it may
+ /// still contain a loop if the node has an edge back to itself.
+ bool hasLoop() const;
+
+ /// This informs the \c scc_iterator that the specified \c Old node
+ /// has been deleted, and \c New is to be used in its place.
+ void ReplaceNode(NodeType *Old, NodeType *New) {
+ assert(nodeVisitNumbers.count(Old) && "Old not in scc_iterator?");
+ nodeVisitNumbers[New] = nodeVisitNumbers[Old];
+ nodeVisitNumbers.erase(Old);
}
- inline bool operator!=(const _Self& x) const { return !operator==(x); }
+};
- // Iterator traversal: forward iteration only
- inline _Self& operator++() { // Preincrement
- GetNextSCC();
- return *this;
- }
- inline _Self operator++(int) { // Postincrement
- _Self tmp = *this; ++*this; return tmp;
+template <class GraphT, class GT>
+void scc_iterator<GraphT, GT>::DFSVisitOne(NodeType *N) {
+ ++visitNum;
+ nodeVisitNumbers[N] = visitNum;
+ SCCNodeStack.push_back(N);
+ VisitStack.push_back(StackElement(N, GT::child_begin(N), visitNum));
+#if 0 // Enable if needed when debugging.
+ dbgs() << "TarjanSCC: Node " << N <<
+ " : visitNum = " << visitNum << "\n";
+#endif
+}
+
+template <class GraphT, class GT>
+void scc_iterator<GraphT, GT>::DFSVisitChildren() {
+ assert(!VisitStack.empty());
+ while (VisitStack.back().NextChild != GT::child_end(VisitStack.back().Node)) {
+ // TOS has at least one more child so continue DFS
+ NodeType *childN = *VisitStack.back().NextChild++;
+ typename DenseMap<NodeType *, unsigned>::iterator Visited =
+ nodeVisitNumbers.find(childN);
+ if (Visited == nodeVisitNumbers.end()) {
+ // this node has never been seen.
+ DFSVisitOne(childN);
+ continue;
+ }
+
+ unsigned childNum = Visited->second;
+ if (VisitStack.back().MinVisited > childNum)
+ VisitStack.back().MinVisited = childNum;
}
+}
+
+template <class GraphT, class GT> void scc_iterator<GraphT, GT>::GetNextSCC() {
+ CurrentSCC.clear(); // Prepare to compute the next SCC
+ while (!VisitStack.empty()) {
+ DFSVisitChildren();
+
+ // Pop the leaf on top of the VisitStack.
+ NodeType *visitingN = VisitStack.back().Node;
+ unsigned minVisitNum = VisitStack.back().MinVisited;
+ assert(VisitStack.back().NextChild == GT::child_end(visitingN));
+ VisitStack.pop_back();
+
+ // Propagate MinVisitNum to parent so we can detect the SCC starting node.
+ if (!VisitStack.empty() && VisitStack.back().MinVisited > minVisitNum)
+ VisitStack.back().MinVisited = minVisitNum;
+
+#if 0 // Enable if needed when debugging.
+ dbgs() << "TarjanSCC: Popped node " << visitingN <<
+ " : minVisitNum = " << minVisitNum << "; Node visit num = " <<
+ nodeVisitNumbers[visitingN] << "\n";
+#endif
- // Retrieve a pointer to the current SCC. Returns NULL when done.
- inline const SccTy* operator*() const {
- assert(!CurrentSCC.empty() || fini());
- return CurrentSCC.empty()? NULL : &CurrentSCC;
+ if (minVisitNum != nodeVisitNumbers[visitingN])
+ continue;
+
+ // A full SCC is on the SCCNodeStack! It includes all nodes below
+ // visitingN on the stack. Copy those nodes to CurrentSCC,
+ // reset their minVisit values, and return (this suspends
+ // the DFS traversal till the next ++).
+ do {
+ CurrentSCC.push_back(SCCNodeStack.back());
+ SCCNodeStack.pop_back();
+ nodeVisitNumbers[CurrentSCC.back()] = ~0U;
+ } while (CurrentSCC.back() != visitingN);
+ return;
}
- inline SccTy* operator*() {
- assert(!CurrentSCC.empty() || fini());
- return CurrentSCC.empty()? NULL : &CurrentSCC;
+}
+
+template <class GraphT, class GT>
+bool scc_iterator<GraphT, GT>::hasLoop() const {
+ assert(!CurrentSCC.empty() && "Dereferencing END SCC iterator!");
+ if (CurrentSCC.size() > 1)
+ return true;
+ NodeType *N = CurrentSCC.front();
+ for (ChildItTy CI = GT::child_begin(N), CE = GT::child_end(N); CI != CE;
+ ++CI)
+ if (*CI == N)
+ return true;
+ return false;
}
-};
+/// \brief Construct the begin iterator for a deduced graph type T.
+template <class T> scc_iterator<T> scc_begin(const T &G) {
+ return scc_iterator<T>::begin(G);
+}
-// Global constructor for the Tarjan SCC iterator. Use *I == NULL or I.fini()
-// to test termination efficiently, instead of I == the "end" iterator.
-template <class T>
-TarjanSCC_iterator<T> tarj_begin(T G)
-{
- return TarjanSCC_iterator<T>::begin(G);
+/// \brief Construct the end iterator for a deduced graph type T.
+template <class T> scc_iterator<T> scc_end(const T &G) {
+ return scc_iterator<T>::end(G);
}
-template <class T>
-TarjanSCC_iterator<T> tarj_end(T G)
-{
- return TarjanSCC_iterator<T>::end(G);
+/// \brief Construct the begin iterator for a deduced graph type T's Inverse<T>.
+template <class T> scc_iterator<Inverse<T> > scc_begin(const Inverse<T> &G) {
+ return scc_iterator<Inverse<T> >::begin(G);
}
-//===----------------------------------------------------------------------===//
+/// \brief Construct the end iterator for a deduced graph type T's Inverse<T>.
+template <class T> scc_iterator<Inverse<T> > scc_end(const Inverse<T> &G) {
+ return scc_iterator<Inverse<T> >::end(G);
+}
+
+} // End llvm namespace
#endif
projects / oota-llvm.git / blobdiff