LLVM  8.0.0svn
CFG.h
Go to the documentation of this file.
1 //===- CFG.h - Process LLVM structures as graphs ----------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines specializations of GraphTraits that allow Function and
11 // BasicBlock graphs to be treated as proper graphs for generic algorithms.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_IR_CFG_H
16 #define LLVM_IR_CFG_H
17 
18 #include "llvm/ADT/GraphTraits.h"
19 #include "llvm/ADT/iterator.h"
21 #include "llvm/IR/BasicBlock.h"
22 #include "llvm/IR/Function.h"
23 #include "llvm/IR/InstrTypes.h"
24 #include "llvm/IR/Value.h"
25 #include "llvm/Support/Casting.h"
27 #include <cassert>
28 #include <cstddef>
29 #include <iterator>
30 
31 namespace llvm {
32 
33 //===----------------------------------------------------------------------===//
34 // BasicBlock pred_iterator definition
35 //===----------------------------------------------------------------------===//
36 
37 template <class Ptr, class USE_iterator> // Predecessor Iterator
38 class PredIterator : public std::iterator<std::forward_iterator_tag,
39  Ptr, ptrdiff_t, Ptr*, Ptr*> {
40  using super =
41  std::iterator<std::forward_iterator_tag, Ptr, ptrdiff_t, Ptr*, Ptr*>;
43  USE_iterator It;
44 
45  inline void advancePastNonTerminators() {
46  // Loop to ignore non-terminator uses (for example BlockAddresses).
47  while (!It.atEnd() && !isa<TerminatorInst>(*It))
48  ++It;
49  }
50 
51 public:
52  using pointer = typename super::pointer;
53  using reference = typename super::reference;
54 
55  PredIterator() = default;
56  explicit inline PredIterator(Ptr *bb) : It(bb->user_begin()) {
57  advancePastNonTerminators();
58  }
59  inline PredIterator(Ptr *bb, bool) : It(bb->user_end()) {}
60 
61  inline bool operator==(const Self& x) const { return It == x.It; }
62  inline bool operator!=(const Self& x) const { return !operator==(x); }
63 
64  inline reference operator*() const {
65  assert(!It.atEnd() && "pred_iterator out of range!");
66  return cast<TerminatorInst>(*It)->getParent();
67  }
68  inline pointer *operator->() const { return &operator*(); }
69 
70  inline Self& operator++() { // Preincrement
71  assert(!It.atEnd() && "pred_iterator out of range!");
72  ++It; advancePastNonTerminators();
73  return *this;
74  }
75 
76  inline Self operator++(int) { // Postincrement
77  Self tmp = *this; ++*this; return tmp;
78  }
79 
80  /// getOperandNo - Return the operand number in the predecessor's
81  /// terminator of the successor.
82  unsigned getOperandNo() const {
83  return It.getOperandNo();
84  }
85 
86  /// getUse - Return the operand Use in the predecessor's terminator
87  /// of the successor.
88  Use &getUse() const {
89  return It.getUse();
90  }
91 };
92 
94 using const_pred_iterator =
98 
99 inline pred_iterator pred_begin(BasicBlock *BB) { return pred_iterator(BB); }
101  return const_pred_iterator(BB);
102 }
103 inline pred_iterator pred_end(BasicBlock *BB) { return pred_iterator(BB, true);}
105  return const_pred_iterator(BB, true);
106 }
107 inline bool pred_empty(const BasicBlock *BB) {
108  return pred_begin(BB) == pred_end(BB);
109 }
110 inline unsigned pred_size(const BasicBlock *BB) {
111  return std::distance(pred_begin(BB), pred_end(BB));
112 }
114  return pred_range(pred_begin(BB), pred_end(BB));
115 }
117  return pred_const_range(pred_begin(BB), pred_end(BB));
118 }
119 
120 //===----------------------------------------------------------------------===//
121 // BasicBlock succ_iterator helpers
122 //===----------------------------------------------------------------------===//
123 
124 using succ_iterator =
126 using succ_const_iterator =
130 
132  return succ_iterator(BB->getTerminator());
133 }
135  return succ_const_iterator(BB->getTerminator());
136 }
138  return succ_iterator(BB->getTerminator(), true);
139 }
141  return succ_const_iterator(BB->getTerminator(), true);
142 }
143 inline bool succ_empty(const BasicBlock *BB) {
144  return succ_begin(BB) == succ_end(BB);
145 }
146 inline unsigned succ_size(const BasicBlock *BB) {
147  return std::distance(succ_begin(BB), succ_end(BB));
148 }
150  return succ_range(succ_begin(BB), succ_end(BB));
151 }
153  return succ_const_range(succ_begin(BB), succ_end(BB));
154 }
155 
156 template <typename T, typename U>
157 struct isPodLike<TerminatorInst::SuccIterator<T, U>> {
158  static const bool value = isPodLike<T>::value;
159 };
160 
161 //===--------------------------------------------------------------------===//
162 // GraphTraits specializations for basic block graphs (CFGs)
163 //===--------------------------------------------------------------------===//
164 
165 // Provide specializations of GraphTraits to be able to treat a function as a
166 // graph of basic blocks...
167 
168 template <> struct GraphTraits<BasicBlock*> {
169  using NodeRef = BasicBlock *;
171 
172  static NodeRef getEntryNode(BasicBlock *BB) { return BB; }
175 };
176 
177 template <> struct GraphTraits<const BasicBlock*> {
178  using NodeRef = const BasicBlock *;
180 
181  static NodeRef getEntryNode(const BasicBlock *BB) { return BB; }
182 
185 };
186 
187 // Provide specializations of GraphTraits to be able to treat a function as a
188 // graph of basic blocks... and to walk it in inverse order. Inverse order for
189 // a function is considered to be when traversing the predecessor edges of a BB
190 // instead of the successor edges.
191 //
192 template <> struct GraphTraits<Inverse<BasicBlock*>> {
193  using NodeRef = BasicBlock *;
195 
199 };
200 
201 template <> struct GraphTraits<Inverse<const BasicBlock*>> {
202  using NodeRef = const BasicBlock *;
204 
208 };
209 
210 //===--------------------------------------------------------------------===//
211 // GraphTraits specializations for function basic block graphs (CFGs)
212 //===--------------------------------------------------------------------===//
213 
214 // Provide specializations of GraphTraits to be able to treat a function as a
215 // graph of basic blocks... these are the same as the basic block iterators,
216 // except that the root node is implicitly the first node of the function.
217 //
218 template <> struct GraphTraits<Function*> : public GraphTraits<BasicBlock*> {
219  static NodeRef getEntryNode(Function *F) { return &F->getEntryBlock(); }
220 
221  // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
223 
225  return nodes_iterator(F->begin());
226  }
227 
229  return nodes_iterator(F->end());
230  }
231 
232  static size_t size(Function *F) { return F->size(); }
233 };
234 template <> struct GraphTraits<const Function*> :
236  static NodeRef getEntryNode(const Function *F) { return &F->getEntryBlock(); }
237 
238  // nodes_iterator/begin/end - Allow iteration over all nodes in the graph
240 
242  return nodes_iterator(F->begin());
243  }
244 
246  return nodes_iterator(F->end());
247  }
248 
249  static size_t size(const Function *F) { return F->size(); }
250 };
251 
252 // Provide specializations of GraphTraits to be able to treat a function as a
253 // graph of basic blocks... and to walk it in inverse order. Inverse order for
254 // a function is considered to be when traversing the predecessor edges of a BB
255 // instead of the successor edges.
256 //
257 template <> struct GraphTraits<Inverse<Function*>> :
260  return &G.Graph->getEntryBlock();
261  }
262 };
263 template <> struct GraphTraits<Inverse<const Function*>> :
266  return &G.Graph->getEntryBlock();
267  }
268 };
269 
270 } // end namespace llvm
271 
272 #endif // LLVM_IR_CFG_H
size_t size() const
Definition: Function.h:647
static NodeRef getEntryNode(const BasicBlock *BB)
Definition: CFG.h:181
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
iterator_range< succ_iterator > succ_range
Definition: CFG.h:128
static NodeRef getEntryNode(Inverse< BasicBlock *> G)
Definition: CFG.h:196
PredIterator< BasicBlock, Value::user_iterator > pred_iterator
Definition: CFG.h:93
iterator end()
Definition: Function.h:644
static NodeRef getEntryNode(BasicBlock *BB)
Definition: CFG.h:172
This provides a very simple, boring adaptor for a begin and end iterator into a range type...
static ChildIteratorType child_begin(NodeRef N)
Definition: CFG.h:183
unsigned succ_size(const BasicBlock *BB)
Definition: CFG.h:146
static ChildIteratorType child_end(NodeRef N)
Definition: CFG.h:198
F(f)
TerminatorInst::SuccIterator< TerminatorInst *, BasicBlock > succ_iterator
Definition: CFG.h:125
static NodeRef getEntryNode(Inverse< const Function *> G)
Definition: CFG.h:265
PredIterator(Ptr *bb, bool)
Definition: CFG.h:59
static ChildIteratorType child_end(NodeRef N)
Definition: CFG.h:207
iterator_range< const_pred_iterator > pred_const_range
Definition: CFG.h:97
A Use represents the edge between a Value definition and its users.
Definition: Use.h:56
pointer * operator->() const
Definition: CFG.h:68
Interval::succ_iterator succ_begin(Interval *I)
succ_begin/succ_end - define methods so that Intervals may be used just like BasicBlocks can with the...
Definition: Interval.h:103
reference operator*() const
Definition: CFG.h:64
static ChildIteratorType child_begin(NodeRef N)
Definition: CFG.h:206
iterator begin()
Definition: Function.h:642
iterator_range< succ_const_iterator > succ_const_range
Definition: CFG.h:129
static ChildIteratorType child_end(NodeRef N)
Definition: CFG.h:184
static ChildIteratorType child_begin(NodeRef N)
Definition: CFG.h:173
Interval::succ_iterator succ_end(Interval *I)
Definition: Interval.h:106
Use & getUse() const
getUse - Return the operand Use in the predecessor&#39;s terminator of the successor. ...
Definition: CFG.h:88
static nodes_iterator nodes_begin(const Function *F)
Definition: CFG.h:241
const BasicBlock & getEntryBlock() const
Definition: Function.h:626
typename super::reference reference
Definition: CFG.h:53
typename BasicBlock *::UnknownGraphTypeError NodeRef
Definition: GraphTraits.h:79
Subclasses of this class are all able to terminate a basic block.
Definition: InstrTypes.h:55
static NodeRef getEntryNode(Inverse< Function *> G)
Definition: CFG.h:259
LLVM Basic Block Representation.
Definition: BasicBlock.h:59
Self & operator++()
Definition: CFG.h:70
bool succ_empty(const BasicBlock *BB)
Definition: CFG.h:143
Interval::pred_iterator pred_begin(Interval *I)
pred_begin/pred_end - define methods so that Intervals may be used just like BasicBlocks can with the...
Definition: Interval.h:113
iterator_range< pred_iterator > pred_range
Definition: CFG.h:96
Interval::pred_iterator pred_end(Interval *I)
Definition: Interval.h:116
static ChildIteratorType child_end(NodeRef N)
Definition: CFG.h:174
bool pred_empty(const BasicBlock *BB)
Definition: CFG.h:107
static NodeRef getEntryNode(Inverse< const BasicBlock *> G)
Definition: CFG.h:205
unsigned getOperandNo() const
getOperandNo - Return the operand number in the predecessor&#39;s terminator of the successor.
Definition: CFG.h:82
static nodes_iterator nodes_end(const Function *F)
Definition: CFG.h:245
isPodLike - This is a type trait that is used to determine whether a given type can be copied around ...
Definition: ArrayRef.h:530
const GraphType & Graph
Definition: GraphTraits.h:97
const DataFlowGraph & G
Definition: RDFGraph.cpp:211
static NodeRef getEntryNode(Function *F)
Definition: CFG.h:219
pred_range predecessors(BasicBlock *BB)
Definition: CFG.h:113
A range adaptor for a pair of iterators.
PredIterator(Ptr *bb)
Definition: CFG.h:56
static size_t size(const Function *F)
Definition: CFG.h:249
static NodeRef getEntryNode(const Function *F)
Definition: CFG.h:236
static ChildIteratorType child_begin(NodeRef N)
Definition: CFG.h:197
PredIterator< const BasicBlock, Value::const_user_iterator > const_pred_iterator
Definition: CFG.h:95
typename super::pointer pointer
Definition: CFG.h:52
unsigned pred_size(const BasicBlock *BB)
Definition: CFG.h:110
#define N
static nodes_iterator nodes_end(Function *F)
Definition: CFG.h:228
bool operator!=(const Self &x) const
Definition: CFG.h:62
TerminatorInst::SuccIterator< const TerminatorInst *, const BasicBlock > succ_const_iterator
Definition: CFG.h:127
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
PredIterator()=default
aarch64 promote const
bool operator==(const Self &x) const
Definition: CFG.h:61
static nodes_iterator nodes_begin(Function *F)
Definition: CFG.h:224
succ_range successors(BasicBlock *BB)
Definition: CFG.h:149
Self operator++(int)
Definition: CFG.h:76
static size_t size(Function *F)
Definition: CFG.h:232
const TerminatorInst * getTerminator() const LLVM_READONLY
Returns the terminator instruction if the block is well formed or null if the block is not well forme...
Definition: BasicBlock.cpp:138