include/llvm/Function.h

   1 //===-- llvm/Method.h - Class to represent a single VM method ----*- C++ -*--=//
   2 //
   3 // This file contains the declaration of the Method class, which represents a
   4 // single Method/function/procedure in the VM.
   5 //
   6 // Note that basic blocks themselves are Def's, because they are referenced
   7 // by instructions like calls and can go in virtual function tables and stuff.
   8 //
   9 //===----------------------------------------------------------------------===//
  10
  11 #ifndef LLVM_METHOD_H
  12 #define LLVM_METHOD_H
  13
  14 #include "llvm/SymTabValue.h"
  15 #include "llvm/BasicBlock.h"
  16
  17 class Instruction;
  18 class BasicBlock;
  19 class MethodArgument;
  20 class MethodType;
  21 class Module;
  22
  23 class Method : public Value, public SymTabValue {
  24 public:
  25   typedef ValueHolder<MethodArgument, Method, Method> ArgumentListType;
  26   typedef ValueHolder<BasicBlock    , Method, Method> BasicBlocksType;
  27
  28   // BasicBlock iterators...
  29   typedef BasicBlocksType::iterator iterator;
  30   typedef BasicBlocksType::const_iterator const_iterator;
  31   typedef reverse_iterator<const_iterator> const_reverse_iterator;
  32   typedef reverse_iterator<iterator>             reverse_iterator;
  33
  34 private:
  35
  36   // Important things that make up a method!
  37   BasicBlocksType  BasicBlocks;    // The basic blocks
  38   ArgumentListType ArgumentList;   // The formal arguments
  39
  40   Module *Parent;                  // The module that contains this method
  41
  42   friend class ValueHolder<Method, Module, Module>;
  43   void setParent(Module *parent);
  44
  45 public:
  46   Method(const MethodType *Ty, const string &Name = "");
  47   ~Method();
  48
  49   // Specialize setName to handle symbol table majik...
  50   virtual void setName(const string &name, SymbolTable *ST = 0);
  51
  52   const Type *getReturnType() const;
  53   const MethodType *getType() const {
  54     return (const MethodType*)Value::getType();
  55   }
  56
  57   // Is the body of this method unknown? (the basic block list is empty if so)
  58   // this is true for external methods, defined as forward "declare"ations
  59   bool isExternal() const { return BasicBlocks.empty(); }
  60
  61
  62   // Get the class structure that this method is contained inside of...
  63   inline Module *getParent() { return Parent; }
  64   inline const Module *getParent() const { return Parent; }
  65
  66   // Get the underlying elements of the Method...
  67   inline const ArgumentListType &getArgumentList() const{ return ArgumentList; }
  68   inline       ArgumentListType &getArgumentList()      { return ArgumentList; }
  69
  70   inline const BasicBlocksType  &getBasicBlocks() const { return BasicBlocks; }
  71   inline       BasicBlocksType  &getBasicBlocks()       { return BasicBlocks; }
  72
  73
  74   //===--------------------------------------------------------------------===//
  75   // BasicBlock iterator forwarding functions
  76   //
  77   inline iterator                begin()       { return BasicBlocks.begin(); }
  78   inline const_iterator          begin() const { return BasicBlocks.begin(); }
  79   inline iterator                end  ()       { return BasicBlocks.end();   }
  80   inline const_iterator          end  () const { return BasicBlocks.end();   }
  81
  82   inline reverse_iterator       rbegin()       { return BasicBlocks.rbegin(); }
  83   inline const_reverse_iterator rbegin() const { return BasicBlocks.rbegin(); }
  84   inline reverse_iterator       rend  ()       { return BasicBlocks.rend();   }
  85   inline const_reverse_iterator rend  () const { return BasicBlocks.rend();   }
  86
  87   inline unsigned                 size() const { return BasicBlocks.size(); }
  88   inline bool                    empty() const { return BasicBlocks.empty(); }
  89   inline const BasicBlock       *front() const { return BasicBlocks.front(); }
  90   inline       BasicBlock       *front()       { return BasicBlocks.front(); }
  91   inline const BasicBlock        *back() const { return BasicBlocks.back(); }
  92   inline       BasicBlock        *back()       { return BasicBlocks.back(); }
  93
  94
  95   // Methods for support type inquiry through isa, cast, and dyn_cast:
  96   static inline bool classof(const Method *T) { return true; }
  97   static inline bool classof(const Value *V) {
  98     return V->getValueType() == Value::MethodVal;
  99   }
 100
 101   // dropAllReferences() - This function causes all the subinstructions to "let
 102   // go" of all references that they are maintaining.  This allows one to
 103   // 'delete' a whole class at a time, even though there may be circular
 104   // references... first all references are dropped, and all use counts go to
 105   // zero.  Then everything is delete'd for real.  Note that no operations are
 106   // valid on an object that has "dropped all references", except operator
 107   // delete.
 108   //
 109   void dropAllReferences();
 110
 111   //===--------------------------------------------------------------------===//
 112   // Method Instruction iterator code
 113   //===--------------------------------------------------------------------===//
 114   //
 115   template <class _BB_t, class _BB_i_t, class _BI_t, class _II_t>
 116   class InstIterator;
 117   typedef InstIterator<BasicBlocksType, iterator,
 118                        BasicBlock::iterator, Instruction*> inst_iterator;
 119   typedef InstIterator<const BasicBlocksType, const_iterator,
 120                        BasicBlock::const_iterator,
 121                        const Instruction*> inst_const_iterator;
 122
 123   // This inner class is used to implement inst_begin() & inst_end() for
 124   // inst_iterator and inst_const_iterator's.
 125   //
 126   template <class _BB_t, class _BB_i_t, class _BI_t, class _II_t>
 127   class InstIterator {
 128     typedef _BB_t   BBty;
 129     typedef _BB_i_t BBIty;
 130     typedef _BI_t   BIty;
 131     typedef _II_t   IIty;
 132     _BB_t  &BBs;      // BasicBlocksType
 133     _BB_i_t BB;       // BasicBlocksType::iterator
 134     _BI_t   BI;       // BasicBlock::iterator
 135   public:
 136     typedef bidirectional_iterator_tag iterator_category;
 137
 138     template<class M> InstIterator(M &m)
 139       : BBs(m.getBasicBlocks()), BB(BBs.begin()) {    // begin ctor
 140       if (BB != BBs.end()) {
 141         BI = (*BB)->begin();
 142         resyncInstructionIterator();
 143       }
 144     }
 145
 146     template<class M> InstIterator(M &m, bool)
 147       : BBs(m.getBasicBlocks()), BB(BBs.end()) {    // end ctor
 148     }
 149
 150     // Accessors to get at the underlying iterators...
 151     inline BBIty &getBasicBlockIterator()  { return BB; }
 152     inline BIty  &getInstructionIterator() { return BI; }
 153
 154     inline IIty operator*()  const { return *BI; }
 155     inline IIty operator->() const { return operator*(); }
 156
 157     inline bool operator==(const InstIterator &y) const {
 158       return BB == y.BB && (BI == y.BI || BB == BBs.end());
 159     }
 160     inline bool operator!=(const InstIterator& y) const {
 161       return !operator==(y);
 162     }
 163
 164     // resyncInstructionIterator - This should be called if the
 165     // InstructionIterator is modified outside of our control.  This resynchs
 166     // the internals of the InstIterator to a consistent state.
 167     //
 168     inline void resyncInstructionIterator() {
 169       // The only way that the II could be broken is if it is now pointing to
 170       // the end() of the current BasicBlock and there are successor BBs.
 171       while (BI == (*BB)->end()) {
 172         ++BB;
 173         if (BB == BBs.end()) break;
 174         BI = (*BB)->begin();
 175       }
 176     }
 177
 178     InstIterator& operator++() {
 179       ++BI;
 180       resyncInstructionIterator();   // Make sure it is still valid.
 181       return *this;
 182     }
 183     inline InstIterator operator++(int) {
 184       InstIterator tmp = *this; ++*this; return tmp;
 185     }
 186
 187     InstIterator& operator--() {
 188       while (BB == BBs.end() || BI == (*BB)->begin()) {
 189         --BB;
 190         BI = (*BB)->end();
 191       }
 192       --BI;
 193       return *this;
 194     }
 195     inline InstIterator  operator--(int) {
 196       InstIterator tmp = *this; --*this; return tmp;
 197     }
 198
 199     inline bool atEnd() const { return BB == BBs.end(); }
 200   };
 201
 202   inline inst_iterator inst_begin() { return inst_iterator(*this); }
 203   inline inst_iterator inst_end()   { return inst_iterator(*this, true); }
 204   inline inst_const_iterator inst_begin() const { return inst_const_iterator(*this); }
 205   inline inst_const_iterator inst_end()   const { return inst_const_iterator(*this, true); }
 206 };
 207
 208 // Provide specializations of GraphTraits to be able to treat a method as a
 209 // graph of basic blocks... these are the same as the basic block iterators,
 210 // except that the root node is implicitly the first node of the method.
 211 //
 212 template <> struct GraphTraits<Method*> : public GraphTraits<BasicBlock*> {
 213   static NodeType *getEntryNode(Method *M) { return M->front(); }
 214 };
 215 template <> struct GraphTraits<const Method*> :
 216   public GraphTraits<const BasicBlock*> {
 217   static NodeType *getEntryNode(const Method *M) { return M->front(); }
 218 };
 219
 220 // Provide specializations of GraphTraits to be able to treat a method as a
 221 // graph of basic blocks... and to walk it in inverse order.  Inverse order for
 222 // a method is considered to be when traversing the predecessor edges of a BB
 223 // instead of the successor edges.
 224 //
 225 template <> struct GraphTraits<Inverse<Method*> > :
 226   public GraphTraits<Inverse<BasicBlock*> > {
 227   static NodeType *getEntryNode(Inverse<Method *> G) { return G.Graph->front();}
 228 };
 229 template <> struct GraphTraits<Inverse<const Method*> > :
 230   public GraphTraits<Inverse<const BasicBlock*> > {
 231   static NodeType *getEntryNode(Inverse<const Method *> G) {
 232     return G.Graph->front();
 233   }
 234 };
 235
 236 #endif