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/LLVMContext.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/ADT/StringExtras.h"
21 #include "llvm/Support/LeakDetector.h"
22 #include "SymbolTableListTraitsImpl.h"
23 #include "llvm/TypeSymbolTable.h"
29 //===----------------------------------------------------------------------===//
30 // Methods to implement the globals and functions lists.
33 GlobalVariable *ilist_traits<GlobalVariable>::createSentinel() {
34 GlobalVariable *Ret = new GlobalVariable(Type::Int32Ty, false,
35 GlobalValue::ExternalLinkage);
36 // This should not be garbage monitored.
37 LeakDetector::removeGarbageObject(Ret);
40 GlobalAlias *ilist_traits<GlobalAlias>::createSentinel() {
41 GlobalAlias *Ret = new GlobalAlias(Type::Int32Ty,
42 GlobalValue::ExternalLinkage);
43 // This should not be garbage monitored.
44 LeakDetector::removeGarbageObject(Ret);
48 // Explicit instantiations of SymbolTableListTraits since some of the methods
49 // are not in the public header file.
50 template class SymbolTableListTraits<GlobalVariable, Module>;
51 template class SymbolTableListTraits<Function, Module>;
52 template class SymbolTableListTraits<GlobalAlias, Module>;
54 //===----------------------------------------------------------------------===//
55 // Primitive Module methods.
58 Module::Module(const std::string &MID, const LLVMContext& C)
59 : Context(C), ModuleID(MID), DataLayout("") {
60 ValSymTab = new ValueSymbolTable();
61 TypeSymTab = new TypeSymbolTable();
74 /// Target endian information...
75 Module::Endianness Module::getEndianness() const {
76 std::string temp = DataLayout;
77 Module::Endianness ret = AnyEndianness;
79 while (!temp.empty()) {
80 std::string token = getToken(temp, "-");
82 if (token[0] == 'e') {
84 } else if (token[0] == 'E') {
92 /// Target Pointer Size information...
93 Module::PointerSize Module::getPointerSize() const {
94 std::string temp = DataLayout;
95 Module::PointerSize ret = AnyPointerSize;
97 while (!temp.empty()) {
98 std::string token = getToken(temp, "-");
99 char signal = getToken(token, ":")[0];
102 int size = atoi(getToken(token, ":").c_str());
113 /// getNamedValue - Return the first global value in the module with
114 /// the specified name, of arbitrary type. This method returns null
115 /// if a global with the specified name is not found.
116 GlobalValue *Module::getNamedValue(const std::string &Name) const {
117 return cast_or_null<GlobalValue>(getValueSymbolTable().lookup(Name));
120 GlobalValue *Module::getNamedValue(const char *Name) const {
121 llvm::Value *V = getValueSymbolTable().lookup(Name, Name+strlen(Name));
122 return cast_or_null<GlobalValue>(V);
125 //===----------------------------------------------------------------------===//
126 // Methods for easy access to the functions in the module.
129 // getOrInsertFunction - Look up the specified function in the module symbol
130 // table. If it does not exist, add a prototype for the function and return
131 // it. This is nice because it allows most passes to get away with not handling
132 // the symbol table directly for this common task.
134 Constant *Module::getOrInsertFunction(const std::string &Name,
135 const FunctionType *Ty,
136 AttrListPtr AttributeList) {
137 // See if we have a definition for the specified function already.
138 GlobalValue *F = getNamedValue(Name);
141 Function *New = Function::Create(Ty, GlobalVariable::ExternalLinkage, Name);
142 if (!New->isIntrinsic()) // Intrinsics get attrs set on construction
143 New->setAttributes(AttributeList);
144 FunctionList.push_back(New);
145 return New; // Return the new prototype.
148 // Okay, the function exists. Does it have externally visible linkage?
149 if (F->hasLocalLinkage()) {
150 // Clear the function's name.
152 // Retry, now there won't be a conflict.
153 Constant *NewF = getOrInsertFunction(Name, Ty);
154 F->setName(&Name[0], Name.size());
158 // If the function exists but has the wrong type, return a bitcast to the
160 if (F->getType() != PointerType::getUnqual(Ty))
161 return ConstantExpr::getBitCast(F, PointerType::getUnqual(Ty));
163 // Otherwise, we just found the existing function or a prototype.
167 Constant *Module::getOrInsertTargetIntrinsic(const std::string &Name,
168 const FunctionType *Ty,
169 AttrListPtr AttributeList) {
170 // See if we have a definition for the specified function already.
171 GlobalValue *F = getNamedValue(Name);
174 Function *New = Function::Create(Ty, GlobalVariable::ExternalLinkage, Name);
175 New->setAttributes(AttributeList);
176 FunctionList.push_back(New);
177 return New; // Return the new prototype.
180 // Otherwise, we just found the existing function or a prototype.
184 Constant *Module::getOrInsertFunction(const std::string &Name,
185 const FunctionType *Ty) {
186 AttrListPtr AttributeList = AttrListPtr::get((AttributeWithIndex *)0, 0);
187 return getOrInsertFunction(Name, Ty, AttributeList);
190 // getOrInsertFunction - Look up the specified function in the module symbol
191 // table. If it does not exist, add a prototype for the function and return it.
192 // This version of the method takes a null terminated list of function
193 // arguments, which makes it easier for clients to use.
195 Constant *Module::getOrInsertFunction(const std::string &Name,
196 AttrListPtr AttributeList,
197 const Type *RetTy, ...) {
199 va_start(Args, RetTy);
201 // Build the list of argument types...
202 std::vector<const Type*> ArgTys;
203 while (const Type *ArgTy = va_arg(Args, const Type*))
204 ArgTys.push_back(ArgTy);
208 // Build the function type and chain to the other getOrInsertFunction...
209 return getOrInsertFunction(Name, FunctionType::get(RetTy, ArgTys, false),
213 Constant *Module::getOrInsertFunction(const std::string &Name,
214 const Type *RetTy, ...) {
216 va_start(Args, RetTy);
218 // Build the list of argument types...
219 std::vector<const Type*> ArgTys;
220 while (const Type *ArgTy = va_arg(Args, const Type*))
221 ArgTys.push_back(ArgTy);
225 // Build the function type and chain to the other getOrInsertFunction...
226 return getOrInsertFunction(Name, FunctionType::get(RetTy, ArgTys, false),
227 AttrListPtr::get((AttributeWithIndex *)0, 0));
230 // getFunction - Look up the specified function in the module symbol table.
231 // If it does not exist, return null.
233 Function *Module::getFunction(const std::string &Name) const {
234 return dyn_cast_or_null<Function>(getNamedValue(Name));
237 Function *Module::getFunction(const char *Name) const {
238 return dyn_cast_or_null<Function>(getNamedValue(Name));
241 //===----------------------------------------------------------------------===//
242 // Methods for easy access to the global variables in the module.
245 /// getGlobalVariable - Look up the specified global variable in the module
246 /// symbol table. If it does not exist, return null. The type argument
247 /// should be the underlying type of the global, i.e., it should not have
248 /// the top-level PointerType, which represents the address of the global.
249 /// If AllowLocal is set to true, this function will return types that
250 /// have an local. By default, these types are not returned.
252 GlobalVariable *Module::getGlobalVariable(const std::string &Name,
253 bool AllowLocal) const {
254 if (GlobalVariable *Result =
255 dyn_cast_or_null<GlobalVariable>(getNamedValue(Name)))
256 if (AllowLocal || !Result->hasLocalLinkage())
261 /// getOrInsertGlobal - Look up the specified global in the module symbol table.
262 /// 1. If it does not exist, add a declaration of the global and return it.
263 /// 2. Else, the global exists but has the wrong type: return the function
264 /// with a constantexpr cast to the right type.
265 /// 3. Finally, if the existing global is the correct delclaration, return the
267 Constant *Module::getOrInsertGlobal(const std::string &Name, const Type *Ty) {
268 // See if we have a definition for the specified global already.
269 GlobalVariable *GV = dyn_cast_or_null<GlobalVariable>(getNamedValue(Name));
272 GlobalVariable *New =
273 new GlobalVariable(Ty, false, GlobalVariable::ExternalLinkage, 0, Name);
274 GlobalList.push_back(New);
275 return New; // Return the new declaration.
278 // If the variable exists but has the wrong type, return a bitcast to the
280 if (GV->getType() != PointerType::getUnqual(Ty))
281 return ConstantExpr::getBitCast(GV, PointerType::getUnqual(Ty));
283 // Otherwise, we just found the existing function or a prototype.
287 //===----------------------------------------------------------------------===//
288 // Methods for easy access to the global variables in the module.
291 // getNamedAlias - Look up the specified global in the module symbol table.
292 // If it does not exist, return null.
294 GlobalAlias *Module::getNamedAlias(const std::string &Name) const {
295 return dyn_cast_or_null<GlobalAlias>(getNamedValue(Name));
298 //===----------------------------------------------------------------------===//
299 // Methods for easy access to the types in the module.
303 // addTypeName - Insert an entry in the symbol table mapping Str to Type. If
304 // there is already an entry for this name, true is returned and the symbol
305 // table is not modified.
307 bool Module::addTypeName(const std::string &Name, const Type *Ty) {
308 TypeSymbolTable &ST = getTypeSymbolTable();
310 if (ST.lookup(Name)) return true; // Already in symtab...
312 // Not in symbol table? Set the name with the Symtab as an argument so the
313 // type knows what to update...
319 /// getTypeByName - Return the type with the specified name in this module, or
320 /// null if there is none by that name.
321 const Type *Module::getTypeByName(const std::string &Name) const {
322 const TypeSymbolTable &ST = getTypeSymbolTable();
323 return cast_or_null<Type>(ST.lookup(Name));
326 // getTypeName - If there is at least one entry in the symbol table for the
327 // specified type, return it.
329 std::string Module::getTypeName(const Type *Ty) const {
330 const TypeSymbolTable &ST = getTypeSymbolTable();
332 TypeSymbolTable::const_iterator TI = ST.begin();
333 TypeSymbolTable::const_iterator TE = ST.end();
334 if ( TI == TE ) return ""; // No names for types
336 while (TI != TE && TI->second != Ty)
339 if (TI != TE) // Must have found an entry!
341 return ""; // Must not have found anything...
344 //===----------------------------------------------------------------------===//
345 // Other module related stuff.
349 // dropAllReferences() - This function causes all the subelementss to "let go"
350 // of all references that they are maintaining. This allows one to 'delete' a
351 // whole module at a time, even though there may be circular references... first
352 // all references are dropped, and all use counts go to zero. Then everything
353 // is deleted for real. Note that no operations are valid on an object that
354 // has "dropped all references", except operator delete.
356 void Module::dropAllReferences() {
357 for(Module::iterator I = begin(), E = end(); I != E; ++I)
358 I->dropAllReferences();
360 for(Module::global_iterator I = global_begin(), E = global_end(); I != E; ++I)
361 I->dropAllReferences();
363 for(Module::alias_iterator I = alias_begin(), E = alias_end(); I != E; ++I)
364 I->dropAllReferences();
367 void Module::addLibrary(const std::string& Lib) {
368 for (Module::lib_iterator I = lib_begin(), E = lib_end(); I != E; ++I)
371 LibraryList.push_back(Lib);
374 void Module::removeLibrary(const std::string& Lib) {
375 LibraryListType::iterator I = LibraryList.begin();
376 LibraryListType::iterator E = LibraryList.end();
379 LibraryList.erase(I);