JIT.h revision 434dd4fd94f5f248492c675e4285e7d67342d4c4 
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;
23class TargetMachine;
24class TargetJITInfo;
25class MachineCodeEmitter;
26class MachineCodeInfo;
27
28class JITState {
29private:
30  FunctionPassManager PM;  // Passes to compile a function
31  ModuleProvider *MP;      // ModuleProvider used to create the PM
32
33  /// PendingFunctions - Functions which have not been code generated yet, but
34  /// were called from a function being code generated.
35  std::vector<Function*> PendingFunctions;
36
37public:
38  explicit JITState(ModuleProvider *MP) : PM(MP), MP(MP) {}
39
40  FunctionPassManager &getPM(const MutexGuard &L) {
41    return PM;
42  }
43
44  ModuleProvider *getMP() const { return MP; }
45  std::vector<Function*> &getPendingFunctions(const MutexGuard &L) {
46    return PendingFunctions;
47  }
48};
49
50
51class 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  JITCodeEmitter *JCE;     // JCE object
55
56  JITState *jitstate;
57
58  JIT(ModuleProvider *MP, TargetMachine &tm, TargetJITInfo &tji,
59      JITMemoryManager *JMM, CodeGenOpt::Level OptLevel);
60public:
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                                 CodeGenOpt::Level OptLevel =
76                                   CodeGenOpt::Default) {
77    return createJIT(MP, Err, 0, OptLevel);
78  }
79
80  virtual void addModuleProvider(ModuleProvider *MP);
81
82  /// removeModuleProvider - Remove a ModuleProvider from the list of modules.
83  /// Relases the Module from the ModuleProvider, materializing it in the
84  /// process, and returns the materialized Module.
85  virtual Module *removeModuleProvider(ModuleProvider *MP,
86                                       std::string *ErrInfo = 0);
87
88  /// deleteModuleProvider - Remove a ModuleProvider from the list of modules,
89  /// and deletes the ModuleProvider and owned Module.  Avoids materializing
90  /// the underlying module.
91  virtual void deleteModuleProvider(ModuleProvider *P,std::string *ErrInfo = 0);
92
93  /// runFunction - Start execution with the specified function and arguments.
94  ///
95  virtual GenericValue runFunction(Function *F,
96                                   const std::vector<GenericValue> &ArgValues);
97
98  /// getPointerToNamedFunction - This method returns the address of the
99  /// specified function by using the dlsym function call.  As such it is only
100  /// useful for resolving library symbols, not code generated symbols.
101  ///
102  /// If AbortOnFailure is false and no function with the given name is
103  /// found, this function silently returns a null pointer. Otherwise,
104  /// it prints a message to stderr and aborts.
105  ///
106  void *getPointerToNamedFunction(const std::string &Name,
107                                  bool AbortOnFailure = true);
108
109  // CompilationCallback - Invoked the first time that a call site is found,
110  // which causes lazy compilation of the target function.
111  //
112  static void CompilationCallback();
113
114  /// getPointerToFunction - This returns the address of the specified function,
115  /// compiling it if necessary.
116  ///
117  void *getPointerToFunction(Function *F);
118
119  /// getOrEmitGlobalVariable - Return the address of the specified global
120  /// variable, possibly emitting it to memory if needed.  This is used by the
121  /// Emitter.
122  void *getOrEmitGlobalVariable(const GlobalVariable *GV);
123
124  /// getPointerToFunctionOrStub - If the specified function has been
125  /// code-gen'd, return a pointer to the function.  If not, compile it, or use
126  /// a stub to implement lazy compilation if available.
127  ///
128  void *getPointerToFunctionOrStub(Function *F);
129
130  /// recompileAndRelinkFunction - This method is used to force a function
131  /// which has already been compiled, to be compiled again, possibly
132  /// after it has been modified. Then the entry to the old copy is overwritten
133  /// with a branch to the new copy. If there was no old copy, this acts
134  /// just like JIT::getPointerToFunction().
135  ///
136  void *recompileAndRelinkFunction(Function *F);
137
138  /// freeMachineCodeForFunction - deallocate memory used to code-generate this
139  /// Function.
140  ///
141  void freeMachineCodeForFunction(Function *F);
142
143  /// addPendingFunction - while jitting non-lazily, a called but non-codegen'd
144  /// function was encountered.  Add it to a pending list to be processed after
145  /// the current function.
146  ///
147  void addPendingFunction(Function *F);
148
149  /// getCodeEmitter - Return the code emitter this JIT is emitting into.
150  JITCodeEmitter *getCodeEmitter() const { return JCE; }
151
152  static ExecutionEngine *createJIT(ModuleProvider *MP, std::string *Err,
153                                    JITMemoryManager *JMM,
154                                    CodeGenOpt::Level OptLevel);
155
156
157  // Run the JIT on F and return information about the generated code
158  void runJITOnFunction(Function *F, MachineCodeInfo *MCI = 0);
159
160private:
161  static JITCodeEmitter *createEmitter(JIT &J, JITMemoryManager *JMM);
162  void registerMachineCodeInfo(MachineCodeInfo *MCI);
163  void runJITOnFunctionUnlocked(Function *F, const MutexGuard &locked);
164  void updateFunctionStub(Function *F);
165  void updateDlsymStubTable();
166
167protected:
168
169  /// getMemoryforGV - Allocate memory for a global variable.
170  virtual char* getMemoryForGV(const GlobalVariable* GV);
171
172};
173
174} // End llvm namespace
175
176#endif
177