contrib/llvm/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-c/Types.h"
  19 #include "llvm/ADT/Optional.h"
  20 #include "llvm/ADT/STLExtras.h"
  21 #include "llvm/ADT/StringMap.h"
  22 #include "llvm/ADT/StringRef.h"
  23 #include "llvm/ADT/iterator_range.h"
  24 #include "llvm/IR/Attributes.h"
  25 #include "llvm/IR/Comdat.h"
  26 #include "llvm/IR/DataLayout.h"
  27 #include "llvm/IR/Function.h"
  28 #include "llvm/IR/GlobalAlias.h"
  29 #include "llvm/IR/GlobalIFunc.h"
  30 #include "llvm/IR/GlobalVariable.h"
  31 #include "llvm/IR/Metadata.h"
  32 #include "llvm/IR/SymbolTableListTraits.h"
  33 #include "llvm/Support/CBindingWrapping.h"
  34 #include "llvm/Support/CodeGen.h"
  35 #include <cstddef>
  36 #include <cstdint>
  37 #include <iterator>
  38 #include <memory>
  39 #include <string>
  40 #include <vector>
  41
  42 namespace llvm {
  43
  44 class Error;
  45 class FunctionType;
  46 class GVMaterializer;
  47 class LLVMContext;
  48 class MemoryBuffer;
  49 class RandomNumberGenerator;
  50 template <class PtrType> class SmallPtrSetImpl;
  51 class StructType;
  52 class VersionTuple;
  53
  54 /// A Module instance is used to store all the information related to an
  55 /// LLVM module. Modules are the top level container of all other LLVM
  56 /// Intermediate Representation (IR) objects. Each module directly contains a
  57 /// list of globals variables, a list of functions, a list of libraries (or
  58 /// other modules) this module depends on, a symbol table, and various data
  59 /// about the target's characteristics.
  60 ///
  61 /// A module maintains a GlobalValRefMap object that is used to hold all
  62 /// constant references to global variables in the module.  When a global
  63 /// variable is destroyed, it should have no entries in the GlobalValueRefMap.
  64 /// The main container class for the LLVM Intermediate Representation.
  65 class Module {
  66 /// @name Types And Enumerations
  67 /// @{
  68 public:
  69   /// The type for the list of global variables.
  70   using GlobalListType = SymbolTableList<GlobalVariable>;
  71   /// The type for the list of functions.
  72   using FunctionListType = SymbolTableList<Function>;
  73   /// The type for the list of aliases.
  74   using AliasListType = SymbolTableList<GlobalAlias>;
  75   /// The type for the list of ifuncs.
  76   using IFuncListType = SymbolTableList<GlobalIFunc>;
  77   /// The type for the list of named metadata.
  78   using NamedMDListType = ilist<NamedMDNode>;
  79   /// The type of the comdat "symbol" table.
  80   using ComdatSymTabType = StringMap<Comdat>;
  81
  82   /// The Global Variable iterator.
  83   using global_iterator = GlobalListType::iterator;
  84   /// The Global Variable constant iterator.
  85   using const_global_iterator = GlobalListType::const_iterator;
  86
  87   /// The Function iterators.
  88   using iterator = FunctionListType::iterator;
  89   /// The Function constant iterator
  90   using const_iterator = FunctionListType::const_iterator;
  91
  92   /// The Function reverse iterator.
  93   using reverse_iterator = FunctionListType::reverse_iterator;
  94   /// The Function constant reverse iterator.
  95   using const_reverse_iterator = FunctionListType::const_reverse_iterator;
  96
  97   /// The Global Alias iterators.
  98   using alias_iterator = AliasListType::iterator;
  99   /// The Global Alias constant iterator
 100   using const_alias_iterator = AliasListType::const_iterator;
 101
 102   /// The Global IFunc iterators.
 103   using ifunc_iterator = IFuncListType::iterator;
 104   /// The Global IFunc constant iterator
 105   using const_ifunc_iterator = IFuncListType::const_iterator;
 106
 107   /// The named metadata iterators.
 108   using named_metadata_iterator = NamedMDListType::iterator;
 109   /// The named metadata constant iterators.
 110   using const_named_metadata_iterator = NamedMDListType::const_iterator;
 111
 112   /// This enumeration defines the supported behaviors of module flags.
 113   enum ModFlagBehavior {
 114     /// Emits an error if two values disagree, otherwise the resulting value is
 115     /// that of the operands.
 116     Error = 1,
 117
 118     /// Emits a warning if two values disagree. The result value will be the
 119     /// operand for the flag from the first module being linked.
 120     Warning = 2,
 121
 122     /// Adds a requirement that another module flag be present and have a
 123     /// specified value after linking is performed. The value must be a metadata
 124     /// pair, where the first element of the pair is the ID of the module flag
 125     /// to be restricted, and the second element of the pair is the value the
 126     /// module flag should be restricted to. This behavior can be used to
 127     /// restrict the allowable results (via triggering of an error) of linking
 128     /// IDs with the **Override** behavior.
 129     Require = 3,
 130
 131     /// Uses the specified value, regardless of the behavior or value of the
 132     /// other module. If both modules specify **Override**, but the values
 133     /// differ, an error will be emitted.
 134     Override = 4,
 135
 136     /// Appends the two values, which are required to be metadata nodes.
 137     Append = 5,
 138
 139     /// Appends the two values, which are required to be metadata
 140     /// nodes. However, duplicate entries in the second list are dropped
 141     /// during the append operation.
 142     AppendUnique = 6,
 143
 144     /// Takes the max of the two values, which are required to be integers.
 145     Max = 7,
 146
 147     // Markers:
 148     ModFlagBehaviorFirstVal = Error,
 149     ModFlagBehaviorLastVal = Max
 150   };
 151
 152   /// Checks if Metadata represents a valid ModFlagBehavior, and stores the
 153   /// converted result in MFB.
 154   static bool isValidModFlagBehavior(Metadata *MD, ModFlagBehavior &MFB);
 155
 156   struct ModuleFlagEntry {
 157     ModFlagBehavior Behavior;
 158     MDString *Key;
 159     Metadata *Val;
 160
 161     ModuleFlagEntry(ModFlagBehavior B, MDString *K, Metadata *V)
 162         : Behavior(B), Key(K), Val(V) {}
 163   };
 164
 165 /// @}
 166 /// @name Member Variables
 167 /// @{
 168 private:
 169   LLVMContext &Context;           ///< The LLVMContext from which types and
 170                                   ///< constants are allocated.
 171   GlobalListType GlobalList;      ///< The Global Variables in the module
 172   FunctionListType FunctionList;  ///< The Functions in the module
 173   AliasListType AliasList;        ///< The Aliases in the module
 174   IFuncListType IFuncList;        ///< The IFuncs in the module
 175   NamedMDListType NamedMDList;    ///< The named metadata in the module
 176   std::string GlobalScopeAsm;     ///< Inline Asm at global scope.
 177   ValueSymbolTable *ValSymTab;    ///< Symbol table for values
 178   ComdatSymTabType ComdatSymTab;  ///< Symbol table for COMDATs
 179   std::unique_ptr<MemoryBuffer>
 180   OwnedMemoryBuffer;              ///< Memory buffer directly owned by this
 181                                   ///< module, for legacy clients only.
 182   std::unique_ptr<GVMaterializer>
 183   Materializer;                   ///< Used to materialize GlobalValues
 184   std::string ModuleID;           ///< Human readable identifier for the module
 185   std::string SourceFileName;     ///< Original source file name for module,
 186                                   ///< recorded in bitcode.
 187   std::string TargetTriple;       ///< Platform target triple Module compiled on
 188                                   ///< Format: (arch)(sub)-(vendor)-(sys0-(abi)
 189   void *NamedMDSymTab;            ///< NamedMDNode names.
 190   DataLayout DL;                  ///< DataLayout associated with the module
 191
 192   friend class Constant;
 193
 194 /// @}
 195 /// @name Constructors
 196 /// @{
 197 public:
 198   /// The Module constructor. Note that there is no default constructor. You
 199   /// must provide a name for the module upon construction.
 200   explicit Module(StringRef ModuleID, LLVMContext& C);
 201   /// The module destructor. This will dropAllReferences.
 202   ~Module();
 203
 204 /// @}
 205 /// @name Module Level Accessors
 206 /// @{
 207
 208   /// Get the module identifier which is, essentially, the name of the module.
 209   /// @returns the module identifier as a string
 210   const std::string &getModuleIdentifier() const { return ModuleID; }
 211
 212   /// Returns the number of non-debug IR instructions in the module.
 213   /// This is equivalent to the sum of the IR instruction counts of each
 214   /// function contained in the module.
 215   unsigned getInstructionCount();
 216
 217   /// Get the module's original source file name. When compiling from
 218   /// bitcode, this is taken from a bitcode record where it was recorded.
 219   /// For other compiles it is the same as the ModuleID, which would
 220   /// contain the source file name.
 221   const std::string &getSourceFileName() const { return SourceFileName; }
 222
 223   /// Get a short "name" for the module.
 224   ///
 225   /// This is useful for debugging or logging. It is essentially a convenience
 226   /// wrapper around getModuleIdentifier().
 227   StringRef getName() const { return ModuleID; }
 228
 229   /// Get the data layout string for the module's target platform. This is
 230   /// equivalent to getDataLayout()->getStringRepresentation().
 231   const std::string &getDataLayoutStr() const {
 232     return DL.getStringRepresentation();
 233   }
 234
 235   /// Get the data layout for the module's target platform.
 236   const DataLayout &getDataLayout() const;
 237
 238   /// Get the target triple which is a string describing the target host.
 239   /// @returns a string containing the target triple.
 240   const std::string &getTargetTriple() const { return TargetTriple; }
 241
 242   /// Get the global data context.
 243   /// @returns LLVMContext - a container for LLVM's global information
 244   LLVMContext &getContext() const { return Context; }
 245
 246   /// Get any module-scope inline assembly blocks.
 247   /// @returns a string containing the module-scope inline assembly blocks.
 248   const std::string &getModuleInlineAsm() const { return GlobalScopeAsm; }
 249
 250   /// Get a RandomNumberGenerator salted for use with this module. The
 251   /// RNG can be seeded via -rng-seed=<uint64> and is salted with the
 252   /// ModuleID and the provided pass salt. The returned RNG should not
 253   /// be shared across threads or passes.
 254   ///
 255   /// A unique RNG per pass ensures a reproducible random stream even
 256   /// when other randomness consuming passes are added or removed. In
 257   /// addition, the random stream will be reproducible across LLVM
 258   /// versions when the pass does not change.
 259   std::unique_ptr<RandomNumberGenerator> createRNG(const Pass* P) const;
 260
 261   /// Return true if size-info optimization remark is enabled, false
 262   /// otherwise.
 263   bool shouldEmitInstrCountChangedRemark() {
 264     return getContext().getDiagHandlerPtr()->isAnalysisRemarkEnabled(
 265         "size-info");
 266   }
 267
 268   /// @}
 269   /// @name Module Level Mutators
 270   /// @{
 271
 272   /// Set the module identifier.
 273   void setModuleIdentifier(StringRef ID) { ModuleID = ID; }
 274
 275   /// Set the module's original source file name.
 276   void setSourceFileName(StringRef Name) { SourceFileName = Name; }
 277
 278   /// Set the data layout
 279   void setDataLayout(StringRef Desc);
 280   void setDataLayout(const DataLayout &Other);
 281
 282   /// Set the target triple.
 283   void setTargetTriple(StringRef T) { TargetTriple = T; }
 284
 285   /// Set the module-scope inline assembly blocks.
 286   /// A trailing newline is added if the input doesn't have one.
 287   void setModuleInlineAsm(StringRef Asm) {
 288     GlobalScopeAsm = Asm;
 289     if (!GlobalScopeAsm.empty() && GlobalScopeAsm.back() != '\n')
 290       GlobalScopeAsm += '\n';
 291   }
 292
 293   /// Append to the module-scope inline assembly blocks.
 294   /// A trailing newline is added if the input doesn't have one.
 295   void appendModuleInlineAsm(StringRef Asm) {
 296     GlobalScopeAsm += Asm;
 297     if (!GlobalScopeAsm.empty() && GlobalScopeAsm.back() != '\n')
 298       GlobalScopeAsm += '\n';
 299   }
 300
 301 /// @}
 302 /// @name Generic Value Accessors
 303 /// @{
 304
 305   /// Return the global value in the module with the specified name, of
 306   /// arbitrary type. This method returns null if a global with the specified
 307   /// name is not found.
 308   GlobalValue *getNamedValue(StringRef Name) const;
 309
 310   /// Return a unique non-zero ID for the specified metadata kind. This ID is
 311   /// uniqued across modules in the current LLVMContext.
 312   unsigned getMDKindID(StringRef Name) const;
 313
 314   /// Populate client supplied SmallVector with the name for custom metadata IDs
 315   /// registered in this LLVMContext.
 316   void getMDKindNames(SmallVectorImpl<StringRef> &Result) const;
 317
 318   /// Populate client supplied SmallVector with the bundle tags registered in
 319   /// this LLVMContext.  The bundle tags are ordered by increasing bundle IDs.
 320   /// \see LLVMContext::getOperandBundleTagID
 321   void getOperandBundleTags(SmallVectorImpl<StringRef> &Result) const;
 322
 323   /// Return the type with the specified name, or null if there is none by that
 324   /// name.
 325   StructType *getTypeByName(StringRef Name) const;
 326
 327   std::vector<StructType *> getIdentifiedStructTypes() const;
 328
 329 /// @}
 330 /// @name Function Accessors
 331 /// @{
 332
 333   /// Look up the specified function in the module symbol table. Four
 334   /// possibilities:
 335   ///   1. If it does not exist, add a prototype for the function and return it.
 336   ///   2. If it exists, and has a local linkage, the existing function is
 337   ///      renamed and a new one is inserted.
 338   ///   3. Otherwise, if the existing function has the correct prototype, return
 339   ///      the existing function.
 340   ///   4. Finally, the function exists but has the wrong prototype: return the
 341   ///      function with a constantexpr cast to the right prototype.
 342   Constant *getOrInsertFunction(StringRef Name, FunctionType *T,
 343                                 AttributeList AttributeList);
 344
 345   Constant *getOrInsertFunction(StringRef Name, FunctionType *T);
 346
 347   /// Look up the specified function in the module symbol table. If it does not
 348   /// exist, add a prototype for the function and return it. This function
 349   /// guarantees to return a constant of pointer to the specified function type
 350   /// or a ConstantExpr BitCast of that type if the named function has a
 351   /// different type. This version of the method takes a list of
 352   /// function arguments, which makes it easier for clients to use.
 353   template<typename... ArgsTy>
 354   Constant *getOrInsertFunction(StringRef Name,
 355                                 AttributeList AttributeList,
 356                                 Type *RetTy, ArgsTy... Args)
 357   {
 358     SmallVector<Type*, sizeof...(ArgsTy)> ArgTys{Args...};
 359     return getOrInsertFunction(Name,
 360                                FunctionType::get(RetTy, ArgTys, false),
 361                                AttributeList);
 362   }
 363
 364   /// Same as above, but without the attributes.
 365   template<typename... ArgsTy>
 366   Constant *getOrInsertFunction(StringRef Name, Type *RetTy, ArgsTy... Args) {
 367     return getOrInsertFunction(Name, AttributeList{}, RetTy, Args...);
 368   }
 369
 370   // Avoid an incorrect ordering that'd otherwise compile incorrectly.
 371   template <typename... ArgsTy>
 372   Constant *getOrInsertFunction(StringRef Name, AttributeList AttributeList,
 373                                 FunctionType *Invalid, ArgsTy... Args) = delete;
 374
 375   /// Look up the specified function in the module symbol table. If it does not
 376   /// exist, return null.
 377   Function *getFunction(StringRef Name) const;
 378
 379 /// @}
 380 /// @name Global Variable Accessors
 381 /// @{
 382
 383   /// Look up the specified global variable in the module symbol table. If it
 384   /// does not exist, return null. If AllowInternal is set to true, this
 385   /// function will return types that have InternalLinkage. By default, these
 386   /// types are not returned.
 387   GlobalVariable *getGlobalVariable(StringRef Name) const {
 388     return getGlobalVariable(Name, false);
 389   }
 390
 391   GlobalVariable *getGlobalVariable(StringRef Name, bool AllowInternal) const;
 392
 393   GlobalVariable *getGlobalVariable(StringRef Name,
 394                                     bool AllowInternal = false) {
 395     return static_cast<const Module *>(this)->getGlobalVariable(Name,
 396                                                                 AllowInternal);
 397   }
 398
 399   /// Return the global variable in the module with the specified name, of
 400   /// arbitrary type. This method returns null if a global with the specified
 401   /// name is not found.
 402   const GlobalVariable *getNamedGlobal(StringRef Name) const {
 403     return getGlobalVariable(Name, true);
 404   }
 405   GlobalVariable *getNamedGlobal(StringRef Name) {
 406     return const_cast<GlobalVariable *>(
 407                        static_cast<const Module *>(this)->getNamedGlobal(Name));
 408   }
 409
 410   /// Look up the specified global in the module symbol table.
 411   /// If it does not exist, invoke a callback to create a declaration of the
 412   /// global and return it. The global is constantexpr casted to the expected
 413   /// type if necessary.
 414   Constant *
 415   getOrInsertGlobal(StringRef Name, Type *Ty,
 416                     function_ref<GlobalVariable *()> CreateGlobalCallback);
 417
 418   /// Look up the specified global in the module symbol table. If required, this
 419   /// overload constructs the global variable using its constructor's defaults.
 420   Constant *getOrInsertGlobal(StringRef Name, Type *Ty);
 421
 422 /// @}
 423 /// @name Global Alias Accessors
 424 /// @{
 425
 426   /// Return the global alias in the module with the specified name, of
 427   /// arbitrary type. This method returns null if a global with the specified
 428   /// name is not found.
 429   GlobalAlias *getNamedAlias(StringRef Name) const;
 430
 431 /// @}
 432 /// @name Global IFunc Accessors
 433 /// @{
 434
 435   /// Return the global ifunc in the module with the specified name, of
 436   /// arbitrary type. This method returns null if a global with the specified
 437   /// name is not found.
 438   GlobalIFunc *getNamedIFunc(StringRef Name) const;
 439
 440 /// @}
 441 /// @name Named Metadata Accessors
 442 /// @{
 443
 444   /// Return the first NamedMDNode in the module with the specified name. This
 445   /// method returns null if a NamedMDNode with the specified name is not found.
 446   NamedMDNode *getNamedMetadata(const Twine &Name) const;
 447
 448   /// Return the named MDNode in the module with the specified name. This method
 449   /// returns a new NamedMDNode if a NamedMDNode with the specified name is not
 450   /// found.
 451   NamedMDNode *getOrInsertNamedMetadata(StringRef Name);
 452
 453   /// Remove the given NamedMDNode from this module and delete it.
 454   void eraseNamedMetadata(NamedMDNode *NMD);
 455
 456 /// @}
 457 /// @name Comdat Accessors
 458 /// @{
 459
 460   /// Return the Comdat in the module with the specified name. It is created
 461   /// if it didn't already exist.
 462   Comdat *getOrInsertComdat(StringRef Name);
 463
 464 /// @}
 465 /// @name Module Flags Accessors
 466 /// @{
 467
 468   /// Returns the module flags in the provided vector.
 469   void getModuleFlagsMetadata(SmallVectorImpl<ModuleFlagEntry> &Flags) const;
 470
 471   /// Return the corresponding value if Key appears in module flags, otherwise
 472   /// return null.
 473   Metadata *getModuleFlag(StringRef Key) const;
 474
 475   /// Returns the NamedMDNode in the module that represents module-level flags.
 476   /// This method returns null if there are no module-level flags.
 477   NamedMDNode *getModuleFlagsMetadata() const;
 478
 479   /// Returns the NamedMDNode in the module that represents module-level flags.
 480   /// If module-level flags aren't found, it creates the named metadata that
 481   /// contains them.
 482   NamedMDNode *getOrInsertModuleFlagsMetadata();
 483
 484   /// Add a module-level flag to the module-level flags metadata. It will create
 485   /// the module-level flags named metadata if it doesn't already exist.
 486   void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, Metadata *Val);
 487   void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, Constant *Val);
 488   void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, uint32_t Val);
 489   void addModuleFlag(MDNode *Node);
 490
 491 /// @}
 492 /// @name Materialization
 493 /// @{
 494
 495   /// Sets the GVMaterializer to GVM. This module must not yet have a
 496   /// Materializer. To reset the materializer for a module that already has one,
 497   /// call materializeAll first. Destroying this module will destroy
 498   /// its materializer without materializing any more GlobalValues. Without
 499   /// destroying the Module, there is no way to detach or destroy a materializer
 500   /// without materializing all the GVs it controls, to avoid leaving orphan
 501   /// unmaterialized GVs.
 502   void setMaterializer(GVMaterializer *GVM);
 503   /// Retrieves the GVMaterializer, if any, for this Module.
 504   GVMaterializer *getMaterializer() const { return Materializer.get(); }
 505   bool isMaterialized() const { return !getMaterializer(); }
 506
 507   /// Make sure the GlobalValue is fully read.
 508   llvm::Error materialize(GlobalValue *GV);
 509
 510   /// Make sure all GlobalValues in this Module are fully read and clear the
 511   /// Materializer.
 512   llvm::Error materializeAll();
 513
 514   llvm::Error materializeMetadata();
 515
 516 /// @}
 517 /// @name Direct access to the globals list, functions list, and symbol table
 518 /// @{
 519
 520   /// Get the Module's list of global variables (constant).
 521   const GlobalListType   &getGlobalList() const       { return GlobalList; }
 522   /// Get the Module's list of global variables.
 523   GlobalListType         &getGlobalList()             { return GlobalList; }
 524
 525   static GlobalListType Module::*getSublistAccess(GlobalVariable*) {
 526     return &Module::GlobalList;
 527   }
 528
 529   /// Get the Module's list of functions (constant).
 530   const FunctionListType &getFunctionList() const     { return FunctionList; }
 531   /// Get the Module's list of functions.
 532   FunctionListType       &getFunctionList()           { return FunctionList; }
 533   static FunctionListType Module::*getSublistAccess(Function*) {
 534     return &Module::FunctionList;
 535   }
 536
 537   /// Get the Module's list of aliases (constant).
 538   const AliasListType    &getAliasList() const        { return AliasList; }
 539   /// Get the Module's list of aliases.
 540   AliasListType          &getAliasList()              { return AliasList; }
 541
 542   static AliasListType Module::*getSublistAccess(GlobalAlias*) {
 543     return &Module::AliasList;
 544   }
 545
 546   /// Get the Module's list of ifuncs (constant).
 547   const IFuncListType    &getIFuncList() const        { return IFuncList; }
 548   /// Get the Module's list of ifuncs.
 549   IFuncListType          &getIFuncList()              { return IFuncList; }
 550
 551   static IFuncListType Module::*getSublistAccess(GlobalIFunc*) {
 552     return &Module::IFuncList;
 553   }
 554
 555   /// Get the Module's list of named metadata (constant).
 556   const NamedMDListType  &getNamedMDList() const      { return NamedMDList; }
 557   /// Get the Module's list of named metadata.
 558   NamedMDListType        &getNamedMDList()            { return NamedMDList; }
 559
 560   static NamedMDListType Module::*getSublistAccess(NamedMDNode*) {
 561     return &Module::NamedMDList;
 562   }
 563
 564   /// Get the symbol table of global variable and function identifiers
 565   const ValueSymbolTable &getValueSymbolTable() const { return *ValSymTab; }
 566   /// Get the Module's symbol table of global variable and function identifiers.
 567   ValueSymbolTable       &getValueSymbolTable()       { return *ValSymTab; }
 568
 569   /// Get the Module's symbol table for COMDATs (constant).
 570   const ComdatSymTabType &getComdatSymbolTable() const { return ComdatSymTab; }
 571   /// Get the Module's symbol table for COMDATs.
 572   ComdatSymTabType &getComdatSymbolTable() { return ComdatSymTab; }
 573
 574 /// @}
 575 /// @name Global Variable Iteration
 576 /// @{
 577
 578   global_iterator       global_begin()       { return GlobalList.begin(); }
 579   const_global_iterator global_begin() const { return GlobalList.begin(); }
 580   global_iterator       global_end  ()       { return GlobalList.end(); }
 581   const_global_iterator global_end  () const { return GlobalList.end(); }
 582   bool                  global_empty() const { return GlobalList.empty(); }
 583
 584   iterator_range<global_iterator> globals() {
 585     return make_range(global_begin(), global_end());
 586   }
 587   iterator_range<const_global_iterator> globals() const {
 588     return make_range(global_begin(), global_end());
 589   }
 590
 591 /// @}
 592 /// @name Function Iteration
 593 /// @{
 594
 595   iterator                begin()       { return FunctionList.begin(); }
 596   const_iterator          begin() const { return FunctionList.begin(); }
 597   iterator                end  ()       { return FunctionList.end();   }
 598   const_iterator          end  () const { return FunctionList.end();   }
 599   reverse_iterator        rbegin()      { return FunctionList.rbegin(); }
 600   const_reverse_iterator  rbegin() const{ return FunctionList.rbegin(); }
 601   reverse_iterator        rend()        { return FunctionList.rend(); }
 602   const_reverse_iterator  rend() const  { return FunctionList.rend(); }
 603   size_t                  size() const  { return FunctionList.size(); }
 604   bool                    empty() const { return FunctionList.empty(); }
 605
 606   iterator_range<iterator> functions() {
 607     return make_range(begin(), end());
 608   }
 609   iterator_range<const_iterator> functions() const {
 610     return make_range(begin(), end());
 611   }
 612
 613 /// @}
 614 /// @name Alias Iteration
 615 /// @{
 616
 617   alias_iterator       alias_begin()            { return AliasList.begin(); }
 618   const_alias_iterator alias_begin() const      { return AliasList.begin(); }
 619   alias_iterator       alias_end  ()            { return AliasList.end();   }
 620   const_alias_iterator alias_end  () const      { return AliasList.end();   }
 621   size_t               alias_size () const      { return AliasList.size();  }
 622   bool                 alias_empty() const      { return AliasList.empty(); }
 623
 624   iterator_range<alias_iterator> aliases() {
 625     return make_range(alias_begin(), alias_end());
 626   }
 627   iterator_range<const_alias_iterator> aliases() const {
 628     return make_range(alias_begin(), alias_end());
 629   }
 630
 631 /// @}
 632 /// @name IFunc Iteration
 633 /// @{
 634
 635   ifunc_iterator       ifunc_begin()            { return IFuncList.begin(); }
 636   const_ifunc_iterator ifunc_begin() const      { return IFuncList.begin(); }
 637   ifunc_iterator       ifunc_end  ()            { return IFuncList.end();   }
 638   const_ifunc_iterator ifunc_end  () const      { return IFuncList.end();   }
 639   size_t               ifunc_size () const      { return IFuncList.size();  }
 640   bool                 ifunc_empty() const      { return IFuncList.empty(); }
 641
 642   iterator_range<ifunc_iterator> ifuncs() {
 643     return make_range(ifunc_begin(), ifunc_end());
 644   }
 645   iterator_range<const_ifunc_iterator> ifuncs() const {
 646     return make_range(ifunc_begin(), ifunc_end());
 647   }
 648
 649   /// @}
 650   /// @name Convenience iterators
 651   /// @{
 652
 653   using global_object_iterator =
 654       concat_iterator<GlobalObject, iterator, global_iterator>;
 655   using const_global_object_iterator =
 656       concat_iterator<const GlobalObject, const_iterator,
 657                       const_global_iterator>;
 658
 659   iterator_range<global_object_iterator> global_objects() {
 660     return concat<GlobalObject>(functions(), globals());
 661   }
 662   iterator_range<const_global_object_iterator> global_objects() const {
 663     return concat<const GlobalObject>(functions(), globals());
 664   }
 665
 666   global_object_iterator global_object_begin() {
 667     return global_objects().begin();
 668   }
 669   global_object_iterator global_object_end() { return global_objects().end(); }
 670
 671   const_global_object_iterator global_object_begin() const {
 672     return global_objects().begin();
 673   }
 674   const_global_object_iterator global_object_end() const {
 675     return global_objects().end();
 676   }
 677
 678   using global_value_iterator =
 679       concat_iterator<GlobalValue, iterator, global_iterator, alias_iterator,
 680                       ifunc_iterator>;
 681   using const_global_value_iterator =
 682       concat_iterator<const GlobalValue, const_iterator, const_global_iterator,
 683                       const_alias_iterator, const_ifunc_iterator>;
 684
 685   iterator_range<global_value_iterator> global_values() {
 686     return concat<GlobalValue>(functions(), globals(), aliases(), ifuncs());
 687   }
 688   iterator_range<const_global_value_iterator> global_values() const {
 689     return concat<const GlobalValue>(functions(), globals(), aliases(),
 690                                      ifuncs());
 691   }
 692
 693   global_value_iterator global_value_begin() { return global_values().begin(); }
 694   global_value_iterator global_value_end() { return global_values().end(); }
 695
 696   const_global_value_iterator global_value_begin() const {
 697     return global_values().begin();
 698   }
 699   const_global_value_iterator global_value_end() const {
 700     return global_values().end();
 701   }
 702
 703   /// @}
 704   /// @name Named Metadata Iteration
 705   /// @{
 706
 707   named_metadata_iterator named_metadata_begin() { return NamedMDList.begin(); }
 708   const_named_metadata_iterator named_metadata_begin() const {
 709     return NamedMDList.begin();
 710   }
 711
 712   named_metadata_iterator named_metadata_end() { return NamedMDList.end(); }
 713   const_named_metadata_iterator named_metadata_end() const {
 714     return NamedMDList.end();
 715   }
 716
 717   size_t named_metadata_size() const { return NamedMDList.size();  }
 718   bool named_metadata_empty() const { return NamedMDList.empty(); }
 719
 720   iterator_range<named_metadata_iterator> named_metadata() {
 721     return make_range(named_metadata_begin(), named_metadata_end());
 722   }
 723   iterator_range<const_named_metadata_iterator> named_metadata() const {
 724     return make_range(named_metadata_begin(), named_metadata_end());
 725   }
 726
 727   /// An iterator for DICompileUnits that skips those marked NoDebug.
 728   class debug_compile_units_iterator
 729       : public std::iterator<std::input_iterator_tag, DICompileUnit *> {
 730     NamedMDNode *CUs;
 731     unsigned Idx;
 732
 733     void SkipNoDebugCUs();
 734
 735   public:
 736     explicit debug_compile_units_iterator(NamedMDNode *CUs, unsigned Idx)
 737         : CUs(CUs), Idx(Idx) {
 738       SkipNoDebugCUs();
 739     }
 740
 741     debug_compile_units_iterator &operator++() {
 742       ++Idx;
 743       SkipNoDebugCUs();
 744       return *this;
 745     }
 746
 747     debug_compile_units_iterator operator++(int) {
 748       debug_compile_units_iterator T(*this);
 749       ++Idx;
 750       return T;
 751     }
 752
 753     bool operator==(const debug_compile_units_iterator &I) const {
 754       return Idx == I.Idx;
 755     }
 756
 757     bool operator!=(const debug_compile_units_iterator &I) const {
 758       return Idx != I.Idx;
 759     }
 760
 761     DICompileUnit *operator*() const;
 762     DICompileUnit *operator->() const;
 763   };
 764
 765   debug_compile_units_iterator debug_compile_units_begin() const {
 766     auto *CUs = getNamedMetadata("llvm.dbg.cu");
 767     return debug_compile_units_iterator(CUs, 0);
 768   }
 769
 770   debug_compile_units_iterator debug_compile_units_end() const {
 771     auto *CUs = getNamedMetadata("llvm.dbg.cu");
 772     return debug_compile_units_iterator(CUs, CUs ? CUs->getNumOperands() : 0);
 773   }
 774
 775   /// Return an iterator for all DICompileUnits listed in this Module's
 776   /// llvm.dbg.cu named metadata node and aren't explicitly marked as
 777   /// NoDebug.
 778   iterator_range<debug_compile_units_iterator> debug_compile_units() const {
 779     auto *CUs = getNamedMetadata("llvm.dbg.cu");
 780     return make_range(
 781         debug_compile_units_iterator(CUs, 0),
 782         debug_compile_units_iterator(CUs, CUs ? CUs->getNumOperands() : 0));
 783   }
 784 /// @}
 785
 786   /// Destroy ConstantArrays in LLVMContext if they are not used.
 787   /// ConstantArrays constructed during linking can cause quadratic memory
 788   /// explosion. Releasing all unused constants can cause a 20% LTO compile-time
 789   /// slowdown for a large application.
 790   ///
 791   /// NOTE: Constants are currently owned by LLVMContext. This can then only
 792   /// be called where all uses of the LLVMContext are understood.
 793   void dropTriviallyDeadConstantArrays();
 794
 795 /// @name Utility functions for printing and dumping Module objects
 796 /// @{
 797
 798   /// Print the module to an output stream with an optional
 799   /// AssemblyAnnotationWriter.  If \c ShouldPreserveUseListOrder, then include
 800   /// uselistorder directives so that use-lists can be recreated when reading
 801   /// the assembly.
 802   void print(raw_ostream &OS, AssemblyAnnotationWriter *AAW,
 803              bool ShouldPreserveUseListOrder = false,
 804              bool IsForDebug = false) const;
 805
 806   /// Dump the module to stderr (for debugging).
 807   void dump() const;
 808
 809   /// This function causes all the subinstructions to "let go" of all references
 810   /// that they are maintaining.  This allows one to 'delete' a whole class at
 811   /// a time, even though there may be circular references... first all
 812   /// references are dropped, and all use counts go to zero.  Then everything
 813   /// is delete'd for real.  Note that no operations are valid on an object
 814   /// that has "dropped all references", except operator delete.
 815   void dropAllReferences();
 816
 817 /// @}
 818 /// @name Utility functions for querying Debug information.
 819 /// @{
 820
 821   /// Returns the Number of Register ParametersDwarf Version by checking
 822   /// module flags.
 823   unsigned getNumberRegisterParameters() const;
 824
 825   /// Returns the Dwarf Version by checking module flags.
 826   unsigned getDwarfVersion() const;
 827
 828   /// Returns the CodeView Version by checking module flags.
 829   /// Returns zero if not present in module.
 830   unsigned getCodeViewFlag() const;
 831
 832 /// @}
 833 /// @name Utility functions for querying and setting PIC level
 834 /// @{
 835
 836   /// Returns the PIC level (small or large model)
 837   PICLevel::Level getPICLevel() const;
 838
 839   /// Set the PIC level (small or large model)
 840   void setPICLevel(PICLevel::Level PL);
 841 /// @}
 842
 843 /// @}
 844 /// @name Utility functions for querying and setting PIE level
 845 /// @{
 846
 847   /// Returns the PIE level (small or large model)
 848   PIELevel::Level getPIELevel() const;
 849
 850   /// Set the PIE level (small or large model)
 851   void setPIELevel(PIELevel::Level PL);
 852 /// @}
 853
 854   /// @}
 855   /// @name Utility function for querying and setting code model
 856   /// @{
 857
 858   /// Returns the code model (tiny, small, kernel, medium or large model)
 859   Optional<CodeModel::Model> getCodeModel() const;
 860
 861   /// Set the code model (tiny, small, kernel, medium or large)
 862   void setCodeModel(CodeModel::Model CL);
 863   /// @}
 864
 865   /// @name Utility functions for querying and setting PGO summary
 866   /// @{
 867
 868   /// Attach profile summary metadata to this module.
 869   void setProfileSummary(Metadata *M);
 870
 871   /// Returns profile summary metadata
 872   Metadata *getProfileSummary();
 873   /// @}
 874
 875   /// Returns true if PLT should be avoided for RTLib calls.
 876   bool getRtLibUseGOT() const;
 877
 878   /// Set that PLT should be avoid for RTLib calls.
 879   void setRtLibUseGOT();
 880
 881   /// @name Utility functions for querying and setting the build SDK version
 882   /// @{
 883
 884   /// Attach a build SDK version metadata to this module.
 885   void setSDKVersion(const VersionTuple &V);
 886
 887   /// Get the build SDK version metadata.
 888   ///
 889   /// An empty version is returned if no such metadata is attached.
 890   VersionTuple getSDKVersion() const;
 891   /// @}
 892
 893   /// Take ownership of the given memory buffer.
 894   void setOwnedMemoryBuffer(std::unique_ptr<MemoryBuffer> MB);
 895 };
 896
 897 /// Given "llvm.used" or "llvm.compiler.used" as a global name, collect
 898 /// the initializer elements of that global in Set and return the global itself.
 899 GlobalVariable *collectUsedGlobalVariables(const Module &M,
 900                                            SmallPtrSetImpl<GlobalValue *> &Set,
 901                                            bool CompilerUsed);
 902
 903 /// An raw_ostream inserter for modules.
 904 inline raw_ostream &operator<<(raw_ostream &O, const Module &M) {
 905   M.print(O, nullptr);
 906   return O;
 907 }
 908
 909 // Create wrappers for C Binding types (see CBindingWrapping.h).
 910 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef)
 911
 912 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
 913  * Module.
 914  */
 915 inline Module *unwrap(LLVMModuleProviderRef MP) {
 916   return reinterpret_cast<Module*>(MP);
 917 }
 918
 919 } // end namespace llvm
 920
 921 #endif // LLVM_IR_MODULE_H