1 //===-- llvm/BasicBlock.h - Represent a basic block in the VM ---*- 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 //===----------------------------------------------------------------------===//
11 // This file contains the declaration of the BasicBlock class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_BASICBLOCK_H
15 #define LLVM_BASICBLOCK_H
17 #include "llvm/Instruction.h"
18 #include "llvm/SymbolTableListTraits.h"
19 #include "llvm/ADT/ilist"
24 template <class Term, class BB> class SuccIterator; // Successor Iterator
25 template <class Ptr, class USE_iterator> class PredIterator;
27 template<> struct ilist_traits<Instruction>
28 : public SymbolTableListTraits<Instruction, BasicBlock, Function> {
29 // createSentinel is used to create a node that marks the end of the list...
30 static Instruction *createSentinel();
31 static void destroySentinel(Instruction *I) { delete I; }
32 static iplist<Instruction> &getList(BasicBlock *BB);
35 /// This represents a single basic block in LLVM. A basic block is simply a
36 /// container of instructions that execute sequentially. Basic blocks are Values
37 /// because they are referenced by instructions such as branches and switch
38 /// tables. The type of a BasicBlock is "Type::LabelTy" because the basic block
39 /// represents a label to which a branch can jump.
41 /// A well formed basic block is formed of a list of non-terminating
42 /// instructions followed by a single TerminatorInst instruction.
43 /// TerminatorInst's may not occur in the middle of basic blocks, and must
44 /// terminate the blocks. The BasicBlock class allows malformed basic blocks to
45 /// occur because it may be useful in the intermediate stage of constructing or
46 /// modifying a program. However, the verifier will ensure that basic blocks
47 /// are "well formed".
48 /// @brief LLVM Basic Block Representation
49 class BasicBlock : public Value { // Basic blocks are data objects also
51 typedef iplist<Instruction> InstListType;
53 InstListType InstList;
54 BasicBlock *Prev, *Next; // Next and Prev links for our intrusive linked list
56 void setParent(Function *parent);
57 void setNext(BasicBlock *N) { Next = N; }
58 void setPrev(BasicBlock *N) { Prev = N; }
59 friend class SymbolTableListTraits<BasicBlock, Function, Function>;
61 BasicBlock(const BasicBlock &); // Do not implement
62 void operator=(const BasicBlock &); // Do not implement
65 /// Instruction iterators...
66 typedef InstListType::iterator iterator;
67 typedef InstListType::const_iterator const_iterator;
69 /// BasicBlock ctor - If the function parameter is specified, the basic block
70 /// is automatically inserted at either the end of the function (if
71 /// InsertBefore is null), or before the specified basic block.
73 explicit BasicBlock(const std::string &Name = "", Function *Parent = 0,
74 BasicBlock *InsertBefore = 0);
77 /// getParent - Return the enclosing method, or null if none
79 const Function *getParent() const { return InstList.getParent(); }
80 Function *getParent() { return InstList.getParent(); }
82 // getNext/Prev - Return the next or previous basic block in the list.
83 BasicBlock *getNext() { return Next; }
84 const BasicBlock *getNext() const { return Next; }
85 BasicBlock *getPrev() { return Prev; }
86 const BasicBlock *getPrev() const { return Prev; }
88 /// use_back - Specialize the methods defined in Value, as we know that an
89 /// BasicBlock can only be used by Instructions (specifically PHI and terms).
90 Instruction *use_back() { return cast<Instruction>(*use_begin());}
91 const Instruction *use_back() const { return cast<Instruction>(*use_begin());}
93 /// getTerminator() - If this is a well formed basic block, then this returns
94 /// a pointer to the terminator instruction. If it is not, then you get a
95 /// null pointer back.
97 TerminatorInst *getTerminator();
98 const TerminatorInst *const getTerminator() const;
100 /// Returns a pointer to the first instructon in this block that is not a
101 /// PHINode instruction. When adding instruction to the beginning of the
102 /// basic block, they should be added before the returned value, not before
103 /// the first instruction, which might be PHI.
104 /// Returns 0 is there's no non-PHI instruction.
105 Instruction* getFirstNonPHI();
107 /// removeFromParent - This method unlinks 'this' from the containing
108 /// function, but does not delete it.
110 void removeFromParent();
112 /// eraseFromParent - This method unlinks 'this' from the containing function
115 void eraseFromParent();
117 /// moveBefore - Unlink this basic block from its current function and
118 /// insert it into the function that MovePos lives in, right before MovePos.
119 void moveBefore(BasicBlock *MovePos);
121 /// moveAfter - Unlink this basic block from its current function and
122 /// insert it into the function that MovePos lives in, right after MovePos.
123 void moveAfter(BasicBlock *MovePos);
126 /// getSinglePredecessor - If this basic block has a single predecessor block,
127 /// return the block, otherwise return a null pointer.
128 BasicBlock *getSinglePredecessor();
129 const BasicBlock *getSinglePredecessor() const {
130 return const_cast<BasicBlock*>(this)->getSinglePredecessor();
133 //===--------------------------------------------------------------------===//
134 /// Instruction iterator methods
136 inline iterator begin() { return InstList.begin(); }
137 inline const_iterator begin() const { return InstList.begin(); }
138 inline iterator end () { return InstList.end(); }
139 inline const_iterator end () const { return InstList.end(); }
141 inline size_t size() const { return InstList.size(); }
142 inline bool empty() const { return InstList.empty(); }
143 inline const Instruction &front() const { return InstList.front(); }
144 inline Instruction &front() { return InstList.front(); }
145 inline const Instruction &back() const { return InstList.back(); }
146 inline Instruction &back() { return InstList.back(); }
148 /// getInstList() - Return the underlying instruction list container. You
149 /// need to access it directly if you want to modify it currently.
151 const InstListType &getInstList() const { return InstList; }
152 InstListType &getInstList() { return InstList; }
154 virtual void print(std::ostream &OS) const { print(OS, 0); }
155 void print(std::ostream *OS) const { if (OS) print(*OS); }
156 void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
158 /// Methods for support type inquiry through isa, cast, and dyn_cast:
159 static inline bool classof(const BasicBlock *) { return true; }
160 static inline bool classof(const Value *V) {
161 return V->getValueType() == Value::BasicBlockVal;
164 /// dropAllReferences() - This function causes all the subinstructions to "let
165 /// go" of all references that they are maintaining. This allows one to
166 /// 'delete' a whole class at a time, even though there may be circular
167 /// references... first all references are dropped, and all use counts go to
168 /// zero. Then everything is delete'd for real. Note that no operations are
169 /// valid on an object that has "dropped all references", except operator
172 void dropAllReferences();
174 /// removePredecessor - This method is used to notify a BasicBlock that the
175 /// specified Predecessor of the block is no longer able to reach it. This is
176 /// actually not used to update the Predecessor list, but is actually used to
177 /// update the PHI nodes that reside in the block. Note that this should be
178 /// called while the predecessor still refers to this block.
180 void removePredecessor(BasicBlock *Pred, bool DontDeleteUselessPHIs = false);
182 /// splitBasicBlock - This splits a basic block into two at the specified
183 /// instruction. Note that all instructions BEFORE the specified iterator
184 /// stay as part of the original basic block, an unconditional branch is added
185 /// to the original BB, and the rest of the instructions in the BB are moved
186 /// to the new BB, including the old terminator. The newly formed BasicBlock
187 /// is returned. This function invalidates the specified iterator.
189 /// Note that this only works on well formed basic blocks (must have a
190 /// terminator), and 'I' must not be the end of instruction list (which would
191 /// cause a degenerate basic block to be formed, having a terminator inside of
192 /// the basic block).
194 BasicBlock *splitBasicBlock(iterator I, const std::string &BBName = "");
197 } // End llvm namespace