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