blob: 883278b7bc1f11ee70d49b94ca97f3566f6999c1 [file] [log] [blame]
Daniel Dunbar7da045e2010-12-20 15:07:39 +00001//===-- X86MachObjectWriter.cpp - X86 Mach-O Writer -----------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
Chandler Carruthed0881b2012-12-03 16:50:05 +000010#include "MCTargetDesc/X86FixupKinds.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000011#include "MCTargetDesc/X86MCTargetDesc.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000012#include "llvm/ADT/Twine.h"
Zachary Turner264b5d92017-06-07 03:48:56 +000013#include "llvm/BinaryFormat/MachO.h"
Rafael Espindola26585542015-01-19 21:11:14 +000014#include "llvm/MC/MCAsmInfo.h"
Jim Grosbach28fcafb2011-06-24 23:44:37 +000015#include "llvm/MC/MCAsmLayout.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000016#include "llvm/MC/MCAssembler.h"
Jim Grosbachc03a0c22012-09-26 21:27:45 +000017#include "llvm/MC/MCContext.h"
Daniel Dunbar7da045e2010-12-20 15:07:39 +000018#include "llvm/MC/MCMachObjectWriter.h"
Jim Grosbach28fcafb2011-06-24 23:44:37 +000019#include "llvm/MC/MCSectionMachO.h"
20#include "llvm/MC/MCValue.h"
21#include "llvm/Support/ErrorHandling.h"
Jim Grosbachc03a0c22012-09-26 21:27:45 +000022#include "llvm/Support/Format.h"
Jim Grosbach28fcafb2011-06-24 23:44:37 +000023
Daniel Dunbar7da045e2010-12-20 15:07:39 +000024using namespace llvm;
25
26namespace {
27class X86MachObjectWriter : public MCMachObjectTargetWriter {
Jim Grosbach56ed0bb2015-06-04 23:25:54 +000028 bool recordScatteredRelocation(MachObjectWriter *Writer,
Jim Grosbach28fcafb2011-06-24 23:44:37 +000029 const MCAssembler &Asm,
30 const MCAsmLayout &Layout,
31 const MCFragment *Fragment,
32 const MCFixup &Fixup,
33 MCValue Target,
34 unsigned Log2Size,
35 uint64_t &FixedValue);
Jim Grosbach56ed0bb2015-06-04 23:25:54 +000036 void recordTLVPRelocation(MachObjectWriter *Writer,
Jim Grosbach28fcafb2011-06-24 23:44:37 +000037 const MCAssembler &Asm,
38 const MCAsmLayout &Layout,
39 const MCFragment *Fragment,
40 const MCFixup &Fixup,
41 MCValue Target,
42 uint64_t &FixedValue);
43
44 void RecordX86Relocation(MachObjectWriter *Writer,
45 const MCAssembler &Asm,
46 const MCAsmLayout &Layout,
47 const MCFragment *Fragment,
48 const MCFixup &Fixup,
49 MCValue Target,
50 uint64_t &FixedValue);
Rafael Espindola26585542015-01-19 21:11:14 +000051 void RecordX86_64Relocation(MachObjectWriter *Writer, MCAssembler &Asm,
Jim Grosbach28fcafb2011-06-24 23:44:37 +000052 const MCAsmLayout &Layout,
Rafael Espindola26585542015-01-19 21:11:14 +000053 const MCFragment *Fragment, const MCFixup &Fixup,
54 MCValue Target, uint64_t &FixedValue);
55
Daniel Dunbar7da045e2010-12-20 15:07:39 +000056public:
Jim Grosbach7c76b4c2015-06-04 20:27:42 +000057 X86MachObjectWriter(bool Is64Bit, uint32_t CPUType, uint32_t CPUSubtype)
58 : MCMachObjectTargetWriter(Is64Bit, CPUType, CPUSubtype) {}
Jim Grosbach28fcafb2011-06-24 23:44:37 +000059
Jim Grosbach36e60e92015-06-04 22:24:41 +000060 void recordRelocation(MachObjectWriter *Writer, MCAssembler &Asm,
Rafael Espindola26585542015-01-19 21:11:14 +000061 const MCAsmLayout &Layout, const MCFragment *Fragment,
62 const MCFixup &Fixup, MCValue Target,
63 uint64_t &FixedValue) override {
Jim Grosbach28fcafb2011-06-24 23:44:37 +000064 if (Writer->is64Bit())
65 RecordX86_64Relocation(Writer, Asm, Layout, Fragment, Fixup, Target,
66 FixedValue);
67 else
68 RecordX86Relocation(Writer, Asm, Layout, Fragment, Fixup, Target,
69 FixedValue);
70 }
Daniel Dunbar7da045e2010-12-20 15:07:39 +000071};
Alexander Kornienkof00654e2015-06-23 09:49:53 +000072}
Daniel Dunbar7da045e2010-12-20 15:07:39 +000073
Jim Grosbach28fcafb2011-06-24 23:44:37 +000074static bool isFixupKindRIPRel(unsigned Kind) {
75 return Kind == X86::reloc_riprel_4byte ||
Rafael Espindola52bd3302016-05-28 15:51:38 +000076 Kind == X86::reloc_riprel_4byte_movq_load ||
77 Kind == X86::reloc_riprel_4byte_relax ||
78 Kind == X86::reloc_riprel_4byte_relax_rex;
Jim Grosbach28fcafb2011-06-24 23:44:37 +000079}
80
81static unsigned getFixupKindLog2Size(unsigned Kind) {
82 switch (Kind) {
83 default:
84 llvm_unreachable("invalid fixup kind!");
85 case FK_PCRel_1:
86 case FK_Data_1: return 0;
87 case FK_PCRel_2:
88 case FK_Data_2: return 1;
89 case FK_PCRel_4:
90 // FIXME: Remove these!!!
91 case X86::reloc_riprel_4byte:
Rafael Espindola52bd3302016-05-28 15:51:38 +000092 case X86::reloc_riprel_4byte_relax:
93 case X86::reloc_riprel_4byte_relax_rex:
Jim Grosbach28fcafb2011-06-24 23:44:37 +000094 case X86::reloc_riprel_4byte_movq_load:
95 case X86::reloc_signed_4byte:
Rafael Espindolaa29971f2016-07-06 21:19:11 +000096 case X86::reloc_signed_4byte_relax:
George Rimarda4f43a42018-02-20 10:17:57 +000097 case X86::reloc_branch_4byte_pcrel:
Jim Grosbach28fcafb2011-06-24 23:44:37 +000098 case FK_Data_4: return 2;
99 case FK_Data_8: return 3;
100 }
101}
102
Rafael Espindola26585542015-01-19 21:11:14 +0000103void X86MachObjectWriter::RecordX86_64Relocation(
104 MachObjectWriter *Writer, MCAssembler &Asm, const MCAsmLayout &Layout,
105 const MCFragment *Fragment, const MCFixup &Fixup, MCValue Target,
106 uint64_t &FixedValue) {
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000107 unsigned IsPCRel = Writer->isFixupKindPCRel(Asm, Fixup.getKind());
108 unsigned IsRIPRel = isFixupKindRIPRel(Fixup.getKind());
109 unsigned Log2Size = getFixupKindLog2Size(Fixup.getKind());
110
111 // See <reloc.h>.
112 uint32_t FixupOffset =
113 Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
114 uint32_t FixupAddress =
115 Writer->getFragmentAddress(Fragment, Layout) + Fixup.getOffset();
116 int64_t Value = 0;
117 unsigned Index = 0;
118 unsigned IsExtern = 0;
119 unsigned Type = 0;
Duncan P. N. Exon Smith09bfa582015-05-16 00:48:58 +0000120 const MCSymbol *RelSymbol = nullptr;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000121
122 Value = Target.getConstant();
123
124 if (IsPCRel) {
125 // Compensate for the relocation offset, Darwin x86_64 relocations only have
126 // the addend and appear to have attempted to define it to be the actual
127 // expression addend without the PCrel bias. However, instructions with data
128 // following the relocation are not accommodated for (see comment below
129 // regarding SIGNED{1,2,4}), so it isn't exactly that either.
130 Value += 1LL << Log2Size;
131 }
132
133 if (Target.isAbsolute()) { // constant
134 // SymbolNum of 0 indicates the absolute section.
Charles Davis8bdfafd2013-09-01 04:28:48 +0000135 Type = MachO::X86_64_RELOC_UNSIGNED;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000136
137 // FIXME: I believe this is broken, I don't think the linker can understand
138 // it. I think it would require a local relocation, but I'm not sure if that
139 // would work either. The official way to get an absolute PCrel relocation
140 // is to use an absolute symbol (which we don't support yet).
141 if (IsPCRel) {
142 IsExtern = 1;
Charles Davis8bdfafd2013-09-01 04:28:48 +0000143 Type = MachO::X86_64_RELOC_BRANCH;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000144 }
145 } else if (Target.getSymB()) { // A - B + constant
146 const MCSymbol *A = &Target.getSymA()->getSymbol();
Kevin Enderby09cdb432013-09-05 20:25:06 +0000147 if (A->isTemporary())
Rafael Espindola7f4e07b2015-04-17 12:28:43 +0000148 A = &Writer->findAliasedSymbol(*A);
Duncan P. N. Exon Smithfd27a1d2015-05-20 16:02:11 +0000149 const MCSymbol *A_Base = Asm.getAtom(*A);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000150
151 const MCSymbol *B = &Target.getSymB()->getSymbol();
Kevin Enderby09cdb432013-09-05 20:25:06 +0000152 if (B->isTemporary())
Rafael Espindola7f4e07b2015-04-17 12:28:43 +0000153 B = &Writer->findAliasedSymbol(*B);
Duncan P. N. Exon Smithfd27a1d2015-05-20 16:02:11 +0000154 const MCSymbol *B_Base = Asm.getAtom(*B);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000155
156 // Neither symbol can be modified.
Rafael Espindola8a261c22017-06-22 17:25:35 +0000157 if (Target.getSymA()->getKind() != MCSymbolRefExpr::VK_None) {
Tim Northover614e8ff2015-12-08 18:31:35 +0000158 Asm.getContext().reportError(Fixup.getLoc(),
159 "unsupported relocation of modified symbol");
160 return;
161 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000162
163 // We don't support PCrel relocations of differences. Darwin 'as' doesn't
164 // implement most of these correctly.
Tim Northover614e8ff2015-12-08 18:31:35 +0000165 if (IsPCRel) {
166 Asm.getContext().reportError(
167 Fixup.getLoc(), "unsupported pc-relative relocation of difference");
168 return;
169 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000170
171 // The support for the situation where one or both of the symbols would
172 // require a local relocation is handled just like if the symbols were
173 // external. This is certainly used in the case of debug sections where the
174 // section has only temporary symbols and thus the symbols don't have base
175 // symbols. This is encoded using the section ordinal and non-extern
176 // relocation entries.
177
178 // Darwin 'as' doesn't emit correct relocations for this (it ends up with a
179 // single SIGNED relocation); reject it for now. Except the case where both
180 // symbols don't have a base, equal but both NULL.
Tim Northover614e8ff2015-12-08 18:31:35 +0000181 if (A_Base == B_Base && A_Base) {
182 Asm.getContext().reportError(
183 Fixup.getLoc(), "unsupported relocation with identical base");
184 return;
185 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000186
Kevin Enderby2813f492014-10-24 22:39:40 +0000187 // A subtraction expression where either symbol is undefined is a
Kevin Enderbyb03f3fe2013-08-12 22:45:44 +0000188 // non-relocatable expression.
Kevin Enderby2813f492014-10-24 22:39:40 +0000189 if (A->isUndefined() || B->isUndefined()) {
190 StringRef Name = A->isUndefined() ? A->getName() : B->getName();
Oliver Stannard9be59af2015-11-17 10:00:43 +0000191 Asm.getContext().reportError(Fixup.getLoc(),
Michael Liao5bf95782014-12-04 05:20:33 +0000192 "unsupported relocation with subtraction expression, symbol '" +
Kevin Enderby2813f492014-10-24 22:39:40 +0000193 Name + "' can not be undefined in a subtraction expression");
Oliver Stannard9be59af2015-11-17 10:00:43 +0000194 return;
Kevin Enderby2813f492014-10-24 22:39:40 +0000195 }
Kevin Enderbyb03f3fe2013-08-12 22:45:44 +0000196
Duncan P. N. Exon Smith99d8a8e2015-05-20 00:02:39 +0000197 Value += Writer->getSymbolAddress(*A, Layout) -
198 (!A_Base ? 0 : Writer->getSymbolAddress(*A_Base, Layout));
199 Value -= Writer->getSymbolAddress(*B, Layout) -
200 (!B_Base ? 0 : Writer->getSymbolAddress(*B_Base, Layout));
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000201
Rafael Espindola26585542015-01-19 21:11:14 +0000202 if (!A_Base)
Rafael Espindola4d37b2a2015-05-29 21:45:01 +0000203 Index = A->getFragment()->getParent()->getOrdinal() + 1;
Charles Davis8bdfafd2013-09-01 04:28:48 +0000204 Type = MachO::X86_64_RELOC_UNSIGNED;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000205
Charles Davis8bdfafd2013-09-01 04:28:48 +0000206 MachO::any_relocation_info MRE;
207 MRE.r_word0 = FixupOffset;
Rafael Espindola26585542015-01-19 21:11:14 +0000208 MRE.r_word1 =
209 (Index << 0) | (IsPCRel << 24) | (Log2Size << 25) | (Type << 28);
Rafael Espindola61e724a2015-05-26 01:15:30 +0000210 Writer->addRelocation(A_Base, Fragment->getParent(), MRE);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000211
Rafael Espindola26585542015-01-19 21:11:14 +0000212 if (B_Base)
213 RelSymbol = B_Base;
214 else
Rafael Espindola4d37b2a2015-05-29 21:45:01 +0000215 Index = B->getFragment()->getParent()->getOrdinal() + 1;
Charles Davis8bdfafd2013-09-01 04:28:48 +0000216 Type = MachO::X86_64_RELOC_SUBTRACTOR;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000217 } else {
218 const MCSymbol *Symbol = &Target.getSymA()->getSymbol();
Rafael Espindola26585542015-01-19 21:11:14 +0000219 if (Symbol->isTemporary() && Value) {
220 const MCSection &Sec = Symbol->getSection();
221 if (!Asm.getContext().getAsmInfo()->isSectionAtomizableBySymbols(Sec))
Rafael Espindoladfe2d352015-06-17 20:08:20 +0000222 Symbol->setUsedInReloc();
Rafael Espindola26585542015-01-19 21:11:14 +0000223 }
Duncan P. N. Exon Smithfd27a1d2015-05-20 16:02:11 +0000224 RelSymbol = Asm.getAtom(*Symbol);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000225
226 // Relocations inside debug sections always use local relocations when
227 // possible. This seems to be done because the debugger doesn't fully
228 // understand x86_64 relocation entries, and expects to find values that
229 // have already been fixed up.
230 if (Symbol->isInSection()) {
Rafael Espindola7549f872015-05-26 00:36:57 +0000231 const MCSectionMachO &Section =
232 static_cast<const MCSectionMachO &>(*Fragment->getParent());
David Majnemer7b583052014-03-07 07:36:05 +0000233 if (Section.hasAttribute(MachO::S_ATTR_DEBUG))
Rafael Espindola26585542015-01-19 21:11:14 +0000234 RelSymbol = nullptr;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000235 }
236
237 // x86_64 almost always uses external relocations, except when there is no
238 // symbol to use as a base address (a local symbol with no preceding
239 // non-local symbol).
Rafael Espindola26585542015-01-19 21:11:14 +0000240 if (RelSymbol) {
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000241 // Add the local offset, if needed.
Duncan P. N. Exon Smith2a404832015-05-19 23:53:20 +0000242 if (RelSymbol != Symbol)
243 Value += Layout.getSymbolOffset(*Symbol) -
244 Layout.getSymbolOffset(*RelSymbol);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000245 } else if (Symbol->isInSection() && !Symbol->isVariable()) {
246 // The index is the section ordinal (1-based).
Rafael Espindola4d37b2a2015-05-29 21:45:01 +0000247 Index = Symbol->getFragment()->getParent()->getOrdinal() + 1;
Duncan P. N. Exon Smith99d8a8e2015-05-20 00:02:39 +0000248 Value += Writer->getSymbolAddress(*Symbol, Layout);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000249
250 if (IsPCRel)
251 Value -= FixupAddress + (1 << Log2Size);
252 } else if (Symbol->isVariable()) {
253 const MCExpr *Value = Symbol->getVariableValue();
254 int64_t Res;
Jim Grosbach13760bd2015-05-30 01:25:56 +0000255 bool isAbs = Value->evaluateAsAbsolute(Res, Layout,
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000256 Writer->getSectionAddressMap());
257 if (isAbs) {
258 FixedValue = Res;
259 return;
260 } else {
Tim Northover614e8ff2015-12-08 18:31:35 +0000261 Asm.getContext().reportError(Fixup.getLoc(),
262 "unsupported relocation of variable '" +
263 Symbol->getName() + "'");
264 return;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000265 }
266 } else {
Tim Northover614e8ff2015-12-08 18:31:35 +0000267 Asm.getContext().reportError(
268 Fixup.getLoc(), "unsupported relocation of undefined symbol '" +
269 Symbol->getName() + "'");
270 return;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000271 }
272
273 MCSymbolRefExpr::VariantKind Modifier = Target.getSymA()->getKind();
274 if (IsPCRel) {
275 if (IsRIPRel) {
276 if (Modifier == MCSymbolRefExpr::VK_GOTPCREL) {
277 // x86_64 distinguishes movq foo@GOTPCREL so that the linker can
278 // rewrite the movq to an leaq at link time if the symbol ends up in
279 // the same linkage unit.
280 if (unsigned(Fixup.getKind()) == X86::reloc_riprel_4byte_movq_load)
Charles Davis8bdfafd2013-09-01 04:28:48 +0000281 Type = MachO::X86_64_RELOC_GOT_LOAD;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000282 else
Charles Davis8bdfafd2013-09-01 04:28:48 +0000283 Type = MachO::X86_64_RELOC_GOT;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000284 } else if (Modifier == MCSymbolRefExpr::VK_TLVP) {
Charles Davis8bdfafd2013-09-01 04:28:48 +0000285 Type = MachO::X86_64_RELOC_TLV;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000286 } else if (Modifier != MCSymbolRefExpr::VK_None) {
Tim Northover614e8ff2015-12-08 18:31:35 +0000287 Asm.getContext().reportError(
288 Fixup.getLoc(), "unsupported symbol modifier in relocation");
289 return;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000290 } else {
Charles Davis8bdfafd2013-09-01 04:28:48 +0000291 Type = MachO::X86_64_RELOC_SIGNED;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000292
293 // The Darwin x86_64 relocation format has a problem where it cannot
294 // encode an address (L<foo> + <constant>) which is outside the atom
295 // containing L<foo>. Generally, this shouldn't occur but it does
296 // happen when we have a RIPrel instruction with data following the
297 // relocation entry (e.g., movb $012, L0(%rip)). Even with the PCrel
298 // adjustment Darwin x86_64 uses, the offset is still negative and the
299 // linker has no way to recognize this.
300 //
301 // To work around this, Darwin uses several special relocation types
302 // to indicate the offsets. However, the specification or
303 // implementation of these seems to also be incomplete; they should
304 // adjust the addend as well based on the actual encoded instruction
305 // (the additional bias), but instead appear to just look at the final
306 // offset.
307 switch (-(Target.getConstant() + (1LL << Log2Size))) {
Charles Davis8bdfafd2013-09-01 04:28:48 +0000308 case 1: Type = MachO::X86_64_RELOC_SIGNED_1; break;
309 case 2: Type = MachO::X86_64_RELOC_SIGNED_2; break;
310 case 4: Type = MachO::X86_64_RELOC_SIGNED_4; break;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000311 }
312 }
313 } else {
Tim Northover614e8ff2015-12-08 18:31:35 +0000314 if (Modifier != MCSymbolRefExpr::VK_None) {
315 Asm.getContext().reportError(
316 Fixup.getLoc(),
317 "unsupported symbol modifier in branch relocation");
318 return;
319 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000320
Charles Davis8bdfafd2013-09-01 04:28:48 +0000321 Type = MachO::X86_64_RELOC_BRANCH;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000322 }
323 } else {
324 if (Modifier == MCSymbolRefExpr::VK_GOT) {
Charles Davis8bdfafd2013-09-01 04:28:48 +0000325 Type = MachO::X86_64_RELOC_GOT;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000326 } else if (Modifier == MCSymbolRefExpr::VK_GOTPCREL) {
327 // GOTPCREL is allowed as a modifier on non-PCrel instructions, in which
328 // case all we do is set the PCrel bit in the relocation entry; this is
329 // used with exception handling, for example. The source is required to
330 // include any necessary offset directly.
Charles Davis8bdfafd2013-09-01 04:28:48 +0000331 Type = MachO::X86_64_RELOC_GOT;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000332 IsPCRel = 1;
333 } else if (Modifier == MCSymbolRefExpr::VK_TLVP) {
Tim Northover614e8ff2015-12-08 18:31:35 +0000334 Asm.getContext().reportError(
335 Fixup.getLoc(), "TLVP symbol modifier should have been rip-rel");
336 return;
337 } else if (Modifier != MCSymbolRefExpr::VK_None) {
338 Asm.getContext().reportError(
339 Fixup.getLoc(), "unsupported symbol modifier in relocation");
340 return;
341 } else {
Charles Davis8bdfafd2013-09-01 04:28:48 +0000342 Type = MachO::X86_64_RELOC_UNSIGNED;
Kevin Enderby74946752013-08-29 00:19:03 +0000343 unsigned Kind = Fixup.getKind();
Tim Northover614e8ff2015-12-08 18:31:35 +0000344 if (Kind == X86::reloc_signed_4byte) {
345 Asm.getContext().reportError(
346 Fixup.getLoc(),
347 "32-bit absolute addressing is not supported in 64-bit mode");
348 return;
349 }
Kevin Enderby74946752013-08-29 00:19:03 +0000350 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000351 }
352 }
353
354 // x86_64 always writes custom values into the fixups.
355 FixedValue = Value;
356
357 // struct relocation_info (8 bytes)
Charles Davis8bdfafd2013-09-01 04:28:48 +0000358 MachO::any_relocation_info MRE;
359 MRE.r_word0 = FixupOffset;
Rafael Espindola26585542015-01-19 21:11:14 +0000360 MRE.r_word1 = (Index << 0) | (IsPCRel << 24) | (Log2Size << 25) |
361 (IsExtern << 27) | (Type << 28);
Rafael Espindola61e724a2015-05-26 01:15:30 +0000362 Writer->addRelocation(RelSymbol, Fragment->getParent(), MRE);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000363}
364
Jim Grosbach56ed0bb2015-06-04 23:25:54 +0000365bool X86MachObjectWriter::recordScatteredRelocation(MachObjectWriter *Writer,
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000366 const MCAssembler &Asm,
367 const MCAsmLayout &Layout,
368 const MCFragment *Fragment,
369 const MCFixup &Fixup,
370 MCValue Target,
371 unsigned Log2Size,
372 uint64_t &FixedValue) {
Kevin Enderby86496a42013-12-04 23:36:24 +0000373 uint64_t OriginalFixedValue = FixedValue;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000374 uint32_t FixupOffset = Layout.getFragmentOffset(Fragment)+Fixup.getOffset();
375 unsigned IsPCRel = Writer->isFixupKindPCRel(Asm, Fixup.getKind());
Charles Davis8bdfafd2013-09-01 04:28:48 +0000376 unsigned Type = MachO::GENERIC_RELOC_VANILLA;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000377
378 // See <reloc.h>.
379 const MCSymbol *A = &Target.getSymA()->getSymbol();
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000380
Tim Northover614e8ff2015-12-08 18:31:35 +0000381 if (!A->getFragment()) {
382 Asm.getContext().reportError(
383 Fixup.getLoc(),
384 "symbol '" + A->getName() +
385 "' can not be undefined in a subtraction expression");
386 return false;
387 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000388
Duncan P. N. Exon Smith99d8a8e2015-05-20 00:02:39 +0000389 uint32_t Value = Writer->getSymbolAddress(*A, Layout);
Rafael Espindola4d37b2a2015-05-29 21:45:01 +0000390 uint64_t SecAddr = Writer->getSectionAddress(A->getFragment()->getParent());
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000391 FixedValue += SecAddr;
392 uint32_t Value2 = 0;
393
394 if (const MCSymbolRefExpr *B = Target.getSymB()) {
Rafael Espindola4d37b2a2015-05-29 21:45:01 +0000395 const MCSymbol *SB = &B->getSymbol();
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000396
Tim Northover614e8ff2015-12-08 18:31:35 +0000397 if (!SB->getFragment()) {
398 Asm.getContext().reportError(
399 Fixup.getLoc(),
Rafael Espindolad926ea22017-06-28 19:26:37 +0000400 "symbol '" + SB->getName() +
Tim Northover614e8ff2015-12-08 18:31:35 +0000401 "' can not be undefined in a subtraction expression");
402 return false;
403 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000404
405 // Select the appropriate difference relocation type.
406 //
407 // Note that there is no longer any semantic difference between these two
408 // relocation types from the linkers point of view, this is done solely for
409 // pedantic compatibility with 'as'.
Rafael Espindola4d37b2a2015-05-29 21:45:01 +0000410 Type = A->isExternal() ? (unsigned)MachO::GENERIC_RELOC_SECTDIFF
411 : (unsigned)MachO::GENERIC_RELOC_LOCAL_SECTDIFF;
Rafael Espindolad926ea22017-06-28 19:26:37 +0000412 Value2 = Writer->getSymbolAddress(*SB, Layout);
Rafael Espindola4d37b2a2015-05-29 21:45:01 +0000413 FixedValue -= Writer->getSectionAddress(SB->getFragment()->getParent());
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000414 }
415
416 // Relocations are written out in reverse order, so the PAIR comes first.
Charles Davis8bdfafd2013-09-01 04:28:48 +0000417 if (Type == MachO::GENERIC_RELOC_SECTDIFF ||
418 Type == MachO::GENERIC_RELOC_LOCAL_SECTDIFF) {
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000419 // If the offset is too large to fit in a scattered relocation,
420 // we're hosed. It's an unfortunate limitation of the MachO format.
421 if (FixupOffset > 0xffffff) {
422 char Buffer[32];
423 format("0x%x", FixupOffset).print(Buffer, sizeof(Buffer));
Oliver Stannard9be59af2015-11-17 10:00:43 +0000424 Asm.getContext().reportError(Fixup.getLoc(),
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000425 Twine("Section too large, can't encode "
426 "r_address (") + Buffer +
427 ") into 24 bits of scattered "
428 "relocation entry.");
Oliver Stannard9be59af2015-11-17 10:00:43 +0000429 return false;
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000430 }
431
Charles Davis8bdfafd2013-09-01 04:28:48 +0000432 MachO::any_relocation_info MRE;
433 MRE.r_word0 = ((0 << 0) | // r_address
434 (MachO::GENERIC_RELOC_PAIR << 24) | // r_type
435 (Log2Size << 28) |
436 (IsPCRel << 30) |
437 MachO::R_SCATTERED);
438 MRE.r_word1 = Value2;
Rafael Espindola61e724a2015-05-26 01:15:30 +0000439 Writer->addRelocation(nullptr, Fragment->getParent(), MRE);
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000440 } else {
441 // If the offset is more than 24-bits, it won't fit in a scattered
442 // relocation offset field, so we fall back to using a non-scattered
443 // relocation. This is a bit risky, as if the offset reaches out of
444 // the block and the linker is doing scattered loading on this
445 // symbol, things can go badly.
446 //
447 // Required for 'as' compatibility.
Kevin Enderby86496a42013-12-04 23:36:24 +0000448 if (FixupOffset > 0xffffff) {
449 FixedValue = OriginalFixedValue;
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000450 return false;
Kevin Enderby86496a42013-12-04 23:36:24 +0000451 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000452 }
453
Charles Davis8bdfafd2013-09-01 04:28:48 +0000454 MachO::any_relocation_info MRE;
455 MRE.r_word0 = ((FixupOffset << 0) |
456 (Type << 24) |
457 (Log2Size << 28) |
458 (IsPCRel << 30) |
459 MachO::R_SCATTERED);
460 MRE.r_word1 = Value;
Rafael Espindola61e724a2015-05-26 01:15:30 +0000461 Writer->addRelocation(nullptr, Fragment->getParent(), MRE);
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000462 return true;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000463}
464
Jim Grosbach56ed0bb2015-06-04 23:25:54 +0000465void X86MachObjectWriter::recordTLVPRelocation(MachObjectWriter *Writer,
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000466 const MCAssembler &Asm,
467 const MCAsmLayout &Layout,
468 const MCFragment *Fragment,
469 const MCFixup &Fixup,
470 MCValue Target,
471 uint64_t &FixedValue) {
Rafael Espindolad926ea22017-06-28 19:26:37 +0000472 const MCSymbolRefExpr *SymA = Target.getSymA();
473 assert(SymA->getKind() == MCSymbolRefExpr::VK_TLVP && !is64Bit() &&
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000474 "Should only be called with a 32-bit TLVP relocation!");
475
476 unsigned Log2Size = getFixupKindLog2Size(Fixup.getKind());
477 uint32_t Value = Layout.getFragmentOffset(Fragment)+Fixup.getOffset();
478 unsigned IsPCRel = 0;
479
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000480 // We're only going to have a second symbol in pic mode and it'll be a
481 // subtraction from the picbase. For 32-bit pic the addend is the difference
482 // between the picbase and the next address. For 32-bit static the addend is
483 // zero.
Rafael Espindolad926ea22017-06-28 19:26:37 +0000484 if (auto *SymB = Target.getSymB()) {
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000485 // If this is a subtraction then we're pcrel.
486 uint32_t FixupAddress =
487 Writer->getFragmentAddress(Fragment, Layout) + Fixup.getOffset();
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000488 IsPCRel = 1;
Rafael Espindolad926ea22017-06-28 19:26:37 +0000489 FixedValue = FixupAddress -
490 Writer->getSymbolAddress(SymB->getSymbol(), Layout) +
491 Target.getConstant();
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000492 FixedValue += 1ULL << Log2Size;
493 } else {
494 FixedValue = 0;
495 }
496
497 // struct relocation_info (8 bytes)
Charles Davis8bdfafd2013-09-01 04:28:48 +0000498 MachO::any_relocation_info MRE;
499 MRE.r_word0 = Value;
Rafael Espindola26585542015-01-19 21:11:14 +0000500 MRE.r_word1 =
501 (IsPCRel << 24) | (Log2Size << 25) | (MachO::GENERIC_RELOC_TLV << 28);
Rafael Espindolad926ea22017-06-28 19:26:37 +0000502 Writer->addRelocation(&SymA->getSymbol(), Fragment->getParent(), MRE);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000503}
504
505void X86MachObjectWriter::RecordX86Relocation(MachObjectWriter *Writer,
506 const MCAssembler &Asm,
507 const MCAsmLayout &Layout,
508 const MCFragment *Fragment,
509 const MCFixup &Fixup,
510 MCValue Target,
511 uint64_t &FixedValue) {
512 unsigned IsPCRel = Writer->isFixupKindPCRel(Asm, Fixup.getKind());
513 unsigned Log2Size = getFixupKindLog2Size(Fixup.getKind());
514
515 // If this is a 32-bit TLVP reloc it's handled a bit differently.
516 if (Target.getSymA() &&
517 Target.getSymA()->getKind() == MCSymbolRefExpr::VK_TLVP) {
Jim Grosbach56ed0bb2015-06-04 23:25:54 +0000518 recordTLVPRelocation(Writer, Asm, Layout, Fragment, Fixup, Target,
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000519 FixedValue);
520 return;
521 }
522
523 // If this is a difference or a defined symbol plus an offset, then we need a
524 // scattered relocation entry. Differences always require scattered
525 // relocations.
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000526 if (Target.getSymB()) {
Jim Grosbach56ed0bb2015-06-04 23:25:54 +0000527 recordScatteredRelocation(Writer, Asm, Layout, Fragment, Fixup,
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000528 Target, Log2Size, FixedValue);
529 return;
530 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000531
532 // Get the symbol data, if any.
Duncan P. N. Exon Smith08b87262015-05-20 15:16:14 +0000533 const MCSymbol *A = nullptr;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000534 if (Target.getSymA())
Duncan P. N. Exon Smith08b87262015-05-20 15:16:14 +0000535 A = &Target.getSymA()->getSymbol();
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000536
537 // If this is an internal relocation with an offset, it also needs a scattered
538 // relocation entry.
539 uint32_t Offset = Target.getConstant();
540 if (IsPCRel)
541 Offset += 1 << Log2Size;
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000542 // Try to record the scattered relocation if needed. Fall back to non
Jim Grosbach56ed0bb2015-06-04 23:25:54 +0000543 // scattered if necessary (see comments in recordScatteredRelocation()
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000544 // for details).
Duncan P. N. Exon Smith08b87262015-05-20 15:16:14 +0000545 if (Offset && A && !Writer->doesSymbolRequireExternRelocation(*A) &&
Jim Grosbach56ed0bb2015-06-04 23:25:54 +0000546 recordScatteredRelocation(Writer, Asm, Layout, Fragment, Fixup, Target,
Duncan P. N. Exon Smith08b87262015-05-20 15:16:14 +0000547 Log2Size, FixedValue))
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000548 return;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000549
550 // See <reloc.h>.
551 uint32_t FixupOffset = Layout.getFragmentOffset(Fragment)+Fixup.getOffset();
552 unsigned Index = 0;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000553 unsigned Type = 0;
Duncan P. N. Exon Smith6e23e5a2015-05-16 01:14:19 +0000554 const MCSymbol *RelSymbol = nullptr;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000555
556 if (Target.isAbsolute()) { // constant
557 // SymbolNum of 0 indicates the absolute section.
558 //
559 // FIXME: Currently, these are never generated (see code below). I cannot
560 // find a case where they are actually emitted.
Charles Davis8bdfafd2013-09-01 04:28:48 +0000561 Type = MachO::GENERIC_RELOC_VANILLA;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000562 } else {
563 // Resolve constant variables.
Duncan P. N. Exon Smith08b87262015-05-20 15:16:14 +0000564 if (A->isVariable()) {
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000565 int64_t Res;
Jim Grosbach13760bd2015-05-30 01:25:56 +0000566 if (A->getVariableValue()->evaluateAsAbsolute(
Duncan P. N. Exon Smith08b87262015-05-20 15:16:14 +0000567 Res, Layout, Writer->getSectionAddressMap())) {
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000568 FixedValue = Res;
569 return;
570 }
571 }
572
573 // Check whether we need an external or internal relocation.
Duncan P. N. Exon Smith08b87262015-05-20 15:16:14 +0000574 if (Writer->doesSymbolRequireExternRelocation(*A)) {
575 RelSymbol = A;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000576 // For external relocations, make sure to offset the fixup value to
577 // compensate for the addend of the symbol address, if it was
578 // undefined. This occurs with weak definitions, for example.
Duncan P. N. Exon Smith08b87262015-05-20 15:16:14 +0000579 if (!A->isUndefined())
580 FixedValue -= Layout.getSymbolOffset(*A);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000581 } else {
582 // The index is the section ordinal (1-based).
Rafael Espindola6e6820a2015-05-25 14:12:48 +0000583 const MCSection &Sec = A->getSection();
Rafael Espindola6e6820a2015-05-25 14:12:48 +0000584 Index = Sec.getOrdinal() + 1;
Rafael Espindola079027e2015-05-26 00:52:18 +0000585 FixedValue += Writer->getSectionAddress(&Sec);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000586 }
587 if (IsPCRel)
Rafael Espindola079027e2015-05-26 00:52:18 +0000588 FixedValue -= Writer->getSectionAddress(Fragment->getParent());
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000589
Charles Davis8bdfafd2013-09-01 04:28:48 +0000590 Type = MachO::GENERIC_RELOC_VANILLA;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000591 }
592
593 // struct relocation_info (8 bytes)
Charles Davis8bdfafd2013-09-01 04:28:48 +0000594 MachO::any_relocation_info MRE;
595 MRE.r_word0 = FixupOffset;
Rafael Espindola26585542015-01-19 21:11:14 +0000596 MRE.r_word1 =
597 (Index << 0) | (IsPCRel << 24) | (Log2Size << 25) | (Type << 28);
Rafael Espindola61e724a2015-05-26 01:15:30 +0000598 Writer->addRelocation(RelSymbol, Fragment->getParent(), MRE);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000599}
600
Peter Collingbournedcd7d6c2018-05-21 19:20:29 +0000601std::unique_ptr<MCObjectTargetWriter>
602llvm::createX86MachObjectWriter(bool Is64Bit, uint32_t CPUType,
603 uint32_t CPUSubtype) {
604 return llvm::make_unique<X86MachObjectWriter>(Is64Bit, CPUType, CPUSubtype);
Daniel Dunbar7da045e2010-12-20 15:07:39 +0000605}