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/Support/DataTypes.h"
  20 #include <vector>
  21
  22 namespace llvm {
  23
  24 class GlobalVariable;
  25 class GlobalValueRefMap;   // Used by ConstantVals.cpp
  26 class FunctionType;
  27
  28 template<> struct ilist_traits<Function>
  29   : public SymbolTableListTraits<Function, Module> {
  30   // createSentinel is used to create a node that marks the end of the list.
  31   static Function *createSentinel();
  32   static void destroySentinel(Function *F) { delete F; }
  33   static iplist<Function> &getList(Module *M);
  34   static inline ValueSymbolTable *getSymTab(Module *M);
  35 };
  36 template<> struct ilist_traits<GlobalVariable>
  37   : public SymbolTableListTraits<GlobalVariable, Module> {
  38   // createSentinel is used to create a node that marks the end of the list.
  39   static GlobalVariable *createSentinel();
  40   static void destroySentinel(GlobalVariable *GV) { delete GV; }
  41   static iplist<GlobalVariable> &getList(Module *M);
  42   static inline ValueSymbolTable *getSymTab(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 std::vector<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   ValueSymbolTable *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   explicit 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 function guarantees to return a constant of pointer to the
 176   /// specified function type or a ConstantExpr BitCast of that type if the
 177   /// named /// function has a different type.  This version of the method
 178   /// takes a null terminated list of function arguments, which makes it
 179   /// easier for clients to use.
 180   Constant *getOrInsertFunction(const std::string &Name, const Type *RetTy,...)
 181     END_WITH_NULL;
 182
 183   /// getFunction - Look up the specified function in the module symbol table.
 184   /// If it does not exist, return null.
 185   Function *getFunction(const std::string &Name) const;
 186
 187 /// @}
 188 /// @name Global Variable Accessors
 189 /// @{
 190 public:
 191   /// getGlobalVariable - Look up the specified global variable in the module
 192   /// symbol table.  If it does not exist, return null.  The type argument
 193   /// should be the underlying type of the global, i.e., it should not have
 194   /// the top-level PointerType, which represents the address of the global.
 195   /// If AllowInternal is set to true, this function will return types that
 196   /// have InternalLinkage. By default, these types are not returned.
 197   GlobalVariable *getGlobalVariable(const std::string &Name,
 198                                     bool AllowInternal = false) const;
 199
 200   /// getNamedGlobal - Return the first global variable in the module with the
 201   /// specified name, of arbitrary type.  This method returns null if a global
 202   /// with the specified name is not found.
 203   GlobalVariable *getNamedGlobal(const std::string &Name) const {
 204     return getGlobalVariable(Name, true);
 205   }
 206
 207 /// @}
 208 /// @name Type Accessors
 209 /// @{
 210 public:
 211   /// addTypeName - Insert an entry in the symbol table mapping Str to Type.  If
 212   /// there is already an entry for this name, true is returned and the symbol
 213   /// table is not modified.
 214   bool addTypeName(const std::string &Name, const Type *Ty);
 215
 216   /// getTypeName - If there is at least one entry in the symbol table for the
 217   /// specified type, return it.
 218   std::string getTypeName(const Type *Ty) const;
 219
 220   /// getTypeByName - Return the type with the specified name in this module, or
 221   /// null if there is none by that name.
 222   const Type *getTypeByName(const std::string &Name) const;
 223
 224 /// @}
 225 /// @name Direct access to the globals list, functions list, and symbol table
 226 /// @{
 227 public:
 228   /// Get the Module's list of global variables (constant).
 229   const GlobalListType   &getGlobalList() const       { return GlobalList; }
 230   /// Get the Module's list of global variables.
 231   GlobalListType         &getGlobalList()             { return GlobalList; }
 232   /// Get the Module's list of functions (constant).
 233   const FunctionListType &getFunctionList() const     { return FunctionList; }
 234   /// Get the Module's list of functions.
 235   FunctionListType       &getFunctionList()           { return FunctionList; }
 236   /// Get the symbol table of global variable and function identifiers
 237   const ValueSymbolTable &getValueSymbolTable() const { return *ValSymTab; }
 238   /// Get the Module's symbol table of global variable and function identifiers.
 239   ValueSymbolTable       &getValueSymbolTable()       { return *ValSymTab; }
 240   /// Get the symbol table of types
 241   const TypeSymbolTable   &getTypeSymbolTable() const { return *TypeSymTab; }
 242   /// Get the Module's symbol table of types
 243   TypeSymbolTable         &getTypeSymbolTable()       { return *TypeSymTab; }
 244
 245 /// @}
 246 /// @name Global Variable Iteration
 247 /// @{
 248 public:
 249   /// Get an iterator to the first global variable
 250   global_iterator       global_begin()       { return GlobalList.begin(); }
 251   /// Get a constant iterator to the first global variable
 252   const_global_iterator global_begin() const { return GlobalList.begin(); }
 253   /// Get an iterator to the last global variable
 254   global_iterator       global_end  ()       { return GlobalList.end(); }
 255   /// Get a constant iterator to the last global variable
 256   const_global_iterator global_end  () const { return GlobalList.end(); }
 257   /// Determine if the list of globals is empty.
 258   bool                  global_empty() const { return GlobalList.empty(); }
 259
 260 /// @}
 261 /// @name Function Iteration
 262 /// @{
 263 public:
 264   /// Get an iterator to the first function.
 265   iterator                begin()       { return FunctionList.begin(); }
 266   /// Get a constant iterator to the first function.
 267   const_iterator          begin() const { return FunctionList.begin(); }
 268   /// Get an iterator to the last function.
 269   iterator                end  ()       { return FunctionList.end();   }
 270   /// Get a constant iterator to the last function.
 271   const_iterator          end  () const { return FunctionList.end();   }
 272   /// Determine how many functions are in the Module's list of functions.
 273   size_t                   size() const { return FunctionList.size(); }
 274   /// Determine if the list of functions is empty.
 275   bool                    empty() const { return FunctionList.empty(); }
 276
 277 /// @}
 278 /// @name Dependent Library Iteration
 279 /// @{
 280 public:
 281   /// @brief Get a constant iterator to beginning of dependent library list.
 282   inline lib_iterator lib_begin() const { return LibraryList.begin(); }
 283   /// @brief Get a constant iterator to end of dependent library list.
 284   inline lib_iterator lib_end() const { return LibraryList.end(); }
 285   /// @brief Returns the number of items in the list of libraries.
 286   inline size_t lib_size() const { return LibraryList.size(); }
 287   /// @brief Add a library to the list of dependent libraries
 288   void addLibrary(const std::string& Lib);
 289   /// @brief Remove a library from the list of dependent libraries
 290   void removeLibrary(const std::string& Lib);
 291   /// @brief Get all the libraries
 292   inline const LibraryListType& getLibraries() const { return LibraryList; }
 293
 294 /// @}
 295 /// @name Utility functions for printing and dumping Module objects
 296 /// @{
 297 public:
 298   /// Print the module to an output stream
 299   void print(std::ostream &OS) const { print(OS, 0); }
 300   void print(std::ostream *OS) const { if (OS) print(*OS); }
 301   /// Print the module to an output stream with AssemblyAnnotationWriter.
 302   void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
 303   void print(std::ostream *OS, AssemblyAnnotationWriter *AAW) const {
 304     if (OS) print(*OS, AAW);
 305   }
 306   /// Dump the module to std::cerr (for debugging).
 307   void dump() const;
 308   /// This function causes all the subinstructions to "let go" of all references
 309   /// that they are maintaining.  This allows one to 'delete' a whole class at
 310   /// a time, even though there may be circular references... first all
 311   /// references are dropped, and all use counts go to zero.  Then everything
 312   /// is delete'd for real.  Note that no operations are valid on an object
 313   /// that has "dropped all references", except operator delete.
 314   void dropAllReferences();
 315 /// @}
 316 };
 317
 318 /// An iostream inserter for modules.
 319 inline std::ostream &operator<<(std::ostream &O, const Module &M) {
 320   M.print(O);
 321   return O;
 322 }
 323
 324 inline ValueSymbolTable *
 325 ilist_traits<Function>::getSymTab(Module *M) {
 326   return M ? &M->getValueSymbolTable() : 0;
 327 }
 328
 329 inline ValueSymbolTable *
 330 ilist_traits<GlobalVariable>::getSymTab(Module *M) {
 331   return M ? &M->getValueSymbolTable() : 0;
 332 }
 333
 334
 335 } // End llvm namespace
 336
 337 #endif