LLVM  10.0.0svn
Module.h
Go to the documentation of this file.
1 //===- llvm/Module.h - C++ class to represent a VM module -------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 /// @file
10 /// Module.h This file contains the declarations for the Module class.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_IR_MODULE_H
15 #define LLVM_IR_MODULE_H
16 
17 #include "llvm-c/Types.h"
18 #include "llvm/ADT/Optional.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/ADT/StringMap.h"
21 #include "llvm/ADT/StringRef.h"
23 #include "llvm/IR/Attributes.h"
24 #include "llvm/IR/Comdat.h"
25 #include "llvm/IR/DataLayout.h"
26 #include "llvm/IR/Function.h"
27 #include "llvm/IR/GlobalAlias.h"
28 #include "llvm/IR/GlobalIFunc.h"
29 #include "llvm/IR/GlobalVariable.h"
30 #include "llvm/IR/Metadata.h"
31 #include "llvm/IR/ProfileSummary.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.
71  /// The type for the list of functions.
73  /// The type for the list of aliases.
75  /// The type for the list of ifuncs.
77  /// The type for the list of named metadata.
79  /// The type of the comdat "symbol" table.
81 
82  /// The Global Variable iterator.
84  /// The Global Variable constant iterator.
86 
87  /// The Function iterators.
89  /// The Function constant iterator
91 
92  /// The Function reverse iterator.
94  /// The Function constant reverse iterator.
96 
97  /// The Global Alias iterators.
99  /// The Global Alias constant iterator
101 
102  /// The Global IFunc iterators.
104  /// The Global IFunc constant iterator
106 
107  /// The named metadata iterators.
109  /// The named metadata constant iterators.
111 
112  /// This enumeration defines the supported behaviors of module flags.
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.
143 
144  /// Takes the max of the two values, which are required to be integers.
145  Max = 7,
146 
147  // Markers:
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 
160 
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.
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.
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.
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.
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
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. Otherwise, if the existing function has the correct prototype, return
337  /// the existing function.
338  /// 3. Finally, the function exists but has the wrong prototype: return the
339  /// function with a constantexpr cast to the right prototype.
340  ///
341  /// In all cases, the returned value is a FunctionCallee wrapper around the
342  /// 'FunctionType *T' passed in, as well as a 'Value*' either of the Function or
343  /// the bitcast to the function.
346 
348 
349  /// Look up the specified function in the module symbol table. If it does not
350  /// exist, add a prototype for the function and return it. This function
351  /// guarantees to return a constant of pointer to the specified function type
352  /// or a ConstantExpr BitCast of that type if the named function has a
353  /// different type. This version of the method takes a list of
354  /// function arguments, which makes it easier for clients to use.
355  template <typename... ArgsTy>
357  AttributeList AttributeList, Type *RetTy,
358  ArgsTy... Args) {
359  SmallVector<Type*, sizeof...(ArgsTy)> ArgTys{Args...};
360  return getOrInsertFunction(Name,
361  FunctionType::get(RetTy, ArgTys, false),
362  AttributeList);
363  }
364 
365  /// Same as above, but without the attributes.
366  template <typename... ArgsTy>
368  ArgsTy... Args) {
369  return getOrInsertFunction(Name, AttributeList{}, RetTy, Args...);
370  }
371 
372  // Avoid an incorrect ordering that'd otherwise compile incorrectly.
373  template <typename... ArgsTy>
375  getOrInsertFunction(StringRef Name, AttributeList AttributeList,
376  FunctionType *Invalid, ArgsTy... Args) = delete;
377 
378  /// Look up the specified function in the module symbol table. If it does not
379  /// exist, return null.
380  Function *getFunction(StringRef Name) const;
381 
382 /// @}
383 /// @name Global Variable Accessors
384 /// @{
385 
386  /// Look up the specified global variable in the module symbol table. If it
387  /// does not exist, return null. If AllowInternal is set to true, this
388  /// function will return types that have InternalLinkage. By default, these
389  /// types are not returned.
391  return getGlobalVariable(Name, false);
392  }
393 
394  GlobalVariable *getGlobalVariable(StringRef Name, bool AllowInternal) const;
395 
397  bool AllowInternal = false) {
398  return static_cast<const Module *>(this)->getGlobalVariable(Name,
399  AllowInternal);
400  }
401 
402  /// Return the global variable in the module with the specified name, of
403  /// arbitrary type. This method returns null if a global with the specified
404  /// name is not found.
406  return getGlobalVariable(Name, true);
407  }
409  return const_cast<GlobalVariable *>(
410  static_cast<const Module *>(this)->getNamedGlobal(Name));
411  }
412 
413  /// Look up the specified global in the module symbol table.
414  /// If it does not exist, invoke a callback to create a declaration of the
415  /// global and return it. The global is constantexpr casted to the expected
416  /// type if necessary.
417  Constant *
418  getOrInsertGlobal(StringRef Name, Type *Ty,
419  function_ref<GlobalVariable *()> CreateGlobalCallback);
420 
421  /// Look up the specified global in the module symbol table. If required, this
422  /// overload constructs the global variable using its constructor's defaults.
424 
425 /// @}
426 /// @name Global Alias Accessors
427 /// @{
428 
429  /// Return the global alias in the module with the specified name, of
430  /// arbitrary type. This method returns null if a global with the specified
431  /// name is not found.
432  GlobalAlias *getNamedAlias(StringRef Name) const;
433 
434 /// @}
435 /// @name Global IFunc Accessors
436 /// @{
437 
438  /// Return the global ifunc in the module with the specified name, of
439  /// arbitrary type. This method returns null if a global with the specified
440  /// name is not found.
441  GlobalIFunc *getNamedIFunc(StringRef Name) const;
442 
443 /// @}
444 /// @name Named Metadata Accessors
445 /// @{
446 
447  /// Return the first NamedMDNode in the module with the specified name. This
448  /// method returns null if a NamedMDNode with the specified name is not found.
449  NamedMDNode *getNamedMetadata(const Twine &Name) const;
450 
451  /// Return the named MDNode in the module with the specified name. This method
452  /// returns a new NamedMDNode if a NamedMDNode with the specified name is not
453  /// found.
455 
456  /// Remove the given NamedMDNode from this module and delete it.
457  void eraseNamedMetadata(NamedMDNode *NMD);
458 
459 /// @}
460 /// @name Comdat Accessors
461 /// @{
462 
463  /// Return the Comdat in the module with the specified name. It is created
464  /// if it didn't already exist.
466 
467 /// @}
468 /// @name Module Flags Accessors
469 /// @{
470 
471  /// Returns the module flags in the provided vector.
473 
474  /// Return the corresponding value if Key appears in module flags, otherwise
475  /// return null.
477 
478  /// Returns the NamedMDNode in the module that represents module-level flags.
479  /// This method returns null if there are no module-level flags.
481 
482  /// Returns the NamedMDNode in the module that represents module-level flags.
483  /// If module-level flags aren't found, it creates the named metadata that
484  /// contains them.
486 
487  /// Add a module-level flag to the module-level flags metadata. It will create
488  /// the module-level flags named metadata if it doesn't already exist.
490  void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, Constant *Val);
491  void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, uint32_t Val);
492  void addModuleFlag(MDNode *Node);
493 
494 /// @}
495 /// @name Materialization
496 /// @{
497 
498  /// Sets the GVMaterializer to GVM. This module must not yet have a
499  /// Materializer. To reset the materializer for a module that already has one,
500  /// call materializeAll first. Destroying this module will destroy
501  /// its materializer without materializing any more GlobalValues. Without
502  /// destroying the Module, there is no way to detach or destroy a materializer
503  /// without materializing all the GVs it controls, to avoid leaving orphan
504  /// unmaterialized GVs.
505  void setMaterializer(GVMaterializer *GVM);
506  /// Retrieves the GVMaterializer, if any, for this Module.
507  GVMaterializer *getMaterializer() const { return Materializer.get(); }
508  bool isMaterialized() const { return !getMaterializer(); }
509 
510  /// Make sure the GlobalValue is fully read.
512 
513  /// Make sure all GlobalValues in this Module are fully read and clear the
514  /// Materializer.
516 
518 
519 /// @}
520 /// @name Direct access to the globals list, functions list, and symbol table
521 /// @{
522 
523  /// Get the Module's list of global variables (constant).
524  const GlobalListType &getGlobalList() const { return GlobalList; }
525  /// Get the Module's list of global variables.
526  GlobalListType &getGlobalList() { return GlobalList; }
527 
529  return &Module::GlobalList;
530  }
531 
532  /// Get the Module's list of functions (constant).
533  const FunctionListType &getFunctionList() const { return FunctionList; }
534  /// Get the Module's list of functions.
535  FunctionListType &getFunctionList() { return FunctionList; }
537  return &Module::FunctionList;
538  }
539 
540  /// Get the Module's list of aliases (constant).
541  const AliasListType &getAliasList() const { return AliasList; }
542  /// Get the Module's list of aliases.
543  AliasListType &getAliasList() { return AliasList; }
544 
546  return &Module::AliasList;
547  }
548 
549  /// Get the Module's list of ifuncs (constant).
550  const IFuncListType &getIFuncList() const { return IFuncList; }
551  /// Get the Module's list of ifuncs.
552  IFuncListType &getIFuncList() { return IFuncList; }
553 
555  return &Module::IFuncList;
556  }
557 
558  /// Get the Module's list of named metadata (constant).
559  const NamedMDListType &getNamedMDList() const { return NamedMDList; }
560  /// Get the Module's list of named metadata.
561  NamedMDListType &getNamedMDList() { return NamedMDList; }
562 
564  return &Module::NamedMDList;
565  }
566 
567  /// Get the symbol table of global variable and function identifiers
568  const ValueSymbolTable &getValueSymbolTable() const { return *ValSymTab; }
569  /// Get the Module's symbol table of global variable and function identifiers.
570  ValueSymbolTable &getValueSymbolTable() { return *ValSymTab; }
571 
572  /// Get the Module's symbol table for COMDATs (constant).
573  const ComdatSymTabType &getComdatSymbolTable() const { return ComdatSymTab; }
574  /// Get the Module's symbol table for COMDATs.
575  ComdatSymTabType &getComdatSymbolTable() { return ComdatSymTab; }
576 
577 /// @}
578 /// @name Global Variable Iteration
579 /// @{
580 
581  global_iterator global_begin() { return GlobalList.begin(); }
582  const_global_iterator global_begin() const { return GlobalList.begin(); }
583  global_iterator global_end () { return GlobalList.end(); }
584  const_global_iterator global_end () const { return GlobalList.end(); }
585  bool global_empty() const { return GlobalList.empty(); }
586 
588  return make_range(global_begin(), global_end());
589  }
591  return make_range(global_begin(), global_end());
592  }
593 
594 /// @}
595 /// @name Function Iteration
596 /// @{
597 
598  iterator begin() { return FunctionList.begin(); }
599  const_iterator begin() const { return FunctionList.begin(); }
600  iterator end () { return FunctionList.end(); }
601  const_iterator end () const { return FunctionList.end(); }
602  reverse_iterator rbegin() { return FunctionList.rbegin(); }
603  const_reverse_iterator rbegin() const{ return FunctionList.rbegin(); }
604  reverse_iterator rend() { return FunctionList.rend(); }
605  const_reverse_iterator rend() const { return FunctionList.rend(); }
606  size_t size() const { return FunctionList.size(); }
607  bool empty() const { return FunctionList.empty(); }
608 
610  return make_range(begin(), end());
611  }
613  return make_range(begin(), end());
614  }
615 
616 /// @}
617 /// @name Alias Iteration
618 /// @{
619 
620  alias_iterator alias_begin() { return AliasList.begin(); }
621  const_alias_iterator alias_begin() const { return AliasList.begin(); }
622  alias_iterator alias_end () { return AliasList.end(); }
623  const_alias_iterator alias_end () const { return AliasList.end(); }
624  size_t alias_size () const { return AliasList.size(); }
625  bool alias_empty() const { return AliasList.empty(); }
626 
628  return make_range(alias_begin(), alias_end());
629  }
631  return make_range(alias_begin(), alias_end());
632  }
633 
634 /// @}
635 /// @name IFunc Iteration
636 /// @{
637 
638  ifunc_iterator ifunc_begin() { return IFuncList.begin(); }
639  const_ifunc_iterator ifunc_begin() const { return IFuncList.begin(); }
640  ifunc_iterator ifunc_end () { return IFuncList.end(); }
641  const_ifunc_iterator ifunc_end () const { return IFuncList.end(); }
642  size_t ifunc_size () const { return IFuncList.size(); }
643  bool ifunc_empty() const { return IFuncList.empty(); }
644 
646  return make_range(ifunc_begin(), ifunc_end());
647  }
649  return make_range(ifunc_begin(), ifunc_end());
650  }
651 
652  /// @}
653  /// @name Convenience iterators
654  /// @{
655 
656  using global_object_iterator =
661 
663  return concat<GlobalObject>(functions(), globals());
664  }
666  return concat<const GlobalObject>(functions(), globals());
667  }
668 
670  return global_objects().begin();
671  }
673 
675  return global_objects().begin();
676  }
678  return global_objects().end();
679  }
680 
681  using global_value_iterator =
687 
689  return concat<GlobalValue>(functions(), globals(), aliases(), ifuncs());
690  }
692  return concat<const GlobalValue>(functions(), globals(), aliases(),
693  ifuncs());
694  }
695 
698 
700  return global_values().begin();
701  }
703  return global_values().end();
704  }
705 
706  /// @}
707  /// @name Named Metadata Iteration
708  /// @{
709 
710  named_metadata_iterator named_metadata_begin() { return NamedMDList.begin(); }
712  return NamedMDList.begin();
713  }
714 
715  named_metadata_iterator named_metadata_end() { return NamedMDList.end(); }
717  return NamedMDList.end();
718  }
719 
720  size_t named_metadata_size() const { return NamedMDList.size(); }
721  bool named_metadata_empty() const { return NamedMDList.empty(); }
722 
725  }
728  }
729 
730  /// An iterator for DICompileUnits that skips those marked NoDebug.
732  : public std::iterator<std::input_iterator_tag, DICompileUnit *> {
733  NamedMDNode *CUs;
734  unsigned Idx;
735 
736  void SkipNoDebugCUs();
737 
738  public:
739  explicit debug_compile_units_iterator(NamedMDNode *CUs, unsigned Idx)
740  : CUs(CUs), Idx(Idx) {
741  SkipNoDebugCUs();
742  }
743 
745  ++Idx;
746  SkipNoDebugCUs();
747  return *this;
748  }
749 
752  ++Idx;
753  return T;
754  }
755 
757  return Idx == I.Idx;
758  }
759 
761  return Idx != I.Idx;
762  }
763 
764  DICompileUnit *operator*() const;
765  DICompileUnit *operator->() const;
766  };
767 
769  auto *CUs = getNamedMetadata("llvm.dbg.cu");
770  return debug_compile_units_iterator(CUs, 0);
771  }
772 
774  auto *CUs = getNamedMetadata("llvm.dbg.cu");
775  return debug_compile_units_iterator(CUs, CUs ? CUs->getNumOperands() : 0);
776  }
777 
778  /// Return an iterator for all DICompileUnits listed in this Module's
779  /// llvm.dbg.cu named metadata node and aren't explicitly marked as
780  /// NoDebug.
782  auto *CUs = getNamedMetadata("llvm.dbg.cu");
783  return make_range(
785  debug_compile_units_iterator(CUs, CUs ? CUs->getNumOperands() : 0));
786  }
787 /// @}
788 
789  /// Destroy ConstantArrays in LLVMContext if they are not used.
790  /// ConstantArrays constructed during linking can cause quadratic memory
791  /// explosion. Releasing all unused constants can cause a 20% LTO compile-time
792  /// slowdown for a large application.
793  ///
794  /// NOTE: Constants are currently owned by LLVMContext. This can then only
795  /// be called where all uses of the LLVMContext are understood.
797 
798 /// @name Utility functions for printing and dumping Module objects
799 /// @{
800 
801  /// Print the module to an output stream with an optional
802  /// AssemblyAnnotationWriter. If \c ShouldPreserveUseListOrder, then include
803  /// uselistorder directives so that use-lists can be recreated when reading
804  /// the assembly.
806  bool ShouldPreserveUseListOrder = false,
807  bool IsForDebug = false) const;
808 
809  /// Dump the module to stderr (for debugging).
810  void dump() const;
811 
812  /// This function causes all the subinstructions to "let go" of all references
813  /// that they are maintaining. This allows one to 'delete' a whole class at
814  /// a time, even though there may be circular references... first all
815  /// references are dropped, and all use counts go to zero. Then everything
816  /// is delete'd for real. Note that no operations are valid on an object
817  /// that has "dropped all references", except operator delete.
818  void dropAllReferences();
819 
820 /// @}
821 /// @name Utility functions for querying Debug information.
822 /// @{
823 
824  /// Returns the Number of Register ParametersDwarf Version by checking
825  /// module flags.
826  unsigned getNumberRegisterParameters() const;
827 
828  /// Returns the Dwarf Version by checking module flags.
829  unsigned getDwarfVersion() const;
830 
831  /// Returns the CodeView Version by checking module flags.
832  /// Returns zero if not present in module.
833  unsigned getCodeViewFlag() const;
834 
835 /// @}
836 /// @name Utility functions for querying and setting PIC level
837 /// @{
838 
839  /// Returns the PIC level (small or large model)
841 
842  /// Set the PIC level (small or large model)
844 /// @}
845 
846 /// @}
847 /// @name Utility functions for querying and setting PIE level
848 /// @{
849 
850  /// Returns the PIE level (small or large model)
852 
853  /// Set the PIE level (small or large model)
854  void setPIELevel(PIELevel::Level PL);
855 /// @}
856 
857  /// @}
858  /// @name Utility function for querying and setting code model
859  /// @{
860 
861  /// Returns the code model (tiny, small, kernel, medium or large model)
863 
864  /// Set the code model (tiny, small, kernel, medium or large)
866  /// @}
867 
868  /// @name Utility functions for querying and setting PGO summary
869  /// @{
870 
871  /// Attach profile summary metadata to this module.
873 
874  /// Returns profile summary metadata. When IsCS is true, use the context
875  /// sensitive profile summary.
876  Metadata *getProfileSummary(bool IsCS);
877  /// @}
878 
879  /// Returns true if PLT should be avoided for RTLib calls.
880  bool getRtLibUseGOT() const;
881 
882  /// Set that PLT should be avoid for RTLib calls.
883  void setRtLibUseGOT();
884 
885  /// @name Utility functions for querying and setting the build SDK version
886  /// @{
887 
888  /// Attach a build SDK version metadata to this module.
889  void setSDKVersion(const VersionTuple &V);
890 
891  /// Get the build SDK version metadata.
892  ///
893  /// An empty version is returned if no such metadata is attached.
894  VersionTuple getSDKVersion() const;
895  /// @}
896 
897  /// Take ownership of the given memory buffer.
898  void setOwnedMemoryBuffer(std::unique_ptr<MemoryBuffer> MB);
899 };
900 
901 /// Given "llvm.used" or "llvm.compiler.used" as a global name, collect
902 /// the initializer elements of that global in Set and return the global itself.
905  bool CompilerUsed);
906 
907 /// An raw_ostream inserter for modules.
909  M.print(O, nullptr);
910  return O;
911 }
912 
913 // Create wrappers for C Binding types (see CBindingWrapping.h).
915 
916 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
917  * Module.
918  */
920  return reinterpret_cast<Module*>(MP);
921 }
922 
923 } // end namespace llvm
924 
925 #endif // LLVM_IR_MODULE_H
Pass interface - Implemented by all &#39;passes&#39;.
Definition: Pass.h:80
uint64_t CallInst * C
debug_compile_units_iterator debug_compile_units_end() const
Definition: Module.h:773
const_alias_iterator alias_end() const
Definition: Module.h:623
A parsed version of the target data layout string in and methods for querying it. ...
Definition: DataLayout.h:112
const std::string & getTargetTriple() const
Get the target triple which is a string describing the target host.
Definition: Module.h:240
This class provides a symbol table of name/value pairs.
const_named_metadata_iterator named_metadata_begin() const
Definition: Module.h:711
llvm::Error materializeAll()
Make sure all GlobalValues in this Module are fully read and clear the Materializer.
Definition: Module.cpp:401
LLVMContext & Context
ValueSymbolTable & getValueSymbolTable()
Get the Module&#39;s symbol table of global variable and function identifiers.
Definition: Module.h:570
const_reverse_iterator rend() const
Definition: Module.h:605
Takes the max of the two values, which are required to be integers.
Definition: Module.h:145
This class represents lattice values for constants.
Definition: AllocatorList.h:23
struct LLVMOpaqueModule * LLVMModuleRef
The top-level container for all other LLVM Intermediate Representation (IR) objects.
Definition: Types.h:62
NamedMDNode * getModuleFlagsMetadata() const
Returns the NamedMDNode in the module that represents module-level flags.
Definition: Module.cpp:323
A Module instance is used to store all the information related to an LLVM module. ...
Definition: Module.h:65
amdgpu Simplify well known AMD library false FunctionCallee Value const Twine & Name
void setModuleIdentifier(StringRef ID)
Set the module identifier.
Definition: Module.h:273
A handy container for a FunctionType+Callee-pointer pair, which can be passed around as a single enti...
Definition: DerivedTypes.h:170
const ValueSymbolTable & getValueSymbolTable() const
Get the symbol table of global variable and function identifiers.
Definition: Module.h:568
This provides a very simple, boring adaptor for a begin and end iterator into a range type...
void setMaterializer(GVMaterializer *GVM)
Sets the GVMaterializer to GVM.
Definition: Module.cpp:387
const std::string & getStringRepresentation() const
Returns the string representation of the DataLayout.
Definition: DataLayout.h:241
size_t named_metadata_size() const
Definition: Module.h:720
debug_compile_units_iterator operator++(int)
Definition: Module.h:750
named_metadata_iterator named_metadata_end()
Definition: Module.h:715
This file contains the declarations for metadata subclasses.
Optional< std::vector< StOtherPiece > > Other
Definition: ELFYAML.cpp:953
Metadata * getProfileSummary(bool IsCS)
Returns profile summary metadata.
Definition: Module.cpp:541
FunctionListType::iterator iterator
The Function iterators.
Definition: Module.h:88
An efficient, type-erasing, non-owning reference to a callable.
Definition: STLExtras.h:104
const GlobalVariable * getNamedGlobal(StringRef Name) const
Return the global variable in the module with the specified name, of arbitrary type.
Definition: Module.h:405
ifunc_iterator ifunc_end()
Definition: Module.h:640
This file contains the declaration of the Comdat class, which represents a single COMDAT in LLVM...
iterator_range< const_iterator > functions() const
Definition: Module.h:612
bool global_empty() const
Definition: Module.h:585
NamedMDNode * getOrInsertNamedMetadata(StringRef Name)
Return the named MDNode in the module with the specified name.
Definition: Module.cpp:259
const_iterator begin() const
Definition: Module.h:599
void setDataLayout(StringRef Desc)
Set the data layout.
Definition: Module.cpp:363
global_object_iterator global_object_begin()
Definition: Module.h:669
debug_compile_units_iterator & operator++()
Definition: Module.h:744
const_reverse_iterator rbegin() const
Definition: Module.h:603
const std::string & getDataLayoutStr() const
Get the data layout string for the module&#39;s target platform.
Definition: Module.h:231
Optional< CodeModel::Model > getCodeModel() const
Returns the code model (tiny, small, kernel, medium or large model)
Definition: Module.cpp:516
GlobalVariable * getGlobalVariable(StringRef Name) const
Look up the specified global variable in the module symbol table.
Definition: Module.h:390
const_global_iterator global_end() const
Definition: Module.h:584
Metadata node.
Definition: Metadata.h:863
StringRef getName() const
Get a short "name" for the module.
Definition: Module.h:227
AliasListType::iterator alias_iterator
The Global Alias iterators.
Definition: Module.h:98
const GlobalListType & getGlobalList() const
Get the Module&#39;s list of global variables (constant).
Definition: Module.h:524
iterator_range< const_ifunc_iterator > ifuncs() const
Definition: Module.h:648
const_ifunc_iterator ifunc_begin() const
Definition: Module.h:639
A templated base class for SmallPtrSet which provides the typesafe interface that is common across al...
Definition: SmallPtrSet.h:343
Adds a requirement that another module flag be present and have a specified value after linking is pe...
Definition: Module.h:129
const AliasListType & getAliasList() const
Get the Module&#39;s list of aliases (constant).
Definition: Module.h:541
iterator_range< global_object_iterator > global_objects()
Definition: Module.h:662
ComdatSymTabType & getComdatSymbolTable()
Get the Module&#39;s symbol table for COMDATs.
Definition: Module.h:575
ModFlagBehavior Behavior
Definition: Module.h:157
Appends the two values, which are required to be metadata nodes.
Definition: Module.h:137
GlobalAlias * getNamedAlias(StringRef Name) const
Return the global alias in the module with the specified name, of arbitrary type. ...
Definition: Module.cpp:239
A tuple of MDNodes.
Definition: Metadata.h:1325
iterator_range< const_global_iterator > globals() const
Definition: Module.h:590
#define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)
const DataLayout & getDataLayout() const
Get the data layout for the module&#39;s target platform.
Definition: Module.cpp:369
global_value_iterator global_value_end()
Definition: Module.h:697
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:80
Attribute unwrap(LLVMAttributeRef Attr)
Definition: Attributes.h:204
void eraseNamedMetadata(NamedMDNode *NMD)
Remove the given NamedMDNode from this module and delete it.
Definition: Module.cpp:272
const ComdatSymTabType & getComdatSymbolTable() const
Get the Module&#39;s symbol table for COMDATs (constant).
Definition: Module.h:573
Class to represent struct types.
Definition: DerivedTypes.h:238
LLVMContext & getContext() const
Get the global data context.
Definition: Module.h:244
unsigned getInstructionCount()
Returns the number of non-debug IR instructions in the module.
Definition: Module.cpp:475
This file contains the simple types necessary to represent the attributes associated with functions a...
void setModuleInlineAsm(StringRef Asm)
Set the module-scope inline assembly blocks.
Definition: Module.h:287
APInt operator*(APInt a, uint64_t RHS)
Definition: APInt.h:2099
global_iterator global_begin()
Definition: Module.h:581
Class to represent function types.
Definition: DerivedTypes.h:108
reverse_iterator rend()
Definition: Module.h:604
void setRtLibUseGOT()
Set that PLT should be avoid for RTLib calls.
Definition: Module.cpp:555
NamedMDListType & getNamedMDList()
Get the Module&#39;s list of named metadata.
Definition: Module.h:561
const_iterator end() const
Definition: Module.h:601
bool empty() const
Definition: Module.h:607
bool operator==(const debug_compile_units_iterator &I) const
Definition: Module.h:756
NamedMDNode * getNamedMetadata(const Twine &Name) const
Return the first NamedMDNode in the module with the specified name.
Definition: Module.cpp:250
GlobalValue * getNamedValue(StringRef Name) const
Return the global value in the module with the specified name, of arbitrary type. ...
Definition: Module.cpp:113
debug_compile_units_iterator debug_compile_units_begin() const
Definition: Module.h:768
global_object_iterator global_object_end()
Definition: Module.h:672
iterator_range< const_alias_iterator > aliases() const
Definition: Module.h:630
void dropAllReferences()
This function causes all the subinstructions to "let go" of all references that they are maintaining...
Definition: Module.cpp:439
const_alias_iterator alias_begin() const
Definition: Module.h:621
IFuncListType & getIFuncList()
Get the Module&#39;s list of ifuncs.
Definition: Module.h:552
const std::string & getSourceFileName() const
Get the module&#39;s original source file name.
Definition: Module.h:221
unsigned getCodeViewFlag() const
Returns the CodeView Version by checking module flags.
Definition: Module.cpp:468
static AliasListType Module::* getSublistAccess(GlobalAlias *)
Definition: Module.h:545
bool alias_empty() const
Definition: Module.h:625
void getOperandBundleTags(SmallVectorImpl< StringRef > &Result) const
Populate client supplied SmallVector with the bundle tags registered in this LLVMContext.
Definition: Module.cpp:130
static IFuncListType Module::* getSublistAccess(GlobalIFunc *)
Definition: Module.h:554
#define P(N)
Module(StringRef ModuleID, LLVMContext &C)
The Module constructor.
Definition: Module.cpp:73
Emits an error if two values disagree, otherwise the resulting value is that of the operands...
Definition: Module.h:116
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
iterator_range< iterator > functions()
Definition: Module.h:609
alias_iterator alias_end()
Definition: Module.h:622
PIELevel::Level getPIELevel() const
Returns the PIE level (small or large model)
Definition: Module.cpp:502
const FunctionListType & getFunctionList() const
Get the Module&#39;s list of functions (constant).
Definition: Module.h:533
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:46
AliasListType & getAliasList()
Get the Module&#39;s list of aliases.
Definition: Module.h:543
iterator_range< const_global_object_iterator > global_objects() const
Definition: Module.h:665
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:64
Metadata * getModuleFlag(StringRef Key) const
Return the corresponding value if Key appears in module flags, otherwise return null.
Definition: Module.cpp:310
bool shouldEmitInstrCountChangedRemark()
Return true if size-info optimization remark is enabled, false otherwise.
Definition: Module.h:263
This is an important base class in LLVM.
Definition: Constant.h:41
ifunc_iterator ifunc_begin()
Definition: Module.h:638
iterator_range< const_global_value_iterator > global_values() const
Definition: Module.h:691
void dump() const
Dump the module to stderr (for debugging).
Definition: AsmWriter.cpp:4437
FunctionCallee getOrInsertFunction(StringRef Name, Type *RetTy, ArgsTy... Args)
Same as above, but without the attributes.
Definition: Module.h:367
static GlobalListType Module::* getSublistAccess(GlobalVariable *)
Definition: Module.h:528
amdgpu inline
ModFlagBehavior
This enumeration defines the supported behaviors of module flags.
Definition: Module.h:113
size_t alias_size() const
Definition: Module.h:624
iterator_range< named_metadata_iterator > named_metadata()
Definition: Module.h:723
static FunctionListType Module::* getSublistAccess(Function *)
Definition: Module.h:536
void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, Metadata *Val)
Add a module-level flag to the module-level flags metadata.
Definition: Module.cpp:337
void setCodeModel(CodeModel::Model CL)
Set the code model (tiny, small, kernel, medium or large)
Definition: Module.cpp:526
AliasListType::const_iterator const_alias_iterator
The Global Alias constant iterator.
Definition: Module.h:100
static FunctionType * get(Type *Result, ArrayRef< Type *> Params, bool isVarArg)
This static method is the primary way of constructing a FunctionType.
Definition: Type.cpp:301
const_global_value_iterator global_value_end() const
Definition: Module.h:702
An iterator for DICompileUnits that skips those marked NoDebug.
Definition: Module.h:731
struct LLVMOpaqueModuleProvider * LLVMModuleProviderRef
Interface used to provide a module to JIT or interpreter.
Definition: Types.h:125
Comdat * getOrInsertComdat(StringRef Name)
Return the Comdat in the module with the specified name.
Definition: Module.cpp:482
const NamedMDListType & getNamedMDList() const
Get the Module&#39;s list of named metadata (constant).
Definition: Module.h:559
const std::string & getModuleIdentifier() const
Get the module identifier which is, essentially, the name of the module.
Definition: Module.h:210
unsigned getDwarfVersion() const
Returns the Dwarf Version by checking module flags.
Definition: Module.cpp:461
An intrusive list with ownership and callbacks specified/controlled by ilist_traits, only with API safe for polymorphic types.
Definition: ilist.h:388
const_global_value_iterator global_value_begin() const
Definition: Module.h:699
const IFuncListType & getIFuncList() const
Get the Module&#39;s list of ifuncs (constant).
Definition: Module.h:550
std::vector< StructType * > getIdentifiedStructTypes() const
Definition: Module.cpp:418
reverse_iterator rbegin()
Definition: Module.h:602
void print(raw_ostream &OS, AssemblyAnnotationWriter *AAW, bool ShouldPreserveUseListOrder=false, bool IsForDebug=false) const
Print the module to an output stream with an optional AssemblyAnnotationWriter.
Definition: AsmWriter.cpp:4196
global_iterator global_end()
Definition: Module.h:583
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
GlobalVariable * collectUsedGlobalVariables(const Module &M, SmallPtrSetImpl< GlobalValue *> &Set, bool CompilerUsed)
Given "llvm.used" or "llvm.compiler.used" as a global name, collect the initializer elements of that ...
Definition: Module.cpp:598
Iterator for intrusive lists based on ilist_node.
ModuleFlagEntry(ModFlagBehavior B, MDString *K, Metadata *V)
Definition: Module.h:161
GlobalListType & getGlobalList()
Get the Module&#39;s list of global variables.
Definition: Module.h:526
void dropTriviallyDeadConstantArrays()
Destroy ConstantArrays in LLVMContext if they are not used.
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:837
static bool isValidModFlagBehavior(Metadata *MD, ModFlagBehavior &MFB)
Checks if Metadata represents a valid ModFlagBehavior, and stores the converted result in MFB...
Definition: Module.cpp:277
GlobalVariable * getNamedGlobal(StringRef Name)
Definition: Module.h:408
NamedMDNode * getOrInsertModuleFlagsMetadata()
Returns the NamedMDNode in the module that represents module-level flags.
Definition: Module.cpp:330
alias_iterator alias_begin()
Definition: Module.h:620
const_ifunc_iterator ifunc_end() const
Definition: Module.h:641
FunctionCallee getOrInsertFunction(StringRef Name, FunctionType *T, AttributeList AttributeList)
Look up the specified function in the module symbol table.
Definition: Module.cpp:143
size_t ifunc_size() const
Definition: Module.h:642
static NamedMDListType Module::* getSublistAccess(NamedMDNode *)
Definition: Module.h:563
Uses the specified value, regardless of the behavior or value of the other module.
Definition: Module.h:134
Function * getFunction(StringRef Name) const
Look up the specified function in the module symbol table.
Definition: Module.cpp:174
A range adaptor for a pair of iterators.
Emits a warning if two values disagree.
Definition: Module.h:120
FunctionListType & getFunctionList()
Get the Module&#39;s list of functions.
Definition: Module.h:535
bool getRtLibUseGOT() const
Returns true if PLT should be avoided for RTLib calls.
Definition: Module.cpp:550
const_global_object_iterator global_object_begin() const
Definition: Module.h:674
const_named_metadata_iterator named_metadata_end() const
Definition: Module.h:716
bool isMaterialized() const
Definition: Module.h:508
debug_compile_units_iterator(NamedMDNode *CUs, unsigned Idx)
Definition: Module.h:739
Represents a version number in the form major[.minor[.subminor[.build]]].
Definition: VersionTuple.h:26
Constant * getOrInsertGlobal(StringRef Name, Type *Ty, function_ref< GlobalVariable *()> CreateGlobalCallback)
Look up the specified global in the module symbol table.
Definition: Module.cpp:204
virtual bool isAnalysisRemarkEnabled(StringRef PassName) const
Return true if analysis remarks are enabled, override to provide different implementation.
iterator end()
Definition: Module.h:600
Appends the two values, which are required to be metadata nodes.
Definition: Module.h:142
bool ifunc_empty() const
Definition: Module.h:643
GlobalVariable * getGlobalVariable(StringRef Name, bool AllowInternal=false)
Definition: Module.h:396
void setSourceFileName(StringRef Name)
Set the module&#39;s original source file name.
Definition: Module.h:276
size_t size() const
Definition: Module.h:606
#define I(x, y, z)
Definition: MD5.cpp:58
void setSDKVersion(const VersionTuple &V)
Attach a build SDK version metadata to this module.
Definition: Module.cpp:559
global_value_iterator global_value_begin()
Definition: Module.h:696
iterator_range< debug_compile_units_iterator > debug_compile_units() const
Return an iterator for all DICompileUnits listed in this Module&#39;s llvm.dbg.cu named metadata node and...
Definition: Module.h:781
std::unique_ptr< RandomNumberGenerator > createRNG(const Pass *P) const
Get a RandomNumberGenerator salted for use with this module.
Definition: Module.cpp:92
iterator begin()
Definition: Module.h:598
void appendModuleInlineAsm(StringRef Asm)
Append to the module-scope inline assembly blocks.
Definition: Module.h:295
llvm::Error materialize(GlobalValue *GV)
Make sure the GlobalValue is fully read.
Definition: Module.cpp:394
void setTargetTriple(StringRef T)
Set the target triple.
Definition: Module.h:283
StructType * getTypeByName(StringRef Name) const
Return the type with the specified name, or null if there is none by that name.
Definition: Type.cpp:528
~Module()
The module destructor. This will dropAllReferences.
Definition: Module.cpp:80
void setPIELevel(PIELevel::Level PL)
Set the PIE level (small or large model)
Definition: Module.cpp:512
iterator_range< ifunc_iterator > ifuncs()
Definition: Module.h:645
void setOwnedMemoryBuffer(std::unique_ptr< MemoryBuffer > MB)
Take ownership of the given memory buffer.
Definition: Module.cpp:546
raw_ostream & operator<<(raw_ostream &OS, const APInt &I)
Definition: APInt.h:2047
const std::string & getModuleInlineAsm() const
Get any module-scope inline assembly blocks.
Definition: Module.h:248
void getMDKindNames(SmallVectorImpl< StringRef > &Result) const
Populate client supplied SmallVector with the name for custom metadata IDs registered in this LLVMCon...
Definition: Module.cpp:126
const DiagnosticHandler * getDiagHandlerPtr() const
getDiagHandlerPtr - Returns const raw pointer of DiagnosticHandler set by setDiagnosticHandler.
unsigned getMDKindID(StringRef Name) const
Return a unique non-zero ID for the specified metadata kind.
Definition: Module.cpp:119
unsigned getNumberRegisterParameters() const
Returns the Number of Register ParametersDwarf Version by checking module flags.
Definition: Module.cpp:453
FunctionListType::const_iterator const_iterator
The Function constant iterator.
Definition: Module.h:90
Lightweight error class with error context and mandatory checking.
Definition: Error.h:157
bool named_metadata_empty() const
Definition: Module.h:721
GlobalListType::const_iterator const_global_iterator
The Global Variable constant iterator.
Definition: Module.h:85
const_global_iterator global_begin() const
Definition: Module.h:582
void setPICLevel(PICLevel::Level PL)
Set the PIC level (small or large model)
Definition: Module.cpp:498
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:45
PICLevel::Level getPICLevel() const
Returns the PIC level (small or large model)
Definition: Module.cpp:488
iterator_range< global_iterator > globals()
Definition: Module.h:587
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
A single uniqued string.
Definition: Metadata.h:603
Iterator wrapper that concatenates sequences together.
Definition: STLExtras.h:812
VersionTuple getSDKVersion() const
Get the build SDK version metadata.
Definition: Module.cpp:573
void setProfileSummary(Metadata *M, ProfileSummary::Kind Kind)
Attach profile summary metadata to this module.
Definition: Module.cpp:534
FunctionCallee getOrInsertFunction(StringRef Name, AttributeList AttributeList, Type *RetTy, ArgsTy... Args)
Look up the specified function in the module symbol table.
Definition: Module.h:356
iterator_range< global_value_iterator > global_values()
Definition: Module.h:688
GlobalIFunc * getNamedIFunc(StringRef Name) const
Return the global ifunc in the module with the specified name, of arbitrary type. ...
Definition: Module.cpp:243
Root of the metadata hierarchy.
Definition: Metadata.h:57
GlobalListType::iterator global_iterator
The Global Variable iterator.
Definition: Module.h:83
llvm::Error materializeMetadata()
Definition: Module.cpp:408
constexpr char Args[]
Key for Kernel::Metadata::mArgs.
bool operator!=(const debug_compile_units_iterator &I) const
Definition: Module.h:760
named_metadata_iterator named_metadata_begin()
Definition: Module.h:710
const_global_object_iterator global_object_end() const
Definition: Module.h:677
GVMaterializer * getMaterializer() const
Retrieves the GVMaterializer, if any, for this Module.
Definition: Module.h:507
iterator_range< const_named_metadata_iterator > named_metadata() const
Definition: Module.h:726
iterator_range< alias_iterator > aliases()
Definition: Module.h:627