109467b48Spatrick //===---- MachO_arm64.cpp - JIT linker implementation for MachO/arm64 -----===//
209467b48Spatrick //
309467b48Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
409467b48Spatrick // See https://llvm.org/LICENSE.txt for license information.
509467b48Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
609467b48Spatrick //
709467b48Spatrick //===----------------------------------------------------------------------===//
809467b48Spatrick //
909467b48Spatrick // MachO/arm64 jit-link implementation.
1009467b48Spatrick //
1109467b48Spatrick //===----------------------------------------------------------------------===//
1209467b48Spatrick
1309467b48Spatrick #include "llvm/ExecutionEngine/JITLink/MachO_arm64.h"
14*d415bd75Srobert #include "llvm/ExecutionEngine/JITLink/DWARFRecordSectionSplitter.h"
15*d415bd75Srobert #include "llvm/ExecutionEngine/JITLink/aarch64.h"
1609467b48Spatrick
1709467b48Spatrick #include "MachOLinkGraphBuilder.h"
1809467b48Spatrick
1909467b48Spatrick #define DEBUG_TYPE "jitlink"
2009467b48Spatrick
2109467b48Spatrick using namespace llvm;
2209467b48Spatrick using namespace llvm::jitlink;
2309467b48Spatrick
2409467b48Spatrick namespace {
2509467b48Spatrick
2609467b48Spatrick class MachOLinkGraphBuilder_arm64 : public MachOLinkGraphBuilder {
2709467b48Spatrick public:
MachOLinkGraphBuilder_arm64(const object::MachOObjectFile & Obj)2809467b48Spatrick MachOLinkGraphBuilder_arm64(const object::MachOObjectFile &Obj)
2973471bf0Spatrick : MachOLinkGraphBuilder(Obj, Triple("arm64-apple-darwin"),
30*d415bd75Srobert aarch64::getEdgeKindName),
3109467b48Spatrick NumSymbols(Obj.getSymtabLoadCommand().nsyms) {}
3209467b48Spatrick
3309467b48Spatrick private:
34*d415bd75Srobert enum MachOARM64RelocationKind : Edge::Kind {
35*d415bd75Srobert MachOBranch26 = Edge::FirstRelocation,
36*d415bd75Srobert MachOPointer32,
37*d415bd75Srobert MachOPointer64,
38*d415bd75Srobert MachOPointer64Anon,
39*d415bd75Srobert MachOPage21,
40*d415bd75Srobert MachOPageOffset12,
41*d415bd75Srobert MachOGOTPage21,
42*d415bd75Srobert MachOGOTPageOffset12,
43*d415bd75Srobert MachOTLVPage21,
44*d415bd75Srobert MachOTLVPageOffset12,
45*d415bd75Srobert MachOPointerToGOT,
46*d415bd75Srobert MachOPairedAddend,
47*d415bd75Srobert MachOLDRLiteral19,
48*d415bd75Srobert MachODelta32,
49*d415bd75Srobert MachODelta64,
50*d415bd75Srobert MachONegDelta32,
51*d415bd75Srobert MachONegDelta64,
52*d415bd75Srobert };
53*d415bd75Srobert
5409467b48Spatrick static Expected<MachOARM64RelocationKind>
getRelocationKind(const MachO::relocation_info & RI)5509467b48Spatrick getRelocationKind(const MachO::relocation_info &RI) {
5609467b48Spatrick switch (RI.r_type) {
5709467b48Spatrick case MachO::ARM64_RELOC_UNSIGNED:
5809467b48Spatrick if (!RI.r_pcrel) {
5909467b48Spatrick if (RI.r_length == 3)
60*d415bd75Srobert return RI.r_extern ? MachOPointer64 : MachOPointer64Anon;
6109467b48Spatrick else if (RI.r_length == 2)
62*d415bd75Srobert return MachOPointer32;
6309467b48Spatrick }
6409467b48Spatrick break;
6509467b48Spatrick case MachO::ARM64_RELOC_SUBTRACTOR:
6609467b48Spatrick // SUBTRACTOR must be non-pc-rel, extern, with length 2 or 3.
6709467b48Spatrick // Initially represent SUBTRACTOR relocations with 'Delta<W>'.
6809467b48Spatrick // They may be turned into NegDelta<W> by parsePairRelocation.
6909467b48Spatrick if (!RI.r_pcrel && RI.r_extern) {
7009467b48Spatrick if (RI.r_length == 2)
71*d415bd75Srobert return MachODelta32;
7209467b48Spatrick else if (RI.r_length == 3)
73*d415bd75Srobert return MachODelta64;
7409467b48Spatrick }
7509467b48Spatrick break;
7609467b48Spatrick case MachO::ARM64_RELOC_BRANCH26:
7709467b48Spatrick if (RI.r_pcrel && RI.r_extern && RI.r_length == 2)
78*d415bd75Srobert return MachOBranch26;
7909467b48Spatrick break;
8009467b48Spatrick case MachO::ARM64_RELOC_PAGE21:
8109467b48Spatrick if (RI.r_pcrel && RI.r_extern && RI.r_length == 2)
82*d415bd75Srobert return MachOPage21;
8309467b48Spatrick break;
8409467b48Spatrick case MachO::ARM64_RELOC_PAGEOFF12:
8509467b48Spatrick if (!RI.r_pcrel && RI.r_extern && RI.r_length == 2)
86*d415bd75Srobert return MachOPageOffset12;
8709467b48Spatrick break;
8809467b48Spatrick case MachO::ARM64_RELOC_GOT_LOAD_PAGE21:
8909467b48Spatrick if (RI.r_pcrel && RI.r_extern && RI.r_length == 2)
90*d415bd75Srobert return MachOGOTPage21;
9109467b48Spatrick break;
9209467b48Spatrick case MachO::ARM64_RELOC_GOT_LOAD_PAGEOFF12:
9309467b48Spatrick if (!RI.r_pcrel && RI.r_extern && RI.r_length == 2)
94*d415bd75Srobert return MachOGOTPageOffset12;
9509467b48Spatrick break;
9609467b48Spatrick case MachO::ARM64_RELOC_POINTER_TO_GOT:
9709467b48Spatrick if (RI.r_pcrel && RI.r_extern && RI.r_length == 2)
98*d415bd75Srobert return MachOPointerToGOT;
9909467b48Spatrick break;
10009467b48Spatrick case MachO::ARM64_RELOC_ADDEND:
10109467b48Spatrick if (!RI.r_pcrel && !RI.r_extern && RI.r_length == 2)
102*d415bd75Srobert return MachOPairedAddend;
103*d415bd75Srobert break;
104*d415bd75Srobert case MachO::ARM64_RELOC_TLVP_LOAD_PAGE21:
105*d415bd75Srobert if (RI.r_pcrel && RI.r_extern && RI.r_length == 2)
106*d415bd75Srobert return MachOTLVPage21;
107*d415bd75Srobert break;
108*d415bd75Srobert case MachO::ARM64_RELOC_TLVP_LOAD_PAGEOFF12:
109*d415bd75Srobert if (!RI.r_pcrel && RI.r_extern && RI.r_length == 2)
110*d415bd75Srobert return MachOTLVPageOffset12;
11109467b48Spatrick break;
11209467b48Spatrick }
11309467b48Spatrick
11409467b48Spatrick return make_error<JITLinkError>(
11509467b48Spatrick "Unsupported arm64 relocation: address=" +
11609467b48Spatrick formatv("{0:x8}", RI.r_address) +
11709467b48Spatrick ", symbolnum=" + formatv("{0:x6}", RI.r_symbolnum) +
11809467b48Spatrick ", kind=" + formatv("{0:x1}", RI.r_type) +
11909467b48Spatrick ", pc_rel=" + (RI.r_pcrel ? "true" : "false") +
12009467b48Spatrick ", extern=" + (RI.r_extern ? "true" : "false") +
12109467b48Spatrick ", length=" + formatv("{0:d}", RI.r_length));
12209467b48Spatrick }
12309467b48Spatrick
124*d415bd75Srobert using PairRelocInfo = std::tuple<Edge::Kind, Symbol *, uint64_t>;
12509467b48Spatrick
12609467b48Spatrick // Parses paired SUBTRACTOR/UNSIGNED relocations and, on success,
12709467b48Spatrick // returns the edge kind and addend to be used.
12809467b48Spatrick Expected<PairRelocInfo>
parsePairRelocation(Block & BlockToFix,Edge::Kind SubtractorKind,const MachO::relocation_info & SubRI,orc::ExecutorAddr FixupAddress,const char * FixupContent,object::relocation_iterator & UnsignedRelItr,object::relocation_iterator & RelEnd)12909467b48Spatrick parsePairRelocation(Block &BlockToFix, Edge::Kind SubtractorKind,
13009467b48Spatrick const MachO::relocation_info &SubRI,
131*d415bd75Srobert orc::ExecutorAddr FixupAddress, const char *FixupContent,
13209467b48Spatrick object::relocation_iterator &UnsignedRelItr,
13309467b48Spatrick object::relocation_iterator &RelEnd) {
13409467b48Spatrick using namespace support;
13509467b48Spatrick
136*d415bd75Srobert assert(((SubtractorKind == MachODelta32 && SubRI.r_length == 2) ||
137*d415bd75Srobert (SubtractorKind == MachODelta64 && SubRI.r_length == 3)) &&
13809467b48Spatrick "Subtractor kind should match length");
13909467b48Spatrick assert(SubRI.r_extern && "SUBTRACTOR reloc symbol should be extern");
14009467b48Spatrick assert(!SubRI.r_pcrel && "SUBTRACTOR reloc should not be PCRel");
14109467b48Spatrick
14209467b48Spatrick if (UnsignedRelItr == RelEnd)
14309467b48Spatrick return make_error<JITLinkError>("arm64 SUBTRACTOR without paired "
14409467b48Spatrick "UNSIGNED relocation");
14509467b48Spatrick
14609467b48Spatrick auto UnsignedRI = getRelocationInfo(UnsignedRelItr);
14709467b48Spatrick
14809467b48Spatrick if (SubRI.r_address != UnsignedRI.r_address)
14909467b48Spatrick return make_error<JITLinkError>("arm64 SUBTRACTOR and paired UNSIGNED "
15009467b48Spatrick "point to different addresses");
15109467b48Spatrick
15209467b48Spatrick if (SubRI.r_length != UnsignedRI.r_length)
15309467b48Spatrick return make_error<JITLinkError>("length of arm64 SUBTRACTOR and paired "
15409467b48Spatrick "UNSIGNED reloc must match");
15509467b48Spatrick
15609467b48Spatrick Symbol *FromSymbol;
15709467b48Spatrick if (auto FromSymbolOrErr = findSymbolByIndex(SubRI.r_symbolnum))
15809467b48Spatrick FromSymbol = FromSymbolOrErr->GraphSymbol;
15909467b48Spatrick else
16009467b48Spatrick return FromSymbolOrErr.takeError();
16109467b48Spatrick
16209467b48Spatrick // Read the current fixup value.
16309467b48Spatrick uint64_t FixupValue = 0;
16409467b48Spatrick if (SubRI.r_length == 3)
16509467b48Spatrick FixupValue = *(const little64_t *)FixupContent;
16609467b48Spatrick else
16709467b48Spatrick FixupValue = *(const little32_t *)FixupContent;
16809467b48Spatrick
16909467b48Spatrick // Find 'ToSymbol' using symbol number or address, depending on whether the
17009467b48Spatrick // paired UNSIGNED relocation is extern.
17109467b48Spatrick Symbol *ToSymbol = nullptr;
17209467b48Spatrick if (UnsignedRI.r_extern) {
17309467b48Spatrick // Find target symbol by symbol index.
17409467b48Spatrick if (auto ToSymbolOrErr = findSymbolByIndex(UnsignedRI.r_symbolnum))
17509467b48Spatrick ToSymbol = ToSymbolOrErr->GraphSymbol;
17609467b48Spatrick else
17709467b48Spatrick return ToSymbolOrErr.takeError();
17809467b48Spatrick } else {
17973471bf0Spatrick auto ToSymbolSec = findSectionByIndex(UnsignedRI.r_symbolnum - 1);
18073471bf0Spatrick if (!ToSymbolSec)
18173471bf0Spatrick return ToSymbolSec.takeError();
182*d415bd75Srobert ToSymbol = getSymbolByAddress(*ToSymbolSec, ToSymbolSec->Address);
18373471bf0Spatrick assert(ToSymbol && "No symbol for section");
184*d415bd75Srobert FixupValue -= ToSymbol->getAddress().getValue();
18509467b48Spatrick }
18609467b48Spatrick
187*d415bd75Srobert Edge::Kind DeltaKind;
18809467b48Spatrick Symbol *TargetSymbol;
18909467b48Spatrick uint64_t Addend;
19009467b48Spatrick if (&BlockToFix == &FromSymbol->getAddressable()) {
19109467b48Spatrick TargetSymbol = ToSymbol;
192*d415bd75Srobert DeltaKind = (SubRI.r_length == 3) ? aarch64::Delta64 : aarch64::Delta32;
19309467b48Spatrick Addend = FixupValue + (FixupAddress - FromSymbol->getAddress());
19409467b48Spatrick // FIXME: handle extern 'from'.
19509467b48Spatrick } else if (&BlockToFix == &ToSymbol->getAddressable()) {
19609467b48Spatrick TargetSymbol = &*FromSymbol;
197*d415bd75Srobert DeltaKind =
198*d415bd75Srobert (SubRI.r_length == 3) ? aarch64::NegDelta64 : aarch64::NegDelta32;
19909467b48Spatrick Addend = FixupValue - (FixupAddress - ToSymbol->getAddress());
20009467b48Spatrick } else {
20109467b48Spatrick // BlockToFix was neither FromSymbol nor ToSymbol.
20209467b48Spatrick return make_error<JITLinkError>("SUBTRACTOR relocation must fix up "
20309467b48Spatrick "either 'A' or 'B' (or a symbol in one "
20409467b48Spatrick "of their alt-entry groups)");
20509467b48Spatrick }
20609467b48Spatrick
20709467b48Spatrick return PairRelocInfo(DeltaKind, TargetSymbol, Addend);
20809467b48Spatrick }
20909467b48Spatrick
addRelocations()21009467b48Spatrick Error addRelocations() override {
21109467b48Spatrick using namespace support;
21209467b48Spatrick auto &Obj = getObject();
21309467b48Spatrick
21473471bf0Spatrick LLVM_DEBUG(dbgs() << "Processing relocations:\n");
21573471bf0Spatrick
21609467b48Spatrick for (auto &S : Obj.sections()) {
21709467b48Spatrick
218*d415bd75Srobert orc::ExecutorAddr SectionAddress(S.getAddress());
21909467b48Spatrick
220097a140dSpatrick // Skip relocations virtual sections.
221097a140dSpatrick if (S.isVirtual()) {
222097a140dSpatrick if (S.relocation_begin() != S.relocation_end())
223097a140dSpatrick return make_error<JITLinkError>("Virtual section contains "
224097a140dSpatrick "relocations");
225097a140dSpatrick continue;
226097a140dSpatrick }
227097a140dSpatrick
228*d415bd75Srobert auto NSec =
229*d415bd75Srobert findSectionByIndex(Obj.getSectionIndex(S.getRawDataRefImpl()));
230*d415bd75Srobert if (!NSec)
231*d415bd75Srobert return NSec.takeError();
232*d415bd75Srobert
233*d415bd75Srobert // Skip relocations for MachO sections without corresponding graph
234*d415bd75Srobert // sections.
235097a140dSpatrick {
236*d415bd75Srobert if (!NSec->GraphSection) {
237097a140dSpatrick LLVM_DEBUG({
23873471bf0Spatrick dbgs() << " Skipping relocations for MachO section "
239*d415bd75Srobert << NSec->SegName << "/" << NSec->SectName
240097a140dSpatrick << " which has no associated graph section\n";
241097a140dSpatrick });
242097a140dSpatrick continue;
243097a140dSpatrick }
244097a140dSpatrick }
245097a140dSpatrick
24609467b48Spatrick for (auto RelItr = S.relocation_begin(), RelEnd = S.relocation_end();
24709467b48Spatrick RelItr != RelEnd; ++RelItr) {
24809467b48Spatrick
24909467b48Spatrick MachO::relocation_info RI = getRelocationInfo(RelItr);
25009467b48Spatrick
251*d415bd75Srobert // Validate the relocation kind.
252*d415bd75Srobert auto MachORelocKind = getRelocationKind(RI);
253*d415bd75Srobert if (!MachORelocKind)
254*d415bd75Srobert return MachORelocKind.takeError();
25509467b48Spatrick
25609467b48Spatrick // Find the address of the value to fix up.
257*d415bd75Srobert orc::ExecutorAddr FixupAddress =
258*d415bd75Srobert SectionAddress + (uint32_t)RI.r_address;
25909467b48Spatrick LLVM_DEBUG({
260*d415bd75Srobert dbgs() << " " << NSec->SectName << " + "
26173471bf0Spatrick << formatv("{0:x8}", RI.r_address) << ":\n";
26209467b48Spatrick });
26309467b48Spatrick
26409467b48Spatrick // Find the block that the fixup points to.
26509467b48Spatrick Block *BlockToFix = nullptr;
26609467b48Spatrick {
267*d415bd75Srobert auto SymbolToFixOrErr = findSymbolByAddress(*NSec, FixupAddress);
26809467b48Spatrick if (!SymbolToFixOrErr)
26909467b48Spatrick return SymbolToFixOrErr.takeError();
27009467b48Spatrick BlockToFix = &SymbolToFixOrErr->getBlock();
27109467b48Spatrick }
27209467b48Spatrick
273*d415bd75Srobert if (FixupAddress + orc::ExecutorAddrDiff(1ULL << RI.r_length) >
27409467b48Spatrick BlockToFix->getAddress() + BlockToFix->getContent().size())
27509467b48Spatrick return make_error<JITLinkError>(
27609467b48Spatrick "Relocation content extends past end of fixup block");
27709467b48Spatrick
278*d415bd75Srobert Edge::Kind Kind = Edge::Invalid;
279*d415bd75Srobert
28009467b48Spatrick // Get a pointer to the fixup content.
28109467b48Spatrick const char *FixupContent = BlockToFix->getContent().data() +
28209467b48Spatrick (FixupAddress - BlockToFix->getAddress());
28309467b48Spatrick
28409467b48Spatrick // The target symbol and addend will be populated by the switch below.
28509467b48Spatrick Symbol *TargetSymbol = nullptr;
28609467b48Spatrick uint64_t Addend = 0;
28709467b48Spatrick
288*d415bd75Srobert if (*MachORelocKind == MachOPairedAddend) {
28909467b48Spatrick // If this is an Addend relocation then process it and move to the
29009467b48Spatrick // paired reloc.
29109467b48Spatrick
29273471bf0Spatrick Addend = SignExtend64(RI.r_symbolnum, 24);
29309467b48Spatrick
29409467b48Spatrick if (RelItr == RelEnd)
29509467b48Spatrick return make_error<JITLinkError>("Unpaired Addend reloc at " +
29609467b48Spatrick formatv("{0:x16}", FixupAddress));
29709467b48Spatrick ++RelItr;
29809467b48Spatrick RI = getRelocationInfo(RelItr);
29909467b48Spatrick
300*d415bd75Srobert MachORelocKind = getRelocationKind(RI);
301*d415bd75Srobert if (!MachORelocKind)
302*d415bd75Srobert return MachORelocKind.takeError();
30309467b48Spatrick
304*d415bd75Srobert if (*MachORelocKind != MachOBranch26 &&
305*d415bd75Srobert *MachORelocKind != MachOPage21 &&
306*d415bd75Srobert *MachORelocKind != MachOPageOffset12)
30709467b48Spatrick return make_error<JITLinkError>(
30809467b48Spatrick "Invalid relocation pair: Addend + " +
309*d415bd75Srobert StringRef(getMachOARM64RelocationKindName(*MachORelocKind)));
31073471bf0Spatrick
31109467b48Spatrick LLVM_DEBUG({
31273471bf0Spatrick dbgs() << " Addend: value = " << formatv("{0:x6}", Addend)
313*d415bd75Srobert << ", pair is "
314*d415bd75Srobert << getMachOARM64RelocationKindName(*MachORelocKind) << "\n";
31509467b48Spatrick });
31609467b48Spatrick
31709467b48Spatrick // Find the address of the value to fix up.
318*d415bd75Srobert orc::ExecutorAddr PairedFixupAddress =
31909467b48Spatrick SectionAddress + (uint32_t)RI.r_address;
32009467b48Spatrick if (PairedFixupAddress != FixupAddress)
32109467b48Spatrick return make_error<JITLinkError>("Paired relocation points at "
32209467b48Spatrick "different target");
32309467b48Spatrick }
32409467b48Spatrick
325*d415bd75Srobert switch (*MachORelocKind) {
326*d415bd75Srobert case MachOBranch26: {
32709467b48Spatrick if (auto TargetSymbolOrErr = findSymbolByIndex(RI.r_symbolnum))
32809467b48Spatrick TargetSymbol = TargetSymbolOrErr->GraphSymbol;
32909467b48Spatrick else
33009467b48Spatrick return TargetSymbolOrErr.takeError();
33109467b48Spatrick uint32_t Instr = *(const ulittle32_t *)FixupContent;
33209467b48Spatrick if ((Instr & 0x7fffffff) != 0x14000000)
33309467b48Spatrick return make_error<JITLinkError>("BRANCH26 target is not a B or BL "
33409467b48Spatrick "instruction with a zero addend");
335*d415bd75Srobert Kind = aarch64::Branch26PCRel;
33609467b48Spatrick break;
33709467b48Spatrick }
338*d415bd75Srobert case MachOPointer32:
33909467b48Spatrick if (auto TargetSymbolOrErr = findSymbolByIndex(RI.r_symbolnum))
34009467b48Spatrick TargetSymbol = TargetSymbolOrErr->GraphSymbol;
34109467b48Spatrick else
34209467b48Spatrick return TargetSymbolOrErr.takeError();
34309467b48Spatrick Addend = *(const ulittle32_t *)FixupContent;
344*d415bd75Srobert Kind = aarch64::Pointer32;
34509467b48Spatrick break;
346*d415bd75Srobert case MachOPointer64:
34709467b48Spatrick if (auto TargetSymbolOrErr = findSymbolByIndex(RI.r_symbolnum))
34809467b48Spatrick TargetSymbol = TargetSymbolOrErr->GraphSymbol;
34909467b48Spatrick else
35009467b48Spatrick return TargetSymbolOrErr.takeError();
35109467b48Spatrick Addend = *(const ulittle64_t *)FixupContent;
352*d415bd75Srobert Kind = aarch64::Pointer64;
35309467b48Spatrick break;
354*d415bd75Srobert case MachOPointer64Anon: {
355*d415bd75Srobert orc::ExecutorAddr TargetAddress(*(const ulittle64_t *)FixupContent);
356*d415bd75Srobert auto TargetNSec = findSectionByIndex(RI.r_symbolnum - 1);
357*d415bd75Srobert if (!TargetNSec)
358*d415bd75Srobert return TargetNSec.takeError();
359*d415bd75Srobert if (auto TargetSymbolOrErr =
360*d415bd75Srobert findSymbolByAddress(*TargetNSec, TargetAddress))
36109467b48Spatrick TargetSymbol = &*TargetSymbolOrErr;
36209467b48Spatrick else
36309467b48Spatrick return TargetSymbolOrErr.takeError();
36409467b48Spatrick Addend = TargetAddress - TargetSymbol->getAddress();
365*d415bd75Srobert Kind = aarch64::Pointer64;
36609467b48Spatrick break;
36709467b48Spatrick }
368*d415bd75Srobert case MachOPage21:
369*d415bd75Srobert case MachOGOTPage21:
370*d415bd75Srobert case MachOTLVPage21: {
37109467b48Spatrick if (auto TargetSymbolOrErr = findSymbolByIndex(RI.r_symbolnum))
37209467b48Spatrick TargetSymbol = TargetSymbolOrErr->GraphSymbol;
37309467b48Spatrick else
37409467b48Spatrick return TargetSymbolOrErr.takeError();
37509467b48Spatrick uint32_t Instr = *(const ulittle32_t *)FixupContent;
37609467b48Spatrick if ((Instr & 0xffffffe0) != 0x90000000)
37709467b48Spatrick return make_error<JITLinkError>("PAGE21/GOTPAGE21 target is not an "
37809467b48Spatrick "ADRP instruction with a zero "
37909467b48Spatrick "addend");
380*d415bd75Srobert
381*d415bd75Srobert if (*MachORelocKind == MachOPage21) {
382*d415bd75Srobert Kind = aarch64::Page21;
383*d415bd75Srobert } else if (*MachORelocKind == MachOGOTPage21) {
384*d415bd75Srobert Kind = aarch64::RequestGOTAndTransformToPage21;
385*d415bd75Srobert } else if (*MachORelocKind == MachOTLVPage21) {
386*d415bd75Srobert Kind = aarch64::RequestTLVPAndTransformToPage21;
387*d415bd75Srobert }
38809467b48Spatrick break;
38909467b48Spatrick }
390*d415bd75Srobert case MachOPageOffset12: {
39109467b48Spatrick if (auto TargetSymbolOrErr = findSymbolByIndex(RI.r_symbolnum))
39209467b48Spatrick TargetSymbol = TargetSymbolOrErr->GraphSymbol;
39309467b48Spatrick else
39409467b48Spatrick return TargetSymbolOrErr.takeError();
39573471bf0Spatrick uint32_t Instr = *(const ulittle32_t *)FixupContent;
39673471bf0Spatrick uint32_t EncodedAddend = (Instr & 0x003FFC00) >> 10;
39773471bf0Spatrick if (EncodedAddend != 0)
39873471bf0Spatrick return make_error<JITLinkError>("GOTPAGEOFF12 target has non-zero "
39973471bf0Spatrick "encoded addend");
400*d415bd75Srobert Kind = aarch64::PageOffset12;
40109467b48Spatrick break;
40209467b48Spatrick }
403*d415bd75Srobert case MachOGOTPageOffset12:
404*d415bd75Srobert case MachOTLVPageOffset12: {
40509467b48Spatrick if (auto TargetSymbolOrErr = findSymbolByIndex(RI.r_symbolnum))
40609467b48Spatrick TargetSymbol = TargetSymbolOrErr->GraphSymbol;
40709467b48Spatrick else
40809467b48Spatrick return TargetSymbolOrErr.takeError();
40909467b48Spatrick uint32_t Instr = *(const ulittle32_t *)FixupContent;
41009467b48Spatrick if ((Instr & 0xfffffc00) != 0xf9400000)
41109467b48Spatrick return make_error<JITLinkError>("GOTPAGEOFF12 target is not an LDR "
41209467b48Spatrick "immediate instruction with a zero "
41309467b48Spatrick "addend");
414*d415bd75Srobert
415*d415bd75Srobert if (*MachORelocKind == MachOGOTPageOffset12) {
416*d415bd75Srobert Kind = aarch64::RequestGOTAndTransformToPageOffset12;
417*d415bd75Srobert } else if (*MachORelocKind == MachOTLVPageOffset12) {
418*d415bd75Srobert Kind = aarch64::RequestTLVPAndTransformToPageOffset12;
419*d415bd75Srobert }
42009467b48Spatrick break;
42109467b48Spatrick }
422*d415bd75Srobert case MachOPointerToGOT:
42309467b48Spatrick if (auto TargetSymbolOrErr = findSymbolByIndex(RI.r_symbolnum))
42409467b48Spatrick TargetSymbol = TargetSymbolOrErr->GraphSymbol;
42509467b48Spatrick else
42609467b48Spatrick return TargetSymbolOrErr.takeError();
427*d415bd75Srobert
428*d415bd75Srobert Kind = aarch64::RequestGOTAndTransformToDelta32;
42909467b48Spatrick break;
430*d415bd75Srobert case MachODelta32:
431*d415bd75Srobert case MachODelta64: {
43209467b48Spatrick // We use Delta32/Delta64 to represent SUBTRACTOR relocations.
43309467b48Spatrick // parsePairRelocation handles the paired reloc, and returns the
43409467b48Spatrick // edge kind to be used (either Delta32/Delta64, or
43509467b48Spatrick // NegDelta32/NegDelta64, depending on the direction of the
43609467b48Spatrick // subtraction) along with the addend.
43709467b48Spatrick auto PairInfo =
438*d415bd75Srobert parsePairRelocation(*BlockToFix, *MachORelocKind, RI,
439*d415bd75Srobert FixupAddress, FixupContent, ++RelItr, RelEnd);
44009467b48Spatrick if (!PairInfo)
44109467b48Spatrick return PairInfo.takeError();
442*d415bd75Srobert std::tie(Kind, TargetSymbol, Addend) = *PairInfo;
44309467b48Spatrick assert(TargetSymbol && "No target symbol from parsePairRelocation?");
44409467b48Spatrick break;
44509467b48Spatrick }
44609467b48Spatrick default:
44709467b48Spatrick llvm_unreachable("Special relocation kind should not appear in "
44809467b48Spatrick "mach-o file");
44909467b48Spatrick }
45009467b48Spatrick
45109467b48Spatrick LLVM_DEBUG({
45273471bf0Spatrick dbgs() << " ";
453*d415bd75Srobert Edge GE(Kind, FixupAddress - BlockToFix->getAddress(), *TargetSymbol,
45409467b48Spatrick Addend);
455*d415bd75Srobert printEdge(dbgs(), *BlockToFix, GE, aarch64::getEdgeKindName(Kind));
45609467b48Spatrick dbgs() << "\n";
45709467b48Spatrick });
458*d415bd75Srobert BlockToFix->addEdge(Kind, FixupAddress - BlockToFix->getAddress(),
45909467b48Spatrick *TargetSymbol, Addend);
46009467b48Spatrick }
46109467b48Spatrick }
46209467b48Spatrick return Error::success();
46309467b48Spatrick }
46409467b48Spatrick
465*d415bd75Srobert /// Return the string name of the given MachO arm64 edge kind.
getMachOARM64RelocationKindName(Edge::Kind R)466*d415bd75Srobert const char *getMachOARM64RelocationKindName(Edge::Kind R) {
467*d415bd75Srobert switch (R) {
468*d415bd75Srobert case MachOBranch26:
469*d415bd75Srobert return "MachOBranch26";
470*d415bd75Srobert case MachOPointer64:
471*d415bd75Srobert return "MachOPointer64";
472*d415bd75Srobert case MachOPointer64Anon:
473*d415bd75Srobert return "MachOPointer64Anon";
474*d415bd75Srobert case MachOPage21:
475*d415bd75Srobert return "MachOPage21";
476*d415bd75Srobert case MachOPageOffset12:
477*d415bd75Srobert return "MachOPageOffset12";
478*d415bd75Srobert case MachOGOTPage21:
479*d415bd75Srobert return "MachOGOTPage21";
480*d415bd75Srobert case MachOGOTPageOffset12:
481*d415bd75Srobert return "MachOGOTPageOffset12";
482*d415bd75Srobert case MachOTLVPage21:
483*d415bd75Srobert return "MachOTLVPage21";
484*d415bd75Srobert case MachOTLVPageOffset12:
485*d415bd75Srobert return "MachOTLVPageOffset12";
486*d415bd75Srobert case MachOPointerToGOT:
487*d415bd75Srobert return "MachOPointerToGOT";
488*d415bd75Srobert case MachOPairedAddend:
489*d415bd75Srobert return "MachOPairedAddend";
490*d415bd75Srobert case MachOLDRLiteral19:
491*d415bd75Srobert return "MachOLDRLiteral19";
492*d415bd75Srobert case MachODelta32:
493*d415bd75Srobert return "MachODelta32";
494*d415bd75Srobert case MachODelta64:
495*d415bd75Srobert return "MachODelta64";
496*d415bd75Srobert case MachONegDelta32:
497*d415bd75Srobert return "MachONegDelta32";
498*d415bd75Srobert case MachONegDelta64:
499*d415bd75Srobert return "MachONegDelta64";
500*d415bd75Srobert default:
501*d415bd75Srobert return getGenericEdgeKindName(static_cast<Edge::Kind>(R));
502*d415bd75Srobert }
503*d415bd75Srobert }
504*d415bd75Srobert
50509467b48Spatrick unsigned NumSymbols = 0;
50609467b48Spatrick };
50709467b48Spatrick
50809467b48Spatrick } // namespace
50909467b48Spatrick
51009467b48Spatrick namespace llvm {
51109467b48Spatrick namespace jitlink {
51209467b48Spatrick
buildTables_MachO_arm64(LinkGraph & G)513*d415bd75Srobert Error buildTables_MachO_arm64(LinkGraph &G) {
514*d415bd75Srobert LLVM_DEBUG(dbgs() << "Visiting edges in graph:\n");
515*d415bd75Srobert
516*d415bd75Srobert aarch64::GOTTableManager GOT;
517*d415bd75Srobert aarch64::PLTTableManager PLT(GOT);
518*d415bd75Srobert visitExistingEdges(G, GOT, PLT);
519*d415bd75Srobert return Error::success();
520*d415bd75Srobert }
521*d415bd75Srobert
52209467b48Spatrick class MachOJITLinker_arm64 : public JITLinker<MachOJITLinker_arm64> {
52309467b48Spatrick friend class JITLinker<MachOJITLinker_arm64>;
52409467b48Spatrick
52509467b48Spatrick public:
MachOJITLinker_arm64(std::unique_ptr<JITLinkContext> Ctx,std::unique_ptr<LinkGraph> G,PassConfiguration PassConfig)52609467b48Spatrick MachOJITLinker_arm64(std::unique_ptr<JITLinkContext> Ctx,
52773471bf0Spatrick std::unique_ptr<LinkGraph> G,
52809467b48Spatrick PassConfiguration PassConfig)
52973471bf0Spatrick : JITLinker(std::move(Ctx), std::move(G), std::move(PassConfig)) {}
53009467b48Spatrick
53109467b48Spatrick private:
applyFixup(LinkGraph & G,Block & B,const Edge & E) const53273471bf0Spatrick Error applyFixup(LinkGraph &G, Block &B, const Edge &E) const {
533*d415bd75Srobert return aarch64::applyFixup(G, B, E);
53409467b48Spatrick }
53509467b48Spatrick
53609467b48Spatrick uint64_t NullValue = 0;
53709467b48Spatrick };
53809467b48Spatrick
53973471bf0Spatrick Expected<std::unique_ptr<LinkGraph>>
createLinkGraphFromMachOObject_arm64(MemoryBufferRef ObjectBuffer)54073471bf0Spatrick createLinkGraphFromMachOObject_arm64(MemoryBufferRef ObjectBuffer) {
54173471bf0Spatrick auto MachOObj = object::ObjectFile::createMachOObjectFile(ObjectBuffer);
54273471bf0Spatrick if (!MachOObj)
54373471bf0Spatrick return MachOObj.takeError();
54473471bf0Spatrick return MachOLinkGraphBuilder_arm64(**MachOObj).buildGraph();
54573471bf0Spatrick }
54609467b48Spatrick
link_MachO_arm64(std::unique_ptr<LinkGraph> G,std::unique_ptr<JITLinkContext> Ctx)54773471bf0Spatrick void link_MachO_arm64(std::unique_ptr<LinkGraph> G,
54873471bf0Spatrick std::unique_ptr<JITLinkContext> Ctx) {
54973471bf0Spatrick
55073471bf0Spatrick PassConfiguration Config;
55173471bf0Spatrick
55273471bf0Spatrick if (Ctx->shouldAddDefaultTargetPasses(G->getTargetTriple())) {
55309467b48Spatrick // Add a mark-live pass.
55473471bf0Spatrick if (auto MarkLive = Ctx->getMarkLivePass(G->getTargetTriple()))
55509467b48Spatrick Config.PrePrunePasses.push_back(std::move(MarkLive));
55609467b48Spatrick else
55709467b48Spatrick Config.PrePrunePasses.push_back(markAllSymbolsLive);
55809467b48Spatrick
559*d415bd75Srobert // Add compact unwind splitter pass.
560*d415bd75Srobert Config.PrePrunePasses.push_back(
561*d415bd75Srobert CompactUnwindSplitter("__LD,__compact_unwind"));
562*d415bd75Srobert
563*d415bd75Srobert // Add eh-frame passses.
564*d415bd75Srobert // FIXME: Prune eh-frames for which compact-unwind is available once
565*d415bd75Srobert // we support compact-unwind registration with libunwind.
566*d415bd75Srobert Config.PrePrunePasses.push_back(createEHFrameSplitterPass_MachO_arm64());
567*d415bd75Srobert Config.PrePrunePasses.push_back(createEHFrameEdgeFixerPass_MachO_arm64());
568*d415bd75Srobert
56909467b48Spatrick // Add an in-place GOT/Stubs pass.
570*d415bd75Srobert Config.PostPrunePasses.push_back(buildTables_MachO_arm64);
57109467b48Spatrick }
57209467b48Spatrick
57373471bf0Spatrick if (auto Err = Ctx->modifyPassConfig(*G, Config))
57409467b48Spatrick return Ctx->notifyFailed(std::move(Err));
57509467b48Spatrick
57609467b48Spatrick // Construct a JITLinker and run the link function.
57773471bf0Spatrick MachOJITLinker_arm64::link(std::move(Ctx), std::move(G), std::move(Config));
57809467b48Spatrick }
57909467b48Spatrick
createEHFrameSplitterPass_MachO_arm64()580*d415bd75Srobert LinkGraphPassFunction createEHFrameSplitterPass_MachO_arm64() {
581*d415bd75Srobert return DWARFRecordSectionSplitter("__TEXT,__eh_frame");
58209467b48Spatrick }
583*d415bd75Srobert
createEHFrameEdgeFixerPass_MachO_arm64()584*d415bd75Srobert LinkGraphPassFunction createEHFrameEdgeFixerPass_MachO_arm64() {
585*d415bd75Srobert return EHFrameEdgeFixer("__TEXT,__eh_frame", aarch64::PointerSize,
586*d415bd75Srobert aarch64::Pointer32, aarch64::Pointer64,
587*d415bd75Srobert aarch64::Delta32, aarch64::Delta64,
588*d415bd75Srobert aarch64::NegDelta32);
58909467b48Spatrick }
59009467b48Spatrick
59109467b48Spatrick } // end namespace jitlink
59209467b48Spatrick } // end namespace llvm
593