lib/ExecutionEngine/JIT/JIT.h

   1 //===-- JIT.h - Class definition for the JIT --------------------*- C++ -*-===//
   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 // This file defines the top-level JIT data structure.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef JIT_H
  15 #define JIT_H
  16
  17 #include "llvm/ExecutionEngine/ExecutionEngine.h"
  18 #include "llvm/PassManager.h"
  19
  20 namespace llvm {
  21
  22 class Function;
  23 class GlobalValue;
  24 class Constant;
  25 class TargetMachine;
  26 class TargetJITInfo;
  27 class MachineCodeEmitter;
  28
  29 class JITState {
  30 private:
  31   FunctionPassManager PM;  // Passes to compile a function
  32
  33   /// PendingGlobals - Global variables which have had memory allocated for them
  34   /// while a function was code generated, but which have not been initialized
  35   /// yet.
  36   std::vector<const GlobalVariable*> PendingGlobals;
  37
  38 public:
  39   explicit JITState(ModuleProvider *MP) : PM(MP) {}
  40
  41   FunctionPassManager &getPM(const MutexGuard &L) {
  42     return PM;
  43   }
  44
  45   std::vector<const GlobalVariable*> &getPendingGlobals(const MutexGuard &L) {
  46     return PendingGlobals;
  47   }
  48 };
  49
  50
  51 class JIT : public ExecutionEngine {
  52   TargetMachine &TM;       // The current target we are compiling to
  53   TargetJITInfo &TJI;      // The JITInfo for the target we are compiling to
  54   MachineCodeEmitter *MCE; // MCE object
  55
  56   JITState *jitstate;
  57
  58   JIT(ModuleProvider *MP, TargetMachine &tm, TargetJITInfo &tji,
  59       JITMemoryManager *JMM, bool Fast);
  60 public:
  61   ~JIT();
  62
  63   static void Register() {
  64     JITCtor = create;
  65   }
  66
  67   /// getJITInfo - Return the target JIT information structure.
  68   ///
  69   TargetJITInfo &getJITInfo() const { return TJI; }
  70
  71   /// create - Create an return a new JIT compiler if there is one available
  72   /// for the current target.  Otherwise, return null.
  73   ///
  74   static ExecutionEngine *create(ModuleProvider *MP, std::string *Err,
  75                                  bool Fast = false) {
  76     return createJIT(MP, Err, 0, Fast);
  77   }
  78
  79   virtual void addModuleProvider(ModuleProvider *MP);
  80
  81   /// removeModuleProvider - Remove a ModuleProvider from the list of modules.
  82   /// Relases the Module from the ModuleProvider, materializing it in the
  83   /// process, and returns the materialized Module.
  84   virtual Module *removeModuleProvider(ModuleProvider *MP,
  85                                        std::string *ErrInfo = 0);
  86
  87   /// deleteModuleProvider - Remove a ModuleProvider from the list of modules,
  88   /// and deletes the ModuleProvider and owned Module.  Avoids materializing
  89   /// the underlying module.
  90   virtual void deleteModuleProvider(ModuleProvider *P,std::string *ErrInfo = 0);
  91
  92   /// runFunction - Start execution with the specified function and arguments.
  93   ///
  94   virtual GenericValue runFunction(Function *F,
  95                                    const std::vector<GenericValue> &ArgValues);
  96
  97   /// getPointerToNamedFunction - This method returns the address of the
  98   /// specified function by using the dlsym function call.  As such it is only
  99   /// useful for resolving library symbols, not code generated symbols.
 100   ///
 101   /// If AbortOnFailure is false and no function with the given name is
 102   /// found, this function silently returns a null pointer. Otherwise,
 103   /// it prints a message to stderr and aborts.
 104   ///
 105   void *getPointerToNamedFunction(const std::string &Name,
 106                                   bool AbortOnFailure = true);
 107
 108   // CompilationCallback - Invoked the first time that a call site is found,
 109   // which causes lazy compilation of the target function.
 110   //
 111   static void CompilationCallback();
 112
 113   /// getPointerToFunction - This returns the address of the specified function,
 114   /// compiling it if necessary.
 115   ///
 116   void *getPointerToFunction(Function *F);
 117
 118   /// getOrEmitGlobalVariable - Return the address of the specified global
 119   /// variable, possibly emitting it to memory if needed.  This is used by the
 120   /// Emitter.
 121   void *getOrEmitGlobalVariable(const GlobalVariable *GV);
 122
 123   /// getPointerToFunctionOrStub - If the specified function has been
 124   /// code-gen'd, return a pointer to the function.  If not, compile it, or use
 125   /// a stub to implement lazy compilation if available.
 126   ///
 127   void *getPointerToFunctionOrStub(Function *F);
 128
 129   /// recompileAndRelinkFunction - This method is used to force a function
 130   /// which has already been compiled, to be compiled again, possibly
 131   /// after it has been modified. Then the entry to the old copy is overwritten
 132   /// with a branch to the new copy. If there was no old copy, this acts
 133   /// just like JIT::getPointerToFunction().
 134   ///
 135   void *recompileAndRelinkFunction(Function *F);
 136
 137   /// freeMachineCodeForFunction - deallocate memory used to code-generate this
 138   /// Function.
 139   ///
 140   void freeMachineCodeForFunction(Function *F);
 141
 142   /// getCodeEmitter - Return the code emitter this JIT is emitting into.
 143   MachineCodeEmitter *getCodeEmitter() const { return MCE; }
 144
 145   static ExecutionEngine *createJIT(ModuleProvider *MP, std::string *Err,
 146                                     JITMemoryManager *JMM, bool Fast);
 147
 148 private:
 149   static MachineCodeEmitter *createEmitter(JIT &J, JITMemoryManager *JMM);
 150   void runJITOnFunction (Function *F);
 151
 152 protected:
 153
 154   /// getMemoryforGV - Allocate memory for a global variable.
 155   virtual char* getMemoryForGV(const GlobalVariable* GV);
 156
 157 };
 158
 159 } // End llvm namespace
 160
 161 #endif