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/ilist"
  19 #include <iosfwd>
  20
  21 namespace llvm {
  22
  23 // ilist_traits
  24 template <>
  25 class ilist_traits<MachineInstr>
  26 {
  27   typedef ilist_traits<MachineInstr> self;
  28
  29   // this is only set by the MachineBasicBlock owning the ilist
  30   friend class MachineBasicBlock;
  31   MachineBasicBlock* parent;
  32
  33 public:
  34   ilist_traits<MachineInstr>() : parent(0) { }
  35
  36   static MachineInstr* getPrev(MachineInstr* N) { return N->prev; }
  37   static MachineInstr* getNext(MachineInstr* N) { return N->next; }
  38
  39   static const MachineInstr*
  40   getPrev(const MachineInstr* N) { return N->prev; }
  41
  42   static const MachineInstr*
  43   getNext(const MachineInstr* N) { return N->next; }
  44
  45   static void setPrev(MachineInstr* N, MachineInstr* prev) { N->prev = prev; }
  46   static void setNext(MachineInstr* N, MachineInstr* next) { N->next = next; }
  47
  48   static MachineInstr* createNode() { return new MachineInstr(0, 0); }
  49
  50   void addNodeToList(MachineInstr* N) {
  51     assert(N->parent == 0 && "machine instruction already in a basic block");
  52     N->parent = parent;
  53   }
  54
  55   void removeNodeFromList(MachineInstr* N) {
  56     assert(N->parent != 0 && "machine instruction not in a basic block");
  57     N->parent = 0;
  58   }
  59
  60   void transferNodesFromList(iplist<MachineInstr, self>& toList,
  61                              ilist_iterator<MachineInstr> first,
  62                              ilist_iterator<MachineInstr> last) {
  63     if (parent != toList.parent)
  64       for (; first != last; ++first)
  65           first->parent = toList.parent;
  66   }
  67 };
  68
  69 class BasicBlock;
  70
  71 class MachineBasicBlock {
  72 public:
  73   typedef ilist<MachineInstr> Instructions;
  74   Instructions Insts;
  75   MachineBasicBlock *Prev, *Next;
  76   const BasicBlock *BB;
  77 public:
  78   MachineBasicBlock(const BasicBlock *bb = 0) : Prev(0), Next(0), BB(bb) {
  79     Insts.parent = this;
  80   }
  81   ~MachineBasicBlock() {}
  82
  83   /// getBasicBlock - Return the LLVM basic block that this instance
  84   /// corresponded to originally.
  85   ///
  86   const BasicBlock *getBasicBlock() const { return BB; }
  87
  88   typedef ilist<MachineInstr>::iterator                       iterator;
  89   typedef ilist<MachineInstr>::const_iterator           const_iterator;
  90   typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
  91   typedef std::reverse_iterator<iterator>             reverse_iterator;
  92
  93   unsigned size() const { return Insts.size(); }
  94   bool empty() const { return Insts.empty(); }
  95
  96   const MachineInstr& operator[](unsigned i) const {
  97       const_iterator it = Insts.begin();
  98       std::advance(it, i);
  99       return *it;
 100   }
 101   MachineInstr& operator[](unsigned i) {
 102       iterator it = Insts.begin();
 103       std::advance(it, i);
 104       return *it;
 105   }
 106
 107   MachineInstr& front() { return Insts.front(); }
 108   MachineInstr& back()  { return Insts.back(); }
 109
 110   iterator                begin()       { return Insts.begin();  }
 111   const_iterator          begin() const { return Insts.begin();  }
 112   iterator                  end()       { return Insts.end();    }
 113   const_iterator            end() const { return Insts.end();    }
 114   reverse_iterator       rbegin()       { return Insts.rbegin(); }
 115   const_reverse_iterator rbegin() const { return Insts.rbegin(); }
 116   reverse_iterator       rend  ()       { return Insts.rend();   }
 117   const_reverse_iterator rend  () const { return Insts.rend();   }
 118
 119   void push_back(MachineInstr *MI) { Insts.push_back(MI); }
 120   template<typename IT>
 121   void insert(iterator I, IT S, IT E) { Insts.insert(I, S, E); }
 122   iterator insert(iterator I, MachineInstr *M) { return Insts.insert(I, M); }
 123
 124   // erase - Remove the specified element or range from the instruction list.
 125   // These functions delete any instructions removed.
 126   //
 127   iterator erase(iterator I)             { return Insts.erase(I); }
 128   iterator erase(iterator I, iterator E) { return Insts.erase(I, E); }
 129   MachineInstr* remove(iterator &I)      { return Insts.remove(I); }
 130
 131   // Debugging methods.
 132   void dump() const;
 133   void print(std::ostream &OS) const;
 134
 135 private:   // Methods used to maintain doubly linked list of blocks...
 136   friend class ilist_traits<MachineBasicBlock>;
 137
 138   MachineBasicBlock *getPrev() const { return Prev; }
 139   MachineBasicBlock *getNext() const { return Next; }
 140   void setPrev(MachineBasicBlock *P) { Prev = P; }
 141   void setNext(MachineBasicBlock *N) { Next = N; }
 142 };
 143
 144 } // End llvm namespace
 145
 146 #endif