1 //===- lib/MC/MachObjectWriter.cpp - Mach-O File 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 "llvm/MC/MCMachObjectWriter.h"
11 #include "llvm/ADT/OwningPtr.h"
12 #include "llvm/ADT/StringMap.h"
13 #include "llvm/ADT/Twine.h"
14 #include "llvm/MC/MCAssembler.h"
15 #include "llvm/MC/MCAsmLayout.h"
16 #include "llvm/MC/MCExpr.h"
17 #include "llvm/MC/MCObjectWriter.h"
18 #include "llvm/MC/MCSectionMachO.h"
19 #include "llvm/MC/MCSymbol.h"
20 #include "llvm/MC/MCMachOSymbolFlags.h"
21 #include "llvm/MC/MCValue.h"
22 #include "llvm/Object/MachOFormat.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/Target/TargetAsmBackend.h"
27 #include "../Target/X86/X86FixupKinds.h"
31 using namespace llvm::object;
33 // FIXME: this has been copied from (or to) X86AsmBackend.cpp
34 static unsigned getFixupKindLog2Size(unsigned Kind) {
36 // FIXME: Until ARM has it's own relocation stuff spun off, it comes
37 // through here and we don't want it to puke all over. Any reasonable
38 // values will only come when ARM relocation support gets added, at which
39 // point this will be X86 only again and the llvm_unreachable can be
41 default: return 0;// llvm_unreachable("invalid fixup kind!");
43 case FK_Data_1: return 0;
45 case FK_Data_2: return 1;
47 case X86::reloc_riprel_4byte:
48 case X86::reloc_riprel_4byte_movq_load:
49 case X86::reloc_signed_4byte:
50 case FK_Data_4: return 2;
51 case FK_Data_8: return 3;
55 static bool doesSymbolRequireExternRelocation(MCSymbolData *SD) {
56 // Undefined symbols are always extern.
57 if (SD->Symbol->isUndefined())
60 // References to weak definitions require external relocation entries; the
61 // definition may not always be the one in the same object file.
62 if (SD->getFlags() & SF_WeakDefinition)
65 // Otherwise, we can use an internal relocation.
69 static bool isScatteredFixupFullyResolved(const MCAssembler &Asm,
71 const MCSymbolData *BaseSymbol) {
72 // The effective fixup address is
73 // addr(atom(A)) + offset(A)
74 // - addr(atom(B)) - offset(B)
75 // - addr(BaseSymbol) + <fixup offset from base symbol>
76 // and the offsets are not relocatable, so the fixup is fully resolved when
77 // addr(atom(A)) - addr(atom(B)) - addr(BaseSymbol) == 0.
79 // Note that "false" is almost always conservatively correct (it means we emit
80 // a relocation which is unnecessary), except when it would force us to emit a
81 // relocation which the target cannot encode.
83 const MCSymbolData *A_Base = 0, *B_Base = 0;
84 if (const MCSymbolRefExpr *A = Target.getSymA()) {
85 // Modified symbol references cannot be resolved.
86 if (A->getKind() != MCSymbolRefExpr::VK_None)
89 A_Base = Asm.getAtom(&Asm.getSymbolData(A->getSymbol()));
94 if (const MCSymbolRefExpr *B = Target.getSymB()) {
95 // Modified symbol references cannot be resolved.
96 if (B->getKind() != MCSymbolRefExpr::VK_None)
99 B_Base = Asm.getAtom(&Asm.getSymbolData(B->getSymbol()));
104 // If there is no base, A and B have to be the same atom for this fixup to be
107 return A_Base == B_Base;
109 // Otherwise, B must be missing and A must be the base.
110 return !B_Base && BaseSymbol == A_Base;
113 static bool isScatteredFixupFullyResolvedSimple(const MCAssembler &Asm,
114 const MCValue Target,
115 const MCSection *BaseSection) {
116 // The effective fixup address is
117 // addr(atom(A)) + offset(A)
118 // - addr(atom(B)) - offset(B)
119 // - addr(<base symbol>) + <fixup offset from base symbol>
120 // and the offsets are not relocatable, so the fixup is fully resolved when
121 // addr(atom(A)) - addr(atom(B)) - addr(<base symbol>)) == 0.
123 // The simple (Darwin, except on x86_64) way of dealing with this was to
124 // assume that any reference to a temporary symbol *must* be a temporary
125 // symbol in the same atom, unless the sections differ. Therefore, any PCrel
126 // relocation to a temporary symbol (in the same section) is fully
127 // resolved. This also works in conjunction with absolutized .set, which
128 // requires the compiler to use .set to absolutize the differences between
129 // symbols which the compiler knows to be assembly time constants, so we don't
130 // need to worry about considering symbol differences fully resolved.
132 // Non-relative fixups are only resolved if constant.
134 return Target.isAbsolute();
136 // Otherwise, relative fixups are only resolved if not a difference and the
137 // target is a temporary in the same section.
138 if (Target.isAbsolute() || Target.getSymB())
141 const MCSymbol *A = &Target.getSymA()->getSymbol();
142 if (!A->isTemporary() || !A->isInSection() ||
143 &A->getSection() != BaseSection)
151 class MachObjectWriter : public MCObjectWriter {
152 /// MachSymbolData - Helper struct for containing some precomputed information
154 struct MachSymbolData {
155 MCSymbolData *SymbolData;
156 uint64_t StringIndex;
157 uint8_t SectionIndex;
159 // Support lexicographic sorting.
160 bool operator<(const MachSymbolData &RHS) const {
161 return SymbolData->getSymbol().getName() <
162 RHS.SymbolData->getSymbol().getName();
166 /// The target specific Mach-O writer instance.
167 llvm::OwningPtr<MCMachObjectTargetWriter> TargetObjectWriter;
169 /// @name Relocation Data
172 llvm::DenseMap<const MCSectionData*,
173 std::vector<macho::RelocationEntry> > Relocations;
174 llvm::DenseMap<const MCSectionData*, unsigned> IndirectSymBase;
177 /// @name Symbol Table Data
180 SmallString<256> StringTable;
181 std::vector<MachSymbolData> LocalSymbolData;
182 std::vector<MachSymbolData> ExternalSymbolData;
183 std::vector<MachSymbolData> UndefinedSymbolData;
188 /// @name Utility Methods
191 bool isFixupKindPCRel(const MCAssembler &Asm, unsigned Kind) {
192 const MCFixupKindInfo &FKI = Asm.getBackend().getFixupKindInfo(
195 return FKI.Flags & MCFixupKindInfo::FKF_IsPCRel;
200 SectionAddrMap SectionAddress;
201 uint64_t getSectionAddress(const MCSectionData* SD) const {
202 return SectionAddress.lookup(SD);
204 uint64_t getSymbolAddress(const MCSymbolData* SD,
205 const MCAsmLayout &Layout) const {
206 return getSectionAddress(SD->getFragment()->getParent()) +
207 Layout.getSymbolOffset(SD);
209 uint64_t getFragmentAddress(const MCFragment *Fragment,
210 const MCAsmLayout &Layout) const {
211 return getSectionAddress(Fragment->getParent()) +
212 Layout.getFragmentOffset(Fragment);
215 uint64_t getPaddingSize(const MCSectionData *SD,
216 const MCAsmLayout &Layout) const {
217 uint64_t EndAddr = getSectionAddress(SD) + Layout.getSectionAddressSize(SD);
218 unsigned Next = SD->getLayoutOrder() + 1;
219 if (Next >= Layout.getSectionOrder().size())
222 const MCSectionData &NextSD = *Layout.getSectionOrder()[Next];
223 if (NextSD.getSection().isVirtualSection())
225 return OffsetToAlignment(EndAddr, NextSD.getAlignment());
228 unsigned Is64Bit : 1;
234 MachObjectWriter(MCMachObjectTargetWriter *MOTW, raw_ostream &_OS,
235 bool _Is64Bit, uint32_t _CPUType, uint32_t _CPUSubtype,
236 bool _IsLittleEndian)
237 : MCObjectWriter(_OS, _IsLittleEndian), TargetObjectWriter(MOTW),
238 Is64Bit(_Is64Bit), CPUType(_CPUType), CPUSubtype(_CPUSubtype) {
241 void WriteHeader(unsigned NumLoadCommands, unsigned LoadCommandsSize,
242 bool SubsectionsViaSymbols) {
245 if (SubsectionsViaSymbols)
246 Flags |= macho::HF_SubsectionsViaSymbols;
248 // struct mach_header (28 bytes) or
249 // struct mach_header_64 (32 bytes)
251 uint64_t Start = OS.tell();
254 Write32(Is64Bit ? macho::HM_Object64 : macho::HM_Object32);
259 Write32(macho::HFT_Object);
260 Write32(NumLoadCommands);
261 Write32(LoadCommandsSize);
264 Write32(0); // reserved
266 assert(OS.tell() - Start == Is64Bit ?
267 macho::Header64Size : macho::Header32Size);
270 /// WriteSegmentLoadCommand - Write a segment load command.
272 /// \arg NumSections - The number of sections in this segment.
273 /// \arg SectionDataSize - The total size of the sections.
274 void WriteSegmentLoadCommand(unsigned NumSections,
276 uint64_t SectionDataStartOffset,
277 uint64_t SectionDataSize) {
278 // struct segment_command (56 bytes) or
279 // struct segment_command_64 (72 bytes)
281 uint64_t Start = OS.tell();
284 unsigned SegmentLoadCommandSize = Is64Bit ? macho::SegmentLoadCommand64Size:
285 macho::SegmentLoadCommand32Size;
286 Write32(Is64Bit ? macho::LCT_Segment64 : macho::LCT_Segment);
287 Write32(SegmentLoadCommandSize +
288 NumSections * (Is64Bit ? macho::Section64Size :
289 macho::Section32Size));
293 Write64(0); // vmaddr
294 Write64(VMSize); // vmsize
295 Write64(SectionDataStartOffset); // file offset
296 Write64(SectionDataSize); // file size
298 Write32(0); // vmaddr
299 Write32(VMSize); // vmsize
300 Write32(SectionDataStartOffset); // file offset
301 Write32(SectionDataSize); // file size
303 Write32(0x7); // maxprot
304 Write32(0x7); // initprot
305 Write32(NumSections);
308 assert(OS.tell() - Start == SegmentLoadCommandSize);
311 void WriteSection(const MCAssembler &Asm, const MCAsmLayout &Layout,
312 const MCSectionData &SD, uint64_t FileOffset,
313 uint64_t RelocationsStart, unsigned NumRelocations) {
314 uint64_t SectionSize = Layout.getSectionAddressSize(&SD);
316 // The offset is unused for virtual sections.
317 if (SD.getSection().isVirtualSection()) {
318 assert(Layout.getSectionFileSize(&SD) == 0 && "Invalid file size!");
322 // struct section (68 bytes) or
323 // struct section_64 (80 bytes)
325 uint64_t Start = OS.tell();
328 const MCSectionMachO &Section = cast<MCSectionMachO>(SD.getSection());
329 WriteBytes(Section.getSectionName(), 16);
330 WriteBytes(Section.getSegmentName(), 16);
332 Write64(getSectionAddress(&SD)); // address
333 Write64(SectionSize); // size
335 Write32(getSectionAddress(&SD)); // address
336 Write32(SectionSize); // size
340 unsigned Flags = Section.getTypeAndAttributes();
341 if (SD.hasInstructions())
342 Flags |= MCSectionMachO::S_ATTR_SOME_INSTRUCTIONS;
344 assert(isPowerOf2_32(SD.getAlignment()) && "Invalid alignment!");
345 Write32(Log2_32(SD.getAlignment()));
346 Write32(NumRelocations ? RelocationsStart : 0);
347 Write32(NumRelocations);
349 Write32(IndirectSymBase.lookup(&SD)); // reserved1
350 Write32(Section.getStubSize()); // reserved2
352 Write32(0); // reserved3
354 assert(OS.tell() - Start == Is64Bit ? macho::Section64Size :
355 macho::Section32Size);
358 void WriteSymtabLoadCommand(uint32_t SymbolOffset, uint32_t NumSymbols,
359 uint32_t StringTableOffset,
360 uint32_t StringTableSize) {
361 // struct symtab_command (24 bytes)
363 uint64_t Start = OS.tell();
366 Write32(macho::LCT_Symtab);
367 Write32(macho::SymtabLoadCommandSize);
368 Write32(SymbolOffset);
370 Write32(StringTableOffset);
371 Write32(StringTableSize);
373 assert(OS.tell() - Start == macho::SymtabLoadCommandSize);
376 void WriteDysymtabLoadCommand(uint32_t FirstLocalSymbol,
377 uint32_t NumLocalSymbols,
378 uint32_t FirstExternalSymbol,
379 uint32_t NumExternalSymbols,
380 uint32_t FirstUndefinedSymbol,
381 uint32_t NumUndefinedSymbols,
382 uint32_t IndirectSymbolOffset,
383 uint32_t NumIndirectSymbols) {
384 // struct dysymtab_command (80 bytes)
386 uint64_t Start = OS.tell();
389 Write32(macho::LCT_Dysymtab);
390 Write32(macho::DysymtabLoadCommandSize);
391 Write32(FirstLocalSymbol);
392 Write32(NumLocalSymbols);
393 Write32(FirstExternalSymbol);
394 Write32(NumExternalSymbols);
395 Write32(FirstUndefinedSymbol);
396 Write32(NumUndefinedSymbols);
397 Write32(0); // tocoff
399 Write32(0); // modtaboff
400 Write32(0); // nmodtab
401 Write32(0); // extrefsymoff
402 Write32(0); // nextrefsyms
403 Write32(IndirectSymbolOffset);
404 Write32(NumIndirectSymbols);
405 Write32(0); // extreloff
406 Write32(0); // nextrel
407 Write32(0); // locreloff
408 Write32(0); // nlocrel
410 assert(OS.tell() - Start == macho::DysymtabLoadCommandSize);
413 void WriteNlist(MachSymbolData &MSD, const MCAsmLayout &Layout) {
414 MCSymbolData &Data = *MSD.SymbolData;
415 const MCSymbol &Symbol = Data.getSymbol();
417 uint16_t Flags = Data.getFlags();
418 uint32_t Address = 0;
420 // Set the N_TYPE bits. See <mach-o/nlist.h>.
422 // FIXME: Are the prebound or indirect fields possible here?
423 if (Symbol.isUndefined())
424 Type = macho::STT_Undefined;
425 else if (Symbol.isAbsolute())
426 Type = macho::STT_Absolute;
428 Type = macho::STT_Section;
430 // FIXME: Set STAB bits.
432 if (Data.isPrivateExtern())
433 Type |= macho::STF_PrivateExtern;
436 if (Data.isExternal() || Symbol.isUndefined())
437 Type |= macho::STF_External;
439 // Compute the symbol address.
440 if (Symbol.isDefined()) {
441 if (Symbol.isAbsolute()) {
442 Address = cast<MCConstantExpr>(Symbol.getVariableValue())->getValue();
444 Address = getSymbolAddress(&Data, Layout);
446 } else if (Data.isCommon()) {
447 // Common symbols are encoded with the size in the address
448 // field, and their alignment in the flags.
449 Address = Data.getCommonSize();
451 // Common alignment is packed into the 'desc' bits.
452 if (unsigned Align = Data.getCommonAlignment()) {
453 unsigned Log2Size = Log2_32(Align);
454 assert((1U << Log2Size) == Align && "Invalid 'common' alignment!");
456 report_fatal_error("invalid 'common' alignment '" +
458 // FIXME: Keep this mask with the SymbolFlags enumeration.
459 Flags = (Flags & 0xF0FF) | (Log2Size << 8);
463 // struct nlist (12 bytes)
465 Write32(MSD.StringIndex);
467 Write8(MSD.SectionIndex);
469 // The Mach-O streamer uses the lowest 16-bits of the flags for the 'desc'
478 // FIXME: We really need to improve the relocation validation. Basically, we
479 // want to implement a separate computation which evaluates the relocation
480 // entry as the linker would, and verifies that the resultant fixup value is
481 // exactly what the encoder wanted. This will catch several classes of
484 // - Relocation entry bugs, the two algorithms are unlikely to have the same
487 // - Relaxation issues, where we forget to relax something.
489 // - Input errors, where something cannot be correctly encoded. 'as' allows
490 // these through in many cases.
492 static bool isFixupKindRIPRel(unsigned Kind) {
493 return Kind == X86::reloc_riprel_4byte ||
494 Kind == X86::reloc_riprel_4byte_movq_load;
496 void RecordX86_64Relocation(const MCAssembler &Asm, const MCAsmLayout &Layout,
497 const MCFragment *Fragment,
498 const MCFixup &Fixup, MCValue Target,
499 uint64_t &FixedValue) {
500 unsigned IsPCRel = isFixupKindPCRel(Asm, Fixup.getKind());
501 unsigned IsRIPRel = isFixupKindRIPRel(Fixup.getKind());
502 unsigned Log2Size = getFixupKindLog2Size(Fixup.getKind());
505 uint32_t FixupOffset =
506 Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
507 uint32_t FixupAddress =
508 getFragmentAddress(Fragment, Layout) + Fixup.getOffset();
511 unsigned IsExtern = 0;
514 Value = Target.getConstant();
517 // Compensate for the relocation offset, Darwin x86_64 relocations only
518 // have the addend and appear to have attempted to define it to be the
519 // actual expression addend without the PCrel bias. However, instructions
520 // with data following the relocation are not accomodated for (see comment
521 // below regarding SIGNED{1,2,4}), so it isn't exactly that either.
522 Value += 1LL << Log2Size;
525 if (Target.isAbsolute()) { // constant
526 // SymbolNum of 0 indicates the absolute section.
527 Type = macho::RIT_X86_64_Unsigned;
530 // FIXME: I believe this is broken, I don't think the linker can
531 // understand it. I think it would require a local relocation, but I'm not
532 // sure if that would work either. The official way to get an absolute
533 // PCrel relocation is to use an absolute symbol (which we don't support
537 Type = macho::RIT_X86_64_Branch;
539 } else if (Target.getSymB()) { // A - B + constant
540 const MCSymbol *A = &Target.getSymA()->getSymbol();
541 MCSymbolData &A_SD = Asm.getSymbolData(*A);
542 const MCSymbolData *A_Base = Asm.getAtom(&A_SD);
544 const MCSymbol *B = &Target.getSymB()->getSymbol();
545 MCSymbolData &B_SD = Asm.getSymbolData(*B);
546 const MCSymbolData *B_Base = Asm.getAtom(&B_SD);
548 // Neither symbol can be modified.
549 if (Target.getSymA()->getKind() != MCSymbolRefExpr::VK_None ||
550 Target.getSymB()->getKind() != MCSymbolRefExpr::VK_None)
551 report_fatal_error("unsupported relocation of modified symbol");
553 // We don't support PCrel relocations of differences. Darwin 'as' doesn't
554 // implement most of these correctly.
556 report_fatal_error("unsupported pc-relative relocation of difference");
558 // The support for the situation where one or both of the symbols would
559 // require a local relocation is handled just like if the symbols were
560 // external. This is certainly used in the case of debug sections where
561 // the section has only temporary symbols and thus the symbols don't have
562 // base symbols. This is encoded using the section ordinal and
563 // non-extern relocation entries.
565 // Darwin 'as' doesn't emit correct relocations for this (it ends up with
566 // a single SIGNED relocation); reject it for now. Except the case where
567 // both symbols don't have a base, equal but both NULL.
568 if (A_Base == B_Base && A_Base)
569 report_fatal_error("unsupported relocation with identical base");
571 Value += getSymbolAddress(&A_SD, Layout) -
572 (A_Base == NULL ? 0 : getSymbolAddress(A_Base, Layout));
573 Value -= getSymbolAddress(&B_SD, Layout) -
574 (B_Base == NULL ? 0 : getSymbolAddress(B_Base, Layout));
577 Index = A_Base->getIndex();
581 Index = A_SD.getFragment()->getParent()->getOrdinal() + 1;
584 Type = macho::RIT_X86_64_Unsigned;
586 macho::RelocationEntry MRE;
587 MRE.Word0 = FixupOffset;
588 MRE.Word1 = ((Index << 0) |
593 Relocations[Fragment->getParent()].push_back(MRE);
596 Index = B_Base->getIndex();
600 Index = B_SD.getFragment()->getParent()->getOrdinal() + 1;
603 Type = macho::RIT_X86_64_Subtractor;
605 const MCSymbol *Symbol = &Target.getSymA()->getSymbol();
606 MCSymbolData &SD = Asm.getSymbolData(*Symbol);
607 const MCSymbolData *Base = Asm.getAtom(&SD);
609 // Relocations inside debug sections always use local relocations when
610 // possible. This seems to be done because the debugger doesn't fully
611 // understand x86_64 relocation entries, and expects to find values that
612 // have already been fixed up.
613 if (Symbol->isInSection()) {
614 const MCSectionMachO &Section = static_cast<const MCSectionMachO&>(
615 Fragment->getParent()->getSection());
616 if (Section.hasAttribute(MCSectionMachO::S_ATTR_DEBUG))
620 // x86_64 almost always uses external relocations, except when there is no
621 // symbol to use as a base address (a local symbol with no preceeding
622 // non-local symbol).
624 Index = Base->getIndex();
627 // Add the local offset, if needed.
629 Value += Layout.getSymbolOffset(&SD) - Layout.getSymbolOffset(Base);
630 } else if (Symbol->isInSection()) {
631 // The index is the section ordinal (1-based).
632 Index = SD.getFragment()->getParent()->getOrdinal() + 1;
634 Value += getSymbolAddress(&SD, Layout);
637 Value -= FixupAddress + (1 << Log2Size);
638 } else if (Symbol->isVariable()) {
639 const MCExpr *Value = Symbol->getVariableValue();
641 bool isAbs = Value->EvaluateAsAbsolute(Res, Layout, SectionAddress);
646 report_fatal_error("unsupported relocation of variable '" +
647 Symbol->getName() + "'");
650 report_fatal_error("unsupported relocation of undefined symbol '" +
651 Symbol->getName() + "'");
654 MCSymbolRefExpr::VariantKind Modifier = Target.getSymA()->getKind();
657 if (Modifier == MCSymbolRefExpr::VK_GOTPCREL) {
658 // x86_64 distinguishes movq foo@GOTPCREL so that the linker can
659 // rewrite the movq to an leaq at link time if the symbol ends up in
660 // the same linkage unit.
661 if (unsigned(Fixup.getKind()) == X86::reloc_riprel_4byte_movq_load)
662 Type = macho::RIT_X86_64_GOTLoad;
664 Type = macho::RIT_X86_64_GOT;
665 } else if (Modifier == MCSymbolRefExpr::VK_TLVP) {
666 Type = macho::RIT_X86_64_TLV;
667 } else if (Modifier != MCSymbolRefExpr::VK_None) {
668 report_fatal_error("unsupported symbol modifier in relocation");
670 Type = macho::RIT_X86_64_Signed;
672 // The Darwin x86_64 relocation format has a problem where it cannot
673 // encode an address (L<foo> + <constant>) which is outside the atom
674 // containing L<foo>. Generally, this shouldn't occur but it does
675 // happen when we have a RIPrel instruction with data following the
676 // relocation entry (e.g., movb $012, L0(%rip)). Even with the PCrel
677 // adjustment Darwin x86_64 uses, the offset is still negative and
678 // the linker has no way to recognize this.
680 // To work around this, Darwin uses several special relocation types
681 // to indicate the offsets. However, the specification or
682 // implementation of these seems to also be incomplete; they should
683 // adjust the addend as well based on the actual encoded instruction
684 // (the additional bias), but instead appear to just look at the
686 switch (-(Target.getConstant() + (1LL << Log2Size))) {
687 case 1: Type = macho::RIT_X86_64_Signed1; break;
688 case 2: Type = macho::RIT_X86_64_Signed2; break;
689 case 4: Type = macho::RIT_X86_64_Signed4; break;
693 if (Modifier != MCSymbolRefExpr::VK_None)
694 report_fatal_error("unsupported symbol modifier in branch "
697 Type = macho::RIT_X86_64_Branch;
700 if (Modifier == MCSymbolRefExpr::VK_GOT) {
701 Type = macho::RIT_X86_64_GOT;
702 } else if (Modifier == MCSymbolRefExpr::VK_GOTPCREL) {
703 // GOTPCREL is allowed as a modifier on non-PCrel instructions, in
704 // which case all we do is set the PCrel bit in the relocation entry;
705 // this is used with exception handling, for example. The source is
706 // required to include any necessary offset directly.
707 Type = macho::RIT_X86_64_GOT;
709 } else if (Modifier == MCSymbolRefExpr::VK_TLVP) {
710 report_fatal_error("TLVP symbol modifier should have been rip-rel");
711 } else if (Modifier != MCSymbolRefExpr::VK_None)
712 report_fatal_error("unsupported symbol modifier in relocation");
714 Type = macho::RIT_X86_64_Unsigned;
718 // x86_64 always writes custom values into the fixups.
721 // struct relocation_info (8 bytes)
722 macho::RelocationEntry MRE;
723 MRE.Word0 = FixupOffset;
724 MRE.Word1 = ((Index << 0) |
729 Relocations[Fragment->getParent()].push_back(MRE);
732 void RecordScatteredRelocation(const MCAssembler &Asm,
733 const MCAsmLayout &Layout,
734 const MCFragment *Fragment,
735 const MCFixup &Fixup, MCValue Target,
736 uint64_t &FixedValue) {
737 uint32_t FixupOffset = Layout.getFragmentOffset(Fragment)+Fixup.getOffset();
738 unsigned IsPCRel = isFixupKindPCRel(Asm, Fixup.getKind());
739 unsigned Log2Size = getFixupKindLog2Size(Fixup.getKind());
740 unsigned Type = macho::RIT_Vanilla;
743 const MCSymbol *A = &Target.getSymA()->getSymbol();
744 MCSymbolData *A_SD = &Asm.getSymbolData(*A);
746 if (!A_SD->getFragment())
747 report_fatal_error("symbol '" + A->getName() +
748 "' can not be undefined in a subtraction expression");
750 uint32_t Value = getSymbolAddress(A_SD, Layout);
751 uint64_t SecAddr = getSectionAddress(A_SD->getFragment()->getParent());
752 FixedValue += SecAddr;
755 if (const MCSymbolRefExpr *B = Target.getSymB()) {
756 MCSymbolData *B_SD = &Asm.getSymbolData(B->getSymbol());
758 if (!B_SD->getFragment())
759 report_fatal_error("symbol '" + B->getSymbol().getName() +
760 "' can not be undefined in a subtraction expression");
762 // Select the appropriate difference relocation type.
764 // Note that there is no longer any semantic difference between these two
765 // relocation types from the linkers point of view, this is done solely
766 // for pedantic compatibility with 'as'.
767 Type = A_SD->isExternal() ? macho::RIT_Difference :
768 macho::RIT_LocalDifference;
769 Value2 = getSymbolAddress(B_SD, Layout);
770 FixedValue -= getSectionAddress(B_SD->getFragment()->getParent());
773 // Relocations are written out in reverse order, so the PAIR comes first.
774 if (Type == macho::RIT_Difference || Type == macho::RIT_LocalDifference) {
775 macho::RelocationEntry MRE;
776 MRE.Word0 = ((0 << 0) |
777 (macho::RIT_Pair << 24) |
780 macho::RF_Scattered);
782 Relocations[Fragment->getParent()].push_back(MRE);
785 macho::RelocationEntry MRE;
786 MRE.Word0 = ((FixupOffset << 0) |
790 macho::RF_Scattered);
792 Relocations[Fragment->getParent()].push_back(MRE);
795 void RecordTLVPRelocation(const MCAssembler &Asm,
796 const MCAsmLayout &Layout,
797 const MCFragment *Fragment,
798 const MCFixup &Fixup, MCValue Target,
799 uint64_t &FixedValue) {
800 assert(Target.getSymA()->getKind() == MCSymbolRefExpr::VK_TLVP &&
802 "Should only be called with a 32-bit TLVP relocation!");
804 unsigned Log2Size = getFixupKindLog2Size(Fixup.getKind());
805 uint32_t Value = Layout.getFragmentOffset(Fragment)+Fixup.getOffset();
806 unsigned IsPCRel = 0;
808 // Get the symbol data.
809 MCSymbolData *SD_A = &Asm.getSymbolData(Target.getSymA()->getSymbol());
810 unsigned Index = SD_A->getIndex();
812 // We're only going to have a second symbol in pic mode and it'll be a
813 // subtraction from the picbase. For 32-bit pic the addend is the difference
814 // between the picbase and the next address. For 32-bit static the addend
816 if (Target.getSymB()) {
817 // If this is a subtraction then we're pcrel.
818 uint32_t FixupAddress =
819 getFragmentAddress(Fragment, Layout) + Fixup.getOffset();
820 MCSymbolData *SD_B = &Asm.getSymbolData(Target.getSymB()->getSymbol());
822 FixedValue = (FixupAddress - getSymbolAddress(SD_B, Layout) +
823 Target.getConstant());
824 FixedValue += 1ULL << Log2Size;
829 // struct relocation_info (8 bytes)
830 macho::RelocationEntry MRE;
832 MRE.Word1 = ((Index << 0) |
835 (1 << 27) | // Extern
836 (macho::RIT_TLV << 28)); // Type
837 Relocations[Fragment->getParent()].push_back(MRE);
840 void RecordRelocation(const MCAssembler &Asm, const MCAsmLayout &Layout,
841 const MCFragment *Fragment, const MCFixup &Fixup,
842 MCValue Target, uint64_t &FixedValue) {
844 RecordX86_64Relocation(Asm, Layout, Fragment, Fixup, Target, FixedValue);
848 unsigned IsPCRel = isFixupKindPCRel(Asm, Fixup.getKind());
849 unsigned Log2Size = getFixupKindLog2Size(Fixup.getKind());
851 // If this is a 32-bit TLVP reloc it's handled a bit differently.
852 if (Target.getSymA() &&
853 Target.getSymA()->getKind() == MCSymbolRefExpr::VK_TLVP) {
854 RecordTLVPRelocation(Asm, Layout, Fragment, Fixup, Target, FixedValue);
858 // If this is a difference or a defined symbol plus an offset, then we need
859 // a scattered relocation entry.
860 // Differences always require scattered relocations.
861 if (Target.getSymB())
862 return RecordScatteredRelocation(Asm, Layout, Fragment, Fixup,
865 // Get the symbol data, if any.
866 MCSymbolData *SD = 0;
867 if (Target.getSymA())
868 SD = &Asm.getSymbolData(Target.getSymA()->getSymbol());
870 // If this is an internal relocation with an offset, it also needs a
871 // scattered relocation entry.
872 uint32_t Offset = Target.getConstant();
874 Offset += 1 << Log2Size;
875 if (Offset && SD && !doesSymbolRequireExternRelocation(SD))
876 return RecordScatteredRelocation(Asm, Layout, Fragment, Fixup,
880 uint32_t FixupOffset = Layout.getFragmentOffset(Fragment)+Fixup.getOffset();
882 unsigned IsExtern = 0;
885 if (Target.isAbsolute()) { // constant
886 // SymbolNum of 0 indicates the absolute section.
888 // FIXME: Currently, these are never generated (see code below). I cannot
889 // find a case where they are actually emitted.
890 Type = macho::RIT_Vanilla;
891 } else if (SD->getSymbol().isVariable()) {
892 const MCExpr *Value = SD->getSymbol().getVariableValue();
894 bool isAbs = Value->EvaluateAsAbsolute(Res, Layout, SectionAddress);
899 report_fatal_error("unsupported relocation of variable '" +
900 SD->getSymbol().getName() + "'");
903 // Check whether we need an external or internal relocation.
904 if (doesSymbolRequireExternRelocation(SD)) {
906 Index = SD->getIndex();
907 // For external relocations, make sure to offset the fixup value to
908 // compensate for the addend of the symbol address, if it was
909 // undefined. This occurs with weak definitions, for example.
910 if (!SD->Symbol->isUndefined())
911 FixedValue -= Layout.getSymbolOffset(SD);
913 // The index is the section ordinal (1-based).
914 Index = SD->getFragment()->getParent()->getOrdinal() + 1;
915 FixedValue += getSectionAddress(SD->getFragment()->getParent());
918 FixedValue -= getSectionAddress(Fragment->getParent());
920 Type = macho::RIT_Vanilla;
923 // struct relocation_info (8 bytes)
924 macho::RelocationEntry MRE;
925 MRE.Word0 = FixupOffset;
926 MRE.Word1 = ((Index << 0) |
931 Relocations[Fragment->getParent()].push_back(MRE);
934 void BindIndirectSymbols(MCAssembler &Asm) {
935 // This is the point where 'as' creates actual symbols for indirect symbols
936 // (in the following two passes). It would be easier for us to do this
937 // sooner when we see the attribute, but that makes getting the order in the
938 // symbol table much more complicated than it is worth.
940 // FIXME: Revisit this when the dust settles.
942 // Bind non lazy symbol pointers first.
943 unsigned IndirectIndex = 0;
944 for (MCAssembler::indirect_symbol_iterator it = Asm.indirect_symbol_begin(),
945 ie = Asm.indirect_symbol_end(); it != ie; ++it, ++IndirectIndex) {
946 const MCSectionMachO &Section =
947 cast<MCSectionMachO>(it->SectionData->getSection());
949 if (Section.getType() != MCSectionMachO::S_NON_LAZY_SYMBOL_POINTERS)
952 // Initialize the section indirect symbol base, if necessary.
953 if (!IndirectSymBase.count(it->SectionData))
954 IndirectSymBase[it->SectionData] = IndirectIndex;
956 Asm.getOrCreateSymbolData(*it->Symbol);
959 // Then lazy symbol pointers and symbol stubs.
961 for (MCAssembler::indirect_symbol_iterator it = Asm.indirect_symbol_begin(),
962 ie = Asm.indirect_symbol_end(); it != ie; ++it, ++IndirectIndex) {
963 const MCSectionMachO &Section =
964 cast<MCSectionMachO>(it->SectionData->getSection());
966 if (Section.getType() != MCSectionMachO::S_LAZY_SYMBOL_POINTERS &&
967 Section.getType() != MCSectionMachO::S_SYMBOL_STUBS)
970 // Initialize the section indirect symbol base, if necessary.
971 if (!IndirectSymBase.count(it->SectionData))
972 IndirectSymBase[it->SectionData] = IndirectIndex;
974 // Set the symbol type to undefined lazy, but only on construction.
976 // FIXME: Do not hardcode.
978 MCSymbolData &Entry = Asm.getOrCreateSymbolData(*it->Symbol, &Created);
980 Entry.setFlags(Entry.getFlags() | 0x0001);
984 /// ComputeSymbolTable - Compute the symbol table data
986 /// \param StringTable [out] - The string table data.
987 /// \param StringIndexMap [out] - Map from symbol names to offsets in the
989 void ComputeSymbolTable(MCAssembler &Asm, SmallString<256> &StringTable,
990 std::vector<MachSymbolData> &LocalSymbolData,
991 std::vector<MachSymbolData> &ExternalSymbolData,
992 std::vector<MachSymbolData> &UndefinedSymbolData) {
993 // Build section lookup table.
994 DenseMap<const MCSection*, uint8_t> SectionIndexMap;
996 for (MCAssembler::iterator it = Asm.begin(),
997 ie = Asm.end(); it != ie; ++it, ++Index)
998 SectionIndexMap[&it->getSection()] = Index;
999 assert(Index <= 256 && "Too many sections!");
1001 // Index 0 is always the empty string.
1002 StringMap<uint64_t> StringIndexMap;
1003 StringTable += '\x00';
1005 // Build the symbol arrays and the string table, but only for non-local
1008 // The particular order that we collect the symbols and create the string
1009 // table, then sort the symbols is chosen to match 'as'. Even though it
1010 // doesn't matter for correctness, this is important for letting us diff .o
1012 for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
1013 ie = Asm.symbol_end(); it != ie; ++it) {
1014 const MCSymbol &Symbol = it->getSymbol();
1016 // Ignore non-linker visible symbols.
1017 if (!Asm.isSymbolLinkerVisible(it->getSymbol()))
1020 if (!it->isExternal() && !Symbol.isUndefined())
1023 uint64_t &Entry = StringIndexMap[Symbol.getName()];
1025 Entry = StringTable.size();
1026 StringTable += Symbol.getName();
1027 StringTable += '\x00';
1031 MSD.SymbolData = it;
1032 MSD.StringIndex = Entry;
1034 if (Symbol.isUndefined()) {
1035 MSD.SectionIndex = 0;
1036 UndefinedSymbolData.push_back(MSD);
1037 } else if (Symbol.isAbsolute()) {
1038 MSD.SectionIndex = 0;
1039 ExternalSymbolData.push_back(MSD);
1041 MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
1042 assert(MSD.SectionIndex && "Invalid section index!");
1043 ExternalSymbolData.push_back(MSD);
1047 // Now add the data for local symbols.
1048 for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
1049 ie = Asm.symbol_end(); it != ie; ++it) {
1050 const MCSymbol &Symbol = it->getSymbol();
1052 // Ignore non-linker visible symbols.
1053 if (!Asm.isSymbolLinkerVisible(it->getSymbol()))
1056 if (it->isExternal() || Symbol.isUndefined())
1059 uint64_t &Entry = StringIndexMap[Symbol.getName()];
1061 Entry = StringTable.size();
1062 StringTable += Symbol.getName();
1063 StringTable += '\x00';
1067 MSD.SymbolData = it;
1068 MSD.StringIndex = Entry;
1070 if (Symbol.isAbsolute()) {
1071 MSD.SectionIndex = 0;
1072 LocalSymbolData.push_back(MSD);
1074 MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
1075 assert(MSD.SectionIndex && "Invalid section index!");
1076 LocalSymbolData.push_back(MSD);
1080 // External and undefined symbols are required to be in lexicographic order.
1081 std::sort(ExternalSymbolData.begin(), ExternalSymbolData.end());
1082 std::sort(UndefinedSymbolData.begin(), UndefinedSymbolData.end());
1084 // Set the symbol indices.
1086 for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
1087 LocalSymbolData[i].SymbolData->setIndex(Index++);
1088 for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
1089 ExternalSymbolData[i].SymbolData->setIndex(Index++);
1090 for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
1091 UndefinedSymbolData[i].SymbolData->setIndex(Index++);
1093 // The string table is padded to a multiple of 4.
1094 while (StringTable.size() % 4)
1095 StringTable += '\x00';
1098 void computeSectionAddresses(const MCAssembler &Asm,
1099 const MCAsmLayout &Layout) {
1100 uint64_t StartAddress = 0;
1101 const SmallVectorImpl<MCSectionData*> &Order = Layout.getSectionOrder();
1102 for (int i = 0, n = Order.size(); i != n ; ++i) {
1103 const MCSectionData *SD = Order[i];
1104 StartAddress = RoundUpToAlignment(StartAddress, SD->getAlignment());
1105 SectionAddress[SD] = StartAddress;
1106 StartAddress += Layout.getSectionAddressSize(SD);
1107 // Explicitly pad the section to match the alignment requirements of the
1108 // following one. This is for 'gas' compatibility, it shouldn't
1109 /// strictly be necessary.
1110 StartAddress += getPaddingSize(SD, Layout);
1114 void ExecutePostLayoutBinding(MCAssembler &Asm, const MCAsmLayout &Layout) {
1115 computeSectionAddresses(Asm, Layout);
1117 // Create symbol data for any indirect symbols.
1118 BindIndirectSymbols(Asm);
1120 // Compute symbol table information and bind symbol indices.
1121 ComputeSymbolTable(Asm, StringTable, LocalSymbolData, ExternalSymbolData,
1122 UndefinedSymbolData);
1126 bool IsFixupFullyResolved(const MCAssembler &Asm,
1127 const MCValue Target,
1129 const MCFragment *DF) const {
1130 // If we aren't using scattered symbols, the fixup is fully resolved.
1131 if (!Asm.getBackend().hasScatteredSymbols())
1134 // Otherwise, determine whether this value is actually resolved; scattering
1135 // may cause atoms to move.
1137 // Check if we are using the "simple" resolution algorithm (e.g.,
1139 if (!Asm.getBackend().hasReliableSymbolDifference()) {
1140 const MCSection *BaseSection = 0;
1142 BaseSection = &DF->getParent()->getSection();
1144 return isScatteredFixupFullyResolvedSimple(Asm, Target, BaseSection);
1147 // Otherwise, compute the proper answer as reliably as possible.
1149 // If this is a PCrel relocation, find the base atom (identified by its
1150 // symbol) that the fixup value is relative to.
1151 const MCSymbolData *BaseSymbol = 0;
1153 BaseSymbol = DF->getAtom();
1158 return isScatteredFixupFullyResolved(Asm, Target, BaseSymbol);
1161 void WriteObject(MCAssembler &Asm, const MCAsmLayout &Layout) {
1162 unsigned NumSections = Asm.size();
1164 // The section data starts after the header, the segment load command (and
1165 // section headers) and the symbol table.
1166 unsigned NumLoadCommands = 1;
1167 uint64_t LoadCommandsSize = Is64Bit ?
1168 macho::SegmentLoadCommand64Size + NumSections * macho::Section64Size :
1169 macho::SegmentLoadCommand32Size + NumSections * macho::Section32Size;
1171 // Add the symbol table load command sizes, if used.
1172 unsigned NumSymbols = LocalSymbolData.size() + ExternalSymbolData.size() +
1173 UndefinedSymbolData.size();
1175 NumLoadCommands += 2;
1176 LoadCommandsSize += (macho::SymtabLoadCommandSize +
1177 macho::DysymtabLoadCommandSize);
1180 // Compute the total size of the section data, as well as its file size and
1182 uint64_t SectionDataStart = (Is64Bit ? macho::Header64Size :
1183 macho::Header32Size) + LoadCommandsSize;
1184 uint64_t SectionDataSize = 0;
1185 uint64_t SectionDataFileSize = 0;
1186 uint64_t VMSize = 0;
1187 for (MCAssembler::const_iterator it = Asm.begin(),
1188 ie = Asm.end(); it != ie; ++it) {
1189 const MCSectionData &SD = *it;
1190 uint64_t Address = getSectionAddress(&SD);
1191 uint64_t Size = Layout.getSectionAddressSize(&SD);
1192 uint64_t FileSize = Layout.getSectionFileSize(&SD);
1193 FileSize += getPaddingSize(&SD, Layout);
1195 VMSize = std::max(VMSize, Address + Size);
1197 if (SD.getSection().isVirtualSection())
1200 SectionDataSize = std::max(SectionDataSize, Address + Size);
1201 SectionDataFileSize = std::max(SectionDataFileSize, Address + FileSize);
1204 // The section data is padded to 4 bytes.
1206 // FIXME: Is this machine dependent?
1207 unsigned SectionDataPadding = OffsetToAlignment(SectionDataFileSize, 4);
1208 SectionDataFileSize += SectionDataPadding;
1210 // Write the prolog, starting with the header and load command...
1211 WriteHeader(NumLoadCommands, LoadCommandsSize,
1212 Asm.getSubsectionsViaSymbols());
1213 WriteSegmentLoadCommand(NumSections, VMSize,
1214 SectionDataStart, SectionDataSize);
1216 // ... and then the section headers.
1217 uint64_t RelocTableEnd = SectionDataStart + SectionDataFileSize;
1218 for (MCAssembler::const_iterator it = Asm.begin(),
1219 ie = Asm.end(); it != ie; ++it) {
1220 std::vector<macho::RelocationEntry> &Relocs = Relocations[it];
1221 unsigned NumRelocs = Relocs.size();
1222 uint64_t SectionStart = SectionDataStart + getSectionAddress(it);
1223 WriteSection(Asm, Layout, *it, SectionStart, RelocTableEnd, NumRelocs);
1224 RelocTableEnd += NumRelocs * macho::RelocationInfoSize;
1227 // Write the symbol table load command, if used.
1229 unsigned FirstLocalSymbol = 0;
1230 unsigned NumLocalSymbols = LocalSymbolData.size();
1231 unsigned FirstExternalSymbol = FirstLocalSymbol + NumLocalSymbols;
1232 unsigned NumExternalSymbols = ExternalSymbolData.size();
1233 unsigned FirstUndefinedSymbol = FirstExternalSymbol + NumExternalSymbols;
1234 unsigned NumUndefinedSymbols = UndefinedSymbolData.size();
1235 unsigned NumIndirectSymbols = Asm.indirect_symbol_size();
1236 unsigned NumSymTabSymbols =
1237 NumLocalSymbols + NumExternalSymbols + NumUndefinedSymbols;
1238 uint64_t IndirectSymbolSize = NumIndirectSymbols * 4;
1239 uint64_t IndirectSymbolOffset = 0;
1241 // If used, the indirect symbols are written after the section data.
1242 if (NumIndirectSymbols)
1243 IndirectSymbolOffset = RelocTableEnd;
1245 // The symbol table is written after the indirect symbol data.
1246 uint64_t SymbolTableOffset = RelocTableEnd + IndirectSymbolSize;
1248 // The string table is written after symbol table.
1249 uint64_t StringTableOffset =
1250 SymbolTableOffset + NumSymTabSymbols * (Is64Bit ? macho::Nlist64Size :
1251 macho::Nlist32Size);
1252 WriteSymtabLoadCommand(SymbolTableOffset, NumSymTabSymbols,
1253 StringTableOffset, StringTable.size());
1255 WriteDysymtabLoadCommand(FirstLocalSymbol, NumLocalSymbols,
1256 FirstExternalSymbol, NumExternalSymbols,
1257 FirstUndefinedSymbol, NumUndefinedSymbols,
1258 IndirectSymbolOffset, NumIndirectSymbols);
1261 // Write the actual section data.
1262 for (MCAssembler::const_iterator it = Asm.begin(),
1263 ie = Asm.end(); it != ie; ++it) {
1264 Asm.WriteSectionData(it, Layout, this);
1266 uint64_t Pad = getPaddingSize(it, Layout);
1267 for (unsigned int i = 0; i < Pad; ++i)
1271 // Write the extra padding.
1272 WriteZeros(SectionDataPadding);
1274 // Write the relocation entries.
1275 for (MCAssembler::const_iterator it = Asm.begin(),
1276 ie = Asm.end(); it != ie; ++it) {
1277 // Write the section relocation entries, in reverse order to match 'as'
1278 // (approximately, the exact algorithm is more complicated than this).
1279 std::vector<macho::RelocationEntry> &Relocs = Relocations[it];
1280 for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
1281 Write32(Relocs[e - i - 1].Word0);
1282 Write32(Relocs[e - i - 1].Word1);
1286 // Write the symbol table data, if used.
1288 // Write the indirect symbol entries.
1289 for (MCAssembler::const_indirect_symbol_iterator
1290 it = Asm.indirect_symbol_begin(),
1291 ie = Asm.indirect_symbol_end(); it != ie; ++it) {
1292 // Indirect symbols in the non lazy symbol pointer section have some
1293 // special handling.
1294 const MCSectionMachO &Section =
1295 static_cast<const MCSectionMachO&>(it->SectionData->getSection());
1296 if (Section.getType() == MCSectionMachO::S_NON_LAZY_SYMBOL_POINTERS) {
1297 // If this symbol is defined and internal, mark it as such.
1298 if (it->Symbol->isDefined() &&
1299 !Asm.getSymbolData(*it->Symbol).isExternal()) {
1300 uint32_t Flags = macho::ISF_Local;
1301 if (it->Symbol->isAbsolute())
1302 Flags |= macho::ISF_Absolute;
1308 Write32(Asm.getSymbolData(*it->Symbol).getIndex());
1311 // FIXME: Check that offsets match computed ones.
1313 // Write the symbol table entries.
1314 for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
1315 WriteNlist(LocalSymbolData[i], Layout);
1316 for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
1317 WriteNlist(ExternalSymbolData[i], Layout);
1318 for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
1319 WriteNlist(UndefinedSymbolData[i], Layout);
1321 // Write the string table.
1322 OS << StringTable.str();
1329 MCObjectWriter *llvm::createMachObjectWriter(MCMachObjectTargetWriter *MOTW,
1330 raw_ostream &OS, bool is64Bit,
1332 uint32_t CPUSubtype,
1333 bool IsLittleEndian) {
1334 return new MachObjectWriter(MOTW, OS, is64Bit, CPUType, CPUSubtype,