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   std::string DataLayout;        ///< Target data description
  98
  99   friend class Constant;
 100
 101 /// @}
 102 /// @name Constructors
 103 /// @{
 104 public:
 105   /// The Module constructor. Note that there is no default constructor. You
 106   /// must provide a name for the module upon construction.
 107   Module(const std::string &ModuleID);
 108   /// The module destructor. This will dropAllReferences.
 109   ~Module();
 110
 111 /// @}
 112 /// @name Module Level Accessors
 113 /// @{
 114 public:
 115   /// Get the module identifier which is, essentially, the name of the module.
 116   /// @returns the module identifier as a string
 117   const std::string &getModuleIdentifier() const { return ModuleID; }
 118
 119   /// Get the target triple which is a string describing the target host.
 120   /// @returns a string containing the target triple.
 121   const std::string &getTargetTriple() const { return TargetTriple; }
 122
 123   /// Get the target endian information.
 124   /// @returns Endianess - an enumeration for the endianess of the target
 125   Endianness getEndianness() const;
 126
 127   /// Get the target pointer size.
 128   /// @returns PointerSize - an enumeration for the size of the target's pointer
 129   PointerSize getPointerSize() const;
 130
 131   /// Get any module-scope inline assembly blocks.
 132   /// @returns a string containing the module-scope inline assembly blocks.
 133   const std::string &getModuleInlineAsm() const { return GlobalScopeAsm; }
 134 /// @}
 135 /// @name Module Level Mutators
 136 /// @{
 137 public:
 138
 139   /// Set the module identifier.
 140   void setModuleIdentifier(const std::string &ID) { ModuleID = ID; }
 141
 142   /// Set the target triple.
 143   void setTargetTriple(const std::string &T) { TargetTriple = T; }
 144
 145   /// Set the target endian information.
 146   void setEndianness(Endianness E);
 147
 148   /// Set the target pointer size.
 149   void setPointerSize(PointerSize PS);
 150
 151   /// Set the module-scope inline assembly blocks.
 152   void setModuleInlineAsm(const std::string &Asm) { GlobalScopeAsm = Asm; }
 153
 154 /// @}
 155 /// @name Function Accessors
 156 /// @{
 157 public:
 158   /// getOrInsertFunction - Look up the specified function in the module symbol
 159   /// table.  If it does not exist, add a prototype for the function and return
 160   /// it.
 161   Function *getOrInsertFunction(const std::string &Name, const FunctionType *T);
 162
 163   /// getOrInsertFunction - Look up the specified function in the module symbol
 164   /// table.  If it does not exist, add a prototype for the function and return
 165   /// it.  This version of the method takes a null terminated list of function
 166   /// arguments, which makes it easier for clients to use.
 167   Function *getOrInsertFunction(const std::string &Name, const Type *RetTy,...)
 168     END_WITH_NULL;
 169
 170   /// getFunction - Look up the specified function in the module symbol table.
 171   /// If it does not exist, return null.
 172   Function *getFunction(const std::string &Name, const FunctionType *Ty);
 173
 174   /// getMainFunction - This function looks up main efficiently.  This is such a
 175   /// common case, that it is a method in Module.  If main cannot be found, a
 176   /// null pointer is returned.
 177   Function *getMainFunction();
 178
 179   /// getNamedFunction - Return the first function in the module with the
 180   /// specified name, of arbitrary type.  This method returns null if a function
 181   /// with the specified name is not found.
 182   Function *getNamedFunction(const std::string &Name) const;
 183
 184 /// @}
 185 /// @name Global Variable Accessors
 186 /// @{
 187 public:
 188   /// getGlobalVariable - Look up the specified global variable in the module
 189   /// symbol table.  If it does not exist, return null.  The type argument
 190   /// should be the underlying type of the global, i.e., it should not have
 191   /// the top-level PointerType, which represents the address of the global.
 192   /// If AllowInternal is set to true, this function will return types that
 193   /// have InternalLinkage. By default, these types are not returned.
 194   GlobalVariable *getGlobalVariable(const std::string &Name, const Type *Ty,
 195                                     bool AllowInternal = false);
 196
 197   /// getNamedGlobal - Return the first global variable in the module with the
 198   /// specified name, of arbitrary type.  This method returns null if a global
 199   /// with the specified name is not found.
 200   GlobalVariable *getNamedGlobal(const std::string &Name) const;
 201
 202 /// @}
 203 /// @name Type Accessors
 204 /// @{
 205 public:
 206   /// addTypeName - Insert an entry in the symbol table mapping Str to Type.  If
 207   /// there is already an entry for this name, true is returned and the symbol
 208   /// table is not modified.
 209   bool addTypeName(const std::string &Name, const Type *Ty);
 210
 211   /// getTypeName - If there is at least one entry in the symbol table for the
 212   /// specified type, return it.
 213   std::string getTypeName(const Type *Ty) const;
 214
 215   /// getTypeByName - Return the type with the specified name in this module, or
 216   /// null if there is none by that name.
 217   const Type *getTypeByName(const std::string &Name) const;
 218
 219 /// @}
 220 /// @name Direct access to the globals list, functions list, and symbol table
 221 /// @{
 222 public:
 223   /// Get the Module's list of global variables (constant).
 224   const GlobalListType   &getGlobalList() const       { return GlobalList; }
 225   /// Get the Module's list of global variables.
 226   GlobalListType         &getGlobalList()             { return GlobalList; }
 227   /// Get the Module's list of functions (constant).
 228   const FunctionListType &getFunctionList() const     { return FunctionList; }
 229   /// Get the Module's list of functions.
 230   FunctionListType       &getFunctionList()           { return FunctionList; }
 231   /// Get the symbol table of global variable and function identifiers
 232   const SymbolTable      &getSymbolTable() const      { return *SymTab; }
 233   /// Get the Module's symbol table of global variable and function identifiers.
 234   SymbolTable            &getSymbolTable()            { return *SymTab; }
 235
 236 /// @}
 237 /// @name Global Variable Iteration
 238 /// @{
 239 public:
 240   /// Get an iterator to the first global variable
 241   global_iterator       global_begin()       { return GlobalList.begin(); }
 242   /// Get a constant iterator to the first global variable
 243   const_global_iterator global_begin() const { return GlobalList.begin(); }
 244   /// Get an iterator to the last global variable
 245   global_iterator       global_end  ()       { return GlobalList.end(); }
 246   /// Get a constant iterator to the last global variable
 247   const_global_iterator global_end  () const { return GlobalList.end(); }
 248   /// Determine if the list of globals is empty.
 249   bool                  global_empty() const { return GlobalList.empty(); }
 250
 251 /// @}
 252 /// @name Function Iteration
 253 /// @{
 254 public:
 255   /// Get an iterator to the first function.
 256   iterator                begin()       { return FunctionList.begin(); }
 257   /// Get a constant iterator to the first function.
 258   const_iterator          begin() const { return FunctionList.begin(); }
 259   /// Get an iterator to the last function.
 260   iterator                end  ()       { return FunctionList.end();   }
 261   /// Get a constant iterator to the last function.
 262   const_iterator          end  () const { return FunctionList.end();   }
 263   /// Determine how many functions are in the Module's list of functions.
 264   size_t                   size() const { return FunctionList.size(); }
 265   /// Determine if the list of functions is empty.
 266   bool                    empty() const { return FunctionList.empty(); }
 267
 268 /// @}
 269 /// @name Dependent Library Iteration
 270 /// @{
 271 public:
 272   /// @brief Get a constant iterator to beginning of dependent library list.
 273   inline lib_iterator lib_begin() const { return LibraryList.begin(); }
 274   /// @brief Get a constant iterator to end of dependent library list.
 275   inline lib_iterator lib_end() const { return LibraryList.end(); }
 276   /// @brief Returns the number of items in the list of libraries.
 277   inline size_t lib_size() const { return LibraryList.size(); }
 278   /// @brief Add a library to the list of dependent libraries
 279   inline void addLibrary(const std::string& Lib){ LibraryList.insert(Lib); }
 280   /// @brief Remove a library from the list of dependent libraries
 281   inline void removeLibrary(const std::string& Lib) { LibraryList.remove(Lib); }
 282   /// @brief Get all the libraries
 283   inline const LibraryListType& getLibraries() const { return LibraryList; }
 284
 285 /// @}
 286 /// @name Utility functions for printing and dumping Module objects
 287 /// @{
 288 public:
 289   /// Print the module to an output stream
 290   void print(std::ostream &OS) const { print(OS, 0); }
 291   /// Print the module to an output stream with AssemblyAnnotationWriter.
 292   void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
 293   /// Dump the module to std::cerr (for debugging).
 294   void dump() const;
 295   /// This function causes all the subinstructions to "let go" of all references
 296   /// that they are maintaining.  This allows one to 'delete' a whole class at
 297   /// a time, even though there may be circular references... first all
 298   /// references are dropped, and all use counts go to zero.  Then everything
 299   /// is delete'd for real.  Note that no operations are valid on an object
 300   /// that has "dropped all references", except operator delete.
 301   void dropAllReferences();
 302 /// @}
 303 };
 304
 305 /// An iostream inserter for modules.
 306 inline std::ostream &operator<<(std::ostream &O, const Module &M) {
 307   M.print(O);
 308   return O;
 309 }
 310
 311 } // End llvm namespace
 312
 313 #endif