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
  31 using namespace llvm;
  32
  33 namespace {
  34
  35 static struct RegisterJIT {
  36   RegisterJIT() { MCJIT::Register(); }
  37 } JITRegistrator;
  38
  39 }
  40
  41 extern "C" void LLVMLinkInMCJIT() {
  42 }
  43
  44 ExecutionEngine *MCJIT::createJIT(Module *M,
  45                                   std::string *ErrorStr,
  46                                   RTDyldMemoryManager *MemMgr,
  47                                   bool GVsWithCode,
  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(0, NULL);
  53
  54   return new MCJIT(M, TM, MemMgr ? MemMgr : new SectionMemoryManager(),
  55                    GVsWithCode);
  56 }
  57
  58 MCJIT::MCJIT(Module *m, TargetMachine *tm, RTDyldMemoryManager *MM,
  59              bool AllocateGVsWithCode)
  60   : ExecutionEngine(m), TM(tm), Ctx(0), MemMgr(this, MM), Dyld(&MemMgr),
  61     ObjCache(0) {
  62
  63   OwnedModules.addModule(m);
  64   setDataLayout(TM->getDataLayout());
  65 }
  66
  67 MCJIT::~MCJIT() {
  68   MutexGuard locked(lock);
  69   // FIXME: We are managing our modules, so we do not want the base class
  70   // ExecutionEngine to manage them as well. To avoid double destruction
  71   // of the first (and only) module added in ExecutionEngine constructor
  72   // we remove it from EE and will destruct it ourselves.
  73   //
  74   // It may make sense to move our module manager (based on SmallStPtr) back
  75   // into EE if the JIT and Interpreter can live with it.
  76   // If so, additional functions: addModule, removeModule, FindFunctionNamed,
  77   // runStaticConstructorsDestructors could be moved back to EE as well.
  78   //
  79   Modules.clear();
  80   Dyld.deregisterEHFrames();
  81
  82   LoadedObjectList::iterator it, end;
  83   for (it = LoadedObjects.begin(), end = LoadedObjects.end(); it != end; ++it) {
  84     ObjectImage *Obj = *it;
  85     if (Obj) {
  86       NotifyFreeingObject(*Obj);
  87       delete Obj;
  88     }
  89   }
  90   LoadedObjects.clear();
  91
  92
  93   SmallVector<object::Archive *, 2>::iterator ArIt, ArEnd;
  94   for (ArIt = Archives.begin(), ArEnd = Archives.end(); ArIt != ArEnd; ++ArIt) {
  95     object::Archive *A = *ArIt;
  96     delete A;
  97   }
  98   Archives.clear();
  99
 100   delete TM;
 101 }
 102
 103 void MCJIT::addModule(Module *M) {
 104   MutexGuard locked(lock);
 105   OwnedModules.addModule(M);
 106 }
 107
 108 bool MCJIT::removeModule(Module *M) {
 109   MutexGuard locked(lock);
 110   return OwnedModules.removeModule(M);
 111 }
 112
 113
 114
 115 void MCJIT::addObjectFile(object::ObjectFile *Obj) {
 116   ObjectImage *LoadedObject = Dyld.loadObject(Obj);
 117   if (!LoadedObject)
 118     report_fatal_error(Dyld.getErrorString());
 119
 120   LoadedObjects.push_back(LoadedObject);
 121
 122   NotifyObjectEmitted(*LoadedObject);
 123 }
 124
 125 void MCJIT::addArchive(object::Archive *A) {
 126   Archives.push_back(A);
 127 }
 128
 129
 130 void MCJIT::setObjectCache(ObjectCache* NewCache) {
 131   MutexGuard locked(lock);
 132   ObjCache = NewCache;
 133 }
 134
 135 ObjectBufferStream* MCJIT::emitObject(Module *M) {
 136   MutexGuard locked(lock);
 137
 138   // This must be a module which has already been added but not loaded to this
 139   // MCJIT instance, since these conditions are tested by our caller,
 140   // generateCodeForModule.
 141
 142   PassManager PM;
 143
 144   PM.add(new DataLayout(*TM->getDataLayout()));
 145
 146   // The RuntimeDyld will take ownership of this shortly
 147   OwningPtr<ObjectBufferStream> CompiledObject(new ObjectBufferStream());
 148
 149   // Turn the machine code intermediate representation into bytes in memory
 150   // that may be executed.
 151   if (TM->addPassesToEmitMC(PM, Ctx, CompiledObject->getOStream(), false)) {
 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     OwningPtr<MemoryBuffer> MB(CompiledObject->getMemBuffer());
 166     ObjCache->notifyObjectCompiled(M, MB.get());
 167   }
 168
 169   return CompiledObject.take();
 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   OwningPtr<ObjectBuffer> ObjectToLoad;
 185   // Try to load the pre-compiled object from cache if possible
 186   if (0 != ObjCache) {
 187     OwningPtr<MemoryBuffer> PreCompiledObject(ObjCache->getObject(M));
 188     if (0 != PreCompiledObject.get())
 189       ObjectToLoad.reset(new ObjectBuffer(PreCompiledObject.take()));
 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.take());
 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 NULL;
 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       OwningPtr<object::Binary> ChildBin;
 306       // FIXME: Support nested archives?
 307       if (!ChildIt->getAsBinary(ChildBin) && ChildBin->isObject()) {
 308         object::ObjectFile *OF = reinterpret_cast<object::ObjectFile *>(
 309                                                             ChildBin.take());
 310         // This causes the object file to be loaded.
 311         addObjectFile(OF);
 312         // The address should be here now.
 313         Addr = getExistingSymbolAddress(Name);
 314         if (Addr)
 315           return Addr;
 316       }
 317     }
 318   }
 319
 320   // If it hasn't already been generated, see if it's in one of our modules.
 321   Module *M = findModuleForSymbol(Name, CheckFunctionsOnly);
 322   if (!M)
 323     return 0;
 324
 325   generateCodeForModule(M);
 326
 327   // Check the RuntimeDyld table again, it should be there now.
 328   return getExistingSymbolAddress(Name);
 329 }
 330
 331 uint64_t MCJIT::getGlobalValueAddress(const std::string &Name) {
 332   MutexGuard locked(lock);
 333   uint64_t Result = getSymbolAddress(Name, false);
 334   if (Result != 0)
 335     finalizeLoadedModules();
 336   return Result;
 337 }
 338
 339 uint64_t MCJIT::getFunctionAddress(const std::string &Name) {
 340   MutexGuard locked(lock);
 341   uint64_t Result = getSymbolAddress(Name, true);
 342   if (Result != 0)
 343     finalizeLoadedModules();
 344   return Result;
 345 }
 346
 347 // Deprecated.  Use getFunctionAddress instead.
 348 void *MCJIT::getPointerToFunction(Function *F) {
 349   MutexGuard locked(lock);
 350
 351   if (F->isDeclaration() || F->hasAvailableExternallyLinkage()) {
 352     bool AbortOnFailure = !F->hasExternalWeakLinkage();
 353     void *Addr = getPointerToNamedFunction(F->getName(), AbortOnFailure);
 354     addGlobalMapping(F, Addr);
 355     return Addr;
 356   }
 357
 358   Module *M = F->getParent();
 359   bool HasBeenAddedButNotLoaded = OwnedModules.hasModuleBeenAddedButNotLoaded(M);
 360
 361   // Make sure the relevant module has been compiled and loaded.
 362   if (HasBeenAddedButNotLoaded)
 363     generateCodeForModule(M);
 364   else if (!OwnedModules.hasModuleBeenLoaded(M))
 365     // If this function doesn't belong to one of our modules, we're done.
 366     return NULL;
 367
 368   // FIXME: Should the Dyld be retaining module information? Probably not.
 369   //
 370   // This is the accessor for the target address, so make sure to check the
 371   // load address of the symbol, not the local address.
 372   Mangler Mang(TM->getDataLayout());
 373   SmallString<128> Name;
 374   Mang.getNameWithPrefix(Name, F);
 375   return (void*)Dyld.getSymbolLoadAddress(Name);
 376 }
 377
 378 void *MCJIT::recompileAndRelinkFunction(Function *F) {
 379   report_fatal_error("not yet implemented");
 380 }
 381
 382 void MCJIT::freeMachineCodeForFunction(Function *F) {
 383   report_fatal_error("not yet implemented");
 384 }
 385
 386 void MCJIT::runStaticConstructorsDestructorsInModulePtrSet(
 387     bool isDtors, ModulePtrSet::iterator I, ModulePtrSet::iterator E) {
 388   for (; I != E; ++I) {
 389     ExecutionEngine::runStaticConstructorsDestructors(*I, isDtors);
 390   }
 391 }
 392
 393 void MCJIT::runStaticConstructorsDestructors(bool isDtors) {
 394   // Execute global ctors/dtors for each module in the program.
 395   runStaticConstructorsDestructorsInModulePtrSet(
 396       isDtors, OwnedModules.begin_added(), OwnedModules.end_added());
 397   runStaticConstructorsDestructorsInModulePtrSet(
 398       isDtors, OwnedModules.begin_loaded(), OwnedModules.end_loaded());
 399   runStaticConstructorsDestructorsInModulePtrSet(
 400       isDtors, OwnedModules.begin_finalized(), OwnedModules.end_finalized());
 401 }
 402
 403 Function *MCJIT::FindFunctionNamedInModulePtrSet(const char *FnName,
 404                                                  ModulePtrSet::iterator I,
 405                                                  ModulePtrSet::iterator E) {
 406   for (; I != E; ++I) {
 407     if (Function *F = (*I)->getFunction(FnName))
 408       return F;
 409   }
 410   return 0;
 411 }
 412
 413 Function *MCJIT::FindFunctionNamed(const char *FnName) {
 414   Function *F = FindFunctionNamedInModulePtrSet(
 415       FnName, OwnedModules.begin_added(), OwnedModules.end_added());
 416   if (!F)
 417     F = FindFunctionNamedInModulePtrSet(FnName, OwnedModules.begin_loaded(),
 418                                         OwnedModules.end_loaded());
 419   if (!F)
 420     F = FindFunctionNamedInModulePtrSet(FnName, OwnedModules.begin_finalized(),
 421                                         OwnedModules.end_finalized());
 422   return F;
 423 }
 424
 425 GenericValue MCJIT::runFunction(Function *F,
 426                                 const std::vector<GenericValue> &ArgValues) {
 427   assert(F && "Function *F was null at entry to run()");
 428
 429   void *FPtr = getPointerToFunction(F);
 430   assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
 431   FunctionType *FTy = F->getFunctionType();
 432   Type *RetTy = FTy->getReturnType();
 433
 434   assert((FTy->getNumParams() == ArgValues.size() ||
 435           (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
 436          "Wrong number of arguments passed into function!");
 437   assert(FTy->getNumParams() == ArgValues.size() &&
 438          "This doesn't support passing arguments through varargs (yet)!");
 439
 440   // Handle some common cases first.  These cases correspond to common `main'
 441   // prototypes.
 442   if (RetTy->isIntegerTy(32) || RetTy->isVoidTy()) {
 443     switch (ArgValues.size()) {
 444     case 3:
 445       if (FTy->getParamType(0)->isIntegerTy(32) &&
 446           FTy->getParamType(1)->isPointerTy() &&
 447           FTy->getParamType(2)->isPointerTy()) {
 448         int (*PF)(int, char **, const char **) =
 449           (int(*)(int, char **, const char **))(intptr_t)FPtr;
 450
 451         // Call the function.
 452         GenericValue rv;
 453         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
 454                                  (char **)GVTOP(ArgValues[1]),
 455                                  (const char **)GVTOP(ArgValues[2])));
 456         return rv;
 457       }
 458       break;
 459     case 2:
 460       if (FTy->getParamType(0)->isIntegerTy(32) &&
 461           FTy->getParamType(1)->isPointerTy()) {
 462         int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
 463
 464         // Call the function.
 465         GenericValue rv;
 466         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
 467                                  (char **)GVTOP(ArgValues[1])));
 468         return rv;
 469       }
 470       break;
 471     case 1:
 472       if (FTy->getNumParams() == 1 &&
 473           FTy->getParamType(0)->isIntegerTy(32)) {
 474         GenericValue rv;
 475         int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
 476         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
 477         return rv;
 478       }
 479       break;
 480     }
 481   }
 482
 483   // Handle cases where no arguments are passed first.
 484   if (ArgValues.empty()) {
 485     GenericValue rv;
 486     switch (RetTy->getTypeID()) {
 487     default: llvm_unreachable("Unknown return type for function call!");
 488     case Type::IntegerTyID: {
 489       unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
 490       if (BitWidth == 1)
 491         rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
 492       else if (BitWidth <= 8)
 493         rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
 494       else if (BitWidth <= 16)
 495         rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
 496       else if (BitWidth <= 32)
 497         rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
 498       else if (BitWidth <= 64)
 499         rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
 500       else
 501         llvm_unreachable("Integer types > 64 bits not supported");
 502       return rv;
 503     }
 504     case Type::VoidTyID:
 505       rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
 506       return rv;
 507     case Type::FloatTyID:
 508       rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
 509       return rv;
 510     case Type::DoubleTyID:
 511       rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
 512       return rv;
 513     case Type::X86_FP80TyID:
 514     case Type::FP128TyID:
 515     case Type::PPC_FP128TyID:
 516       llvm_unreachable("long double not supported yet");
 517     case Type::PointerTyID:
 518       return PTOGV(((void*(*)())(intptr_t)FPtr)());
 519     }
 520   }
 521
 522   llvm_unreachable("Full-featured argument passing not supported yet!");
 523 }
 524
 525 void *MCJIT::getPointerToNamedFunction(const std::string &Name,
 526                                        bool AbortOnFailure) {
 527   if (!isSymbolSearchingDisabled()) {
 528     void *ptr = MemMgr.getPointerToNamedFunction(Name, false);
 529     if (ptr)
 530       return ptr;
 531   }
 532
 533   /// If a LazyFunctionCreator is installed, use it to get/create the function.
 534   if (LazyFunctionCreator)
 535     if (void *RP = LazyFunctionCreator(Name))
 536       return RP;
 537
 538   if (AbortOnFailure) {
 539     report_fatal_error("Program used external function '"+Name+
 540                        "' which could not be resolved!");
 541   }
 542   return 0;
 543 }
 544
 545 void MCJIT::RegisterJITEventListener(JITEventListener *L) {
 546   if (L == NULL)
 547     return;
 548   MutexGuard locked(lock);
 549   EventListeners.push_back(L);
 550 }
 551 void MCJIT::UnregisterJITEventListener(JITEventListener *L) {
 552   if (L == NULL)
 553     return;
 554   MutexGuard locked(lock);
 555   SmallVector<JITEventListener*, 2>::reverse_iterator I=
 556       std::find(EventListeners.rbegin(), EventListeners.rend(), L);
 557   if (I != EventListeners.rend()) {
 558     std::swap(*I, EventListeners.back());
 559     EventListeners.pop_back();
 560   }
 561 }
 562 void MCJIT::NotifyObjectEmitted(const ObjectImage& Obj) {
 563   MutexGuard locked(lock);
 564   MemMgr.notifyObjectLoaded(this, &Obj);
 565   for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
 566     EventListeners[I]->NotifyObjectEmitted(Obj);
 567   }
 568 }
 569 void MCJIT::NotifyFreeingObject(const ObjectImage& Obj) {
 570   MutexGuard locked(lock);
 571   for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
 572     EventListeners[I]->NotifyFreeingObject(Obj);
 573   }
 574 }
 575
 576 uint64_t LinkingMemoryManager::getSymbolAddress(const std::string &Name) {
 577   uint64_t Result = ParentEngine->getSymbolAddress(Name, false);
 578   // If the symbols wasn't found and it begins with an underscore, try again
 579   // without the underscore.
 580   if (!Result && Name[0] == '_')
 581     Result = ParentEngine->getSymbolAddress(Name.substr(1), false);
 582   if (Result)
 583     return Result;
 584   return ClientMM->getSymbolAddress(Name);
 585 }