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 public:
  69   /// Instruction iterators...
  70   typedef InstListType::iterator                              iterator;
  71   typedef InstListType::const_iterator                  const_iterator;
  72
  73   /// BasicBlock ctor - If the function parameter is specified, the basic block
  74   /// is automatically inserted at either the end of the function (if
  75   /// InsertBefore is null), or before the specified basic block.
  76   ///
  77   explicit BasicBlock(const std::string &Name = "", Function *Parent = 0,
  78                       BasicBlock *InsertBefore = 0);
  79   ~BasicBlock();
  80
  81   /// getParent - Return the enclosing method, or null if none
  82   ///
  83   const Function *getParent() const { return Parent; }
  84         Function *getParent()       { return Parent; }
  85
  86   /// use_back - Specialize the methods defined in Value, as we know that an
  87   /// BasicBlock can only be used by Instructions (specifically PHI and terms).
  88   Instruction       *use_back()       { return cast<Instruction>(*use_begin());}
  89   const Instruction *use_back() const { return cast<Instruction>(*use_begin());}
  90
  91   /// getTerminator() - If this is a well formed basic block, then this returns
  92   /// a pointer to the terminator instruction.  If it is not, then you get a
  93   /// null pointer back.
  94   ///
  95   TerminatorInst *getTerminator();
  96   const TerminatorInst *getTerminator() const;
  97
  98   /// Returns a pointer to the first instructon in this block that is not a
  99   /// PHINode instruction. When adding instruction to the beginning of the
 100   /// basic block, they should be added before the returned value, not before
 101   /// the first instruction, which might be PHI.
 102   /// Returns 0 is there's no non-PHI instruction.
 103   Instruction* getFirstNonPHI();
 104
 105   /// removeFromParent - This method unlinks 'this' from the containing
 106   /// function, but does not delete it.
 107   ///
 108   void removeFromParent();
 109
 110   /// eraseFromParent - This method unlinks 'this' from the containing function
 111   /// and deletes it.
 112   ///
 113   void eraseFromParent();
 114
 115   /// moveBefore - Unlink this basic block from its current function and
 116   /// insert it into the function that MovePos lives in, right before MovePos.
 117   void moveBefore(BasicBlock *MovePos);
 118
 119   /// moveAfter - Unlink this basic block from its current function and
 120   /// insert it into the function that MovePos lives in, right after MovePos.
 121   void moveAfter(BasicBlock *MovePos);
 122
 123
 124   /// getSinglePredecessor - If this basic block has a single predecessor block,
 125   /// return the block, otherwise return a null pointer.
 126   BasicBlock *getSinglePredecessor();
 127   const BasicBlock *getSinglePredecessor() const {
 128     return const_cast<BasicBlock*>(this)->getSinglePredecessor();
 129   }
 130
 131   //===--------------------------------------------------------------------===//
 132   /// Instruction iterator methods
 133   ///
 134   inline iterator                begin()       { return InstList.begin(); }
 135   inline const_iterator          begin() const { return InstList.begin(); }
 136   inline iterator                end  ()       { return InstList.end();   }
 137   inline const_iterator          end  () const { return InstList.end();   }
 138
 139   inline size_t                   size() const { return InstList.size();  }
 140   inline bool                    empty() const { return InstList.empty(); }
 141   inline const Instruction      &front() const { return InstList.front(); }
 142   inline       Instruction      &front()       { return InstList.front(); }
 143   inline const Instruction       &back() const { return InstList.back();  }
 144   inline       Instruction       &back()       { return InstList.back();  }
 145
 146   /// getInstList() - Return the underlying instruction list container.  You
 147   /// need to access it directly if you want to modify it currently.
 148   ///
 149   const InstListType &getInstList() const { return InstList; }
 150         InstListType &getInstList()       { return InstList; }
 151
 152   virtual void print(std::ostream &OS) const { print(OS, 0); }
 153   void print(std::ostream *OS) const { if (OS) print(*OS); }
 154   void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
 155
 156   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 157   static inline bool classof(const BasicBlock *) { return true; }
 158   static inline bool classof(const Value *V) {
 159     return V->getValueID() == Value::BasicBlockVal;
 160   }
 161
 162   /// dropAllReferences() - This function causes all the subinstructions to "let
 163   /// go" of all references that they are maintaining.  This allows one to
 164   /// 'delete' a whole class at a time, even though there may be circular
 165   /// references... first all references are dropped, and all use counts go to
 166   /// zero.  Then everything is delete'd for real.  Note that no operations are
 167   /// valid on an object that has "dropped all references", except operator
 168   /// delete.
 169   ///
 170   void dropAllReferences();
 171
 172   /// removePredecessor - This method is used to notify a BasicBlock that the
 173   /// specified Predecessor of the block is no longer able to reach it.  This is
 174   /// actually not used to update the Predecessor list, but is actually used to
 175   /// update the PHI nodes that reside in the block.  Note that this should be
 176   /// called while the predecessor still refers to this block.
 177   ///
 178   void removePredecessor(BasicBlock *Pred, bool DontDeleteUselessPHIs = false);
 179
 180   /// splitBasicBlock - This splits a basic block into two at the specified
 181   /// instruction.  Note that all instructions BEFORE the specified iterator
 182   /// stay as part of the original basic block, an unconditional branch is added
 183   /// to the original BB, and the rest of the instructions in the BB are moved
 184   /// to the new BB, including the old terminator.  The newly formed BasicBlock
 185   /// is returned.  This function invalidates the specified iterator.
 186   ///
 187   /// Note that this only works on well formed basic blocks (must have a
 188   /// terminator), and 'I' must not be the end of instruction list (which would
 189   /// cause a degenerate basic block to be formed, having a terminator inside of
 190   /// the basic block).
 191   ///
 192   BasicBlock *splitBasicBlock(iterator I, const std::string &BBName = "");
 193
 194
 195   static unsigned getInstListOffset() {
 196     BasicBlock *Obj = 0;
 197     return unsigned(reinterpret_cast<uintptr_t>(&Obj->InstList));
 198   }
 199
 200 private:
 201   // getNext/Prev - Return the next or previous basic block in the list.  Access
 202   // these with Function::iterator.
 203   BasicBlock *getNext()       { return Next; }
 204   const BasicBlock *getNext() const { return Next; }
 205   BasicBlock *getPrev()       { return Prev; }
 206   const BasicBlock *getPrev() const { return Prev; }
 207 };
 208
 209 inline int
 210 ilist_traits<Instruction>::getListOffset() {
 211   return BasicBlock::getInstListOffset();
 212 }
 213
 214 } // End llvm namespace
 215
 216 #endif