10b57cec5SDimitry Andric //===-- MCJIT.cpp - MC-based Just-in-Time Compiler ------------------------===// 20b57cec5SDimitry Andric // 30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information. 50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 60b57cec5SDimitry Andric // 70b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 80b57cec5SDimitry Andric 90b57cec5SDimitry Andric #include "MCJIT.h" 100b57cec5SDimitry Andric #include "llvm/ADT/STLExtras.h" 110b57cec5SDimitry Andric #include "llvm/ExecutionEngine/GenericValue.h" 120b57cec5SDimitry Andric #include "llvm/ExecutionEngine/JITEventListener.h" 130b57cec5SDimitry Andric #include "llvm/ExecutionEngine/MCJIT.h" 140b57cec5SDimitry Andric #include "llvm/ExecutionEngine/SectionMemoryManager.h" 150b57cec5SDimitry Andric #include "llvm/IR/DataLayout.h" 160b57cec5SDimitry Andric #include "llvm/IR/DerivedTypes.h" 170b57cec5SDimitry Andric #include "llvm/IR/Function.h" 180b57cec5SDimitry Andric #include "llvm/IR/LegacyPassManager.h" 190b57cec5SDimitry Andric #include "llvm/IR/Mangler.h" 200b57cec5SDimitry Andric #include "llvm/IR/Module.h" 210b57cec5SDimitry Andric #include "llvm/Object/Archive.h" 220b57cec5SDimitry Andric #include "llvm/Object/ObjectFile.h" 230b57cec5SDimitry Andric #include "llvm/Support/DynamicLibrary.h" 240b57cec5SDimitry Andric #include "llvm/Support/ErrorHandling.h" 250b57cec5SDimitry Andric #include "llvm/Support/MemoryBuffer.h" 26*8bcb0991SDimitry Andric #include <mutex> 270b57cec5SDimitry Andric 280b57cec5SDimitry Andric using namespace llvm; 290b57cec5SDimitry Andric 300b57cec5SDimitry Andric namespace { 310b57cec5SDimitry Andric 320b57cec5SDimitry Andric static struct RegisterJIT { 330b57cec5SDimitry Andric RegisterJIT() { MCJIT::Register(); } 340b57cec5SDimitry Andric } JITRegistrator; 350b57cec5SDimitry Andric 360b57cec5SDimitry Andric } 370b57cec5SDimitry Andric 380b57cec5SDimitry Andric extern "C" void LLVMLinkInMCJIT() { 390b57cec5SDimitry Andric } 400b57cec5SDimitry Andric 410b57cec5SDimitry Andric ExecutionEngine * 420b57cec5SDimitry Andric MCJIT::createJIT(std::unique_ptr<Module> M, std::string *ErrorStr, 430b57cec5SDimitry Andric std::shared_ptr<MCJITMemoryManager> MemMgr, 440b57cec5SDimitry Andric std::shared_ptr<LegacyJITSymbolResolver> Resolver, 450b57cec5SDimitry Andric std::unique_ptr<TargetMachine> TM) { 460b57cec5SDimitry Andric // Try to register the program as a source of symbols to resolve against. 470b57cec5SDimitry Andric // 480b57cec5SDimitry Andric // FIXME: Don't do this here. 490b57cec5SDimitry Andric sys::DynamicLibrary::LoadLibraryPermanently(nullptr, nullptr); 500b57cec5SDimitry Andric 510b57cec5SDimitry Andric if (!MemMgr || !Resolver) { 520b57cec5SDimitry Andric auto RTDyldMM = std::make_shared<SectionMemoryManager>(); 530b57cec5SDimitry Andric if (!MemMgr) 540b57cec5SDimitry Andric MemMgr = RTDyldMM; 550b57cec5SDimitry Andric if (!Resolver) 560b57cec5SDimitry Andric Resolver = RTDyldMM; 570b57cec5SDimitry Andric } 580b57cec5SDimitry Andric 590b57cec5SDimitry Andric return new MCJIT(std::move(M), std::move(TM), std::move(MemMgr), 600b57cec5SDimitry Andric std::move(Resolver)); 610b57cec5SDimitry Andric } 620b57cec5SDimitry Andric 630b57cec5SDimitry Andric MCJIT::MCJIT(std::unique_ptr<Module> M, std::unique_ptr<TargetMachine> TM, 640b57cec5SDimitry Andric std::shared_ptr<MCJITMemoryManager> MemMgr, 650b57cec5SDimitry Andric std::shared_ptr<LegacyJITSymbolResolver> Resolver) 660b57cec5SDimitry Andric : ExecutionEngine(TM->createDataLayout(), std::move(M)), TM(std::move(TM)), 670b57cec5SDimitry Andric Ctx(nullptr), MemMgr(std::move(MemMgr)), 680b57cec5SDimitry Andric Resolver(*this, std::move(Resolver)), Dyld(*this->MemMgr, this->Resolver), 690b57cec5SDimitry Andric ObjCache(nullptr) { 700b57cec5SDimitry Andric // FIXME: We are managing our modules, so we do not want the base class 710b57cec5SDimitry Andric // ExecutionEngine to manage them as well. To avoid double destruction 720b57cec5SDimitry Andric // of the first (and only) module added in ExecutionEngine constructor 730b57cec5SDimitry Andric // we remove it from EE and will destruct it ourselves. 740b57cec5SDimitry Andric // 750b57cec5SDimitry Andric // It may make sense to move our module manager (based on SmallStPtr) back 760b57cec5SDimitry Andric // into EE if the JIT and Interpreter can live with it. 770b57cec5SDimitry Andric // If so, additional functions: addModule, removeModule, FindFunctionNamed, 780b57cec5SDimitry Andric // runStaticConstructorsDestructors could be moved back to EE as well. 790b57cec5SDimitry Andric // 800b57cec5SDimitry Andric std::unique_ptr<Module> First = std::move(Modules[0]); 810b57cec5SDimitry Andric Modules.clear(); 820b57cec5SDimitry Andric 830b57cec5SDimitry Andric if (First->getDataLayout().isDefault()) 840b57cec5SDimitry Andric First->setDataLayout(getDataLayout()); 850b57cec5SDimitry Andric 860b57cec5SDimitry Andric OwnedModules.addModule(std::move(First)); 870b57cec5SDimitry Andric RegisterJITEventListener(JITEventListener::createGDBRegistrationListener()); 880b57cec5SDimitry Andric } 890b57cec5SDimitry Andric 900b57cec5SDimitry Andric MCJIT::~MCJIT() { 91*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 920b57cec5SDimitry Andric 930b57cec5SDimitry Andric Dyld.deregisterEHFrames(); 940b57cec5SDimitry Andric 950b57cec5SDimitry Andric for (auto &Obj : LoadedObjects) 960b57cec5SDimitry Andric if (Obj) 970b57cec5SDimitry Andric notifyFreeingObject(*Obj); 980b57cec5SDimitry Andric 990b57cec5SDimitry Andric Archives.clear(); 1000b57cec5SDimitry Andric } 1010b57cec5SDimitry Andric 1020b57cec5SDimitry Andric void MCJIT::addModule(std::unique_ptr<Module> M) { 103*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 1040b57cec5SDimitry Andric 1050b57cec5SDimitry Andric if (M->getDataLayout().isDefault()) 1060b57cec5SDimitry Andric M->setDataLayout(getDataLayout()); 1070b57cec5SDimitry Andric 1080b57cec5SDimitry Andric OwnedModules.addModule(std::move(M)); 1090b57cec5SDimitry Andric } 1100b57cec5SDimitry Andric 1110b57cec5SDimitry Andric bool MCJIT::removeModule(Module *M) { 112*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 1130b57cec5SDimitry Andric return OwnedModules.removeModule(M); 1140b57cec5SDimitry Andric } 1150b57cec5SDimitry Andric 1160b57cec5SDimitry Andric void MCJIT::addObjectFile(std::unique_ptr<object::ObjectFile> Obj) { 1170b57cec5SDimitry Andric std::unique_ptr<RuntimeDyld::LoadedObjectInfo> L = Dyld.loadObject(*Obj); 1180b57cec5SDimitry Andric if (Dyld.hasError()) 1190b57cec5SDimitry Andric report_fatal_error(Dyld.getErrorString()); 1200b57cec5SDimitry Andric 1210b57cec5SDimitry Andric notifyObjectLoaded(*Obj, *L); 1220b57cec5SDimitry Andric 1230b57cec5SDimitry Andric LoadedObjects.push_back(std::move(Obj)); 1240b57cec5SDimitry Andric } 1250b57cec5SDimitry Andric 1260b57cec5SDimitry Andric void MCJIT::addObjectFile(object::OwningBinary<object::ObjectFile> Obj) { 1270b57cec5SDimitry Andric std::unique_ptr<object::ObjectFile> ObjFile; 1280b57cec5SDimitry Andric std::unique_ptr<MemoryBuffer> MemBuf; 1290b57cec5SDimitry Andric std::tie(ObjFile, MemBuf) = Obj.takeBinary(); 1300b57cec5SDimitry Andric addObjectFile(std::move(ObjFile)); 1310b57cec5SDimitry Andric Buffers.push_back(std::move(MemBuf)); 1320b57cec5SDimitry Andric } 1330b57cec5SDimitry Andric 1340b57cec5SDimitry Andric void MCJIT::addArchive(object::OwningBinary<object::Archive> A) { 1350b57cec5SDimitry Andric Archives.push_back(std::move(A)); 1360b57cec5SDimitry Andric } 1370b57cec5SDimitry Andric 1380b57cec5SDimitry Andric void MCJIT::setObjectCache(ObjectCache* NewCache) { 139*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 1400b57cec5SDimitry Andric ObjCache = NewCache; 1410b57cec5SDimitry Andric } 1420b57cec5SDimitry Andric 1430b57cec5SDimitry Andric std::unique_ptr<MemoryBuffer> MCJIT::emitObject(Module *M) { 1440b57cec5SDimitry Andric assert(M && "Can not emit a null module"); 1450b57cec5SDimitry Andric 146*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 1470b57cec5SDimitry Andric 1480b57cec5SDimitry Andric // Materialize all globals in the module if they have not been 1490b57cec5SDimitry Andric // materialized already. 1500b57cec5SDimitry Andric cantFail(M->materializeAll()); 1510b57cec5SDimitry Andric 1520b57cec5SDimitry Andric // This must be a module which has already been added but not loaded to this 1530b57cec5SDimitry Andric // MCJIT instance, since these conditions are tested by our caller, 1540b57cec5SDimitry Andric // generateCodeForModule. 1550b57cec5SDimitry Andric 1560b57cec5SDimitry Andric legacy::PassManager PM; 1570b57cec5SDimitry Andric 1580b57cec5SDimitry Andric // The RuntimeDyld will take ownership of this shortly 1590b57cec5SDimitry Andric SmallVector<char, 4096> ObjBufferSV; 1600b57cec5SDimitry Andric raw_svector_ostream ObjStream(ObjBufferSV); 1610b57cec5SDimitry Andric 1620b57cec5SDimitry Andric // Turn the machine code intermediate representation into bytes in memory 1630b57cec5SDimitry Andric // that may be executed. 1640b57cec5SDimitry Andric if (TM->addPassesToEmitMC(PM, Ctx, ObjStream, !getVerifyModules())) 1650b57cec5SDimitry Andric report_fatal_error("Target does not support MC emission!"); 1660b57cec5SDimitry Andric 1670b57cec5SDimitry Andric // Initialize passes. 1680b57cec5SDimitry Andric PM.run(*M); 1690b57cec5SDimitry Andric // Flush the output buffer to get the generated code into memory 1700b57cec5SDimitry Andric 1710b57cec5SDimitry Andric std::unique_ptr<MemoryBuffer> CompiledObjBuffer( 1720b57cec5SDimitry Andric new SmallVectorMemoryBuffer(std::move(ObjBufferSV))); 1730b57cec5SDimitry Andric 1740b57cec5SDimitry Andric // If we have an object cache, tell it about the new object. 1750b57cec5SDimitry Andric // Note that we're using the compiled image, not the loaded image (as below). 1760b57cec5SDimitry Andric if (ObjCache) { 1770b57cec5SDimitry Andric // MemoryBuffer is a thin wrapper around the actual memory, so it's OK 1780b57cec5SDimitry Andric // to create a temporary object here and delete it after the call. 1790b57cec5SDimitry Andric MemoryBufferRef MB = CompiledObjBuffer->getMemBufferRef(); 1800b57cec5SDimitry Andric ObjCache->notifyObjectCompiled(M, MB); 1810b57cec5SDimitry Andric } 1820b57cec5SDimitry Andric 1830b57cec5SDimitry Andric return CompiledObjBuffer; 1840b57cec5SDimitry Andric } 1850b57cec5SDimitry Andric 1860b57cec5SDimitry Andric void MCJIT::generateCodeForModule(Module *M) { 1870b57cec5SDimitry Andric // Get a thread lock to make sure we aren't trying to load multiple times 188*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 1890b57cec5SDimitry Andric 1900b57cec5SDimitry Andric // This must be a module which has already been added to this MCJIT instance. 1910b57cec5SDimitry Andric assert(OwnedModules.ownsModule(M) && 1920b57cec5SDimitry Andric "MCJIT::generateCodeForModule: Unknown module."); 1930b57cec5SDimitry Andric 1940b57cec5SDimitry Andric // Re-compilation is not supported 1950b57cec5SDimitry Andric if (OwnedModules.hasModuleBeenLoaded(M)) 1960b57cec5SDimitry Andric return; 1970b57cec5SDimitry Andric 1980b57cec5SDimitry Andric std::unique_ptr<MemoryBuffer> ObjectToLoad; 1990b57cec5SDimitry Andric // Try to load the pre-compiled object from cache if possible 2000b57cec5SDimitry Andric if (ObjCache) 2010b57cec5SDimitry Andric ObjectToLoad = ObjCache->getObject(M); 2020b57cec5SDimitry Andric 2030b57cec5SDimitry Andric assert(M->getDataLayout() == getDataLayout() && "DataLayout Mismatch"); 2040b57cec5SDimitry Andric 2050b57cec5SDimitry Andric // If the cache did not contain a suitable object, compile the object 2060b57cec5SDimitry Andric if (!ObjectToLoad) { 2070b57cec5SDimitry Andric ObjectToLoad = emitObject(M); 2080b57cec5SDimitry Andric assert(ObjectToLoad && "Compilation did not produce an object."); 2090b57cec5SDimitry Andric } 2100b57cec5SDimitry Andric 2110b57cec5SDimitry Andric // Load the object into the dynamic linker. 2120b57cec5SDimitry Andric // MCJIT now owns the ObjectImage pointer (via its LoadedObjects list). 2130b57cec5SDimitry Andric Expected<std::unique_ptr<object::ObjectFile>> LoadedObject = 2140b57cec5SDimitry Andric object::ObjectFile::createObjectFile(ObjectToLoad->getMemBufferRef()); 2150b57cec5SDimitry Andric if (!LoadedObject) { 2160b57cec5SDimitry Andric std::string Buf; 2170b57cec5SDimitry Andric raw_string_ostream OS(Buf); 2180b57cec5SDimitry Andric logAllUnhandledErrors(LoadedObject.takeError(), OS); 2190b57cec5SDimitry Andric OS.flush(); 2200b57cec5SDimitry Andric report_fatal_error(Buf); 2210b57cec5SDimitry Andric } 2220b57cec5SDimitry Andric std::unique_ptr<RuntimeDyld::LoadedObjectInfo> L = 2230b57cec5SDimitry Andric Dyld.loadObject(*LoadedObject.get()); 2240b57cec5SDimitry Andric 2250b57cec5SDimitry Andric if (Dyld.hasError()) 2260b57cec5SDimitry Andric report_fatal_error(Dyld.getErrorString()); 2270b57cec5SDimitry Andric 2280b57cec5SDimitry Andric notifyObjectLoaded(*LoadedObject.get(), *L); 2290b57cec5SDimitry Andric 2300b57cec5SDimitry Andric Buffers.push_back(std::move(ObjectToLoad)); 2310b57cec5SDimitry Andric LoadedObjects.push_back(std::move(*LoadedObject)); 2320b57cec5SDimitry Andric 2330b57cec5SDimitry Andric OwnedModules.markModuleAsLoaded(M); 2340b57cec5SDimitry Andric } 2350b57cec5SDimitry Andric 2360b57cec5SDimitry Andric void MCJIT::finalizeLoadedModules() { 237*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 2380b57cec5SDimitry Andric 2390b57cec5SDimitry Andric // Resolve any outstanding relocations. 2400b57cec5SDimitry Andric Dyld.resolveRelocations(); 2410b57cec5SDimitry Andric 2420b57cec5SDimitry Andric OwnedModules.markAllLoadedModulesAsFinalized(); 2430b57cec5SDimitry Andric 2440b57cec5SDimitry Andric // Register EH frame data for any module we own which has been loaded 2450b57cec5SDimitry Andric Dyld.registerEHFrames(); 2460b57cec5SDimitry Andric 2470b57cec5SDimitry Andric // Set page permissions. 2480b57cec5SDimitry Andric MemMgr->finalizeMemory(); 2490b57cec5SDimitry Andric } 2500b57cec5SDimitry Andric 2510b57cec5SDimitry Andric // FIXME: Rename this. 2520b57cec5SDimitry Andric void MCJIT::finalizeObject() { 253*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 2540b57cec5SDimitry Andric 2550b57cec5SDimitry Andric // Generate code for module is going to move objects out of the 'added' list, 2560b57cec5SDimitry Andric // so we need to copy that out before using it: 2570b57cec5SDimitry Andric SmallVector<Module*, 16> ModsToAdd; 2580b57cec5SDimitry Andric for (auto M : OwnedModules.added()) 2590b57cec5SDimitry Andric ModsToAdd.push_back(M); 2600b57cec5SDimitry Andric 2610b57cec5SDimitry Andric for (auto M : ModsToAdd) 2620b57cec5SDimitry Andric generateCodeForModule(M); 2630b57cec5SDimitry Andric 2640b57cec5SDimitry Andric finalizeLoadedModules(); 2650b57cec5SDimitry Andric } 2660b57cec5SDimitry Andric 2670b57cec5SDimitry Andric void MCJIT::finalizeModule(Module *M) { 268*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 2690b57cec5SDimitry Andric 2700b57cec5SDimitry Andric // This must be a module which has already been added to this MCJIT instance. 2710b57cec5SDimitry Andric assert(OwnedModules.ownsModule(M) && "MCJIT::finalizeModule: Unknown module."); 2720b57cec5SDimitry Andric 2730b57cec5SDimitry Andric // If the module hasn't been compiled, just do that. 2740b57cec5SDimitry Andric if (!OwnedModules.hasModuleBeenLoaded(M)) 2750b57cec5SDimitry Andric generateCodeForModule(M); 2760b57cec5SDimitry Andric 2770b57cec5SDimitry Andric finalizeLoadedModules(); 2780b57cec5SDimitry Andric } 2790b57cec5SDimitry Andric 2800b57cec5SDimitry Andric JITSymbol MCJIT::findExistingSymbol(const std::string &Name) { 2810b57cec5SDimitry Andric if (void *Addr = getPointerToGlobalIfAvailable(Name)) 2820b57cec5SDimitry Andric return JITSymbol(static_cast<uint64_t>( 2830b57cec5SDimitry Andric reinterpret_cast<uintptr_t>(Addr)), 2840b57cec5SDimitry Andric JITSymbolFlags::Exported); 2850b57cec5SDimitry Andric 2860b57cec5SDimitry Andric return Dyld.getSymbol(Name); 2870b57cec5SDimitry Andric } 2880b57cec5SDimitry Andric 2890b57cec5SDimitry Andric Module *MCJIT::findModuleForSymbol(const std::string &Name, 2900b57cec5SDimitry Andric bool CheckFunctionsOnly) { 2910b57cec5SDimitry Andric StringRef DemangledName = Name; 2920b57cec5SDimitry Andric if (DemangledName[0] == getDataLayout().getGlobalPrefix()) 2930b57cec5SDimitry Andric DemangledName = DemangledName.substr(1); 2940b57cec5SDimitry Andric 295*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 2960b57cec5SDimitry Andric 2970b57cec5SDimitry Andric // If it hasn't already been generated, see if it's in one of our modules. 2980b57cec5SDimitry Andric for (ModulePtrSet::iterator I = OwnedModules.begin_added(), 2990b57cec5SDimitry Andric E = OwnedModules.end_added(); 3000b57cec5SDimitry Andric I != E; ++I) { 3010b57cec5SDimitry Andric Module *M = *I; 3020b57cec5SDimitry Andric Function *F = M->getFunction(DemangledName); 3030b57cec5SDimitry Andric if (F && !F->isDeclaration()) 3040b57cec5SDimitry Andric return M; 3050b57cec5SDimitry Andric if (!CheckFunctionsOnly) { 3060b57cec5SDimitry Andric GlobalVariable *G = M->getGlobalVariable(DemangledName); 3070b57cec5SDimitry Andric if (G && !G->isDeclaration()) 3080b57cec5SDimitry Andric return M; 3090b57cec5SDimitry Andric // FIXME: Do we need to worry about global aliases? 3100b57cec5SDimitry Andric } 3110b57cec5SDimitry Andric } 3120b57cec5SDimitry Andric // We didn't find the symbol in any of our modules. 3130b57cec5SDimitry Andric return nullptr; 3140b57cec5SDimitry Andric } 3150b57cec5SDimitry Andric 3160b57cec5SDimitry Andric uint64_t MCJIT::getSymbolAddress(const std::string &Name, 3170b57cec5SDimitry Andric bool CheckFunctionsOnly) { 3180b57cec5SDimitry Andric std::string MangledName; 3190b57cec5SDimitry Andric { 3200b57cec5SDimitry Andric raw_string_ostream MangledNameStream(MangledName); 3210b57cec5SDimitry Andric Mangler::getNameWithPrefix(MangledNameStream, Name, getDataLayout()); 3220b57cec5SDimitry Andric } 3230b57cec5SDimitry Andric if (auto Sym = findSymbol(MangledName, CheckFunctionsOnly)) { 3240b57cec5SDimitry Andric if (auto AddrOrErr = Sym.getAddress()) 3250b57cec5SDimitry Andric return *AddrOrErr; 3260b57cec5SDimitry Andric else 3270b57cec5SDimitry Andric report_fatal_error(AddrOrErr.takeError()); 3280b57cec5SDimitry Andric } else if (auto Err = Sym.takeError()) 3290b57cec5SDimitry Andric report_fatal_error(Sym.takeError()); 3300b57cec5SDimitry Andric return 0; 3310b57cec5SDimitry Andric } 3320b57cec5SDimitry Andric 3330b57cec5SDimitry Andric JITSymbol MCJIT::findSymbol(const std::string &Name, 3340b57cec5SDimitry Andric bool CheckFunctionsOnly) { 335*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 3360b57cec5SDimitry Andric 3370b57cec5SDimitry Andric // First, check to see if we already have this symbol. 3380b57cec5SDimitry Andric if (auto Sym = findExistingSymbol(Name)) 3390b57cec5SDimitry Andric return Sym; 3400b57cec5SDimitry Andric 3410b57cec5SDimitry Andric for (object::OwningBinary<object::Archive> &OB : Archives) { 3420b57cec5SDimitry Andric object::Archive *A = OB.getBinary(); 3430b57cec5SDimitry Andric // Look for our symbols in each Archive 3440b57cec5SDimitry Andric auto OptionalChildOrErr = A->findSym(Name); 3450b57cec5SDimitry Andric if (!OptionalChildOrErr) 3460b57cec5SDimitry Andric report_fatal_error(OptionalChildOrErr.takeError()); 3470b57cec5SDimitry Andric auto &OptionalChild = *OptionalChildOrErr; 3480b57cec5SDimitry Andric if (OptionalChild) { 3490b57cec5SDimitry Andric // FIXME: Support nested archives? 3500b57cec5SDimitry Andric Expected<std::unique_ptr<object::Binary>> ChildBinOrErr = 3510b57cec5SDimitry Andric OptionalChild->getAsBinary(); 3520b57cec5SDimitry Andric if (!ChildBinOrErr) { 3530b57cec5SDimitry Andric // TODO: Actually report errors helpfully. 3540b57cec5SDimitry Andric consumeError(ChildBinOrErr.takeError()); 3550b57cec5SDimitry Andric continue; 3560b57cec5SDimitry Andric } 3570b57cec5SDimitry Andric std::unique_ptr<object::Binary> &ChildBin = ChildBinOrErr.get(); 3580b57cec5SDimitry Andric if (ChildBin->isObject()) { 3590b57cec5SDimitry Andric std::unique_ptr<object::ObjectFile> OF( 3600b57cec5SDimitry Andric static_cast<object::ObjectFile *>(ChildBin.release())); 3610b57cec5SDimitry Andric // This causes the object file to be loaded. 3620b57cec5SDimitry Andric addObjectFile(std::move(OF)); 3630b57cec5SDimitry Andric // The address should be here now. 3640b57cec5SDimitry Andric if (auto Sym = findExistingSymbol(Name)) 3650b57cec5SDimitry Andric return Sym; 3660b57cec5SDimitry Andric } 3670b57cec5SDimitry Andric } 3680b57cec5SDimitry Andric } 3690b57cec5SDimitry Andric 3700b57cec5SDimitry Andric // If it hasn't already been generated, see if it's in one of our modules. 3710b57cec5SDimitry Andric Module *M = findModuleForSymbol(Name, CheckFunctionsOnly); 3720b57cec5SDimitry Andric if (M) { 3730b57cec5SDimitry Andric generateCodeForModule(M); 3740b57cec5SDimitry Andric 3750b57cec5SDimitry Andric // Check the RuntimeDyld table again, it should be there now. 3760b57cec5SDimitry Andric return findExistingSymbol(Name); 3770b57cec5SDimitry Andric } 3780b57cec5SDimitry Andric 3790b57cec5SDimitry Andric // If a LazyFunctionCreator is installed, use it to get/create the function. 3800b57cec5SDimitry Andric // FIXME: Should we instead have a LazySymbolCreator callback? 3810b57cec5SDimitry Andric if (LazyFunctionCreator) { 3820b57cec5SDimitry Andric auto Addr = static_cast<uint64_t>( 3830b57cec5SDimitry Andric reinterpret_cast<uintptr_t>(LazyFunctionCreator(Name))); 3840b57cec5SDimitry Andric return JITSymbol(Addr, JITSymbolFlags::Exported); 3850b57cec5SDimitry Andric } 3860b57cec5SDimitry Andric 3870b57cec5SDimitry Andric return nullptr; 3880b57cec5SDimitry Andric } 3890b57cec5SDimitry Andric 3900b57cec5SDimitry Andric uint64_t MCJIT::getGlobalValueAddress(const std::string &Name) { 391*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 3920b57cec5SDimitry Andric uint64_t Result = getSymbolAddress(Name, false); 3930b57cec5SDimitry Andric if (Result != 0) 3940b57cec5SDimitry Andric finalizeLoadedModules(); 3950b57cec5SDimitry Andric return Result; 3960b57cec5SDimitry Andric } 3970b57cec5SDimitry Andric 3980b57cec5SDimitry Andric uint64_t MCJIT::getFunctionAddress(const std::string &Name) { 399*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 4000b57cec5SDimitry Andric uint64_t Result = getSymbolAddress(Name, true); 4010b57cec5SDimitry Andric if (Result != 0) 4020b57cec5SDimitry Andric finalizeLoadedModules(); 4030b57cec5SDimitry Andric return Result; 4040b57cec5SDimitry Andric } 4050b57cec5SDimitry Andric 4060b57cec5SDimitry Andric // Deprecated. Use getFunctionAddress instead. 4070b57cec5SDimitry Andric void *MCJIT::getPointerToFunction(Function *F) { 408*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 4090b57cec5SDimitry Andric 4100b57cec5SDimitry Andric Mangler Mang; 4110b57cec5SDimitry Andric SmallString<128> Name; 4120b57cec5SDimitry Andric TM->getNameWithPrefix(Name, F, Mang); 4130b57cec5SDimitry Andric 4140b57cec5SDimitry Andric if (F->isDeclaration() || F->hasAvailableExternallyLinkage()) { 4150b57cec5SDimitry Andric bool AbortOnFailure = !F->hasExternalWeakLinkage(); 4160b57cec5SDimitry Andric void *Addr = getPointerToNamedFunction(Name, AbortOnFailure); 4170b57cec5SDimitry Andric updateGlobalMapping(F, Addr); 4180b57cec5SDimitry Andric return Addr; 4190b57cec5SDimitry Andric } 4200b57cec5SDimitry Andric 4210b57cec5SDimitry Andric Module *M = F->getParent(); 4220b57cec5SDimitry Andric bool HasBeenAddedButNotLoaded = OwnedModules.hasModuleBeenAddedButNotLoaded(M); 4230b57cec5SDimitry Andric 4240b57cec5SDimitry Andric // Make sure the relevant module has been compiled and loaded. 4250b57cec5SDimitry Andric if (HasBeenAddedButNotLoaded) 4260b57cec5SDimitry Andric generateCodeForModule(M); 4270b57cec5SDimitry Andric else if (!OwnedModules.hasModuleBeenLoaded(M)) { 4280b57cec5SDimitry Andric // If this function doesn't belong to one of our modules, we're done. 4290b57cec5SDimitry Andric // FIXME: Asking for the pointer to a function that hasn't been registered, 4300b57cec5SDimitry Andric // and isn't a declaration (which is handled above) should probably 4310b57cec5SDimitry Andric // be an assertion. 4320b57cec5SDimitry Andric return nullptr; 4330b57cec5SDimitry Andric } 4340b57cec5SDimitry Andric 4350b57cec5SDimitry Andric // FIXME: Should the Dyld be retaining module information? Probably not. 4360b57cec5SDimitry Andric // 4370b57cec5SDimitry Andric // This is the accessor for the target address, so make sure to check the 4380b57cec5SDimitry Andric // load address of the symbol, not the local address. 4390b57cec5SDimitry Andric return (void*)Dyld.getSymbol(Name).getAddress(); 4400b57cec5SDimitry Andric } 4410b57cec5SDimitry Andric 4420b57cec5SDimitry Andric void MCJIT::runStaticConstructorsDestructorsInModulePtrSet( 4430b57cec5SDimitry Andric bool isDtors, ModulePtrSet::iterator I, ModulePtrSet::iterator E) { 4440b57cec5SDimitry Andric for (; I != E; ++I) { 4450b57cec5SDimitry Andric ExecutionEngine::runStaticConstructorsDestructors(**I, isDtors); 4460b57cec5SDimitry Andric } 4470b57cec5SDimitry Andric } 4480b57cec5SDimitry Andric 4490b57cec5SDimitry Andric void MCJIT::runStaticConstructorsDestructors(bool isDtors) { 4500b57cec5SDimitry Andric // Execute global ctors/dtors for each module in the program. 4510b57cec5SDimitry Andric runStaticConstructorsDestructorsInModulePtrSet( 4520b57cec5SDimitry Andric isDtors, OwnedModules.begin_added(), OwnedModules.end_added()); 4530b57cec5SDimitry Andric runStaticConstructorsDestructorsInModulePtrSet( 4540b57cec5SDimitry Andric isDtors, OwnedModules.begin_loaded(), OwnedModules.end_loaded()); 4550b57cec5SDimitry Andric runStaticConstructorsDestructorsInModulePtrSet( 4560b57cec5SDimitry Andric isDtors, OwnedModules.begin_finalized(), OwnedModules.end_finalized()); 4570b57cec5SDimitry Andric } 4580b57cec5SDimitry Andric 4590b57cec5SDimitry Andric Function *MCJIT::FindFunctionNamedInModulePtrSet(StringRef FnName, 4600b57cec5SDimitry Andric ModulePtrSet::iterator I, 4610b57cec5SDimitry Andric ModulePtrSet::iterator E) { 4620b57cec5SDimitry Andric for (; I != E; ++I) { 4630b57cec5SDimitry Andric Function *F = (*I)->getFunction(FnName); 4640b57cec5SDimitry Andric if (F && !F->isDeclaration()) 4650b57cec5SDimitry Andric return F; 4660b57cec5SDimitry Andric } 4670b57cec5SDimitry Andric return nullptr; 4680b57cec5SDimitry Andric } 4690b57cec5SDimitry Andric 4700b57cec5SDimitry Andric GlobalVariable *MCJIT::FindGlobalVariableNamedInModulePtrSet(StringRef Name, 4710b57cec5SDimitry Andric bool AllowInternal, 4720b57cec5SDimitry Andric ModulePtrSet::iterator I, 4730b57cec5SDimitry Andric ModulePtrSet::iterator E) { 4740b57cec5SDimitry Andric for (; I != E; ++I) { 4750b57cec5SDimitry Andric GlobalVariable *GV = (*I)->getGlobalVariable(Name, AllowInternal); 4760b57cec5SDimitry Andric if (GV && !GV->isDeclaration()) 4770b57cec5SDimitry Andric return GV; 4780b57cec5SDimitry Andric } 4790b57cec5SDimitry Andric return nullptr; 4800b57cec5SDimitry Andric } 4810b57cec5SDimitry Andric 4820b57cec5SDimitry Andric 4830b57cec5SDimitry Andric Function *MCJIT::FindFunctionNamed(StringRef FnName) { 4840b57cec5SDimitry Andric Function *F = FindFunctionNamedInModulePtrSet( 4850b57cec5SDimitry Andric FnName, OwnedModules.begin_added(), OwnedModules.end_added()); 4860b57cec5SDimitry Andric if (!F) 4870b57cec5SDimitry Andric F = FindFunctionNamedInModulePtrSet(FnName, OwnedModules.begin_loaded(), 4880b57cec5SDimitry Andric OwnedModules.end_loaded()); 4890b57cec5SDimitry Andric if (!F) 4900b57cec5SDimitry Andric F = FindFunctionNamedInModulePtrSet(FnName, OwnedModules.begin_finalized(), 4910b57cec5SDimitry Andric OwnedModules.end_finalized()); 4920b57cec5SDimitry Andric return F; 4930b57cec5SDimitry Andric } 4940b57cec5SDimitry Andric 4950b57cec5SDimitry Andric GlobalVariable *MCJIT::FindGlobalVariableNamed(StringRef Name, bool AllowInternal) { 4960b57cec5SDimitry Andric GlobalVariable *GV = FindGlobalVariableNamedInModulePtrSet( 4970b57cec5SDimitry Andric Name, AllowInternal, OwnedModules.begin_added(), OwnedModules.end_added()); 4980b57cec5SDimitry Andric if (!GV) 4990b57cec5SDimitry Andric GV = FindGlobalVariableNamedInModulePtrSet(Name, AllowInternal, OwnedModules.begin_loaded(), 5000b57cec5SDimitry Andric OwnedModules.end_loaded()); 5010b57cec5SDimitry Andric if (!GV) 5020b57cec5SDimitry Andric GV = FindGlobalVariableNamedInModulePtrSet(Name, AllowInternal, OwnedModules.begin_finalized(), 5030b57cec5SDimitry Andric OwnedModules.end_finalized()); 5040b57cec5SDimitry Andric return GV; 5050b57cec5SDimitry Andric } 5060b57cec5SDimitry Andric 5070b57cec5SDimitry Andric GenericValue MCJIT::runFunction(Function *F, ArrayRef<GenericValue> ArgValues) { 5080b57cec5SDimitry Andric assert(F && "Function *F was null at entry to run()"); 5090b57cec5SDimitry Andric 5100b57cec5SDimitry Andric void *FPtr = getPointerToFunction(F); 5110b57cec5SDimitry Andric finalizeModule(F->getParent()); 5120b57cec5SDimitry Andric assert(FPtr && "Pointer to fn's code was null after getPointerToFunction"); 5130b57cec5SDimitry Andric FunctionType *FTy = F->getFunctionType(); 5140b57cec5SDimitry Andric Type *RetTy = FTy->getReturnType(); 5150b57cec5SDimitry Andric 5160b57cec5SDimitry Andric assert((FTy->getNumParams() == ArgValues.size() || 5170b57cec5SDimitry Andric (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) && 5180b57cec5SDimitry Andric "Wrong number of arguments passed into function!"); 5190b57cec5SDimitry Andric assert(FTy->getNumParams() == ArgValues.size() && 5200b57cec5SDimitry Andric "This doesn't support passing arguments through varargs (yet)!"); 5210b57cec5SDimitry Andric 5220b57cec5SDimitry Andric // Handle some common cases first. These cases correspond to common `main' 5230b57cec5SDimitry Andric // prototypes. 5240b57cec5SDimitry Andric if (RetTy->isIntegerTy(32) || RetTy->isVoidTy()) { 5250b57cec5SDimitry Andric switch (ArgValues.size()) { 5260b57cec5SDimitry Andric case 3: 5270b57cec5SDimitry Andric if (FTy->getParamType(0)->isIntegerTy(32) && 5280b57cec5SDimitry Andric FTy->getParamType(1)->isPointerTy() && 5290b57cec5SDimitry Andric FTy->getParamType(2)->isPointerTy()) { 5300b57cec5SDimitry Andric int (*PF)(int, char **, const char **) = 5310b57cec5SDimitry Andric (int(*)(int, char **, const char **))(intptr_t)FPtr; 5320b57cec5SDimitry Andric 5330b57cec5SDimitry Andric // Call the function. 5340b57cec5SDimitry Andric GenericValue rv; 5350b57cec5SDimitry Andric rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(), 5360b57cec5SDimitry Andric (char **)GVTOP(ArgValues[1]), 5370b57cec5SDimitry Andric (const char **)GVTOP(ArgValues[2]))); 5380b57cec5SDimitry Andric return rv; 5390b57cec5SDimitry Andric } 5400b57cec5SDimitry Andric break; 5410b57cec5SDimitry Andric case 2: 5420b57cec5SDimitry Andric if (FTy->getParamType(0)->isIntegerTy(32) && 5430b57cec5SDimitry Andric FTy->getParamType(1)->isPointerTy()) { 5440b57cec5SDimitry Andric int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr; 5450b57cec5SDimitry Andric 5460b57cec5SDimitry Andric // Call the function. 5470b57cec5SDimitry Andric GenericValue rv; 5480b57cec5SDimitry Andric rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(), 5490b57cec5SDimitry Andric (char **)GVTOP(ArgValues[1]))); 5500b57cec5SDimitry Andric return rv; 5510b57cec5SDimitry Andric } 5520b57cec5SDimitry Andric break; 5530b57cec5SDimitry Andric case 1: 5540b57cec5SDimitry Andric if (FTy->getNumParams() == 1 && 5550b57cec5SDimitry Andric FTy->getParamType(0)->isIntegerTy(32)) { 5560b57cec5SDimitry Andric GenericValue rv; 5570b57cec5SDimitry Andric int (*PF)(int) = (int(*)(int))(intptr_t)FPtr; 5580b57cec5SDimitry Andric rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue())); 5590b57cec5SDimitry Andric return rv; 5600b57cec5SDimitry Andric } 5610b57cec5SDimitry Andric break; 5620b57cec5SDimitry Andric } 5630b57cec5SDimitry Andric } 5640b57cec5SDimitry Andric 5650b57cec5SDimitry Andric // Handle cases where no arguments are passed first. 5660b57cec5SDimitry Andric if (ArgValues.empty()) { 5670b57cec5SDimitry Andric GenericValue rv; 5680b57cec5SDimitry Andric switch (RetTy->getTypeID()) { 5690b57cec5SDimitry Andric default: llvm_unreachable("Unknown return type for function call!"); 5700b57cec5SDimitry Andric case Type::IntegerTyID: { 5710b57cec5SDimitry Andric unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth(); 5720b57cec5SDimitry Andric if (BitWidth == 1) 5730b57cec5SDimitry Andric rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)()); 5740b57cec5SDimitry Andric else if (BitWidth <= 8) 5750b57cec5SDimitry Andric rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)()); 5760b57cec5SDimitry Andric else if (BitWidth <= 16) 5770b57cec5SDimitry Andric rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)()); 5780b57cec5SDimitry Andric else if (BitWidth <= 32) 5790b57cec5SDimitry Andric rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)()); 5800b57cec5SDimitry Andric else if (BitWidth <= 64) 5810b57cec5SDimitry Andric rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)()); 5820b57cec5SDimitry Andric else 5830b57cec5SDimitry Andric llvm_unreachable("Integer types > 64 bits not supported"); 5840b57cec5SDimitry Andric return rv; 5850b57cec5SDimitry Andric } 5860b57cec5SDimitry Andric case Type::VoidTyID: 5870b57cec5SDimitry Andric rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)()); 5880b57cec5SDimitry Andric return rv; 5890b57cec5SDimitry Andric case Type::FloatTyID: 5900b57cec5SDimitry Andric rv.FloatVal = ((float(*)())(intptr_t)FPtr)(); 5910b57cec5SDimitry Andric return rv; 5920b57cec5SDimitry Andric case Type::DoubleTyID: 5930b57cec5SDimitry Andric rv.DoubleVal = ((double(*)())(intptr_t)FPtr)(); 5940b57cec5SDimitry Andric return rv; 5950b57cec5SDimitry Andric case Type::X86_FP80TyID: 5960b57cec5SDimitry Andric case Type::FP128TyID: 5970b57cec5SDimitry Andric case Type::PPC_FP128TyID: 5980b57cec5SDimitry Andric llvm_unreachable("long double not supported yet"); 5990b57cec5SDimitry Andric case Type::PointerTyID: 6000b57cec5SDimitry Andric return PTOGV(((void*(*)())(intptr_t)FPtr)()); 6010b57cec5SDimitry Andric } 6020b57cec5SDimitry Andric } 6030b57cec5SDimitry Andric 6040b57cec5SDimitry Andric report_fatal_error("MCJIT::runFunction does not support full-featured " 6050b57cec5SDimitry Andric "argument passing. Please use " 6060b57cec5SDimitry Andric "ExecutionEngine::getFunctionAddress and cast the result " 6070b57cec5SDimitry Andric "to the desired function pointer type."); 6080b57cec5SDimitry Andric } 6090b57cec5SDimitry Andric 6100b57cec5SDimitry Andric void *MCJIT::getPointerToNamedFunction(StringRef Name, bool AbortOnFailure) { 6110b57cec5SDimitry Andric if (!isSymbolSearchingDisabled()) { 6120b57cec5SDimitry Andric if (auto Sym = Resolver.findSymbol(Name)) { 6130b57cec5SDimitry Andric if (auto AddrOrErr = Sym.getAddress()) 6140b57cec5SDimitry Andric return reinterpret_cast<void*>( 6150b57cec5SDimitry Andric static_cast<uintptr_t>(*AddrOrErr)); 6160b57cec5SDimitry Andric } else if (auto Err = Sym.takeError()) 6170b57cec5SDimitry Andric report_fatal_error(std::move(Err)); 6180b57cec5SDimitry Andric } 6190b57cec5SDimitry Andric 6200b57cec5SDimitry Andric /// If a LazyFunctionCreator is installed, use it to get/create the function. 6210b57cec5SDimitry Andric if (LazyFunctionCreator) 6220b57cec5SDimitry Andric if (void *RP = LazyFunctionCreator(Name)) 6230b57cec5SDimitry Andric return RP; 6240b57cec5SDimitry Andric 6250b57cec5SDimitry Andric if (AbortOnFailure) { 6260b57cec5SDimitry Andric report_fatal_error("Program used external function '"+Name+ 6270b57cec5SDimitry Andric "' which could not be resolved!"); 6280b57cec5SDimitry Andric } 6290b57cec5SDimitry Andric return nullptr; 6300b57cec5SDimitry Andric } 6310b57cec5SDimitry Andric 6320b57cec5SDimitry Andric void MCJIT::RegisterJITEventListener(JITEventListener *L) { 6330b57cec5SDimitry Andric if (!L) 6340b57cec5SDimitry Andric return; 635*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 6360b57cec5SDimitry Andric EventListeners.push_back(L); 6370b57cec5SDimitry Andric } 6380b57cec5SDimitry Andric 6390b57cec5SDimitry Andric void MCJIT::UnregisterJITEventListener(JITEventListener *L) { 6400b57cec5SDimitry Andric if (!L) 6410b57cec5SDimitry Andric return; 642*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 6430b57cec5SDimitry Andric auto I = find(reverse(EventListeners), L); 6440b57cec5SDimitry Andric if (I != EventListeners.rend()) { 6450b57cec5SDimitry Andric std::swap(*I, EventListeners.back()); 6460b57cec5SDimitry Andric EventListeners.pop_back(); 6470b57cec5SDimitry Andric } 6480b57cec5SDimitry Andric } 6490b57cec5SDimitry Andric 6500b57cec5SDimitry Andric void MCJIT::notifyObjectLoaded(const object::ObjectFile &Obj, 6510b57cec5SDimitry Andric const RuntimeDyld::LoadedObjectInfo &L) { 6520b57cec5SDimitry Andric uint64_t Key = 6530b57cec5SDimitry Andric static_cast<uint64_t>(reinterpret_cast<uintptr_t>(Obj.getData().data())); 654*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 6550b57cec5SDimitry Andric MemMgr->notifyObjectLoaded(this, Obj); 6560b57cec5SDimitry Andric for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) { 6570b57cec5SDimitry Andric EventListeners[I]->notifyObjectLoaded(Key, Obj, L); 6580b57cec5SDimitry Andric } 6590b57cec5SDimitry Andric } 6600b57cec5SDimitry Andric 6610b57cec5SDimitry Andric void MCJIT::notifyFreeingObject(const object::ObjectFile &Obj) { 6620b57cec5SDimitry Andric uint64_t Key = 6630b57cec5SDimitry Andric static_cast<uint64_t>(reinterpret_cast<uintptr_t>(Obj.getData().data())); 664*8bcb0991SDimitry Andric std::lock_guard<sys::Mutex> locked(lock); 6650b57cec5SDimitry Andric for (JITEventListener *L : EventListeners) 6660b57cec5SDimitry Andric L->notifyFreeingObject(Key); 6670b57cec5SDimitry Andric } 6680b57cec5SDimitry Andric 6690b57cec5SDimitry Andric JITSymbol 6700b57cec5SDimitry Andric LinkingSymbolResolver::findSymbol(const std::string &Name) { 6710b57cec5SDimitry Andric auto Result = ParentEngine.findSymbol(Name, false); 6720b57cec5SDimitry Andric if (Result) 6730b57cec5SDimitry Andric return Result; 6740b57cec5SDimitry Andric if (ParentEngine.isSymbolSearchingDisabled()) 6750b57cec5SDimitry Andric return nullptr; 6760b57cec5SDimitry Andric return ClientResolver->findSymbol(Name); 6770b57cec5SDimitry Andric } 6780b57cec5SDimitry Andric 6790b57cec5SDimitry Andric void LinkingSymbolResolver::anchor() {} 680