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.Name << " " << State << " -----";
46 if (S.Address == nullptr) {
47 dbgs() << "\n <section not emitted>\n";
51 const unsigned ColsPerRow = 16;
53 uint8_t *DataAddr = S.Address;
54 uint64_t LoadAddr = S.LoadAddress;
56 unsigned StartPadding = LoadAddr & (ColsPerRow - 1);
57 unsigned BytesRemaining = S.Size;
60 dbgs() << "\n" << format("0x%016" PRIx64,
61 LoadAddr & ~(uint64_t)(ColsPerRow - 1)) << ":";
62 while (StartPadding--)
66 while (BytesRemaining > 0) {
67 if ((LoadAddr & (ColsPerRow - 1)) == 0)
68 dbgs() << "\n" << format("0x%016" PRIx64, LoadAddr) << ":";
70 dbgs() << " " << format("%02x", *DataAddr);
81 // Resolve the relocations for all symbols we currently know about.
82 void RuntimeDyldImpl::resolveRelocations() {
83 MutexGuard locked(lock);
85 // First, resolve relocations associated with external symbols.
86 resolveExternalSymbols();
88 // Just iterate over the sections we have and resolve all the relocations
89 // in them. Gross overkill, but it gets the job done.
90 for (int i = 0, e = Sections.size(); i != e; ++i) {
91 // The Section here (Sections[i]) refers to the section in which the
92 // symbol for the relocation is located. The SectionID in the relocation
93 // entry provides the section to which the relocation will be applied.
94 uint64_t Addr = Sections[i].LoadAddress;
95 DEBUG(dbgs() << "Resolving relocations Section #" << i << "\t"
96 << format("%p", (uintptr_t)Addr) << "\n");
97 DEBUG(dumpSectionMemory(Sections[i], "before relocations"));
98 resolveRelocationList(Relocations[i], Addr);
99 DEBUG(dumpSectionMemory(Sections[i], "after relocations"));
100 Relocations.erase(i);
104 void RuntimeDyldImpl::mapSectionAddress(const void *LocalAddress,
105 uint64_t TargetAddress) {
106 MutexGuard locked(lock);
107 for (unsigned i = 0, e = Sections.size(); i != e; ++i) {
108 if (Sections[i].Address == LocalAddress) {
109 reassignSectionAddress(i, TargetAddress);
113 llvm_unreachable("Attempting to remap address of unknown section!");
116 static std::error_code getOffset(const SymbolRef &Sym, uint64_t &Result) {
118 if (std::error_code EC = Sym.getAddress(Address))
121 if (Address == UnknownAddressOrSize) {
122 Result = UnknownAddressOrSize;
123 return object_error::success;
126 const ObjectFile *Obj = Sym.getObject();
127 section_iterator SecI(Obj->section_begin());
128 if (std::error_code EC = Sym.getSection(SecI))
131 if (SecI == Obj->section_end()) {
132 Result = UnknownAddressOrSize;
133 return object_error::success;
136 uint64_t SectionAddress = SecI->getAddress();
137 Result = Address - SectionAddress;
138 return object_error::success;
141 std::pair<unsigned, unsigned>
142 RuntimeDyldImpl::loadObjectImpl(const object::ObjectFile &Obj) {
143 MutexGuard locked(lock);
145 // Grab the first Section ID. We'll use this later to construct the underlying
146 // range for the returned LoadedObjectInfo.
147 unsigned SectionsAddedBeginIdx = Sections.size();
149 // Save information about our target
150 Arch = (Triple::ArchType)Obj.getArch();
151 IsTargetLittleEndian = Obj.isLittleEndian();
154 // Compute the memory size required to load all sections to be loaded
155 // and pass this information to the memory manager
156 if (MemMgr.needsToReserveAllocationSpace()) {
157 uint64_t CodeSize = 0, DataSizeRO = 0, DataSizeRW = 0;
158 computeTotalAllocSize(Obj, CodeSize, DataSizeRO, DataSizeRW);
159 MemMgr.reserveAllocationSpace(CodeSize, DataSizeRO, DataSizeRW);
162 // Used sections from the object file
163 ObjSectionToIDMap LocalSections;
165 // Common symbols requiring allocation, with their sizes and alignments
166 CommonSymbolList CommonSymbols;
169 DEBUG(dbgs() << "Parse symbols:\n");
170 for (symbol_iterator I = Obj.symbol_begin(), E = Obj.symbol_end(); I != E;
172 uint32_t Flags = I->getFlags();
174 bool IsCommon = Flags & SymbolRef::SF_Common;
176 CommonSymbols.push_back(*I);
178 object::SymbolRef::Type SymType;
179 Check(I->getType(SymType));
181 if (SymType == object::SymbolRef::ST_Function ||
182 SymType == object::SymbolRef::ST_Data ||
183 SymType == object::SymbolRef::ST_Unknown) {
187 Check(I->getName(Name));
188 Check(getOffset(*I, SectOffset));
189 section_iterator SI = Obj.section_end();
190 Check(I->getSection(SI));
191 if (SI == Obj.section_end())
193 StringRef SectionData;
194 Check(SI->getContents(SectionData));
195 bool IsCode = SI->isText();
197 findOrEmitSection(Obj, *SI, IsCode, LocalSections);
198 DEBUG(dbgs() << "\tType: " << SymType << " Name: " << Name
199 << " SID: " << SectionID << " Offset: "
200 << format("%p", (uintptr_t)SectOffset)
201 << " flags: " << Flags << "\n");
202 JITSymbolFlags RTDyldSymFlags = JITSymbolFlags::None;
203 if (Flags & SymbolRef::SF_Weak)
204 RTDyldSymFlags |= JITSymbolFlags::Weak;
205 if (Flags & SymbolRef::SF_Exported)
206 RTDyldSymFlags |= JITSymbolFlags::Exported;
207 GlobalSymbolTable[Name] =
208 SymbolTableEntry(SectionID, SectOffset, RTDyldSymFlags);
213 // Allocate common symbols
214 emitCommonSymbols(Obj, CommonSymbols);
216 // Parse and process relocations
217 DEBUG(dbgs() << "Parse relocations:\n");
218 for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end();
220 unsigned SectionID = 0;
222 section_iterator RelocatedSection = SI->getRelocatedSection();
224 if (RelocatedSection == SE)
227 relocation_iterator I = SI->relocation_begin();
228 relocation_iterator E = SI->relocation_end();
230 if (I == E && !ProcessAllSections)
233 bool IsCode = RelocatedSection->isText();
235 findOrEmitSection(Obj, *RelocatedSection, IsCode, LocalSections);
236 DEBUG(dbgs() << "\tSectionID: " << SectionID << "\n");
239 I = processRelocationRef(SectionID, I, Obj, LocalSections, Stubs);
241 // If there is an attached checker, notify it about the stubs for this
242 // section so that they can be verified.
244 Checker->registerStubMap(Obj.getFileName(), SectionID, Stubs);
247 // Give the subclasses a chance to tie-up any loose ends.
248 finalizeLoad(Obj, LocalSections);
250 unsigned SectionsAddedEndIdx = Sections.size();
252 return std::make_pair(SectionsAddedBeginIdx, SectionsAddedEndIdx);
255 // A helper method for computeTotalAllocSize.
256 // Computes the memory size required to allocate sections with the given sizes,
257 // assuming that all sections are allocated with the given alignment
259 computeAllocationSizeForSections(std::vector<uint64_t> &SectionSizes,
260 uint64_t Alignment) {
261 uint64_t TotalSize = 0;
262 for (size_t Idx = 0, Cnt = SectionSizes.size(); Idx < Cnt; Idx++) {
263 uint64_t AlignedSize =
264 (SectionSizes[Idx] + Alignment - 1) / Alignment * Alignment;
265 TotalSize += AlignedSize;
270 static bool isRequiredForExecution(const SectionRef &Section) {
271 const ObjectFile *Obj = Section.getObject();
272 if (auto *ELFObj = dyn_cast<object::ELFObjectFileBase>(Obj))
273 return ELFObj->getSectionFlags(Section) & ELF::SHF_ALLOC;
274 if (auto *COFFObj = dyn_cast<object::COFFObjectFile>(Obj)) {
275 const coff_section *CoffSection = COFFObj->getCOFFSection(Section);
276 // Avoid loading zero-sized COFF sections.
277 // In PE files, VirtualSize gives the section size, and SizeOfRawData
278 // may be zero for sections with content. In Obj files, SizeOfRawData
279 // gives the section size, and VirtualSize is always zero. Hence
280 // the need to check for both cases below.
281 bool HasContent = (CoffSection->VirtualSize > 0)
282 || (CoffSection->SizeOfRawData > 0);
283 bool IsDiscardable = CoffSection->Characteristics &
284 (COFF::IMAGE_SCN_MEM_DISCARDABLE | COFF::IMAGE_SCN_LNK_INFO);
285 return HasContent && !IsDiscardable;
288 assert(isa<MachOObjectFile>(Obj));
292 static bool isReadOnlyData(const SectionRef &Section) {
293 const ObjectFile *Obj = Section.getObject();
294 if (auto *ELFObj = dyn_cast<object::ELFObjectFileBase>(Obj))
295 return !(ELFObj->getSectionFlags(Section) &
296 (ELF::SHF_WRITE | ELF::SHF_EXECINSTR));
297 if (auto *COFFObj = dyn_cast<object::COFFObjectFile>(Obj))
298 return ((COFFObj->getCOFFSection(Section)->Characteristics &
299 (COFF::IMAGE_SCN_CNT_INITIALIZED_DATA
300 | COFF::IMAGE_SCN_MEM_READ
301 | COFF::IMAGE_SCN_MEM_WRITE))
303 (COFF::IMAGE_SCN_CNT_INITIALIZED_DATA
304 | COFF::IMAGE_SCN_MEM_READ));
306 assert(isa<MachOObjectFile>(Obj));
310 static bool isZeroInit(const SectionRef &Section) {
311 const ObjectFile *Obj = Section.getObject();
312 if (auto *ELFObj = dyn_cast<object::ELFObjectFileBase>(Obj))
313 return ELFObj->getSectionType(Section) == ELF::SHT_NOBITS;
314 if (auto *COFFObj = dyn_cast<object::COFFObjectFile>(Obj))
315 return COFFObj->getCOFFSection(Section)->Characteristics &
316 COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA;
318 auto *MachO = cast<MachOObjectFile>(Obj);
319 unsigned SectionType = MachO->getSectionType(Section);
320 return SectionType == MachO::S_ZEROFILL ||
321 SectionType == MachO::S_GB_ZEROFILL;
324 // Compute an upper bound of the memory size that is required to load all
326 void RuntimeDyldImpl::computeTotalAllocSize(const ObjectFile &Obj,
328 uint64_t &DataSizeRO,
329 uint64_t &DataSizeRW) {
330 // Compute the size of all sections required for execution
331 std::vector<uint64_t> CodeSectionSizes;
332 std::vector<uint64_t> ROSectionSizes;
333 std::vector<uint64_t> RWSectionSizes;
334 uint64_t MaxAlignment = sizeof(void *);
336 // Collect sizes of all sections to be loaded;
337 // also determine the max alignment of all sections
338 for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end();
340 const SectionRef &Section = *SI;
342 bool IsRequired = isRequiredForExecution(Section);
344 // Consider only the sections that are required to be loaded for execution
347 uint64_t DataSize = Section.getSize();
348 uint64_t Alignment64 = Section.getAlignment();
349 bool IsCode = Section.isText();
350 bool IsReadOnly = isReadOnlyData(Section);
351 Check(Section.getName(Name));
352 unsigned Alignment = (unsigned)Alignment64 & 0xffffffffL;
354 uint64_t StubBufSize = computeSectionStubBufSize(Obj, Section);
355 uint64_t SectionSize = DataSize + StubBufSize;
357 // The .eh_frame section (at least on Linux) needs an extra four bytes
359 // with zeroes added at the end. For MachO objects, this section has a
360 // slightly different name, so this won't have any effect for MachO
362 if (Name == ".eh_frame")
369 CodeSectionSizes.push_back(SectionSize);
370 } else if (IsReadOnly) {
371 ROSectionSizes.push_back(SectionSize);
373 RWSectionSizes.push_back(SectionSize);
376 // update the max alignment
377 if (Alignment > MaxAlignment) {
378 MaxAlignment = Alignment;
383 // Compute the size of all common symbols
384 uint64_t CommonSize = 0;
385 for (symbol_iterator I = Obj.symbol_begin(), E = Obj.symbol_end(); I != E;
387 uint32_t Flags = I->getFlags();
388 if (Flags & SymbolRef::SF_Common) {
389 // Add the common symbols to a list. We'll allocate them all below.
391 Check(I->getSize(Size));
395 if (CommonSize != 0) {
396 RWSectionSizes.push_back(CommonSize);
399 // Compute the required allocation space for each different type of sections
400 // (code, read-only data, read-write data) assuming that all sections are
401 // allocated with the max alignment. Note that we cannot compute with the
402 // individual alignments of the sections, because then the required size
403 // depends on the order, in which the sections are allocated.
404 CodeSize = computeAllocationSizeForSections(CodeSectionSizes, MaxAlignment);
405 DataSizeRO = computeAllocationSizeForSections(ROSectionSizes, MaxAlignment);
406 DataSizeRW = computeAllocationSizeForSections(RWSectionSizes, MaxAlignment);
409 // compute stub buffer size for the given section
410 unsigned RuntimeDyldImpl::computeSectionStubBufSize(const ObjectFile &Obj,
411 const SectionRef &Section) {
412 unsigned StubSize = getMaxStubSize();
416 // FIXME: this is an inefficient way to handle this. We should computed the
417 // necessary section allocation size in loadObject by walking all the sections
419 unsigned StubBufSize = 0;
420 for (section_iterator SI = Obj.section_begin(), SE = Obj.section_end();
422 section_iterator RelSecI = SI->getRelocatedSection();
423 if (!(RelSecI == Section))
426 for (const RelocationRef &Reloc : SI->relocations()) {
428 StubBufSize += StubSize;
432 // Get section data size and alignment
433 uint64_t DataSize = Section.getSize();
434 uint64_t Alignment64 = Section.getAlignment();
436 // Add stubbuf size alignment
437 unsigned Alignment = (unsigned)Alignment64 & 0xffffffffL;
438 unsigned StubAlignment = getStubAlignment();
439 unsigned EndAlignment = (DataSize | Alignment) & -(DataSize | Alignment);
440 if (StubAlignment > EndAlignment)
441 StubBufSize += StubAlignment - EndAlignment;
445 uint64_t RuntimeDyldImpl::readBytesUnaligned(uint8_t *Src,
446 unsigned Size) const {
448 if (IsTargetLittleEndian) {
451 Result = (Result << 8) | *Src--;
454 Result = (Result << 8) | *Src++;
459 void RuntimeDyldImpl::writeBytesUnaligned(uint64_t Value, uint8_t *Dst,
460 unsigned Size) const {
461 if (IsTargetLittleEndian) {
463 *Dst++ = Value & 0xFF;
469 *Dst-- = Value & 0xFF;
475 void RuntimeDyldImpl::emitCommonSymbols(const ObjectFile &Obj,
476 CommonSymbolList &CommonSymbols) {
477 if (CommonSymbols.empty())
480 uint64_t CommonSize = 0;
481 CommonSymbolList SymbolsToAllocate;
483 DEBUG(dbgs() << "Processing common symbols...\n");
485 for (const auto &Sym : CommonSymbols) {
487 Check(Sym.getName(Name));
489 // Skip common symbols already elsewhere.
490 if (GlobalSymbolTable.count(Name) ||
491 Resolver.findSymbolInLogicalDylib(Name)) {
492 DEBUG(dbgs() << "\tSkipping already emitted common symbol '" << Name
499 Check(Sym.getAlignment(Align));
500 Check(Sym.getSize(Size));
502 CommonSize += Align + Size;
503 SymbolsToAllocate.push_back(Sym);
506 // Allocate memory for the section
507 unsigned SectionID = Sections.size();
508 uint8_t *Addr = MemMgr.allocateDataSection(CommonSize, sizeof(void *),
509 SectionID, StringRef(), false);
511 report_fatal_error("Unable to allocate memory for common symbols!");
513 Sections.push_back(SectionEntry("<common symbols>", Addr, CommonSize, 0));
514 memset(Addr, 0, CommonSize);
516 DEBUG(dbgs() << "emitCommonSection SectionID: " << SectionID << " new addr: "
517 << format("%p", Addr) << " DataSize: " << CommonSize << "\n");
519 // Assign the address of each symbol
520 for (auto &Sym : SymbolsToAllocate) {
524 Check(Sym.getAlignment(Align));
525 Check(Sym.getSize(Size));
526 Check(Sym.getName(Name));
528 // This symbol has an alignment requirement.
529 uint64_t AlignOffset = OffsetToAlignment((uint64_t)Addr, Align);
531 Offset += AlignOffset;
533 uint32_t Flags = Sym.getFlags();
534 JITSymbolFlags RTDyldSymFlags = JITSymbolFlags::None;
535 if (Flags & SymbolRef::SF_Weak)
536 RTDyldSymFlags |= JITSymbolFlags::Weak;
537 if (Flags & SymbolRef::SF_Exported)
538 RTDyldSymFlags |= JITSymbolFlags::Exported;
539 DEBUG(dbgs() << "Allocating common symbol " << Name << " address "
540 << format("%p", Addr) << "\n");
541 GlobalSymbolTable[Name] =
542 SymbolTableEntry(SectionID, Offset, RTDyldSymFlags);
548 unsigned RuntimeDyldImpl::emitSection(const ObjectFile &Obj,
549 const SectionRef &Section, bool IsCode) {
552 uint64_t Alignment64 = Section.getAlignment();
554 unsigned Alignment = (unsigned)Alignment64 & 0xffffffffL;
555 unsigned PaddingSize = 0;
556 unsigned StubBufSize = 0;
558 bool IsRequired = isRequiredForExecution(Section);
559 bool IsVirtual = Section.isVirtual();
560 bool IsZeroInit = isZeroInit(Section);
561 bool IsReadOnly = isReadOnlyData(Section);
562 uint64_t DataSize = Section.getSize();
563 Check(Section.getName(Name));
565 StubBufSize = computeSectionStubBufSize(Obj, Section);
567 // The .eh_frame section (at least on Linux) needs an extra four bytes padded
568 // with zeroes added at the end. For MachO objects, this section has a
569 // slightly different name, so this won't have any effect for MachO objects.
570 if (Name == ".eh_frame")
574 unsigned SectionID = Sections.size();
576 const char *pData = nullptr;
578 // In either case, set the location of the unrelocated section in memory,
579 // since we still process relocations for it even if we're not applying them.
580 Check(Section.getContents(data));
581 // Virtual sections have no data in the object image, so leave pData = 0
585 // Some sections, such as debug info, don't need to be loaded for execution.
586 // Leave those where they are.
588 Allocate = DataSize + PaddingSize + StubBufSize;
591 Addr = IsCode ? MemMgr.allocateCodeSection(Allocate, Alignment, SectionID,
593 : MemMgr.allocateDataSection(Allocate, Alignment, SectionID,
596 report_fatal_error("Unable to allocate section memory!");
598 // Zero-initialize or copy the data from the image
599 if (IsZeroInit || IsVirtual)
600 memset(Addr, 0, DataSize);
602 memcpy(Addr, pData, DataSize);
604 // Fill in any extra bytes we allocated for padding
605 if (PaddingSize != 0) {
606 memset(Addr + DataSize, 0, PaddingSize);
607 // Update the DataSize variable so that the stub offset is set correctly.
608 DataSize += PaddingSize;
611 DEBUG(dbgs() << "emitSection SectionID: " << SectionID << " Name: " << Name
612 << " obj addr: " << format("%p", pData)
613 << " new addr: " << format("%p", Addr)
614 << " DataSize: " << DataSize << " StubBufSize: " << StubBufSize
615 << " Allocate: " << Allocate << "\n");
617 // Even if we didn't load the section, we need to record an entry for it
618 // to handle later processing (and by 'handle' I mean don't do anything
619 // with these sections).
622 DEBUG(dbgs() << "emitSection SectionID: " << SectionID << " Name: " << Name
623 << " obj addr: " << format("%p", data.data()) << " new addr: 0"
624 << " DataSize: " << DataSize << " StubBufSize: " << StubBufSize
625 << " Allocate: " << Allocate << "\n");
628 Sections.push_back(SectionEntry(Name, Addr, DataSize, (uintptr_t)pData));
631 Checker->registerSection(Obj.getFileName(), SectionID);
636 unsigned RuntimeDyldImpl::findOrEmitSection(const ObjectFile &Obj,
637 const SectionRef &Section,
639 ObjSectionToIDMap &LocalSections) {
641 unsigned SectionID = 0;
642 ObjSectionToIDMap::iterator i = LocalSections.find(Section);
643 if (i != LocalSections.end())
644 SectionID = i->second;
646 SectionID = emitSection(Obj, Section, IsCode);
647 LocalSections[Section] = SectionID;
652 void RuntimeDyldImpl::addRelocationForSection(const RelocationEntry &RE,
653 unsigned SectionID) {
654 Relocations[SectionID].push_back(RE);
657 void RuntimeDyldImpl::addRelocationForSymbol(const RelocationEntry &RE,
658 StringRef SymbolName) {
659 // Relocation by symbol. If the symbol is found in the global symbol table,
660 // create an appropriate section relocation. Otherwise, add it to
661 // ExternalSymbolRelocations.
662 RTDyldSymbolTable::const_iterator Loc = GlobalSymbolTable.find(SymbolName);
663 if (Loc == GlobalSymbolTable.end()) {
664 ExternalSymbolRelocations[SymbolName].push_back(RE);
666 // Copy the RE since we want to modify its addend.
667 RelocationEntry RECopy = RE;
668 const auto &SymInfo = Loc->second;
669 RECopy.Addend += SymInfo.getOffset();
670 Relocations[SymInfo.getSectionID()].push_back(RECopy);
674 uint8_t *RuntimeDyldImpl::createStubFunction(uint8_t *Addr,
675 unsigned AbiVariant) {
676 if (Arch == Triple::aarch64 || Arch == Triple::aarch64_be) {
677 // This stub has to be able to access the full address space,
678 // since symbol lookup won't necessarily find a handy, in-range,
679 // PLT stub for functions which could be anywhere.
680 // Stub can use ip0 (== x16) to calculate address
681 writeBytesUnaligned(0xd2e00010, Addr, 4); // movz ip0, #:abs_g3:<addr>
682 writeBytesUnaligned(0xf2c00010, Addr+4, 4); // movk ip0, #:abs_g2_nc:<addr>
683 writeBytesUnaligned(0xf2a00010, Addr+8, 4); // movk ip0, #:abs_g1_nc:<addr>
684 writeBytesUnaligned(0xf2800010, Addr+12, 4); // movk ip0, #:abs_g0_nc:<addr>
685 writeBytesUnaligned(0xd61f0200, Addr+16, 4); // br ip0
688 } else if (Arch == Triple::arm || Arch == Triple::armeb) {
689 // TODO: There is only ARM far stub now. We should add the Thumb stub,
690 // and stubs for branches Thumb - ARM and ARM - Thumb.
691 writeBytesUnaligned(0xe51ff004, Addr, 4); // ldr pc,<label>
693 } else if (IsMipsO32ABI) {
694 // 0: 3c190000 lui t9,%hi(addr).
695 // 4: 27390000 addiu t9,t9,%lo(addr).
696 // 8: 03200008 jr t9.
698 const unsigned LuiT9Instr = 0x3c190000, AdduiT9Instr = 0x27390000;
699 const unsigned JrT9Instr = 0x03200008, NopInstr = 0x0;
701 writeBytesUnaligned(LuiT9Instr, Addr, 4);
702 writeBytesUnaligned(AdduiT9Instr, Addr+4, 4);
703 writeBytesUnaligned(JrT9Instr, Addr+8, 4);
704 writeBytesUnaligned(NopInstr, Addr+12, 4);
706 } else if (Arch == Triple::ppc64 || Arch == Triple::ppc64le) {
707 // Depending on which version of the ELF ABI is in use, we need to
708 // generate one of two variants of the stub. They both start with
709 // the same sequence to load the target address into r12.
710 writeInt32BE(Addr, 0x3D800000); // lis r12, highest(addr)
711 writeInt32BE(Addr+4, 0x618C0000); // ori r12, higher(addr)
712 writeInt32BE(Addr+8, 0x798C07C6); // sldi r12, r12, 32
713 writeInt32BE(Addr+12, 0x658C0000); // oris r12, r12, h(addr)
714 writeInt32BE(Addr+16, 0x618C0000); // ori r12, r12, l(addr)
715 if (AbiVariant == 2) {
716 // PowerPC64 stub ELFv2 ABI: The address points to the function itself.
717 // The address is already in r12 as required by the ABI. Branch to it.
718 writeInt32BE(Addr+20, 0xF8410018); // std r2, 24(r1)
719 writeInt32BE(Addr+24, 0x7D8903A6); // mtctr r12
720 writeInt32BE(Addr+28, 0x4E800420); // bctr
722 // PowerPC64 stub ELFv1 ABI: The address points to a function descriptor.
723 // Load the function address on r11 and sets it to control register. Also
724 // loads the function TOC in r2 and environment pointer to r11.
725 writeInt32BE(Addr+20, 0xF8410028); // std r2, 40(r1)
726 writeInt32BE(Addr+24, 0xE96C0000); // ld r11, 0(r12)
727 writeInt32BE(Addr+28, 0xE84C0008); // ld r2, 0(r12)
728 writeInt32BE(Addr+32, 0x7D6903A6); // mtctr r11
729 writeInt32BE(Addr+36, 0xE96C0010); // ld r11, 16(r2)
730 writeInt32BE(Addr+40, 0x4E800420); // bctr
733 } else if (Arch == Triple::systemz) {
734 writeInt16BE(Addr, 0xC418); // lgrl %r1,.+8
735 writeInt16BE(Addr+2, 0x0000);
736 writeInt16BE(Addr+4, 0x0004);
737 writeInt16BE(Addr+6, 0x07F1); // brc 15,%r1
738 // 8-byte address stored at Addr + 8
740 } else if (Arch == Triple::x86_64) {
742 *(Addr+1) = 0x25; // rip
743 // 32-bit PC-relative address of the GOT entry will be stored at Addr+2
744 } else if (Arch == Triple::x86) {
745 *Addr = 0xE9; // 32-bit pc-relative jump.
750 // Assign an address to a symbol name and resolve all the relocations
751 // associated with it.
752 void RuntimeDyldImpl::reassignSectionAddress(unsigned SectionID,
754 // The address to use for relocation resolution is not
755 // the address of the local section buffer. We must be doing
756 // a remote execution environment of some sort. Relocations can't
757 // be applied until all the sections have been moved. The client must
758 // trigger this with a call to MCJIT::finalize() or
759 // RuntimeDyld::resolveRelocations().
761 // Addr is a uint64_t because we can't assume the pointer width
762 // of the target is the same as that of the host. Just use a generic
763 // "big enough" type.
764 DEBUG(dbgs() << "Reassigning address for section "
765 << SectionID << " (" << Sections[SectionID].Name << "): "
766 << format("0x%016" PRIx64, Sections[SectionID].LoadAddress) << " -> "
767 << format("0x%016" PRIx64, Addr) << "\n");
768 Sections[SectionID].LoadAddress = Addr;
771 void RuntimeDyldImpl::resolveRelocationList(const RelocationList &Relocs,
773 for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
774 const RelocationEntry &RE = Relocs[i];
775 // Ignore relocations for sections that were not loaded
776 if (Sections[RE.SectionID].Address == nullptr)
778 resolveRelocation(RE, Value);
782 void RuntimeDyldImpl::resolveExternalSymbols() {
783 while (!ExternalSymbolRelocations.empty()) {
784 StringMap<RelocationList>::iterator i = ExternalSymbolRelocations.begin();
786 StringRef Name = i->first();
787 if (Name.size() == 0) {
788 // This is an absolute symbol, use an address of zero.
789 DEBUG(dbgs() << "Resolving absolute relocations."
791 RelocationList &Relocs = i->second;
792 resolveRelocationList(Relocs, 0);
795 RTDyldSymbolTable::const_iterator Loc = GlobalSymbolTable.find(Name);
796 if (Loc == GlobalSymbolTable.end()) {
797 // This is an external symbol, try to get its address from the symbol
799 Addr = Resolver.findSymbol(Name.data()).getAddress();
800 // The call to getSymbolAddress may have caused additional modules to
801 // be loaded, which may have added new entries to the
802 // ExternalSymbolRelocations map. Consquently, we need to update our
803 // iterator. This is also why retrieval of the relocation list
804 // associated with this symbol is deferred until below this point.
805 // New entries may have been added to the relocation list.
806 i = ExternalSymbolRelocations.find(Name);
808 // We found the symbol in our global table. It was probably in a
809 // Module that we loaded previously.
810 const auto &SymInfo = Loc->second;
811 Addr = getSectionLoadAddress(SymInfo.getSectionID()) +
815 // FIXME: Implement error handling that doesn't kill the host program!
817 report_fatal_error("Program used external function '" + Name +
818 "' which could not be resolved!");
820 DEBUG(dbgs() << "Resolving relocations Name: " << Name << "\t"
821 << format("0x%lx", Addr) << "\n");
822 // This list may have been updated when we called getSymbolAddress, so
823 // don't change this code to get the list earlier.
824 RelocationList &Relocs = i->second;
825 resolveRelocationList(Relocs, Addr);
828 ExternalSymbolRelocations.erase(i);
832 //===----------------------------------------------------------------------===//
833 // RuntimeDyld class implementation
835 uint64_t RuntimeDyld::LoadedObjectInfo::getSectionLoadAddress(
836 StringRef SectionName) const {
837 for (unsigned I = BeginIdx; I != EndIdx; ++I)
838 if (RTDyld.Sections[I].Name == SectionName)
839 return RTDyld.Sections[I].LoadAddress;
844 void RuntimeDyld::MemoryManager::anchor() {}
845 void RuntimeDyld::SymbolResolver::anchor() {}
847 RuntimeDyld::RuntimeDyld(RuntimeDyld::MemoryManager &MemMgr,
848 RuntimeDyld::SymbolResolver &Resolver)
849 : MemMgr(MemMgr), Resolver(Resolver) {
850 // FIXME: There's a potential issue lurking here if a single instance of
851 // RuntimeDyld is used to load multiple objects. The current implementation
852 // associates a single memory manager with a RuntimeDyld instance. Even
853 // though the public class spawns a new 'impl' instance for each load,
854 // they share a single memory manager. This can become a problem when page
855 // permissions are applied.
857 ProcessAllSections = false;
861 RuntimeDyld::~RuntimeDyld() {}
863 static std::unique_ptr<RuntimeDyldCOFF>
864 createRuntimeDyldCOFF(Triple::ArchType Arch, RuntimeDyld::MemoryManager &MM,
865 RuntimeDyld::SymbolResolver &Resolver,
866 bool ProcessAllSections, RuntimeDyldCheckerImpl *Checker) {
867 std::unique_ptr<RuntimeDyldCOFF> Dyld =
868 RuntimeDyldCOFF::create(Arch, MM, Resolver);
869 Dyld->setProcessAllSections(ProcessAllSections);
870 Dyld->setRuntimeDyldChecker(Checker);
874 static std::unique_ptr<RuntimeDyldELF>
875 createRuntimeDyldELF(RuntimeDyld::MemoryManager &MM,
876 RuntimeDyld::SymbolResolver &Resolver,
877 bool ProcessAllSections, RuntimeDyldCheckerImpl *Checker) {
878 std::unique_ptr<RuntimeDyldELF> Dyld(new RuntimeDyldELF(MM, Resolver));
879 Dyld->setProcessAllSections(ProcessAllSections);
880 Dyld->setRuntimeDyldChecker(Checker);
884 static std::unique_ptr<RuntimeDyldMachO>
885 createRuntimeDyldMachO(Triple::ArchType Arch, RuntimeDyld::MemoryManager &MM,
886 RuntimeDyld::SymbolResolver &Resolver,
887 bool ProcessAllSections,
888 RuntimeDyldCheckerImpl *Checker) {
889 std::unique_ptr<RuntimeDyldMachO> Dyld =
890 RuntimeDyldMachO::create(Arch, MM, Resolver);
891 Dyld->setProcessAllSections(ProcessAllSections);
892 Dyld->setRuntimeDyldChecker(Checker);
896 std::unique_ptr<RuntimeDyld::LoadedObjectInfo>
897 RuntimeDyld::loadObject(const ObjectFile &Obj) {
900 Dyld = createRuntimeDyldELF(MemMgr, Resolver, ProcessAllSections, Checker);
901 else if (Obj.isMachO())
902 Dyld = createRuntimeDyldMachO(
903 static_cast<Triple::ArchType>(Obj.getArch()), MemMgr, Resolver,
904 ProcessAllSections, Checker);
905 else if (Obj.isCOFF())
906 Dyld = createRuntimeDyldCOFF(
907 static_cast<Triple::ArchType>(Obj.getArch()), MemMgr, Resolver,
908 ProcessAllSections, Checker);
910 report_fatal_error("Incompatible object format!");
913 if (!Dyld->isCompatibleFile(Obj))
914 report_fatal_error("Incompatible object format!");
916 return Dyld->loadObject(Obj);
919 void *RuntimeDyld::getSymbolLocalAddress(StringRef Name) const {
922 return Dyld->getSymbolLocalAddress(Name);
925 RuntimeDyld::SymbolInfo RuntimeDyld::getSymbol(StringRef Name) const {
928 return Dyld->getSymbol(Name);
931 void RuntimeDyld::resolveRelocations() { Dyld->resolveRelocations(); }
933 void RuntimeDyld::reassignSectionAddress(unsigned SectionID, uint64_t Addr) {
934 Dyld->reassignSectionAddress(SectionID, Addr);
937 void RuntimeDyld::mapSectionAddress(const void *LocalAddress,
938 uint64_t TargetAddress) {
939 Dyld->mapSectionAddress(LocalAddress, TargetAddress);
942 bool RuntimeDyld::hasError() { return Dyld->hasError(); }
944 StringRef RuntimeDyld::getErrorString() { return Dyld->getErrorString(); }
946 void RuntimeDyld::registerEHFrames() {
948 Dyld->registerEHFrames();
951 void RuntimeDyld::deregisterEHFrames() {
953 Dyld->deregisterEHFrames();
956 } // end namespace llvm