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/DerivedTypes.h"
12 #include "llvm/Function.h"
13 #include "llvm/ExecutionEngine/GenericValue.h"
14 #include "llvm/ExecutionEngine/JITMemoryManager.h"
15 #include "llvm/ExecutionEngine/MCJIT.h"
16 #include "llvm/ExecutionEngine/ObjectBuffer.h"
17 #include "llvm/ExecutionEngine/ObjectImage.h"
18 #include "llvm/MC/MCAsmInfo.h"
19 #include "llvm/Support/ErrorHandling.h"
20 #include "llvm/Support/DynamicLibrary.h"
21 #include "llvm/Support/MemoryBuffer.h"
22 #include "llvm/Support/MutexGuard.h"
23 #include "llvm/DataLayout.h"
29 static struct RegisterJIT {
30 RegisterJIT() { MCJIT::Register(); }
35 extern "C" void LLVMLinkInMCJIT() {
38 ExecutionEngine *MCJIT::createJIT(Module *M,
39 std::string *ErrorStr,
40 JITMemoryManager *JMM,
43 // Try to register the program as a source of symbols to resolve against.
45 // FIXME: Don't do this here.
46 sys::DynamicLibrary::LoadLibraryPermanently(0, NULL);
48 return new MCJIT(M, TM, JMM, GVsWithCode);
51 MCJIT::MCJIT(Module *m, TargetMachine *tm, RTDyldMemoryManager *MM,
52 bool AllocateGVsWithCode)
53 : ExecutionEngine(m), TM(tm), Ctx(0), MemMgr(MM), Dyld(MM),
54 isCompiled(false), M(m) {
56 setDataLayout(TM->getDataLayout());
64 void MCJIT::emitObject(Module *m) {
65 /// Currently, MCJIT only supports a single module and the module passed to
66 /// this function call is expected to be the contained module. The module
67 /// is passed as a parameter here to prepare for multiple module support in
71 // Get a thread lock to make sure we aren't trying to compile multiple times
72 MutexGuard locked(lock);
74 // FIXME: Track compilation state on a per-module basis when multiple modules
76 // Re-compilation is not supported
82 PM.add(new DataLayout(*TM->getDataLayout()));
84 // The RuntimeDyld will take ownership of this shortly
85 OwningPtr<ObjectBufferStream> Buffer(new ObjectBufferStream());
87 // Turn the machine code intermediate representation into bytes in memory
88 // that may be executed.
89 if (TM->addPassesToEmitMC(PM, Ctx, Buffer->getOStream(), false)) {
90 report_fatal_error("Target does not support MC emission!");
95 // Flush the output buffer to get the generated code into memory
98 // Load the object into the dynamic linker.
99 // handing off ownership of the buffer
100 LoadedObject.reset(Dyld.loadObject(Buffer.take()));
102 report_fatal_error(Dyld.getErrorString());
104 // Resolve any relocations.
105 Dyld.resolveRelocations();
107 // FIXME: Make this optional, maybe even move it to a JIT event listener
108 LoadedObject->registerWithDebugger();
110 // FIXME: Add support for per-module compilation state
114 void *MCJIT::getPointerToBasicBlock(BasicBlock *BB) {
115 report_fatal_error("not yet implemented");
118 void *MCJIT::getPointerToFunction(Function *F) {
119 // FIXME: This should really return a uint64_t since it's a pointer in the
120 // target address space, not our local address space. That's part of the
121 // ExecutionEngine interface, though. Fix that when the old JIT finally
124 // FIXME: Add support for per-module compilation state
128 if (F->isDeclaration() || F->hasAvailableExternallyLinkage()) {
129 bool AbortOnFailure = !F->hasExternalWeakLinkage();
130 void *Addr = getPointerToNamedFunction(F->getName(), AbortOnFailure);
131 addGlobalMapping(F, Addr);
135 // FIXME: Should the Dyld be retaining module information? Probably not.
136 // FIXME: Should we be using the mangler for this? Probably.
138 // This is the accessor for the target address, so make sure to check the
139 // load address of the symbol, not the local address.
140 StringRef BaseName = F->getName();
141 if (BaseName[0] == '\1')
142 return (void*)Dyld.getSymbolLoadAddress(BaseName.substr(1));
143 return (void*)Dyld.getSymbolLoadAddress((TM->getMCAsmInfo()->getGlobalPrefix()
147 void *MCJIT::recompileAndRelinkFunction(Function *F) {
148 report_fatal_error("not yet implemented");
151 void MCJIT::freeMachineCodeForFunction(Function *F) {
152 report_fatal_error("not yet implemented");
155 GenericValue MCJIT::runFunction(Function *F,
156 const std::vector<GenericValue> &ArgValues) {
157 assert(F && "Function *F was null at entry to run()");
159 void *FPtr = getPointerToFunction(F);
160 assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
161 FunctionType *FTy = F->getFunctionType();
162 Type *RetTy = FTy->getReturnType();
164 assert((FTy->getNumParams() == ArgValues.size() ||
165 (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
166 "Wrong number of arguments passed into function!");
167 assert(FTy->getNumParams() == ArgValues.size() &&
168 "This doesn't support passing arguments through varargs (yet)!");
170 // Handle some common cases first. These cases correspond to common `main'
172 if (RetTy->isIntegerTy(32) || RetTy->isVoidTy()) {
173 switch (ArgValues.size()) {
175 if (FTy->getParamType(0)->isIntegerTy(32) &&
176 FTy->getParamType(1)->isPointerTy() &&
177 FTy->getParamType(2)->isPointerTy()) {
178 int (*PF)(int, char **, const char **) =
179 (int(*)(int, char **, const char **))(intptr_t)FPtr;
181 // Call the function.
183 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
184 (char **)GVTOP(ArgValues[1]),
185 (const char **)GVTOP(ArgValues[2])));
190 if (FTy->getParamType(0)->isIntegerTy(32) &&
191 FTy->getParamType(1)->isPointerTy()) {
192 int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
194 // Call the function.
196 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
197 (char **)GVTOP(ArgValues[1])));
202 if (FTy->getNumParams() == 1 &&
203 FTy->getParamType(0)->isIntegerTy(32)) {
205 int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
206 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
213 // Handle cases where no arguments are passed first.
214 if (ArgValues.empty()) {
216 switch (RetTy->getTypeID()) {
217 default: llvm_unreachable("Unknown return type for function call!");
218 case Type::IntegerTyID: {
219 unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
221 rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
222 else if (BitWidth <= 8)
223 rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
224 else if (BitWidth <= 16)
225 rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
226 else if (BitWidth <= 32)
227 rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
228 else if (BitWidth <= 64)
229 rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
231 llvm_unreachable("Integer types > 64 bits not supported");
235 rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
237 case Type::FloatTyID:
238 rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
240 case Type::DoubleTyID:
241 rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
243 case Type::X86_FP80TyID:
244 case Type::FP128TyID:
245 case Type::PPC_FP128TyID:
246 llvm_unreachable("long double not supported yet");
247 case Type::PointerTyID:
248 return PTOGV(((void*(*)())(intptr_t)FPtr)());
252 llvm_unreachable("Full-featured argument passing not supported yet!");
255 void *MCJIT::getPointerToNamedFunction(const std::string &Name,
256 bool AbortOnFailure) {
257 // FIXME: Add support for per-module compilation state
261 if (!isSymbolSearchingDisabled() && MemMgr) {
262 void *ptr = MemMgr->getPointerToNamedFunction(Name, false);
267 /// If a LazyFunctionCreator is installed, use it to get/create the function.
268 if (LazyFunctionCreator)
269 if (void *RP = LazyFunctionCreator(Name))
272 if (AbortOnFailure) {
273 report_fatal_error("Program used external function '"+Name+
274 "' which could not be resolved!");