1 //===- RegionIterator.h - Iterators to iteratate over Regions ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
9 // This file defines the iterators to iterate over the elements of a Region.
10 //===----------------------------------------------------------------------===//
11 #ifndef LLVM_ANALYSIS_REGIONITERATOR_H
12 #define LLVM_ANALYSIS_REGIONITERATOR_H
14 #include "llvm/ADT/GraphTraits.h"
15 #include "llvm/ADT/PointerIntPair.h"
16 #include "llvm/ADT/SmallPtrSet.h"
17 #include "llvm/Analysis/RegionInfo.h"
18 #include "llvm/IR/CFG.h"
19 #include "llvm/Support/raw_ostream.h"
22 //===----------------------------------------------------------------------===//
23 /// @brief Hierarchical RegionNode successor iterator.
25 /// This iterator iterates over all successors of a RegionNode.
27 /// For a BasicBlock RegionNode it skips all BasicBlocks that are not part of
28 /// the parent Region. Furthermore for BasicBlocks that start a subregion, a
29 /// RegionNode representing the subregion is returned.
31 /// For a subregion RegionNode there is just one successor. The RegionNode
32 /// representing the exit of the subregion.
33 template<class NodeType, class BlockT, class RegionT>
34 class RNSuccIterator : public std::iterator<std::forward_iterator_tag,
35 NodeType, ptrdiff_t> {
36 typedef std::iterator<std::forward_iterator_tag, NodeType, ptrdiff_t> super;
38 typedef GraphTraits<BlockT*> BlockTraits;
39 typedef typename BlockTraits::ChildIteratorType SuccIterTy;
41 // The iterator works in two modes, bb mode or region mode.
43 // In BB mode it returns all successors of this BasicBlock as its
46 // In region mode there is only one successor, thats the regionnode mapping
47 // to the exit block of the regionnode
48 ItRgBegin, // At the beginning of the regionnode successor.
49 ItRgEnd // At the end of the regionnode successor.
52 // Use two bit to represent the mode iterator.
53 PointerIntPair<NodeType*, 2, ItMode> Node;
55 // The block successor iterator.
58 // advanceRegionSucc - A region node has only one successor. It reaches end
59 // once we advance it.
60 void advanceRegionSucc() {
61 assert(Node.getInt() == ItRgBegin && "Cannot advance region successor!");
65 NodeType* getNode() const{ return Node.getPointer(); }
67 // isRegionMode - Is the current iterator in region mode?
68 bool isRegionMode() const { return Node.getInt() != ItBB; }
70 // Get the immediate successor. This function may return a Basic Block
71 // RegionNode or a subregion RegionNode.
72 NodeType* getISucc(BlockT* BB) const {
74 succ = getNode()->getParent()->getNode(BB);
75 assert(succ && "BB not in Region or entered subregion!");
79 // getRegionSucc - Return the successor basic block of a SubRegion RegionNode.
80 inline BlockT* getRegionSucc() const {
81 assert(Node.getInt() == ItRgBegin && "Cannot get the region successor!");
82 return getNode()->template getNodeAs<RegionT>()->getExit();
85 // isExit - Is this the exit BB of the Region?
86 inline bool isExit(BlockT* BB) const {
87 return getNode()->getParent()->getExit() == BB;
90 typedef RNSuccIterator<NodeType, BlockT, RegionT> Self;
92 typedef typename super::pointer pointer;
94 /// @brief Create begin iterator of a RegionNode.
95 inline RNSuccIterator(NodeType* node)
96 : Node(node, node->isSubRegion() ? ItRgBegin : ItBB),
97 BItor(BlockTraits::child_begin(node->getEntry())) {
99 // Skip the exit block
101 while (BlockTraits::child_end(node->getEntry()) != BItor && isExit(*BItor))
104 if (isRegionMode() && isExit(getRegionSucc()))
108 /// @brief Create an end iterator.
109 inline RNSuccIterator(NodeType* node, bool)
110 : Node(node, node->isSubRegion() ? ItRgEnd : ItBB),
111 BItor(BlockTraits::child_end(node->getEntry())) {}
113 inline bool operator==(const Self& x) const {
114 assert(isRegionMode() == x.isRegionMode() && "Broken iterator!");
116 return Node.getInt() == x.Node.getInt();
118 return BItor == x.BItor;
121 inline bool operator!=(const Self& x) const { return !operator==(x); }
123 inline pointer operator*() const {
124 BlockT *BB = isRegionMode() ? getRegionSucc() : *BItor;
125 assert(!isExit(BB) && "Iterator out of range!");
129 inline Self& operator++() {
131 // The Region only has 1 successor.
137 while (BItor != BlockTraits::child_end(getNode()->getEntry())
143 inline Self operator++(int) {
149 inline const Self &operator=(const Self &I) {
151 assert(getNode()->getParent() == I.getNode()->getParent()
152 && "Cannot assign iterators of two different regions!");
161 //===----------------------------------------------------------------------===//
162 /// @brief Flat RegionNode iterator.
164 /// The Flat Region iterator will iterate over all BasicBlock RegionNodes that
165 /// are contained in the Region and its subregions. This is close to a virtual
166 /// control flow graph of the Region.
167 template<class NodeType, class BlockT, class RegionT>
168 class RNSuccIterator<FlatIt<NodeType>, BlockT, RegionT>
169 : public std::iterator<std::forward_iterator_tag, NodeType, ptrdiff_t> {
170 typedef std::iterator<std::forward_iterator_tag, NodeType, ptrdiff_t> super;
171 typedef GraphTraits<BlockT*> BlockTraits;
172 typedef typename BlockTraits::ChildIteratorType SuccIterTy;
178 typedef RNSuccIterator<FlatIt<NodeType>, BlockT, RegionT> Self;
179 typedef typename super::pointer pointer;
181 /// @brief Create the iterator from a RegionNode.
183 /// Note that the incoming node must be a bb node, otherwise it will trigger
184 /// an assertion when we try to get a BasicBlock.
185 inline RNSuccIterator(NodeType* node) :
187 Itor(BlockTraits::child_begin(node->getEntry())) {
188 assert(!Node->isSubRegion()
189 && "Subregion node not allowed in flat iterating mode!");
190 assert(Node->getParent() && "A BB node must have a parent!");
192 // Skip the exit block of the iterating region.
193 while (BlockTraits::child_end(Node->getEntry()) != Itor
194 && Node->getParent()->getExit() == *Itor)
198 /// @brief Create an end iterator
199 inline RNSuccIterator(NodeType* node, bool) :
201 Itor(BlockTraits::child_end(node->getEntry())) {
202 assert(!Node->isSubRegion()
203 && "Subregion node not allowed in flat iterating mode!");
206 inline bool operator==(const Self& x) const {
207 assert(Node->getParent() == x.Node->getParent()
208 && "Cannot compare iterators of different regions!");
210 return Itor == x.Itor && Node == x.Node;
213 inline bool operator!=(const Self& x) const { return !operator==(x); }
215 inline pointer operator*() const {
218 // Get the iterating region.
219 RegionT *Parent = Node->getParent();
221 // The only case that the successor reaches out of the region is it reaches
222 // the exit of the region.
223 assert(Parent->getExit() != BB && "iterator out of range!");
225 return Parent->getBBNode(BB);
228 inline Self& operator++() {
229 // Skip the exit block of the iterating region.
232 while (Itor != succ_end(Node->getEntry())
233 && Node->getParent()->getExit() == *Itor);
238 inline Self operator++(int) {
244 inline const Self &operator=(const Self &I) {
246 assert(Node->getParent() == I.Node->getParent()
247 && "Cannot assign iterators to two different regions!");
255 template<class NodeType, class BlockT, class RegionT>
256 inline RNSuccIterator<NodeType, BlockT, RegionT> succ_begin(NodeType* Node) {
257 return RNSuccIterator<NodeType, BlockT, RegionT>(Node);
260 template<class NodeType, class BlockT, class RegionT>
261 inline RNSuccIterator<NodeType, BlockT, RegionT> succ_end(NodeType* Node) {
262 return RNSuccIterator<NodeType, BlockT, RegionT>(Node, true);
265 //===--------------------------------------------------------------------===//
266 // RegionNode GraphTraits specialization so the bbs in the region can be
267 // iterate by generic graph iterators.
269 // NodeT can either be region node or const region node, otherwise child_begin
270 // and child_end fail.
272 #define RegionNodeGraphTraits(NodeT, BlockT, RegionT) \
273 template<> struct GraphTraits<NodeT*> { \
274 typedef NodeT NodeType; \
275 typedef RNSuccIterator<NodeType, BlockT, RegionT> ChildIteratorType; \
276 static NodeType *getEntryNode(NodeType* N) { return N; } \
277 static inline ChildIteratorType child_begin(NodeType *N) { \
278 return RNSuccIterator<NodeType, BlockT, RegionT>(N); \
280 static inline ChildIteratorType child_end(NodeType *N) { \
281 return RNSuccIterator<NodeType, BlockT, RegionT>(N, true); \
284 template<> struct GraphTraits<FlatIt<NodeT*>> { \
285 typedef NodeT NodeType; \
286 typedef RNSuccIterator<FlatIt<NodeT>, BlockT, RegionT > ChildIteratorType; \
287 static NodeType *getEntryNode(NodeType* N) { return N; } \
288 static inline ChildIteratorType child_begin(NodeType *N) { \
289 return RNSuccIterator<FlatIt<NodeType>, BlockT, RegionT>(N); \
291 static inline ChildIteratorType child_end(NodeType *N) { \
292 return RNSuccIterator<FlatIt<NodeType>, BlockT, RegionT>(N, true); \
296 #define RegionGraphTraits(RegionT, NodeT) \
297 template<> struct GraphTraits<RegionT*> \
298 : public GraphTraits<NodeT*> { \
299 typedef df_iterator<NodeType*> nodes_iterator; \
300 static NodeType *getEntryNode(RegionT* R) { \
301 return R->getNode(R->getEntry()); \
303 static nodes_iterator nodes_begin(RegionT* R) { \
304 return nodes_iterator::begin(getEntryNode(R)); \
306 static nodes_iterator nodes_end(RegionT* R) { \
307 return nodes_iterator::end(getEntryNode(R)); \
310 template<> struct GraphTraits<FlatIt<RegionT*> > \
311 : public GraphTraits<FlatIt<NodeT*> > { \
312 typedef df_iterator<NodeType*, SmallPtrSet<NodeType*, 8>, false, \
313 GraphTraits<FlatIt<NodeType*> > > nodes_iterator; \
314 static NodeType *getEntryNode(RegionT* R) { \
315 return R->getBBNode(R->getEntry()); \
317 static nodes_iterator nodes_begin(RegionT* R) { \
318 return nodes_iterator::begin(getEntryNode(R)); \
320 static nodes_iterator nodes_end(RegionT* R) { \
321 return nodes_iterator::end(getEntryNode(R)); \
325 RegionNodeGraphTraits(RegionNode, BasicBlock, Region);
326 RegionNodeGraphTraits(const RegionNode, BasicBlock, Region);
328 RegionGraphTraits(Region, RegionNode);
329 RegionGraphTraits(const Region, const RegionNode);
331 template <> struct GraphTraits<RegionInfo*>
332 : public GraphTraits<FlatIt<RegionNode*> > {
333 typedef df_iterator<NodeType*, SmallPtrSet<NodeType*, 8>, false,
334 GraphTraits<FlatIt<NodeType*> > > nodes_iterator;
336 static NodeType *getEntryNode(RegionInfo *RI) {
337 return GraphTraits<FlatIt<Region*> >::getEntryNode(RI->getTopLevelRegion());
339 static nodes_iterator nodes_begin(RegionInfo* RI) {
340 return nodes_iterator::begin(getEntryNode(RI));
342 static nodes_iterator nodes_end(RegionInfo *RI) {
343 return nodes_iterator::end(getEntryNode(RI));
347 template <> struct GraphTraits<RegionInfoPass*>
348 : public GraphTraits<RegionInfo *> {
349 typedef df_iterator<NodeType*, SmallPtrSet<NodeType*, 8>, false,
350 GraphTraits<FlatIt<NodeType*> > > nodes_iterator;
352 static NodeType *getEntryNode(RegionInfoPass *RI) {
353 return GraphTraits<RegionInfo*>::getEntryNode(&RI->getRegionInfo());
355 static nodes_iterator nodes_begin(RegionInfoPass* RI) {
356 return GraphTraits<RegionInfo*>::nodes_begin(&RI->getRegionInfo());
358 static nodes_iterator nodes_end(RegionInfoPass *RI) {
359 return GraphTraits<RegionInfo*>::nodes_end(&RI->getRegionInfo());
363 } // End namespace llvm