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"
19 #include "llvm/Support/ValueHandle.h"
24 struct JITEvent_EmittedFunctionDetails;
25 class MachineCodeEmitter;
26 class MachineCodeInfo;
32 FunctionPassManager PM; // Passes to compile a function
33 ModuleProvider *MP; // ModuleProvider used to create the PM
35 /// PendingFunctions - Functions which have not been code generated yet, but
36 /// were called from a function being code generated.
37 std::vector<AssertingVH<Function> > PendingFunctions;
40 explicit JITState(ModuleProvider *MP) : PM(MP), MP(MP) {}
42 FunctionPassManager &getPM(const MutexGuard &L) {
46 ModuleProvider *getMP() const { return MP; }
47 std::vector<AssertingVH<Function> > &getPendingFunctions(const MutexGuard &L){
48 return PendingFunctions;
53 class JIT : public ExecutionEngine {
54 TargetMachine &TM; // The current target we are compiling to
55 TargetJITInfo &TJI; // The JITInfo for the target we are compiling to
56 JITCodeEmitter *JCE; // JCE object
57 std::vector<JITEventListener*> EventListeners;
59 /// AllocateGVsWithCode - Some applications require that global variables and
60 /// code be allocated into the same region of memory, in which case this flag
61 /// should be set to true. Doing so breaks freeMachineCodeForFunction.
62 bool AllocateGVsWithCode;
66 JIT(ModuleProvider *MP, TargetMachine &tm, TargetJITInfo &tji,
67 JITMemoryManager *JMM, CodeGenOpt::Level OptLevel,
68 bool AllocateGVsWithCode);
72 static void Register() {
76 /// getJITInfo - Return the target JIT information structure.
78 TargetJITInfo &getJITInfo() const { return TJI; }
80 /// create - Create an return a new JIT compiler if there is one available
81 /// for the current target. Otherwise, return null.
83 static ExecutionEngine *create(ModuleProvider *MP,
85 JITMemoryManager *JMM,
86 CodeGenOpt::Level OptLevel =
88 bool GVsWithCode = true) {
89 return ExecutionEngine::createJIT(MP, Err, JMM, OptLevel, GVsWithCode);
92 virtual void addModuleProvider(ModuleProvider *MP);
94 /// removeModuleProvider - Remove a ModuleProvider from the list of modules.
95 /// Relases the Module from the ModuleProvider, materializing it in the
96 /// process, and returns the materialized Module.
97 virtual Module *removeModuleProvider(ModuleProvider *MP,
98 std::string *ErrInfo = 0);
100 /// deleteModuleProvider - Remove a ModuleProvider from the list of modules,
101 /// and deletes the ModuleProvider and owned Module. Avoids materializing
102 /// the underlying module.
103 virtual void deleteModuleProvider(ModuleProvider *P,std::string *ErrInfo = 0);
105 /// runFunction - Start execution with the specified function and arguments.
107 virtual GenericValue runFunction(Function *F,
108 const std::vector<GenericValue> &ArgValues);
110 /// getPointerToNamedFunction - This method returns the address of the
111 /// specified function by using the dlsym function call. As such it is only
112 /// useful for resolving library symbols, not code generated symbols.
114 /// If AbortOnFailure is false and no function with the given name is
115 /// found, this function silently returns a null pointer. Otherwise,
116 /// it prints a message to stderr and aborts.
118 void *getPointerToNamedFunction(const std::string &Name,
119 bool AbortOnFailure = true);
121 // CompilationCallback - Invoked the first time that a call site is found,
122 // which causes lazy compilation of the target function.
124 static void CompilationCallback();
126 /// getPointerToFunction - This returns the address of the specified function,
127 /// compiling it if necessary.
129 void *getPointerToFunction(Function *F);
131 /// getOrEmitGlobalVariable - Return the address of the specified global
132 /// variable, possibly emitting it to memory if needed. This is used by the
134 void *getOrEmitGlobalVariable(const GlobalVariable *GV);
136 /// getPointerToFunctionOrStub - If the specified function has been
137 /// code-gen'd, return a pointer to the function. If not, compile it, or use
138 /// a stub to implement lazy compilation if available.
140 void *getPointerToFunctionOrStub(Function *F);
142 /// recompileAndRelinkFunction - This method is used to force a function
143 /// which has already been compiled, to be compiled again, possibly
144 /// after it has been modified. Then the entry to the old copy is overwritten
145 /// with a branch to the new copy. If there was no old copy, this acts
146 /// just like JIT::getPointerToFunction().
148 void *recompileAndRelinkFunction(Function *F);
150 /// freeMachineCodeForFunction - deallocate memory used to code-generate this
153 void freeMachineCodeForFunction(Function *F);
155 /// addPendingFunction - while jitting non-lazily, a called but non-codegen'd
156 /// function was encountered. Add it to a pending list to be processed after
157 /// the current function.
159 void addPendingFunction(Function *F);
161 /// getCodeEmitter - Return the code emitter this JIT is emitting into.
163 JITCodeEmitter *getCodeEmitter() const { return JCE; }
165 /// selectTarget - Pick a target either via -march or by guessing the native
166 /// arch. Add any CPU features specified via -mcpu or -mattr.
167 static TargetMachine *selectTarget(ModuleProvider *MP, std::string *Err);
169 static ExecutionEngine *createJIT(ModuleProvider *MP,
170 std::string *ErrorStr,
171 JITMemoryManager *JMM,
172 CodeGenOpt::Level OptLevel,
175 // Run the JIT on F and return information about the generated code
176 void runJITOnFunction(Function *F, MachineCodeInfo *MCI = 0);
178 virtual void RegisterJITEventListener(JITEventListener *L);
179 virtual void UnregisterJITEventListener(JITEventListener *L);
180 /// These functions correspond to the methods on JITEventListener. They
181 /// iterate over the registered listeners and call the corresponding method on
183 void NotifyFunctionEmitted(
184 const Function &F, void *Code, size_t Size,
185 const JITEvent_EmittedFunctionDetails &Details);
186 void NotifyFreeingMachineCode(void *OldPtr);
189 static JITCodeEmitter *createEmitter(JIT &J, JITMemoryManager *JMM,
191 void runJITOnFunctionUnlocked(Function *F, const MutexGuard &locked);
192 void updateFunctionStub(Function *F);
193 void updateDlsymStubTable();
197 /// getMemoryforGV - Allocate memory for a global variable.
198 virtual char* getMemoryForGV(const GlobalVariable* GV);
202 } // End llvm namespace