1 //===-- JIT.h - Class definition for the JIT --------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the top-level JIT data structure.
12 //===----------------------------------------------------------------------===//
17 #include "llvm/ExecutionEngine/ExecutionEngine.h"
18 #include "llvm/PassManager.h"
27 class MachineCodeEmitter;
31 FunctionPassManager PM; // Passes to compile a function
33 /// PendingGlobals - Global variables which have had memory allocated for them
34 /// while a function was code generated, but which have not been initialized
36 std::vector<const GlobalVariable*> PendingGlobals;
39 explicit JITState(ModuleProvider *MP) : PM(MP) {}
41 FunctionPassManager &getPM(const MutexGuard &L) {
45 std::vector<const GlobalVariable*> &getPendingGlobals(const MutexGuard &L) {
46 return PendingGlobals;
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
58 JIT(ModuleProvider *MP, TargetMachine &tm, TargetJITInfo &tji,
59 JITMemoryManager *JMM, bool Fast);
63 static void Register() {
67 /// getJITInfo - Return the target JIT information structure.
69 TargetJITInfo &getJITInfo() const { return TJI; }
71 /// create - Create an return a new JIT compiler if there is one available
72 /// for the current target. Otherwise, return null.
74 static ExecutionEngine *create(ModuleProvider *MP, std::string *Err,
76 return createJIT(MP, Err, 0, Fast);
79 virtual void addModuleProvider(ModuleProvider *MP);
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);
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);
92 /// runFunction - Start execution with the specified function and arguments.
94 virtual GenericValue runFunction(Function *F,
95 const std::vector<GenericValue> &ArgValues);
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.
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.
105 void *getPointerToNamedFunction(const std::string &Name,
106 bool AbortOnFailure = true);
108 // CompilationCallback - Invoked the first time that a call site is found,
109 // which causes lazy compilation of the target function.
111 static void CompilationCallback();
113 /// getPointerToFunction - This returns the address of the specified function,
114 /// compiling it if necessary.
116 void *getPointerToFunction(Function *F);
118 /// getOrEmitGlobalVariable - Return the address of the specified global
119 /// variable, possibly emitting it to memory if needed. This is used by the
121 void *getOrEmitGlobalVariable(const GlobalVariable *GV);
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.
127 void *getPointerToFunctionOrStub(Function *F);
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().
135 void *recompileAndRelinkFunction(Function *F);
137 /// freeMachineCodeForFunction - deallocate memory used to code-generate this
140 void freeMachineCodeForFunction(Function *F);
142 /// getCodeEmitter - Return the code emitter this JIT is emitting into.
143 MachineCodeEmitter *getCodeEmitter() const { return MCE; }
145 static ExecutionEngine *createJIT(ModuleProvider *MP, std::string *Err,
146 JITMemoryManager *JMM, bool Fast);
149 static MachineCodeEmitter *createEmitter(JIT &J, JITMemoryManager *JMM);
150 void runJITOnFunction(Function *F);
151 void runJITOnFunctionUnlocked(Function *F, const MutexGuard &locked);
155 /// getMemoryforGV - Allocate memory for a global variable.
156 virtual char* getMemoryForGV(const GlobalVariable* GV);
160 } // End llvm namespace