1 //===-- MCJIT.cpp - MC-based Just-in-Time Compiler ------------------------===//
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 //===----------------------------------------------------------------------===//
11 #include "llvm/ADT/STLExtras.h"
12 #include "llvm/ExecutionEngine/GenericValue.h"
13 #include "llvm/ExecutionEngine/JITEventListener.h"
14 #include "llvm/ExecutionEngine/MCJIT.h"
15 #include "llvm/ExecutionEngine/SectionMemoryManager.h"
16 #include "llvm/IR/DataLayout.h"
17 #include "llvm/IR/DerivedTypes.h"
18 #include "llvm/IR/Function.h"
19 #include "llvm/IR/LegacyPassManager.h"
20 #include "llvm/IR/Mangler.h"
21 #include "llvm/IR/Module.h"
22 #include "llvm/MC/MCAsmInfo.h"
23 #include "llvm/Object/Archive.h"
24 #include "llvm/Object/ObjectFile.h"
25 #include "llvm/Support/DynamicLibrary.h"
26 #include "llvm/Support/ErrorHandling.h"
27 #include "llvm/Support/MemoryBuffer.h"
28 #include "llvm/Support/MutexGuard.h"
32 void ObjectCache::anchor() {}
36 static struct RegisterJIT {
37 RegisterJIT() { MCJIT::Register(); }
42 extern "C" void LLVMLinkInMCJIT() {
46 MCJIT::createJIT(std::unique_ptr<Module> M,
47 std::string *ErrorStr,
48 std::shared_ptr<MCJITMemoryManager> MemMgr,
49 std::shared_ptr<RuntimeDyld::SymbolResolver> Resolver,
50 std::unique_ptr<TargetMachine> TM) {
51 // Try to register the program as a source of symbols to resolve against.
53 // FIXME: Don't do this here.
54 sys::DynamicLibrary::LoadLibraryPermanently(nullptr, nullptr);
56 if (!MemMgr || !Resolver) {
57 auto RTDyldMM = std::make_shared<SectionMemoryManager>();
64 return new MCJIT(std::move(M), std::move(TM), std::move(MemMgr),
68 MCJIT::MCJIT(std::unique_ptr<Module> M, std::unique_ptr<TargetMachine> tm,
69 std::shared_ptr<MCJITMemoryManager> MemMgr,
70 std::shared_ptr<RuntimeDyld::SymbolResolver> Resolver)
71 : ExecutionEngine(std::move(M)), TM(std::move(tm)), Ctx(nullptr),
72 MemMgr(std::move(MemMgr)), Resolver(*this, std::move(Resolver)),
73 Dyld(*this->MemMgr, this->Resolver), ObjCache(nullptr) {
74 // FIXME: We are managing our modules, so we do not want the base class
75 // ExecutionEngine to manage them as well. To avoid double destruction
76 // of the first (and only) module added in ExecutionEngine constructor
77 // we remove it from EE and will destruct it ourselves.
79 // It may make sense to move our module manager (based on SmallStPtr) back
80 // into EE if the JIT and Interpreter can live with it.
81 // If so, additional functions: addModule, removeModule, FindFunctionNamed,
82 // runStaticConstructorsDestructors could be moved back to EE as well.
84 std::unique_ptr<Module> First = std::move(Modules[0]);
87 OwnedModules.addModule(std::move(First));
88 setDataLayout(TM->getDataLayout());
89 RegisterJITEventListener(JITEventListener::createGDBRegistrationListener());
93 MutexGuard locked(lock);
95 Dyld.deregisterEHFrames();
97 for (auto &Obj : LoadedObjects)
99 NotifyFreeingObject(*Obj);
104 void MCJIT::addModule(std::unique_ptr<Module> M) {
105 MutexGuard locked(lock);
106 OwnedModules.addModule(std::move(M));
109 bool MCJIT::removeModule(Module *M) {
110 MutexGuard locked(lock);
111 return OwnedModules.removeModule(M);
114 void MCJIT::addObjectFile(std::unique_ptr<object::ObjectFile> Obj) {
115 std::unique_ptr<RuntimeDyld::LoadedObjectInfo> L = Dyld.loadObject(*Obj);
117 report_fatal_error(Dyld.getErrorString());
119 NotifyObjectEmitted(*Obj, *L);
121 LoadedObjects.push_back(std::move(Obj));
124 void MCJIT::addObjectFile(object::OwningBinary<object::ObjectFile> Obj) {
125 std::unique_ptr<object::ObjectFile> ObjFile;
126 std::unique_ptr<MemoryBuffer> MemBuf;
127 std::tie(ObjFile, MemBuf) = Obj.takeBinary();
128 addObjectFile(std::move(ObjFile));
129 Buffers.push_back(std::move(MemBuf));
132 void MCJIT::addArchive(object::OwningBinary<object::Archive> A) {
133 Archives.push_back(std::move(A));
136 void MCJIT::setObjectCache(ObjectCache* NewCache) {
137 MutexGuard locked(lock);
141 std::unique_ptr<MemoryBuffer> MCJIT::emitObject(Module *M) {
142 MutexGuard locked(lock);
144 // This must be a module which has already been added but not loaded to this
145 // MCJIT instance, since these conditions are tested by our caller,
146 // generateCodeForModule.
148 legacy::PassManager PM;
150 M->setDataLayout(*TM->getDataLayout());
152 // The RuntimeDyld will take ownership of this shortly
153 SmallVector<char, 4096> ObjBufferSV;
154 raw_svector_ostream ObjStream(ObjBufferSV);
156 // Turn the machine code intermediate representation into bytes in memory
157 // that may be executed.
158 if (TM->addPassesToEmitMC(PM, Ctx, ObjStream, !getVerifyModules()))
159 report_fatal_error("Target does not support MC emission!");
161 // Initialize passes.
163 // Flush the output buffer to get the generated code into memory
166 std::unique_ptr<MemoryBuffer> CompiledObjBuffer(
167 new ObjectMemoryBuffer(std::move(ObjBufferSV)));
169 // If we have an object cache, tell it about the new object.
170 // Note that we're using the compiled image, not the loaded image (as below).
172 // MemoryBuffer is a thin wrapper around the actual memory, so it's OK
173 // to create a temporary object here and delete it after the call.
174 MemoryBufferRef MB = CompiledObjBuffer->getMemBufferRef();
175 ObjCache->notifyObjectCompiled(M, MB);
178 return CompiledObjBuffer;
181 void MCJIT::generateCodeForModule(Module *M) {
182 // Get a thread lock to make sure we aren't trying to load multiple times
183 MutexGuard locked(lock);
185 // This must be a module which has already been added to this MCJIT instance.
186 assert(OwnedModules.ownsModule(M) &&
187 "MCJIT::generateCodeForModule: Unknown module.");
189 // Re-compilation is not supported
190 if (OwnedModules.hasModuleBeenLoaded(M))
193 std::unique_ptr<MemoryBuffer> ObjectToLoad;
194 // Try to load the pre-compiled object from cache if possible
196 ObjectToLoad = ObjCache->getObject(M);
198 // If the cache did not contain a suitable object, compile the object
200 ObjectToLoad = emitObject(M);
201 assert(ObjectToLoad && "Compilation did not produce an object.");
204 // Load the object into the dynamic linker.
205 // MCJIT now owns the ObjectImage pointer (via its LoadedObjects list).
206 ErrorOr<std::unique_ptr<object::ObjectFile>> LoadedObject =
207 object::ObjectFile::createObjectFile(ObjectToLoad->getMemBufferRef());
208 std::unique_ptr<RuntimeDyld::LoadedObjectInfo> L =
209 Dyld.loadObject(*LoadedObject.get());
212 report_fatal_error(Dyld.getErrorString());
214 NotifyObjectEmitted(*LoadedObject.get(), *L);
216 Buffers.push_back(std::move(ObjectToLoad));
217 LoadedObjects.push_back(std::move(*LoadedObject));
219 OwnedModules.markModuleAsLoaded(M);
222 void MCJIT::finalizeLoadedModules() {
223 MutexGuard locked(lock);
225 // Resolve any outstanding relocations.
226 Dyld.resolveRelocations();
228 OwnedModules.markAllLoadedModulesAsFinalized();
230 // Register EH frame data for any module we own which has been loaded
231 Dyld.registerEHFrames();
233 // Set page permissions.
234 MemMgr->finalizeMemory();
237 // FIXME: Rename this.
238 void MCJIT::finalizeObject() {
239 MutexGuard locked(lock);
241 // Generate code for module is going to move objects out of the 'added' list,
242 // so we need to copy that out before using it:
243 SmallVector<Module*, 16> ModsToAdd;
244 for (auto M : OwnedModules.added())
245 ModsToAdd.push_back(M);
247 for (auto M : ModsToAdd)
248 generateCodeForModule(M);
250 finalizeLoadedModules();
253 void MCJIT::finalizeModule(Module *M) {
254 MutexGuard locked(lock);
256 // This must be a module which has already been added to this MCJIT instance.
257 assert(OwnedModules.ownsModule(M) && "MCJIT::finalizeModule: Unknown module.");
259 // If the module hasn't been compiled, just do that.
260 if (!OwnedModules.hasModuleBeenLoaded(M))
261 generateCodeForModule(M);
263 finalizeLoadedModules();
266 RuntimeDyld::SymbolInfo MCJIT::findExistingSymbol(const std::string &Name) {
267 Mangler Mang(TM->getDataLayout());
268 SmallString<128> FullName;
269 Mang.getNameWithPrefix(FullName, Name);
270 return Dyld.getSymbol(FullName);
273 Module *MCJIT::findModuleForSymbol(const std::string &Name,
274 bool CheckFunctionsOnly) {
275 MutexGuard locked(lock);
277 // If it hasn't already been generated, see if it's in one of our modules.
278 for (ModulePtrSet::iterator I = OwnedModules.begin_added(),
279 E = OwnedModules.end_added();
282 Function *F = M->getFunction(Name);
283 if (F && !F->isDeclaration())
285 if (!CheckFunctionsOnly) {
286 GlobalVariable *G = M->getGlobalVariable(Name);
287 if (G && !G->isDeclaration())
289 // FIXME: Do we need to worry about global aliases?
292 // We didn't find the symbol in any of our modules.
296 uint64_t MCJIT::getSymbolAddress(const std::string &Name,
297 bool CheckFunctionsOnly) {
298 return findSymbol(Name, CheckFunctionsOnly).getAddress();
301 RuntimeDyld::SymbolInfo MCJIT::findSymbol(const std::string &Name,
302 bool CheckFunctionsOnly) {
303 MutexGuard locked(lock);
305 // First, check to see if we already have this symbol.
306 if (auto Sym = findExistingSymbol(Name))
309 for (object::OwningBinary<object::Archive> &OB : Archives) {
310 object::Archive *A = OB.getBinary();
311 // Look for our symbols in each Archive
312 object::Archive::child_iterator ChildIt = A->findSym(Name);
313 if (ChildIt != A->child_end()) {
314 // FIXME: Support nested archives?
315 ErrorOr<std::unique_ptr<object::Binary>> ChildBinOrErr =
316 ChildIt->getAsBinary();
317 if (ChildBinOrErr.getError())
319 std::unique_ptr<object::Binary> &ChildBin = ChildBinOrErr.get();
320 if (ChildBin->isObject()) {
321 std::unique_ptr<object::ObjectFile> OF(
322 static_cast<object::ObjectFile *>(ChildBin.release()));
323 // This causes the object file to be loaded.
324 addObjectFile(std::move(OF));
325 // The address should be here now.
326 if (auto Sym = findExistingSymbol(Name))
332 // If it hasn't already been generated, see if it's in one of our modules.
333 Module *M = findModuleForSymbol(Name, CheckFunctionsOnly);
335 generateCodeForModule(M);
337 // Check the RuntimeDyld table again, it should be there now.
338 return findExistingSymbol(Name);
341 // If a LazyFunctionCreator is installed, use it to get/create the function.
342 // FIXME: Should we instead have a LazySymbolCreator callback?
343 if (LazyFunctionCreator) {
344 auto Addr = static_cast<uint64_t>(
345 reinterpret_cast<uintptr_t>(LazyFunctionCreator(Name)));
346 return RuntimeDyld::SymbolInfo(Addr, JITSymbolFlags::Exported);
352 uint64_t MCJIT::getGlobalValueAddress(const std::string &Name) {
353 MutexGuard locked(lock);
354 uint64_t Result = getSymbolAddress(Name, false);
356 finalizeLoadedModules();
360 uint64_t MCJIT::getFunctionAddress(const std::string &Name) {
361 MutexGuard locked(lock);
362 uint64_t Result = getSymbolAddress(Name, true);
364 finalizeLoadedModules();
368 // Deprecated. Use getFunctionAddress instead.
369 void *MCJIT::getPointerToFunction(Function *F) {
370 MutexGuard locked(lock);
372 Mangler Mang(TM->getDataLayout());
373 SmallString<128> Name;
374 TM->getNameWithPrefix(Name, F, Mang);
376 if (F->isDeclaration() || F->hasAvailableExternallyLinkage()) {
377 bool AbortOnFailure = !F->hasExternalWeakLinkage();
378 void *Addr = getPointerToNamedFunction(Name, AbortOnFailure);
379 updateGlobalMapping(F, Addr);
383 Module *M = F->getParent();
384 bool HasBeenAddedButNotLoaded = OwnedModules.hasModuleBeenAddedButNotLoaded(M);
386 // Make sure the relevant module has been compiled and loaded.
387 if (HasBeenAddedButNotLoaded)
388 generateCodeForModule(M);
389 else if (!OwnedModules.hasModuleBeenLoaded(M)) {
390 // If this function doesn't belong to one of our modules, we're done.
391 // FIXME: Asking for the pointer to a function that hasn't been registered,
392 // and isn't a declaration (which is handled above) should probably
397 // FIXME: Should the Dyld be retaining module information? Probably not.
399 // This is the accessor for the target address, so make sure to check the
400 // load address of the symbol, not the local address.
401 return (void*)Dyld.getSymbol(Name).getAddress();
404 void MCJIT::runStaticConstructorsDestructorsInModulePtrSet(
405 bool isDtors, ModulePtrSet::iterator I, ModulePtrSet::iterator E) {
406 for (; I != E; ++I) {
407 ExecutionEngine::runStaticConstructorsDestructors(**I, isDtors);
411 void MCJIT::runStaticConstructorsDestructors(bool isDtors) {
412 // Execute global ctors/dtors for each module in the program.
413 runStaticConstructorsDestructorsInModulePtrSet(
414 isDtors, OwnedModules.begin_added(), OwnedModules.end_added());
415 runStaticConstructorsDestructorsInModulePtrSet(
416 isDtors, OwnedModules.begin_loaded(), OwnedModules.end_loaded());
417 runStaticConstructorsDestructorsInModulePtrSet(
418 isDtors, OwnedModules.begin_finalized(), OwnedModules.end_finalized());
421 Function *MCJIT::FindFunctionNamedInModulePtrSet(const char *FnName,
422 ModulePtrSet::iterator I,
423 ModulePtrSet::iterator E) {
424 for (; I != E; ++I) {
425 Function *F = (*I)->getFunction(FnName);
426 if (F && !F->isDeclaration())
432 Function *MCJIT::FindFunctionNamed(const char *FnName) {
433 Function *F = FindFunctionNamedInModulePtrSet(
434 FnName, OwnedModules.begin_added(), OwnedModules.end_added());
436 F = FindFunctionNamedInModulePtrSet(FnName, OwnedModules.begin_loaded(),
437 OwnedModules.end_loaded());
439 F = FindFunctionNamedInModulePtrSet(FnName, OwnedModules.begin_finalized(),
440 OwnedModules.end_finalized());
444 GenericValue MCJIT::runFunction(Function *F, ArrayRef<GenericValue> ArgValues) {
445 assert(F && "Function *F was null at entry to run()");
447 void *FPtr = getPointerToFunction(F);
448 assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
449 FunctionType *FTy = F->getFunctionType();
450 Type *RetTy = FTy->getReturnType();
452 assert((FTy->getNumParams() == ArgValues.size() ||
453 (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
454 "Wrong number of arguments passed into function!");
455 assert(FTy->getNumParams() == ArgValues.size() &&
456 "This doesn't support passing arguments through varargs (yet)!");
458 // Handle some common cases first. These cases correspond to common `main'
460 if (RetTy->isIntegerTy(32) || RetTy->isVoidTy()) {
461 switch (ArgValues.size()) {
463 if (FTy->getParamType(0)->isIntegerTy(32) &&
464 FTy->getParamType(1)->isPointerTy() &&
465 FTy->getParamType(2)->isPointerTy()) {
466 int (*PF)(int, char **, const char **) =
467 (int(*)(int, char **, const char **))(intptr_t)FPtr;
469 // Call the function.
471 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
472 (char **)GVTOP(ArgValues[1]),
473 (const char **)GVTOP(ArgValues[2])));
478 if (FTy->getParamType(0)->isIntegerTy(32) &&
479 FTy->getParamType(1)->isPointerTy()) {
480 int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
482 // Call the function.
484 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
485 (char **)GVTOP(ArgValues[1])));
490 if (FTy->getNumParams() == 1 &&
491 FTy->getParamType(0)->isIntegerTy(32)) {
493 int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
494 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
501 // Handle cases where no arguments are passed first.
502 if (ArgValues.empty()) {
504 switch (RetTy->getTypeID()) {
505 default: llvm_unreachable("Unknown return type for function call!");
506 case Type::IntegerTyID: {
507 unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
509 rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
510 else if (BitWidth <= 8)
511 rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
512 else if (BitWidth <= 16)
513 rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
514 else if (BitWidth <= 32)
515 rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
516 else if (BitWidth <= 64)
517 rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
519 llvm_unreachable("Integer types > 64 bits not supported");
523 rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
525 case Type::FloatTyID:
526 rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
528 case Type::DoubleTyID:
529 rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
531 case Type::X86_FP80TyID:
532 case Type::FP128TyID:
533 case Type::PPC_FP128TyID:
534 llvm_unreachable("long double not supported yet");
535 case Type::PointerTyID:
536 return PTOGV(((void*(*)())(intptr_t)FPtr)());
540 llvm_unreachable("Full-featured argument passing not supported yet!");
543 void *MCJIT::getPointerToNamedFunction(StringRef Name, bool AbortOnFailure) {
544 if (!isSymbolSearchingDisabled()) {
546 reinterpret_cast<void*>(
547 static_cast<uintptr_t>(Resolver.findSymbol(Name).getAddress()));
552 /// If a LazyFunctionCreator is installed, use it to get/create the function.
553 if (LazyFunctionCreator)
554 if (void *RP = LazyFunctionCreator(Name))
557 if (AbortOnFailure) {
558 report_fatal_error("Program used external function '"+Name+
559 "' which could not be resolved!");
564 void MCJIT::RegisterJITEventListener(JITEventListener *L) {
567 MutexGuard locked(lock);
568 EventListeners.push_back(L);
571 void MCJIT::UnregisterJITEventListener(JITEventListener *L) {
574 MutexGuard locked(lock);
575 auto I = std::find(EventListeners.rbegin(), EventListeners.rend(), L);
576 if (I != EventListeners.rend()) {
577 std::swap(*I, EventListeners.back());
578 EventListeners.pop_back();
582 void MCJIT::NotifyObjectEmitted(const object::ObjectFile& Obj,
583 const RuntimeDyld::LoadedObjectInfo &L) {
584 MutexGuard locked(lock);
585 MemMgr->notifyObjectLoaded(this, Obj);
586 for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
587 EventListeners[I]->NotifyObjectEmitted(Obj, L);
591 void MCJIT::NotifyFreeingObject(const object::ObjectFile& Obj) {
592 MutexGuard locked(lock);
593 for (JITEventListener *L : EventListeners)
594 L->NotifyFreeingObject(Obj);
597 RuntimeDyld::SymbolInfo
598 LinkingSymbolResolver::findSymbol(const std::string &Name) {
599 auto Result = ParentEngine.findSymbol(Name, false);
600 // If the symbols wasn't found and it begins with an underscore, try again
601 // without the underscore.
602 if (!Result && Name[0] == '_')
603 Result = ParentEngine.findSymbol(Name.substr(1), false);
606 if (ParentEngine.isSymbolSearchingDisabled())
608 return ClientResolver->findSymbol(Name);