[llvm] [cmake] Add possibility to use ChooseMSVCCRT.cmake when include LLVM library
[llvm-core.git] / include / llvm / IR / Module.h
blobf458680cfe15d6f2b6bbf69d19227fc17b247209
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.
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"
35 #include <cstddef>
36 #include <cstdint>
37 #include <iterator>
38 #include <memory>
39 #include <string>
40 #include <vector>
42 namespace llvm {
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;
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>;
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;
87 /// The Function iterators.
88 using iterator = FunctionListType::iterator;
89 /// The Function constant iterator
90 using const_iterator = FunctionListType::const_iterator;
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;
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;
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;
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;
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,
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,
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,
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,
136 /// Appends the two values, which are required to be metadata nodes.
137 Append = 5,
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,
144 /// Takes the max of the two values, which are required to be integers.
145 Max = 7,
147 // Markers:
148 ModFlagBehaviorFirstVal = Error,
149 ModFlagBehaviorLastVal = Max
152 /// Checks if Metadata represents a valid ModFlagBehavior, and stores the
153 /// converted result in MFB.
154 static bool isValidModFlagBehavior(Metadata *MD, ModFlagBehavior &MFB);
156 struct ModuleFlagEntry {
157 ModFlagBehavior Behavior;
158 MDString *Key;
159 Metadata *Val;
161 ModuleFlagEntry(ModFlagBehavior B, MDString *K, Metadata *V)
162 : Behavior(B), Key(K), Val(V) {}
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
192 friend class Constant;
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();
204 /// @}
205 /// @name Module Level Accessors
206 /// @{
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; }
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();
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; }
223 /// Get a short "name" for the module.
225 /// This is useful for debugging or logging. It is essentially a convenience
226 /// wrapper around getModuleIdentifier().
227 StringRef getName() const { return ModuleID; }
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();
235 /// Get the data layout for the module's target platform.
236 const DataLayout &getDataLayout() const;
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; }
242 /// Get the global data context.
243 /// @returns LLVMContext - a container for LLVM's global information
244 LLVMContext &getContext() const { return Context; }
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; }
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.
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;
261 /// Return true if size-info optimization remark is enabled, false
262 /// otherwise.
263 bool shouldEmitInstrCountChangedRemark() {
264 return getContext().getDiagHandlerPtr()->isAnalysisRemarkEnabled(
265 "size-info");
268 /// @}
269 /// @name Module Level Mutators
270 /// @{
272 /// Set the module identifier.
273 void setModuleIdentifier(StringRef ID) { ModuleID = ID; }
275 /// Set the module's original source file name.
276 void setSourceFileName(StringRef Name) { SourceFileName = Name; }
278 /// Set the data layout
279 void setDataLayout(StringRef Desc);
280 void setDataLayout(const DataLayout &Other);
282 /// Set the target triple.
283 void setTargetTriple(StringRef T) { TargetTriple = T; }
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';
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';
301 /// @}
302 /// @name Generic Value Accessors
303 /// @{
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;
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;
314 /// Populate client supplied SmallVector with the name for custom metadata IDs
315 /// registered in this LLVMContext.
316 void getMDKindNames(SmallVectorImpl<StringRef> &Result) const;
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;
323 /// Return the type with the specified name, or null if there is none by that
324 /// name.
325 StructType *getTypeByName(StringRef Name) const;
327 std::vector<StructType *> getIdentifiedStructTypes() const;
329 /// @}
330 /// @name Function Accessors
331 /// @{
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.
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.
344 FunctionCallee getOrInsertFunction(StringRef Name, FunctionType *T,
345 AttributeList AttributeList);
347 FunctionCallee getOrInsertFunction(StringRef Name, FunctionType *T);
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>
356 FunctionCallee getOrInsertFunction(StringRef Name,
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);
365 /// Same as above, but without the attributes.
366 template <typename... ArgsTy>
367 FunctionCallee getOrInsertFunction(StringRef Name, Type *RetTy,
368 ArgsTy... Args) {
369 return getOrInsertFunction(Name, AttributeList{}, RetTy, Args...);
372 // Avoid an incorrect ordering that'd otherwise compile incorrectly.
373 template <typename... ArgsTy>
374 FunctionCallee
375 getOrInsertFunction(StringRef Name, AttributeList AttributeList,
376 FunctionType *Invalid, ArgsTy... Args) = delete;
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;
382 /// @}
383 /// @name Global Variable Accessors
384 /// @{
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.
390 GlobalVariable *getGlobalVariable(StringRef Name) const {
391 return getGlobalVariable(Name, false);
394 GlobalVariable *getGlobalVariable(StringRef Name, bool AllowInternal) const;
396 GlobalVariable *getGlobalVariable(StringRef Name,
397 bool AllowInternal = false) {
398 return static_cast<const Module *>(this)->getGlobalVariable(Name,
399 AllowInternal);
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.
405 const GlobalVariable *getNamedGlobal(StringRef Name) const {
406 return getGlobalVariable(Name, true);
408 GlobalVariable *getNamedGlobal(StringRef Name) {
409 return const_cast<GlobalVariable *>(
410 static_cast<const Module *>(this)->getNamedGlobal(Name));
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);
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.
423 Constant *getOrInsertGlobal(StringRef Name, Type *Ty);
425 /// @}
426 /// @name Global Alias Accessors
427 /// @{
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;
434 /// @}
435 /// @name Global IFunc Accessors
436 /// @{
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;
443 /// @}
444 /// @name Named Metadata Accessors
445 /// @{
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;
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.
454 NamedMDNode *getOrInsertNamedMetadata(StringRef Name);
456 /// Remove the given NamedMDNode from this module and delete it.
457 void eraseNamedMetadata(NamedMDNode *NMD);
459 /// @}
460 /// @name Comdat Accessors
461 /// @{
463 /// Return the Comdat in the module with the specified name. It is created
464 /// if it didn't already exist.
465 Comdat *getOrInsertComdat(StringRef Name);
467 /// @}
468 /// @name Module Flags Accessors
469 /// @{
471 /// Returns the module flags in the provided vector.
472 void getModuleFlagsMetadata(SmallVectorImpl<ModuleFlagEntry> &Flags) const;
474 /// Return the corresponding value if Key appears in module flags, otherwise
475 /// return null.
476 Metadata *getModuleFlag(StringRef Key) const;
478 /// Returns the NamedMDNode in the module that represents module-level flags.
479 /// This method returns null if there are no module-level flags.
480 NamedMDNode *getModuleFlagsMetadata() const;
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.
485 NamedMDNode *getOrInsertModuleFlagsMetadata();
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.
489 void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, Metadata *Val);
490 void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, Constant *Val);
491 void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, uint32_t Val);
492 void addModuleFlag(MDNode *Node);
494 /// @}
495 /// @name Materialization
496 /// @{
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(); }
510 /// Make sure the GlobalValue is fully read.
511 llvm::Error materialize(GlobalValue *GV);
513 /// Make sure all GlobalValues in this Module are fully read and clear the
514 /// Materializer.
515 llvm::Error materializeAll();
517 llvm::Error materializeMetadata();
519 /// @}
520 /// @name Direct access to the globals list, functions list, and symbol table
521 /// @{
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; }
528 static GlobalListType Module::*getSublistAccess(GlobalVariable*) {
529 return &Module::GlobalList;
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; }
536 static FunctionListType Module::*getSublistAccess(Function*) {
537 return &Module::FunctionList;
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; }
545 static AliasListType Module::*getSublistAccess(GlobalAlias*) {
546 return &Module::AliasList;
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; }
554 static IFuncListType Module::*getSublistAccess(GlobalIFunc*) {
555 return &Module::IFuncList;
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; }
563 static NamedMDListType Module::*getSublistAccess(NamedMDNode*) {
564 return &Module::NamedMDList;
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; }
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; }
577 /// @}
578 /// @name Global Variable Iteration
579 /// @{
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(); }
587 iterator_range<global_iterator> globals() {
588 return make_range(global_begin(), global_end());
590 iterator_range<const_global_iterator> globals() const {
591 return make_range(global_begin(), global_end());
594 /// @}
595 /// @name Function Iteration
596 /// @{
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(); }
609 iterator_range<iterator> functions() {
610 return make_range(begin(), end());
612 iterator_range<const_iterator> functions() const {
613 return make_range(begin(), end());
616 /// @}
617 /// @name Alias Iteration
618 /// @{
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(); }
627 iterator_range<alias_iterator> aliases() {
628 return make_range(alias_begin(), alias_end());
630 iterator_range<const_alias_iterator> aliases() const {
631 return make_range(alias_begin(), alias_end());
634 /// @}
635 /// @name IFunc Iteration
636 /// @{
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(); }
645 iterator_range<ifunc_iterator> ifuncs() {
646 return make_range(ifunc_begin(), ifunc_end());
648 iterator_range<const_ifunc_iterator> ifuncs() const {
649 return make_range(ifunc_begin(), ifunc_end());
652 /// @}
653 /// @name Convenience iterators
654 /// @{
656 using global_object_iterator =
657 concat_iterator<GlobalObject, iterator, global_iterator>;
658 using const_global_object_iterator =
659 concat_iterator<const GlobalObject, const_iterator,
660 const_global_iterator>;
662 iterator_range<global_object_iterator> global_objects() {
663 return concat<GlobalObject>(functions(), globals());
665 iterator_range<const_global_object_iterator> global_objects() const {
666 return concat<const GlobalObject>(functions(), globals());
669 global_object_iterator global_object_begin() {
670 return global_objects().begin();
672 global_object_iterator global_object_end() { return global_objects().end(); }
674 const_global_object_iterator global_object_begin() const {
675 return global_objects().begin();
677 const_global_object_iterator global_object_end() const {
678 return global_objects().end();
681 using global_value_iterator =
682 concat_iterator<GlobalValue, iterator, global_iterator, alias_iterator,
683 ifunc_iterator>;
684 using const_global_value_iterator =
685 concat_iterator<const GlobalValue, const_iterator, const_global_iterator,
686 const_alias_iterator, const_ifunc_iterator>;
688 iterator_range<global_value_iterator> global_values() {
689 return concat<GlobalValue>(functions(), globals(), aliases(), ifuncs());
691 iterator_range<const_global_value_iterator> global_values() const {
692 return concat<const GlobalValue>(functions(), globals(), aliases(),
693 ifuncs());
696 global_value_iterator global_value_begin() { return global_values().begin(); }
697 global_value_iterator global_value_end() { return global_values().end(); }
699 const_global_value_iterator global_value_begin() const {
700 return global_values().begin();
702 const_global_value_iterator global_value_end() const {
703 return global_values().end();
706 /// @}
707 /// @name Named Metadata Iteration
708 /// @{
710 named_metadata_iterator named_metadata_begin() { return NamedMDList.begin(); }
711 const_named_metadata_iterator named_metadata_begin() const {
712 return NamedMDList.begin();
715 named_metadata_iterator named_metadata_end() { return NamedMDList.end(); }
716 const_named_metadata_iterator named_metadata_end() const {
717 return NamedMDList.end();
720 size_t named_metadata_size() const { return NamedMDList.size(); }
721 bool named_metadata_empty() const { return NamedMDList.empty(); }
723 iterator_range<named_metadata_iterator> named_metadata() {
724 return make_range(named_metadata_begin(), named_metadata_end());
726 iterator_range<const_named_metadata_iterator> named_metadata() const {
727 return make_range(named_metadata_begin(), named_metadata_end());
730 /// An iterator for DICompileUnits that skips those marked NoDebug.
731 class debug_compile_units_iterator
732 : public std::iterator<std::input_iterator_tag, DICompileUnit *> {
733 NamedMDNode *CUs;
734 unsigned Idx;
736 void SkipNoDebugCUs();
738 public:
739 explicit debug_compile_units_iterator(NamedMDNode *CUs, unsigned Idx)
740 : CUs(CUs), Idx(Idx) {
741 SkipNoDebugCUs();
744 debug_compile_units_iterator &operator++() {
745 ++Idx;
746 SkipNoDebugCUs();
747 return *this;
750 debug_compile_units_iterator operator++(int) {
751 debug_compile_units_iterator T(*this);
752 ++Idx;
753 return T;
756 bool operator==(const debug_compile_units_iterator &I) const {
757 return Idx == I.Idx;
760 bool operator!=(const debug_compile_units_iterator &I) const {
761 return Idx != I.Idx;
764 DICompileUnit *operator*() const;
765 DICompileUnit *operator->() const;
768 debug_compile_units_iterator debug_compile_units_begin() const {
769 auto *CUs = getNamedMetadata("llvm.dbg.cu");
770 return debug_compile_units_iterator(CUs, 0);
773 debug_compile_units_iterator debug_compile_units_end() const {
774 auto *CUs = getNamedMetadata("llvm.dbg.cu");
775 return debug_compile_units_iterator(CUs, CUs ? CUs->getNumOperands() : 0);
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.
781 iterator_range<debug_compile_units_iterator> debug_compile_units() const {
782 auto *CUs = getNamedMetadata("llvm.dbg.cu");
783 return make_range(
784 debug_compile_units_iterator(CUs, 0),
785 debug_compile_units_iterator(CUs, CUs ? CUs->getNumOperands() : 0));
787 /// @}
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.
794 /// NOTE: Constants are currently owned by LLVMContext. This can then only
795 /// be called where all uses of the LLVMContext are understood.
796 void dropTriviallyDeadConstantArrays();
798 /// @name Utility functions for printing and dumping Module objects
799 /// @{
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.
805 void print(raw_ostream &OS, AssemblyAnnotationWriter *AAW,
806 bool ShouldPreserveUseListOrder = false,
807 bool IsForDebug = false) const;
809 /// Dump the module to stderr (for debugging).
810 void dump() const;
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();
820 /// @}
821 /// @name Utility functions for querying Debug information.
822 /// @{
824 /// Returns the Number of Register ParametersDwarf Version by checking
825 /// module flags.
826 unsigned getNumberRegisterParameters() const;
828 /// Returns the Dwarf Version by checking module flags.
829 unsigned getDwarfVersion() const;
831 /// Returns the CodeView Version by checking module flags.
832 /// Returns zero if not present in module.
833 unsigned getCodeViewFlag() const;
835 /// @}
836 /// @name Utility functions for querying and setting PIC level
837 /// @{
839 /// Returns the PIC level (small or large model)
840 PICLevel::Level getPICLevel() const;
842 /// Set the PIC level (small or large model)
843 void setPICLevel(PICLevel::Level PL);
844 /// @}
846 /// @}
847 /// @name Utility functions for querying and setting PIE level
848 /// @{
850 /// Returns the PIE level (small or large model)
851 PIELevel::Level getPIELevel() const;
853 /// Set the PIE level (small or large model)
854 void setPIELevel(PIELevel::Level PL);
855 /// @}
857 /// @}
858 /// @name Utility function for querying and setting code model
859 /// @{
861 /// Returns the code model (tiny, small, kernel, medium or large model)
862 Optional<CodeModel::Model> getCodeModel() const;
864 /// Set the code model (tiny, small, kernel, medium or large)
865 void setCodeModel(CodeModel::Model CL);
866 /// @}
868 /// @name Utility functions for querying and setting PGO summary
869 /// @{
871 /// Attach profile summary metadata to this module.
872 void setProfileSummary(Metadata *M, ProfileSummary::Kind Kind);
874 /// Returns profile summary metadata. When IsCS is true, use the context
875 /// sensitive profile summary.
876 Metadata *getProfileSummary(bool IsCS);
877 /// @}
879 /// Returns true if PLT should be avoided for RTLib calls.
880 bool getRtLibUseGOT() const;
882 /// Set that PLT should be avoid for RTLib calls.
883 void setRtLibUseGOT();
885 /// @name Utility functions for querying and setting the build SDK version
886 /// @{
888 /// Attach a build SDK version metadata to this module.
889 void setSDKVersion(const VersionTuple &V);
891 /// Get the build SDK version metadata.
893 /// An empty version is returned if no such metadata is attached.
894 VersionTuple getSDKVersion() const;
895 /// @}
897 /// Take ownership of the given memory buffer.
898 void setOwnedMemoryBuffer(std::unique_ptr<MemoryBuffer> MB);
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.
903 GlobalVariable *collectUsedGlobalVariables(const Module &M,
904 SmallPtrSetImpl<GlobalValue *> &Set,
905 bool CompilerUsed);
907 /// An raw_ostream inserter for modules.
908 inline raw_ostream &operator<<(raw_ostream &O, const Module &M) {
909 M.print(O, nullptr);
910 return O;
913 // Create wrappers for C Binding types (see CBindingWrapping.h).
914 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef)
916 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
917 * Module.
919 inline Module *unwrap(LLVMModuleProviderRef MP) {
920 return reinterpret_cast<Module*>(MP);
923 } // end namespace llvm
925 #endif // LLVM_IR_MODULE_H