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/Mangler.h"
22 #include "llvm/IR/Module.h"
23 #include "llvm/MC/MCAsmInfo.h"
24 #include "llvm/Object/Archive.h"
25 #include "llvm/PassManager.h"
26 #include "llvm/Support/DynamicLibrary.h"
27 #include "llvm/Support/ErrorHandling.h"
28 #include "llvm/Support/MemoryBuffer.h"
29 #include "llvm/Support/MutexGuard.h"
30 #include "llvm/Target/TargetLowering.h"
31 #include "llvm/Target/TargetSubtargetInfo.h"
37 static struct RegisterJIT {
38 RegisterJIT() { MCJIT::Register(); }
43 extern "C" void LLVMLinkInMCJIT() {
46 ExecutionEngine *MCJIT::createJIT(Module *M,
47 std::string *ErrorStr,
48 RTDyldMemoryManager *MemMgr,
50 // Try to register the program as a source of symbols to resolve against.
52 // FIXME: Don't do this here.
53 sys::DynamicLibrary::LoadLibraryPermanently(nullptr, nullptr);
55 return new MCJIT(M, TM, MemMgr ? MemMgr : new SectionMemoryManager());
58 MCJIT::MCJIT(Module *m, TargetMachine *tm, RTDyldMemoryManager *MM)
59 : ExecutionEngine(m), TM(tm), Ctx(nullptr), MemMgr(this, MM), Dyld(&MemMgr),
62 OwnedModules.addModule(m);
63 setDataLayout(TM->getSubtargetImpl()->getDataLayout());
67 MutexGuard locked(lock);
68 // FIXME: We are managing our modules, so we do not want the base class
69 // ExecutionEngine to manage them as well. To avoid double destruction
70 // of the first (and only) module added in ExecutionEngine constructor
71 // we remove it from EE and will destruct it ourselves.
73 // It may make sense to move our module manager (based on SmallStPtr) back
74 // into EE if the JIT and Interpreter can live with it.
75 // If so, additional functions: addModule, removeModule, FindFunctionNamed,
76 // runStaticConstructorsDestructors could be moved back to EE as well.
79 Dyld.deregisterEHFrames();
81 LoadedObjectList::iterator it, end;
82 for (it = LoadedObjects.begin(), end = LoadedObjects.end(); it != end; ++it) {
83 ObjectImage *Obj = *it;
85 NotifyFreeingObject(*Obj);
89 LoadedObjects.clear();
96 void MCJIT::addModule(Module *M) {
97 MutexGuard locked(lock);
98 OwnedModules.addModule(M);
101 bool MCJIT::removeModule(Module *M) {
102 MutexGuard locked(lock);
103 return OwnedModules.removeModule(M);
108 void MCJIT::addObjectFile(std::unique_ptr<object::ObjectFile> Obj) {
109 ObjectImage *LoadedObject = Dyld.loadObject(std::move(Obj));
110 if (!LoadedObject || Dyld.hasError())
111 report_fatal_error(Dyld.getErrorString());
113 LoadedObjects.push_back(LoadedObject);
115 NotifyObjectEmitted(*LoadedObject);
118 void MCJIT::addArchive(std::unique_ptr<object::Archive> A) {
119 Archives.push_back(std::move(A));
123 void MCJIT::setObjectCache(ObjectCache* NewCache) {
124 MutexGuard locked(lock);
128 ObjectBufferStream* MCJIT::emitObject(Module *M) {
129 MutexGuard locked(lock);
131 // This must be a module which has already been added but not loaded to this
132 // MCJIT instance, since these conditions are tested by our caller,
133 // generateCodeForModule.
137 M->setDataLayout(TM->getSubtargetImpl()->getDataLayout());
138 PM.add(new DataLayoutPass(M));
140 // The RuntimeDyld will take ownership of this shortly
141 std::unique_ptr<ObjectBufferStream> CompiledObject(new ObjectBufferStream());
143 // Turn the machine code intermediate representation into bytes in memory
144 // that may be executed.
145 if (TM->addPassesToEmitMC(PM, Ctx, CompiledObject->getOStream(),
146 !getVerifyModules())) {
147 report_fatal_error("Target does not support MC emission!");
150 // Initialize passes.
152 // Flush the output buffer to get the generated code into memory
153 CompiledObject->flush();
155 // If we have an object cache, tell it about the new object.
156 // Note that we're using the compiled image, not the loaded image (as below).
158 // MemoryBuffer is a thin wrapper around the actual memory, so it's OK
159 // to create a temporary object here and delete it after the call.
160 std::unique_ptr<MemoryBuffer> MB = CompiledObject->getMemBuffer();
161 ObjCache->notifyObjectCompiled(M, MB.get());
164 return CompiledObject.release();
167 void MCJIT::generateCodeForModule(Module *M) {
168 // Get a thread lock to make sure we aren't trying to load multiple times
169 MutexGuard locked(lock);
171 // This must be a module which has already been added to this MCJIT instance.
172 assert(OwnedModules.ownsModule(M) &&
173 "MCJIT::generateCodeForModule: Unknown module.");
175 // Re-compilation is not supported
176 if (OwnedModules.hasModuleBeenLoaded(M))
179 std::unique_ptr<ObjectBuffer> ObjectToLoad;
180 // Try to load the pre-compiled object from cache if possible
182 std::unique_ptr<MemoryBuffer> PreCompiledObject(ObjCache->getObject(M));
183 if (PreCompiledObject.get())
184 ObjectToLoad.reset(new ObjectBuffer(PreCompiledObject.release()));
187 // If the cache did not contain a suitable object, compile the object
189 ObjectToLoad.reset(emitObject(M));
190 assert(ObjectToLoad.get() && "Compilation did not produce an object.");
193 // Load the object into the dynamic linker.
194 // MCJIT now owns the ObjectImage pointer (via its LoadedObjects list).
195 ObjectImage *LoadedObject = Dyld.loadObject(ObjectToLoad.release());
196 LoadedObjects.push_back(LoadedObject);
198 report_fatal_error(Dyld.getErrorString());
200 // FIXME: Make this optional, maybe even move it to a JIT event listener
201 LoadedObject->registerWithDebugger();
203 NotifyObjectEmitted(*LoadedObject);
205 OwnedModules.markModuleAsLoaded(M);
208 void MCJIT::finalizeLoadedModules() {
209 MutexGuard locked(lock);
211 // Resolve any outstanding relocations.
212 Dyld.resolveRelocations();
214 OwnedModules.markAllLoadedModulesAsFinalized();
216 // Register EH frame data for any module we own which has been loaded
217 Dyld.registerEHFrames();
219 // Set page permissions.
220 MemMgr.finalizeMemory();
223 // FIXME: Rename this.
224 void MCJIT::finalizeObject() {
225 MutexGuard locked(lock);
227 for (ModulePtrSet::iterator I = OwnedModules.begin_added(),
228 E = OwnedModules.end_added();
231 generateCodeForModule(M);
234 finalizeLoadedModules();
237 void MCJIT::finalizeModule(Module *M) {
238 MutexGuard locked(lock);
240 // This must be a module which has already been added to this MCJIT instance.
241 assert(OwnedModules.ownsModule(M) && "MCJIT::finalizeModule: Unknown module.");
243 // If the module hasn't been compiled, just do that.
244 if (!OwnedModules.hasModuleBeenLoaded(M))
245 generateCodeForModule(M);
247 finalizeLoadedModules();
250 void *MCJIT::getPointerToBasicBlock(BasicBlock *BB) {
251 report_fatal_error("not yet implemented");
254 uint64_t MCJIT::getExistingSymbolAddress(const std::string &Name) {
255 Mangler Mang(TM->getSubtargetImpl()->getDataLayout());
256 SmallString<128> FullName;
257 Mang.getNameWithPrefix(FullName, Name);
258 return Dyld.getSymbolLoadAddress(FullName);
261 Module *MCJIT::findModuleForSymbol(const std::string &Name,
262 bool CheckFunctionsOnly) {
263 MutexGuard locked(lock);
265 // If it hasn't already been generated, see if it's in one of our modules.
266 for (ModulePtrSet::iterator I = OwnedModules.begin_added(),
267 E = OwnedModules.end_added();
270 Function *F = M->getFunction(Name);
271 if (F && !F->isDeclaration())
273 if (!CheckFunctionsOnly) {
274 GlobalVariable *G = M->getGlobalVariable(Name);
275 if (G && !G->isDeclaration())
277 // FIXME: Do we need to worry about global aliases?
280 // We didn't find the symbol in any of our modules.
284 uint64_t MCJIT::getSymbolAddress(const std::string &Name,
285 bool CheckFunctionsOnly)
287 MutexGuard locked(lock);
289 // First, check to see if we already have this symbol.
290 uint64_t Addr = getExistingSymbolAddress(Name);
294 for (std::unique_ptr<object::Archive> &A : Archives) {
295 // Look for our symbols in each Archive
296 object::Archive::child_iterator ChildIt = A->findSym(Name);
297 if (ChildIt != A->child_end()) {
298 // FIXME: Support nested archives?
299 ErrorOr<std::unique_ptr<object::Binary>> ChildBinOrErr =
300 ChildIt->getAsBinary();
301 if (ChildBinOrErr.getError())
303 std::unique_ptr<object::Binary> &ChildBin = ChildBinOrErr.get();
304 if (ChildBin->isObject()) {
305 std::unique_ptr<object::ObjectFile> OF(
306 static_cast<object::ObjectFile *>(ChildBin.release()));
307 // This causes the object file to be loaded.
308 addObjectFile(std::move(OF));
309 // The address should be here now.
310 Addr = getExistingSymbolAddress(Name);
317 // If it hasn't already been generated, see if it's in one of our modules.
318 Module *M = findModuleForSymbol(Name, CheckFunctionsOnly);
320 generateCodeForModule(M);
322 // Check the RuntimeDyld table again, it should be there now.
323 return getExistingSymbolAddress(Name);
326 // If a LazyFunctionCreator is installed, use it to get/create the function.
327 // FIXME: Should we instead have a LazySymbolCreator callback?
328 if (LazyFunctionCreator)
329 Addr = (uint64_t)LazyFunctionCreator(Name);
334 uint64_t MCJIT::getGlobalValueAddress(const std::string &Name) {
335 MutexGuard locked(lock);
336 uint64_t Result = getSymbolAddress(Name, false);
338 finalizeLoadedModules();
342 uint64_t MCJIT::getFunctionAddress(const std::string &Name) {
343 MutexGuard locked(lock);
344 uint64_t Result = getSymbolAddress(Name, true);
346 finalizeLoadedModules();
350 // Deprecated. Use getFunctionAddress instead.
351 void *MCJIT::getPointerToFunction(Function *F) {
352 MutexGuard locked(lock);
354 if (F->isDeclaration() || F->hasAvailableExternallyLinkage()) {
355 bool AbortOnFailure = !F->hasExternalWeakLinkage();
356 void *Addr = getPointerToNamedFunction(F->getName(), AbortOnFailure);
357 addGlobalMapping(F, Addr);
361 Module *M = F->getParent();
362 bool HasBeenAddedButNotLoaded = OwnedModules.hasModuleBeenAddedButNotLoaded(M);
364 // Make sure the relevant module has been compiled and loaded.
365 if (HasBeenAddedButNotLoaded)
366 generateCodeForModule(M);
367 else if (!OwnedModules.hasModuleBeenLoaded(M))
368 // If this function doesn't belong to one of our modules, we're done.
371 // FIXME: Should the Dyld be retaining module information? Probably not.
373 // This is the accessor for the target address, so make sure to check the
374 // load address of the symbol, not the local address.
375 Mangler Mang(TM->getSubtargetImpl()->getDataLayout());
376 SmallString<128> Name;
377 TM->getNameWithPrefix(Name, F, Mang);
378 return (void*)Dyld.getSymbolLoadAddress(Name);
381 void *MCJIT::recompileAndRelinkFunction(Function *F) {
382 report_fatal_error("not yet implemented");
385 void MCJIT::freeMachineCodeForFunction(Function *F) {
386 report_fatal_error("not yet implemented");
389 void MCJIT::runStaticConstructorsDestructorsInModulePtrSet(
390 bool isDtors, ModulePtrSet::iterator I, ModulePtrSet::iterator E) {
391 for (; I != E; ++I) {
392 ExecutionEngine::runStaticConstructorsDestructors(*I, isDtors);
396 void MCJIT::runStaticConstructorsDestructors(bool isDtors) {
397 // Execute global ctors/dtors for each module in the program.
398 runStaticConstructorsDestructorsInModulePtrSet(
399 isDtors, OwnedModules.begin_added(), OwnedModules.end_added());
400 runStaticConstructorsDestructorsInModulePtrSet(
401 isDtors, OwnedModules.begin_loaded(), OwnedModules.end_loaded());
402 runStaticConstructorsDestructorsInModulePtrSet(
403 isDtors, OwnedModules.begin_finalized(), OwnedModules.end_finalized());
406 Function *MCJIT::FindFunctionNamedInModulePtrSet(const char *FnName,
407 ModulePtrSet::iterator I,
408 ModulePtrSet::iterator E) {
409 for (; I != E; ++I) {
410 if (Function *F = (*I)->getFunction(FnName))
416 Function *MCJIT::FindFunctionNamed(const char *FnName) {
417 Function *F = FindFunctionNamedInModulePtrSet(
418 FnName, OwnedModules.begin_added(), OwnedModules.end_added());
420 F = FindFunctionNamedInModulePtrSet(FnName, OwnedModules.begin_loaded(),
421 OwnedModules.end_loaded());
423 F = FindFunctionNamedInModulePtrSet(FnName, OwnedModules.begin_finalized(),
424 OwnedModules.end_finalized());
428 GenericValue MCJIT::runFunction(Function *F,
429 const std::vector<GenericValue> &ArgValues) {
430 assert(F && "Function *F was null at entry to run()");
432 void *FPtr = getPointerToFunction(F);
433 assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
434 FunctionType *FTy = F->getFunctionType();
435 Type *RetTy = FTy->getReturnType();
437 assert((FTy->getNumParams() == ArgValues.size() ||
438 (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
439 "Wrong number of arguments passed into function!");
440 assert(FTy->getNumParams() == ArgValues.size() &&
441 "This doesn't support passing arguments through varargs (yet)!");
443 // Handle some common cases first. These cases correspond to common `main'
445 if (RetTy->isIntegerTy(32) || RetTy->isVoidTy()) {
446 switch (ArgValues.size()) {
448 if (FTy->getParamType(0)->isIntegerTy(32) &&
449 FTy->getParamType(1)->isPointerTy() &&
450 FTy->getParamType(2)->isPointerTy()) {
451 int (*PF)(int, char **, const char **) =
452 (int(*)(int, char **, const char **))(intptr_t)FPtr;
454 // Call the function.
456 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
457 (char **)GVTOP(ArgValues[1]),
458 (const char **)GVTOP(ArgValues[2])));
463 if (FTy->getParamType(0)->isIntegerTy(32) &&
464 FTy->getParamType(1)->isPointerTy()) {
465 int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
467 // Call the function.
469 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
470 (char **)GVTOP(ArgValues[1])));
475 if (FTy->getNumParams() == 1 &&
476 FTy->getParamType(0)->isIntegerTy(32)) {
478 int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
479 rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
486 // Handle cases where no arguments are passed first.
487 if (ArgValues.empty()) {
489 switch (RetTy->getTypeID()) {
490 default: llvm_unreachable("Unknown return type for function call!");
491 case Type::IntegerTyID: {
492 unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
494 rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
495 else if (BitWidth <= 8)
496 rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
497 else if (BitWidth <= 16)
498 rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
499 else if (BitWidth <= 32)
500 rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
501 else if (BitWidth <= 64)
502 rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
504 llvm_unreachable("Integer types > 64 bits not supported");
508 rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
510 case Type::FloatTyID:
511 rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
513 case Type::DoubleTyID:
514 rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
516 case Type::X86_FP80TyID:
517 case Type::FP128TyID:
518 case Type::PPC_FP128TyID:
519 llvm_unreachable("long double not supported yet");
520 case Type::PointerTyID:
521 return PTOGV(((void*(*)())(intptr_t)FPtr)());
525 llvm_unreachable("Full-featured argument passing not supported yet!");
528 void *MCJIT::getPointerToNamedFunction(const std::string &Name,
529 bool AbortOnFailure) {
530 if (!isSymbolSearchingDisabled()) {
531 void *ptr = MemMgr.getPointerToNamedFunction(Name, false);
536 /// If a LazyFunctionCreator is installed, use it to get/create the function.
537 if (LazyFunctionCreator)
538 if (void *RP = LazyFunctionCreator(Name))
541 if (AbortOnFailure) {
542 report_fatal_error("Program used external function '"+Name+
543 "' which could not be resolved!");
548 void MCJIT::RegisterJITEventListener(JITEventListener *L) {
551 MutexGuard locked(lock);
552 EventListeners.push_back(L);
554 void MCJIT::UnregisterJITEventListener(JITEventListener *L) {
557 MutexGuard locked(lock);
558 SmallVector<JITEventListener*, 2>::reverse_iterator I=
559 std::find(EventListeners.rbegin(), EventListeners.rend(), L);
560 if (I != EventListeners.rend()) {
561 std::swap(*I, EventListeners.back());
562 EventListeners.pop_back();
565 void MCJIT::NotifyObjectEmitted(const ObjectImage& Obj) {
566 MutexGuard locked(lock);
567 MemMgr.notifyObjectLoaded(this, &Obj);
568 for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
569 EventListeners[I]->NotifyObjectEmitted(Obj);
572 void MCJIT::NotifyFreeingObject(const ObjectImage& Obj) {
573 MutexGuard locked(lock);
574 for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
575 EventListeners[I]->NotifyFreeingObject(Obj);
579 uint64_t LinkingMemoryManager::getSymbolAddress(const std::string &Name) {
580 uint64_t Result = ParentEngine->getSymbolAddress(Name, false);
581 // If the symbols wasn't found and it begins with an underscore, try again
582 // without the underscore.
583 if (!Result && Name[0] == '_')
584 Result = ParentEngine->getSymbolAddress(Name.substr(1), false);
587 if (ParentEngine->isSymbolSearchingDisabled())
589 return ClientMM->getSymbolAddress(Name);