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"
29 class GlobalValueRefMap; // Used by ConstantVals.cpp
33 template<> struct ilist_traits<Function>
34 : public SymbolTableListTraits<Function, Module, Module> {
35 // createSentinel is used to create a node that marks the end of the list.
36 static Function *createSentinel();
37 static void destroySentinel(Function *F) { delete F; }
38 static iplist<Function> &getList(Module *M);
40 template<> struct ilist_traits<GlobalVariable>
41 : public SymbolTableListTraits<GlobalVariable, Module, Module> {
42 // createSentinel is used to create a node that marks the end of the list.
43 static GlobalVariable *createSentinel();
44 static void destroySentinel(GlobalVariable *GV) { delete GV; }
45 static iplist<GlobalVariable> &getList(Module *M);
50 typedef iplist<GlobalVariable> GlobalListType;
51 typedef iplist<Function> FunctionListType;
52 typedef SetVector<std::string> LibraryListType;
54 // Global Variable iterators...
55 typedef GlobalListType::iterator global_iterator;
56 typedef GlobalListType::const_iterator const_global_iterator;
57 typedef global_iterator giterator; // these are legacy, deprecated
58 typedef const_global_iterator const_giterator;
60 // Function iterators...
61 typedef FunctionListType::iterator iterator;
62 typedef FunctionListType::const_iterator const_iterator;
64 // Library list iterators
65 typedef LibraryListType::const_iterator lib_iterator;
67 enum Endianness { AnyEndianness, LittleEndian, BigEndian };
68 enum PointerSize { AnyPointerSize, Pointer32, Pointer64 };
71 GlobalListType GlobalList; // The Global Variables in the module
72 FunctionListType FunctionList; // The Functions in the module
73 LibraryListType LibraryList; // The Libraries needed by the module
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
78 // These flags are probably not the right long-term way to handle this kind of
79 // target information, but it is sufficient for now.
80 Endianness Endian; // True if target is little endian
81 PointerSize PtrSize; // True if target has 32-bit pointers (false = 64-bit)
83 friend class Constant;
86 Module(const std::string &ModuleID);
89 const std::string& getModuleIdentifier() const { return ModuleID; }
90 const std::string& getTargetTriple() const { return TargetTriple; }
91 void setTargetTriple(const std::string& T) { TargetTriple = T; }
93 /// Target endian information...
94 Endianness getEndianness() const { return Endian; }
95 void setEndianness(Endianness E) { Endian = E; }
97 /// Target Pointer Size information...
98 PointerSize getPointerSize() const { return PtrSize; }
99 void setPointerSize(PointerSize PS) { PtrSize = PS; }
101 //===--------------------------------------------------------------------===//
102 // Methods for easy access to the functions in the module.
105 /// getOrInsertFunction - Look up the specified function in the module symbol
106 /// table. If it does not exist, add a prototype for the function and return
108 Function *getOrInsertFunction(const std::string &Name, const FunctionType *T);
110 /// getOrInsertFunction - Look up the specified function in the module symbol
111 /// table. If it does not exist, add a prototype for the function and return
112 /// it. This version of the method takes a null terminated list of function
113 /// arguments, which makes it easier for clients to use.
114 Function *getOrInsertFunction(const std::string &Name, const Type *RetTy,...);
116 /// getFunction - Look up the specified function in the module symbol table.
117 /// If it does not exist, return null.
119 Function *getFunction(const std::string &Name, const FunctionType *Ty);
121 /// getMainFunction - This function looks up main efficiently. This is such a
122 /// common case, that it is a method in Module. If main cannot be found, a
123 /// null pointer is returned.
125 Function *getMainFunction();
127 /// getNamedFunction - Return the first function in the module with the
128 /// specified name, of arbitrary type. This method returns null if a function
129 /// with the specified name is not found.
131 Function *getNamedFunction(const std::string &Name);
133 //===--------------------------------------------------------------------===//
134 // Methods for easy access to the global variables in the module.
137 /// getGlobalVariable - Look up the specified global variable in the module
138 /// symbol table. If it does not exist, return null. Note that this only
139 /// returns a global variable if it does not have internal linkage. The type
140 /// argument should be the underlying type of the global, i.e., it should not
141 /// have the top-level PointerType, which represents the address of the
144 GlobalVariable *getGlobalVariable(const std::string &Name, const Type *Ty);
147 //===--------------------------------------------------------------------===//
148 // Methods for easy access to the types in the module.
151 /// addTypeName - Insert an entry in the symbol table mapping Str to Type. If
152 /// there is already an entry for this name, true is returned and the symbol
153 /// table is not modified.
155 bool addTypeName(const std::string &Name, const Type *Ty);
157 /// getTypeName - If there is at least one entry in the symbol table for the
158 /// specified type, return it.
160 std::string getTypeName(const Type *Ty) const;
162 /// getTypeByName - Return the type with the specified name in this module, or
163 /// null if there is none by that name.
164 const Type *getTypeByName(const std::string &Name) const;
167 //===--------------------------------------------------------------------===//
168 // Methods for direct access to the globals list, functions list, and symbol
172 /// Get the underlying elements of the Module...
173 inline const GlobalListType &getGlobalList() const { return GlobalList; }
174 inline GlobalListType &getGlobalList() { return GlobalList; }
175 inline const FunctionListType &getFunctionList() const { return FunctionList;}
176 inline FunctionListType &getFunctionList() { return FunctionList;}
178 /// getSymbolTable() - Get access to the symbol table for the module, where
179 /// global variables and functions are identified.
181 inline SymbolTable &getSymbolTable() { return *SymTab; }
182 inline const SymbolTable &getSymbolTable() const { return *SymTab; }
185 //===--------------------------------------------------------------------===//
186 // Module iterator forwarding functions
188 // Globals list interface
189 global_iterator global_begin() { return GlobalList.begin(); }
190 const_global_iterator global_begin() const { return GlobalList.begin(); }
191 global_iterator global_end () { return GlobalList.end(); }
192 const_global_iterator global_end () const { return GlobalList.end(); }
193 bool global_empty() const { return GlobalList.empty(); }
195 // FunctionList interface
196 inline iterator begin() { return FunctionList.begin(); }
197 inline const_iterator begin() const { return FunctionList.begin(); }
198 inline iterator end () { return FunctionList.end(); }
199 inline const_iterator end () const { return FunctionList.end(); }
201 inline size_t size() const { return FunctionList.size(); }
202 inline bool empty() const { return FunctionList.empty(); }
204 //===--------------------------------------------------------------------===//
205 // List of dependent library access functions
207 /// @brief Get a constant iterator to beginning of dependent library list.
208 inline lib_iterator lib_begin() const { return LibraryList.begin(); }
210 /// @brief Get a constant iterator to end of dependent library list.
211 inline lib_iterator lib_end() const { return LibraryList.end(); }
213 /// @brief Returns the number of items in the list of libraries.
214 inline size_t lib_size() const { return LibraryList.size(); }
216 /// @brief Add a library to the list of dependent libraries
217 inline void addLibrary(const std::string& Lib){ LibraryList.insert(Lib); }
219 /// @brief Remove a library from the list of dependent libraries
220 inline void removeLibrary(const std::string& Lib) { LibraryList.remove(Lib); }
222 /// @brief Get all the libraries
223 inline const LibraryListType& getLibraries() const { return LibraryList; }
225 //===--------------------------------------------------------------------===//
226 // Utility functions for printing and dumping Module objects
228 void print(std::ostream &OS) const { print(OS, 0); }
229 void print(std::ostream &OS, AssemblyAnnotationWriter *AAW) const;
233 /// dropAllReferences() - This function causes all the subinstructions to "let
234 /// go" of all references that they are maintaining. This allows one to
235 /// 'delete' a whole class at a time, even though there may be circular
236 /// references... first all references are dropped, and all use counts go to
237 /// zero. Then everything is delete'd for real. Note that no operations are
238 /// valid on an object that has "dropped all references", except operator
241 void dropAllReferences();
244 inline std::ostream &operator<<(std::ostream &O, const Module &M) {
249 } // End llvm namespace