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/ADT/iterator_range.h"
  19 #include "llvm/IR/Comdat.h"
  20 #include "llvm/IR/DataLayout.h"
  21 #include "llvm/IR/Function.h"
  22 #include "llvm/IR/GlobalAlias.h"
  23 #include "llvm/IR/GlobalVariable.h"
  24 #include "llvm/IR/Metadata.h"
  25 #include "llvm/Support/CBindingWrapping.h"
  26 #include "llvm/Support/CodeGen.h"
  27 #include "llvm/Support/DataTypes.h"
  28 #include <system_error>
  29
  30 namespace llvm {
  31 class FunctionType;
  32 class GVMaterializer;
  33 class LLVMContext;
  34 class RandomNumberGenerator;
  35 class StructType;
  36 template<typename T> struct DenseMapInfo;
  37 template<typename KeyT, typename ValueT, typename KeyInfoT> class DenseMap;
  38
  39 template<> struct ilist_traits<Function>
  40   : public SymbolTableListTraits<Function, Module> {
  41
  42   // createSentinel is used to get hold of the node that marks the end of the
  43   // list... (same trick used here as in ilist_traits<Instruction>)
  44   Function *createSentinel() const {
  45     return static_cast<Function*>(&Sentinel);
  46   }
  47   static void destroySentinel(Function*) {}
  48
  49   Function *provideInitialHead() const { return createSentinel(); }
  50   Function *ensureHead(Function*) const { return createSentinel(); }
  51   static void noteHead(Function*, Function*) {}
  52
  53 private:
  54   mutable ilist_node<Function> Sentinel;
  55 };
  56
  57 template<> struct ilist_traits<GlobalVariable>
  58   : public SymbolTableListTraits<GlobalVariable, Module> {
  59   // createSentinel is used to create a node that marks the end of the list.
  60   GlobalVariable *createSentinel() const {
  61     return static_cast<GlobalVariable*>(&Sentinel);
  62   }
  63   static void destroySentinel(GlobalVariable*) {}
  64
  65   GlobalVariable *provideInitialHead() const { return createSentinel(); }
  66   GlobalVariable *ensureHead(GlobalVariable*) const { return createSentinel(); }
  67   static void noteHead(GlobalVariable*, GlobalVariable*) {}
  68 private:
  69   mutable ilist_node<GlobalVariable> Sentinel;
  70 };
  71
  72 template<> struct ilist_traits<GlobalAlias>
  73   : public SymbolTableListTraits<GlobalAlias, Module> {
  74   // createSentinel is used to create a node that marks the end of the list.
  75   GlobalAlias *createSentinel() const {
  76     return static_cast<GlobalAlias*>(&Sentinel);
  77   }
  78   static void destroySentinel(GlobalAlias*) {}
  79
  80   GlobalAlias *provideInitialHead() const { return createSentinel(); }
  81   GlobalAlias *ensureHead(GlobalAlias*) const { return createSentinel(); }
  82   static void noteHead(GlobalAlias*, GlobalAlias*) {}
  83 private:
  84   mutable ilist_node<GlobalAlias> Sentinel;
  85 };
  86
  87 template<> struct ilist_traits<NamedMDNode>
  88   : public ilist_default_traits<NamedMDNode> {
  89   // createSentinel is used to get hold of a node that marks the end of
  90   // the list...
  91   NamedMDNode *createSentinel() const {
  92     return static_cast<NamedMDNode*>(&Sentinel);
  93   }
  94   static void destroySentinel(NamedMDNode*) {}
  95
  96   NamedMDNode *provideInitialHead() const { return createSentinel(); }
  97   NamedMDNode *ensureHead(NamedMDNode*) const { return createSentinel(); }
  98   static void noteHead(NamedMDNode*, NamedMDNode*) {}
  99   void addNodeToList(NamedMDNode *) {}
 100   void removeNodeFromList(NamedMDNode *) {}
 101 private:
 102   mutable ilist_node<NamedMDNode> Sentinel;
 103 };
 104
 105 /// A Module instance is used to store all the information related to an
 106 /// LLVM module. Modules are the top level container of all other LLVM
 107 /// Intermediate Representation (IR) objects. Each module directly contains a
 108 /// list of globals variables, a list of functions, a list of libraries (or
 109 /// other modules) this module depends on, a symbol table, and various data
 110 /// about the target's characteristics.
 111 ///
 112 /// A module maintains a GlobalValRefMap object that is used to hold all
 113 /// constant references to global variables in the module.  When a global
 114 /// variable is destroyed, it should have no entries in the GlobalValueRefMap.
 115 /// @brief The main container class for the LLVM Intermediate Representation.
 116 class Module {
 117 /// @name Types And Enumerations
 118 /// @{
 119 public:
 120   /// The type for the list of global variables.
 121   typedef iplist<GlobalVariable> GlobalListType;
 122   /// The type for the list of functions.
 123   typedef iplist<Function> FunctionListType;
 124   /// The type for the list of aliases.
 125   typedef iplist<GlobalAlias> AliasListType;
 126   /// The type for the list of named metadata.
 127   typedef ilist<NamedMDNode> NamedMDListType;
 128   /// The type of the comdat "symbol" table.
 129   typedef StringMap<Comdat> ComdatSymTabType;
 130
 131   /// The Global Variable iterator.
 132   typedef GlobalListType::iterator                      global_iterator;
 133   /// The Global Variable constant iterator.
 134   typedef GlobalListType::const_iterator          const_global_iterator;
 135
 136   /// The Function iterators.
 137   typedef FunctionListType::iterator                           iterator;
 138   /// The Function constant iterator
 139   typedef FunctionListType::const_iterator               const_iterator;
 140
 141   /// The Function reverse iterator.
 142   typedef FunctionListType::reverse_iterator             reverse_iterator;
 143   /// The Function constant reverse iterator.
 144   typedef FunctionListType::const_reverse_iterator const_reverse_iterator;
 145
 146   /// The Global Alias iterators.
 147   typedef AliasListType::iterator                        alias_iterator;
 148   /// The Global Alias constant iterator
 149   typedef AliasListType::const_iterator            const_alias_iterator;
 150
 151   /// The named metadata iterators.
 152   typedef NamedMDListType::iterator             named_metadata_iterator;
 153   /// The named metadata constant interators.
 154   typedef NamedMDListType::const_iterator const_named_metadata_iterator;
 155
 156   /// This enumeration defines the supported behaviors of module flags.
 157   enum ModFlagBehavior {
 158     /// Emits an error if two values disagree, otherwise the resulting value is
 159     /// that of the operands.
 160     Error = 1,
 161
 162     /// Emits a warning if two values disagree. The result value will be the
 163     /// operand for the flag from the first module being linked.
 164     Warning = 2,
 165
 166     /// Adds a requirement that another module flag be present and have a
 167     /// specified value after linking is performed. The value must be a metadata
 168     /// pair, where the first element of the pair is the ID of the module flag
 169     /// to be restricted, and the second element of the pair is the value the
 170     /// module flag should be restricted to. This behavior can be used to
 171     /// restrict the allowable results (via triggering of an error) of linking
 172     /// IDs with the **Override** behavior.
 173     Require = 3,
 174
 175     /// Uses the specified value, regardless of the behavior or value of the
 176     /// other module. If both modules specify **Override**, but the values
 177     /// differ, an error will be emitted.
 178     Override = 4,
 179
 180     /// Appends the two values, which are required to be metadata nodes.
 181     Append = 5,
 182
 183     /// Appends the two values, which are required to be metadata
 184     /// nodes. However, duplicate entries in the second list are dropped
 185     /// during the append operation.
 186     AppendUnique = 6,
 187
 188     // Markers:
 189     ModFlagBehaviorFirstVal = Error,
 190     ModFlagBehaviorLastVal = AppendUnique
 191   };
 192
 193   /// Checks if Value represents a valid ModFlagBehavior, and stores the
 194   /// converted result in MFB.
 195   static bool isValidModFlagBehavior(Value *V, ModFlagBehavior &MFB);
 196
 197   struct ModuleFlagEntry {
 198     ModFlagBehavior Behavior;
 199     MDString *Key;
 200     Value *Val;
 201     ModuleFlagEntry(ModFlagBehavior B, MDString *K, Value *V)
 202       : Behavior(B), Key(K), Val(V) {}
 203   };
 204
 205 /// @}
 206 /// @name Member Variables
 207 /// @{
 208 private:
 209   LLVMContext &Context;           ///< The LLVMContext from which types and
 210                                   ///< constants are allocated.
 211   GlobalListType GlobalList;      ///< The Global Variables in the module
 212   FunctionListType FunctionList;  ///< The Functions in the module
 213   AliasListType AliasList;        ///< The Aliases in the module
 214   NamedMDListType NamedMDList;    ///< The named metadata in the module
 215   std::string GlobalScopeAsm;     ///< Inline Asm at global scope.
 216   ValueSymbolTable *ValSymTab;    ///< Symbol table for values
 217   ComdatSymTabType ComdatSymTab;  ///< Symbol table for COMDATs
 218   std::unique_ptr<GVMaterializer>
 219   Materializer;                   ///< Used to materialize GlobalValues
 220   std::string ModuleID;           ///< Human readable identifier for the module
 221   std::string TargetTriple;       ///< Platform target triple Module compiled on
 222   void *NamedMDSymTab;            ///< NamedMDNode names.
 223   // Allow lazy initialization in const method.
 224   mutable RandomNumberGenerator *RNG; ///< The random number generator for this module.
 225
 226   // We need to keep the string because the C API expects us to own the string
 227   // representation.
 228   // Since we have it, we also use an empty string to represent a module without
 229   // a DataLayout. If it has a DataLayout, these variables are in sync and the
 230   // string is just a cache of getDataLayout()->getStringRepresentation().
 231   std::string DataLayoutStr;
 232   DataLayout DL;
 233
 234   friend class Constant;
 235
 236 /// @}
 237 /// @name Constructors
 238 /// @{
 239 public:
 240   /// The Module constructor. Note that there is no default constructor. You
 241   /// must provide a name for the module upon construction.
 242   explicit Module(StringRef ModuleID, LLVMContext& C);
 243   /// The module destructor. This will dropAllReferences.
 244   ~Module();
 245
 246 /// @}
 247 /// @name Module Level Accessors
 248 /// @{
 249
 250   /// Get the module identifier which is, essentially, the name of the module.
 251   /// @returns the module identifier as a string
 252   const std::string &getModuleIdentifier() const { return ModuleID; }
 253
 254   /// Get the data layout string for the module's target platform. This is
 255   /// equivalent to getDataLayout()->getStringRepresentation().
 256   const std::string &getDataLayoutStr() const { return DataLayoutStr; }
 257
 258   /// Get the data layout for the module's target platform.
 259   const DataLayout *getDataLayout() const;
 260
 261   /// Get the target triple which is a string describing the target host.
 262   /// @returns a string containing the target triple.
 263   const std::string &getTargetTriple() const { return TargetTriple; }
 264
 265   /// Get the global data context.
 266   /// @returns LLVMContext - a container for LLVM's global information
 267   LLVMContext &getContext() const { return Context; }
 268
 269   /// Get any module-scope inline assembly blocks.
 270   /// @returns a string containing the module-scope inline assembly blocks.
 271   const std::string &getModuleInlineAsm() const { return GlobalScopeAsm; }
 272
 273   /// Get the RandomNumberGenerator for this module. The RNG can be
 274   /// seeded via -rng-seed=<uint64> and is salted with the ModuleID.
 275   /// The returned RNG should not be shared across threads.
 276   RandomNumberGenerator &getRNG() const;
 277
 278 /// @}
 279 /// @name Module Level Mutators
 280 /// @{
 281
 282   /// Set the module identifier.
 283   void setModuleIdentifier(StringRef ID) { ModuleID = ID; }
 284
 285   /// Set the data layout
 286   void setDataLayout(StringRef Desc);
 287   void setDataLayout(const DataLayout *Other);
 288
 289   /// Set the target triple.
 290   void setTargetTriple(StringRef T) { TargetTriple = T; }
 291
 292   /// Set the module-scope inline assembly blocks.
 293   void setModuleInlineAsm(StringRef Asm) {
 294     GlobalScopeAsm = Asm;
 295     if (!GlobalScopeAsm.empty() &&
 296         GlobalScopeAsm[GlobalScopeAsm.size()-1] != '\n')
 297       GlobalScopeAsm += '\n';
 298   }
 299
 300   /// Append to the module-scope inline assembly blocks, automatically inserting
 301   /// a separating newline if necessary.
 302   void appendModuleInlineAsm(StringRef Asm) {
 303     GlobalScopeAsm += Asm;
 304     if (!GlobalScopeAsm.empty() &&
 305         GlobalScopeAsm[GlobalScopeAsm.size()-1] != '\n')
 306       GlobalScopeAsm += '\n';
 307   }
 308
 309 /// @}
 310 /// @name Generic Value Accessors
 311 /// @{
 312
 313   /// Return the global value in the module with the specified name, of
 314   /// arbitrary type. This method returns null if a global with the specified
 315   /// name is not found.
 316   GlobalValue *getNamedValue(StringRef Name) const;
 317
 318   /// Return a unique non-zero ID for the specified metadata kind. This ID is
 319   /// uniqued across modules in the current LLVMContext.
 320   unsigned getMDKindID(StringRef Name) const;
 321
 322   /// Populate client supplied SmallVector with the name for custom metadata IDs
 323   /// registered in this LLVMContext.
 324   void getMDKindNames(SmallVectorImpl<StringRef> &Result) const;
 325
 326   /// Return the type with the specified name, or null if there is none by that
 327   /// name.
 328   StructType *getTypeByName(StringRef Name) const;
 329
 330 /// @}
 331 /// @name Function Accessors
 332 /// @{
 333
 334   /// Look up the specified function in the module symbol table. Four
 335   /// possibilities:
 336   ///   1. If it does not exist, add a prototype for the function and return it.
 337   ///   2. If it exists, and has a local linkage, the existing function is
 338   ///      renamed and a new one is inserted.
 339   ///   3. Otherwise, if the existing function has the correct prototype, return
 340   ///      the existing function.
 341   ///   4. Finally, the function exists but has the wrong prototype: return the
 342   ///      function with a constantexpr cast to the right prototype.
 343   Constant *getOrInsertFunction(StringRef Name, FunctionType *T,
 344                                 AttributeSet AttributeList);
 345
 346   Constant *getOrInsertFunction(StringRef Name, FunctionType *T);
 347
 348   /// Look up the specified function in the module symbol table. If it does not
 349   /// exist, add a prototype for the function and return it. This function
 350   /// guarantees to return a constant of pointer to the specified function type
 351   /// or a ConstantExpr BitCast of that type if the named function has a
 352   /// different type. This version of the method takes a null terminated list of
 353   /// function arguments, which makes it easier for clients to use.
 354   Constant *getOrInsertFunction(StringRef Name,
 355                                 AttributeSet AttributeList,
 356                                 Type *RetTy, ...) LLVM_END_WITH_NULL;
 357
 358   /// Same as above, but without the attributes.
 359   Constant *getOrInsertFunction(StringRef Name, Type *RetTy, ...)
 360     LLVM_END_WITH_NULL;
 361
 362   /// Look up the specified function in the module symbol table. If it does not
 363   /// exist, return null.
 364   Function *getFunction(StringRef Name) const;
 365
 366 /// @}
 367 /// @name Global Variable Accessors
 368 /// @{
 369
 370   /// Look up the specified global variable in the module symbol table. If it
 371   /// does not exist, return null. If AllowInternal is set to true, this
 372   /// function will return types that have InternalLinkage. By default, these
 373   /// types are not returned.
 374   GlobalVariable *getGlobalVariable(StringRef Name) const {
 375     return getGlobalVariable(Name, false);
 376   }
 377
 378   GlobalVariable *getGlobalVariable(StringRef Name, bool AllowInternal) const {
 379     return const_cast<Module *>(this)->getGlobalVariable(Name, AllowInternal);
 380   }
 381
 382   GlobalVariable *getGlobalVariable(StringRef Name, bool AllowInternal = false);
 383
 384   /// Return the global variable in the module with the specified name, of
 385   /// arbitrary type. This method returns null if a global with the specified
 386   /// name is not found.
 387   GlobalVariable *getNamedGlobal(StringRef Name) {
 388     return getGlobalVariable(Name, true);
 389   }
 390   const GlobalVariable *getNamedGlobal(StringRef Name) const {
 391     return const_cast<Module *>(this)->getNamedGlobal(Name);
 392   }
 393
 394   /// Look up the specified global in the module symbol table.
 395   ///   1. If it does not exist, add a declaration of the global and return it.
 396   ///   2. Else, the global exists but has the wrong type: return the function
 397   ///      with a constantexpr cast to the right type.
 398   ///   3. Finally, if the existing global is the correct declaration, return
 399   ///      the existing global.
 400   Constant *getOrInsertGlobal(StringRef Name, Type *Ty);
 401
 402 /// @}
 403 /// @name Global Alias Accessors
 404 /// @{
 405
 406   /// Return the global alias in the module with the specified name, of
 407   /// arbitrary type. This method returns null if a global with the specified
 408   /// name is not found.
 409   GlobalAlias *getNamedAlias(StringRef Name) const;
 410
 411 /// @}
 412 /// @name Named Metadata Accessors
 413 /// @{
 414
 415   /// Return the first NamedMDNode in the module with the specified name. This
 416   /// method returns null if a NamedMDNode with the specified name is not found.
 417   NamedMDNode *getNamedMetadata(const Twine &Name) const;
 418
 419   /// Return the named MDNode in the module with the specified name. This method
 420   /// returns a new NamedMDNode if a NamedMDNode with the specified name is not
 421   /// found.
 422   NamedMDNode *getOrInsertNamedMetadata(StringRef Name);
 423
 424   /// Remove the given NamedMDNode from this module and delete it.
 425   void eraseNamedMetadata(NamedMDNode *NMD);
 426
 427 /// @}
 428 /// @name Comdat Accessors
 429 /// @{
 430
 431   /// Return the Comdat in the module with the specified name. It is created
 432   /// if it didn't already exist.
 433   Comdat *getOrInsertComdat(StringRef Name);
 434
 435 /// @}
 436 /// @name Module Flags Accessors
 437 /// @{
 438
 439   /// Returns the module flags in the provided vector.
 440   void getModuleFlagsMetadata(SmallVectorImpl<ModuleFlagEntry> &Flags) const;
 441
 442   /// Return the corresponding value if Key appears in module flags, otherwise
 443   /// return null.
 444   Value *getModuleFlag(StringRef Key) const;
 445
 446   /// Returns the NamedMDNode in the module that represents module-level flags.
 447   /// This method returns null if there are no module-level flags.
 448   NamedMDNode *getModuleFlagsMetadata() const;
 449
 450   /// Returns the NamedMDNode in the module that represents module-level flags.
 451   /// If module-level flags aren't found, it creates the named metadata that
 452   /// contains them.
 453   NamedMDNode *getOrInsertModuleFlagsMetadata();
 454
 455   /// Add a module-level flag to the module-level flags metadata. It will create
 456   /// the module-level flags named metadata if it doesn't already exist.
 457   void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, Value *Val);
 458   void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, uint32_t Val);
 459   void addModuleFlag(MDNode *Node);
 460
 461 /// @}
 462 /// @name Materialization
 463 /// @{
 464
 465   /// Sets the GVMaterializer to GVM. This module must not yet have a
 466   /// Materializer. To reset the materializer for a module that already has one,
 467   /// call MaterializeAllPermanently first. Destroying this module will destroy
 468   /// its materializer without materializing any more GlobalValues. Without
 469   /// destroying the Module, there is no way to detach or destroy a materializer
 470   /// without materializing all the GVs it controls, to avoid leaving orphan
 471   /// unmaterialized GVs.
 472   void setMaterializer(GVMaterializer *GVM);
 473   /// Retrieves the GVMaterializer, if any, for this Module.
 474   GVMaterializer *getMaterializer() const { return Materializer.get(); }
 475
 476   /// Returns true if this GV was loaded from this Module's GVMaterializer and
 477   /// the GVMaterializer knows how to dematerialize the GV.
 478   bool isDematerializable(const GlobalValue *GV) const;
 479
 480   /// Make sure the GlobalValue is fully read. If the module is corrupt, this
 481   /// returns true and fills in the optional string with information about the
 482   /// problem. If successful, this returns false.
 483   std::error_code materialize(GlobalValue *GV);
 484   /// If the GlobalValue is read in, and if the GVMaterializer supports it,
 485   /// release the memory for the function, and set it up to be materialized
 486   /// lazily. If !isDematerializable(), this method is a noop.
 487   void Dematerialize(GlobalValue *GV);
 488
 489   /// Make sure all GlobalValues in this Module are fully read.
 490   std::error_code materializeAll();
 491
 492   /// Make sure all GlobalValues in this Module are fully read and clear the
 493   /// Materializer. If the module is corrupt, this DOES NOT clear the old
 494   /// Materializer.
 495   std::error_code materializeAllPermanently();
 496
 497 /// @}
 498 /// @name Direct access to the globals list, functions list, and symbol table
 499 /// @{
 500
 501   /// Get the Module's list of global variables (constant).
 502   const GlobalListType   &getGlobalList() const       { return GlobalList; }
 503   /// Get the Module's list of global variables.
 504   GlobalListType         &getGlobalList()             { return GlobalList; }
 505   static iplist<GlobalVariable> Module::*getSublistAccess(GlobalVariable*) {
 506     return &Module::GlobalList;
 507   }
 508   /// Get the Module's list of functions (constant).
 509   const FunctionListType &getFunctionList() const     { return FunctionList; }
 510   /// Get the Module's list of functions.
 511   FunctionListType       &getFunctionList()           { return FunctionList; }
 512   static iplist<Function> Module::*getSublistAccess(Function*) {
 513     return &Module::FunctionList;
 514   }
 515   /// Get the Module's list of aliases (constant).
 516   const AliasListType    &getAliasList() const        { return AliasList; }
 517   /// Get the Module's list of aliases.
 518   AliasListType          &getAliasList()              { return AliasList; }
 519   static iplist<GlobalAlias> Module::*getSublistAccess(GlobalAlias*) {
 520     return &Module::AliasList;
 521   }
 522   /// Get the Module's list of named metadata (constant).
 523   const NamedMDListType  &getNamedMDList() const      { return NamedMDList; }
 524   /// Get the Module's list of named metadata.
 525   NamedMDListType        &getNamedMDList()            { return NamedMDList; }
 526   static ilist<NamedMDNode> Module::*getSublistAccess(NamedMDNode*) {
 527     return &Module::NamedMDList;
 528   }
 529   /// Get the symbol table of global variable and function identifiers
 530   const ValueSymbolTable &getValueSymbolTable() const { return *ValSymTab; }
 531   /// Get the Module's symbol table of global variable and function identifiers.
 532   ValueSymbolTable       &getValueSymbolTable()       { return *ValSymTab; }
 533   /// Get the Module's symbol table for COMDATs (constant).
 534   const ComdatSymTabType &getComdatSymbolTable() const { return ComdatSymTab; }
 535   /// Get the Module's symbol table for COMDATs.
 536   ComdatSymTabType &getComdatSymbolTable() { return ComdatSymTab; }
 537
 538 /// @}
 539 /// @name Global Variable Iteration
 540 /// @{
 541
 542   global_iterator       global_begin()       { return GlobalList.begin(); }
 543   const_global_iterator global_begin() const { return GlobalList.begin(); }
 544   global_iterator       global_end  ()       { return GlobalList.end(); }
 545   const_global_iterator global_end  () const { return GlobalList.end(); }
 546   bool                  global_empty() const { return GlobalList.empty(); }
 547
 548   iterator_range<global_iterator> globals() {
 549     return iterator_range<global_iterator>(global_begin(), global_end());
 550   }
 551   iterator_range<const_global_iterator> globals() const {
 552     return iterator_range<const_global_iterator>(global_begin(), global_end());
 553   }
 554
 555 /// @}
 556 /// @name Function Iteration
 557 /// @{
 558
 559   iterator                begin()       { return FunctionList.begin(); }
 560   const_iterator          begin() const { return FunctionList.begin(); }
 561   iterator                end  ()       { return FunctionList.end();   }
 562   const_iterator          end  () const { return FunctionList.end();   }
 563   reverse_iterator        rbegin()      { return FunctionList.rbegin(); }
 564   const_reverse_iterator  rbegin() const{ return FunctionList.rbegin(); }
 565   reverse_iterator        rend()        { return FunctionList.rend(); }
 566   const_reverse_iterator  rend() const  { return FunctionList.rend(); }
 567   size_t                  size() const  { return FunctionList.size(); }
 568   bool                    empty() const { return FunctionList.empty(); }
 569
 570   iterator_range<iterator> functions() {
 571     return iterator_range<iterator>(begin(), end());
 572   }
 573   iterator_range<const_iterator> functions() const {
 574     return iterator_range<const_iterator>(begin(), end());
 575   }
 576
 577 /// @}
 578 /// @name Alias Iteration
 579 /// @{
 580
 581   alias_iterator       alias_begin()            { return AliasList.begin(); }
 582   const_alias_iterator alias_begin() const      { return AliasList.begin(); }
 583   alias_iterator       alias_end  ()            { return AliasList.end();   }
 584   const_alias_iterator alias_end  () const      { return AliasList.end();   }
 585   size_t               alias_size () const      { return AliasList.size();  }
 586   bool                 alias_empty() const      { return AliasList.empty(); }
 587
 588   iterator_range<alias_iterator> aliases() {
 589     return iterator_range<alias_iterator>(alias_begin(), alias_end());
 590   }
 591   iterator_range<const_alias_iterator> aliases() const {
 592     return iterator_range<const_alias_iterator>(alias_begin(), alias_end());
 593   }
 594
 595 /// @}
 596 /// @name Named Metadata Iteration
 597 /// @{
 598
 599   named_metadata_iterator named_metadata_begin() { return NamedMDList.begin(); }
 600   const_named_metadata_iterator named_metadata_begin() const {
 601     return NamedMDList.begin();
 602   }
 603
 604   named_metadata_iterator named_metadata_end() { return NamedMDList.end(); }
 605   const_named_metadata_iterator named_metadata_end() const {
 606     return NamedMDList.end();
 607   }
 608
 609   size_t named_metadata_size() const { return NamedMDList.size();  }
 610   bool named_metadata_empty() const { return NamedMDList.empty(); }
 611
 612   iterator_range<named_metadata_iterator> named_metadata() {
 613     return iterator_range<named_metadata_iterator>(named_metadata_begin(),
 614                                                    named_metadata_end());
 615   }
 616   iterator_range<const_named_metadata_iterator> named_metadata() const {
 617     return iterator_range<const_named_metadata_iterator>(named_metadata_begin(),
 618                                                          named_metadata_end());
 619   }
 620
 621 /// @}
 622 /// @name Utility functions for printing and dumping Module objects
 623 /// @{
 624
 625   /// Print the module to an output stream with an optional
 626   /// AssemblyAnnotationWriter.
 627   void print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const;
 628
 629   /// Dump the module to stderr (for debugging).
 630   void dump() const;
 631
 632   /// This function causes all the subinstructions to "let go" of all references
 633   /// that they are maintaining.  This allows one to 'delete' a whole class at
 634   /// a time, even though there may be circular references... first all
 635   /// references are dropped, and all use counts go to zero.  Then everything
 636   /// is delete'd for real.  Note that no operations are valid on an object
 637   /// that has "dropped all references", except operator delete.
 638   void dropAllReferences();
 639
 640 /// @}
 641 /// @name Utility functions for querying Debug information.
 642 /// @{
 643
 644   /// \brief Returns the Dwarf Version by checking module flags.
 645   unsigned getDwarfVersion() const;
 646
 647 /// @}
 648 /// @name Utility functions for querying and setting PIC level
 649 /// @{
 650
 651   /// \brief Returns the PIC level (small or large model)
 652   PICLevel::Level getPICLevel() const;
 653
 654   /// \brief Set the PIC level (small or large model)
 655   void setPICLevel(PICLevel::Level PL);
 656 /// @}
 657 };
 658
 659 /// An raw_ostream inserter for modules.
 660 inline raw_ostream &operator<<(raw_ostream &O, const Module &M) {
 661   M.print(O, nullptr);
 662   return O;
 663 }
 664
 665 // Create wrappers for C Binding types (see CBindingWrapping.h).
 666 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef)
 667
 668 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
 669  * Module.
 670  */
 671 inline Module *unwrap(LLVMModuleProviderRef MP) {
 672   return reinterpret_cast<Module*>(MP);
 673 }
 674
 675 } // End llvm namespace
 676
 677 #endif