lib/ExecutionEngine/MCJIT/MCJIT.cpp

   1 //===-- MCJIT.cpp - MC-based Just-in-Time Compiler ------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "MCJIT.h"
  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"
  32
  33 using namespace llvm;
  34
  35 namespace {
  36
  37 static struct RegisterJIT {
  38   RegisterJIT() { MCJIT::Register(); }
  39 } JITRegistrator;
  40
  41 }
  42
  43 extern "C" void LLVMLinkInMCJIT() {
  44 }
  45
  46 ExecutionEngine *MCJIT::createJIT(Module *M,
  47                                   std::string *ErrorStr,
  48                                   RTDyldMemoryManager *MemMgr,
  49                                   TargetMachine *TM) {
  50   // Try to register the program as a source of symbols to resolve against.
  51   //
  52   // FIXME: Don't do this here.
  53   sys::DynamicLibrary::LoadLibraryPermanently(nullptr, nullptr);
  54
  55   return new MCJIT(M, TM, MemMgr ? MemMgr : new SectionMemoryManager());
  56 }
  57
  58 MCJIT::MCJIT(Module *m, TargetMachine *tm, RTDyldMemoryManager *MM)
  59   : ExecutionEngine(m), TM(tm), Ctx(nullptr), MemMgr(this, MM), Dyld(&MemMgr),
  60     ObjCache(nullptr) {
  61
  62   OwnedModules.addModule(m);
  63   setDataLayout(TM->getSubtargetImpl()->getDataLayout());
  64 }
  65
  66 MCJIT::~MCJIT() {
  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.
  72   //
  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.
  77   //
  78   Modules.clear();
  79   Dyld.deregisterEHFrames();
  80
  81   LoadedObjectList::iterator it, end;
  82   for (it = LoadedObjects.begin(), end = LoadedObjects.end(); it != end; ++it) {
  83     ObjectImage *Obj = *it;
  84     if (Obj) {
  85       NotifyFreeingObject(*Obj);
  86       delete Obj;
  87     }
  88   }
  89   LoadedObjects.clear();
  90
  91   Archives.clear();
  92
  93   delete TM;
  94 }
  95
  96 void MCJIT::addModule(Module *M) {
  97   MutexGuard locked(lock);
  98   OwnedModules.addModule(M);
  99 }
 100
 101 bool MCJIT::removeModule(Module *M) {
 102   MutexGuard locked(lock);
 103   return OwnedModules.removeModule(M);
 104 }
 105
 106
 107
 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());
 112
 113   LoadedObjects.push_back(LoadedObject);
 114
 115   NotifyObjectEmitted(*LoadedObject);
 116 }
 117
 118 void MCJIT::addArchive(std::unique_ptr<object::Archive> A) {
 119   Archives.push_back(std::move(A));
 120 }
 121
 122
 123 void MCJIT::setObjectCache(ObjectCache* NewCache) {
 124   MutexGuard locked(lock);
 125   ObjCache = NewCache;
 126 }
 127
 128 ObjectBufferStream* MCJIT::emitObject(Module *M) {
 129   MutexGuard locked(lock);
 130
 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.
 134
 135   PassManager PM;
 136
 137   M->setDataLayout(TM->getSubtargetImpl()->getDataLayout());
 138   PM.add(new DataLayoutPass(M));
 139
 140   // The RuntimeDyld will take ownership of this shortly
 141   std::unique_ptr<ObjectBufferStream> CompiledObject(new ObjectBufferStream());
 142
 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!");
 148   }
 149
 150   // Initialize passes.
 151   PM.run(*M);
 152   // Flush the output buffer to get the generated code into memory
 153   CompiledObject->flush();
 154
 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).
 157   if (ObjCache) {
 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());
 162   }
 163
 164   return CompiledObject.release();
 165 }
 166
 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);
 170
 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.");
 174
 175   // Re-compilation is not supported
 176   if (OwnedModules.hasModuleBeenLoaded(M))
 177     return;
 178
 179   std::unique_ptr<ObjectBuffer> ObjectToLoad;
 180   // Try to load the pre-compiled object from cache if possible
 181   if (ObjCache) {
 182     std::unique_ptr<MemoryBuffer> PreCompiledObject(ObjCache->getObject(M));
 183     if (PreCompiledObject.get())
 184       ObjectToLoad.reset(new ObjectBuffer(PreCompiledObject.release()));
 185   }
 186
 187   // If the cache did not contain a suitable object, compile the object
 188   if (!ObjectToLoad) {
 189     ObjectToLoad.reset(emitObject(M));
 190     assert(ObjectToLoad.get() && "Compilation did not produce an object.");
 191   }
 192
 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);
 197   if (!LoadedObject)
 198     report_fatal_error(Dyld.getErrorString());
 199
 200   // FIXME: Make this optional, maybe even move it to a JIT event listener
 201   LoadedObject->registerWithDebugger();
 202
 203   NotifyObjectEmitted(*LoadedObject);
 204
 205   OwnedModules.markModuleAsLoaded(M);
 206 }
 207
 208 void MCJIT::finalizeLoadedModules() {
 209   MutexGuard locked(lock);
 210
 211   // Resolve any outstanding relocations.
 212   Dyld.resolveRelocations();
 213
 214   OwnedModules.markAllLoadedModulesAsFinalized();
 215
 216   // Register EH frame data for any module we own which has been loaded
 217   Dyld.registerEHFrames();
 218
 219   // Set page permissions.
 220   MemMgr.finalizeMemory();
 221 }
 222
 223 // FIXME: Rename this.
 224 void MCJIT::finalizeObject() {
 225   MutexGuard locked(lock);
 226
 227   for (ModulePtrSet::iterator I = OwnedModules.begin_added(),
 228                               E = OwnedModules.end_added();
 229        I != E; ++I) {
 230     Module *M = *I;
 231     generateCodeForModule(M);
 232   }
 233
 234   finalizeLoadedModules();
 235 }
 236
 237 void MCJIT::finalizeModule(Module *M) {
 238   MutexGuard locked(lock);
 239
 240   // This must be a module which has already been added to this MCJIT instance.
 241   assert(OwnedModules.ownsModule(M) && "MCJIT::finalizeModule: Unknown module.");
 242
 243   // If the module hasn't been compiled, just do that.
 244   if (!OwnedModules.hasModuleBeenLoaded(M))
 245     generateCodeForModule(M);
 246
 247   finalizeLoadedModules();
 248 }
 249
 250 void *MCJIT::getPointerToBasicBlock(BasicBlock *BB) {
 251   report_fatal_error("not yet implemented");
 252 }
 253
 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);
 259 }
 260
 261 Module *MCJIT::findModuleForSymbol(const std::string &Name,
 262                                    bool CheckFunctionsOnly) {
 263   MutexGuard locked(lock);
 264
 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();
 268        I != E; ++I) {
 269     Module *M = *I;
 270     Function *F = M->getFunction(Name);
 271     if (F && !F->isDeclaration())
 272       return M;
 273     if (!CheckFunctionsOnly) {
 274       GlobalVariable *G = M->getGlobalVariable(Name);
 275       if (G && !G->isDeclaration())
 276         return M;
 277       // FIXME: Do we need to worry about global aliases?
 278     }
 279   }
 280   // We didn't find the symbol in any of our modules.
 281   return nullptr;
 282 }
 283
 284 uint64_t MCJIT::getSymbolAddress(const std::string &Name,
 285                                  bool CheckFunctionsOnly)
 286 {
 287   MutexGuard locked(lock);
 288
 289   // First, check to see if we already have this symbol.
 290   uint64_t Addr = getExistingSymbolAddress(Name);
 291   if (Addr)
 292     return Addr;
 293
 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())
 302         continue;
 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);
 311         if (Addr)
 312           return Addr;
 313       }
 314     }
 315   }
 316
 317   // If it hasn't already been generated, see if it's in one of our modules.
 318   Module *M = findModuleForSymbol(Name, CheckFunctionsOnly);
 319   if (!M)
 320     return 0;
 321
 322   generateCodeForModule(M);
 323
 324   // Check the RuntimeDyld table again, it should be there now.
 325   return getExistingSymbolAddress(Name);
 326 }
 327
 328 uint64_t MCJIT::getGlobalValueAddress(const std::string &Name) {
 329   MutexGuard locked(lock);
 330   uint64_t Result = getSymbolAddress(Name, false);
 331   if (Result != 0)
 332     finalizeLoadedModules();
 333   return Result;
 334 }
 335
 336 uint64_t MCJIT::getFunctionAddress(const std::string &Name) {
 337   MutexGuard locked(lock);
 338   uint64_t Result = getSymbolAddress(Name, true);
 339   if (Result != 0)
 340     finalizeLoadedModules();
 341   return Result;
 342 }
 343
 344 // Deprecated.  Use getFunctionAddress instead.
 345 void *MCJIT::getPointerToFunction(Function *F) {
 346   MutexGuard locked(lock);
 347
 348   if (F->isDeclaration() || F->hasAvailableExternallyLinkage()) {
 349     bool AbortOnFailure = !F->hasExternalWeakLinkage();
 350     void *Addr = getPointerToNamedFunction(F->getName(), AbortOnFailure);
 351     addGlobalMapping(F, Addr);
 352     return Addr;
 353   }
 354
 355   Module *M = F->getParent();
 356   bool HasBeenAddedButNotLoaded = OwnedModules.hasModuleBeenAddedButNotLoaded(M);
 357
 358   // Make sure the relevant module has been compiled and loaded.
 359   if (HasBeenAddedButNotLoaded)
 360     generateCodeForModule(M);
 361   else if (!OwnedModules.hasModuleBeenLoaded(M))
 362     // If this function doesn't belong to one of our modules, we're done.
 363     return nullptr;
 364
 365   // FIXME: Should the Dyld be retaining module information? Probably not.
 366   //
 367   // This is the accessor for the target address, so make sure to check the
 368   // load address of the symbol, not the local address.
 369   Mangler Mang(TM->getSubtargetImpl()->getDataLayout());
 370   SmallString<128> Name;
 371   TM->getNameWithPrefix(Name, F, Mang);
 372   return (void*)Dyld.getSymbolLoadAddress(Name);
 373 }
 374
 375 void *MCJIT::recompileAndRelinkFunction(Function *F) {
 376   report_fatal_error("not yet implemented");
 377 }
 378
 379 void MCJIT::freeMachineCodeForFunction(Function *F) {
 380   report_fatal_error("not yet implemented");
 381 }
 382
 383 void MCJIT::runStaticConstructorsDestructorsInModulePtrSet(
 384     bool isDtors, ModulePtrSet::iterator I, ModulePtrSet::iterator E) {
 385   for (; I != E; ++I) {
 386     ExecutionEngine::runStaticConstructorsDestructors(*I, isDtors);
 387   }
 388 }
 389
 390 void MCJIT::runStaticConstructorsDestructors(bool isDtors) {
 391   // Execute global ctors/dtors for each module in the program.
 392   runStaticConstructorsDestructorsInModulePtrSet(
 393       isDtors, OwnedModules.begin_added(), OwnedModules.end_added());
 394   runStaticConstructorsDestructorsInModulePtrSet(
 395       isDtors, OwnedModules.begin_loaded(), OwnedModules.end_loaded());
 396   runStaticConstructorsDestructorsInModulePtrSet(
 397       isDtors, OwnedModules.begin_finalized(), OwnedModules.end_finalized());
 398 }
 399
 400 Function *MCJIT::FindFunctionNamedInModulePtrSet(const char *FnName,
 401                                                  ModulePtrSet::iterator I,
 402                                                  ModulePtrSet::iterator E) {
 403   for (; I != E; ++I) {
 404     if (Function *F = (*I)->getFunction(FnName))
 405       return F;
 406   }
 407   return nullptr;
 408 }
 409
 410 Function *MCJIT::FindFunctionNamed(const char *FnName) {
 411   Function *F = FindFunctionNamedInModulePtrSet(
 412       FnName, OwnedModules.begin_added(), OwnedModules.end_added());
 413   if (!F)
 414     F = FindFunctionNamedInModulePtrSet(FnName, OwnedModules.begin_loaded(),
 415                                         OwnedModules.end_loaded());
 416   if (!F)
 417     F = FindFunctionNamedInModulePtrSet(FnName, OwnedModules.begin_finalized(),
 418                                         OwnedModules.end_finalized());
 419   return F;
 420 }
 421
 422 GenericValue MCJIT::runFunction(Function *F,
 423                                 const std::vector<GenericValue> &ArgValues) {
 424   assert(F && "Function *F was null at entry to run()");
 425
 426   void *FPtr = getPointerToFunction(F);
 427   assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
 428   FunctionType *FTy = F->getFunctionType();
 429   Type *RetTy = FTy->getReturnType();
 430
 431   assert((FTy->getNumParams() == ArgValues.size() ||
 432           (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
 433          "Wrong number of arguments passed into function!");
 434   assert(FTy->getNumParams() == ArgValues.size() &&
 435          "This doesn't support passing arguments through varargs (yet)!");
 436
 437   // Handle some common cases first.  These cases correspond to common `main'
 438   // prototypes.
 439   if (RetTy->isIntegerTy(32) || RetTy->isVoidTy()) {
 440     switch (ArgValues.size()) {
 441     case 3:
 442       if (FTy->getParamType(0)->isIntegerTy(32) &&
 443           FTy->getParamType(1)->isPointerTy() &&
 444           FTy->getParamType(2)->isPointerTy()) {
 445         int (*PF)(int, char **, const char **) =
 446           (int(*)(int, char **, const char **))(intptr_t)FPtr;
 447
 448         // Call the function.
 449         GenericValue rv;
 450         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
 451                                  (char **)GVTOP(ArgValues[1]),
 452                                  (const char **)GVTOP(ArgValues[2])));
 453         return rv;
 454       }
 455       break;
 456     case 2:
 457       if (FTy->getParamType(0)->isIntegerTy(32) &&
 458           FTy->getParamType(1)->isPointerTy()) {
 459         int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
 460
 461         // Call the function.
 462         GenericValue rv;
 463         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
 464                                  (char **)GVTOP(ArgValues[1])));
 465         return rv;
 466       }
 467       break;
 468     case 1:
 469       if (FTy->getNumParams() == 1 &&
 470           FTy->getParamType(0)->isIntegerTy(32)) {
 471         GenericValue rv;
 472         int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
 473         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
 474         return rv;
 475       }
 476       break;
 477     }
 478   }
 479
 480   // Handle cases where no arguments are passed first.
 481   if (ArgValues.empty()) {
 482     GenericValue rv;
 483     switch (RetTy->getTypeID()) {
 484     default: llvm_unreachable("Unknown return type for function call!");
 485     case Type::IntegerTyID: {
 486       unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
 487       if (BitWidth == 1)
 488         rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
 489       else if (BitWidth <= 8)
 490         rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
 491       else if (BitWidth <= 16)
 492         rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
 493       else if (BitWidth <= 32)
 494         rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
 495       else if (BitWidth <= 64)
 496         rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
 497       else
 498         llvm_unreachable("Integer types > 64 bits not supported");
 499       return rv;
 500     }
 501     case Type::VoidTyID:
 502       rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
 503       return rv;
 504     case Type::FloatTyID:
 505       rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
 506       return rv;
 507     case Type::DoubleTyID:
 508       rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
 509       return rv;
 510     case Type::X86_FP80TyID:
 511     case Type::FP128TyID:
 512     case Type::PPC_FP128TyID:
 513       llvm_unreachable("long double not supported yet");
 514     case Type::PointerTyID:
 515       return PTOGV(((void*(*)())(intptr_t)FPtr)());
 516     }
 517   }
 518
 519   llvm_unreachable("Full-featured argument passing not supported yet!");
 520 }
 521
 522 void *MCJIT::getPointerToNamedFunction(const std::string &Name,
 523                                        bool AbortOnFailure) {
 524   if (!isSymbolSearchingDisabled()) {
 525     void *ptr = MemMgr.getPointerToNamedFunction(Name, false);
 526     if (ptr)
 527       return ptr;
 528   }
 529
 530   /// If a LazyFunctionCreator is installed, use it to get/create the function.
 531   if (LazyFunctionCreator)
 532     if (void *RP = LazyFunctionCreator(Name))
 533       return RP;
 534
 535   if (AbortOnFailure) {
 536     report_fatal_error("Program used external function '"+Name+
 537                        "' which could not be resolved!");
 538   }
 539   return nullptr;
 540 }
 541
 542 void MCJIT::RegisterJITEventListener(JITEventListener *L) {
 543   if (!L)
 544     return;
 545   MutexGuard locked(lock);
 546   EventListeners.push_back(L);
 547 }
 548 void MCJIT::UnregisterJITEventListener(JITEventListener *L) {
 549   if (!L)
 550     return;
 551   MutexGuard locked(lock);
 552   SmallVector<JITEventListener*, 2>::reverse_iterator I=
 553       std::find(EventListeners.rbegin(), EventListeners.rend(), L);
 554   if (I != EventListeners.rend()) {
 555     std::swap(*I, EventListeners.back());
 556     EventListeners.pop_back();
 557   }
 558 }
 559 void MCJIT::NotifyObjectEmitted(const ObjectImage& Obj) {
 560   MutexGuard locked(lock);
 561   MemMgr.notifyObjectLoaded(this, &Obj);
 562   for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
 563     EventListeners[I]->NotifyObjectEmitted(Obj);
 564   }
 565 }
 566 void MCJIT::NotifyFreeingObject(const ObjectImage& Obj) {
 567   MutexGuard locked(lock);
 568   for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
 569     EventListeners[I]->NotifyFreeingObject(Obj);
 570   }
 571 }
 572
 573 uint64_t LinkingMemoryManager::getSymbolAddress(const std::string &Name) {
 574   uint64_t Result = ParentEngine->getSymbolAddress(Name, false);
 575   // If the symbols wasn't found and it begins with an underscore, try again
 576   // without the underscore.
 577   if (!Result && Name[0] == '_')
 578     Result = ParentEngine->getSymbolAddress(Name.substr(1), false);
 579   if (Result)
 580     return Result;
 581   return ClientMM->getSymbolAddress(Name);
 582 }