//===-- Module.cpp - Implement the Module class ---------------------------===//
-//
+//
// The LLVM Compiler Infrastructure
//
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
-//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
//===----------------------------------------------------------------------===//
//
// This file implements the Module class for the VMCore library.
#include "llvm/InstrTypes.h"
#include "llvm/Constants.h"
#include "llvm/DerivedTypes.h"
-#include "Support/STLExtras.h"
-#include "Support/LeakDetector.h"
+#include "llvm/LLVMContext.h"
+#include "llvm/ADT/STLExtras.h"
+#include "llvm/ADT/StringExtras.h"
+#include "llvm/Support/LeakDetector.h"
#include "SymbolTableListTraitsImpl.h"
+#include "llvm/TypeSymbolTable.h"
#include <algorithm>
#include <cstdarg>
-#include <map>
+#include <cstdlib>
using namespace llvm;
//===----------------------------------------------------------------------===//
-// Stuff to implement the globals and functions lists.
+// Methods to implement the globals and functions lists.
//
-Function *ilist_traits<Function>::createNode() {
- FunctionType *FTy =
- FunctionType::get(Type::VoidTy, std::vector<const Type*>(), false);
- Function *Ret = new Function(FTy, GlobalValue::ExternalLinkage);
+GlobalVariable *ilist_traits<GlobalVariable>::createSentinel() {
+ GlobalVariable *Ret = new GlobalVariable(Type::getInt32Ty(getGlobalContext()),
+ false, GlobalValue::ExternalLinkage);
// This should not be garbage monitored.
LeakDetector::removeGarbageObject(Ret);
return Ret;
}
-GlobalVariable *ilist_traits<GlobalVariable>::createNode() {
- GlobalVariable *Ret = new GlobalVariable(Type::IntTy, false,
- GlobalValue::ExternalLinkage);
+GlobalAlias *ilist_traits<GlobalAlias>::createSentinel() {
+ GlobalAlias *Ret = new GlobalAlias(Type::getInt32Ty(getGlobalContext()),
+ GlobalValue::ExternalLinkage);
// This should not be garbage monitored.
LeakDetector::removeGarbageObject(Ret);
return Ret;
}
-iplist<Function> &ilist_traits<Function>::getList(Module *M) {
- return M->getFunctionList();
-}
-iplist<GlobalVariable> &ilist_traits<GlobalVariable>::getList(Module *M) {
- return M->getGlobalList();
-}
-
// Explicit instantiations of SymbolTableListTraits since some of the methods
-// are not in the public header file...
-template class SymbolTableListTraits<GlobalVariable, Module, Module>;
-template class SymbolTableListTraits<Function, Module, Module>;
-
-// Define the GlobalValueRefMap as a struct that wraps a map so that we don't
-// have Module.h depend on <map>
-//
-namespace llvm {
- struct GlobalValueRefMap {
- typedef std::map<GlobalValue*, ConstantPointerRef*> MapTy;
- typedef MapTy::iterator iterator;
- std::map<GlobalValue*, ConstantPointerRef*> Map;
- };
-}
+// are not in the public header file.
+template class llvm::SymbolTableListTraits<GlobalVariable, Module>;
+template class llvm::SymbolTableListTraits<Function, Module>;
+template class llvm::SymbolTableListTraits<GlobalAlias, Module>;
//===----------------------------------------------------------------------===//
// Primitive Module methods.
//
-Module::Module(const std::string &MID)
- : ModuleID(MID), Endian(AnyEndianness), PtrSize(AnyPointerSize) {
- FunctionList.setItemParent(this);
- FunctionList.setParent(this);
- GlobalList.setItemParent(this);
- GlobalList.setParent(this);
- GVRefMap = 0;
- SymTab = new SymbolTable();
+Module::Module(StringRef MID, LLVMContext& C)
+ : Context(C), ModuleID(MID), DataLayout("") {
+ ValSymTab = new ValueSymbolTable();
+ TypeSymTab = new TypeSymbolTable();
+ NamedMDSymTab = new MDSymbolTable();
}
Module::~Module() {
dropAllReferences();
GlobalList.clear();
- GlobalList.setParent(0);
FunctionList.clear();
- FunctionList.setParent(0);
- delete SymTab;
+ AliasList.clear();
+ LibraryList.clear();
+ NamedMDList.clear();
+ delete ValSymTab;
+ delete TypeSymTab;
+ delete NamedMDSymTab;
+}
+
+/// Target endian information...
+Module::Endianness Module::getEndianness() const {
+ StringRef temp = DataLayout;
+ Module::Endianness ret = AnyEndianness;
+
+ while (!temp.empty()) {
+ StringRef token = DataLayout;
+ tie(token, temp) = getToken(DataLayout, "-");
+
+ if (token[0] == 'e') {
+ ret = LittleEndian;
+ } else if (token[0] == 'E') {
+ ret = BigEndian;
+ }
+ }
+
+ return ret;
+}
+
+/// Target Pointer Size information...
+Module::PointerSize Module::getPointerSize() const {
+ StringRef temp = DataLayout;
+ Module::PointerSize ret = AnyPointerSize;
+
+ while (!temp.empty()) {
+ StringRef token, signalToken;
+ tie(token, temp) = getToken(temp, "-");
+ tie(signalToken, token) = getToken(token, ":");
+
+ if (signalToken[0] == 'p') {
+ int size = 0;
+ getToken(token, ":").first.getAsInteger(10, size);
+ if (size == 32)
+ ret = Pointer32;
+ else if (size == 64)
+ ret = Pointer64;
+ }
+ }
+
+ return ret;
}
-// Module::dump() - Allow printing from debugger
-void Module::dump() const {
- print(std::cerr);
+/// getNamedValue - Return the first global value in the module with
+/// the specified name, of arbitrary type. This method returns null
+/// if a global with the specified name is not found.
+GlobalValue *Module::getNamedValue(StringRef Name) const {
+ return cast_or_null<GlobalValue>(getValueSymbolTable().lookup(Name));
}
+/// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
+/// This ID is uniqued across modules in the current LLVMContext.
+unsigned Module::getMDKindID(StringRef Name) const {
+ return Context.getMDKindID(Name);
+}
+
+/// getMDKindNames - Populate client supplied SmallVector with the name for
+/// custom metadata IDs registered in this LLVMContext. ID #0 is not used,
+/// so it is filled in as an empty string.
+void Module::getMDKindNames(SmallVectorImpl<StringRef> &Result) const {
+ return Context.getMDKindNames(Result);
+}
+
+
//===----------------------------------------------------------------------===//
// Methods for easy access to the functions in the module.
//
// it. This is nice because it allows most passes to get away with not handling
// the symbol table directly for this common task.
//
-Function *Module::getOrInsertFunction(const std::string &Name,
- const FunctionType *Ty) {
- SymbolTable &SymTab = getSymbolTable();
+Constant *Module::getOrInsertFunction(StringRef Name,
+ const FunctionType *Ty,
+ AttrListPtr AttributeList) {
+ // See if we have a definition for the specified function already.
+ GlobalValue *F = getNamedValue(Name);
+ if (F == 0) {
+ // Nope, add it
+ Function *New = Function::Create(Ty, GlobalVariable::ExternalLinkage, Name);
+ if (!New->isIntrinsic()) // Intrinsics get attrs set on construction
+ New->setAttributes(AttributeList);
+ FunctionList.push_back(New);
+ return New; // Return the new prototype.
+ }
+
+ // Okay, the function exists. Does it have externally visible linkage?
+ if (F->hasLocalLinkage()) {
+ // Clear the function's name.
+ F->setName("");
+ // Retry, now there won't be a conflict.
+ Constant *NewF = getOrInsertFunction(Name, Ty);
+ F->setName(Name);
+ return NewF;
+ }
- // See if we have a definitions for the specified function already...
- if (Value *V = SymTab.lookup(PointerType::get(Ty), Name)) {
- return cast<Function>(V); // Yup, got it
- } else { // Nope, add one
- Function *New = new Function(Ty, GlobalVariable::ExternalLinkage, Name);
+ // If the function exists but has the wrong type, return a bitcast to the
+ // right type.
+ if (F->getType() != PointerType::getUnqual(Ty))
+ return ConstantExpr::getBitCast(F, PointerType::getUnqual(Ty));
+
+ // Otherwise, we just found the existing function or a prototype.
+ return F;
+}
+
+Constant *Module::getOrInsertTargetIntrinsic(StringRef Name,
+ const FunctionType *Ty,
+ AttrListPtr AttributeList) {
+ // See if we have a definition for the specified function already.
+ GlobalValue *F = getNamedValue(Name);
+ if (F == 0) {
+ // Nope, add it
+ Function *New = Function::Create(Ty, GlobalVariable::ExternalLinkage, Name);
+ New->setAttributes(AttributeList);
FunctionList.push_back(New);
- return New; // Return the new prototype...
+ return New; // Return the new prototype.
}
+
+ // Otherwise, we just found the existing function or a prototype.
+ return F;
+}
+
+Constant *Module::getOrInsertFunction(StringRef Name,
+ const FunctionType *Ty) {
+ AttrListPtr AttributeList = AttrListPtr::get((AttributeWithIndex *)0, 0);
+ return getOrInsertFunction(Name, Ty, AttributeList);
}
// getOrInsertFunction - Look up the specified function in the module symbol
// This version of the method takes a null terminated list of function
// arguments, which makes it easier for clients to use.
//
-Function *Module::getOrInsertFunction(const std::string &Name,
+Constant *Module::getOrInsertFunction(StringRef Name,
+ AttrListPtr AttributeList,
const Type *RetTy, ...) {
va_list Args;
va_start(Args, RetTy);
va_end(Args);
// Build the function type and chain to the other getOrInsertFunction...
- return getOrInsertFunction(Name, FunctionType::get(RetTy, ArgTys, false));
+ return getOrInsertFunction(Name,
+ FunctionType::get(RetTy, ArgTys, false),
+ AttributeList);
}
+Constant *Module::getOrInsertFunction(StringRef Name,
+ const Type *RetTy, ...) {
+ va_list Args;
+ va_start(Args, RetTy);
+
+ // Build the list of argument types...
+ std::vector<const Type*> ArgTys;
+ while (const Type *ArgTy = va_arg(Args, const Type*))
+ ArgTys.push_back(ArgTy);
+
+ va_end(Args);
+
+ // Build the function type and chain to the other getOrInsertFunction...
+ return getOrInsertFunction(Name,
+ FunctionType::get(RetTy, ArgTys, false),
+ AttrListPtr::get((AttributeWithIndex *)0, 0));
+}
// getFunction - Look up the specified function in the module symbol table.
// If it does not exist, return null.
//
-Function *Module::getFunction(const std::string &Name, const FunctionType *Ty) {
- SymbolTable &SymTab = getSymbolTable();
- return cast_or_null<Function>(SymTab.lookup(PointerType::get(Ty), Name));
+Function *Module::getFunction(StringRef Name) const {
+ return dyn_cast_or_null<Function>(getNamedValue(Name));
}
+//===----------------------------------------------------------------------===//
+// Methods for easy access to the global variables in the module.
+//
-/// getMainFunction - This function looks up main efficiently. This is such a
-/// common case, that it is a method in Module. If main cannot be found, a
-/// null pointer is returned.
+/// getGlobalVariable - Look up the specified global variable in the module
+/// symbol table. If it does not exist, return null. The type argument
+/// should be the underlying type of the global, i.e., it should not have
+/// the top-level PointerType, which represents the address of the global.
+/// If AllowLocal is set to true, this function will return types that
+/// have an local. By default, these types are not returned.
///
-Function *Module::getMainFunction() {
- std::vector<const Type*> Params;
-
- // int main(void)...
- if (Function *F = getFunction("main", FunctionType::get(Type::IntTy,
- Params, false)))
- return F;
-
- // void main(void)...
- if (Function *F = getFunction("main", FunctionType::get(Type::VoidTy,
- Params, false)))
- return F;
-
- Params.push_back(Type::IntTy);
-
- // int main(int argc)...
- if (Function *F = getFunction("main", FunctionType::get(Type::IntTy,
- Params, false)))
- return F;
-
- // void main(int argc)...
- if (Function *F = getFunction("main", FunctionType::get(Type::VoidTy,
- Params, false)))
- return F;
-
- for (unsigned i = 0; i != 2; ++i) { // Check argv and envp
- Params.push_back(PointerType::get(PointerType::get(Type::SByteTy)));
-
- // int main(int argc, char **argv)...
- if (Function *F = getFunction("main", FunctionType::get(Type::IntTy,
- Params, false)))
- return F;
-
- // void main(int argc, char **argv)...
- if (Function *F = getFunction("main", FunctionType::get(Type::VoidTy,
- Params, false)))
- return F;
- }
-
- // Ok, try to find main the hard way...
- return getNamedFunction("main");
+GlobalVariable *Module::getGlobalVariable(StringRef Name,
+ bool AllowLocal) const {
+ if (GlobalVariable *Result =
+ dyn_cast_or_null<GlobalVariable>(getNamedValue(Name)))
+ if (AllowLocal || !Result->hasLocalLinkage())
+ return Result;
+ return 0;
}
-/// getNamedFunction - Return the first function in the module with the
-/// specified name, of arbitrary type. This method returns null if a function
-/// with the specified name is not found.
-///
-Function *Module::getNamedFunction(const std::string &Name) {
- // Loop over all of the functions, looking for the function desired
- Function *Found = 0;
- for (iterator I = begin(), E = end(); I != E; ++I)
- if (I->getName() == Name)
- if (I->isExternal())
- Found = I;
- else
- return I;
- return Found; // Non-external function not found...
+/// getOrInsertGlobal - Look up the specified global in the module symbol table.
+/// 1. If it does not exist, add a declaration of the global and return it.
+/// 2. Else, the global exists but has the wrong type: return the function
+/// with a constantexpr cast to the right type.
+/// 3. Finally, if the existing global is the correct delclaration, return the
+/// existing global.
+Constant *Module::getOrInsertGlobal(StringRef Name, const Type *Ty) {
+ // See if we have a definition for the specified global already.
+ GlobalVariable *GV = dyn_cast_or_null<GlobalVariable>(getNamedValue(Name));
+ if (GV == 0) {
+ // Nope, add it
+ GlobalVariable *New =
+ new GlobalVariable(*this, Ty, false, GlobalVariable::ExternalLinkage,
+ 0, Name);
+ return New; // Return the new declaration.
+ }
+
+ // If the variable exists but has the wrong type, return a bitcast to the
+ // right type.
+ if (GV->getType() != PointerType::getUnqual(Ty))
+ return ConstantExpr::getBitCast(GV, PointerType::getUnqual(Ty));
+
+ // Otherwise, we just found the existing function or a prototype.
+ return GV;
}
//===----------------------------------------------------------------------===//
// Methods for easy access to the global variables in the module.
//
-/// getGlobalVariable - Look up the specified global variable in the module
-/// symbol table. If it does not exist, return null. Note that this only
-/// returns a global variable if it does not have internal linkage. The type
-/// argument should be the underlying type of the global, ie, it should not
-/// have the top-level PointerType, which represents the address of the
-/// global.
-///
-GlobalVariable *Module::getGlobalVariable(const std::string &Name,
- const Type *Ty) {
- if (Value *V = getSymbolTable().lookup(PointerType::get(Ty), Name)) {
- GlobalVariable *Result = cast<GlobalVariable>(V);
- if (!Result->hasInternalLinkage())
- return Result;
- }
- return 0;
+// getNamedAlias - Look up the specified global in the module symbol table.
+// If it does not exist, return null.
+//
+GlobalAlias *Module::getNamedAlias(StringRef Name) const {
+ return dyn_cast_or_null<GlobalAlias>(getNamedValue(Name));
}
+/// getNamedMetadata - Return the first NamedMDNode in the module with the
+/// specified name. This method returns null if a NamedMDNode with the
+//// specified name is not found.
+NamedMDNode *Module::getNamedMetadata(StringRef Name) const {
+ return NamedMDSymTab->lookup(Name);
+}
+/// getOrInsertNamedMetadata - Return the first named MDNode in the module
+/// with the specified name. This method returns a new NamedMDNode if a
+/// NamedMDNode with the specified name is not found.
+NamedMDNode *Module::getOrInsertNamedMetadata(StringRef Name) {
+ NamedMDNode *NMD = NamedMDSymTab->lookup(Name);
+ if (!NMD)
+ NMD = NamedMDNode::Create(getContext(), Name, NULL, 0, this);
+ return NMD;
+}
//===----------------------------------------------------------------------===//
// Methods for easy access to the types in the module.
// there is already an entry for this name, true is returned and the symbol
// table is not modified.
//
-bool Module::addTypeName(const std::string &Name, const Type *Ty) {
- SymbolTable &ST = getSymbolTable();
+bool Module::addTypeName(StringRef Name, const Type *Ty) {
+ TypeSymbolTable &ST = getTypeSymbolTable();
+
+ if (ST.lookup(Name)) return true; // Already in symtab...
- if (ST.lookup(Type::TypeTy, Name)) return true; // Already in symtab...
-
// Not in symbol table? Set the name with the Symtab as an argument so the
// type knows what to update...
- ((Value*)Ty)->setName(Name, &ST);
+ ST.insert(Name, Ty);
return false;
}
/// getTypeByName - Return the type with the specified name in this module, or
/// null if there is none by that name.
-const Type *Module::getTypeByName(const std::string &Name) const {
- const SymbolTable &ST = getSymbolTable();
- return cast_or_null<Type>(ST.lookup(Type::TypeTy, Name));
+const Type *Module::getTypeByName(StringRef Name) const {
+ const TypeSymbolTable &ST = getTypeSymbolTable();
+ return cast_or_null<Type>(ST.lookup(Name));
}
// getTypeName - If there is at least one entry in the symbol table for the
// specified type, return it.
//
std::string Module::getTypeName(const Type *Ty) const {
- const SymbolTable &ST = getSymbolTable();
- if (ST.find(Type::TypeTy) == ST.end())
- return ""; // No names for types...
+ const TypeSymbolTable &ST = getTypeSymbolTable();
- SymbolTable::type_const_iterator TI = ST.type_begin(Type::TypeTy);
- SymbolTable::type_const_iterator TE = ST.type_end(Type::TypeTy);
+ TypeSymbolTable::const_iterator TI = ST.begin();
+ TypeSymbolTable::const_iterator TE = ST.end();
+ if ( TI == TE ) return ""; // No names for types
- while (TI != TE && TI->second != (const Value*)Ty)
+ while (TI != TE && TI->second != Ty)
++TI;
if (TI != TE) // Must have found an entry!
return ""; // Must not have found anything...
}
-
//===----------------------------------------------------------------------===//
// Other module related stuff.
//
for(Module::iterator I = begin(), E = end(); I != E; ++I)
I->dropAllReferences();
- for(Module::giterator I = gbegin(), E = gend(); I != E; ++I)
+ for(Module::global_iterator I = global_begin(), E = global_end(); I != E; ++I)
I->dropAllReferences();
- // If there are any GlobalVariable references still out there, nuke them now.
- // Since all references are hereby dropped, nothing could possibly reference
- // them still. Note that destroying all of the constant pointer refs will
- // eventually cause the GVRefMap field to be set to null (by
- // destroyConstantPointerRef, below).
- //
- while (GVRefMap)
- // Delete the ConstantPointerRef node...
- GVRefMap->Map.begin()->second->destroyConstant();
+ for(Module::alias_iterator I = alias_begin(), E = alias_end(); I != E; ++I)
+ I->dropAllReferences();
}
-// Accessor for the underlying GlobalValRefMap...
-ConstantPointerRef *Module::getConstantPointerRef(GlobalValue *V){
- // Create ref map lazily on demand...
- if (GVRefMap == 0) GVRefMap = new GlobalValueRefMap();
-
- GlobalValueRefMap::iterator I = GVRefMap->Map.find(V);
- if (I != GVRefMap->Map.end()) return I->second;
-
- ConstantPointerRef *Ref = new ConstantPointerRef(V);
- GVRefMap->Map[V] = Ref;
- return Ref;
+void Module::addLibrary(StringRef Lib) {
+ for (Module::lib_iterator I = lib_begin(), E = lib_end(); I != E; ++I)
+ if (*I == Lib)
+ return;
+ LibraryList.push_back(Lib);
}
-void Module::destroyConstantPointerRef(ConstantPointerRef *CPR) {
- assert(GVRefMap && "No map allocated, but we have a CPR?");
- if (!GVRefMap->Map.erase(CPR->getValue())) // Remove it from the map...
- assert(0 && "ConstantPointerRef not found in module CPR map!");
-
- if (GVRefMap->Map.empty()) { // If the map is empty, delete it.
- delete GVRefMap;
- GVRefMap = 0;
- }
+void Module::removeLibrary(StringRef Lib) {
+ LibraryListType::iterator I = LibraryList.begin();
+ LibraryListType::iterator E = LibraryList.end();
+ for (;I != E; ++I)
+ if (*I == Lib) {
+ LibraryList.erase(I);
+ return;
+ }
}