1 //===-- llvm/CodeGen/MachineBasicBlock.h ------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Collect the sequence of machine instructions for a basic block.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CODEGEN_MACHINEBASICBLOCK_H
15 #define LLVM_CODEGEN_MACHINEBASICBLOCK_H
17 #include "llvm/CodeGen/MachineInstr.h"
18 #include "llvm/ADT/GraphTraits.h"
19 #include "llvm/ADT/ilist"
23 class MachineFunction;
27 struct ilist_traits<MachineInstr> {
29 // this is only set by the MachineBasicBlock owning the ilist
30 friend class MachineBasicBlock;
31 MachineBasicBlock* parent;
34 ilist_traits<MachineInstr>() : parent(0) { }
36 static MachineInstr* getPrev(MachineInstr* N) { return N->prev; }
37 static MachineInstr* getNext(MachineInstr* N) { return N->next; }
39 static const MachineInstr*
40 getPrev(const MachineInstr* N) { return N->prev; }
42 static const MachineInstr*
43 getNext(const MachineInstr* N) { return N->next; }
45 static void setPrev(MachineInstr* N, MachineInstr* prev) { N->prev = prev; }
46 static void setNext(MachineInstr* N, MachineInstr* next) { N->next = next; }
48 static MachineInstr* createSentinel();
49 static void destroySentinel(MachineInstr *MI) { delete MI; }
50 void addNodeToList(MachineInstr* N);
51 void removeNodeFromList(MachineInstr* N);
52 void transferNodesFromList(
53 iplist<MachineInstr, ilist_traits<MachineInstr> >& toList,
54 ilist_iterator<MachineInstr> first,
55 ilist_iterator<MachineInstr> last);
60 class MachineBasicBlock {
62 typedef ilist<MachineInstr> Instructions;
64 MachineBasicBlock *Prev, *Next;
66 std::vector<MachineBasicBlock *> Predecessors;
67 std::vector<MachineBasicBlock *> Successors;
69 MachineFunction *Parent;
72 MachineBasicBlock(const BasicBlock *bb = 0) : Prev(0), Next(0), BB(bb),
73 Number(-1), Parent(0) {
79 /// getBasicBlock - Return the LLVM basic block that this instance
80 /// corresponded to originally.
82 const BasicBlock *getBasicBlock() const { return BB; }
84 /// getParent - Return the MachineFunction containing this basic block.
86 const MachineFunction *getParent() const { return Parent; }
87 MachineFunction *getParent() { return Parent; }
89 typedef ilist<MachineInstr>::iterator iterator;
90 typedef ilist<MachineInstr>::const_iterator const_iterator;
91 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
92 typedef std::reverse_iterator<iterator> reverse_iterator;
94 unsigned size() const { return Insts.size(); }
95 bool empty() const { return Insts.empty(); }
97 MachineInstr& front() { return Insts.front(); }
98 MachineInstr& back() { return Insts.back(); }
100 iterator begin() { return Insts.begin(); }
101 const_iterator begin() const { return Insts.begin(); }
102 iterator end() { return Insts.end(); }
103 const_iterator end() const { return Insts.end(); }
104 reverse_iterator rbegin() { return Insts.rbegin(); }
105 const_reverse_iterator rbegin() const { return Insts.rbegin(); }
106 reverse_iterator rend () { return Insts.rend(); }
107 const_reverse_iterator rend () const { return Insts.rend(); }
109 // Machine-CFG iterators
110 typedef std::vector<MachineBasicBlock *>::iterator pred_iterator;
111 typedef std::vector<MachineBasicBlock *>::const_iterator const_pred_iterator;
112 typedef std::vector<MachineBasicBlock *>::iterator succ_iterator;
113 typedef std::vector<MachineBasicBlock *>::const_iterator const_succ_iterator;
115 pred_iterator pred_begin() { return Predecessors.begin (); }
116 const_pred_iterator pred_begin() const { return Predecessors.begin (); }
117 pred_iterator pred_end() { return Predecessors.end (); }
118 const_pred_iterator pred_end() const { return Predecessors.end (); }
119 unsigned pred_size() const { return Predecessors.size (); }
120 bool pred_empty() const { return Predecessors.empty(); }
121 succ_iterator succ_begin() { return Successors.begin (); }
122 const_succ_iterator succ_begin() const { return Successors.begin (); }
123 succ_iterator succ_end() { return Successors.end (); }
124 const_succ_iterator succ_end() const { return Successors.end (); }
125 unsigned succ_size() const { return Successors.size (); }
126 bool succ_empty() const { return Successors.empty(); }
128 // Machine-CFG mutators
130 /// addSuccessor - Add succ as a successor of this MachineBasicBlock.
131 /// The Predecessors list of succ is automatically updated.
133 void addSuccessor(MachineBasicBlock *succ);
135 /// removeSuccessor - Remove successor from the successors list of this
136 /// MachineBasicBlock. The Predecessors list of succ is automatically updated.
138 void removeSuccessor(MachineBasicBlock *succ);
140 /// removeSuccessor - Remove specified successor from the successors list of
141 /// this MachineBasicBlock. The Predecessors list of succ is automatically
144 void removeSuccessor(succ_iterator I);
146 /// getFirstTerminator - returns an iterator to the first terminator
147 /// instruction of this basic block. If a terminator does not exist,
149 iterator getFirstTerminator();
151 void pop_front() { Insts.pop_front(); }
152 void pop_back() { Insts.pop_back(); }
153 void push_back(MachineInstr *MI) { Insts.push_back(MI); }
154 template<typename IT>
155 void insert(iterator I, IT S, IT E) { Insts.insert(I, S, E); }
156 iterator insert(iterator I, MachineInstr *M) { return Insts.insert(I, M); }
158 // erase - Remove the specified element or range from the instruction list.
159 // These functions delete any instructions removed.
161 iterator erase(iterator I) { return Insts.erase(I); }
162 iterator erase(iterator I, iterator E) { return Insts.erase(I, E); }
163 MachineInstr *remove(MachineInstr *I) { return Insts.remove(I); }
164 void clear() { Insts.clear(); }
166 /// splice - Take a block of instructions from MBB 'Other' in the range [From,
167 /// To), and insert them into this MBB right before 'where'.
168 void splice(iterator where, MachineBasicBlock *Other, iterator From,
170 Insts.splice(where, Other->Insts, From, To);
173 // Debugging methods.
175 void print(std::ostream &OS) const;
177 /// getNumber - MachineBasicBlocks are uniquely numbered at the function
178 /// level, unless they're not in a MachineFunction yet, in which case this
181 int getNumber() const { return Number; }
183 private: // Methods used to maintain doubly linked list of blocks...
184 friend struct ilist_traits<MachineBasicBlock>;
186 MachineBasicBlock *getPrev() const { return Prev; }
187 MachineBasicBlock *getNext() const { return Next; }
188 void setPrev(MachineBasicBlock *P) { Prev = P; }
189 void setNext(MachineBasicBlock *N) { Next = N; }
191 // Machine-CFG mutators
193 /// addPredecessor - Remove pred as a predecessor of this MachineBasicBlock.
194 /// Don't do this unless you know what you're doing, because it doesn't
195 /// update pred's successors list. Use pred->addSuccessor instead.
197 void addPredecessor(MachineBasicBlock *pred);
199 /// removePredecessor - Remove pred as a predecessor of this
200 /// MachineBasicBlock. Don't do this unless you know what you're
201 /// doing, because it doesn't update pred's successors list. Use
202 /// pred->removeSuccessor instead.
204 void removePredecessor(MachineBasicBlock *pred);
209 //===--------------------------------------------------------------------===//
210 // GraphTraits specializations for machine basic block graphs (machine-CFGs)
211 //===--------------------------------------------------------------------===//
213 // Provide specializations of GraphTraits to be able to treat a
214 // MachineFunction as a graph of MachineBasicBlocks...
217 template <> struct GraphTraits<MachineBasicBlock *> {
218 typedef MachineBasicBlock NodeType;
219 typedef MachineBasicBlock::succ_iterator ChildIteratorType;
221 static NodeType *getEntryNode(MachineBasicBlock *BB) { return BB; }
222 static inline ChildIteratorType child_begin(NodeType *N) {
223 return N->succ_begin();
225 static inline ChildIteratorType child_end(NodeType *N) {
226 return N->succ_end();
230 template <> struct GraphTraits<const MachineBasicBlock *> {
231 typedef const MachineBasicBlock NodeType;
232 typedef MachineBasicBlock::const_succ_iterator ChildIteratorType;
234 static NodeType *getEntryNode(const MachineBasicBlock *BB) { return BB; }
235 static inline ChildIteratorType child_begin(NodeType *N) {
236 return N->succ_begin();
238 static inline ChildIteratorType child_end(NodeType *N) {
239 return N->succ_end();
243 // Provide specializations of GraphTraits to be able to treat a
244 // MachineFunction as a graph of MachineBasicBlocks... and to walk it
245 // in inverse order. Inverse order for a function is considered
246 // to be when traversing the predecessor edges of a MBB
247 // instead of the successor edges.
249 template <> struct GraphTraits<Inverse<MachineBasicBlock*> > {
250 typedef MachineBasicBlock NodeType;
251 typedef MachineBasicBlock::pred_iterator ChildIteratorType;
252 static NodeType *getEntryNode(Inverse<MachineBasicBlock *> G) {
255 static inline ChildIteratorType child_begin(NodeType *N) {
256 return N->pred_begin();
258 static inline ChildIteratorType child_end(NodeType *N) {
259 return N->pred_end();
263 template <> struct GraphTraits<Inverse<const MachineBasicBlock*> > {
264 typedef const MachineBasicBlock NodeType;
265 typedef MachineBasicBlock::const_pred_iterator ChildIteratorType;
266 static NodeType *getEntryNode(Inverse<const MachineBasicBlock*> G) {
269 static inline ChildIteratorType child_begin(NodeType *N) {
270 return N->pred_begin();
272 static inline ChildIteratorType child_end(NodeType *N) {
273 return N->pred_end();
277 } // End llvm namespace