2002-02-12 21:02:53 +00:00
|
|
|
//===-- llvm/Support/CFG.h - Process LLVM structures as graphs ---*- C++ -*--=//
|
|
|
|
//
|
2002-04-07 20:49:59 +00:00
|
|
|
// This file defines specializations of GraphTraits that allow Function and
|
2002-02-12 21:02:53 +00:00
|
|
|
// BasicBlock graphs to be treated as proper graphs for generic algorithms.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#ifndef LLVM_CFG_H
|
|
|
|
#define LLVM_CFG_H
|
|
|
|
|
|
|
|
#include "Support/GraphTraits.h"
|
2002-04-07 20:49:59 +00:00
|
|
|
#include "llvm/Function.h"
|
2002-02-12 22:35:32 +00:00
|
|
|
#include "llvm/InstrTypes.h"
|
2002-07-24 22:08:53 +00:00
|
|
|
#include "Support/iterator"
|
2002-02-12 22:35:32 +00:00
|
|
|
|
|
|
|
//===--------------------------------------------------------------------===//
|
|
|
|
// BasicBlock pred_iterator definition
|
|
|
|
//===--------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
template <class _Ptr, class _USE_iterator> // Predecessor Iterator
|
2002-07-24 22:08:53 +00:00
|
|
|
class PredIterator : public bidirectional_iterator<_Ptr, ptrdiff_t> {
|
|
|
|
typedef bidirectional_iterator<_Ptr, ptrdiff_t> super;
|
2002-02-12 22:35:32 +00:00
|
|
|
_Ptr *BB;
|
|
|
|
_USE_iterator It;
|
|
|
|
public:
|
|
|
|
typedef PredIterator<_Ptr,_USE_iterator> _Self;
|
2002-07-24 22:08:53 +00:00
|
|
|
typedef typename super::pointer pointer;
|
2002-02-12 22:35:32 +00:00
|
|
|
|
|
|
|
inline PredIterator(_Ptr *bb) : BB(bb), It(bb->use_begin()) {
|
|
|
|
}
|
|
|
|
inline PredIterator(_Ptr *bb, bool) : BB(bb), It(bb->use_end()) {}
|
|
|
|
|
|
|
|
inline bool operator==(const _Self& x) const { return It == x.It; }
|
|
|
|
inline bool operator!=(const _Self& x) const { return !operator==(x); }
|
|
|
|
|
|
|
|
inline pointer operator*() const {
|
|
|
|
assert(It != BB->use_end() && "pred_iterator out of range!");
|
2003-04-25 23:39:08 +00:00
|
|
|
return cast<TerminatorInst>(*It)->getParent();
|
2002-02-12 22:35:32 +00:00
|
|
|
}
|
|
|
|
inline pointer *operator->() const { return &(operator*()); }
|
|
|
|
|
|
|
|
inline _Self& operator++() { // Preincrement
|
|
|
|
assert(It != BB->use_end() && "pred_iterator out of range!");
|
2003-04-25 23:39:08 +00:00
|
|
|
++It;
|
2002-02-12 22:35:32 +00:00
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
inline _Self operator++(int) { // Postincrement
|
|
|
|
_Self tmp = *this; ++*this; return tmp;
|
|
|
|
}
|
|
|
|
|
|
|
|
inline _Self& operator--() { --It; return *this; } // Predecrement
|
|
|
|
inline _Self operator--(int) { // Postdecrement
|
|
|
|
_Self tmp = *this; --*this; return tmp;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
typedef PredIterator<BasicBlock, Value::use_iterator> pred_iterator;
|
|
|
|
typedef PredIterator<const BasicBlock,
|
|
|
|
Value::use_const_iterator> pred_const_iterator;
|
|
|
|
|
|
|
|
inline pred_iterator pred_begin(BasicBlock *BB) { return pred_iterator(BB); }
|
|
|
|
inline pred_const_iterator pred_begin(const BasicBlock *BB) {
|
|
|
|
return pred_const_iterator(BB);
|
|
|
|
}
|
|
|
|
inline pred_iterator pred_end(BasicBlock *BB) { return pred_iterator(BB, true);}
|
|
|
|
inline pred_const_iterator pred_end(const BasicBlock *BB) {
|
|
|
|
return pred_const_iterator(BB, true);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
//===--------------------------------------------------------------------===//
|
|
|
|
// BasicBlock succ_iterator definition
|
|
|
|
//===--------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
template <class _Term, class _BB> // Successor Iterator
|
2002-07-24 22:08:53 +00:00
|
|
|
class SuccIterator : public bidirectional_iterator<_BB, ptrdiff_t> {
|
2002-02-12 22:35:32 +00:00
|
|
|
const _Term Term;
|
|
|
|
unsigned idx;
|
2002-07-24 22:08:53 +00:00
|
|
|
typedef bidirectional_iterator<_BB, ptrdiff_t> super;
|
2002-02-12 22:35:32 +00:00
|
|
|
public:
|
|
|
|
typedef SuccIterator<_Term, _BB> _Self;
|
2002-07-24 22:08:53 +00:00
|
|
|
typedef typename super::pointer pointer;
|
2002-02-12 22:35:32 +00:00
|
|
|
// TODO: This can be random access iterator, need operator+ and stuff tho
|
|
|
|
|
|
|
|
inline SuccIterator(_Term T) : Term(T), idx(0) { // begin iterator
|
|
|
|
assert(T && "getTerminator returned null!");
|
|
|
|
}
|
|
|
|
inline SuccIterator(_Term T, bool) // end iterator
|
|
|
|
: Term(T), idx(Term->getNumSuccessors()) {
|
|
|
|
assert(T && "getTerminator returned null!");
|
|
|
|
}
|
2002-10-07 16:53:22 +00:00
|
|
|
|
|
|
|
inline const _Self &operator=(const _Self &I) {
|
|
|
|
assert(Term == I.Term &&"Cannot assign iterators to two different blocks!");
|
|
|
|
idx = I.idx;
|
2002-10-07 17:13:22 +00:00
|
|
|
return *this;
|
2002-10-07 16:53:22 +00:00
|
|
|
}
|
2002-02-12 22:35:32 +00:00
|
|
|
|
|
|
|
inline bool operator==(const _Self& x) const { return idx == x.idx; }
|
|
|
|
inline bool operator!=(const _Self& x) const { return !operator==(x); }
|
|
|
|
|
|
|
|
inline pointer operator*() const { return Term->getSuccessor(idx); }
|
|
|
|
inline pointer operator->() const { return operator*(); }
|
|
|
|
|
|
|
|
inline _Self& operator++() { ++idx; return *this; } // Preincrement
|
|
|
|
inline _Self operator++(int) { // Postincrement
|
|
|
|
_Self tmp = *this; ++*this; return tmp;
|
|
|
|
}
|
|
|
|
|
|
|
|
inline _Self& operator--() { --idx; return *this; } // Predecrement
|
|
|
|
inline _Self operator--(int) { // Postdecrement
|
|
|
|
_Self tmp = *this; --*this; return tmp;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
typedef SuccIterator<TerminatorInst*, BasicBlock> succ_iterator;
|
|
|
|
typedef SuccIterator<const TerminatorInst*,
|
|
|
|
const BasicBlock> succ_const_iterator;
|
|
|
|
|
|
|
|
inline succ_iterator succ_begin(BasicBlock *BB) {
|
|
|
|
return succ_iterator(BB->getTerminator());
|
|
|
|
}
|
|
|
|
inline succ_const_iterator succ_begin(const BasicBlock *BB) {
|
|
|
|
return succ_const_iterator(BB->getTerminator());
|
|
|
|
}
|
|
|
|
inline succ_iterator succ_end(BasicBlock *BB) {
|
|
|
|
return succ_iterator(BB->getTerminator(), true);
|
|
|
|
}
|
|
|
|
inline succ_const_iterator succ_end(const BasicBlock *BB) {
|
|
|
|
return succ_const_iterator(BB->getTerminator(), true);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2002-02-12 21:02:53 +00:00
|
|
|
|
|
|
|
//===--------------------------------------------------------------------===//
|
|
|
|
// GraphTraits specializations for basic block graphs (CFGs)
|
|
|
|
//===--------------------------------------------------------------------===//
|
|
|
|
|
2002-04-07 20:49:59 +00:00
|
|
|
// Provide specializations of GraphTraits to be able to treat a function as a
|
2002-02-12 21:02:53 +00:00
|
|
|
// graph of basic blocks...
|
|
|
|
|
|
|
|
template <> struct GraphTraits<BasicBlock*> {
|
|
|
|
typedef BasicBlock NodeType;
|
2002-02-12 22:35:32 +00:00
|
|
|
typedef succ_iterator ChildIteratorType;
|
2002-02-12 21:02:53 +00:00
|
|
|
|
|
|
|
static NodeType *getEntryNode(BasicBlock *BB) { return BB; }
|
|
|
|
static inline ChildIteratorType child_begin(NodeType *N) {
|
2002-02-12 22:35:32 +00:00
|
|
|
return succ_begin(N);
|
2002-02-12 21:02:53 +00:00
|
|
|
}
|
|
|
|
static inline ChildIteratorType child_end(NodeType *N) {
|
2002-02-12 22:35:32 +00:00
|
|
|
return succ_end(N);
|
2002-02-12 21:02:53 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
template <> struct GraphTraits<const BasicBlock*> {
|
|
|
|
typedef const BasicBlock NodeType;
|
2002-02-12 22:35:32 +00:00
|
|
|
typedef succ_const_iterator ChildIteratorType;
|
2002-02-12 21:02:53 +00:00
|
|
|
|
|
|
|
static NodeType *getEntryNode(const BasicBlock *BB) { return BB; }
|
|
|
|
|
|
|
|
static inline ChildIteratorType child_begin(NodeType *N) {
|
2002-02-12 22:35:32 +00:00
|
|
|
return succ_begin(N);
|
2002-02-12 21:02:53 +00:00
|
|
|
}
|
|
|
|
static inline ChildIteratorType child_end(NodeType *N) {
|
2002-02-12 22:35:32 +00:00
|
|
|
return succ_end(N);
|
2002-02-12 21:02:53 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2002-04-07 20:49:59 +00:00
|
|
|
// Provide specializations of GraphTraits to be able to treat a function as a
|
2002-02-12 21:02:53 +00:00
|
|
|
// graph of basic blocks... and to walk it in inverse order. Inverse order for
|
2002-04-07 20:49:59 +00:00
|
|
|
// a function is considered to be when traversing the predecessor edges of a BB
|
2002-02-12 21:02:53 +00:00
|
|
|
// instead of the successor edges.
|
|
|
|
//
|
|
|
|
template <> struct GraphTraits<Inverse<BasicBlock*> > {
|
|
|
|
typedef BasicBlock NodeType;
|
2002-02-12 22:35:32 +00:00
|
|
|
typedef pred_iterator ChildIteratorType;
|
2002-02-12 21:02:53 +00:00
|
|
|
static NodeType *getEntryNode(Inverse<BasicBlock *> G) { return G.Graph; }
|
|
|
|
static inline ChildIteratorType child_begin(NodeType *N) {
|
2002-02-12 22:35:32 +00:00
|
|
|
return pred_begin(N);
|
2002-02-12 21:02:53 +00:00
|
|
|
}
|
|
|
|
static inline ChildIteratorType child_end(NodeType *N) {
|
2002-02-12 22:35:32 +00:00
|
|
|
return pred_end(N);
|
2002-02-12 21:02:53 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
template <> struct GraphTraits<Inverse<const BasicBlock*> > {
|
|
|
|
typedef const BasicBlock NodeType;
|
2002-02-12 22:35:32 +00:00
|
|
|
typedef pred_const_iterator ChildIteratorType;
|
2002-02-12 21:02:53 +00:00
|
|
|
static NodeType *getEntryNode(Inverse<const BasicBlock*> G) {
|
|
|
|
return G.Graph;
|
|
|
|
}
|
|
|
|
static inline ChildIteratorType child_begin(NodeType *N) {
|
2002-02-12 22:35:32 +00:00
|
|
|
return pred_begin(N);
|
2002-02-12 21:02:53 +00:00
|
|
|
}
|
|
|
|
static inline ChildIteratorType child_end(NodeType *N) {
|
2002-02-12 22:35:32 +00:00
|
|
|
return pred_end(N);
|
2002-02-12 21:02:53 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
//===--------------------------------------------------------------------===//
|
2002-04-07 20:49:59 +00:00
|
|
|
// GraphTraits specializations for function basic block graphs (CFGs)
|
2002-02-12 21:02:53 +00:00
|
|
|
//===--------------------------------------------------------------------===//
|
|
|
|
|
2002-04-07 20:49:59 +00:00
|
|
|
// Provide specializations of GraphTraits to be able to treat a function as a
|
2002-02-12 21:02:53 +00:00
|
|
|
// graph of basic blocks... these are the same as the basic block iterators,
|
2002-04-07 20:49:59 +00:00
|
|
|
// except that the root node is implicitly the first node of the function.
|
2002-02-12 21:02:53 +00:00
|
|
|
//
|
2002-04-07 20:49:59 +00:00
|
|
|
template <> struct GraphTraits<Function*> : public GraphTraits<BasicBlock*> {
|
2002-06-25 16:13:24 +00:00
|
|
|
static NodeType *getEntryNode(Function *F) { return &F->getEntryNode(); }
|
2002-10-10 22:31:31 +00:00
|
|
|
|
|
|
|
// nodes_iterator/begin/end - Allow iteration over all nodes in the graph
|
|
|
|
typedef Function::iterator nodes_iterator;
|
|
|
|
static nodes_iterator nodes_begin(Function *F) { return F->begin(); }
|
|
|
|
static nodes_iterator nodes_end (Function *F) { return F->end(); }
|
2002-02-12 21:02:53 +00:00
|
|
|
};
|
2002-04-07 20:49:59 +00:00
|
|
|
template <> struct GraphTraits<const Function*> :
|
2002-02-12 21:02:53 +00:00
|
|
|
public GraphTraits<const BasicBlock*> {
|
2002-06-25 16:13:24 +00:00
|
|
|
static NodeType *getEntryNode(const Function *F) { return &F->getEntryNode();}
|
2002-10-10 22:31:31 +00:00
|
|
|
|
|
|
|
// nodes_iterator/begin/end - Allow iteration over all nodes in the graph
|
|
|
|
typedef Function::const_iterator nodes_iterator;
|
|
|
|
static nodes_iterator nodes_begin(const Function *F) { return F->begin(); }
|
|
|
|
static nodes_iterator nodes_end (const Function *F) { return F->end(); }
|
2002-02-12 21:02:53 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
2002-04-07 20:49:59 +00:00
|
|
|
// Provide specializations of GraphTraits to be able to treat a function as a
|
2002-02-12 21:02:53 +00:00
|
|
|
// graph of basic blocks... and to walk it in inverse order. Inverse order for
|
2002-04-07 20:49:59 +00:00
|
|
|
// a function is considered to be when traversing the predecessor edges of a BB
|
2002-02-12 21:02:53 +00:00
|
|
|
// instead of the successor edges.
|
|
|
|
//
|
2002-04-07 20:49:59 +00:00
|
|
|
template <> struct GraphTraits<Inverse<Function*> > :
|
2002-02-12 21:02:53 +00:00
|
|
|
public GraphTraits<Inverse<BasicBlock*> > {
|
2002-04-07 20:49:59 +00:00
|
|
|
static NodeType *getEntryNode(Inverse<Function*> G) {
|
2002-06-25 16:13:24 +00:00
|
|
|
return &G.Graph->getEntryNode();
|
2002-04-07 20:49:59 +00:00
|
|
|
}
|
2002-02-12 21:02:53 +00:00
|
|
|
};
|
2002-04-07 20:49:59 +00:00
|
|
|
template <> struct GraphTraits<Inverse<const Function*> > :
|
2002-02-12 21:02:53 +00:00
|
|
|
public GraphTraits<Inverse<const BasicBlock*> > {
|
2002-04-07 20:49:59 +00:00
|
|
|
static NodeType *getEntryNode(Inverse<const Function *> G) {
|
2002-06-25 16:13:24 +00:00
|
|
|
return &G.Graph->getEntryNode();
|
2002-02-12 21:02:53 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|