include/llvm/BasicBlock.h

   1 //===-- llvm/BasicBlock.h - Represent a basic block in the VM ---*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   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.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //
  11 // This file contains the declaration of the BasicBlock class.
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_BASICBLOCK_H
  15 #define LLVM_BASICBLOCK_H
  16
  17 #include "llvm/Instruction.h"
  18 #include "llvm/SymbolTableListTraits.h"
  19 #include "llvm/ADT/ilist"
  20 #include "llvm/Support/DataTypes.h"
  21
  22 namespace llvm {
  23
  24 class TerminatorInst;
  25 template <class Term, class BB> class SuccIterator;  // Successor Iterator
  26 template <class Ptr, class USE_iterator> class PredIterator;
  27
  28 template<> struct ilist_traits<Instruction>
  29   : public SymbolTableListTraits<Instruction, BasicBlock> {
  30   // createSentinel is used to create a node that marks the end of the list...
  31   static Instruction *createSentinel();
  32   static void destroySentinel(Instruction *I) { delete I; }
  33   static iplist<Instruction> &getList(BasicBlock *BB);
  34   static ValueSymbolTable *getSymTab(BasicBlock *ItemParent);
  35   static int getListOffset();
  36 };
  37
  38 /// This represents a single basic block in LLVM. A basic block is simply a
  39 /// container of instructions that execute sequentially. Basic blocks are Values
  40 /// because they are referenced by instructions such as branches and switch
  41 /// tables. The type of a BasicBlock is "Type::LabelTy" because the basic block
  42 /// represents a label to which a branch can jump.
  43 ///
  44 /// A well formed basic block is formed of a list of non-terminating
  45 /// instructions followed by a single TerminatorInst instruction.
  46 /// TerminatorInst's may not occur in the middle of basic blocks, and must
  47 /// terminate the blocks. The BasicBlock class allows malformed basic blocks to
  48 /// occur because it may be useful in the intermediate stage of constructing or
  49 /// modifying a program. However, the verifier will ensure that basic blocks
  50 /// are "well formed".
  51 /// @brief LLVM Basic Block Representation
  52 class BasicBlock : public Value {       // Basic blocks are data objects also
  53 public:
  54   typedef iplist<Instruction> InstListType;
  55 private :
  56   InstListType InstList;
  57   BasicBlock *Prev, *Next; // Next and Prev links for our intrusive linked list
  58   Function *Parent;
  59
  60   void setParent(Function *parent);
  61   void setNext(BasicBlock *N) { Next = N; }
  62   void setPrev(BasicBlock *N) { Prev = N; }
  63   friend class SymbolTableListTraits<BasicBlock, Function>;
  64
  65   BasicBlock(const BasicBlock &);     // Do not implement
  66   void operator=(const BasicBlock &); // Do not implement
  67
  68 protected:
  69   static void destroyThis(BasicBlock*);
  70   friend class Value;
  71 public:
  72   /// Instruction iterators...
  73   typedef InstListType::iterator                              iterator;
  74   typedef InstListType::const_iterator                  const_iterator;
  75
  76   /// BasicBlock ctor - If the function parameter is specified, the basic block
  77   /// is automatically inserted at either the end of the function (if
  78   /// InsertBefore is null), or before the specified basic block.
  79   ///
  80   explicit BasicBlock(const std::string &Name = "", Function *Parent = 0,
  81                       BasicBlock *InsertBefore = 0);
  82
  83   /// getParent - Return the enclosing method, or null if none
  84   ///
  85   const Function *getParent() const { return Parent; }
  86         Function *getParent()       { return Parent; }
  87
  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());}
  92
  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.
  96   ///
  97   TerminatorInst *getTerminator();
  98   const TerminatorInst *getTerminator() const;
  99
 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();
 106
 107   /// removeFromParent - This method unlinks 'this' from the containing
 108   /// function, but does not delete it.
 109   ///
 110   void removeFromParent();
 111
 112   /// eraseFromParent - This method unlinks 'this' from the containing function
 113   /// and deletes it.
 114   ///
 115   void eraseFromParent();
 116
 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);
 120
 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);
 124
 125
 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();
 131   }
 132
 133   //===--------------------------------------------------------------------===//
 134   /// Instruction iterator methods
 135   ///
 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();   }
 140
 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();  }
 147
 148   /// getInstList() - Return the underlying instruction list container.  You
 149   /// need to access it directly if you want to modify it currently.
 150   ///
 151   const InstListType &getInstList() const { return InstList; }
 152         InstListType &getInstList()       { return InstList; }
 153
 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;
 157
 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->getValueID() == Value::BasicBlockVal;
 162   }
 163
 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
 170   /// delete.
 171   ///
 172   void dropAllReferences();
 173
 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.
 179   ///
 180   void removePredecessor(BasicBlock *Pred, bool DontDeleteUselessPHIs = false);
 181
 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.
 188   ///
 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).
 193   ///
 194   BasicBlock *splitBasicBlock(iterator I, const std::string &BBName = "");
 195
 196
 197   static unsigned getInstListOffset() {
 198     BasicBlock *Obj = 0;
 199     return unsigned(reinterpret_cast<uintptr_t>(&Obj->InstList));
 200   }
 201
 202 private:
 203   // getNext/Prev - Return the next or previous basic block in the list.  Access
 204   // these with Function::iterator.
 205   BasicBlock *getNext()       { return Next; }
 206   const BasicBlock *getNext() const { return Next; }
 207   BasicBlock *getPrev()       { return Prev; }
 208   const BasicBlock *getPrev() const { return Prev; }
 209 };
 210
 211 /// DummyInst - An instance of this class is used to mark the end of the
 212 /// instruction list.  This is not a real instruction.
 213 class DummyInst : public Instruction {
 214 protected:
 215   static void destroyThis(DummyInst* v) {
 216     Instruction::destroyThis(v);
 217   }
 218   friend class Value;
 219 public:
 220   DummyInst();
 221
 222   Instruction *clone() const {
 223     assert(0 && "Cannot clone EOL");abort();
 224     return 0;
 225   }
 226   const char *getOpcodeName() const { return "*end-of-list-inst*"; }
 227
 228   // Methods for support type inquiry through isa, cast, and dyn_cast...
 229   static inline bool classof(const DummyInst *) { return true; }
 230   static inline bool classof(const Instruction *I) {
 231     return I->getOpcode() == OtherOpsEnd;
 232   }
 233   static inline bool classof(const Value *V) {
 234     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 235   }
 236 };
 237
 238 inline int
 239 ilist_traits<Instruction>::getListOffset() {
 240   return BasicBlock::getInstListOffset();
 241 }
 242
 243 } // End llvm namespace
 244
 245 #endif