2011-04-22 03:07:06 +00:00
|
|
|
//===-- MCJIT.cpp - MC-based Just-in-Time Compiler ------------------------===//
|
2010-11-17 16:06:43 +00:00
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#include "MCJIT.h"
|
2012-12-03 16:50:05 +00:00
|
|
|
#include "llvm/DataLayout.h"
|
2011-03-22 18:05:27 +00:00
|
|
|
#include "llvm/DerivedTypes.h"
|
2010-11-17 16:06:43 +00:00
|
|
|
#include "llvm/ExecutionEngine/GenericValue.h"
|
2012-11-06 18:51:59 +00:00
|
|
|
#include "llvm/ExecutionEngine/JITEventListener.h"
|
2011-03-22 01:06:42 +00:00
|
|
|
#include "llvm/ExecutionEngine/JITMemoryManager.h"
|
2012-10-02 21:18:39 +00:00
|
|
|
#include "llvm/ExecutionEngine/MCJIT.h"
|
|
|
|
#include "llvm/ExecutionEngine/ObjectBuffer.h"
|
|
|
|
#include "llvm/ExecutionEngine/ObjectImage.h"
|
2012-12-03 16:50:05 +00:00
|
|
|
#include "llvm/Function.h"
|
2011-03-22 01:06:42 +00:00
|
|
|
#include "llvm/MC/MCAsmInfo.h"
|
2010-11-29 18:16:10 +00:00
|
|
|
#include "llvm/Support/DynamicLibrary.h"
|
2012-12-03 16:50:05 +00:00
|
|
|
#include "llvm/Support/ErrorHandling.h"
|
2011-03-22 01:06:42 +00:00
|
|
|
#include "llvm/Support/MemoryBuffer.h"
|
2012-08-07 18:33:00 +00:00
|
|
|
#include "llvm/Support/MutexGuard.h"
|
2010-11-17 16:06:43 +00:00
|
|
|
|
|
|
|
using namespace llvm;
|
|
|
|
|
|
|
|
namespace {
|
|
|
|
|
|
|
|
static struct RegisterJIT {
|
|
|
|
RegisterJIT() { MCJIT::Register(); }
|
|
|
|
} JITRegistrator;
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
extern "C" void LLVMLinkInMCJIT() {
|
|
|
|
}
|
|
|
|
|
|
|
|
ExecutionEngine *MCJIT::createJIT(Module *M,
|
|
|
|
std::string *ErrorStr,
|
|
|
|
JITMemoryManager *JMM,
|
|
|
|
bool GVsWithCode,
|
2011-05-13 21:51:29 +00:00
|
|
|
TargetMachine *TM) {
|
2010-11-17 16:06:43 +00:00
|
|
|
// Try to register the program as a source of symbols to resolve against.
|
|
|
|
//
|
|
|
|
// FIXME: Don't do this here.
|
|
|
|
sys::DynamicLibrary::LoadLibraryPermanently(0, NULL);
|
|
|
|
|
2012-11-01 00:46:04 +00:00
|
|
|
return new MCJIT(M, TM, JMM, GVsWithCode);
|
2010-11-17 16:06:43 +00:00
|
|
|
}
|
|
|
|
|
2012-08-21 15:42:49 +00:00
|
|
|
MCJIT::MCJIT(Module *m, TargetMachine *tm, RTDyldMemoryManager *MM,
|
|
|
|
bool AllocateGVsWithCode)
|
|
|
|
: ExecutionEngine(m), TM(tm), Ctx(0), MemMgr(MM), Dyld(MM),
|
2012-10-02 21:18:39 +00:00
|
|
|
isCompiled(false), M(m) {
|
2011-03-18 22:48:41 +00:00
|
|
|
|
2012-10-08 16:38:25 +00:00
|
|
|
setDataLayout(TM->getDataLayout());
|
2012-08-07 18:33:00 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
MCJIT::~MCJIT() {
|
2012-11-06 18:51:59 +00:00
|
|
|
if (LoadedObject)
|
2012-11-06 19:06:46 +00:00
|
|
|
NotifyFreeingObject(*LoadedObject.get());
|
2012-08-07 18:33:00 +00:00
|
|
|
delete MemMgr;
|
|
|
|
delete TM;
|
|
|
|
}
|
|
|
|
|
|
|
|
void MCJIT::emitObject(Module *m) {
|
|
|
|
/// Currently, MCJIT only supports a single module and the module passed to
|
|
|
|
/// this function call is expected to be the contained module. The module
|
2012-10-02 21:18:39 +00:00
|
|
|
/// is passed as a parameter here to prepare for multiple module support in
|
2012-08-07 18:33:00 +00:00
|
|
|
/// the future.
|
|
|
|
assert(M == m);
|
|
|
|
|
|
|
|
// Get a thread lock to make sure we aren't trying to compile multiple times
|
|
|
|
MutexGuard locked(lock);
|
|
|
|
|
|
|
|
// FIXME: Track compilation state on a per-module basis when multiple modules
|
|
|
|
// are supported.
|
|
|
|
// Re-compilation is not supported
|
|
|
|
if (isCompiled)
|
|
|
|
return;
|
|
|
|
|
|
|
|
PassManager PM;
|
|
|
|
|
2012-10-08 16:38:25 +00:00
|
|
|
PM.add(new DataLayout(*TM->getDataLayout()));
|
2011-03-18 22:48:41 +00:00
|
|
|
|
2012-10-02 21:18:39 +00:00
|
|
|
// The RuntimeDyld will take ownership of this shortly
|
|
|
|
OwningPtr<ObjectBufferStream> Buffer(new ObjectBufferStream());
|
|
|
|
|
2011-03-18 22:48:41 +00:00
|
|
|
// Turn the machine code intermediate representation into bytes in memory
|
|
|
|
// that may be executed.
|
2012-10-02 21:18:39 +00:00
|
|
|
if (TM->addPassesToEmitMC(PM, Ctx, Buffer->getOStream(), false)) {
|
2011-03-18 22:48:41 +00:00
|
|
|
report_fatal_error("Target does not support MC emission!");
|
|
|
|
}
|
|
|
|
|
|
|
|
// Initialize passes.
|
2012-08-07 18:33:00 +00:00
|
|
|
PM.run(*m);
|
2012-10-02 21:18:39 +00:00
|
|
|
// Flush the output buffer to get the generated code into memory
|
|
|
|
Buffer->flush();
|
2011-03-22 01:06:42 +00:00
|
|
|
|
|
|
|
// Load the object into the dynamic linker.
|
2012-10-02 21:18:39 +00:00
|
|
|
// handing off ownership of the buffer
|
|
|
|
LoadedObject.reset(Dyld.loadObject(Buffer.take()));
|
|
|
|
if (!LoadedObject)
|
2011-03-23 19:51:34 +00:00
|
|
|
report_fatal_error(Dyld.getErrorString());
|
2012-08-07 18:33:00 +00:00
|
|
|
|
2011-04-13 15:28:10 +00:00
|
|
|
// Resolve any relocations.
|
|
|
|
Dyld.resolveRelocations();
|
2010-11-17 16:06:43 +00:00
|
|
|
|
2012-10-02 21:18:39 +00:00
|
|
|
// FIXME: Make this optional, maybe even move it to a JIT event listener
|
|
|
|
LoadedObject->registerWithDebugger();
|
|
|
|
|
2012-11-06 18:51:59 +00:00
|
|
|
NotifyObjectEmitted(*LoadedObject);
|
|
|
|
|
2012-08-07 18:33:00 +00:00
|
|
|
// FIXME: Add support for per-module compilation state
|
|
|
|
isCompiled = true;
|
2010-11-17 16:06:43 +00:00
|
|
|
}
|
|
|
|
|
2012-11-05 20:57:16 +00:00
|
|
|
// FIXME: Add a parameter to identify which object is being finalized when
|
|
|
|
// MCJIT supports multiple modules.
|
2012-11-15 23:50:01 +00:00
|
|
|
// FIXME: Provide a way to separate code emission, relocations and page
|
|
|
|
// protection in the interface.
|
2012-11-05 20:57:16 +00:00
|
|
|
void MCJIT::finalizeObject() {
|
|
|
|
// If the module hasn't been compiled, just do that.
|
|
|
|
if (!isCompiled) {
|
|
|
|
// If the call to Dyld.resolveRelocations() is removed from emitObject()
|
|
|
|
// we'll need to do that here.
|
|
|
|
emitObject(M);
|
2012-11-15 23:50:01 +00:00
|
|
|
|
|
|
|
// Set page permissions.
|
|
|
|
MemMgr->applyPermissions();
|
|
|
|
|
2012-11-05 20:57:16 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Resolve any relocations.
|
|
|
|
Dyld.resolveRelocations();
|
2012-11-15 23:50:01 +00:00
|
|
|
|
|
|
|
// Set page permissions.
|
|
|
|
MemMgr->applyPermissions();
|
2012-11-05 20:57:16 +00:00
|
|
|
}
|
|
|
|
|
2010-11-17 16:06:43 +00:00
|
|
|
void *MCJIT::getPointerToBasicBlock(BasicBlock *BB) {
|
|
|
|
report_fatal_error("not yet implemented");
|
|
|
|
}
|
|
|
|
|
|
|
|
void *MCJIT::getPointerToFunction(Function *F) {
|
2012-09-05 16:50:40 +00:00
|
|
|
// FIXME: This should really return a uint64_t since it's a pointer in the
|
|
|
|
// target address space, not our local address space. That's part of the
|
|
|
|
// ExecutionEngine interface, though. Fix that when the old JIT finally
|
|
|
|
// dies.
|
|
|
|
|
2012-08-07 18:33:00 +00:00
|
|
|
// FIXME: Add support for per-module compilation state
|
|
|
|
if (!isCompiled)
|
|
|
|
emitObject(M);
|
|
|
|
|
2011-03-22 18:05:27 +00:00
|
|
|
if (F->isDeclaration() || F->hasAvailableExternallyLinkage()) {
|
|
|
|
bool AbortOnFailure = !F->hasExternalWeakLinkage();
|
|
|
|
void *Addr = getPointerToNamedFunction(F->getName(), AbortOnFailure);
|
|
|
|
addGlobalMapping(F, Addr);
|
|
|
|
return Addr;
|
|
|
|
}
|
|
|
|
|
2012-08-07 18:33:00 +00:00
|
|
|
// FIXME: Should the Dyld be retaining module information? Probably not.
|
2011-05-18 23:53:21 +00:00
|
|
|
// FIXME: Should we be using the mangler for this? Probably.
|
2012-09-05 16:50:40 +00:00
|
|
|
//
|
|
|
|
// This is the accessor for the target address, so make sure to check the
|
|
|
|
// load address of the symbol, not the local address.
|
2011-05-18 23:53:21 +00:00
|
|
|
StringRef BaseName = F->getName();
|
|
|
|
if (BaseName[0] == '\1')
|
2012-09-05 16:50:40 +00:00
|
|
|
return (void*)Dyld.getSymbolLoadAddress(BaseName.substr(1));
|
|
|
|
return (void*)Dyld.getSymbolLoadAddress((TM->getMCAsmInfo()->getGlobalPrefix()
|
2011-05-19 00:45:05 +00:00
|
|
|
+ BaseName).str());
|
2010-11-17 16:06:43 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void *MCJIT::recompileAndRelinkFunction(Function *F) {
|
|
|
|
report_fatal_error("not yet implemented");
|
|
|
|
}
|
|
|
|
|
|
|
|
void MCJIT::freeMachineCodeForFunction(Function *F) {
|
|
|
|
report_fatal_error("not yet implemented");
|
|
|
|
}
|
|
|
|
|
|
|
|
GenericValue MCJIT::runFunction(Function *F,
|
|
|
|
const std::vector<GenericValue> &ArgValues) {
|
2011-03-22 18:05:27 +00:00
|
|
|
assert(F && "Function *F was null at entry to run()");
|
|
|
|
|
2011-03-18 22:48:41 +00:00
|
|
|
void *FPtr = getPointerToFunction(F);
|
2011-03-22 18:05:27 +00:00
|
|
|
assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
|
2011-07-18 04:54:35 +00:00
|
|
|
FunctionType *FTy = F->getFunctionType();
|
|
|
|
Type *RetTy = FTy->getReturnType();
|
2011-03-22 18:05:27 +00:00
|
|
|
|
|
|
|
assert((FTy->getNumParams() == ArgValues.size() ||
|
|
|
|
(FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
|
|
|
|
"Wrong number of arguments passed into function!");
|
|
|
|
assert(FTy->getNumParams() == ArgValues.size() &&
|
|
|
|
"This doesn't support passing arguments through varargs (yet)!");
|
|
|
|
|
|
|
|
// Handle some common cases first. These cases correspond to common `main'
|
|
|
|
// prototypes.
|
|
|
|
if (RetTy->isIntegerTy(32) || RetTy->isVoidTy()) {
|
|
|
|
switch (ArgValues.size()) {
|
|
|
|
case 3:
|
|
|
|
if (FTy->getParamType(0)->isIntegerTy(32) &&
|
|
|
|
FTy->getParamType(1)->isPointerTy() &&
|
|
|
|
FTy->getParamType(2)->isPointerTy()) {
|
|
|
|
int (*PF)(int, char **, const char **) =
|
|
|
|
(int(*)(int, char **, const char **))(intptr_t)FPtr;
|
|
|
|
|
|
|
|
// Call the function.
|
|
|
|
GenericValue rv;
|
|
|
|
rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
|
|
|
|
(char **)GVTOP(ArgValues[1]),
|
|
|
|
(const char **)GVTOP(ArgValues[2])));
|
|
|
|
return rv;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
case 2:
|
|
|
|
if (FTy->getParamType(0)->isIntegerTy(32) &&
|
|
|
|
FTy->getParamType(1)->isPointerTy()) {
|
|
|
|
int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
|
|
|
|
|
|
|
|
// Call the function.
|
|
|
|
GenericValue rv;
|
|
|
|
rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
|
|
|
|
(char **)GVTOP(ArgValues[1])));
|
|
|
|
return rv;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
case 1:
|
|
|
|
if (FTy->getNumParams() == 1 &&
|
|
|
|
FTy->getParamType(0)->isIntegerTy(32)) {
|
|
|
|
GenericValue rv;
|
|
|
|
int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
|
|
|
|
rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
|
|
|
|
return rv;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Handle cases where no arguments are passed first.
|
|
|
|
if (ArgValues.empty()) {
|
|
|
|
GenericValue rv;
|
|
|
|
switch (RetTy->getTypeID()) {
|
|
|
|
default: llvm_unreachable("Unknown return type for function call!");
|
|
|
|
case Type::IntegerTyID: {
|
|
|
|
unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
|
|
|
|
if (BitWidth == 1)
|
|
|
|
rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
|
|
|
|
else if (BitWidth <= 8)
|
|
|
|
rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
|
|
|
|
else if (BitWidth <= 16)
|
|
|
|
rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
|
|
|
|
else if (BitWidth <= 32)
|
|
|
|
rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
|
|
|
|
else if (BitWidth <= 64)
|
|
|
|
rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
|
|
|
|
else
|
|
|
|
llvm_unreachable("Integer types > 64 bits not supported");
|
|
|
|
return rv;
|
|
|
|
}
|
|
|
|
case Type::VoidTyID:
|
|
|
|
rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
|
|
|
|
return rv;
|
|
|
|
case Type::FloatTyID:
|
|
|
|
rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
|
|
|
|
return rv;
|
|
|
|
case Type::DoubleTyID:
|
|
|
|
rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
|
|
|
|
return rv;
|
|
|
|
case Type::X86_FP80TyID:
|
|
|
|
case Type::FP128TyID:
|
|
|
|
case Type::PPC_FP128TyID:
|
|
|
|
llvm_unreachable("long double not supported yet");
|
|
|
|
case Type::PointerTyID:
|
|
|
|
return PTOGV(((void*(*)())(intptr_t)FPtr)());
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-02-07 05:05:23 +00:00
|
|
|
llvm_unreachable("Full-featured argument passing not supported yet!");
|
2010-11-17 16:06:43 +00:00
|
|
|
}
|
2012-03-28 21:46:36 +00:00
|
|
|
|
|
|
|
void *MCJIT::getPointerToNamedFunction(const std::string &Name,
|
2012-04-29 12:40:47 +00:00
|
|
|
bool AbortOnFailure) {
|
2012-08-07 18:33:00 +00:00
|
|
|
// FIXME: Add support for per-module compilation state
|
|
|
|
if (!isCompiled)
|
|
|
|
emitObject(M);
|
|
|
|
|
2012-03-28 21:46:36 +00:00
|
|
|
if (!isSymbolSearchingDisabled() && MemMgr) {
|
|
|
|
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+
|
2012-04-29 12:40:47 +00:00
|
|
|
"' which could not be resolved!");
|
2012-03-28 21:46:36 +00:00
|
|
|
}
|
|
|
|
return 0;
|
|
|
|
}
|
2012-11-06 18:51:59 +00:00
|
|
|
|
|
|
|
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);
|
|
|
|
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);
|
|
|
|
}
|
|
|
|
}
|