include/llvm/Module.h

   1 //===-- llvm/Module.h - C++ class to represent a VM module -------*- C++ -*--=//
   2 //
   3 // This file contains the declarations for the Module class that is used to
   4 // maintain all the information related to a VM module.
   5 //
   6 // A module also maintains a GlobalValRefMap object that is used to hold all
   7 // constant references to global variables in the module.  When a global
   8 // variable is destroyed, it should have no entries in the GlobalValueRefMap.
   9 //
  10 //===----------------------------------------------------------------------===//
  11
  12 #ifndef LLVM_MODULE_H
  13 #define LLVM_MODULE_H
  14
  15 #include "llvm/Function.h"
  16 #include "llvm/GlobalVariable.h"
  17 class GlobalVariable;
  18 class GlobalValueRefMap;   // Used by ConstantVals.cpp
  19 class ConstantPointerRef;
  20 class FunctionType;
  21 class SymbolTable;
  22
  23 template<> struct ilist_traits<Function>
  24   : public SymbolTableListTraits<Function, Module, Module> {
  25   // createNode is used to create a node that marks the end of the list...
  26   static Function *createNode();
  27   static iplist<Function> &getList(Module *M);
  28 };
  29 template<> struct ilist_traits<GlobalVariable>
  30   : public SymbolTableListTraits<GlobalVariable, Module, Module> {
  31   // createNode is used to create a node that marks the end of the list...
  32   static GlobalVariable *createNode();
  33   static iplist<GlobalVariable> &getList(Module *M);
  34 };
  35
  36 class Module : public Annotable {
  37 public:
  38   typedef iplist<GlobalVariable> GlobalListType;
  39   typedef iplist<Function> FunctionListType;
  40
  41   // Global Variable iterators...
  42   typedef GlobalListType::iterator                             giterator;
  43   typedef GlobalListType::const_iterator                 const_giterator;
  44   typedef std::reverse_iterator<giterator>             reverse_giterator;
  45   typedef std::reverse_iterator<const_giterator> const_reverse_giterator;
  46
  47   // Function iterators...
  48   typedef FunctionListType::iterator                            iterator;
  49   typedef FunctionListType::const_iterator                const_iterator;
  50   typedef std::reverse_iterator<iterator>             reverse_iterator;
  51   typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
  52
  53 private:
  54   GlobalListType GlobalList;     // The Global Variables
  55   FunctionListType FunctionList;     // The Functions
  56
  57   GlobalValueRefMap *GVRefMap;
  58
  59   SymbolTable *SymTab;
  60
  61   // Accessor for the underlying GlobalValRefMap... only through the
  62   // Constant class...
  63   friend class Constant;
  64   friend class ConstantPointerRef;
  65   void mutateConstantPointerRef(GlobalValue *OldGV, GlobalValue *NewGV);
  66   ConstantPointerRef *getConstantPointerRef(GlobalValue *GV);
  67   void destroyConstantPointerRef(ConstantPointerRef *CPR);
  68
  69 public:
  70   Module();
  71   ~Module();
  72
  73   /// getOrInsertFunction - Look up the specified function in the module symbol
  74   /// table.  If it does not exist, add a prototype for the function and return
  75   /// it.
  76   Function *getOrInsertFunction(const std::string &Name, const FunctionType *T);
  77
  78   /// getFunction - Look up the specified function in the module symbol table.
  79   /// If it does not exist, return null.
  80   ///
  81   Function *getFunction(const std::string &Name, const FunctionType *Ty);
  82
  83   /// getMainFunction - This function looks up main efficiently.  This is such a
  84   /// common case, that it is a method in Module.  If main cannot be found, a
  85   /// null pointer is returned.
  86   ///
  87   Function *getMainFunction();
  88
  89   /// addTypeName - Insert an entry in the symbol table mapping Str to Type.  If
  90   /// there is already an entry for this name, true is returned and the symbol
  91   /// table is not modified.
  92   ///
  93   bool addTypeName(const std::string &Name, const Type *Ty);
  94
  95   /// getTypeName - If there is at least one entry in the symbol table for the
  96   /// specified type, return it.
  97   ///
  98   std::string getTypeName(const Type *Ty);
  99
 100   /// Get the underlying elements of the Module...
 101   inline const GlobalListType &getGlobalList() const  { return GlobalList; }
 102   inline       GlobalListType &getGlobalList()        { return GlobalList; }
 103   inline const FunctionListType &getFunctionList() const { return FunctionList;}
 104   inline       FunctionListType &getFunctionList()       { return FunctionList;}
 105
 106
 107   //===--------------------------------------------------------------------===//
 108   // Symbol table support functions...
 109
 110   /// hasSymbolTable() - Returns true if there is a symbol table allocated to
 111   /// this object AND if there is at least one name in it!
 112   ///
 113   bool hasSymbolTable() const;
 114
 115   /// getSymbolTable() - CAUTION: The current symbol table may be null if there
 116   /// are no names (ie, the symbol table is empty)
 117   ///
 118   inline       SymbolTable *getSymbolTable()       { return SymTab; }
 119   inline const SymbolTable *getSymbolTable() const { return SymTab; }
 120
 121   /// getSymbolTableSure is guaranteed to not return a null pointer, because if
 122   /// the method does not already have a symtab, one is created.  Use this if
 123   /// you intend to put something into the symbol table for the method.
 124   ///
 125   SymbolTable *getSymbolTableSure();
 126
 127
 128   //===--------------------------------------------------------------------===//
 129   // Module iterator forwarding functions
 130   //
 131   inline giterator                gbegin()       { return GlobalList.begin(); }
 132   inline const_giterator          gbegin() const { return GlobalList.begin(); }
 133   inline giterator                gend  ()       { return GlobalList.end();   }
 134   inline const_giterator          gend  () const { return GlobalList.end();   }
 135
 136   inline reverse_giterator       grbegin()       { return GlobalList.rbegin(); }
 137   inline const_reverse_giterator grbegin() const { return GlobalList.rbegin(); }
 138   inline reverse_giterator       grend  ()       { return GlobalList.rend();   }
 139   inline const_reverse_giterator grend  () const { return GlobalList.rend();   }
 140
 141   inline unsigned                  gsize() const { return GlobalList.size(); }
 142   inline bool                     gempty() const { return GlobalList.empty(); }
 143   inline const GlobalVariable    &gfront() const { return GlobalList.front(); }
 144   inline       GlobalVariable    &gfront()       { return GlobalList.front(); }
 145   inline const GlobalVariable     &gback() const { return GlobalList.back(); }
 146   inline       GlobalVariable     &gback()       { return GlobalList.back(); }
 147
 148
 149
 150   inline iterator                begin()       { return FunctionList.begin(); }
 151   inline const_iterator          begin() const { return FunctionList.begin(); }
 152   inline iterator                end  ()       { return FunctionList.end();   }
 153   inline const_iterator          end  () const { return FunctionList.end();   }
 154
 155   inline reverse_iterator       rbegin()       { return FunctionList.rbegin(); }
 156   inline const_reverse_iterator rbegin() const { return FunctionList.rbegin(); }
 157   inline reverse_iterator       rend  ()       { return FunctionList.rend();   }
 158   inline const_reverse_iterator rend  () const { return FunctionList.rend();   }
 159
 160   inline unsigned                 size() const { return FunctionList.size(); }
 161   inline bool                    empty() const { return FunctionList.empty(); }
 162   inline const Function         &front() const { return FunctionList.front(); }
 163   inline       Function         &front()       { return FunctionList.front(); }
 164   inline const Function          &back() const { return FunctionList.back(); }
 165   inline       Function          &back()       { return FunctionList.back(); }
 166
 167   void print(std::ostream &OS) const;
 168   void dump() const;
 169
 170   /// dropAllReferences() - This function causes all the subinstructions to "let
 171   /// go" of all references that they are maintaining.  This allows one to
 172   /// 'delete' a whole class at a time, even though there may be circular
 173   /// references... first all references are dropped, and all use counts go to
 174   /// zero.  Then everything is delete'd for real.  Note that no operations are
 175   /// valid on an object that has "dropped all references", except operator
 176   /// delete.
 177   ///
 178   void dropAllReferences();
 179 };
 180
 181 inline std::ostream &operator<<(std::ostream &O, const Module *M) {
 182   M->print(O);
 183   return O;
 184 }
 185
 186 inline std::ostream &operator<<(std::ostream &O, const Module &M) {
 187   M.print(O);
 188   return O;
 189 }
 190
 191 #endif