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