//===----------------------------------------------------------------------===//
#include "MCJIT.h"
-#include "MCJITMemoryManager.h"
-#include "llvm/DerivedTypes.h"
-#include "llvm/Function.h"
#include "llvm/ExecutionEngine/GenericValue.h"
-#include "llvm/ExecutionEngine/MCJIT.h"
+#include "llvm/ExecutionEngine/JITEventListener.h"
#include "llvm/ExecutionEngine/JITMemoryManager.h"
+#include "llvm/ExecutionEngine/MCJIT.h"
+#include "llvm/ExecutionEngine/ObjectBuffer.h"
+#include "llvm/ExecutionEngine/ObjectImage.h"
+#include "llvm/ExecutionEngine/SectionMemoryManager.h"
+#include "llvm/IR/DataLayout.h"
+#include "llvm/IR/DerivedTypes.h"
+#include "llvm/IR/Function.h"
+#include "llvm/IR/Module.h"
#include "llvm/MC/MCAsmInfo.h"
-#include "llvm/Support/ErrorHandling.h"
#include "llvm/Support/DynamicLibrary.h"
+#include "llvm/Support/ErrorHandling.h"
#include "llvm/Support/MemoryBuffer.h"
-#include "llvm/Target/TargetData.h"
+#include "llvm/Support/MutexGuard.h"
using namespace llvm;
ExecutionEngine *MCJIT::createJIT(Module *M,
std::string *ErrorStr,
- JITMemoryManager *JMM,
- CodeGenOpt::Level OptLevel,
+ RTDyldMemoryManager *MemMgr,
bool GVsWithCode,
TargetMachine *TM) {
// Try to register the program as a source of symbols to resolve against.
// FIXME: Don't do this here.
sys::DynamicLibrary::LoadLibraryPermanently(0, NULL);
- // If the target supports JIT code generation, create the JIT.
- if (TargetJITInfo *TJ = TM->getJITInfo())
- return new MCJIT(M, TM, *TJ, new MCJITMemoryManager(JMM, M), OptLevel,
- GVsWithCode);
-
- if (ErrorStr)
- *ErrorStr = "target does not support JIT code generation";
- return 0;
+ return new MCJIT(M, TM, MemMgr ? MemMgr : new SectionMemoryManager(),
+ GVsWithCode);
}
-MCJIT::MCJIT(Module *m, TargetMachine *tm, TargetJITInfo &tji,
- RTDyldMemoryManager *MM, CodeGenOpt::Level OptLevel,
+MCJIT::MCJIT(Module *m, TargetMachine *tm, RTDyldMemoryManager *MM,
bool AllocateGVsWithCode)
- : ExecutionEngine(m), TM(tm), MemMgr(MM), M(m), OS(Buffer), Dyld(MM) {
+ : ExecutionEngine(m), TM(tm), Ctx(0), MemMgr(this, MM), Dyld(&MemMgr),
+ ObjCache(0) {
+
+ ModuleStates[m] = ModuleAdded;
+ setDataLayout(TM->getDataLayout());
+}
- PM.add(new TargetData(*TM->getTargetData()));
+MCJIT::~MCJIT() {
+ Dyld.deregisterEHFrames();
+
+ LoadedObjectMap::iterator it, end = LoadedObjects.end();
+ for (it = LoadedObjects.begin(); it != end; ++it) {
+ ObjectImage *Obj = it->second;
+ if (Obj) {
+ NotifyFreeingObject(*Obj);
+ delete Obj;
+ }
+ }
+ LoadedObjects.clear();
+ delete TM;
+}
+
+void MCJIT::addModule(Module *M) {
+ Modules.push_back(M);
+ ModuleStates[M] = MCJITModuleState();
+}
+
+void MCJIT::setObjectCache(ObjectCache* NewCache) {
+ ObjCache = NewCache;
+}
+
+ObjectBufferStream* MCJIT::emitObject(Module *M) {
+ // This must be a module which has already been added to this MCJIT instance.
+ assert(std::find(Modules.begin(), Modules.end(), M) != Modules.end());
+ assert(ModuleStates.find(M) != ModuleStates.end());
+
+ // Get a thread lock to make sure we aren't trying to compile multiple times
+ MutexGuard locked(lock);
+
+ // Re-compilation is not supported
+ assert(!ModuleStates[M].hasBeenEmitted());
+
+ PassManager PM;
+
+ PM.add(new DataLayout(*TM->getDataLayout()));
+
+ // The RuntimeDyld will take ownership of this shortly
+ OwningPtr<ObjectBufferStream> CompiledObject(new ObjectBufferStream());
// Turn the machine code intermediate representation into bytes in memory
// that may be executed.
- if (TM->addPassesToEmitMC(PM, Ctx, OS, CodeGenOpt::Default, false)) {
+ if (TM->addPassesToEmitMC(PM, Ctx, CompiledObject->getOStream(), false)) {
report_fatal_error("Target does not support MC emission!");
}
// Initialize passes.
- // FIXME: When we support multiple modules, we'll want to move the code
- // gen and finalization out of the constructor here and do it more
- // on-demand as part of getPointerToFunction().
PM.run(*M);
- // Flush the output buffer so the SmallVector gets its data.
- OS.flush();
+ // Flush the output buffer to get the generated code into memory
+ CompiledObject->flush();
+
+ // If we have an object cache, tell it about the new object.
+ // Note that we're using the compiled image, not the loaded image (as below).
+ if (ObjCache) {
+ // MemoryBuffer is a thin wrapper around the actual memory, so it's OK
+ // to create a temporary object here and delete it after the call.
+ OwningPtr<MemoryBuffer> MB(CompiledObject->getMemBuffer());
+ ObjCache->notifyObjectCompiled(M, MB.get());
+ }
+
+ return CompiledObject.take();
+}
+
+void MCJIT::generateCodeForModule(Module *M) {
+ // This must be a module which has already been added to this MCJIT instance.
+ assert(std::find(Modules.begin(), Modules.end(), M) != Modules.end());
+ assert(ModuleStates.find(M) != ModuleStates.end());
+
+ // Get a thread lock to make sure we aren't trying to load multiple times
+ MutexGuard locked(lock);
+
+ // Re-compilation is not supported
+ if (ModuleStates[M].hasBeenLoaded())
+ return;
+
+ OwningPtr<ObjectBuffer> ObjectToLoad;
+ // Try to load the pre-compiled object from cache if possible
+ if (0 != ObjCache) {
+ OwningPtr<MemoryBuffer> PreCompiledObject(ObjCache->getObject(M));
+ if (0 != PreCompiledObject.get())
+ ObjectToLoad.reset(new ObjectBuffer(PreCompiledObject.take()));
+ }
+
+ // If the cache did not contain a suitable object, compile the object
+ if (!ObjectToLoad) {
+ ObjectToLoad.reset(emitObject(M));
+ assert(ObjectToLoad.get() && "Compilation did not produce an object.");
+ }
// Load the object into the dynamic linker.
- // FIXME: It would be nice to avoid making yet another copy.
- MemoryBuffer *MB = MemoryBuffer::getMemBufferCopy(StringRef(Buffer.data(),
- Buffer.size()));
- if (Dyld.loadObject(MB))
+ // MCJIT now owns the ObjectImage pointer (via its LoadedObjects map).
+ ObjectImage *LoadedObject = Dyld.loadObject(ObjectToLoad.take());
+ LoadedObjects[M] = LoadedObject;
+ if (!LoadedObject)
report_fatal_error(Dyld.getErrorString());
- // Resolve any relocations.
+
+ // FIXME: Make this optional, maybe even move it to a JIT event listener
+ LoadedObject->registerWithDebugger();
+
+ NotifyObjectEmitted(*LoadedObject);
+
+ ModuleStates[M] = ModuleLoaded;
+}
+
+void MCJIT::finalizeLoadedModules() {
+ // Resolve any outstanding relocations.
Dyld.resolveRelocations();
+
+ // Register EH frame data for any module we own which has been loaded
+ SmallVector<Module *, 1>::iterator end = Modules.end();
+ SmallVector<Module *, 1>::iterator it;
+ for (it = Modules.begin(); it != end; ++it) {
+ Module *M = *it;
+ assert(ModuleStates.find(M) != ModuleStates.end());
+
+ if (ModuleStates[M].hasBeenLoaded() &&
+ !ModuleStates[M].hasBeenFinalized()) {
+ ModuleStates[M] = ModuleFinalized;
+ }
+ }
+
+ Dyld.registerEHFrames();
+
+ // Set page permissions.
+ MemMgr.finalizeMemory();
}
-MCJIT::~MCJIT() {
- delete MemMgr;
+// FIXME: Rename this.
+void MCJIT::finalizeObject() {
+ // FIXME: This is a temporary hack to get around problems with calling
+ // finalize multiple times.
+ bool finalizeNeeded = false;
+ SmallVector<Module *, 1>::iterator end = Modules.end();
+ SmallVector<Module *, 1>::iterator it;
+ for (it = Modules.begin(); it != end; ++it) {
+ Module *M = *it;
+ assert(ModuleStates.find(M) != ModuleStates.end());
+ if (!ModuleStates[M].hasBeenFinalized())
+ finalizeNeeded = true;
+
+ // I don't really like this, but the C API depends on this behavior.
+ // I suppose it's OK for a deprecated function.
+ if (!ModuleStates[M].hasBeenLoaded())
+ generateCodeForModule(M);
+ }
+ if (!finalizeNeeded)
+ return;
+
+ // Resolve any outstanding relocations.
+ Dyld.resolveRelocations();
+
+ // Register EH frame data for any module we own which has been loaded
+ for (it = Modules.begin(); it != end; ++it) {
+ Module *M = *it;
+ assert(ModuleStates.find(M) != ModuleStates.end());
+
+ if (ModuleStates[M].hasBeenLoaded() &&
+ !ModuleStates[M].hasBeenFinalized()) {
+ ModuleStates[M] = ModuleFinalized;
+ }
+ }
+
+ Dyld.registerEHFrames();
+
+ // Set page permissions.
+ MemMgr.finalizeMemory();
+}
+
+void MCJIT::finalizeModule(Module *M) {
+ // This must be a module which has already been added to this MCJIT instance.
+ assert(std::find(Modules.begin(), Modules.end(), M) != Modules.end());
+ assert(ModuleStates.find(M) != ModuleStates.end());
+
+ if (ModuleStates[M].hasBeenFinalized())
+ return;
+
+ // If the module hasn't been compiled, just do that.
+ if (!ModuleStates[M].hasBeenLoaded())
+ generateCodeForModule(M);
+
+ // Resolve any outstanding relocations.
+ Dyld.resolveRelocations();
+
+ Dyld.registerEHFrames();
+
+ // Set page permissions.
+ MemMgr.finalizeMemory();
+
+ ModuleStates[M] = ModuleFinalized;
}
void *MCJIT::getPointerToBasicBlock(BasicBlock *BB) {
report_fatal_error("not yet implemented");
- return 0;
}
+uint64_t MCJIT::getExistingSymbolAddress(const std::string &Name) {
+ // Check with the RuntimeDyld to see if we already have this symbol.
+ if (Name[0] == '\1')
+ return Dyld.getSymbolLoadAddress(Name.substr(1));
+ return Dyld.getSymbolLoadAddress((TM->getMCAsmInfo()->getGlobalPrefix()
+ + Name));
+}
+
+Module *MCJIT::findModuleForSymbol(const std::string &Name,
+ bool CheckFunctionsOnly) {
+ // If it hasn't already been generated, see if it's in one of our modules.
+ SmallVector<Module *, 1>::iterator end = Modules.end();
+ SmallVector<Module *, 1>::iterator it;
+ for (it = Modules.begin(); it != end; ++it) {
+ Module *M = *it;
+ Function *F = M->getFunction(Name);
+ if (F && !F->empty())
+ return M;
+ if (!CheckFunctionsOnly) {
+ GlobalVariable *G = M->getGlobalVariable(Name);
+ if (G)
+ return M;
+ // FIXME: Do we need to worry about global aliases?
+ }
+ }
+ // We didn't find the symbol in any of our modules.
+ return NULL;
+}
+
+uint64_t MCJIT::getSymbolAddress(const std::string &Name,
+ bool CheckFunctionsOnly)
+{
+ // First, check to see if we already have this symbol.
+ uint64_t Addr = getExistingSymbolAddress(Name);
+ if (Addr)
+ return Addr;
+
+ // If it hasn't already been generated, see if it's in one of our modules.
+ Module *M = findModuleForSymbol(Name, CheckFunctionsOnly);
+ if (!M)
+ return 0;
+
+ // If this is in one of our modules, generate code for that module.
+ assert(ModuleStates.find(M) != ModuleStates.end());
+ // If the module code has already been generated, we won't find the symbol.
+ if (ModuleStates[M].hasBeenLoaded())
+ return 0;
+
+ // FIXME: We probably need to make sure we aren't in the process of
+ // loading or finalizing this module.
+ generateCodeForModule(M);
+
+ // Check the RuntimeDyld table again, it should be there now.
+ return getExistingSymbolAddress(Name);
+}
+
+uint64_t MCJIT::getGlobalValueAddress(const std::string &Name) {
+ uint64_t Result = getSymbolAddress(Name, false);
+ if (Result != 0)
+ finalizeLoadedModules();
+ return Result;
+}
+
+uint64_t MCJIT::getFunctionAddress(const std::string &Name) {
+ uint64_t Result = getSymbolAddress(Name, true);
+ if (Result != 0)
+ finalizeLoadedModules();
+ return Result;
+}
+
+// Deprecated. Use getFunctionAddress instead.
void *MCJIT::getPointerToFunction(Function *F) {
+
if (F->isDeclaration() || F->hasAvailableExternallyLinkage()) {
bool AbortOnFailure = !F->hasExternalWeakLinkage();
void *Addr = getPointerToNamedFunction(F->getName(), AbortOnFailure);
return Addr;
}
+ // If this function doesn't belong to one of our modules, we're done.
+ Module *M = F->getParent();
+ if (std::find(Modules.begin(), Modules.end(), M) == Modules.end())
+ return NULL;
+
+ assert(ModuleStates.find(M) != ModuleStates.end());
+
+ // Make sure the relevant module has been compiled and loaded.
+ if (!ModuleStates[M].hasBeenLoaded())
+ generateCodeForModule(M);
+
+ // FIXME: Should the Dyld be retaining module information? Probably not.
// FIXME: Should we be using the mangler for this? Probably.
+ //
+ // This is the accessor for the target address, so make sure to check the
+ // load address of the symbol, not the local address.
StringRef BaseName = F->getName();
if (BaseName[0] == '\1')
- return (void*)Dyld.getSymbolAddress(BaseName.substr(1));
- return (void*)Dyld.getSymbolAddress((TM->getMCAsmInfo()->getGlobalPrefix()
+ return (void*)Dyld.getSymbolLoadAddress(BaseName.substr(1));
+ return (void*)Dyld.getSymbolLoadAddress((TM->getMCAsmInfo()->getGlobalPrefix()
+ BaseName).str());
}
case Type::FP128TyID:
case Type::PPC_FP128TyID:
llvm_unreachable("long double not supported yet");
- return rv;
case Type::PointerTyID:
return PTOGV(((void*(*)())(intptr_t)FPtr)());
}
}
- assert(0 && "Full-featured argument passing not supported yet!");
- return GenericValue();
+ llvm_unreachable("Full-featured argument passing not supported yet!");
+}
+
+void *MCJIT::getPointerToNamedFunction(const std::string &Name,
+ bool AbortOnFailure) {
+ if (!isSymbolSearchingDisabled()) {
+ void *ptr = MemMgr.getPointerToNamedFunction(Name, false);
+ if (ptr)
+ return ptr;
+ }
+
+ /// If a LazyFunctionCreator is installed, use it to get/create the function.
+ if (LazyFunctionCreator)
+ if (void *RP = LazyFunctionCreator(Name))
+ return RP;
+
+ if (AbortOnFailure) {
+ report_fatal_error("Program used external function '"+Name+
+ "' which could not be resolved!");
+ }
+ return 0;
+}
+
+void MCJIT::RegisterJITEventListener(JITEventListener *L) {
+ if (L == NULL)
+ return;
+ MutexGuard locked(lock);
+ EventListeners.push_back(L);
+}
+void MCJIT::UnregisterJITEventListener(JITEventListener *L) {
+ if (L == NULL)
+ return;
+ MutexGuard locked(lock);
+ SmallVector<JITEventListener*, 2>::reverse_iterator I=
+ std::find(EventListeners.rbegin(), EventListeners.rend(), L);
+ if (I != EventListeners.rend()) {
+ std::swap(*I, EventListeners.back());
+ EventListeners.pop_back();
+ }
+}
+void MCJIT::NotifyObjectEmitted(const ObjectImage& Obj) {
+ MutexGuard locked(lock);
+ MemMgr.notifyObjectLoaded(this, &Obj);
+ for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
+ EventListeners[I]->NotifyObjectEmitted(Obj);
+ }
+}
+void MCJIT::NotifyFreeingObject(const ObjectImage& Obj) {
+ MutexGuard locked(lock);
+ for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
+ EventListeners[I]->NotifyFreeingObject(Obj);
+ }
+}
+
+uint64_t LinkingMemoryManager::getSymbolAddress(const std::string &Name) {
+ uint64_t Result = ParentEngine->getSymbolAddress(Name, false);
+ // If the symbols wasn't found and it begins with an underscore, try again
+ // without the underscore.
+ if (!Result && Name[0] == '_')
+ Result = ParentEngine->getSymbolAddress(Name.substr(1), false);
+ if (Result)
+ return Result;
+ return ClientMM->getSymbolAddress(Name);
}