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 IR library.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/IR/Module.h"
15 #include "SymbolTableListTraitsImpl.h"
16 #include "llvm/ADT/DenseSet.h"
17 #include "llvm/ADT/STLExtras.h"
18 #include "llvm/ADT/SmallString.h"
19 #include "llvm/ADT/StringExtras.h"
20 #include "llvm/IR/Constants.h"
21 #include "llvm/IR/DerivedTypes.h"
22 #include "llvm/IR/GVMaterializer.h"
23 #include "llvm/IR/InstrTypes.h"
24 #include "llvm/IR/LLVMContext.h"
25 #include "llvm/IR/LeakDetector.h"
31 //===----------------------------------------------------------------------===//
32 // Methods to implement the globals and functions lists.
35 // Explicit instantiations of SymbolTableListTraits since some of the methods
36 // are not in the public header file.
37 template class llvm::SymbolTableListTraits<Function, Module>;
38 template class llvm::SymbolTableListTraits<GlobalVariable, Module>;
39 template class llvm::SymbolTableListTraits<GlobalAlias, Module>;
41 //===----------------------------------------------------------------------===//
42 // Primitive Module methods.
45 Module::Module(StringRef MID, LLVMContext &C)
46 : Context(C), Materializer(), ModuleID(MID), DL("") {
47 ValSymTab = new ValueSymbolTable();
48 NamedMDSymTab = new StringMap<NamedMDNode *>();
49 Context.addModule(this);
53 Context.removeModule(this);
60 delete static_cast<StringMap<NamedMDNode *> *>(NamedMDSymTab);
63 /// getNamedValue - Return the first global value in the module with
64 /// the specified name, of arbitrary type. This method returns null
65 /// if a global with the specified name is not found.
66 GlobalValue *Module::getNamedValue(StringRef Name) const {
67 return cast_or_null<GlobalValue>(getValueSymbolTable().lookup(Name));
70 /// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
71 /// This ID is uniqued across modules in the current LLVMContext.
72 unsigned Module::getMDKindID(StringRef Name) const {
73 return Context.getMDKindID(Name);
76 /// getMDKindNames - Populate client supplied SmallVector with the name for
77 /// custom metadata IDs registered in this LLVMContext. ID #0 is not used,
78 /// so it is filled in as an empty string.
79 void Module::getMDKindNames(SmallVectorImpl<StringRef> &Result) const {
80 return Context.getMDKindNames(Result);
84 //===----------------------------------------------------------------------===//
85 // Methods for easy access to the functions in the module.
88 // getOrInsertFunction - Look up the specified function in the module symbol
89 // table. If it does not exist, add a prototype for the function and return
90 // it. This is nice because it allows most passes to get away with not handling
91 // the symbol table directly for this common task.
93 Constant *Module::getOrInsertFunction(StringRef Name,
95 AttributeSet AttributeList) {
96 // See if we have a definition for the specified function already.
97 GlobalValue *F = getNamedValue(Name);
100 Function *New = Function::Create(Ty, GlobalVariable::ExternalLinkage, Name);
101 if (!New->isIntrinsic()) // Intrinsics get attrs set on construction
102 New->setAttributes(AttributeList);
103 FunctionList.push_back(New);
104 return New; // Return the new prototype.
107 // If the function exists but has the wrong type, return a bitcast to the
109 if (F->getType() != PointerType::getUnqual(Ty))
110 return ConstantExpr::getBitCast(F, PointerType::getUnqual(Ty));
112 // Otherwise, we just found the existing function or a prototype.
116 Constant *Module::getOrInsertFunction(StringRef Name,
118 return getOrInsertFunction(Name, Ty, AttributeSet());
121 // getOrInsertFunction - Look up the specified function in the module symbol
122 // table. If it does not exist, add a prototype for the function and return it.
123 // This version of the method takes a null terminated list of function
124 // arguments, which makes it easier for clients to use.
126 Constant *Module::getOrInsertFunction(StringRef Name,
127 AttributeSet AttributeList,
130 va_start(Args, RetTy);
132 // Build the list of argument types...
133 std::vector<Type*> ArgTys;
134 while (Type *ArgTy = va_arg(Args, Type*))
135 ArgTys.push_back(ArgTy);
139 // Build the function type and chain to the other getOrInsertFunction...
140 return getOrInsertFunction(Name,
141 FunctionType::get(RetTy, ArgTys, false),
145 Constant *Module::getOrInsertFunction(StringRef Name,
148 va_start(Args, RetTy);
150 // Build the list of argument types...
151 std::vector<Type*> ArgTys;
152 while (Type *ArgTy = va_arg(Args, Type*))
153 ArgTys.push_back(ArgTy);
157 // Build the function type and chain to the other getOrInsertFunction...
158 return getOrInsertFunction(Name,
159 FunctionType::get(RetTy, ArgTys, false),
163 // getFunction - Look up the specified function in the module symbol table.
164 // If it does not exist, return null.
166 Function *Module::getFunction(StringRef Name) const {
167 return dyn_cast_or_null<Function>(getNamedValue(Name));
170 //===----------------------------------------------------------------------===//
171 // Methods for easy access to the global variables in the module.
174 /// getGlobalVariable - Look up the specified global variable in the module
175 /// symbol table. If it does not exist, return null. The type argument
176 /// should be the underlying type of the global, i.e., it should not have
177 /// the top-level PointerType, which represents the address of the global.
178 /// If AllowLocal is set to true, this function will return types that
179 /// have an local. By default, these types are not returned.
181 GlobalVariable *Module::getGlobalVariable(StringRef Name, bool AllowLocal) {
182 if (GlobalVariable *Result =
183 dyn_cast_or_null<GlobalVariable>(getNamedValue(Name)))
184 if (AllowLocal || !Result->hasLocalLinkage())
189 /// getOrInsertGlobal - Look up the specified global in the module symbol table.
190 /// 1. If it does not exist, add a declaration of the global and return it.
191 /// 2. Else, the global exists but has the wrong type: return the function
192 /// with a constantexpr cast to the right type.
193 /// 3. Finally, if the existing global is the correct declaration, return the
195 Constant *Module::getOrInsertGlobal(StringRef Name, Type *Ty) {
196 // See if we have a definition for the specified global already.
197 GlobalVariable *GV = dyn_cast_or_null<GlobalVariable>(getNamedValue(Name));
200 GlobalVariable *New =
201 new GlobalVariable(*this, Ty, false, GlobalVariable::ExternalLinkage,
203 return New; // Return the new declaration.
206 // If the variable exists but has the wrong type, return a bitcast to the
208 Type *GVTy = GV->getType();
209 PointerType *PTy = PointerType::get(Ty, GVTy->getPointerAddressSpace());
211 return ConstantExpr::getBitCast(GV, PTy);
213 // Otherwise, we just found the existing function or a prototype.
217 //===----------------------------------------------------------------------===//
218 // Methods for easy access to the global variables in the module.
221 // getNamedAlias - Look up the specified global in the module symbol table.
222 // If it does not exist, return null.
224 GlobalAlias *Module::getNamedAlias(StringRef Name) const {
225 return dyn_cast_or_null<GlobalAlias>(getNamedValue(Name));
228 /// getNamedMetadata - Return the first NamedMDNode in the module with the
229 /// specified name. This method returns null if a NamedMDNode with the
230 /// specified name is not found.
231 NamedMDNode *Module::getNamedMetadata(const Twine &Name) const {
232 SmallString<256> NameData;
233 StringRef NameRef = Name.toStringRef(NameData);
234 return static_cast<StringMap<NamedMDNode*> *>(NamedMDSymTab)->lookup(NameRef);
237 /// getOrInsertNamedMetadata - Return the first named MDNode in the module
238 /// with the specified name. This method returns a new NamedMDNode if a
239 /// NamedMDNode with the specified name is not found.
240 NamedMDNode *Module::getOrInsertNamedMetadata(StringRef Name) {
242 (*static_cast<StringMap<NamedMDNode *> *>(NamedMDSymTab))[Name];
244 NMD = new NamedMDNode(Name);
245 NMD->setParent(this);
246 NamedMDList.push_back(NMD);
251 /// eraseNamedMetadata - Remove the given NamedMDNode from this module and
253 void Module::eraseNamedMetadata(NamedMDNode *NMD) {
254 static_cast<StringMap<NamedMDNode *> *>(NamedMDSymTab)->erase(NMD->getName());
255 NamedMDList.erase(NMD);
258 /// getModuleFlagsMetadata - Returns the module flags in the provided vector.
260 getModuleFlagsMetadata(SmallVectorImpl<ModuleFlagEntry> &Flags) const {
261 const NamedMDNode *ModFlags = getModuleFlagsMetadata();
262 if (!ModFlags) return;
264 for (const MDNode *Flag : ModFlags->operands()) {
265 if (Flag->getNumOperands() >= 3 && isa<ConstantInt>(Flag->getOperand(0)) &&
266 isa<MDString>(Flag->getOperand(1))) {
267 // Check the operands of the MDNode before accessing the operands.
268 // The verifier will actually catch these failures.
269 ConstantInt *Behavior = cast<ConstantInt>(Flag->getOperand(0));
270 MDString *Key = cast<MDString>(Flag->getOperand(1));
271 Value *Val = Flag->getOperand(2);
272 Flags.push_back(ModuleFlagEntry(ModFlagBehavior(Behavior->getZExtValue()),
278 /// Return the corresponding value if Key appears in module flags, otherwise
280 Value *Module::getModuleFlag(StringRef Key) const {
281 SmallVector<Module::ModuleFlagEntry, 8> ModuleFlags;
282 getModuleFlagsMetadata(ModuleFlags);
283 for (const ModuleFlagEntry &MFE : ModuleFlags) {
284 if (Key == MFE.Key->getString())
290 /// getModuleFlagsMetadata - Returns the NamedMDNode in the module that
291 /// represents module-level flags. This method returns null if there are no
292 /// module-level flags.
293 NamedMDNode *Module::getModuleFlagsMetadata() const {
294 return getNamedMetadata("llvm.module.flags");
297 /// getOrInsertModuleFlagsMetadata - Returns the NamedMDNode in the module that
298 /// represents module-level flags. If module-level flags aren't found, it
299 /// creates the named metadata that contains them.
300 NamedMDNode *Module::getOrInsertModuleFlagsMetadata() {
301 return getOrInsertNamedMetadata("llvm.module.flags");
304 /// addModuleFlag - Add a module-level flag to the module-level flags
305 /// metadata. It will create the module-level flags named metadata if it doesn't
307 void Module::addModuleFlag(ModFlagBehavior Behavior, StringRef Key,
309 Type *Int32Ty = Type::getInt32Ty(Context);
311 ConstantInt::get(Int32Ty, Behavior), MDString::get(Context, Key), Val
313 getOrInsertModuleFlagsMetadata()->addOperand(MDNode::get(Context, Ops));
315 void Module::addModuleFlag(ModFlagBehavior Behavior, StringRef Key,
317 Type *Int32Ty = Type::getInt32Ty(Context);
318 addModuleFlag(Behavior, Key, ConstantInt::get(Int32Ty, Val));
320 void Module::addModuleFlag(MDNode *Node) {
321 assert(Node->getNumOperands() == 3 &&
322 "Invalid number of operands for module flag!");
323 assert(isa<ConstantInt>(Node->getOperand(0)) &&
324 isa<MDString>(Node->getOperand(1)) &&
325 "Invalid operand types for module flag!");
326 getOrInsertModuleFlagsMetadata()->addOperand(Node);
329 void Module::setDataLayout(StringRef Desc) {
335 DataLayoutStr = DL.getStringRepresentation();
336 // DataLayoutStr is now equivalent to Desc, but since the representation
337 // is not unique, they may not be identical.
341 void Module::setDataLayout(const DataLayout *Other) {
347 DataLayoutStr = DL.getStringRepresentation();
351 const DataLayout *Module::getDataLayout() const {
352 if (DataLayoutStr.empty())
357 //===----------------------------------------------------------------------===//
358 // Methods to control the materialization of GlobalValues in the Module.
360 void Module::setMaterializer(GVMaterializer *GVM) {
361 assert(!Materializer &&
362 "Module already has a GVMaterializer. Call MaterializeAllPermanently"
363 " to clear it out before setting another one.");
364 Materializer.reset(GVM);
367 bool Module::isMaterializable(const GlobalValue *GV) const {
369 return Materializer->isMaterializable(GV);
373 bool Module::isDematerializable(const GlobalValue *GV) const {
375 return Materializer->isDematerializable(GV);
379 bool Module::Materialize(GlobalValue *GV, std::string *ErrInfo) {
383 error_code EC = Materializer->Materialize(GV);
387 *ErrInfo = EC.message();
391 void Module::Dematerialize(GlobalValue *GV) {
393 return Materializer->Dematerialize(GV);
396 error_code Module::materializeAll() {
398 return error_code::success();
399 return Materializer->MaterializeModule(this);
402 error_code Module::materializeAllPermanently() {
403 if (error_code EC = materializeAll())
406 Materializer.reset();
407 return error_code::success();
410 //===----------------------------------------------------------------------===//
411 // Other module related stuff.
415 // dropAllReferences() - This function causes all the subelements to "let go"
416 // of all references that they are maintaining. This allows one to 'delete' a
417 // whole module at a time, even though there may be circular references... first
418 // all references are dropped, and all use counts go to zero. Then everything
419 // is deleted for real. Note that no operations are valid on an object that
420 // has "dropped all references", except operator delete.
422 void Module::dropAllReferences() {
423 for(Module::iterator I = begin(), E = end(); I != E; ++I)
424 I->dropAllReferences();
426 for(Module::global_iterator I = global_begin(), E = global_end(); I != E; ++I)
427 I->dropAllReferences();
429 for(Module::alias_iterator I = alias_begin(), E = alias_end(); I != E; ++I)
430 I->dropAllReferences();