blob: 191ebeac7265ea27c59c13c092dc7f6dfea974c6 [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
Evan Chengb2531002011-07-25 19:33:48 +000010#include "MCTargetDesc/X86MCTargetDesc.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000011#include "MCTargetDesc/X86FixupKinds.h"
12#include "llvm/ADT/Twine.h"
Rafael Espindola26585542015-01-19 21:11:14 +000013#include "llvm/MC/MCAsmInfo.h"
Jim Grosbach28fcafb2011-06-24 23:44:37 +000014#include "llvm/MC/MCAsmLayout.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000015#include "llvm/MC/MCAssembler.h"
Jim Grosbachc03a0c22012-09-26 21:27:45 +000016#include "llvm/MC/MCContext.h"
Daniel Dunbar7da045e2010-12-20 15:07:39 +000017#include "llvm/MC/MCMachObjectWriter.h"
Jim Grosbach28fcafb2011-06-24 23:44:37 +000018#include "llvm/MC/MCSectionMachO.h"
19#include "llvm/MC/MCValue.h"
20#include "llvm/Support/ErrorHandling.h"
Jim Grosbachc03a0c22012-09-26 21:27:45 +000021#include "llvm/Support/Format.h"
Charles Davis8bdfafd2013-09-01 04:28:48 +000022#include "llvm/Support/MachO.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 ||
76 Kind == X86::reloc_riprel_4byte_movq_load;
77}
78
79static unsigned getFixupKindLog2Size(unsigned Kind) {
80 switch (Kind) {
81 default:
82 llvm_unreachable("invalid fixup kind!");
83 case FK_PCRel_1:
84 case FK_Data_1: return 0;
85 case FK_PCRel_2:
86 case FK_Data_2: return 1;
87 case FK_PCRel_4:
88 // FIXME: Remove these!!!
89 case X86::reloc_riprel_4byte:
90 case X86::reloc_riprel_4byte_movq_load:
91 case X86::reloc_signed_4byte:
92 case FK_Data_4: return 2;
93 case FK_Data_8: return 3;
94 }
95}
96
Rafael Espindola26585542015-01-19 21:11:14 +000097void X86MachObjectWriter::RecordX86_64Relocation(
98 MachObjectWriter *Writer, MCAssembler &Asm, const MCAsmLayout &Layout,
99 const MCFragment *Fragment, const MCFixup &Fixup, MCValue Target,
100 uint64_t &FixedValue) {
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000101 unsigned IsPCRel = Writer->isFixupKindPCRel(Asm, Fixup.getKind());
102 unsigned IsRIPRel = isFixupKindRIPRel(Fixup.getKind());
103 unsigned Log2Size = getFixupKindLog2Size(Fixup.getKind());
104
105 // See <reloc.h>.
106 uint32_t FixupOffset =
107 Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
108 uint32_t FixupAddress =
109 Writer->getFragmentAddress(Fragment, Layout) + Fixup.getOffset();
110 int64_t Value = 0;
111 unsigned Index = 0;
112 unsigned IsExtern = 0;
113 unsigned Type = 0;
Duncan P. N. Exon Smith09bfa582015-05-16 00:48:58 +0000114 const MCSymbol *RelSymbol = nullptr;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000115
116 Value = Target.getConstant();
117
118 if (IsPCRel) {
119 // Compensate for the relocation offset, Darwin x86_64 relocations only have
120 // the addend and appear to have attempted to define it to be the actual
121 // expression addend without the PCrel bias. However, instructions with data
122 // following the relocation are not accommodated for (see comment below
123 // regarding SIGNED{1,2,4}), so it isn't exactly that either.
124 Value += 1LL << Log2Size;
125 }
126
127 if (Target.isAbsolute()) { // constant
128 // SymbolNum of 0 indicates the absolute section.
Charles Davis8bdfafd2013-09-01 04:28:48 +0000129 Type = MachO::X86_64_RELOC_UNSIGNED;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000130
131 // FIXME: I believe this is broken, I don't think the linker can understand
132 // it. I think it would require a local relocation, but I'm not sure if that
133 // would work either. The official way to get an absolute PCrel relocation
134 // is to use an absolute symbol (which we don't support yet).
135 if (IsPCRel) {
136 IsExtern = 1;
Charles Davis8bdfafd2013-09-01 04:28:48 +0000137 Type = MachO::X86_64_RELOC_BRANCH;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000138 }
139 } else if (Target.getSymB()) { // A - B + constant
140 const MCSymbol *A = &Target.getSymA()->getSymbol();
Kevin Enderby09cdb432013-09-05 20:25:06 +0000141 if (A->isTemporary())
Rafael Espindola7f4e07b2015-04-17 12:28:43 +0000142 A = &Writer->findAliasedSymbol(*A);
Duncan P. N. Exon Smithfd27a1d2015-05-20 16:02:11 +0000143 const MCSymbol *A_Base = Asm.getAtom(*A);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000144
145 const MCSymbol *B = &Target.getSymB()->getSymbol();
Kevin Enderby09cdb432013-09-05 20:25:06 +0000146 if (B->isTemporary())
Rafael Espindola7f4e07b2015-04-17 12:28:43 +0000147 B = &Writer->findAliasedSymbol(*B);
Duncan P. N. Exon Smithfd27a1d2015-05-20 16:02:11 +0000148 const MCSymbol *B_Base = Asm.getAtom(*B);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000149
150 // Neither symbol can be modified.
151 if (Target.getSymA()->getKind() != MCSymbolRefExpr::VK_None ||
Tim Northover614e8ff2015-12-08 18:31:35 +0000152 Target.getSymB()->getKind() != MCSymbolRefExpr::VK_None) {
153 Asm.getContext().reportError(Fixup.getLoc(),
154 "unsupported relocation of modified symbol");
155 return;
156 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000157
158 // We don't support PCrel relocations of differences. Darwin 'as' doesn't
159 // implement most of these correctly.
Tim Northover614e8ff2015-12-08 18:31:35 +0000160 if (IsPCRel) {
161 Asm.getContext().reportError(
162 Fixup.getLoc(), "unsupported pc-relative relocation of difference");
163 return;
164 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000165
166 // The support for the situation where one or both of the symbols would
167 // require a local relocation is handled just like if the symbols were
168 // external. This is certainly used in the case of debug sections where the
169 // section has only temporary symbols and thus the symbols don't have base
170 // symbols. This is encoded using the section ordinal and non-extern
171 // relocation entries.
172
173 // Darwin 'as' doesn't emit correct relocations for this (it ends up with a
174 // single SIGNED relocation); reject it for now. Except the case where both
175 // symbols don't have a base, equal but both NULL.
Tim Northover614e8ff2015-12-08 18:31:35 +0000176 if (A_Base == B_Base && A_Base) {
177 Asm.getContext().reportError(
178 Fixup.getLoc(), "unsupported relocation with identical base");
179 return;
180 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000181
Kevin Enderby2813f492014-10-24 22:39:40 +0000182 // A subtraction expression where either symbol is undefined is a
Kevin Enderbyb03f3fe2013-08-12 22:45:44 +0000183 // non-relocatable expression.
Kevin Enderby2813f492014-10-24 22:39:40 +0000184 if (A->isUndefined() || B->isUndefined()) {
185 StringRef Name = A->isUndefined() ? A->getName() : B->getName();
Oliver Stannard9be59af2015-11-17 10:00:43 +0000186 Asm.getContext().reportError(Fixup.getLoc(),
Michael Liao5bf95782014-12-04 05:20:33 +0000187 "unsupported relocation with subtraction expression, symbol '" +
Kevin Enderby2813f492014-10-24 22:39:40 +0000188 Name + "' can not be undefined in a subtraction expression");
Oliver Stannard9be59af2015-11-17 10:00:43 +0000189 return;
Kevin Enderby2813f492014-10-24 22:39:40 +0000190 }
Kevin Enderbyb03f3fe2013-08-12 22:45:44 +0000191
Duncan P. N. Exon Smith99d8a8e2015-05-20 00:02:39 +0000192 Value += Writer->getSymbolAddress(*A, Layout) -
193 (!A_Base ? 0 : Writer->getSymbolAddress(*A_Base, Layout));
194 Value -= Writer->getSymbolAddress(*B, Layout) -
195 (!B_Base ? 0 : Writer->getSymbolAddress(*B_Base, Layout));
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000196
Rafael Espindola26585542015-01-19 21:11:14 +0000197 if (!A_Base)
Rafael Espindola4d37b2a2015-05-29 21:45:01 +0000198 Index = A->getFragment()->getParent()->getOrdinal() + 1;
Charles Davis8bdfafd2013-09-01 04:28:48 +0000199 Type = MachO::X86_64_RELOC_UNSIGNED;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000200
Charles Davis8bdfafd2013-09-01 04:28:48 +0000201 MachO::any_relocation_info MRE;
202 MRE.r_word0 = FixupOffset;
Rafael Espindola26585542015-01-19 21:11:14 +0000203 MRE.r_word1 =
204 (Index << 0) | (IsPCRel << 24) | (Log2Size << 25) | (Type << 28);
Rafael Espindola61e724a2015-05-26 01:15:30 +0000205 Writer->addRelocation(A_Base, Fragment->getParent(), MRE);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000206
Rafael Espindola26585542015-01-19 21:11:14 +0000207 if (B_Base)
208 RelSymbol = B_Base;
209 else
Rafael Espindola4d37b2a2015-05-29 21:45:01 +0000210 Index = B->getFragment()->getParent()->getOrdinal() + 1;
Charles Davis8bdfafd2013-09-01 04:28:48 +0000211 Type = MachO::X86_64_RELOC_SUBTRACTOR;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000212 } else {
213 const MCSymbol *Symbol = &Target.getSymA()->getSymbol();
Rafael Espindola26585542015-01-19 21:11:14 +0000214 if (Symbol->isTemporary() && Value) {
215 const MCSection &Sec = Symbol->getSection();
216 if (!Asm.getContext().getAsmInfo()->isSectionAtomizableBySymbols(Sec))
Rafael Espindoladfe2d352015-06-17 20:08:20 +0000217 Symbol->setUsedInReloc();
Rafael Espindola26585542015-01-19 21:11:14 +0000218 }
Duncan P. N. Exon Smithfd27a1d2015-05-20 16:02:11 +0000219 RelSymbol = Asm.getAtom(*Symbol);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000220
221 // Relocations inside debug sections always use local relocations when
222 // possible. This seems to be done because the debugger doesn't fully
223 // understand x86_64 relocation entries, and expects to find values that
224 // have already been fixed up.
225 if (Symbol->isInSection()) {
Rafael Espindola7549f872015-05-26 00:36:57 +0000226 const MCSectionMachO &Section =
227 static_cast<const MCSectionMachO &>(*Fragment->getParent());
David Majnemer7b583052014-03-07 07:36:05 +0000228 if (Section.hasAttribute(MachO::S_ATTR_DEBUG))
Rafael Espindola26585542015-01-19 21:11:14 +0000229 RelSymbol = nullptr;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000230 }
231
232 // x86_64 almost always uses external relocations, except when there is no
233 // symbol to use as a base address (a local symbol with no preceding
234 // non-local symbol).
Rafael Espindola26585542015-01-19 21:11:14 +0000235 if (RelSymbol) {
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000236 // Add the local offset, if needed.
Duncan P. N. Exon Smith2a404832015-05-19 23:53:20 +0000237 if (RelSymbol != Symbol)
238 Value += Layout.getSymbolOffset(*Symbol) -
239 Layout.getSymbolOffset(*RelSymbol);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000240 } else if (Symbol->isInSection() && !Symbol->isVariable()) {
241 // The index is the section ordinal (1-based).
Rafael Espindola4d37b2a2015-05-29 21:45:01 +0000242 Index = Symbol->getFragment()->getParent()->getOrdinal() + 1;
Duncan P. N. Exon Smith99d8a8e2015-05-20 00:02:39 +0000243 Value += Writer->getSymbolAddress(*Symbol, Layout);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000244
245 if (IsPCRel)
246 Value -= FixupAddress + (1 << Log2Size);
247 } else if (Symbol->isVariable()) {
248 const MCExpr *Value = Symbol->getVariableValue();
249 int64_t Res;
Jim Grosbach13760bd2015-05-30 01:25:56 +0000250 bool isAbs = Value->evaluateAsAbsolute(Res, Layout,
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000251 Writer->getSectionAddressMap());
252 if (isAbs) {
253 FixedValue = Res;
254 return;
255 } else {
Tim Northover614e8ff2015-12-08 18:31:35 +0000256 Asm.getContext().reportError(Fixup.getLoc(),
257 "unsupported relocation of variable '" +
258 Symbol->getName() + "'");
259 return;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000260 }
261 } else {
Tim Northover614e8ff2015-12-08 18:31:35 +0000262 Asm.getContext().reportError(
263 Fixup.getLoc(), "unsupported relocation of undefined symbol '" +
264 Symbol->getName() + "'");
265 return;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000266 }
267
268 MCSymbolRefExpr::VariantKind Modifier = Target.getSymA()->getKind();
269 if (IsPCRel) {
270 if (IsRIPRel) {
271 if (Modifier == MCSymbolRefExpr::VK_GOTPCREL) {
272 // x86_64 distinguishes movq foo@GOTPCREL so that the linker can
273 // rewrite the movq to an leaq at link time if the symbol ends up in
274 // the same linkage unit.
275 if (unsigned(Fixup.getKind()) == X86::reloc_riprel_4byte_movq_load)
Charles Davis8bdfafd2013-09-01 04:28:48 +0000276 Type = MachO::X86_64_RELOC_GOT_LOAD;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000277 else
Charles Davis8bdfafd2013-09-01 04:28:48 +0000278 Type = MachO::X86_64_RELOC_GOT;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000279 } else if (Modifier == MCSymbolRefExpr::VK_TLVP) {
Charles Davis8bdfafd2013-09-01 04:28:48 +0000280 Type = MachO::X86_64_RELOC_TLV;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000281 } else if (Modifier != MCSymbolRefExpr::VK_None) {
Tim Northover614e8ff2015-12-08 18:31:35 +0000282 Asm.getContext().reportError(
283 Fixup.getLoc(), "unsupported symbol modifier in relocation");
284 return;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000285 } else {
Charles Davis8bdfafd2013-09-01 04:28:48 +0000286 Type = MachO::X86_64_RELOC_SIGNED;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000287
288 // The Darwin x86_64 relocation format has a problem where it cannot
289 // encode an address (L<foo> + <constant>) which is outside the atom
290 // containing L<foo>. Generally, this shouldn't occur but it does
291 // happen when we have a RIPrel instruction with data following the
292 // relocation entry (e.g., movb $012, L0(%rip)). Even with the PCrel
293 // adjustment Darwin x86_64 uses, the offset is still negative and the
294 // linker has no way to recognize this.
295 //
296 // To work around this, Darwin uses several special relocation types
297 // to indicate the offsets. However, the specification or
298 // implementation of these seems to also be incomplete; they should
299 // adjust the addend as well based on the actual encoded instruction
300 // (the additional bias), but instead appear to just look at the final
301 // offset.
302 switch (-(Target.getConstant() + (1LL << Log2Size))) {
Charles Davis8bdfafd2013-09-01 04:28:48 +0000303 case 1: Type = MachO::X86_64_RELOC_SIGNED_1; break;
304 case 2: Type = MachO::X86_64_RELOC_SIGNED_2; break;
305 case 4: Type = MachO::X86_64_RELOC_SIGNED_4; break;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000306 }
307 }
308 } else {
Tim Northover614e8ff2015-12-08 18:31:35 +0000309 if (Modifier != MCSymbolRefExpr::VK_None) {
310 Asm.getContext().reportError(
311 Fixup.getLoc(),
312 "unsupported symbol modifier in branch relocation");
313 return;
314 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000315
Charles Davis8bdfafd2013-09-01 04:28:48 +0000316 Type = MachO::X86_64_RELOC_BRANCH;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000317 }
318 } else {
319 if (Modifier == MCSymbolRefExpr::VK_GOT) {
Charles Davis8bdfafd2013-09-01 04:28:48 +0000320 Type = MachO::X86_64_RELOC_GOT;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000321 } else if (Modifier == MCSymbolRefExpr::VK_GOTPCREL) {
322 // GOTPCREL is allowed as a modifier on non-PCrel instructions, in which
323 // case all we do is set the PCrel bit in the relocation entry; this is
324 // used with exception handling, for example. The source is required to
325 // include any necessary offset directly.
Charles Davis8bdfafd2013-09-01 04:28:48 +0000326 Type = MachO::X86_64_RELOC_GOT;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000327 IsPCRel = 1;
328 } else if (Modifier == MCSymbolRefExpr::VK_TLVP) {
Tim Northover614e8ff2015-12-08 18:31:35 +0000329 Asm.getContext().reportError(
330 Fixup.getLoc(), "TLVP symbol modifier should have been rip-rel");
331 return;
332 } else if (Modifier != MCSymbolRefExpr::VK_None) {
333 Asm.getContext().reportError(
334 Fixup.getLoc(), "unsupported symbol modifier in relocation");
335 return;
336 } else {
Charles Davis8bdfafd2013-09-01 04:28:48 +0000337 Type = MachO::X86_64_RELOC_UNSIGNED;
Kevin Enderby74946752013-08-29 00:19:03 +0000338 unsigned Kind = Fixup.getKind();
Tim Northover614e8ff2015-12-08 18:31:35 +0000339 if (Kind == X86::reloc_signed_4byte) {
340 Asm.getContext().reportError(
341 Fixup.getLoc(),
342 "32-bit absolute addressing is not supported in 64-bit mode");
343 return;
344 }
Kevin Enderby74946752013-08-29 00:19:03 +0000345 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000346 }
347 }
348
349 // x86_64 always writes custom values into the fixups.
350 FixedValue = Value;
351
352 // struct relocation_info (8 bytes)
Charles Davis8bdfafd2013-09-01 04:28:48 +0000353 MachO::any_relocation_info MRE;
354 MRE.r_word0 = FixupOffset;
Rafael Espindola26585542015-01-19 21:11:14 +0000355 MRE.r_word1 = (Index << 0) | (IsPCRel << 24) | (Log2Size << 25) |
356 (IsExtern << 27) | (Type << 28);
Rafael Espindola61e724a2015-05-26 01:15:30 +0000357 Writer->addRelocation(RelSymbol, Fragment->getParent(), MRE);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000358}
359
Jim Grosbach56ed0bb2015-06-04 23:25:54 +0000360bool X86MachObjectWriter::recordScatteredRelocation(MachObjectWriter *Writer,
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000361 const MCAssembler &Asm,
362 const MCAsmLayout &Layout,
363 const MCFragment *Fragment,
364 const MCFixup &Fixup,
365 MCValue Target,
366 unsigned Log2Size,
367 uint64_t &FixedValue) {
Kevin Enderby86496a42013-12-04 23:36:24 +0000368 uint64_t OriginalFixedValue = FixedValue;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000369 uint32_t FixupOffset = Layout.getFragmentOffset(Fragment)+Fixup.getOffset();
370 unsigned IsPCRel = Writer->isFixupKindPCRel(Asm, Fixup.getKind());
Charles Davis8bdfafd2013-09-01 04:28:48 +0000371 unsigned Type = MachO::GENERIC_RELOC_VANILLA;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000372
373 // See <reloc.h>.
374 const MCSymbol *A = &Target.getSymA()->getSymbol();
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000375
Tim Northover614e8ff2015-12-08 18:31:35 +0000376 if (!A->getFragment()) {
377 Asm.getContext().reportError(
378 Fixup.getLoc(),
379 "symbol '" + A->getName() +
380 "' can not be undefined in a subtraction expression");
381 return false;
382 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000383
Duncan P. N. Exon Smith99d8a8e2015-05-20 00:02:39 +0000384 uint32_t Value = Writer->getSymbolAddress(*A, Layout);
Rafael Espindola4d37b2a2015-05-29 21:45:01 +0000385 uint64_t SecAddr = Writer->getSectionAddress(A->getFragment()->getParent());
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000386 FixedValue += SecAddr;
387 uint32_t Value2 = 0;
388
389 if (const MCSymbolRefExpr *B = Target.getSymB()) {
Rafael Espindola4d37b2a2015-05-29 21:45:01 +0000390 const MCSymbol *SB = &B->getSymbol();
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000391
Tim Northover614e8ff2015-12-08 18:31:35 +0000392 if (!SB->getFragment()) {
393 Asm.getContext().reportError(
394 Fixup.getLoc(),
395 "symbol '" + B->getSymbol().getName() +
396 "' can not be undefined in a subtraction expression");
397 return false;
398 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000399
400 // Select the appropriate difference relocation type.
401 //
402 // Note that there is no longer any semantic difference between these two
403 // relocation types from the linkers point of view, this is done solely for
404 // pedantic compatibility with 'as'.
Rafael Espindola4d37b2a2015-05-29 21:45:01 +0000405 Type = A->isExternal() ? (unsigned)MachO::GENERIC_RELOC_SECTDIFF
406 : (unsigned)MachO::GENERIC_RELOC_LOCAL_SECTDIFF;
Duncan P. N. Exon Smith99d8a8e2015-05-20 00:02:39 +0000407 Value2 = Writer->getSymbolAddress(B->getSymbol(), Layout);
Rafael Espindola4d37b2a2015-05-29 21:45:01 +0000408 FixedValue -= Writer->getSectionAddress(SB->getFragment()->getParent());
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000409 }
410
411 // Relocations are written out in reverse order, so the PAIR comes first.
Charles Davis8bdfafd2013-09-01 04:28:48 +0000412 if (Type == MachO::GENERIC_RELOC_SECTDIFF ||
413 Type == MachO::GENERIC_RELOC_LOCAL_SECTDIFF) {
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000414 // If the offset is too large to fit in a scattered relocation,
415 // we're hosed. It's an unfortunate limitation of the MachO format.
416 if (FixupOffset > 0xffffff) {
417 char Buffer[32];
418 format("0x%x", FixupOffset).print(Buffer, sizeof(Buffer));
Oliver Stannard9be59af2015-11-17 10:00:43 +0000419 Asm.getContext().reportError(Fixup.getLoc(),
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000420 Twine("Section too large, can't encode "
421 "r_address (") + Buffer +
422 ") into 24 bits of scattered "
423 "relocation entry.");
Oliver Stannard9be59af2015-11-17 10:00:43 +0000424 return false;
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000425 }
426
Charles Davis8bdfafd2013-09-01 04:28:48 +0000427 MachO::any_relocation_info MRE;
428 MRE.r_word0 = ((0 << 0) | // r_address
429 (MachO::GENERIC_RELOC_PAIR << 24) | // r_type
430 (Log2Size << 28) |
431 (IsPCRel << 30) |
432 MachO::R_SCATTERED);
433 MRE.r_word1 = Value2;
Rafael Espindola61e724a2015-05-26 01:15:30 +0000434 Writer->addRelocation(nullptr, Fragment->getParent(), MRE);
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000435 } else {
436 // If the offset is more than 24-bits, it won't fit in a scattered
437 // relocation offset field, so we fall back to using a non-scattered
438 // relocation. This is a bit risky, as if the offset reaches out of
439 // the block and the linker is doing scattered loading on this
440 // symbol, things can go badly.
441 //
442 // Required for 'as' compatibility.
Kevin Enderby86496a42013-12-04 23:36:24 +0000443 if (FixupOffset > 0xffffff) {
444 FixedValue = OriginalFixedValue;
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000445 return false;
Kevin Enderby86496a42013-12-04 23:36:24 +0000446 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000447 }
448
Charles Davis8bdfafd2013-09-01 04:28:48 +0000449 MachO::any_relocation_info MRE;
450 MRE.r_word0 = ((FixupOffset << 0) |
451 (Type << 24) |
452 (Log2Size << 28) |
453 (IsPCRel << 30) |
454 MachO::R_SCATTERED);
455 MRE.r_word1 = Value;
Rafael Espindola61e724a2015-05-26 01:15:30 +0000456 Writer->addRelocation(nullptr, Fragment->getParent(), MRE);
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000457 return true;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000458}
459
Jim Grosbach56ed0bb2015-06-04 23:25:54 +0000460void X86MachObjectWriter::recordTLVPRelocation(MachObjectWriter *Writer,
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000461 const MCAssembler &Asm,
462 const MCAsmLayout &Layout,
463 const MCFragment *Fragment,
464 const MCFixup &Fixup,
465 MCValue Target,
466 uint64_t &FixedValue) {
467 assert(Target.getSymA()->getKind() == MCSymbolRefExpr::VK_TLVP &&
468 !is64Bit() &&
469 "Should only be called with a 32-bit TLVP relocation!");
470
471 unsigned Log2Size = getFixupKindLog2Size(Fixup.getKind());
472 uint32_t Value = Layout.getFragmentOffset(Fragment)+Fixup.getOffset();
473 unsigned IsPCRel = 0;
474
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000475 // We're only going to have a second symbol in pic mode and it'll be a
476 // subtraction from the picbase. For 32-bit pic the addend is the difference
477 // between the picbase and the next address. For 32-bit static the addend is
478 // zero.
479 if (Target.getSymB()) {
480 // If this is a subtraction then we're pcrel.
481 uint32_t FixupAddress =
482 Writer->getFragmentAddress(Fragment, Layout) + Fixup.getOffset();
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000483 IsPCRel = 1;
Duncan P. N. Exon Smith99d8a8e2015-05-20 00:02:39 +0000484 FixedValue =
485 FixupAddress -
486 Writer->getSymbolAddress(Target.getSymB()->getSymbol(), Layout) +
487 Target.getConstant();
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000488 FixedValue += 1ULL << Log2Size;
489 } else {
490 FixedValue = 0;
491 }
492
493 // struct relocation_info (8 bytes)
Charles Davis8bdfafd2013-09-01 04:28:48 +0000494 MachO::any_relocation_info MRE;
495 MRE.r_word0 = Value;
Rafael Espindola26585542015-01-19 21:11:14 +0000496 MRE.r_word1 =
497 (IsPCRel << 24) | (Log2Size << 25) | (MachO::GENERIC_RELOC_TLV << 28);
Rafael Espindola61e724a2015-05-26 01:15:30 +0000498 Writer->addRelocation(&Target.getSymA()->getSymbol(), Fragment->getParent(),
499 MRE);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000500}
501
502void X86MachObjectWriter::RecordX86Relocation(MachObjectWriter *Writer,
503 const MCAssembler &Asm,
504 const MCAsmLayout &Layout,
505 const MCFragment *Fragment,
506 const MCFixup &Fixup,
507 MCValue Target,
508 uint64_t &FixedValue) {
509 unsigned IsPCRel = Writer->isFixupKindPCRel(Asm, Fixup.getKind());
510 unsigned Log2Size = getFixupKindLog2Size(Fixup.getKind());
511
512 // If this is a 32-bit TLVP reloc it's handled a bit differently.
513 if (Target.getSymA() &&
514 Target.getSymA()->getKind() == MCSymbolRefExpr::VK_TLVP) {
Jim Grosbach56ed0bb2015-06-04 23:25:54 +0000515 recordTLVPRelocation(Writer, Asm, Layout, Fragment, Fixup, Target,
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000516 FixedValue);
517 return;
518 }
519
520 // If this is a difference or a defined symbol plus an offset, then we need a
521 // scattered relocation entry. Differences always require scattered
522 // relocations.
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000523 if (Target.getSymB()) {
Jim Grosbach56ed0bb2015-06-04 23:25:54 +0000524 recordScatteredRelocation(Writer, Asm, Layout, Fragment, Fixup,
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000525 Target, Log2Size, FixedValue);
526 return;
527 }
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000528
529 // Get the symbol data, if any.
Duncan P. N. Exon Smith08b87262015-05-20 15:16:14 +0000530 const MCSymbol *A = nullptr;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000531 if (Target.getSymA())
Duncan P. N. Exon Smith08b87262015-05-20 15:16:14 +0000532 A = &Target.getSymA()->getSymbol();
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000533
534 // If this is an internal relocation with an offset, it also needs a scattered
535 // relocation entry.
536 uint32_t Offset = Target.getConstant();
537 if (IsPCRel)
538 Offset += 1 << Log2Size;
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000539 // Try to record the scattered relocation if needed. Fall back to non
Jim Grosbach56ed0bb2015-06-04 23:25:54 +0000540 // scattered if necessary (see comments in recordScatteredRelocation()
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000541 // for details).
Duncan P. N. Exon Smith08b87262015-05-20 15:16:14 +0000542 if (Offset && A && !Writer->doesSymbolRequireExternRelocation(*A) &&
Jim Grosbach56ed0bb2015-06-04 23:25:54 +0000543 recordScatteredRelocation(Writer, Asm, Layout, Fragment, Fixup, Target,
Duncan P. N. Exon Smith08b87262015-05-20 15:16:14 +0000544 Log2Size, FixedValue))
Jim Grosbachc03a0c22012-09-26 21:27:45 +0000545 return;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000546
547 // See <reloc.h>.
548 uint32_t FixupOffset = Layout.getFragmentOffset(Fragment)+Fixup.getOffset();
549 unsigned Index = 0;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000550 unsigned Type = 0;
Duncan P. N. Exon Smith6e23e5a2015-05-16 01:14:19 +0000551 const MCSymbol *RelSymbol = nullptr;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000552
553 if (Target.isAbsolute()) { // constant
554 // SymbolNum of 0 indicates the absolute section.
555 //
556 // FIXME: Currently, these are never generated (see code below). I cannot
557 // find a case where they are actually emitted.
Charles Davis8bdfafd2013-09-01 04:28:48 +0000558 Type = MachO::GENERIC_RELOC_VANILLA;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000559 } else {
560 // Resolve constant variables.
Duncan P. N. Exon Smith08b87262015-05-20 15:16:14 +0000561 if (A->isVariable()) {
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000562 int64_t Res;
Jim Grosbach13760bd2015-05-30 01:25:56 +0000563 if (A->getVariableValue()->evaluateAsAbsolute(
Duncan P. N. Exon Smith08b87262015-05-20 15:16:14 +0000564 Res, Layout, Writer->getSectionAddressMap())) {
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000565 FixedValue = Res;
566 return;
567 }
568 }
569
570 // Check whether we need an external or internal relocation.
Duncan P. N. Exon Smith08b87262015-05-20 15:16:14 +0000571 if (Writer->doesSymbolRequireExternRelocation(*A)) {
572 RelSymbol = A;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000573 // For external relocations, make sure to offset the fixup value to
574 // compensate for the addend of the symbol address, if it was
575 // undefined. This occurs with weak definitions, for example.
Duncan P. N. Exon Smith08b87262015-05-20 15:16:14 +0000576 if (!A->isUndefined())
577 FixedValue -= Layout.getSymbolOffset(*A);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000578 } else {
579 // The index is the section ordinal (1-based).
Rafael Espindola6e6820a2015-05-25 14:12:48 +0000580 const MCSection &Sec = A->getSection();
Rafael Espindola6e6820a2015-05-25 14:12:48 +0000581 Index = Sec.getOrdinal() + 1;
Rafael Espindola079027e2015-05-26 00:52:18 +0000582 FixedValue += Writer->getSectionAddress(&Sec);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000583 }
584 if (IsPCRel)
Rafael Espindola079027e2015-05-26 00:52:18 +0000585 FixedValue -= Writer->getSectionAddress(Fragment->getParent());
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000586
Charles Davis8bdfafd2013-09-01 04:28:48 +0000587 Type = MachO::GENERIC_RELOC_VANILLA;
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000588 }
589
590 // struct relocation_info (8 bytes)
Charles Davis8bdfafd2013-09-01 04:28:48 +0000591 MachO::any_relocation_info MRE;
592 MRE.r_word0 = FixupOffset;
Rafael Espindola26585542015-01-19 21:11:14 +0000593 MRE.r_word1 =
594 (Index << 0) | (IsPCRel << 24) | (Log2Size << 25) | (Type << 28);
Rafael Espindola61e724a2015-05-26 01:15:30 +0000595 Writer->addRelocation(RelSymbol, Fragment->getParent(), MRE);
Jim Grosbach28fcafb2011-06-24 23:44:37 +0000596}
597
Rafael Espindola5560a4c2015-04-14 22:14:34 +0000598MCObjectWriter *llvm::createX86MachObjectWriter(raw_pwrite_stream &OS,
599 bool Is64Bit, uint32_t CPUType,
Daniel Dunbar7da045e2010-12-20 15:07:39 +0000600 uint32_t CPUSubtype) {
601 return createMachObjectWriter(new X86MachObjectWriter(Is64Bit,
602 CPUType,
603 CPUSubtype),
604 OS, /*IsLittleEndian=*/true);
605}