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 #include "llvm/ADT/SetVector.h"
  25 #include "llvm/Support/DataTypes.h"
  26
  27 namespace llvm {
  28
  29 class GlobalVariable;
  30 class GlobalValueRefMap;   // Used by ConstantVals.cpp
  31 class FunctionType;
  32 class SymbolTable;
  33
  34 template<> struct ilist_traits<Function>
  35   : public SymbolTableListTraits<Function, Module, Module> {
  36   // createSentinel is used to create a node that marks the end of the list.
  37   static Function *createSentinel();
  38   static void destroySentinel(Function *F) { delete F; }
  39   static iplist<Function> &getList(Module *M);
  40 };
  41 template<> struct ilist_traits<GlobalVariable>
  42   : public SymbolTableListTraits<GlobalVariable, Module, Module> {
  43   // createSentinel is used to create a node that marks the end of the list.
  44   static GlobalVariable *createSentinel();
  45   static void destroySentinel(GlobalVariable *GV) { delete GV; }
  46   static iplist<GlobalVariable> &getList(Module *M);
  47 };
  48
  49 class Module {
  50 public:
  51   typedef iplist<GlobalVariable> GlobalListType;
  52   typedef iplist<Function> FunctionListType;
  53   typedef SetVector<std::string> LibraryListType;
  54
  55   // Global Variable iterators.
  56   typedef GlobalListType::iterator                     global_iterator;
  57   typedef GlobalListType::const_iterator         const_global_iterator;
  58
  59   // Function iterators.
  60   typedef FunctionListType::iterator                          iterator;
  61   typedef FunctionListType::const_iterator              const_iterator;
  62
  63   // Library list iterators.
  64   typedef LibraryListType::const_iterator lib_iterator;
  65
  66   enum Endianness  { AnyEndianness, LittleEndian, BigEndian };
  67   enum PointerSize { AnyPointerSize, Pointer32, Pointer64 };
  68
  69 private:
  70   GlobalListType GlobalList;     // The Global Variables in the module
  71   FunctionListType FunctionList; // The Functions in the module
  72   LibraryListType LibraryList;   // The Libraries needed by the module
  73   SymbolTable *SymTab;           // Symbol Table for the module
  74   std::string ModuleID;          // Human readable identifier for the module
  75   std::string TargetTriple;      // Platform target triple Module compiled on
  76
  77   Endianness  Endian;     // Endianness assumed in the module
  78   PointerSize PtrSize;    // Pointer size assumed in the module
  79
  80   friend class Constant;
  81
  82 public:
  83   Module(const std::string &ModuleID);
  84   ~Module();
  85
  86   const std::string &getModuleIdentifier() const { return ModuleID; }
  87   void setModuleIdentifier(const std::string &ID) { ModuleID = ID; }
  88
  89   const std::string &getTargetTriple() const { return TargetTriple; }
  90   void setTargetTriple(const std::string &T) { TargetTriple = T; }
  91
  92   /// Target endian information...
  93   Endianness getEndianness() const { return Endian; }
  94   void setEndianness(Endianness E) { Endian = E; }
  95
  96   /// Target Pointer Size information...
  97   PointerSize getPointerSize() const { return PtrSize; }
  98   void setPointerSize(PointerSize PS) { PtrSize = PS; }
  99
 100   //===--------------------------------------------------------------------===//
 101   // Methods for easy access to the functions in the module.
 102   //
 103
 104   /// getOrInsertFunction - Look up the specified function in the module symbol
 105   /// table.  If it does not exist, add a prototype for the function and return
 106   /// it.
 107   Function *getOrInsertFunction(const std::string &Name, const FunctionType *T);
 108
 109   /// getOrInsertFunction - Look up the specified function in the module symbol
 110   /// table.  If it does not exist, add a prototype for the function and return
 111   /// it.  This version of the method takes a null terminated list of function
 112   /// arguments, which makes it easier for clients to use.
 113   Function *getOrInsertFunction(const std::string &Name, const Type *RetTy,...)
 114     END_WITH_NULL;
 115
 116   /// getFunction - Look up the specified function in the module symbol table.
 117   /// If it does not exist, return null.
 118   ///
 119   Function *getFunction(const std::string &Name, const FunctionType *Ty);
 120
 121   /// getMainFunction - This function looks up main efficiently.  This is such a
 122   /// common case, that it is a method in Module.  If main cannot be found, a
 123   /// null pointer is returned.
 124   ///
 125   Function *getMainFunction();
 126
 127   /// getNamedFunction - Return the first function in the module with the
 128   /// specified name, of arbitrary type.  This method returns null if a function
 129   /// with the specified name is not found.
 130   ///
 131   Function *getNamedFunction(const std::string &Name);
 132
 133   //===--------------------------------------------------------------------===//
 134   // Methods for easy access to the global variables in the module.
 135   //
 136
 137   /// getGlobalVariable - Look up the specified global variable in the module
 138   /// symbol table.  If it does not exist, return null.  The type argument
 139   /// should be the underlying type of the global, i.e., it should not have
 140   /// the top-level PointerType, which represents the address of the global.
 141   /// If AllowInternal is set to true, this function will return types that
 142   /// have InternalLinkage. By default, these types are not returned.
 143   ///
 144   GlobalVariable *getGlobalVariable(const std::string &Name, const Type *Ty,
 145                                     bool AllowInternal = false);
 146
 147
 148   //===--------------------------------------------------------------------===//
 149   // Methods for easy access to the types in the module.
 150   //
 151
 152   /// addTypeName - Insert an entry in the symbol table mapping Str to Type.  If
 153   /// there is already an entry for this name, true is returned and the symbol
 154   /// table is not modified.
 155   ///
 156   bool addTypeName(const std::string &Name, const Type *Ty);
 157
 158   /// getTypeName - If there is at least one entry in the symbol table for the
 159   /// specified type, return it.
 160   ///
 161   std::string getTypeName(const Type *Ty) const;
 162
 163   /// getTypeByName - Return the type with the specified name in this module, or
 164   /// null if there is none by that name.
 165   const Type *getTypeByName(const std::string &Name) const;
 166
 167
 168   //===--------------------------------------------------------------------===//
 169   // Methods for direct access to the globals list, functions list, and symbol
 170   // table.
 171   //
 172
 173   /// Get the underlying elements of the Module...
 174   inline const GlobalListType &getGlobalList() const  { return GlobalList; }
 175   inline       GlobalListType &getGlobalList()        { return GlobalList; }
 176   inline const FunctionListType &getFunctionList() const { return FunctionList;}
 177   inline       FunctionListType &getFunctionList()       { return FunctionList;}
 178
 179   /// getSymbolTable() - Get access to the symbol table for the module, where
 180   /// global variables and functions are identified.
 181   ///
 182   inline       SymbolTable &getSymbolTable()       { return *SymTab; }
 183   inline const SymbolTable &getSymbolTable() const { return *SymTab; }
 184
 185
 186   //===--------------------------------------------------------------------===//
 187   // Module iterator forwarding functions
 188   //
 189   // Globals list interface
 190   global_iterator       global_begin()       { return GlobalList.begin(); }
 191   const_global_iterator global_begin() const { return GlobalList.begin(); }
 192   global_iterator       global_end  ()       { return GlobalList.end(); }
 193   const_global_iterator global_end  () const { return GlobalList.end(); }
 194   bool                  global_empty() const { return GlobalList.empty(); }
 195
 196   // FunctionList interface
 197   inline iterator                begin()       { return FunctionList.begin(); }
 198   inline const_iterator          begin() const { return FunctionList.begin(); }
 199   inline iterator                end  ()       { return FunctionList.end();   }
 200   inline const_iterator          end  () const { return FunctionList.end();   }
 201
 202   inline size_t                   size() const { return FunctionList.size(); }
 203   inline bool                    empty() const { return FunctionList.empty(); }
 204
 205   //===--------------------------------------------------------------------===//
 206   // List of dependent library access functions
 207
 208   /// @brief Get a constant iterator to beginning of dependent library list.
 209   inline lib_iterator lib_begin() const { return LibraryList.begin(); }
 210
 211   /// @brief Get a constant iterator to end of dependent library list.
 212   inline lib_iterator lib_end() const { return LibraryList.end(); }
 213
 214   /// @brief Returns the number of items in the list of libraries.
 215   inline size_t lib_size() const { return LibraryList.size(); }
 216
 217   /// @brief Add a library to the list of dependent libraries
 218   inline void addLibrary(const std::string& Lib){ LibraryList.insert(Lib); }
 219
 220   /// @brief Remove a library from the list of dependent libraries
 221   inline void removeLibrary(const std::string& Lib) { LibraryList.remove(Lib); }
 222
 223   /// @brief Get all the libraries
 224   inline const LibraryListType& getLibraries() const { return LibraryList; }
 225
 226   //===--------------------------------------------------------------------===//
 227   // Utility functions for printing and dumping Module objects
 228
 229   void print(std::ostream &OS) const { print(OS, 0); }
 230   void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
 231
 232   void dump() const;
 233
 234   /// dropAllReferences() - This function causes all the subinstructions to "let
 235   /// go" of all references that they are maintaining.  This allows one to
 236   /// 'delete' a whole class at a time, even though there may be circular
 237   /// references... first all references are dropped, and all use counts go to
 238   /// zero.  Then everything is delete'd for real.  Note that no operations are
 239   /// valid on an object that has "dropped all references", except operator
 240   /// delete.
 241   ///
 242   void dropAllReferences();
 243 };
 244
 245 inline std::ostream &operator<<(std::ostream &O, const Module &M) {
 246   M.print(O);
 247   return O;
 248 }
 249
 250 } // End llvm namespace
 251
 252 #endif