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/MC/MCAsmInfo.h"
  22 #include "llvm/Support/DynamicLibrary.h"
  23 #include "llvm/Support/ErrorHandling.h"
  24 #include "llvm/Support/MemoryBuffer.h"
  25 #include "llvm/Support/MutexGuard.h"
  26
  27 using namespace llvm;
  28
  29 namespace {
  30
  31 static struct RegisterJIT {
  32   RegisterJIT() { MCJIT::Register(); }
  33 } JITRegistrator;
  34
  35 }
  36
  37 extern "C" void LLVMLinkInMCJIT() {
  38 }
  39
  40 ExecutionEngine *MCJIT::createJIT(Module *M,
  41                                   std::string *ErrorStr,
  42                                   JITMemoryManager *JMM,
  43                                   bool GVsWithCode,
  44                                   TargetMachine *TM) {
  45   // Try to register the program as a source of symbols to resolve against.
  46   //
  47   // FIXME: Don't do this here.
  48   sys::DynamicLibrary::LoadLibraryPermanently(0, NULL);
  49
  50   return new MCJIT(M, TM, JMM ? JMM : new SectionMemoryManager(), GVsWithCode);
  51 }
  52
  53 MCJIT::MCJIT(Module *m, TargetMachine *tm, RTDyldMemoryManager *MM,
  54              bool AllocateGVsWithCode)
  55   : ExecutionEngine(m), TM(tm), Ctx(0),
  56     MemMgr(MM ? MM : new SectionMemoryManager()), Dyld(MemMgr),
  57     IsLoaded(false), M(m), ObjCache(0)  {
  58
  59   setDataLayout(TM->getDataLayout());
  60 }
  61
  62 MCJIT::~MCJIT() {
  63   if (LoadedObject)
  64     NotifyFreeingObject(*LoadedObject.get());
  65   delete MemMgr;
  66   delete TM;
  67 }
  68
  69 void MCJIT::setObjectCache(ObjectCache* NewCache) {
  70   ObjCache = NewCache;
  71 }
  72
  73 ObjectBufferStream* MCJIT::emitObject(Module *m) {
  74   /// Currently, MCJIT only supports a single module and the module passed to
  75   /// this function call is expected to be the contained module.  The module
  76   /// is passed as a parameter here to prepare for multiple module support in
  77   /// the future.
  78   assert(M == m);
  79
  80   // Get a thread lock to make sure we aren't trying to compile multiple times
  81   MutexGuard locked(lock);
  82
  83   // FIXME: Track compilation state on a per-module basis when multiple modules
  84   //        are supported.
  85   // Re-compilation is not supported
  86   assert(!IsLoaded);
  87
  88   PassManager PM;
  89
  90   PM.add(new DataLayout(*TM->getDataLayout()));
  91
  92   // The RuntimeDyld will take ownership of this shortly
  93   OwningPtr<ObjectBufferStream> CompiledObject(new ObjectBufferStream());
  94
  95   // Turn the machine code intermediate representation into bytes in memory
  96   // that may be executed.
  97   if (TM->addPassesToEmitMC(PM, Ctx, CompiledObject->getOStream(), false)) {
  98     report_fatal_error("Target does not support MC emission!");
  99   }
 100
 101   // Initialize passes.
 102   PM.run(*m);
 103   // Flush the output buffer to get the generated code into memory
 104   CompiledObject->flush();
 105
 106   // If we have an object cache, tell it about the new object.
 107   // Note that we're using the compiled image, not the loaded image (as below).
 108   if (ObjCache) {
 109     // MemoryBuffer is a thin wrapper around the actual memory, so it's OK
 110     // to create a temporary object here and delete it after the call.
 111     OwningPtr<MemoryBuffer> MB(CompiledObject->getMemBuffer());
 112     ObjCache->notifyObjectCompiled(m, MB.get());
 113   }
 114
 115   return CompiledObject.take();
 116 }
 117
 118 void MCJIT::loadObject(Module *M) {
 119
 120   // Get a thread lock to make sure we aren't trying to load multiple times
 121   MutexGuard locked(lock);
 122
 123   // FIXME: Track compilation state on a per-module basis when multiple modules
 124   //        are supported.
 125   // Re-compilation is not supported
 126   if (IsLoaded)
 127     return;
 128
 129   OwningPtr<ObjectBuffer> ObjectToLoad;
 130   // Try to load the pre-compiled object from cache if possible
 131   if (0 != ObjCache) {
 132     OwningPtr<MemoryBuffer> PreCompiledObject(ObjCache->getObjectCopy(M));
 133     if (0 != PreCompiledObject.get())
 134       ObjectToLoad.reset(new ObjectBuffer(PreCompiledObject.take()));
 135   }
 136
 137   // If the cache did not contain a suitable object, compile the object
 138   if (!ObjectToLoad) {
 139     ObjectToLoad.reset(emitObject(M));
 140     assert(ObjectToLoad.get() && "Compilation did not produce an object.");
 141   }
 142
 143   // Load the object into the dynamic linker.
 144   // handing off ownership of the buffer
 145   LoadedObject.reset(Dyld.loadObject(ObjectToLoad.take()));
 146   if (!LoadedObject)
 147     report_fatal_error(Dyld.getErrorString());
 148
 149   // Resolve any relocations.
 150   Dyld.resolveRelocations();
 151
 152   // FIXME: Make this optional, maybe even move it to a JIT event listener
 153   LoadedObject->registerWithDebugger();
 154
 155   NotifyObjectEmitted(*LoadedObject);
 156
 157   // FIXME: Add support for per-module compilation state
 158   IsLoaded = true;
 159 }
 160
 161 // FIXME: Add a parameter to identify which object is being finalized when
 162 // MCJIT supports multiple modules.
 163 // FIXME: Provide a way to separate code emission, relocations and page
 164 // protection in the interface.
 165 void MCJIT::finalizeObject() {
 166   // If the module hasn't been compiled, just do that.
 167   if (!IsLoaded) {
 168     // If the call to Dyld.resolveRelocations() is removed from loadObject()
 169     // we'll need to do that here.
 170     loadObject(M);
 171
 172     // Set page permissions.
 173     MemMgr->applyPermissions();
 174
 175     return;
 176   }
 177
 178   // Resolve any relocations.
 179   Dyld.resolveRelocations();
 180
 181   // Set page permissions.
 182   MemMgr->applyPermissions();
 183 }
 184
 185 void *MCJIT::getPointerToBasicBlock(BasicBlock *BB) {
 186   report_fatal_error("not yet implemented");
 187 }
 188
 189 void *MCJIT::getPointerToFunction(Function *F) {
 190   // FIXME: This should really return a uint64_t since it's a pointer in the
 191   // target address space, not our local address space. That's part of the
 192   // ExecutionEngine interface, though. Fix that when the old JIT finally
 193   // dies.
 194
 195   // FIXME: Add support for per-module compilation state
 196   if (!IsLoaded)
 197     loadObject(M);
 198
 199   if (F->isDeclaration() || F->hasAvailableExternallyLinkage()) {
 200     bool AbortOnFailure = !F->hasExternalWeakLinkage();
 201     void *Addr = getPointerToNamedFunction(F->getName(), AbortOnFailure);
 202     addGlobalMapping(F, Addr);
 203     return Addr;
 204   }
 205
 206   // FIXME: Should the Dyld be retaining module information? Probably not.
 207   // FIXME: Should we be using the mangler for this? Probably.
 208   //
 209   // This is the accessor for the target address, so make sure to check the
 210   // load address of the symbol, not the local address.
 211   StringRef BaseName = F->getName();
 212   if (BaseName[0] == '\1')
 213     return (void*)Dyld.getSymbolLoadAddress(BaseName.substr(1));
 214   return (void*)Dyld.getSymbolLoadAddress((TM->getMCAsmInfo()->getGlobalPrefix()
 215                                        + BaseName).str());
 216 }
 217
 218 void *MCJIT::recompileAndRelinkFunction(Function *F) {
 219   report_fatal_error("not yet implemented");
 220 }
 221
 222 void MCJIT::freeMachineCodeForFunction(Function *F) {
 223   report_fatal_error("not yet implemented");
 224 }
 225
 226 GenericValue MCJIT::runFunction(Function *F,
 227                                 const std::vector<GenericValue> &ArgValues) {
 228   assert(F && "Function *F was null at entry to run()");
 229
 230   void *FPtr = getPointerToFunction(F);
 231   assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
 232   FunctionType *FTy = F->getFunctionType();
 233   Type *RetTy = FTy->getReturnType();
 234
 235   assert((FTy->getNumParams() == ArgValues.size() ||
 236           (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
 237          "Wrong number of arguments passed into function!");
 238   assert(FTy->getNumParams() == ArgValues.size() &&
 239          "This doesn't support passing arguments through varargs (yet)!");
 240
 241   // Handle some common cases first.  These cases correspond to common `main'
 242   // prototypes.
 243   if (RetTy->isIntegerTy(32) || RetTy->isVoidTy()) {
 244     switch (ArgValues.size()) {
 245     case 3:
 246       if (FTy->getParamType(0)->isIntegerTy(32) &&
 247           FTy->getParamType(1)->isPointerTy() &&
 248           FTy->getParamType(2)->isPointerTy()) {
 249         int (*PF)(int, char **, const char **) =
 250           (int(*)(int, char **, const char **))(intptr_t)FPtr;
 251
 252         // Call the function.
 253         GenericValue rv;
 254         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
 255                                  (char **)GVTOP(ArgValues[1]),
 256                                  (const char **)GVTOP(ArgValues[2])));
 257         return rv;
 258       }
 259       break;
 260     case 2:
 261       if (FTy->getParamType(0)->isIntegerTy(32) &&
 262           FTy->getParamType(1)->isPointerTy()) {
 263         int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
 264
 265         // Call the function.
 266         GenericValue rv;
 267         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
 268                                  (char **)GVTOP(ArgValues[1])));
 269         return rv;
 270       }
 271       break;
 272     case 1:
 273       if (FTy->getNumParams() == 1 &&
 274           FTy->getParamType(0)->isIntegerTy(32)) {
 275         GenericValue rv;
 276         int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
 277         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
 278         return rv;
 279       }
 280       break;
 281     }
 282   }
 283
 284   // Handle cases where no arguments are passed first.
 285   if (ArgValues.empty()) {
 286     GenericValue rv;
 287     switch (RetTy->getTypeID()) {
 288     default: llvm_unreachable("Unknown return type for function call!");
 289     case Type::IntegerTyID: {
 290       unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
 291       if (BitWidth == 1)
 292         rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
 293       else if (BitWidth <= 8)
 294         rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
 295       else if (BitWidth <= 16)
 296         rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
 297       else if (BitWidth <= 32)
 298         rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
 299       else if (BitWidth <= 64)
 300         rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
 301       else
 302         llvm_unreachable("Integer types > 64 bits not supported");
 303       return rv;
 304     }
 305     case Type::VoidTyID:
 306       rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
 307       return rv;
 308     case Type::FloatTyID:
 309       rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
 310       return rv;
 311     case Type::DoubleTyID:
 312       rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
 313       return rv;
 314     case Type::X86_FP80TyID:
 315     case Type::FP128TyID:
 316     case Type::PPC_FP128TyID:
 317       llvm_unreachable("long double not supported yet");
 318     case Type::PointerTyID:
 319       return PTOGV(((void*(*)())(intptr_t)FPtr)());
 320     }
 321   }
 322
 323   llvm_unreachable("Full-featured argument passing not supported yet!");
 324 }
 325
 326 void *MCJIT::getPointerToNamedFunction(const std::string &Name,
 327                                        bool AbortOnFailure) {
 328   // FIXME: Add support for per-module compilation state
 329   if (!IsLoaded)
 330     loadObject(M);
 331
 332   if (!isSymbolSearchingDisabled() && MemMgr) {
 333     void *ptr = MemMgr->getPointerToNamedFunction(Name, false);
 334     if (ptr)
 335       return ptr;
 336   }
 337
 338   /// If a LazyFunctionCreator is installed, use it to get/create the function.
 339   if (LazyFunctionCreator)
 340     if (void *RP = LazyFunctionCreator(Name))
 341       return RP;
 342
 343   if (AbortOnFailure) {
 344     report_fatal_error("Program used external function '"+Name+
 345                        "' which could not be resolved!");
 346   }
 347   return 0;
 348 }
 349
 350 void MCJIT::RegisterJITEventListener(JITEventListener *L) {
 351   if (L == NULL)
 352     return;
 353   MutexGuard locked(lock);
 354   EventListeners.push_back(L);
 355 }
 356 void MCJIT::UnregisterJITEventListener(JITEventListener *L) {
 357   if (L == NULL)
 358     return;
 359   MutexGuard locked(lock);
 360   SmallVector<JITEventListener*, 2>::reverse_iterator I=
 361       std::find(EventListeners.rbegin(), EventListeners.rend(), L);
 362   if (I != EventListeners.rend()) {
 363     std::swap(*I, EventListeners.back());
 364     EventListeners.pop_back();
 365   }
 366 }
 367 void MCJIT::NotifyObjectEmitted(const ObjectImage& Obj) {
 368   MutexGuard locked(lock);
 369   for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
 370     EventListeners[I]->NotifyObjectEmitted(Obj);
 371   }
 372 }
 373 void MCJIT::NotifyFreeingObject(const ObjectImage& Obj) {
 374   MutexGuard locked(lock);
 375   for (unsigned I = 0, S = EventListeners.size(); I < S; ++I) {
 376     EventListeners[I]->NotifyFreeingObject(Obj);
 377   }
 378 }