1 //===-- llvm/Module.h - C++ class to represent a VM module ------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 /// @file This file contains the declarations for the Module class.
12 //===----------------------------------------------------------------------===//
17 #include "llvm/Function.h"
18 #include "llvm/GlobalVariable.h"
19 #include "llvm/GlobalAlias.h"
20 #include "llvm/Support/DataTypes.h"
25 class GlobalValueRefMap; // Used by ConstantVals.cpp
28 template<> struct ilist_traits<Function>
29 : public SymbolTableListTraits<Function, Module> {
30 // createSentinel is used to create a node that marks the end of the list.
31 static Function *createSentinel();
32 static void destroySentinel(Function *F) { delete F; }
33 static iplist<Function> &getList(Module *M);
34 static inline ValueSymbolTable *getSymTab(Module *M);
35 static int getListOffset();
37 template<> struct ilist_traits<GlobalVariable>
38 : public SymbolTableListTraits<GlobalVariable, Module> {
39 // createSentinel is used to create a node that marks the end of the list.
40 static GlobalVariable *createSentinel();
41 static void destroySentinel(GlobalVariable *GV) { delete GV; }
42 static iplist<GlobalVariable> &getList(Module *M);
43 static inline ValueSymbolTable *getSymTab(Module *M);
44 static int getListOffset();
46 template<> struct ilist_traits<GlobalAlias>
47 : public SymbolTableListTraits<GlobalAlias, Module> {
48 // createSentinel is used to create a node that marks the end of the list.
49 static GlobalAlias *createSentinel();
50 static void destroySentinel(GlobalAlias *GA) { delete GA; }
51 static iplist<GlobalAlias> &getList(Module *M);
52 static inline ValueSymbolTable *getSymTab(Module *M);
53 static int getListOffset();
56 /// A Module instance is used to store all the information related to an
57 /// LLVM module. Modules are the top level container of all other LLVM
58 /// Intermediate Representation (IR) objects. Each module directly contains a
59 /// list of globals variables, a list of functions, a list of libraries (or
60 /// other modules) this module depends on, a symbol table, and various data
61 /// about the target's characteristics.
63 /// A module maintains a GlobalValRefMap object that is used to hold all
64 /// constant references to global variables in the module. When a global
65 /// variable is destroyed, it should have no entries in the GlobalValueRefMap.
66 /// @brief The main container class for the LLVM Intermediate Representation.
68 /// @name Types And Enumerations
71 /// The type for the list of global variables.
72 typedef iplist<GlobalVariable> GlobalListType;
73 /// The type for the list of functions.
74 typedef iplist<Function> FunctionListType;
75 /// The type for the list of aliases.
76 typedef iplist<GlobalAlias> AliasListType;
78 /// The type for the list of dependent libraries.
79 typedef std::vector<std::string> LibraryListType;
81 /// The Global Variable iterator.
82 typedef GlobalListType::iterator global_iterator;
83 /// The Global Variable constant iterator.
84 typedef GlobalListType::const_iterator const_global_iterator;
86 /// The Function iterators.
87 typedef FunctionListType::iterator iterator;
88 /// The Function constant iterator
89 typedef FunctionListType::const_iterator const_iterator;
91 /// The Global Alias iterators.
92 typedef AliasListType::iterator alias_iterator;
93 /// The Global Alias constant iterator
94 typedef AliasListType::const_iterator const_alias_iterator;
96 /// The Library list iterator.
97 typedef LibraryListType::const_iterator lib_iterator;
99 /// An enumeration for describing the endianess of the target machine.
100 enum Endianness { AnyEndianness, LittleEndian, BigEndian };
102 /// An enumeration for describing the size of a pointer on the target machine.
103 enum PointerSize { AnyPointerSize, Pointer32, Pointer64 };
106 /// @name Member Variables
109 GlobalListType GlobalList; ///< The Global Variables in the module
110 FunctionListType FunctionList; ///< The Functions in the module
111 AliasListType AliasList; ///< The Aliases in the module
112 LibraryListType LibraryList; ///< The Libraries needed by the module
113 std::string GlobalScopeAsm; ///< Inline Asm at global scope.
114 ValueSymbolTable *ValSymTab; ///< Symbol table for values
115 TypeSymbolTable *TypeSymTab; ///< Symbol table for types
116 std::string ModuleID; ///< Human readable identifier for the module
117 std::string TargetTriple; ///< Platform target triple Module compiled on
118 std::string DataLayout; ///< Target data description
120 friend class Constant;
123 /// @name Constructors
126 /// The Module constructor. Note that there is no default constructor. You
127 /// must provide a name for the module upon construction.
128 explicit Module(const std::string &ModuleID);
129 /// The module destructor. This will dropAllReferences.
133 /// @name Module Level Accessors
136 /// Get the module identifier which is, essentially, the name of the module.
137 /// @returns the module identifier as a string
138 const std::string &getModuleIdentifier() const { return ModuleID; }
140 /// Get the data layout string for the module's target platform. This encodes
141 /// the type sizes and alignments expected by this module.
142 /// @returns the data layout as a string
143 const std::string& getDataLayout() const { return DataLayout; }
145 /// Get the target triple which is a string describing the target host.
146 /// @returns a string containing the target triple.
147 const std::string &getTargetTriple() const { return TargetTriple; }
149 /// Get the target endian information.
150 /// @returns Endianess - an enumeration for the endianess of the target
151 Endianness getEndianness() const;
153 /// Get the target pointer size.
154 /// @returns PointerSize - an enumeration for the size of the target's pointer
155 PointerSize getPointerSize() const;
157 /// Get any module-scope inline assembly blocks.
158 /// @returns a string containing the module-scope inline assembly blocks.
159 const std::string &getModuleInlineAsm() const { return GlobalScopeAsm; }
161 /// @name Module Level Mutators
165 /// Set the module identifier.
166 void setModuleIdentifier(const std::string &ID) { ModuleID = ID; }
168 /// Set the data layout
169 void setDataLayout(const std::string& DL) { DataLayout = DL; }
171 /// Set the target triple.
172 void setTargetTriple(const std::string &T) { TargetTriple = T; }
174 /// Set the module-scope inline assembly blocks.
175 void setModuleInlineAsm(const std::string &Asm) { GlobalScopeAsm = Asm; }
178 /// @name Function Accessors
181 /// getOrInsertFunction - Look up the specified function in the module symbol
182 /// table. Four possibilities:
183 /// 1. If it does not exist, add a prototype for the function and return it.
184 /// 2. If it exists, and has internal linkage, the existing function is
185 /// renamed and a new one is inserted.
186 /// 3. Otherwise, if the existing function has the correct prototype, return
187 /// the existing function.
188 /// 4. Finally, the function exists but has the wrong prototype: return the
189 /// function with a constantexpr cast to the right prototype.
190 Constant *getOrInsertFunction(const std::string &Name, const FunctionType *T);
192 /// getOrInsertFunction - Look up the specified function in the module symbol
193 /// table. If it does not exist, add a prototype for the function and return
194 /// it. This function guarantees to return a constant of pointer to the
195 /// specified function type or a ConstantExpr BitCast of that type if the
196 /// named function has a different type. This version of the method takes a
197 /// null terminated list of function arguments, which makes it easier for
199 Constant *getOrInsertFunction(const std::string &Name, const Type *RetTy,...)
202 /// getFunction - Look up the specified function in the module symbol table.
203 /// If it does not exist, return null.
204 Function *getFunction(const std::string &Name) const;
207 /// @name Global Variable Accessors
210 /// getGlobalVariable - Look up the specified global variable in the module
211 /// symbol table. If it does not exist, return null. The type argument
212 /// should be the underlying type of the global, i.e., it should not have
213 /// the top-level PointerType, which represents the address of the global.
214 /// If AllowInternal is set to true, this function will return types that
215 /// have InternalLinkage. By default, these types are not returned.
216 GlobalVariable *getGlobalVariable(const std::string &Name,
217 bool AllowInternal = false) const;
219 /// getNamedGlobal - Return the first global variable in the module with the
220 /// specified name, of arbitrary type. This method returns null if a global
221 /// with the specified name is not found.
222 GlobalVariable *getNamedGlobal(const std::string &Name) const {
223 return getGlobalVariable(Name, true);
227 /// @name Global Variable Accessors
230 /// getNamedGlobal - Return the first global alias in the module with the
231 /// specified name, of arbitrary type. This method returns null if a global
232 /// with the specified name is not found.
233 GlobalAlias *getNamedAlias(const std::string &Name) const;
236 /// @name Type Accessors
239 /// addTypeName - Insert an entry in the symbol table mapping Str to Type. If
240 /// there is already an entry for this name, true is returned and the symbol
241 /// table is not modified.
242 bool addTypeName(const std::string &Name, const Type *Ty);
244 /// getTypeName - If there is at least one entry in the symbol table for the
245 /// specified type, return it.
246 std::string getTypeName(const Type *Ty) const;
248 /// getTypeByName - Return the type with the specified name in this module, or
249 /// null if there is none by that name.
250 const Type *getTypeByName(const std::string &Name) const;
253 /// @name Direct access to the globals list, functions list, and symbol table
256 /// Get the Module's list of global variables (constant).
257 const GlobalListType &getGlobalList() const { return GlobalList; }
258 /// Get the Module's list of global variables.
259 GlobalListType &getGlobalList() { return GlobalList; }
260 /// Get the Module's list of functions (constant).
261 const FunctionListType &getFunctionList() const { return FunctionList; }
262 /// Get the Module's list of functions.
263 FunctionListType &getFunctionList() { return FunctionList; }
264 /// Get the Module's list of aliases (constant).
265 const AliasListType &getAliasList() const { return AliasList; }
266 /// Get the Module's list of aliases.
267 AliasListType &getAliasList() { return AliasList; }
268 /// Get the symbol table of global variable and function identifiers
269 const ValueSymbolTable &getValueSymbolTable() const { return *ValSymTab; }
270 /// Get the Module's symbol table of global variable and function identifiers.
271 ValueSymbolTable &getValueSymbolTable() { return *ValSymTab; }
272 /// Get the symbol table of types
273 const TypeSymbolTable &getTypeSymbolTable() const { return *TypeSymTab; }
274 /// Get the Module's symbol table of types
275 TypeSymbolTable &getTypeSymbolTable() { return *TypeSymTab; }
278 /// @name Global Variable Iteration
281 /// Get an iterator to the first global variable
282 global_iterator global_begin() { return GlobalList.begin(); }
283 /// Get a constant iterator to the first global variable
284 const_global_iterator global_begin() const { return GlobalList.begin(); }
285 /// Get an iterator to the last global variable
286 global_iterator global_end () { return GlobalList.end(); }
287 /// Get a constant iterator to the last global variable
288 const_global_iterator global_end () const { return GlobalList.end(); }
289 /// Determine if the list of globals is empty.
290 bool global_empty() const { return GlobalList.empty(); }
293 /// @name Function Iteration
296 /// Get an iterator to the first function.
297 iterator begin() { return FunctionList.begin(); }
298 /// Get a constant iterator to the first function.
299 const_iterator begin() const { return FunctionList.begin(); }
300 /// Get an iterator to the last function.
301 iterator end () { return FunctionList.end(); }
302 /// Get a constant iterator to the last function.
303 const_iterator end () const { return FunctionList.end(); }
304 /// Determine how many functions are in the Module's list of functions.
305 size_t size() const { return FunctionList.size(); }
306 /// Determine if the list of functions is empty.
307 bool empty() const { return FunctionList.empty(); }
310 /// @name Dependent Library Iteration
313 /// @brief Get a constant iterator to beginning of dependent library list.
314 inline lib_iterator lib_begin() const { return LibraryList.begin(); }
315 /// @brief Get a constant iterator to end of dependent library list.
316 inline lib_iterator lib_end() const { return LibraryList.end(); }
317 /// @brief Returns the number of items in the list of libraries.
318 inline size_t lib_size() const { return LibraryList.size(); }
319 /// @brief Add a library to the list of dependent libraries
320 void addLibrary(const std::string& Lib);
321 /// @brief Remove a library from the list of dependent libraries
322 void removeLibrary(const std::string& Lib);
323 /// @brief Get all the libraries
324 inline const LibraryListType& getLibraries() const { return LibraryList; }
327 /// @name Alias Iteration
330 /// Get an iterator to the first alias.
331 alias_iterator alias_begin() { return AliasList.begin(); }
332 /// Get a constant iterator to the first alias.
333 const_alias_iterator alias_begin() const { return AliasList.begin(); }
334 /// Get an iterator to the last alias.
335 alias_iterator alias_end () { return AliasList.end(); }
336 /// Get a constant iterator to the last alias.
337 const_alias_iterator alias_end () const { return AliasList.end(); }
338 /// Determine how many functions are in the Module's list of aliases.
339 size_t alias_size () const { return AliasList.size(); }
340 /// Determine if the list of aliases is empty.
341 bool alias_empty() const { return AliasList.empty(); }
344 /// @name Utility functions for printing and dumping Module objects
347 /// Print the module to an output stream
348 void print(std::ostream &OS) const { print(OS, 0); }
349 void print(std::ostream *OS) const { if (OS) print(*OS); }
350 /// Print the module to an output stream with AssemblyAnnotationWriter.
351 void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
352 void print(std::ostream *OS, AssemblyAnnotationWriter *AAW) const {
353 if (OS) print(*OS, AAW);
355 /// Dump the module to std::cerr (for debugging).
357 /// This function causes all the subinstructions to "let go" of all references
358 /// that they are maintaining. This allows one to 'delete' a whole class at
359 /// a time, even though there may be circular references... first all
360 /// references are dropped, and all use counts go to zero. Then everything
361 /// is delete'd for real. Note that no operations are valid on an object
362 /// that has "dropped all references", except operator delete.
363 void dropAllReferences();
366 static unsigned getFunctionListOffset() {
368 return unsigned(reinterpret_cast<uintptr_t>(&Obj->FunctionList));
370 static unsigned getGlobalVariableListOffset() {
372 return unsigned(reinterpret_cast<uintptr_t>(&Obj->GlobalList));
374 static unsigned getAliasListOffset() {
376 return unsigned(reinterpret_cast<uintptr_t>(&Obj->AliasList));
380 /// An iostream inserter for modules.
381 inline std::ostream &operator<<(std::ostream &O, const Module &M) {
386 inline ValueSymbolTable *
387 ilist_traits<Function>::getSymTab(Module *M) {
388 return M ? &M->getValueSymbolTable() : 0;
391 inline ValueSymbolTable *
392 ilist_traits<GlobalVariable>::getSymTab(Module *M) {
393 return M ? &M->getValueSymbolTable() : 0;
396 inline ValueSymbolTable *
397 ilist_traits<GlobalAlias>::getSymTab(Module *M) {
398 return M ? &M->getValueSymbolTable() : 0;
402 ilist_traits<Function>::getListOffset() {
403 return Module::getFunctionListOffset();
407 ilist_traits<GlobalVariable>::getListOffset() {
408 return Module::getGlobalVariableListOffset();
412 ilist_traits<GlobalAlias>::getListOffset() {
413 return Module::getAliasListOffset();
416 } // End llvm namespace