1 //===-- RuntimeDyld.h - Run-time dynamic linker for MC-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 // Interface for the runtime dynamic linker facilities of the MC-JIT.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_EXECUTIONENGINE_RUNTIMEDYLD_H
15 #define LLVM_EXECUTIONENGINE_RUNTIMEDYLD_H
17 #include "JITSymbolFlags.h"
18 #include "llvm/ADT/STLExtras.h"
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/Object/ObjectFile.h"
21 #include "llvm/Support/Memory.h"
22 #include "llvm/DebugInfo/DIContext.h"
30 template <typename T> class OwningBinary;
33 class RuntimeDyldImpl;
34 class RuntimeDyldCheckerImpl;
37 friend class RuntimeDyldCheckerImpl;
39 RuntimeDyld(const RuntimeDyld &) = delete;
40 void operator=(const RuntimeDyld &) = delete;
43 // Change the address associated with a section when resolving relocations.
44 // Any relocations already associated with the symbol will be re-resolved.
45 void reassignSectionAddress(unsigned SectionID, uint64_t Addr);
48 /// \brief Information about a named symbol.
49 class SymbolInfo : public JITSymbolBase {
51 SymbolInfo(std::nullptr_t) : JITSymbolBase(JITSymbolFlags::None), Address(0) {}
52 SymbolInfo(uint64_t Address, JITSymbolFlags Flags)
53 : JITSymbolBase(Flags), Address(Address) {}
54 explicit operator bool() const { return Address != 0; }
55 uint64_t getAddress() const { return Address; }
60 /// \brief Information about the loaded object.
61 class LoadedObjectInfo : public llvm::LoadedObjectInfo {
62 friend class RuntimeDyldImpl;
64 typedef std::map<object::SectionRef, unsigned> ObjSectionToIDMap;
66 LoadedObjectInfo(RuntimeDyldImpl &RTDyld, ObjSectionToIDMap ObjSecToIDMap)
67 : RTDyld(RTDyld), ObjSecToIDMap(ObjSecToIDMap) { }
69 virtual object::OwningBinary<object::ObjectFile>
70 getObjectForDebug(const object::ObjectFile &Obj) const = 0;
72 uint64_t getSectionLoadAddress(const object::SectionRef &Sec) const;
75 virtual void anchor();
77 RuntimeDyldImpl &RTDyld;
78 ObjSectionToIDMap ObjSecToIDMap;
81 template <typename Derived> struct LoadedObjectInfoHelper : LoadedObjectInfo {
82 LoadedObjectInfoHelper(RuntimeDyldImpl &RTDyld,
83 LoadedObjectInfo::ObjSectionToIDMap ObjSecToIDMap)
84 : LoadedObjectInfo(RTDyld, std::move(ObjSecToIDMap)) {}
85 std::unique_ptr<llvm::LoadedObjectInfo> clone() const override {
86 return llvm::make_unique<Derived>(static_cast<const Derived &>(*this));
90 /// \brief Memory Management.
93 virtual ~MemoryManager() {}
95 /// Allocate a memory block of (at least) the given size suitable for
96 /// executable code. The SectionID is a unique identifier assigned by the
97 /// RuntimeDyld instance, and optionally recorded by the memory manager to
98 /// access a loaded section.
99 virtual uint8_t *allocateCodeSection(uintptr_t Size, unsigned Alignment,
101 StringRef SectionName) = 0;
103 /// Allocate a memory block of (at least) the given size suitable for data.
104 /// The SectionID is a unique identifier assigned by the JIT engine, and
105 /// optionally recorded by the memory manager to access a loaded section.
106 virtual uint8_t *allocateDataSection(uintptr_t Size, unsigned Alignment,
108 StringRef SectionName,
109 bool IsReadOnly) = 0;
111 /// Inform the memory manager about the total amount of memory required to
112 /// allocate all sections to be loaded:
113 /// \p CodeSize - the total size of all code sections
114 /// \p DataSizeRO - the total size of all read-only data sections
115 /// \p DataSizeRW - the total size of all read-write data sections
117 /// Note that by default the callback is disabled. To enable it
118 /// redefine the method needsToReserveAllocationSpace to return true.
119 virtual void reserveAllocationSpace(uintptr_t CodeSize,
120 uintptr_t DataSizeRO,
121 uintptr_t DataSizeRW) {}
123 /// Override to return true to enable the reserveAllocationSpace callback.
124 virtual bool needsToReserveAllocationSpace() { return false; }
126 /// Register the EH frames with the runtime so that c++ exceptions work.
128 /// \p Addr parameter provides the local address of the EH frame section
129 /// data, while \p LoadAddr provides the address of the data in the target
130 /// address space. If the section has not been remapped (which will usually
131 /// be the case for local execution) these two values will be the same.
132 virtual void registerEHFrames(uint8_t *Addr, uint64_t LoadAddr,
134 virtual void deregisterEHFrames(uint8_t *addr, uint64_t LoadAddr,
137 /// This method is called when object loading is complete and section page
138 /// permissions can be applied. It is up to the memory manager implementation
139 /// to decide whether or not to act on this method. The memory manager will
140 /// typically allocate all sections as read-write and then apply specific
141 /// permissions when this method is called. Code sections cannot be executed
142 /// until this function has been called. In addition, any cache coherency
143 /// operations needed to reliably use the memory are also performed.
145 /// Returns true if an error occurred, false otherwise.
146 virtual bool finalizeMemory(std::string *ErrMsg = nullptr) = 0;
149 virtual void anchor();
152 /// \brief Symbol resolution.
153 class SymbolResolver {
155 virtual ~SymbolResolver() {}
157 /// This method returns the address of the specified function or variable.
158 /// It is used to resolve symbols during module linking.
160 /// If the returned symbol's address is equal to ~0ULL then RuntimeDyld will
161 /// skip all relocations for that symbol, and the client will be responsible
162 /// for handling them manually.
163 virtual SymbolInfo findSymbol(const std::string &Name) = 0;
165 /// This method returns the address of the specified symbol if it exists
166 /// within the logical dynamic library represented by this
167 /// RTDyldMemoryManager. Unlike getSymbolAddress, queries through this
168 /// interface should return addresses for hidden symbols.
170 /// This is of particular importance for the Orc JIT APIs, which support lazy
171 /// compilation by breaking up modules: Each of those broken out modules
172 /// must be able to resolve hidden symbols provided by the others. Clients
173 /// writing memory managers for MCJIT can usually ignore this method.
175 /// This method will be queried by RuntimeDyld when checking for previous
176 /// definitions of common symbols. It will *not* be queried by default when
177 /// resolving external symbols (this minimises the link-time overhead for
178 /// MCJIT clients who don't care about Orc features). If you are writing a
179 /// RTDyldMemoryManager for Orc and want "external" symbol resolution to
180 /// search the logical dylib, you should override your getSymbolAddress
181 /// method call this method directly.
182 virtual SymbolInfo findSymbolInLogicalDylib(const std::string &Name) = 0;
184 virtual void anchor();
187 /// \brief Construct a RuntimeDyld instance.
188 RuntimeDyld(MemoryManager &MemMgr, SymbolResolver &Resolver);
191 /// Add the referenced object file to the list of objects to be loaded and
193 std::unique_ptr<LoadedObjectInfo> loadObject(const object::ObjectFile &O);
195 /// Get the address of our local copy of the symbol. This may or may not
196 /// be the address used for relocation (clients can copy the data around
197 /// and resolve relocatons based on where they put it).
198 void *getSymbolLocalAddress(StringRef Name) const;
200 /// Get the target address and flags for the named symbol.
201 /// This address is the one used for relocation.
202 SymbolInfo getSymbol(StringRef Name) const;
204 /// Resolve the relocations for all symbols we currently know about.
205 void resolveRelocations();
207 /// Map a section to its target address space value.
208 /// Map the address of a JIT section as returned from the memory manager
209 /// to the address in the target process as the running code will see it.
210 /// This is the address which will be used for relocation resolution.
211 void mapSectionAddress(const void *LocalAddress, uint64_t TargetAddress);
213 /// Register any EH frame sections that have been loaded but not previously
214 /// registered with the memory manager. Note, RuntimeDyld is responsible
215 /// for identifying the EH frame and calling the memory manager with the
216 /// EH frame section data. However, the memory manager itself will handle
217 /// the actual target-specific EH frame registration.
218 void registerEHFrames();
220 void deregisterEHFrames();
223 StringRef getErrorString();
225 /// By default, only sections that are "required for execution" are passed to
226 /// the RTDyldMemoryManager, and other sections are discarded. Passing 'true'
227 /// to this method will cause RuntimeDyld to pass all sections to its
228 /// memory manager regardless of whether they are "required to execute" in the
229 /// usual sense. This is useful for inspecting metadata sections that may not
230 /// contain relocations, E.g. Debug info, stackmaps.
232 /// Must be called before the first object file is loaded.
233 void setProcessAllSections(bool ProcessAllSections) {
234 assert(!Dyld && "setProcessAllSections must be called before loadObject.");
235 this->ProcessAllSections = ProcessAllSections;
239 // RuntimeDyldImpl is the actual class. RuntimeDyld is just the public
241 std::unique_ptr<RuntimeDyldImpl> Dyld;
242 MemoryManager &MemMgr;
243 SymbolResolver &Resolver;
244 bool ProcessAllSections;
245 RuntimeDyldCheckerImpl *Checker;
248 } // end namespace llvm