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