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/DataLayout.h"
20 #include "llvm/IR/Function.h"
21 #include "llvm/IR/GlobalAlias.h"
22 #include "llvm/IR/GlobalVariable.h"
23 #include "llvm/IR/Metadata.h"
24 #include "llvm/Support/CBindingWrapping.h"
25 #include "llvm/Support/DataTypes.h"
26 #include "llvm/Support/system_error.h"
34 template<typename T> struct DenseMapInfo;
35 template<typename KeyT, typename ValueT, typename KeyInfoT> class DenseMap;
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;
127 /// The Global Variable iterator.
128 typedef GlobalListType::iterator global_iterator;
129 /// The Global Variable constant iterator.
130 typedef GlobalListType::const_iterator const_global_iterator;
132 /// The Function iterators.
133 typedef FunctionListType::iterator iterator;
134 /// The Function constant iterator
135 typedef FunctionListType::const_iterator const_iterator;
137 /// The Global Alias iterators.
138 typedef AliasListType::iterator alias_iterator;
139 /// The Global Alias constant iterator
140 typedef AliasListType::const_iterator const_alias_iterator;
142 /// The named metadata iterators.
143 typedef NamedMDListType::iterator named_metadata_iterator;
144 /// The named metadata constant interators.
145 typedef NamedMDListType::const_iterator const_named_metadata_iterator;
147 /// This enumeration defines the supported behaviors of module flags.
148 enum ModFlagBehavior {
149 /// Emits an error if two values disagree, otherwise the resulting value is
150 /// that of the operands.
153 /// Emits a warning if two values disagree. The result value will be the
154 /// operand for the flag from the first module being linked.
157 /// Adds a requirement that another module flag be present and have a
158 /// specified value after linking is performed. The value must be a metadata
159 /// pair, where the first element of the pair is the ID of the module flag
160 /// to be restricted, and the second element of the pair is the value the
161 /// module flag should be restricted to. This behavior can be used to
162 /// restrict the allowable results (via triggering of an error) of linking
163 /// IDs with the **Override** behavior.
166 /// Uses the specified value, regardless of the behavior or value of the
167 /// other module. If both modules specify **Override**, but the values
168 /// differ, an error will be emitted.
171 /// Appends the two values, which are required to be metadata nodes.
174 /// Appends the two values, which are required to be metadata
175 /// nodes. However, duplicate entries in the second list are dropped
176 /// during the append operation.
180 struct ModuleFlagEntry {
181 ModFlagBehavior Behavior;
184 ModuleFlagEntry(ModFlagBehavior B, MDString *K, Value *V)
185 : Behavior(B), Key(K), Val(V) {}
189 /// @name Member Variables
192 LLVMContext &Context; ///< The LLVMContext from which types and
193 ///< constants are allocated.
194 GlobalListType GlobalList; ///< The Global Variables in the module
195 FunctionListType FunctionList; ///< The Functions in the module
196 AliasListType AliasList; ///< The Aliases in the module
197 NamedMDListType NamedMDList; ///< The named metadata in the module
198 std::string GlobalScopeAsm; ///< Inline Asm at global scope.
199 ValueSymbolTable *ValSymTab; ///< Symbol table for values
200 std::unique_ptr<GVMaterializer>
201 Materializer; ///< Used to materialize GlobalValues
202 std::string ModuleID; ///< Human readable identifier for the module
203 std::string TargetTriple; ///< Platform target triple Module compiled on
204 void *NamedMDSymTab; ///< NamedMDNode names.
206 // We need to keep the string because the C API expects us to own the string
208 // Since we have it, we also use an empty string to represent a module without
209 // a DataLayout. If it has a DataLayout, these variables are in sync and the
210 // string is just a cache of getDataLayout()->getStringRepresentation().
211 std::string DataLayoutStr;
214 friend class Constant;
217 /// @name Constructors
220 /// The Module constructor. Note that there is no default constructor. You
221 /// must provide a name for the module upon construction.
222 explicit Module(StringRef ModuleID, LLVMContext& C);
223 /// The module destructor. This will dropAllReferences.
227 /// @name Module Level Accessors
230 /// Get the module identifier which is, essentially, the name of the module.
231 /// @returns the module identifier as a string
232 const std::string &getModuleIdentifier() const { return ModuleID; }
234 /// Get the data layout string for the module's target platform. This is
235 /// equivalent to getDataLayout()->getStringRepresentation().
236 const std::string &getDataLayoutStr() const { return DataLayoutStr; }
238 /// Get the data layout for the module's target platform.
239 const DataLayout *getDataLayout() const;
241 /// Get the target triple which is a string describing the target host.
242 /// @returns a string containing the target triple.
243 const std::string &getTargetTriple() const { return TargetTriple; }
245 /// Get the global data context.
246 /// @returns LLVMContext - a container for LLVM's global information
247 LLVMContext &getContext() const { return Context; }
249 /// Get any module-scope inline assembly blocks.
250 /// @returns a string containing the module-scope inline assembly blocks.
251 const std::string &getModuleInlineAsm() const { return GlobalScopeAsm; }
254 /// @name Module Level Mutators
257 /// Set the module identifier.
258 void setModuleIdentifier(StringRef ID) { ModuleID = ID; }
260 /// Set the data layout
261 void setDataLayout(StringRef Desc);
262 void setDataLayout(const DataLayout *Other);
264 /// Set the target triple.
265 void setTargetTriple(StringRef T) { TargetTriple = T; }
267 /// Set the module-scope inline assembly blocks.
268 void setModuleInlineAsm(StringRef Asm) {
269 GlobalScopeAsm = Asm;
270 if (!GlobalScopeAsm.empty() &&
271 GlobalScopeAsm[GlobalScopeAsm.size()-1] != '\n')
272 GlobalScopeAsm += '\n';
275 /// Append to the module-scope inline assembly blocks, automatically inserting
276 /// a separating newline if necessary.
277 void appendModuleInlineAsm(StringRef Asm) {
278 GlobalScopeAsm += Asm;
279 if (!GlobalScopeAsm.empty() &&
280 GlobalScopeAsm[GlobalScopeAsm.size()-1] != '\n')
281 GlobalScopeAsm += '\n';
285 /// @name Generic Value Accessors
288 /// getNamedValue - Return the global value in the module with
289 /// the specified name, of arbitrary type. This method returns null
290 /// if a global with the specified name is not found.
291 GlobalValue *getNamedValue(StringRef Name) const;
293 /// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
294 /// This ID is uniqued across modules in the current LLVMContext.
295 unsigned getMDKindID(StringRef Name) const;
297 /// getMDKindNames - Populate client supplied SmallVector with the name for
298 /// custom metadata IDs registered in this LLVMContext.
299 void getMDKindNames(SmallVectorImpl<StringRef> &Result) const;
302 typedef DenseMap<StructType*, unsigned, DenseMapInfo<StructType*> >
305 /// getTypeByName - Return the type with the specified name, or null if there
306 /// is none by that name.
307 StructType *getTypeByName(StringRef Name) const;
310 /// @name Function Accessors
313 /// getOrInsertFunction - Look up the specified function in the module symbol
314 /// table. Four possibilities:
315 /// 1. If it does not exist, add a prototype for the function and return it.
316 /// 2. If it exists, and has a local linkage, the existing function is
317 /// renamed and a new one is inserted.
318 /// 3. Otherwise, if the existing function has the correct prototype, return
319 /// the existing function.
320 /// 4. Finally, the function exists but has the wrong prototype: return the
321 /// function with a constantexpr cast to the right prototype.
322 Constant *getOrInsertFunction(StringRef Name, FunctionType *T,
323 AttributeSet AttributeList);
325 Constant *getOrInsertFunction(StringRef Name, FunctionType *T);
327 /// getOrInsertFunction - Look up the specified function in the module symbol
328 /// table. If it does not exist, add a prototype for the function and return
329 /// it. This function guarantees to return a constant of pointer to the
330 /// specified function type or a ConstantExpr BitCast of that type if the
331 /// named function has a different type. This version of the method takes a
332 /// null terminated list of function arguments, which makes it easier for
334 Constant *getOrInsertFunction(StringRef Name,
335 AttributeSet AttributeList,
336 Type *RetTy, ...) END_WITH_NULL;
338 /// getOrInsertFunction - Same as above, but without the attributes.
339 Constant *getOrInsertFunction(StringRef Name, Type *RetTy, ...)
342 /// getFunction - Look up the specified function in the module symbol table.
343 /// If it does not exist, return null.
344 Function *getFunction(StringRef Name) const;
347 /// @name Global Variable Accessors
350 /// getGlobalVariable - Look up the specified global variable in the module
351 /// symbol table. If it does not exist, return null. If AllowInternal is set
352 /// to true, this function will return types that have InternalLinkage. By
353 /// default, these types are not returned.
354 const GlobalVariable *getGlobalVariable(StringRef Name,
355 bool AllowInternal = false) const {
356 return const_cast<Module *>(this)->getGlobalVariable(Name, AllowInternal);
359 GlobalVariable *getGlobalVariable(StringRef Name, bool AllowInternal = false);
361 /// getNamedGlobal - Return the global variable in the module with the
362 /// specified name, of arbitrary type. This method returns null if a global
363 /// with the specified name is not found.
364 GlobalVariable *getNamedGlobal(StringRef Name) {
365 return getGlobalVariable(Name, true);
367 const GlobalVariable *getNamedGlobal(StringRef Name) const {
368 return const_cast<Module *>(this)->getNamedGlobal(Name);
371 /// getOrInsertGlobal - Look up the specified global in the module symbol
373 /// 1. If it does not exist, add a declaration of the global and return it.
374 /// 2. Else, the global exists but has the wrong type: return the function
375 /// with a constantexpr cast to the right type.
376 /// 3. Finally, if the existing global is the correct declaration, return
377 /// the existing global.
378 Constant *getOrInsertGlobal(StringRef Name, Type *Ty);
381 /// @name Global Alias Accessors
384 /// getNamedAlias - Return the global alias in the module with the
385 /// specified name, of arbitrary type. This method returns null if a global
386 /// with the specified name is not found.
387 GlobalAlias *getNamedAlias(StringRef Name) const;
390 /// @name Named Metadata Accessors
393 /// getNamedMetadata - Return the first NamedMDNode in the module with the
394 /// specified name. This method returns null if a NamedMDNode with the
395 /// specified name is not found.
396 NamedMDNode *getNamedMetadata(const Twine &Name) const;
398 /// getOrInsertNamedMetadata - Return the named MDNode in the module
399 /// with the specified name. This method returns a new NamedMDNode if a
400 /// NamedMDNode with the specified name is not found.
401 NamedMDNode *getOrInsertNamedMetadata(StringRef Name);
403 /// eraseNamedMetadata - Remove the given NamedMDNode from this module
405 void eraseNamedMetadata(NamedMDNode *NMD);
408 /// @name Module Flags Accessors
411 /// getModuleFlagsMetadata - Returns the module flags in the provided vector.
412 void getModuleFlagsMetadata(SmallVectorImpl<ModuleFlagEntry> &Flags) const;
414 /// Return the corresponding value if Key appears in module flags, otherwise
416 Value *getModuleFlag(StringRef Key) const;
418 /// getModuleFlagsMetadata - Returns the NamedMDNode in the module that
419 /// represents module-level flags. This method returns null if there are no
420 /// module-level flags.
421 NamedMDNode *getModuleFlagsMetadata() const;
423 /// getOrInsertModuleFlagsMetadata - Returns the NamedMDNode in the module
424 /// that represents module-level flags. If module-level flags aren't found,
425 /// it creates the named metadata that contains them.
426 NamedMDNode *getOrInsertModuleFlagsMetadata();
428 /// addModuleFlag - Add a module-level flag to the module-level flags
429 /// metadata. It will create the module-level flags named metadata if it
430 /// doesn't already exist.
431 void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, Value *Val);
432 void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, uint32_t Val);
433 void addModuleFlag(MDNode *Node);
436 /// @name Materialization
439 /// setMaterializer - Sets the GVMaterializer to GVM. This module must not
440 /// yet have a Materializer. To reset the materializer for a module that
441 /// already has one, call MaterializeAllPermanently first. Destroying this
442 /// module will destroy its materializer without materializing any more
443 /// GlobalValues. Without destroying the Module, there is no way to detach or
444 /// destroy a materializer without materializing all the GVs it controls, to
445 /// avoid leaving orphan unmaterialized GVs.
446 void setMaterializer(GVMaterializer *GVM);
447 /// getMaterializer - Retrieves the GVMaterializer, if any, for this Module.
448 GVMaterializer *getMaterializer() const { return Materializer.get(); }
450 /// isMaterializable - True if the definition of GV has yet to be materialized
451 /// from the GVMaterializer.
452 bool isMaterializable(const GlobalValue *GV) const;
453 /// isDematerializable - Returns true if this GV was loaded from this Module's
454 /// GVMaterializer and the GVMaterializer knows how to dematerialize the GV.
455 bool isDematerializable(const GlobalValue *GV) const;
457 /// Materialize - Make sure the GlobalValue is fully read. If the module is
458 /// corrupt, this returns true and fills in the optional string with
459 /// information about the problem. If successful, this returns false.
460 bool Materialize(GlobalValue *GV, std::string *ErrInfo = 0);
461 /// Dematerialize - If the GlobalValue is read in, and if the GVMaterializer
462 /// supports it, release the memory for the function, and set it up to be
463 /// materialized lazily. If !isDematerializable(), this method is a noop.
464 void Dematerialize(GlobalValue *GV);
466 /// Make sure all GlobalValues in this Module are fully read.
467 error_code materializeAll();
469 /// Make sure all GlobalValues in this Module are fully read and clear the
470 /// Materializer. If the module is corrupt, this DOES NOT clear the old
472 error_code materializeAllPermanently();
475 /// @name Direct access to the globals list, functions list, and symbol table
478 /// Get the Module's list of global variables (constant).
479 const GlobalListType &getGlobalList() const { return GlobalList; }
480 /// Get the Module's list of global variables.
481 GlobalListType &getGlobalList() { return GlobalList; }
482 static iplist<GlobalVariable> Module::*getSublistAccess(GlobalVariable*) {
483 return &Module::GlobalList;
485 /// Get the Module's list of functions (constant).
486 const FunctionListType &getFunctionList() const { return FunctionList; }
487 /// Get the Module's list of functions.
488 FunctionListType &getFunctionList() { return FunctionList; }
489 static iplist<Function> Module::*getSublistAccess(Function*) {
490 return &Module::FunctionList;
492 /// Get the Module's list of aliases (constant).
493 const AliasListType &getAliasList() const { return AliasList; }
494 /// Get the Module's list of aliases.
495 AliasListType &getAliasList() { return AliasList; }
496 static iplist<GlobalAlias> Module::*getSublistAccess(GlobalAlias*) {
497 return &Module::AliasList;
499 /// Get the Module's list of named metadata (constant).
500 const NamedMDListType &getNamedMDList() const { return NamedMDList; }
501 /// Get the Module's list of named metadata.
502 NamedMDListType &getNamedMDList() { return NamedMDList; }
503 static ilist<NamedMDNode> Module::*getSublistAccess(NamedMDNode*) {
504 return &Module::NamedMDList;
506 /// Get the symbol table of global variable and function identifiers
507 const ValueSymbolTable &getValueSymbolTable() const { return *ValSymTab; }
508 /// Get the Module's symbol table of global variable and function identifiers.
509 ValueSymbolTable &getValueSymbolTable() { return *ValSymTab; }
512 /// @name Global Variable Iteration
515 global_iterator global_begin() { return GlobalList.begin(); }
516 const_global_iterator global_begin() const { return GlobalList.begin(); }
517 global_iterator global_end () { return GlobalList.end(); }
518 const_global_iterator global_end () const { return GlobalList.end(); }
519 bool global_empty() const { return GlobalList.empty(); }
521 iterator_range<global_iterator> globals() {
522 return iterator_range<global_iterator>(global_begin(), global_end());
524 iterator_range<const_global_iterator> globals() const {
525 return iterator_range<const_global_iterator>(global_begin(), global_end());
529 /// @name Function Iteration
532 iterator begin() { return FunctionList.begin(); }
533 const_iterator begin() const { return FunctionList.begin(); }
534 iterator end () { return FunctionList.end(); }
535 const_iterator end () const { return FunctionList.end(); }
536 size_t size() const { return FunctionList.size(); }
537 bool empty() const { return FunctionList.empty(); }
540 /// @name Alias Iteration
543 alias_iterator alias_begin() { return AliasList.begin(); }
544 const_alias_iterator alias_begin() const { return AliasList.begin(); }
545 alias_iterator alias_end () { return AliasList.end(); }
546 const_alias_iterator alias_end () const { return AliasList.end(); }
547 size_t alias_size () const { return AliasList.size(); }
548 bool alias_empty() const { return AliasList.empty(); }
550 iterator_range<alias_iterator> aliases() {
551 return iterator_range<alias_iterator>(alias_begin(), alias_end());
553 iterator_range<const_alias_iterator> aliases() const {
554 return iterator_range<const_alias_iterator>(alias_begin(), alias_end());
558 /// @name Named Metadata Iteration
561 named_metadata_iterator named_metadata_begin() { return NamedMDList.begin(); }
562 const_named_metadata_iterator named_metadata_begin() const {
563 return NamedMDList.begin();
566 named_metadata_iterator named_metadata_end() { return NamedMDList.end(); }
567 const_named_metadata_iterator named_metadata_end() const {
568 return NamedMDList.end();
571 size_t named_metadata_size() const { return NamedMDList.size(); }
572 bool named_metadata_empty() const { return NamedMDList.empty(); }
574 iterator_range<named_metadata_iterator> named_metadata() {
575 return iterator_range<named_metadata_iterator>(named_metadata_begin(),
576 named_metadata_end());
578 iterator_range<const_named_metadata_iterator> named_metadata() const {
579 return iterator_range<const_named_metadata_iterator>(named_metadata_begin(),
580 named_metadata_end());
584 /// @name Utility functions for printing and dumping Module objects
587 /// Print the module to an output stream with an optional
588 /// AssemblyAnnotationWriter.
589 void print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const;
591 /// Dump the module to stderr (for debugging).
594 /// This function causes all the subinstructions to "let go" of all references
595 /// that they are maintaining. This allows one to 'delete' a whole class at
596 /// a time, even though there may be circular references... first all
597 /// references are dropped, and all use counts go to zero. Then everything
598 /// is delete'd for real. Note that no operations are valid on an object
599 /// that has "dropped all references", except operator delete.
600 void dropAllReferences();
604 /// An raw_ostream inserter for modules.
605 inline raw_ostream &operator<<(raw_ostream &O, const Module &M) {
610 // Create wrappers for C Binding types (see CBindingWrapping.h).
611 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef)
613 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
616 inline Module *unwrap(LLVMModuleProviderRef MP) {
617 return reinterpret_cast<Module*>(MP);
620 } // End llvm namespace