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