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/ObjectImage.h"
22 #include "llvm/ExecutionEngine/RuntimeDyld.h"
23 #include "llvm/ExecutionEngine/RuntimeDyldChecker.h"
24 #include "llvm/Object/ObjectFile.h"
25 #include "llvm/Support/Debug.h"
26 #include "llvm/Support/ErrorHandling.h"
27 #include "llvm/Support/Format.h"
28 #include "llvm/Support/Host.h"
29 #include "llvm/Support/Mutex.h"
30 #include "llvm/Support/SwapByteOrder.h"
31 #include "llvm/Support/raw_ostream.h"
33 #include <system_error>
36 using namespace llvm::object;
43 /// SectionEntry - represents a section emitted into memory by the dynamic
47 /// Name - section name.
50 /// Address - address in the linker's memory where the section resides.
53 /// Size - section size. Doesn't include the stubs.
56 /// LoadAddress - the address of the section in the target process's memory.
57 /// Used for situations in which JIT-ed code is being executed in the address
58 /// space of a separate process. If the code executes in the same address
59 /// space where it was JIT-ed, this just equals Address.
62 /// StubOffset - used for architectures with stub functions for far
63 /// relocations (like ARM).
66 /// ObjAddress - address of the section in the in-memory object file. Used
67 /// for calculating relocations in some object formats (like MachO).
70 SectionEntry(StringRef name, uint8_t *address, size_t size,
72 : Name(name), Address(address), Size(size),
73 LoadAddress(reinterpret_cast<uintptr_t>(address)), StubOffset(size),
74 ObjAddress(objAddress) {}
77 /// RelocationEntry - used to represent relocations internally in the dynamic
79 class RelocationEntry {
81 /// SectionID - the section this relocation points to.
84 /// Offset - offset into the section.
87 /// RelType - relocation type.
90 /// Addend - the relocation addend encoded in the instruction itself. Also
91 /// used to make a relocation section relative instead of symbol relative.
99 /// SymOffset - Section offset of the relocation entry's symbol (used for GOT
103 SectionPair Sections;
106 /// True if this is a PCRel relocation (MachO specific).
109 /// The size of this relocation (MachO specific).
112 RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend)
113 : SectionID(id), Offset(offset), RelType(type), Addend(addend),
114 SymOffset(0), IsPCRel(false), Size(0) {}
116 RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend,
118 : SectionID(id), Offset(offset), RelType(type), Addend(addend),
119 SymOffset(symoffset), IsPCRel(false), Size(0) {}
121 RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend,
122 bool IsPCRel, unsigned Size)
123 : SectionID(id), Offset(offset), RelType(type), Addend(addend),
124 SymOffset(0), IsPCRel(IsPCRel), Size(Size) {}
126 RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend,
127 unsigned SectionA, uint64_t SectionAOffset, unsigned SectionB,
128 uint64_t SectionBOffset, bool IsPCRel, unsigned Size)
129 : SectionID(id), Offset(offset), RelType(type),
130 Addend(SectionAOffset - SectionBOffset + addend), IsPCRel(IsPCRel),
132 Sections.SectionA = SectionA;
133 Sections.SectionB = SectionB;
137 class RelocationValueRef {
142 const char *SymbolName;
143 RelocationValueRef() : SectionID(0), Offset(0), Addend(0),
144 SymbolName(nullptr) {}
146 inline bool operator==(const RelocationValueRef &Other) const {
147 return SectionID == Other.SectionID && Offset == Other.Offset &&
148 Addend == Other.Addend && SymbolName == Other.SymbolName;
150 inline bool operator<(const RelocationValueRef &Other) const {
151 if (SectionID != Other.SectionID)
152 return SectionID < Other.SectionID;
153 if (Offset != Other.Offset)
154 return Offset < Other.Offset;
155 if (Addend != Other.Addend)
156 return Addend < Other.Addend;
157 return SymbolName < Other.SymbolName;
161 class RuntimeDyldImpl {
162 friend class RuntimeDyldCheckerImpl;
165 uint64_t getAnySymbolRemoteAddress(StringRef Symbol) {
166 if (uint64_t InternalSymbolAddr = getSymbolLoadAddress(Symbol))
167 return InternalSymbolAddr;
168 return MemMgr->getSymbolAddress(Symbol);
172 // The MemoryManager to load objects into.
173 RTDyldMemoryManager *MemMgr;
175 // Attached RuntimeDyldChecker instance. Null if no instance attached.
176 RuntimeDyldCheckerImpl *Checker;
178 // A list of all sections emitted by the dynamic linker. These sections are
179 // referenced in the code by means of their index in this list - SectionID.
180 typedef SmallVector<SectionEntry, 64> SectionList;
181 SectionList Sections;
183 typedef unsigned SID; // Type for SectionIDs
184 #define RTDYLD_INVALID_SECTION_ID ((SID)(-1))
186 // Keep a map of sections from object file to the SectionID which
188 typedef std::map<SectionRef, unsigned> ObjSectionToIDMap;
190 // A global symbol table for symbols from all loaded modules. Maps the
191 // symbol name to a (SectionID, offset in section) pair.
192 typedef std::pair<unsigned, uintptr_t> SymbolLoc;
193 typedef StringMap<SymbolLoc> SymbolTableMap;
194 SymbolTableMap GlobalSymbolTable;
196 // Pair representing the size and alignment requirement for a common symbol.
197 typedef std::pair<unsigned, unsigned> CommonSymbolInfo;
198 // Keep a map of common symbols to their info pairs
199 typedef std::map<SymbolRef, CommonSymbolInfo> CommonSymbolMap;
201 // For each symbol, keep a list of relocations based on it. Anytime
202 // its address is reassigned (the JIT re-compiled the function, e.g.),
203 // the relocations get re-resolved.
204 // The symbol (or section) the relocation is sourced from is the Key
205 // in the relocation list where it's stored.
206 typedef SmallVector<RelocationEntry, 64> RelocationList;
207 // Relocations to sections already loaded. Indexed by SectionID which is the
208 // source of the address. The target where the address will be written is
209 // SectionID/Offset in the relocation itself.
210 DenseMap<unsigned, RelocationList> Relocations;
212 // Relocations to external symbols that are not yet resolved. Symbols are
213 // external when they aren't found in the global symbol table of all loaded
214 // modules. This map is indexed by symbol name.
215 StringMap<RelocationList> ExternalSymbolRelocations;
218 typedef std::map<RelocationValueRef, uintptr_t> StubMap;
220 Triple::ArchType Arch;
221 bool IsTargetLittleEndian;
223 // True if all sections should be passed to the memory manager, false if only
224 // sections containing relocations should be. Defaults to 'false'.
225 bool ProcessAllSections;
227 // This mutex prevents simultaneously loading objects from two different
228 // threads. This keeps us from having to protect individual data structures
229 // and guarantees that section allocation requests to the memory manager
230 // won't be interleaved between modules. It is also used in mapSectionAddress
231 // and resolveRelocations to protect write access to internal data structures.
233 // loadObject may be called on the same thread during the handling of of
234 // processRelocations, and that's OK. The handling of the relocation lists
235 // is written in such a way as to work correctly if new elements are added to
236 // the end of the list while the list is being processed.
239 virtual unsigned getMaxStubSize() = 0;
240 virtual unsigned getStubAlignment() = 0;
243 std::string ErrorStr;
245 // Set the error state and record an error string.
246 bool Error(const Twine &Msg) {
247 ErrorStr = Msg.str();
252 uint64_t getSectionLoadAddress(unsigned SectionID) const {
253 return Sections[SectionID].LoadAddress;
256 uint8_t *getSectionAddress(unsigned SectionID) const {
257 return (uint8_t *)Sections[SectionID].Address;
260 void writeInt16BE(uint8_t *Addr, uint16_t Value) {
261 if (IsTargetLittleEndian)
262 sys::swapByteOrder(Value);
263 *Addr = (Value >> 8) & 0xFF;
264 *(Addr + 1) = Value & 0xFF;
267 void writeInt32BE(uint8_t *Addr, uint32_t Value) {
268 if (IsTargetLittleEndian)
269 sys::swapByteOrder(Value);
270 *Addr = (Value >> 24) & 0xFF;
271 *(Addr + 1) = (Value >> 16) & 0xFF;
272 *(Addr + 2) = (Value >> 8) & 0xFF;
273 *(Addr + 3) = Value & 0xFF;
276 void writeInt64BE(uint8_t *Addr, uint64_t Value) {
277 if (IsTargetLittleEndian)
278 sys::swapByteOrder(Value);
279 *Addr = (Value >> 56) & 0xFF;
280 *(Addr + 1) = (Value >> 48) & 0xFF;
281 *(Addr + 2) = (Value >> 40) & 0xFF;
282 *(Addr + 3) = (Value >> 32) & 0xFF;
283 *(Addr + 4) = (Value >> 24) & 0xFF;
284 *(Addr + 5) = (Value >> 16) & 0xFF;
285 *(Addr + 6) = (Value >> 8) & 0xFF;
286 *(Addr + 7) = Value & 0xFF;
289 /// Endian-aware read Read the least significant Size bytes from Src.
290 uint64_t readBytesUnaligned(uint8_t *Src, unsigned Size) const;
292 /// Endian-aware write. Write the least significant Size bytes from Value to
294 void writeBytesUnaligned(uint64_t Value, uint8_t *Dst, unsigned Size) const;
296 /// \brief Given the common symbols discovered in the object file, emit a
297 /// new section for them and update the symbol mappings in the object and
299 void emitCommonSymbols(ObjectImage &Obj, const CommonSymbolMap &CommonSymbols,
300 uint64_t TotalSize, SymbolTableMap &SymbolTable);
302 /// \brief Emits section data from the object file to the MemoryManager.
303 /// \param IsCode if it's true then allocateCodeSection() will be
304 /// used for emits, else allocateDataSection() will be used.
305 /// \return SectionID.
306 unsigned emitSection(ObjectImage &Obj, const SectionRef &Section,
309 /// \brief Find Section in LocalSections. If the secton is not found - emit
310 /// it and store in LocalSections.
311 /// \param IsCode if it's true then allocateCodeSection() will be
312 /// used for emmits, else allocateDataSection() will be used.
313 /// \return SectionID.
314 unsigned findOrEmitSection(ObjectImage &Obj, const SectionRef &Section,
315 bool IsCode, ObjSectionToIDMap &LocalSections);
317 // \brief Add a relocation entry that uses the given section.
318 void addRelocationForSection(const RelocationEntry &RE, unsigned SectionID);
320 // \brief Add a relocation entry that uses the given symbol. This symbol may
321 // be found in the global symbol table, or it may be external.
322 void addRelocationForSymbol(const RelocationEntry &RE, StringRef SymbolName);
324 /// \brief Emits long jump instruction to Addr.
325 /// \return Pointer to the memory area for emitting target address.
326 uint8_t *createStubFunction(uint8_t *Addr, unsigned AbiVariant = 0);
328 /// \brief Resolves relocations from Relocs list with address from Value.
329 void resolveRelocationList(const RelocationList &Relocs, uint64_t Value);
331 /// \brief A object file specific relocation resolver
332 /// \param RE The relocation to be resolved
333 /// \param Value Target symbol address to apply the relocation action
334 virtual void resolveRelocation(const RelocationEntry &RE, uint64_t Value) = 0;
336 /// \brief Parses one or more object file relocations (some object files use
337 /// relocation pairs) and stores it to Relocations or SymbolRelocations
338 /// (this depends on the object file type).
339 /// \return Iterator to the next relocation that needs to be parsed.
340 virtual relocation_iterator
341 processRelocationRef(unsigned SectionID, relocation_iterator RelI,
342 ObjectImage &Obj, ObjSectionToIDMap &ObjSectionToID,
343 const SymbolTableMap &Symbols, StubMap &Stubs) = 0;
345 /// \brief Resolve relocations to external symbols.
346 void resolveExternalSymbols();
348 /// \brief Update GOT entries for external symbols.
349 // The base class does nothing. ELF overrides this.
350 virtual void updateGOTEntries(StringRef Name, uint64_t Addr) {}
352 // \brief Compute an upper bound of the memory that is required to load all
354 void computeTotalAllocSize(ObjectImage &Obj, uint64_t &CodeSize,
355 uint64_t &DataSizeRO, uint64_t &DataSizeRW);
357 // \brief Compute the stub buffer size required for a section
358 unsigned computeSectionStubBufSize(ObjectImage &Obj,
359 const SectionRef &Section);
362 RuntimeDyldImpl(RTDyldMemoryManager *mm)
363 : MemMgr(mm), Checker(nullptr), ProcessAllSections(false), HasError(false) {
366 virtual ~RuntimeDyldImpl();
368 void setProcessAllSections(bool ProcessAllSections) {
369 this->ProcessAllSections = ProcessAllSections;
372 void setRuntimeDyldChecker(RuntimeDyldCheckerImpl *Checker) {
373 this->Checker = Checker;
376 std::unique_ptr<ObjectImage>
377 loadObject(std::unique_ptr<ObjectImage> InputObject);
379 uint8_t* getSymbolAddress(StringRef Name) const {
380 // FIXME: Just look up as a function for now. Overly simple of course.
382 SymbolTableMap::const_iterator pos = GlobalSymbolTable.find(Name);
383 if (pos == GlobalSymbolTable.end())
385 SymbolLoc Loc = pos->second;
386 return getSectionAddress(Loc.first) + Loc.second;
389 uint64_t getSymbolLoadAddress(StringRef Name) const {
390 // FIXME: Just look up as a function for now. Overly simple of course.
392 SymbolTableMap::const_iterator pos = GlobalSymbolTable.find(Name);
393 if (pos == GlobalSymbolTable.end())
395 SymbolLoc Loc = pos->second;
396 return getSectionLoadAddress(Loc.first) + Loc.second;
399 void resolveRelocations();
401 void reassignSectionAddress(unsigned SectionID, uint64_t Addr);
403 void mapSectionAddress(const void *LocalAddress, uint64_t TargetAddress);
405 // Is the linker in an error state?
406 bool hasError() { return HasError; }
408 // Mark the error condition as handled and continue.
409 void clearError() { HasError = false; }
411 // Get the error message.
412 StringRef getErrorString() { return ErrorStr; }
414 virtual bool isCompatibleFormat(const ObjectBuffer *Buffer) const = 0;
415 virtual bool isCompatibleFile(const ObjectFile *Obj) const = 0;
417 virtual void registerEHFrames();
419 virtual void deregisterEHFrames();
421 virtual void finalizeLoad(ObjectImage &ObjImg, ObjSectionToIDMap &SectionMap) {}
424 } // end namespace llvm