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 // This file contains the declarations for the Module class that is used to
11 // maintain all the information related to a VM module.
13 // A module also maintains a GlobalValRefMap object that is used to hold all
14 // constant references to global variables in the module. When a global
15 // variable is destroyed, it should have no entries in the GlobalValueRefMap.
17 //===----------------------------------------------------------------------===//
22 #include "llvm/Function.h"
23 #include "llvm/GlobalVariable.h"
24 #include "llvm/ADT/SetVector.h"
25 #include "llvm/Support/DataTypes.h"
30 class GlobalValueRefMap; // Used by ConstantVals.cpp
34 template<> struct ilist_traits<Function>
35 : public SymbolTableListTraits<Function, Module, Module> {
36 // createSentinel is used to create a node that marks the end of the list.
37 static Function *createSentinel();
38 static void destroySentinel(Function *F) { delete F; }
39 static iplist<Function> &getList(Module *M);
41 template<> struct ilist_traits<GlobalVariable>
42 : public SymbolTableListTraits<GlobalVariable, Module, Module> {
43 // createSentinel is used to create a node that marks the end of the list.
44 static GlobalVariable *createSentinel();
45 static void destroySentinel(GlobalVariable *GV) { delete GV; }
46 static iplist<GlobalVariable> &getList(Module *M);
51 typedef iplist<GlobalVariable> GlobalListType;
52 typedef iplist<Function> FunctionListType;
53 typedef SetVector<std::string> LibraryListType;
55 // Global Variable iterators.
56 typedef GlobalListType::iterator global_iterator;
57 typedef GlobalListType::const_iterator const_global_iterator;
59 // Function iterators.
60 typedef FunctionListType::iterator iterator;
61 typedef FunctionListType::const_iterator const_iterator;
63 // Library list iterators.
64 typedef LibraryListType::const_iterator lib_iterator;
66 enum Endianness { AnyEndianness, LittleEndian, BigEndian };
67 enum PointerSize { AnyPointerSize, Pointer32, Pointer64 };
70 GlobalListType GlobalList; // The Global Variables in the module
71 FunctionListType FunctionList; // The Functions in the module
72 LibraryListType LibraryList; // The Libraries needed by the module
73 std::string GlobalScopeAsm; // Inline Asm at global scope.
74 SymbolTable *SymTab; // Symbol Table for the module
75 std::string ModuleID; // Human readable identifier for the module
76 std::string TargetTriple; // Platform target triple Module compiled on
77 Endianness Endian; // Endianness assumed in the module
78 PointerSize PtrSize; // Pointer size assumed in the module
80 friend class Constant;
83 Module(const std::string &ModuleID);
86 const std::string &getModuleIdentifier() const { return ModuleID; }
87 void setModuleIdentifier(const std::string &ID) { ModuleID = ID; }
89 const std::string &getTargetTriple() const { return TargetTriple; }
90 void setTargetTriple(const std::string &T) { TargetTriple = T; }
92 /// Target endian information...
93 Endianness getEndianness() const { return Endian; }
94 void setEndianness(Endianness E) { Endian = E; }
96 /// Target Pointer Size information...
97 PointerSize getPointerSize() const { return PtrSize; }
98 void setPointerSize(PointerSize PS) { PtrSize = PS; }
100 // Access to any module-scope inline asm blocks.
101 const std::string &getModuleInlineAsm() const { return GlobalScopeAsm; }
102 void setModuleInlineAsm(const std::string &Asm) { GlobalScopeAsm = Asm; }
104 //===--------------------------------------------------------------------===//
105 // Methods for easy access to the functions in the module.
108 /// getOrInsertFunction - Look up the specified function in the module symbol
109 /// table. If it does not exist, add a prototype for the function and return
111 Function *getOrInsertFunction(const std::string &Name, const FunctionType *T);
113 /// getOrInsertFunction - Look up the specified function in the module symbol
114 /// table. If it does not exist, add a prototype for the function and return
115 /// it. This version of the method takes a null terminated list of function
116 /// arguments, which makes it easier for clients to use.
117 Function *getOrInsertFunction(const std::string &Name, const Type *RetTy,...)
120 /// getFunction - Look up the specified function in the module symbol table.
121 /// If it does not exist, return null.
123 Function *getFunction(const std::string &Name, const FunctionType *Ty);
125 /// getMainFunction - This function looks up main efficiently. This is such a
126 /// common case, that it is a method in Module. If main cannot be found, a
127 /// null pointer is returned.
129 Function *getMainFunction();
131 /// getNamedFunction - Return the first function in the module with the
132 /// specified name, of arbitrary type. This method returns null if a function
133 /// with the specified name is not found.
135 Function *getNamedFunction(const std::string &Name);
137 //===--------------------------------------------------------------------===//
138 // Methods for easy access to the global variables in the module.
141 /// getGlobalVariable - Look up the specified global variable in the module
142 /// symbol table. If it does not exist, return null. The type argument
143 /// should be the underlying type of the global, i.e., it should not have
144 /// the top-level PointerType, which represents the address of the global.
145 /// If AllowInternal is set to true, this function will return types that
146 /// have InternalLinkage. By default, these types are not returned.
148 GlobalVariable *getGlobalVariable(const std::string &Name, const Type *Ty,
149 bool AllowInternal = false);
151 /// getNamedGlobal - Return the first global variable in the module with the
152 /// specified name, of arbitrary type. This method returns null if a global
153 /// with the specified name is not found.
155 GlobalVariable *getNamedGlobal(const std::string &Name);
158 //===--------------------------------------------------------------------===//
159 // Methods for easy access to the types in the module.
162 /// addTypeName - Insert an entry in the symbol table mapping Str to Type. If
163 /// there is already an entry for this name, true is returned and the symbol
164 /// table is not modified.
166 bool addTypeName(const std::string &Name, const Type *Ty);
168 /// getTypeName - If there is at least one entry in the symbol table for the
169 /// specified type, return it.
171 std::string getTypeName(const Type *Ty) const;
173 /// getTypeByName - Return the type with the specified name in this module, or
174 /// null if there is none by that name.
175 const Type *getTypeByName(const std::string &Name) const;
178 //===--------------------------------------------------------------------===//
179 // Methods for direct access to the globals list, functions list, and symbol
183 // Get the underlying elements of the Module.
184 const GlobalListType &getGlobalList() const { return GlobalList; }
185 GlobalListType &getGlobalList() { return GlobalList; }
186 const FunctionListType &getFunctionList() const { return FunctionList; }
187 FunctionListType &getFunctionList() { return FunctionList; }
189 /// getSymbolTable() - Get access to the symbol table for the module, where
190 /// global variables and functions are identified.
192 SymbolTable &getSymbolTable() { return *SymTab; }
193 const SymbolTable &getSymbolTable() const { return *SymTab; }
196 //===--------------------------------------------------------------------===//
197 // Module iterator forwarding functions
199 // Globals list interface
200 global_iterator global_begin() { return GlobalList.begin(); }
201 const_global_iterator global_begin() const { return GlobalList.begin(); }
202 global_iterator global_end () { return GlobalList.end(); }
203 const_global_iterator global_end () const { return GlobalList.end(); }
204 bool global_empty() const { return GlobalList.empty(); }
206 // FunctionList interface
207 iterator begin() { return FunctionList.begin(); }
208 const_iterator begin() const { return FunctionList.begin(); }
209 iterator end () { return FunctionList.end(); }
210 const_iterator end () const { return FunctionList.end(); }
212 size_t size() const { return FunctionList.size(); }
213 bool empty() const { return FunctionList.empty(); }
215 //===--------------------------------------------------------------------===//
216 // List of dependent library access functions
218 /// @brief Get a constant iterator to beginning of dependent library list.
219 inline lib_iterator lib_begin() const { return LibraryList.begin(); }
221 /// @brief Get a constant iterator to end of dependent library list.
222 inline lib_iterator lib_end() const { return LibraryList.end(); }
224 /// @brief Returns the number of items in the list of libraries.
225 inline size_t lib_size() const { return LibraryList.size(); }
227 /// @brief Add a library to the list of dependent libraries
228 inline void addLibrary(const std::string& Lib){ LibraryList.insert(Lib); }
230 /// @brief Remove a library from the list of dependent libraries
231 inline void removeLibrary(const std::string& Lib) { LibraryList.remove(Lib); }
233 /// @brief Get all the libraries
234 inline const LibraryListType& getLibraries() const { return LibraryList; }
236 //===--------------------------------------------------------------------===//
237 // Utility functions for printing and dumping Module objects
239 void print(std::ostream &OS) const { print(OS, 0); }
240 void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
244 /// dropAllReferences() - This function causes all the subinstructions to "let
245 /// go" of all references that they are maintaining. This allows one to
246 /// 'delete' a whole class at a time, even though there may be circular
247 /// references... first all references are dropped, and all use counts go to
248 /// zero. Then everything is delete'd for real. Note that no operations are
249 /// valid on an object that has "dropped all references", except operator
252 void dropAllReferences();
255 inline std::ostream &operator<<(std::ostream &O, const Module &M) {
260 } // End llvm namespace