1 //===-- RuntimeDyld.cpp - 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 // Implementation of the MC-JIT runtime dynamic linker.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/ExecutionEngine/RuntimeDyld.h"
15 #include "RuntimeDyldCheckerImpl.h"
16 #include "RuntimeDyldCOFF.h"
17 #include "RuntimeDyldELF.h"
18 #include "RuntimeDyldImpl.h"
19 #include "RuntimeDyldMachO.h"
20 #include "llvm/Object/ELFObjectFile.h"
21 #include "llvm/Object/COFF.h"
22 #include "llvm/Support/MathExtras.h"
23 #include "llvm/Support/MutexGuard.h"
26 using namespace llvm::object;
28 #define DEBUG_TYPE "dyld"
30 // Empty out-of-line virtual destructor as the key function.
31 RuntimeDyldImpl::~RuntimeDyldImpl() {}
33 // Pin LoadedObjectInfo's vtables to this file.
34 void RuntimeDyld::LoadedObjectInfo::anchor() {}
38 void RuntimeDyldImpl::registerEHFrames() {}
40 void RuntimeDyldImpl::deregisterEHFrames() {}
43 static void dumpSectionMemory(const SectionEntry &S, StringRef State) {
44 dbgs() << "----- Contents of section " << S.getName() << " " << State
47 if (S.getAddress() == nullptr) {
48 dbgs() << "\n <section not emitted>\n";
52 const unsigned ColsPerRow = 16;
54 uint8_t *DataAddr = S.getAddress();
55 uint64_t LoadAddr = S.getLoadAddress();
57 unsigned StartPadding = LoadAddr & (ColsPerRow - 1);
58 unsigned BytesRemaining = S.getSize();
61 dbgs() << "\n" << format("0x%016" PRIx64,
62 LoadAddr & ~(uint64_t)(ColsPerRow - 1)) << ":";
63 while (StartPadding--)
67 while (BytesRemaining > 0) {
68 if ((LoadAddr & (ColsPerRow - 1)) == 0)
69 dbgs() << "\n" << format("0x%016" PRIx64, LoadAddr) << ":";
71 dbgs() << " " << format("%02x", *DataAddr);
82 // Resolve the relocations for all symbols we currently know about.
83 void RuntimeDyldImpl::resolveRelocations() {
84 MutexGuard locked(lock);
86 // Print out the sections prior to relocation.
88 for (int i = 0, e = Sections.size(); i != e; ++i)
89 dumpSectionMemory(Sections[i], "before relocations");
92 // First, resolve relocations associated with external symbols.
93 resolveExternalSymbols();
95 // Iterate over all outstanding relocations
96 for (auto it = Relocations.begin(), e = Relocations.end(); it != e; ++it) {
97 // The Section here (Sections[i]) refers to the section in which the
98 // symbol for the relocation is located. The SectionID in the relocation
99 // entry provides the section to which the relocation will be applied.
100 int Idx = it->getFirst();
101 uint64_t Addr = Sections[Idx].getLoadAddress();
102 DEBUG(dbgs() << "Resolving relocations Section #" << Idx << "\t"
103 << format("%p", (uintptr_t)Addr) << "\n");
104 resolveRelocationList(it->getSecond(), Addr);
108 // Print out sections after relocation.
110 for (int i = 0, e = Sections.size(); i != e; ++i)
111 dumpSectionMemory(Sections[i], "after relocations");
116 void RuntimeDyldImpl::mapSectionAddress(const void *LocalAddress,
117 uint64_t TargetAddress) {
118 MutexGuard locked(lock);
119 for (unsigned i = 0, e = Sections.size(); i != e; ++i) {
120 if (Sections[i].getAddress() == LocalAddress) {
121 reassignSectionAddress(i, TargetAddress);
125 llvm_unreachable("Attempting to remap address of unknown section!");
128 static std::error_code getOffset(const SymbolRef &Sym, SectionRef Sec,
130 ErrorOr<uint64_t> AddressOrErr = Sym.getAddress();
131 if (std::error_code EC = AddressOrErr.getError())
133 Result = *AddressOrErr - Sec.getAddress();
134 return std::error_code();
137 RuntimeDyldImpl::ObjSectionToIDMap
138 RuntimeDyldImpl::loadObjectImpl(const object::ObjectFile &Obj) {
139 MutexGuard locked(lock);
141 // Save information about our target
142 Arch = (Triple::ArchType)Obj.getArch();
143 IsTargetLittleEndian = Obj.isLittleEndian();
146 // Compute the memory size required to load all sections to be loaded
147 // and pass this information to the memory manager
148 if (MemMgr.needsToReserveAllocationSpace()) {
149 uint64_t CodeSize = 0, DataSizeRO = 0, DataSizeRW = 0;
150 computeTotalAllocSize(Obj, CodeSize, DataSizeRO, DataSizeRW);
151 MemMgr.reserveAllocationSpace(CodeSize, DataSizeRO, DataSizeRW);
154 // Used sections from the object file
155 ObjSectionToIDMap LocalSections;
157 // Common symbols requiring allocation, with their sizes and alignments
158 CommonSymbolList CommonSymbols;
161 DEBUG(dbgs() << "Parse symbols:\n");
162 for (symbol_iterator I = Obj.symbol_begin(), E = Obj.symbol_end(); I != E;
164 uint32_t Flags = I->getFlags();
166 if (Flags & SymbolRef::SF_Common)
167 CommonSymbols.push_back(*I);
169 object::SymbolRef::Type SymType = I->getType();
172 ErrorOr<StringRef> NameOrErr = I->getName();
173 Check(NameOrErr.getError());
174 StringRef Name = *NameOrErr;
176 // Compute JIT symbol flags.
177 JITSymbolFlags RTDyldSymFlags = JITSymbolFlags::None;
178 if (Flags & SymbolRef::SF_Weak)
179 RTDyldSymFlags |= JITSymbolFlags::Weak;
180 if (Flags & SymbolRef::SF_Exported)
181 RTDyldSymFlags |= JITSymbolFlags::Exported;
183 if (Flags & SymbolRef::SF_Absolute &&
184 SymType != object::SymbolRef::ST_File) {
185 auto Addr = I->getAddress();
186 Check(Addr.getError());
187 uint64_t SectOffset = *Addr;
188 unsigned SectionID = AbsoluteSymbolSection;
190 DEBUG(dbgs() << "\tType: " << SymType << " (absolute) Name: " << Name
191 << " SID: " << SectionID << " Offset: "
192 << format("%p", (uintptr_t)SectOffset)
193 << " flags: " << Flags << "\n");
194 GlobalSymbolTable[Name] =
195 SymbolTableEntry(SectionID, SectOffset, RTDyldSymFlags);
196 } else if (SymType == object::SymbolRef::ST_Function ||
197 SymType == object::SymbolRef::ST_Data ||
198 SymType == object::SymbolRef::ST_Unknown ||
199 SymType == object::SymbolRef::ST_Other) {
201 ErrorOr<section_iterator> SIOrErr = I->getSection();
202 Check(SIOrErr.getError());
203 section_iterator SI = *SIOrErr;
204 if (SI == Obj.section_end())
206 // Get symbol offset.
208 Check(getOffset(*I, *SI, SectOffset));
209 bool IsCode = SI->isText();
210 unsigned SectionID = findOrEmitSection(Obj, *SI, IsCode, LocalSections);
212 DEBUG(dbgs() << "\tType: " << SymType << " Name: " << Name
213 << " SID: " << SectionID << " Offset: "
214 << format("%p", (uintptr_t)SectOffset)
215 << " flags: " << Flags << "\n");
216 GlobalSymbolTable[Name] =
217 SymbolTableEntry(SectionID, SectOffset, RTDyldSymFlags);
222 // Allocate common symbols
223 emitCommonSymbols(Obj, CommonSymbols);
225 // Parse and process relocations
226 DEBUG(dbgs() << "Parse relocations:\n");
227 for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end();
229 unsigned SectionID = 0;
231 section_iterator RelocatedSection = SI->getRelocatedSection();
233 if (RelocatedSection == SE)
236 relocation_iterator I = SI->relocation_begin();
237 relocation_iterator E = SI->relocation_end();
239 if (I == E && !ProcessAllSections)
242 bool IsCode = RelocatedSection->isText();
244 findOrEmitSection(Obj, *RelocatedSection, IsCode, LocalSections);
245 DEBUG(dbgs() << "\tSectionID: " << SectionID << "\n");
248 I = processRelocationRef(SectionID, I, Obj, LocalSections, Stubs);
250 // If there is an attached checker, notify it about the stubs for this
251 // section so that they can be verified.
253 Checker->registerStubMap(Obj.getFileName(), SectionID, Stubs);
256 // Give the subclasses a chance to tie-up any loose ends.
257 finalizeLoad(Obj, LocalSections);
259 // for (auto E : LocalSections)
260 // llvm::dbgs() << "Added: " << E.first.getRawDataRefImpl() << " -> " << E.second << "\n";
262 return LocalSections;
265 // A helper method for computeTotalAllocSize.
266 // Computes the memory size required to allocate sections with the given sizes,
267 // assuming that all sections are allocated with the given alignment
269 computeAllocationSizeForSections(std::vector<uint64_t> &SectionSizes,
270 uint64_t Alignment) {
271 uint64_t TotalSize = 0;
272 for (size_t Idx = 0, Cnt = SectionSizes.size(); Idx < Cnt; Idx++) {
273 uint64_t AlignedSize =
274 (SectionSizes[Idx] + Alignment - 1) / Alignment * Alignment;
275 TotalSize += AlignedSize;
280 static bool isRequiredForExecution(const SectionRef Section) {
281 const ObjectFile *Obj = Section.getObject();
282 if (isa<object::ELFObjectFileBase>(Obj))
283 return ELFSectionRef(Section).getFlags() & ELF::SHF_ALLOC;
284 if (auto *COFFObj = dyn_cast<object::COFFObjectFile>(Obj)) {
285 const coff_section *CoffSection = COFFObj->getCOFFSection(Section);
286 // Avoid loading zero-sized COFF sections.
287 // In PE files, VirtualSize gives the section size, and SizeOfRawData
288 // may be zero for sections with content. In Obj files, SizeOfRawData
289 // gives the section size, and VirtualSize is always zero. Hence
290 // the need to check for both cases below.
291 bool HasContent = (CoffSection->VirtualSize > 0)
292 || (CoffSection->SizeOfRawData > 0);
293 bool IsDiscardable = CoffSection->Characteristics &
294 (COFF::IMAGE_SCN_MEM_DISCARDABLE | COFF::IMAGE_SCN_LNK_INFO);
295 return HasContent && !IsDiscardable;
298 assert(isa<MachOObjectFile>(Obj));
302 static bool isReadOnlyData(const SectionRef Section) {
303 const ObjectFile *Obj = Section.getObject();
304 if (isa<object::ELFObjectFileBase>(Obj))
305 return !(ELFSectionRef(Section).getFlags() &
306 (ELF::SHF_WRITE | ELF::SHF_EXECINSTR));
307 if (auto *COFFObj = dyn_cast<object::COFFObjectFile>(Obj))
308 return ((COFFObj->getCOFFSection(Section)->Characteristics &
309 (COFF::IMAGE_SCN_CNT_INITIALIZED_DATA
310 | COFF::IMAGE_SCN_MEM_READ
311 | COFF::IMAGE_SCN_MEM_WRITE))
313 (COFF::IMAGE_SCN_CNT_INITIALIZED_DATA
314 | COFF::IMAGE_SCN_MEM_READ));
316 assert(isa<MachOObjectFile>(Obj));
320 static bool isZeroInit(const SectionRef Section) {
321 const ObjectFile *Obj = Section.getObject();
322 if (isa<object::ELFObjectFileBase>(Obj))
323 return ELFSectionRef(Section).getType() == ELF::SHT_NOBITS;
324 if (auto *COFFObj = dyn_cast<object::COFFObjectFile>(Obj))
325 return COFFObj->getCOFFSection(Section)->Characteristics &
326 COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA;
328 auto *MachO = cast<MachOObjectFile>(Obj);
329 unsigned SectionType = MachO->getSectionType(Section);
330 return SectionType == MachO::S_ZEROFILL ||
331 SectionType == MachO::S_GB_ZEROFILL;
334 // Compute an upper bound of the memory size that is required to load all
336 void RuntimeDyldImpl::computeTotalAllocSize(const ObjectFile &Obj,
338 uint64_t &DataSizeRO,
339 uint64_t &DataSizeRW) {
340 // Compute the size of all sections required for execution
341 std::vector<uint64_t> CodeSectionSizes;
342 std::vector<uint64_t> ROSectionSizes;
343 std::vector<uint64_t> RWSectionSizes;
344 uint64_t MaxAlignment = sizeof(void *);
346 // Collect sizes of all sections to be loaded;
347 // also determine the max alignment of all sections
348 for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end();
350 const SectionRef &Section = *SI;
352 bool IsRequired = isRequiredForExecution(Section);
354 // Consider only the sections that are required to be loaded for execution
357 uint64_t DataSize = Section.getSize();
358 uint64_t Alignment64 = Section.getAlignment();
359 bool IsCode = Section.isText();
360 bool IsReadOnly = isReadOnlyData(Section);
361 Check(Section.getName(Name));
362 unsigned Alignment = (unsigned)Alignment64 & 0xffffffffL;
364 uint64_t StubBufSize = computeSectionStubBufSize(Obj, Section);
365 uint64_t SectionSize = DataSize + StubBufSize;
367 // The .eh_frame section (at least on Linux) needs an extra four bytes
369 // with zeroes added at the end. For MachO objects, this section has a
370 // slightly different name, so this won't have any effect for MachO
372 if (Name == ".eh_frame")
379 CodeSectionSizes.push_back(SectionSize);
380 } else if (IsReadOnly) {
381 ROSectionSizes.push_back(SectionSize);
383 RWSectionSizes.push_back(SectionSize);
386 // update the max alignment
387 if (Alignment > MaxAlignment) {
388 MaxAlignment = Alignment;
393 // Compute the size of all common symbols
394 uint64_t CommonSize = 0;
395 for (symbol_iterator I = Obj.symbol_begin(), E = Obj.symbol_end(); I != E;
397 uint32_t Flags = I->getFlags();
398 if (Flags & SymbolRef::SF_Common) {
399 // Add the common symbols to a list. We'll allocate them all below.
400 uint64_t Size = I->getCommonSize();
404 if (CommonSize != 0) {
405 RWSectionSizes.push_back(CommonSize);
408 // Compute the required allocation space for each different type of sections
409 // (code, read-only data, read-write data) assuming that all sections are
410 // allocated with the max alignment. Note that we cannot compute with the
411 // individual alignments of the sections, because then the required size
412 // depends on the order, in which the sections are allocated.
413 CodeSize = computeAllocationSizeForSections(CodeSectionSizes, MaxAlignment);
414 DataSizeRO = computeAllocationSizeForSections(ROSectionSizes, MaxAlignment);
415 DataSizeRW = computeAllocationSizeForSections(RWSectionSizes, MaxAlignment);
418 // compute stub buffer size for the given section
419 unsigned RuntimeDyldImpl::computeSectionStubBufSize(const ObjectFile &Obj,
420 const SectionRef &Section) {
421 unsigned StubSize = getMaxStubSize();
425 // FIXME: this is an inefficient way to handle this. We should computed the
426 // necessary section allocation size in loadObject by walking all the sections
428 unsigned StubBufSize = 0;
429 for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end();
431 section_iterator RelSecI = SI->getRelocatedSection();
432 if (!(RelSecI == Section))
435 for (const RelocationRef &Reloc : SI->relocations()) {
437 StubBufSize += StubSize;
441 // Get section data size and alignment
442 uint64_t DataSize = Section.getSize();
443 uint64_t Alignment64 = Section.getAlignment();
445 // Add stubbuf size alignment
446 unsigned Alignment = (unsigned)Alignment64 & 0xffffffffL;
447 unsigned StubAlignment = getStubAlignment();
448 unsigned EndAlignment = (DataSize | Alignment) & -(DataSize | Alignment);
449 if (StubAlignment > EndAlignment)
450 StubBufSize += StubAlignment - EndAlignment;
454 uint64_t RuntimeDyldImpl::readBytesUnaligned(uint8_t *Src,
455 unsigned Size) const {
457 if (IsTargetLittleEndian) {
460 Result = (Result << 8) | *Src--;
463 Result = (Result << 8) | *Src++;
468 void RuntimeDyldImpl::writeBytesUnaligned(uint64_t Value, uint8_t *Dst,
469 unsigned Size) const {
470 if (IsTargetLittleEndian) {
472 *Dst++ = Value & 0xFF;
478 *Dst-- = Value & 0xFF;
484 void RuntimeDyldImpl::emitCommonSymbols(const ObjectFile &Obj,
485 CommonSymbolList &CommonSymbols) {
486 if (CommonSymbols.empty())
489 uint64_t CommonSize = 0;
490 CommonSymbolList SymbolsToAllocate;
492 DEBUG(dbgs() << "Processing common symbols...\n");
494 for (const auto &Sym : CommonSymbols) {
495 ErrorOr<StringRef> NameOrErr = Sym.getName();
496 Check(NameOrErr.getError());
497 StringRef Name = *NameOrErr;
499 // Skip common symbols already elsewhere.
500 if (GlobalSymbolTable.count(Name) ||
501 Resolver.findSymbolInLogicalDylib(Name)) {
502 DEBUG(dbgs() << "\tSkipping already emitted common symbol '" << Name
507 uint32_t Align = Sym.getAlignment();
508 uint64_t Size = Sym.getCommonSize();
510 CommonSize += Align + Size;
511 SymbolsToAllocate.push_back(Sym);
514 // Allocate memory for the section
515 unsigned SectionID = Sections.size();
516 uint8_t *Addr = MemMgr.allocateDataSection(CommonSize, sizeof(void *),
517 SectionID, StringRef(), false);
519 report_fatal_error("Unable to allocate memory for common symbols!");
522 SectionEntry("<common symbols>", Addr, CommonSize, CommonSize, 0));
523 memset(Addr, 0, CommonSize);
525 DEBUG(dbgs() << "emitCommonSection SectionID: " << SectionID << " new addr: "
526 << format("%p", Addr) << " DataSize: " << CommonSize << "\n");
528 // Assign the address of each symbol
529 for (auto &Sym : SymbolsToAllocate) {
530 uint32_t Align = Sym.getAlignment();
531 uint64_t Size = Sym.getCommonSize();
532 ErrorOr<StringRef> NameOrErr = Sym.getName();
533 Check(NameOrErr.getError());
534 StringRef Name = *NameOrErr;
536 // This symbol has an alignment requirement.
537 uint64_t AlignOffset = OffsetToAlignment((uint64_t)Addr, Align);
539 Offset += AlignOffset;
541 uint32_t Flags = Sym.getFlags();
542 JITSymbolFlags RTDyldSymFlags = JITSymbolFlags::None;
543 if (Flags & SymbolRef::SF_Weak)
544 RTDyldSymFlags |= JITSymbolFlags::Weak;
545 if (Flags & SymbolRef::SF_Exported)
546 RTDyldSymFlags |= JITSymbolFlags::Exported;
547 DEBUG(dbgs() << "Allocating common symbol " << Name << " address "
548 << format("%p", Addr) << "\n");
549 GlobalSymbolTable[Name] =
550 SymbolTableEntry(SectionID, Offset, RTDyldSymFlags);
556 Checker->registerSection(Obj.getFileName(), SectionID);
559 unsigned RuntimeDyldImpl::emitSection(const ObjectFile &Obj,
560 const SectionRef &Section, bool IsCode) {
563 uint64_t Alignment64 = Section.getAlignment();
565 unsigned Alignment = (unsigned)Alignment64 & 0xffffffffL;
566 unsigned PaddingSize = 0;
567 unsigned StubBufSize = 0;
569 bool IsRequired = isRequiredForExecution(Section);
570 bool IsVirtual = Section.isVirtual();
571 bool IsZeroInit = isZeroInit(Section);
572 bool IsReadOnly = isReadOnlyData(Section);
573 uint64_t DataSize = Section.getSize();
574 Check(Section.getName(Name));
576 StubBufSize = computeSectionStubBufSize(Obj, Section);
578 // The .eh_frame section (at least on Linux) needs an extra four bytes padded
579 // with zeroes added at the end. For MachO objects, this section has a
580 // slightly different name, so this won't have any effect for MachO objects.
581 if (Name == ".eh_frame")
585 unsigned SectionID = Sections.size();
587 const char *pData = nullptr;
589 // If this section contains any bits (i.e. isn't a virtual or bss section),
590 // grab a reference to them.
591 if (!IsVirtual && !IsZeroInit) {
592 // In either case, set the location of the unrelocated section in memory,
593 // since we still process relocations for it even if we're not applying them.
594 Check(Section.getContents(data));
598 // Code section alignment needs to be at least as high as stub alignment or
599 // padding calculations may by incorrect when the section is remapped to a
602 Alignment = std::max(Alignment, getStubAlignment());
604 // Some sections, such as debug info, don't need to be loaded for execution.
605 // Leave those where they are.
607 Allocate = DataSize + PaddingSize + StubBufSize;
610 Addr = IsCode ? MemMgr.allocateCodeSection(Allocate, Alignment, SectionID,
612 : MemMgr.allocateDataSection(Allocate, Alignment, SectionID,
615 report_fatal_error("Unable to allocate section memory!");
617 // Zero-initialize or copy the data from the image
618 if (IsZeroInit || IsVirtual)
619 memset(Addr, 0, DataSize);
621 memcpy(Addr, pData, DataSize);
623 // Fill in any extra bytes we allocated for padding
624 if (PaddingSize != 0) {
625 memset(Addr + DataSize, 0, PaddingSize);
626 // Update the DataSize variable so that the stub offset is set correctly.
627 DataSize += PaddingSize;
630 DEBUG(dbgs() << "emitSection SectionID: " << SectionID << " Name: " << Name
631 << " obj addr: " << format("%p", pData)
632 << " new addr: " << format("%p", Addr)
633 << " DataSize: " << DataSize << " StubBufSize: " << StubBufSize
634 << " Allocate: " << Allocate << "\n");
636 // Even if we didn't load the section, we need to record an entry for it
637 // to handle later processing (and by 'handle' I mean don't do anything
638 // with these sections).
641 DEBUG(dbgs() << "emitSection SectionID: " << SectionID << " Name: " << Name
642 << " obj addr: " << format("%p", data.data()) << " new addr: 0"
643 << " DataSize: " << DataSize << " StubBufSize: " << StubBufSize
644 << " Allocate: " << Allocate << "\n");
648 SectionEntry(Name, Addr, DataSize, Allocate, (uintptr_t)pData));
651 Checker->registerSection(Obj.getFileName(), SectionID);
656 unsigned RuntimeDyldImpl::findOrEmitSection(const ObjectFile &Obj,
657 const SectionRef &Section,
659 ObjSectionToIDMap &LocalSections) {
661 unsigned SectionID = 0;
662 ObjSectionToIDMap::iterator i = LocalSections.find(Section);
663 if (i != LocalSections.end())
664 SectionID = i->second;
666 SectionID = emitSection(Obj, Section, IsCode);
667 LocalSections[Section] = SectionID;
672 void RuntimeDyldImpl::addRelocationForSection(const RelocationEntry &RE,
673 unsigned SectionID) {
674 Relocations[SectionID].push_back(RE);
677 void RuntimeDyldImpl::addRelocationForSymbol(const RelocationEntry &RE,
678 StringRef SymbolName) {
679 // Relocation by symbol. If the symbol is found in the global symbol table,
680 // create an appropriate section relocation. Otherwise, add it to
681 // ExternalSymbolRelocations.
682 RTDyldSymbolTable::const_iterator Loc = GlobalSymbolTable.find(SymbolName);
683 if (Loc == GlobalSymbolTable.end()) {
684 ExternalSymbolRelocations[SymbolName].push_back(RE);
686 // Copy the RE since we want to modify its addend.
687 RelocationEntry RECopy = RE;
688 const auto &SymInfo = Loc->second;
689 RECopy.Addend += SymInfo.getOffset();
690 Relocations[SymInfo.getSectionID()].push_back(RECopy);
694 uint8_t *RuntimeDyldImpl::createStubFunction(uint8_t *Addr,
695 unsigned AbiVariant) {
696 if (Arch == Triple::aarch64 || Arch == Triple::aarch64_be) {
697 // This stub has to be able to access the full address space,
698 // since symbol lookup won't necessarily find a handy, in-range,
699 // PLT stub for functions which could be anywhere.
700 // Stub can use ip0 (== x16) to calculate address
701 writeBytesUnaligned(0xd2e00010, Addr, 4); // movz ip0, #:abs_g3:<addr>
702 writeBytesUnaligned(0xf2c00010, Addr+4, 4); // movk ip0, #:abs_g2_nc:<addr>
703 writeBytesUnaligned(0xf2a00010, Addr+8, 4); // movk ip0, #:abs_g1_nc:<addr>
704 writeBytesUnaligned(0xf2800010, Addr+12, 4); // movk ip0, #:abs_g0_nc:<addr>
705 writeBytesUnaligned(0xd61f0200, Addr+16, 4); // br ip0
708 } else if (Arch == Triple::arm || Arch == Triple::armeb) {
709 // TODO: There is only ARM far stub now. We should add the Thumb stub,
710 // and stubs for branches Thumb - ARM and ARM - Thumb.
711 writeBytesUnaligned(0xe51ff004, Addr, 4); // ldr pc,<label>
713 } else if (IsMipsO32ABI) {
714 // 0: 3c190000 lui t9,%hi(addr).
715 // 4: 27390000 addiu t9,t9,%lo(addr).
716 // 8: 03200008 jr t9.
718 const unsigned LuiT9Instr = 0x3c190000, AdduiT9Instr = 0x27390000;
719 const unsigned JrT9Instr = 0x03200008, NopInstr = 0x0;
721 writeBytesUnaligned(LuiT9Instr, Addr, 4);
722 writeBytesUnaligned(AdduiT9Instr, Addr+4, 4);
723 writeBytesUnaligned(JrT9Instr, Addr+8, 4);
724 writeBytesUnaligned(NopInstr, Addr+12, 4);
726 } else if (Arch == Triple::ppc64 || Arch == Triple::ppc64le) {
727 // Depending on which version of the ELF ABI is in use, we need to
728 // generate one of two variants of the stub. They both start with
729 // the same sequence to load the target address into r12.
730 writeInt32BE(Addr, 0x3D800000); // lis r12, highest(addr)
731 writeInt32BE(Addr+4, 0x618C0000); // ori r12, higher(addr)
732 writeInt32BE(Addr+8, 0x798C07C6); // sldi r12, r12, 32
733 writeInt32BE(Addr+12, 0x658C0000); // oris r12, r12, h(addr)
734 writeInt32BE(Addr+16, 0x618C0000); // ori r12, r12, l(addr)
735 if (AbiVariant == 2) {
736 // PowerPC64 stub ELFv2 ABI: The address points to the function itself.
737 // The address is already in r12 as required by the ABI. Branch to it.
738 writeInt32BE(Addr+20, 0xF8410018); // std r2, 24(r1)
739 writeInt32BE(Addr+24, 0x7D8903A6); // mtctr r12
740 writeInt32BE(Addr+28, 0x4E800420); // bctr
742 // PowerPC64 stub ELFv1 ABI: The address points to a function descriptor.
743 // Load the function address on r11 and sets it to control register. Also
744 // loads the function TOC in r2 and environment pointer to r11.
745 writeInt32BE(Addr+20, 0xF8410028); // std r2, 40(r1)
746 writeInt32BE(Addr+24, 0xE96C0000); // ld r11, 0(r12)
747 writeInt32BE(Addr+28, 0xE84C0008); // ld r2, 0(r12)
748 writeInt32BE(Addr+32, 0x7D6903A6); // mtctr r11
749 writeInt32BE(Addr+36, 0xE96C0010); // ld r11, 16(r2)
750 writeInt32BE(Addr+40, 0x4E800420); // bctr
753 } else if (Arch == Triple::systemz) {
754 writeInt16BE(Addr, 0xC418); // lgrl %r1,.+8
755 writeInt16BE(Addr+2, 0x0000);
756 writeInt16BE(Addr+4, 0x0004);
757 writeInt16BE(Addr+6, 0x07F1); // brc 15,%r1
758 // 8-byte address stored at Addr + 8
760 } else if (Arch == Triple::x86_64) {
762 *(Addr+1) = 0x25; // rip
763 // 32-bit PC-relative address of the GOT entry will be stored at Addr+2
764 } else if (Arch == Triple::x86) {
765 *Addr = 0xE9; // 32-bit pc-relative jump.
770 // Assign an address to a symbol name and resolve all the relocations
771 // associated with it.
772 void RuntimeDyldImpl::reassignSectionAddress(unsigned SectionID,
774 // The address to use for relocation resolution is not
775 // the address of the local section buffer. We must be doing
776 // a remote execution environment of some sort. Relocations can't
777 // be applied until all the sections have been moved. The client must
778 // trigger this with a call to MCJIT::finalize() or
779 // RuntimeDyld::resolveRelocations().
781 // Addr is a uint64_t because we can't assume the pointer width
782 // of the target is the same as that of the host. Just use a generic
783 // "big enough" type.
784 DEBUG(dbgs() << "Reassigning address for section " << SectionID << " ("
785 << Sections[SectionID].getName() << "): "
786 << format("0x%016" PRIx64, Sections[SectionID].getLoadAddress())
787 << " -> " << format("0x%016" PRIx64, Addr) << "\n");
788 Sections[SectionID].setLoadAddress(Addr);
791 void RuntimeDyldImpl::resolveRelocationList(const RelocationList &Relocs,
793 for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
794 const RelocationEntry &RE = Relocs[i];
795 // Ignore relocations for sections that were not loaded
796 if (Sections[RE.SectionID].getAddress() == nullptr)
798 resolveRelocation(RE, Value);
802 void RuntimeDyldImpl::resolveExternalSymbols() {
803 while (!ExternalSymbolRelocations.empty()) {
804 StringMap<RelocationList>::iterator i = ExternalSymbolRelocations.begin();
806 StringRef Name = i->first();
807 if (Name.size() == 0) {
808 // This is an absolute symbol, use an address of zero.
809 DEBUG(dbgs() << "Resolving absolute relocations."
811 RelocationList &Relocs = i->second;
812 resolveRelocationList(Relocs, 0);
815 RTDyldSymbolTable::const_iterator Loc = GlobalSymbolTable.find(Name);
816 if (Loc == GlobalSymbolTable.end()) {
817 // This is an external symbol, try to get its address from the symbol
819 Addr = Resolver.findSymbol(Name.data()).getAddress();
820 // The call to getSymbolAddress may have caused additional modules to
821 // be loaded, which may have added new entries to the
822 // ExternalSymbolRelocations map. Consquently, we need to update our
823 // iterator. This is also why retrieval of the relocation list
824 // associated with this symbol is deferred until below this point.
825 // New entries may have been added to the relocation list.
826 i = ExternalSymbolRelocations.find(Name);
828 // We found the symbol in our global table. It was probably in a
829 // Module that we loaded previously.
830 const auto &SymInfo = Loc->second;
831 Addr = getSectionLoadAddress(SymInfo.getSectionID()) +
835 // FIXME: Implement error handling that doesn't kill the host program!
837 report_fatal_error("Program used external function '" + Name +
838 "' which could not be resolved!");
840 // If Resolver returned UINT64_MAX, the client wants to handle this symbol
841 // manually and we shouldn't resolve its relocations.
842 if (Addr != UINT64_MAX) {
843 DEBUG(dbgs() << "Resolving relocations Name: " << Name << "\t"
844 << format("0x%lx", Addr) << "\n");
845 // This list may have been updated when we called getSymbolAddress, so
846 // don't change this code to get the list earlier.
847 RelocationList &Relocs = i->second;
848 resolveRelocationList(Relocs, Addr);
852 ExternalSymbolRelocations.erase(i);
856 //===----------------------------------------------------------------------===//
857 // RuntimeDyld class implementation
859 uint64_t RuntimeDyld::LoadedObjectInfo::getSectionLoadAddress(
860 const object::SectionRef &Sec) const {
862 auto I = ObjSecToIDMap.find(Sec);
863 if (I != ObjSecToIDMap.end())
864 return RTDyld.Sections[I->second].getLoadAddress();
869 void RuntimeDyld::MemoryManager::anchor() {}
870 void RuntimeDyld::SymbolResolver::anchor() {}
872 RuntimeDyld::RuntimeDyld(RuntimeDyld::MemoryManager &MemMgr,
873 RuntimeDyld::SymbolResolver &Resolver)
874 : MemMgr(MemMgr), Resolver(Resolver) {
875 // FIXME: There's a potential issue lurking here if a single instance of
876 // RuntimeDyld is used to load multiple objects. The current implementation
877 // associates a single memory manager with a RuntimeDyld instance. Even
878 // though the public class spawns a new 'impl' instance for each load,
879 // they share a single memory manager. This can become a problem when page
880 // permissions are applied.
882 ProcessAllSections = false;
886 RuntimeDyld::~RuntimeDyld() {}
888 static std::unique_ptr<RuntimeDyldCOFF>
889 createRuntimeDyldCOFF(Triple::ArchType Arch, RuntimeDyld::MemoryManager &MM,
890 RuntimeDyld::SymbolResolver &Resolver,
891 bool ProcessAllSections, RuntimeDyldCheckerImpl *Checker) {
892 std::unique_ptr<RuntimeDyldCOFF> Dyld =
893 RuntimeDyldCOFF::create(Arch, MM, Resolver);
894 Dyld->setProcessAllSections(ProcessAllSections);
895 Dyld->setRuntimeDyldChecker(Checker);
899 static std::unique_ptr<RuntimeDyldELF>
900 createRuntimeDyldELF(RuntimeDyld::MemoryManager &MM,
901 RuntimeDyld::SymbolResolver &Resolver,
902 bool ProcessAllSections, RuntimeDyldCheckerImpl *Checker) {
903 std::unique_ptr<RuntimeDyldELF> Dyld(new RuntimeDyldELF(MM, Resolver));
904 Dyld->setProcessAllSections(ProcessAllSections);
905 Dyld->setRuntimeDyldChecker(Checker);
909 static std::unique_ptr<RuntimeDyldMachO>
910 createRuntimeDyldMachO(Triple::ArchType Arch, RuntimeDyld::MemoryManager &MM,
911 RuntimeDyld::SymbolResolver &Resolver,
912 bool ProcessAllSections,
913 RuntimeDyldCheckerImpl *Checker) {
914 std::unique_ptr<RuntimeDyldMachO> Dyld =
915 RuntimeDyldMachO::create(Arch, MM, Resolver);
916 Dyld->setProcessAllSections(ProcessAllSections);
917 Dyld->setRuntimeDyldChecker(Checker);
921 std::unique_ptr<RuntimeDyld::LoadedObjectInfo>
922 RuntimeDyld::loadObject(const ObjectFile &Obj) {
925 Dyld = createRuntimeDyldELF(MemMgr, Resolver, ProcessAllSections, Checker);
926 else if (Obj.isMachO())
927 Dyld = createRuntimeDyldMachO(
928 static_cast<Triple::ArchType>(Obj.getArch()), MemMgr, Resolver,
929 ProcessAllSections, Checker);
930 else if (Obj.isCOFF())
931 Dyld = createRuntimeDyldCOFF(
932 static_cast<Triple::ArchType>(Obj.getArch()), MemMgr, Resolver,
933 ProcessAllSections, Checker);
935 report_fatal_error("Incompatible object format!");
938 if (!Dyld->isCompatibleFile(Obj))
939 report_fatal_error("Incompatible object format!");
941 return Dyld->loadObject(Obj);
944 void *RuntimeDyld::getSymbolLocalAddress(StringRef Name) const {
947 return Dyld->getSymbolLocalAddress(Name);
950 RuntimeDyld::SymbolInfo RuntimeDyld::getSymbol(StringRef Name) const {
953 return Dyld->getSymbol(Name);
956 void RuntimeDyld::resolveRelocations() { Dyld->resolveRelocations(); }
958 void RuntimeDyld::reassignSectionAddress(unsigned SectionID, uint64_t Addr) {
959 Dyld->reassignSectionAddress(SectionID, Addr);
962 void RuntimeDyld::mapSectionAddress(const void *LocalAddress,
963 uint64_t TargetAddress) {
964 Dyld->mapSectionAddress(LocalAddress, TargetAddress);
967 bool RuntimeDyld::hasError() { return Dyld->hasError(); }
969 StringRef RuntimeDyld::getErrorString() { return Dyld->getErrorString(); }
971 void RuntimeDyld::registerEHFrames() {
973 Dyld->registerEHFrames();
976 void RuntimeDyld::deregisterEHFrames() {
978 Dyld->deregisterEHFrames();
981 } // end namespace llvm