1 //===-- RuntimeDyldImpl.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 implementations of runtime dynamic linker facilities.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_LIB_EXECUTIONENGINE_RUNTIMEDYLD_RUNTIMEDYLDIMPL_H
15 #define LLVM_LIB_EXECUTIONENGINE_RUNTIMEDYLD_RUNTIMEDYLDIMPL_H
17 #include "llvm/ADT/DenseMap.h"
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/ADT/StringMap.h"
20 #include "llvm/ADT/Triple.h"
21 #include "llvm/ExecutionEngine/RuntimeDyld.h"
22 #include "llvm/ExecutionEngine/RuntimeDyldChecker.h"
23 #include "llvm/Object/ObjectFile.h"
24 #include "llvm/Support/Debug.h"
25 #include "llvm/Support/ErrorHandling.h"
26 #include "llvm/Support/Format.h"
27 #include "llvm/Support/Host.h"
28 #include "llvm/Support/Mutex.h"
29 #include "llvm/Support/SwapByteOrder.h"
30 #include "llvm/Support/raw_ostream.h"
32 #include <system_error>
35 using namespace llvm::object;
39 // Helper for extensive error checking in debug builds.
40 inline std::error_code Check(std::error_code Err) {
42 report_fatal_error(Err.message());
49 /// SectionEntry - represents a section emitted into memory by the dynamic
53 /// Name - section name.
56 /// Address - address in the linker's memory where the section resides.
59 /// Size - section size. Doesn't include the stubs.
62 /// LoadAddress - the address of the section in the target process's memory.
63 /// Used for situations in which JIT-ed code is being executed in the address
64 /// space of a separate process. If the code executes in the same address
65 /// space where it was JIT-ed, this just equals Address.
68 /// StubOffset - used for architectures with stub functions for far
69 /// relocations (like ARM).
72 /// ObjAddress - address of the section in the in-memory object file. Used
73 /// for calculating relocations in some object formats (like MachO).
76 SectionEntry(StringRef name, uint8_t *address, size_t size,
78 : Name(name), Address(address), Size(size),
79 LoadAddress(reinterpret_cast<uintptr_t>(address)), StubOffset(size),
80 ObjAddress(objAddress) {}
83 /// RelocationEntry - used to represent relocations internally in the dynamic
85 class RelocationEntry {
87 /// SectionID - the section this relocation points to.
90 /// Offset - offset into the section.
93 /// RelType - relocation type.
96 /// Addend - the relocation addend encoded in the instruction itself. Also
97 /// used to make a relocation section relative instead of symbol relative.
105 /// SymOffset - Section offset of the relocation entry's symbol (used for GOT
109 SectionPair Sections;
112 /// True if this is a PCRel relocation (MachO specific).
115 /// The size of this relocation (MachO specific).
118 RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend)
119 : SectionID(id), Offset(offset), RelType(type), Addend(addend),
120 SymOffset(0), IsPCRel(false), Size(0) {}
122 RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend,
124 : SectionID(id), Offset(offset), RelType(type), Addend(addend),
125 SymOffset(symoffset), IsPCRel(false), Size(0) {}
127 RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend,
128 bool IsPCRel, unsigned Size)
129 : SectionID(id), Offset(offset), RelType(type), Addend(addend),
130 SymOffset(0), IsPCRel(IsPCRel), Size(Size) {}
132 RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend,
133 unsigned SectionA, uint64_t SectionAOffset, unsigned SectionB,
134 uint64_t SectionBOffset, bool IsPCRel, unsigned Size)
135 : SectionID(id), Offset(offset), RelType(type),
136 Addend(SectionAOffset - SectionBOffset + addend), IsPCRel(IsPCRel),
138 Sections.SectionA = SectionA;
139 Sections.SectionB = SectionB;
143 class RelocationValueRef {
148 const char *SymbolName;
149 RelocationValueRef() : SectionID(0), Offset(0), Addend(0),
150 SymbolName(nullptr) {}
152 inline bool operator==(const RelocationValueRef &Other) const {
153 return SectionID == Other.SectionID && Offset == Other.Offset &&
154 Addend == Other.Addend && SymbolName == Other.SymbolName;
156 inline bool operator<(const RelocationValueRef &Other) const {
157 if (SectionID != Other.SectionID)
158 return SectionID < Other.SectionID;
159 if (Offset != Other.Offset)
160 return Offset < Other.Offset;
161 if (Addend != Other.Addend)
162 return Addend < Other.Addend;
163 return SymbolName < Other.SymbolName;
167 /// @brief Symbol info for RuntimeDyld.
168 class SymbolTableEntry : public JITSymbolBase {
171 : JITSymbolBase(JITSymbolFlags::None), Offset(0), SectionID(0) {}
173 SymbolTableEntry(unsigned SectionID, uint64_t Offset, JITSymbolFlags Flags)
174 : JITSymbolBase(Flags), Offset(Offset), SectionID(SectionID) {}
176 unsigned getSectionID() const { return SectionID; }
177 uint64_t getOffset() const { return Offset; }
184 typedef StringMap<SymbolTableEntry> RTDyldSymbolTable;
186 class RuntimeDyldImpl {
187 friend class RuntimeDyld::LoadedObjectInfo;
188 friend class RuntimeDyldCheckerImpl;
190 // The MemoryManager to load objects into.
191 RTDyldMemoryManager *MemMgr;
193 // Attached RuntimeDyldChecker instance. Null if no instance attached.
194 RuntimeDyldCheckerImpl *Checker;
196 // A list of all sections emitted by the dynamic linker. These sections are
197 // referenced in the code by means of their index in this list - SectionID.
198 typedef SmallVector<SectionEntry, 64> SectionList;
199 SectionList Sections;
201 typedef unsigned SID; // Type for SectionIDs
202 #define RTDYLD_INVALID_SECTION_ID ((SID)(-1))
204 // Keep a map of sections from object file to the SectionID which
206 typedef std::map<SectionRef, unsigned> ObjSectionToIDMap;
208 // A global symbol table for symbols from all loaded modules.
209 RTDyldSymbolTable GlobalSymbolTable;
211 // Keep a map of common symbols to their info pairs
212 typedef std::vector<SymbolRef> CommonSymbolList;
214 // For each symbol, keep a list of relocations based on it. Anytime
215 // its address is reassigned (the JIT re-compiled the function, e.g.),
216 // the relocations get re-resolved.
217 // The symbol (or section) the relocation is sourced from is the Key
218 // in the relocation list where it's stored.
219 typedef SmallVector<RelocationEntry, 64> RelocationList;
220 // Relocations to sections already loaded. Indexed by SectionID which is the
221 // source of the address. The target where the address will be written is
222 // SectionID/Offset in the relocation itself.
223 DenseMap<unsigned, RelocationList> Relocations;
225 // Relocations to external symbols that are not yet resolved. Symbols are
226 // external when they aren't found in the global symbol table of all loaded
227 // modules. This map is indexed by symbol name.
228 StringMap<RelocationList> ExternalSymbolRelocations;
231 typedef std::map<RelocationValueRef, uintptr_t> StubMap;
233 Triple::ArchType Arch;
234 bool IsTargetLittleEndian;
236 // True if all sections should be passed to the memory manager, false if only
237 // sections containing relocations should be. Defaults to 'false'.
238 bool ProcessAllSections;
240 // This mutex prevents simultaneously loading objects from two different
241 // threads. This keeps us from having to protect individual data structures
242 // and guarantees that section allocation requests to the memory manager
243 // won't be interleaved between modules. It is also used in mapSectionAddress
244 // and resolveRelocations to protect write access to internal data structures.
246 // loadObject may be called on the same thread during the handling of of
247 // processRelocations, and that's OK. The handling of the relocation lists
248 // is written in such a way as to work correctly if new elements are added to
249 // the end of the list while the list is being processed.
252 virtual unsigned getMaxStubSize() = 0;
253 virtual unsigned getStubAlignment() = 0;
256 std::string ErrorStr;
258 // Set the error state and record an error string.
259 bool Error(const Twine &Msg) {
260 ErrorStr = Msg.str();
265 uint64_t getSectionLoadAddress(unsigned SectionID) const {
266 return Sections[SectionID].LoadAddress;
269 uint8_t *getSectionAddress(unsigned SectionID) const {
270 return (uint8_t *)Sections[SectionID].Address;
273 void writeInt16BE(uint8_t *Addr, uint16_t Value) {
274 if (IsTargetLittleEndian)
275 sys::swapByteOrder(Value);
276 *Addr = (Value >> 8) & 0xFF;
277 *(Addr + 1) = Value & 0xFF;
280 void writeInt32BE(uint8_t *Addr, uint32_t Value) {
281 if (IsTargetLittleEndian)
282 sys::swapByteOrder(Value);
283 *Addr = (Value >> 24) & 0xFF;
284 *(Addr + 1) = (Value >> 16) & 0xFF;
285 *(Addr + 2) = (Value >> 8) & 0xFF;
286 *(Addr + 3) = Value & 0xFF;
289 void writeInt64BE(uint8_t *Addr, uint64_t Value) {
290 if (IsTargetLittleEndian)
291 sys::swapByteOrder(Value);
292 *Addr = (Value >> 56) & 0xFF;
293 *(Addr + 1) = (Value >> 48) & 0xFF;
294 *(Addr + 2) = (Value >> 40) & 0xFF;
295 *(Addr + 3) = (Value >> 32) & 0xFF;
296 *(Addr + 4) = (Value >> 24) & 0xFF;
297 *(Addr + 5) = (Value >> 16) & 0xFF;
298 *(Addr + 6) = (Value >> 8) & 0xFF;
299 *(Addr + 7) = Value & 0xFF;
302 /// Endian-aware read Read the least significant Size bytes from Src.
303 uint64_t readBytesUnaligned(uint8_t *Src, unsigned Size) const;
305 /// Endian-aware write. Write the least significant Size bytes from Value to
307 void writeBytesUnaligned(uint64_t Value, uint8_t *Dst, unsigned Size) const;
309 /// \brief Given the common symbols discovered in the object file, emit a
310 /// new section for them and update the symbol mappings in the object and
312 void emitCommonSymbols(const ObjectFile &Obj, CommonSymbolList &CommonSymbols);
314 /// \brief Emits section data from the object file to the MemoryManager.
315 /// \param IsCode if it's true then allocateCodeSection() will be
316 /// used for emits, else allocateDataSection() will be used.
317 /// \return SectionID.
318 unsigned emitSection(const ObjectFile &Obj, const SectionRef &Section,
321 /// \brief Find Section in LocalSections. If the secton is not found - emit
322 /// it and store in LocalSections.
323 /// \param IsCode if it's true then allocateCodeSection() will be
324 /// used for emmits, else allocateDataSection() will be used.
325 /// \return SectionID.
326 unsigned findOrEmitSection(const ObjectFile &Obj, const SectionRef &Section,
327 bool IsCode, ObjSectionToIDMap &LocalSections);
329 // \brief Add a relocation entry that uses the given section.
330 void addRelocationForSection(const RelocationEntry &RE, unsigned SectionID);
332 // \brief Add a relocation entry that uses the given symbol. This symbol may
333 // be found in the global symbol table, or it may be external.
334 void addRelocationForSymbol(const RelocationEntry &RE, StringRef SymbolName);
336 /// \brief Emits long jump instruction to Addr.
337 /// \return Pointer to the memory area for emitting target address.
338 uint8_t *createStubFunction(uint8_t *Addr, unsigned AbiVariant = 0);
340 /// \brief Resolves relocations from Relocs list with address from Value.
341 void resolveRelocationList(const RelocationList &Relocs, uint64_t Value);
343 /// \brief A object file specific relocation resolver
344 /// \param RE The relocation to be resolved
345 /// \param Value Target symbol address to apply the relocation action
346 virtual void resolveRelocation(const RelocationEntry &RE, uint64_t Value) = 0;
348 /// \brief Parses one or more object file relocations (some object files use
349 /// relocation pairs) and stores it to Relocations or SymbolRelocations
350 /// (this depends on the object file type).
351 /// \return Iterator to the next relocation that needs to be parsed.
352 virtual relocation_iterator
353 processRelocationRef(unsigned SectionID, relocation_iterator RelI,
354 const ObjectFile &Obj, ObjSectionToIDMap &ObjSectionToID,
357 /// \brief Resolve relocations to external symbols.
358 void resolveExternalSymbols();
360 /// \brief Update GOT entries for external symbols.
361 // The base class does nothing. ELF overrides this.
362 virtual void updateGOTEntries(StringRef Name, uint64_t Addr) {}
364 // \brief Compute an upper bound of the memory that is required to load all
366 void computeTotalAllocSize(const ObjectFile &Obj, uint64_t &CodeSize,
367 uint64_t &DataSizeRO, uint64_t &DataSizeRW);
369 // \brief Compute the stub buffer size required for a section
370 unsigned computeSectionStubBufSize(const ObjectFile &Obj,
371 const SectionRef &Section);
373 // \brief Implementation of the generic part of the loadObject algorithm.
374 std::pair<unsigned, unsigned> loadObjectImpl(const object::ObjectFile &Obj);
377 RuntimeDyldImpl(RTDyldMemoryManager *mm)
378 : MemMgr(mm), Checker(nullptr), ProcessAllSections(false), HasError(false) {
381 virtual ~RuntimeDyldImpl();
383 void setProcessAllSections(bool ProcessAllSections) {
384 this->ProcessAllSections = ProcessAllSections;
387 void setRuntimeDyldChecker(RuntimeDyldCheckerImpl *Checker) {
388 this->Checker = Checker;
391 virtual std::unique_ptr<RuntimeDyld::LoadedObjectInfo>
392 loadObject(const object::ObjectFile &Obj) = 0;
394 uint8_t* getSymbolLocalAddress(StringRef Name) const {
395 // FIXME: Just look up as a function for now. Overly simple of course.
397 RTDyldSymbolTable::const_iterator pos = GlobalSymbolTable.find(Name);
398 if (pos == GlobalSymbolTable.end())
400 const auto &SymInfo = pos->second;
401 return getSectionAddress(SymInfo.getSectionID()) + SymInfo.getOffset();
404 RuntimeDyld::SymbolInfo getSymbol(StringRef Name) const {
405 // FIXME: Just look up as a function for now. Overly simple of course.
407 RTDyldSymbolTable::const_iterator pos = GlobalSymbolTable.find(Name);
408 if (pos == GlobalSymbolTable.end())
410 const auto &SymEntry = pos->second;
411 uint64_t TargetAddr =
412 getSectionLoadAddress(SymEntry.getSectionID()) + SymEntry.getOffset();
413 return RuntimeDyld::SymbolInfo(TargetAddr, SymEntry.getFlags());
416 void resolveRelocations();
418 void reassignSectionAddress(unsigned SectionID, uint64_t Addr);
420 void mapSectionAddress(const void *LocalAddress, uint64_t TargetAddress);
422 // Is the linker in an error state?
423 bool hasError() { return HasError; }
425 // Mark the error condition as handled and continue.
426 void clearError() { HasError = false; }
428 // Get the error message.
429 StringRef getErrorString() { return ErrorStr; }
431 virtual bool isCompatibleFile(const ObjectFile &Obj) const = 0;
433 virtual void registerEHFrames();
435 virtual void deregisterEHFrames();
437 virtual void finalizeLoad(const ObjectFile &ObjImg,
438 ObjSectionToIDMap &SectionMap) {}
441 } // end namespace llvm