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