LLVM 17.0.0git
MCJIT.h
Go to the documentation of this file.
1//===-- MCJIT.h - Class definition for the MCJIT ----------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_LIB_EXECUTIONENGINE_MCJIT_MCJIT_H
10#define LLVM_LIB_EXECUTIONENGINE_MCJIT_MCJIT_H
11
17
18namespace llvm {
19class MCJIT;
20class Module;
21class ObjectCache;
22
23// This is a helper class that the MCJIT execution engine uses for linking
24// functions across modules that it owns. It aggregates the memory manager
25// that is passed in to the MCJIT constructor and defers most functionality
26// to that object.
28public:
30 std::shared_ptr<LegacyJITSymbolResolver> Resolver)
31 : ParentEngine(Parent), ClientResolver(std::move(Resolver)) {}
32
33 JITSymbol findSymbol(const std::string &Name) override;
34
35 // MCJIT doesn't support logical dylibs.
36 JITSymbol findSymbolInLogicalDylib(const std::string &Name) override {
37 return nullptr;
38 }
39
40private:
41 MCJIT &ParentEngine;
42 std::shared_ptr<LegacyJITSymbolResolver> ClientResolver;
43 void anchor() override;
44};
45
46// About Module states: added->loaded->finalized.
47//
48// The purpose of the "added" state is having modules in standby. (added=known
49// but not compiled). The idea is that you can add a module to provide function
50// definitions but if nothing in that module is referenced by a module in which
51// a function is executed (note the wording here because it's not exactly the
52// ideal case) then the module never gets compiled. This is sort of lazy
53// compilation.
54//
55// The purpose of the "loaded" state (loaded=compiled and required sections
56// copied into local memory but not yet ready for execution) is to have an
57// intermediate state wherein clients can remap the addresses of sections, using
58// MCJIT::mapSectionAddress, (in preparation for later copying to a new location
59// or an external process) before relocations and page permissions are applied.
60//
61// It might not be obvious at first glance, but the "remote-mcjit" case in the
62// lli tool does this. In that case, the intermediate action is taken by the
63// RemoteMemoryManager in response to the notifyObjectLoaded function being
64// called.
65
66class MCJIT : public ExecutionEngine {
67 MCJIT(std::unique_ptr<Module> M, std::unique_ptr<TargetMachine> tm,
68 std::shared_ptr<MCJITMemoryManager> MemMgr,
69 std::shared_ptr<LegacyJITSymbolResolver> Resolver);
70
72
73 class OwningModuleContainer {
74 public:
75 OwningModuleContainer() = default;
76 ~OwningModuleContainer() {
77 freeModulePtrSet(AddedModules);
78 freeModulePtrSet(LoadedModules);
79 freeModulePtrSet(FinalizedModules);
80 }
81
82 ModulePtrSet::iterator begin_added() { return AddedModules.begin(); }
83 ModulePtrSet::iterator end_added() { return AddedModules.end(); }
85 return make_range(begin_added(), end_added());
86 }
87
88 ModulePtrSet::iterator begin_loaded() { return LoadedModules.begin(); }
89 ModulePtrSet::iterator end_loaded() { return LoadedModules.end(); }
90
91 ModulePtrSet::iterator begin_finalized() { return FinalizedModules.begin(); }
92 ModulePtrSet::iterator end_finalized() { return FinalizedModules.end(); }
93
94 void addModule(std::unique_ptr<Module> M) {
95 AddedModules.insert(M.release());
96 }
97
98 bool removeModule(Module *M) {
99 return AddedModules.erase(M) || LoadedModules.erase(M) ||
100 FinalizedModules.erase(M);
101 }
102
103 bool hasModuleBeenAddedButNotLoaded(Module *M) {
104 return AddedModules.contains(M);
105 }
106
107 bool hasModuleBeenLoaded(Module *M) {
108 // If the module is in either the "loaded" or "finalized" sections it
109 // has been loaded.
110 return LoadedModules.contains(M) || FinalizedModules.contains(M);
111 }
112
113 bool hasModuleBeenFinalized(Module *M) {
114 return FinalizedModules.contains(M);
115 }
116
117 bool ownsModule(Module* M) {
118 return AddedModules.contains(M) || LoadedModules.contains(M) ||
119 FinalizedModules.contains(M);
120 }
121
122 void markModuleAsLoaded(Module *M) {
123 // This checks against logic errors in the MCJIT implementation.
124 // This function should never be called with either a Module that MCJIT
125 // does not own or a Module that has already been loaded and/or finalized.
126 assert(AddedModules.count(M) &&
127 "markModuleAsLoaded: Module not found in AddedModules");
128
129 // Remove the module from the "Added" set.
130 AddedModules.erase(M);
131
132 // Add the Module to the "Loaded" set.
133 LoadedModules.insert(M);
134 }
135
136 void markModuleAsFinalized(Module *M) {
137 // This checks against logic errors in the MCJIT implementation.
138 // This function should never be called with either a Module that MCJIT
139 // does not own, a Module that has not been loaded or a Module that has
140 // already been finalized.
141 assert(LoadedModules.count(M) &&
142 "markModuleAsFinalized: Module not found in LoadedModules");
143
144 // Remove the module from the "Loaded" section of the list.
145 LoadedModules.erase(M);
146
147 // Add the Module to the "Finalized" section of the list by inserting it
148 // before the 'end' iterator.
149 FinalizedModules.insert(M);
150 }
151
152 void markAllLoadedModulesAsFinalized() {
153 for (Module *M : LoadedModules)
154 FinalizedModules.insert(M);
155 LoadedModules.clear();
156 }
157
158 private:
159 ModulePtrSet AddedModules;
160 ModulePtrSet LoadedModules;
161 ModulePtrSet FinalizedModules;
162
163 void freeModulePtrSet(ModulePtrSet& MPS) {
164 // Go through the module set and delete everything.
165 for (Module *M : MPS)
166 delete M;
167 MPS.clear();
168 }
169 };
170
171 std::unique_ptr<TargetMachine> TM;
172 MCContext *Ctx;
173 std::shared_ptr<MCJITMemoryManager> MemMgr;
175 RuntimeDyld Dyld;
176 std::vector<JITEventListener*> EventListeners;
177
178 OwningModuleContainer OwnedModules;
179
182
184
185 // An optional ObjectCache to be notified of compiled objects and used to
186 // perform lookup of pre-compiled code to avoid re-compilation.
187 ObjectCache *ObjCache;
188
189 Function *FindFunctionNamedInModulePtrSet(StringRef FnName,
192
193 GlobalVariable *FindGlobalVariableNamedInModulePtrSet(StringRef Name,
194 bool AllowInternal,
197
198 void runStaticConstructorsDestructorsInModulePtrSet(bool isDtors,
201
202public:
203 ~MCJIT() override;
204
205 /// @name ExecutionEngine interface implementation
206 /// @{
207 void addModule(std::unique_ptr<Module> M) override;
208 void addObjectFile(std::unique_ptr<object::ObjectFile> O) override;
211 bool removeModule(Module *M) override;
212
213 /// FindFunctionNamed - Search all of the active modules to find the function that
214 /// defines FnName. This is very slow operation and shouldn't be used for
215 /// general code.
216 Function *FindFunctionNamed(StringRef FnName) override;
217
218 /// FindGlobalVariableNamed - Search all of the active modules to find the
219 /// global variable that defines Name. This is very slow operation and
220 /// shouldn't be used for general code.
222 bool AllowInternal = false) override;
223
224 /// Sets the object manager that MCJIT should use to avoid compilation.
225 void setObjectCache(ObjectCache *manager) override;
226
227 void setProcessAllSections(bool ProcessAllSections) override {
228 Dyld.setProcessAllSections(ProcessAllSections);
229 }
230
231 void generateCodeForModule(Module *M) override;
232
233 /// finalizeObject - ensure the module is fully processed and is usable.
234 ///
235 /// It is the user-level function for completing the process of making the
236 /// object usable for execution. It should be called after sections within an
237 /// object have been relocated using mapSectionAddress. When this method is
238 /// called the MCJIT execution engine will reapply relocations for a loaded
239 /// object.
240 /// Is it OK to finalize a set of modules, add modules and finalize again.
241 // FIXME: Do we really need both of these?
242 void finalizeObject() override;
243 virtual void finalizeModule(Module *);
245
246 /// runStaticConstructorsDestructors - This method is used to execute all of
247 /// the static constructors or destructors for a program.
248 ///
249 /// \param isDtors - Run the destructors instead of constructors.
250 void runStaticConstructorsDestructors(bool isDtors) override;
251
252 void *getPointerToFunction(Function *F) override;
253
255 ArrayRef<GenericValue> ArgValues) override;
256
257 /// getPointerToNamedFunction - This method returns the address of the
258 /// specified function by using the dlsym function call. As such it is only
259 /// useful for resolving library symbols, not code generated symbols.
260 ///
261 /// If AbortOnFailure is false and no function with the given name is
262 /// found, this function silently returns a null pointer. Otherwise,
263 /// it prints a message to stderr and aborts.
264 ///
266 bool AbortOnFailure = true) override;
267
268 /// mapSectionAddress - map a section to its target address space value.
269 /// Map the address of a JIT section as returned from the memory manager
270 /// to the address in the target process as the running code will see it.
271 /// This is the address which will be used for relocation resolution.
272 void mapSectionAddress(const void *LocalAddress,
273 uint64_t TargetAddress) override {
274 Dyld.mapSectionAddress(LocalAddress, TargetAddress);
275 }
278
279 // If successful, these function will implicitly finalize all loaded objects.
280 // To get a function address within MCJIT without causing a finalize, use
281 // getSymbolAddress.
282 uint64_t getGlobalValueAddress(const std::string &Name) override;
283 uint64_t getFunctionAddress(const std::string &Name) override;
284
285 TargetMachine *getTargetMachine() override { return TM.get(); }
286
287 /// @}
288 /// @name (Private) Registration Interfaces
289 /// @{
290
291 static void Register() {
293 }
294
295 static ExecutionEngine *
296 createJIT(std::unique_ptr<Module> M, std::string *ErrorStr,
297 std::shared_ptr<MCJITMemoryManager> MemMgr,
298 std::shared_ptr<LegacyJITSymbolResolver> Resolver,
299 std::unique_ptr<TargetMachine> TM);
300
301 // @}
302
303 // Takes a mangled name and returns the corresponding JITSymbol (if a
304 // definition of that mangled name has been added to the JIT).
305 JITSymbol findSymbol(const std::string &Name, bool CheckFunctionsOnly);
306
307 // DEPRECATED - Please use findSymbol instead.
308 //
309 // This is not directly exposed via the ExecutionEngine API, but it is
310 // used by the LinkingMemoryManager.
311 //
312 // getSymbolAddress takes an unmangled name and returns the corresponding
313 // JITSymbol if a definition of the name has been added to the JIT.
314 uint64_t getSymbolAddress(const std::string &Name,
315 bool CheckFunctionsOnly);
316
317protected:
318 /// emitObject -- Generate a JITed object in memory from the specified module
319 /// Currently, MCJIT only supports a single module and the module passed to
320 /// this function call is expected to be the contained module. The module
321 /// is passed as a parameter here to prepare for multiple module support in
322 /// the future.
323 std::unique_ptr<MemoryBuffer> emitObject(Module *M);
324
328
329 JITSymbol findExistingSymbol(const std::string &Name);
330 Module *findModuleForSymbol(const std::string &Name, bool CheckFunctionsOnly);
331};
332
333} // end llvm namespace
334
335#endif // LLVM_LIB_EXECUTIONENGINE_MCJIT_MCJIT_H
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
std::string Name
#define F(x, y, z)
Definition: MD5.cpp:55
#define I(x, y, z)
Definition: MD5.cpp:58
Machine Check Debug Module
const char LLVMTargetMachineRef TM
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
This file defines the SmallPtrSet class.
This file defines the SmallVector class.
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: ArrayRef.h:41
Abstract interface for implementation execution of LLVM modules, designed to support both interpreter...
static ExecutionEngine *(* MCJITCtor)(std::unique_ptr< Module > M, std::string *ErrorStr, std::shared_ptr< MCJITMemoryManager > MM, std::shared_ptr< LegacyJITSymbolResolver > SR, std::unique_ptr< TargetMachine > TM)
JITEventListener - Abstract interface for use by the JIT to notify clients about significant events d...
Represents a symbol in the JIT.
Definition: JITSymbol.h:265
Legacy symbol resolution interface.
Definition: JITSymbol.h:401
LinkingSymbolResolver(MCJIT &Parent, std::shared_ptr< LegacyJITSymbolResolver > Resolver)
Definition: MCJIT.h:29
JITSymbol findSymbol(const std::string &Name) override
This method returns the address of the specified function or variable.
Definition: MCJIT.cpp:675
JITSymbol findSymbolInLogicalDylib(const std::string &Name) override
This method returns the address of the specified symbol if it exists within the logical dynamic libra...
Definition: MCJIT.h:36
Context object for machine code objects.
Definition: MCContext.h:76
GenericValue runFunction(Function *F, ArrayRef< GenericValue > ArgValues) override
runFunction - Execute the specified function with the specified arguments, and return the result.
Definition: MCJIT.cpp:513
void setProcessAllSections(bool ProcessAllSections) override
setProcessAllSections (MCJIT Only): By default, only sections that are "required for execution" are p...
Definition: MCJIT.h:227
void * getPointerToNamedFunction(StringRef Name, bool AbortOnFailure=true) override
getPointerToNamedFunction - This method returns the address of the specified function by using the dl...
Definition: MCJIT.cpp:616
void RegisterJITEventListener(JITEventListener *L) override
Registers a listener to be called back on various events within the JIT.
Definition: MCJIT.cpp:638
static ExecutionEngine * createJIT(std::unique_ptr< Module > M, std::string *ErrorStr, std::shared_ptr< MCJITMemoryManager > MemMgr, std::shared_ptr< LegacyJITSymbolResolver > Resolver, std::unique_ptr< TargetMachine > TM)
Definition: MCJIT.cpp:45
void runStaticConstructorsDestructors(bool isDtors) override
runStaticConstructorsDestructors - This method is used to execute all of the static constructors or d...
Definition: MCJIT.cpp:455
Module * findModuleForSymbol(const std::string &Name, bool CheckFunctionsOnly)
Definition: MCJIT.cpp:295
void addArchive(object::OwningBinary< object::Archive > O) override
addArchive - Add an Archive to the execution engine.
Definition: MCJIT.cpp:137
Function * FindFunctionNamed(StringRef FnName) override
FindFunctionNamed - Search all of the active modules to find the function that defines FnName.
Definition: MCJIT.cpp:489
~MCJIT() override
Definition: MCJIT.cpp:93
void finalizeObject() override
finalizeObject - ensure the module is fully processed and is usable.
Definition: MCJIT.cpp:258
void finalizeLoadedModules()
Definition: MCJIT.cpp:238
void notifyObjectLoaded(const object::ObjectFile &Obj, const RuntimeDyld::LoadedObjectInfo &L)
Definition: MCJIT.cpp:656
void generateCodeForModule(Module *M) override
generateCodeForModule - Run code generation for the specified module and load it into memory.
Definition: MCJIT.cpp:189
uint64_t getFunctionAddress(const std::string &Name) override
getFunctionAddress - Return the address of the specified function.
Definition: MCJIT.cpp:404
void addObjectFile(std::unique_ptr< object::ObjectFile > O) override
addObjectFile - Add an ObjectFile to the execution engine.
Definition: MCJIT.cpp:119
std::unique_ptr< MemoryBuffer > emitObject(Module *M)
emitObject – Generate a JITed object in memory from the specified module Currently,...
Definition: MCJIT.cpp:146
TargetMachine * getTargetMachine() override
Return the target machine (if available).
Definition: MCJIT.h:285
static void Register()
Definition: MCJIT.h:291
void UnregisterJITEventListener(JITEventListener *L) override
Definition: MCJIT.cpp:645
bool removeModule(Module *M) override
removeModule - Removes a Module from the list of modules, but does not free the module's memory.
Definition: MCJIT.cpp:114
void mapSectionAddress(const void *LocalAddress, uint64_t TargetAddress) override
mapSectionAddress - map a section to its target address space value.
Definition: MCJIT.h:272
JITSymbol findExistingSymbol(const std::string &Name)
Definition: MCJIT.cpp:286
GlobalVariable * FindGlobalVariableNamed(StringRef Name, bool AllowInternal=false) override
FindGlobalVariableNamed - Search all of the active modules to find the global variable that defines N...
Definition: MCJIT.cpp:501
uint64_t getGlobalValueAddress(const std::string &Name) override
getGlobalValueAddress - Return the address of the specified global value.
Definition: MCJIT.cpp:396
uint64_t getSymbolAddress(const std::string &Name, bool CheckFunctionsOnly)
Definition: MCJIT.cpp:322
void notifyFreeingObject(const object::ObjectFile &Obj)
Definition: MCJIT.cpp:666
virtual void finalizeModule(Module *)
Definition: MCJIT.cpp:273
JITSymbol findSymbol(const std::string &Name, bool CheckFunctionsOnly)
Definition: MCJIT.cpp:339
void * getPointerToFunction(Function *F) override
getPointerToFunction - The different EE's represent function bodies in different ways.
Definition: MCJIT.cpp:413
void setObjectCache(ObjectCache *manager) override
Sets the object manager that MCJIT should use to avoid compilation.
Definition: MCJIT.cpp:141
void addModule(std::unique_ptr< Module > M) override
Add a Module to the list of modules that we can JIT from.
Definition: MCJIT.cpp:105
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
This is the base ObjectCache type which can be provided to an ExecutionEngine for the purpose of avoi...
Definition: ObjectCache.h:23
Interface for looking up the initializer for a variable name, used by Init::resolveReferences.
Definition: Record.h:2137
Information about the loaded object.
Definition: RuntimeDyld.h:69
void mapSectionAddress(const void *LocalAddress, uint64_t TargetAddress)
Map a section to its target address space value.
void setProcessAllSections(bool ProcessAllSections)
By default, only sections that are "required for execution" are passed to the RTDyldMemoryManager,...
Definition: RuntimeDyld.h:262
SmallPtrSetIterator - This implements a const_iterator for SmallPtrSet.
Definition: SmallPtrSet.h:268
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
Definition: SmallPtrSet.h:450
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1200
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
Primary interface to the complete machine description for the target machine.
Definition: TargetMachine.h:78
A range adaptor for a pair of iterators.
This class is the base class for all object file types.
Definition: ObjectFile.h:228
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1862
Definition: BitVector.h:851