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 "MCJITMemoryManager.h"
  12 #include "llvm/DerivedTypes.h"
  13 #include "llvm/Function.h"
  14 #include "llvm/ExecutionEngine/GenericValue.h"
  15 #include "llvm/ExecutionEngine/MCJIT.h"
  16 #include "llvm/ExecutionEngine/JITMemoryManager.h"
  17 #include "llvm/MC/MCAsmInfo.h"
  18 #include "llvm/Support/ErrorHandling.h"
  19 #include "llvm/Support/DynamicLibrary.h"
  20 #include "llvm/Support/MemoryBuffer.h"
  21 #include "llvm/Target/TargetData.h"
  22
  23 using namespace llvm;
  24
  25 namespace {
  26
  27 static struct RegisterJIT {
  28   RegisterJIT() { MCJIT::Register(); }
  29 } JITRegistrator;
  30
  31 }
  32
  33 extern "C" void LLVMLinkInMCJIT() {
  34 }
  35
  36 ExecutionEngine *MCJIT::createJIT(Module *M,
  37                                   std::string *ErrorStr,
  38                                   JITMemoryManager *JMM,
  39                                   CodeGenOpt::Level OptLevel,
  40                                   bool GVsWithCode,
  41                                   CodeModel::Model CMM,
  42                                   StringRef MArch,
  43                                   StringRef MCPU,
  44                                   const SmallVectorImpl<std::string>& MAttrs) {
  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   // Pick a target either via -march or by guessing the native arch.
  51   //
  52   // FIXME: This should be lifted out of here, it isn't something which should
  53   // be part of the JIT policy, rather the burden for this selection should be
  54   // pushed to clients.
  55   TargetMachine *TM = MCJIT::selectTarget(M, MArch, MCPU, MAttrs, ErrorStr);
  56   if (!TM || (ErrorStr && ErrorStr->length() > 0)) return 0;
  57   TM->setCodeModel(CMM);
  58
  59   // If the target supports JIT code generation, create the JIT.
  60   if (TargetJITInfo *TJ = TM->getJITInfo())
  61     return new MCJIT(M, TM, *TJ, new MCJITMemoryManager(JMM), OptLevel,
  62                      GVsWithCode);
  63
  64   if (ErrorStr)
  65     *ErrorStr = "target does not support JIT code generation";
  66   return 0;
  67 }
  68
  69 MCJIT::MCJIT(Module *m, TargetMachine *tm, TargetJITInfo &tji,
  70              RTDyldMemoryManager *MM, CodeGenOpt::Level OptLevel,
  71              bool AllocateGVsWithCode)
  72   : ExecutionEngine(m), TM(tm), MemMgr(MM), M(m), OS(Buffer), Dyld(MM) {
  73
  74   PM.add(new TargetData(*TM->getTargetData()));
  75
  76   // Turn the machine code intermediate representation into bytes in memory
  77   // that may be executed.
  78   if (TM->addPassesToEmitMC(PM, Ctx, OS, CodeGenOpt::Default, false)) {
  79     report_fatal_error("Target does not support MC emission!");
  80   }
  81
  82   // Initialize passes.
  83   // FIXME: When we support multiple modules, we'll want to move the code
  84   // gen and finalization out of the constructor here and do it more
  85   // on-demand as part of getPointerToFunction().
  86   PM.run(*M);
  87   // Flush the output buffer so the SmallVector gets its data.
  88   OS.flush();
  89
  90   // Load the object into the dynamic linker.
  91   // FIXME: It would be nice to avoid making yet another copy.
  92   MemoryBuffer *MB = MemoryBuffer::getMemBufferCopy(StringRef(Buffer.data(),
  93                                                               Buffer.size()));
  94   if (Dyld.loadObject(MB))
  95     report_fatal_error(Dyld.getErrorString());
  96   // Resolve any relocations.
  97   Dyld.resolveRelocations();
  98 }
  99
 100 MCJIT::~MCJIT() {
 101   delete MemMgr;
 102 }
 103
 104 void *MCJIT::getPointerToBasicBlock(BasicBlock *BB) {
 105   report_fatal_error("not yet implemented");
 106   return 0;
 107 }
 108
 109 void *MCJIT::getPointerToFunction(Function *F) {
 110   if (F->isDeclaration() || F->hasAvailableExternallyLinkage()) {
 111     bool AbortOnFailure = !F->hasExternalWeakLinkage();
 112     void *Addr = getPointerToNamedFunction(F->getName(), AbortOnFailure);
 113     addGlobalMapping(F, Addr);
 114     return Addr;
 115   }
 116
 117   Twine Name = TM->getMCAsmInfo()->getGlobalPrefix() + F->getName();
 118   return (void*)Dyld.getSymbolAddress(Name.str());
 119 }
 120
 121 void *MCJIT::recompileAndRelinkFunction(Function *F) {
 122   report_fatal_error("not yet implemented");
 123 }
 124
 125 void MCJIT::freeMachineCodeForFunction(Function *F) {
 126   report_fatal_error("not yet implemented");
 127 }
 128
 129 GenericValue MCJIT::runFunction(Function *F,
 130                                 const std::vector<GenericValue> &ArgValues) {
 131   assert(F && "Function *F was null at entry to run()");
 132
 133   void *FPtr = getPointerToFunction(F);
 134   assert(FPtr && "Pointer to fn's code was null after getPointerToFunction");
 135   const FunctionType *FTy = F->getFunctionType();
 136   const Type *RetTy = FTy->getReturnType();
 137
 138   assert((FTy->getNumParams() == ArgValues.size() ||
 139           (FTy->isVarArg() && FTy->getNumParams() <= ArgValues.size())) &&
 140          "Wrong number of arguments passed into function!");
 141   assert(FTy->getNumParams() == ArgValues.size() &&
 142          "This doesn't support passing arguments through varargs (yet)!");
 143
 144   // Handle some common cases first.  These cases correspond to common `main'
 145   // prototypes.
 146   if (RetTy->isIntegerTy(32) || RetTy->isVoidTy()) {
 147     switch (ArgValues.size()) {
 148     case 3:
 149       if (FTy->getParamType(0)->isIntegerTy(32) &&
 150           FTy->getParamType(1)->isPointerTy() &&
 151           FTy->getParamType(2)->isPointerTy()) {
 152         int (*PF)(int, char **, const char **) =
 153           (int(*)(int, char **, const char **))(intptr_t)FPtr;
 154
 155         // Call the function.
 156         GenericValue rv;
 157         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
 158                                  (char **)GVTOP(ArgValues[1]),
 159                                  (const char **)GVTOP(ArgValues[2])));
 160         return rv;
 161       }
 162       break;
 163     case 2:
 164       if (FTy->getParamType(0)->isIntegerTy(32) &&
 165           FTy->getParamType(1)->isPointerTy()) {
 166         int (*PF)(int, char **) = (int(*)(int, char **))(intptr_t)FPtr;
 167
 168         // Call the function.
 169         GenericValue rv;
 170         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue(),
 171                                  (char **)GVTOP(ArgValues[1])));
 172         return rv;
 173       }
 174       break;
 175     case 1:
 176       if (FTy->getNumParams() == 1 &&
 177           FTy->getParamType(0)->isIntegerTy(32)) {
 178         GenericValue rv;
 179         int (*PF)(int) = (int(*)(int))(intptr_t)FPtr;
 180         rv.IntVal = APInt(32, PF(ArgValues[0].IntVal.getZExtValue()));
 181         return rv;
 182       }
 183       break;
 184     }
 185   }
 186
 187   // Handle cases where no arguments are passed first.
 188   if (ArgValues.empty()) {
 189     GenericValue rv;
 190     switch (RetTy->getTypeID()) {
 191     default: llvm_unreachable("Unknown return type for function call!");
 192     case Type::IntegerTyID: {
 193       unsigned BitWidth = cast<IntegerType>(RetTy)->getBitWidth();
 194       if (BitWidth == 1)
 195         rv.IntVal = APInt(BitWidth, ((bool(*)())(intptr_t)FPtr)());
 196       else if (BitWidth <= 8)
 197         rv.IntVal = APInt(BitWidth, ((char(*)())(intptr_t)FPtr)());
 198       else if (BitWidth <= 16)
 199         rv.IntVal = APInt(BitWidth, ((short(*)())(intptr_t)FPtr)());
 200       else if (BitWidth <= 32)
 201         rv.IntVal = APInt(BitWidth, ((int(*)())(intptr_t)FPtr)());
 202       else if (BitWidth <= 64)
 203         rv.IntVal = APInt(BitWidth, ((int64_t(*)())(intptr_t)FPtr)());
 204       else
 205         llvm_unreachable("Integer types > 64 bits not supported");
 206       return rv;
 207     }
 208     case Type::VoidTyID:
 209       rv.IntVal = APInt(32, ((int(*)())(intptr_t)FPtr)());
 210       return rv;
 211     case Type::FloatTyID:
 212       rv.FloatVal = ((float(*)())(intptr_t)FPtr)();
 213       return rv;
 214     case Type::DoubleTyID:
 215       rv.DoubleVal = ((double(*)())(intptr_t)FPtr)();
 216       return rv;
 217     case Type::X86_FP80TyID:
 218     case Type::FP128TyID:
 219     case Type::PPC_FP128TyID:
 220       llvm_unreachable("long double not supported yet");
 221       return rv;
 222     case Type::PointerTyID:
 223       return PTOGV(((void*(*)())(intptr_t)FPtr)());
 224     }
 225   }
 226
 227   assert("Full-featured argument passing not supported yet!");
 228   return GenericValue();
 229 }