lib/ExecutionEngine/JIT/JIT.cpp

   1 //===-- JIT.cpp - LLVM Just in Time Compiler ------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This tool implements a just-in-time compiler for LLVM, allowing direct
  11 // execution of LLVM bytecode in an efficient manner.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "JIT.h"
  16 #include "llvm/DerivedTypes.h"
  17 #include "llvm/Function.h"
  18 #include "llvm/GlobalVariable.h"
  19 #include "llvm/ModuleProvider.h"
  20 #include "llvm/CodeGen/MachineCodeEmitter.h"
  21 #include "llvm/CodeGen/MachineFunction.h"
  22 #include "llvm/ExecutionEngine/GenericValue.h"
  23 #include "llvm/Target/TargetMachine.h"
  24 #include "llvm/Target/TargetJITInfo.h"
  25 #include "Support/DynamicLinker.h"
  26 using namespace llvm;
  27
  28 JIT::JIT(ModuleProvider *MP, TargetMachine &tm, TargetJITInfo &tji)
  29   : ExecutionEngine(MP), TM(tm), TJI(tji), PM(MP) {
  30   setTargetData(TM.getTargetData());
  31
  32   // Initialize MCE
  33   MCE = createEmitter(*this);
  34
  35   // Compile LLVM Code down to machine code in the intermediate representation
  36   TJI.addPassesToJITCompile(PM);
  37
  38   // Turn the machine code intermediate representation into bytes in memory that
  39   // may be executed.
  40   if (TM.addPassesToEmitMachineCode(PM, *MCE)) {
  41     std::cerr << "lli: target '" << TM.getName()
  42               << "' doesn't support machine code emission!\n";
  43     abort();
  44   }
  45 }
  46
  47 JIT::~JIT() {
  48   delete MCE;
  49   delete &TM;
  50 }
  51
  52 /// run - Start execution with the specified function and arguments.
  53 ///
  54 GenericValue JIT::runFunction(Function *F,
  55                               const std::vector<GenericValue> &ArgValues) {
  56   assert (F && "Function *F was null at entry to run()");
  57     GenericValue rv;
  58
  59   if (ArgValues.size() == 3) {
  60     int (*PF)(int, char **, const char **) =
  61       (int(*)(int, char **, const char **))getPointerToFunction(F);
  62     assert(PF && "Pointer to fn's code was null after getPointerToFunction");
  63
  64     // Call the function.
  65     int ExitCode = PF(ArgValues[0].IntVal, (char **) GVTOP (ArgValues[1]),
  66                       (const char **) GVTOP (ArgValues[2]));
  67
  68     rv.IntVal = ExitCode;
  69   } else {
  70     // FIXME: This code should handle a couple of common cases efficiently, but
  71     // it should also implement the general case by code-gening a new anonymous
  72     // nullary function to call.
  73     assert(ArgValues.size() == 1);
  74     void (*PF)(int) = (void(*)(int))getPointerToFunction(F);
  75     assert(PF && "Pointer to fn's code was null after getPointerToFunction");
  76     PF(ArgValues[0].IntVal);
  77   }
  78
  79   return rv;
  80 }
  81
  82 /// runJITOnFunction - Run the FunctionPassManager full of
  83 /// just-in-time compilation passes on F, hopefully filling in
  84 /// GlobalAddress[F] with the address of F's machine code.
  85 ///
  86 void JIT::runJITOnFunction(Function *F) {
  87   static bool isAlreadyCodeGenerating = false;
  88   assert(!isAlreadyCodeGenerating && "Error: Recursive compilation detected!");
  89
  90   // JIT the function
  91   isAlreadyCodeGenerating = true;
  92   PM.run(*F);
  93   isAlreadyCodeGenerating = false;
  94
  95   // If the function referred to a global variable that had not yet been
  96   // emitted, it allocates memory for the global, but doesn't emit it yet.  Emit
  97   // all of these globals now.
  98   while (!PendingGlobals.empty()) {
  99     const GlobalVariable *GV = PendingGlobals.back();
 100     PendingGlobals.pop_back();
 101     EmitGlobalVariable(GV);
 102   }
 103 }
 104
 105 /// getPointerToFunction - This method is used to get the address of the
 106 /// specified function, compiling it if neccesary.
 107 ///
 108 void *JIT::getPointerToFunction(Function *F) {
 109   if (void *Addr = getPointerToGlobalIfAvailable(F))
 110     return Addr;   // Check if function already code gen'd
 111
 112   // Make sure we read in the function if it exists in this Module
 113   MP->materializeFunction(F);
 114
 115   if (F->isExternal()) {
 116     void *Addr = getPointerToNamedFunction(F->getName());
 117     addGlobalMapping(F, Addr);
 118     return Addr;
 119   }
 120
 121   runJITOnFunction(F);
 122
 123   void *Addr = getPointerToGlobalIfAvailable(F);
 124   assert(Addr && "Code generation didn't add function to GlobalAddress table!");
 125   return Addr;
 126 }
 127
 128 // getPointerToFunctionOrStub - If the specified function has been
 129 // code-gen'd, return a pointer to the function.  If not, compile it, or use
 130 // a stub to implement lazy compilation if available.
 131 //
 132 void *JIT::getPointerToFunctionOrStub(Function *F) {
 133   // If we have already code generated the function, just return the address.
 134   if (void *Addr = getPointerToGlobalIfAvailable(F))
 135     return Addr;
 136
 137   // If the target supports "stubs" for functions, get a stub now.
 138   if (void *Ptr = TJI.getJITStubForFunction(F, *MCE))
 139     return Ptr;
 140
 141   // Otherwise, if the target doesn't support it, just codegen the function.
 142   return getPointerToFunction(F);
 143 }
 144
 145 /// getOrEmitGlobalVariable - Return the address of the specified global
 146 /// variable, possibly emitting it to memory if needed.  This is used by the
 147 /// Emitter.
 148 void *JIT::getOrEmitGlobalVariable(const GlobalVariable *GV) {
 149   void *Ptr = getPointerToGlobalIfAvailable(GV);
 150   if (Ptr) return Ptr;
 151
 152   // If the global is external, just remember the address.
 153   if (GV->isExternal()) {
 154     Ptr = GetAddressOfSymbol(GV->getName().c_str());
 155     if (Ptr == 0) {
 156       std::cerr << "Could not resolve external global address: "
 157                 << GV->getName() << "\n";
 158       abort();
 159     }
 160   } else {
 161     // If the global hasn't been emitted to memory yet, allocate space.  We will
 162     // actually initialize the global after current function has finished
 163     // compilation.
 164     Ptr =new char[getTargetData().getTypeSize(GV->getType()->getElementType())];
 165     PendingGlobals.push_back(GV);
 166   }
 167   addGlobalMapping(GV, Ptr);
 168   return Ptr;
 169 }
 170
 171
 172 /// recompileAndRelinkFunction - This method is used to force a function
 173 /// which has already been compiled, to be compiled again, possibly
 174 /// after it has been modified. Then the entry to the old copy is overwritten
 175 /// with a branch to the new copy. If there was no old copy, this acts
 176 /// just like JIT::getPointerToFunction().
 177 ///
 178 void *JIT::recompileAndRelinkFunction(Function *F) {
 179   void *OldAddr = getPointerToGlobalIfAvailable(F);
 180
 181   // If it's not already compiled there is no reason to patch it up.
 182   if (OldAddr == 0) { return getPointerToFunction(F); }
 183
 184   // Delete the old function mapping.
 185   addGlobalMapping(F, 0);
 186
 187   // Recodegen the function
 188   runJITOnFunction(F);
 189
 190   // Update state, forward the old function to the new function.
 191   void *Addr = getPointerToGlobalIfAvailable(F);
 192   assert(Addr && "Code generation didn't add function to GlobalAddress table!");
 193   TJI.replaceMachineCodeForFunction(OldAddr, Addr);
 194   return Addr;
 195 }