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 /// \class BasicBlock
  11 ///
  12 /// This file contains the declaration of the BasicBlock class, which represents
  13 /// a single basic block in the VM.
  14 ///
  15 /// Note that basic blocks themselves are Value's, because they are referenced
  16 /// by instructions like branches and can go in switch tables and stuff...
  17 ///
  18 ///===---------------------------------------------------------------------===//
  19 ///
  20 /// Note that well formed basic blocks are formed of a list of instructions
  21 /// followed by a single TerminatorInst instruction.  TerminatorInst's may not
  22 /// occur in the middle of basic blocks, and must terminate the blocks.
  23 ///
  24 /// This code allows malformed basic blocks to occur, because it may be useful
  25 /// in the intermediate stage modification to a program.
  26 ///
  27 //===----------------------------------------------------------------------===//
  28
  29 #ifndef LLVM_BASICBLOCK_H
  30 #define LLVM_BASICBLOCK_H
  31
  32 #include "llvm/Instruction.h"
  33 #include "llvm/SymbolTableListTraits.h"
  34 #include "Support/ilist"
  35
  36 namespace llvm {
  37
  38 class TerminatorInst;
  39 template <class _Term, class _BB> class SuccIterator;  // Successor Iterator
  40 template <class _Ptr, class _USE_iterator> class PredIterator;
  41
  42 template<> struct ilist_traits<Instruction>
  43   : public SymbolTableListTraits<Instruction, BasicBlock, Function> {
  44   // createNode is used to create a node that marks the end of the list...
  45   static Instruction *createNode();
  46   static iplist<Instruction> &getList(BasicBlock *BB);
  47 };
  48
  49 struct BasicBlock : public Value {       // Basic blocks are data objects also
  50   typedef iplist<Instruction> InstListType;
  51 private :
  52   InstListType InstList;
  53   BasicBlock *Prev, *Next; // Next and Prev links for our intrusive linked list
  54
  55   void setParent(Function *parent);
  56   void setNext(BasicBlock *N) { Next = N; }
  57   void setPrev(BasicBlock *N) { Prev = N; }
  58   friend class SymbolTableListTraits<BasicBlock, Function, Function>;
  59
  60   BasicBlock(const BasicBlock &);     // Do not implement
  61   void operator=(const BasicBlock &); // Do not implement
  62
  63 public:
  64   /// Instruction iterators...
  65   typedef InstListType::iterator iterator;
  66   typedef InstListType::const_iterator const_iterator;
  67   typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
  68   typedef std::reverse_iterator<iterator>             reverse_iterator;
  69
  70   /// BasicBlock ctor - If the function parameter is specified, the basic block
  71   /// is automatically inserted at the end of the function.
  72   ///
  73   BasicBlock(const std::string &Name = "", Function *Parent = 0);
  74
  75   /// BasicBlock ctor - If the InsertBefore parameter is specified, the basic
  76   /// block is automatically inserted right before the specified block.
  77   BasicBlock(const std::string &Name, BasicBlock *InsertBefore);
  78   ~BasicBlock();
  79
  80   // Specialize setName to take care of symbol table majik
  81   virtual void setName(const std::string &name, SymbolTable *ST = 0);
  82
  83   /// getParent - Return the enclosing method, or null if none
  84   ///
  85   const Function *getParent() const { return InstList.getParent(); }
  86         Function *getParent()       { return InstList.getParent(); }
  87
  88   // getNext/Prev - Return the next or previous basic block in the list.
  89         BasicBlock *getNext()       { return Next; }
  90   const BasicBlock *getNext() const { return Next; }
  91         BasicBlock *getPrev()       { return Prev; }
  92   const BasicBlock *getPrev() const { return Prev; }
  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 *const getTerminator() const;
 100
 101   //===--------------------------------------------------------------------===//
 102   /// Instruction iterator methods
 103   ///
 104   inline iterator                begin()       { return InstList.begin(); }
 105   inline const_iterator          begin() const { return InstList.begin(); }
 106   inline iterator                end  ()       { return InstList.end();   }
 107   inline const_iterator          end  () const { return InstList.end();   }
 108
 109   inline reverse_iterator       rbegin()       { return InstList.rbegin(); }
 110   inline const_reverse_iterator rbegin() const { return InstList.rbegin(); }
 111   inline reverse_iterator       rend  ()       { return InstList.rend();   }
 112   inline const_reverse_iterator rend  () const { return InstList.rend();   }
 113
 114   inline unsigned                 size() const { return InstList.size(); }
 115   inline bool                    empty() const { return InstList.empty(); }
 116   inline const Instruction      &front() const { return InstList.front(); }
 117   inline       Instruction      &front()       { return InstList.front(); }
 118   inline const Instruction       &back()  const { return InstList.back(); }
 119   inline       Instruction       &back()        { return InstList.back(); }
 120
 121   /// getInstList() - Return the underlying instruction list container.  You
 122   /// need to access it directly if you want to modify it currently.
 123   ///
 124   const InstListType &getInstList() const { return InstList; }
 125         InstListType &getInstList()       { return InstList; }
 126
 127   virtual void print(std::ostream &OS) const { print(OS, 0); }
 128   void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
 129
 130   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 131   static inline bool classof(const BasicBlock *BB) { return true; }
 132   static inline bool classof(const Value *V) {
 133     return V->getValueType() == Value::BasicBlockVal;
 134   }
 135
 136   /// hasConstantReferences() - This predicate is true if there is a
 137   /// reference to this basic block in the constant pool for this method.  For
 138   /// example, if a block is reached through a switch table, that table resides
 139   /// in the constant pool, and the basic block is reference from it.
 140   ///
 141   bool hasConstantReferences() const;
 142
 143   /// dropAllReferences() - This function causes all the subinstructions to "let
 144   /// go" of all references that they are maintaining.  This allows one to
 145   /// 'delete' a whole class at a time, even though there may be circular
 146   /// references... first all references are dropped, and all use counts go to
 147   /// zero.  Then everything is delete'd for real.  Note that no operations are
 148   /// valid on an object that has "dropped all references", except operator
 149   /// delete.
 150   ///
 151   void dropAllReferences();
 152
 153   /// removePredecessor - This method is used to notify a BasicBlock that the
 154   /// specified Predecessor of the block is no longer able to reach it.  This is
 155   /// actually not used to update the Predecessor list, but is actually used to
 156   /// update the PHI nodes that reside in the block.  Note that this should be
 157   /// called while the predecessor still refers to this block.
 158   ///
 159   void removePredecessor(BasicBlock *Pred);
 160
 161   /// splitBasicBlock - This splits a basic block into two at the specified
 162   /// instruction.  Note that all instructions BEFORE the specified iterator
 163   /// stay as part of the original basic block, an unconditional branch is added
 164   /// to the new BB, and the rest of the instructions in the BB are moved to the
 165   /// new BB, including the old terminator.  The newly formed BasicBlock is
 166   /// returned.  This function invalidates the specified iterator.
 167   ///
 168   /// Note that this only works on well formed basic blocks (must have a
 169   /// terminator), and 'I' must not be the end of instruction list (which would
 170   /// cause a degenerate basic block to be formed, having a terminator inside of
 171   /// the basic block).
 172   ///
 173   BasicBlock *splitBasicBlock(iterator I, const std::string &BBName = "");
 174 };
 175
 176 } // End llvm namespace
 177
 178 #endif