X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=lib%2FVMCore%2FModule.cpp;h=5b5176b3c70bc5150b934eccecb9ac248ae50db5;hb=ad41dcfd875e8d3421a5f0970b6a886b6e10b3b7;hp=3f599958985ed0fb304d19faa209d3946d6e5f88;hpb=e2fac77ad355b732da347e51234f02579da62bb6;p=oota-llvm.git diff --git a/lib/VMCore/Module.cpp b/lib/VMCore/Module.cpp index 3f599958985..5b5176b3c70 100644 --- a/lib/VMCore/Module.cpp +++ b/lib/VMCore/Module.cpp @@ -1,10 +1,10 @@ //===-- 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. @@ -15,86 +15,118 @@ #include "llvm/InstrTypes.h" #include "llvm/Constants.h" #include "llvm/DerivedTypes.h" -#include "Support/STLExtras.h" -#include "Support/LeakDetector.h" +#include "llvm/GVMaterializer.h" +#include "llvm/LLVMContext.h" +#include "llvm/ADT/DenseSet.h" +#include "llvm/ADT/SmallString.h" +#include "llvm/ADT/STLExtras.h" +#include "llvm/ADT/StringExtras.h" +#include "llvm/Support/LeakDetector.h" #include "SymbolTableListTraitsImpl.h" #include #include -#include -#include +#include using namespace llvm; //===----------------------------------------------------------------------===// // Methods to implement the globals and functions lists. // -Function *ilist_traits::createNode() { - FunctionType *FTy = - FunctionType::get(Type::VoidTy, std::vector(), false); - Function *Ret = new Function(FTy, GlobalValue::ExternalLinkage); - // This should not be garbage monitored. - LeakDetector::removeGarbageObject(Ret); - return Ret; -} -GlobalVariable *ilist_traits::createNode() { - GlobalVariable *Ret = new GlobalVariable(Type::IntTy, false, - GlobalValue::ExternalLinkage); - // This should not be garbage monitored. - LeakDetector::removeGarbageObject(Ret); - return Ret; -} - -iplist &ilist_traits::getList(Module *M) { - return M->getFunctionList(); -} -iplist &ilist_traits::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; -template class SymbolTableListTraits; - -// Define the GlobalValueRefMap as a struct that wraps a map so that we don't -// have Module.h depend on -// -namespace llvm { - struct GlobalValueRefMap { - typedef std::map MapTy; - typedef MapTy::iterator iterator; - std::map Map; - }; -} +// are not in the public header file. +template class llvm::SymbolTableListTraits; +template class llvm::SymbolTableListTraits; +template class llvm::SymbolTableListTraits; //===----------------------------------------------------------------------===// // 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), Materializer(NULL), ModuleID(MID) { + ValSymTab = new ValueSymbolTable(); + NamedMDSymTab = new StringMap(); + Context.addModule(this); } Module::~Module() { + Context.removeModule(this); dropAllReferences(); GlobalList.clear(); - GlobalList.setParent(0); FunctionList.clear(); - FunctionList.setParent(0); - delete SymTab; + AliasList.clear(); + LibraryList.clear(); + NamedMDList.clear(); + delete ValSymTab; + delete static_cast *>(NamedMDSymTab); +} + +/// Target endian information. +Module::Endianness Module::getEndianness() const { + StringRef temp = DataLayout; + Module::Endianness ret = AnyEndianness; + + while (!temp.empty()) { + std::pair P = getToken(temp, "-"); + + StringRef token = P.first; + temp = P.second; + + 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()) { + std::pair TmpP = getToken(temp, "-"); + temp = TmpP.second; + TmpP = getToken(TmpP.first, ":"); + StringRef token = TmpP.second, signalToken = TmpP.first; + + 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; +} + +/// 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(getValueSymbolTable().lookup(Name)); } -// Module::dump() - Allow printing from debugger -void Module::dump() const { - print(std::cerr); +/// 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 &Result) const { + return Context.getMDKindNames(Result); +} + + //===----------------------------------------------------------------------===// // Methods for easy access to the functions in the module. // @@ -104,18 +136,59 @@ void Module::dump() const { // 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(); - - // See if we have a definitions for the specified function already... - if (Value *V = SymTab.lookup(PointerType::get(Ty), Name)) { - return cast(V); // Yup, got it - } else { // Nope, add one - Function *New = new Function(Ty, GlobalVariable::ExternalLinkage, Name); +Constant *Module::getOrInsertFunction(StringRef Name, + 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; + } + + // 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, + 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, + FunctionType *Ty) { + return getOrInsertFunction(Name, Ty, AttrListPtr()); } // getOrInsertFunction - Look up the specified function in the module symbol @@ -123,93 +196,48 @@ Function *Module::getOrInsertFunction(const std::string &Name, // 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, - const Type *RetTy, ...) { +Constant *Module::getOrInsertFunction(StringRef Name, + AttrListPtr AttributeList, + Type *RetTy, ...) { va_list Args; va_start(Args, RetTy); // Build the list of argument types... - std::vector ArgTys; - while (const Type *ArgTy = va_arg(Args, const Type*)) + std::vector ArgTys; + while (Type *ArgTy = va_arg(Args, 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)); + return getOrInsertFunction(Name, + FunctionType::get(RetTy, ArgTys, false), + AttributeList); } +Constant *Module::getOrInsertFunction(StringRef Name, + Type *RetTy, ...) { + va_list Args; + va_start(Args, RetTy); -// 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(SymTab.lookup(PointerType::get(Ty), Name)); -} - + // Build the list of argument types... + std::vector ArgTys; + while (Type *ArgTy = va_arg(Args, Type*)) + ArgTys.push_back(ArgTy); -/// 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. -/// -Function *Module::getMainFunction() { - std::vector 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; - } + va_end(Args); - // Ok, try to find main the hard way... - return getNamedFunction("main"); + // Build the function type and chain to the other getOrInsertFunction... + return getOrInsertFunction(Name, + FunctionType::get(RetTy, ArgTys, false), + AttrListPtr()); } -/// 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... +// getFunction - Look up the specified function in the module symbol table. +// If it does not exist, return null. +// +Function *Module::getFunction(StringRef Name) const { + return dyn_cast_or_null(getNamedValue(Name)); } //===----------------------------------------------------------------------===// @@ -217,77 +245,195 @@ Function *Module::getNamedFunction(const std::string &Name) { // /// 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. +/// 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. /// -GlobalVariable *Module::getGlobalVariable(const std::string &Name, - const Type *Ty) { - if (Value *V = getSymbolTable().lookup(PointerType::get(Ty), Name)) { - GlobalVariable *Result = cast(V); - if (!Result->hasInternalLinkage()) +GlobalVariable *Module::getGlobalVariable(StringRef Name, + bool AllowLocal) const { + if (GlobalVariable *Result = + dyn_cast_or_null(getNamedValue(Name))) + if (AllowLocal || !Result->hasLocalLinkage()) return Result; - } return 0; } +/// 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, Type *Ty) { + // See if we have a definition for the specified global already. + GlobalVariable *GV = dyn_cast_or_null(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 types in the module. +// Methods for easy access to the global variables in the module. // - -// addTypeName - Insert an entry in the symbol table mapping Str to Type. If -// there is already an entry for this name, true is returned and the symbol -// table is not modified. +// getNamedAlias - Look up the specified global in the module symbol table. +// If it does not exist, return null. // -bool Module::addTypeName(const std::string &Name, const Type *Ty) { - SymbolTable &ST = getSymbolTable(); +GlobalAlias *Module::getNamedAlias(StringRef Name) const { + return dyn_cast_or_null(getNamedValue(Name)); +} - if (ST.lookupType(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); +/// 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(const Twine &Name) const { + SmallString<256> NameData; + StringRef NameRef = Name.toStringRef(NameData); + return static_cast *>(NamedMDSymTab)->lookup(NameRef); +} - return false; +/// 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 = + (*static_cast *>(NamedMDSymTab))[Name]; + if (!NMD) { + NMD = new NamedMDNode(Name); + NMD->setParent(this); + NamedMDList.push_back(NMD); + } + return NMD; +} + +/// eraseNamedMetadata - Remove the given NamedMDNode from this module and +/// delete it. +void Module::eraseNamedMetadata(NamedMDNode *NMD) { + static_cast *>(NamedMDSymTab)->erase(NMD->getName()); + NamedMDList.erase(NMD); +} + +/// getModuleFlagsMetadata - Returns the module flags in the provided vector. +void Module:: +getModuleFlagsMetadata(SmallVectorImpl &Flags) const { + const NamedMDNode *ModFlags = getModuleFlagsMetadata(); + if (!ModFlags) return; + + for (unsigned i = 0, e = ModFlags->getNumOperands(); i != e; ++i) { + MDNode *Flag = ModFlags->getOperand(i); + ConstantInt *Behavior = cast(Flag->getOperand(0)); + MDString *Key = cast(Flag->getOperand(1)); + Value *Val = Flag->getOperand(2); + Flags.push_back(ModuleFlagEntry(ModFlagBehavior(Behavior->getZExtValue()), + Key, Val)); + } +} + +/// getModuleFlagsMetadata - Returns the NamedMDNode in the module that +/// represents module-level flags. This method returns null if there are no +/// module-level flags. +NamedMDNode *Module::getModuleFlagsMetadata() const { + return getNamedMetadata("llvm.module.flags"); } -/// 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(ST.lookupType(Name)); +/// getOrInsertModuleFlagsMetadata - Returns the NamedMDNode in the module that +/// represents module-level flags. If module-level flags aren't found, it +/// creates the named metadata that contains them. +NamedMDNode *Module::getOrInsertModuleFlagsMetadata() { + return getOrInsertNamedMetadata("llvm.module.flags"); } -// getTypeName - If there is at least one entry in the symbol table for the -// specified type, return it. +/// addModuleFlag - Add a module-level flag to the module-level flags +/// metadata. It will create the module-level flags named metadata if it doesn't +/// already exist. +void Module::addModuleFlag(ModFlagBehavior Behavior, StringRef Key, + Value *Val) { + Type *Int32Ty = Type::getInt32Ty(Context); + Value *Ops[3] = { + ConstantInt::get(Int32Ty, Behavior), MDString::get(Context, Key), Val + }; + getOrInsertModuleFlagsMetadata()->addOperand(MDNode::get(Context, Ops)); +} +void Module::addModuleFlag(ModFlagBehavior Behavior, StringRef Key, + uint32_t Val) { + Type *Int32Ty = Type::getInt32Ty(Context); + addModuleFlag(Behavior, Key, ConstantInt::get(Int32Ty, Val)); +} +void Module::addModuleFlag(MDNode *Node) { + assert(Node->getNumOperands() == 3 && + "Invalid number of operands for module flag!"); + assert(isa(Node->getOperand(0)) && + isa(Node->getOperand(1)) && + "Invalid operand types for module flag!"); + getOrInsertModuleFlagsMetadata()->addOperand(Node); +} + +//===----------------------------------------------------------------------===// +// Methods to control the materialization of GlobalValues in the Module. // -std::string Module::getTypeName(const Type *Ty) const { - const SymbolTable &ST = getSymbolTable(); +void Module::setMaterializer(GVMaterializer *GVM) { + assert(!Materializer && + "Module already has a GVMaterializer. Call MaterializeAllPermanently" + " to clear it out before setting another one."); + Materializer.reset(GVM); +} + +bool Module::isMaterializable(const GlobalValue *GV) const { + if (Materializer) + return Materializer->isMaterializable(GV); + return false; +} + +bool Module::isDematerializable(const GlobalValue *GV) const { + if (Materializer) + return Materializer->isDematerializable(GV); + return false; +} - SymbolTable::type_const_iterator TI = ST.type_begin(); - SymbolTable::type_const_iterator TE = ST.type_end(); - if ( TI == TE ) return ""; // No names for types +bool Module::Materialize(GlobalValue *GV, std::string *ErrInfo) { + if (Materializer) + return Materializer->Materialize(GV, ErrInfo); + return false; +} - while (TI != TE && TI->second != Ty) - ++TI; +void Module::Dematerialize(GlobalValue *GV) { + if (Materializer) + return Materializer->Dematerialize(GV); +} - if (TI != TE) // Must have found an entry! - return TI->first; - return ""; // Must not have found anything... +bool Module::MaterializeAll(std::string *ErrInfo) { + if (!Materializer) + return false; + return Materializer->MaterializeModule(this, ErrInfo); } +bool Module::MaterializeAllPermanently(std::string *ErrInfo) { + if (MaterializeAll(ErrInfo)) + return true; + Materializer.reset(); + return false; +} //===----------------------------------------------------------------------===// // Other module related stuff. // -// dropAllReferences() - This function causes all the subelementss to "let go" +// dropAllReferences() - This function causes all the subelements to "let go" // of all references that they are maintaining. This allows one to 'delete' a // whole module at a time, even though there may be circular references... first // all references are dropped, and all use counts go to zero. Then everything @@ -298,40 +444,26 @@ void Module::dropAllReferences() { 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(); -} - -// 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::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; - } + for(Module::alias_iterator I = alias_begin(), E = alias_end(); I != E; ++I) + I->dropAllReferences(); +} + +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::removeLibrary(StringRef Lib) { + LibraryListType::iterator I = LibraryList.begin(); + LibraryListType::iterator E = LibraryList.end(); + for (;I != E; ++I) + if (*I == Lib) { + LibraryList.erase(I); + return; + } }