JIT.h revision deb052a3dd0227579f86d74b3c1d70384ea5c16b 
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
20namespace llvm {
21
22class Function;
23struct JITEvent_EmittedFunctionDetails;
24class MachineCodeEmitter;
25class MachineCodeInfo;
26class TargetJITInfo;
27class TargetMachine;
28
29class JITState {
30private:
31  FunctionPassManager PM;  // Passes to compile a function
32  ModuleProvider *MP;      // ModuleProvider used to create the PM
33
34  /// PendingFunctions - Functions which have not been code generated yet, but
35  /// were called from a function being code generated.
36  std::vector<Function*> PendingFunctions;
37
38public:
39  explicit JITState(ModuleProvider *MP) : PM(MP), MP(MP) {}
40
41  FunctionPassManager &getPM(const MutexGuard &L) {
42    return PM;
43  }
44
45  ModuleProvider *getMP() const { return MP; }
46  std::vector<Function*> &getPendingFunctions(const MutexGuard &L) {
47    return PendingFunctions;
48  }
49};
50
51
52class JIT : public ExecutionEngine {
53  TargetMachine &TM;       // The current target we are compiling to
54  TargetJITInfo &TJI;      // The JITInfo for the target we are compiling to
55  JITCodeEmitter *JCE;     // JCE object
56  std::vector<JITEventListener*> EventListeners;
57
58  /// AllocateGVsWithCode - Some applications require that global variables and
59  /// code be allocated into the same region of memory, in which case this flag
60  /// should be set to true.  Doing so breaks freeMachineCodeForFunction.
61  bool AllocateGVsWithCode;
62
63  JITState *jitstate;
64
65  JIT(ModuleProvider *MP, TargetMachine &tm, TargetJITInfo &tji,
66      JITMemoryManager *JMM, CodeGenOpt::Level OptLevel,
67      bool AllocateGVsWithCode);
68public:
69  ~JIT();
70
71  static void Register() {
72    JITCtor = create;
73  }
74
75  /// getJITInfo - Return the target JIT information structure.
76  ///
77  TargetJITInfo &getJITInfo() const { return TJI; }
78
79  /// create - Create an return a new JIT compiler if there is one available
80  /// for the current target.  Otherwise, return null.
81  ///
82  static ExecutionEngine *create(ModuleProvider *MP, std::string *Err,
83                                 CodeGenOpt::Level OptLevel =
84                                   CodeGenOpt::Default,
85                                 bool AllocateGVsWithCode = true) {
86    return createJIT(MP, Err, 0, OptLevel, AllocateGVsWithCode);
87  }
88
89  virtual void addModuleProvider(ModuleProvider *MP);
90
91  /// removeModuleProvider - Remove a ModuleProvider from the list of modules.
92  /// Relases the Module from the ModuleProvider, materializing it in the
93  /// process, and returns the materialized Module.
94  virtual Module *removeModuleProvider(ModuleProvider *MP,
95                                       std::string *ErrInfo = 0);
96
97  /// deleteModuleProvider - Remove a ModuleProvider from the list of modules,
98  /// and deletes the ModuleProvider and owned Module.  Avoids materializing
99  /// the underlying module.
100  virtual void deleteModuleProvider(ModuleProvider *P,std::string *ErrInfo = 0);
101
102  /// runFunction - Start execution with the specified function and arguments.
103  ///
104  virtual GenericValue runFunction(Function *F,
105                                   const std::vector<GenericValue> &ArgValues);
106
107  /// getPointerToNamedFunction - This method returns the address of the
108  /// specified function by using the dlsym function call.  As such it is only
109  /// useful for resolving library symbols, not code generated symbols.
110  ///
111  /// If AbortOnFailure is false and no function with the given name is
112  /// found, this function silently returns a null pointer. Otherwise,
113  /// it prints a message to stderr and aborts.
114  ///
115  void *getPointerToNamedFunction(const std::string &Name,
116                                  bool AbortOnFailure = true);
117
118  // CompilationCallback - Invoked the first time that a call site is found,
119  // which causes lazy compilation of the target function.
120  //
121  static void CompilationCallback();
122
123  /// getPointerToFunction - This returns the address of the specified function,
124  /// compiling it if necessary.
125  ///
126  void *getPointerToFunction(Function *F);
127
128  /// getOrEmitGlobalVariable - Return the address of the specified global
129  /// variable, possibly emitting it to memory if needed.  This is used by the
130  /// Emitter.
131  void *getOrEmitGlobalVariable(const GlobalVariable *GV);
132
133  /// getPointerToFunctionOrStub - If the specified function has been
134  /// code-gen'd, return a pointer to the function.  If not, compile it, or use
135  /// a stub to implement lazy compilation if available.
136  ///
137  void *getPointerToFunctionOrStub(Function *F);
138
139  /// recompileAndRelinkFunction - This method is used to force a function
140  /// which has already been compiled, to be compiled again, possibly
141  /// after it has been modified. Then the entry to the old copy is overwritten
142  /// with a branch to the new copy. If there was no old copy, this acts
143  /// just like JIT::getPointerToFunction().
144  ///
145  void *recompileAndRelinkFunction(Function *F);
146
147  /// freeMachineCodeForFunction - deallocate memory used to code-generate this
148  /// Function.
149  ///
150  void freeMachineCodeForFunction(Function *F);
151
152  /// addPendingFunction - while jitting non-lazily, a called but non-codegen'd
153  /// function was encountered.  Add it to a pending list to be processed after
154  /// the current function.
155  ///
156  void addPendingFunction(Function *F);
157
158  /// getCodeEmitter - Return the code emitter this JIT is emitting into.
159  JITCodeEmitter *getCodeEmitter() const { return JCE; }
160
161  static ExecutionEngine *createJIT(ModuleProvider *MP,
162                                    std::string *Err,
163                                    JITMemoryManager *JMM,
164                                    CodeGenOpt::Level OptLevel,
165                                    bool AllocateGVsWithCode);
166
167
168  // Run the JIT on F and return information about the generated code
169  void runJITOnFunction(Function *F, MachineCodeInfo *MCI = 0);
170
171  virtual void RegisterJITEventListener(JITEventListener *L);
172  virtual void UnregisterJITEventListener(JITEventListener *L);
173  /// These functions correspond to the methods on JITEventListener.  They
174  /// iterate over the registered listeners and call the corresponding method on
175  /// each.
176  void NotifyFunctionEmitted(
177      const Function &F, void *Code, size_t Size,
178      const JITEvent_EmittedFunctionDetails &Details);
179  void NotifyFreeingMachineCode(const Function &F, void *OldPtr);
180
181private:
182  static JITCodeEmitter *createEmitter(JIT &J, JITMemoryManager *JMM);
183  void runJITOnFunctionUnlocked(Function *F, const MutexGuard &locked);
184  void updateFunctionStub(Function *F);
185  void updateDlsymStubTable();
186
187protected:
188
189  /// getMemoryforGV - Allocate memory for a global variable.
190  virtual char* getMemoryForGV(const GlobalVariable* GV);
191
192};
193
194} // End llvm namespace
195
196#endif
197