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/OwningPtr.h"
19 #include "llvm/IR/Function.h"
20 #include "llvm/IR/GlobalAlias.h"
21 #include "llvm/IR/GlobalVariable.h"
22 #include "llvm/IR/Metadata.h"
23 #include "llvm/Support/CBindingWrapping.h"
24 #include "llvm/Support/DataTypes.h"
25 #include "llvm/Support/system_error.h"
33 template<typename T> struct DenseMapInfo;
34 template<typename KeyT, typename ValueT, typename KeyInfoT> class DenseMap;
36 template<> struct ilist_traits<Function>
37 : public SymbolTableListTraits<Function, Module> {
39 // createSentinel is used to get hold of the node that marks the end of the
40 // list... (same trick used here as in ilist_traits<Instruction>)
41 Function *createSentinel() const {
42 return static_cast<Function*>(&Sentinel);
44 static void destroySentinel(Function*) {}
46 Function *provideInitialHead() const { return createSentinel(); }
47 Function *ensureHead(Function*) const { return createSentinel(); }
48 static void noteHead(Function*, Function*) {}
51 mutable ilist_node<Function> Sentinel;
54 template<> struct ilist_traits<GlobalVariable>
55 : public SymbolTableListTraits<GlobalVariable, Module> {
56 // createSentinel is used to create a node that marks the end of the list.
57 GlobalVariable *createSentinel() const {
58 return static_cast<GlobalVariable*>(&Sentinel);
60 static void destroySentinel(GlobalVariable*) {}
62 GlobalVariable *provideInitialHead() const { return createSentinel(); }
63 GlobalVariable *ensureHead(GlobalVariable*) const { return createSentinel(); }
64 static void noteHead(GlobalVariable*, GlobalVariable*) {}
66 mutable ilist_node<GlobalVariable> Sentinel;
69 template<> struct ilist_traits<GlobalAlias>
70 : public SymbolTableListTraits<GlobalAlias, Module> {
71 // createSentinel is used to create a node that marks the end of the list.
72 GlobalAlias *createSentinel() const {
73 return static_cast<GlobalAlias*>(&Sentinel);
75 static void destroySentinel(GlobalAlias*) {}
77 GlobalAlias *provideInitialHead() const { return createSentinel(); }
78 GlobalAlias *ensureHead(GlobalAlias*) const { return createSentinel(); }
79 static void noteHead(GlobalAlias*, GlobalAlias*) {}
81 mutable ilist_node<GlobalAlias> Sentinel;
84 template<> struct ilist_traits<NamedMDNode>
85 : public ilist_default_traits<NamedMDNode> {
86 // createSentinel is used to get hold of a node that marks the end of
88 NamedMDNode *createSentinel() const {
89 return static_cast<NamedMDNode*>(&Sentinel);
91 static void destroySentinel(NamedMDNode*) {}
93 NamedMDNode *provideInitialHead() const { return createSentinel(); }
94 NamedMDNode *ensureHead(NamedMDNode*) const { return createSentinel(); }
95 static void noteHead(NamedMDNode*, NamedMDNode*) {}
96 void addNodeToList(NamedMDNode *) {}
97 void removeNodeFromList(NamedMDNode *) {}
99 mutable ilist_node<NamedMDNode> Sentinel;
102 /// A Module instance is used to store all the information related to an
103 /// LLVM module. Modules are the top level container of all other LLVM
104 /// Intermediate Representation (IR) objects. Each module directly contains a
105 /// list of globals variables, a list of functions, a list of libraries (or
106 /// other modules) this module depends on, a symbol table, and various data
107 /// about the target's characteristics.
109 /// A module maintains a GlobalValRefMap object that is used to hold all
110 /// constant references to global variables in the module. When a global
111 /// variable is destroyed, it should have no entries in the GlobalValueRefMap.
112 /// @brief The main container class for the LLVM Intermediate Representation.
114 /// @name Types And Enumerations
117 /// The type for the list of global variables.
118 typedef iplist<GlobalVariable> GlobalListType;
119 /// The type for the list of functions.
120 typedef iplist<Function> FunctionListType;
121 /// The type for the list of aliases.
122 typedef iplist<GlobalAlias> AliasListType;
123 /// The type for the list of named metadata.
124 typedef ilist<NamedMDNode> NamedMDListType;
126 /// The Global Variable iterator.
127 typedef GlobalListType::iterator global_iterator;
128 /// The Global Variable constant iterator.
129 typedef GlobalListType::const_iterator const_global_iterator;
131 /// The Function iterators.
132 typedef FunctionListType::iterator iterator;
133 /// The Function constant iterator
134 typedef FunctionListType::const_iterator const_iterator;
136 /// The Global Alias iterators.
137 typedef AliasListType::iterator alias_iterator;
138 /// The Global Alias constant iterator
139 typedef AliasListType::const_iterator const_alias_iterator;
141 /// The named metadata iterators.
142 typedef NamedMDListType::iterator named_metadata_iterator;
143 /// The named metadata constant interators.
144 typedef NamedMDListType::const_iterator const_named_metadata_iterator;
146 /// This enumeration defines the supported behaviors of module flags.
147 enum ModFlagBehavior {
148 /// Emits an error if two values disagree, otherwise the resulting value is
149 /// that of the operands.
152 /// Emits a warning if two values disagree. The result value will be the
153 /// operand for the flag from the first module being linked.
156 /// Adds a requirement that another module flag be present and have a
157 /// specified value after linking is performed. The value must be a metadata
158 /// pair, where the first element of the pair is the ID of the module flag
159 /// to be restricted, and the second element of the pair is the value the
160 /// module flag should be restricted to. This behavior can be used to
161 /// restrict the allowable results (via triggering of an error) of linking
162 /// IDs with the **Override** behavior.
165 /// Uses the specified value, regardless of the behavior or value of the
166 /// other module. If both modules specify **Override**, but the values
167 /// differ, an error will be emitted.
170 /// Appends the two values, which are required to be metadata nodes.
173 /// Appends the two values, which are required to be metadata
174 /// nodes. However, duplicate entries in the second list are dropped
175 /// during the append operation.
179 struct ModuleFlagEntry {
180 ModFlagBehavior Behavior;
183 ModuleFlagEntry(ModFlagBehavior B, MDString *K, Value *V)
184 : Behavior(B), Key(K), Val(V) {}
188 /// @name Member Variables
191 LLVMContext &Context; ///< The LLVMContext from which types and
192 ///< constants are allocated.
193 GlobalListType GlobalList; ///< The Global Variables in the module
194 FunctionListType FunctionList; ///< The Functions in the module
195 AliasListType AliasList; ///< The Aliases in the module
196 NamedMDListType NamedMDList; ///< The named metadata in the module
197 std::string GlobalScopeAsm; ///< Inline Asm at global scope.
198 ValueSymbolTable *ValSymTab; ///< Symbol table for values
199 OwningPtr<GVMaterializer> Materializer; ///< Used to materialize GlobalValues
200 std::string ModuleID; ///< Human readable identifier for the module
201 std::string TargetTriple; ///< Platform target triple Module compiled on
202 std::string DataLayout; ///< Target data description
203 void *NamedMDSymTab; ///< NamedMDNode names.
205 friend class Constant;
208 /// @name Constructors
211 /// The Module constructor. Note that there is no default constructor. You
212 /// must provide a name for the module upon construction.
213 explicit Module(StringRef ModuleID, LLVMContext& C);
214 /// The module destructor. This will dropAllReferences.
218 /// @name Module Level Accessors
221 /// Get the module identifier which is, essentially, the name of the module.
222 /// @returns the module identifier as a string
223 const std::string &getModuleIdentifier() const { return ModuleID; }
225 /// Get the data layout string for the module's target platform. This encodes
226 /// the type sizes and alignments expected by this module.
227 /// @returns the data layout as a string
228 const std::string &getDataLayout() const { return DataLayout; }
230 /// Get the target triple which is a string describing the target host.
231 /// @returns a string containing the target triple.
232 const std::string &getTargetTriple() const { return TargetTriple; }
234 /// Get the global data context.
235 /// @returns LLVMContext - a container for LLVM's global information
236 LLVMContext &getContext() const { return Context; }
238 /// Get any module-scope inline assembly blocks.
239 /// @returns a string containing the module-scope inline assembly blocks.
240 const std::string &getModuleInlineAsm() const { return GlobalScopeAsm; }
243 /// @name Module Level Mutators
246 /// Set the module identifier.
247 void setModuleIdentifier(StringRef ID) { ModuleID = ID; }
249 /// Set the data layout
250 void setDataLayout(StringRef DL) { DataLayout = DL; }
252 /// Set the target triple.
253 void setTargetTriple(StringRef T) { TargetTriple = T; }
255 /// Set the module-scope inline assembly blocks.
256 void setModuleInlineAsm(StringRef Asm) {
257 GlobalScopeAsm = Asm;
258 if (!GlobalScopeAsm.empty() &&
259 GlobalScopeAsm[GlobalScopeAsm.size()-1] != '\n')
260 GlobalScopeAsm += '\n';
263 /// Append to the module-scope inline assembly blocks, automatically inserting
264 /// a separating newline if necessary.
265 void appendModuleInlineAsm(StringRef Asm) {
266 GlobalScopeAsm += Asm;
267 if (!GlobalScopeAsm.empty() &&
268 GlobalScopeAsm[GlobalScopeAsm.size()-1] != '\n')
269 GlobalScopeAsm += '\n';
273 /// @name Generic Value Accessors
276 /// getNamedValue - Return the global value in the module with
277 /// the specified name, of arbitrary type. This method returns null
278 /// if a global with the specified name is not found.
279 GlobalValue *getNamedValue(StringRef Name) const;
281 /// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
282 /// This ID is uniqued across modules in the current LLVMContext.
283 unsigned getMDKindID(StringRef Name) const;
285 /// getMDKindNames - Populate client supplied SmallVector with the name for
286 /// custom metadata IDs registered in this LLVMContext.
287 void getMDKindNames(SmallVectorImpl<StringRef> &Result) const;
290 typedef DenseMap<StructType*, unsigned, DenseMapInfo<StructType*> >
293 /// getTypeByName - Return the type with the specified name, or null if there
294 /// is none by that name.
295 StructType *getTypeByName(StringRef Name) const;
298 /// @name Function Accessors
301 /// getOrInsertFunction - Look up the specified function in the module symbol
302 /// table. Four possibilities:
303 /// 1. If it does not exist, add a prototype for the function and return it.
304 /// 2. If it exists, and has a local linkage, the existing function is
305 /// renamed and a new one is inserted.
306 /// 3. Otherwise, if the existing function has the correct prototype, return
307 /// the existing function.
308 /// 4. Finally, the function exists but has the wrong prototype: return the
309 /// function with a constantexpr cast to the right prototype.
310 Constant *getOrInsertFunction(StringRef Name, FunctionType *T,
311 AttributeSet AttributeList);
313 Constant *getOrInsertFunction(StringRef Name, FunctionType *T);
315 /// getOrInsertFunction - Look up the specified function in the module symbol
316 /// table. If it does not exist, add a prototype for the function and return
317 /// it. This function guarantees to return a constant of pointer to the
318 /// specified function type or a ConstantExpr BitCast of that type if the
319 /// named function has a different type. This version of the method takes a
320 /// null terminated list of function arguments, which makes it easier for
322 Constant *getOrInsertFunction(StringRef Name,
323 AttributeSet AttributeList,
324 Type *RetTy, ...) END_WITH_NULL;
326 /// getOrInsertFunction - Same as above, but without the attributes.
327 Constant *getOrInsertFunction(StringRef Name, Type *RetTy, ...)
330 /// getFunction - Look up the specified function in the module symbol table.
331 /// If it does not exist, return null.
332 Function *getFunction(StringRef Name) const;
335 /// @name Global Variable Accessors
338 /// getGlobalVariable - Look up the specified global variable in the module
339 /// symbol table. If it does not exist, return null. If AllowInternal is set
340 /// to true, this function will return types that have InternalLinkage. By
341 /// default, these types are not returned.
342 const GlobalVariable *getGlobalVariable(StringRef Name,
343 bool AllowInternal = false) const {
344 return const_cast<Module *>(this)->getGlobalVariable(Name, AllowInternal);
347 GlobalVariable *getGlobalVariable(StringRef Name, bool AllowInternal = false);
349 /// getNamedGlobal - Return the global variable in the module with the
350 /// specified name, of arbitrary type. This method returns null if a global
351 /// with the specified name is not found.
352 GlobalVariable *getNamedGlobal(StringRef Name) {
353 return getGlobalVariable(Name, true);
355 const GlobalVariable *getNamedGlobal(StringRef Name) const {
356 return const_cast<Module *>(this)->getNamedGlobal(Name);
359 /// getOrInsertGlobal - Look up the specified global in the module symbol
361 /// 1. If it does not exist, add a declaration of the global and return it.
362 /// 2. Else, the global exists but has the wrong type: return the function
363 /// with a constantexpr cast to the right type.
364 /// 3. Finally, if the existing global is the correct declaration, return
365 /// the existing global.
366 Constant *getOrInsertGlobal(StringRef Name, Type *Ty);
369 /// @name Global Alias Accessors
372 /// getNamedAlias - Return the global alias in the module with the
373 /// specified name, of arbitrary type. This method returns null if a global
374 /// with the specified name is not found.
375 GlobalAlias *getNamedAlias(StringRef Name) const;
378 /// @name Named Metadata Accessors
381 /// getNamedMetadata - Return the first NamedMDNode in the module with the
382 /// specified name. This method returns null if a NamedMDNode with the
383 /// specified name is not found.
384 NamedMDNode *getNamedMetadata(const Twine &Name) const;
386 /// getOrInsertNamedMetadata - Return the named MDNode in the module
387 /// with the specified name. This method returns a new NamedMDNode if a
388 /// NamedMDNode with the specified name is not found.
389 NamedMDNode *getOrInsertNamedMetadata(StringRef Name);
391 /// eraseNamedMetadata - Remove the given NamedMDNode from this module
393 void eraseNamedMetadata(NamedMDNode *NMD);
396 /// @name Module Flags Accessors
399 /// getModuleFlagsMetadata - Returns the module flags in the provided vector.
400 void getModuleFlagsMetadata(SmallVectorImpl<ModuleFlagEntry> &Flags) const;
402 /// Return the corresponding value if Key appears in module flags, otherwise
404 Value *getModuleFlag(StringRef Key) const;
406 /// getModuleFlagsMetadata - Returns the NamedMDNode in the module that
407 /// represents module-level flags. This method returns null if there are no
408 /// module-level flags.
409 NamedMDNode *getModuleFlagsMetadata() const;
411 /// getOrInsertModuleFlagsMetadata - Returns the NamedMDNode in the module
412 /// that represents module-level flags. If module-level flags aren't found,
413 /// it creates the named metadata that contains them.
414 NamedMDNode *getOrInsertModuleFlagsMetadata();
416 /// addModuleFlag - Add a module-level flag to the module-level flags
417 /// metadata. It will create the module-level flags named metadata if it
418 /// doesn't already exist.
419 void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, Value *Val);
420 void addModuleFlag(ModFlagBehavior Behavior, StringRef Key, uint32_t Val);
421 void addModuleFlag(MDNode *Node);
424 /// @name Materialization
427 /// setMaterializer - Sets the GVMaterializer to GVM. This module must not
428 /// yet have a Materializer. To reset the materializer for a module that
429 /// already has one, call MaterializeAllPermanently first. Destroying this
430 /// module will destroy its materializer without materializing any more
431 /// GlobalValues. Without destroying the Module, there is no way to detach or
432 /// destroy a materializer without materializing all the GVs it controls, to
433 /// avoid leaving orphan unmaterialized GVs.
434 void setMaterializer(GVMaterializer *GVM);
435 /// getMaterializer - Retrieves the GVMaterializer, if any, for this Module.
436 GVMaterializer *getMaterializer() const { return Materializer.get(); }
438 /// isMaterializable - True if the definition of GV has yet to be materialized
439 /// from the GVMaterializer.
440 bool isMaterializable(const GlobalValue *GV) const;
441 /// isDematerializable - Returns true if this GV was loaded from this Module's
442 /// GVMaterializer and the GVMaterializer knows how to dematerialize the GV.
443 bool isDematerializable(const GlobalValue *GV) const;
445 /// Materialize - Make sure the GlobalValue is fully read. If the module is
446 /// corrupt, this returns true and fills in the optional string with
447 /// information about the problem. If successful, this returns false.
448 bool Materialize(GlobalValue *GV, std::string *ErrInfo = 0);
449 /// Dematerialize - If the GlobalValue is read in, and if the GVMaterializer
450 /// supports it, release the memory for the function, and set it up to be
451 /// materialized lazily. If !isDematerializable(), this method is a noop.
452 void Dematerialize(GlobalValue *GV);
454 /// Make sure all GlobalValues in this Module are fully read.
455 error_code materializeAll();
457 /// Make sure all GlobalValues in this Module are fully read and clear the
458 /// Materializer. If the module is corrupt, this DOES NOT clear the old
460 error_code materializeAllPermanently();
463 /// @name Direct access to the globals list, functions list, and symbol table
466 /// Get the Module's list of global variables (constant).
467 const GlobalListType &getGlobalList() const { return GlobalList; }
468 /// Get the Module's list of global variables.
469 GlobalListType &getGlobalList() { return GlobalList; }
470 static iplist<GlobalVariable> Module::*getSublistAccess(GlobalVariable*) {
471 return &Module::GlobalList;
473 /// Get the Module's list of functions (constant).
474 const FunctionListType &getFunctionList() const { return FunctionList; }
475 /// Get the Module's list of functions.
476 FunctionListType &getFunctionList() { return FunctionList; }
477 static iplist<Function> Module::*getSublistAccess(Function*) {
478 return &Module::FunctionList;
480 /// Get the Module's list of aliases (constant).
481 const AliasListType &getAliasList() const { return AliasList; }
482 /// Get the Module's list of aliases.
483 AliasListType &getAliasList() { return AliasList; }
484 static iplist<GlobalAlias> Module::*getSublistAccess(GlobalAlias*) {
485 return &Module::AliasList;
487 /// Get the Module's list of named metadata (constant).
488 const NamedMDListType &getNamedMDList() const { return NamedMDList; }
489 /// Get the Module's list of named metadata.
490 NamedMDListType &getNamedMDList() { return NamedMDList; }
491 static ilist<NamedMDNode> Module::*getSublistAccess(NamedMDNode*) {
492 return &Module::NamedMDList;
494 /// Get the symbol table of global variable and function identifiers
495 const ValueSymbolTable &getValueSymbolTable() const { return *ValSymTab; }
496 /// Get the Module's symbol table of global variable and function identifiers.
497 ValueSymbolTable &getValueSymbolTable() { return *ValSymTab; }
500 /// @name Global Variable Iteration
503 global_iterator global_begin() { return GlobalList.begin(); }
504 const_global_iterator global_begin() const { return GlobalList.begin(); }
505 global_iterator global_end () { return GlobalList.end(); }
506 const_global_iterator global_end () const { return GlobalList.end(); }
507 bool global_empty() const { return GlobalList.empty(); }
510 /// @name Function Iteration
513 iterator begin() { return FunctionList.begin(); }
514 const_iterator begin() const { return FunctionList.begin(); }
515 iterator end () { return FunctionList.end(); }
516 const_iterator end () const { return FunctionList.end(); }
517 size_t size() const { return FunctionList.size(); }
518 bool empty() const { return FunctionList.empty(); }
521 /// @name Alias Iteration
524 alias_iterator alias_begin() { return AliasList.begin(); }
525 const_alias_iterator alias_begin() const { return AliasList.begin(); }
526 alias_iterator alias_end () { return AliasList.end(); }
527 const_alias_iterator alias_end () const { return AliasList.end(); }
528 size_t alias_size () const { return AliasList.size(); }
529 bool alias_empty() const { return AliasList.empty(); }
533 /// @name Named Metadata Iteration
536 named_metadata_iterator named_metadata_begin() { return NamedMDList.begin(); }
537 const_named_metadata_iterator named_metadata_begin() const {
538 return NamedMDList.begin();
541 named_metadata_iterator named_metadata_end() { return NamedMDList.end(); }
542 const_named_metadata_iterator named_metadata_end() const {
543 return NamedMDList.end();
546 size_t named_metadata_size() const { return NamedMDList.size(); }
547 bool named_metadata_empty() const { return NamedMDList.empty(); }
551 /// @name Utility functions for printing and dumping Module objects
554 /// Print the module to an output stream with an optional
555 /// AssemblyAnnotationWriter.
556 void print(raw_ostream &OS, AssemblyAnnotationWriter *AAW) const;
558 /// Dump the module to stderr (for debugging).
561 /// This function causes all the subinstructions to "let go" of all references
562 /// that they are maintaining. This allows one to 'delete' a whole class at
563 /// a time, even though there may be circular references... first all
564 /// references are dropped, and all use counts go to zero. Then everything
565 /// is delete'd for real. Note that no operations are valid on an object
566 /// that has "dropped all references", except operator delete.
567 void dropAllReferences();
571 /// An raw_ostream inserter for modules.
572 inline raw_ostream &operator<<(raw_ostream &O, const Module &M) {
577 // Create wrappers for C Binding types (see CBindingWrapping.h).
578 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(Module, LLVMModuleRef)
580 /* LLVMModuleProviderRef exists for historical reasons, but now just holds a
583 inline Module *unwrap(LLVMModuleProviderRef MP) {
584 return reinterpret_cast<Module*>(MP);
587 } // End llvm namespace