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