22d39408a5984e8e263878b347623a78e882e427
[oota-llvm.git] / lib / ExecutionEngine / RuntimeDyld / RuntimeDyldImpl.h
1 //===-- RuntimeDyldImpl.h - Run-time dynamic linker for MC-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 // Interface for the implementations of runtime dynamic linker facilities.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_LIB_EXECUTIONENGINE_RUNTIMEDYLD_RUNTIMEDYLDIMPL_H
15 #define LLVM_LIB_EXECUTIONENGINE_RUNTIMEDYLD_RUNTIMEDYLDIMPL_H
16
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"
31 #include <map>
32 #include <system_error>
33
34 using namespace llvm;
35 using namespace llvm::object;
36
37 namespace llvm {
38
39 class Twine;
40
41 /// SectionEntry - represents a section emitted into memory by the dynamic
42 /// linker.
43 class SectionEntry {
44 public:
45   /// Name - section name.
46   StringRef Name;
47
48   /// Address - address in the linker's memory where the section resides.
49   uint8_t *Address;
50
51   /// Size - section size. Doesn't include the stubs.
52   size_t Size;
53
54   /// LoadAddress - the address of the section in the target process's memory.
55   /// Used for situations in which JIT-ed code is being executed in the address
56   /// space of a separate process.  If the code executes in the same address
57   /// space where it was JIT-ed, this just equals Address.
58   uint64_t LoadAddress;
59
60   /// StubOffset - used for architectures with stub functions for far
61   /// relocations (like ARM).
62   uintptr_t StubOffset;
63
64   /// ObjAddress - address of the section in the in-memory object file.  Used
65   /// for calculating relocations in some object formats (like MachO).
66   uintptr_t ObjAddress;
67
68   SectionEntry(StringRef name, uint8_t *address, size_t size,
69                uintptr_t objAddress)
70       : Name(name), Address(address), Size(size),
71         LoadAddress(reinterpret_cast<uintptr_t>(address)), StubOffset(size),
72         ObjAddress(objAddress) {}
73 };
74
75 /// RelocationEntry - used to represent relocations internally in the dynamic
76 /// linker.
77 class RelocationEntry {
78 public:
79   /// SectionID - the section this relocation points to.
80   unsigned SectionID;
81
82   /// Offset - offset into the section.
83   uint64_t Offset;
84
85   /// RelType - relocation type.
86   uint32_t RelType;
87
88   /// Addend - the relocation addend encoded in the instruction itself.  Also
89   /// used to make a relocation section relative instead of symbol relative.
90   int64_t Addend;
91
92   struct SectionPair {
93       uint32_t SectionA;
94       uint32_t SectionB;
95   };
96
97   /// SymOffset - Section offset of the relocation entry's symbol (used for GOT
98   /// lookup).
99   union {
100     uint64_t SymOffset;
101     SectionPair Sections;
102   };
103
104   /// True if this is a PCRel relocation (MachO specific).
105   bool IsPCRel;
106
107   /// The size of this relocation (MachO specific).
108   unsigned Size;
109
110   RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend)
111       : SectionID(id), Offset(offset), RelType(type), Addend(addend),
112         SymOffset(0), IsPCRel(false), Size(0) {}
113
114   RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend,
115                   uint64_t symoffset)
116       : SectionID(id), Offset(offset), RelType(type), Addend(addend),
117         SymOffset(symoffset), IsPCRel(false), Size(0) {}
118
119   RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend,
120                   bool IsPCRel, unsigned Size)
121       : SectionID(id), Offset(offset), RelType(type), Addend(addend),
122         SymOffset(0), IsPCRel(IsPCRel), Size(Size) {}
123
124   RelocationEntry(unsigned id, uint64_t offset, uint32_t type, int64_t addend,
125                   unsigned SectionA, uint64_t SectionAOffset, unsigned SectionB,
126                   uint64_t SectionBOffset, bool IsPCRel, unsigned Size)
127       : SectionID(id), Offset(offset), RelType(type),
128         Addend(SectionAOffset - SectionBOffset + addend), IsPCRel(IsPCRel),
129         Size(Size) {
130     Sections.SectionA = SectionA;
131     Sections.SectionB = SectionB;
132   }
133 };
134
135 class RelocationValueRef {
136 public:
137   unsigned SectionID;
138   uint64_t Offset;
139   int64_t Addend;
140   const char *SymbolName;
141   RelocationValueRef() : SectionID(0), Offset(0), Addend(0),
142                          SymbolName(nullptr) {}
143
144   inline bool operator==(const RelocationValueRef &Other) const {
145     return SectionID == Other.SectionID && Offset == Other.Offset &&
146            Addend == Other.Addend && SymbolName == Other.SymbolName;
147   }
148   inline bool operator<(const RelocationValueRef &Other) const {
149     if (SectionID != Other.SectionID)
150       return SectionID < Other.SectionID;
151     if (Offset != Other.Offset)
152       return Offset < Other.Offset;
153     if (Addend != Other.Addend)
154       return Addend < Other.Addend;
155     return SymbolName < Other.SymbolName;
156   }
157 };
158
159 class RuntimeDyldImpl {
160   friend class RuntimeDyld::LoadedObjectInfo;
161   friend class RuntimeDyldCheckerImpl;
162 private:
163
164   uint64_t getAnySymbolRemoteAddress(StringRef Symbol) {
165     if (uint64_t InternalSymbolAddr = getSymbolLoadAddress(Symbol))
166       return InternalSymbolAddr;
167     return MemMgr->getSymbolAddress(Symbol);
168   }
169
170 protected:
171   // The MemoryManager to load objects into.
172   RTDyldMemoryManager *MemMgr;
173
174   // Attached RuntimeDyldChecker instance. Null if no instance attached.
175   RuntimeDyldCheckerImpl *Checker;
176
177   // A list of all sections emitted by the dynamic linker.  These sections are
178   // referenced in the code by means of their index in this list - SectionID.
179   typedef SmallVector<SectionEntry, 64> SectionList;
180   SectionList Sections;
181
182   typedef unsigned SID; // Type for SectionIDs
183 #define RTDYLD_INVALID_SECTION_ID ((SID)(-1))
184
185   // Keep a map of sections from object file to the SectionID which
186   // references it.
187   typedef std::map<SectionRef, unsigned> ObjSectionToIDMap;
188
189   // A global symbol table for symbols from all loaded modules.  Maps the
190   // symbol name to a (SectionID, offset in section) pair.
191   typedef std::pair<unsigned, uintptr_t> SymbolLoc;
192   typedef StringMap<SymbolLoc> SymbolTableMap;
193   SymbolTableMap GlobalSymbolTable;
194
195   // Pair representing the size and alignment requirement for a common symbol.
196   typedef std::pair<unsigned, unsigned> CommonSymbolInfo;
197   // Keep a map of common symbols to their info pairs
198   typedef std::map<SymbolRef, CommonSymbolInfo> CommonSymbolMap;
199
200   // For each symbol, keep a list of relocations based on it. Anytime
201   // its address is reassigned (the JIT re-compiled the function, e.g.),
202   // the relocations get re-resolved.
203   // The symbol (or section) the relocation is sourced from is the Key
204   // in the relocation list where it's stored.
205   typedef SmallVector<RelocationEntry, 64> RelocationList;
206   // Relocations to sections already loaded. Indexed by SectionID which is the
207   // source of the address. The target where the address will be written is
208   // SectionID/Offset in the relocation itself.
209   DenseMap<unsigned, RelocationList> Relocations;
210
211   // Relocations to external symbols that are not yet resolved.  Symbols are
212   // external when they aren't found in the global symbol table of all loaded
213   // modules.  This map is indexed by symbol name.
214   StringMap<RelocationList> ExternalSymbolRelocations;
215
216
217   typedef std::map<RelocationValueRef, uintptr_t> StubMap;
218
219   Triple::ArchType Arch;
220   bool IsTargetLittleEndian;
221
222   // True if all sections should be passed to the memory manager, false if only
223   // sections containing relocations should be. Defaults to 'false'.
224   bool ProcessAllSections;
225
226   // This mutex prevents simultaneously loading objects from two different
227   // threads.  This keeps us from having to protect individual data structures
228   // and guarantees that section allocation requests to the memory manager
229   // won't be interleaved between modules.  It is also used in mapSectionAddress
230   // and resolveRelocations to protect write access to internal data structures.
231   //
232   // loadObject may be called on the same thread during the handling of of
233   // processRelocations, and that's OK.  The handling of the relocation lists
234   // is written in such a way as to work correctly if new elements are added to
235   // the end of the list while the list is being processed.
236   sys::Mutex lock;
237
238   virtual unsigned getMaxStubSize() = 0;
239   virtual unsigned getStubAlignment() = 0;
240
241   bool HasError;
242   std::string ErrorStr;
243
244   // Set the error state and record an error string.
245   bool Error(const Twine &Msg) {
246     ErrorStr = Msg.str();
247     HasError = true;
248     return true;
249   }
250
251   uint64_t getSectionLoadAddress(unsigned SectionID) const {
252     return Sections[SectionID].LoadAddress;
253   }
254
255   uint8_t *getSectionAddress(unsigned SectionID) const {
256     return (uint8_t *)Sections[SectionID].Address;
257   }
258
259   void writeInt16BE(uint8_t *Addr, uint16_t Value) {
260     if (IsTargetLittleEndian)
261       sys::swapByteOrder(Value);
262     *Addr       = (Value >> 8) & 0xFF;
263     *(Addr + 1) = Value & 0xFF;
264   }
265
266   void writeInt32BE(uint8_t *Addr, uint32_t Value) {
267     if (IsTargetLittleEndian)
268       sys::swapByteOrder(Value);
269     *Addr       = (Value >> 24) & 0xFF;
270     *(Addr + 1) = (Value >> 16) & 0xFF;
271     *(Addr + 2) = (Value >> 8) & 0xFF;
272     *(Addr + 3) = Value & 0xFF;
273   }
274
275   void writeInt64BE(uint8_t *Addr, uint64_t Value) {
276     if (IsTargetLittleEndian)
277       sys::swapByteOrder(Value);
278     *Addr       = (Value >> 56) & 0xFF;
279     *(Addr + 1) = (Value >> 48) & 0xFF;
280     *(Addr + 2) = (Value >> 40) & 0xFF;
281     *(Addr + 3) = (Value >> 32) & 0xFF;
282     *(Addr + 4) = (Value >> 24) & 0xFF;
283     *(Addr + 5) = (Value >> 16) & 0xFF;
284     *(Addr + 6) = (Value >> 8) & 0xFF;
285     *(Addr + 7) = Value & 0xFF;
286   }
287
288   /// Endian-aware read Read the least significant Size bytes from Src.
289   uint64_t readBytesUnaligned(uint8_t *Src, unsigned Size) const;
290
291   /// Endian-aware write. Write the least significant Size bytes from Value to
292   /// Dst.
293   void writeBytesUnaligned(uint64_t Value, uint8_t *Dst, unsigned Size) const;
294
295   /// \brief Given the common symbols discovered in the object file, emit a
296   /// new section for them and update the symbol mappings in the object and
297   /// symbol table.
298   void emitCommonSymbols(const ObjectFile &Obj,
299                          const CommonSymbolMap &CommonSymbols,
300                          uint64_t TotalSize, SymbolTableMap &SymbolTable);
301
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(const ObjectFile &Obj, const SectionRef &Section,
307                        bool IsCode);
308
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(const ObjectFile &Obj, const SectionRef &Section,
315                              bool IsCode, ObjSectionToIDMap &LocalSections);
316
317   // \brief Add a relocation entry that uses the given section.
318   void addRelocationForSection(const RelocationEntry &RE, unsigned SectionID);
319
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);
323
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);
327
328   /// \brief Resolves relocations from Relocs list with address from Value.
329   void resolveRelocationList(const RelocationList &Relocs, uint64_t Value);
330
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;
335
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                        const ObjectFile &Obj, ObjSectionToIDMap &ObjSectionToID,
343                        const SymbolTableMap &Symbols, StubMap &Stubs) = 0;
344
345   /// \brief Resolve relocations to external symbols.
346   void resolveExternalSymbols();
347
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) {}
351
352   // \brief Compute an upper bound of the memory that is required to load all
353   // sections
354   void computeTotalAllocSize(const ObjectFile &Obj, uint64_t &CodeSize,
355                              uint64_t &DataSizeRO, uint64_t &DataSizeRW);
356
357   // \brief Compute the stub buffer size required for a section
358   unsigned computeSectionStubBufSize(const ObjectFile &Obj,
359                                      const SectionRef &Section);
360
361   // \brief Implementation of the generic part of the loadObject algorithm.
362   std::pair<unsigned, unsigned> loadObjectImpl(const object::ObjectFile &Obj);
363
364 public:
365   RuntimeDyldImpl(RTDyldMemoryManager *mm)
366     : MemMgr(mm), Checker(nullptr), ProcessAllSections(false), HasError(false) {
367   }
368
369   virtual ~RuntimeDyldImpl();
370
371   void setProcessAllSections(bool ProcessAllSections) {
372     this->ProcessAllSections = ProcessAllSections;
373   }
374
375   void setRuntimeDyldChecker(RuntimeDyldCheckerImpl *Checker) {
376     this->Checker = Checker;
377   }
378
379   virtual std::unique_ptr<RuntimeDyld::LoadedObjectInfo>
380   loadObject(const object::ObjectFile &Obj) = 0;
381
382   uint8_t* getSymbolAddress(StringRef Name) const {
383     // FIXME: Just look up as a function for now. Overly simple of course.
384     // Work in progress.
385     SymbolTableMap::const_iterator pos = GlobalSymbolTable.find(Name);
386     if (pos == GlobalSymbolTable.end())
387       return nullptr;
388     SymbolLoc Loc = pos->second;
389     return getSectionAddress(Loc.first) + Loc.second;
390   }
391
392   uint64_t getSymbolLoadAddress(StringRef Name) const {
393     // FIXME: Just look up as a function for now. Overly simple of course.
394     // Work in progress.
395     SymbolTableMap::const_iterator pos = GlobalSymbolTable.find(Name);
396     if (pos == GlobalSymbolTable.end())
397       return 0;
398     SymbolLoc Loc = pos->second;
399     return getSectionLoadAddress(Loc.first) + Loc.second;
400   }
401
402   void resolveRelocations();
403
404   void reassignSectionAddress(unsigned SectionID, uint64_t Addr);
405
406   void mapSectionAddress(const void *LocalAddress, uint64_t TargetAddress);
407
408   // Is the linker in an error state?
409   bool hasError() { return HasError; }
410
411   // Mark the error condition as handled and continue.
412   void clearError() { HasError = false; }
413
414   // Get the error message.
415   StringRef getErrorString() { return ErrorStr; }
416
417   virtual bool isCompatibleFile(const ObjectFile &Obj) const = 0;
418
419   virtual void registerEHFrames();
420
421   virtual void deregisterEHFrames();
422
423   virtual void finalizeLoad(const ObjectFile &ObjImg,
424                             ObjSectionToIDMap &SectionMap) {}
425 };
426
427 } // end namespace llvm
428
429 #endif