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