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/ExecutionEngine/GenericValue.h"
12 #include "llvm/ExecutionEngine/JITEventListener.h"
13 #include "llvm/ExecutionEngine/JITMemoryManager.h"
14 #include "llvm/ExecutionEngine/MCJIT.h"
15 #include "llvm/ExecutionEngine/ObjectBuffer.h"
16 #include "llvm/ExecutionEngine/ObjectImage.h"
17 #include "llvm/ExecutionEngine/SectionMemoryManager.h"
18 #include "llvm/IR/DataLayout.h"
19 #include "llvm/IR/DerivedTypes.h"
20 #include "llvm/IR/Function.h"
21 #include "llvm/IR/Module.h"
22 #include "llvm/MC/MCAsmInfo.h"
23 #include "llvm/Support/DynamicLibrary.h"
24 #include "llvm/Support/ErrorHandling.h"
25 #include "llvm/Support/MemoryBuffer.h"
26 #include "llvm/Support/MutexGuard.h"
32 static struct RegisterJIT {
33 RegisterJIT() { MCJIT::Register(); }
38 extern "C" void LLVMLinkInMCJIT() {
41 ExecutionEngine *MCJIT::createJIT(Module *M,
42 std::string *ErrorStr,
43 RTDyldMemoryManager *MemMgr,
46 // Try to register the program as a source of symbols to resolve against.
48 // FIXME: Don't do this here.
49 sys::DynamicLibrary::LoadLibraryPermanently(0, NULL);
51 return new MCJIT(M, TM, MemMgr ? MemMgr : new SectionMemoryManager(),
55 MCJIT::MCJIT(Module *m, TargetMachine *tm, RTDyldMemoryManager *MM,
56 bool AllocateGVsWithCode)
57 : ExecutionEngine(m), TM(tm), Ctx(0), MemMgr(this, MM), Dyld(&MemMgr),
60 ModuleStates[m] = ModuleAdded;
61 setDataLayout(TM->getDataLayout());
65 LoadedObjectMap::iterator it, end = LoadedObjects.end();
66 for (it = LoadedObjects.begin(); it != end; ++it) {
67 ObjectImage *Obj = it->second;
69 NotifyFreeingObject(*Obj);
73 LoadedObjects.clear();
77 void MCJIT::addModule(Module *M) {
79 ModuleStates[M] = MCJITModuleState();
82 void MCJIT::setObjectCache(ObjectCache* NewCache) {
86 ObjectBufferStream* MCJIT::emitObject(Module *M) {
87 // This must be a module which has already been added to this MCJIT instance.
88 assert(std::find(Modules.begin(), Modules.end(), M) != Modules.end());
89 assert(ModuleStates.find(M) != ModuleStates.end());
91 // Get a thread lock to make sure we aren't trying to compile multiple times
92 MutexGuard locked(lock);
94 // Re-compilation is not supported
95 assert(!ModuleStates[M].hasBeenEmitted());
99 PM.add(new DataLayout(*TM->getDataLayout()));
101 // The RuntimeDyld will take ownership of this shortly
102 OwningPtr<ObjectBufferStream> CompiledObject(new ObjectBufferStream());
104 // Turn the machine code intermediate representation into bytes in memory
105 // that may be executed.
106 if (TM->addPassesToEmitMC(PM, Ctx, CompiledObject->getOStream(), false)) {
107 report_fatal_error("Target does not support MC emission!");
110 // Initialize passes.
112 // Flush the output buffer to get the generated code into memory
113 CompiledObject->flush();
115 // If we have an object cache, tell it about the new object.
116 // Note that we're using the compiled image, not the loaded image (as below).
118 // MemoryBuffer is a thin wrapper around the actual memory, so it's OK
119 // to create a temporary object here and delete it after the call.
120 OwningPtr<MemoryBuffer> MB(CompiledObject->getMemBuffer());
121 ObjCache->notifyObjectCompiled(M, MB.get());
124 return CompiledObject.take();
127 void MCJIT::generateCodeForModule(Module *M) {
128 // This must be a module which has already been added to this MCJIT instance.
129 assert(std::find(Modules.begin(), Modules.end(), M) != Modules.end());
130 assert(ModuleStates.find(M) != ModuleStates.end());
132 // Get a thread lock to make sure we aren't trying to load multiple times
133 MutexGuard locked(lock);
135 // Re-compilation is not supported
136 if (ModuleStates[M].hasBeenLoaded())
139 OwningPtr<ObjectBuffer> ObjectToLoad;
140 // Try to load the pre-compiled object from cache if possible
142 OwningPtr<MemoryBuffer> PreCompiledObject(ObjCache->getObject(M));
143 if (0 != PreCompiledObject.get())
144 ObjectToLoad.reset(new ObjectBuffer(PreCompiledObject.take()));
147 // If the cache did not contain a suitable object, compile the object
149 ObjectToLoad.reset(emitObject(M));
150 assert(ObjectToLoad.get() && "Compilation did not produce an object.");
153 // Load the object into the dynamic linker.
154 // MCJIT now owns the ObjectImage pointer (via its LoadedObjects map).
155 ObjectImage *LoadedObject = Dyld.loadObject(ObjectToLoad.take());
156 LoadedObjects[M] = LoadedObject;
158 report_fatal_error(Dyld.getErrorString());
160 // FIXME: Make this optional, maybe even move it to a JIT event listener
161 LoadedObject->registerWithDebugger();
163 NotifyObjectEmitted(*LoadedObject);
165 ModuleStates[M] = ModuleLoaded;
168 void MCJIT::finalizeLoadedModules() {
169 // Resolve any outstanding relocations.
170 Dyld.resolveRelocations();
172 // Register EH frame data for any module we own which has been loaded
173 SmallVector<Module *, 1>::iterator end = Modules.end();
174 SmallVector<Module *, 1>::iterator it;
175 for (it = Modules.begin(); it != end; ++it) {
177 assert(ModuleStates.find(M) != ModuleStates.end());
179 if (ModuleStates[M].hasBeenLoaded() &&
180 !ModuleStates[M].hasBeenFinalized()) {
181 // FIXME: This should be module specific!
182 StringRef EHData = Dyld.getEHFrameSection();
184 MemMgr.registerEHFrames(EHData);
185 ModuleStates[M] = ModuleFinalized;
189 // Set page permissions.
190 MemMgr.finalizeMemory();
193 // FIXME: Rename this.
194 void MCJIT::finalizeObject() {
195 // FIXME: This is a temporary hack to get around problems with calling
196 // finalize multiple times.
197 bool finalizeNeeded = false;
198 SmallVector<Module *, 1>::iterator end = Modules.end();
199 SmallVector<Module *, 1>::iterator it;
200 for (it = Modules.begin(); it != end; ++it) {
202 assert(ModuleStates.find(M) != ModuleStates.end());
203 if (!ModuleStates[M].hasBeenFinalized())
204 finalizeNeeded = true;
206 // I don't really like this, but the C API depends on this behavior.
207 // I suppose it's OK for a deprecated function.
208 if (!ModuleStates[M].hasBeenLoaded())
209 generateCodeForModule(M);
214 // Resolve any outstanding relocations.
215 Dyld.resolveRelocations();
217 // Register EH frame data for any module we own which has been loaded
218 for (it = Modules.begin(); it != end; ++it) {
220 assert(ModuleStates.find(M) != ModuleStates.end());
222 if (ModuleStates[M].hasBeenLoaded() &&
223 !ModuleStates[M].hasBeenFinalized()) {
224 // FIXME: This should be module specific!
225 StringRef EHData = Dyld.getEHFrameSection();
227 MemMgr.registerEHFrames(EHData);
228 ModuleStates[M] = ModuleFinalized;
232 // Set page permissions.
233 MemMgr.finalizeMemory();
236 void MCJIT::finalizeModule(Module *M) {
237 // This must be a module which has already been added to this MCJIT instance.
238 assert(std::find(Modules.begin(), Modules.end(), M) != Modules.end());
239 assert(ModuleStates.find(M) != ModuleStates.end());
241 if (ModuleStates[M].hasBeenFinalized())
244 // If the module hasn't been compiled, just do that.
245 if (!ModuleStates[M].hasBeenLoaded())
246 generateCodeForModule(M);
248 // Resolve any outstanding relocations.
249 Dyld.resolveRelocations();
251 // FIXME: Should this be module specific?
252 StringRef EHData = Dyld.getEHFrameSection();
254 MemMgr.registerEHFrames(EHData);
256 // Set page permissions.
257 MemMgr.finalizeMemory();
259 ModuleStates[M] = ModuleFinalized;
262 void *MCJIT::getPointerToBasicBlock(BasicBlock *BB) {
263 report_fatal_error("not yet implemented");
266 uint64_t MCJIT::getExistingSymbolAddress(const std::string &Name) {
267 // Check with the RuntimeDyld to see if we already have this symbol.
269 return Dyld.getSymbolLoadAddress(Name.substr(1));
270 return Dyld.getSymbolLoadAddress((TM->getMCAsmInfo()->getGlobalPrefix()
274 Module *MCJIT::findModuleForSymbol(const std::string &Name,
275 bool CheckFunctionsOnly) {
276 // If it hasn't already been generated, see if it's in one of our modules.
277 SmallVector<Module *, 1>::iterator end = Modules.end();
278 SmallVector<Module *, 1>::iterator it;
279 for (it = Modules.begin(); it != end; ++it) {
281 Function *F = M->getFunction(Name);
282 if (F && !F->empty())
284 if (!CheckFunctionsOnly) {
285 GlobalVariable *G = M->getGlobalVariable(Name);
288 // FIXME: Do we need to worry about global aliases?
291 // We didn't find the symbol in any of our modules.
295 uint64_t MCJIT::getSymbolAddress(const std::string &Name,
296 bool CheckFunctionsOnly)
298 // First, check to see if we already have this symbol.
299 uint64_t Addr = getExistingSymbolAddress(Name);
303 // If it hasn't already been generated, see if it's in one of our modules.
304 Module *M = findModuleForSymbol(Name, CheckFunctionsOnly);
308 // If this is in one of our modules, generate code for that module.
309 assert(ModuleStates.find(M) != ModuleStates.end());
310 // If the module code has already been generated, we won't find the symbol.
311 if (ModuleStates[M].hasBeenLoaded())
314 // FIXME: We probably need to make sure we aren't in the process of
315 // loading or finalizing this module.
316 generateCodeForModule(M);
318 // Check the RuntimeDyld table again, it should be there now.
319 return getExistingSymbolAddress(Name);
322 uint64_t MCJIT::getGlobalValueAddress(const std::string &Name) {
323 uint64_t Result = getSymbolAddress(Name, false);
325 finalizeLoadedModules();
329 uint64_t MCJIT::getFunctionAddress(const std::string &Name) {
330 uint64_t Result = getSymbolAddress(Name, true);
332 finalizeLoadedModules();
336 // Deprecated. Use getFunctionAddress instead.
337 void *MCJIT::getPointerToFunction(Function *F) {
339 if (F->isDeclaration() || F->hasAvailableExternallyLinkage()) {
340 bool AbortOnFailure = !F->hasExternalWeakLinkage();
341 void *Addr = getPointerToNamedFunction(F->getName(), AbortOnFailure);
342 addGlobalMapping(F, Addr);
346 // If this function doesn't belong to one of our modules, we're done.
347 Module *M = F->getParent();
348 if (std::find(Modules.begin(), Modules.end(), M) == Modules.end())
351 assert(ModuleStates.find(M) != ModuleStates.end());
353 // Make sure the relevant module has been compiled and loaded.
354 if (!ModuleStates[M].hasBeenLoaded())
355 generateCodeForModule(M);
357 // FIXME: Should the Dyld be retaining module information? Probably not.
358 // FIXME: Should we be using the mangler for this? Probably.
360 // This is the accessor for the target address, so make sure to check the
361 // load address of the symbol, not the local address.
362 StringRef BaseName = F->getName();
363 if (BaseName[0] == '\1')
364 return (void*)Dyld.getSymbolLoadAddress(BaseName.substr(1));
365 return (void*)Dyld.getSymbolLoadAddress((TM->getMCAsmInfo()->getGlobalPrefix()
369 void *MCJIT::recompileAndRelinkFunction(Function *F) {
370 report_fatal_error("not yet implemented");
373 void MCJIT::freeMachineCodeForFunction(Function *F) {
374 report_fatal_error("not yet implemented");
377 GenericValue MCJIT::runFunction(Function *F,
378 const std::vector<GenericValue> &ArgValues) {
379 assert(F && "Function *F was null at entry to run()");
381 void *FPtr = getPointerToFunction(F);
382 assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
383 FunctionType *FTy = F->getFunctionType();
384 Type *RetTy = FTy->getReturnType();
386 assert((FTy->getNumParams() == ArgValues.size() ||
387 (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
388 "Wrong number of arguments passed into function!");
389 assert(FTy->getNumParams() == ArgValues.size() &&
390 "This doesn't support passing arguments through varargs (yet)!");
392 // Handle some common cases first. These cases correspond to common `main'
394 if (RetTy->isIntegerTy(32) || RetTy->isVoidTy()) {
395 switch (ArgValues.size()) {
397 if (FTy->getParamType(0)->isIntegerTy(32) &&
398 FTy->getParamType(1)->isPointerTy() &&
399 FTy->getParamType(2)->isPointerTy()) {
400 int (*PF)(int, char **, const char **) =
401 (int(*)(int, char **, const char **))(intptr_t)FPtr;
403 // Call the function.
405 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
406 (char **)GVTOP(ArgValues[1]),
407 (const char **)GVTOP(ArgValues[2])));
412 if (FTy->getParamType(0)->isIntegerTy(32) &&
413 FTy->getParamType(1)->isPointerTy()) {
414 int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
416 // Call the function.
418 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
419 (char **)GVTOP(ArgValues[1])));
424 if (FTy->getNumParams() == 1 &&
425 FTy->getParamType(0)->isIntegerTy(32)) {
427 int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
428 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
435 // Handle cases where no arguments are passed first.
436 if (ArgValues.empty()) {
438 switch (RetTy->getTypeID()) {
439 default: llvm_unreachable("Unknown return type for function call!");
440 case Type::IntegerTyID: {
441 unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
443 rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
444 else if (BitWidth <= 8)
445 rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
446 else if (BitWidth <= 16)
447 rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
448 else if (BitWidth <= 32)
449 rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
450 else if (BitWidth <= 64)
451 rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
453 llvm_unreachable("Integer types > 64 bits not supported");
457 rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
459 case Type::FloatTyID:
460 rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
462 case Type::DoubleTyID:
463 rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
465 case Type::X86_FP80TyID:
466 case Type::FP128TyID:
467 case Type::PPC_FP128TyID:
468 llvm_unreachable("long double not supported yet");
469 case Type::PointerTyID:
470 return PTOGV(((void*(*)())(intptr_t)FPtr)());
474 llvm_unreachable("Full-featured argument passing not supported yet!");
477 void *MCJIT::getPointerToNamedFunction(const std::string &Name,
478 bool AbortOnFailure) {
479 if (!isSymbolSearchingDisabled()) {
480 void *ptr = MemMgr.getPointerToNamedFunction(Name, false);
485 /// If a LazyFunctionCreator is installed, use it to get/create the function.
486 if (LazyFunctionCreator)
487 if (void *RP = LazyFunctionCreator(Name))
490 if (AbortOnFailure) {
491 report_fatal_error("Program used external function '"+Name+
492 "' which could not be resolved!");
497 void MCJIT::RegisterJITEventListener(JITEventListener *L) {
500 MutexGuard locked(lock);
501 EventListeners.push_back(L);
503 void MCJIT::UnregisterJITEventListener(JITEventListener *L) {
506 MutexGuard locked(lock);
507 SmallVector<JITEventListener*, 2>::reverse_iterator I=
508 std::find(EventListeners.rbegin(), EventListeners.rend(), L);
509 if (I != EventListeners.rend()) {
510 std::swap(*I, EventListeners.back());
511 EventListeners.pop_back();
514 void MCJIT::NotifyObjectEmitted(const ObjectImage& Obj) {
515 MutexGuard locked(lock);
516 MemMgr.notifyObjectLoaded(this, &Obj);
517 for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
518 EventListeners[I]->NotifyObjectEmitted(Obj);
521 void MCJIT::NotifyFreeingObject(const ObjectImage& Obj) {
522 MutexGuard locked(lock);
523 for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
524 EventListeners[I]->NotifyFreeingObject(Obj);
528 uint64_t LinkingMemoryManager::getSymbolAddress(const std::string &Name) {
529 uint64_t Result = ParentEngine->getSymbolAddress(Name, false);
530 // If the symbols wasn't found and it begins with an underscore, try again
531 // without the underscore.
532 if (!Result && Name[0] == '_')
533 Result = ParentEngine->getSymbolAddress(Name.substr(1), false);
536 return ClientMM->getSymbolAddress(Name);