include/llvm/IR/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_IR_MODULE_H
  16 #define LLVM_IR_MODULE_H
  17
  18 #include "llvm/IR/DataLayout.h"
  19 #include "llvm/IR/Function.h"
  20 #include "llvm/IR/GlobalAlias.h"
  21 #include "llvm/IR/GlobalVariable.h"
  22 #include "llvm/IR/Metadata.h"
  23 #include "llvm/Support/CBindingWrapping.h"
  24 #include "llvm/Support/DataTypes.h"
  25 #include "llvm/Support/system_error.h"
  26
  27 namespace llvm {
  28
  29 class FunctionType;
  30 class GVMaterializer;
  31 class LLVMContext;
  32 class StructType;
  33 template<typename T> struct DenseMapInfo;
  34 template<typename KeyT, typename ValueT, typename KeyInfoT> 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 Global Variable iterator.
 127   typedef GlobalListType::iterator                      global_iterator;
 128   /// The Global Variable constant iterator.
 129   typedef GlobalListType::const_iterator          const_global_iterator;
 130
 131   /// The Function iterators.
 132   typedef FunctionListType::iterator                           iterator;
 133   /// The Function constant iterator
 134   typedef FunctionListType::const_iterator               const_iterator;
 135
 136   /// The Global Alias iterators.
 137   typedef AliasListType::iterator                        alias_iterator;
 138   /// The Global Alias constant iterator
 139   typedef AliasListType::const_iterator            const_alias_iterator;
 140
 141   /// The named metadata iterators.
 142   typedef NamedMDListType::iterator             named_metadata_iterator;
 143   /// The named metadata constant interators.
 144   typedef NamedMDListType::const_iterator const_named_metadata_iterator;
 145
 146   /// This enumeration defines the supported behaviors of module flags.
 147   enum ModFlagBehavior {
 148     /// Emits an error if two values disagree, otherwise the resulting value is
 149     /// that of the operands.
 150     Error = 1,
 151
 152     /// Emits a warning if two values disagree. The result value will be the
 153     /// operand for the flag from the first module being linked.
 154     Warning = 2,
 155
 156     /// Adds a requirement that another module flag be present and have a
 157     /// specified value after linking is performed. The value must be a metadata
 158     /// pair, where the first element of the pair is the ID of the module flag
 159     /// to be restricted, and the second element of the pair is the value the
 160     /// module flag should be restricted to. This behavior can be used to
 161     /// restrict the allowable results (via triggering of an error) of linking
 162     /// IDs with the **Override** behavior.
 163     Require = 3,
 164
 165     /// Uses the specified value, regardless of the behavior or value of the
 166     /// other module. If both modules specify **Override**, but the values
 167     /// differ, an error will be emitted.
 168     Override = 4,
 169
 170     /// Appends the two values, which are required to be metadata nodes.
 171     Append = 5,
 172
 173     /// Appends the two values, which are required to be metadata
 174     /// nodes. However, duplicate entries in the second list are dropped
 175     /// during the append operation.
 176     AppendUnique = 6
 177   };
 178
 179   struct ModuleFlagEntry {
 180     ModFlagBehavior Behavior;
 181     MDString *Key;
 182     Value *Val;
 183     ModuleFlagEntry(ModFlagBehavior B, MDString *K, Value *V)
 184       : Behavior(B), Key(K), Val(V) {}
 185   };
 186
 187 /// @}
 188 /// @name Member Variables
 189 /// @{
 190 private:
 191   LLVMContext &Context;           ///< The LLVMContext from which types and
 192                                   ///< constants are allocated.
 193   GlobalListType GlobalList;      ///< The Global Variables in the module
 194   FunctionListType FunctionList;  ///< The Functions in the module
 195   AliasListType AliasList;        ///< The Aliases in the module
 196   NamedMDListType NamedMDList;    ///< The named metadata in the module
 197   std::string GlobalScopeAsm;     ///< Inline Asm at global scope.
 198   ValueSymbolTable *ValSymTab;    ///< Symbol table for values
 199   std::unique_ptr<GVMaterializer>
 200   Materializer;                   ///< Used to materialize GlobalValues
 201   std::string ModuleID;           ///< Human readable identifier for the module
 202   std::string TargetTriple;       ///< Platform target triple Module compiled on
 203   void *NamedMDSymTab;            ///< NamedMDNode names.
 204
 205   // We need to keep the string because the C API expects us to own the string
 206   // representation.
 207   // Since we have it, we also use an empty string to represent a module without
 208   // a DataLayout. If it has a DataLayout, these variables are in sync and the
 209   // string is just a cache of getDataLayout()->getStringRepresentation().
 210   std::string DataLayoutStr;
 211   DataLayout DL;
 212
 213   friend class Constant;
 214
 215 /// @}
 216 /// @name Constructors
 217 /// @{
 218 public:
 219   /// The Module constructor. Note that there is no default constructor. You
 220   /// must provide a name for the module upon construction.
 221   explicit Module(StringRef ModuleID, LLVMContext& C);
 222   /// The module destructor. This will dropAllReferences.
 223   ~Module();
 224
 225 /// @}
 226 /// @name Module Level Accessors
 227 /// @{
 228
 229   /// Get the module identifier which is, essentially, the name of the module.
 230   /// @returns the module identifier as a string
 231   const std::string &getModuleIdentifier() const { return ModuleID; }
 232
 233   /// Get the data layout string for the module's target platform. This is
 234   /// equivalent to getDataLayout()->getStringRepresentation().
 235   const std::string &getDataLayoutStr() const { return DataLayoutStr; }
 236
 237   /// Get the data layout for the module's target platform.
 238   const DataLayout *getDataLayout() const;
 239
 240   /// Get the target triple which is a string describing the target host.
 241   /// @returns a string containing the target triple.
 242   const std::string &getTargetTriple() const { return TargetTriple; }
 243
 244   /// Get the global data context.
 245   /// @returns LLVMContext - a container for LLVM's global information
 246   LLVMContext &getContext() const { return Context; }
 247
 248   /// Get any module-scope inline assembly blocks.
 249   /// @returns a string containing the module-scope inline assembly blocks.
 250   const std::string &getModuleInlineAsm() const { return GlobalScopeAsm; }
 251
 252 /// @}
 253 /// @name Module Level Mutators
 254 /// @{
 255
 256   /// Set the module identifier.
 257   void setModuleIdentifier(StringRef ID) { ModuleID = ID; }
 258
 259   /// Set the data layout
 260   void setDataLayout(StringRef Desc);
 261   void setDataLayout(const DataLayout *Other);
 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   /// getTypeByName - Return the type with the specified name, or null if there
 305   /// is none by that name.
 306   StructType *getTypeByName(StringRef Name) const;
 307
 308 /// @}
 309 /// @name Function Accessors
 310 /// @{
 311
 312   /// getOrInsertFunction - Look up the specified function in the module symbol
 313   /// table.  Four possibilities:
 314   ///   1. If it does not exist, add a prototype for the function and return it.
 315   ///   2. If it exists, and has a local linkage, the existing function is
 316   ///      renamed and a new one is inserted.
 317   ///   3. Otherwise, if the existing function has the correct prototype, return
 318   ///      the existing function.
 319   ///   4. Finally, the function exists but has the wrong prototype: return the
 320   ///      function with a constantexpr cast to the right prototype.
 321   Constant *getOrInsertFunction(StringRef Name, FunctionType *T,
 322                                 AttributeSet AttributeList);
 323
 324   Constant *getOrInsertFunction(StringRef Name, FunctionType *T);
 325
 326   /// getOrInsertFunction - Look up the specified function in the module symbol
 327   /// table.  If it does not exist, add a prototype for the function and return
 328   /// it.  This function guarantees to return a constant of pointer to the
 329   /// specified function type or a ConstantExpr BitCast of that type if the
 330   /// named function has a different type.  This version of the method takes a
 331   /// null terminated list of function arguments, which makes it easier for
 332   /// clients to use.
 333   Constant *getOrInsertFunction(StringRef Name,
 334                                 AttributeSet AttributeList,
 335                                 Type *RetTy, ...)  END_WITH_NULL;
 336
 337   /// getOrInsertFunction - Same as above, but without the attributes.
 338   Constant *getOrInsertFunction(StringRef Name, Type *RetTy, ...)
 339     END_WITH_NULL;
 340
 341   /// getFunction - Look up the specified function in the module symbol table.
 342   /// If it does not exist, return null.
 343   Function *getFunction(StringRef Name) const;
 344
 345 /// @}
 346 /// @name Global Variable Accessors
 347 /// @{
 348
 349   /// getGlobalVariable - Look up the specified global variable in the module
 350   /// symbol table.  If it does not exist, return null. If AllowInternal is set
 351   /// to true, this function will return types that have InternalLinkage. By
 352   /// default, these types are not returned.
 353   const GlobalVariable *getGlobalVariable(StringRef Name,
 354                                           bool AllowInternal = false) const {
 355     return const_cast<Module *>(this)->getGlobalVariable(Name, AllowInternal);
 356   }
 357
 358   GlobalVariable *getGlobalVariable(StringRef Name, bool AllowInternal = false);
 359
 360   /// getNamedGlobal - Return the global variable in the module with the
 361   /// specified name, of arbitrary type.  This method returns null if a global
 362   /// with the specified name is not found.
 363   GlobalVariable *getNamedGlobal(StringRef Name) {
 364     return getGlobalVariable(Name, true);
 365   }
 366   const GlobalVariable *getNamedGlobal(StringRef Name) const {
 367     return const_cast<Module *>(this)->getNamedGlobal(Name);
 368   }
 369
 370   /// getOrInsertGlobal - Look up the specified global in the module symbol
 371   /// table.
 372   ///   1. If it does not exist, add a declaration of the global and return it.
 373   ///   2. Else, the global exists but has the wrong type: return the function
 374   ///      with a constantexpr cast to the right type.
 375   ///   3. Finally, if the existing global is the correct declaration, return
 376   ///      the existing global.
 377   Constant *getOrInsertGlobal(StringRef Name, Type *Ty);
 378
 379 /// @}
 380 /// @name Global Alias Accessors
 381 /// @{
 382
 383   /// getNamedAlias - Return the global alias in the module with the
 384   /// specified name, of arbitrary type.  This method returns null if a global
 385   /// with the specified name is not found.
 386   GlobalAlias *getNamedAlias(StringRef Name) const;
 387
 388 /// @}
 389 /// @name Named Metadata Accessors
 390 /// @{
 391
 392   /// getNamedMetadata - Return the first NamedMDNode in the module with the
 393   /// specified name. This method returns null if a NamedMDNode with the
 394   /// specified name is not found.
 395   NamedMDNode *getNamedMetadata(const Twine &Name) const;
 396
 397   /// getOrInsertNamedMetadata - Return the named MDNode in the module
 398   /// with the specified name. This method returns a new NamedMDNode if a
 399   /// NamedMDNode with the specified name is not found.
 400   NamedMDNode *getOrInsertNamedMetadata(StringRef Name);
 401
 402   /// eraseNamedMetadata - Remove the given NamedMDNode from this module
 403   /// and delete it.
 404   void eraseNamedMetadata(NamedMDNode *NMD);
 405
 406 /// @}
 407 /// @name Module Flags Accessors
 408 /// @{
 409
 410   /// getModuleFlagsMetadata - Returns the module flags in the provided vector.
 411   void getModuleFlagsMetadata(SmallVectorImpl<ModuleFlagEntry> &Flags) const;
 412
 413   /// Return the corresponding value if Key appears in module flags, otherwise
 414   /// return null.
 415   Value *getModuleFlag(StringRef Key) const;
 416
 417   /// getModuleFlagsMetadata - Returns the NamedMDNode in the module that
 418   /// represents module-level flags. This method returns null if there are no
 419   /// module-level flags.
 420   NamedMDNode *getModuleFlagsMetadata() const;
 421
 422   /// getOrInsertModuleFlagsMetadata - Returns the NamedMDNode in the module
 423   /// that represents module-level flags. If module-level flags aren't found,
 424   /// it creates the named metadata that contains them.
 425   NamedMDNode *getOrInsertModuleFlagsMetadata();
 426
 427   /// addModuleFlag - Add a module-level flag to the module-level flags
 428   /// metadata. It will create the module-level flags named metadata if it
 429   /// doesn't already exist.
 430   void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, Value *Val);
 431   void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, uint32_t Val);
 432   void addModuleFlag(MDNode *Node);
 433
 434 /// @}
 435 /// @name Materialization
 436 /// @{
 437
 438   /// setMaterializer - Sets the GVMaterializer to GVM.  This module must not
 439   /// yet have a Materializer.  To reset the materializer for a module that
 440   /// already has one, call MaterializeAllPermanently first.  Destroying this
 441   /// module will destroy its materializer without materializing any more
 442   /// GlobalValues.  Without destroying the Module, there is no way to detach or
 443   /// destroy a materializer without materializing all the GVs it controls, to
 444   /// avoid leaving orphan unmaterialized GVs.
 445   void setMaterializer(GVMaterializer *GVM);
 446   /// getMaterializer - Retrieves the GVMaterializer, if any, for this Module.
 447   GVMaterializer *getMaterializer() const { return Materializer.get(); }
 448
 449   /// isMaterializable - True if the definition of GV has yet to be materialized
 450   /// from the GVMaterializer.
 451   bool isMaterializable(const GlobalValue *GV) const;
 452   /// isDematerializable - Returns true if this GV was loaded from this Module's
 453   /// GVMaterializer and the GVMaterializer knows how to dematerialize the GV.
 454   bool isDematerializable(const GlobalValue *GV) const;
 455
 456   /// Materialize - Make sure the GlobalValue is fully read.  If the module is
 457   /// corrupt, this returns true and fills in the optional string with
 458   /// information about the problem.  If successful, this returns false.
 459   bool Materialize(GlobalValue *GV, std::string *ErrInfo = 0);
 460   /// Dematerialize - If the GlobalValue is read in, and if the GVMaterializer
 461   /// supports it, release the memory for the function, and set it up to be
 462   /// materialized lazily.  If !isDematerializable(), this method is a noop.
 463   void Dematerialize(GlobalValue *GV);
 464
 465   /// Make sure all GlobalValues in this Module are fully read.
 466   error_code materializeAll();
 467
 468   /// Make sure all GlobalValues in this Module are fully read and clear the
 469   /// Materializer. If the module is corrupt, this DOES NOT clear the old
 470   /// Materializer.
 471   error_code materializeAllPermanently();
 472
 473 /// @}
 474 /// @name Direct access to the globals list, functions list, and symbol table
 475 /// @{
 476
 477   /// Get the Module's list of global variables (constant).
 478   const GlobalListType   &getGlobalList() const       { return GlobalList; }
 479   /// Get the Module's list of global variables.
 480   GlobalListType         &getGlobalList()             { return GlobalList; }
 481   static iplist<GlobalVariable> Module::*getSublistAccess(GlobalVariable*) {
 482     return &Module::GlobalList;
 483   }
 484   /// Get the Module's list of functions (constant).
 485   const FunctionListType &getFunctionList() const     { return FunctionList; }
 486   /// Get the Module's list of functions.
 487   FunctionListType       &getFunctionList()           { return FunctionList; }
 488   static iplist<Function> Module::*getSublistAccess(Function*) {
 489     return &Module::FunctionList;
 490   }
 491   /// Get the Module's list of aliases (constant).
 492   const AliasListType    &getAliasList() const        { return AliasList; }
 493   /// Get the Module's list of aliases.
 494   AliasListType          &getAliasList()              { return AliasList; }
 495   static iplist<GlobalAlias> Module::*getSublistAccess(GlobalAlias*) {
 496     return &Module::AliasList;
 497   }
 498   /// Get the Module's list of named metadata (constant).
 499   const NamedMDListType  &getNamedMDList() const      { return NamedMDList; }
 500   /// Get the Module's list of named metadata.
 501   NamedMDListType        &getNamedMDList()            { return NamedMDList; }
 502   static ilist<NamedMDNode> Module::*getSublistAccess(NamedMDNode*) {
 503     return &Module::NamedMDList;
 504   }
 505   /// Get the symbol table of global variable and function identifiers
 506   const ValueSymbolTable &getValueSymbolTable() const { return *ValSymTab; }
 507   /// Get the Module's symbol table of global variable and function identifiers.
 508   ValueSymbolTable       &getValueSymbolTable()       { return *ValSymTab; }
 509
 510 /// @}
 511 /// @name Global Variable Iteration
 512 /// @{
 513
 514   global_iterator       global_begin()       { return GlobalList.begin(); }
 515   const_global_iterator global_begin() const { return GlobalList.begin(); }
 516   global_iterator       global_end  ()       { return GlobalList.end(); }
 517   const_global_iterator global_end  () const { return GlobalList.end(); }
 518   bool                  global_empty() const { return GlobalList.empty(); }
 519
 520 /// @}
 521 /// @name Function Iteration
 522 /// @{
 523
 524   iterator                begin()       { return FunctionList.begin(); }
 525   const_iterator          begin() const { return FunctionList.begin(); }
 526   iterator                end  ()       { return FunctionList.end();   }
 527   const_iterator          end  () const { return FunctionList.end();   }
 528   size_t                  size() const  { return FunctionList.size(); }
 529   bool                    empty() const { return FunctionList.empty(); }
 530
 531 /// @}
 532 /// @name Alias Iteration
 533 /// @{
 534
 535   alias_iterator       alias_begin()            { return AliasList.begin(); }
 536   const_alias_iterator alias_begin() const      { return AliasList.begin(); }
 537   alias_iterator       alias_end  ()            { return AliasList.end();   }
 538   const_alias_iterator alias_end  () const      { return AliasList.end();   }
 539   size_t               alias_size () const      { return AliasList.size();  }
 540   bool                 alias_empty() const      { return AliasList.empty(); }
 541
 542
 543 /// @}
 544 /// @name Named Metadata Iteration
 545 /// @{
 546
 547   named_metadata_iterator named_metadata_begin() { return NamedMDList.begin(); }
 548   const_named_metadata_iterator named_metadata_begin() const {
 549     return NamedMDList.begin();
 550   }
 551
 552   named_metadata_iterator named_metadata_end() { return NamedMDList.end(); }
 553   const_named_metadata_iterator named_metadata_end() const {
 554     return NamedMDList.end();
 555   }
 556
 557   size_t named_metadata_size() const { return NamedMDList.size();  }
 558   bool named_metadata_empty() const { return NamedMDList.empty(); }
 559
 560
 561 /// @}
 562 /// @name Utility functions for printing and dumping Module objects
 563 /// @{
 564
 565   /// Print the module to an output stream with an optional
 566   /// AssemblyAnnotationWriter.
 567   void print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const;
 568
 569   /// Dump the module to stderr (for debugging).
 570   void dump() const;
 571
 572   /// This function causes all the subinstructions to "let go" of all references
 573   /// that they are maintaining.  This allows one to 'delete' a whole class at
 574   /// a time, even though there may be circular references... first all
 575   /// references are dropped, and all use counts go to zero.  Then everything
 576   /// is delete'd for real.  Note that no operations are valid on an object
 577   /// that has "dropped all references", except operator delete.
 578   void dropAllReferences();
 579 /// @}
 580 };
 581
 582 /// An raw_ostream inserter for modules.
 583 inline raw_ostream &operator<<(raw_ostream &O, const Module &M) {
 584   M.print(O, 0);
 585   return O;
 586 }
 587
 588 // Create wrappers for C Binding types (see CBindingWrapping.h).
 589 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef)
 590
 591 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
 592  * Module.
 593  */
 594 inline Module *unwrap(LLVMModuleProviderRef MP) {
 595   return reinterpret_cast<Module*>(MP);
 596 }
 597
 598 } // End llvm namespace
 599
 600 #endif