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