1 //===- llvm/Module.h - C++ class to represent a VM module -------*- C++ -*-===//
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
7 //===----------------------------------------------------------------------===//
10 /// Module.h This file contains the declarations for the Module class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_IR_MODULE_H
15 #define LLVM_IR_MODULE_H
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"
22 #include "llvm/ADT/iterator_range.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"
32 #include "llvm/IR/SymbolTableListTraits.h"
33 #include "llvm/Support/CBindingWrapping.h"
34 #include "llvm/Support/CodeGen.h"
50 class RandomNumberGenerator
;
51 template <class PtrType
> class SmallPtrSetImpl
;
55 /// A Module instance is used to store all the information related to an
56 /// LLVM module. Modules are the top level container of all other LLVM
57 /// Intermediate Representation (IR) objects. Each module directly contains a
58 /// list of globals variables, a list of functions, a list of libraries (or
59 /// other modules) this module depends on, a symbol table, and various data
60 /// about the target's characteristics.
62 /// A module maintains a GlobalValRefMap object that is used to hold all
63 /// constant references to global variables in the module. When a global
64 /// variable is destroyed, it should have no entries in the GlobalValueRefMap.
65 /// The main container class for the LLVM Intermediate Representation.
67 /// @name Types And Enumerations
70 /// The type for the list of global variables.
71 using GlobalListType
= SymbolTableList
<GlobalVariable
>;
72 /// The type for the list of functions.
73 using FunctionListType
= SymbolTableList
<Function
>;
74 /// The type for the list of aliases.
75 using AliasListType
= SymbolTableList
<GlobalAlias
>;
76 /// The type for the list of ifuncs.
77 using IFuncListType
= SymbolTableList
<GlobalIFunc
>;
78 /// The type for the list of named metadata.
79 using NamedMDListType
= ilist
<NamedMDNode
>;
80 /// The type of the comdat "symbol" table.
81 using ComdatSymTabType
= StringMap
<Comdat
>;
83 /// The Global Variable iterator.
84 using global_iterator
= GlobalListType::iterator
;
85 /// The Global Variable constant iterator.
86 using const_global_iterator
= GlobalListType::const_iterator
;
88 /// The Function iterators.
89 using iterator
= FunctionListType::iterator
;
90 /// The Function constant iterator
91 using const_iterator
= FunctionListType::const_iterator
;
93 /// The Function reverse iterator.
94 using reverse_iterator
= FunctionListType::reverse_iterator
;
95 /// The Function constant reverse iterator.
96 using const_reverse_iterator
= FunctionListType::const_reverse_iterator
;
98 /// The Global Alias iterators.
99 using alias_iterator
= AliasListType::iterator
;
100 /// The Global Alias constant iterator
101 using const_alias_iterator
= AliasListType::const_iterator
;
103 /// The Global IFunc iterators.
104 using ifunc_iterator
= IFuncListType::iterator
;
105 /// The Global IFunc constant iterator
106 using const_ifunc_iterator
= IFuncListType::const_iterator
;
108 /// The named metadata iterators.
109 using named_metadata_iterator
= NamedMDListType::iterator
;
110 /// The named metadata constant iterators.
111 using const_named_metadata_iterator
= NamedMDListType::const_iterator
;
113 /// This enumeration defines the supported behaviors of module flags.
114 enum ModFlagBehavior
{
115 /// Emits an error if two values disagree, otherwise the resulting value is
116 /// that of the operands.
119 /// Emits a warning if two values disagree. The result value will be the
120 /// operand for the flag from the first module being linked.
123 /// Adds a requirement that another module flag be present and have a
124 /// specified value after linking is performed. The value must be a metadata
125 /// pair, where the first element of the pair is the ID of the module flag
126 /// to be restricted, and the second element of the pair is the value the
127 /// module flag should be restricted to. This behavior can be used to
128 /// restrict the allowable results (via triggering of an error) of linking
129 /// IDs with the **Override** behavior.
132 /// Uses the specified value, regardless of the behavior or value of the
133 /// other module. If both modules specify **Override**, but the values
134 /// differ, an error will be emitted.
137 /// Appends the two values, which are required to be metadata nodes.
140 /// Appends the two values, which are required to be metadata
141 /// nodes. However, duplicate entries in the second list are dropped
142 /// during the append operation.
145 /// Takes the max of the two values, which are required to be integers.
149 ModFlagBehaviorFirstVal
= Error
,
150 ModFlagBehaviorLastVal
= Max
153 /// Checks if Metadata represents a valid ModFlagBehavior, and stores the
154 /// converted result in MFB.
155 static bool isValidModFlagBehavior(Metadata
*MD
, ModFlagBehavior
&MFB
);
157 struct ModuleFlagEntry
{
158 ModFlagBehavior Behavior
;
162 ModuleFlagEntry(ModFlagBehavior B
, MDString
*K
, Metadata
*V
)
163 : Behavior(B
), Key(K
), Val(V
) {}
167 /// @name Member Variables
170 LLVMContext
&Context
; ///< The LLVMContext from which types and
171 ///< constants are allocated.
172 GlobalListType GlobalList
; ///< The Global Variables in the module
173 FunctionListType FunctionList
; ///< The Functions in the module
174 AliasListType AliasList
; ///< The Aliases in the module
175 IFuncListType IFuncList
; ///< The IFuncs in the module
176 NamedMDListType NamedMDList
; ///< The named metadata in the module
177 std::string GlobalScopeAsm
; ///< Inline Asm at global scope.
178 ValueSymbolTable
*ValSymTab
; ///< Symbol table for values
179 ComdatSymTabType ComdatSymTab
; ///< Symbol table for COMDATs
180 std::unique_ptr
<MemoryBuffer
>
181 OwnedMemoryBuffer
; ///< Memory buffer directly owned by this
182 ///< module, for legacy clients only.
183 std::unique_ptr
<GVMaterializer
>
184 Materializer
; ///< Used to materialize GlobalValues
185 std::string ModuleID
; ///< Human readable identifier for the module
186 std::string SourceFileName
; ///< Original source file name for module,
187 ///< recorded in bitcode.
188 std::string TargetTriple
; ///< Platform target triple Module compiled on
189 ///< Format: (arch)(sub)-(vendor)-(sys0-(abi)
190 void *NamedMDSymTab
; ///< NamedMDNode names.
191 DataLayout DL
; ///< DataLayout associated with the module
193 friend class Constant
;
196 /// @name Constructors
199 /// The Module constructor. Note that there is no default constructor. You
200 /// must provide a name for the module upon construction.
201 explicit Module(StringRef ModuleID
, LLVMContext
& C
);
202 /// The module destructor. This will dropAllReferences.
206 /// @name Module Level Accessors
209 /// Get the module identifier which is, essentially, the name of the module.
210 /// @returns the module identifier as a string
211 const std::string
&getModuleIdentifier() const { return ModuleID
; }
213 /// Returns the number of non-debug IR instructions in the module.
214 /// This is equivalent to the sum of the IR instruction counts of each
215 /// function contained in the module.
216 unsigned getInstructionCount();
218 /// Get the module's original source file name. When compiling from
219 /// bitcode, this is taken from a bitcode record where it was recorded.
220 /// For other compiles it is the same as the ModuleID, which would
221 /// contain the source file name.
222 const std::string
&getSourceFileName() const { return SourceFileName
; }
224 /// Get a short "name" for the module.
226 /// This is useful for debugging or logging. It is essentially a convenience
227 /// wrapper around getModuleIdentifier().
228 StringRef
getName() const { return ModuleID
; }
230 /// Get the data layout string for the module's target platform. This is
231 /// equivalent to getDataLayout()->getStringRepresentation().
232 const std::string
&getDataLayoutStr() const {
233 return DL
.getStringRepresentation();
236 /// Get the data layout for the module's target platform.
237 const DataLayout
&getDataLayout() const;
239 /// Get the target triple which is a string describing the target host.
240 /// @returns a string containing the target triple.
241 const std::string
&getTargetTriple() const { return TargetTriple
; }
243 /// Get the global data context.
244 /// @returns LLVMContext - a container for LLVM's global information
245 LLVMContext
&getContext() const { return Context
; }
247 /// Get any module-scope inline assembly blocks.
248 /// @returns a string containing the module-scope inline assembly blocks.
249 const std::string
&getModuleInlineAsm() const { return GlobalScopeAsm
; }
251 /// Get a RandomNumberGenerator salted for use with this module. The
252 /// RNG can be seeded via -rng-seed=<uint64> and is salted with the
253 /// ModuleID and the provided pass salt. The returned RNG should not
254 /// be shared across threads or passes.
256 /// A unique RNG per pass ensures a reproducible random stream even
257 /// when other randomness consuming passes are added or removed. In
258 /// addition, the random stream will be reproducible across LLVM
259 /// versions when the pass does not change.
260 std::unique_ptr
<RandomNumberGenerator
> createRNG(const Pass
* P
) const;
262 /// Return true if size-info optimization remark is enabled, false
264 bool shouldEmitInstrCountChangedRemark() {
265 return getContext().getDiagHandlerPtr()->isAnalysisRemarkEnabled(
270 /// @name Module Level Mutators
273 /// Set the module identifier.
274 void setModuleIdentifier(StringRef ID
) { ModuleID
= ID
; }
276 /// Set the module's original source file name.
277 void setSourceFileName(StringRef Name
) { SourceFileName
= Name
; }
279 /// Set the data layout
280 void setDataLayout(StringRef Desc
);
281 void setDataLayout(const DataLayout
&Other
);
283 /// Set the target triple.
284 void setTargetTriple(StringRef T
) { TargetTriple
= T
; }
286 /// Set the module-scope inline assembly blocks.
287 /// A trailing newline is added if the input doesn't have one.
288 void setModuleInlineAsm(StringRef Asm
) {
289 GlobalScopeAsm
= Asm
;
290 if (!GlobalScopeAsm
.empty() && GlobalScopeAsm
.back() != '\n')
291 GlobalScopeAsm
+= '\n';
294 /// Append to the module-scope inline assembly blocks.
295 /// A trailing newline is added if the input doesn't have one.
296 void appendModuleInlineAsm(StringRef Asm
) {
297 GlobalScopeAsm
+= Asm
;
298 if (!GlobalScopeAsm
.empty() && GlobalScopeAsm
.back() != '\n')
299 GlobalScopeAsm
+= '\n';
303 /// @name Generic Value Accessors
306 /// Return the global value in the module with the specified name, of
307 /// arbitrary type. This method returns null if a global with the specified
308 /// name is not found.
309 GlobalValue
*getNamedValue(StringRef Name
) const;
311 /// Return a unique non-zero ID for the specified metadata kind. This ID is
312 /// uniqued across modules in the current LLVMContext.
313 unsigned getMDKindID(StringRef Name
) const;
315 /// Populate client supplied SmallVector with the name for custom metadata IDs
316 /// registered in this LLVMContext.
317 void getMDKindNames(SmallVectorImpl
<StringRef
> &Result
) const;
319 /// Populate client supplied SmallVector with the bundle tags registered in
320 /// this LLVMContext. The bundle tags are ordered by increasing bundle IDs.
321 /// \see LLVMContext::getOperandBundleTagID
322 void getOperandBundleTags(SmallVectorImpl
<StringRef
> &Result
) const;
324 /// Return the type with the specified name, or null if there is none by that
326 StructType
*getTypeByName(StringRef Name
) const;
328 std::vector
<StructType
*> getIdentifiedStructTypes() const;
331 /// @name Function Accessors
334 /// Look up the specified function in the module symbol table. Four
336 /// 1. If it does not exist, add a prototype for the function and return it.
337 /// 2. Otherwise, if the existing function has the correct prototype, return
338 /// the existing function.
339 /// 3. Finally, the function exists but has the wrong prototype: return the
340 /// function with a constantexpr cast to the right prototype.
342 /// In all cases, the returned value is a FunctionCallee wrapper around the
343 /// 'FunctionType *T' passed in, as well as a 'Value*' either of the Function or
344 /// the bitcast to the function.
345 FunctionCallee
getOrInsertFunction(StringRef Name
, FunctionType
*T
,
346 AttributeList AttributeList
);
348 FunctionCallee
getOrInsertFunction(StringRef Name
, FunctionType
*T
);
350 /// Look up the specified function in the module symbol table. If it does not
351 /// exist, add a prototype for the function and return it. This function
352 /// guarantees to return a constant of pointer to the specified function type
353 /// or a ConstantExpr BitCast of that type if the named function has a
354 /// different type. This version of the method takes a list of
355 /// function arguments, which makes it easier for clients to use.
356 template <typename
... ArgsTy
>
357 FunctionCallee
getOrInsertFunction(StringRef Name
,
358 AttributeList AttributeList
, Type
*RetTy
,
360 SmallVector
<Type
*, sizeof...(ArgsTy
)> ArgTys
{Args
...};
361 return getOrInsertFunction(Name
,
362 FunctionType::get(RetTy
, ArgTys
, false),
366 /// Same as above, but without the attributes.
367 template <typename
... ArgsTy
>
368 FunctionCallee
getOrInsertFunction(StringRef Name
, Type
*RetTy
,
370 return getOrInsertFunction(Name
, AttributeList
{}, RetTy
, Args
...);
373 // Avoid an incorrect ordering that'd otherwise compile incorrectly.
374 template <typename
... ArgsTy
>
376 getOrInsertFunction(StringRef Name
, AttributeList AttributeList
,
377 FunctionType
*Invalid
, ArgsTy
... Args
) = delete;
379 /// Look up the specified function in the module symbol table. If it does not
380 /// exist, return null.
381 Function
*getFunction(StringRef Name
) const;
384 /// @name Global Variable Accessors
387 /// Look up the specified global variable in the module symbol table. If it
388 /// does not exist, return null. If AllowInternal is set to true, this
389 /// function will return types that have InternalLinkage. By default, these
390 /// types are not returned.
391 GlobalVariable
*getGlobalVariable(StringRef Name
) const {
392 return getGlobalVariable(Name
, false);
395 GlobalVariable
*getGlobalVariable(StringRef Name
, bool AllowInternal
) const;
397 GlobalVariable
*getGlobalVariable(StringRef Name
,
398 bool AllowInternal
= false) {
399 return static_cast<const Module
*>(this)->getGlobalVariable(Name
,
403 /// Return the global variable in the module with the specified name, of
404 /// arbitrary type. This method returns null if a global with the specified
405 /// name is not found.
406 const GlobalVariable
*getNamedGlobal(StringRef Name
) const {
407 return getGlobalVariable(Name
, true);
409 GlobalVariable
*getNamedGlobal(StringRef Name
) {
410 return const_cast<GlobalVariable
*>(
411 static_cast<const Module
*>(this)->getNamedGlobal(Name
));
414 /// Look up the specified global in the module symbol table.
415 /// If it does not exist, invoke a callback to create a declaration of the
416 /// global and return it. The global is constantexpr casted to the expected
417 /// type if necessary.
419 getOrInsertGlobal(StringRef Name
, Type
*Ty
,
420 function_ref
<GlobalVariable
*()> CreateGlobalCallback
);
422 /// Look up the specified global in the module symbol table. If required, this
423 /// overload constructs the global variable using its constructor's defaults.
424 Constant
*getOrInsertGlobal(StringRef Name
, Type
*Ty
);
427 /// @name Global Alias Accessors
430 /// Return the global alias in the module with the specified name, of
431 /// arbitrary type. This method returns null if a global with the specified
432 /// name is not found.
433 GlobalAlias
*getNamedAlias(StringRef Name
) const;
436 /// @name Global IFunc Accessors
439 /// Return the global ifunc in the module with the specified name, of
440 /// arbitrary type. This method returns null if a global with the specified
441 /// name is not found.
442 GlobalIFunc
*getNamedIFunc(StringRef Name
) const;
445 /// @name Named Metadata Accessors
448 /// Return the first NamedMDNode in the module with the specified name. This
449 /// method returns null if a NamedMDNode with the specified name is not found.
450 NamedMDNode
*getNamedMetadata(const Twine
&Name
) const;
452 /// Return the named MDNode in the module with the specified name. This method
453 /// returns a new NamedMDNode if a NamedMDNode with the specified name is not
455 NamedMDNode
*getOrInsertNamedMetadata(StringRef Name
);
457 /// Remove the given NamedMDNode from this module and delete it.
458 void eraseNamedMetadata(NamedMDNode
*NMD
);
461 /// @name Comdat Accessors
464 /// Return the Comdat in the module with the specified name. It is created
465 /// if it didn't already exist.
466 Comdat
*getOrInsertComdat(StringRef Name
);
469 /// @name Module Flags Accessors
472 /// Returns the module flags in the provided vector.
473 void getModuleFlagsMetadata(SmallVectorImpl
<ModuleFlagEntry
> &Flags
) const;
475 /// Return the corresponding value if Key appears in module flags, otherwise
477 Metadata
*getModuleFlag(StringRef Key
) const;
479 /// Returns the NamedMDNode in the module that represents module-level flags.
480 /// This method returns null if there are no module-level flags.
481 NamedMDNode
*getModuleFlagsMetadata() const;
483 /// Returns the NamedMDNode in the module that represents module-level flags.
484 /// If module-level flags aren't found, it creates the named metadata that
486 NamedMDNode
*getOrInsertModuleFlagsMetadata();
488 /// Add a module-level flag to the module-level flags metadata. It will create
489 /// the module-level flags named metadata if it doesn't already exist.
490 void addModuleFlag(ModFlagBehavior Behavior
, StringRef Key
, Metadata
*Val
);
491 void addModuleFlag(ModFlagBehavior Behavior
, StringRef Key
, Constant
*Val
);
492 void addModuleFlag(ModFlagBehavior Behavior
, StringRef Key
, uint32_t Val
);
493 void addModuleFlag(MDNode
*Node
);
496 /// @name Materialization
499 /// Sets the GVMaterializer to GVM. This module must not yet have a
500 /// Materializer. To reset the materializer for a module that already has one,
501 /// call materializeAll first. Destroying this module will destroy
502 /// its materializer without materializing any more GlobalValues. Without
503 /// destroying the Module, there is no way to detach or destroy a materializer
504 /// without materializing all the GVs it controls, to avoid leaving orphan
505 /// unmaterialized GVs.
506 void setMaterializer(GVMaterializer
*GVM
);
507 /// Retrieves the GVMaterializer, if any, for this Module.
508 GVMaterializer
*getMaterializer() const { return Materializer
.get(); }
509 bool isMaterialized() const { return !getMaterializer(); }
511 /// Make sure the GlobalValue is fully read.
512 llvm::Error
materialize(GlobalValue
*GV
);
514 /// Make sure all GlobalValues in this Module are fully read and clear the
516 llvm::Error
materializeAll();
518 llvm::Error
materializeMetadata();
521 /// @name Direct access to the globals list, functions list, and symbol table
524 /// Get the Module's list of global variables (constant).
525 const GlobalListType
&getGlobalList() const { return GlobalList
; }
526 /// Get the Module's list of global variables.
527 GlobalListType
&getGlobalList() { return GlobalList
; }
529 static GlobalListType
Module::*getSublistAccess(GlobalVariable
*) {
530 return &Module::GlobalList
;
533 /// Get the Module's list of functions (constant).
534 const FunctionListType
&getFunctionList() const { return FunctionList
; }
535 /// Get the Module's list of functions.
536 FunctionListType
&getFunctionList() { return FunctionList
; }
537 static FunctionListType
Module::*getSublistAccess(Function
*) {
538 return &Module::FunctionList
;
541 /// Get the Module's list of aliases (constant).
542 const AliasListType
&getAliasList() const { return AliasList
; }
543 /// Get the Module's list of aliases.
544 AliasListType
&getAliasList() { return AliasList
; }
546 static AliasListType
Module::*getSublistAccess(GlobalAlias
*) {
547 return &Module::AliasList
;
550 /// Get the Module's list of ifuncs (constant).
551 const IFuncListType
&getIFuncList() const { return IFuncList
; }
552 /// Get the Module's list of ifuncs.
553 IFuncListType
&getIFuncList() { return IFuncList
; }
555 static IFuncListType
Module::*getSublistAccess(GlobalIFunc
*) {
556 return &Module::IFuncList
;
559 /// Get the Module's list of named metadata (constant).
560 const NamedMDListType
&getNamedMDList() const { return NamedMDList
; }
561 /// Get the Module's list of named metadata.
562 NamedMDListType
&getNamedMDList() { return NamedMDList
; }
564 static NamedMDListType
Module::*getSublistAccess(NamedMDNode
*) {
565 return &Module::NamedMDList
;
568 /// Get the symbol table of global variable and function identifiers
569 const ValueSymbolTable
&getValueSymbolTable() const { return *ValSymTab
; }
570 /// Get the Module's symbol table of global variable and function identifiers.
571 ValueSymbolTable
&getValueSymbolTable() { return *ValSymTab
; }
573 /// Get the Module's symbol table for COMDATs (constant).
574 const ComdatSymTabType
&getComdatSymbolTable() const { return ComdatSymTab
; }
575 /// Get the Module's symbol table for COMDATs.
576 ComdatSymTabType
&getComdatSymbolTable() { return ComdatSymTab
; }
579 /// @name Global Variable Iteration
582 global_iterator
global_begin() { return GlobalList
.begin(); }
583 const_global_iterator
global_begin() const { return GlobalList
.begin(); }
584 global_iterator
global_end () { return GlobalList
.end(); }
585 const_global_iterator
global_end () const { return GlobalList
.end(); }
586 bool global_empty() const { return GlobalList
.empty(); }
588 iterator_range
<global_iterator
> globals() {
589 return make_range(global_begin(), global_end());
591 iterator_range
<const_global_iterator
> globals() const {
592 return make_range(global_begin(), global_end());
596 /// @name Function Iteration
599 iterator
begin() { return FunctionList
.begin(); }
600 const_iterator
begin() const { return FunctionList
.begin(); }
601 iterator
end () { return FunctionList
.end(); }
602 const_iterator
end () const { return FunctionList
.end(); }
603 reverse_iterator
rbegin() { return FunctionList
.rbegin(); }
604 const_reverse_iterator
rbegin() const{ return FunctionList
.rbegin(); }
605 reverse_iterator
rend() { return FunctionList
.rend(); }
606 const_reverse_iterator
rend() const { return FunctionList
.rend(); }
607 size_t size() const { return FunctionList
.size(); }
608 bool empty() const { return FunctionList
.empty(); }
610 iterator_range
<iterator
> functions() {
611 return make_range(begin(), end());
613 iterator_range
<const_iterator
> functions() const {
614 return make_range(begin(), end());
618 /// @name Alias Iteration
621 alias_iterator
alias_begin() { return AliasList
.begin(); }
622 const_alias_iterator
alias_begin() const { return AliasList
.begin(); }
623 alias_iterator
alias_end () { return AliasList
.end(); }
624 const_alias_iterator
alias_end () const { return AliasList
.end(); }
625 size_t alias_size () const { return AliasList
.size(); }
626 bool alias_empty() const { return AliasList
.empty(); }
628 iterator_range
<alias_iterator
> aliases() {
629 return make_range(alias_begin(), alias_end());
631 iterator_range
<const_alias_iterator
> aliases() const {
632 return make_range(alias_begin(), alias_end());
636 /// @name IFunc Iteration
639 ifunc_iterator
ifunc_begin() { return IFuncList
.begin(); }
640 const_ifunc_iterator
ifunc_begin() const { return IFuncList
.begin(); }
641 ifunc_iterator
ifunc_end () { return IFuncList
.end(); }
642 const_ifunc_iterator
ifunc_end () const { return IFuncList
.end(); }
643 size_t ifunc_size () const { return IFuncList
.size(); }
644 bool ifunc_empty() const { return IFuncList
.empty(); }
646 iterator_range
<ifunc_iterator
> ifuncs() {
647 return make_range(ifunc_begin(), ifunc_end());
649 iterator_range
<const_ifunc_iterator
> ifuncs() const {
650 return make_range(ifunc_begin(), ifunc_end());
654 /// @name Convenience iterators
657 using global_object_iterator
=
658 concat_iterator
<GlobalObject
, iterator
, global_iterator
>;
659 using const_global_object_iterator
=
660 concat_iterator
<const GlobalObject
, const_iterator
,
661 const_global_iterator
>;
663 iterator_range
<global_object_iterator
> global_objects() {
664 return concat
<GlobalObject
>(functions(), globals());
666 iterator_range
<const_global_object_iterator
> global_objects() const {
667 return concat
<const GlobalObject
>(functions(), globals());
670 global_object_iterator
global_object_begin() {
671 return global_objects().begin();
673 global_object_iterator
global_object_end() { return global_objects().end(); }
675 const_global_object_iterator
global_object_begin() const {
676 return global_objects().begin();
678 const_global_object_iterator
global_object_end() const {
679 return global_objects().end();
682 using global_value_iterator
=
683 concat_iterator
<GlobalValue
, iterator
, global_iterator
, alias_iterator
,
685 using const_global_value_iterator
=
686 concat_iterator
<const GlobalValue
, const_iterator
, const_global_iterator
,
687 const_alias_iterator
, const_ifunc_iterator
>;
689 iterator_range
<global_value_iterator
> global_values() {
690 return concat
<GlobalValue
>(functions(), globals(), aliases(), ifuncs());
692 iterator_range
<const_global_value_iterator
> global_values() const {
693 return concat
<const GlobalValue
>(functions(), globals(), aliases(),
697 global_value_iterator
global_value_begin() { return global_values().begin(); }
698 global_value_iterator
global_value_end() { return global_values().end(); }
700 const_global_value_iterator
global_value_begin() const {
701 return global_values().begin();
703 const_global_value_iterator
global_value_end() const {
704 return global_values().end();
708 /// @name Named Metadata Iteration
711 named_metadata_iterator
named_metadata_begin() { return NamedMDList
.begin(); }
712 const_named_metadata_iterator
named_metadata_begin() const {
713 return NamedMDList
.begin();
716 named_metadata_iterator
named_metadata_end() { return NamedMDList
.end(); }
717 const_named_metadata_iterator
named_metadata_end() const {
718 return NamedMDList
.end();
721 size_t named_metadata_size() const { return NamedMDList
.size(); }
722 bool named_metadata_empty() const { return NamedMDList
.empty(); }
724 iterator_range
<named_metadata_iterator
> named_metadata() {
725 return make_range(named_metadata_begin(), named_metadata_end());
727 iterator_range
<const_named_metadata_iterator
> named_metadata() const {
728 return make_range(named_metadata_begin(), named_metadata_end());
731 /// An iterator for DICompileUnits that skips those marked NoDebug.
732 class debug_compile_units_iterator
733 : public std::iterator
<std::input_iterator_tag
, DICompileUnit
*> {
737 void SkipNoDebugCUs();
740 explicit debug_compile_units_iterator(NamedMDNode
*CUs
, unsigned Idx
)
741 : CUs(CUs
), Idx(Idx
) {
745 debug_compile_units_iterator
&operator++() {
751 debug_compile_units_iterator
operator++(int) {
752 debug_compile_units_iterator
T(*this);
757 bool operator==(const debug_compile_units_iterator
&I
) const {
761 bool operator!=(const debug_compile_units_iterator
&I
) const {
765 DICompileUnit
*operator*() const;
766 DICompileUnit
*operator->() const;
769 debug_compile_units_iterator
debug_compile_units_begin() const {
770 auto *CUs
= getNamedMetadata("llvm.dbg.cu");
771 return debug_compile_units_iterator(CUs
, 0);
774 debug_compile_units_iterator
debug_compile_units_end() const {
775 auto *CUs
= getNamedMetadata("llvm.dbg.cu");
776 return debug_compile_units_iterator(CUs
, CUs
? CUs
->getNumOperands() : 0);
779 /// Return an iterator for all DICompileUnits listed in this Module's
780 /// llvm.dbg.cu named metadata node and aren't explicitly marked as
782 iterator_range
<debug_compile_units_iterator
> debug_compile_units() const {
783 auto *CUs
= getNamedMetadata("llvm.dbg.cu");
785 debug_compile_units_iterator(CUs
, 0),
786 debug_compile_units_iterator(CUs
, CUs
? CUs
->getNumOperands() : 0));
790 /// Destroy ConstantArrays in LLVMContext if they are not used.
791 /// ConstantArrays constructed during linking can cause quadratic memory
792 /// explosion. Releasing all unused constants can cause a 20% LTO compile-time
793 /// slowdown for a large application.
795 /// NOTE: Constants are currently owned by LLVMContext. This can then only
796 /// be called where all uses of the LLVMContext are understood.
797 void dropTriviallyDeadConstantArrays();
799 /// @name Utility functions for printing and dumping Module objects
802 /// Print the module to an output stream with an optional
803 /// AssemblyAnnotationWriter. If \c ShouldPreserveUseListOrder, then include
804 /// uselistorder directives so that use-lists can be recreated when reading
806 void print(raw_ostream
&OS
, AssemblyAnnotationWriter
*AAW
,
807 bool ShouldPreserveUseListOrder
= false,
808 bool IsForDebug
= false) const;
810 /// Dump the module to stderr (for debugging).
813 /// This function causes all the subinstructions to "let go" of all references
814 /// that they are maintaining. This allows one to 'delete' a whole class at
815 /// a time, even though there may be circular references... first all
816 /// references are dropped, and all use counts go to zero. Then everything
817 /// is delete'd for real. Note that no operations are valid on an object
818 /// that has "dropped all references", except operator delete.
819 void dropAllReferences();
822 /// @name Utility functions for querying Debug information.
825 /// Returns the Number of Register ParametersDwarf Version by checking
827 unsigned getNumberRegisterParameters() const;
829 /// Returns the Dwarf Version by checking module flags.
830 unsigned getDwarfVersion() const;
832 /// Returns the CodeView Version by checking module flags.
833 /// Returns zero if not present in module.
834 unsigned getCodeViewFlag() const;
837 /// @name Utility functions for querying and setting PIC level
840 /// Returns the PIC level (small or large model)
841 PICLevel::Level
getPICLevel() const;
843 /// Set the PIC level (small or large model)
844 void setPICLevel(PICLevel::Level PL
);
848 /// @name Utility functions for querying and setting PIE level
851 /// Returns the PIE level (small or large model)
852 PIELevel::Level
getPIELevel() const;
854 /// Set the PIE level (small or large model)
855 void setPIELevel(PIELevel::Level PL
);
859 /// @name Utility function for querying and setting code model
862 /// Returns the code model (tiny, small, kernel, medium or large model)
863 Optional
<CodeModel::Model
> getCodeModel() const;
865 /// Set the code model (tiny, small, kernel, medium or large)
866 void setCodeModel(CodeModel::Model CL
);
869 /// @name Utility functions for querying and setting PGO summary
872 /// Attach profile summary metadata to this module.
873 void setProfileSummary(Metadata
*M
, ProfileSummary::Kind Kind
);
875 /// Returns profile summary metadata. When IsCS is true, use the context
876 /// sensitive profile summary.
877 Metadata
*getProfileSummary(bool IsCS
);
880 /// Returns true if PLT should be avoided for RTLib calls.
881 bool getRtLibUseGOT() const;
883 /// Set that PLT should be avoid for RTLib calls.
884 void setRtLibUseGOT();
886 /// @name Utility functions for querying and setting the build SDK version
889 /// Attach a build SDK version metadata to this module.
890 void setSDKVersion(const VersionTuple
&V
);
892 /// Get the build SDK version metadata.
894 /// An empty version is returned if no such metadata is attached.
895 VersionTuple
getSDKVersion() const;
898 /// Take ownership of the given memory buffer.
899 void setOwnedMemoryBuffer(std::unique_ptr
<MemoryBuffer
> MB
);
902 /// Given "llvm.used" or "llvm.compiler.used" as a global name, collect
903 /// the initializer elements of that global in Set and return the global itself.
904 GlobalVariable
*collectUsedGlobalVariables(const Module
&M
,
905 SmallPtrSetImpl
<GlobalValue
*> &Set
,
908 /// An raw_ostream inserter for modules.
909 inline raw_ostream
&operator<<(raw_ostream
&O
, const Module
&M
) {
914 // Create wrappers for C Binding types (see CBindingWrapping.h).
915 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module
, LLVMModuleRef
)
917 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
920 inline Module
*unwrap(LLVMModuleProviderRef MP
) {
921 return reinterpret_cast<Module
*>(MP
);
924 } // end namespace llvm
926 #endif // LLVM_IR_MODULE_H