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 is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 /// @file
  11 /// Module.h This file contains the declarations for the Module class.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_MODULE_H
  16 #define LLVM_MODULE_H
  17
  18 #include "llvm/Function.h"
  19 #include "llvm/GlobalVariable.h"
  20 #include "llvm/GlobalAlias.h"
  21 #include "llvm/Metadata.h"
  22 #include "llvm/ADT/OwningPtr.h"
  23 #include "llvm/Support/DataTypes.h"
  24 #include <vector>
  25
  26 namespace llvm {
  27
  28 class FunctionType;
  29 class GVMaterializer;
  30 class LLVMContext;
  31 class StructType;
  32 template<typename T> struct DenseMapInfo;
  33 template<typename KeyT, typename ValueT,
  34          typename KeyInfoT, typename ValueInfoT> class DenseMap;
  35
  36 template<> struct ilist_traits<Function>
  37   : public SymbolTableListTraits<Function, Module> {
  38
  39   // createSentinel is used to get hold of the node that marks the end of the
  40   // list... (same trick used here as in ilist_traits<Instruction>)
  41   Function *createSentinel() const {
  42     return static_cast<Function*>(&Sentinel);
  43   }
  44   static void destroySentinel(Function*) {}
  45
  46   Function *provideInitialHead() const { return createSentinel(); }
  47   Function *ensureHead(Function*) const { return createSentinel(); }
  48   static void noteHead(Function*, Function*) {}
  49
  50 private:
  51   mutable ilist_node<Function> Sentinel;
  52 };
  53
  54 template<> struct ilist_traits<GlobalVariable>
  55   : public SymbolTableListTraits<GlobalVariable, Module> {
  56   // createSentinel is used to create a node that marks the end of the list.
  57   GlobalVariable *createSentinel() const {
  58     return static_cast<GlobalVariable*>(&Sentinel);
  59   }
  60   static void destroySentinel(GlobalVariable*) {}
  61
  62   GlobalVariable *provideInitialHead() const { return createSentinel(); }
  63   GlobalVariable *ensureHead(GlobalVariable*) const { return createSentinel(); }
  64   static void noteHead(GlobalVariable*, GlobalVariable*) {}
  65 private:
  66   mutable ilist_node<GlobalVariable> Sentinel;
  67 };
  68
  69 template<> struct ilist_traits<GlobalAlias>
  70   : public SymbolTableListTraits<GlobalAlias, Module> {
  71   // createSentinel is used to create a node that marks the end of the list.
  72   GlobalAlias *createSentinel() const {
  73     return static_cast<GlobalAlias*>(&Sentinel);
  74   }
  75   static void destroySentinel(GlobalAlias*) {}
  76
  77   GlobalAlias *provideInitialHead() const { return createSentinel(); }
  78   GlobalAlias *ensureHead(GlobalAlias*) const { return createSentinel(); }
  79   static void noteHead(GlobalAlias*, GlobalAlias*) {}
  80 private:
  81   mutable ilist_node<GlobalAlias> Sentinel;
  82 };
  83
  84 template<> struct ilist_traits<NamedMDNode>
  85   : public ilist_default_traits<NamedMDNode> {
  86   // createSentinel is used to get hold of a node that marks the end of
  87   // the list...
  88   NamedMDNode *createSentinel() const {
  89     return static_cast<NamedMDNode*>(&Sentinel);
  90   }
  91   static void destroySentinel(NamedMDNode*) {}
  92
  93   NamedMDNode *provideInitialHead() const { return createSentinel(); }
  94   NamedMDNode *ensureHead(NamedMDNode*) const { return createSentinel(); }
  95   static void noteHead(NamedMDNode*, NamedMDNode*) {}
  96   void addNodeToList(NamedMDNode *) {}
  97   void removeNodeFromList(NamedMDNode *) {}
  98 private:
  99   mutable ilist_node<NamedMDNode> Sentinel;
 100 };
 101
 102 /// A Module instance is used to store all the information related to an
 103 /// LLVM module. Modules are the top level container of all other LLVM
 104 /// Intermediate Representation (IR) objects. Each module directly contains a
 105 /// list of globals variables, a list of functions, a list of libraries (or
 106 /// other modules) this module depends on, a symbol table, and various data
 107 /// about the target's characteristics.
 108 ///
 109 /// A module maintains a GlobalValRefMap object that is used to hold all
 110 /// constant references to global variables in the module.  When a global
 111 /// variable is destroyed, it should have no entries in the GlobalValueRefMap.
 112 /// @brief The main container class for the LLVM Intermediate Representation.
 113 class Module {
 114 /// @name Types And Enumerations
 115 /// @{
 116 public:
 117   /// The type for the list of global variables.
 118   typedef iplist<GlobalVariable> GlobalListType;
 119   /// The type for the list of functions.
 120   typedef iplist<Function> FunctionListType;
 121   /// The type for the list of aliases.
 122   typedef iplist<GlobalAlias> AliasListType;
 123   /// The type for the list of named metadata.
 124   typedef ilist<NamedMDNode> NamedMDListType;
 125
 126   /// The type for the list of dependent libraries.
 127   typedef std::vector<std::string> LibraryListType;
 128
 129   /// The Global Variable iterator.
 130   typedef GlobalListType::iterator                      global_iterator;
 131   /// The Global Variable constant iterator.
 132   typedef GlobalListType::const_iterator          const_global_iterator;
 133
 134   /// The Function iterators.
 135   typedef FunctionListType::iterator                           iterator;
 136   /// The Function constant iterator
 137   typedef FunctionListType::const_iterator               const_iterator;
 138
 139   /// The Global Alias iterators.
 140   typedef AliasListType::iterator                        alias_iterator;
 141   /// The Global Alias constant iterator
 142   typedef AliasListType::const_iterator            const_alias_iterator;
 143
 144   /// The named metadata iterators.
 145   typedef NamedMDListType::iterator             named_metadata_iterator;
 146   /// The named metadata constant interators.
 147   typedef NamedMDListType::const_iterator const_named_metadata_iterator;
 148   /// The Library list iterator.
 149   typedef LibraryListType::const_iterator lib_iterator;
 150
 151   /// An enumeration for describing the endianess of the target machine.
 152   enum Endianness  { AnyEndianness, LittleEndian, BigEndian };
 153
 154   /// An enumeration for describing the size of a pointer on the target machine.
 155   enum PointerSize { AnyPointerSize, Pointer32, Pointer64 };
 156
 157   /// An enumeration for the supported behaviors of module flags. The following
 158   /// module flags behavior values are supported:
 159   ///
 160   ///    Value        Behavior
 161   ///    -----        --------
 162   ///      1          Error
 163   ///                   Emits an error if two values disagree.
 164   ///
 165   ///      2          Warning
 166   ///                   Emits a warning if two values disagree.
 167   ///
 168   ///      3          Require
 169   ///                   Emits an error when the specified value is not present
 170   ///                   or doesn't have the specified value. It is an error for
 171   ///                   two (or more) llvm.module.flags with the same ID to have
 172   ///                   the Require behavior but different values. There may be
 173   ///                   multiple Require flags per ID.
 174   ///
 175   ///      4          Override
 176   ///                   Uses the specified value if the two values disagree. It
 177   ///                   is an error for two (or more) llvm.module.flags with the
 178   ///                   same ID to have the Override behavior but different
 179   ///                   values.
 180   enum ModFlagBehavior { Error = 1, Warning  = 2, Require = 3, Override = 4 };
 181
 182   struct ModuleFlagEntry {
 183     ModFlagBehavior Behavior;
 184     MDString *Key;
 185     Value *Val;
 186     ModuleFlagEntry(ModFlagBehavior B, MDString *K, Value *V)
 187       : Behavior(B), Key(K), Val(V) {}
 188   };
 189
 190 /// @}
 191 /// @name Member Variables
 192 /// @{
 193 private:
 194   LLVMContext &Context;           ///< The LLVMContext from which types and
 195                                   ///< constants are allocated.
 196   GlobalListType GlobalList;      ///< The Global Variables in the module
 197   FunctionListType FunctionList;  ///< The Functions in the module
 198   AliasListType AliasList;        ///< The Aliases in the module
 199   LibraryListType LibraryList;    ///< The Libraries needed by the module
 200   NamedMDListType NamedMDList;    ///< The named metadata in the module
 201   std::string GlobalScopeAsm;     ///< Inline Asm at global scope.
 202   ValueSymbolTable *ValSymTab;    ///< Symbol table for values
 203   OwningPtr<GVMaterializer> Materializer;  ///< Used to materialize GlobalValues
 204   std::string ModuleID;           ///< Human readable identifier for the module
 205   std::string TargetTriple;       ///< Platform target triple Module compiled on
 206   std::string DataLayout;         ///< Target data description
 207   void *NamedMDSymTab;            ///< NamedMDNode names.
 208
 209   friend class Constant;
 210
 211 /// @}
 212 /// @name Constructors
 213 /// @{
 214 public:
 215   /// The Module constructor. Note that there is no default constructor. You
 216   /// must provide a name for the module upon construction.
 217   explicit Module(StringRef ModuleID, LLVMContext& C);
 218   /// The module destructor. This will dropAllReferences.
 219   ~Module();
 220
 221 /// @}
 222 /// @name Module Level Accessors
 223 /// @{
 224
 225   /// Get the module identifier which is, essentially, the name of the module.
 226   /// @returns the module identifier as a string
 227   const std::string &getModuleIdentifier() const { return ModuleID; }
 228
 229   /// Get the data layout string for the module's target platform.  This encodes
 230   /// the type sizes and alignments expected by this module.
 231   /// @returns the data layout as a string
 232   const std::string &getDataLayout() const { return DataLayout; }
 233
 234   /// Get the target triple which is a string describing the target host.
 235   /// @returns a string containing the target triple.
 236   const std::string &getTargetTriple() const { return TargetTriple; }
 237
 238   /// Get the target endian information.
 239   /// @returns Endianess - an enumeration for the endianess of the target
 240   Endianness getEndianness() const;
 241
 242   /// Get the target pointer size.
 243   /// @returns PointerSize - an enumeration for the size of the target's pointer
 244   PointerSize getPointerSize() const;
 245
 246   /// Get the global data context.
 247   /// @returns LLVMContext - a container for LLVM's global information
 248   LLVMContext &getContext() const { return Context; }
 249
 250   /// Get any module-scope inline assembly blocks.
 251   /// @returns a string containing the module-scope inline assembly blocks.
 252   const std::string &getModuleInlineAsm() const { return GlobalScopeAsm; }
 253
 254 /// @}
 255 /// @name Module Level Mutators
 256 /// @{
 257
 258   /// Set the module identifier.
 259   void setModuleIdentifier(StringRef ID) { ModuleID = ID; }
 260
 261   /// Set the data layout
 262   void setDataLayout(StringRef DL) { DataLayout = DL; }
 263
 264   /// Set the target triple.
 265   void setTargetTriple(StringRef T) { TargetTriple = T; }
 266
 267   /// Set the module-scope inline assembly blocks.
 268   void setModuleInlineAsm(StringRef Asm) {
 269     GlobalScopeAsm = Asm;
 270     if (!GlobalScopeAsm.empty() &&
 271         GlobalScopeAsm[GlobalScopeAsm.size()-1] != '\n')
 272       GlobalScopeAsm += '\n';
 273   }
 274
 275   /// Append to the module-scope inline assembly blocks, automatically inserting
 276   /// a separating newline if necessary.
 277   void appendModuleInlineAsm(StringRef Asm) {
 278     GlobalScopeAsm += Asm;
 279     if (!GlobalScopeAsm.empty() &&
 280         GlobalScopeAsm[GlobalScopeAsm.size()-1] != '\n')
 281       GlobalScopeAsm += '\n';
 282   }
 283
 284 /// @}
 285 /// @name Generic Value Accessors
 286 /// @{
 287
 288   /// getNamedValue - Return the global value in the module with
 289   /// the specified name, of arbitrary type.  This method returns null
 290   /// if a global with the specified name is not found.
 291   GlobalValue *getNamedValue(StringRef Name) const;
 292
 293   /// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
 294   /// This ID is uniqued across modules in the current LLVMContext.
 295   unsigned getMDKindID(StringRef Name) const;
 296
 297   /// getMDKindNames - Populate client supplied SmallVector with the name for
 298   /// custom metadata IDs registered in this LLVMContext.
 299   void getMDKindNames(SmallVectorImpl<StringRef> &Result) const;
 300
 301
 302   typedef DenseMap<StructType*, unsigned, DenseMapInfo<StructType*>,
 303                    DenseMapInfo<unsigned> > NumeredTypesMapTy;
 304
 305   /// findUsedStructTypes - Walk the entire module and find all of the
 306   /// struct types that are in use, returning them in a vector.
 307   void findUsedStructTypes(std::vector<StructType*> &StructTypes) const;
 308
 309   /// getTypeByName - Return the type with the specified name, or null if there
 310   /// is none by that name.
 311   StructType *getTypeByName(StringRef Name) const;
 312
 313 /// @}
 314 /// @name Function Accessors
 315 /// @{
 316
 317   /// getOrInsertFunction - Look up the specified function in the module symbol
 318   /// table.  Four possibilities:
 319   ///   1. If it does not exist, add a prototype for the function and return it.
 320   ///   2. If it exists, and has a local linkage, the existing function is
 321   ///      renamed and a new one is inserted.
 322   ///   3. Otherwise, if the existing function has the correct prototype, return
 323   ///      the existing function.
 324   ///   4. Finally, the function exists but has the wrong prototype: return the
 325   ///      function with a constantexpr cast to the right prototype.
 326   Constant *getOrInsertFunction(StringRef Name, FunctionType *T,
 327                                 AttrListPtr AttributeList);
 328
 329   Constant *getOrInsertFunction(StringRef Name, FunctionType *T);
 330
 331   /// getOrInsertFunction - Look up the specified function in the module symbol
 332   /// table.  If it does not exist, add a prototype for the function and return
 333   /// it.  This function guarantees to return a constant of pointer to the
 334   /// specified function type or a ConstantExpr BitCast of that type if the
 335   /// named function has a different type.  This version of the method takes a
 336   /// null terminated list of function arguments, which makes it easier for
 337   /// clients to use.
 338   Constant *getOrInsertFunction(StringRef Name,
 339                                 AttrListPtr AttributeList,
 340                                 Type *RetTy, ...)  END_WITH_NULL;
 341
 342   /// getOrInsertFunction - Same as above, but without the attributes.
 343   Constant *getOrInsertFunction(StringRef Name, Type *RetTy, ...)
 344     END_WITH_NULL;
 345
 346   Constant *getOrInsertTargetIntrinsic(StringRef Name,
 347                                        FunctionType *Ty,
 348                                        AttrListPtr AttributeList);
 349
 350   /// getFunction - Look up the specified function in the module symbol table.
 351   /// If it does not exist, return null.
 352   Function *getFunction(StringRef Name) const;
 353
 354 /// @}
 355 /// @name Global Variable Accessors
 356 /// @{
 357
 358   /// getGlobalVariable - Look up the specified global variable in the module
 359   /// symbol table.  If it does not exist, return null. If AllowInternal is set
 360   /// to true, this function will return types that have InternalLinkage. By
 361   /// default, these types are not returned.
 362   GlobalVariable *getGlobalVariable(StringRef Name,
 363                                     bool AllowInternal = false) const;
 364
 365   /// getNamedGlobal - Return the global variable in the module with the
 366   /// specified name, of arbitrary type.  This method returns null if a global
 367   /// with the specified name is not found.
 368   GlobalVariable *getNamedGlobal(StringRef Name) const {
 369     return getGlobalVariable(Name, true);
 370   }
 371
 372   /// getOrInsertGlobal - Look up the specified global in the module symbol
 373   /// table.
 374   ///   1. If it does not exist, add a declaration of the global and return it.
 375   ///   2. Else, the global exists but has the wrong type: return the function
 376   ///      with a constantexpr cast to the right type.
 377   ///   3. Finally, if the existing global is the correct declaration, return
 378   ///      the existing global.
 379   Constant *getOrInsertGlobal(StringRef Name, Type *Ty);
 380
 381 /// @}
 382 /// @name Global Alias Accessors
 383 /// @{
 384
 385   /// getNamedAlias - Return the global alias in the module with the
 386   /// specified name, of arbitrary type.  This method returns null if a global
 387   /// with the specified name is not found.
 388   GlobalAlias *getNamedAlias(StringRef Name) const;
 389
 390 /// @}
 391 /// @name Named Metadata Accessors
 392 /// @{
 393
 394   /// getNamedMetadata - Return the NamedMDNode in the module with the
 395   /// specified name. This method returns null if a NamedMDNode with the
 396   /// specified name is not found.
 397   NamedMDNode *getNamedMetadata(const Twine &Name) const;
 398
 399   /// getOrInsertNamedMetadata - Return the named MDNode in the module
 400   /// with the specified name. This method returns a new NamedMDNode if a
 401   /// NamedMDNode with the specified name is not found.
 402   NamedMDNode *getOrInsertNamedMetadata(StringRef Name);
 403
 404   /// eraseNamedMetadata - Remove the given NamedMDNode from this module
 405   /// and delete it.
 406   void eraseNamedMetadata(NamedMDNode *NMD);
 407
 408 /// @}
 409 /// @name Module Flags Accessors
 410 /// @{
 411
 412   /// getModuleFlagsMetadata - Returns the module flags in the provided vector.
 413   void getModuleFlagsMetadata(SmallVectorImpl<ModuleFlagEntry> &Flags) const;
 414
 415   /// getModuleFlagsMetadata - Returns the NamedMDNode in the module that
 416   /// represents module-level flags. This method returns null if there are no
 417   /// module-level flags.
 418   NamedMDNode *getModuleFlagsMetadata() const;
 419
 420   /// getOrInsertModuleFlagsMetadata - Returns the NamedMDNode in the module
 421   /// that represents module-level flags. If module-level flags aren't found,
 422   /// it creates the named metadata that contains them.
 423   NamedMDNode *getOrInsertModuleFlagsMetadata();
 424
 425   /// addModuleFlag - Add a module-level flag to the module-level flags
 426   /// metadata. It will create the module-level flags named metadata if it
 427   /// doesn't already exist.
 428   void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, Value *Val);
 429   void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, uint32_t Val);
 430   void addModuleFlag(MDNode *Node);
 431
 432 /// @}
 433 /// @name Materialization
 434 /// @{
 435
 436   /// setMaterializer - Sets the GVMaterializer to GVM.  This module must not
 437   /// yet have a Materializer.  To reset the materializer for a module that
 438   /// already has one, call MaterializeAllPermanently first.  Destroying this
 439   /// module will destroy its materializer without materializing any more
 440   /// GlobalValues.  Without destroying the Module, there is no way to detach or
 441   /// destroy a materializer without materializing all the GVs it controls, to
 442   /// avoid leaving orphan unmaterialized GVs.
 443   void setMaterializer(GVMaterializer *GVM);
 444   /// getMaterializer - Retrieves the GVMaterializer, if any, for this Module.
 445   GVMaterializer *getMaterializer() const { return Materializer.get(); }
 446
 447   /// isMaterializable - True if the definition of GV has yet to be materialized
 448   /// from the GVMaterializer.
 449   bool isMaterializable(const GlobalValue *GV) const;
 450   /// isDematerializable - Returns true if this GV was loaded from this Module's
 451   /// GVMaterializer and the GVMaterializer knows how to dematerialize the GV.
 452   bool isDematerializable(const GlobalValue *GV) const;
 453
 454   /// Materialize - Make sure the GlobalValue is fully read.  If the module is
 455   /// corrupt, this returns true and fills in the optional string with
 456   /// information about the problem.  If successful, this returns false.
 457   bool Materialize(GlobalValue *GV, std::string *ErrInfo = 0);
 458   /// Dematerialize - If the GlobalValue is read in, and if the GVMaterializer
 459   /// supports it, release the memory for the function, and set it up to be
 460   /// materialized lazily.  If !isDematerializable(), this method is a noop.
 461   void Dematerialize(GlobalValue *GV);
 462
 463   /// MaterializeAll - Make sure all GlobalValues in this Module are fully read.
 464   /// If the module is corrupt, this returns true and fills in the optional
 465   /// string with information about the problem.  If successful, this returns
 466   /// false.
 467   bool MaterializeAll(std::string *ErrInfo = 0);
 468
 469   /// MaterializeAllPermanently - Make sure all GlobalValues in this Module are
 470   /// fully read and clear the Materializer.  If the module is corrupt, this
 471   /// returns true, fills in the optional string with information about the
 472   /// problem, and DOES NOT clear the old Materializer.  If successful, this
 473   /// returns false.
 474   bool MaterializeAllPermanently(std::string *ErrInfo = 0);
 475
 476 /// @}
 477 /// @name Direct access to the globals list, functions list, and symbol table
 478 /// @{
 479
 480   /// Get the Module's list of global variables (constant).
 481   const GlobalListType   &getGlobalList() const       { return GlobalList; }
 482   /// Get the Module's list of global variables.
 483   GlobalListType         &getGlobalList()             { return GlobalList; }
 484   static iplist<GlobalVariable> Module::*getSublistAccess(GlobalVariable*) {
 485     return &Module::GlobalList;
 486   }
 487   /// Get the Module's list of functions (constant).
 488   const FunctionListType &getFunctionList() const     { return FunctionList; }
 489   /// Get the Module's list of functions.
 490   FunctionListType       &getFunctionList()           { return FunctionList; }
 491   static iplist<Function> Module::*getSublistAccess(Function*) {
 492     return &Module::FunctionList;
 493   }
 494   /// Get the Module's list of aliases (constant).
 495   const AliasListType    &getAliasList() const        { return AliasList; }
 496   /// Get the Module's list of aliases.
 497   AliasListType          &getAliasList()              { return AliasList; }
 498   static iplist<GlobalAlias> Module::*getSublistAccess(GlobalAlias*) {
 499     return &Module::AliasList;
 500   }
 501   /// Get the symbol table of global variable and function identifiers
 502   const ValueSymbolTable &getValueSymbolTable() const { return *ValSymTab; }
 503   /// Get the Module's symbol table of global variable and function identifiers.
 504   ValueSymbolTable       &getValueSymbolTable()       { return *ValSymTab; }
 505
 506 /// @}
 507 /// @name Global Variable Iteration
 508 /// @{
 509
 510   global_iterator       global_begin()       { return GlobalList.begin(); }
 511   const_global_iterator global_begin() const { return GlobalList.begin(); }
 512   global_iterator       global_end  ()       { return GlobalList.end(); }
 513   const_global_iterator global_end  () const { return GlobalList.end(); }
 514   bool                  global_empty() const { return GlobalList.empty(); }
 515
 516 /// @}
 517 /// @name Function Iteration
 518 /// @{
 519
 520   iterator                begin()       { return FunctionList.begin(); }
 521   const_iterator          begin() const { return FunctionList.begin(); }
 522   iterator                end  ()       { return FunctionList.end();   }
 523   const_iterator          end  () const { return FunctionList.end();   }
 524   size_t                  size() const  { return FunctionList.size(); }
 525   bool                    empty() const { return FunctionList.empty(); }
 526
 527 /// @}
 528 /// @name Dependent Library Iteration
 529 /// @{
 530
 531   /// @brief Get a constant iterator to beginning of dependent library list.
 532   inline lib_iterator lib_begin() const { return LibraryList.begin(); }
 533   /// @brief Get a constant iterator to end of dependent library list.
 534   inline lib_iterator lib_end()   const { return LibraryList.end();   }
 535   /// @brief Returns the number of items in the list of libraries.
 536   inline size_t       lib_size()  const { return LibraryList.size();  }
 537   /// @brief Add a library to the list of dependent libraries
 538   void addLibrary(StringRef Lib);
 539   /// @brief Remove a library from the list of dependent libraries
 540   void removeLibrary(StringRef Lib);
 541   /// @brief Get all the libraries
 542   inline const LibraryListType& getLibraries() const { return LibraryList; }
 543
 544 /// @}
 545 /// @name Alias Iteration
 546 /// @{
 547
 548   alias_iterator       alias_begin()            { return AliasList.begin(); }
 549   const_alias_iterator alias_begin() const      { return AliasList.begin(); }
 550   alias_iterator       alias_end  ()            { return AliasList.end();   }
 551   const_alias_iterator alias_end  () const      { return AliasList.end();   }
 552   size_t               alias_size () const      { return AliasList.size();  }
 553   bool                 alias_empty() const      { return AliasList.empty(); }
 554
 555
 556 /// @}
 557 /// @name Named Metadata Iteration
 558 /// @{
 559
 560   named_metadata_iterator named_metadata_begin() { return NamedMDList.begin(); }
 561   const_named_metadata_iterator named_metadata_begin() const {
 562     return NamedMDList.begin();
 563   }
 564
 565   named_metadata_iterator named_metadata_end() { return NamedMDList.end(); }
 566   const_named_metadata_iterator named_metadata_end() const {
 567     return NamedMDList.end();
 568   }
 569
 570   size_t named_metadata_size() const { return NamedMDList.size();  }
 571   bool named_metadata_empty() const { return NamedMDList.empty(); }
 572
 573
 574 /// @}
 575 /// @name Utility functions for printing and dumping Module objects
 576 /// @{
 577
 578   /// Print the module to an output stream with an optional
 579   /// AssemblyAnnotationWriter.
 580   void print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const;
 581
 582   /// Dump the module to stderr (for debugging).
 583   void dump() const;
 584
 585   /// This function causes all the subinstructions to "let go" of all references
 586   /// that they are maintaining.  This allows one to 'delete' a whole class at
 587   /// a time, even though there may be circular references... first all
 588   /// references are dropped, and all use counts go to zero.  Then everything
 589   /// is delete'd for real.  Note that no operations are valid on an object
 590   /// that has "dropped all references", except operator delete.
 591   void dropAllReferences();
 592 /// @}
 593 };
 594
 595 /// An raw_ostream inserter for modules.
 596 inline raw_ostream &operator<<(raw_ostream &O, const Module &M) {
 597   M.print(O, 0);
 598   return O;
 599 }
 600
 601 } // End llvm namespace
 602
 603 #endif