include/llvm/Module.h

   1 //===-- llvm/Module.h - C++ class to represent a VM module ------*- 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 // This file contains the declarations for the Module class that is used to
  11 // maintain all the information related to a VM module.
  12 //
  13 // A module also maintains a GlobalValRefMap object that is used to hold all
  14 // constant references to global variables in the module.  When a global
  15 // variable is destroyed, it should have no entries in the GlobalValueRefMap.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #ifndef LLVM_MODULE_H
  20 #define LLVM_MODULE_H
  21
  22 #include "llvm/Function.h"
  23 #include "llvm/GlobalVariable.h"
  24
  25 namespace llvm {
  26
  27 class GlobalVariable;
  28 class GlobalValueRefMap;   // Used by ConstantVals.cpp
  29 class ConstantPointerRef;
  30 class FunctionType;
  31 class SymbolTable;
  32
  33 template<> struct ilist_traits<Function>
  34   : public SymbolTableListTraits<Function, Module, Module> {
  35   // createNode is used to create a node that marks the end of the list...
  36   static Function *createNode();
  37   static iplist<Function> &getList(Module *M);
  38 };
  39 template<> struct ilist_traits<GlobalVariable>
  40   : public SymbolTableListTraits<GlobalVariable, Module, Module> {
  41   // createNode is used to create a node that marks the end of the list...
  42   static GlobalVariable *createNode();
  43   static iplist<GlobalVariable> &getList(Module *M);
  44 };
  45
  46 struct Module : public Annotable {
  47   typedef iplist<GlobalVariable> GlobalListType;
  48   typedef iplist<Function> FunctionListType;
  49
  50   // Global Variable iterators...
  51   typedef GlobalListType::iterator                             giterator;
  52   typedef GlobalListType::const_iterator                 const_giterator;
  53   typedef std::reverse_iterator<giterator>             reverse_giterator;
  54   typedef std::reverse_iterator<const_giterator> const_reverse_giterator;
  55
  56   // Function iterators...
  57   typedef FunctionListType::iterator                          iterator;
  58   typedef FunctionListType::const_iterator              const_iterator;
  59   typedef std::reverse_iterator<iterator>             reverse_iterator;
  60   typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
  61
  62   enum Endianness  { AnyEndianness, LittleEndian, BigEndian };
  63   enum PointerSize { AnyPointerSize, Pointer32, Pointer64 };
  64
  65 private:
  66   GlobalListType GlobalList;     // The Global Variables in the module
  67   FunctionListType FunctionList; // The Functions in the module
  68   GlobalValueRefMap *GVRefMap;   // Keep track of GlobalValueRef's
  69   SymbolTable *SymTab;           // Symbol Table for the module
  70   std::string ModuleID;    // Human readable identifier for the module
  71
  72   // These flags are probably not the right long-term way to handle this kind of
  73   // target information, but it is sufficient for now.
  74   Endianness  Endian;       // True if target is little endian
  75   PointerSize PtrSize;    // True if target has 32-bit pointers (false = 64-bit)
  76
  77   // Accessor for the underlying GVRefMap... only through the Constant class...
  78   friend class Constant;
  79   friend class ConstantPointerRef;
  80   ConstantPointerRef *getConstantPointerRef(GlobalValue *GV);
  81   void destroyConstantPointerRef(ConstantPointerRef *CPR);
  82
  83 public:
  84   Module(const std::string &ModuleID);
  85   ~Module();
  86
  87   const std::string &getModuleIdentifier() const { return ModuleID; }
  88
  89   /// Target endian information...
  90   Endianness getEndianness() const { return Endian; }
  91   void setEndianness(Endianness E) { Endian = E; }
  92
  93   /// Target Pointer Size information...
  94   PointerSize getPointerSize() const { return PtrSize; }
  95   void setPointerSize(PointerSize PS) { PtrSize = PS; }
  96
  97   //===--------------------------------------------------------------------===//
  98   // Methods for easy access to the functions in the module.
  99   //
 100
 101   /// getOrInsertFunction - Look up the specified function in the module symbol
 102   /// table.  If it does not exist, add a prototype for the function and return
 103   /// it.
 104   Function *getOrInsertFunction(const std::string &Name, const FunctionType *T);
 105
 106   /// getOrInsertFunction - Look up the specified function in the module symbol
 107   /// table.  If it does not exist, add a prototype for the function and return
 108   /// it.  This version of the method takes a null terminated list of function
 109   /// arguments, which makes it easier for clients to use.
 110   Function *getOrInsertFunction(const std::string &Name, const Type *RetTy,...);
 111
 112   /// getFunction - Look up the specified function in the module symbol table.
 113   /// If it does not exist, return null.
 114   ///
 115   Function *getFunction(const std::string &Name, const FunctionType *Ty);
 116
 117   /// getMainFunction - This function looks up main efficiently.  This is such a
 118   /// common case, that it is a method in Module.  If main cannot be found, a
 119   /// null pointer is returned.
 120   ///
 121   Function *getMainFunction();
 122
 123   /// getNamedFunction - Return the first function in the module with the
 124   /// specified name, of arbitrary type.  This method returns null if a function
 125   /// with the specified name is not found.
 126   ///
 127   Function *getNamedFunction(const std::string &Name);
 128
 129   //===--------------------------------------------------------------------===//
 130   // Methods for easy access to the global variables in the module.
 131   //
 132
 133   /// getGlobalVariable - Look up the specified global variable in the module
 134   /// symbol table.  If it does not exist, return null.  Note that this only
 135   /// returns a global variable if it does not have internal linkage.  The type
 136   /// argument should be the underlying type of the global, ie, it should not
 137   /// have the top-level PointerType, which represents the address of the
 138   /// global.
 139   ///
 140   GlobalVariable *getGlobalVariable(const std::string &Name, const Type *Ty);
 141
 142
 143   //===--------------------------------------------------------------------===//
 144   // Methods for easy access to the types in the module.
 145   //
 146
 147   /// addTypeName - Insert an entry in the symbol table mapping Str to Type.  If
 148   /// there is already an entry for this name, true is returned and the symbol
 149   /// table is not modified.
 150   ///
 151   bool addTypeName(const std::string &Name, const Type *Ty);
 152
 153   /// getTypeName - If there is at least one entry in the symbol table for the
 154   /// specified type, return it.
 155   ///
 156   std::string getTypeName(const Type *Ty) const;
 157
 158   /// getTypeByName - Return the type with the specified name in this module, or
 159   /// null if there is none by that name.
 160   const Type *getTypeByName(const std::string &Name) const;
 161
 162
 163   //===--------------------------------------------------------------------===//
 164   // Methods for direct access to the globals list, functions list, and symbol
 165   // table.
 166   //
 167
 168   /// Get the underlying elements of the Module...
 169   inline const GlobalListType &getGlobalList() const  { return GlobalList; }
 170   inline       GlobalListType &getGlobalList()        { return GlobalList; }
 171   inline const FunctionListType &getFunctionList() const { return FunctionList;}
 172   inline       FunctionListType &getFunctionList()       { return FunctionList;}
 173
 174   /// getSymbolTable() - Get access to the symbol table for the module, where
 175   /// global variables and functions are identified.
 176   ///
 177   inline       SymbolTable &getSymbolTable()       { return *SymTab; }
 178   inline const SymbolTable &getSymbolTable() const { return *SymTab; }
 179
 180
 181   //===--------------------------------------------------------------------===//
 182   // Module iterator forwarding functions
 183   //
 184   inline giterator                gbegin()       { return GlobalList.begin(); }
 185   inline const_giterator          gbegin() const { return GlobalList.begin(); }
 186   inline giterator                gend  ()       { return GlobalList.end();   }
 187   inline const_giterator          gend  () const { return GlobalList.end();   }
 188
 189   inline reverse_giterator       grbegin()       { return GlobalList.rbegin(); }
 190   inline const_reverse_giterator grbegin() const { return GlobalList.rbegin(); }
 191   inline reverse_giterator       grend  ()       { return GlobalList.rend();   }
 192   inline const_reverse_giterator grend  () const { return GlobalList.rend();   }
 193
 194   inline unsigned                  gsize() const { return GlobalList.size(); }
 195   inline bool                     gempty() const { return GlobalList.empty(); }
 196   inline const GlobalVariable    &gfront() const { return GlobalList.front(); }
 197   inline       GlobalVariable    &gfront()       { return GlobalList.front(); }
 198   inline const GlobalVariable     &gback() const { return GlobalList.back(); }
 199   inline       GlobalVariable     &gback()       { return GlobalList.back(); }
 200
 201
 202
 203   inline iterator                begin()       { return FunctionList.begin(); }
 204   inline const_iterator          begin() const { return FunctionList.begin(); }
 205   inline iterator                end  ()       { return FunctionList.end();   }
 206   inline const_iterator          end  () const { return FunctionList.end();   }
 207
 208   inline reverse_iterator       rbegin()       { return FunctionList.rbegin(); }
 209   inline const_reverse_iterator rbegin() const { return FunctionList.rbegin(); }
 210   inline reverse_iterator       rend  ()       { return FunctionList.rend();   }
 211   inline const_reverse_iterator rend  () const { return FunctionList.rend();   }
 212
 213   inline unsigned                 size() const { return FunctionList.size(); }
 214   inline bool                    empty() const { return FunctionList.empty(); }
 215   inline const Function         &front() const { return FunctionList.front(); }
 216   inline       Function         &front()       { return FunctionList.front(); }
 217   inline const Function          &back() const { return FunctionList.back(); }
 218   inline       Function          &back()       { return FunctionList.back(); }
 219
 220   void print(std::ostream &OS) const { print(OS, 0); }
 221   void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
 222
 223   void dump() const;
 224
 225   /// dropAllReferences() - This function causes all the subinstructions to "let
 226   /// go" of all references that they are maintaining.  This allows one to
 227   /// 'delete' a whole class at a time, even though there may be circular
 228   /// references... first all references are dropped, and all use counts go to
 229   /// zero.  Then everything is delete'd for real.  Note that no operations are
 230   /// valid on an object that has "dropped all references", except operator
 231   /// delete.
 232   ///
 233   void dropAllReferences();
 234 };
 235
 236 inline std::ostream &operator<<(std::ostream &O, const Module *M) {
 237   M->print(O);
 238   return O;
 239 }
 240
 241 inline std::ostream &operator<<(std::ostream &O, const Module &M) {
 242   M.print(O);
 243   return O;
 244 }
 245
 246 } // End llvm namespace
 247
 248 #endif