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