1 //===-- Module.cpp - Implement the Module class ---------------------------===//
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 //===----------------------------------------------------------------------===//
10 // This file implements the Module class for the VMCore library.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Module.h"
15 #include "llvm/InstrTypes.h"
16 #include "llvm/Constants.h"
17 #include "llvm/DerivedTypes.h"
18 #include "llvm/ADT/STLExtras.h"
19 #include "llvm/ADT/StringExtras.h"
20 #include "llvm/Support/LeakDetector.h"
21 #include "SymbolTableListTraitsImpl.h"
22 #include "llvm/TypeSymbolTable.h"
28 //===----------------------------------------------------------------------===//
29 // Methods to implement the globals and functions lists.
32 Function *ilist_traits<Function>::createSentinel() {
34 FunctionType::get(Type::VoidTy, std::vector<const Type*>(), false);
35 Function *Ret = Function::Create(FTy, GlobalValue::ExternalLinkage);
36 // This should not be garbage monitored.
37 LeakDetector::removeGarbageObject(Ret);
40 GlobalVariable *ilist_traits<GlobalVariable>::createSentinel() {
41 GlobalVariable *Ret = new GlobalVariable(Type::Int32Ty, false,
42 GlobalValue::ExternalLinkage);
43 // This should not be garbage monitored.
44 LeakDetector::removeGarbageObject(Ret);
47 GlobalAlias *ilist_traits<GlobalAlias>::createSentinel() {
48 GlobalAlias *Ret = new GlobalAlias(Type::Int32Ty,
49 GlobalValue::ExternalLinkage);
50 // This should not be garbage monitored.
51 LeakDetector::removeGarbageObject(Ret);
55 iplist<Function> &ilist_traits<Function>::getList(Module *M) {
56 return M->getFunctionList();
58 iplist<GlobalVariable> &ilist_traits<GlobalVariable>::getList(Module *M) {
59 return M->getGlobalList();
61 iplist<GlobalAlias> &ilist_traits<GlobalAlias>::getList(Module *M) {
62 return M->getAliasList();
65 // Explicit instantiations of SymbolTableListTraits since some of the methods
66 // are not in the public header file.
67 template class SymbolTableListTraits<GlobalVariable, Module>;
68 template class SymbolTableListTraits<Function, Module>;
69 template class SymbolTableListTraits<GlobalAlias, Module>;
71 //===----------------------------------------------------------------------===//
72 // Primitive Module methods.
75 Module::Module(const std::string &MID)
76 : ModuleID(MID), DataLayout("") {
77 ValSymTab = new ValueSymbolTable();
78 TypeSymTab = new TypeSymbolTable();
91 /// Target endian information...
92 Module::Endianness Module::getEndianness() const {
93 std::string temp = DataLayout;
94 Module::Endianness ret = AnyEndianness;
96 while (!temp.empty()) {
97 std::string token = getToken(temp, "-");
99 if (token[0] == 'e') {
101 } else if (token[0] == 'E') {
109 /// Target Pointer Size information...
110 Module::PointerSize Module::getPointerSize() const {
111 std::string temp = DataLayout;
112 Module::PointerSize ret = AnyPointerSize;
114 while (!temp.empty()) {
115 std::string token = getToken(temp, "-");
116 char signal = getToken(token, ":")[0];
119 int size = atoi(getToken(token, ":").c_str());
130 //===----------------------------------------------------------------------===//
131 // Methods for easy access to the functions in the module.
134 // getOrInsertFunction - Look up the specified function in the module symbol
135 // table. If it does not exist, add a prototype for the function and return
136 // it. This is nice because it allows most passes to get away with not handling
137 // the symbol table directly for this common task.
139 Constant *Module::getOrInsertFunction(const std::string &Name,
140 const FunctionType *Ty) {
141 ValueSymbolTable &SymTab = getValueSymbolTable();
143 // See if we have a definition for the specified function already.
144 GlobalValue *F = dyn_cast_or_null<GlobalValue>(SymTab.lookup(Name));
147 Function *New = Function::Create(Ty, GlobalVariable::ExternalLinkage, Name);
148 FunctionList.push_back(New);
149 return New; // Return the new prototype.
152 // Okay, the function exists. Does it have externally visible linkage?
153 if (F->hasInternalLinkage()) {
154 // Clear the function's name.
156 // Retry, now there won't be a conflict.
157 Constant *NewF = getOrInsertFunction(Name, Ty);
158 F->setName(&Name[0], Name.size());
162 // If the function exists but has the wrong type, return a bitcast to the
164 if (F->getType() != PointerType::getUnqual(Ty))
165 return ConstantExpr::getBitCast(F, PointerType::getUnqual(Ty));
167 // Otherwise, we just found the existing function or a prototype.
171 // getOrInsertFunction - Look up the specified function in the module symbol
172 // table. If it does not exist, add a prototype for the function and return it.
173 // This version of the method takes a null terminated list of function
174 // arguments, which makes it easier for clients to use.
176 Constant *Module::getOrInsertFunction(const std::string &Name,
177 const Type *RetTy, ...) {
179 va_start(Args, RetTy);
181 // Build the list of argument types...
182 std::vector<const Type*> ArgTys;
183 while (const Type *ArgTy = va_arg(Args, const Type*))
184 ArgTys.push_back(ArgTy);
188 // Build the function type and chain to the other getOrInsertFunction...
189 return getOrInsertFunction(Name, FunctionType::get(RetTy, ArgTys, false));
193 // getFunction - Look up the specified function in the module symbol table.
194 // If it does not exist, return null.
196 Function *Module::getFunction(const std::string &Name) const {
197 const ValueSymbolTable &SymTab = getValueSymbolTable();
198 return dyn_cast_or_null<Function>(SymTab.lookup(Name));
201 Function *Module::getFunction(const char *Name) const {
202 const ValueSymbolTable &SymTab = getValueSymbolTable();
203 return dyn_cast_or_null<Function>(SymTab.lookup(Name, Name+strlen(Name)));
206 //===----------------------------------------------------------------------===//
207 // Methods for easy access to the global variables in the module.
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.
217 GlobalVariable *Module::getGlobalVariable(const std::string &Name,
218 bool AllowInternal) const {
219 if (Value *V = ValSymTab->lookup(Name)) {
220 GlobalVariable *Result = dyn_cast<GlobalVariable>(V);
221 if (Result && (AllowInternal || !Result->hasInternalLinkage()))
227 /// getOrInsertGlobal - Look up the specified global in the module symbol table.
228 /// 1. If it does not exist, add a declaration of the global and return it.
229 /// 2. Else, the global exists but has the wrong type: return the function
230 /// with a constantexpr cast to the right type.
231 /// 3. Finally, if the existing global is the correct delclaration, return the
233 Constant *Module::getOrInsertGlobal(const std::string &Name, const Type *Ty) {
234 ValueSymbolTable &SymTab = getValueSymbolTable();
236 // See if we have a definition for the specified global already.
237 GlobalVariable *GV = dyn_cast_or_null<GlobalVariable>(SymTab.lookup(Name));
240 GlobalVariable *New =
241 new GlobalVariable(Ty, false, GlobalVariable::ExternalLinkage, 0, Name);
242 GlobalList.push_back(New);
243 return New; // Return the new declaration.
246 // If the variable exists but has the wrong type, return a bitcast to the
248 if (GV->getType() != PointerType::getUnqual(Ty))
249 return ConstantExpr::getBitCast(GV, PointerType::getUnqual(Ty));
251 // Otherwise, we just found the existing function or a prototype.
255 //===----------------------------------------------------------------------===//
256 // Methods for easy access to the global variables in the module.
259 // getNamedAlias - Look up the specified global in the module symbol table.
260 // If it does not exist, return null.
262 GlobalAlias *Module::getNamedAlias(const std::string &Name) const {
263 const ValueSymbolTable &SymTab = getValueSymbolTable();
264 return dyn_cast_or_null<GlobalAlias>(SymTab.lookup(Name));
267 //===----------------------------------------------------------------------===//
268 // Methods for easy access to the types in the module.
272 // addTypeName - Insert an entry in the symbol table mapping Str to Type. If
273 // there is already an entry for this name, true is returned and the symbol
274 // table is not modified.
276 bool Module::addTypeName(const std::string &Name, const Type *Ty) {
277 TypeSymbolTable &ST = getTypeSymbolTable();
279 if (ST.lookup(Name)) return true; // Already in symtab...
281 // Not in symbol table? Set the name with the Symtab as an argument so the
282 // type knows what to update...
288 /// getTypeByName - Return the type with the specified name in this module, or
289 /// null if there is none by that name.
290 const Type *Module::getTypeByName(const std::string &Name) const {
291 const TypeSymbolTable &ST = getTypeSymbolTable();
292 return cast_or_null<Type>(ST.lookup(Name));
295 // getTypeName - If there is at least one entry in the symbol table for the
296 // specified type, return it.
298 std::string Module::getTypeName(const Type *Ty) const {
299 const TypeSymbolTable &ST = getTypeSymbolTable();
301 TypeSymbolTable::const_iterator TI = ST.begin();
302 TypeSymbolTable::const_iterator TE = ST.end();
303 if ( TI == TE ) return ""; // No names for types
305 while (TI != TE && TI->second != Ty)
308 if (TI != TE) // Must have found an entry!
310 return ""; // Must not have found anything...
313 //===----------------------------------------------------------------------===//
314 // Other module related stuff.
318 // dropAllReferences() - This function causes all the subelementss to "let go"
319 // of all references that they are maintaining. This allows one to 'delete' a
320 // whole module at a time, even though there may be circular references... first
321 // all references are dropped, and all use counts go to zero. Then everything
322 // is deleted for real. Note that no operations are valid on an object that
323 // has "dropped all references", except operator delete.
325 void Module::dropAllReferences() {
326 for(Module::iterator I = begin(), E = end(); I != E; ++I)
327 I->dropAllReferences();
329 for(Module::global_iterator I = global_begin(), E = global_end(); I != E; ++I)
330 I->dropAllReferences();
332 for(Module::alias_iterator I = alias_begin(), E = alias_end(); I != E; ++I)
333 I->dropAllReferences();
336 void Module::addLibrary(const std::string& Lib) {
337 for (Module::lib_iterator I = lib_begin(), E = lib_end(); I != E; ++I)
340 LibraryList.push_back(Lib);
343 void Module::removeLibrary(const std::string& Lib) {
344 LibraryListType::iterator I = LibraryList.begin();
345 LibraryListType::iterator E = LibraryList.end();
348 LibraryList.erase(I);