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/ADT/Twine.h"
  18 #include "llvm/ADT/ilist.h"
  19 #include "llvm/Instruction.h"
  20 #include "llvm/Support/DataTypes.h"
  21 #include "llvm/SymbolTableListTraits.h"
  22
  23 namespace llvm {
  24
  25 class LandingPadInst;
  26 class TerminatorInst;
  27 class LLVMContext;
  28 class BlockAddress;
  29
  30 template<> struct ilist_traits<Instruction>
  31   : public SymbolTableListTraits<Instruction, BasicBlock> {
  32   // createSentinel is used to get hold of a node that marks the end of
  33   // the list...
  34   // The sentinel is relative to this instance, so we use a non-static
  35   // method.
  36   Instruction *createSentinel() const {
  37     // since i(p)lists always publicly derive from the corresponding
  38     // traits, placing a data member in this class will augment i(p)list.
  39     // But since the NodeTy is expected to publicly derive from
  40     // ilist_node<NodeTy>, there is a legal viable downcast from it
  41     // to NodeTy. We use this trick to superpose i(p)list with a "ghostly"
  42     // NodeTy, which becomes the sentinel. Dereferencing the sentinel is
  43     // forbidden (save the ilist_node<NodeTy>) so no one will ever notice
  44     // the superposition.
  45     return static_cast<Instruction*>(&Sentinel);
  46   }
  47   static void destroySentinel(Instruction*) {}
  48
  49   Instruction *provideInitialHead() const { return createSentinel(); }
  50   Instruction *ensureHead(Instruction*) const { return createSentinel(); }
  51   static void noteHead(Instruction*, Instruction*) {}
  52 private:
  53   mutable ilist_half_node<Instruction> Sentinel;
  54 };
  55
  56 /// This represents a single basic block in LLVM. A basic block is simply a
  57 /// container of instructions that execute sequentially. Basic blocks are Values
  58 /// because they are referenced by instructions such as branches and switch
  59 /// tables. The type of a BasicBlock is "Type::LabelTy" because the basic block
  60 /// represents a label to which a branch can jump.
  61 ///
  62 /// A well formed basic block is formed of a list of non-terminating
  63 /// instructions followed by a single TerminatorInst instruction.
  64 /// TerminatorInst's may not occur in the middle of basic blocks, and must
  65 /// terminate the blocks. The BasicBlock class allows malformed basic blocks to
  66 /// occur because it may be useful in the intermediate stage of constructing or
  67 /// modifying a program. However, the verifier will ensure that basic blocks
  68 /// are "well formed".
  69 /// @brief LLVM Basic Block Representation
  70 class BasicBlock : public Value, // Basic blocks are data objects also
  71                    public ilist_node<BasicBlock> {
  72   friend class BlockAddress;
  73 public:
  74   typedef iplist<Instruction> InstListType;
  75 private:
  76   InstListType InstList;
  77   Function *Parent;
  78
  79   void setParent(Function *parent);
  80   friend class SymbolTableListTraits<BasicBlock, Function>;
  81
  82   BasicBlock(const BasicBlock &) LLVM_DELETED_FUNCTION;
  83   void operator=(const BasicBlock &) LLVM_DELETED_FUNCTION;
  84
  85   /// BasicBlock ctor - If the function parameter is specified, the basic block
  86   /// is automatically inserted at either the end of the function (if
  87   /// InsertBefore is null), or before the specified basic block.
  88   ///
  89   explicit BasicBlock(LLVMContext &C, const Twine &Name = "",
  90                       Function *Parent = 0, BasicBlock *InsertBefore = 0);
  91 public:
  92   /// getContext - Get the context in which this basic block lives.
  93   LLVMContext &getContext() const;
  94
  95   /// Instruction iterators...
  96   typedef InstListType::iterator iterator;
  97   typedef InstListType::const_iterator const_iterator;
  98   typedef InstListType::reverse_iterator reverse_iterator;
  99   typedef InstListType::const_reverse_iterator const_reverse_iterator;
 100
 101   /// Create - Creates a new BasicBlock. If the Parent parameter is specified,
 102   /// the basic block is automatically inserted at either the end of the
 103   /// function (if InsertBefore is 0), or before the specified basic block.
 104   static BasicBlock *Create(LLVMContext &Context, const Twine &Name = "",
 105                             Function *Parent = 0,BasicBlock *InsertBefore = 0) {
 106     return new BasicBlock(Context, Name, Parent, InsertBefore);
 107   }
 108   ~BasicBlock();
 109
 110   /// getParent - Return the enclosing method, or null if none
 111   ///
 112   const Function *getParent() const { return Parent; }
 113         Function *getParent()       { return Parent; }
 114
 115   /// getTerminator() - If this is a well formed basic block, then this returns
 116   /// a pointer to the terminator instruction.  If it is not, then you get a
 117   /// null pointer back.
 118   ///
 119   TerminatorInst *getTerminator();
 120   const TerminatorInst *getTerminator() const;
 121
 122   /// Returns a pointer to the first instructon in this block that is not a
 123   /// PHINode instruction. When adding instruction to the beginning of the
 124   /// basic block, they should be added before the returned value, not before
 125   /// the first instruction, which might be PHI.
 126   /// Returns 0 is there's no non-PHI instruction.
 127   Instruction* getFirstNonPHI();
 128   const Instruction* getFirstNonPHI() const {
 129     return const_cast<BasicBlock*>(this)->getFirstNonPHI();
 130   }
 131
 132   // Same as above, but also skip debug intrinsics.
 133   Instruction* getFirstNonPHIOrDbg();
 134   const Instruction* getFirstNonPHIOrDbg() const {
 135     return const_cast<BasicBlock*>(this)->getFirstNonPHIOrDbg();
 136   }
 137
 138   // Same as above, but also skip lifetime intrinsics.
 139   Instruction* getFirstNonPHIOrDbgOrLifetime();
 140   const Instruction* getFirstNonPHIOrDbgOrLifetime() const {
 141     return const_cast<BasicBlock*>(this)->getFirstNonPHIOrDbgOrLifetime();
 142   }
 143
 144   /// getFirstInsertionPt - Returns an iterator to the first instruction in this
 145   /// block that is suitable for inserting a non-PHI instruction. In particular,
 146   /// it skips all PHIs and LandingPad instructions.
 147   iterator getFirstInsertionPt();
 148   const_iterator getFirstInsertionPt() const {
 149     return const_cast<BasicBlock*>(this)->getFirstInsertionPt();
 150   }
 151
 152   /// removeFromParent - This method unlinks 'this' from the containing
 153   /// function, but does not delete it.
 154   ///
 155   void removeFromParent();
 156
 157   /// eraseFromParent - This method unlinks 'this' from the containing function
 158   /// and deletes it.
 159   ///
 160   void eraseFromParent();
 161
 162   /// moveBefore - Unlink this basic block from its current function and
 163   /// insert it into the function that MovePos lives in, right before MovePos.
 164   void moveBefore(BasicBlock *MovePos);
 165
 166   /// moveAfter - Unlink this basic block from its current function and
 167   /// insert it into the function that MovePos lives in, right after MovePos.
 168   void moveAfter(BasicBlock *MovePos);
 169
 170
 171   /// getSinglePredecessor - If this basic block has a single predecessor block,
 172   /// return the block, otherwise return a null pointer.
 173   BasicBlock *getSinglePredecessor();
 174   const BasicBlock *getSinglePredecessor() const {
 175     return const_cast<BasicBlock*>(this)->getSinglePredecessor();
 176   }
 177
 178   /// getUniquePredecessor - If this basic block has a unique predecessor block,
 179   /// return the block, otherwise return a null pointer.
 180   /// Note that unique predecessor doesn't mean single edge, there can be
 181   /// multiple edges from the unique predecessor to this block (for example
 182   /// a switch statement with multiple cases having the same destination).
 183   BasicBlock *getUniquePredecessor();
 184   const BasicBlock *getUniquePredecessor() const {
 185     return const_cast<BasicBlock*>(this)->getUniquePredecessor();
 186   }
 187
 188   //===--------------------------------------------------------------------===//
 189   /// Instruction iterator methods
 190   ///
 191   inline iterator                begin()       { return InstList.begin(); }
 192   inline const_iterator          begin() const { return InstList.begin(); }
 193   inline iterator                end  ()       { return InstList.end();   }
 194   inline const_iterator          end  () const { return InstList.end();   }
 195
 196   inline reverse_iterator        rbegin()       { return InstList.rbegin(); }
 197   inline const_reverse_iterator  rbegin() const { return InstList.rbegin(); }
 198   inline reverse_iterator        rend  ()       { return InstList.rend();   }
 199   inline const_reverse_iterator  rend  () const { return InstList.rend();   }
 200
 201   inline size_t                   size() const { return InstList.size();  }
 202   inline bool                    empty() const { return InstList.empty(); }
 203   inline const Instruction      &front() const { return InstList.front(); }
 204   inline       Instruction      &front()       { return InstList.front(); }
 205   inline const Instruction       &back() const { return InstList.back();  }
 206   inline       Instruction       &back()       { return InstList.back();  }
 207
 208   /// getInstList() - Return the underlying instruction list container.  You
 209   /// need to access it directly if you want to modify it currently.
 210   ///
 211   const InstListType &getInstList() const { return InstList; }
 212         InstListType &getInstList()       { return InstList; }
 213
 214   /// getSublistAccess() - returns pointer to member of instruction list
 215   static iplist<Instruction> BasicBlock::*getSublistAccess(Instruction*) {
 216     return &BasicBlock::InstList;
 217   }
 218
 219   /// getValueSymbolTable() - returns pointer to symbol table (if any)
 220   ValueSymbolTable *getValueSymbolTable();
 221
 222   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 223   static inline bool classof(const Value *V) {
 224     return V->getValueID() == Value::BasicBlockVal;
 225   }
 226
 227   /// dropAllReferences() - This function causes all the subinstructions to "let
 228   /// go" of all references that they are maintaining.  This allows one to
 229   /// 'delete' a whole class at a time, even though there may be circular
 230   /// references... first all references are dropped, and all use counts go to
 231   /// zero.  Then everything is delete'd for real.  Note that no operations are
 232   /// valid on an object that has "dropped all references", except operator
 233   /// delete.
 234   ///
 235   void dropAllReferences();
 236
 237   /// removePredecessor - This method is used to notify a BasicBlock that the
 238   /// specified Predecessor of the block is no longer able to reach it.  This is
 239   /// actually not used to update the Predecessor list, but is actually used to
 240   /// update the PHI nodes that reside in the block.  Note that this should be
 241   /// called while the predecessor still refers to this block.
 242   ///
 243   void removePredecessor(BasicBlock *Pred, bool DontDeleteUselessPHIs = false);
 244
 245   /// splitBasicBlock - This splits a basic block into two at the specified
 246   /// instruction.  Note that all instructions BEFORE the specified iterator
 247   /// stay as part of the original basic block, an unconditional branch is added
 248   /// to the original BB, and the rest of the instructions in the BB are moved
 249   /// to the new BB, including the old terminator.  The newly formed BasicBlock
 250   /// is returned.  This function invalidates the specified iterator.
 251   ///
 252   /// Note that this only works on well formed basic blocks (must have a
 253   /// terminator), and 'I' must not be the end of instruction list (which would
 254   /// cause a degenerate basic block to be formed, having a terminator inside of
 255   /// the basic block).
 256   ///
 257   /// Also note that this doesn't preserve any passes. To split blocks while
 258   /// keeping loop information consistent, use the SplitBlock utility function.
 259   ///
 260   BasicBlock *splitBasicBlock(iterator I, const Twine &BBName = "");
 261
 262   /// hasAddressTaken - returns true if there are any uses of this basic block
 263   /// other than direct branches, switches, etc. to it.
 264   bool hasAddressTaken() const { return getSubclassDataFromValue() != 0; }
 265
 266   /// replaceSuccessorsPhiUsesWith - Update all phi nodes in all our successors
 267   /// to refer to basic block New instead of to us.
 268   void replaceSuccessorsPhiUsesWith(BasicBlock *New);
 269
 270   /// isLandingPad - Return true if this basic block is a landing pad. I.e.,
 271   /// it's the destination of the 'unwind' edge of an invoke instruction.
 272   bool isLandingPad() const;
 273
 274   /// getLandingPadInst() - Return the landingpad instruction associated with
 275   /// the landing pad.
 276   LandingPadInst *getLandingPadInst();
 277   const LandingPadInst *getLandingPadInst() const;
 278
 279 private:
 280   /// AdjustBlockAddressRefCount - BasicBlock stores the number of BlockAddress
 281   /// objects using it.  This is almost always 0, sometimes one, possibly but
 282   /// almost never 2, and inconceivably 3 or more.
 283   void AdjustBlockAddressRefCount(int Amt) {
 284     setValueSubclassData(getSubclassDataFromValue()+Amt);
 285     assert((int)(signed char)getSubclassDataFromValue() >= 0 &&
 286            "Refcount wrap-around");
 287   }
 288   // Shadow Value::setValueSubclassData with a private forwarding method so that
 289   // any future subclasses cannot accidentally use it.
 290   void setValueSubclassData(unsigned short D) {
 291     Value::setValueSubclassData(D);
 292   }
 293 };
 294
 295 } // End llvm namespace
 296
 297 #endif