1 //===-- llvm/Module.h - C++ class to represent a VM module ------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// Module.h This file contains the declarations for the Module class.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_IR_MODULE_H
16 #define LLVM_IR_MODULE_H
18 #include "llvm/ADT/iterator_range.h"
19 #include "llvm/IR/Comdat.h"
20 #include "llvm/IR/DataLayout.h"
21 #include "llvm/IR/Function.h"
22 #include "llvm/IR/GlobalAlias.h"
23 #include "llvm/IR/GlobalVariable.h"
24 #include "llvm/IR/Metadata.h"
25 #include "llvm/Support/CBindingWrapping.h"
26 #include "llvm/Support/CodeGen.h"
27 #include "llvm/Support/DataTypes.h"
28 #include <system_error>
34 class RandomNumberGenerator;
37 template<> struct ilist_traits<Function>
38 : public SymbolTableListTraits<Function, Module> {
40 // createSentinel is used to get hold of the node that marks the end of the
41 // list... (same trick used here as in ilist_traits<Instruction>)
42 Function *createSentinel() const {
43 return static_cast<Function*>(&Sentinel);
45 static void destroySentinel(Function*) {}
47 Function *provideInitialHead() const { return createSentinel(); }
48 Function *ensureHead(Function*) const { return createSentinel(); }
49 static void noteHead(Function*, Function*) {}
52 mutable ilist_node<Function> Sentinel;
55 template<> struct ilist_traits<GlobalVariable>
56 : public SymbolTableListTraits<GlobalVariable, Module> {
57 // createSentinel is used to create a node that marks the end of the list.
58 GlobalVariable *createSentinel() const {
59 return static_cast<GlobalVariable*>(&Sentinel);
61 static void destroySentinel(GlobalVariable*) {}
63 GlobalVariable *provideInitialHead() const { return createSentinel(); }
64 GlobalVariable *ensureHead(GlobalVariable*) const { return createSentinel(); }
65 static void noteHead(GlobalVariable*, GlobalVariable*) {}
67 mutable ilist_node<GlobalVariable> Sentinel;
70 template<> struct ilist_traits<GlobalAlias>
71 : public SymbolTableListTraits<GlobalAlias, Module> {
72 // createSentinel is used to create a node that marks the end of the list.
73 GlobalAlias *createSentinel() const {
74 return static_cast<GlobalAlias*>(&Sentinel);
76 static void destroySentinel(GlobalAlias*) {}
78 GlobalAlias *provideInitialHead() const { return createSentinel(); }
79 GlobalAlias *ensureHead(GlobalAlias*) const { return createSentinel(); }
80 static void noteHead(GlobalAlias*, GlobalAlias*) {}
82 mutable ilist_node<GlobalAlias> Sentinel;
85 template<> struct ilist_traits<NamedMDNode>
86 : public ilist_default_traits<NamedMDNode> {
87 // createSentinel is used to get hold of a node that marks the end of
89 NamedMDNode *createSentinel() const {
90 return static_cast<NamedMDNode*>(&Sentinel);
92 static void destroySentinel(NamedMDNode*) {}
94 NamedMDNode *provideInitialHead() const { return createSentinel(); }
95 NamedMDNode *ensureHead(NamedMDNode*) const { return createSentinel(); }
96 static void noteHead(NamedMDNode*, NamedMDNode*) {}
97 void addNodeToList(NamedMDNode *) {}
98 void removeNodeFromList(NamedMDNode *) {}
100 mutable ilist_node<NamedMDNode> Sentinel;
103 /// A Module instance is used to store all the information related to an
104 /// LLVM module. Modules are the top level container of all other LLVM
105 /// Intermediate Representation (IR) objects. Each module directly contains a
106 /// list of globals variables, a list of functions, a list of libraries (or
107 /// other modules) this module depends on, a symbol table, and various data
108 /// about the target's characteristics.
110 /// A module maintains a GlobalValRefMap object that is used to hold all
111 /// constant references to global variables in the module. When a global
112 /// variable is destroyed, it should have no entries in the GlobalValueRefMap.
113 /// @brief The main container class for the LLVM Intermediate Representation.
115 /// @name Types And Enumerations
118 /// The type for the list of global variables.
119 typedef iplist<GlobalVariable> GlobalListType;
120 /// The type for the list of functions.
121 typedef iplist<Function> FunctionListType;
122 /// The type for the list of aliases.
123 typedef iplist<GlobalAlias> AliasListType;
124 /// The type for the list of named metadata.
125 typedef ilist<NamedMDNode> NamedMDListType;
126 /// The type of the comdat "symbol" table.
127 typedef StringMap<Comdat> ComdatSymTabType;
129 /// The Global Variable iterator.
130 typedef GlobalListType::iterator global_iterator;
131 /// The Global Variable constant iterator.
132 typedef GlobalListType::const_iterator const_global_iterator;
134 /// The Function iterators.
135 typedef FunctionListType::iterator iterator;
136 /// The Function constant iterator
137 typedef FunctionListType::const_iterator const_iterator;
139 /// The Function reverse iterator.
140 typedef FunctionListType::reverse_iterator reverse_iterator;
141 /// The Function constant reverse iterator.
142 typedef FunctionListType::const_reverse_iterator const_reverse_iterator;
144 /// The Global Alias iterators.
145 typedef AliasListType::iterator alias_iterator;
146 /// The Global Alias constant iterator
147 typedef AliasListType::const_iterator const_alias_iterator;
149 /// The named metadata iterators.
150 typedef NamedMDListType::iterator named_metadata_iterator;
151 /// The named metadata constant iterators.
152 typedef NamedMDListType::const_iterator const_named_metadata_iterator;
154 /// This enumeration defines the supported behaviors of module flags.
155 enum ModFlagBehavior {
156 /// Emits an error if two values disagree, otherwise the resulting value is
157 /// that of the operands.
160 /// Emits a warning if two values disagree. The result value will be the
161 /// operand for the flag from the first module being linked.
164 /// Adds a requirement that another module flag be present and have a
165 /// specified value after linking is performed. The value must be a metadata
166 /// pair, where the first element of the pair is the ID of the module flag
167 /// to be restricted, and the second element of the pair is the value the
168 /// module flag should be restricted to. This behavior can be used to
169 /// restrict the allowable results (via triggering of an error) of linking
170 /// IDs with the **Override** behavior.
173 /// Uses the specified value, regardless of the behavior or value of the
174 /// other module. If both modules specify **Override**, but the values
175 /// differ, an error will be emitted.
178 /// Appends the two values, which are required to be metadata nodes.
181 /// Appends the two values, which are required to be metadata
182 /// nodes. However, duplicate entries in the second list are dropped
183 /// during the append operation.
187 ModFlagBehaviorFirstVal = Error,
188 ModFlagBehaviorLastVal = AppendUnique
191 /// Checks if Metadata represents a valid ModFlagBehavior, and stores the
192 /// converted result in MFB.
193 static bool isValidModFlagBehavior(Metadata *MD, ModFlagBehavior &MFB);
195 struct ModuleFlagEntry {
196 ModFlagBehavior Behavior;
199 ModuleFlagEntry(ModFlagBehavior B, MDString *K, Metadata *V)
200 : Behavior(B), Key(K), Val(V) {}
204 /// @name Member Variables
207 LLVMContext &Context; ///< The LLVMContext from which types and
208 ///< constants are allocated.
209 GlobalListType GlobalList; ///< The Global Variables in the module
210 FunctionListType FunctionList; ///< The Functions in the module
211 AliasListType AliasList; ///< The Aliases in the module
212 NamedMDListType NamedMDList; ///< The named metadata in the module
213 std::string GlobalScopeAsm; ///< Inline Asm at global scope.
214 ValueSymbolTable *ValSymTab; ///< Symbol table for values
215 ComdatSymTabType ComdatSymTab; ///< Symbol table for COMDATs
216 std::unique_ptr<GVMaterializer>
217 Materializer; ///< Used to materialize GlobalValues
218 std::string ModuleID; ///< Human readable identifier for the module
219 std::string TargetTriple; ///< Platform target triple Module compiled on
220 ///< Format: (arch)(sub)-(vendor)-(sys0-(abi)
221 void *NamedMDSymTab; ///< NamedMDNode names.
222 DataLayout DL; ///< DataLayout associated with the module
224 friend class Constant;
227 /// @name Constructors
230 /// The Module constructor. Note that there is no default constructor. You
231 /// must provide a name for the module upon construction.
232 explicit Module(StringRef ModuleID, LLVMContext& C);
233 /// The module destructor. This will dropAllReferences.
237 /// @name Module Level Accessors
240 /// Get the module identifier which is, essentially, the name of the module.
241 /// @returns the module identifier as a string
242 const std::string &getModuleIdentifier() const { return ModuleID; }
244 /// \brief Get a short "name" for the module.
246 /// This is useful for debugging or logging. It is essentially a convenience
247 /// wrapper around getModuleIdentifier().
248 StringRef getName() const { return ModuleID; }
250 /// Get the data layout string for the module's target platform. This is
251 /// equivalent to getDataLayout()->getStringRepresentation().
252 const std::string getDataLayoutStr() const {
253 return DL.getStringRepresentation();
256 /// Get the data layout for the module's target platform.
257 const DataLayout &getDataLayout() const;
259 /// Get the target triple which is a string describing the target host.
260 /// @returns a string containing the target triple.
261 const std::string &getTargetTriple() const { return TargetTriple; }
263 /// Get the global data context.
264 /// @returns LLVMContext - a container for LLVM's global information
265 LLVMContext &getContext() const { return Context; }
267 /// Get any module-scope inline assembly blocks.
268 /// @returns a string containing the module-scope inline assembly blocks.
269 const std::string &getModuleInlineAsm() const { return GlobalScopeAsm; }
271 /// Get a RandomNumberGenerator salted for use with this module. The
272 /// RNG can be seeded via -rng-seed=<uint64> and is salted with the
273 /// ModuleID and the provided pass salt. The returned RNG should not
274 /// be shared across threads or passes.
276 /// A unique RNG per pass ensures a reproducible random stream even
277 /// when other randomness consuming passes are added or removed. In
278 /// addition, the random stream will be reproducible across LLVM
279 /// versions when the pass does not change.
280 RandomNumberGenerator *createRNG(const Pass* P) const;
283 /// @name Module Level Mutators
286 /// Set the module identifier.
287 void setModuleIdentifier(StringRef ID) { ModuleID = ID; }
289 /// Set the data layout
290 void setDataLayout(StringRef Desc);
291 void setDataLayout(const DataLayout &Other);
293 /// Set the target triple.
294 void setTargetTriple(StringRef T) { TargetTriple = T; }
296 /// Set the module-scope inline assembly blocks.
297 void setModuleInlineAsm(StringRef Asm) {
298 GlobalScopeAsm = Asm;
299 if (!GlobalScopeAsm.empty() &&
300 GlobalScopeAsm[GlobalScopeAsm.size()-1] != '\n')
301 GlobalScopeAsm += '\n';
304 /// Append to the module-scope inline assembly blocks, automatically inserting
305 /// a separating newline if necessary.
306 void appendModuleInlineAsm(StringRef Asm) {
307 GlobalScopeAsm += Asm;
308 if (!GlobalScopeAsm.empty() &&
309 GlobalScopeAsm[GlobalScopeAsm.size()-1] != '\n')
310 GlobalScopeAsm += '\n';
314 /// @name Generic Value Accessors
317 /// Return the global value in the module with the specified name, of
318 /// arbitrary type. This method returns null if a global with the specified
319 /// name is not found.
320 GlobalValue *getNamedValue(StringRef Name) const;
322 /// Return a unique non-zero ID for the specified metadata kind. This ID is
323 /// uniqued across modules in the current LLVMContext.
324 unsigned getMDKindID(StringRef Name) const;
326 /// Populate client supplied SmallVector with the name for custom metadata IDs
327 /// registered in this LLVMContext.
328 void getMDKindNames(SmallVectorImpl<StringRef> &Result) const;
330 /// Return the type with the specified name, or null if there is none by that
332 StructType *getTypeByName(StringRef Name) const;
334 std::vector<StructType *> getIdentifiedStructTypes() const;
337 /// @name Function Accessors
340 /// Look up the specified function in the module symbol table. Four
342 /// 1. If it does not exist, add a prototype for the function and return it.
343 /// 2. If it exists, and has a local linkage, the existing function is
344 /// renamed and a new one is inserted.
345 /// 3. Otherwise, if the existing function has the correct prototype, return
346 /// the existing function.
347 /// 4. Finally, the function exists but has the wrong prototype: return the
348 /// function with a constantexpr cast to the right prototype.
349 Constant *getOrInsertFunction(StringRef Name, FunctionType *T,
350 AttributeSet AttributeList);
352 Constant *getOrInsertFunction(StringRef Name, FunctionType *T);
354 /// Look up the specified function in the module symbol table. If it does not
355 /// exist, add a prototype for the function and return it. This function
356 /// guarantees to return a constant of pointer to the specified function type
357 /// or a ConstantExpr BitCast of that type if the named function has a
358 /// different type. This version of the method takes a null terminated list of
359 /// function arguments, which makes it easier for clients to use.
360 Constant *getOrInsertFunction(StringRef Name,
361 AttributeSet AttributeList,
362 Type *RetTy, ...) LLVM_END_WITH_NULL;
364 /// Same as above, but without the attributes.
365 Constant *getOrInsertFunction(StringRef Name, Type *RetTy, ...)
368 /// Look up the specified function in the module symbol table. If it does not
369 /// exist, return null.
370 Function *getFunction(StringRef Name) const;
373 /// @name Global Variable Accessors
376 /// Look up the specified global variable in the module symbol table. If it
377 /// does not exist, return null. If AllowInternal is set to true, this
378 /// function will return types that have InternalLinkage. By default, these
379 /// types are not returned.
380 GlobalVariable *getGlobalVariable(StringRef Name) const {
381 return getGlobalVariable(Name, false);
384 GlobalVariable *getGlobalVariable(StringRef Name, bool AllowInternal) const {
385 return const_cast<Module *>(this)->getGlobalVariable(Name, AllowInternal);
388 GlobalVariable *getGlobalVariable(StringRef Name, bool AllowInternal = false);
390 /// Return the global variable in the module with the specified name, of
391 /// arbitrary type. This method returns null if a global with the specified
392 /// name is not found.
393 GlobalVariable *getNamedGlobal(StringRef Name) {
394 return getGlobalVariable(Name, true);
396 const GlobalVariable *getNamedGlobal(StringRef Name) const {
397 return const_cast<Module *>(this)->getNamedGlobal(Name);
400 /// Look up the specified global in the module symbol table.
401 /// 1. If it does not exist, add a declaration of the global and return it.
402 /// 2. Else, the global exists but has the wrong type: return the function
403 /// with a constantexpr cast to the right type.
404 /// 3. Finally, if the existing global is the correct declaration, return
405 /// the existing global.
406 Constant *getOrInsertGlobal(StringRef Name, Type *Ty);
409 /// @name Global Alias Accessors
412 /// Return the global alias in the module with the specified name, of
413 /// arbitrary type. This method returns null if a global with the specified
414 /// name is not found.
415 GlobalAlias *getNamedAlias(StringRef Name) const;
418 /// @name Named Metadata Accessors
421 /// Return the first NamedMDNode in the module with the specified name. This
422 /// method returns null if a NamedMDNode with the specified name is not found.
423 NamedMDNode *getNamedMetadata(const Twine &Name) const;
425 /// Return the named MDNode in the module with the specified name. This method
426 /// returns a new NamedMDNode if a NamedMDNode with the specified name is not
428 NamedMDNode *getOrInsertNamedMetadata(StringRef Name);
430 /// Remove the given NamedMDNode from this module and delete it.
431 void eraseNamedMetadata(NamedMDNode *NMD);
434 /// @name Comdat Accessors
437 /// Return the Comdat in the module with the specified name. It is created
438 /// if it didn't already exist.
439 Comdat *getOrInsertComdat(StringRef Name);
442 /// @name Module Flags Accessors
445 /// Returns the module flags in the provided vector.
446 void getModuleFlagsMetadata(SmallVectorImpl<ModuleFlagEntry> &Flags) const;
448 /// Return the corresponding value if Key appears in module flags, otherwise
450 Metadata *getModuleFlag(StringRef Key) const;
452 /// Returns the NamedMDNode in the module that represents module-level flags.
453 /// This method returns null if there are no module-level flags.
454 NamedMDNode *getModuleFlagsMetadata() const;
456 /// Returns the NamedMDNode in the module that represents module-level flags.
457 /// If module-level flags aren't found, it creates the named metadata that
459 NamedMDNode *getOrInsertModuleFlagsMetadata();
461 /// Add a module-level flag to the module-level flags metadata. It will create
462 /// the module-level flags named metadata if it doesn't already exist.
463 void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, Metadata *Val);
464 void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, Constant *Val);
465 void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, uint32_t Val);
466 void addModuleFlag(MDNode *Node);
469 /// @name Materialization
472 /// Sets the GVMaterializer to GVM. This module must not yet have a
473 /// Materializer. To reset the materializer for a module that already has one,
474 /// call MaterializeAllPermanently first. Destroying this module will destroy
475 /// its materializer without materializing any more GlobalValues. Without
476 /// destroying the Module, there is no way to detach or destroy a materializer
477 /// without materializing all the GVs it controls, to avoid leaving orphan
478 /// unmaterialized GVs.
479 void setMaterializer(GVMaterializer *GVM);
480 /// Retrieves the GVMaterializer, if any, for this Module.
481 GVMaterializer *getMaterializer() const { return Materializer.get(); }
483 /// Returns true if this GV was loaded from this Module's GVMaterializer and
484 /// the GVMaterializer knows how to dematerialize the GV.
485 bool isDematerializable(const GlobalValue *GV) const;
487 /// Make sure the GlobalValue is fully read. If the module is corrupt, this
488 /// returns true and fills in the optional string with information about the
489 /// problem. If successful, this returns false.
490 std::error_code materialize(GlobalValue *GV);
491 /// If the GlobalValue is read in, and if the GVMaterializer supports it,
492 /// release the memory for the function, and set it up to be materialized
493 /// lazily. If !isDematerializable(), this method is a no-op.
494 void Dematerialize(GlobalValue *GV);
496 /// Make sure all GlobalValues in this Module are fully read.
497 std::error_code materializeAll();
499 /// Make sure all GlobalValues in this Module are fully read and clear the
500 /// Materializer. If the module is corrupt, this DOES NOT clear the old
502 std::error_code materializeAllPermanently();
505 /// @name Direct access to the globals list, functions list, and symbol table
508 /// Get the Module's list of global variables (constant).
509 const GlobalListType &getGlobalList() const { return GlobalList; }
510 /// Get the Module's list of global variables.
511 GlobalListType &getGlobalList() { return GlobalList; }
512 static iplist<GlobalVariable> Module::*getSublistAccess(GlobalVariable*) {
513 return &Module::GlobalList;
515 /// Get the Module's list of functions (constant).
516 const FunctionListType &getFunctionList() const { return FunctionList; }
517 /// Get the Module's list of functions.
518 FunctionListType &getFunctionList() { return FunctionList; }
519 static iplist<Function> Module::*getSublistAccess(Function*) {
520 return &Module::FunctionList;
522 /// Get the Module's list of aliases (constant).
523 const AliasListType &getAliasList() const { return AliasList; }
524 /// Get the Module's list of aliases.
525 AliasListType &getAliasList() { return AliasList; }
526 static iplist<GlobalAlias> Module::*getSublistAccess(GlobalAlias*) {
527 return &Module::AliasList;
529 /// Get the Module's list of named metadata (constant).
530 const NamedMDListType &getNamedMDList() const { return NamedMDList; }
531 /// Get the Module's list of named metadata.
532 NamedMDListType &getNamedMDList() { return NamedMDList; }
533 static ilist<NamedMDNode> Module::*getSublistAccess(NamedMDNode*) {
534 return &Module::NamedMDList;
536 /// Get the symbol table of global variable and function identifiers
537 const ValueSymbolTable &getValueSymbolTable() const { return *ValSymTab; }
538 /// Get the Module's symbol table of global variable and function identifiers.
539 ValueSymbolTable &getValueSymbolTable() { return *ValSymTab; }
540 /// Get the Module's symbol table for COMDATs (constant).
541 const ComdatSymTabType &getComdatSymbolTable() const { return ComdatSymTab; }
542 /// Get the Module's symbol table for COMDATs.
543 ComdatSymTabType &getComdatSymbolTable() { return ComdatSymTab; }
546 /// @name Global Variable Iteration
549 global_iterator global_begin() { return GlobalList.begin(); }
550 const_global_iterator global_begin() const { return GlobalList.begin(); }
551 global_iterator global_end () { return GlobalList.end(); }
552 const_global_iterator global_end () const { return GlobalList.end(); }
553 bool global_empty() const { return GlobalList.empty(); }
555 iterator_range<global_iterator> globals() {
556 return iterator_range<global_iterator>(global_begin(), global_end());
558 iterator_range<const_global_iterator> globals() const {
559 return iterator_range<const_global_iterator>(global_begin(), global_end());
563 /// @name Function Iteration
566 iterator begin() { return FunctionList.begin(); }
567 const_iterator begin() const { return FunctionList.begin(); }
568 iterator end () { return FunctionList.end(); }
569 const_iterator end () const { return FunctionList.end(); }
570 reverse_iterator rbegin() { return FunctionList.rbegin(); }
571 const_reverse_iterator rbegin() const{ return FunctionList.rbegin(); }
572 reverse_iterator rend() { return FunctionList.rend(); }
573 const_reverse_iterator rend() const { return FunctionList.rend(); }
574 size_t size() const { return FunctionList.size(); }
575 bool empty() const { return FunctionList.empty(); }
577 iterator_range<iterator> functions() {
578 return iterator_range<iterator>(begin(), end());
580 iterator_range<const_iterator> functions() const {
581 return iterator_range<const_iterator>(begin(), end());
585 /// @name Alias Iteration
588 alias_iterator alias_begin() { return AliasList.begin(); }
589 const_alias_iterator alias_begin() const { return AliasList.begin(); }
590 alias_iterator alias_end () { return AliasList.end(); }
591 const_alias_iterator alias_end () const { return AliasList.end(); }
592 size_t alias_size () const { return AliasList.size(); }
593 bool alias_empty() const { return AliasList.empty(); }
595 iterator_range<alias_iterator> aliases() {
596 return iterator_range<alias_iterator>(alias_begin(), alias_end());
598 iterator_range<const_alias_iterator> aliases() const {
599 return iterator_range<const_alias_iterator>(alias_begin(), alias_end());
603 /// @name Named Metadata Iteration
606 named_metadata_iterator named_metadata_begin() { return NamedMDList.begin(); }
607 const_named_metadata_iterator named_metadata_begin() const {
608 return NamedMDList.begin();
611 named_metadata_iterator named_metadata_end() { return NamedMDList.end(); }
612 const_named_metadata_iterator named_metadata_end() const {
613 return NamedMDList.end();
616 size_t named_metadata_size() const { return NamedMDList.size(); }
617 bool named_metadata_empty() const { return NamedMDList.empty(); }
619 iterator_range<named_metadata_iterator> named_metadata() {
620 return iterator_range<named_metadata_iterator>(named_metadata_begin(),
621 named_metadata_end());
623 iterator_range<const_named_metadata_iterator> named_metadata() const {
624 return iterator_range<const_named_metadata_iterator>(named_metadata_begin(),
625 named_metadata_end());
628 /// Destroy ConstantArrays in LLVMContext if they are not used.
629 /// ConstantArrays constructed during linking can cause quadratic memory
630 /// explosion. Releasing all unused constants can cause a 20% LTO compile-time
631 /// slowdown for a large application.
633 /// NOTE: Constants are currently owned by LLVMContext. This can then only
634 /// be called where all uses of the LLVMContext are understood.
635 void dropTriviallyDeadConstantArrays();
638 /// @name Utility functions for printing and dumping Module objects
641 /// Print the module to an output stream with an optional
642 /// AssemblyAnnotationWriter.
643 void print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const;
645 /// Dump the module to stderr (for debugging).
648 /// This function causes all the subinstructions to "let go" of all references
649 /// that they are maintaining. This allows one to 'delete' a whole class at
650 /// a time, even though there may be circular references... first all
651 /// references are dropped, and all use counts go to zero. Then everything
652 /// is delete'd for real. Note that no operations are valid on an object
653 /// that has "dropped all references", except operator delete.
654 void dropAllReferences();
657 /// @name Utility functions for querying Debug information.
660 /// \brief Returns the Dwarf Version by checking module flags.
661 unsigned getDwarfVersion() const;
664 /// @name Utility functions for querying and setting PIC level
667 /// \brief Returns the PIC level (small or large model)
668 PICLevel::Level getPICLevel() const;
670 /// \brief Set the PIC level (small or large model)
671 void setPICLevel(PICLevel::Level PL);
675 /// An raw_ostream inserter for modules.
676 inline raw_ostream &operator<<(raw_ostream &O, const Module &M) {
681 // Create wrappers for C Binding types (see CBindingWrapping.h).
682 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef)
684 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
687 inline Module *unwrap(LLVMModuleProviderRef MP) {
688 return reinterpret_cast<Module*>(MP);
691 } // End llvm namespace