MC/Mach-O: Fix another mismatch with .weak_definition, we shouldn't use a
[oota-llvm.git] / lib / MC / MachObjectWriter.cpp
1 //===- lib/MC/MachObjectWriter.cpp - Mach-O File 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
10 #include "llvm/MC/MachObjectWriter.h"
11 #include "llvm/ADT/StringMap.h"
12 #include "llvm/ADT/Twine.h"
13 #include "llvm/MC/MCAssembler.h"
14 #include "llvm/MC/MCAsmLayout.h"
15 #include "llvm/MC/MCExpr.h"
16 #include "llvm/MC/MCObjectWriter.h"
17 #include "llvm/MC/MCSectionMachO.h"
18 #include "llvm/MC/MCSymbol.h"
19 #include "llvm/MC/MCMachOSymbolFlags.h"
20 #include "llvm/MC/MCValue.h"
21 #include "llvm/Support/ErrorHandling.h"
22 #include "llvm/Support/MachO.h"
23 #include "llvm/Target/TargetAsmBackend.h"
24
25 // FIXME: Gross.
26 #include "../Target/X86/X86FixupKinds.h"
27
28 #include <vector>
29 using namespace llvm;
30
31 static unsigned getFixupKindLog2Size(unsigned Kind) {
32   switch (Kind) {
33   default: llvm_unreachable("invalid fixup kind!");
34   case X86::reloc_pcrel_1byte:
35   case FK_Data_1: return 0;
36   case FK_Data_2: return 1;
37   case X86::reloc_pcrel_4byte:
38   case X86::reloc_riprel_4byte:
39   case X86::reloc_riprel_4byte_movq_load:
40   case FK_Data_4: return 2;
41   case FK_Data_8: return 3;
42   }
43 }
44
45 static bool isFixupKindPCRel(unsigned Kind) {
46   switch (Kind) {
47   default:
48     return false;
49   case X86::reloc_pcrel_1byte:
50   case X86::reloc_pcrel_4byte:
51   case X86::reloc_riprel_4byte:
52   case X86::reloc_riprel_4byte_movq_load:
53     return true;
54   }
55 }
56
57 static bool isFixupKindRIPRel(unsigned Kind) {
58   return Kind == X86::reloc_riprel_4byte ||
59     Kind == X86::reloc_riprel_4byte_movq_load;
60 }
61
62 static bool doesSymbolRequireExternRelocation(MCSymbolData *SD) {
63   // Undefined symbols are always extern.
64   if (SD->Symbol->isUndefined())
65     return true;
66
67   // References to weak definitions require external relocation entries; the
68   // definition may not always be the one in the same object file.
69   if (SD->getFlags() & SF_WeakDefinition)
70     return true;
71
72   // Otherwise, we can use an internal relocation.
73   return false;
74 }
75
76 namespace {
77
78 class MachObjectWriterImpl {
79   // See <mach-o/loader.h>.
80   enum {
81     Header_Magic32 = 0xFEEDFACE,
82     Header_Magic64 = 0xFEEDFACF
83   };
84
85   enum {
86     Header32Size = 28,
87     Header64Size = 32,
88     SegmentLoadCommand32Size = 56,
89     SegmentLoadCommand64Size = 72,
90     Section32Size = 68,
91     Section64Size = 80,
92     SymtabLoadCommandSize = 24,
93     DysymtabLoadCommandSize = 80,
94     Nlist32Size = 12,
95     Nlist64Size = 16,
96     RelocationInfoSize = 8
97   };
98
99   enum HeaderFileType {
100     HFT_Object = 0x1
101   };
102
103   enum HeaderFlags {
104     HF_SubsectionsViaSymbols = 0x2000
105   };
106
107   enum LoadCommandType {
108     LCT_Segment = 0x1,
109     LCT_Symtab = 0x2,
110     LCT_Dysymtab = 0xb,
111     LCT_Segment64 = 0x19
112   };
113
114   // See <mach-o/nlist.h>.
115   enum SymbolTypeType {
116     STT_Undefined = 0x00,
117     STT_Absolute  = 0x02,
118     STT_Section   = 0x0e
119   };
120
121   enum SymbolTypeFlags {
122     // If any of these bits are set, then the entry is a stab entry number (see
123     // <mach-o/stab.h>. Otherwise the other masks apply.
124     STF_StabsEntryMask = 0xe0,
125
126     STF_TypeMask       = 0x0e,
127     STF_External       = 0x01,
128     STF_PrivateExtern  = 0x10
129   };
130
131   /// IndirectSymbolFlags - Flags for encoding special values in the indirect
132   /// symbol entry.
133   enum IndirectSymbolFlags {
134     ISF_Local    = 0x80000000,
135     ISF_Absolute = 0x40000000
136   };
137
138   /// RelocationFlags - Special flags for addresses.
139   enum RelocationFlags {
140     RF_Scattered = 0x80000000
141   };
142
143   enum RelocationInfoType {
144     RIT_Vanilla             = 0,
145     RIT_Pair                = 1,
146     RIT_Difference          = 2,
147     RIT_PreboundLazyPointer = 3,
148     RIT_LocalDifference     = 4
149   };
150
151   /// X86_64 uses its own relocation types.
152   enum RelocationInfoTypeX86_64 {
153     RIT_X86_64_Unsigned   = 0,
154     RIT_X86_64_Signed     = 1,
155     RIT_X86_64_Branch     = 2,
156     RIT_X86_64_GOTLoad    = 3,
157     RIT_X86_64_GOT        = 4,
158     RIT_X86_64_Subtractor = 5,
159     RIT_X86_64_Signed1    = 6,
160     RIT_X86_64_Signed2    = 7,
161     RIT_X86_64_Signed4    = 8
162   };
163
164   /// MachSymbolData - Helper struct for containing some precomputed information
165   /// on symbols.
166   struct MachSymbolData {
167     MCSymbolData *SymbolData;
168     uint64_t StringIndex;
169     uint8_t SectionIndex;
170
171     // Support lexicographic sorting.
172     bool operator<(const MachSymbolData &RHS) const {
173       const std::string &Name = SymbolData->getSymbol().getName();
174       return Name < RHS.SymbolData->getSymbol().getName();
175     }
176   };
177
178   /// @name Relocation Data
179   /// @{
180
181   struct MachRelocationEntry {
182     uint32_t Word0;
183     uint32_t Word1;
184   };
185
186   llvm::DenseMap<const MCSectionData*,
187                  std::vector<MachRelocationEntry> > Relocations;
188
189   /// @}
190   /// @name Symbol Table Data
191   /// @{
192
193   SmallString<256> StringTable;
194   std::vector<MachSymbolData> LocalSymbolData;
195   std::vector<MachSymbolData> ExternalSymbolData;
196   std::vector<MachSymbolData> UndefinedSymbolData;
197
198   /// @}
199
200   MachObjectWriter *Writer;
201
202   raw_ostream &OS;
203
204   unsigned Is64Bit : 1;
205
206 public:
207   MachObjectWriterImpl(MachObjectWriter *_Writer, bool _Is64Bit)
208     : Writer(_Writer), OS(Writer->getStream()), Is64Bit(_Is64Bit) {
209   }
210
211   void Write8(uint8_t Value) { Writer->Write8(Value); }
212   void Write16(uint16_t Value) { Writer->Write16(Value); }
213   void Write32(uint32_t Value) { Writer->Write32(Value); }
214   void Write64(uint64_t Value) { Writer->Write64(Value); }
215   void WriteZeros(unsigned N) { Writer->WriteZeros(N); }
216   void WriteBytes(StringRef Str, unsigned ZeroFillSize = 0) {
217     Writer->WriteBytes(Str, ZeroFillSize);
218   }
219
220   void WriteHeader(unsigned NumLoadCommands, unsigned LoadCommandsSize,
221                    bool SubsectionsViaSymbols) {
222     uint32_t Flags = 0;
223
224     if (SubsectionsViaSymbols)
225       Flags |= HF_SubsectionsViaSymbols;
226
227     // struct mach_header (28 bytes) or
228     // struct mach_header_64 (32 bytes)
229
230     uint64_t Start = OS.tell();
231     (void) Start;
232
233     Write32(Is64Bit ? Header_Magic64 : Header_Magic32);
234
235     // FIXME: Support cputype.
236     Write32(Is64Bit ? MachO::CPUTypeX86_64 : MachO::CPUTypeI386);
237     // FIXME: Support cpusubtype.
238     Write32(MachO::CPUSubType_I386_ALL);
239     Write32(HFT_Object);
240     Write32(NumLoadCommands);    // Object files have a single load command, the
241                                  // segment.
242     Write32(LoadCommandsSize);
243     Write32(Flags);
244     if (Is64Bit)
245       Write32(0); // reserved
246
247     assert(OS.tell() - Start == Is64Bit ? Header64Size : Header32Size);
248   }
249
250   /// WriteSegmentLoadCommand - Write a segment load command.
251   ///
252   /// \arg NumSections - The number of sections in this segment.
253   /// \arg SectionDataSize - The total size of the sections.
254   void WriteSegmentLoadCommand(unsigned NumSections,
255                                uint64_t VMSize,
256                                uint64_t SectionDataStartOffset,
257                                uint64_t SectionDataSize) {
258     // struct segment_command (56 bytes) or
259     // struct segment_command_64 (72 bytes)
260
261     uint64_t Start = OS.tell();
262     (void) Start;
263
264     unsigned SegmentLoadCommandSize = Is64Bit ? SegmentLoadCommand64Size :
265       SegmentLoadCommand32Size;
266     Write32(Is64Bit ? LCT_Segment64 : LCT_Segment);
267     Write32(SegmentLoadCommandSize +
268             NumSections * (Is64Bit ? Section64Size : Section32Size));
269
270     WriteBytes("", 16);
271     if (Is64Bit) {
272       Write64(0); // vmaddr
273       Write64(VMSize); // vmsize
274       Write64(SectionDataStartOffset); // file offset
275       Write64(SectionDataSize); // file size
276     } else {
277       Write32(0); // vmaddr
278       Write32(VMSize); // vmsize
279       Write32(SectionDataStartOffset); // file offset
280       Write32(SectionDataSize); // file size
281     }
282     Write32(0x7); // maxprot
283     Write32(0x7); // initprot
284     Write32(NumSections);
285     Write32(0); // flags
286
287     assert(OS.tell() - Start == SegmentLoadCommandSize);
288   }
289
290   void WriteSection(const MCAssembler &Asm, const MCAsmLayout &Layout,
291                     const MCSectionData &SD, uint64_t FileOffset,
292                     uint64_t RelocationsStart, unsigned NumRelocations) {
293     uint64_t SectionSize = Layout.getSectionSize(&SD);
294
295     // The offset is unused for virtual sections.
296     if (Asm.getBackend().isVirtualSection(SD.getSection())) {
297       assert(Layout.getSectionFileSize(&SD) == 0 && "Invalid file size!");
298       FileOffset = 0;
299     }
300
301     // struct section (68 bytes) or
302     // struct section_64 (80 bytes)
303
304     uint64_t Start = OS.tell();
305     (void) Start;
306
307     // FIXME: cast<> support!
308     const MCSectionMachO &Section =
309       static_cast<const MCSectionMachO&>(SD.getSection());
310     WriteBytes(Section.getSectionName(), 16);
311     WriteBytes(Section.getSegmentName(), 16);
312     if (Is64Bit) {
313       Write64(Layout.getSectionAddress(&SD)); // address
314       Write64(SectionSize); // size
315     } else {
316       Write32(Layout.getSectionAddress(&SD)); // address
317       Write32(SectionSize); // size
318     }
319     Write32(FileOffset);
320
321     unsigned Flags = Section.getTypeAndAttributes();
322     if (SD.hasInstructions())
323       Flags |= MCSectionMachO::S_ATTR_SOME_INSTRUCTIONS;
324
325     assert(isPowerOf2_32(SD.getAlignment()) && "Invalid alignment!");
326     Write32(Log2_32(SD.getAlignment()));
327     Write32(NumRelocations ? RelocationsStart : 0);
328     Write32(NumRelocations);
329     Write32(Flags);
330     Write32(0); // reserved1
331     Write32(Section.getStubSize()); // reserved2
332     if (Is64Bit)
333       Write32(0); // reserved3
334
335     assert(OS.tell() - Start == Is64Bit ? Section64Size : Section32Size);
336   }
337
338   void WriteSymtabLoadCommand(uint32_t SymbolOffset, uint32_t NumSymbols,
339                               uint32_t StringTableOffset,
340                               uint32_t StringTableSize) {
341     // struct symtab_command (24 bytes)
342
343     uint64_t Start = OS.tell();
344     (void) Start;
345
346     Write32(LCT_Symtab);
347     Write32(SymtabLoadCommandSize);
348     Write32(SymbolOffset);
349     Write32(NumSymbols);
350     Write32(StringTableOffset);
351     Write32(StringTableSize);
352
353     assert(OS.tell() - Start == SymtabLoadCommandSize);
354   }
355
356   void WriteDysymtabLoadCommand(uint32_t FirstLocalSymbol,
357                                 uint32_t NumLocalSymbols,
358                                 uint32_t FirstExternalSymbol,
359                                 uint32_t NumExternalSymbols,
360                                 uint32_t FirstUndefinedSymbol,
361                                 uint32_t NumUndefinedSymbols,
362                                 uint32_t IndirectSymbolOffset,
363                                 uint32_t NumIndirectSymbols) {
364     // struct dysymtab_command (80 bytes)
365
366     uint64_t Start = OS.tell();
367     (void) Start;
368
369     Write32(LCT_Dysymtab);
370     Write32(DysymtabLoadCommandSize);
371     Write32(FirstLocalSymbol);
372     Write32(NumLocalSymbols);
373     Write32(FirstExternalSymbol);
374     Write32(NumExternalSymbols);
375     Write32(FirstUndefinedSymbol);
376     Write32(NumUndefinedSymbols);
377     Write32(0); // tocoff
378     Write32(0); // ntoc
379     Write32(0); // modtaboff
380     Write32(0); // nmodtab
381     Write32(0); // extrefsymoff
382     Write32(0); // nextrefsyms
383     Write32(IndirectSymbolOffset);
384     Write32(NumIndirectSymbols);
385     Write32(0); // extreloff
386     Write32(0); // nextrel
387     Write32(0); // locreloff
388     Write32(0); // nlocrel
389
390     assert(OS.tell() - Start == DysymtabLoadCommandSize);
391   }
392
393   void WriteNlist(MachSymbolData &MSD, const MCAsmLayout &Layout) {
394     MCSymbolData &Data = *MSD.SymbolData;
395     const MCSymbol &Symbol = Data.getSymbol();
396     uint8_t Type = 0;
397     uint16_t Flags = Data.getFlags();
398     uint32_t Address = 0;
399
400     // Set the N_TYPE bits. See <mach-o/nlist.h>.
401     //
402     // FIXME: Are the prebound or indirect fields possible here?
403     if (Symbol.isUndefined())
404       Type = STT_Undefined;
405     else if (Symbol.isAbsolute())
406       Type = STT_Absolute;
407     else
408       Type = STT_Section;
409
410     // FIXME: Set STAB bits.
411
412     if (Data.isPrivateExtern())
413       Type |= STF_PrivateExtern;
414
415     // Set external bit.
416     if (Data.isExternal() || Symbol.isUndefined())
417       Type |= STF_External;
418
419     // Compute the symbol address.
420     if (Symbol.isDefined()) {
421       if (Symbol.isAbsolute()) {
422         Address = cast<MCConstantExpr>(Symbol.getVariableValue())->getValue();
423       } else {
424         Address = Layout.getSymbolAddress(&Data);
425       }
426     } else if (Data.isCommon()) {
427       // Common symbols are encoded with the size in the address
428       // field, and their alignment in the flags.
429       Address = Data.getCommonSize();
430
431       // Common alignment is packed into the 'desc' bits.
432       if (unsigned Align = Data.getCommonAlignment()) {
433         unsigned Log2Size = Log2_32(Align);
434         assert((1U << Log2Size) == Align && "Invalid 'common' alignment!");
435         if (Log2Size > 15)
436           report_fatal_error("invalid 'common' alignment '" +
437                             Twine(Align) + "'");
438         // FIXME: Keep this mask with the SymbolFlags enumeration.
439         Flags = (Flags & 0xF0FF) | (Log2Size << 8);
440       }
441     }
442
443     // struct nlist (12 bytes)
444
445     Write32(MSD.StringIndex);
446     Write8(Type);
447     Write8(MSD.SectionIndex);
448
449     // The Mach-O streamer uses the lowest 16-bits of the flags for the 'desc'
450     // value.
451     Write16(Flags);
452     if (Is64Bit)
453       Write64(Address);
454     else
455       Write32(Address);
456   }
457
458   // FIXME: We really need to improve the relocation validation. Basically, we
459   // want to implement a separate computation which evaluates the relocation
460   // entry as the linker would, and verifies that the resultant fixup value is
461   // exactly what the encoder wanted. This will catch several classes of
462   // problems:
463   //
464   //  - Relocation entry bugs, the two algorithms are unlikely to have the same
465   //    exact bug.
466   //
467   //  - Relaxation issues, where we forget to relax something.
468   //
469   //  - Input errors, where something cannot be correctly encoded. 'as' allows
470   //    these through in many cases.
471
472   void RecordX86_64Relocation(const MCAssembler &Asm, const MCAsmLayout &Layout,
473                               const MCFragment *Fragment,
474                               const MCAsmFixup &Fixup, MCValue Target,
475                               uint64_t &FixedValue) {
476     unsigned IsPCRel = isFixupKindPCRel(Fixup.Kind);
477     unsigned IsRIPRel = isFixupKindRIPRel(Fixup.Kind);
478     unsigned Log2Size = getFixupKindLog2Size(Fixup.Kind);
479
480     // See <reloc.h>.
481     uint32_t Address = Layout.getFragmentOffset(Fragment) + Fixup.Offset;
482     int64_t Value = 0;
483     unsigned Index = 0;
484     unsigned IsExtern = 0;
485     unsigned Type = 0;
486
487     Value = Target.getConstant();
488
489     if (IsPCRel) {
490       // Compensate for the relocation offset, Darwin x86_64 relocations only
491       // have the addend and appear to have attempted to define it to be the
492       // actual expression addend without the PCrel bias. However, instructions
493       // with data following the relocation are not accomodated for (see comment
494       // below regarding SIGNED{1,2,4}), so it isn't exactly that either.
495       Value += 1LL << Log2Size;
496     }
497
498     if (Target.isAbsolute()) { // constant
499       // SymbolNum of 0 indicates the absolute section.
500       Type = RIT_X86_64_Unsigned;
501       Index = 0;
502
503       // FIXME: I believe this is broken, I don't think the linker can
504       // understand it. I think it would require a local relocation, but I'm not
505       // sure if that would work either. The official way to get an absolute
506       // PCrel relocation is to use an absolute symbol (which we don't support
507       // yet).
508       if (IsPCRel) {
509         IsExtern = 1;
510         Type = RIT_X86_64_Branch;
511       }
512     } else if (Target.getSymB()) { // A - B + constant
513       const MCSymbol *A = &Target.getSymA()->getSymbol();
514       MCSymbolData &A_SD = Asm.getSymbolData(*A);
515       const MCSymbolData *A_Base = Asm.getAtom(Layout, &A_SD);
516
517       const MCSymbol *B = &Target.getSymB()->getSymbol();
518       MCSymbolData &B_SD = Asm.getSymbolData(*B);
519       const MCSymbolData *B_Base = Asm.getAtom(Layout, &B_SD);
520
521       // Neither symbol can be modified.
522       if (Target.getSymA()->getKind() != MCSymbolRefExpr::VK_None ||
523           Target.getSymB()->getKind() != MCSymbolRefExpr::VK_None)
524         report_fatal_error("unsupported relocation of modified symbol");
525
526       // We don't support PCrel relocations of differences. Darwin 'as' doesn't
527       // implement most of these correctly.
528       if (IsPCRel)
529         report_fatal_error("unsupported pc-relative relocation of difference");
530
531       // We don't currently support any situation where one or both of the
532       // symbols would require a local relocation. This is almost certainly
533       // unused and may not be possible to encode correctly.
534       if (!A_Base || !B_Base)
535         report_fatal_error("unsupported local relocations in difference");
536
537       // Darwin 'as' doesn't emit correct relocations for this (it ends up with
538       // a single SIGNED relocation); reject it for now.
539       if (A_Base == B_Base)
540         report_fatal_error("unsupported relocation with identical base");
541
542       Value += Layout.getSymbolAddress(&A_SD) - Layout.getSymbolAddress(A_Base);
543       Value -= Layout.getSymbolAddress(&B_SD) - Layout.getSymbolAddress(B_Base);
544
545       Index = A_Base->getIndex();
546       IsExtern = 1;
547       Type = RIT_X86_64_Unsigned;
548
549       MachRelocationEntry MRE;
550       MRE.Word0 = Address;
551       MRE.Word1 = ((Index     <<  0) |
552                    (IsPCRel   << 24) |
553                    (Log2Size  << 25) |
554                    (IsExtern  << 27) |
555                    (Type      << 28));
556       Relocations[Fragment->getParent()].push_back(MRE);
557
558       Index = B_Base->getIndex();
559       IsExtern = 1;
560       Type = RIT_X86_64_Subtractor;
561     } else {
562       const MCSymbol *Symbol = &Target.getSymA()->getSymbol();
563       MCSymbolData &SD = Asm.getSymbolData(*Symbol);
564       const MCSymbolData *Base = Asm.getAtom(Layout, &SD);
565
566       // Relocations inside debug sections always use local relocations when
567       // possible. This seems to be done because the debugger doesn't fully
568       // understand x86_64 relocation entries, and expects to find values that
569       // have already been fixed up.
570       if (Symbol->isInSection()) {
571         const MCSectionMachO &Section = static_cast<const MCSectionMachO&>(
572           Fragment->getParent()->getSection());
573         if (Section.hasAttribute(MCSectionMachO::S_ATTR_DEBUG))
574           Base = 0;
575       }
576
577       // x86_64 almost always uses external relocations, except when there is no
578       // symbol to use as a base address (a local symbol with no preceeding
579       // non-local symbol).
580       if (Base) {
581         Index = Base->getIndex();
582         IsExtern = 1;
583
584         // Add the local offset, if needed.
585         if (Base != &SD)
586           Value += Layout.getSymbolAddress(&SD) - Layout.getSymbolAddress(Base);
587       } else {
588         // The index is the section ordinal (1-based).
589         Index = SD.getFragment()->getParent()->getOrdinal() + 1;
590         IsExtern = 0;
591         Value += Layout.getSymbolAddress(&SD);
592
593         if (IsPCRel)
594           Value -= Address + (1 << Log2Size);
595       }
596
597       MCSymbolRefExpr::VariantKind Modifier = Target.getSymA()->getKind();
598       if (IsPCRel) {
599         if (IsRIPRel) {
600           if (Modifier == MCSymbolRefExpr::VK_GOTPCREL) {
601             // x86_64 distinguishes movq foo@GOTPCREL so that the linker can
602             // rewrite the movq to an leaq at link time if the symbol ends up in
603             // the same linkage unit.
604             if (unsigned(Fixup.Kind) == X86::reloc_riprel_4byte_movq_load)
605               Type = RIT_X86_64_GOTLoad;
606             else
607               Type = RIT_X86_64_GOT;
608           } else if (Modifier != MCSymbolRefExpr::VK_None)
609             report_fatal_error("unsupported symbol modifier in relocation");
610           else
611             Type = RIT_X86_64_Signed;
612         } else {
613           if (Modifier != MCSymbolRefExpr::VK_None)
614             report_fatal_error("unsupported symbol modifier in branch "
615                               "relocation");
616
617           Type = RIT_X86_64_Branch;
618         }
619
620         // The Darwin x86_64 relocation format has a problem where it cannot
621         // encode an address (L<foo> + <constant>) which is outside the atom
622         // containing L<foo>. Generally, this shouldn't occur but it does happen
623         // when we have a RIPrel instruction with data following the relocation
624         // entry (e.g., movb $012, L0(%rip)). Even with the PCrel adjustment
625         // Darwin x86_64 uses, the offset is still negative and the linker has
626         // no way to recognize this.
627         //
628         // To work around this, Darwin uses several special relocation types to
629         // indicate the offsets. However, the specification or implementation of
630         // these seems to also be incomplete; they should adjust the addend as
631         // well based on the actual encoded instruction (the additional bias),
632         // but instead appear to just look at the final offset.
633         if (IsRIPRel) {
634           switch (-(Target.getConstant() + (1LL << Log2Size))) {
635           case 1: Type = RIT_X86_64_Signed1; break;
636           case 2: Type = RIT_X86_64_Signed2; break;
637           case 4: Type = RIT_X86_64_Signed4; break;
638           }
639         }
640       } else {
641         if (Modifier == MCSymbolRefExpr::VK_GOT) {
642           Type = RIT_X86_64_GOT;
643         } else if (Modifier == MCSymbolRefExpr::VK_GOTPCREL) {
644           // GOTPCREL is allowed as a modifier on non-PCrel instructions, in
645           // which case all we do is set the PCrel bit in the relocation entry;
646           // this is used with exception handling, for example. The source is
647           // required to include any necessary offset directly.
648           Type = RIT_X86_64_GOT;
649           IsPCRel = 1;
650         } else if (Modifier != MCSymbolRefExpr::VK_None)
651           report_fatal_error("unsupported symbol modifier in relocation");
652         else
653           Type = RIT_X86_64_Unsigned;
654       }
655     }
656
657     // x86_64 always writes custom values into the fixups.
658     FixedValue = Value;
659
660     // struct relocation_info (8 bytes)
661     MachRelocationEntry MRE;
662     MRE.Word0 = Address;
663     MRE.Word1 = ((Index     <<  0) |
664                  (IsPCRel   << 24) |
665                  (Log2Size  << 25) |
666                  (IsExtern  << 27) |
667                  (Type      << 28));
668     Relocations[Fragment->getParent()].push_back(MRE);
669   }
670
671   void RecordScatteredRelocation(const MCAssembler &Asm,
672                                  const MCAsmLayout &Layout,
673                                  const MCFragment *Fragment,
674                                  const MCAsmFixup &Fixup, MCValue Target,
675                                  uint64_t &FixedValue) {
676     uint32_t Address = Layout.getFragmentOffset(Fragment) + Fixup.Offset;
677     unsigned IsPCRel = isFixupKindPCRel(Fixup.Kind);
678     unsigned Log2Size = getFixupKindLog2Size(Fixup.Kind);
679     unsigned Type = RIT_Vanilla;
680
681     // See <reloc.h>.
682     const MCSymbol *A = &Target.getSymA()->getSymbol();
683     MCSymbolData *A_SD = &Asm.getSymbolData(*A);
684
685     if (!A_SD->getFragment())
686       report_fatal_error("symbol '" + A->getName() +
687                         "' can not be undefined in a subtraction expression");
688
689     uint32_t Value = Layout.getSymbolAddress(A_SD);
690     uint32_t Value2 = 0;
691
692     if (const MCSymbolRefExpr *B = Target.getSymB()) {
693       MCSymbolData *B_SD = &Asm.getSymbolData(B->getSymbol());
694
695       if (!B_SD->getFragment())
696         report_fatal_error("symbol '" + B->getSymbol().getName() +
697                           "' can not be undefined in a subtraction expression");
698
699       // Select the appropriate difference relocation type.
700       //
701       // Note that there is no longer any semantic difference between these two
702       // relocation types from the linkers point of view, this is done solely
703       // for pedantic compatibility with 'as'.
704       Type = A_SD->isExternal() ? RIT_Difference : RIT_LocalDifference;
705       Value2 = Layout.getSymbolAddress(B_SD);
706     }
707
708     // Relocations are written out in reverse order, so the PAIR comes first.
709     if (Type == RIT_Difference || Type == RIT_LocalDifference) {
710       MachRelocationEntry MRE;
711       MRE.Word0 = ((0         <<  0) |
712                    (RIT_Pair  << 24) |
713                    (Log2Size  << 28) |
714                    (IsPCRel   << 30) |
715                    RF_Scattered);
716       MRE.Word1 = Value2;
717       Relocations[Fragment->getParent()].push_back(MRE);
718     }
719
720     MachRelocationEntry MRE;
721     MRE.Word0 = ((Address   <<  0) |
722                  (Type      << 24) |
723                  (Log2Size  << 28) |
724                  (IsPCRel   << 30) |
725                  RF_Scattered);
726     MRE.Word1 = Value;
727     Relocations[Fragment->getParent()].push_back(MRE);
728   }
729
730   void RecordRelocation(const MCAssembler &Asm, const MCAsmLayout &Layout,
731                         const MCFragment *Fragment, const MCAsmFixup &Fixup,
732                         MCValue Target, uint64_t &FixedValue) {
733     if (Is64Bit) {
734       RecordX86_64Relocation(Asm, Layout, Fragment, Fixup, Target, FixedValue);
735       return;
736     }
737
738     unsigned IsPCRel = isFixupKindPCRel(Fixup.Kind);
739     unsigned Log2Size = getFixupKindLog2Size(Fixup.Kind);
740
741     // If this is a difference or a defined symbol plus an offset, then we need
742     // a scattered relocation entry.
743     // Differences always require scattered relocations.
744     if (Target.getSymB())
745         return RecordScatteredRelocation(Asm, Layout, Fragment, Fixup,
746                                          Target, FixedValue);
747
748     // Get the symbol data, if any.
749     MCSymbolData *SD = 0;
750     if (Target.getSymA())
751       SD = &Asm.getSymbolData(Target.getSymA()->getSymbol());
752
753     // If this is an internal relocation with an offset, it also needs a
754     // scattered relocation entry.
755     uint32_t Offset = Target.getConstant();
756     if (IsPCRel)
757       Offset += 1 << Log2Size;
758     if (Offset && SD && !doesSymbolRequireExternRelocation(SD))
759       return RecordScatteredRelocation(Asm, Layout, Fragment, Fixup,
760                                        Target, FixedValue);
761
762     // See <reloc.h>.
763     uint32_t Address = Layout.getFragmentOffset(Fragment) + Fixup.Offset;
764     uint32_t Value = 0;
765     unsigned Index = 0;
766     unsigned IsExtern = 0;
767     unsigned Type = 0;
768
769     if (Target.isAbsolute()) { // constant
770       // SymbolNum of 0 indicates the absolute section.
771       //
772       // FIXME: Currently, these are never generated (see code below). I cannot
773       // find a case where they are actually emitted.
774       Type = RIT_Vanilla;
775       Value = 0;
776     } else {
777       // Check whether we need an external or internal relocation.
778       if (doesSymbolRequireExternRelocation(SD)) {
779         IsExtern = 1;
780         Index = SD->getIndex();
781         // For external relocations, make sure to offset the fixup value to
782         // compensate for the addend of the symbol address, if it was
783         // undefined. This occurs with weak definitions, for example.
784         if (!SD->Symbol->isUndefined())
785           FixedValue -= Layout.getSymbolAddress(SD);
786         Value = 0;
787       } else {
788         // The index is the section ordinal (1-based).
789         Index = SD->getFragment()->getParent()->getOrdinal() + 1;
790         Value = Layout.getSymbolAddress(SD);
791       }
792
793       Type = RIT_Vanilla;
794     }
795
796     // struct relocation_info (8 bytes)
797     MachRelocationEntry MRE;
798     MRE.Word0 = Address;
799     MRE.Word1 = ((Index     <<  0) |
800                  (IsPCRel   << 24) |
801                  (Log2Size  << 25) |
802                  (IsExtern  << 27) |
803                  (Type      << 28));
804     Relocations[Fragment->getParent()].push_back(MRE);
805   }
806
807   void BindIndirectSymbols(MCAssembler &Asm) {
808     // This is the point where 'as' creates actual symbols for indirect symbols
809     // (in the following two passes). It would be easier for us to do this
810     // sooner when we see the attribute, but that makes getting the order in the
811     // symbol table much more complicated than it is worth.
812     //
813     // FIXME: Revisit this when the dust settles.
814
815     // Bind non lazy symbol pointers first.
816     for (MCAssembler::indirect_symbol_iterator it = Asm.indirect_symbol_begin(),
817            ie = Asm.indirect_symbol_end(); it != ie; ++it) {
818       // FIXME: cast<> support!
819       const MCSectionMachO &Section =
820         static_cast<const MCSectionMachO&>(it->SectionData->getSection());
821
822       if (Section.getType() != MCSectionMachO::S_NON_LAZY_SYMBOL_POINTERS)
823         continue;
824
825       Asm.getOrCreateSymbolData(*it->Symbol);
826     }
827
828     // Then lazy symbol pointers and symbol stubs.
829     for (MCAssembler::indirect_symbol_iterator it = Asm.indirect_symbol_begin(),
830            ie = Asm.indirect_symbol_end(); it != ie; ++it) {
831       // FIXME: cast<> support!
832       const MCSectionMachO &Section =
833         static_cast<const MCSectionMachO&>(it->SectionData->getSection());
834
835       if (Section.getType() != MCSectionMachO::S_LAZY_SYMBOL_POINTERS &&
836           Section.getType() != MCSectionMachO::S_SYMBOL_STUBS)
837         continue;
838
839       // Set the symbol type to undefined lazy, but only on construction.
840       //
841       // FIXME: Do not hardcode.
842       bool Created;
843       MCSymbolData &Entry = Asm.getOrCreateSymbolData(*it->Symbol, &Created);
844       if (Created)
845         Entry.setFlags(Entry.getFlags() | 0x0001);
846     }
847   }
848
849   /// ComputeSymbolTable - Compute the symbol table data
850   ///
851   /// \param StringTable [out] - The string table data.
852   /// \param StringIndexMap [out] - Map from symbol names to offsets in the
853   /// string table.
854   void ComputeSymbolTable(MCAssembler &Asm, SmallString<256> &StringTable,
855                           std::vector<MachSymbolData> &LocalSymbolData,
856                           std::vector<MachSymbolData> &ExternalSymbolData,
857                           std::vector<MachSymbolData> &UndefinedSymbolData) {
858     // Build section lookup table.
859     DenseMap<const MCSection*, uint8_t> SectionIndexMap;
860     unsigned Index = 1;
861     for (MCAssembler::iterator it = Asm.begin(),
862            ie = Asm.end(); it != ie; ++it, ++Index)
863       SectionIndexMap[&it->getSection()] = Index;
864     assert(Index <= 256 && "Too many sections!");
865
866     // Index 0 is always the empty string.
867     StringMap<uint64_t> StringIndexMap;
868     StringTable += '\x00';
869
870     // Build the symbol arrays and the string table, but only for non-local
871     // symbols.
872     //
873     // The particular order that we collect the symbols and create the string
874     // table, then sort the symbols is chosen to match 'as'. Even though it
875     // doesn't matter for correctness, this is important for letting us diff .o
876     // files.
877     for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
878            ie = Asm.symbol_end(); it != ie; ++it) {
879       const MCSymbol &Symbol = it->getSymbol();
880
881       // Ignore non-linker visible symbols.
882       if (!Asm.isSymbolLinkerVisible(it))
883         continue;
884
885       if (!it->isExternal() && !Symbol.isUndefined())
886         continue;
887
888       uint64_t &Entry = StringIndexMap[Symbol.getName()];
889       if (!Entry) {
890         Entry = StringTable.size();
891         StringTable += Symbol.getName();
892         StringTable += '\x00';
893       }
894
895       MachSymbolData MSD;
896       MSD.SymbolData = it;
897       MSD.StringIndex = Entry;
898
899       if (Symbol.isUndefined()) {
900         MSD.SectionIndex = 0;
901         UndefinedSymbolData.push_back(MSD);
902       } else if (Symbol.isAbsolute()) {
903         MSD.SectionIndex = 0;
904         ExternalSymbolData.push_back(MSD);
905       } else {
906         MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
907         assert(MSD.SectionIndex && "Invalid section index!");
908         ExternalSymbolData.push_back(MSD);
909       }
910     }
911
912     // Now add the data for local symbols.
913     for (MCAssembler::symbol_iterator it = Asm.symbol_begin(),
914            ie = Asm.symbol_end(); it != ie; ++it) {
915       const MCSymbol &Symbol = it->getSymbol();
916
917       // Ignore non-linker visible symbols.
918       if (!Asm.isSymbolLinkerVisible(it))
919         continue;
920
921       if (it->isExternal() || Symbol.isUndefined())
922         continue;
923
924       uint64_t &Entry = StringIndexMap[Symbol.getName()];
925       if (!Entry) {
926         Entry = StringTable.size();
927         StringTable += Symbol.getName();
928         StringTable += '\x00';
929       }
930
931       MachSymbolData MSD;
932       MSD.SymbolData = it;
933       MSD.StringIndex = Entry;
934
935       if (Symbol.isAbsolute()) {
936         MSD.SectionIndex = 0;
937         LocalSymbolData.push_back(MSD);
938       } else {
939         MSD.SectionIndex = SectionIndexMap.lookup(&Symbol.getSection());
940         assert(MSD.SectionIndex && "Invalid section index!");
941         LocalSymbolData.push_back(MSD);
942       }
943     }
944
945     // External and undefined symbols are required to be in lexicographic order.
946     std::sort(ExternalSymbolData.begin(), ExternalSymbolData.end());
947     std::sort(UndefinedSymbolData.begin(), UndefinedSymbolData.end());
948
949     // Set the symbol indices.
950     Index = 0;
951     for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
952       LocalSymbolData[i].SymbolData->setIndex(Index++);
953     for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
954       ExternalSymbolData[i].SymbolData->setIndex(Index++);
955     for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
956       UndefinedSymbolData[i].SymbolData->setIndex(Index++);
957
958     // The string table is padded to a multiple of 4.
959     while (StringTable.size() % 4)
960       StringTable += '\x00';
961   }
962
963   void ExecutePostLayoutBinding(MCAssembler &Asm) {
964     // Create symbol data for any indirect symbols.
965     BindIndirectSymbols(Asm);
966
967     // Compute symbol table information and bind symbol indices.
968     ComputeSymbolTable(Asm, StringTable, LocalSymbolData, ExternalSymbolData,
969                        UndefinedSymbolData);
970   }
971
972   void WriteObject(const MCAssembler &Asm, const MCAsmLayout &Layout) {
973     unsigned NumSections = Asm.size();
974
975     // The section data starts after the header, the segment load command (and
976     // section headers) and the symbol table.
977     unsigned NumLoadCommands = 1;
978     uint64_t LoadCommandsSize = Is64Bit ?
979       SegmentLoadCommand64Size + NumSections * Section64Size :
980       SegmentLoadCommand32Size + NumSections * Section32Size;
981
982     // Add the symbol table load command sizes, if used.
983     unsigned NumSymbols = LocalSymbolData.size() + ExternalSymbolData.size() +
984       UndefinedSymbolData.size();
985     if (NumSymbols) {
986       NumLoadCommands += 2;
987       LoadCommandsSize += SymtabLoadCommandSize + DysymtabLoadCommandSize;
988     }
989
990     // Compute the total size of the section data, as well as its file size and
991     // vm size.
992     uint64_t SectionDataStart = (Is64Bit ? Header64Size : Header32Size)
993       + LoadCommandsSize;
994     uint64_t SectionDataSize = 0;
995     uint64_t SectionDataFileSize = 0;
996     uint64_t VMSize = 0;
997     for (MCAssembler::const_iterator it = Asm.begin(),
998            ie = Asm.end(); it != ie; ++it) {
999       const MCSectionData &SD = *it;
1000       uint64_t Address = Layout.getSectionAddress(&SD);
1001       uint64_t Size = Layout.getSectionSize(&SD);
1002       uint64_t FileSize = Layout.getSectionFileSize(&SD);
1003
1004       VMSize = std::max(VMSize, Address + Size);
1005
1006       if (Asm.getBackend().isVirtualSection(SD.getSection()))
1007         continue;
1008
1009       SectionDataSize = std::max(SectionDataSize, Address + Size);
1010       SectionDataFileSize = std::max(SectionDataFileSize, Address + FileSize);
1011     }
1012
1013     // The section data is padded to 4 bytes.
1014     //
1015     // FIXME: Is this machine dependent?
1016     unsigned SectionDataPadding = OffsetToAlignment(SectionDataFileSize, 4);
1017     SectionDataFileSize += SectionDataPadding;
1018
1019     // Write the prolog, starting with the header and load command...
1020     WriteHeader(NumLoadCommands, LoadCommandsSize,
1021                 Asm.getSubsectionsViaSymbols());
1022     WriteSegmentLoadCommand(NumSections, VMSize,
1023                             SectionDataStart, SectionDataSize);
1024
1025     // ... and then the section headers.
1026     uint64_t RelocTableEnd = SectionDataStart + SectionDataFileSize;
1027     for (MCAssembler::const_iterator it = Asm.begin(),
1028            ie = Asm.end(); it != ie; ++it) {
1029       std::vector<MachRelocationEntry> &Relocs = Relocations[it];
1030       unsigned NumRelocs = Relocs.size();
1031       uint64_t SectionStart = SectionDataStart + Layout.getSectionAddress(it);
1032       WriteSection(Asm, Layout, *it, SectionStart, RelocTableEnd, NumRelocs);
1033       RelocTableEnd += NumRelocs * RelocationInfoSize;
1034     }
1035
1036     // Write the symbol table load command, if used.
1037     if (NumSymbols) {
1038       unsigned FirstLocalSymbol = 0;
1039       unsigned NumLocalSymbols = LocalSymbolData.size();
1040       unsigned FirstExternalSymbol = FirstLocalSymbol + NumLocalSymbols;
1041       unsigned NumExternalSymbols = ExternalSymbolData.size();
1042       unsigned FirstUndefinedSymbol = FirstExternalSymbol + NumExternalSymbols;
1043       unsigned NumUndefinedSymbols = UndefinedSymbolData.size();
1044       unsigned NumIndirectSymbols = Asm.indirect_symbol_size();
1045       unsigned NumSymTabSymbols =
1046         NumLocalSymbols + NumExternalSymbols + NumUndefinedSymbols;
1047       uint64_t IndirectSymbolSize = NumIndirectSymbols * 4;
1048       uint64_t IndirectSymbolOffset = 0;
1049
1050       // If used, the indirect symbols are written after the section data.
1051       if (NumIndirectSymbols)
1052         IndirectSymbolOffset = RelocTableEnd;
1053
1054       // The symbol table is written after the indirect symbol data.
1055       uint64_t SymbolTableOffset = RelocTableEnd + IndirectSymbolSize;
1056
1057       // The string table is written after symbol table.
1058       uint64_t StringTableOffset =
1059         SymbolTableOffset + NumSymTabSymbols * (Is64Bit ? Nlist64Size :
1060                                                 Nlist32Size);
1061       WriteSymtabLoadCommand(SymbolTableOffset, NumSymTabSymbols,
1062                              StringTableOffset, StringTable.size());
1063
1064       WriteDysymtabLoadCommand(FirstLocalSymbol, NumLocalSymbols,
1065                                FirstExternalSymbol, NumExternalSymbols,
1066                                FirstUndefinedSymbol, NumUndefinedSymbols,
1067                                IndirectSymbolOffset, NumIndirectSymbols);
1068     }
1069
1070     // Write the actual section data.
1071     for (MCAssembler::const_iterator it = Asm.begin(),
1072            ie = Asm.end(); it != ie; ++it)
1073       Asm.WriteSectionData(it, Layout, Writer);
1074
1075     // Write the extra padding.
1076     WriteZeros(SectionDataPadding);
1077
1078     // Write the relocation entries.
1079     for (MCAssembler::const_iterator it = Asm.begin(),
1080            ie = Asm.end(); it != ie; ++it) {
1081       // Write the section relocation entries, in reverse order to match 'as'
1082       // (approximately, the exact algorithm is more complicated than this).
1083       std::vector<MachRelocationEntry> &Relocs = Relocations[it];
1084       for (unsigned i = 0, e = Relocs.size(); i != e; ++i) {
1085         Write32(Relocs[e - i - 1].Word0);
1086         Write32(Relocs[e - i - 1].Word1);
1087       }
1088     }
1089
1090     // Write the symbol table data, if used.
1091     if (NumSymbols) {
1092       // Write the indirect symbol entries.
1093       for (MCAssembler::const_indirect_symbol_iterator
1094              it = Asm.indirect_symbol_begin(),
1095              ie = Asm.indirect_symbol_end(); it != ie; ++it) {
1096         // Indirect symbols in the non lazy symbol pointer section have some
1097         // special handling.
1098         const MCSectionMachO &Section =
1099           static_cast<const MCSectionMachO&>(it->SectionData->getSection());
1100         if (Section.getType() == MCSectionMachO::S_NON_LAZY_SYMBOL_POINTERS) {
1101           // If this symbol is defined and internal, mark it as such.
1102           if (it->Symbol->isDefined() &&
1103               !Asm.getSymbolData(*it->Symbol).isExternal()) {
1104             uint32_t Flags = ISF_Local;
1105             if (it->Symbol->isAbsolute())
1106               Flags |= ISF_Absolute;
1107             Write32(Flags);
1108             continue;
1109           }
1110         }
1111
1112         Write32(Asm.getSymbolData(*it->Symbol).getIndex());
1113       }
1114
1115       // FIXME: Check that offsets match computed ones.
1116
1117       // Write the symbol table entries.
1118       for (unsigned i = 0, e = LocalSymbolData.size(); i != e; ++i)
1119         WriteNlist(LocalSymbolData[i], Layout);
1120       for (unsigned i = 0, e = ExternalSymbolData.size(); i != e; ++i)
1121         WriteNlist(ExternalSymbolData[i], Layout);
1122       for (unsigned i = 0, e = UndefinedSymbolData.size(); i != e; ++i)
1123         WriteNlist(UndefinedSymbolData[i], Layout);
1124
1125       // Write the string table.
1126       OS << StringTable.str();
1127     }
1128   }
1129 };
1130
1131 }
1132
1133 MachObjectWriter::MachObjectWriter(raw_ostream &OS,
1134                                    bool Is64Bit,
1135                                    bool IsLittleEndian)
1136   : MCObjectWriter(OS, IsLittleEndian)
1137 {
1138   Impl = new MachObjectWriterImpl(this, Is64Bit);
1139 }
1140
1141 MachObjectWriter::~MachObjectWriter() {
1142   delete (MachObjectWriterImpl*) Impl;
1143 }
1144
1145 void MachObjectWriter::ExecutePostLayoutBinding(MCAssembler &Asm) {
1146   ((MachObjectWriterImpl*) Impl)->ExecutePostLayoutBinding(Asm);
1147 }
1148
1149 void MachObjectWriter::RecordRelocation(const MCAssembler &Asm,
1150                                         const MCAsmLayout &Layout,
1151                                         const MCFragment *Fragment,
1152                                         const MCAsmFixup &Fixup, MCValue Target,
1153                                         uint64_t &FixedValue) {
1154   ((MachObjectWriterImpl*) Impl)->RecordRelocation(Asm, Layout, Fragment, Fixup,
1155                                                    Target, FixedValue);
1156 }
1157
1158 void MachObjectWriter::WriteObject(const MCAssembler &Asm,
1159                                    const MCAsmLayout &Layout) {
1160   ((MachObjectWriterImpl*) Impl)->WriteObject(Asm, Layout);
1161 }