include/llvm/CodeGen/MachineBasicBlock.h

   1 //===-- llvm/CodeGen/MachineBasicBlock.h ------------------------*- 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 // Collect the sequence of machine instructions for a basic block.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_CODEGEN_MACHINEBASICBLOCK_H
  15 #define LLVM_CODEGEN_MACHINEBASICBLOCK_H
  16
  17 #include "llvm/CodeGen/MachineInstr.h"
  18 #include "Support/GraphTraits.h"
  19 #include "Support/ilist"
  20 #include <iosfwd>
  21
  22 namespace llvm {
  23   class MachineFunction;
  24
  25 // ilist_traits
  26 template <>
  27 class ilist_traits<MachineInstr> {
  28   // this is only set by the MachineBasicBlock owning the ilist
  29   friend class MachineBasicBlock;
  30   MachineBasicBlock* parent;
  31
  32 public:
  33   ilist_traits<MachineInstr>() : parent(0) { }
  34
  35   static MachineInstr* getPrev(MachineInstr* N) { return N->prev; }
  36   static MachineInstr* getNext(MachineInstr* N) { return N->next; }
  37
  38   static const MachineInstr*
  39   getPrev(const MachineInstr* N) { return N->prev; }
  40
  41   static const MachineInstr*
  42   getNext(const MachineInstr* N) { return N->next; }
  43
  44   static void setPrev(MachineInstr* N, MachineInstr* prev) { N->prev = prev; }
  45   static void setNext(MachineInstr* N, MachineInstr* next) { N->next = next; }
  46
  47   static MachineInstr* createNode();
  48   void addNodeToList(MachineInstr* N);
  49   void removeNodeFromList(MachineInstr* N);
  50   void transferNodesFromList(
  51       iplist<MachineInstr, ilist_traits<MachineInstr> >& toList,
  52       ilist_iterator<MachineInstr> first,
  53       ilist_iterator<MachineInstr> last);
  54 };
  55
  56 class BasicBlock;
  57
  58 class MachineBasicBlock {
  59 public:
  60   typedef ilist<MachineInstr> Instructions;
  61   Instructions Insts;
  62   MachineBasicBlock *Prev, *Next;
  63   const BasicBlock *BB;
  64   std::vector<MachineBasicBlock *> Predecessors;
  65   std::vector<MachineBasicBlock *> Successors;
  66   int Number;
  67   MachineFunction *Parent;
  68
  69 public:
  70   MachineBasicBlock(const BasicBlock *bb = 0) : Prev(0), Next(0), BB(bb),
  71                                                 Number(-1), Parent(0) {
  72     Insts.parent = this;
  73   }
  74
  75   ~MachineBasicBlock();
  76
  77   /// getBasicBlock - Return the LLVM basic block that this instance
  78   /// corresponded to originally.
  79   ///
  80   const BasicBlock *getBasicBlock() const { return BB; }
  81
  82   /// getParent - Return the MachineFunction containing this basic block.
  83   ///
  84   const MachineFunction *getParent() const { return Parent; }
  85   MachineFunction *getParent() { return Parent; }
  86
  87   typedef ilist<MachineInstr>::iterator                       iterator;
  88   typedef ilist<MachineInstr>::const_iterator           const_iterator;
  89   typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
  90   typedef std::reverse_iterator<iterator>             reverse_iterator;
  91
  92   unsigned size() const { return Insts.size(); }
  93   bool empty() const { return Insts.empty(); }
  94
  95   MachineInstr& front() { return Insts.front(); }
  96   MachineInstr& back()  { return Insts.back(); }
  97
  98   iterator                begin()       { return Insts.begin();  }
  99   const_iterator          begin() const { return Insts.begin();  }
 100   iterator                  end()       { return Insts.end();    }
 101   const_iterator            end() const { return Insts.end();    }
 102   reverse_iterator       rbegin()       { return Insts.rbegin(); }
 103   const_reverse_iterator rbegin() const { return Insts.rbegin(); }
 104   reverse_iterator       rend  ()       { return Insts.rend();   }
 105   const_reverse_iterator rend  () const { return Insts.rend();   }
 106
 107   // Machine-CFG iterators
 108   typedef std::vector<MachineBasicBlock *>::iterator       pred_iterator;
 109   typedef std::vector<MachineBasicBlock *>::const_iterator const_pred_iterator;
 110   typedef std::vector<MachineBasicBlock *>::iterator       succ_iterator;
 111   typedef std::vector<MachineBasicBlock *>::const_iterator const_succ_iterator;
 112
 113   pred_iterator        pred_begin()       { return Predecessors.begin (); }
 114   const_pred_iterator  pred_begin() const { return Predecessors.begin (); }
 115   pred_iterator        pred_end()         { return Predecessors.end ();   }
 116   const_pred_iterator  pred_end()   const { return Predecessors.end ();   }
 117   unsigned             pred_size()  const { return Predecessors.size ();  }
 118   succ_iterator        succ_begin()       { return Successors.begin ();   }
 119   const_succ_iterator  succ_begin() const { return Successors.begin ();   }
 120   succ_iterator        succ_end()         { return Successors.end ();     }
 121   const_succ_iterator  succ_end()   const { return Successors.end ();     }
 122   unsigned             succ_size()  const { return Successors.size ();    }
 123
 124   // Machine-CFG mutators
 125
 126   /// addSuccessor - Add succ as a successor of this MachineBasicBlock.
 127   /// The Predecessors list of succ is automatically updated.
 128   ///
 129   void addSuccessor (MachineBasicBlock *succ) {
 130     Successors.push_back (succ);
 131     succ->addPredecessor (this);
 132   }
 133
 134   /// removeSuccessor - Remove succ from the successors list of this
 135   /// MachineBasicBlock. The Predecessors list of succ is automatically updated.
 136   ///
 137   void removeSuccessor (MachineBasicBlock *succ) {
 138     succ->removePredecessor (this);
 139     std::vector<MachineBasicBlock *>::iterator goner =
 140       std::find (Successors.begin(), Successors.end (), succ);
 141     Successors.erase (goner);
 142   }
 143
 144   /// getFirstTerminator - returns an iterator to the first terminator
 145   /// instruction of this basic block. If a terminator does not exist,
 146   /// it returns end()
 147   iterator getFirstTerminator();
 148
 149   void pop_front() { Insts.pop_front(); }
 150   void push_back(MachineInstr *MI) { Insts.push_back(MI); }
 151   template<typename IT>
 152   void insert(iterator I, IT S, IT E) { Insts.insert(I, S, E); }
 153   iterator insert(iterator I, MachineInstr *M) { return Insts.insert(I, M); }
 154
 155   // erase - Remove the specified element or range from the instruction list.
 156   // These functions delete any instructions removed.
 157   //
 158   iterator erase(iterator I)             { return Insts.erase(I); }
 159   iterator erase(iterator I, iterator E) { return Insts.erase(I, E); }
 160   MachineInstr *remove(MachineInstr *I)  { return Insts.remove(I); }
 161   void clear()                           { Insts.clear(); }
 162
 163   // Debugging methods.
 164   void dump() const;
 165   void print(std::ostream &OS) const;
 166
 167   /// getNumber - MachineBasicBlocks are uniquely numbered at the function
 168   /// level, unless they're not in a MachineFunction yet, in which case this
 169   /// will return -1.
 170   ///
 171   int getNumber() const { return Number; }
 172
 173 private:   // Methods used to maintain doubly linked list of blocks...
 174   friend class ilist_traits<MachineBasicBlock>;
 175
 176   MachineBasicBlock *getPrev() const { return Prev; }
 177   MachineBasicBlock *getNext() const { return Next; }
 178   void setPrev(MachineBasicBlock *P) { Prev = P; }
 179   void setNext(MachineBasicBlock *N) { Next = N; }
 180
 181   // Machine-CFG mutators
 182
 183   /// addPredecessor - Remove pred as a predecessor of this MachineBasicBlock.
 184   /// Don't do this unless you know what you're doing, because it doesn't
 185   /// update pred's successors list. Use pred->addSuccessor instead.
 186   ///
 187   void addPredecessor (MachineBasicBlock *pred) {
 188     Predecessors.push_back (pred);
 189   }
 190
 191   /// removePredecessor - Remove pred as a predecessor of this
 192   /// MachineBasicBlock. Don't do this unless you know what you're
 193   /// doing, because it doesn't update pred's successors list. Use
 194   /// pred->removeSuccessor instead.
 195   ///
 196   void removePredecessor (MachineBasicBlock *pred) {
 197     std::vector<MachineBasicBlock *>::iterator goner =
 198       std::find (Predecessors.begin(), Predecessors.end (), pred);
 199     Predecessors.erase (goner);
 200   }
 201 };
 202
 203
 204 //===--------------------------------------------------------------------===//
 205 // GraphTraits specializations for machine basic block graphs (machine-CFGs)
 206 //===--------------------------------------------------------------------===//
 207
 208 // Provide specializations of GraphTraits to be able to treat a
 209 // MachineFunction as a graph of MachineBasicBlocks...
 210 //
 211
 212 template <> struct GraphTraits<MachineBasicBlock *> {
 213   typedef MachineBasicBlock NodeType;
 214   typedef MachineBasicBlock::succ_iterator ChildIteratorType;
 215
 216   static NodeType *getEntryNode(MachineBasicBlock *BB) { return BB; }
 217   static inline ChildIteratorType child_begin(NodeType *N) {
 218     return N->succ_begin();
 219   }
 220   static inline ChildIteratorType child_end(NodeType *N) {
 221     return N->succ_end();
 222   }
 223 };
 224
 225 template <> struct GraphTraits<const MachineBasicBlock *> {
 226   typedef const MachineBasicBlock NodeType;
 227   typedef MachineBasicBlock::const_succ_iterator ChildIteratorType;
 228
 229   static NodeType *getEntryNode(const MachineBasicBlock *BB) { return BB; }
 230   static inline ChildIteratorType child_begin(NodeType *N) {
 231     return N->succ_begin();
 232   }
 233   static inline ChildIteratorType child_end(NodeType *N) {
 234     return N->succ_end();
 235   }
 236 };
 237
 238 // Provide specializations of GraphTraits to be able to treat a
 239 // MachineFunction as a graph of MachineBasicBlocks... and to walk it
 240 // in inverse order.  Inverse order for a function is considered
 241 // to be when traversing the predecessor edges of a MBB
 242 // instead of the successor edges.
 243 //
 244 template <> struct GraphTraits<Inverse<MachineBasicBlock*> > {
 245   typedef MachineBasicBlock NodeType;
 246   typedef MachineBasicBlock::pred_iterator ChildIteratorType;
 247   static NodeType *getEntryNode(Inverse<MachineBasicBlock *> G) {
 248     return G.Graph;
 249   }
 250   static inline ChildIteratorType child_begin(NodeType *N) {
 251     return N->pred_begin();
 252   }
 253   static inline ChildIteratorType child_end(NodeType *N) {
 254     return N->pred_end();
 255   }
 256 };
 257
 258 template <> struct GraphTraits<Inverse<const MachineBasicBlock*> > {
 259   typedef const MachineBasicBlock NodeType;
 260   typedef MachineBasicBlock::const_pred_iterator ChildIteratorType;
 261   static NodeType *getEntryNode(Inverse<const MachineBasicBlock*> G) {
 262     return G.Graph;
 263   }
 264   static inline ChildIteratorType child_begin(NodeType *N) {
 265     return N->pred_begin();
 266   }
 267   static inline ChildIteratorType child_end(NodeType *N) {
 268     return N->pred_end();
 269   }
 270 };
 271
 272 } // End llvm namespace
 273
 274 #endif