1 //===-- AArch64MachObjectWriter.cpp - ARM Mach Object Writer --------------===//
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 #include "MCTargetDesc/AArch64FixupKinds.h"
11 #include "MCTargetDesc/AArch64MCTargetDesc.h"
12 #include "llvm/ADT/Twine.h"
13 #include "llvm/MC/MCAsmInfo.h"
14 #include "llvm/MC/MCAsmLayout.h"
15 #include "llvm/MC/MCAssembler.h"
16 #include "llvm/MC/MCContext.h"
17 #include "llvm/MC/MCExpr.h"
18 #include "llvm/MC/MCFixup.h"
19 #include "llvm/MC/MCMachObjectWriter.h"
20 #include "llvm/MC/MCSectionMachO.h"
21 #include "llvm/MC/MCValue.h"
22 #include "llvm/Support/ErrorHandling.h"
23 #include "llvm/Support/MachO.h"
27 class AArch64MachObjectWriter : public MCMachObjectTargetWriter {
28 bool getAArch64FixupKindMachOInfo(const MCFixup &Fixup, unsigned &RelocType,
29 const MCSymbolRefExpr *Sym,
30 unsigned &Log2Size, const MCAssembler &Asm);
33 AArch64MachObjectWriter(uint32_t CPUType, uint32_t CPUSubtype)
34 : MCMachObjectTargetWriter(true /* is64Bit */, CPUType, CPUSubtype,
35 /*UseAggressiveSymbolFolding=*/true) {}
37 void RecordRelocation(MachObjectWriter *Writer, MCAssembler &Asm,
38 const MCAsmLayout &Layout, const MCFragment *Fragment,
39 const MCFixup &Fixup, MCValue Target,
40 uint64_t &FixedValue) override;
44 bool AArch64MachObjectWriter::getAArch64FixupKindMachOInfo(
45 const MCFixup &Fixup, unsigned &RelocType, const MCSymbolRefExpr *Sym,
46 unsigned &Log2Size, const MCAssembler &Asm) {
47 RelocType = unsigned(MachO::ARM64_RELOC_UNSIGNED);
50 switch ((unsigned)Fixup.getKind()) {
55 Log2Size = llvm::Log2_32(1);
58 Log2Size = llvm::Log2_32(2);
61 Log2Size = llvm::Log2_32(4);
62 if (Sym->getKind() == MCSymbolRefExpr::VK_GOT)
63 RelocType = unsigned(MachO::ARM64_RELOC_POINTER_TO_GOT);
66 Log2Size = llvm::Log2_32(8);
67 if (Sym->getKind() == MCSymbolRefExpr::VK_GOT)
68 RelocType = unsigned(MachO::ARM64_RELOC_POINTER_TO_GOT);
70 case AArch64::fixup_aarch64_add_imm12:
71 case AArch64::fixup_aarch64_ldst_imm12_scale1:
72 case AArch64::fixup_aarch64_ldst_imm12_scale2:
73 case AArch64::fixup_aarch64_ldst_imm12_scale4:
74 case AArch64::fixup_aarch64_ldst_imm12_scale8:
75 case AArch64::fixup_aarch64_ldst_imm12_scale16:
76 Log2Size = llvm::Log2_32(4);
77 switch (Sym->getKind()) {
79 llvm_unreachable("Unexpected symbol reference variant kind!");
80 case MCSymbolRefExpr::VK_PAGEOFF:
81 RelocType = unsigned(MachO::ARM64_RELOC_PAGEOFF12);
83 case MCSymbolRefExpr::VK_GOTPAGEOFF:
84 RelocType = unsigned(MachO::ARM64_RELOC_GOT_LOAD_PAGEOFF12);
86 case MCSymbolRefExpr::VK_TLVPPAGEOFF:
87 RelocType = unsigned(MachO::ARM64_RELOC_TLVP_LOAD_PAGEOFF12);
90 case AArch64::fixup_aarch64_pcrel_adrp_imm21:
91 Log2Size = llvm::Log2_32(4);
92 // This encompasses the relocation for the whole 21-bit value.
93 switch (Sym->getKind()) {
95 Asm.getContext().FatalError(Fixup.getLoc(),
96 "ADR/ADRP relocations must be GOT relative");
97 case MCSymbolRefExpr::VK_PAGE:
98 RelocType = unsigned(MachO::ARM64_RELOC_PAGE21);
100 case MCSymbolRefExpr::VK_GOTPAGE:
101 RelocType = unsigned(MachO::ARM64_RELOC_GOT_LOAD_PAGE21);
103 case MCSymbolRefExpr::VK_TLVPPAGE:
104 RelocType = unsigned(MachO::ARM64_RELOC_TLVP_LOAD_PAGE21);
108 case AArch64::fixup_aarch64_pcrel_branch26:
109 case AArch64::fixup_aarch64_pcrel_call26:
110 Log2Size = llvm::Log2_32(4);
111 RelocType = unsigned(MachO::ARM64_RELOC_BRANCH26);
116 static bool canUseLocalRelocation(const MCSectionMachO &Section,
117 const MCSymbol &Symbol, unsigned Log2Size) {
118 // Debug info sections can use local relocations.
119 if (Section.hasAttribute(MachO::S_ATTR_DEBUG))
122 // Otherwise, only pointer sized relocations are supported.
126 // But only if they don't point to a few forbidden sections.
127 if (!Symbol.isInSection())
129 const MCSectionMachO &RefSec = cast<MCSectionMachO>(Symbol.getSection());
130 if (RefSec.getType() == MachO::S_CSTRING_LITERALS)
133 if (RefSec.getSegmentName() == "__DATA" &&
134 RefSec.getSectionName() == "__cfstring")
140 void AArch64MachObjectWriter::RecordRelocation(
141 MachObjectWriter *Writer, MCAssembler &Asm, const MCAsmLayout &Layout,
142 const MCFragment *Fragment, const MCFixup &Fixup, MCValue Target,
143 uint64_t &FixedValue) {
144 unsigned IsPCRel = Writer->isFixupKindPCRel(Asm, Fixup.getKind());
147 uint32_t FixupOffset = Layout.getFragmentOffset(Fragment);
148 unsigned Log2Size = 0;
152 unsigned Kind = Fixup.getKind();
153 const MCSymbolData *RelSymbol = nullptr;
155 FixupOffset += Fixup.getOffset();
157 // AArch64 pcrel relocation addends do not include the section offset.
159 FixedValue += FixupOffset;
161 // ADRP fixups use relocations for the whole symbol value and only
162 // put the addend in the instruction itself. Clear out any value the
163 // generic code figured out from the sybmol definition.
164 if (Kind == AArch64::fixup_aarch64_pcrel_adrp_imm21)
167 // imm19 relocations are for conditional branches, which require
168 // assembler local symbols. If we got here, that's not what we have,
169 // so complain loudly.
170 if (Kind == AArch64::fixup_aarch64_pcrel_branch19) {
171 Asm.getContext().FatalError(Fixup.getLoc(),
172 "conditional branch requires assembler-local"
174 Target.getSymA()->getSymbol().getName() +
179 // 14-bit branch relocations should only target internal labels, and so
180 // should never get here.
181 if (Kind == AArch64::fixup_aarch64_pcrel_branch14) {
182 Asm.getContext().FatalError(Fixup.getLoc(),
183 "Invalid relocation on conditional branch!");
187 if (!getAArch64FixupKindMachOInfo(Fixup, Type, Target.getSymA(), Log2Size,
189 Asm.getContext().FatalError(Fixup.getLoc(), "unknown AArch64 fixup kind!");
193 Value = Target.getConstant();
195 if (Target.isAbsolute()) { // constant
196 // FIXME: Should this always be extern?
197 // SymbolNum of 0 indicates the absolute section.
198 Type = MachO::ARM64_RELOC_UNSIGNED;
201 Asm.getContext().FatalError(Fixup.getLoc(),
202 "PC relative absolute relocation!");
204 // FIXME: x86_64 sets the type to a branch reloc here. Should we do
205 // something similar?
207 } else if (Target.getSymB()) { // A - B + constant
208 const MCSymbol *A = &Target.getSymA()->getSymbol();
209 const MCSymbolData &A_SD = Asm.getSymbolData(*A);
210 const MCSymbolData *A_Base = Asm.getAtom(&A_SD);
212 const MCSymbol *B = &Target.getSymB()->getSymbol();
213 const MCSymbolData &B_SD = Asm.getSymbolData(*B);
214 const MCSymbolData *B_Base = Asm.getAtom(&B_SD);
216 // Check for "_foo@got - .", which comes through here as:
218 // ... _foo@got - Ltmp0
219 if (Target.getSymA()->getKind() == MCSymbolRefExpr::VK_GOT &&
220 Target.getSymB()->getKind() == MCSymbolRefExpr::VK_None &&
221 Layout.getSymbolOffset(&B_SD) ==
222 Layout.getFragmentOffset(Fragment) + Fixup.getOffset()) {
223 // SymB is the PC, so use a PC-rel pointer-to-GOT relocation.
224 Type = MachO::ARM64_RELOC_POINTER_TO_GOT;
226 MachO::any_relocation_info MRE;
227 MRE.r_word0 = FixupOffset;
228 MRE.r_word1 = (IsPCRel << 24) | (Log2Size << 25) | (Type << 28);
229 Writer->addRelocation(A_Base, Fragment->getParent(), MRE);
231 } else if (Target.getSymA()->getKind() != MCSymbolRefExpr::VK_None ||
232 Target.getSymB()->getKind() != MCSymbolRefExpr::VK_None)
233 // Otherwise, neither symbol can be modified.
234 Asm.getContext().FatalError(Fixup.getLoc(),
235 "unsupported relocation of modified symbol");
237 // We don't support PCrel relocations of differences.
239 Asm.getContext().FatalError(Fixup.getLoc(),
240 "unsupported pc-relative relocation of "
243 // AArch64 always uses external relocations. If there is no symbol to use as
244 // a base address (a local symbol with no preceding non-local symbol),
247 // FIXME: We should probably just synthesize an external symbol and use
250 Asm.getContext().FatalError(
252 "unsupported relocation of local symbol '" + A->getName() +
253 "'. Must have non-local symbol earlier in section.");
255 Asm.getContext().FatalError(
257 "unsupported relocation of local symbol '" + B->getName() +
258 "'. Must have non-local symbol earlier in section.");
260 if (A_Base == B_Base && A_Base)
261 Asm.getContext().FatalError(Fixup.getLoc(),
262 "unsupported relocation with identical base");
264 Value += (!A_SD.getFragment() ? 0
265 : Writer->getSymbolAddress(&A_SD, Layout)) -
266 (!A_Base || !A_Base->getFragment()
268 : Writer->getSymbolAddress(A_Base, Layout));
269 Value -= (!B_SD.getFragment() ? 0
270 : Writer->getSymbolAddress(&B_SD, Layout)) -
271 (!B_Base || !B_Base->getFragment()
273 : Writer->getSymbolAddress(B_Base, Layout));
275 Type = MachO::ARM64_RELOC_UNSIGNED;
277 MachO::any_relocation_info MRE;
278 MRE.r_word0 = FixupOffset;
279 MRE.r_word1 = (IsPCRel << 24) | (Log2Size << 25) | (Type << 28);
280 Writer->addRelocation(A_Base, Fragment->getParent(), MRE);
283 Type = MachO::ARM64_RELOC_SUBTRACTOR;
284 } else { // A + constant
285 const MCSymbol *Symbol = &Target.getSymA()->getSymbol();
286 const MCSectionMachO &Section = static_cast<const MCSectionMachO &>(
287 Fragment->getParent()->getSection());
289 bool CanUseLocalRelocation =
290 canUseLocalRelocation(Section, *Symbol, Log2Size);
291 if (Symbol->isTemporary() && (Value || !CanUseLocalRelocation)) {
292 const MCSection &Sec = Symbol->getSection();
293 if (!Asm.getContext().getAsmInfo()->isSectionAtomizableBySymbols(Sec))
294 Asm.addLocalUsedInReloc(*Symbol);
297 const MCSymbolData &SD = Asm.getSymbolData(*Symbol);
298 const MCSymbolData *Base = Asm.getAtom(&SD);
300 // If the symbol is a variable and we weren't able to get a Base for it
301 // (i.e., it's not in the symbol table associated with a section) resolve
302 // the relocation based its expansion instead.
303 if (Symbol->isVariable() && !Base) {
304 // If the evaluation is an absolute value, just use that directly
305 // to keep things easy.
307 if (SD.getSymbol().getVariableValue()->EvaluateAsAbsolute(
308 Res, Layout, Writer->getSectionAddressMap())) {
313 // FIXME: Will the Target we already have ever have any data in it
314 // we need to preserve and merge with the new Target? How about
316 if (!Symbol->getVariableValue()->EvaluateAsRelocatable(Target, &Layout,
318 Asm.getContext().FatalError(Fixup.getLoc(),
319 "unable to resolve variable '" +
320 Symbol->getName() + "'");
321 return RecordRelocation(Writer, Asm, Layout, Fragment, Fixup, Target,
325 // Relocations inside debug sections always use local relocations when
326 // possible. This seems to be done because the debugger doesn't fully
327 // understand relocation entries and expects to find values that
328 // have already been fixed up.
329 if (Symbol->isInSection()) {
330 if (Section.hasAttribute(MachO::S_ATTR_DEBUG))
334 // AArch64 uses external relocations as much as possible. For debug
335 // sections, and for pointer-sized relocations (.quad), we allow section
336 // relocations. It's code sections that run into trouble.
340 // Add the local offset, if needed.
342 Value += Layout.getSymbolOffset(&SD) - Layout.getSymbolOffset(Base);
343 } else if (Symbol->isInSection()) {
344 if (!CanUseLocalRelocation)
345 Asm.getContext().FatalError(
347 "unsupported relocation of local symbol '" + Symbol->getName() +
348 "'. Must have non-local symbol earlier in section.");
349 // Adjust the relocation to be section-relative.
350 // The index is the section ordinal (1-based).
351 const MCSectionData &SymSD =
352 Asm.getSectionData(SD.getSymbol().getSection());
353 Index = SymSD.getOrdinal() + 1;
354 Value += Writer->getSymbolAddress(&SD, Layout);
357 Value -= Writer->getFragmentAddress(Fragment, Layout) +
358 Fixup.getOffset() + (1ULL << Log2Size);
360 // Resolve constant variables.
361 if (SD.getSymbol().isVariable()) {
363 if (SD.getSymbol().getVariableValue()->EvaluateAsAbsolute(
364 Res, Layout, Writer->getSectionAddressMap())) {
369 Asm.getContext().FatalError(Fixup.getLoc(),
370 "unsupported relocation of variable '" +
371 Symbol->getName() + "'");
375 // If the relocation kind is Branch26, Page21, or Pageoff12, any addend
376 // is represented via an Addend relocation, not encoded directly into
378 if ((Type == MachO::ARM64_RELOC_BRANCH26 ||
379 Type == MachO::ARM64_RELOC_PAGE21 ||
380 Type == MachO::ARM64_RELOC_PAGEOFF12) &&
382 assert((Value & 0xff000000) == 0 && "Added relocation out of range!");
384 MachO::any_relocation_info MRE;
385 MRE.r_word0 = FixupOffset;
387 (Index << 0) | (IsPCRel << 24) | (Log2Size << 25) | (Type << 28);
388 Writer->addRelocation(RelSymbol, Fragment->getParent(), MRE);
390 // Now set up the Addend relocation.
391 Type = MachO::ARM64_RELOC_ADDEND;
397 // Put zero into the instruction itself. The addend is in the relocation.
401 // If there's any addend left to handle, encode it in the instruction.
404 // struct relocation_info (8 bytes)
405 MachO::any_relocation_info MRE;
406 MRE.r_word0 = FixupOffset;
408 (Index << 0) | (IsPCRel << 24) | (Log2Size << 25) | (Type << 28);
409 Writer->addRelocation(RelSymbol, Fragment->getParent(), MRE);
412 MCObjectWriter *llvm::createAArch64MachObjectWriter(raw_ostream &OS,
414 uint32_t CPUSubtype) {
415 return createMachObjectWriter(
416 new AArch64MachObjectWriter(CPUType, CPUSubtype), OS,
417 /*IsLittleEndian=*/true);