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 /// @file This file contains the declarations for the Module class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_MODULE_H
  15 #define LLVM_MODULE_H
  16
  17 #include "llvm/Function.h"
  18 #include "llvm/GlobalVariable.h"
  19 #include "llvm/ADT/SetVector.h"
  20 #include "llvm/Support/DataTypes.h"
  21
  22 namespace llvm {
  23
  24 class GlobalVariable;
  25 class GlobalValueRefMap;   // Used by ConstantVals.cpp
  26 class FunctionType;
  27 class SymbolTable;
  28 class TypeSymbolTable;
  29
  30 template<> struct ilist_traits<Function>
  31   : public SymbolTableListTraits<Function, Module, Module> {
  32   // createSentinel is used to create a node that marks the end of the list.
  33   static Function *createSentinel();
  34   static void destroySentinel(Function *F) { delete F; }
  35   static iplist<Function> &getList(Module *M);
  36 };
  37 template<> struct ilist_traits<GlobalVariable>
  38   : public SymbolTableListTraits<GlobalVariable, Module, Module> {
  39   // createSentinel is used to create a node that marks the end of the list.
  40   static GlobalVariable *createSentinel();
  41   static void destroySentinel(GlobalVariable *GV) { delete GV; }
  42   static iplist<GlobalVariable> &getList(Module *M);
  43 };
  44
  45 /// A Module instance is used to store all the information related to an
  46 /// LLVM module. Modules are the top level container of all other LLVM
  47 /// Intermediate Representation (IR) objects. Each module directly contains a
  48 /// list of globals variables, a list of functions, a list of libraries (or
  49 /// other modules) this module depends on, a symbol table, and various data
  50 /// about the target's characteristics.
  51 ///
  52 /// A module maintains a GlobalValRefMap object that is used to hold all
  53 /// constant references to global variables in the module.  When a global
  54 /// variable is destroyed, it should have no entries in the GlobalValueRefMap.
  55 /// @brief The main container class for the LLVM Intermediate Representation.
  56 class Module {
  57 /// @name Types And Enumerations
  58 /// @{
  59 public:
  60   /// The type for the list of global variables.
  61   typedef iplist<GlobalVariable> GlobalListType;
  62   /// The type for the list of functions.
  63   typedef iplist<Function> FunctionListType;
  64
  65   /// The type for the list of dependent libraries.
  66   typedef SetVector<std::string> LibraryListType;
  67
  68   /// The Global Variable iterator.
  69   typedef GlobalListType::iterator                     global_iterator;
  70   /// The Global Variable constant iterator.
  71   typedef GlobalListType::const_iterator         const_global_iterator;
  72
  73   /// The Function iterators.
  74   typedef FunctionListType::iterator                          iterator;
  75   /// The Function constant iterator
  76   typedef FunctionListType::const_iterator              const_iterator;
  77
  78   /// The Library list iterator.
  79   typedef LibraryListType::const_iterator lib_iterator;
  80
  81   /// An enumeration for describing the endianess of the target machine.
  82   enum Endianness  { AnyEndianness, LittleEndian, BigEndian };
  83
  84   /// An enumeration for describing the size of a pointer on the target machine.
  85   enum PointerSize { AnyPointerSize, Pointer32, Pointer64 };
  86
  87 /// @}
  88 /// @name Member Variables
  89 /// @{
  90 private:
  91   GlobalListType GlobalList;     ///< The Global Variables in the module
  92   FunctionListType FunctionList; ///< The Functions in the module
  93   LibraryListType LibraryList;   ///< The Libraries needed by the module
  94   std::string GlobalScopeAsm;    ///< Inline Asm at global scope.
  95   SymbolTable *ValSymTab;        ///< Symbol table for values
  96   TypeSymbolTable *TypeSymTab;   ///< Symbol table for types
  97   std::string ModuleID;          ///< Human readable identifier for the module
  98   std::string TargetTriple;      ///< Platform target triple Module compiled on
  99   std::string DataLayout;        ///< Target data description
 100
 101   friend class Constant;
 102
 103 /// @}
 104 /// @name Constructors
 105 /// @{
 106 public:
 107   /// The Module constructor. Note that there is no default constructor. You
 108   /// must provide a name for the module upon construction.
 109   Module(const std::string &ModuleID);
 110   /// The module destructor. This will dropAllReferences.
 111   ~Module();
 112
 113 /// @}
 114 /// @name Module Level Accessors
 115 /// @{
 116 public:
 117   /// Get the module identifier which is, essentially, the name of the module.
 118   /// @returns the module identifier as a string
 119   const std::string &getModuleIdentifier() const { return ModuleID; }
 120
 121   /// Get the data layout string for the module's target platform.  This encodes
 122   /// the type sizes and alignments expected by this module.
 123   /// @returns the data layout as a string
 124   const std::string& getDataLayout() const { return DataLayout; }
 125
 126   /// Get the target triple which is a string describing the target host.
 127   /// @returns a string containing the target triple.
 128   const std::string &getTargetTriple() const { return TargetTriple; }
 129
 130   /// Get the target endian information.
 131   /// @returns Endianess - an enumeration for the endianess of the target
 132   Endianness getEndianness() const;
 133
 134   /// Get the target pointer size.
 135   /// @returns PointerSize - an enumeration for the size of the target's pointer
 136   PointerSize getPointerSize() const;
 137
 138   /// Get any module-scope inline assembly blocks.
 139   /// @returns a string containing the module-scope inline assembly blocks.
 140   const std::string &getModuleInlineAsm() const { return GlobalScopeAsm; }
 141 /// @}
 142 /// @name Module Level Mutators
 143 /// @{
 144 public:
 145
 146   /// Set the module identifier.
 147   void setModuleIdentifier(const std::string &ID) { ModuleID = ID; }
 148
 149   /// Set the data layout
 150   void setDataLayout(const std::string& DL) { DataLayout = DL; }
 151
 152   /// Set the target triple.
 153   void setTargetTriple(const std::string &T) { TargetTriple = T; }
 154
 155   /// Set the module-scope inline assembly blocks.
 156   void setModuleInlineAsm(const std::string &Asm) { GlobalScopeAsm = Asm; }
 157
 158 /// @}
 159 /// @name Function Accessors
 160 /// @{
 161 public:
 162   /// getOrInsertFunction - Look up the specified function in the module symbol
 163   /// table.  Four possibilities:
 164   ///   1. If it does not exist, add a prototype for the function and return it.
 165   ///   2. If it exists, and has internal linkage, the existing function is
 166   ///      renamed and a new one is inserted.
 167   ///   3. Otherwise, if the existing function has the correct prototype, return
 168   ///      the existing function.
 169   ///   4. Finally, the function exists but has the wrong prototype: return the
 170   ///      function with a constantexpr cast to the right prototype.
 171   Constant *getOrInsertFunction(const std::string &Name, const FunctionType *T);
 172
 173   /// getOrInsertFunction - Look up the specified function in the module symbol
 174   /// table.  If it does not exist, add a prototype for the function and return
 175   /// it.  This version of the method takes a null terminated list of function
 176   /// arguments, which makes it easier for clients to use.
 177   Constant *getOrInsertFunction(const std::string &Name, const Type *RetTy,...)
 178     END_WITH_NULL;
 179
 180   /// getFunction - Look up the specified function in the module symbol table.
 181   /// If it does not exist, return null.
 182   Function *getFunction(const std::string &Name, const FunctionType *Ty);
 183
 184   /// getMainFunction - This function looks up main efficiently.  This is such a
 185   /// common case, that it is a method in Module.  If main cannot be found, a
 186   /// null pointer is returned.
 187   Function *getMainFunction();
 188
 189   /// getNamedFunction - Return the first function in the module with the
 190   /// specified name, of arbitrary type.  This method returns null if a function
 191   /// with the specified name is not found.
 192   Function *getNamedFunction(const std::string &Name) const;
 193
 194 /// @}
 195 /// @name Global Variable Accessors
 196 /// @{
 197 public:
 198   /// getGlobalVariable - Look up the specified global variable in the module
 199   /// symbol table.  If it does not exist, return null.  The type argument
 200   /// should be the underlying type of the global, i.e., it should not have
 201   /// the top-level PointerType, which represents the address of the global.
 202   /// If AllowInternal is set to true, this function will return types that
 203   /// have InternalLinkage. By default, these types are not returned.
 204   GlobalVariable *getGlobalVariable(const std::string &Name, const Type *Ty,
 205                                     bool AllowInternal = false);
 206
 207   /// getNamedGlobal - Return the first global variable in the module with the
 208   /// specified name, of arbitrary type.  This method returns null if a global
 209   /// with the specified name is not found.
 210   GlobalVariable *getNamedGlobal(const std::string &Name) const;
 211
 212 /// @}
 213 /// @name Type Accessors
 214 /// @{
 215 public:
 216   /// addTypeName - Insert an entry in the symbol table mapping Str to Type.  If
 217   /// there is already an entry for this name, true is returned and the symbol
 218   /// table is not modified.
 219   bool addTypeName(const std::string &Name, const Type *Ty);
 220
 221   /// getTypeName - If there is at least one entry in the symbol table for the
 222   /// specified type, return it.
 223   std::string getTypeName(const Type *Ty) const;
 224
 225   /// getTypeByName - Return the type with the specified name in this module, or
 226   /// null if there is none by that name.
 227   const Type *getTypeByName(const std::string &Name) const;
 228
 229 /// @}
 230 /// @name Direct access to the globals list, functions list, and symbol table
 231 /// @{
 232 public:
 233   /// Get the Module's list of global variables (constant).
 234   const GlobalListType   &getGlobalList() const       { return GlobalList; }
 235   /// Get the Module's list of global variables.
 236   GlobalListType         &getGlobalList()             { return GlobalList; }
 237   /// Get the Module's list of functions (constant).
 238   const FunctionListType &getFunctionList() const     { return FunctionList; }
 239   /// Get the Module's list of functions.
 240   FunctionListType       &getFunctionList()           { return FunctionList; }
 241   /// Get the symbol table of global variable and function identifiers
 242   const SymbolTable      &getValueSymbolTable() const { return *ValSymTab; }
 243   /// Get the Module's symbol table of global variable and function identifiers.
 244   SymbolTable            &getValueSymbolTable()       { return *ValSymTab; }
 245   /// Get the symbol table of types
 246   const TypeSymbolTable   &getTypeSymbolTable() const { return *TypeSymTab; }
 247   /// Get the Module's symbol table of types
 248   TypeSymbolTable         &getTypeSymbolTable()       { return *TypeSymTab; }
 249
 250 /// @}
 251 /// @name Global Variable Iteration
 252 /// @{
 253 public:
 254   /// Get an iterator to the first global variable
 255   global_iterator       global_begin()       { return GlobalList.begin(); }
 256   /// Get a constant iterator to the first global variable
 257   const_global_iterator global_begin() const { return GlobalList.begin(); }
 258   /// Get an iterator to the last global variable
 259   global_iterator       global_end  ()       { return GlobalList.end(); }
 260   /// Get a constant iterator to the last global variable
 261   const_global_iterator global_end  () const { return GlobalList.end(); }
 262   /// Determine if the list of globals is empty.
 263   bool                  global_empty() const { return GlobalList.empty(); }
 264
 265 /// @}
 266 /// @name Function Iteration
 267 /// @{
 268 public:
 269   /// Get an iterator to the first function.
 270   iterator                begin()       { return FunctionList.begin(); }
 271   /// Get a constant iterator to the first function.
 272   const_iterator          begin() const { return FunctionList.begin(); }
 273   /// Get an iterator to the last function.
 274   iterator                end  ()       { return FunctionList.end();   }
 275   /// Get a constant iterator to the last function.
 276   const_iterator          end  () const { return FunctionList.end();   }
 277   /// Determine how many functions are in the Module's list of functions.
 278   size_t                   size() const { return FunctionList.size(); }
 279   /// Determine if the list of functions is empty.
 280   bool                    empty() const { return FunctionList.empty(); }
 281
 282 /// @}
 283 /// @name Dependent Library Iteration
 284 /// @{
 285 public:
 286   /// @brief Get a constant iterator to beginning of dependent library list.
 287   inline lib_iterator lib_begin() const { return LibraryList.begin(); }
 288   /// @brief Get a constant iterator to end of dependent library list.
 289   inline lib_iterator lib_end() const { return LibraryList.end(); }
 290   /// @brief Returns the number of items in the list of libraries.
 291   inline size_t lib_size() const { return LibraryList.size(); }
 292   /// @brief Add a library to the list of dependent libraries
 293   inline void addLibrary(const std::string& Lib){ LibraryList.insert(Lib); }
 294   /// @brief Remove a library from the list of dependent libraries
 295   inline void removeLibrary(const std::string& Lib) { LibraryList.remove(Lib); }
 296   /// @brief Get all the libraries
 297   inline const LibraryListType& getLibraries() const { return LibraryList; }
 298
 299 /// @}
 300 /// @name Utility functions for printing and dumping Module objects
 301 /// @{
 302 public:
 303   /// Print the module to an output stream
 304   void print(std::ostream &OS) const { print(OS, 0); }
 305   void print(std::ostream *OS) const { if (OS) print(*OS); }
 306   /// Print the module to an output stream with AssemblyAnnotationWriter.
 307   void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
 308   void print(std::ostream *OS, AssemblyAnnotationWriter *AAW) const {
 309     if (OS) print(*OS, AAW);
 310   }
 311   /// Dump the module to std::cerr (for debugging).
 312   void dump() const;
 313   /// This function causes all the subinstructions to "let go" of all references
 314   /// that they are maintaining.  This allows one to 'delete' a whole class at
 315   /// a time, even though there may be circular references... first all
 316   /// references are dropped, and all use counts go to zero.  Then everything
 317   /// is delete'd for real.  Note that no operations are valid on an object
 318   /// that has "dropped all references", except operator delete.
 319   void dropAllReferences();
 320 /// @}
 321 };
 322
 323 /// An iostream inserter for modules.
 324 inline std::ostream &operator<<(std::ostream &O, const Module &M) {
 325   M.print(O);
 326   return O;
 327 }
 328
 329 } // End llvm namespace
 330
 331 #endif